cinterion: implement FDL update method

Adds AT^SFDL based Firmware Download as an update method for supported Cinterion modems.

Signed-off-by: Lukas Voegl <lvoegl@tdt.de>

6 files changed, 143 insertions, 7 deletions

diff --git a/include/ModemManager-enums.h b/include/ModemManager-enums.h
index e1baf30f..ca15c80b 100644
--- a/include/ModemManager-enums.h
+++ b/include/ModemManager-enums.h
@@ -1670,19 +1670,21 @@ typedef enum { /*< underscore_name=mm_call_direction >*/
  * @MM_MODEM_FIRMWARE_UPDATE_METHOD_FIREHOSE: Device supports Firehose based update. Since 1.18.
  * @MM_MODEM_FIRMWARE_UPDATE_METHOD_SAHARA: Device supports Sahara protocol. Usually used in combination with Firehose. Since 1.20.
  * @MM_MODEM_FIRMWARE_UPDATE_METHOD_DFOTA: Device supports Quectel DFOTA based update. Since 1.24.
+ * @MM_MODEM_FIRMWARE_UPDATE_METHOD_CINTERION_FDL: Device supports AT^SFDL based update. Since 1.24.
  *
  * Type of firmware update method supported by the module.
  *
  * Since: 1.10
  */
 typedef enum { /*< underscore_name=mm_modem_firmware_update_method >*/
-    MM_MODEM_FIRMWARE_UPDATE_METHOD_NONE     = 0,
-    MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT = 1 << 0,
-    MM_MODEM_FIRMWARE_UPDATE_METHOD_QMI_PDC  = 1 << 1,
-    MM_MODEM_FIRMWARE_UPDATE_METHOD_MBIM_QDU = 1 << 2,
-    MM_MODEM_FIRMWARE_UPDATE_METHOD_FIREHOSE = 1 << 3,
-    MM_MODEM_FIRMWARE_UPDATE_METHOD_SAHARA   = 1 << 4,
-    MM_MODEM_FIRMWARE_UPDATE_METHOD_DFOTA    = 1 << 5,
+    MM_MODEM_FIRMWARE_UPDATE_METHOD_NONE          = 0,
+    MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT      = 1 << 0,
+    MM_MODEM_FIRMWARE_UPDATE_METHOD_QMI_PDC       = 1 << 1,
+    MM_MODEM_FIRMWARE_UPDATE_METHOD_MBIM_QDU      = 1 << 2,
+    MM_MODEM_FIRMWARE_UPDATE_METHOD_FIREHOSE      = 1 << 3,
+    MM_MODEM_FIRMWARE_UPDATE_METHOD_SAHARA        = 1 << 4,
+    MM_MODEM_FIRMWARE_UPDATE_METHOD_DFOTA         = 1 << 5,
+    MM_MODEM_FIRMWARE_UPDATE_METHOD_CINTERION_FDL = 1 << 6,
 } MMModemFirmwareUpdateMethod;
 
 /**
diff --git a/src/plugins/cinterion/mm-broadband-modem-cinterion.c b/src/plugins/cinterion/mm-broadband-modem-cinterion.c
index 7d4587c7..5cca384b 100644
--- a/src/plugins/cinterion/mm-broadband-modem-cinterion.c
+++ b/src/plugins/cinterion/mm-broadband-modem-cinterion.c
@@ -32,6 +32,7 @@
 #include "mm-errors-types.h"
 #include "mm-iface-modem.h"
 #include "mm-iface-modem-3gpp.h"
+#include "mm-iface-modem-firmware.h"
 #include "mm-iface-modem-messaging.h"
 #include "mm-iface-modem-location.h"
 #include "mm-iface-modem-voice.h"
@@ -43,6 +44,7 @@
 #include "mm-iface-modem-signal.h"
 
 static void iface_modem_init           (MMIfaceModemInterface          *iface);
+static void iface_modem_firmware_init  (MMIfaceModemFirmwareInterface  *iface);
 static void iface_modem_3gpp_init      (MMIfaceModem3gppInterface      *iface);
 static void iface_modem_messaging_init (MMIfaceModemMessagingInterface *iface);
 static void iface_modem_location_init  (MMIfaceModemLocationInterface  *iface);
@@ -60,6 +62,7 @@ static MMIfaceModemSignalInterface   *iface_modem_signal_parent;
 
 G_DEFINE_TYPE_EXTENDED (MMBroadbandModemCinterion, mm_broadband_modem_cinterion, MM_TYPE_BROADBAND_MODEM, 0,
                         G_IMPLEMENT_INTERFACE (MM_TYPE_IFACE_MODEM, iface_modem_init)
+                        G_IMPLEMENT_INTERFACE (MM_TYPE_IFACE_MODEM_FIRMWARE, iface_modem_firmware_init)
                         G_IMPLEMENT_INTERFACE (MM_TYPE_IFACE_MODEM_3GPP, iface_modem_3gpp_init)
                         G_IMPLEMENT_INTERFACE (MM_TYPE_IFACE_MODEM_MESSAGING, iface_modem_messaging_init)
                         G_IMPLEMENT_INTERFACE (MM_TYPE_IFACE_MODEM_LOCATION, iface_modem_location_init)
@@ -3098,6 +3101,13 @@ peek_parent_interface (MMSharedCinterion *self)
 }
 
 static void
+iface_modem_firmware_init (MMIfaceModemFirmwareInterface *iface)
+{
+    iface->load_update_settings = mm_shared_cinterion_firmware_load_update_settings;
+    iface->load_update_settings_finish = mm_shared_cinterion_firmware_load_update_settings_finish;
+}
+
+static void
 iface_modem_3gpp_init (MMIfaceModem3gppInterface *iface)
 {
     iface_modem_3gpp_parent = g_type_interface_peek_parent (iface);
diff --git a/src/plugins/cinterion/mm-broadband-modem-mbim-cinterion.c b/src/plugins/cinterion/mm-broadband-modem-mbim-cinterion.c
index 471f2d58..eb1c09a5 100644
--- a/src/plugins/cinterion/mm-broadband-modem-mbim-cinterion.c
+++ b/src/plugins/cinterion/mm-broadband-modem-mbim-cinterion.c
@@ -25,12 +25,14 @@
 #include "mm-log.h"
 #include "mm-errors-types.h"
 #include "mm-iface-modem.h"
+#include "mm-iface-modem-firmware.h"
 #include "mm-iface-modem-location.h"
 #include "mm-iface-modem-voice.h"
 #include "mm-broadband-modem-mbim-cinterion.h"
 #include "mm-shared-cinterion.h"
 
 static void iface_modem_init          (MMIfaceModemInterface         *iface);
+static void iface_modem_firmware_init (MMIfaceModemFirmwareInterface *iface);
 static void iface_modem_location_init (MMIfaceModemLocationInterface *iface);
 static void iface_modem_voice_init    (MMIfaceModemVoiceInterface    *iface);
 static void iface_modem_time_init     (MMIfaceModemTimeInterface     *iface);
@@ -43,6 +45,7 @@ static MMIfaceModemTimeInterface     *iface_modem_time_parent;
 
 G_DEFINE_TYPE_EXTENDED (MMBroadbandModemMbimCinterion, mm_broadband_modem_mbim_cinterion, MM_TYPE_BROADBAND_MODEM_MBIM, 0,
                         G_IMPLEMENT_INTERFACE (MM_TYPE_IFACE_MODEM, iface_modem_init)
+                        G_IMPLEMENT_INTERFACE (MM_TYPE_IFACE_MODEM_FIRMWARE, iface_modem_firmware_init)
                         G_IMPLEMENT_INTERFACE (MM_TYPE_IFACE_MODEM_LOCATION, iface_modem_location_init)
                         G_IMPLEMENT_INTERFACE (MM_TYPE_IFACE_MODEM_VOICE, iface_modem_voice_init)
                         G_IMPLEMENT_INTERFACE (MM_TYPE_IFACE_MODEM_TIME, iface_modem_time_init)
@@ -95,6 +98,13 @@ peek_parent_interface (MMSharedCinterion *self)
 }
 
 static void
+iface_modem_firmware_init (MMIfaceModemFirmwareInterface *iface)
+{
+    iface->load_update_settings = mm_shared_cinterion_firmware_load_update_settings;
+    iface->load_update_settings_finish = mm_shared_cinterion_firmware_load_update_settings_finish;
+}
+
+static void
 iface_modem_location_init (MMIfaceModemLocationInterface *iface)
 {
     iface_modem_location_parent = g_type_interface_peek_parent (iface);
diff --git a/src/plugins/cinterion/mm-broadband-modem-qmi-cinterion.c b/src/plugins/cinterion/mm-broadband-modem-qmi-cinterion.c
index 77d399b6..da064a40 100644
--- a/src/plugins/cinterion/mm-broadband-modem-qmi-cinterion.c
+++ b/src/plugins/cinterion/mm-broadband-modem-qmi-cinterion.c
@@ -26,12 +26,14 @@
 #include "mm-log.h"
 #include "mm-errors-types.h"
 #include "mm-iface-modem.h"
+#include "mm-iface-modem-firmware.h"
 #include "mm-iface-modem-location.h"
 #include "mm-iface-modem-voice.h"
 #include "mm-broadband-modem-qmi-cinterion.h"
 #include "mm-shared-cinterion.h"
 
 static void iface_modem_init          (MMIfaceModemInterface         *iface);
+static void iface_modem_firmware_init (MMIfaceModemFirmwareInterface *iface);
 static void iface_modem_location_init (MMIfaceModemLocationInterface *iface);
 static void iface_modem_voice_init    (MMIfaceModemVoiceInterface    *iface);
 static void iface_modem_time_init     (MMIfaceModemTimeInterface     *iface);
@@ -44,6 +46,7 @@ static MMIfaceModemTimeInterface     *iface_modem_time_parent;
 
 G_DEFINE_TYPE_EXTENDED (MMBroadbandModemQmiCinterion, mm_broadband_modem_qmi_cinterion, MM_TYPE_BROADBAND_MODEM_QMI, 0,
                         G_IMPLEMENT_INTERFACE (MM_TYPE_IFACE_MODEM, iface_modem_init)
+                        G_IMPLEMENT_INTERFACE (MM_TYPE_IFACE_MODEM_FIRMWARE, iface_modem_firmware_init)
                         G_IMPLEMENT_INTERFACE (MM_TYPE_IFACE_MODEM_LOCATION, iface_modem_location_init)
                         G_IMPLEMENT_INTERFACE (MM_TYPE_IFACE_MODEM_VOICE, iface_modem_voice_init)
                         G_IMPLEMENT_INTERFACE (MM_TYPE_IFACE_MODEM_TIME, iface_modem_time_init)
@@ -94,6 +97,13 @@ peek_parent_interface (MMSharedCinterion *self)
 }
 
 static void
+iface_modem_firmware_init (MMIfaceModemFirmwareInterface *iface)
+{
+    iface->load_update_settings = mm_shared_cinterion_firmware_load_update_settings;
+    iface->load_update_settings_finish = mm_shared_cinterion_firmware_load_update_settings_finish;
+}
+
+static void
 iface_modem_location_init (MMIfaceModemLocationInterface *iface)
 {
     iface_modem_location_parent = g_type_interface_peek_parent (iface);
diff --git a/src/plugins/cinterion/mm-shared-cinterion.c b/src/plugins/cinterion/mm-shared-cinterion.c
index 26135a02..0ebf0499 100644
--- a/src/plugins/cinterion/mm-shared-cinterion.c
+++ b/src/plugins/cinterion/mm-shared-cinterion.c
@@ -25,6 +25,7 @@
 
 #include "mm-log-object.h"
 #include "mm-iface-modem.h"
+#include "mm-iface-modem-firmware.h"
 #include "mm-iface-modem-location.h"
 #include "mm-base-modem.h"
 #include "mm-base-modem-at.h"
@@ -192,6 +193,97 @@ mm_shared_cinterion_modem_reset (MMIfaceModem        *self,
 }
 
 /*****************************************************************************/
+/* Firmware update settings loading (Firmware interface) */
+
+typedef struct {
+    MMFirmwareUpdateSettings *update_settings;
+} LoadUpdateSettingsContext;
+
+static void
+load_update_settings_context_free (LoadUpdateSettingsContext *ctx)
+{
+    g_clear_object (&ctx->update_settings);
+    g_free (ctx);
+}
+
+MMFirmwareUpdateSettings *
+mm_shared_cinterion_firmware_load_update_settings_finish (MMIfaceModemFirmware  *self,
+                                                          GAsyncResult          *res,
+                                                          GError               **error)
+{
+    return g_task_propagate_pointer (G_TASK (res), error);
+}
+
+static void
+sfdl_test_ready (MMBaseModem  *self,
+                 GAsyncResult *res,
+                 GTask        *task)
+{
+    LoadUpdateSettingsContext *ctx;
+
+    ctx = g_task_get_task_data (task);
+
+    if (mm_base_modem_at_command_finish (self, res, NULL))
+        mm_firmware_update_settings_set_method (ctx->update_settings, MM_MODEM_FIRMWARE_UPDATE_METHOD_CINTERION_FDL);
+
+    g_task_return_pointer (task, g_object_ref (ctx->update_settings), g_object_unref);
+    g_object_unref (task);
+}
+
+static void
+modem_set_cinterion_firmware_update_method (MMBaseModem *self,
+                                            GTask       *task)
+{
+    LoadUpdateSettingsContext *ctx;
+    MMPortSerialAt            *at_port;
+
+    ctx = g_task_get_task_data (task);
+
+    /* We always report the primary port as the one to be used for FW upgrade */
+    at_port = mm_base_modem_peek_port_primary (self);
+    if (at_port) {
+        mm_base_modem_at_command (self,
+                                  "AT^SFDL=?",
+                                  3,
+                                  TRUE,
+                                  (GAsyncReadyCallback) sfdl_test_ready,
+                                  task);
+        return;
+    }
+
+    g_task_return_pointer (task, g_object_ref (ctx->update_settings), g_object_unref);
+    g_object_unref (task);
+}
+
+void
+mm_shared_cinterion_firmware_load_update_settings (MMIfaceModemFirmware *self,
+                                                   GAsyncReadyCallback   callback,
+                                                   gpointer              user_data)
+{
+    LoadUpdateSettingsContext *ctx;
+    g_autoptr(GPtrArray)       ids = NULL;
+    GError                    *error = NULL;
+    GTask                     *task;
+
+    task = g_task_new (self, NULL, callback, user_data);
+    ctx = g_new0 (LoadUpdateSettingsContext, 1);
+
+    g_task_set_task_data (task, ctx, (GDestroyNotify)load_update_settings_context_free);
+
+    ctx->update_settings = mm_firmware_update_settings_new (MM_MODEM_FIRMWARE_UPDATE_METHOD_NONE);
+    ids = mm_iface_firmware_build_generic_device_ids (MM_IFACE_MODEM_FIRMWARE (self), &error);
+    if (error) {
+        mm_obj_warn (self, "failed to build generic device ids: %s", error->message);
+        g_task_return_error (task, error);
+        g_object_unref (task);
+        return;
+    }
+
+    mm_firmware_update_settings_set_device_ids (ctx->update_settings, (const gchar **)ids->pdata);
+    modem_set_cinterion_firmware_update_method (MM_BASE_MODEM (self), task);
+}
+
+/*****************************************************************************/
 /* GPS trace received */
 
 static void
diff --git a/src/plugins/cinterion/mm-shared-cinterion.h b/src/plugins/cinterion/mm-shared-cinterion.h
index 76b1d75e..775c8024 100644
--- a/src/plugins/cinterion/mm-shared-cinterion.h
+++ b/src/plugins/cinterion/mm-shared-cinterion.h
@@ -26,6 +26,7 @@
 
 #include "mm-broadband-modem.h"
 #include "mm-iface-modem.h"
+#include "mm-iface-modem-firmware.h"
 #include "mm-iface-modem-location.h"
 #include "mm-iface-modem-voice.h"
 #include "mm-iface-modem-time.h"
@@ -60,6 +61,17 @@ gboolean mm_shared_cinterion_modem_reset_finish (MMIfaceModem        *self,
                                                  GError             **error);
 
 /*****************************************************************************/
+/* Firmware interface */
+
+void mm_shared_cinterion_firmware_load_update_settings (MMIfaceModemFirmware *self,
+                                                        GAsyncReadyCallback   callback,
+                                                        gpointer              user_data);
+
+MMFirmwareUpdateSettings *mm_shared_cinterion_firmware_load_update_settings_finish (MMIfaceModemFirmware  *self,
+                                                                                    GAsyncResult          *res,
+                                                                                    GError               **error);
+
+/*****************************************************************************/
 /* Location interface */
 
 void                  mm_shared_cinterion_location_load_capabilities        (MMIfaceModemLocation *self,