[PATCH v2] qmimodem: support wake on SMS receive

Some modems, like Quectel EC25, support waking the host platform from a suspend state upon an SMS reception. Current SMS handling configures the modem to not save incoming messages. On platforms where the modem's interfaces (eg, cdc-wdm, wwan, etc) disconnect on suspend and reconnect on resume, oFono will re-initialize. This can cause lost messages upon resume because the QMI indication is sent before oFono is ready. Changes to support suspend/resume with wake on SMS: - On startup: 1. Configure modem to save messages to NV and notify for class NONE. 2. Delete all processed messages in modem memory to free space. 3. Get list of unread messages, then get and delete each. - After startup: 1. Process message upon event indication and delete. 2. Then check for possibly more messages to process. --- drivers/qmimodem/sms.c | 344 +++++++++++++++++++++++++++++++++++++++++-------- drivers/qmimodem/wms.h | 77 ++++++++--- 2 files changed, 348 insertions(+), 73 deletions(-) diff --git a/drivers/qmimodem/sms.c b/drivers/qmimodem/sms.c index 1e93039..73af9fe 100644 --- a/drivers/qmimodem/sms.c +++ b/drivers/qmimodem/sms.c @@ -39,8 +39,15 @@ struct sms_data { struct qmi_service *wms; uint16_t major; uint16_t minor; + struct qmi_wms_read_msg_id rd_msg_id; + uint8_t msg_mode; + bool msg_chk_all; + bool msg_list_chk; }; +static void get_msg_list(struct ofono_sms *sms); + + static void get_smsc_addr_cb(struct qmi_result *result, void *user_data) { struct cb_data *cbd = user_data; @@ -334,21 +341,81 @@ error: g_free(cbd); } -static void raw_read_cb(struct qmi_result *result, void *user_data) +static void delete_msg_cb(struct qmi_result *result, void *user_data) { struct ofono_sms *sms = user_data; - const struct qmi_wms_raw_message* msg; - uint16_t len; - uint16_t error; + uint16_t err; - if (qmi_result_set_error(result, &error)) { - DBG("Raw read error: %d (%s)", error, - qmi_result_get_error(result)); + DBG(""); + + if (qmi_result_set_error(result, &err)) + DBG("Err: delete %d - %s", err, qmi_result_get_error(result)); + else { + DBG("msg deleted"); + + /* check for more messages */ + get_msg_list(sms); + } +} + +static void delete_msg(struct ofono_sms *sms, uint8_t tag) { + struct sms_data *data = ofono_sms_get_data(sms); + struct qmi_param *param; + qmi_result_func_t func = NULL; + + DBG(""); + + param = qmi_param_new(); + if (param == NULL) + goto done; + + qmi_param_append_uint8(param, QMI_WMS_PARAM_DEL_STORE, + QMI_WMS_STORAGE_TYPE_NV); + + if (tag == QMI_WMS_MT_UNDEFINE) { + DBG("delete read msg type %d ndx %d", data->rd_msg_id.type, + data->rd_msg_id.ndx); + + /* delete 1 msg */ + qmi_param_append_uint32(param, QMI_WMS_PARAM_DEL_NDX, + data->rd_msg_id.ndx); + func = delete_msg_cb; + } else { + DBG("delete msg tag %d mode %d", tag, data->msg_mode); + + /* delete all msgs from 1 tag type */ + qmi_param_append_uint8(param, QMI_WMS_PARAM_DEL_TYPE, tag); + } + + qmi_param_append_uint8(param, QMI_WMS_PARAM_DEL_MODE, data->msg_mode); + + if (qmi_service_send(data->wms, QMI_WMS_DELETE, param, + func, sms, NULL) > 0) return; + + qmi_param_free(param); + +done: + return; +} + +static void raw_read_cb(struct qmi_result *result, void *user_data) { + struct ofono_sms *sms = user_data; + struct sms_data *data = ofono_sms_get_data(sms); + const struct qmi_wms_raw_message *msg; + uint16_t err; + + DBG(""); + + if (qmi_result_set_error(result, &err)) { + DBG("Err: read %d - %s", err, qmi_result_get_error(result)); + goto done; } /* Raw message data */ - msg = qmi_result_get(result, 0x01, &len); + msg = qmi_result_get(result, QMI_WMS_RESULT_READ_MSG, NULL); if (msg) { uint16_t plen; uint16_t tpdu_len; @@ -357,9 +424,165 @@ static void raw_read_cb(struct qmi_result *result, void *user_data) tpdu_len = plen - msg->msg_data[0] - 1; ofono_sms_deliver_notify(sms, msg->msg_data, plen, tpdu_len); + } else + DBG("Err: no data in type %d ndx %d", data->rd_msg_id.type, + data->rd_msg_id.ndx); + + /* delete read msg */ + delete_msg(sms, QMI_WMS_MT_UNDEFINE); + +done: + return; +} + +static void raw_read(struct ofono_sms *sms, uint8_t type, uint32_t ndx) +{ + struct sms_data *data = ofono_sms_get_data(sms); + struct qmi_param *param; + + DBG(""); + + param = qmi_param_new(); + if (param == NULL) + goto done; + + data->rd_msg_id.type = type; + data->rd_msg_id.ndx = ndx; + + DBG("read type %d ndx %d", data->rd_msg_id.type, data->rd_msg_id.ndx); + + qmi_param_append(param, QMI_WMS_PARAM_READ_MSG, + sizeof(data->rd_msg_id), &data->rd_msg_id); + qmi_param_append_uint8(param, QMI_WMS_PARAM_READ_MODE, +data->msg_mode); + + if (qmi_service_send(data->wms, QMI_WMS_RAW_READ, param, + raw_read_cb, sms, NULL) > 0) + return; + + qmi_param_free(param); + +done: + return; +} + +static void get_msg_list_cb(struct qmi_result *result, void *user_data) +{ + struct ofono_sms *sms = user_data; + struct sms_data *data = ofono_sms_get_data(sms); + struct qmi_param *param; + const struct qmi_wms_result_msg_list *list; + uint32_t cnt = 0; + uint16_t tmp; + + DBG(""); + + if (qmi_result_set_error(result, &tmp)) { + DBG("Err: get msg list %d - %s", tmp, + qmi_result_get_error(result)); + goto done; + } + + list = qmi_result_get(result, QMI_WMS_RESULT_MSG_LIST, NULL); + if (list == NULL) { + DBG("Err: get msg list empty"); + goto done; + } + + cnt = GUINT32_FROM_LE(list->cnt); + DBG("msgs found %d", cnt); + + for (tmp = 0; tmp < cnt; tmp++) { + DBG("unread type %d ndx %d", list->msg[tmp].type, + GUINT32_FROM_LE(list->msg[tmp].ndx)); + } + + /* get 1st msg in list */ + if (cnt) + raw_read(sms, list->msg[0].type, + GUINT32_FROM_LE(list->msg[0].ndx)); + else + data->msg_list_chk = false; + +done: + /* check other protocol if needed */ + if (data->msg_chk_all && (cnt == 0)) { + data->msg_chk_all = false; + data->msg_mode = QMI_WMS_MESSAGE_MODE_GSMWCDMA; + get_msg_list(sms); + } +} + +static void get_msg_list(struct ofono_sms *sms) { + struct sms_data *data = ofono_sms_get_data(sms); + struct qmi_param *param; + + DBG(""); + + param = qmi_param_new(); + if (param == NULL) + goto done; + + data->msg_list_chk = true; + + /* query NOT_READ msg list */ + qmi_param_append_uint8(param, QMI_WMS_PARAM_STORAGE_TYPE, + QMI_WMS_STORAGE_TYPE_NV); + qmi_param_append_uint8(param, QMI_WMS_PARAM_TAG_TYPE, + QMI_WMS_MT_NOT_READ); + qmi_param_append_uint8(param, QMI_WMS_PARAM_MESSAGE_MODE, + data->msg_mode); + + if (qmi_service_send(data->wms, QMI_WMS_GET_MSG_LIST, param, + get_msg_list_cb, sms, NULL) > 0) + return; + + qmi_param_free(param); + +done: + return; +} + +static void get_msg_protocol_cb(struct qmi_result *result, void +*user_data) { + struct ofono_sms *sms = user_data; + struct sms_data *data = ofono_sms_get_data(sms); + uint16_t err; + + DBG(""); + + if (qmi_result_set_error(result, &err) && + (err != QMI_ERR_OP_DEVICE_UNSUPPORTED)) { + DBG("Err: protocol %d - %s", err, qmi_result_get_error(result)); + goto done; + } + + if (err != QMI_ERR_OP_DEVICE_UNSUPPORTED) { + /* modem supports only 1 protocol */ + qmi_result_get_uint8(result, QMI_WMS_PARAM_PROTOCOL, + &data->msg_mode); } else { - DBG("No message data available at requested position"); + /* check both, start with 1 then switch to other */ + DBG("device supports CDMA and WCDMA msg protocol"); + data->msg_chk_all = true; + data->msg_mode = QMI_WMS_MESSAGE_MODE_CDMA; } + + /* check for messages */ + get_msg_list(sms); + +done: + return; +} + +static void get_msg_protocol(struct ofono_sms *sms) { + struct sms_data *data = ofono_sms_get_data(sms); + + DBG(""); + + qmi_service_send(data->wms, QMI_WMS_GET_MSG_PROTOCOL, NULL, + get_msg_protocol_cb, sms, NULL); } static void event_notify(struct qmi_result *result, void *user_data) @@ -367,66 +590,72 @@ static void event_notify(struct qmi_result *result, void *user_data) struct ofono_sms *sms = user_data; struct sms_data *data = ofono_sms_get_data(sms); const struct qmi_wms_result_new_msg_notify *notify; - const struct qmi_wms_result_message *message; - uint16_t len; DBG(""); - notify = qmi_result_get(result, QMI_WMS_RESULT_NEW_MSG_NOTIFY, &len); + notify = qmi_result_get(result, QMI_WMS_RESULT_NEW_MSG_NOTIFY, NULL); if (notify) { - DBG("storage type %d index %d", notify->storage_type, - GUINT32_FROM_LE(notify->storage_index)); - } + /* route is store and notify */ + if (!qmi_result_get_uint8(result, QMI_WMS_RESULT_MSG_MODE, + &data->msg_mode)) + DBG("msg mode not found, use mode %d", data->msg_mode); + + DBG("msg type %d ndx %d mode %d", notify->storage_type, + GUINT32_FROM_LE(notify->storage_index), data->msg_mode); + + /* don't read if list is being processed, will find this msg */ + if (!data->msg_list_chk) + raw_read(sms, notify->storage_type, + GUINT32_FROM_LE(notify->storage_index)); + } else { + const struct qmi_wms_result_message *message; - message = qmi_result_get(result, QMI_WMS_RESULT_MESSAGE, &len); - if (message) { - uint16_t plen; + message = qmi_result_get(result, QMI_WMS_RESULT_MESSAGE, NULL); + if (message) { + /* route is either transfer only or transfer and ACK */ + uint16_t plen; - plen = GUINT16_FROM_LE(message->msg_length); + plen = GUINT16_FROM_LE(message->msg_length); - DBG("ack_required %d transaction id %u", message->ack_required, + DBG("ack_required %d transaction id %u", + message->ack_required, GUINT32_FROM_LE(message->transaction_id)); - DBG("msg format %d PDU length %d", message->msg_format, plen); + DBG("msg format %d PDU length %d", + message->msg_format, plen); - ofono_sms_deliver_notify(sms, message->msg_data, plen, plen); - } else { - /* The Quectel EC21, at least, does not provide the - * message data in the event notification, so a 'raw read' - * needs to be issued in order to query the message itself - */ - struct qmi_param *param; - - param = qmi_param_new(); - if (!param) - return; - - /* Message memory storage ID */ - qmi_param_append(param, 0x01, sizeof(*notify), notify); - /* The 'message mode' parameter is documented as optional, - * but the Quectel EC21 errors out with error 17 (missing - * argument) if it is not provided... we default to 3GPP - * here because that's what works for me and it's not clear - * how to actually query what this should be otherwise... - */ - /* Message mode */ - qmi_param_append_uint8(param, 0x10, - QMI_WMS_MESSAGE_MODE_GSMWCDMA); - - if (qmi_service_send(data->wms, QMI_WMS_RAW_READ, param, - raw_read_cb, sms, NULL) > 0) - return; - - qmi_param_free(param); + ofono_sms_deliver_notify(sms, message->msg_data, + plen, plen); + } } } static void set_routes_cb(struct qmi_result *result, void *user_data) { struct ofono_sms *sms = user_data; + struct sms_data *data = ofono_sms_get_data(sms); DBG(""); ofono_sms_register(sms); + + /* + * Modem storage is limited. As a fail safe, delete processed messages + * to free device memory to prevent blockage of new messages. + */ + data->msg_mode = QMI_WMS_MESSAGE_MODE_CDMA; + delete_msg(sms, QMI_WMS_MT_READ); + delete_msg(sms, QMI_WMS_MO_SENT); + data->msg_mode = QMI_WMS_MESSAGE_MODE_GSMWCDMA; + delete_msg(sms, QMI_WMS_MT_READ); + delete_msg(sms, QMI_WMS_MO_SENT); + + /* + * Subsystem initialized, now start process to check for unread + * messages. First, query msg protocol/mode. If modem supports both + * modes, then check messages for both modes since there's no way to + * query which mode is active. + */ + get_msg_protocol(sms); } static void get_routes_cb(struct qmi_result *result, void *user_data) @@ -445,7 +674,7 @@ static void get_routes_cb(struct qmi_result *result, void *user_data) goto done; list = qmi_result_get(result, QMI_WMS_RESULT_ROUTE_LIST, &len); - if (!list) + if (!list) goto done; num = GUINT16_FROM_LE(list->count); @@ -468,8 +697,8 @@ static void get_routes_cb(struct qmi_result *result, void *user_data) new_list->count = GUINT16_TO_LE(1); new_list->route[0].msg_type = QMI_WMS_MSG_TYPE_P2P; new_list->route[0].msg_class = QMI_WMS_MSG_CLASS_NONE; - new_list->route[0].storage_type = QMI_WMS_STORAGE_TYPE_NONE; - new_list->route[0].action = QMI_WMS_ACTION_TRANSFER_AND_ACK; + new_list->route[0].storage_type = QMI_WMS_STORAGE_TYPE_NV; + new_list->route[0].action = QMI_WMS_ACTION_STORE_AND_NOTIFY; param = qmi_param_new(); if (!param) @@ -478,9 +707,9 @@ static void get_routes_cb(struct qmi_result *result, void *user_data) qmi_param_append(param, QMI_WMS_PARAM_ROUTE_LIST, len, new_list); qmi_param_append_uint8(param, QMI_WMS_PARAM_STATUS_REPORT, 0x01); - if (qmi_service_send(data->wms, QMI_WMS_SET_ROUTES, param, - set_routes_cb, sms, NULL) > 0) - return; + if (qmi_service_send(data->wms, QMI_WMS_SET_ROUTES, param, + set_routes_cb, sms, NULL) > 0) + return; qmi_param_free(param); @@ -524,6 +753,9 @@ static void create_wms_cb(struct qmi_service *service, void *user_data) data->wms = qmi_service_ref(service); + memset(&data->rd_msg_id, 0, sizeof(data->rd_msg_id)); + data->msg_mode = QMI_WMS_MESSAGE_MODE_GSMWCDMA; + qmi_service_register(data->wms, QMI_WMS_EVENT, event_notify, sms, NULL); diff --git a/drivers/qmimodem/wms.h b/drivers/qmimodem/wms.h index 7e18ec9..f53fc1b 100644 --- a/drivers/qmimodem/wms.h +++ b/drivers/qmimodem/wms.h @@ -25,8 +25,9 @@ #define QMI_WMS_RAW_SEND 32 /* Send a raw message */ -#define QMI_WMS_RAW_READ 34 /* Read raw message from storage*/ - +#define QMI_WMS_RAW_READ 34 /* Read raw message from storage */ +#define QMI_WMS_DELETE 36 /* Delete message */ +#define QMI_WMS_GET_MSG_PROTOCOL 48 /* Get message protocol */ #define QMI_WMS_GET_MSG_LIST 49 /* Get list of messages from the device */ #define QMI_WMS_SET_ROUTES 50 /* Set routes for message memory storage */ #define QMI_WMS_GET_ROUTES 51 /* Get routes for message memory storage */ @@ -45,6 +46,17 @@ struct qmi_wms_result_new_msg_notify { uint32_t storage_index; } __attribute__((__packed__)); +#define QMI_WMS_RESULT_MESSAGE 0x11 +struct qmi_wms_result_message { + uint8_t ack_required; /* bool */ + uint32_t transaction_id; + uint8_t msg_format; + uint16_t msg_length; + uint8_t msg_data[0]; +} __attribute__((__packed__)); + +#define QMI_WMS_RESULT_MSG_MODE 0x12 + /* Set new message conditions */ #define QMI_WMS_PARAM_NEW_MSG_REPORT 0x10 /* bool */ @@ -57,23 +69,59 @@ struct qmi_wms_param_message { } __attribute__((__packed__)); #define QMI_WMS_RESULT_MESSAGE_ID 0x01 /* uint16 */ +/* Read a raw message */ +#define QMI_WMS_PARAM_READ_MSG 0x01 +struct qmi_wms_read_msg_id { + uint8_t type; + uint32_t ndx; +} __attribute__((__packed__)); + +#define QMI_WMS_PARAM_READ_MODE 0x10 + +#define QMI_WMS_RESULT_READ_MSG 0x01 +struct qmi_wms_raw_message { + uint8_t msg_tag; + uint8_t msg_format; + uint16_t msg_length; + uint8_t msg_data[0]; +} __attribute__((__packed__)); + +/* Delete messages */ +#define QMI_WMS_PARAM_DEL_STORE 0x01 +#define QMI_WMS_PARAM_DEL_NDX 0x10 +#define QMI_WMS_PARAM_DEL_TYPE 0x11 +#define QMI_WMS_PARAM_DEL_MODE 0x12 + +/* Get message protocol */ +#define QMI_WMS_PARAM_PROTOCOL 0x01 + /* Get list of messages from the device */ #define QMI_WMS_PARAM_STORAGE_TYPE 0x01 /* uint8 */ +#define QMI_WMS_PARAM_TAG_TYPE 0x10 #define QMI_WMS_PARAM_MESSAGE_MODE 0x11 /* uint8 */ +#define QMI_WMS_RESULT_MSG_LIST 0x01 +struct qmi_wms_result_msg_list { + uint32_t cnt; + struct { + uint32_t ndx; + uint8_t type; + } __attribute__((__packed__)) msg[0]; +} __attribute__((__packed__)); + #define QMI_WMS_STORAGE_TYPE_UIM 0 #define QMI_WMS_STORAGE_TYPE_NV 1 #define QMI_WMS_STORAGE_TYPE_UNKNOWN 2 #define QMI_WMS_STORAGE_TYPE_NONE 255 -#define QMI_WMS_MESSAGE_MODE_GSMWCDMA 1 +#define QMI_WMS_MT_READ 0x00 +#define QMI_WMS_MT_NOT_READ 0x01 +#define QMI_WMS_MO_SENT 0x02 +#define QMI_WMS_MO_NOT_SENT 0x03 +#define QMI_WMS_MT_UNDEFINE 0xff -struct qmi_wms_raw_message { - uint8_t msg_tag; - uint8_t msg_format; - uint16_t msg_length; - uint8_t msg_data[0]; -} __attribute__((__packed__)); +#define QMI_WMS_MESSAGE_MODE_CDMA 0x00 +#define QMI_WMS_MESSAGE_MODE_GSMWCDMA 0x01 /* Get routes for message memory storage */ #define QMI_WMS_RESULT_ROUTE_LIST 0x01 @@ -89,14 +137,6 @@ struct qmi_wms_route_list { } __attribute__((__packed__)); #define QMI_WMS_RESULT_STATUS_REPORT 0x10 /* bool */ #define QMI_WMS_PARAM_STATUS_REPORT 0x10 /* bool */ -#define QMI_WMS_RESULT_MESSAGE 0x11 -struct qmi_wms_result_message { - uint8_t ack_required; /* bool */ - uint32_t transaction_id; - uint8_t msg_format; - uint16_t msg_length; - uint8_t msg_data[0]; -} __attribute__((__packed__)); #define QMI_WMS_MSG_TYPE_P2P 0x00 #define QMI_WMS_MSG_TYPE_BROADCAST 0x01 @@ -134,3 +174,6 @@ struct qmi_wms_result_smsc_addr { #define QMI_WMS_DOMAIN_PS_PREFERRED 0x01 #define QMI_WMS_DOMAIN_CS_ONLY 0x02 #define QMI_WMS_DOMAIN_PS_ONLY 0x03 + +/* Error code */ +#define QMI_ERR_OP_DEVICE_UNSUPPORTED 0x19 -- 1.9.1