[PATCH v3] Add a driver for Quectel UC15 modems (rebased)

[PATCH v3] Add a driver for Quectel UC15 modems (rebased)

[Philip Paeps]

[-- Attachment #1: Type: text/plain, Size: 697 bytes --]

Forgot to send this last patch out with the rest before the weekend, sorry.

Changes since v2:
 o Rebased on master with ublox patch set applied
   - Should be a trivial 3-way merge on Makefile.am if
     the patches are applied out of order
 o Reworked the reset/enable code patch based on
   suggestions from Denis
   - Register for +CPIN: rather than polling
 o Used prefixes (even more) consistently


Philip Paeps (1):
  plugins: add a new driver for Quectel UC15 modems

 Makefile.am       |    3 +
 plugins/quectel.c |  379 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 382 insertions(+)
 create mode 100644 plugins/quectel.c

-- 
1.7.10.4

[PATCH] plugins: add a new driver for Quectel UC15 modems

[Philip Paeps]

[-- Attachment #1: Type: text/plain, Size: 10529 bytes --]

---
 Makefile.am       |    3 +
 plugins/quectel.c |  379 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 382 insertions(+)

diff --git a/Makefile.am b/Makefile.am
index cd83ef4..aee28de 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -420,6 +420,9 @@ builtin_sources += plugins/connman.c
 builtin_modules += he910
 builtin_sources += plugins/he910.c
 
+builtin_modules += quectel
+builtin_sources += plugins/quectel.c
+
 if BLUETOOTH
 if BLUEZ4
 builtin_modules += bluez4
diff --git a/plugins/quectel.c b/plugins/quectel.c
new file mode 100644
index 0000000..5fadd16
--- /dev/null
+++ b/plugins/quectel.c
@@ -0,0 +1,379 @@
+/*
+ *
+ *  oFono - Open Source Telephony
+ *
+ *  Copyright (C) 2014  Philip Paeps. 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 <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/gprs.h>
+#include <ofono/gprs-context.h>
+#include <ofono/log.h>
+
+#include <drivers/atmodem/atutil.h>
+#include <drivers/atmodem/vendor.h>
+
+static const char *cfun_prefix[] = { "+CFUN:", NULL };
+static const char *cpin_prefix[] = { "+CPIN:", NULL };
+static const char *none_prefix[] = { NULL };
+
+struct quectel_data {
+	GAtChat *modem;
+	GAtChat *aux;
+	guint cpin_ready;
+	gboolean have_sim;
+};
+
+static void quectel_debug(const char *str, void *user_data)
+{
+	const char *prefix = user_data;
+
+	ofono_info("%s%s", prefix, str);
+}
+
+static int quectel_probe(struct ofono_modem *modem)
+{
+	struct quectel_data *data;
+
+	DBG("%p", modem);
+
+	data = g_try_new0(struct quectel_data, 1);
+	if (data == NULL)
+		return -ENOMEM;
+
+	ofono_modem_set_data(modem, data);
+
+	return 0;
+}
+
+static void quectel_remove(struct ofono_modem *modem)
+{
+	struct quectel_data *data = ofono_modem_get_data(modem);
+
+	DBG("%p", modem);
+
+	if (data->cpin_ready != 0)
+		g_at_chat_unregister(data->aux, data->cpin_ready);
+
+	ofono_modem_set_data(modem, NULL);
+	g_at_chat_unref(data->aux);
+	g_at_chat_unref(data->modem);
+	g_free(data);
+}
+
+static GAtChat *open_device(struct ofono_modem *modem,
+				const char *key, char *debug)
+{
+	const char *device;
+	GAtSyntax *syntax;
+	GIOChannel *channel;
+	GAtChat *chat;
+
+	device = ofono_modem_get_string(modem, key);
+	if (device == NULL)
+		return NULL;
+
+	DBG("%s %s", key, device);
+
+	channel = g_at_tty_open(device, NULL);
+	if (channel == NULL)
+		return NULL;
+
+	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)
+		return NULL;
+
+	if (getenv("OFONO_AT_DEBUG"))
+		g_at_chat_set_debug(chat, quectel_debug, debug);
+
+	return chat;
+}
+
+static void cpin_notify(GAtResult *result, gpointer user_data)
+{
+	struct ofono_modem *modem = user_data;
+	struct quectel_data *data = ofono_modem_get_data(modem);
+	const char *sim_inserted;
+	GAtResultIter iter;
+
+	DBG("%p", modem);
+
+	g_at_result_iter_init(&iter, result);
+
+	if (!g_at_result_iter_next(&iter, "+CPIN:"))
+		return;
+
+	g_at_result_iter_next_unquoted_string(&iter, &sim_inserted);
+
+	if (g_strcmp0(sim_inserted, "NOT INSERTED") != 0)
+		data->have_sim = TRUE;
+
+	ofono_modem_set_powered(modem, TRUE);
+
+	/* Turn off the radio. */
+	g_at_chat_send(data->aux, "AT+CFUN=4", none_prefix, NULL, NULL, NULL);
+
+	g_at_chat_unregister(data->aux, data->cpin_ready);
+	data->cpin_ready = 0;
+}
+
+static void cpin_query(gboolean ok, GAtResult *result, gpointer user_data)
+{
+	DBG("ok %d", ok);
+
+	if (ok)
+		cpin_notify(result, user_data);
+}
+
+static void cfun_enable(gboolean ok, GAtResult *result, gpointer user_data)
+{
+	struct ofono_modem *modem = user_data;
+	struct quectel_data *data = ofono_modem_get_data(modem);
+
+	DBG("ok %d", ok);
+
+	if (!ok) {
+		g_at_chat_unref(data->aux);
+		data->aux = NULL;
+		g_at_chat_unref(data->modem);
+		data->modem = NULL;
+		ofono_modem_set_powered(modem, FALSE);
+		return;
+	}
+
+	data->cpin_ready = g_at_chat_register(data->aux, "+CPIN", cpin_notify,
+						FALSE, modem, NULL);
+	g_at_chat_send(data->aux, "AT+CPIN?", cpin_prefix, cpin_query,
+						modem, NULL);
+}
+
+static void cfun_query(gboolean ok, GAtResult *result, gpointer user_data)
+{
+	struct ofono_modem *modem = user_data;
+	struct quectel_data *data = ofono_modem_get_data(modem);
+	GAtResultIter iter;
+	int status;
+
+	DBG("ok %d", ok);
+
+	if (!ok)
+		return;
+
+	g_at_result_iter_init(&iter, result);
+
+	if (g_at_result_iter_next(&iter, "+CFUN:") == FALSE)
+		return;
+
+	g_at_result_iter_next_number(&iter, &status);
+
+	/*
+	 * The modem firmware powers up in CFUN=1 but will respond to AT+CFUN=4
+	 * with ERROR until some amount of time (which varies with temperature)
+	 * passes.  Empirical evidence suggests that the firmware will report an
+	 * unsolicited +CPIN: notification when it is ready to be useful.
+	 *
+	 * Work around this feature by only transitioning to CFUN=4 after we've
+	 * received an unsolicited +CPIN: notification.
+	 */
+
+	if (status != 1) {
+		g_at_chat_send(data->aux, "AT+CFUN=4", none_prefix,
+					cfun_enable, modem, NULL);
+		return;
+	}
+
+	cfun_enable(TRUE, NULL, modem);
+}
+
+static int quectel_enable(struct ofono_modem *modem)
+{
+	struct quectel_data *data = ofono_modem_get_data(modem);
+
+	DBG("%p", modem);
+
+	data->modem = open_device(modem, "Modem", "Modem: ");
+	if (data->modem == NULL)
+		return -EINVAL;
+
+	data->aux = open_device(modem, "Aux", "Aux: ");
+	if (data->aux == NULL) {
+		g_at_chat_unref(data->modem);
+		data->modem = NULL;
+		return -EIO;
+	}
+	g_at_chat_set_slave(data->modem, data->aux);
+
+	g_at_chat_send(data->modem, "ATE0 &C0 +CMEE=1", none_prefix,
+					NULL, NULL, NULL);
+	g_at_chat_send(data->aux, "ATE0 &C0 +CMEE=1", none_prefix,
+					NULL, NULL, NULL);
+
+	g_at_chat_send(data->aux, "AT+CFUN?", cfun_prefix,
+					cfun_query, modem, NULL);
+
+	return -EINPROGRESS;
+}
+
+static void cfun_disable(gboolean ok, GAtResult *result, gpointer user_data)
+{
+	struct ofono_modem *modem = user_data;
+	struct quectel_data *data = ofono_modem_get_data(modem);
+
+	DBG("");
+
+	g_at_chat_unref(data->aux);
+	data->aux = NULL;
+
+	if (ok)
+		ofono_modem_set_powered(modem, FALSE);
+}
+
+static int quectel_disable(struct ofono_modem *modem)
+{
+	struct quectel_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->aux);
+	g_at_chat_unregister_all(data->aux);
+
+	g_at_chat_send(data->aux, "AT+CFUN=0", cfun_prefix,
+					cfun_disable, modem, NULL);
+
+	return -EINPROGRESS;
+}
+
+static void set_online_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 void quectel_set_online(struct ofono_modem *modem, ofono_bool_t online,
+				ofono_modem_online_cb_t cb, void *user_data)
+{
+	struct quectel_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->aux, command, cfun_prefix, set_online_cb,
+					cbd, g_free) > 0)
+		return;
+
+	CALLBACK_WITH_FAILURE(cb, cbd->data);
+
+	g_free(cbd);
+}
+
+static void quectel_pre_sim(struct ofono_modem *modem)
+{
+	struct quectel_data *data = ofono_modem_get_data(modem);
+	struct ofono_sim *sim;
+
+	DBG("%p", modem);
+
+	ofono_devinfo_create(modem, OFONO_VENDOR_QUECTEL, "atmodem",
+					data->aux);
+	sim = ofono_sim_create(modem, OFONO_VENDOR_QUECTEL, "atmodem",
+					data->aux);
+
+	if (sim && data->have_sim == TRUE)
+		ofono_sim_inserted_notify(sim, TRUE);
+}
+
+static void quectel_post_sim(struct ofono_modem *modem)
+{
+	struct quectel_data *data = ofono_modem_get_data(modem);
+	struct ofono_gprs *gprs;
+	struct ofono_gprs_context *gc;
+
+	DBG("%p", modem);
+
+	gprs = ofono_gprs_create(modem, OFONO_VENDOR_QUECTEL, "atmodem",
+					data->aux);
+	gc = ofono_gprs_context_create(modem, OFONO_VENDOR_QUECTEL, "atmodem",
+					data->modem);
+
+	if (gprs && gc)
+		ofono_gprs_add_context(gprs, gc);
+}
+
+static void quectel_post_online(struct ofono_modem *modem)
+{
+	struct quectel_data *data = ofono_modem_get_data(modem);
+
+	ofono_netreg_create(modem, OFONO_VENDOR_QUECTEL, "atmodem",
+					data->aux);
+}
+
+static struct ofono_modem_driver quectel_driver = {
+	.name			= "quectel",
+	.probe			= quectel_probe,
+	.remove			= quectel_remove,
+	.enable			= quectel_enable,
+	.disable		= quectel_disable,
+	.set_online		= quectel_set_online,
+	.pre_sim		= quectel_pre_sim,
+	.post_sim		= quectel_post_sim,
+	.post_online		= quectel_post_online,
+};
+
+static int quectel_init(void)
+{
+	return ofono_modem_driver_register(&quectel_driver);
+}
+
+static void quectel_exit(void)
+{
+	ofono_modem_driver_unregister(&quectel_driver);
+}
+
+OFONO_PLUGIN_DEFINE(quectel, "Quectel driver", VERSION,
+    OFONO_PLUGIN_PRIORITY_DEFAULT, quectel_init, quectel_exit)
-- 
1.7.10.4

Re: [PATCH] plugins: add a new driver for Quectel UC15 modems

[Denis Kenzior]

[-- Attachment #1: Type: text/plain, Size: 2091 bytes --]

Hi Philip,

On 07/07/2014 04:54 AM, Philip Paeps wrote:
> ---
>  Makefile.am       |    3 +
>  plugins/quectel.c |  379 +++++++++++++++++++++++++++++++++++++++++++++++++++++
>  2 files changed, 382 insertions(+)
> 

I went ahead and applied the patch, with one small fix afterwards:

<snip>

> +static void cfun_query(gboolean ok, GAtResult *result, gpointer user_data)
> +{
> +	struct ofono_modem *modem = user_data;
> +	struct quectel_data *data = ofono_modem_get_data(modem);
> +	GAtResultIter iter;
> +	int status;
> +
> +	DBG("ok %d", ok);
> +
> +	if (!ok)
> +		return;
> +
> +	g_at_result_iter_init(&iter, result);
> +
> +	if (g_at_result_iter_next(&iter, "+CFUN:") == FALSE)
> +		return;
> +
> +	g_at_result_iter_next_number(&iter, &status);
> +
> +	/*
> +	 * The modem firmware powers up in CFUN=1 but will respond to AT+CFUN=4
> +	 * with ERROR until some amount of time (which varies with temperature)
> +	 * passes.  Empirical evidence suggests that the firmware will report an
> +	 * unsolicited +CPIN: notification when it is ready to be useful.
> +	 *
> +	 * Work around this feature by only transitioning to CFUN=4 after we've
> +	 * received an unsolicited +CPIN: notification.
> +	 */
> +
> +	if (status != 1) {
> +		g_at_chat_send(data->aux, "AT+CFUN=4", none_prefix,
> +					cfun_enable, modem, NULL);

This part doesn't match the comment above.  Feel free to send a follow
on patch to fix it.

> +		return;
> +	}
> +
> +	cfun_enable(TRUE, NULL, modem);
> +}
> +

<snip>

> +	ofono_devinfo_create(modem, OFONO_VENDOR_QUECTEL, "atmodem",
> +					data->aux);

<snip>

> +	gprs = ofono_gprs_create(modem, OFONO_VENDOR_QUECTEL, "atmodem",
> +					data->aux);
> +	gc = ofono_gprs_context_create(modem, OFONO_VENDOR_QUECTEL, "atmodem",
> +					data->modem);
> +

<snip>

> +	ofono_netreg_create(modem, OFONO_VENDOR_QUECTEL, "atmodem",
> +					data->aux);

I changed these to 0 instead of OFONO_VENDOR_QUECTEL since no vendor
specific behavior is being used in these atom drivers.

Regards,
-Denis