Skip to contentSkip to conversation

SIMCOM plugin driver

PATCH In review Anthony Viallard 2 participants 8 messages Mar 22, 2013 – Apr 2, 2013 Kbuild

lore
Share & tools
lore
#0 lore raw

PATCH 1/4 SIMCOM plugin driver

Add SIMCOM support.

Implemented using SIM5216E module and ofono 1.12.

- based on SIM5215_SIM5216_ATC_V1.18.pdf documentation ;
- SMS and GPRS work (in the same time) ;
- SIM card presence check ;
- use GSM charset ;
- use 115200bps, 8 bit data, no parity, 1 bit stop, no data stream control for tty configuration ;
- flight mode support ;
- No voice part (because I can't test it).

Makefile.am +3 -0
@@ -371,6 +371,9 @@ builtin_sources += plugins/samsung.c
 builtin_modules += sim900
 builtin_sources += plugins/sim900.c
 
+builtin_modules += simcom
+builtin_sources += plugins/simcom.c
+
 if BLUETOOTH
 builtin_modules += bluetooth
 builtin_sources += plugins/bluetooth.c plugins/bluetooth.h
plugins/simcom.c new file +434 -0

434 lines not on this page · raw message

#1 lore raw

PATCH 2/4 SIMCOM AT+CNMI quirk

Add a quirk for AT+CNMI command building.

Use mode=1 otherwise it fails (ref. SIM5215_SIM5216_ATC_V1.18.pdf - ��6.9)

drivers/atmodem/sms.c +1 -0
@@ -805,6 +807,7 @@ static gboolean build_cnmi_string(char *
 	case OFONO_VENDOR_NOVATEL:
 	case OFONO_VENDOR_HUAWEI:
 	case OFONO_VENDOR_ZTE:
+	case OFONO_VENDOR_SIMCOM:
 		/* MSM devices advertise support for mode 2, but return an
 		 * error if we attempt to actually use it. */
 		mode = "1";
#2 lore raw

Re: [PATCH 2/4] SIMCOM AT+CNMI quirk

Hi Anthony,

Quoted 4 lines · Anthony Viallard

Add a quirk for AT+CNMI command building.

Use mode=1 otherwise it fails (ref. SIM5215_SIM5216_ATC_V1.18.pdf - §6.9)

You might want to quote the relevant section in the patch description. Otherwise it looks good to me, but I still can't apply it. Please use git send-email.

Quoted 13 lines
drivers/atmodem/sms.c +1 -0
@@ -805,6 +807,7 @@ static gboolean build_cnmi_string(char *
  	case OFONO_VENDOR_NOVATEL:
  	case OFONO_VENDOR_HUAWEI:
  	case OFONO_VENDOR_ZTE:
+	case OFONO_VENDOR_SIMCOM:
  		/* MSM devices advertise support for mode 2, but return an
  		 * error if we attempt to actually use it. */
  		mode = "1";
Quoted 4 lines

_______________________________________________
ofono mailing list
ofono(a)ofono.org
http://lists.ofono.org/listinfo/ofono

Regards,
-Denis

#3 lore raw

PATCH 3/4 SIMCOM SIM card ready quirk

In reply to Anthony Viallard

Add a quirk for waiting SIM availability.

SIM is busy right after pin is entered. Use the quirk which add a CPIN? pooling check until having "CPIN: READY" answer.

drivers/atmodem/sim.c +6 -0
diff -pruN ofono-1.12.orig/drivers/atmodem/sim.c ofono-1.12/drivers/atmodem/sim.c
@@ -1023,12 +1023,18 @@ static void at_pin_send_cb(gboolean ok,
 							FALSE, cbd, g_free);
 		return;
 	case OFONO_VENDOR_ZTE:
 	case OFONO_VENDOR_ALCATEL:
 	case OFONO_VENDOR_HUAWEI:
+	case OFONO_VENDOR_SIMCOM:
 		/*
 		 * On ZTE modems, after pin is entered, SIM state is checked
 		 * by polling CPIN as their modem doesn't provide unsolicited
 		 * notification of SIM readiness.
+		 *
+		 * On SIMCOM modems, SIM is busy after pin is entered (we've
+		 * got an "+CME ERROR: 14" at "AT+CPIN?" request) and ofono
+		 * don't catch the "+CPIN: READY" message sent by the modem
+		 * when SIM is ready. So, use extra CPIN to check the state.
 		 */
 		sd->sim_state_query = at_util_sim_state_query_new(sd->chat,
 						2, 20, sim_state_cb, cbd,
#4 lore raw

Re: [PATCH 3/4] SIMCOM SIM card ready quirk

Hi Anthony,

Quoted 5 lines · Anthony Viallard

Add a quirk for waiting SIM availability.

SIM is busy right after pin is entered. Use the quirk which add a CPIN? pooling check until having "CPIN: READY" answer.

Patch has been applied, thanks.

Regards,
-Denis

#5 lore raw

PATCH 4/4 SIMCOM signal strength reporting quirk

In reply to Anthony Viallard

Add a quirk for signal strength reporting.

We must tell we want the signal strength reporting using AT+AUTOCSQ command (ref. SIM5215_SIM5216_ATC_V1.18.pdf - ��10.7).

drivers/atmodem/network-registration.c +8 -1
diff -purN ofono-1.12/drivers/atmodem/network-registration.c ofono-patched/drivers/atmodem/network-registration.c
@@ -1411,6 +1411,14 @@ static void at_creg_set_cb(gboolean ok,
 	}
 
 	switch (nd->vendor) {
+	case OFONO_VENDOR_SIMCOM:
+		/* Register for CSQ changes */
+		g_at_chat_send(nd->chat, "AT+AUTOCSQ=1,1", none_prefix,
+				NULL, NULL, NULL);
+
+		g_at_chat_register(nd->chat, "+CSQ:",
+ 				   csq_notify, FALSE, netreg, NULL);
+ 		break;
 	case OFONO_VENDOR_PHONESIM:
 		g_at_chat_register(nd->chat, "+CSQ:",
 					csq_notify, FALSE, netreg, NULL);
@@ -1534,7 +1537,6 @@ static void at_creg_set_cb(gboolean ok,
 		break;
 	case OFONO_VENDOR_NOKIA:
 	case OFONO_VENDOR_SAMSUNG:
-	case OFONO_VENDOR_SIMCOM:
 		/* Signal strength reporting via CIND is not supported */
 		break;
 	default:
#6 lore raw

Re: [PATCH 4/4] SIMCOM signal strength reporting quirk

Hi Anthony,

Quoted 5 lines · Anthony Viallard

Add a quirk for signal strength reporting.

We must tell we want the signal strength reporting using AT+AUTOCSQ command (ref. SIM5215_SIM5216_ATC_V1.18.pdf - §10.7).

Patch looks fine, but can't apply:

fatal: cannot convert from y to UTF-8

Regards,
-Denis

#7 lore raw
In reply to Anthony Viallard

Hi Anthony,

Makefile.am

Quoted 15 lines · Anthony Viallard

Add SIMCOM support.

Implemented using SIM5216E module and ofono 1.12.

- based on SIM5215_SIM5216_ATC_V1.18.pdf documentation ;
- SMS and GPRS work (in the same time) ;
- SIM card presence check ;
- use GSM charset ;
- use 115200bps, 8 bit data, no parity, 1 bit stop, no data stream control

    for tty configuration ;

- flight mode support ;
- No voice part (because I can't test it).

Makefile.am +0 -0

Please send this using git send-email. I cannot apply these patches:

Applying: SIMCOM plugin driver
fatal: sha1 information is lacking or useless (Makefile.am). Repository lacks necessary blobs to fall back on 3-way merge. Cannot fall back to three-way merge.
Patch failed at 0001 SIMCOM plugin driver
When you have resolved this problem run "git am --resolved". If you would prefer to skip this patch, instead run "git am --skip". To restore the original branch and stop patching run "git am --abort".

Quoted 165 lines
Makefile.am +3 -0
@@ -371,6 +371,9 @@ builtin_sources += plugins/samsung.c
  builtin_modules += sim900
  builtin_sources += plugins/sim900.c
 
+builtin_modules += simcom
+builtin_sources += plugins/simcom.c
+
  if BLUETOOTH
  builtin_modules += bluetooth
  builtin_sources += plugins/bluetooth.c plugins/bluetooth.h
plugins/simcom.c new file +152 -0
@@ -0,0 +1,434 @@
+/*
+ *
+ *  oFono - Open Source Telephony
+ *
+ *  Copyright (C) 2008-2011  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
+ *
+ */
+
+#ifdef HAVE_CONFIG_H
+#include<config.h>
+#endif
+
+#include<errno.h>
+#include<stdlib.h>
+#include<stdio.h>
+
+#include<glib.h>
+#include<gatchat.h>
+#include<gattty.h>
+
+#define OFONO_API_SUBJECT_TO_CHANGE
+#include<ofono/plugin.h>
+#include<ofono/modem.h>
+#include<ofono/devinfo.h>
+#include<ofono/netreg.h>
+#include<ofono/sim.h>
+#include<ofono/cbs.h>
+#include<ofono/sms.h>
+#include<ofono/ussd.h>
+#include<ofono/gprs.h>
+#include<ofono/gprs-context.h>
+#include<ofono/radio-settings.h>
+#include<ofono/phonebook.h>
+#include<ofono/log.h>
+
+#include<drivers/atmodem/atutil.h>
+#include<drivers/atmodem/vendor.h>
+
+#define MAX_IGNITION_POOL_CALL    7
+
+#define CMEERR_SIMBUSY           14
+
+static const char *none_prefix[] = { NULL };
+
+struct simcom_data {
+	GAtChat *modem;
+	GAtChat *chat;
+	guint ignition_pool;
+	unsigned int ignition_pool_call;
+	unsigned int at_ignition_pending;
+	ofono_bool_t have_sim;
+};
+
+/* Callback and helpers functions */
+static void simcom_debug(const char *str, void *user_data)
+{
+	const char *prefix = user_data;
+
+	ofono_info("%s%s", prefix, str);
+}
+
+static gboolean simcom_ignition(gpointer user_data)
+{
+	struct ofono_modem *modem = user_data;
+	struct simcom_data *data = ofono_modem_get_data(modem);
+
+	++data->ignition_pool_call;
+
+	if(data->at_ignition_pending>  0)
+	{
+		if(data->ignition_pool_call>  MAX_IGNITION_POOL_CALL)
+		{
+			ofono_error("Ignition timeout");
+			return FALSE;
+		}
+
+		/* Waiting reply of AT commands */
+		DBG("Waiting AT reply...");
+		return TRUE;
+	}
+
+	ofono_modem_set_powered(modem, TRUE);
+
+	return FALSE;
+}
+
+static void simcom_sim_status(gboolean ok, GAtResult *result, gpointer user_data)
+{
+	struct ofono_modem *modem = user_data;
+	struct ofono_error error;
+	struct simcom_data *data = ofono_modem_get_data(modem);
+
+	--data->at_ignition_pending;
+
+	if(!ok)
+	{
+		decode_at_error(&error, g_at_result_final_response(result));
+		if(error.type == OFONO_ERROR_TYPE_CME)
+		{
+			if(error.error == CMEERR_SIMBUSY)
+			{
+				DBG("System is busy. Retry...");
+				g_at_chat_send(data->chat, "AT+CPIN?",
+					       none_prefix,
+					       simcom_sim_status, modem,
+					       NULL);
+				++data->at_ignition_pending;
+				return;
+			}
+		}
+
+		data->have_sim = FALSE;
+		return;
+	}
+
+	/* If doesn't have an "fatal" error on AT+CPIN request,
+	 * we can guess there a SIM card ...
+	 */
+	data->have_sim = TRUE;
+}
+
+static void cfun_enable(gboolean ok, GAtResult *result, gpointer user_data)
+{
+	struct ofono_modem *modem = user_data;
+	struct simcom_data *data = ofono_modem_get_data(modem);
+
+	DBG("");
+
+	if (!ok) {
+		g_at_chat_unref(data->modem);
+		data->modem = NULL;
+
+		g_at_chat_unref(data->chat);
+		data->chat = NULL;
+
+		ofono_modem_set_powered(modem, FALSE);
+		return;
+	}
+

plugins/simcom.c line 162

Quoted 10 lines
plugins/simcom.c new file +10 -0
+	/* Get model and sim card status */
+	data->at_ignition_pending = 0;
+
+	g_at_chat_send(data->chat, "AT+CPIN?", none_prefix,
+		       simcom_sim_status, modem, NULL);
+	++data->at_ignition_pending;
+
+	data->ignition_pool = g_timeout_add_seconds(1,
+						    simcom_ignition,
+						    modem);

Are you polling CPIN for signs of life? In that case, there's a convenience function for this. Grep for at_util_sim_state_query_new, it takes care of all the magic for you.

Quoted 32 lines
plugins/simcom.c new file +32 -0
+}
+
+static void cfun_disable(gboolean ok, GAtResult *result, gpointer user_data)
+{
+	struct ofono_modem *modem = user_data;
+	struct simcom_data *data = ofono_modem_get_data(modem);
+
+	DBG("");
+
+	g_at_chat_unref(data->chat);
+	data->chat = NULL;
+
+	if (ok)
+		ofono_modem_set_powered(modem, FALSE);
+}
+
+static void flightmode_cb(gboolean ok, GAtResult *result, gpointer user_data)
+{
+	struct cb_data *cbd = user_data;
+	ofono_modem_online_cb_t cb = cbd->cb;
+	struct ofono_error error;
+
+	decode_at_error(&error, g_at_result_final_response(result));
+	cb(&error, cbd->data);
+}
+
+static GAtChat *open_device(struct ofono_modem *modem,
+			    const char *key,
+			    char *debug)
+{
+	const char *device;
+	GIOChannel *channel;

plugins/simcom.c line 204

Quoted 10 lines
plugins/simcom.c new file +10 -0
+	GAtSyntax *syntax;
+	GAtChat *chat;
+	GHashTable *options;
+
+	device = ofono_modem_get_string(modem, key);
+	if (device == NULL)
+	{
+		ofono_error("Failed to get modem '%s'", key);
+		return NULL;
+	}

Wrong coding style

Quoted 6 lines
plugins/simcom.c new file +6 -0
+
+	DBG("%s %s", key, device);
+
+	options = g_hash_table_new(g_str_hash, g_str_equal);
+	if (options == NULL)
+	 	return NULL;

plugins/simcom.c line 220

Quoted 10 lines
plugins/simcom.c new file +10 -0
+
+	g_hash_table_insert(options, "Baud", "115200");
+	g_hash_table_insert(options, "Parity", "none");
+	g_hash_table_insert(options, "StopBits", "1");
+	g_hash_table_insert(options, "DataBits", "8");
+	g_hash_table_insert(options, "XonXoff", "off");
+
+	channel = g_at_tty_open(device, options);
+
+	/* g_hash_table_destroy(options); */

Why is this commented out?

plugins/simcom.c line 226

Quoted 6 lines
plugins/simcom.c new file +6 -0
+
+	if (channel == NULL)
+	{
+		ofono_error("Failed to get tty for '%s'", key);
+		return NULL;
+	}

Coding style is wrong, please see below.

plugins/simcom.c line 238

Quoted 12 lines
plugins/simcom.c new file +12 -0
+
+	syntax = g_at_syntax_new_gsm_permissive();
+	chat = g_at_chat_new(channel, syntax);
+	g_at_syntax_unref(syntax);
+
+	g_io_channel_unref(channel);
+
+	if (chat == NULL)
+	{
+		ofono_error("Failed to get chat for '%s'", key);
+		return NULL;
+	}

Again, coding style is wrong. Please see below.

Quoted 141 lines
plugins/simcom.c new file +141 -0
+
+	if (getenv("OFONO_AT_DEBUG"))
+		g_at_chat_set_debug(chat, simcom_debug, debug);
+
+	return chat;
+}
+
+/* Modem interface function */
+static int simcom_probe(struct ofono_modem *modem)
+{
+	struct simcom_data *data;
+
+	DBG("%p", modem);
+
+	data = g_try_new0(struct simcom_data, 1);
+	if (data == NULL)
+		return -ENOMEM;
+
+	ofono_modem_set_data(modem, data);
+
+	return 0;
+}
+
+static void simcom_remove(struct ofono_modem *modem)
+{
+	struct simcom_data *data = ofono_modem_get_data(modem);
+
+	DBG("%p", modem);
+
+	if(data->ignition_pool>  0)
+	{
+		g_source_remove(data->ignition_pool);
+		data->ignition_pool = 0;
+	}
+
+	ofono_modem_set_data(modem, NULL);
+
+	/* Cleanup after hot-unplug */
+	g_at_chat_unref(data->chat);
+
+	g_free(data);
+}
+
+static int simcom_enable(struct ofono_modem *modem)
+{
+	struct simcom_data *data = ofono_modem_get_data(modem);
+
+	DBG("%p", modem);
+
+	data->modem = open_device(modem, "Modem", "Modem: ");
+	if (data->modem == NULL)
+		return -EINVAL;
+
+	data->chat = open_device(modem, "Data", "Data: ");
+	if (data->chat == NULL) {
+		g_at_chat_unref(data->modem);
+		data->modem = NULL;
+		return -EIO;
+	}
+
+	g_at_chat_set_slave(data->modem, data->chat);
+
+	g_at_chat_blacklist_terminator(data->chat,
+					G_AT_CHAT_TERMINATOR_NO_CARRIER);
+
+	/* Configure AT commands behavior */
+	g_at_chat_send(data->modem, "ATE0 +CMEE=1", NULL, NULL, NULL, NULL);
+	g_at_chat_send(data->chat, "ATE0 +CMEE=1", NULL, NULL, NULL, NULL);
+
+	/* Ensure that the modem is using GSM character set and not IRA */
+	g_at_chat_send(data->modem, "AT+CSCS=\"GSM\"", none_prefix,
+			NULL, NULL, NULL);
+	g_at_chat_send(data->chat, "AT+CSCS=\"GSM\"", none_prefix,
+			NULL, NULL, NULL);
+
+	/* Make it up */
+	g_at_chat_send(data->chat, "AT+CFUN=1", none_prefix,
+		       cfun_enable, modem, NULL);
+
+	return -EINPROGRESS;
+}
+
+static int simcom_disable(struct ofono_modem *modem)
+{
+	struct simcom_data *data = ofono_modem_get_data(modem);
+
+	DBG("%p", modem);
+
+	g_at_chat_cancel_all(data->modem);
+	g_at_chat_unregister_all(data->modem);
+
+	g_at_chat_unref(data->modem);
+	data->modem = NULL;
+
+	g_at_chat_cancel_all(data->chat);
+	g_at_chat_unregister_all(data->chat);
+
+	g_at_chat_send(data->chat, "AT+CFUN=4", none_prefix,
+		       cfun_disable, modem, NULL);
+
+	return -EINPROGRESS;
+}
+
+static void simcom_set_online(struct ofono_modem *modem, ofono_bool_t online,
+                              ofono_modem_online_cb_t cb, void *user_data)
+{
+	struct simcom_data *data = ofono_modem_get_data(modem);
+	struct cb_data *cbd = cb_data_new(cb, user_data);
+	char const *command = online ? "AT+CFUN=1" : "AT+CFUN=4";
+
+	DBG("modem %p %s", modem, online ? "online" : "offline");
+
+	if (g_at_chat_send(data->chat, command, none_prefix,
+			   flightmode_cb, cbd, g_free)>  0)
+		return;
+
+	CALLBACK_WITH_FAILURE(cb, cbd->data);
+
+	g_free(cbd);
+}
+
+static void simcom_pre_sim(struct ofono_modem *modem)
+{
+	struct simcom_data *data = ofono_modem_get_data(modem);
+	struct ofono_sim *sim;
+
+	DBG("%p", modem);
+
+	ofono_devinfo_create(modem, 0, "atmodem", data->chat);
+	sim = ofono_sim_create(modem, OFONO_VENDOR_SIMCOM, "atmodem",
+				data->chat);
+
+	if (sim)
+		ofono_sim_inserted_notify(sim, data->have_sim);
+}
+
+static void simcom_post_sim(struct ofono_modem *modem)
+{
+	struct simcom_data *data = ofono_modem_get_data(modem);
+	struct ofono_message_waiting *mw;
+	struct ofono_gprs *gprs;

plugins/simcom.c line 389

Quoted 10 lines
plugins/simcom.c new file +10 -0
+	struct ofono_gprs_context *gc;
+
+	DBG("%p", modem);
+
+	ofono_phonebook_create(modem, 0, "atmodem", data->chat);
+
+	ofono_sms_create(modem, OFONO_VENDOR_SIMCOM, "atmodem",
+				data->chat);
+
+	/* gprs things */

This comment is rather useless ;)

plugins/simcom.c line 396

Quoted 7 lines
plugins/simcom.c new file +7 -0
+	gprs = ofono_gprs_create(modem, 0, "atmodem", data->chat);
+	gc = ofono_gprs_context_create(modem, 0, "atmodem", data->modem);
+
+	if(gprs&&  gc)
+	{
+		ofono_gprs_add_context(gprs, gc);
+	}

This is not according to the coding style. Please refer to doc/coding-style.txt for details. In particular, there should not be any parentheses around the if. And we use the Linux kernel style, so it would look like:

if (gprs && gc) {
	foo;
	bar;
}
Quoted 28 lines
plugins/simcom.c new file +28 -0
+}
+
+static void simcom_post_online(struct ofono_modem *modem)
+{
+	struct simcom_data *data = ofono_modem_get_data(modem);
+
+	DBG("%p", modem);
+
+	ofono_netreg_create(modem, OFONO_VENDOR_SIMCOM, "atmodem", data->chat);
+	ofono_cbs_create(modem, 0, "atmodem", data->chat);
+	ofono_ussd_create(modem, 0, "atmodem", data->chat);
+}
+
+static struct ofono_modem_driver simcom_driver = {
+	.name		= "simcom",
+	.probe		= simcom_probe,
+	.remove		= simcom_remove,
+	.enable		= simcom_enable,
+	.disable	= simcom_disable,
+	.set_online     = simcom_set_online,
+	.pre_sim	= simcom_pre_sim,
+	.post_sim	= simcom_post_sim,
+	.post_online	= simcom_post_online,
+};
+
+static int simcom_init(void)
+{
+	return ofono_modem_driver_register(&simcom_driver);

plugins/simcom.c line 434

Quoted 10 lines
plugins/simcom.c new file +10 -0
+}
+
+static void simcom_exit(void)
+{
+	ofono_modem_driver_unregister(&simcom_driver);
+}
+
+OFONO_PLUGIN_DEFINE(simcom, "SIMCOM modem driver", VERSION,
+		    OFONO_PLUGIN_PRIORITY_DEFAULT,
+		    simcom_init, simcom_exit)

There is whitespace corruption here, do not use spaces for indentation.

Quoted 4 lines

_______________________________________________
ofono mailing list
ofono(a)ofono.org
http://lists.ofono.org/listinfo/ofono

Regards,
-Denis