colin/ModemManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

api,firmware: new UpdateSettings property

Browse Source
This commit is contained in:
Aleksander Morgado
2018-12-09 13:54:31 +01:00
committed by Dan Williams
parent edf8d34939
commit 8e342cf120
16 changed files with 965 additions and 273 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
cli/mmcli-modem-firmware.c
View File

@@ -45,10 +45,15 @@ typedef struct {
static Context *ctx;
/* Options */
static gboolean status_flag;
static gboolean list_flag;
static gchar *select_str;
static GOptionEntry entries[] = {
{ "firmware-status", 0, 0, G_OPTION_ARG_NONE, &status_flag,
"Show status of firmware management.",
NULL
},
{ "firmware-list", 0, 0, G_OPTION_ARG_NONE, &list_flag,
"List firmware images installed in a given modem",
NULL
@@ -84,7 +89,8 @@ mmcli_modem_firmware_options_enabled (void)
if (checked)
return !!n_actions;
n_actions = (list_flag +
n_actions = (status_flag +
list_flag +
!!select_str);
if (n_actions > 1) {
@@ -92,6 +98,9 @@ mmcli_modem_firmware_options_enabled (void)
exit (EXIT_FAILURE);
}
if (status_flag)
mmcli_force_sync_operation ();
checked = TRUE;
return !!n_actions;
}
@@ -130,6 +139,34 @@ mmcli_modem_firmware_shutdown (void)
context_free (ctx);
}
static void
print_firmware_status (void)
{
MMFirmwareUpdateSettings *update_settings;
const gchar *method = NULL;
const gchar *fastboot_at = NULL;
update_settings = mm_modem_firmware_peek_update_settings (ctx->modem_firmware);
if (update_settings) {
MMModemFirmwareUpdateMethod m;
m = mm_firmware_update_settings_get_method (update_settings);
method = mm_modem_firmware_update_method_get_string (m);
switch (m) {
case MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT:
fastboot_at = mm_firmware_update_settings_get_fastboot_at (update_settings);
break;
default:
break;
}
}
mmcli_output_string (MMC_F_FIRMWARE_METHOD, method);
mmcli_output_string (MMC_F_FIRMWARE_FASTBOOT_AT, fastboot_at);
mmcli_output_dump ();
}
static void
list_process_reply (MMFirmwareProperties *selected,
GList *result,
@@ -205,6 +242,9 @@ get_modem_ready (GObject *source,
ensure_modem_firmware ();
if (status_flag)
g_assert_not_reached ();
/* Request to list images? */
if (list_flag) {
g_debug ("Asynchronously listing firmware images in modem...");
@@ -264,6 +304,13 @@ mmcli_modem_firmware_run_synchronous (GDBusConnection *connection)
ensure_modem_firmware ();
/* Request to get firmware status? */
if (status_flag) {
g_debug ("Printing firmware status...");
print_firmware_status ();
return;
}
/* Request to list firmware images? */
if (list_flag) {
GList *installed = NULL;

5
cli/mmcli-output.c
View File

@@ -65,6 +65,7 @@ static SectionInfo section_infos[] = {
[MMC_S_MODEM_LOCATION_GPS] = { "GPS" },
[MMC_S_MODEM_LOCATION_CDMABS] = { "CDMA BS" },
[MMC_S_MODEM_FIRMWARE] = { "Firmware" },
[MMC_S_MODEM_FIRMWARE_FASTBOOT] = { "Fastboot settings" },
[MMC_S_BEARER_GENERAL] = { "General" },
[MMC_S_BEARER_STATUS] = { "Status" },
[MMC_S_BEARER_PROPERTIES] = { "Properties" },
@@ -188,7 +189,9 @@ static FieldInfo field_infos[] = {
[MMC_F_LOCATION_GPS_ALT] = { "modem.location.gps.altitude", "altitude", MMC_S_MODEM_LOCATION_GPS, },
[MMC_F_LOCATION_CDMABS_LONG] = { "modem.location.cdma-bs.longitude", "longitude", MMC_S_MODEM_LOCATION_CDMABS, },
[MMC_F_LOCATION_CDMABS_LAT] = { "modem.location.cdma-bs.latitude", "latitude", MMC_S_MODEM_LOCATION_CDMABS, },
[MMC_F_FIRMWARE_LIST] = { "modem.firmware-list", "list", MMC_S_MODEM_FIRMWARE, },
[MMC_F_FIRMWARE_LIST] = { "modem.firmware.list", "list", MMC_S_MODEM_FIRMWARE, },
[MMC_F_FIRMWARE_METHOD] = { "modem.firmware.method", "method", MMC_S_MODEM_FIRMWARE, },
[MMC_F_FIRMWARE_FASTBOOT_AT] = { "modem.firmware.fastboot.at", "at command", MMC_S_MODEM_FIRMWARE_FASTBOOT, },
[MMC_F_BEARER_GENERAL_DBUS_PATH] = { "bearer.dbus-path", "dbus path", MMC_S_BEARER_GENERAL, },
[MMC_F_BEARER_GENERAL_TYPE] = { "bearer.type", "type", MMC_S_BEARER_GENERAL, },
[MMC_F_BEARER_STATUS_CONNECTED] = { "bearer.status.connected", "connected", MMC_S_BEARER_STATUS, },

5
cli/mmcli-output.h
View File

@@ -62,6 +62,7 @@ typedef enum {
MMC_S_MODEM_LOCATION_GPS,
MMC_S_MODEM_LOCATION_CDMABS,
MMC_S_MODEM_FIRMWARE,
MMC_S_MODEM_FIRMWARE_FASTBOOT,
MMC_S_BEARER_GENERAL,
MMC_S_BEARER_STATUS,
MMC_S_BEARER_PROPERTIES,
@@ -200,8 +201,10 @@ typedef enum {
MMC_F_LOCATION_GPS_ALT,
MMC_F_LOCATION_CDMABS_LONG,
MMC_F_LOCATION_CDMABS_LAT,
/* Firmware list */
/* Firmware status section */
MMC_F_FIRMWARE_LIST,
MMC_F_FIRMWARE_METHOD,
MMC_F_FIRMWARE_FASTBOOT_AT,
/* Bearer general section */
MMC_F_BEARER_GENERAL_DBUS_PATH,
MMC_F_BEARER_GENERAL_TYPE,

1
docs/reference/api/ModemManager-sections.txt
View File

@@ -40,6 +40,7 @@ MMModemStateFailedReason
MMModemStateChangeReason
MMModemPowerState
MMModemPortType
MMModemFirmwareUpdateMethod
MMOmaFeature
MMOmaSessionState
MMOmaSessionStateFailedReason

1
docs/reference/libmm-glib/libmm-glib-docs.xml
View File

@@ -116,6 +116,7 @@
<title>Firmware support</title>
<xi:include href="xml/mm-modem-firmware.xml"/>
<xi:include href="xml/mm-firmware-properties.xml"/>
<xi:include href="xml/mm-firmware-update-settings.xml"/>
</section>
<section>
<title>Extended signal information</title>

34
docs/reference/libmm-glib/libmm-glib-sections.txt
View File

@@ -684,7 +684,10 @@ mm_modem_firmware_list_sync
mm_modem_firmware_select
mm_modem_firmware_select_finish
mm_modem_firmware_select_sync
mm_modem_firmware_get_update_settings
mm_modem_firmware_peek_update_settings
<SUBSECTION Standard>
MMModemFirmwarePrivate
MMModemFirmwareClass
MM_IS_MODEM_FIRMWARE
MM_IS_MODEM_FIRMWARE_CLASS
@@ -728,6 +731,30 @@ MM_TYPE_FIRMWARE_PROPERTIES
mm_firmware_properties_get_type
</SECTION>
<SECTION>
<FILE>mm-firmware-update-settings</FILE>
<TITLE>MMFirmwareUpdateSettings</TITLE>
MMFirmwareUpdateSettings
<SUBSECTION Getters>
mm_firmware_update_settings_get_fastboot_at
mm_firmware_update_settings_get_method
<SUBSECTION Private>
mm_firmware_update_settings_get_variant
mm_firmware_update_settings_new
mm_firmware_update_settings_new_from_variant
mm_firmware_update_settings_set_fastboot_at
<SUBSECTION Standard>
MMFirmwareUpdateSettingsClass
MMFirmwareUpdateSettingsPrivate
MM_FIRMWARE_UPDATE_SETTINGS
MM_FIRMWARE_UPDATE_SETTINGS_CLASS
MM_FIRMWARE_UPDATE_SETTINGS_GET_CLASS
MM_IS_FIRMWARE_UPDATE_SETTINGS
MM_IS_FIRMWARE_UPDATE_SETTINGS_CLASS
MM_TYPE_FIRMWARE_UPDATE_SETTINGS
mm_firmware_update_settings_get_type
</SECTION>
<SECTION>
<FILE>mm-modem-oma</FILE>
<TITLE>MMModemOma</TITLE>
@@ -1423,6 +1450,7 @@ mm_modem_cdma_rm_protocol_get_string
mm_modem_location_source_build_string_from_mask
mm_modem_location_assistance_data_type_build_string_from_mask
mm_modem_contacts_storage_get_string
mm_modem_firmware_update_method_get_string
mm_sms_pdu_type_get_string
mm_sms_state_get_string
mm_sms_delivery_state_get_string
@@ -1480,6 +1508,7 @@ mm_oma_session_state_failed_reason_build_string_from_mask
mm_call_direction_build_string_from_mask
mm_call_state_build_string_from_mask
mm_call_state_reason_build_string_from_mask
mm_modem_firmware_update_method_build_string_from_mask
<SUBSECTION Standard>
MM_TYPE_BEARER_TYPE
MM_TYPE_BEARER_IP_FAMILY
@@ -1522,6 +1551,7 @@ MM_TYPE_OMA_SESSION_TYPE
MM_TYPE_CALL_DIRECTION
MM_TYPE_CALL_STATE
MM_TYPE_CALL_STATE_REASON
MM_TYPE_MODEM_FIRMWARE_UPDATE_METHOD
mm_bearer_type_get_type
mm_bearer_ip_family_get_type
mm_bearer_ip_method_get_type
@@ -1563,6 +1593,7 @@ mm_oma_session_type_get_type
mm_call_direction_get_type
mm_call_state_get_type
mm_call_state_reason_get_type
mm_modem_firmware_update_method_get_type
</SECTION>
<SECTION>
@@ -2463,6 +2494,8 @@ mm_gdbus_modem_time_skeleton_get_type
MmGdbusModemFirmware
MmGdbusModemFirmwareIface
<SUBSECTION Getters>
mm_gdbus_modem_firmware_dup_update_settings
mm_gdbus_modem_firmware_get_update_settings
<SUBSECTION Methods>
mm_gdbus_modem_firmware_call_list
mm_gdbus_modem_firmware_call_list_finish
@@ -2471,6 +2504,7 @@ mm_gdbus_modem_firmware_call_select
mm_gdbus_modem_firmware_call_select_finish
mm_gdbus_modem_firmware_call_select_sync
<SUBSECTION Private>
mm_gdbus_modem_firmware_set_update_settings
mm_gdbus_modem_firmware_complete_list
mm_gdbus_modem_firmware_complete_select
mm_gdbus_modem_firmware_interface_info

12
include/ModemManager-enums.h
View File

@@ -1403,4 +1403,16 @@ typedef enum { /*< underscore_name=mm_call_direction >*/
MM_CALL_DIRECTION_OUTGOING = 2
} MMCallDirection;
/**
* MMModemFirmwareUpdateMethod:
* @MM_MODEM_FIRMWARE_UPDATE_METHOD_UNKNOWN: Unknown method.
* @MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT: Device supports fastboot-based update.
*
* Type of firmware update method supported by the module.
*/
typedef enum { /*< underscore_name=mm_modem_firmware_update_method >*/
MM_MODEM_FIRMWARE_UPDATE_METHOD_UNKNOWN,
MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT,
} MMModemFirmwareUpdateMethod;
#endif /* _MODEMMANAGER_ENUMS_H_ */

68
introspection/org.freedesktop.ModemManager1.Modem.Firmware.xml
View File

@@ -6,6 +6,7 @@
Copyright (C) 2011-2013 Red Hat, Inc.
Copyright (C) 2011-2013 Google, Inc.
Copyright (C) 2011-2013 Lanedo GmbH
Copyright (C) 2018 Aleksander Morgado <aleksander@aleksander.es>
-->
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
@@ -14,8 +15,24 @@
org.freedesktop.ModemManager1.Modem.Firmware:
@short_description: The ModemManager Firmware interface.
This interface allows clients to select or install firmware images on
modems.
This interface provides access to perform different firmware-related operations
in the modem, including listing the available firmware images in the module and
selecting which of them to use.
This interface does not provide direct access to perform firmware updates in
the device. Instead, it exposes information about the expected firmware update
method as well as method-specific details required for the upgrade to happen.
The actual firmware upgrade may be performed via the Linux Vendor Firmware Service
and the <link linkend="https://fwupd.org">fwupd</link> daemon.
-->
<interface name="org.freedesktop.ModemManager1.Modem.Firmware">
<!--
List:
@selected: The unique name of the selected firmware image, or the empty string if no image is selected.
@installed: An array of dictionaries containing the properties of the installed firmware images.
List installed firmware images.
Firmware slots and firmware images are identified by arbitrary opaque
strings.
@@ -76,20 +93,6 @@
</varlistentry>
</variablelist>
-->
<interface name="org.freedesktop.ModemManager1.Modem.Firmware">
<!--
List:
@selected: The unique name of the selected firmware image, or the empty string if no image is selected.
@installed: An array of dictionaries containing the properties of the installed firmware images.
List installed firmware images.
Depending on the type of modem, installed images may be stored on the
host or the modem.
Installed images can be selected non-destructively.
-->
<method name="List">
<arg name="selected" type="s" direction="out" />
<arg name="installed" type="aa{sv}" direction="out" />
@@ -106,10 +109,43 @@
returned by
<link linkend="gdbus-method-org-freedesktop-ModemManager1-Modem-Firmware.List">List()</link>,
or if the image could not be selected for some reason.
Installed images can be selected non-destructively.
-->
<method name="Select">
<arg name="uniqueid" type="s" direction="in" />
</method>
<!--
UpdateSettings:
Detailed settings that provide information about how the module should be
updated.
The settings are given as a <link linkend="MMModemFirmwareUpdateMethod">MMModemFirmwareUpdateMethod</link>
value specifying the type of firmware update procedure expected followed by a
dictionary that includes other parameters applicable to the specific method.
<variablelist>
<varlistentry><term><link linkend="MM-MODEM-FIRMWARE-UPDATE-METHOD-FASTBOOT:CAPS">MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT</link></term>
<listitem>
<para>
Devices supporting the fastboot firmware update method require exposing the
following additional settings:
</para>
<variablelist>
<varlistentry><term><literal>"fastboot-at"</literal></term>
<listitem>
(Required) This property exposes the AT command that should be sent to the
module to trigger a reset into fastboot mode (signature <literal>'s'</literal>)
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
-->
<property name="UpdateSettings" type="(ua{sv})" access="read" />
</interface>
</node>

3
libmm-glib/Makefile.am
View File

@@ -77,6 +77,8 @@ libmm_glib_la_SOURCES = \
mm-network-timezone.c \
mm-firmware-properties.h \
mm-firmware-properties.c \
mm-firmware-update-settings.h \
mm-firmware-update-settings.c \
mm-cdma-manual-activation-properties.h \
mm-cdma-manual-activation-properties.c \
mm-signal.h \
@@ -153,6 +155,7 @@ include_HEADERS = \
mm-unlock-retries.h \
mm-network-timezone.h \
mm-firmware-properties.h \
mm-firmware-update-settings.h \
mm-cdma-manual-activation-properties.h \
mm-signal.h \
mm-kernel-event-properties.h \

1
libmm-glib/libmm-glib.h
View File

@@ -75,6 +75,7 @@
#include <mm-unlock-retries.h>
#include <mm-network-timezone.h>
#include <mm-firmware-properties.h>
#include <mm-firmware-update-settings.h>
#include <mm-cdma-manual-activation-properties.h>
#include <mm-signal.h>
#include <mm-kernel-event-properties.h>

259
libmm-glib/mm-firmware-update-settings.c Normal file
View File

@@ -0,0 +1,259 @@
/* -*- 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) 2018 Aleksander Morgado <aleksander@aleksander.es>
*/
#include <string.h>
#include "mm-errors-types.h"
#include "mm-common-helpers.h"
#include "mm-firmware-update-settings.h"
/**
* SECTION: mm-firmware-update-settings
* @title: MMFirmwareUpdateSettings
* @short_description: Helper object to handle firmware update settings.
*
* The #MMFirmwareUpdateSettings is an object handling the settings exposed to
* aid in the firmware update operation.
*/
G_DEFINE_TYPE (MMFirmwareUpdateSettings, mm_firmware_update_settings, G_TYPE_OBJECT)
#define PROPERTY_FASTBOOT_AT "fastboot-at"
struct _MMFirmwareUpdateSettingsPrivate {
MMModemFirmwareUpdateMethod method;
/* Fasboot specific */
gchar *fastboot_at;
};
/*****************************************************************************/
/**
* mm_firmware_update_settings_get_method:
* @self: A #MMFirmwareUpdateSettings.
*
* Gets the method to use during the firmware update operation.
*
* Returns: a #MMModemFirmwareUpdateMethod.
*/
MMModemFirmwareUpdateMethod
mm_firmware_update_settings_get_method (MMFirmwareUpdateSettings *self)
{
g_return_val_if_fail (MM_IS_FIRMWARE_UPDATE_SETTINGS (self), MM_MODEM_FIRMWARE_UPDATE_METHOD_UNKNOWN);
return self->priv->method;
}
/*****************************************************************************/
/**
* mm_firmware_update_settings_get_fastboot_at:
* @self: a #MMFirmwareUpdateSettings.
*
* Gets the AT command that should be sent to the module to trigger a reset
* into fastboot mode.
*
* Only applicable if the update method is %MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT.
*
* Returns: The AT command string, or %NULL if unknown. Do not free the returned value, it is owned by @self.
*/
const gchar *
mm_firmware_update_settings_get_fastboot_at (MMFirmwareUpdateSettings *self)
{
g_return_val_if_fail (MM_IS_FIRMWARE_UPDATE_SETTINGS (self), NULL);
g_return_val_if_fail (self->priv->method == MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT, NULL);
return self->priv->fastboot_at;
}
void
mm_firmware_update_settings_set_fastboot_at (MMFirmwareUpdateSettings *self,
const gchar *fastboot_at)
{
g_return_if_fail (MM_IS_FIRMWARE_UPDATE_SETTINGS (self));
g_return_if_fail (self->priv->method == MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT);
g_free (self->priv->fastboot_at);
self->priv->fastboot_at = g_strdup (fastboot_at);
}
/*****************************************************************************/
/**
* mm_firmware_update_settings_get_variant:
* @self: A #MMFirmwareUpdateSettings.
*
* Gets a variant with the contents of @self.
*
* Returns: (transfer full): A variant with the update settings. The returned value should be freed with g_variant_unref().
*/
GVariant *
mm_firmware_update_settings_get_variant (MMFirmwareUpdateSettings *self)
{
MMModemFirmwareUpdateMethod method;
GVariantBuilder builder;
method = (self ? self->priv->method : MM_MODEM_FIRMWARE_UPDATE_METHOD_UNKNOWN);
g_variant_builder_init (&builder, G_VARIANT_TYPE ("(ua{sv})"));
g_variant_builder_add (&builder, "u", method);
switch (method) {
case MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT:
g_variant_builder_open (&builder, G_VARIANT_TYPE ("a{sv}"));
g_variant_builder_add (&builder,
"{sv}",
PROPERTY_FASTBOOT_AT,
g_variant_new_string (self->priv->fastboot_at));
g_variant_builder_close (&builder);
break;
default:
break;
}
return g_variant_ref_sink (g_variant_builder_end (&builder));
}
/*****************************************************************************/
static gboolean
consume_variant (MMFirmwareUpdateSettings *self,
const gchar *key,
GVariant *value,
GError **error)
{
if (g_str_equal (key, PROPERTY_FASTBOOT_AT)) {
g_free (self->priv->fastboot_at);
self->priv->fastboot_at = g_variant_dup_string (value, NULL);
} else {
g_set_error (error, MM_CORE_ERROR, MM_CORE_ERROR_INVALID_ARGS,
"Invalid settings dictionary, unexpected key '%s'", key);
return FALSE;
}
return TRUE;
}
/**
* mm_firmware_update_settings_new_from_variant:
* @variant: A variant with the update settings.
* @error: Return location for error or %NULL.
*
* Creates a new #MMFirmwareUpdateSettings from the input @variant.
*
* Returns: (transfer full): A #MMFirmwareUpdateSettings or %NULL if @error is set. The returned value should be freed with g_object_unref().
*/
MMFirmwareUpdateSettings *
mm_firmware_update_settings_new_from_variant (GVariant *variant,
GError **error)
{
MMFirmwareUpdateSettings *self;
guint method = MM_MODEM_FIRMWARE_UPDATE_METHOD_UNKNOWN;
GVariant *dictionary = NULL;
GError *inner_error = NULL;
if (!variant) {
g_set_error (error, MM_CORE_ERROR, MM_CORE_ERROR_INVALID_ARGS,
"No input given");
return NULL;
}
if (!g_variant_is_of_type (variant, G_VARIANT_TYPE ("(ua{sv})"))) {
g_set_error (error, MM_CORE_ERROR, MM_CORE_ERROR_INVALID_ARGS,
"Invalid input type");
return NULL;
}
g_variant_get (variant, "(u@a{sv})", &method, &dictionary);
self = mm_firmware_update_settings_new (method);
if (dictionary) {
GVariantIter iter;
gchar *key;
GVariant *value;
g_variant_iter_init (&iter, dictionary);
while (!inner_error && g_variant_iter_next (&iter, "{sv}", &key, &value)) {
consume_variant (self, key, value, &inner_error);
g_free (key);
g_variant_unref (value);
}
if (!inner_error) {
switch (method) {
case MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT:
if (!self->priv->fastboot_at)
inner_error = g_error_new (MM_CORE_ERROR, MM_CORE_ERROR_INVALID_ARGS,
"Fastboot method requires the '" PROPERTY_FASTBOOT_AT "' setting");
break;
}
}
g_variant_unref (dictionary);
}
if (inner_error) {
g_propagate_error (error, inner_error);
g_object_unref (self);
return NULL;
}
return self;
}
/*****************************************************************************/
/**
* mm_firmware_update_settings_new:
* @method: A #MMModemFirmwareUpdateMethod specifying the update method.
*
* Creates a new #MMFirmwareUpdateSettings object.
*
* Returns: (transfer full): A #MMFirmwareUpdateSettings. The returned value should be freed with g_object_unref().
*/
MMFirmwareUpdateSettings *
mm_firmware_update_settings_new (MMModemFirmwareUpdateMethod method)
{
MMFirmwareUpdateSettings *self;
self = g_object_new (MM_TYPE_FIRMWARE_UPDATE_SETTINGS, NULL);
self->priv->method = method;
return self;
}
static void
mm_firmware_update_settings_init (MMFirmwareUpdateSettings *self)
{
self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self, MM_TYPE_FIRMWARE_UPDATE_SETTINGS, MMFirmwareUpdateSettingsPrivate);
self->priv->method = MM_MODEM_FIRMWARE_UPDATE_METHOD_UNKNOWN;
}
static void
finalize (GObject *object)
{
MMFirmwareUpdateSettings *self = MM_FIRMWARE_UPDATE_SETTINGS (object);
g_free (self->priv->fastboot_at);
G_OBJECT_CLASS (mm_firmware_update_settings_parent_class)->finalize (object);
}
static void
mm_firmware_update_settings_class_init (MMFirmwareUpdateSettingsClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
g_type_class_add_private (object_class, sizeof (MMFirmwareUpdateSettingsPrivate));
object_class->finalize = finalize;
}

89
libmm-glib/mm-firmware-update-settings.h Normal file
View File

@@ -0,0 +1,89 @@
/* -*- 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) 2018 Aleksander Morgado <aleksander@aleksander.es>
*/
#ifndef MM_FIRMWARE_UPDATE_SETTINGS_H
#define MM_FIRMWARE_UPDATE_SETTINGS_H
#if !defined (__LIBMM_GLIB_H_INSIDE__) && !defined (LIBMM_GLIB_COMPILATION)
#error "Only <libmm-glib.h> can be included directly."
#endif
#include <ModemManager.h>
#include <glib-object.h>
G_BEGIN_DECLS
#define MM_TYPE_FIRMWARE_UPDATE_SETTINGS (mm_firmware_update_settings_get_type ())
#define MM_FIRMWARE_UPDATE_SETTINGS(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), MM_TYPE_FIRMWARE_UPDATE_SETTINGS, MMFirmwareUpdateSettings))
#define MM_FIRMWARE_UPDATE_SETTINGS_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), MM_TYPE_FIRMWARE_UPDATE_SETTINGS, MMFirmwareUpdateSettingsClass))
#define MM_IS_FIRMWARE_UPDATE_SETTINGS(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), MM_TYPE_FIRMWARE_UPDATE_SETTINGS))
#define MM_IS_FIRMWARE_UPDATE_SETTINGS_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), MM_TYPE_FIRMWARE_UPDATE_SETTINGS))
#define MM_FIRMWARE_UPDATE_SETTINGS_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), MM_TYPE_FIRMWARE_UPDATE_SETTINGS, MMFirmwareUpdateSettingsClass))
typedef struct _MMFirmwareUpdateSettings MMFirmwareUpdateSettings;
typedef struct _MMFirmwareUpdateSettingsClass MMFirmwareUpdateSettingsClass;
typedef struct _MMFirmwareUpdateSettingsPrivate MMFirmwareUpdateSettingsPrivate;
/**
* MMFirmwareUpdateSettings:
*
* The #MMFirmwareUpdateSettings structure contains private data and should only be accessed
* using the provided API.
*/
struct _MMFirmwareUpdateSettings {
/*< private >*/
GObject parent;
MMFirmwareUpdateSettingsPrivate *priv;
};
struct _MMFirmwareUpdateSettingsClass {
/*< private >*/
GObjectClass parent;
};
GType mm_firmware_update_settings_get_type (void);
#if GLIB_CHECK_VERSION(2, 44, 0)
G_DEFINE_AUTOPTR_CLEANUP_FUNC (MMFirmwareUpdateSettings, g_object_unref)
#endif
MMModemFirmwareUpdateMethod mm_firmware_update_settings_get_method (MMFirmwareUpdateSettings *self);
/* Fastboot specific */
const gchar *mm_firmware_update_settings_get_fastboot_at (MMFirmwareUpdateSettings *self);
/*****************************************************************************/
/* ModemManager/libmm-glib/mmcli specific methods */
#if defined (_LIBMM_INSIDE_MM) || \
defined (_LIBMM_INSIDE_MMCLI) || \
defined (LIBMM_GLIB_COMPILATION)
MMFirmwareUpdateSettings *mm_firmware_update_settings_new (MMModemFirmwareUpdateMethod method);
MMFirmwareUpdateSettings *mm_firmware_update_settings_new_from_variant (GVariant *variant,
GError **error);
GVariant *mm_firmware_update_settings_get_variant (MMFirmwareUpdateSettings *self);
/* Fastboot specific */
void mm_firmware_update_settings_set_fastboot_at (MMFirmwareUpdateSettings *self,
const gchar *fastboot_at);
#endif
G_END_DECLS
#endif /* MM_FIRMWARE_UPDATE_SETTINGS_H */

145
libmm-glib/mm-modem-firmware.c
View File

@@ -40,6 +40,12 @@
G_DEFINE_TYPE (MMModemFirmware, mm_modem_firmware, MM_GDBUS_TYPE_MODEM_FIRMWARE_PROXY)
struct _MMModemFirmwarePrivate {
GMutex update_settings_mutex;
guint update_settings_id;
MMFirmwareUpdateSettings *update_settings;
};
/*****************************************************************************/
/**
@@ -82,6 +88,116 @@ mm_modem_firmware_dup_path (MMModemFirmware *self)
/*****************************************************************************/
static void
update_settings_updated (MMModemFirmware *self,
GParamSpec *pspec)
{
g_mutex_lock (&self->priv->update_settings_mutex);
{
GVariant *variant;
g_clear_object (&self->priv->update_settings);
variant = mm_gdbus_modem_firmware_get_update_settings (MM_GDBUS_MODEM_FIRMWARE (self));
if (variant) {
GError *error = NULL;
self->priv->update_settings = mm_firmware_update_settings_new_from_variant (variant, &error);
if (error) {
g_warning ("Invalid update settings received: %s", error->message);
g_error_free (error);
}
}
}
g_mutex_unlock (&self->priv->update_settings_mutex);
}
static void
ensure_internal_update_settings (MMModemFirmware *self,
MMFirmwareUpdateSettings **dupl)
{
g_mutex_lock (&self->priv->update_settings_mutex);
{
/* If this is the first time ever asking for the object, setup the
* update listener and the initial object, if any. */
if (!self->priv->update_settings_id) {
GVariant *variant;
variant = mm_gdbus_modem_firmware_dup_update_settings (MM_GDBUS_MODEM_FIRMWARE (self));
if (variant) {
GError *error = NULL;
self->priv->update_settings = mm_firmware_update_settings_new_from_variant (variant, &error);
if (error) {
g_warning ("Invalid initial update settings: %s", error->message);
g_error_free (error);
}
g_variant_unref (variant);
}
/* No need to clear this signal connection when freeing self */
self->priv->update_settings_id =
g_signal_connect (self,
"notify::update-settings",
G_CALLBACK (update_settings_updated),
NULL);
}
if (dupl && self->priv->update_settings)
*dupl = g_object_ref (self->priv->update_settings);
}
g_mutex_unlock (&self->priv->update_settings_mutex);
}
/**
* mm_modem_firmware_get_update_settings:
* @self: A #MMModemFirmware.
*
* Gets a #MMFirmwareUpdateSettings object specifying the expected update
* settings.
*
* <warning>The values reported by @self are not updated when the values in the
* interface change. Instead, the client is expected to call
* mm_modem_firmware_get_update_settings() again to get a new #MMFirmwareUpdateSettings
* with the new values.</warning>
*
* Returns: (transfer full): A #MMFirmwareUpdateSettings that must be freed with g_object_unref() or %NULL if unknown.
*/
MMFirmwareUpdateSettings *
mm_modem_firmware_get_update_settings (MMModemFirmware *self)
{
MMFirmwareUpdateSettings *update_settings = NULL;
g_return_val_if_fail (MM_IS_MODEM_FIRMWARE (self), NULL);
ensure_internal_update_settings (self, &update_settings);
return update_settings;
}
/**
* mm_modem_firmware_peek_update_settings:
* @self: A #MMModemFirmware.
*
* Gets a #MMFirmwareUpdateSettings object specifying the expected update
* settings.
*
* <warning>The returned value is only valid until the property changes so
* it is only safe to use this function on the thread where
* @self was constructed. Use mm_modem_firmware_get_update_settings() if on
* another thread.</warning>
*
* Returns: (transfer none): A #MMFirmwareUpdateSettings. Do not free the returned value, it belongs to @self.
*/
MMFirmwareUpdateSettings *
mm_modem_firmware_peek_update_settings (MMModemFirmware *self)
{
g_return_val_if_fail (MM_IS_MODEM_FIRMWARE (self), NULL);
ensure_internal_update_settings (self, NULL);
return self->priv->update_settings;
}
/*****************************************************************************/
/**
* mm_modem_firmware_select_finish:
* @self: A #MMModemFirmware.
@@ -372,9 +488,38 @@ mm_modem_firmware_list_sync (MMModemFirmware *self,
static void
mm_modem_firmware_init (MMModemFirmware *self)
{
self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self, MM_TYPE_MODEM_FIRMWARE, MMModemFirmwarePrivate);
g_mutex_init (&self->priv->update_settings_mutex);
}
static void
finalize (GObject *object)
{
MMModemFirmware *self = MM_MODEM_FIRMWARE (object);
g_mutex_clear (&self->priv->update_settings_mutex);
G_OBJECT_CLASS (mm_modem_firmware_parent_class)->finalize (object);
}
static void
dispose (GObject *object)
{
MMModemFirmware *self = MM_MODEM_FIRMWARE (object);
g_clear_object (&self->priv->update_settings);
G_OBJECT_CLASS (mm_modem_firmware_parent_class)->dispose (object);
}
static void
mm_modem_firmware_class_init (MMModemFirmwareClass *modem_class)
{
GObjectClass *object_class = G_OBJECT_CLASS (modem_class);
g_type_class_add_private (object_class, sizeof (MMModemFirmwarePrivate));
/* Virtual methods */
object_class->dispose = dispose;
object_class->finalize = finalize;
}

8
libmm-glib/mm-modem-firmware.h
View File

@@ -18,6 +18,7 @@
* Boston, MA 02110-1301 USA.
*
* Copyright (C) 2012 Google, Inc.
* Copyright (C) 2018 Aleksander Morgado <aleksander@aleksander.es>
*/
#ifndef _MM_MODEM_FIRMWARE_H_
@@ -31,6 +32,7 @@
#include "mm-gdbus-modem.h"
#include "mm-firmware-properties.h"
#include "mm-firmware-update-settings.h"
G_BEGIN_DECLS
@@ -43,6 +45,7 @@ G_BEGIN_DECLS
typedef struct _MMModemFirmware MMModemFirmware;
typedef struct _MMModemFirmwareClass MMModemFirmwareClass;
typedef struct _MMModemFirmwarePrivate MMModemFirmwarePrivate;
/**
* MMModemFirmware:
@@ -53,7 +56,7 @@ typedef struct _MMModemFirmwareClass MMModemFirmwareClass;
struct _MMModemFirmware {
/*< private >*/
MmGdbusModemFirmwareProxy parent;
gpointer unused;
MMModemFirmwarePrivate *priv;
};
struct _MMModemFirmwareClass {
@@ -70,6 +73,9 @@ G_DEFINE_AUTOPTR_CLEANUP_FUNC (MMModemFirmware, g_object_unref)
const gchar *mm_modem_firmware_get_path (MMModemFirmware *self);
gchar *mm_modem_firmware_dup_path (MMModemFirmware *self);
MMFirmwareUpdateSettings *mm_modem_firmware_get_update_settings (MMModemFirmware *self);
MMFirmwareUpdateSettings *mm_modem_firmware_peek_update_settings (MMModemFirmware *self);
void mm_modem_firmware_list (MMModemFirmware *self,
GCancellable *cancellable,
GAsyncReadyCallback callback,

44
src/mm-iface-modem-firmware.c
View File

@@ -251,6 +251,7 @@ typedef enum {
INITIALIZATION_STEP_FIRST,
INITIALIZATION_STEP_CHECK_SUPPORT,
INITIALIZATION_STEP_FAIL_IF_UNSUPPORTED,
INITIALIZATION_STEP_UPDATE_SETTINGS,
INITIALIZATION_STEP_LAST
} InitializationStep;
@@ -266,6 +267,37 @@ initialization_context_free (InitializationContext *ctx)
g_free (ctx);
}
static void
load_update_settings_ready (MMIfaceModemFirmware *self,
GAsyncResult *res,
GTask *task)
{
InitializationContext *ctx;
MMFirmwareUpdateSettings *update_settings;
GError *error = NULL;
GVariant *variant = NULL;
ctx = g_task_get_task_data (task);
update_settings = MM_IFACE_MODEM_FIRMWARE_GET_INTERFACE (self)->load_update_settings_finish (self, res, &error);
if (!update_settings) {
mm_dbg ("Couldn't load update settings: '%s'", error->message);
g_error_free (error);
} else {
variant = mm_firmware_update_settings_get_variant (update_settings);
g_object_unref (update_settings);
}
mm_gdbus_modem_firmware_set_update_settings (ctx->skeleton, variant);
if (variant)
g_variant_unref (variant);
/* Go on to next step */
ctx->step++;
interface_initialization_step (task);
}
static void
check_support_ready (MMIfaceModemFirmware *self,
GAsyncResult *res,
@@ -363,6 +395,18 @@ interface_initialization_step (GTask *task)
/* Fall down to next step */
ctx->step++;
case INITIALIZATION_STEP_UPDATE_SETTINGS:
if (MM_IFACE_MODEM_FIRMWARE_GET_INTERFACE (self)->load_update_settings &&
MM_IFACE_MODEM_FIRMWARE_GET_INTERFACE (self)->load_update_settings_finish) {
MM_IFACE_MODEM_FIRMWARE_GET_INTERFACE (self)->load_update_settings (
self,
(GAsyncReadyCallback)load_update_settings_ready,
task);
return;
}
/* Fall down to next step */
ctx->step++;
case INITIALIZATION_STEP_LAST:
/* We are done without errors! */

8
src/mm-iface-modem-firmware.h
View File

@@ -42,6 +42,14 @@ struct _MMIfaceModemFirmware {
GAsyncResult *res,
GError **error);
/* Get update settings (async) */
void (* load_update_settings) (MMIfaceModemFirmware *self,
GAsyncReadyCallback callback,
gpointer user_data);
MMFirmwareUpdateSettings * (* load_update_settings_finish) (MMIfaceModemFirmware *self,
GAsyncResult *res,
GError **error);
/* Get Firmware list (async) */
void (* load_list) (MMIfaceModemFirmware *self,
GAsyncReadyCallback callback,