Break out device info into a separate driver
authorDenis Kenzior <denkenz@gmail.com>
Thu, 20 Aug 2009 17:43:25 +0000 (12:43 -0500)
committerDenis Kenzior <denkenz@gmail.com>
Thu, 20 Aug 2009 17:48:29 +0000 (12:48 -0500)
The modem info ops (Serial, Manufacturer, etc) are broken into a
separate oFono atom.  This is mainly to support a proper modem device
driver infrastructure.  As a result the data structures have been
tweaked a little.

driver.h is now empty and has been removed.

include/Makefile.am
include/devinfo.h [new file with mode: 0644]
include/modem.h
src/Makefile.am
src/driver.h [deleted file]
src/manager.c
src/modem.c
src/ofono.h

index 8992cee..5744663 100644 (file)
@@ -5,7 +5,7 @@ include_HEADERS = log.h plugin.h history.h dbus.h modem.h \
                        types.h call-barring.h call-forwarding.h \
                        call-meter.h call-settings.h phonebook.h \
                        ssn.h ussd.h sms.h sim.h message-waiting.h \
-                       netreg.h voicecall.h
+                       netreg.h voicecall.h devinfo.h
 
 nodist_include_HEADERS = version.h
 
diff --git a/include/devinfo.h b/include/devinfo.h
new file mode 100644 (file)
index 0000000..465aa05
--- /dev/null
@@ -0,0 +1,66 @@
+/*
+ *
+ *  oFono - Open Telephony stack for Linux
+ *
+ *  Copyright (C) 2008-2009  Intel Corporation. All rights reserved.
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License version 2 as
+ *  published by the Free Software Foundation.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program; if not, write to the Free Software
+ *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ */
+
+#ifndef __OFONO_DEVINFO_H
+#define __OFONO_DEVINFO_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <ofono/types.h>
+
+struct ofono_devinfo;
+
+typedef void (*ofono_devinfo_query_cb_t)(const struct ofono_error *error,
+                                       const char *attribute, void *data);
+
+struct ofono_devinfo_driver {
+       const char *name;
+       int (*probe)(struct ofono_devinfo *info);
+       int (*remove)(struct ofono_devinfo *info);
+       void (*query_manufacturer)(struct ofono_devinfo *info,
+                       ofono_devinfo_query_cb_t cb, void *data);
+       void (*query_serial)(struct ofono_devinfo *info,
+                       ofono_devinfo_query_cb_t cb, void *data);
+       void (*query_model)(struct ofono_devinfo *info,
+                       ofono_devinfo_query_cb_t cb, void *data);
+       void (*query_revision)(struct ofono_devinfo *info,
+                       ofono_devinfo_query_cb_t cb, void *data);
+};
+
+int ofono_devinfo_driver_register(const struct ofono_devinfo_driver *d);
+void ofono_devinfo_driver_unregister(const struct ofono_devinfo_driver *d);
+
+struct ofono_devinfo *ofono_devinfo_create(struct ofono_modem *modem,
+                                                       const char *driver,
+                                                       void *data);
+void ofono_devinfo_register(struct ofono_devinfo *info);
+void ofono_devinfo_remove(struct ofono_devinfo *info);
+
+void ofono_devinfo_set_data(struct ofono_devinfo *info, void *data);
+void *ofono_devinfo_get_data(struct ofono_devinfo *info);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* __OFONO_MODEM_INFO_H */
index 2c2db2e..0c53d73 100644 (file)
@@ -39,6 +39,9 @@ const char *ofono_modem_get_path(struct ofono_modem *modem);
 void ofono_modem_set_userdata(struct ofono_modem *modem, void *data);
 void *ofono_modem_get_userdata(struct ofono_modem *modem);
 
+struct ofono_modem *ofono_modem_register();
+int ofono_modem_unregister(struct ofono_modem *modem);
+
 #ifdef __cplusplus
 }
 #endif
index 089eb7c..99b01db 100644 (file)
@@ -8,7 +8,7 @@ endif
 sbin_PROGRAMS = ofonod
 
 ofonod_SOURCES = main.c ofono.h log.c plugin.c \
-               driver.h modem.c common.h common.c \
+               modem.c common.h common.c \
                manager.c dbus.c util.h util.c \
                network.c voicecall.c ussd.c sms.c \
                call-settings.c call-forwarding.c call-meter.c \
diff --git a/src/driver.h b/src/driver.h
deleted file mode 100644 (file)
index 2635a51..0000000
+++ /dev/null
@@ -1,43 +0,0 @@
-/*
- *
- *  oFono - Open Source Telephony
- *
- *  Copyright (C) 2008-2009  Intel Corporation. All rights reserved.
- *
- *  This program is free software; you can redistribute it and/or modify
- *  it under the terms of the GNU General Public License version 2 as
- *  published by the Free Software Foundation.
- *
- *  This program is distributed in the hope that it will be useful,
- *  but WITHOUT ANY WARRANTY; without even the implied warranty of
- *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *  GNU General Public License for more details.
- *
- *  You should have received a copy of the GNU General Public License
- *  along with this program; if not, write to the Free Software
- *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
- *
- */
-
-#include <ofono/types.h>
-
-struct ofono_modem;
-
-
-typedef void (*ofono_modem_attribute_query_cb_t)(const struct ofono_error *error,
-                                       const char *attribute, void *data);
-
-struct ofono_modem_attribute_ops {
-       void (*query_manufacturer)(struct ofono_modem *modem,
-                       ofono_modem_attribute_query_cb_t cb, void *data);
-       void (*query_serial)(struct ofono_modem *modem,
-                       ofono_modem_attribute_query_cb_t cb, void *data);
-       void (*query_model)(struct ofono_modem *modem,
-                       ofono_modem_attribute_query_cb_t cb, void *data);
-       void (*query_revision)(struct ofono_modem *modem,
-                       ofono_modem_attribute_query_cb_t cb, void *data);
-};
-
-struct ofono_modem *ofono_modem_register(struct ofono_modem_attribute_ops *ops);
-int ofono_modem_unregister(struct ofono_modem *modem);
-
index 07df0e0..e35728a 100644 (file)
@@ -29,8 +29,6 @@
 
 #include "ofono.h"
 
-#include "driver.h"
-
 static DBusMessage *manager_get_properties(DBusConnection *conn,
                                                DBusMessage *msg, void *data)
 {
index d41fb08..dc57114 100644 (file)
 
 #include <string.h>
 #include <stdio.h>
+#include <errno.h>
 
 #include <glib.h>
 #include <gdbus.h>
 
 #include "ofono.h"
 
-#include "driver.h"
 #include "common.h"
 
-#define MODEM_FLAG_INITIALIZING_ATTRS 1
+static GSList *g_devinfo_drivers = NULL;
 
 static GSList *g_modem_list = NULL;
 static int g_next_modem_id = 1;
 
 struct ofono_modem_data {
-       char                            *manufacturer;
-       char                            *model;
-       char                            *revision;
-       char                            *serial;
        GSList                          *interface_list;
        int                             flags;
        unsigned int                    idlist;
-       struct ofono_modem_attribute_ops        *ops;
        DBusMessage                     *pending;
        guint                           interface_update;
 };
 
+struct ofono_devinfo {
+       char *manufacturer;
+       char *model;
+       char *revision;
+       char *serial;
+       const struct ofono_devinfo_driver *driver;
+       void *driver_data;
+       struct ofono_atom *atom;
+};
+
 struct ofono_atom {
        enum ofono_atom_type type;
        void (*destruct)(struct ofono_atom *atom);
@@ -338,11 +343,6 @@ static void modem_free(gpointer data)
 
        g_slist_free(modem->modem_info->interface_list);
 
-       g_free(modem->modem_info->manufacturer);
-       g_free(modem->modem_info->serial);
-       g_free(modem->modem_info->revision);
-       g_free(modem->modem_info->model);
-
        if (modem->modem_info->pending)
                dbus_message_unref(modem->modem_info->pending);
 
@@ -355,17 +355,18 @@ static void modem_free(gpointer data)
        g_free(modem);
 }
 
-static DBusMessage *generate_properties_reply(struct ofono_modem *modem,
-                               DBusConnection *conn, DBusMessage *msg)
+static DBusMessage *modem_get_properties(DBusConnection *conn,
+                                               DBusMessage *msg, void *data)
 {
-       struct ofono_modem_data *info = modem->modem_info;
+       struct ofono_modem *modem = data;
+       struct ofono_modem_data *d = modem->modem_info;
        DBusMessage *reply;
        DBusMessageIter iter;
        DBusMessageIter dict;
-
        char **interfaces;
        int i;
        GSList *l;
+       struct ofono_atom *devinfo_atom;
 
        reply = dbus_message_new_method_return(msg);
        if (!reply)
@@ -377,24 +378,36 @@ static DBusMessage *generate_properties_reply(struct ofono_modem *modem,
                                        OFONO_PROPERTIES_ARRAY_SIGNATURE,
                                        &dict);
 
-       if (info->manufacturer)
-               ofono_dbus_dict_append(&dict, "Manufacturer", DBUS_TYPE_STRING,
-                                       &info->manufacturer);
+       devinfo_atom = __ofono_modem_find_atom(modem, OFONO_ATOM_TYPE_DEVINFO);
 
-       if (info->model)
-               ofono_dbus_dict_append(&dict, "Model", DBUS_TYPE_STRING,
-                                       &info->model);
+       /* We cheat a little here and don't check the registered status */
+       if (devinfo_atom) {
+               struct ofono_devinfo *info;
 
-       if (info->revision)
-               ofono_dbus_dict_append(&dict, "Revision", DBUS_TYPE_STRING,
-                                       &info->revision);
+               info = __ofono_atom_get_data(devinfo_atom);
 
-       if (info->serial)
-               ofono_dbus_dict_append(&dict, "Serial", DBUS_TYPE_STRING,
-                                       &info->serial);
+               if (info->manufacturer)
+                       ofono_dbus_dict_append(&dict, "Manufacturer",
+                                               DBUS_TYPE_STRING,
+                                               &info->manufacturer);
 
-       interfaces = g_new0(char *, g_slist_length(info->interface_list) + 1);
-       for (i = 0, l = info->interface_list; l; l = l->next, i++)
+               if (info->model)
+                       ofono_dbus_dict_append(&dict, "Model", DBUS_TYPE_STRING,
+                                               &info->model);
+
+               if (info->revision)
+                       ofono_dbus_dict_append(&dict, "Revision",
+                                               DBUS_TYPE_STRING,
+                                               &info->revision);
+
+               if (info->serial)
+                       ofono_dbus_dict_append(&dict, "Serial",
+                                               DBUS_TYPE_STRING,
+                                               &info->serial);
+       }
+
+       interfaces = g_new0(char *, g_slist_length(d->interface_list) + 1);
+       for (i = 0, l = d->interface_list; l; l = l->next, i++)
                interfaces[i] = l->data;
 
        ofono_dbus_dict_append_array(&dict, "Interfaces", DBUS_TYPE_STRING,
@@ -407,22 +420,8 @@ static DBusMessage *generate_properties_reply(struct ofono_modem *modem,
        return reply;
 }
 
-static DBusMessage *modem_get_properties(DBusConnection *conn,
-                                               DBusMessage *msg, void *data)
-{
-       struct ofono_modem *modem = data;
-
-       if (modem->modem_info->flags & MODEM_FLAG_INITIALIZING_ATTRS) {
-               modem->modem_info->pending = dbus_message_ref(msg);
-               return NULL;
-       }
-
-       return generate_properties_reply(modem, conn, msg);
-}
-
 static GDBusMethodTable modem_methods[] = {
-       { "GetProperties",      "",     "a{sv}",        modem_get_properties,
-                                                       G_DBUS_METHOD_FLAG_ASYNC },
+       { "GetProperties",      "",     "a{sv}",        modem_get_properties },
        { }
 };
 
@@ -495,118 +494,221 @@ void ofono_modem_remove_interface(struct ofono_modem *modem,
                        g_timeout_add(0, trigger_interface_update, modem);
 }
 
-static void finish_attr_query(struct ofono_modem *modem)
+static void query_serial_cb(const struct ofono_error *error,
+                               const char *serial, void *user)
 {
+       struct ofono_devinfo *info = user;
        DBusConnection *conn = ofono_dbus_get_connection();
-       DBusMessage *reply;
-
-       modem->modem_info->flags &= ~MODEM_FLAG_INITIALIZING_ATTRS;
+       const char *path = __ofono_atom_get_path(info->atom);
 
-       if (!modem->modem_info->pending)
+       if (error->type != OFONO_ERROR_TYPE_NO_ERROR)
                return;
 
-       reply = generate_properties_reply(modem, conn,
-                                               modem->modem_info->pending);
-
-       if (reply)
-               g_dbus_send_message(conn, reply);
-
-       dbus_message_unref(modem->modem_info->pending);
-       modem->modem_info->pending = NULL;
-}
+       info->serial = g_strdup(serial);
 
-static void query_serial_cb(const struct ofono_error *error,
-                               const char *serial, void *user)
-{
-       struct ofono_modem *modem = user;
-
-       if (error->type == OFONO_ERROR_TYPE_NO_ERROR)
-               modem->modem_info->serial = g_strdup(serial);
-
-       finish_attr_query(modem);
+       ofono_dbus_signal_property_changed(conn, path,
+                                               OFONO_MODEM_INTERFACE,
+                                               "Serial", DBUS_TYPE_STRING,
+                                               &info->serial);
 }
 
-static void query_serial(struct ofono_modem *modem)
+static void query_serial(struct ofono_devinfo *info)
 {
-       if (!modem->modem_info->ops->query_serial) {
-               finish_attr_query(modem);
+       if (!info->driver->query_serial)
                return;
-       }
 
-       modem->modem_info->ops->query_serial(modem, query_serial_cb, modem);
+       info->driver->query_serial(info, query_serial_cb, info);
 }
 
 static void query_revision_cb(const struct ofono_error *error,
                                const char *revision, void *user)
 {
-       struct ofono_modem *modem = user;
+       struct ofono_devinfo *info = user;
+       DBusConnection *conn = ofono_dbus_get_connection();
+       const char *path = __ofono_atom_get_path(info->atom);
+
+       if (error->type != OFONO_ERROR_TYPE_NO_ERROR)
+               goto out;
 
-       if (error->type == OFONO_ERROR_TYPE_NO_ERROR)
-               modem->modem_info->revision = g_strdup(revision);
+       info->revision = g_strdup(revision);
 
-       query_serial(modem);
+       ofono_dbus_signal_property_changed(conn, path,
+                                               OFONO_MODEM_INTERFACE,
+                                               "Revision", DBUS_TYPE_STRING,
+                                               &info->revision);
+
+out:
+       query_serial(info);
 }
 
-static void query_revision(struct ofono_modem *modem)
+static void query_revision(struct ofono_devinfo *info)
 {
-       if (!modem->modem_info->ops->query_revision) {
-               query_serial(modem);
+       if (!info->driver->query_revision) {
+               query_serial(info);
                return;
        }
 
-       modem->modem_info->ops->query_revision(modem, query_revision_cb, modem);
+       info->driver->query_revision(info, query_revision_cb, info);
 }
 
 static void query_model_cb(const struct ofono_error *error,
                                const char *model, void *user)
 {
-       struct ofono_modem *modem = user;
+       struct ofono_devinfo *info = user;
+       DBusConnection *conn = ofono_dbus_get_connection();
+       const char *path = __ofono_atom_get_path(info->atom);
 
-       if (error->type == OFONO_ERROR_TYPE_NO_ERROR)
-               modem->modem_info->model = g_strdup(model);
+       if (error->type != OFONO_ERROR_TYPE_NO_ERROR)
+               goto out;
 
-       query_revision(modem);
+       info->model = g_strdup(model);
+
+       ofono_dbus_signal_property_changed(conn, path,
+                                               OFONO_MODEM_INTERFACE,
+                                               "Model", DBUS_TYPE_STRING,
+                                               &info->model);
+
+out:
+       query_revision(info);
 }
 
-static void query_model(struct ofono_modem *modem)
+static void query_model(struct ofono_devinfo *info)
 {
-       if (!modem->modem_info->ops->query_model) {
+       if (!info->driver->query_model) {
                /* If model is not supported, don't bother querying revision */
-               query_serial(modem);
-               return;
+               query_serial(info);
        }
 
-       modem->modem_info->ops->query_model(modem, query_model_cb, modem);
+       info->driver->query_model(info, query_model_cb, info);
 }
 
 static void query_manufacturer_cb(const struct ofono_error *error,
                                        const char *manufacturer, void *user)
 {
-       struct ofono_modem *modem = user;
+       struct ofono_devinfo *info = user;
+       DBusConnection *conn = ofono_dbus_get_connection();
+       const char *path = __ofono_atom_get_path(info->atom);
+
+       if (error->type != OFONO_ERROR_TYPE_NO_ERROR)
+               goto out;
 
-       if (error->type == OFONO_ERROR_TYPE_NO_ERROR)
-               modem->modem_info->manufacturer = g_strdup(manufacturer);
+       info->manufacturer = g_strdup(manufacturer);
 
-       query_model(modem);
+       ofono_dbus_signal_property_changed(conn, path,
+                                               OFONO_MODEM_INTERFACE,
+                                               "Serial", DBUS_TYPE_STRING,
+                                               &info->manufacturer);
+
+out:
+       query_model(info);
 }
 
 static gboolean query_manufacturer(gpointer user)
 {
-       struct ofono_modem *modem = user;
+       struct ofono_devinfo *info = user;
 
-       if (!modem->modem_info->ops->query_manufacturer) {
-               query_model(modem);
+       if (!info->driver->query_manufacturer) {
+               query_model(info);
                return FALSE;
        }
 
-       modem->modem_info->ops->query_manufacturer(modem, query_manufacturer_cb,
-                                                       modem);
+       info->driver->query_manufacturer(info, query_manufacturer_cb, info);
 
        return FALSE;
 }
 
-static struct ofono_modem *modem_create(int id,
-                                       struct ofono_modem_attribute_ops *ops)
+int ofono_devinfo_driver_register(const struct ofono_devinfo_driver *d)
+{
+       DBG("driver: %p, name: %s", d, d->name);
+
+       if (d->probe == NULL)
+               return -EINVAL;
+
+       g_devinfo_drivers = g_slist_prepend(g_devinfo_drivers, (void *)d);
+
+       return 0;
+}
+
+void ofono_devinfo_driver_unregister(const struct ofono_devinfo_driver *d)
+{
+       DBG("driver: %p, name: %s", d, d->name);
+
+       g_devinfo_drivers = g_slist_remove(g_devinfo_drivers, (void *)d);
+}
+
+static void devinfo_remove(struct ofono_atom *atom)
+{
+       struct ofono_devinfo *info = __ofono_atom_get_data(atom);
+
+       DBG("atom: %p", atom);
+
+       if (info == NULL)
+               return;
+
+       if (info->driver == NULL)
+               return;
+
+       if (info->driver->remove)
+               info->driver->remove(info);
+
+       g_free(info->manufacturer);
+       g_free(info->model);
+       g_free(info->revision);
+       g_free(info->serial);
+
+       g_free(info);
+}
+
+struct ofono_devinfo *ofono_devinfo_create(struct ofono_modem *modem,
+                                                       const char *driver,
+                                                       void *data)
+{
+       struct ofono_devinfo *info;
+       GSList *l;
+
+       info = g_new0(struct ofono_devinfo, 1);
+
+       info->atom = __ofono_modem_add_atom(modem, OFONO_ATOM_TYPE_DEVINFO,
+                                               devinfo_remove, info);
+       info->driver_data = data;
+
+       for (l = g_devinfo_drivers; l; l = l->next) {
+               const struct ofono_devinfo_driver *drv = l->data;
+
+               if (g_strcmp0(drv->name, driver))
+                       continue;
+
+               if (drv->probe(info) < 0)
+                       continue;
+
+               info->driver = drv;
+               break;
+       }
+
+       return info;
+}
+
+void ofono_devinfo_register(struct ofono_devinfo *info)
+{
+       query_manufacturer(info);
+}
+
+void ofono_devinfo_remove(struct ofono_devinfo *info)
+{
+       __ofono_atom_free(info->atom);
+}
+
+void ofono_devinfo_set_data(struct ofono_devinfo *info, void *data)
+{
+       info->driver_data = data;
+}
+
+void *ofono_devinfo_get_data(struct ofono_devinfo *info)
+{
+       return info->driver_data;
+}
+
+static struct ofono_modem *modem_create(int id)
 {
        char path[128];
        DBusConnection *conn = ofono_dbus_get_connection();
@@ -623,7 +725,6 @@ static struct ofono_modem *modem_create(int id,
        }
 
        modem->id = id;
-       modem->modem_info->ops = ops;
 
        snprintf(path, sizeof(path), "/modem%d", modem->id);
        modem->path = g_strdup(path);
@@ -636,9 +737,6 @@ static struct ofono_modem *modem_create(int id,
                return NULL;
        }
 
-       modem->modem_info->flags |= MODEM_FLAG_INITIALIZING_ATTRS;
-       g_timeout_add(0, query_manufacturer, modem);
-
        return modem;
 }
 
@@ -677,13 +775,13 @@ const char **__ofono_modem_get_list()
        return modems;
 }
 
-struct ofono_modem *ofono_modem_register(struct ofono_modem_attribute_ops *ops)
+struct ofono_modem *ofono_modem_register()
 {
        struct ofono_modem *modem;
        DBusConnection *conn = ofono_dbus_get_connection();
        const char **modems;
 
-       modem = modem_create(g_next_modem_id, ops);
+       modem = modem_create(g_next_modem_id);
 
        if (modem == NULL)
                return 0;
index 457b1fb..13fd577 100644 (file)
@@ -82,7 +82,7 @@ void __ofono_modem_release_callid(struct ofono_modem *modem, int id);
 struct ofono_atom;
 
 enum ofono_atom_type {
-       OFONO_ATOM_TYPE_INFO = 0,
+       OFONO_ATOM_TYPE_DEVINFO = 0,
        OFONO_ATOM_TYPE_CALL_BARRING = 1,
        OFONO_ATOM_TYPE_CALL_FORWARDING = 2,
        OFONO_ATOM_TYPE_CALL_METER = 3,
@@ -137,6 +137,7 @@ void __ofono_atom_free(struct ofono_atom *atom);
 #include <ofono/call-forwarding.h>
 #include <ofono/call-meter.h>
 #include <ofono/call-settings.h>
+#include <ofono/devinfo.h>
 #include <ofono/phonebook.h>
 #include <ofono/sms.h>
 #include <ofono/sim.h>