asynchronous and deferred port detection

Allow plugins to perform asynchronous port detection, and to defer port detection
until later.  This moves the prober bits into MMPluginBase so that all plugins
can take adavantage of it only when needed; the probing is not done at udev time.
Furthermore, plugins like Novatel can flip the secondary ports over the AT mode
through	deferred detection, by deferring the secondary ports until the main port
has been detected and AT$NWDMAT	has been sent.

This commit also finishes the port of the rest of the plugins (except mbm) over
to the new port detection methods and plugin API.

1 files changed, 117 insertions, 102 deletions

diff --git a/plugins/mm-plugin-option.c b/plugins/mm-plugin-option.c
index 1a231f40..6f4aaa97 100644
--- a/plugins/mm-plugin-option.c
+++ b/plugins/mm-plugin-option.c
@@ -1,14 +1,25 @@
 /* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * 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:
+ *
+ * Copyright (C) 2008 - 2009 Novell, Inc.
+ * Copyright (C) 2009 Red Hat, Inc.
+ */
 
 #include <string.h>
 #include <gmodule.h>
 #include "mm-plugin-option.h"
 #include "mm-modem-option.h"
 
-static void plugin_init (MMPlugin *plugin_class);
-
-G_DEFINE_TYPE_EXTENDED (MMPluginOption, mm_plugin_option, G_TYPE_OBJECT,
-                        0, G_IMPLEMENT_INTERFACE (MM_TYPE_PLUGIN, plugin_init))
+G_DEFINE_TYPE (MMPluginOption, mm_plugin_option, MM_TYPE_PLUGIN_BASE)
 
 int mm_plugin_major_version = MM_PLUGIN_MAJOR_VERSION;
 int mm_plugin_minor_version = MM_PLUGIN_MINOR_VERSION;
@@ -16,117 +27,126 @@ int mm_plugin_minor_version = MM_PLUGIN_MINOR_VERSION;
 G_MODULE_EXPORT MMPlugin *
 mm_plugin_create (void)
 {
-    return MM_PLUGIN (g_object_new (MM_TYPE_PLUGIN_OPTION, NULL));
+    return MM_PLUGIN (g_object_new (MM_TYPE_PLUGIN_OPTION,
+                                    MM_PLUGIN_BASE_NAME, "Option",
+                                    NULL));
 }
 
 /*****************************************************************************/
 
-static const char *
-get_name (MMPlugin *plugin)
+static guint32
+get_level_for_capabilities (guint32 capabilities)
 {
-    return "Option";
+    if (capabilities & MM_PLUGIN_BASE_PORT_CAP_GSM)
+        return 10;
+    return 0;
 }
 
-static char **
-list_supported_udis (MMPlugin *plugin, LibHalContext *hal_ctx)
+static void
+probe_result (MMPluginBase *base,
+              MMPluginBaseSupportsTask *task,
+              guint32 capabilities,
+              gpointer user_data)
 {
-    char **supported = NULL;
-    char **devices;
-    int num_devices;
-    int i;
-
-    devices = libhal_find_device_by_capability (hal_ctx, "modem", &num_devices, NULL);
-    if (devices) {
-        GPtrArray *array;
-
-        array = g_ptr_array_new ();
-
-        for (i = 0; i < num_devices; i++) {
-            char *udi = devices[i];
-
-            if (mm_plugin_supports_udi (plugin, hal_ctx, udi))
-                g_ptr_array_add (array, g_strdup (udi));
-        }
-
-        if (array->len > 0) {
-            g_ptr_array_add (array, NULL);
-            supported = (char **) g_ptr_array_free (array, FALSE);
-        } else
-            g_ptr_array_free (array, TRUE);
-    }
-
-    g_strfreev (devices);
-
-    return supported;
+    mm_plugin_base_supports_task_complete (task, get_level_for_capabilities (capabilities));
 }
 
-static gboolean
-supports_udi (MMPlugin *plugin, LibHalContext *hal_ctx, const char *udi)
+static MMPluginSupportsResult
+supports_port (MMPluginBase *base,
+               MMModem *existing,
+               MMPluginBaseSupportsTask *task)
 {
-    char **capabilities;
-    char **iter;
-    gboolean supported = FALSE;
-
-    capabilities = libhal_device_get_property_strlist (hal_ctx, udi, "modem.command_sets", NULL);
-    for (iter = capabilities; iter && *iter && !supported; iter++) {
-        if (!strcmp (*iter, "GSM-07.07")) {
-            char *parent_udi;
-
-            parent_udi = libhal_device_get_property_string (hal_ctx, udi, "info.parent", NULL);
-            if (parent_udi) {
-                int vendor;
-
-                vendor = libhal_device_get_property_int (hal_ctx, parent_udi, "usb.vendor_id", NULL);
-                if (vendor == 0x0af0) {
-                    char *driver;
-
-                    driver = libhal_device_get_property_string (hal_ctx, parent_udi, "info.linux.driver", NULL);
-                    if (driver && !strcmp (driver, "option"))
-                        supported = TRUE;
-                    libhal_free_string (driver);
-                }
-
-                libhal_free_string (parent_udi);
-            }
+    GUdevDevice *port;
+    guint32 cached = 0, level;
+    const char *driver, *subsys, *name;
+    guint16 vendor = 0;
+
+    /* Can't do anything with non-serial ports */
+    port = mm_plugin_base_supports_task_get_port (task);
+    if (strcmp (g_udev_device_get_subsystem (port), "tty"))
+        return MM_PLUGIN_SUPPORTS_PORT_UNSUPPORTED;
+
+    subsys = g_udev_device_get_subsystem (port);
+    name = g_udev_device_get_name (port);
+
+    driver = mm_plugin_base_supports_task_get_driver (task);
+    if (!driver || (strcmp (driver, "option1") && strcmp (driver, "option")))
+        return MM_PLUGIN_SUPPORTS_PORT_UNSUPPORTED;
+
+    if (!mm_plugin_base_get_device_ids (base, subsys, name, &vendor, NULL))
+        return MM_PLUGIN_SUPPORTS_PORT_UNSUPPORTED;
+
+    if (vendor != 0x0af0)
+        return MM_PLUGIN_SUPPORTS_PORT_UNSUPPORTED;
+
+    if (mm_plugin_base_get_cached_port_capabilities (base, port, &cached)) {
+        level = get_level_for_capabilities (cached);
+        if (level) {
+            mm_plugin_base_supports_task_complete (task, level);
+            return MM_PLUGIN_SUPPORTS_PORT_IN_PROGRESS;
         }
+        return MM_PLUGIN_SUPPORTS_PORT_UNSUPPORTED;
     }
-    g_strfreev (capabilities);
 
-    return supported;
-}
-
-static char *
-get_driver_name (LibHalContext *ctx, const char *udi)
-{
-    char *parent_udi;
-    char *driver = NULL;
+    /* Otherwise kick off a probe */
+    if (mm_plugin_base_probe_port (base, task, NULL))
+        return MM_PLUGIN_SUPPORTS_PORT_IN_PROGRESS;
 
-    parent_udi = libhal_device_get_property_string (ctx, udi, "info.parent", NULL);
-    if (parent_udi) {
-        driver = libhal_device_get_property_string (ctx, parent_udi, "info.linux.driver", NULL);
-        libhal_free_string (parent_udi);
-    }
-
-    return driver;
+    return MM_PLUGIN_SUPPORTS_PORT_UNSUPPORTED;
 }
 
 static MMModem *
-create_modem (MMPlugin *plugin, LibHalContext *hal_ctx, const char *udi)
+grab_port (MMPluginBase *base,
+           MMModem *existing,
+           MMPluginBaseSupportsTask *task,
+           GError **error)
 {
-    char *data_device;
-    char *driver;
-    MMModem *modem;
+    GUdevDevice *port = NULL, *physdev = NULL;
+    MMModem *modem = NULL;
+    const char *name, *subsys, *devfile, *sysfs_path;
+    guint32 caps;
+
+    port = mm_plugin_base_supports_task_get_port (task);
+    g_assert (port);
+
+    devfile = g_udev_device_get_device_file (port);
+    if (!devfile) {
+        g_set_error (error, 0, 0, "Could not get port's sysfs file.");
+        return NULL;
+    }
 
-    data_device = libhal_device_get_property_string (hal_ctx, udi, "serial.device", NULL);
-    g_return_val_if_fail (data_device != NULL, NULL);
+    physdev = mm_plugin_base_supports_task_get_physdev (task);
+    g_assert (physdev);
+    sysfs_path = g_udev_device_get_sysfs_path (physdev);
+    if (!sysfs_path) {
+        g_set_error (error, 0, 0, "Could not get port's physical device sysfs path.");
+        return NULL;
+    }
 
-    driver = get_driver_name (hal_ctx, udi);
-    g_return_val_if_fail (driver != NULL, NULL);
+    subsys = g_udev_device_get_subsystem (port);
+    name = g_udev_device_get_name (port);
 
-    modem = MM_MODEM (mm_modem_option_new (data_device, driver));
+    caps = mm_plugin_base_supports_task_get_probed_capabilities (task);
+    if (!existing) {
+        if (caps & MM_PLUGIN_BASE_PORT_CAP_GSM) {
+            modem = mm_modem_option_new (sysfs_path,
+                                         mm_plugin_base_supports_task_get_driver (task),
+                                         mm_plugin_get_name (MM_PLUGIN (base)));
+        }
 
-    libhal_free_string (data_device);
-    libhal_free_string (driver);
+        if (modem) {
+            if (!mm_modem_grab_port (modem, subsys, name, NULL, error)) {
+                g_object_unref (modem);
+                return NULL;
+            }
+        }
+    } else {
+        if (caps & MM_PLUGIN_BASE_PORT_CAP_GSM) {
+            modem = existing;
+            if (!mm_modem_grab_port (modem, subsys, name, NULL, error))
+                return NULL;
+        }
+    }
 
     return modem;
 }
@@ -134,21 +154,16 @@ create_modem (MMPlugin *plugin, LibHalContext *hal_ctx, const char *udi)
 /*****************************************************************************/
 
 static void
-plugin_init (MMPlugin *plugin_class)
-{
-    /* interface implementation */
-    plugin_class->get_name = get_name;
-    plugin_class->list_supported_udis = list_supported_udis;
-    plugin_class->supports_udi = supports_udi;
-    plugin_class->create_modem = create_modem;
-}
-
-static void
 mm_plugin_option_init (MMPluginOption *self)
 {
+    g_signal_connect (self, "probe-result", G_CALLBACK (probe_result), NULL);
 }
 
 static void
 mm_plugin_option_class_init (MMPluginOptionClass *klass)
 {
+    MMPluginBaseClass *pb_class = MM_PLUGIN_BASE_CLASS (klass);
+
+    pb_class->supports_port = supports_port;
+    pb_class->grab_port = grab_port;
 }