[PATCH 5/5] Implement STATUS polling in atmodem driver, enable it for phonesim & atgen.

[PATCH 5/5] Implement STATUS polling in atmodem driver, enable it for phonesim & atgen.

[Andrzej Zaborowski]

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

---
 Makefile.am                |    2 +
 drivers/atmodem/sim-poll.c |  283 ++++++++++++++++++++++++++++++++++++++++++++
 drivers/atmodem/sim-poll.h |   22 ++++
 plugins/atgen.c            |    7 +-
 plugins/phonesim.c         |    6 +-
 5 files changed, 316 insertions(+), 4 deletions(-)
 create mode 100644 drivers/atmodem/sim-poll.c
 create mode 100644 drivers/atmodem/sim-poll.h

diff --git a/Makefile.am b/Makefile.am
index 0eaadda..0df918e 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -123,6 +123,8 @@ builtin_sources += $(gatchat_sources) \
 				drivers/atmodem/call-meter.c \
 				drivers/atmodem/network-registration.c \
 				drivers/atmodem/sim.c \
+				drivers/atmodem/sim-poll.c \
+				drivers/atmodem/sim-poll.h \
 				drivers/atmodem/ussd.c \
 				drivers/atmodem/voicecall.c \
 				drivers/atmodem/call-barring.c \
diff --git a/drivers/atmodem/sim-poll.c b/drivers/atmodem/sim-poll.c
new file mode 100644
index 0000000..303ea82
--- /dev/null
+++ b/drivers/atmodem/sim-poll.c
@@ -0,0 +1,283 @@
+/*
+ *
+ *  oFono - Open Source Telephony
+ *
+ *  Copyright (C) 2008-2010  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
+
+#define _GNU_SOURCE
+#include <stdio.h>
+
+#include <glib.h>
+
+#include <ofono/log.h>
+#include <ofono/modem.h>
+#include <ofono/sim.h>
+
+#include "gatchat.h"
+#include "gatresult.h"
+#include "ofono.h"
+
+#include "atmodem.h"
+#include "sim-poll.h"
+
+struct sim_poll_data {
+	GAtChat *chat;
+	struct ofono_modem *modem;
+	struct ofono_sim *sim;
+	unsigned int sim_watch;
+	unsigned int sim_ready_watch;
+	unsigned int sim_removed_watch;
+	gboolean inserted;
+	int idle_poll_interval;
+	gint status_timeout;
+	gint poll_timeout;
+	guint status_cmd;
+};
+
+static const char *csim_prefix[] = { "+CSIM:", NULL };
+
+static gboolean sim_status_poll(gpointer user_data);
+static void sim_fetch_command(struct sim_poll_data *spd, int length);
+
+static void at_csim_fetch_cb(gboolean ok, GAtResult *result,
+		gpointer user_data)
+{
+	struct sim_poll_data *spd = user_data;
+	GAtResultIter iter;
+	const guint8 *response;
+	gint rlen, len;
+
+	if (!ok)
+		return;
+
+	g_at_result_iter_init(&iter, result);
+
+	if (!g_at_result_iter_next(&iter, "+CSIM:"))
+		return;
+
+	if (!g_at_result_iter_next_number(&iter, &rlen))
+		return;
+
+	if (!g_at_result_iter_next_hexstring(&iter, &response, &len))
+		return;
+
+	if (rlen != len * 2 || len < 2 || (response[len - 2] != 0x90 &&
+				response[len - 2] != 0x91) ||
+			(response[len - 2] == 0x90 && response[len - 1] != 0))
+		return;
+
+	DBG("csim_fetch_cb: %i", len);
+
+	ofono_sim_proactive_command_notify(spd->sim, len - 2, response);
+
+	/* Can this happen? */
+	if (response[len - 2] == 0x91)
+		sim_fetch_command(spd, response[len - 1]);
+}
+
+static void sim_fetch_command(struct sim_poll_data *spd, int length)
+{
+	char buf[64];
+
+	snprintf(buf, sizeof(buf), "AT+CSIM=10,A0120000%02hhX", length);
+
+	g_at_chat_send(spd->chat, buf, csim_prefix,
+			at_csim_fetch_cb, spd, NULL);
+}
+
+static void sim_status_poll_schedule(struct sim_poll_data *spd)
+{
+	/* TODO: Decide on the interval based on whether any call is active */
+	/* TODO: On idle, possibly only schedule if proactive commands enabled
+	 * as indicated by EFphase + EFsst (51.011: 11.6.1) */
+	int interval = spd->idle_poll_interval;
+
+	/* When a SIM is inserted, the SIM might have requested a different
+	 * interval.  */
+	if (spd->inserted)
+		interval = ofono_modem_get_integer(spd->modem,
+				"status-poll-interval");
+
+	spd->poll_timeout = g_timeout_add_seconds(interval,
+			sim_status_poll, spd);
+}
+
+static gboolean sim_status_timeout(gpointer user_data)
+{
+	struct sim_poll_data *spd = user_data;
+
+	spd->status_timeout = 0;
+
+	g_at_chat_cancel(spd->chat, spd->status_cmd);
+	spd->status_cmd = 0;
+
+	if (spd->inserted == TRUE) {
+		spd->inserted = FALSE;
+		ofono_sim_removed(spd->sim);
+	}
+
+	sim_status_poll_schedule(spd);
+
+	return FALSE;
+}
+
+static void at_csim_status_cb(gboolean ok, GAtResult *result,
+		gpointer user_data)
+{
+	struct sim_poll_data *spd = user_data;
+	GAtResultIter iter;
+	const guint8 *response;
+	gint rlen, len;
+
+	spd->status_cmd = 0;
+
+	if (!spd->status_timeout)
+		/* The STATUS already timed out */
+		return;
+
+	/* Card responded on time */
+
+	g_source_remove(spd->status_timeout);
+	spd->status_timeout = 0;
+
+	if (spd->inserted != TRUE) {
+		spd->inserted = TRUE;
+		ofono_sim_inserted(spd->sim);
+	}
+
+	sim_status_poll_schedule(spd);
+
+	/* Check if we have a proactive command */
+
+	if (!ok)
+		return;
+
+	g_at_result_iter_init(&iter, result);
+
+	if (!g_at_result_iter_next(&iter, "+CSIM:"))
+		return;
+
+	if (!g_at_result_iter_next_number(&iter, &rlen))
+		return;
+
+	if (!g_at_result_iter_next_hexstring(&iter, &response, &len))
+		return;
+
+	if (rlen != len * 2 || len < 2 || response[len - 2] != 0x91)
+		return;
+
+	/* We have a proactive command pending, FETCH it */
+	sim_fetch_command(spd, response[len - 1]);
+}
+
+static gboolean sim_status_poll(gpointer user_data)
+{
+	struct sim_poll_data *spd = user_data;
+
+	spd->poll_timeout = 0;
+
+	/* The SIM must respond in a given time frame which is of at
+	 * least 5 seconds in TS 11.11.  */
+	spd->status_timeout = g_timeout_add_seconds(5,
+			sim_status_timeout, spd);
+
+	/* Send STATUS */
+	spd->status_cmd = g_at_chat_send(spd->chat, "AT+CSIM=8,A0F200C0",
+			csim_prefix, at_csim_status_cb, spd, NULL);
+	if (spd->status_cmd == 0)
+		at_csim_status_cb(FALSE, NULL, spd);
+
+	return FALSE;
+}
+
+static void sim_ready_watch(void *user)
+{
+	struct sim_poll_data *spd = user;
+
+	spd->inserted = TRUE;
+
+	ofono_modem_set_integer(spd->modem, "status-poll-interval", 30);
+}
+
+static void sim_removed_watch(void *user)
+{
+	struct sim_poll_data *spd = user;
+
+	spd->inserted = FALSE;
+}
+
+static void sim_watch(struct ofono_atom *atom,
+		enum ofono_atom_watch_condition cond, void *data)
+{
+	struct sim_poll_data *spd = data;
+
+	if (cond != OFONO_ATOM_WATCH_CONDITION_UNREGISTERED)
+		return;
+
+	spd->sim_ready_watch = 0;
+	spd->sim_removed_watch = 0;
+
+	if (spd->sim_watch) {
+		__ofono_modem_remove_atom_watch(spd->modem, spd->sim_watch);
+		spd->sim_watch = 0;
+	}
+
+	if (spd->status_timeout) {
+		g_source_remove(spd->status_timeout);
+		spd->status_timeout = 0;
+	}
+
+	if (spd->poll_timeout) {
+		g_source_remove(spd->poll_timeout);
+		spd->poll_timeout = 0;
+	}
+
+	g_free(spd);
+}
+
+void ofono_atmodem_poll_enable(struct ofono_modem *modem, void *data)
+{
+	struct ofono_atom *sim_atom;
+	struct sim_poll_data *spd;
+
+	sim_atom = __ofono_modem_find_atom(modem, OFONO_ATOM_TYPE_SIM);
+	if (!sim_atom || !__ofono_atom_get_registered(sim_atom))
+		return;
+
+	spd = g_new0(struct sim_poll_data, 1);
+	spd->chat = data;
+	spd->modem = modem;
+	spd->sim = __ofono_atom_get_data(sim_atom);
+	spd->idle_poll_interval = 30;
+
+	spd->sim_ready_watch = ofono_sim_add_ready_watch(spd->sim,
+			sim_ready_watch, spd, NULL);
+	spd->sim_removed_watch = ofono_sim_add_removed_watch(spd->sim,
+			sim_removed_watch, spd, NULL);
+	spd->sim_watch = __ofono_modem_add_atom_watch(spd->modem,
+			OFONO_ATOM_TYPE_SIM, sim_watch, spd, NULL);
+
+	if (ofono_sim_get_ready(spd->sim))
+		sim_ready_watch(spd);
+
+	sim_status_poll(spd);
+}
diff --git a/drivers/atmodem/sim-poll.h b/drivers/atmodem/sim-poll.h
new file mode 100644
index 0000000..b8f9c5c
--- /dev/null
+++ b/drivers/atmodem/sim-poll.h
@@ -0,0 +1,22 @@
+/*
+ *
+ *  oFono - Open Source Telephony
+ *
+ *  Copyright (C) 2008-2010  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
+ *
+ */
+
+void ofono_atmodem_poll_enable(struct ofono_modem *modem, void *data);
diff --git a/plugins/atgen.c b/plugins/atgen.c
index bbfb99c..3501675 100644
--- a/plugins/atgen.c
+++ b/plugins/atgen.c
@@ -48,6 +48,8 @@
 #include <ofono/ussd.h>
 #include <ofono/voicecall.h>
 
+#include <drivers/atmodem/sim-poll.h>
+
 static const char *tty_opts[] = {
 	"Baud",
 	"Read",
@@ -156,15 +158,14 @@ static int atgen_disable(struct ofono_modem *modem)
 static void atgen_pre_sim(struct ofono_modem *modem)
 {
 	GAtChat *chat = ofono_modem_get_data(modem);
-	struct ofono_sim *sim;
 
 	DBG("%p", modem);
 
 	ofono_devinfo_create(modem, 0, "atmodem", chat);
-	sim = ofono_sim_create(modem, 0, "atmodem", chat);
+	ofono_sim_create(modem, 0, "atmodem", chat);
 	ofono_voicecall_create(modem, 0, "atmodem", chat);
 
-	ofono_sim_inserted(sim);
+	ofono_atmodem_poll_enable(modem, chat);
 }
 
 static void atgen_post_sim(struct ofono_modem *modem)
diff --git a/plugins/phonesim.c b/plugins/phonesim.c
index fb85523..7ad2cb6 100644
--- a/plugins/phonesim.c
+++ b/plugins/phonesim.c
@@ -58,6 +58,7 @@
 #include <ofono/gprs-context.h>
 
 #include <drivers/atmodem/vendor.h>
+#include <drivers/atmodem/sim-poll.h>
 
 struct phonesim_data {
 	GAtMux *mux;
@@ -289,7 +290,10 @@ static void phonesim_pre_sim(struct ofono_modem *modem)
 	else
 		ofono_voicecall_create(modem, 0, "atmodem", data->chat);
 
-	ofono_sim_inserted(sim);
+	if (data->calypso)
+		ofono_sim_inserted(sim);
+	else
+		ofono_atmodem_poll_enable(modem, data->chat);
 }
 
 static void phonesim_post_sim(struct ofono_modem *modem)
-- 
1.6.1

Re: [PATCH 5/5] Implement STATUS polling in atmodem driver, enable it for phonesim & atgen.

[Marcel Holtmann]

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

Hi Andrzej,

> +
> +	if (!g_at_result_iter_next_hexstring(&iter, &response, &len))
> +		return;
> +
> +	if (rlen != len * 2 || len < 2 || (response[len - 2] != 0x90 &&
> +				response[len - 2] != 0x91) ||
> +			(response[len - 2] == 0x90 && response[len - 1] != 0))
> +		return;
> +

let me re-write this into something readable ;)

	if (len < 2 || rlen != len * 2)
		return;

	if (response[len - 2] != 0x90 || response[len - 2] != 0x91)
		return;

	if (response[len - 2] == 0x90 && response[len - 1] != 0)
		return;

And please add comments on top of the if statements to explain what they
are checking for.

Regards

Marcel