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

api,firmware: MMModemFirmwareUpdateMethod as flags, not enum

Browse Source 
Devices may require/support more than one update method, so instead of
reporting the method as a single enum value, use a set of flags
instead.
This commit is contained in:
Aleksander Morgado
2018-12-28 12:59:55 +01:00
committed by Dan Williams
parent f35d64a899
commit 87712c27f5
6 changed files with 41 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -143,7 +143,7 @@ static void
print_firmware_status (void) print_firmware_status (void)
{ {
MMFirmwareUpdateSettings *update_settings; MMFirmwareUpdateSettings *update_settings;
const gchar *method = NULL; gchar *method = NULL;
const gchar **device_ids = NULL; const gchar **device_ids = NULL;
const gchar *version = NULL; const gchar *version = NULL;
const gchar *fastboot_at = NULL; const gchar *fastboot_at = NULL;
@@ -153,8 +153,8 @@ print_firmware_status (void)
MMModemFirmwareUpdateMethod m; MMModemFirmwareUpdateMethod m;
m = mm_firmware_update_settings_get_method (update_settings); m = mm_firmware_update_settings_get_method (update_settings);
if (m != MM_MODEM_FIRMWARE_UPDATE_METHOD_UNKNOWN) { if (m != MM_MODEM_FIRMWARE_UPDATE_METHOD_NONE) {
method = mm_modem_firmware_update_method_get_string (m); method = mm_modem_firmware_update_method_build_string_from_mask (m);
device_ids = mm_firmware_update_settings_get_device_ids (update_settings); device_ids = mm_firmware_update_settings_get_device_ids (update_settings);
version = mm_firmware_update_settings_get_version (update_settings); version = mm_firmware_update_settings_get_version (update_settings);
} }
@@ -180,7 +180,7 @@ print_firmware_status (void)
exit (EXIT_FAILURE); exit (EXIT_FAILURE);
} }
mmcli_output_string (MMC_F_FIRMWARE_METHOD, method); mmcli_output_string_take (MMC_F_FIRMWARE_METHOD, method);
mmcli_output_string_array (MMC_F_FIRMWARE_DEVICE_IDS, device_ids, TRUE); mmcli_output_string_array (MMC_F_FIRMWARE_DEVICE_IDS, device_ids, TRUE);
mmcli_output_string (MMC_F_FIRMWARE_VERSION, version); mmcli_output_string (MMC_F_FIRMWARE_VERSION, version);
mmcli_output_string (MMC_F_FIRMWARE_FASTBOOT_AT, fastboot_at); mmcli_output_string (MMC_F_FIRMWARE_FASTBOOT_AT, fastboot_at);

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

@@ -1454,7 +1454,7 @@ mm_modem_cdma_rm_protocol_get_string
mm_modem_location_source_build_string_from_mask mm_modem_location_source_build_string_from_mask
mm_modem_location_assistance_data_type_build_string_from_mask mm_modem_location_assistance_data_type_build_string_from_mask
mm_modem_contacts_storage_get_string mm_modem_contacts_storage_get_string
mm_modem_firmware_update_method_get_string mm_modem_firmware_update_method_build_string_from_mask
mm_sms_pdu_type_get_string mm_sms_pdu_type_get_string
mm_sms_state_get_string mm_sms_state_get_string
mm_sms_delivery_state_get_string mm_sms_delivery_state_get_string
@@ -1512,7 +1512,7 @@ mm_oma_session_state_failed_reason_build_string_from_mask
mm_call_direction_build_string_from_mask mm_call_direction_build_string_from_mask
mm_call_state_build_string_from_mask mm_call_state_build_string_from_mask
mm_call_state_reason_build_string_from_mask mm_call_state_reason_build_string_from_mask
mm_modem_firmware_update_method_build_string_from_mask mm_modem_firmware_update_method_get_string
<SUBSECTION Standard> <SUBSECTION Standard>
MM_TYPE_BEARER_TYPE MM_TYPE_BEARER_TYPE
MM_TYPE_BEARER_IP_FAMILY MM_TYPE_BEARER_IP_FAMILY

6
include/ModemManager-enums.h
View File

@@ -1405,14 +1405,14 @@ typedef enum { /*< underscore_name=mm_call_direction >*/
/** /**
* MMModemFirmwareUpdateMethod: * MMModemFirmwareUpdateMethod:
* @MM_MODEM_FIRMWARE_UPDATE_METHOD_UNKNOWN: Unknown method. * @MM_MODEM_FIRMWARE_UPDATE_METHOD_NONE: No method specified.
* @MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT: Device supports fastboot-based update. * @MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT: Device supports fastboot-based update.
* *
* Type of firmware update method supported by the module. * Type of firmware update method supported by the module.
*/ */
typedef enum { /*< underscore_name=mm_modem_firmware_update_method >*/ typedef enum { /*< underscore_name=mm_modem_firmware_update_method >*/
MM_MODEM_FIRMWARE_UPDATE_METHOD_UNKNOWN, MM_MODEM_FIRMWARE_UPDATE_METHOD_NONE = 0,
MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT, MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT = 1 << 0,
} MMModemFirmwareUpdateMethod; } MMModemFirmwareUpdateMethod;
#endif /* _MODEMMANAGER_ENUMS_H_ */ #endif /* _MODEMMANAGER_ENUMS_H_ */

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

@@ -122,17 +122,16 @@
Detailed settings that provide information about how the module should be Detailed settings that provide information about how the module should be
updated. updated.
The settings are given as a bitmask of <link linkend="MMModemFirmwareUpdateMethod">MMModemFirmwareUpdateMethod</link>
The settings are given as a <link linkend="MMModemFirmwareUpdateMethod">MMModemFirmwareUpdateMethod</link> values specifying the type of firmware update procedures expected followed by a
value specifying the type of firmware update procedure expected followed by a dictionary that includes other parameters applicable to the specific methods reported.
dictionary that includes other parameters applicable to the specific method.
<variablelist> <variablelist>
<varlistentry><term><link linkend="MM-MODEM-FIRMWARE-UPDATE-METHOD-FASTBOOT:CAPS">MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT</link></term> <varlistentry>
<listitem> <listitem>
<para> <para>
Devices supporting the fastboot firmware update method require exposing the The following settings are mandatory as long as the reported update method is not
following additional settings: <term><link linkend="MM-MODEM-FIRMWARE-UPDATE-METHOD-NONE:CAPS">MM_MODEM_FIRMWARE_UPDATE_METHOD_NONE</link></term>.
</para> </para>
<variablelist> <variablelist>
<varlistentry><term><literal>"device-ids"</literal></term> <varlistentry><term><literal>"device-ids"</literal></term>
@@ -152,6 +151,18 @@
(signature <literal>'s'</literal>) (signature <literal>'s'</literal>)
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<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>
<varlistentry><term><literal>"fastboot-at"</literal></term> <varlistentry><term><literal>"fastboot-at"</literal></term>
<listitem> <listitem>
(Required) This property exposes the AT command that should be sent to the (Required) This property exposes the AT command that should be sent to the

34
libmm-glib/mm-firmware-update-settings.c
View File

@@ -49,14 +49,14 @@ struct _MMFirmwareUpdateSettingsPrivate {
* mm_firmware_update_settings_get_method: * mm_firmware_update_settings_get_method:
* @self: A #MMFirmwareUpdateSettings. * @self: A #MMFirmwareUpdateSettings.
* *
* Gets the method to use during the firmware update operation. * Gets the methods to use during the firmware update operation.
* *
* Returns: a #MMModemFirmwareUpdateMethod. * Returns: a bitmask of #MMModemFirmwareUpdateMethod values.
*/ */
MMModemFirmwareUpdateMethod MMModemFirmwareUpdateMethod
mm_firmware_update_settings_get_method (MMFirmwareUpdateSettings *self) 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); g_return_val_if_fail (MM_IS_FIRMWARE_UPDATE_SETTINGS (self), MM_MODEM_FIRMWARE_UPDATE_METHOD_NONE);
return self->priv->method; return self->priv->method;
} }
@@ -128,7 +128,7 @@ mm_firmware_update_settings_set_version (MMFirmwareUpdateSettings *self,
* Gets the AT command that should be sent to the module to trigger a reset * Gets the AT command that should be sent to the module to trigger a reset
* into fastboot mode. * into fastboot mode.
* *
* Only applicable if the update method is %MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT. * Only applicable if the update method includes %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. * Returns: The AT command string, or %NULL if unknown. Do not free the returned value, it is owned by @self.
*/ */
@@ -136,7 +136,7 @@ const gchar *
mm_firmware_update_settings_get_fastboot_at (MMFirmwareUpdateSettings *self) 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 (MM_IS_FIRMWARE_UPDATE_SETTINGS (self), NULL);
g_return_val_if_fail (self->priv->method == MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT, NULL); g_return_val_if_fail (self->priv->method & MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT, NULL);
return self->priv->fastboot_at; return self->priv->fastboot_at;
} }
@@ -146,7 +146,7 @@ mm_firmware_update_settings_set_fastboot_at (MMFirmwareUpdateSettings *self,
const gchar *fastboot_at) const gchar *fastboot_at)
{ {
g_return_if_fail (MM_IS_FIRMWARE_UPDATE_SETTINGS (self)); g_return_if_fail (MM_IS_FIRMWARE_UPDATE_SETTINGS (self));
g_return_if_fail (self->priv->method == MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT); g_return_if_fail (self->priv->method & MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT);
g_free (self->priv->fastboot_at); g_free (self->priv->fastboot_at);
self->priv->fastboot_at = g_strdup (fastboot_at); self->priv->fastboot_at = g_strdup (fastboot_at);
@@ -168,7 +168,7 @@ mm_firmware_update_settings_get_variant (MMFirmwareUpdateSettings *self)
MMModemFirmwareUpdateMethod method; MMModemFirmwareUpdateMethod method;
GVariantBuilder builder; GVariantBuilder builder;
method = (self ? self->priv->method : MM_MODEM_FIRMWARE_UPDATE_METHOD_UNKNOWN); method = (self ? self->priv->method : MM_MODEM_FIRMWARE_UPDATE_METHOD_NONE);
g_variant_builder_init (&builder, G_VARIANT_TYPE ("(ua{sv})")); g_variant_builder_init (&builder, G_VARIANT_TYPE ("(ua{sv})"));
g_variant_builder_add (&builder, "u", method); g_variant_builder_add (&builder, "u", method);
@@ -185,15 +185,11 @@ mm_firmware_update_settings_get_variant (MMFirmwareUpdateSettings *self)
PROPERTY_VERSION, PROPERTY_VERSION,
g_variant_new_string (self->priv->version)); g_variant_new_string (self->priv->version));
switch (method) { if (method & MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT) {
case MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT:
g_variant_builder_add (&builder, g_variant_builder_add (&builder,
"{sv}", "{sv}",
PROPERTY_FASTBOOT_AT, PROPERTY_FASTBOOT_AT,
g_variant_new_string (self->priv->fastboot_at)); g_variant_new_string (self->priv->fastboot_at));
break;
default:
break;
} }
} }
g_variant_builder_close (&builder); g_variant_builder_close (&builder);
@@ -240,7 +236,7 @@ mm_firmware_update_settings_new_from_variant (GVariant *variant,
GError **error) GError **error)
{ {
MMFirmwareUpdateSettings *self; MMFirmwareUpdateSettings *self;
guint method = MM_MODEM_FIRMWARE_UPDATE_METHOD_UNKNOWN; guint method = MM_MODEM_FIRMWARE_UPDATE_METHOD_NONE;
GVariant *dictionary = NULL; GVariant *dictionary = NULL;
GError *inner_error = NULL; GError *inner_error = NULL;
@@ -281,13 +277,9 @@ mm_firmware_update_settings_new_from_variant (GVariant *variant,
} }
if (!inner_error) { if (!inner_error) {
switch (method) { if ((method & MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT) && (!self->priv->fastboot_at))
case MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT: inner_error = g_error_new (MM_CORE_ERROR, MM_CORE_ERROR_INVALID_ARGS,
if (!self->priv->fastboot_at) "Fastboot method requires the '" PROPERTY_FASTBOOT_AT "' setting");
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); g_variant_unref (dictionary);
} }
@@ -317,7 +309,7 @@ static void
mm_firmware_update_settings_init (MMFirmwareUpdateSettings *self) mm_firmware_update_settings_init (MMFirmwareUpdateSettings *self)
{ {
self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self, MM_TYPE_FIRMWARE_UPDATE_SETTINGS, MMFirmwareUpdateSettingsPrivate); self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self, MM_TYPE_FIRMWARE_UPDATE_SETTINGS, MMFirmwareUpdateSettingsPrivate);
self->priv->method = MM_MODEM_FIRMWARE_UPDATE_METHOD_UNKNOWN; self->priv->method = MM_MODEM_FIRMWARE_UPDATE_METHOD_NONE;
} }
static void static void

2
plugins/quectel/mm-shared-quectel.c
View File

@@ -45,7 +45,7 @@ qfastboot_test_ready (MMBaseModem *self,
MMFirmwareUpdateSettings *update_settings; MMFirmwareUpdateSettings *update_settings;
if (!mm_base_modem_at_command_finish (self, res, NULL)) if (!mm_base_modem_at_command_finish (self, res, NULL))
update_settings = mm_firmware_update_settings_new (MM_MODEM_FIRMWARE_UPDATE_METHOD_UNKNOWN); update_settings = mm_firmware_update_settings_new (MM_MODEM_FIRMWARE_UPDATE_METHOD_NONE);
else { else {
update_settings = mm_firmware_update_settings_new (MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT); update_settings = mm_firmware_update_settings_new (MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT);
mm_firmware_update_settings_set_fastboot_at (update_settings, "AT+QFASTBOOT"); mm_firmware_update_settings_set_fastboot_at (update_settings, "AT+QFASTBOOT");