mbimcli: new '--quectel-query-radio-state' and '--quectel-set-radio-state' operations

The '--quectel-set-radio-state' operation is limited to allow only one
value for now: 'on' (0x00000001), which is the one we've seen used
when reviewing traffic from Lenovo's FCC unlock tool.

4 files changed, 209 insertions, 1 deletions

diff --git a/src/mbimcli/mbimcli-quectel.c b/src/mbimcli/mbimcli-quectel.c
new file mode 100644
index 0000000..850b5f7
--- /dev/null
+++ b/src/mbimcli/mbimcli-quectel.c
@@ -0,0 +1,195 @@
+/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+/*
+ * mbimcli -- Command line interface to control MBIM devices
+ *
+ * Copyright (C) 2021 Aleksander Morgado <aleksander@aleksander.es>
+ */
+
+#include "config.h"
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <locale.h>
+#include <string.h>
+
+#include <glib.h>
+#include <gio/gio.h>
+
+#include <libmbim-glib.h>
+
+#include "mbimcli.h"
+#include "mbimcli-helpers.h"
+
+/* Context */
+typedef struct {
+    MbimDevice   *device;
+    GCancellable *cancellable;
+} Context;
+static Context *ctx;
+
+/* Options */
+static gboolean  query_radio_state_flag;
+static gchar    *set_radio_state_str;
+
+static GOptionEntry entries[] = {
+    { "query-radio-state", 0, 0, G_OPTION_ARG_NONE, &query_radio_state_flag,
+      "Query radio state",
+      NULL
+    },
+    { "set-radio-state", 0, 0, G_OPTION_ARG_STRING, &set_radio_state_str,
+      "Set radio state",
+      "[(on)]"
+    },
+    { NULL }
+};
+
+GOptionGroup *
+mbimcli_quectel_get_option_group (void)
+{
+   GOptionGroup *group;
+
+   group = g_option_group_new ("quectel",
+                               "Quectel options:",
+                               "Show Quectel Service options",
+                               NULL,
+                               NULL);
+   g_option_group_add_entries (group, entries);
+
+   return group;
+}
+
+gboolean
+mbimcli_quectel_options_enabled (void)
+{
+    static guint n_actions = 0;
+    static gboolean checked = FALSE;
+
+    if (checked)
+        return !!n_actions;
+
+    n_actions = (query_radio_state_flag +
+                 !!set_radio_state_str);
+
+    if (n_actions > 1) {
+        g_printerr ("error: too many Quectel actions requested\n");
+        exit (EXIT_FAILURE);
+    }
+
+    checked = TRUE;
+    return !!n_actions;
+}
+
+static void
+context_free (Context *context)
+{
+    if (!context)
+        return;
+
+    if (context->cancellable)
+        g_object_unref (context->cancellable);
+    if (context->device)
+        g_object_unref (context->device);
+    g_slice_free (Context, context);
+}
+
+static void
+shutdown (gboolean operation_status)
+{
+    /* Cleanup context and finish async operation */
+    context_free (ctx);
+    mbimcli_async_operation_done (operation_status);
+}
+
+static void
+radio_state_ready (MbimDevice   *device,
+                   GAsyncResult *res,
+                   gpointer      user_data)
+{
+    g_autoptr(MbimMessage)       response = NULL;
+    g_autoptr(GError)            error = NULL;
+    MbimQuectelRadioSwitchState  radio_state;
+    const gchar                 *radio_state_str;
+    gboolean                     action_flag;
+
+    action_flag = GPOINTER_TO_UINT (user_data);
+
+    response = mbim_device_command_finish (device, res, &error);
+    if (!response || !mbim_message_response_get_result (response, MBIM_MESSAGE_TYPE_COMMAND_DONE, &error)) {
+        g_printerr ("error: operation failed: %s\n", error->message);
+        shutdown (FALSE);
+        return;
+    }
+
+    if (action_flag) {
+        g_print ("[%s] Successfully requested to enable radio\n",
+                 mbim_device_get_path_display (device));
+        shutdown (TRUE);
+        return;
+    }
+
+    /* The body is only included in the query response, not in the set response */
+    if (!mbim_message_quectel_radio_state_response_parse (response, &radio_state, &error)) {
+        g_printerr ("error: couldn't parse response message: %s\n", error->message);
+        shutdown (FALSE);
+        return;
+    }
+
+    radio_state_str = mbim_quectel_radio_switch_state_get_string (radio_state);
+
+    g_print ("[%s] Radio state retrieved: '%s'\n",
+             mbim_device_get_path_display (device),
+             VALIDATE_UNKNOWN (radio_state_str));
+
+    shutdown (TRUE);
+}
+
+void
+mbimcli_quectel_run (MbimDevice   *device,
+                     GCancellable *cancellable)
+{
+    g_autoptr(MbimMessage) request = NULL;
+
+    /* Initialize context */
+    ctx = g_slice_new (Context);
+    ctx->device = g_object_ref (device);
+    ctx->cancellable = cancellable ? g_object_ref (cancellable) : NULL;
+
+    /* Request to get radio state? */
+    if (query_radio_state_flag) {
+        g_debug ("Asynchronously querying radio state...");
+        request = (mbim_message_quectel_radio_state_query_new (NULL));
+        mbim_device_command (ctx->device,
+                             request,
+                             10,
+                             ctx->cancellable,
+                             (GAsyncReadyCallback)radio_state_ready,
+                             GUINT_TO_POINTER (FALSE));
+        return;
+    }
+
+    /* Request to set radio state? */
+    if (set_radio_state_str) {
+        MbimQuectelRadioSwitchState radio_state;
+
+        if (g_ascii_strcasecmp (set_radio_state_str, "on") == 0)
+            radio_state = MBIM_QUECTEL_RADIO_SWITCH_STATE_ON;
+        else {
+            g_printerr ("error: invalid radio state (only 'on' allowed): '%s'\n", set_radio_state_str);
+            shutdown (FALSE);
+            return;
+        }
+
+        g_debug ("Asynchronously setting radio state to on...");
+        request = mbim_message_quectel_radio_state_set_new (radio_state, NULL);
+        mbim_device_command (ctx->device,
+                             request,
+                             10,
+                             ctx->cancellable,
+                             (GAsyncReadyCallback)radio_state_ready,
+                             GUINT_TO_POINTER (TRUE));
+        return;
+    }
+
+    g_warn_if_reached ();
+}
diff --git a/src/mbimcli/mbimcli.c b/src/mbimcli/mbimcli.c
index 78d2860..d4a0bf4 100644
--- a/src/mbimcli/mbimcli.c
+++ b/src/mbimcli/mbimcli.c
@@ -294,6 +294,9 @@ device_open_ready (MbimDevice   *dev,
     case MBIM_SERVICE_MS_BASIC_CONNECT_EXTENSIONS:
         mbimcli_ms_basic_connect_extensions_run (dev, cancellable);
         return;
+    case MBIM_SERVICE_QUECTEL:
+        mbimcli_quectel_run (dev, cancellable);
+        return;
     case MBIM_SERVICE_SMS:
     case MBIM_SERVICE_USSD:
     case MBIM_SERVICE_STK:
@@ -302,7 +305,6 @@ device_open_ready (MbimDevice   *dev,
     case MBIM_SERVICE_QMI:
     case MBIM_SERVICE_QDU:
     case MBIM_SERVICE_MS_UICC_LOW_LEVEL_ACCESS:
-    case MBIM_SERVICE_QUECTEL:
         /* unsupported actions in the CLI */
     case MBIM_SERVICE_INVALID:
     default:
@@ -412,6 +414,11 @@ parse_actions (void)
         actions_enabled++;
     }
 
+    if (mbimcli_quectel_options_enabled ()) {
+        service = MBIM_SERVICE_QUECTEL;
+        actions_enabled++;
+    }
+
     /* Noop */
     if (noop_flag)
         actions_enabled++;
@@ -455,6 +462,7 @@ int main (int argc, char **argv)
     g_option_context_add_group (context, mbimcli_atds_get_option_group ());
     g_option_context_add_group (context, mbimcli_intel_firmware_update_get_option_group ());
     g_option_context_add_group (context, mbimcli_ms_basic_connect_extensions_get_option_group ());
+    g_option_context_add_group (context, mbimcli_quectel_get_option_group ());
     g_option_context_add_group (context, mbimcli_link_management_get_option_group ());
     g_option_context_add_main_entries (context, main_entries, NULL);
     if (!g_option_context_parse (context, &argc, &argv, &error)) {
diff --git a/src/mbimcli/mbimcli.h b/src/mbimcli/mbimcli.h
index 9330100..d1f747a 100644
--- a/src/mbimcli/mbimcli.h
+++ b/src/mbimcli/mbimcli.h
@@ -26,6 +26,7 @@ GOptionGroup *mbimcli_ms_sar_get_option_group           (void);
 GOptionGroup *mbimcli_atds_get_option_group             (void);
 GOptionGroup *mbimcli_intel_firmware_update_get_option_group (void);
 GOptionGroup *mbimcli_ms_basic_connect_extensions_get_option_group (void);
+GOptionGroup *mbimcli_quectel_get_option_group          (void);
 
 gboolean      mbimcli_basic_connect_options_enabled     (void);
 gboolean      mbimcli_phonebook_options_enabled         (void);
@@ -36,6 +37,7 @@ gboolean      mbimcli_ms_sar_options_enabled            (void);
 gboolean      mbimcli_atds_options_enabled              (void);
 gboolean      mbimcli_intel_firmware_update_options_enabled (void);
 gboolean      mbimcli_ms_basic_connect_extensions_options_enabled (void);
+gboolean      mbimcli_quectel_options_enabled           (void);
 
 void          mbimcli_basic_connect_run                 (MbimDevice *device,
                                                          GCancellable *cancellable);
@@ -55,6 +57,8 @@ void          mbimcli_intel_firmware_update_run         (MbimDevice *device,
                                                          GCancellable *cancellable);
 void          mbimcli_ms_basic_connect_extensions_run   (MbimDevice *device,
                                                          GCancellable *cancellable);
+void          mbimcli_quectel_run                       (MbimDevice *device,
+                                                         GCancellable *cancellable);
 
 
 /* link management */
diff --git a/src/mbimcli/meson.build b/src/mbimcli/meson.build
index 83342f5..e26ecdd 100644
--- a/src/mbimcli/meson.build
+++ b/src/mbimcli/meson.build
@@ -12,6 +12,7 @@ mbimcli_sources = files(
   'mbimcli-ms-host-shutdown.c',
   'mbimcli-ms-sar.c',
   'mbimcli-phonebook.c',
+  'mbimcli-quectel.c',
 )
 
 sources = mbimcli_sources + files(