SymbX/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
2019-01-03 18:53:52 +00: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
libmm-glib/Makefile.am
+3
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 \
libmm-glib/libmm-glib.h
+1
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>
libmm-glib/mm-firmware-update-settings.c
+259
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;
}
libmm-glib/mm-firmware-update-settings.h
+89
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 */
libmm-glib/mm-modem-firmware.c
+145
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;
}
libmm-glib/mm-modem-firmware.h
+7 -1
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,