Add documentation for the drivers
[connman] / src / element.c
index 7c892e6..66c91d0 100644 (file)
@@ -39,6 +39,7 @@ static GSList *driver_list = NULL;
 
 static GThreadPool *thread_register = NULL;
 static GThreadPool *thread_unregister = NULL;
+static GThreadPool *thread_unregister_children = NULL;
 
 static gchar *device_filter = NULL;
 
@@ -175,8 +176,7 @@ static DBusMessage *get_properties(DBusConnection *conn,
        if (str != NULL)
                append_entry(&dict, "Subtype", DBUS_TYPE_STRING, &str);
 
-       append_entry(&dict, "Connected",
-                               DBUS_TYPE_BOOLEAN, &element->connected);
+       append_entry(&dict, "Enabled", DBUS_TYPE_BOOLEAN, &element->enabled);
 
        if (element->priority > 0)
                append_entry(&dict, "Priority",
@@ -231,7 +231,7 @@ static DBusMessage *do_update(DBusConnection *conn,
        return g_dbus_create_reply(msg, DBUS_TYPE_INVALID);
 }
 
-static DBusMessage *do_connect(DBusConnection *conn,
+static DBusMessage *do_enable(DBusConnection *conn,
                                        DBusMessage *msg, void *data)
 {
        struct connman_element *element = data;
@@ -241,15 +241,15 @@ static DBusMessage *do_connect(DBusConnection *conn,
        if (element->driver == NULL)
                return g_dbus_create_reply(msg, DBUS_TYPE_INVALID);
 
-       if (element->driver->connect) {
-               DBG("Calling connect callback");
-               element->driver->connect(element);
+       if (element->driver->enable) {
+               DBG("Calling enable callback");
+               element->driver->enable(element);
        }
 
        return g_dbus_create_reply(msg, DBUS_TYPE_INVALID);
 }
 
-static DBusMessage *do_disconnect(DBusConnection *conn,
+static DBusMessage *do_disable(DBusConnection *conn,
                                        DBusMessage *msg, void *data)
 {
        struct connman_element *element = data;
@@ -259,9 +259,9 @@ static DBusMessage *do_disconnect(DBusConnection *conn,
        if (element->driver == NULL)
                return g_dbus_create_reply(msg, DBUS_TYPE_INVALID);
 
-       if (element->driver->disconnect) {
-               DBG("Calling disconnect callback");
-               element->driver->disconnect(element);
+       if (element->driver->disable) {
+               DBG("Calling disable callback");
+               element->driver->disable(element);
        }
 
        return g_dbus_create_reply(msg, DBUS_TYPE_INVALID);
@@ -271,8 +271,13 @@ static GDBusMethodTable element_methods[] = {
        { "GetProperties", "",   "a{sv}", get_properties },
        { "SetProperty",   "sv", "",      set_property   },
        { "Update",        "",   "",      do_update      },
-       { "Connect",       "",   "",      do_connect     },
-       { "Disconnect",    "",   "",      do_disconnect  },
+       { "Enable",        "",   "",      do_enable      },
+       { "Disable",       "",   "",      do_disable     },
+       { },
+};
+
+static GDBusSignalTable element_signals[] = {
+       { "PropertyChanged", "sv" },
        { },
 };
 
@@ -325,6 +330,9 @@ static gint compare_priority(gconstpointer a, gconstpointer b)
 static gboolean match_driver(struct connman_element *element,
                                        struct connman_driver *driver)
 {
+       if (element->type == CONNMAN_ELEMENT_TYPE_ROOT)
+               return FALSE;
+
        if (element->type != driver->type &&
                        driver->type != CONNMAN_ELEMENT_TYPE_UNKNOWN)
                return FALSE;
@@ -355,6 +363,14 @@ static gboolean probe_driver(GNode *node, gpointer data)
        return FALSE;
 }
 
+/**
+ * connman_driver_register:
+ * @driver: driver definition
+ *
+ * Register a new driver
+ *
+ * Returns: %0 on success
+ */
 int connman_driver_register(struct connman_driver *driver)
 {
        DBG("driver %p name %s", driver, driver->name);
@@ -398,6 +414,12 @@ static gboolean remove_driver(GNode *node, gpointer data)
        return FALSE;
 }
 
+/**
+ * connman_driver_unregister:
+ * @driver: driver definition
+ *
+ * Remove a previously registered driver
+ */
 void connman_driver_unregister(struct connman_driver *driver)
 {
        DBG("driver %p name %s", driver, driver->name);
@@ -429,7 +451,7 @@ struct connman_element *connman_element_create(void)
        element->subtype = CONNMAN_ELEMENT_SUBTYPE_UNKNOWN;
        element->state   = CONNMAN_ELEMENT_STATE_CLOSED;
 
-       element->connected = FALSE;
+       element->enabled = FALSE;
 
        element->netdev.index = -1;
 
@@ -616,31 +638,9 @@ int connman_element_register(struct connman_element *element,
        __connman_element_load(element);
 
        if (element->name == NULL) {
-               switch (element->type) {
-               case CONNMAN_ELEMENT_TYPE_IPV4:
-                       element->name = g_strdup("ipv4");
-                       break;
-               case CONNMAN_ELEMENT_TYPE_IPV6:
-                       element->name = g_strdup("ipv6");
-                       break;
-               case CONNMAN_ELEMENT_TYPE_DHCP:
-                       element->name = g_strdup("dhcp");
-                       break;
-               case CONNMAN_ELEMENT_TYPE_BOOTP:
-                       element->name = g_strdup("bootp");
-                       break;
-               case CONNMAN_ELEMENT_TYPE_ZEROCONF:
-                       element->name = g_strdup("zeroconf");
-                       break;
-               case CONNMAN_ELEMENT_TYPE_RESOLVER:
-                       element->name = g_strdup("resolver");
-                       break;
-               case CONNMAN_ELEMENT_TYPE_INTERNET:
-                       element->name = g_strdup("internet");
-                       break;
-               default:
-                       break;
-               }
+               element->name = g_strdup(type2string(element->type));
+               if (element->name == NULL)
+                       return -EINVAL;
        }
 
        element->parent = parent;
@@ -661,21 +661,46 @@ void connman_element_unregister(struct connman_element *element)
                g_thread_pool_push(thread_unregister, element, NULL);
 }
 
-void connman_element_update(struct connman_element *element)
+void connman_element_unregister_children(struct connman_element *element)
 {
        DBG("element %p name %s", element, element->name);
 
-       g_static_rw_lock_reader_lock(&element_lock);
+       if (thread_unregister_children != NULL)
+               g_thread_pool_push(thread_unregister_children, element, NULL);
+}
+
+static gboolean update_element(GNode *node, gpointer user_data)
+{
+       struct connman_element *element = node->data;
+
+       DBG("element %p name %s", element, element->name);
 
        if (element->driver && element->driver->update)
                element->driver->update(element);
 
-       g_static_rw_lock_reader_unlock(&element_lock);
-
        g_dbus_emit_signal(connection, CONNMAN_MANAGER_PATH,
                                CONNMAN_MANAGER_INTERFACE, "ElementUpdated",
                                DBUS_TYPE_OBJECT_PATH, &element->path,
                                                        DBUS_TYPE_INVALID);
+
+       return FALSE;
+}
+
+void connman_element_update(struct connman_element *element)
+{
+       GNode *node;
+
+       DBG("element %p name %s", element, element->name);
+
+       g_static_rw_lock_reader_lock(&element_lock);
+
+       node = g_node_find(element_root, G_PRE_ORDER, G_TRAVERSE_ALL, element);
+
+       if (node != NULL)
+               g_node_traverse(node, G_PRE_ORDER,
+                               G_TRAVERSE_ALL, -1, update_element, NULL);
+
+       g_static_rw_lock_reader_unlock(&element_lock);
 }
 
 static void register_element(gpointer data, gpointer user_data)
@@ -709,14 +734,10 @@ static void register_element(gpointer data, gpointer user_data)
 
        g_node_append_data(node, element);
 
-       g_static_rw_lock_writer_unlock(&element_lock);
-
-       __connman_element_store(element);
-
        if (g_dbus_register_interface(connection, element->path,
                                        CONNMAN_ELEMENT_INTERFACE,
-                                       element_methods, NULL, NULL,
-                                               element, NULL) == FALSE)
+                                       element_methods, element_signals,
+                                       NULL, element, NULL) == FALSE)
                connman_error("Failed to register %s", element->path);
 
        g_dbus_emit_signal(connection, CONNMAN_MANAGER_PATH,
@@ -724,11 +745,9 @@ static void register_element(gpointer data, gpointer user_data)
                                DBUS_TYPE_OBJECT_PATH, &element->path,
                                                        DBUS_TYPE_INVALID);
 
-       if (element->type == CONNMAN_ELEMENT_TYPE_DEVICE)
-               g_dbus_emit_signal(connection, CONNMAN_MANAGER_PATH,
-                               CONNMAN_MANAGER_INTERFACE, "DeviceAdded",
-                               DBUS_TYPE_OBJECT_PATH, &element->path,
-                                                       DBUS_TYPE_INVALID);
+       g_static_rw_lock_writer_unlock(&element_lock);
+
+       __connman_element_store(element);
 
        g_static_rw_lock_writer_lock(&element_lock);
 
@@ -740,27 +759,26 @@ static void register_element(gpointer data, gpointer user_data)
 
                DBG("driver %p name %s", driver, driver->name);
 
-               if (driver->probe(element) < 0)
-                       continue;
-
-               connman_element_lock(element);
-               element->driver = driver;
-               connman_element_unlock(element);
+               if (driver->probe(element) == 0) {
+                       connman_element_lock(element);
+                       element->driver = driver;
+                       connman_element_unlock(element);
+                       break;
+               }
        }
 
        g_static_rw_lock_writer_unlock(&element_lock);
 }
 
-static void unregister_element(gpointer data, gpointer user_data)
+static gboolean remove_element(GNode *node, gpointer user_data)
 {
-       struct connman_element *element = data;
-       GNode *node;
+       struct connman_element *element = node->data;
+       struct connman_element *root = user_data;
 
        DBG("element %p name %s", element, element->name);
 
-       g_static_rw_lock_writer_lock(&element_lock);
-
-       node = g_node_find(element_root, G_PRE_ORDER, G_TRAVERSE_ALL, element);
+       if (element == root)
+               return FALSE;
 
        if (element->driver) {
                if (element->driver->remove)
@@ -776,14 +794,6 @@ static void unregister_element(gpointer data, gpointer user_data)
                g_node_destroy(node);
        }
 
-       g_static_rw_lock_writer_unlock(&element_lock);
-
-       if (element->type == CONNMAN_ELEMENT_TYPE_DEVICE)
-               g_dbus_emit_signal(connection, CONNMAN_MANAGER_PATH,
-                               CONNMAN_MANAGER_INTERFACE, "DeviceRemoved",
-                               DBUS_TYPE_OBJECT_PATH, &element->path,
-                                                       DBUS_TYPE_INVALID);
-
        g_dbus_emit_signal(connection, CONNMAN_MANAGER_PATH,
                                CONNMAN_MANAGER_INTERFACE, "ElementRemoved",
                                DBUS_TYPE_OBJECT_PATH, &element->path,
@@ -793,6 +803,44 @@ static void unregister_element(gpointer data, gpointer user_data)
                                                CONNMAN_ELEMENT_INTERFACE);
 
        connman_element_unref(element);
+
+       return FALSE;
+}
+
+static void unregister_element(gpointer data, gpointer user_data)
+{
+       struct connman_element *element = data;
+       GNode *node;
+
+       DBG("element %p name %s", element, element->name);
+
+       g_static_rw_lock_writer_lock(&element_lock);
+
+       node = g_node_find(element_root, G_PRE_ORDER, G_TRAVERSE_ALL, element);
+
+       if (node != NULL)
+               g_node_traverse(node, G_POST_ORDER,
+                               G_TRAVERSE_ALL, -1, remove_element, NULL);
+
+       g_static_rw_lock_writer_unlock(&element_lock);
+}
+
+static void unregister_children(gpointer data, gpointer user_data)
+{
+       struct connman_element *element = data;
+       GNode *node;
+
+       DBG("element %p name %s", element, element->name);
+
+       g_static_rw_lock_writer_lock(&element_lock);
+
+       node = g_node_find(element_root, G_PRE_ORDER, G_TRAVERSE_ALL, element);
+
+       if (node != NULL)
+               g_node_traverse(node, G_POST_ORDER,
+                               G_TRAVERSE_ALL, -1, remove_element, element);
+
+       g_static_rw_lock_writer_unlock(&element_lock);
 }
 
 int __connman_element_init(DBusConnection *conn, const char *device)
@@ -823,6 +871,8 @@ int __connman_element_init(DBusConnection *conn, const char *device)
                                                        NULL, 1, FALSE, NULL);
        thread_unregister = g_thread_pool_new(unregister_element,
                                                        NULL, 1, FALSE, NULL);
+       thread_unregister_children = g_thread_pool_new(unregister_children,
+                                                       NULL, 1, FALSE, NULL);
 
        return 0;
 }
@@ -877,6 +927,9 @@ void __connman_element_cleanup(void)
        g_thread_pool_free(thread_unregister, FALSE, TRUE);
        thread_unregister = NULL;
 
+       g_thread_pool_free(thread_unregister_children, FALSE, TRUE);
+       thread_unregister_children = NULL;
+
        g_static_rw_lock_writer_lock(&element_lock);
        g_node_destroy(element_root);
        element_root = NULL;