nokia: start porting the Nokia plugin to the new codebase

4 files changed, 288 insertions, 156 deletions

diff --git a/plugins/Makefile.am b/plugins/Makefile.am
index f0d7a460..664f361b 100644
--- a/plugins/Makefile.am
+++ b/plugins/Makefile.am
@@ -33,7 +33,8 @@ PLUGIN_COMMON_LINKER_FLAGS = \
 
 pkglib_LTLIBRARIES = \
 	libmm-plugin-generic.la \
-	libmm-plugin-cinterion.la
+	libmm-plugin-cinterion.la \
+	libmm-plugin-nokia.la
 
 #pkglib_LTLIBRARIES = \
 #	libmm-plugin-generic.la \
@@ -155,16 +156,16 @@ libmm_plugin_generic_la_LDFLAGS = $(PLUGIN_COMMON_LINKER_FLAGS)
 #	mm-modem-novatel-cdma.h
 #libmm_plugin_novatel_la_CPPFLAGS = $(PLUGIN_COMMON_COMPILER_FLAGS)
 #libmm_plugin_novatel_la_LDFLAGS = $(PLUGIN_COMMON_LINKER_FLAGS)
-#
-## Nokia
-#libmm_plugin_nokia_la_SOURCES = \
-#	mm-plugin-nokia.c \
-#	mm-plugin-nokia.h \
-#	mm-modem-nokia.c \
-#	mm-modem-nokia.h
-#libmm_plugin_nokia_la_CPPFLAGS = $(PLUGIN_COMMON_COMPILER_FLAGS)
-#libmm_plugin_nokia_la_LDFLAGS = $(PLUGIN_COMMON_LINKER_FLAGS)
-#
+
+# Nokia
+libmm_plugin_nokia_la_SOURCES = \
+	mm-plugin-nokia.c \
+	mm-plugin-nokia.h \
+	mm-broadband-modem-nokia.c \
+	mm-broadband-modem-nokia.h
+libmm_plugin_nokia_la_CPPFLAGS = $(PLUGIN_COMMON_COMPILER_FLAGS)
+libmm_plugin_nokia_la_LDFLAGS = $(PLUGIN_COMMON_LINKER_FLAGS)
+
 ## Zte
 #libmm_plugin_zte_la_SOURCES = \
 #	mm-plugin-zte.c \
diff --git a/plugins/mm-broadband-modem-nokia.c b/plugins/mm-broadband-modem-nokia.c
new file mode 100644
index 00000000..7c2c722d
--- /dev/null
+++ b/plugins/mm-broadband-modem-nokia.c
@@ -0,0 +1,135 @@
+/* -*- 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 - 2011 Red Hat, Inc.
+ * Copyright (C) 2011 Google Inc.
+ */
+
+#include <config.h>
+
+#include <stdlib.h>
+#include <stdio.h>
+#include <string.h>
+#include <unistd.h>
+#include <ctype.h>
+
+#include "ModemManager.h"
+#include "mm-serial-parsers.h"
+#include "mm-log.h"
+#include "mm-errors-types.h"
+#include "mm-iface-modem.h"
+#include "mm-base-modem-at.h"
+#include "mm-broadband-modem-nokia.h"
+
+static void iface_modem_init (MMIfaceModem *iface);
+
+G_DEFINE_TYPE_EXTENDED (MMBroadbandModemNokia, mm_broadband_modem_nokia, MM_TYPE_BROADBAND_MODEM, 0,
+                        G_IMPLEMENT_INTERFACE (MM_TYPE_IFACE_MODEM, iface_modem_init));
+
+/*****************************************************************************/
+/* MODEM INIT */
+
+static gboolean
+modem_init_finish (MMIfaceModem *self,
+                   GAsyncResult *res,
+                   GError **error)
+{
+    return !mm_base_modem_at_sequence_finish (MM_BASE_MODEM (self), res, NULL, error);
+}
+
+static const MMBaseModemAtCommand modem_init_sequence[] = {
+    /* Send the init command twice; some devices (Nokia N900) appear to take a
+     * few commands before responding correctly.  Instead of penalizing them for
+     * being stupid the first time by failing to enable the device, just
+     * try again.
+     *
+     * TODO: only send init command 2nd time if 1st time failed?
+     *
+     * Also, when initializing a Nokia phone, first enable the echo,
+     * and then disable it, so that we get it properly disabled.
+     */
+    { "Z E1 E0 V1", 3, FALSE, NULL },
+    { "Z E1 E0 V1", 3, FALSE, mm_base_modem_response_processor_no_result_continue },
+
+    /* Setup errors */
+    { "+CMEE=1", 3, FALSE, NULL },
+
+    /* Additional OPTIONAL initialization */
+    { "X4 &C1",  3, FALSE, NULL },
+
+    { NULL }
+};
+
+static void
+modem_init (MMIfaceModem *self,
+            GAsyncReadyCallback callback,
+            gpointer user_data)
+{
+    mm_base_modem_at_sequence (MM_BASE_MODEM (self),
+                               modem_init_sequence,
+                               NULL,  /* response_processor_context */
+                               NULL,  /* response_processor_context_free */
+                               NULL,  /* cancellable */
+                               callback,
+                               user_data);
+}
+
+/*****************************************************************************/
+
+MMBroadbandModemNokia *
+mm_broadband_modem_nokia_new (const gchar *device,
+                              const gchar *driver,
+                              const gchar *plugin,
+                              guint16 vendor_id,
+                              guint16 product_id)
+{
+    return g_object_new (MM_TYPE_BROADBAND_MODEM_NOKIA,
+                         MM_BASE_MODEM_DEVICE, device,
+                         MM_BASE_MODEM_DRIVER, driver,
+                         MM_BASE_MODEM_PLUGIN, plugin,
+                         MM_BASE_MODEM_VENDOR_ID, vendor_id,
+                         MM_BASE_MODEM_PRODUCT_ID, product_id,
+                         NULL);
+}
+
+static void
+mm_broadband_modem_nokia_init (MMBroadbandModemNokia *self)
+{
+}
+
+static void
+iface_modem_init (MMIfaceModem *iface)
+{
+    /* Setup custom modem init */
+    iface->modem_init = modem_init;
+    iface->modem_init_finish = modem_init_finish;
+
+    /* Nokia headsets (at least N85) do not support "power on"; they do
+     * support "power off" but you proabably do not want to turn off the
+     * power on your telephone if something went wrong with connecting
+     * process. So, disabling both these operations.  The Nokia GSM/UMTS command
+     * reference v1.2 also states that only CFUN=0 (turn off but still charge)
+     * and CFUN=1 (full functionality) are supported, and since the phone has
+     * to be in CFUN=1 before we'll be able to talk to it in the first place,
+     * we shouldn't bother with CFUN at all.
+     */
+    iface->modem_power_up = NULL;
+    iface->modem_power_up_finish = NULL;
+    iface->modem_power_down = NULL;
+    iface->modem_power_down_finish = NULL;
+}
+
+static void
+mm_broadband_modem_nokia_class_init (MMBroadbandModemNokiaClass *klass)
+{
+}
diff --git a/plugins/mm-broadband-modem-nokia.h b/plugins/mm-broadband-modem-nokia.h
new file mode 100644
index 00000000..9583d5ea
--- /dev/null
+++ b/plugins/mm-broadband-modem-nokia.h
@@ -0,0 +1,49 @@
+/* -*- 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 - 2011 Red Hat, Inc.
+ * Copyright (C) 2011 Google Inc.
+ */
+
+#ifndef MM_BROADBAND_MODEM_NOKIA_H
+#define MM_BROADBAND_MODEM_NOKIA_H
+
+#include "mm-broadband-modem.h"
+
+#define MM_TYPE_BROADBAND_MODEM_NOKIA            (mm_broadband_modem_nokia_get_type ())
+#define MM_BROADBAND_MODEM_NOKIA(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), MM_TYPE_BROADBAND_MODEM_NOKIA, MMBroadbandModemNokia))
+#define MM_BROADBAND_MODEM_NOKIA_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass),  MM_TYPE_BROADBAND_MODEM_NOKIA, MMBroadbandModemNokiaClass))
+#define MM_IS_BROADBAND_MODEM_NOKIA(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), MM_TYPE_BROADBAND_MODEM_NOKIA))
+#define MM_IS_BROADBAND_MODEM_NOKIA_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass),  MM_TYPE_BROADBAND_MODEM_NOKIA))
+#define MM_BROADBAND_MODEM_NOKIA_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj),  MM_TYPE_BROADBAND_MODEM_NOKIA, MMBroadbandModemNokiaClass))
+
+typedef struct _MMBroadbandModemNokia MMBroadbandModemNokia;
+typedef struct _MMBroadbandModemNokiaClass MMBroadbandModemNokiaClass;
+
+struct _MMBroadbandModemNokia {
+    MMBroadbandModem parent;
+};
+
+struct _MMBroadbandModemNokiaClass{
+    MMBroadbandModemClass parent;
+};
+
+GType mm_broadband_modem_nokia_get_type (void);
+
+MMBroadbandModemNokia *mm_broadband_modem_nokia_new (const gchar *device,
+                                                     const gchar *driver,
+                                                     const gchar *plugin,
+                                                     guint16 vendor_id,
+                                                     guint16 product_id);
+
+#endif /* MM_BROADBAND_MODEM_NOKIA_H */
diff --git a/plugins/mm-plugin-nokia.c b/plugins/mm-plugin-nokia.c
index 493400ca..76fbf8e4 100644
--- a/plugins/mm-plugin-nokia.c
+++ b/plugins/mm-plugin-nokia.c
@@ -11,197 +11,145 @@
  * GNU General Public License for more details:
  *
  * Copyright (C) 2008 - 2009 Novell, Inc.
- * Copyright (C) 2009 Red Hat, Inc.
+ * Copyright (C) 2009 - 2011 Red Hat, Inc.
+ * Copyright (C) 2011 Google, Inc.
  */
 
 #include <string.h>
 #include <gmodule.h>
+
+#include <mm-errors-types.h>
+
 #include "mm-plugin-nokia.h"
-#include "mm-modem-nokia.h"
-#include "mm-generic-cdma.h"
+#include "mm-broadband-modem-nokia.h"
 
 G_DEFINE_TYPE (MMPluginNokia, mm_plugin_nokia, MM_TYPE_PLUGIN_BASE)
 
 int mm_plugin_major_version = MM_PLUGIN_MAJOR_VERSION;
 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_NOKIA,
-                                    MM_PLUGIN_BASE_NAME, "Nokia",
-                                    NULL));
-}
-
 /*****************************************************************************/
-
-#define CAP_CDMA (MM_PLUGIN_BASE_PORT_CAP_IS707_A | \
-                  MM_PLUGIN_BASE_PORT_CAP_IS707_P | \
-                  MM_PLUGIN_BASE_PORT_CAP_IS856 | \
-                  MM_PLUGIN_BASE_PORT_CAP_IS856_A)
-
-static guint32
-get_level_for_capabilities (guint32 capabilities)
-{
-    if (capabilities & MM_PLUGIN_BASE_PORT_CAP_GSM)
-        return 10;
-    if (capabilities & CAP_CDMA)
-        return 10;
-    return 0;
-}
-
-static void
-probe_result (MMPluginBase *base,
-              MMPluginBaseSupportsTask *task,
-              guint32 capabilities,
-              gpointer user_data)
-{
-    mm_plugin_base_supports_task_complete (task, get_level_for_capabilities (capabilities));
-}
+/* CUSTOM INIT */
 
 static gboolean
-custom_init_response_cb (MMPluginBaseSupportsTask *task,
-                         GString *response,
-                         GError *error,
-                         guint32 tries,
-                         gboolean *out_stop,
-                         guint32 *out_level,
-                         gpointer user_data)
+parse_init_last (const gchar *response,
+                 const GError *error,
+                 GValue *result,
+                 GError **result_error)
 {
-    if (error)
-        return tries <= 4 ? TRUE : FALSE;
+    if (error) {
+        *result_error = g_error_copy (error);
+        return FALSE;
+    }
 
-    /* No error, assume success */
-    return FALSE;
+    /* Otherwise, done. And also report that it's an AT port. */
+    g_value_init (result, G_TYPE_BOOLEAN);
+    g_value_set_boolean (result, TRUE);
+    return TRUE;
 }
 
-static MMPluginSupportsResult
-supports_port (MMPluginBase *base,
-               MMModem *existing,
-               MMPluginBaseSupportsTask *task)
+static gboolean
+parse_init (const gchar *response,
+            const GError *error,
+            GValue *result,
+            GError **result_error)
 {
-    GUdevDevice *port;
-    const char *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);
-
-    if (!mm_plugin_base_get_device_ids (base, subsys, name, &vendor, NULL))
-        return MM_PLUGIN_SUPPORTS_PORT_UNSUPPORTED;
-
-    if (vendor != 0x0421)
-        return MM_PLUGIN_SUPPORTS_PORT_UNSUPPORTED;
-
-    /* Check if a previous probing was already launched in this port */
-    if (mm_plugin_base_supports_task_propagate_cached (task)) {
-        guint32 level;
-
-        /* A previous probing was already done, use its results */
-        level = get_level_for_capabilities (mm_plugin_base_supports_task_get_probed_capabilities (task));
-        if (level) {
-            mm_plugin_base_supports_task_complete (task, level);
-            return MM_PLUGIN_SUPPORTS_PORT_IN_PROGRESS;
-        }
-        return MM_PLUGIN_SUPPORTS_PORT_UNSUPPORTED;
+    if (error) {
+        /* On timeout, request to retry */
+        if (g_error_matches (error,
+                             MM_SERIAL_ERROR,
+                             MM_SERIAL_ERROR_RESPONSE_TIMEOUT))
+            return FALSE; /* Retry */
     }
 
-    mm_plugin_base_supports_task_add_custom_init_command (task,
-                                                          "ATE1 E0",
-                                                          3,
-                                                          custom_init_response_cb,
-                                                          NULL);
+    /* Otherwise, done. And also report that it's an AT port. */
+    g_value_init (result, G_TYPE_BOOLEAN);
+    g_value_set_boolean (result, TRUE);
+    return TRUE;
+}
 
-    /* Otherwise kick off a probe */
-    if (mm_plugin_base_probe_port (base, task, 100000, NULL))
-        return MM_PLUGIN_SUPPORTS_PORT_IN_PROGRESS;
+static const MMPortProbeAtCommand custom_init[] = {
+    { "ATE1 E0", parse_init },
+    { "ATE1 E0", parse_init },
+    { "ATE1 E0", parse_init_last },
+    { NULL }
+};
 
-    return MM_PLUGIN_SUPPORTS_PORT_UNSUPPORTED;
-}
+/*****************************************************************************/
 
-static MMModem *
+static MMBaseModem *
 grab_port (MMPluginBase *base,
-           MMModem *existing,
-           MMPluginBaseSupportsTask *task,
+           MMBaseModem *existing,
+           MMPortProbe *probe,
            GError **error)
 {
-    GUdevDevice *port = NULL;
-    MMModem *modem = NULL;
-    const char *name, *subsys, *devfile, *sysfs_path;
-    guint32 caps;
+    MMBaseModem *modem = NULL;
+    const gchar *name, *subsys, *driver;
     guint16 vendor = 0, product = 0;
-    MMPortType ptype;
-    MMAtPortFlags pflags = MM_AT_PORT_FLAG_NONE;
-
-    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.");
+    /* The Nokia plugin cannot do anything with non-AT ports */
+    if (!mm_port_probe_is_at (probe)) {
+        g_set_error (error, 0, 0, "Ignoring non-AT port");
         return NULL;
     }
 
-    subsys = g_udev_device_get_subsystem (port);
-    name = g_udev_device_get_name (port);
+    subsys = mm_port_probe_get_port_subsys (probe);
+    name = mm_port_probe_get_port_name (probe);
+    driver = mm_port_probe_get_port_driver (probe);
 
     if (!mm_plugin_base_get_device_ids (base, subsys, name, &vendor, &product)) {
         g_set_error (error, 0, 0, "Could not get modem product ID.");
         return NULL;
     }
 
-    /* Look for port type hints */
-    if (g_udev_device_get_property_as_boolean (port, "ID_MM_NOKIA_PORT_TYPE_MODEM"))
-        pflags = MM_AT_PORT_FLAG_PRIMARY;
-    else if (g_udev_device_get_property_as_boolean (port, "ID_MM_NOKIA_PORT_TYPE_AUX"))
-        pflags = MM_AT_PORT_FLAG_SECONDARY;
-
-    caps = mm_plugin_base_supports_task_get_probed_capabilities (task);
-    sysfs_path = mm_plugin_base_supports_task_get_physdev_path (task);
-    ptype = mm_plugin_base_probed_capabilities_to_port_type (caps);
-    if (!existing) {
-        if (caps & MM_PLUGIN_BASE_PORT_CAP_GSM) {
-            modem = mm_modem_nokia_new (sysfs_path,
-                                        mm_plugin_base_supports_task_get_driver (task),
-                                        mm_plugin_get_name (MM_PLUGIN (base)),
-                                        vendor,
-                                        product);
-        } else if (caps & CAP_CDMA) {
-            modem = mm_generic_cdma_new (sysfs_path,
-                                         mm_plugin_base_supports_task_get_driver (task),
-                                         mm_plugin_get_name (MM_PLUGIN (base)),
-                                         !!(caps & MM_PLUGIN_BASE_PORT_CAP_IS856),
-                                         !!(caps & MM_PLUGIN_BASE_PORT_CAP_IS856_A),
-                                         vendor,
-                                         product);
-        }
-
-        if (modem) {
-            if (!mm_modem_grab_port (modem, subsys, name, ptype, pflags, NULL, error)) {
-                g_object_unref (modem);
-                return NULL;
-            }
-        }
-    } else if (get_level_for_capabilities (caps)) {
-        modem = existing;
-        if (!mm_modem_grab_port (modem, subsys, name, ptype, pflags, NULL, error))
-            return NULL;
+    /* TODO: */
+    /* /\* Look for port type hints *\/ */
+    /* if (g_udev_device_get_property_as_boolean (port, "ID_MM_NOKIA_PORT_TYPE_MODEM")) */
+    /*     ptype = MM_PORT_TYPE_PRIMARY; */
+    /* else if (g_udev_device_get_property_as_boolean (port, "ID_MM_NOKIA_PORT_TYPE_AUX")) */
+    /*     ptype = MM_PORT_TYPE_SECONDARY; */
+
+    /* If this is the first port being grabbed, create a new modem object */
+    if (!existing)
+        modem = MM_BASE_MODEM (mm_broadband_modem_nokia_new (mm_port_probe_get_port_physdev (probe),
+                                                             driver,
+                                                             mm_plugin_get_name (MM_PLUGIN (base)),
+                                                             vendor,
+                                                             product));
+
+    if (!mm_base_modem_grab_port (existing ? existing : modem,
+                                  subsys,
+                                  name,
+                                  MM_PORT_TYPE_UNKNOWN)) {
+        if (modem)
+            g_object_unref (modem);
+        return NULL;
     }
 
-    return modem;
+    return existing ? existing : modem;
 }
 
 /*****************************************************************************/
 
+G_MODULE_EXPORT MMPlugin *
+mm_plugin_create (void)
+{
+    static const gchar *subsystems[] = { "tty", NULL };
+    static const guint16 vendor_ids[] = { 0x0421, 0 };
+
+    return MM_PLUGIN (
+        g_object_new (MM_TYPE_PLUGIN_NOKIA,
+                      MM_PLUGIN_BASE_NAME, "Nokia",
+                      MM_PLUGIN_BASE_ALLOWED_SUBSYSTEMS, subsystems,
+                      MM_PLUGIN_BASE_ALLOWED_VENDOR_IDS, vendor_ids,
+                      MM_PLUGIN_BASE_CUSTOM_INIT, custom_init,
+                      MM_PLUGIN_BASE_ALLOWED_AT, TRUE,
+                      NULL));
+}
+
 static void
 mm_plugin_nokia_init (MMPluginNokia *self)
 {
-    g_signal_connect (self, "probe-result", G_CALLBACK (probe_result), NULL);
 }
 
 static void
@@ -209,6 +157,5 @@ mm_plugin_nokia_class_init (MMPluginNokiaClass *klass)
 {
     MMPluginBaseClass *pb_class = MM_PLUGIN_BASE_CLASS (klass);
 
-    pb_class->supports_port = supports_port;
     pb_class->grab_port = grab_port;
 }