From a74523feabab7b917f74318a4459c23275131359 Mon Sep 17 00:00:00 2001 From: Aleksander Morgado Date: Wed, 11 Jul 2012 17:24:56 +0200 Subject: [PATCH] x22x: start porting the X22X plugin --- plugins/Makefile.am | 21 +- .../{ => x22x}/77-mm-x22x-port-types.rules | 0 plugins/x22x/mm-plugin-x22x.c | 274 ++++++++++++++++++ plugins/x22x/mm-plugin-x22x.h | 42 +++ 4 files changed, 326 insertions(+), 11 deletions(-) rename plugins/{ => x22x}/77-mm-x22x-port-types.rules (100%) create mode 100644 plugins/x22x/mm-plugin-x22x.c create mode 100644 plugins/x22x/mm-plugin-x22x.h diff --git a/plugins/Makefile.am b/plugins/Makefile.am index 1362cb4b..b2c8d3fd 100644 --- a/plugins/Makefile.am +++ b/plugins/Makefile.am @@ -50,7 +50,8 @@ pkglib_LTLIBRARIES = \ libmm-plugin-simtech.la \ libmm-plugin-wavecom.la \ libmm-plugin-huawei.la \ - libmm-plugin-longcheer.la + libmm-plugin-longcheer.la \ + libmm-plugin-x22x.la #pkglib_LTLIBRARIES = \ # libmm-plugin-generic.la \ @@ -228,16 +229,14 @@ libmm_plugin_simtech_la_CPPFLAGS = $(PLUGIN_COMMON_COMPILER_FLAGS) libmm_plugin_simtech_la_LDFLAGS = $(PLUGIN_COMMON_LINKER_FLAGS) udevrules_DATA += simtech/77-mm-simtech-port-types.rules -# -## Alcatel/TCT/JRD x220D and possibly others -#libmm_plugin_x22x_la_SOURCES = \ -# mm-plugin-x22x.c \ -# mm-plugin-x22x.h \ -# mm-modem-x22x-gsm.c \ -# mm-modem-x22x-gsm.h -#libmm_plugin_x22x_la_CPPFLAGS = $(PLUGIN_COMMON_COMPILER_FLAGS) -#libmm_plugin_x22x_la_LDFLAGS = $(PLUGIN_COMMON_LINKER_FLAGS) -# +# Alcatel/TCT/JRD x220D and possibly others +libmm_plugin_x22x_la_SOURCES = \ + x22x/mm-plugin-x22x.c \ + x22x/mm-plugin-x22x.h +libmm_plugin_x22x_la_CPPFLAGS = $(PLUGIN_COMMON_COMPILER_FLAGS) +libmm_plugin_x22x_la_LDFLAGS = $(PLUGIN_COMMON_LINKER_FLAGS) +udevrules_DATA += x22x/77-mm-x22x-port-types.rules + ## Samsung modem #libmm_plugin_samsung_la_SOURCES = \ # mm-plugin-samsung.c \ diff --git a/plugins/77-mm-x22x-port-types.rules b/plugins/x22x/77-mm-x22x-port-types.rules similarity index 100% rename from plugins/77-mm-x22x-port-types.rules rename to plugins/x22x/77-mm-x22x-port-types.rules diff --git a/plugins/x22x/mm-plugin-x22x.c b/plugins/x22x/mm-plugin-x22x.c new file mode 100644 index 00000000..e20e41fc --- /dev/null +++ b/plugins/x22x/mm-plugin-x22x.c @@ -0,0 +1,274 @@ +/* -*- 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 - 2012 Red Hat, Inc. + * Copyright (C) 2012 Aleksander Morgado + */ + +#include +#include + +#include + +#include "mm-log.h" +#include "mm-modem-helpers.h" +#include "mm-plugin-x22x.h" +#include "mm-broadband-modem.h" + +G_DEFINE_TYPE (MMPluginX22x, mm_plugin_x22x, MM_TYPE_PLUGIN) + +int mm_plugin_major_version = MM_PLUGIN_MAJOR_VERSION; +int mm_plugin_minor_version = MM_PLUGIN_MINOR_VERSION; + +/*****************************************************************************/ +/* Custom init */ + +typedef struct { + MMPortProbe *probe; + MMAtSerialPort *port; + GCancellable *cancellable; + GSimpleAsyncResult *result; + guint retries; +} X22xCustomInitContext; + +static void +x22x_custom_init_context_complete_and_free (X22xCustomInitContext *ctx) +{ + g_simple_async_result_complete_in_idle (ctx->result); + + if (ctx->cancellable) + g_object_unref (ctx->cancellable); + g_object_unref (ctx->port); + g_object_unref (ctx->probe); + g_object_unref (ctx->result); + g_slice_free (X22xCustomInitContext, ctx); +} + +static gboolean +x22x_custom_init_finish (MMPortProbe *probe, + GAsyncResult *result, + GError **error) +{ + return !g_simple_async_result_propagate_error (G_SIMPLE_ASYNC_RESULT (result), error); +} + +static void x22x_custom_init_step (X22xCustomInitContext *ctx); + +static void +gmr_ready (MMAtSerialPort *port, + GString *response, + GError *error, + X22xCustomInitContext *ctx) +{ + const gchar *p; + + if (error) { + /* Just retry... */ + x22x_custom_init_step (ctx); + return; + } + + /* Note the lack of a ':' on the GMR; the X200 doesn't send one */ + p = mm_strip_tag (response->str, "AT+GMR"); + if (p && *p != 'L') { + /* X200 modems have a GMR firmware revision that starts with 'L', and + * as far as I can tell X060s devices have a revision starting with 'C'. + * So use that to determine if the device is an X200, which this plugin + * does supports. + */ + g_simple_async_result_set_error (ctx->result, + MM_CORE_ERROR, + MM_CORE_ERROR_UNSUPPORTED, + "Not supported with the X22X plugin"); + } else { + mm_dbg ("(X22X) device is supported by this plugin"); + g_simple_async_result_set_op_res_gboolean (ctx->result, TRUE); + } + + x22x_custom_init_context_complete_and_free (ctx); +} + +static void +x22x_custom_init_step (X22xCustomInitContext *ctx) +{ + /* If cancelled, end */ + if (g_cancellable_is_cancelled (ctx->cancellable)) { + mm_dbg ("(X22X) no need to keep on running custom init in (%s)", + mm_port_get_device (MM_PORT (ctx->port))); + g_simple_async_result_set_error (ctx->result, + MM_CORE_ERROR, + MM_CORE_ERROR_CANCELLED, + "Custom initialization cancelled"); + x22x_custom_init_context_complete_and_free (ctx); + return; + } + + if (ctx->retries == 0) { + /* In this case, we need the AT command result to decide whether we can + * support this modem or not, so really fail if we didn't get it. */ + g_simple_async_result_set_error (ctx->result, + MM_CORE_ERROR, + MM_CORE_ERROR_FAILED, + "Couldn't get device revision information"); + x22x_custom_init_context_complete_and_free (ctx); + return; + } + + ctx->retries--; + mm_at_serial_port_queue_command ( + ctx->port, + "AT+GMR", + 3, + ctx->cancellable, + (MMAtSerialResponseFn)gmr_ready, + ctx); +} + +static void +x22x_custom_init (MMPortProbe *probe, + MMAtSerialPort *port, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) +{ + MMDevice *device; + X22xCustomInitContext *ctx; + + ctx = g_slice_new (X22xCustomInitContext); + ctx->result = g_simple_async_result_new (G_OBJECT (probe), + callback, + user_data, + x22x_custom_init); + ctx->probe = g_object_ref (probe); + ctx->port = g_object_ref (port); + ctx->cancellable = cancellable ? g_object_ref (cancellable) : NULL; + ctx->retries = 3; + + /* TCT/Alcatel in their infinite wisdom assigned the same USB VID/PID to + * the x060s (Longcheer firmware) and the x200 (X22X, this plugin) and thus + * we can't tell them apart via udev rules. Worse, they both report the + * same +GMM and +GMI, so we're left with just +GMR which is a sketchy way + * to tell modems apart. We can't really use X22X-specific commands + * like AT+SSND because we're not sure if they work when the SIM PIN has not + * been entered yet; many modems have a limited command parser before the + * SIM is unlocked. + */ + device = mm_port_probe_peek_device (probe); + if (mm_device_get_vendor (device) != 0x1bbb || + mm_device_get_product (device) != 0x0000) { + /* If not exactly this vendor/product, just skip */ + g_simple_async_result_set_op_res_gboolean (ctx->result, TRUE); + x22x_custom_init_context_complete_and_free (ctx); + return; + } + + x22x_custom_init_step (ctx); +} + +/*****************************************************************************/ + +static MMBaseModem * +create_modem (MMPlugin *self, + const gchar *sysfs_path, + const gchar *driver, + guint16 vendor, + guint16 product, + GList *probes, + GError **error) +{ + return MM_BASE_MODEM (mm_broadband_modem_new (sysfs_path, + driver, + mm_plugin_get_name (self), + vendor, + product)); +} + +static gboolean +grab_port (MMPlugin *self, + MMBaseModem *modem, + MMPortProbe *probe, + GError **error) +{ + GUdevDevice *port; + MMPortType ptype; + MMAtPortFlag pflags = MM_AT_PORT_FLAG_NONE; + + port = mm_port_probe_peek_port (probe); + ptype = mm_port_probe_get_port_type (probe); + + /* Look for port type hints; just probing can't distinguish which port should + * be the data/primary port on these devices. We have to tag them based on + * what the Windows .INF files say the port layout should be. + */ + if (g_udev_device_get_property_as_boolean (port, "ID_MM_X22X_PORT_TYPE_MODEM")) + pflags = MM_AT_PORT_FLAG_PRIMARY; + else if (g_udev_device_get_property_as_boolean (port, "ID_MM_X22X_PORT_TYPE_AUX")) + pflags = MM_AT_PORT_FLAG_SECONDARY; + else { + /* If the port was tagged by the udev rules but isn't a primary or secondary, + * then ignore it to guard against race conditions if a device just happens + * to show up with more than two AT-capable ports. + */ + ptype = MM_PORT_TYPE_IGNORED; + } + + return mm_base_modem_grab_port (modem, + mm_port_probe_get_port_subsys (probe), + mm_port_probe_get_port_name (probe), + ptype, + pflags, + error); +} + +/*****************************************************************************/ + +G_MODULE_EXPORT MMPlugin * +mm_plugin_create (void) +{ + static const gchar *subsystems[] = { "tty", NULL }; + /* Vendors: X22x and TAMobile */ + static const guint16 vendor_ids[] = { 0x1bbb, 0 }; + /* Only handle X22X tagged devices here. */ + static const gchar *udev_tags[] = { + "ID_MM_X22X_TAGGED", + NULL + }; + static const MMAsyncMethod custom_init = { + .async = G_CALLBACK (x22x_custom_init), + .finish = G_CALLBACK (x22x_custom_init_finish), + }; + + return MM_PLUGIN ( + g_object_new (MM_TYPE_PLUGIN_X22X, + MM_PLUGIN_NAME, "X22X", + MM_PLUGIN_ALLOWED_SUBSYSTEMS, subsystems, + MM_PLUGIN_ALLOWED_VENDOR_IDS, vendor_ids, + MM_PLUGIN_ALLOWED_AT, TRUE, + MM_PLUGIN_ALLOWED_UDEV_TAGS, udev_tags, + MM_PLUGIN_CUSTOM_INIT, &custom_init, + NULL)); +} + +static void +mm_plugin_x22x_init (MMPluginX22x *self) +{ +} + +static void +mm_plugin_x22x_class_init (MMPluginX22xClass *klass) +{ + MMPluginClass *plugin_class = MM_PLUGIN_CLASS (klass); + + plugin_class->create_modem = create_modem; + plugin_class->grab_port = grab_port; +} diff --git a/plugins/x22x/mm-plugin-x22x.h b/plugins/x22x/mm-plugin-x22x.h new file mode 100644 index 00000000..bea588c6 --- /dev/null +++ b/plugins/x22x/mm-plugin-x22x.h @@ -0,0 +1,42 @@ +/* -*- 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 - 2012 Red Hat, Inc. + * Copyright (C) 2012 Aleksander Morgado + */ + +#ifndef MM_PLUGIN_X22X_H +#define MM_PLUGIN_X22X_H + +#include "mm-plugin.h" + +#define MM_TYPE_PLUGIN_X22X (mm_plugin_x22x_get_type ()) +#define MM_PLUGIN_X22X(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), MM_TYPE_PLUGIN_X22X, MMPluginX22x)) +#define MM_PLUGIN_X22X_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), MM_TYPE_PLUGIN_X22X, MMPluginX22xClass)) +#define MM_IS_PLUGIN_X22X(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), MM_TYPE_PLUGIN_X22X)) +#define MM_IS_PLUGIN_X22X_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), MM_TYPE_PLUGIN_X22X)) +#define MM_PLUGIN_X22X_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), MM_TYPE_PLUGIN_X22X, MMPluginX22xClass)) + +typedef struct { + MMPlugin parent; +} MMPluginX22x; + +typedef struct { + MMPluginClass parent; +} MMPluginX22xClass; + +GType mm_plugin_x22x_get_type (void); + +G_MODULE_EXPORT MMPlugin *mm_plugin_create (void); + +#endif /* MM_PLUGIN_X22X_H */