iridium: add initial dummy plugin

7 files changed, 398 insertions, 1 deletions

diff --git a/plugins/Makefile.am b/plugins/Makefile.am
index a026c242..7c33684d 100644
--- a/plugins/Makefile.am
+++ b/plugins/Makefile.am
@@ -40,7 +40,8 @@ pkglib_LTLIBRARIES = \
 	libmm-plugin-linktop.la \
 	libmm-plugin-samsung.la \
 	libmm-plugin-wavecom.la \
-	libmm-plugin-cinterion.la
+	libmm-plugin-cinterion.la \
+	libmm-plugin-iridium.la
 
 # Generic
 
@@ -439,6 +440,25 @@ libmm_plugin_cinterion_la_LDFLAGS = \
 	-module \
 	-avoid-version
 
+# Iridium satellite modem
+
+libmm_plugin_iridium_la_SOURCES = \
+	mm-plugin-iridium.c \
+	mm-plugin-iridium.h \
+	mm-modem-iridium-gsm.c \
+	mm-modem-iridium-gsm.h
+
+libmm_plugin_iridium_la_CPPFLAGS = \
+	$(MM_CFLAGS) \
+	$(GUDEV_CFLAGS) \
+	-I$(top_srcdir)/src \
+	-I$(top_srcdir)/include
+
+libmm_plugin_iridium_la_LDFLAGS = \
+	$(GUDEV_LDFLAGS) \
+	-module \
+	-avoid-version
+
 udevrulesdir = $(UDEV_BASE_DIR)/rules.d
 udevrules_DATA = \
 	77-mm-ericsson-mbm.rules \
diff --git a/plugins/mm-modem-iridium-gsm.c b/plugins/mm-modem-iridium-gsm.c
new file mode 100644
index 00000000..4619fa4b
--- /dev/null
+++ b/plugins/mm-modem-iridium-gsm.c
@@ -0,0 +1,64 @@
+/* -*- 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) 2011 Ammonit Measurement GmbH
+ * Author: Aleksander Morgado <aleksander@lanedo.com>
+ */
+
+#include <config.h>
+
+#include <stdlib.h>
+#include <stdio.h>
+#include <string.h>
+#include <unistd.h>
+#include <ctype.h>
+
+#include "mm-errors.h"
+#include "mm-modem-helpers.h"
+#include "mm-modem-iridium-gsm.h"
+#include "mm-log.h"
+
+G_DEFINE_TYPE (MMModemIridiumGsm, mm_modem_iridium_gsm, MM_TYPE_GENERIC_GSM);
+
+MMModem *
+mm_modem_iridium_gsm_new (const char *device,
+                          const char *driver,
+                          const char *plugin,
+                          guint32 vendor,
+                          guint32 product)
+{
+    g_return_val_if_fail (device != NULL, NULL);
+    g_return_val_if_fail (driver != NULL, NULL);
+    g_return_val_if_fail (plugin != NULL, NULL);
+
+    return MM_MODEM (g_object_new (MM_TYPE_MODEM_IRIDIUM_GSM,
+                                   MM_MODEM_MASTER_DEVICE, device,
+                                   MM_MODEM_DRIVER, driver,
+                                   MM_MODEM_PLUGIN, plugin,
+                                   MM_MODEM_HW_VID, vendor,
+                                   MM_MODEM_HW_PID, product,
+                                   MM_MODEM_BASE_MAX_TIMEOUTS, 3,
+                                   NULL));
+}
+
+/*****************************************************************************/
+
+static void
+mm_modem_iridium_gsm_init (MMModemIridiumGsm *self)
+{
+}
+
+static void
+mm_modem_iridium_gsm_class_init (MMModemIridiumGsmClass *klass)
+{
+}
+
diff --git a/plugins/mm-modem-iridium-gsm.h b/plugins/mm-modem-iridium-gsm.h
new file mode 100644
index 00000000..22a8cd32
--- /dev/null
+++ b/plugins/mm-modem-iridium-gsm.h
@@ -0,0 +1,45 @@
+/* -*- 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) 2011 Ammonit Measurement GmbH
+ * Author: Aleksander Morgado <aleksander@lanedo.com>
+ */
+
+#ifndef MM_MODEM_IRIDIUM_GSM_H
+#define MM_MODEM_IRIDIUM_GSM_H
+
+#include "mm-generic-gsm.h"
+
+#define MM_TYPE_MODEM_IRIDIUM_GSM            (mm_modem_iridium_gsm_get_type ())
+#define MM_MODEM_IRIDIUM_GSM(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), MM_TYPE_MODEM_IRIDIUM_GSM, MMModemIridiumGsm))
+#define MM_MODEM_IRIDIUM_GSM_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass),  MM_TYPE_MODEM_IRIDIUM_AIRLINK_GSM, MMModemIridiumGsmClass))
+#define MM_IS_MODEM_IRIDIUM_GSM(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), MM_TYPE_MODEM_IRIDIUM_AIRLINK_GSM))
+#define MM_IS_MODEM_IRIDIUM_GSM_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass),  MM_TYPE_MODEM_IRIDIUM_AIRLINK_GSM))
+#define MM_MODEM_IRIDIUM_GSM_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj),  MM_TYPE_MODEM_IRIDIUM_AIRLINK_GSM, MMModemIridiumGsmClass))
+
+typedef struct {
+    MMGenericGsm parent;
+} MMModemIridiumGsm;
+
+typedef struct {
+    MMGenericGsmClass parent;
+} MMModemIridiumGsmClass;
+
+GType mm_modem_iridium_gsm_get_type (void);
+
+MMModem *mm_modem_iridium_gsm_new (const char *device,
+                                   const char *driver,
+                                   const char *plugin_name,
+                                   guint32 vendor,
+                                   guint32 product);
+
+#endif /* MM_MODEM_IRIDIUM_GSM_H */
diff --git a/plugins/mm-plugin-iridium.c b/plugins/mm-plugin-iridium.c
new file mode 100644
index 00000000..8b94161f
--- /dev/null
+++ b/plugins/mm-plugin-iridium.c
@@ -0,0 +1,218 @@
+/* -*- 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.
+ *
+ * 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., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ *
+ * Copyright (C) 2011 Ammonit Measurement GmbH
+ * Author: Aleksander Morgado <aleksander@lanedo.com>
+ */
+
+#include <string.h>
+#include <gmodule.h>
+#include "mm-plugin-iridium.h"
+#include "mm-modem-iridium-gsm.h"
+#include "mm-log.h"
+
+G_DEFINE_TYPE (MMPluginIridium, mm_plugin_iridium, 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_IRIDIUM,
+                                    MM_PLUGIN_BASE_NAME, "Iridium",
+                                    MM_PLUGIN_BASE_SORT_LAST, TRUE,
+                                    NULL));
+}
+
+static guint32
+get_level_for_capabilities (guint32 capabilities)
+{
+    if (capabilities & MM_PLUGIN_BASE_PORT_CAP_GSM &&
+        capabilities & MM_PLUGIN_BASE_PORT_CAP_IRIDIUM)
+        return 10;
+    return 0;
+}
+
+static gboolean
+check_vendor_iridium (MMPluginBaseSupportsTask *task)
+{
+    MMPluginBase *base;
+    GUdevDevice *port;
+    const char *subsys, *name;
+    guint16 vendor = 0;
+
+    base = MM_PLUGIN_BASE (mm_plugin_base_supports_task_get_plugin (task));
+    port = mm_plugin_base_supports_task_get_port (task);
+
+    /* Try to get device IDs from udev. Note that it is not an error
+     * if we can't get them in our case, as we also support serial
+     * modems. */
+    subsys = g_udev_device_get_subsystem (port);
+    name = g_udev_device_get_name (port);
+    mm_plugin_base_get_device_ids (base, subsys, name, &vendor, NULL);
+
+    /* Vendors: Iridium (0x1edd)*/
+    if (vendor == 0x1edd) {
+        mm_dbg ("Iridium USB modem detected");
+        return TRUE;
+    }
+
+    /* We may get Iridium modems connected in RS232 port, try to get
+     * probed Vendor ID string to check */
+    if (mm_plugin_base_supports_task_propagate_cached (task)) {
+        const gchar *probed_vendor;
+        gchar *probed_vendor_strdown;
+        gboolean probed_vendor_correct = FALSE;
+
+        probed_vendor = mm_plugin_base_supports_task_get_probed_vendor (task);
+        if (!probed_vendor)
+            return FALSE;
+
+        /* Lowercase the vendor string and compare */
+        probed_vendor_strdown = g_utf8_strdown (probed_vendor, -1);
+        if (strstr (probed_vendor_strdown, "iridium")) {
+            mm_dbg ("Iridium RS232 modem detected");
+            probed_vendor_correct = TRUE;
+        }
+
+        g_free (probed_vendor_strdown);
+
+        return probed_vendor_correct;
+    }
+
+    return FALSE;
+}
+
+static void
+probe_result (MMPluginBase *base,
+              MMPluginBaseSupportsTask *task,
+              guint32 capabilities,
+              gpointer user_data)
+{
+    /* Note: the signal contains only capabilities, but we can also query the
+     * probed vendor and product strings here. */
+
+    /* Check vendor */
+    mm_plugin_base_supports_task_complete (task,
+                                           (check_vendor_iridium (task) ?
+                                            get_level_for_capabilities (capabilities) : 0));
+}
+
+static MMPluginSupportsResult
+supports_port (MMPluginBase *base,
+               MMModem *existing,
+               MMPluginBaseSupportsTask *task)
+{
+    GUdevDevice *port;
+    guint32 cached = 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;
+
+    /* First thing to check in this plugin is if we got capabilities already.
+     * This is because we have a later check of the probed vendor, which is
+     * taken also during port probing.
+     * Note that we also relaunch a port probe if we got a cached value but no
+     * capabilities set (used when trying to detect RS232 modems during
+     * re-scans). */
+    if (!mm_plugin_base_supports_task_propagate_cached (task) ||
+        !mm_plugin_base_supports_task_get_probed_capabilities (task)) {
+        /* Kick off a probe */
+        if (mm_plugin_base_probe_port (base, task, 100000, NULL))
+            return MM_PLUGIN_SUPPORTS_PORT_IN_PROGRESS;
+
+        return MM_PLUGIN_SUPPORTS_PORT_UNSUPPORTED;
+    }
+
+    /* Check vendor */
+    if (!check_vendor_iridium (task))
+        return MM_PLUGIN_SUPPORTS_PORT_UNSUPPORTED;
+
+    /* Completed! */
+    mm_plugin_base_supports_task_complete (task, get_level_for_capabilities (cached));
+    return MM_PLUGIN_SUPPORTS_PORT_IN_PROGRESS;
+}
+
+static MMModem *
+grab_port (MMPluginBase *base,
+           MMModem *existing,
+           MMPluginBaseSupportsTask *task,
+           GError **error)
+{
+    GUdevDevice *port = NULL;
+    MMModem *modem = NULL;
+    const char *name, *subsys, *sysfs_path;
+    guint32 caps;
+    guint16 vendor = 0x1e2d;
+    guint16 product = 0;
+
+    port = mm_plugin_base_supports_task_get_port (task);
+    g_assert (port);
+
+    /* Try to get Product IDs from udev. Note that it is not an error
+     * if we can't get them in our case, as we also support serial
+     * modems. */
+    subsys = g_udev_device_get_subsystem (port);
+    name = g_udev_device_get_name (port);
+    mm_plugin_base_get_device_ids (base, subsys, name, NULL, &product);
+
+    caps = mm_plugin_base_supports_task_get_probed_capabilities (task);
+    sysfs_path = mm_plugin_base_supports_task_get_physdev_path (task);
+    if (!existing) {
+        if (caps & MM_PLUGIN_BASE_PORT_CAP_GSM) {
+            modem = mm_modem_iridium_gsm_new (sysfs_path,
+                                              mm_plugin_base_supports_task_get_driver (task),
+                                              mm_plugin_get_name (MM_PLUGIN (base)),
+                                              vendor,
+                                              product);
+        }
+
+        if (modem) {
+            if (!mm_modem_grab_port (modem, subsys, name, MM_PORT_TYPE_UNKNOWN, 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, MM_PORT_TYPE_UNKNOWN, NULL, error))
+            return NULL;
+    }
+
+    return modem;
+}
+
+/*****************************************************************************/
+
+static void
+mm_plugin_iridium_init (MMPluginIridium *self)
+{
+    g_signal_connect (self, "probe-result", G_CALLBACK (probe_result), NULL);
+}
+
+static void
+mm_plugin_iridium_class_init (MMPluginIridiumClass *klass)
+{
+    MMPluginBaseClass *pb_class = MM_PLUGIN_BASE_CLASS (klass);
+
+    pb_class->supports_port = supports_port;
+    pb_class->grab_port = grab_port;
+}
diff --git a/plugins/mm-plugin-iridium.h b/plugins/mm-plugin-iridium.h
new file mode 100644
index 00000000..696b3a2d
--- /dev/null
+++ b/plugins/mm-plugin-iridium.h
@@ -0,0 +1,48 @@
+/* -*- 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.
+ *
+ * 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., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ *
+ * Copyright (C) 2011 Ammonit Measurement GmbH
+ * Author: Aleksander Morgado <aleksander@lanedo.com>
+ */
+
+#ifndef MM_PLUGIN_IRIDIUM_H
+#define MM_PLUGIN_IRIDIUM_H
+
+#include "mm-plugin-base.h"
+#include "mm-generic-gsm.h"
+
+#define MM_TYPE_PLUGIN_IRIDIUM            (mm_plugin_iridium_get_type ())
+#define MM_PLUGIN_IRIDIUM(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), MM_TYPE_PLUGIN_IRIDIUM, MMPluginIridium))
+#define MM_PLUGIN_IRIDIUM_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass),  MM_TYPE_PLUGIN_IRIDIUM, MMPluginIridiumClass))
+#define MM_IS_PLUGIN_IRIDIUM(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), MM_TYPE_PLUGIN_IRIDIUM))
+#define MM_IS_PLUGIN_IRIDIUM_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass),  MM_TYPE_PLUGIN_IRIDIUM))
+#define MM_PLUGIN_IRIDIUM_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj),  MM_TYPE_PLUGIN_IRIDIUM, MMPluginIridiumClass))
+
+typedef struct {
+    MMPluginBase parent;
+} MMPluginIridium;
+
+typedef struct {
+    MMPluginBaseClass parent;
+} MMPluginIridiumClass;
+
+GType mm_plugin_iridium_get_type (void);
+
+G_MODULE_EXPORT MMPlugin *mm_plugin_create (void);
+
+#endif /* MM_PLUGIN_IRIDIUM_H */
diff --git a/src/mm-plugin-base.c b/src/mm-plugin-base.c
index e9591236..2c56c7b4 100644
--- a/src/mm-plugin-base.c
+++ b/src/mm-plugin-base.c
@@ -444,6 +444,7 @@ static struct modem_caps modem_caps[] = {
 	{"+ES",       MM_PLUGIN_BASE_PORT_CAP_ES},
 	{"+MS",       MM_PLUGIN_BASE_PORT_CAP_MS},
 	{"+FCLASS",   MM_PLUGIN_BASE_PORT_CAP_FCLASS},
+    {"+WIRIDIUM", MM_PLUGIN_BASE_PORT_CAP_IRIDIUM},
 	{NULL}
 };
 
diff --git a/src/mm-plugin-base.h b/src/mm-plugin-base.h
index 5b049a48..48bec97e 100644
--- a/src/mm-plugin-base.h
+++ b/src/mm-plugin-base.h
@@ -38,6 +38,7 @@
 #define MM_PLUGIN_BASE_PORT_CAP_IS856_A     0x0200 /* CDMA 3G EVDO rev A */
 #define MM_PLUGIN_BASE_PORT_CAP_QCDM        0x0400 /* QCDM-capable port */
 #define MM_PLUGIN_BASE_PORT_CAP_AT          0x0800 /* Responds to AT commands */
+#define MM_PLUGIN_BASE_PORT_CAP_IRIDIUM     0x1000 /* Iridium */
 
 #define MM_TYPE_PLUGIN_BASE_SUPPORTS_TASK            (mm_plugin_base_supports_task_get_type ())
 #define MM_PLUGIN_BASE_SUPPORTS_TASK(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), MM_TYPE_PLUGIN_BASE_SUPPORTS_TASK, MMPluginBaseSupportsTask))