Add calypso plugin
authorDenis Kenzior <denis.kenzior@intel.com>
Fri, 4 Sep 2009 04:06:12 +0000 (23:06 -0500)
committerDenis Kenzior <denkenz@gmail.com>
Fri, 4 Sep 2009 04:20:22 +0000 (23:20 -0500)
Makefile.am
plugins/calypso.c [new file with mode: 0644]

index 9bc321c..8910d5e 100644 (file)
@@ -122,6 +122,9 @@ builtin_sources += plugins/huawei.c
 
 builtin_modules += novatel
 builtin_sources += plugins/novatel.c
+
+builtin_modules += calypso
+builtin_sources += plugins/calypso.c
 endif
 
 if MAINTAINER_MODE
diff --git a/plugins/calypso.c b/plugins/calypso.c
new file mode 100644 (file)
index 0000000..e8a9915
--- /dev/null
@@ -0,0 +1,539 @@
+/*
+ *  oFono - Open Source Telephony
+ *
+ *  Copyright (C) 2008-2009  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 <stdlib.h>
+#include <errno.h>
+#include <termios.h>
+#include <string.h>
+#include <unistd.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <fcntl.h>
+
+#include <glib.h>
+#include <gatchat.h>
+
+#define OFONO_API_SUBJECT_TO_CHANGE
+#include <ofono/plugin.h>
+#include <ofono/log.h>
+#include <ofono/modem.h>
+#include <ofono/call-barring.h>
+#include <ofono/call-forwarding.h>
+#include <ofono/call-meter.h>
+#include <ofono/call-settings.h>
+#include <ofono/devinfo.h>
+#include <ofono/message-waiting.h>
+#include <ofono/netreg.h>
+#include <ofono/phonebook.h>
+#include <ofono/sim.h>
+#include <ofono/sms.h>
+#include <ofono/ssn.h>
+#include <ofono/ussd.h>
+#include <ofono/voicecall.h>
+
+#include <drivers/atmodem/vendor.h>
+
+#define CALYPSO_POWER_PATH "/sys/bus/platform/devices/neo1973-pm-gsm.0/power_on"
+#define CALYPSO_RESET_PATH "/sys/bus/platform/devices/neo1973-pm-gsm.0/reset"
+
+enum powercycle_state {
+       POWERCYCLE_STATE_POWER0 = 0,
+       POWERCYCLE_STATE_RESET0,
+       POWERCYCLE_STATE_POWER1,
+       POWERCYCLE_STATE_RESET1,
+       POWERCYCLE_STATE_FINISHED,
+};
+
+enum calypso_state {
+       CALYPSO_STATE_IDLE = 0,
+       CALYPSO_STATE_INITIAL_CR,
+       CALYPSO_STATE_INITIAL_LF,
+       CALYPSO_STATE_RESPONSE,
+       CALYPSO_STATE_TERMINATOR_CR,
+       CALYPSO_STATE_GUESS_MULTILINE_RESPONSE,
+       CALYPSO_STATE_MULTILINE_RESPONSE,
+       CALYPSO_STATE_MULTILINE_TERMINATOR_CR,
+       CALYPSO_STATE_PDU_CHECK_EXTRA_CR,
+       CALYPSO_STATE_PDU_CHECK_EXTRA_LF,
+       CALYPSO_STATE_PDU,
+       CALYPSO_STATE_PDU_CR,
+       CALYPSO_STATE_PROMPT,
+};
+
+static void calypso_hint(GAtSyntax *syntax, GAtSyntaxExpectHint hint)
+{
+       switch (hint) {
+       case G_AT_SYNTAX_EXPECT_PDU:
+               syntax->state = CALYPSO_STATE_PDU_CHECK_EXTRA_CR;
+               break;
+       case G_AT_SYNTAX_EXPECT_MULTILINE:
+               syntax->state = CALYPSO_STATE_GUESS_MULTILINE_RESPONSE;
+               break;
+       default:
+               break;
+       };
+}
+
+static GAtSyntaxResult calypso_feed(GAtSyntax *syntax,
+                                       const char *bytes, gsize *len)
+{
+       gsize i = 0;
+       GAtSyntaxResult res = G_AT_SYNTAX_RESULT_UNSURE;
+
+       while (i < *len) {
+               char byte = bytes[i];
+
+               switch (syntax->state) {
+               case CALYPSO_STATE_IDLE:
+                       if (byte == '\r')
+                               syntax->state = CALYPSO_STATE_INITIAL_CR;
+                       else
+                               syntax->state = CALYPSO_STATE_RESPONSE;
+                       break;
+
+               case CALYPSO_STATE_INITIAL_CR:
+                       if (byte == '\n')
+                               syntax->state = CALYPSO_STATE_INITIAL_LF;
+                       break;
+
+               case CALYPSO_STATE_INITIAL_LF:
+                       if (byte == '\r')
+                               syntax->state = CALYPSO_STATE_TERMINATOR_CR;
+                       else if (byte == '>')
+                               syntax->state = CALYPSO_STATE_PROMPT;
+                       else
+                               syntax->state = CALYPSO_STATE_RESPONSE;
+                       break;
+
+               case CALYPSO_STATE_RESPONSE:
+                       if (byte == '\r')
+                               syntax->state = CALYPSO_STATE_TERMINATOR_CR;
+                       break;
+
+               case CALYPSO_STATE_TERMINATOR_CR:
+                       syntax->state = CALYPSO_STATE_IDLE;
+
+                       if (byte == '\n') {
+                               i += 1;
+                               res = G_AT_SYNTAX_RESULT_LINE;
+                       } else
+                               res = G_AT_SYNTAX_RESULT_UNRECOGNIZED;
+
+                       goto out;
+
+               case CALYPSO_STATE_GUESS_MULTILINE_RESPONSE:
+                       if (byte == '\r')
+                               syntax->state = CALYPSO_STATE_INITIAL_CR;
+                       else
+                               syntax->state = CALYPSO_STATE_MULTILINE_RESPONSE;
+                       break;
+
+               case CALYPSO_STATE_MULTILINE_RESPONSE:
+                       if (byte == '\r')
+                               syntax->state = CALYPSO_STATE_MULTILINE_TERMINATOR_CR;
+                       break;
+
+               case CALYPSO_STATE_MULTILINE_TERMINATOR_CR:
+                       syntax->state = CALYPSO_STATE_IDLE;
+
+                       if (byte == '\n') {
+                               i += 1;
+                               res = G_AT_SYNTAX_RESULT_MULTILINE;
+                       } else
+                               res = G_AT_SYNTAX_RESULT_UNRECOGNIZED;
+
+                       goto out;
+
+               case CALYPSO_STATE_PDU_CHECK_EXTRA_CR:
+                       if (byte == '\r')
+                               syntax->state = CALYPSO_STATE_PDU_CHECK_EXTRA_LF;
+                       else
+                               syntax->state = CALYPSO_STATE_PDU;
+                       break;
+
+               case CALYPSO_STATE_PDU_CHECK_EXTRA_LF:
+                       res = G_AT_SYNTAX_RESULT_UNRECOGNIZED;
+                       syntax->state = CALYPSO_STATE_PDU;
+
+                       if (byte == '\n')
+                               i += 1;
+
+                       goto out;
+
+               case CALYPSO_STATE_PDU:
+                       if (byte == '\r')
+                               syntax->state = CALYPSO_STATE_PDU_CR;
+                       break;
+
+               case CALYPSO_STATE_PDU_CR:
+                       syntax->state = CALYPSO_STATE_IDLE;
+
+                       if (byte == '\n') {
+                               i += 1;
+                               res = G_AT_SYNTAX_RESULT_PDU;
+                       } else
+                               res = G_AT_SYNTAX_RESULT_UNRECOGNIZED;
+
+                       goto out;
+
+               case CALYPSO_STATE_PROMPT:
+                       if (byte == ' ') {
+                               syntax->state = CALYPSO_STATE_IDLE;
+                               i += 1;
+                               res = G_AT_SYNTAX_RESULT_PROMPT;
+                               goto out;
+                       }
+
+                       syntax->state = CALYPSO_STATE_RESPONSE;
+                       return G_AT_SYNTAX_RESULT_UNSURE;
+
+               default:
+                       break;
+               };
+
+               i += 1;
+       }
+
+out:
+       *len = i;
+       return res;
+}
+
+struct calypso_data {
+       GAtChat *chat;
+       enum powercycle_state state;
+       gboolean phonebook_added;
+       gboolean sms_added;
+};
+
+static void calypso_debug(const char *str, void *data)
+{
+       DBG("%s", str);
+}
+
+static int calypso_probe(struct ofono_modem *modem)
+{
+       const char *device;
+       struct calypso_data *data;
+
+       DBG("");
+
+       device = ofono_modem_get_string(modem, "Device");
+       if (device == NULL)
+               return -EINVAL;
+
+       DBG("%s", device);
+
+       data = g_new0(struct calypso_data, 1);
+
+       ofono_modem_set_data(modem, data);
+
+       return 0;
+}
+
+static void calypso_remove(struct ofono_modem *modem)
+{
+       struct calypso_data *data = ofono_modem_get_data(modem);
+
+       DBG("");
+
+       g_free(data);
+}
+
+static void cstat_notify(GAtResult *result, gpointer user_data)
+{
+       struct ofono_modem *modem = user_data;
+       struct calypso_data *data = ofono_modem_get_data(modem);
+       GAtResultIter iter;
+       const char *stat;
+       int enabled;
+
+       DBG("phonebook: %d, sms: %d", data->phonebook_added, data->sms_added);
+
+       g_at_result_iter_init(&iter, result);
+
+       if (!g_at_result_iter_next(&iter, "%CSTAT:"))
+               return;
+
+       if (!g_at_result_iter_next_unquoted_string(&iter, &stat))
+               return;
+
+       if (!g_at_result_iter_next_number(&iter, &enabled))
+               return;
+
+       DBG("stat: %s, enabled: %d", stat, enabled);
+
+       if (!g_strcmp0(stat, "PHB") && enabled == 1 && !data->phonebook_added) {
+               data->phonebook_added = TRUE;
+               ofono_phonebook_create(modem, 0, "atmodem", data->chat);
+       }
+
+       if (!g_strcmp0(stat, "SMS") && enabled == 1 && !data->sms_added) {
+               data->sms_added = TRUE;
+               ofono_sms_create(modem, 0, "atmodem", data->chat);
+       }
+}
+
+static void setup_modem(struct ofono_modem *modem)
+{
+       struct calypso_data *data = ofono_modem_get_data(modem);
+
+       g_at_chat_send(data->chat, "AT%CUNS=0", NULL, NULL, NULL, NULL);
+       g_at_chat_send(data->chat, "AT%CSTAT=1", NULL, NULL, NULL, NULL);
+       g_at_chat_send(data->chat, "@ST=\"-26\"", NULL, NULL, NULL, NULL);
+       g_at_chat_send(data->chat, "%SLEEP=2", NULL, NULL, NULL, NULL);
+       g_at_chat_send(data->chat, "+CLVL=255", NULL, NULL, NULL, NULL);
+
+       g_at_chat_register(data->chat, "%CSTAT:", cstat_notify, FALSE,
+                               modem, NULL);
+}
+
+static void cfun_set_on_cb(gboolean ok, GAtResult *result, gpointer user_data)
+{
+       struct ofono_modem *modem = user_data;
+
+       DBG("");
+
+       setup_modem(modem);
+       ofono_modem_set_powered(modem, ok);
+}
+
+static void modem_initialize(struct ofono_modem *modem)
+{
+       struct calypso_data *data = ofono_modem_get_data(modem);
+       GAtSyntax *syntax;
+       GAtChat *chat;
+       const char *device;
+       GIOChannel *io;
+       int sk;
+       struct termios ti;
+
+       DBG("");
+
+       device = ofono_modem_get_string(modem, "Device");
+
+       sk = open(device, O_RDWR | O_NOCTTY);
+
+       if (sk < 0)
+               goto error;
+
+       tcflush(sk, TCIOFLUSH);
+
+       /* Switch TTY to raw mode */
+       memset(&ti, 0, sizeof(ti));
+       cfmakeraw(&ti);
+
+       cfsetospeed(&ti, B115200);
+       cfsetispeed(&ti, B115200);
+
+       ti.c_cflag &= ~(PARENB);
+       ti.c_cflag &= ~(CSTOPB);
+       ti.c_cflag &= ~(CSIZE);
+       ti.c_cflag |= CS8;
+       ti.c_cflag |= CRTSCTS;
+       ti.c_cflag |= CLOCAL;
+       ti.c_iflag |= (IXON | IXOFF | IXANY);
+       ti.c_cc[VSTART] = 17;
+       ti.c_cc[VSTOP] = 19;
+
+       tcsetattr(sk, TCSANOW, &ti);
+
+       io = g_io_channel_unix_new(sk);
+       g_io_channel_set_close_on_unref(io, TRUE);
+
+       /* Calypso is normally compliant to 27.007, except the vendor-specific
+        * notifications (like %CSTAT) are not prefixed by \r\n
+        */
+       syntax = g_at_syntax_new_full(calypso_feed, calypso_hint,
+                                       CALYPSO_STATE_IDLE);
+       chat = g_at_chat_new(io, syntax);
+       g_at_syntax_unref(syntax);
+       g_io_channel_unref(io);
+
+       if (chat == NULL)
+               goto error;
+
+       if (getenv("OFONO_AT_DEBUG") != NULL)
+               g_at_chat_set_debug(chat, calypso_debug, NULL);
+
+       g_at_chat_set_wakeup_command(chat, "\r", 1000, 5000);
+
+       g_at_chat_send(chat, "ATE0", NULL, NULL, NULL, NULL);
+
+       /* power up modem */
+       g_at_chat_send(chat, "AT+CFUN=1", NULL, cfun_set_on_cb, modem, NULL);
+
+       data->chat = chat;
+
+       return;
+
+error:
+       ofono_modem_set_powered(modem, FALSE);
+}
+
+static gboolean write_file(const char *file, gboolean on)
+{
+       int fd;
+       int r;
+
+       fd = open(file, O_WRONLY);
+
+       if (fd == -1)
+               return FALSE;
+
+       DBG("%s, %s", file, on ? "1" : "0");
+
+       if (on)
+               r = write(fd, "1\n", 2);
+       else
+               r = write(fd, "0\n", 2);
+
+       close(fd);
+
+       return r > 0 ? TRUE : FALSE;
+}
+
+static gboolean poweron_cycle(gpointer user_data)
+{
+       struct ofono_modem *modem = user_data;
+       struct calypso_data *data = ofono_modem_get_data(modem);
+
+       switch (data->state) {
+               case POWERCYCLE_STATE_POWER0:
+                       if (write_file(CALYPSO_RESET_PATH, FALSE)) {
+                               data->state = POWERCYCLE_STATE_RESET0;
+                               return TRUE;
+                       }
+
+                       break;
+
+               case POWERCYCLE_STATE_RESET0:
+                       if (write_file(CALYPSO_POWER_PATH, TRUE)) {
+                               data->state = POWERCYCLE_STATE_POWER1;
+                               return TRUE;
+                       }
+
+                       break;
+               case POWERCYCLE_STATE_POWER1:
+                       if (write_file(CALYPSO_RESET_PATH, TRUE)) {
+                               data->state = POWERCYCLE_STATE_RESET1;
+                               return TRUE;
+                       }
+
+                       break;
+               case POWERCYCLE_STATE_RESET1:
+                       if (write_file(CALYPSO_RESET_PATH, FALSE)) {
+                               data->state = POWERCYCLE_STATE_FINISHED;
+                               return TRUE;
+                       }
+
+                       break;
+               case POWERCYCLE_STATE_FINISHED:
+                       modem_initialize(modem);
+                       return FALSE;
+               default:
+                       break;
+       };
+
+       ofono_modem_set_powered(modem, FALSE);
+       return FALSE;
+}
+
+/* power up hardware */
+static int calypso_enable(struct ofono_modem *modem)
+{
+       struct calypso_data *data = ofono_modem_get_data(modem);
+
+       if (write_file(CALYPSO_POWER_PATH, FALSE) == FALSE)
+               return -EINVAL;
+
+       data->state = POWERCYCLE_STATE_POWER0;
+       g_timeout_add_seconds(1, poweron_cycle, modem);
+
+       return -EINPROGRESS;
+}
+
+static int calypso_disable(struct ofono_modem *modem)
+{
+       struct calypso_data *data = ofono_modem_get_data(modem);
+
+       DBG("");
+
+       g_at_chat_unref(data->chat);
+       data->chat = NULL;
+
+       data->phonebook_added = FALSE;
+       data->sms_added = FALSE;
+
+       if (write_file(CALYPSO_POWER_PATH, FALSE))
+               return 0;
+
+       return -EINVAL;
+}
+
+static void calypso_populate(struct ofono_modem *modem)
+{
+       struct calypso_data *data = ofono_modem_get_data(modem);
+       struct ofono_message_waiting *mw;
+
+       DBG("");
+
+       ofono_devinfo_create(modem, 0, "atmodem", data->chat);
+       ofono_ussd_create(modem, 0, "atmodem", data->chat);
+       ofono_sim_create(modem, 0, "atmodem", data->chat);
+       ofono_call_forwarding_create(modem, 0, "atmodem", data->chat);
+       ofono_call_settings_create(modem, 0, "atmodem", data->chat);
+       ofono_netreg_create(modem, OFONO_VENDOR_CALYPSO, "atmodem", data->chat);
+       ofono_voicecall_create(modem, 0, "atmodem", data->chat);
+       ofono_call_meter_create(modem, 0, "atmodem", data->chat);
+       ofono_call_barring_create(modem, 0, "atmodem", data->chat);
+       ofono_ssn_create(modem, 0, "atmodem", data->chat);
+
+       mw = ofono_message_waiting_create(modem);
+       if (mw)
+               ofono_message_waiting_register(mw);
+}
+
+static struct ofono_modem_driver calypso_driver = {
+       .name           = "calypso",
+       .probe          = calypso_probe,
+       .remove         = calypso_remove,
+       .enable         = calypso_enable,
+       .disable        = calypso_disable,
+       .populate       = calypso_populate,
+};
+
+static int calypso_init(void)
+{
+       return ofono_modem_driver_register(&calypso_driver);
+}
+
+static void calypso_exit(void)
+{
+       ofono_modem_driver_unregister(&calypso_driver);
+}
+
+OFONO_PLUGIN_DEFINE(calypso, "TI Calypso modem driver", VERSION,
+                       OFONO_PLUGIN_PRIORITY_DEFAULT,
+                       calypso_init, calypso_exit)