cli: new `--firmware-list' and `--firmware-select' actions

4 files changed, 342 insertions, 0 deletions

diff --git a/cli/Makefile.am b/cli/Makefile.am
index 40eb881a..394113c7 100644
--- a/cli/Makefile.am
+++ b/cli/Makefile.am
@@ -22,6 +22,7 @@ mmcli_SOURCES = \
 	mmcli-modem-location.c \
 	mmcli-modem-messaging.c \
 	mmcli-modem-time.c \
+	mmcli-modem-firmware.c \
 	mmcli-bearer.c \
 	mmcli-sim.c \
 	mmcli-sms.c
diff --git a/cli/mmcli-modem-firmware.c b/cli/mmcli-modem-firmware.c
new file mode 100644
index 00000000..e12a3359
--- /dev/null
+++ b/cli/mmcli-modem-firmware.c
@@ -0,0 +1,322 @@
+/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * mmcli -- Control modem status & access information from the command line
+ *
+ * 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 3 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.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Copyright (C) 2012 Google, Inc.
+ */
+
+#include "config.h"
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <locale.h>
+#include <string.h>
+
+#include <glib.h>
+#include <gio/gio.h>
+
+#include <libmm-glib.h>
+
+#include "mmcli.h"
+#include "mmcli-common.h"
+
+/* Context */
+typedef struct {
+    MMManager *manager;
+    GCancellable *cancellable;
+    MMObject *object;
+    MMModemFirmware *modem_firmware;
+} Context;
+static Context *ctx;
+
+/* Options */
+static gboolean list_flag;
+static gchar *select_str;
+
+static GOptionEntry entries[] = {
+    { "firmware-list", 0, 0, G_OPTION_ARG_NONE, &list_flag,
+      "List firmware images installed in a given modem",
+      NULL
+    },
+    { "firmware-select", 0, 0, G_OPTION_ARG_STRING, &select_str,
+      "Select a given firmware image",
+      "[NAME]"
+    },
+    { NULL }
+};
+
+GOptionGroup *
+mmcli_modem_firmware_get_option_group (void)
+{
+	GOptionGroup *group;
+
+	group = g_option_group_new ("firmware",
+	                            "Firmware options",
+	                            "Show Firmware options",
+	                            NULL,
+	                            NULL);
+	g_option_group_add_entries (group, entries);
+
+	return group;
+}
+
+gboolean
+mmcli_modem_firmware_options_enabled (void)
+{
+    static guint n_actions = 0;
+    static gboolean checked = FALSE;
+
+    if (checked)
+        return !!n_actions;
+
+    n_actions = (list_flag +
+                 !!select_str);
+
+    if (n_actions > 1) {
+        g_printerr ("error: too many Firmware actions requested\n");
+        exit (EXIT_FAILURE);
+    }
+
+    checked = TRUE;
+    return !!n_actions;
+}
+
+static void
+context_free (Context *ctx)
+{
+    if (!ctx)
+        return;
+
+    if (ctx->cancellable)
+        g_object_unref (ctx->cancellable);
+    if (ctx->modem_firmware)
+        g_object_unref (ctx->modem_firmware);
+    if (ctx->object)
+        g_object_unref (ctx->object);
+    if (ctx->manager)
+        g_object_unref (ctx->manager);
+    g_free (ctx);
+}
+
+static void
+ensure_modem_firmware (void)
+{
+    if (mm_modem_get_state (mm_object_peek_modem (ctx->object)) < MM_MODEM_STATE_ENABLED) {
+        g_printerr ("error: modem not enabled yet\n");
+        exit (EXIT_FAILURE);
+    }
+
+    if (!ctx->modem_firmware) {
+        g_printerr ("error: modem has no firmware capabilities\n");
+        exit (EXIT_FAILURE);
+    }
+
+    /* Success */
+}
+
+void
+mmcli_modem_firmware_shutdown (void)
+{
+    context_free (ctx);
+}
+
+static void
+list_process_reply (MMFirmwareProperties *selected,
+                    GList                *result,
+                    const GError         *error)
+{
+    if (error) {
+        g_printerr ("error: couldn't list firmware images: '%s'\n",
+                    error->message);
+        exit (EXIT_FAILURE);
+    }
+
+    g_print ("\n");
+    if (!result) {
+        g_print ("No firmware images were found\n");
+    } else {
+        GList *l;
+        guint i;
+
+        g_print ("Found %u firmware images:\n", g_list_length (result));
+        for (l = result, i = 0; l; l = g_list_next (l), i++) {
+            MMFirmwareProperties *props = MM_FIRMWARE_PROPERTIES (l->data);
+
+            g_print ("\t[%u] %s%s\n"
+                     "\t\t   Type: '%s'\n"
+                     "\t\tVersion: '%s'\n",
+                     i,
+                     mm_firmware_properties_get_name (props),
+                     ((selected &&
+                       g_str_equal (mm_firmware_properties_get_name (props),
+                                    mm_firmware_properties_get_name (selected))) ?
+                      " (CURRENT)" : ""),
+                     mm_firmware_image_type_get_string (
+                         mm_firmware_properties_get_image_type (props)),
+                     mm_firmware_properties_get_version (props));
+            g_object_unref (props);
+        }
+        g_list_free (result);
+    }
+
+    if (selected)
+        g_object_unref (selected);
+}
+
+static void
+list_ready (MMModemFirmware *modem,
+            GAsyncResult    *result,
+            gpointer         nothing)
+{
+    GList *installed = NULL;
+    MMFirmwareProperties *selected = NULL;
+    GError *error = NULL;
+
+    mm_modem_firmware_list_finish (modem, result, &selected, &installed, &error);
+    list_process_reply (selected, installed, error);
+
+    mmcli_async_operation_done ();
+}
+
+static void
+select_process_reply (gboolean      result,
+                      const GError *error)
+{
+    if (!result) {
+        g_printerr ("error: couldn't select firmware image: '%s'\n",
+                    error ? error->message : "unknown error");
+        exit (EXIT_FAILURE);
+    }
+
+    g_print ("Successfully selected firmware image\n");
+}
+
+static void
+create_ready (MMModemFirmware *modem,
+              GAsyncResult    *result)
+{
+    gboolean res;
+    GError *error = NULL;
+
+    res = mm_modem_firmware_select_finish (modem, result, &error);
+    select_process_reply (res, error);
+
+    mmcli_async_operation_done ();
+}
+
+static void
+get_modem_ready (GObject      *source,
+                 GAsyncResult *result)
+{
+    ctx->object = mmcli_get_modem_finish (result, &ctx->manager);
+    ctx->modem_firmware = mm_object_get_modem_firmware (ctx->object);
+
+    /* Setup operation timeout */
+    if (ctx->modem_firmware)
+        mmcli_force_operation_timeout (G_DBUS_PROXY (ctx->modem_firmware));
+
+    ensure_modem_firmware ();
+
+    /* Request to list images? */
+    if (list_flag) {
+        g_debug ("Asynchronously listing firmware images in modem...");
+        mm_modem_firmware_list (ctx->modem_firmware,
+                                ctx->cancellable,
+                                (GAsyncReadyCallback)list_ready,
+                                NULL);
+        return;
+    }
+
+    /* Request to select a given image? */
+    if (select_str) {
+        g_debug ("Asynchronously selecting firmware image in modem...");
+        mm_modem_firmware_select (ctx->modem_firmware,
+                                  select_str,
+                                  ctx->cancellable,
+                                  (GAsyncReadyCallback)create_ready,
+                                  NULL);
+        return;
+    }
+
+    g_warn_if_reached ();
+}
+
+void
+mmcli_modem_firmware_run_asynchronous (GDBusConnection *connection,
+                                       GCancellable    *cancellable)
+{
+    /* Initialize context */
+    ctx = g_new0 (Context, 1);
+    if (cancellable)
+        ctx->cancellable = g_object_ref (cancellable);
+
+    /* Get proper modem */
+    mmcli_get_modem (connection,
+                     mmcli_get_common_modem_string (),
+                     cancellable,
+                     (GAsyncReadyCallback)get_modem_ready,
+                     NULL);
+}
+
+void
+mmcli_modem_firmware_run_synchronous (GDBusConnection *connection)
+{
+    GError *error = NULL;
+
+    /* Initialize context */
+    ctx = g_new0 (Context, 1);
+    ctx->object = mmcli_get_modem_sync (connection,
+                                        mmcli_get_common_modem_string (),
+                                        &ctx->manager);
+    ctx->modem_firmware = mm_object_get_modem_firmware (ctx->object);
+
+    /* Setup operation timeout */
+    if (ctx->modem_firmware)
+        mmcli_force_operation_timeout (G_DBUS_PROXY (ctx->modem_firmware));
+
+    ensure_modem_firmware ();
+
+    /* Request to list firmware images? */
+    if (list_flag) {
+        GList *installed = NULL;
+        MMFirmwareProperties *selected = NULL;
+
+        g_debug ("Synchronously listing firmware images in modem...");
+        mm_modem_firmware_list_sync (ctx->modem_firmware,
+                                     &selected,
+                                     &installed,
+                                     NULL,
+                                     &error);
+        list_process_reply (selected, installed, error);
+        return;
+    }
+
+    /* Request to select a given image? */
+    if (select_str) {
+        gboolean result;
+        GError *error = NULL;
+
+        g_debug ("Synchronously selecting firmware image in modem...");
+        result = mm_modem_firmware_select_sync (ctx->modem_firmware,
+                                                select_str,
+                                                NULL,
+                                                &error);
+        select_process_reply (result, error);
+        return;
+    }
+
+    g_warn_if_reached ();
+}
diff --git a/cli/mmcli.c b/cli/mmcli.c
index b05df9bc..8e81452f 100644
--- a/cli/mmcli.c
+++ b/cli/mmcli.c
@@ -206,6 +206,8 @@ main (gint argc, gchar **argv)
 	g_option_context_add_group (context,
 	                            mmcli_modem_time_get_option_group ());
 	g_option_context_add_group (context,
+	                            mmcli_modem_firmware_get_option_group ());
+	g_option_context_add_group (context,
 	                            mmcli_sim_get_option_group ());
 	g_option_context_add_group (context,
 	                            mmcli_bearer_get_option_group ());
@@ -315,6 +317,13 @@ main (gint argc, gchar **argv)
         else
             mmcli_modem_time_run_synchronous (connection);
     }
+    /* Modem Firmware options? */
+    else if (mmcli_modem_firmware_options_enabled ()) {
+        if (async_flag)
+            mmcli_modem_firmware_run_asynchronous (connection, cancellable);
+        else
+            mmcli_modem_firmware_run_synchronous (connection);
+    }
     /* Modem options?
      * NOTE: let this check be always the last one, as other groups also need
      * having a modem specified, and therefore if -m is set, modem options
@@ -349,6 +358,8 @@ main (gint argc, gchar **argv)
         mmcli_modem_messaging_shutdown ();
     } else if (mmcli_modem_time_options_enabled ()) {
         mmcli_modem_time_shutdown ();
+    } else if (mmcli_modem_firmware_options_enabled ()) {
+        mmcli_modem_firmware_shutdown ();
     }  else if (mmcli_sim_options_enabled ()) {
         mmcli_sim_shutdown ();
     } else if (mmcli_bearer_options_enabled ()) {
diff --git a/cli/mmcli.h b/cli/mmcli.h
index 441bb8e3..52439699 100644
--- a/cli/mmcli.h
+++ b/cli/mmcli.h
@@ -93,6 +93,14 @@ void          mmcli_modem_time_run_asynchronous   (GDBusConnection *connection,
 void          mmcli_modem_time_run_synchronous    (GDBusConnection *connection);
 void          mmcli_modem_time_shutdown           (void);
 
+/* Firmware group */
+GOptionGroup *mmcli_modem_firmware_get_option_group   (void);
+gboolean      mmcli_modem_firmware_options_enabled    (void);
+void          mmcli_modem_firmware_run_asynchronous   (GDBusConnection *connection,
+                                                       GCancellable    *cancellable);
+void          mmcli_modem_firmware_run_synchronous    (GDBusConnection *connection);
+void          mmcli_modem_firmware_shutdown           (void);
+
 /* Bearer group */
 GOptionGroup *mmcli_bearer_get_option_group   (void);
 gboolean      mmcli_bearer_options_enabled    (void);