Files
ModemManager/plugins/cinterion/mm-modem-helpers-cinterion.c
Ben Chan 7de6b6f2e1 core: remove unnecessary NULL checks for g_match_info_free()
g_match_info_free() already check if the given pointer is NULL and does
nothing on a NULL pointer.
2018-10-18 13:17:36 +02:00

670 lines
21 KiB
C

/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* 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:
*
* Copyright (C) 2016 Trimble Navigation Limited
* Copyright (C) 2014 Aleksander Morgado <aleksander@aleksander.es>
* Contributor: Matthew Stanger <matthew_stanger@trimble.com>
*/
#include <config.h>
#include <string.h>
#include <stdlib.h>
#include <stdio.h>
#include "ModemManager.h"
#define _LIBMM_INSIDE_MM
#include <libmm-glib.h>
#include "mm-log.h"
#include "mm-charsets.h"
#include "mm-errors-types.h"
#include "mm-modem-helpers-cinterion.h"
#include "mm-modem-helpers.h"
/* Setup relationship between the 3G band bitmask in the modem and the bitmask
* in ModemManager. */
typedef struct {
guint32 cinterion_band_flag;
MMModemBand mm_band;
} CinterionBand;
/* Table checked in PLS8-X/E/J/V/US, HC25 & PHS8 references. The table includes 2/3/4G
* frequencies. Depending on which one is configured, one access technology or
* the other will be used. This may conflict with the allowed mode configuration
* set, so you shouldn't for example set 3G frequency bands, and then use a
* 2G-only allowed mode. */
static const CinterionBand cinterion_bands[] = {
{ (1 << 0), MM_MODEM_BAND_EGSM },
{ (1 << 1), MM_MODEM_BAND_DCS },
{ (1 << 2), MM_MODEM_BAND_G850 },
{ (1 << 3), MM_MODEM_BAND_PCS },
{ (1 << 4), MM_MODEM_BAND_UTRAN_1 },
{ (1 << 5), MM_MODEM_BAND_UTRAN_2 },
{ (1 << 6), MM_MODEM_BAND_UTRAN_5 },
{ (1 << 7), MM_MODEM_BAND_UTRAN_8 },
{ (1 << 8), MM_MODEM_BAND_UTRAN_6 },
{ (1 << 9), MM_MODEM_BAND_UTRAN_4 },
{ (1 << 10), MM_MODEM_BAND_UTRAN_19 },
{ (1 << 12), MM_MODEM_BAND_UTRAN_3 },
{ (1 << 13), MM_MODEM_BAND_EUTRAN_1 },
{ (1 << 14), MM_MODEM_BAND_EUTRAN_2 },
{ (1 << 15), MM_MODEM_BAND_EUTRAN_3 },
{ (1 << 16), MM_MODEM_BAND_EUTRAN_4 },
{ (1 << 17), MM_MODEM_BAND_EUTRAN_5 },
{ (1 << 18), MM_MODEM_BAND_EUTRAN_7 },
{ (1 << 19), MM_MODEM_BAND_EUTRAN_8 },
{ (1 << 20), MM_MODEM_BAND_EUTRAN_17 },
{ (1 << 21), MM_MODEM_BAND_EUTRAN_20 },
{ (1 << 22), MM_MODEM_BAND_EUTRAN_13 },
{ (1 << 24), MM_MODEM_BAND_EUTRAN_19 }
};
/* Check valid combinations in 2G-only devices */
#define VALIDATE_2G_BAND(cinterion_mask) \
(cinterion_mask == 1 || \
cinterion_mask == 2 || \
cinterion_mask == 4 || \
cinterion_mask == 8 || \
cinterion_mask == 3 || \
cinterion_mask == 5 || \
cinterion_mask == 10 || \
cinterion_mask == 12 || \
cinterion_mask == 15)
/*****************************************************************************/
/* ^SCFG (3G) test parser
*
* Example:
* AT^SCFG=?
* ...
* ^SCFG: "MEShutdown/OnIgnition",("on","off")
* ^SCFG: "Radio/Band",("1-511","0-1")
* ^SCFG: "Radio/NWSM",("0","1","2")
* ...
*
* ^SCFG: "Radio/Band\",("1"-"147")
*/
gboolean
mm_cinterion_parse_scfg_test (const gchar *response,
MMModemCharset charset,
GArray **supported_bands,
GError **error)
{
GRegex *r;
GMatchInfo *match_info;
GError *inner_error = NULL;
GArray *bands = NULL;
if (!response) {
g_set_error (error, MM_CORE_ERROR, MM_CORE_ERROR_FAILED, "Missing response");
return FALSE;
}
r = g_regex_new ("\\^SCFG:\\s*\"Radio/Band\",\\((?:\")?([0-9]*)(?:\")?-(?:\")?([0-9]*)(?:\")?.*\\)",
G_REGEX_DOLLAR_ENDONLY | G_REGEX_RAW,
0, NULL);
g_assert (r != NULL);
g_regex_match_full (r, response, strlen (response), 0, 0, &match_info, &inner_error);
if (!inner_error && g_match_info_matches (match_info)) {
gchar *maxbandstr;
guint maxband = 0;
maxbandstr = mm_get_string_unquoted_from_match_info (match_info, 2);
if (maxbandstr) {
/* Handle charset conversion if the number is given in UCS2 */
if (charset != MM_MODEM_CHARSET_UNKNOWN)
maxbandstr = mm_charset_take_and_convert_to_utf8 (maxbandstr, charset);
mm_get_uint_from_str (maxbandstr, &maxband);
}
if (maxband == 0) {
inner_error = g_error_new (MM_CORE_ERROR,
MM_CORE_ERROR_FAILED,
"Couldn't parse ^SCFG=? response");
} else {
guint i;
for (i = 0; i < G_N_ELEMENTS (cinterion_bands); i++) {
if (maxband & cinterion_bands[i].cinterion_band_flag) {
if (G_UNLIKELY (!bands))
bands = g_array_sized_new (FALSE, FALSE, sizeof (MMModemBand), 9);
g_array_append_val (bands, cinterion_bands[i].mm_band);
}
}
}
g_free (maxbandstr);
}
g_match_info_free (match_info);
g_regex_unref (r);
if (!bands)
inner_error = g_error_new (MM_CORE_ERROR,
MM_CORE_ERROR_FAILED,
"No valid bands found in ^SCFG=? response");
if (inner_error) {
g_propagate_error (error, inner_error);
return FALSE;
}
g_assert (bands != NULL && bands->len > 0);
*supported_bands = bands;
return TRUE;
}
/*****************************************************************************/
/* ^SCFG response parser
*
* Example (3G):
* AT^SCFG="Radio/Band"
* ^SCFG: "Radio/Band",127
*
* Example (2G, UCS-2):
* AT+SCFG="Radio/Band"
* ^SCFG: "Radio/Band","0031","0031"
*
* Example (2G):
* AT+SCFG="Radio/Band"
* ^SCFG: "Radio/Band","3","3"
*/
gboolean
mm_cinterion_parse_scfg_response (const gchar *response,
MMModemCharset charset,
GArray **current_bands,
GError **error)
{
GRegex *r;
GMatchInfo *match_info;
GError *inner_error = NULL;
GArray *bands = NULL;
if (!response) {
g_set_error (error, MM_CORE_ERROR, MM_CORE_ERROR_FAILED, "Missing response");
return FALSE;
}
r = g_regex_new ("\\^SCFG:\\s*\"Radio/Band\",\\s*\"?([0-9a-fA-F]*)\"?", 0, 0, NULL);
g_assert (r != NULL);
if (g_regex_match_full (r, response, strlen (response), 0, 0, &match_info, NULL)) {
gchar *currentstr;
guint current = 0;
currentstr = mm_get_string_unquoted_from_match_info (match_info, 1);
if (currentstr) {
/* Handle charset conversion if the number is given in UCS2 */
if (charset != MM_MODEM_CHARSET_UNKNOWN)
currentstr = mm_charset_take_and_convert_to_utf8 (currentstr, charset);
mm_get_uint_from_str (currentstr, &current);
}
if (current == 0) {
inner_error = g_error_new (MM_CORE_ERROR,
MM_CORE_ERROR_FAILED,
"Couldn't parse ^SCFG response");
} else {
guint i;
for (i = 0; i < G_N_ELEMENTS (cinterion_bands); i++) {
if (current & cinterion_bands[i].cinterion_band_flag) {
if (G_UNLIKELY (!bands))
bands = g_array_sized_new (FALSE, FALSE, sizeof (MMModemBand), 9);
g_array_append_val (bands, cinterion_bands[i].mm_band);
}
}
}
g_free (currentstr);
}
g_match_info_free (match_info);
g_regex_unref (r);
if (!bands)
inner_error = g_error_new (MM_CORE_ERROR,
MM_CORE_ERROR_FAILED,
"No valid bands found in ^SCFG response");
if (inner_error) {
g_propagate_error (error, inner_error);
return FALSE;
}
g_assert (bands != NULL && bands->len > 0);
*current_bands = bands;
return TRUE;
}
/*****************************************************************************/
/* +CNMI test parser
*
* Example (PHS8):
* AT+CNMI=?
* +CNMI: (0,1,2),(0,1),(0,2),(0),(1)
*/
gboolean
mm_cinterion_parse_cnmi_test (const gchar *response,
GArray **supported_mode,
GArray **supported_mt,
GArray **supported_bm,
GArray **supported_ds,
GArray **supported_bfr,
GError **error)
{
GRegex *r;
GMatchInfo *match_info;
GError *inner_error = NULL;
GArray *tmp_supported_mode = NULL;
GArray *tmp_supported_mt = NULL;
GArray *tmp_supported_bm = NULL;
GArray *tmp_supported_ds = NULL;
GArray *tmp_supported_bfr = NULL;
if (!response) {
g_set_error (error, MM_CORE_ERROR, MM_CORE_ERROR_FAILED, "Missing response");
return FALSE;
}
r = g_regex_new ("\\+CNMI:\\s*\\((.*)\\),\\((.*)\\),\\((.*)\\),\\((.*)\\),\\((.*)\\)",
G_REGEX_DOLLAR_ENDONLY | G_REGEX_RAW,
0, NULL);
g_assert (r != NULL);
g_regex_match_full (r, response, strlen (response), 0, 0, &match_info, &inner_error);
if (!inner_error && g_match_info_matches (match_info)) {
if (supported_mode) {
gchar *str;
str = mm_get_string_unquoted_from_match_info (match_info, 1);
tmp_supported_mode = mm_parse_uint_list (str, &inner_error);
g_free (str);
if (inner_error)
goto out;
}
if (supported_mt) {
gchar *str;
str = mm_get_string_unquoted_from_match_info (match_info, 2);
tmp_supported_mt = mm_parse_uint_list (str, &inner_error);
g_free (str);
if (inner_error)
goto out;
}
if (supported_bm) {
gchar *str;
str = mm_get_string_unquoted_from_match_info (match_info, 3);
tmp_supported_bm = mm_parse_uint_list (str, &inner_error);
g_free (str);
if (inner_error)
goto out;
}
if (supported_ds) {
gchar *str;
str = mm_get_string_unquoted_from_match_info (match_info, 4);
tmp_supported_ds = mm_parse_uint_list (str, &inner_error);
g_free (str);
if (inner_error)
goto out;
}
if (supported_bfr) {
gchar *str;
str = mm_get_string_unquoted_from_match_info (match_info, 5);
tmp_supported_bfr = mm_parse_uint_list (str, &inner_error);
g_free (str);
if (inner_error)
goto out;
}
}
out:
g_match_info_free (match_info);
g_regex_unref (r);
if (inner_error) {
g_clear_pointer (&tmp_supported_mode, g_array_unref);
g_clear_pointer (&tmp_supported_mt, g_array_unref);
g_clear_pointer (&tmp_supported_bm, g_array_unref);
g_clear_pointer (&tmp_supported_ds, g_array_unref);
g_clear_pointer (&tmp_supported_bfr, g_array_unref);
g_propagate_error (error, inner_error);
return FALSE;
}
if (supported_mode)
*supported_mode = tmp_supported_mode;
if (supported_mt)
*supported_mt = tmp_supported_mt;
if (supported_bm)
*supported_bm = tmp_supported_bm;
if (supported_ds)
*supported_ds = tmp_supported_ds;
if (supported_bfr)
*supported_bfr = tmp_supported_bfr;
return TRUE;
}
/*****************************************************************************/
/* Build Cinterion-specific band value */
gboolean
mm_cinterion_build_band (GArray *bands,
guint supported,
gboolean only_2g,
guint *out_band,
GError **error)
{
guint band = 0;
/* The special case of ANY should be treated separately. */
if (bands->len == 1 && g_array_index (bands, MMModemBand, 0) == MM_MODEM_BAND_ANY) {
band = supported;
} else {
guint i;
for (i = 0; i < G_N_ELEMENTS (cinterion_bands); i++) {
guint j;
for (j = 0; j < bands->len; j++) {
if (g_array_index (bands, MMModemBand, j) == cinterion_bands[i].mm_band) {
band |= cinterion_bands[i].cinterion_band_flag;
break;
}
}
}
/* 2G-only modems only support a subset of the possible band
* combinations. Detect it early and error out.
*/
if (only_2g && !VALIDATE_2G_BAND (band))
band = 0;
}
if (band == 0) {
gchar *bands_string;
bands_string = mm_common_build_bands_string ((MMModemBand *)bands->data, bands->len);
g_set_error (error,
MM_CORE_ERROR,
MM_CORE_ERROR_FAILED,
"The given band combination is not supported: '%s'",
bands_string);
g_free (bands_string);
return FALSE;
}
*out_band = band;
return TRUE;
}
/*****************************************************************************/
/* Single ^SIND response parser */
gboolean
mm_cinterion_parse_sind_response (const gchar *response,
gchar **description,
guint *mode,
guint *value,
GError **error)
{
GRegex *r;
GMatchInfo *match_info;
guint errors = 0;
if (!response) {
g_set_error (error, MM_CORE_ERROR, MM_CORE_ERROR_FAILED, "Missing response");
return FALSE;
}
r = g_regex_new ("\\^SIND:\\s*(.*),(\\d+),(\\d+)(\\r\\n)?", 0, 0, NULL);
g_assert (r != NULL);
if (g_regex_match_full (r, response, strlen (response), 0, 0, &match_info, NULL)) {
if (description) {
*description = mm_get_string_unquoted_from_match_info (match_info, 1);
if (*description == NULL)
errors++;
}
if (mode && !mm_get_uint_from_match_info (match_info, 2, mode))
errors++;
if (value && !mm_get_uint_from_match_info (match_info, 3, value))
errors++;
} else
errors++;
g_match_info_free (match_info);
g_regex_unref (r);
if (errors > 0) {
g_set_error (error, MM_CORE_ERROR, MM_CORE_ERROR_FAILED, "Failed parsing ^SIND response");
return FALSE;
}
return TRUE;
}
/*****************************************************************************/
/* ^SWWAN read parser
*
* Description: Parses <cid>, <state>[, <WWAN adapter>] or CME ERROR from SWWAN.
*
* The method returns a MMSwwanState with the connection status of a single
* PDP context, the one being queried via the cid given as input.
*
* Note that we use CID for matching because the WWAN adapter field is optional
* it seems.
*
* Read Command
* AT^SWWAN?
* Response(s)
* [^SWWAN: <cid>, <state>[, <WWAN adapter>]]
* [^SWWAN: ...]
* OK
* ERROR
* +CME ERROR: <err>
*
* Examples:
* OK - If no WWAN connection is active, then read command just returns OK
* ^SWWAN: 3,1,1 - 3rd PDP Context, Activated, First WWAN Adaptor
* +CME ERROR: ? -
*/
enum {
MM_SWWAN_STATE_DISCONNECTED = 0,
MM_SWWAN_STATE_CONNECTED = 1,
};
MMBearerConnectionStatus
mm_cinterion_parse_swwan_response (const gchar *response,
guint cid,
GError **error)
{
GRegex *r;
GMatchInfo *match_info;
GError *inner_error = NULL;
MMBearerConnectionStatus status;
g_assert (response);
/* If no WWAN connection is active, then ^SWWAN read command just returns OK
* (which we receive as an empty string) */
if (!response[0])
return MM_BEARER_CONNECTION_STATUS_DISCONNECTED;
if (!g_str_has_prefix (response, "^SWWAN:")) {
g_set_error (error, MM_CORE_ERROR, MM_CORE_ERROR_FAILED,
"Couldn't parse ^SWWAN response: '%s'", response);
return MM_BEARER_CONNECTION_STATUS_UNKNOWN;
}
r = g_regex_new ("\\^SWWAN:\\s*(\\d+),\\s*(\\d+)(?:,\\s*(\\d+))?(?:\\r\\n)?",
G_REGEX_DOLLAR_ENDONLY | G_REGEX_RAW, 0, NULL);
g_assert (r != NULL);
status = MM_BEARER_CONNECTION_STATUS_UNKNOWN;
g_regex_match_full (r, response, strlen (response), 0, 0, &match_info, &inner_error);
while (!inner_error && g_match_info_matches (match_info)) {
guint read_state;
guint read_cid;
if (!mm_get_uint_from_match_info (match_info, 1, &read_cid))
mm_warn ("Couldn't read cid in ^SWWAN response: '%s'", response);
else if (!mm_get_uint_from_match_info (match_info, 2, &read_state))
mm_warn ("Couldn't read state in ^SWWAN response: '%s'", response);
else if (read_cid == cid) {
if (read_state == MM_SWWAN_STATE_CONNECTED) {
status = MM_BEARER_CONNECTION_STATUS_CONNECTED;
break;
}
if (read_state == MM_SWWAN_STATE_DISCONNECTED) {
status = MM_BEARER_CONNECTION_STATUS_DISCONNECTED;
break;
}
mm_warn ("Invalid state read in ^SWWAN response: %u", read_state);
break;
}
g_match_info_next (match_info, &inner_error);
}
g_match_info_free (match_info);
g_regex_unref (r);
if (status == MM_BEARER_CONNECTION_STATUS_UNKNOWN)
g_set_error (error, MM_CORE_ERROR, MM_CORE_ERROR_FAILED,
"No state returned for CID %u", cid);
return status;
}
/*****************************************************************************/
/* ^SMONG response parser */
static MMModemAccessTechnology
get_access_technology_from_smong_gprs_status (guint gprs_status,
GError **error)
{
switch (gprs_status) {
case 0:
return MM_MODEM_ACCESS_TECHNOLOGY_UNKNOWN;
case 1:
case 2:
return MM_MODEM_ACCESS_TECHNOLOGY_GPRS;
case 3:
case 4:
return MM_MODEM_ACCESS_TECHNOLOGY_EDGE;
default:
break;
}
g_set_error (error,
MM_CORE_ERROR,
MM_CORE_ERROR_INVALID_ARGS,
"Couldn't get network capabilities, "
"unsupported GPRS status value: '%u'",
gprs_status);
return MM_MODEM_ACCESS_TECHNOLOGY_UNKNOWN;
}
gboolean
mm_cinterion_parse_smong_response (const gchar *response,
MMModemAccessTechnology *access_tech,
GError **error)
{
GError *inner_error = NULL;
GMatchInfo *match_info = NULL;
GRegex *regex;
/* The AT^SMONG command returns a cell info table, where the second
* column identifies the "GPRS status", which is exactly what we want.
* So we'll try to read that second number in the values row.
*
* AT^SMONG
* GPRS Monitor
* BCCH G PBCCH PAT MCC MNC NOM TA RAC # Cell #
* 0776 1 - - 214 03 2 00 01
* OK
*/
regex = g_regex_new (".*GPRS Monitor(?:\r\n)*"
"BCCH\\s*G.*\\r\\n"
"\\s*(\\d+)\\s*(\\d+)\\s*",
G_REGEX_DOLLAR_ENDONLY | G_REGEX_RAW,
0, NULL);
g_assert (regex);
if (g_regex_match_full (regex, response, strlen (response), 0, 0, &match_info, &inner_error)) {
guint value = 0;
if (!mm_get_uint_from_match_info (match_info, 2, &value))
inner_error = g_error_new (MM_CORE_ERROR, MM_CORE_ERROR_FAILED,
"Couldn't read 'GPRS status' field from AT^SMONG response");
else if (access_tech)
*access_tech = get_access_technology_from_smong_gprs_status (value, &inner_error);
}
g_match_info_free (match_info);
g_regex_unref (regex);
if (inner_error) {
g_propagate_error (error, inner_error);
return FALSE;
}
g_assert (access_tech != MM_MODEM_ACCESS_TECHNOLOGY_UNKNOWN);
return TRUE;
}
/*****************************************************************************/
/* ^SIND psinfo helper */
MMModemAccessTechnology
mm_cinterion_get_access_technology_from_sind_psinfo (guint val)
{
switch (val) {
case 0:
return MM_MODEM_ACCESS_TECHNOLOGY_UNKNOWN;
case 1:
case 2:
return MM_MODEM_ACCESS_TECHNOLOGY_GPRS;
case 3:
case 4:
return MM_MODEM_ACCESS_TECHNOLOGY_EDGE;
case 5:
case 6:
return MM_MODEM_ACCESS_TECHNOLOGY_UMTS;
case 7:
case 8:
return MM_MODEM_ACCESS_TECHNOLOGY_HSDPA;
case 9:
case 10:
return (MM_MODEM_ACCESS_TECHNOLOGY_HSDPA | MM_MODEM_ACCESS_TECHNOLOGY_HSUPA);
case 16:
case 17:
return MM_MODEM_ACCESS_TECHNOLOGY_LTE;
default:
mm_dbg ("Unable to identify access technology from psinfo reported value: %u", val);
return MM_MODEM_ACCESS_TECHNOLOGY_UNKNOWN;
}
}