From 78b853a97ddcfd6152108277dc1d5e825c477413 Mon Sep 17 00:00:00 2001 From: Denis Kenzior Date: Thu, 10 Sep 2009 16:10:14 -0500 Subject: [PATCH] Add initial Cell Broadcast atom implementation --- Makefile.am | 6 +- include/cbs.h | 65 ++++++ src/cbs.c | 552 ++++++++++++++++++++++++++++++++++++++++++++++++++ src/ofono.h | 2 + 4 files changed, 623 insertions(+), 2 deletions(-) create mode 100644 include/cbs.h create mode 100644 src/cbs.c diff --git a/Makefile.am b/Makefile.am index f259015d..4ba6f696 100644 --- a/Makefile.am +++ b/Makefile.am @@ -9,7 +9,8 @@ include_HEADERS = include/log.h include/plugin.h include/history.h \ include/call-meter.h include/call-settings.h \ include/phonebook.h include/ssn.h include/ussd.h \ include/sms.h include/sim.h include/message-waiting.h \ - include/netreg.h include/voicecall.h include/devinfo.h + include/netreg.h include/voicecall.h include/devinfo.h \ + include/cbs.h nodist_include_HEADERS = include/version.h @@ -158,7 +159,8 @@ src_ofonod_SOURCES = $(gdbus_sources) $(builtin_sources) \ src/call-meter.c src/smsutil.h src/smsutil.c \ src/ssn.c src/call-barring.c src/sim.c \ src/phonebook.c src/history.c src/message-waiting.c \ - src/simutil.h src/simutil.c src/storage.h src/storage.c + src/simutil.h src/simutil.c src/storage.h \ + src/storage.c src/cbs.c src_ofonod_LDADD = $(builtin_libadd) \ @GLIB_LIBS@ @GTHREAD_LIBS@ @DBUS_LIBS@ -ldl diff --git a/include/cbs.h b/include/cbs.h new file mode 100644 index 00000000..7fc9b772 --- /dev/null +++ b/include/cbs.h @@ -0,0 +1,65 @@ +/* + * + * 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 + * + */ + +#ifndef __OFONO_CBS_H +#define __OFONO_CBS_H + +#ifdef __cplusplus +extern "C" { +#endif + +#include + +struct ofono_cbs; + +typedef void (*ofono_cbs_set_cb_t)(const struct ofono_error *error, + void *data); + +struct ofono_cbs_driver { + const char *name; + int (*probe)(struct ofono_cbs *cbs, unsigned int vendor, void *data); + void (*remove)(struct ofono_cbs *cbs); + void (*set_topics)(struct ofono_cbs *cbs, const char *topics, + ofono_cbs_set_cb_t cb, void *data); + void (*clear_topics)(struct ofono_cbs *cbs, + ofono_cbs_set_cb_t cb, void *data); +}; + +void ofono_cbs_notify(struct ofono_cbs *cbs, const unsigned char *pdu, int len); + +int ofono_cbs_driver_register(const struct ofono_cbs_driver *d); +void ofono_cbs_driver_unregister(const struct ofono_cbs_driver *d); + +struct ofono_cbs *ofono_cbs_create(struct ofono_modem *modem, + unsigned int vendor, + const char *driver, void *data); + +void ofono_cbs_register(struct ofono_cbs *cbs); +void ofono_cbs_remove(struct ofono_cbs *cbs); + +void ofono_cbs_set_data(struct ofono_cbs *cbs, void *data); +void *ofono_cbs_get_data(struct ofono_cbs *cbs); + +#ifdef __cplusplus +} +#endif + +#endif /* __OFONO_CBS_H */ diff --git a/src/cbs.c b/src/cbs.c new file mode 100644 index 00000000..01f2464b --- /dev/null +++ b/src/cbs.c @@ -0,0 +1,552 @@ +/* + * + * 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 +#endif + +#include +#include +#include + +#include +#include + +#include "ofono.h" + +#include "common.h" +#include "util.h" +#include "smsutil.h" + +#define CBS_MANAGER_INTERFACE "org.ofono.CbsManager" + +static GSList *g_drivers = NULL; + +enum etws_topic_type { + ETWS_TOPIC_TYPE_EARTHQUAKE = 4352, + ETWS_TOPIC_TYPE_TSUNAMI = 4353, + ETWS_TOPIC_TYPE_EARTHQUAKE_TSUNAMI = 4354, + ETWS_TOPIC_TYPE_TEST = 4355, + ETWS_TOPIC_TYPE_EMERGENCY = 4356, +}; + +struct ofono_cbs { + DBusMessage *pending; + struct cbs_assembly *assembly; + GSList *topics; + GSList *new_topics; + struct ofono_sim *sim; + unsigned int sim_watch; + unsigned int imsi_watch; + const struct ofono_cbs_driver *driver; + void *driver_data; + struct ofono_atom *atom; +}; + +static void cbs_dispatch_base_station_id(struct ofono_cbs *cbs, const char *id) +{ + ofono_debug("Base station id: %s", id); +} + +static void cbs_dispatch_emergency(struct ofono_cbs *cbs, const char *message, + enum etws_topic_type topic, + gboolean alert, gboolean popup) +{ + DBusConnection *conn = ofono_dbus_get_connection(); + const char *path = __ofono_atom_get_path(cbs->atom); + DBusMessage *signal; + DBusMessageIter iter; + DBusMessageIter dict; + dbus_bool_t boolean; + const char *emergency_str; + + if (topic == ETWS_TOPIC_TYPE_TEST) { + ofono_error("Explicitly ignoring ETWS Test messages"); + return; + } + + switch (topic) { + case ETWS_TOPIC_TYPE_EARTHQUAKE: + emergency_str = "Earthquake"; + break; + case ETWS_TOPIC_TYPE_TSUNAMI: + emergency_str = "Tsunami"; + break; + case ETWS_TOPIC_TYPE_EARTHQUAKE_TSUNAMI: + emergency_str = "Earthquake+Tsunami"; + break; + case ETWS_TOPIC_TYPE_EMERGENCY: + emergency_str = "Other"; + break; + default: + return; + }; + + signal = dbus_message_new_signal(path, CBS_MANAGER_INTERFACE, + "EmergencyBroadcast"); + + if (!signal) + return; + + dbus_message_iter_init_append(signal, &iter); + + dbus_message_iter_append_basic(&iter, DBUS_TYPE_STRING, &message); + + dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY, + OFONO_PROPERTIES_ARRAY_SIGNATURE, + &dict); + + ofono_dbus_dict_append(&dict, "EmergencyType", + DBUS_TYPE_STRING, &emergency_str); + + boolean = alert; + ofono_dbus_dict_append(&dict, "EmergencyAlert", + DBUS_TYPE_BOOLEAN, &boolean); + + boolean = popup; + ofono_dbus_dict_append(&dict, "Popup", DBUS_TYPE_BOOLEAN, &boolean); + + dbus_message_iter_close_container(&iter, &dict); + g_dbus_send_message(conn, signal); +} + +static void cbs_dispatch_text(struct ofono_cbs *cbs, enum sms_class cls, + unsigned short channel, const char *message) +{ + DBusConnection *conn = ofono_dbus_get_connection(); + const char *path = __ofono_atom_get_path(cbs->atom); + DBusMessage *signal; + DBusMessageIter iter; + + g_dbus_emit_signal(conn, path, CBS_MANAGER_INTERFACE, + "IncomingBroadcast", + DBUS_TYPE_STRING, &message, + DBUS_TYPE_UINT16, &channel, + DBUS_TYPE_INVALID); +} + +void ofono_cbs_notify(struct ofono_cbs *cbs, const unsigned char *pdu, + int pdu_len) +{ + struct cbs c; + enum sms_class cls; + gboolean udhi; + gboolean comp; + GSList *cbs_list; + enum sms_charset charset; + char *message; + char iso639_lang[3]; + + if (cbs->assembly == NULL) + return; + + if (!cbs_decode(pdu, pdu_len, &c)) { + ofono_error("Unable to decode CBS PDU"); + return; + } + + if (!cbs_dcs_decode(c.dcs, &udhi, &cls, &charset, &comp, NULL, NULL)) { + ofono_error("Unknown / Reserved DCS. Ignoring"); + return; + } + + if (udhi) { + ofono_error("CBS messages with UDH not supported"); + return; + } + + if (charset == SMS_CHARSET_8BIT) { + ofono_error("Datagram CBS not supported"); + return; + } + + if (comp) { + ofono_error("CBS messages with compression not supported"); + return; + } + + cbs_list = cbs_assembly_add_page(cbs->assembly, &c); + + if (cbs_list == NULL) + return; + + message = cbs_decode_text(cbs_list, iso639_lang); + + if (message == NULL) + goto out; + + if (c.message_identifier >= ETWS_TOPIC_TYPE_EARTHQUAKE && + c.message_identifier <= ETWS_TOPIC_TYPE_EMERGENCY) { + gboolean alert = FALSE; + gboolean popup = FALSE; + + /* 3GPP 23.041 9.4.1.2.1: Alert is encoded in bit 9 */ + if (c.message_code & (1 << 9)) + alert = TRUE; + + /* 3GPP 23.041 9.4.1.2.1: Popup is encoded in bit 8 */ + if (c.message_code & (1 << 8)) + popup = TRUE; + + cbs_dispatch_emergency(cbs, message, + c.message_identifier, alert, popup); + goto out; + } + + /* 3GPP 23.041: NOTE 5: Code 00 is intended for use by the + * network operators for base station IDs. + */ + if (c.gs == CBS_GEO_SCOPE_CELL_IMMEDIATE) { + cbs_dispatch_base_station_id(cbs, message); + goto out; + } + + cbs_dispatch_text(cbs, cls, c.message_identifier, message); + +out: + g_free(message); + g_slist_foreach(cbs_list, (GFunc)g_free, NULL); + g_slist_free(cbs_list); +} + +static DBusMessage *cbs_get_properties(DBusConnection *conn, + DBusMessage *msg, void *data) +{ + struct ofono_cbs *cbs = data; + DBusMessage *reply; + DBusMessageIter iter, dict; + char *topics; + + reply = dbus_message_new_method_return(msg); + + if (!reply) + return NULL; + + dbus_message_iter_init_append(reply, &iter); + + dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY, + OFONO_PROPERTIES_ARRAY_SIGNATURE, + &dict); + + topics = cbs_topic_ranges_to_string(cbs->topics); + ofono_dbus_dict_append(&dict, "Topics", DBUS_TYPE_STRING, &topics); + g_free(topics); + + dbus_message_iter_close_container(&iter, &dict); + + return reply; +} + +static void cbs_set_topics_cb(const struct ofono_error *error, void *data) +{ + struct ofono_cbs *cbs = data; + const char *path = __ofono_atom_get_path(cbs->atom); + DBusConnection *conn = ofono_dbus_get_connection(); + DBusMessage *reply; + char *topics; + + if (error->type != OFONO_ERROR_TYPE_NO_ERROR) { + g_slist_foreach(cbs->new_topics, (GFunc)g_free, NULL); + g_slist_free(cbs->new_topics); + cbs->new_topics = NULL; + + ofono_debug("Setting Cell Broadcast topics failed"); + __ofono_dbus_pending_reply(&cbs->pending, + __ofono_error_failed(cbs->pending)); + return; + } + + g_slist_foreach(cbs->topics, (GFunc)g_free, NULL); + g_slist_free(cbs->topics); + cbs->topics = cbs->new_topics; + cbs->new_topics = NULL; + + reply = dbus_message_new_method_return(cbs->pending); + __ofono_dbus_pending_reply(&cbs->pending, reply); + + topics = cbs_topic_ranges_to_string(cbs->topics); + ofono_dbus_signal_property_changed(conn, path, + CBS_MANAGER_INTERFACE, + "Topics", + DBUS_TYPE_STRING, &topics); + g_free(topics); +} + +static DBusMessage *cbs_set_topics(struct ofono_cbs *cbs, const char *value, + DBusMessage *msg) +{ + GSList *topics; + GSList *etws_topics = NULL; + char *topic_str; + struct cbs_topic_range etws_range = { 4352, 4356 }; + + topics = cbs_extract_topic_ranges(value); + + if (topics == NULL && value[0] != '\0') + return __ofono_error_invalid_format(msg); + + if (!cbs->driver->set_topics) + return __ofono_error_not_implemented(msg); + + cbs->new_topics = topics; + + if (topics != NULL) + etws_topics = g_slist_copy(topics); + + etws_topics = g_slist_append(etws_topics, &etws_range); + topic_str = cbs_topic_ranges_to_string(etws_topics); + g_slist_free(etws_topics); + + cbs->pending = dbus_message_ref(msg); + cbs->driver->set_topics(cbs, topic_str, cbs_set_topics_cb, cbs); + g_free(topic_str); + + return NULL; +} + +static DBusMessage *cbs_set_property(DBusConnection *conn, DBusMessage *msg, + void *data) +{ + struct ofono_cbs *cbs = data; + DBusMessageIter iter; + DBusMessageIter var; + const char *property; + + if (cbs->pending) + return __ofono_error_busy(msg); + + if (!dbus_message_iter_init(msg, &iter)) + return __ofono_error_invalid_args(msg); + + if (dbus_message_iter_get_arg_type(&iter) != DBUS_TYPE_STRING) + return __ofono_error_invalid_args(msg); + + dbus_message_iter_get_basic(&iter, &property); + dbus_message_iter_next(&iter); + + if (dbus_message_iter_get_arg_type(&iter) != DBUS_TYPE_VARIANT) + return __ofono_error_invalid_args(msg); + + dbus_message_iter_recurse(&iter, &var); + + if (!strcmp(property, "Topics")) { + const char *value; + + if (dbus_message_iter_get_arg_type(&var) != DBUS_TYPE_STRING) + return __ofono_error_invalid_args(msg); + + dbus_message_iter_get_basic(&var, &value); + + return cbs_set_topics(cbs, value, msg); + } + + return __ofono_error_invalid_args(msg); +} + +static GDBusMethodTable cbs_manager_methods[] = { + { "GetProperties", "", "a{sv}", cbs_get_properties }, + { "SetProperty", "sv", "", cbs_set_property, + G_DBUS_METHOD_FLAG_ASYNC }, + { } +}; + +static GDBusSignalTable cbs_manager_signals[] = { + { "PropertyChanged", "sv" }, + { "IncomingBroadcast", "sq" }, + { "EmergencyBroadcast", "sa{sv}" }, + { } +}; + +int ofono_cbs_driver_register(const struct ofono_cbs_driver *d) +{ + DBG("driver: %p, name: %s", d, d->name); + + if (d->probe == NULL) + return -EINVAL; + + g_drivers = g_slist_prepend(g_drivers, (void *)d); + + return 0; +} + +void ofono_cbs_driver_unregister(const struct ofono_cbs_driver *d) +{ + DBG("driver: %p, name: %s", d, d->name); + + g_drivers = g_slist_remove(g_drivers, (void *)d); +} + +static void cbs_unregister(struct ofono_atom *atom) +{ + struct ofono_cbs *cbs = __ofono_atom_get_data(atom); + DBusConnection *conn = ofono_dbus_get_connection(); + struct ofono_modem *modem = __ofono_atom_get_modem(atom); + const char *path = __ofono_atom_get_path(atom); + + g_dbus_unregister_interface(conn, path, CBS_MANAGER_INTERFACE); + ofono_modem_remove_interface(modem, CBS_MANAGER_INTERFACE); + + if (cbs->sim_watch) { + if (cbs->imsi_watch) { + ofono_sim_remove_ready_watch(cbs->sim, + cbs->imsi_watch); + cbs->imsi_watch = 0; + } + + __ofono_modem_remove_atom_watch(modem, cbs->sim_watch); + cbs->sim_watch = 0; + } +} + +static void cbs_remove(struct ofono_atom *atom) +{ + struct ofono_cbs *cbs = __ofono_atom_get_data(atom); + + DBG("atom: %p", atom); + + if (cbs == NULL) + return; + + if (cbs->driver && cbs->driver->remove) + cbs->driver->remove(cbs); + + if (cbs->assembly) { + cbs_assembly_free(cbs->assembly); + cbs->assembly = NULL; + } + + g_free(cbs); +} + +struct ofono_cbs *ofono_cbs_create(struct ofono_modem *modem, + unsigned int vendor, + const char *driver, + void *data) +{ + struct ofono_cbs *cbs; + GSList *l; + + if (driver == NULL) + return NULL; + + cbs = g_try_new0(struct ofono_cbs, 1); + + if (cbs == NULL) + return NULL; + + cbs->assembly = cbs_assembly_new(); + cbs->atom = __ofono_modem_add_atom(modem, OFONO_ATOM_TYPE_CBS, + cbs_remove, cbs); + + for (l = g_drivers; l; l = l->next) { + const struct ofono_cbs_driver *drv = l->data; + + if (g_strcmp0(drv->name, driver)) + continue; + + if (drv->probe(cbs, vendor, data) < 0) + continue; + + cbs->driver = drv; + break; + } + + return cbs; +} + +static void cbs_got_imsi(void *data) +{ + struct ofono_cbs *cbs = data; + const char *imsi = ofono_sim_get_imsi(cbs->sim); + + ofono_debug("Got IMSI: %s", imsi); +} + +static void sim_watch(struct ofono_atom *atom, + enum ofono_atom_watch_condition cond, void *data) +{ + struct ofono_cbs *cbs = data; + + if (cond == OFONO_ATOM_WATCH_CONDITION_UNREGISTERED) { + cbs->imsi_watch = 0; + + if (cbs->assembly) { + cbs_assembly_free(cbs->assembly); + cbs->assembly = NULL; + } + + return; + } + + cbs->sim = __ofono_atom_get_data(atom); + cbs->imsi_watch = ofono_sim_add_ready_watch(cbs->sim, cbs_got_imsi, + cbs, NULL); + + if (ofono_sim_get_ready(cbs->sim)) + cbs_got_imsi(cbs); +} + +void ofono_cbs_register(struct ofono_cbs *cbs) +{ + DBusConnection *conn = ofono_dbus_get_connection(); + struct ofono_modem *modem = __ofono_atom_get_modem(cbs->atom); + const char *path = __ofono_atom_get_path(cbs->atom); + struct ofono_atom *sim_atom; + + if (!g_dbus_register_interface(conn, path, + CBS_MANAGER_INTERFACE, + cbs_manager_methods, + cbs_manager_signals, + NULL, cbs, NULL)) { + ofono_error("Could not create %s interface", + CBS_MANAGER_INTERFACE); + return; + } + + ofono_modem_add_interface(modem, CBS_MANAGER_INTERFACE); + + cbs->sim_watch = __ofono_modem_add_atom_watch(modem, + OFONO_ATOM_TYPE_SIM, + sim_watch, cbs, NULL); + + sim_atom = __ofono_modem_find_atom(modem, OFONO_ATOM_TYPE_SIM); + + if (sim_atom && __ofono_atom_get_registered(sim_atom)) + sim_watch(sim_atom, + OFONO_ATOM_WATCH_CONDITION_REGISTERED, cbs); + + __ofono_atom_register(cbs->atom, cbs_unregister); +} + +void ofono_cbs_remove(struct ofono_cbs *cbs) +{ + __ofono_atom_free(cbs->atom); +} + +void ofono_cbs_set_data(struct ofono_cbs *cbs, void *data) +{ + cbs->driver_data = data; +} + +void *ofono_cbs_get_data(struct ofono_cbs *cbs) +{ + return cbs->driver_data; +} diff --git a/src/ofono.h b/src/ofono.h index ffafae80..79226b04 100644 --- a/src/ofono.h +++ b/src/ofono.h @@ -84,6 +84,7 @@ enum ofono_atom_type { OFONO_ATOM_TYPE_HISTORY = 11, OFONO_ATOM_TYPE_SSN = 12, OFONO_ATOM_TYPE_MESSAGE_WAITING = 13, + OFONO_ATOM_TYPE_CBS = 14, }; enum ofono_atom_watch_condition { @@ -131,6 +132,7 @@ void __ofono_atom_free(struct ofono_atom *atom); #include #include #include +#include #include #include #include