1
<?xml version="1.0" encoding="UTF-8" ?>
4
ModemManager 0.6 Interface Specification
6
Copyright (C) 2008 Novell, Inc.
7
Copyright (C) 2008-2011 Red Hat, Inc.
8
Copyright (C) 2011 The Chromium OS Authors
9
Copyright (C) 2011 Google, Inc.
12
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
15
org.freedesktop.ModemManager1.Modem.Firmware:
16
@short_description: The ModemManager Firmware interface.
18
This interface allows clients to select or install firmware images on
21
Firmware slots and firmware images are identified by arbitrary opaque
24
Firmware images are represented as dictionaries of properties.
25
Certain properties are pre-defined, and some are required:
28
<varlistentry><term><literal>"image-type"</literal></term>
30
(Required) Type of the firmware image, given as a
31
<link linkend="MMFirmwareImageType">MMFirmwareImageType</link> value
32
(signature <literal>"u"</literal>). Firmware images of type
33
<link linkend="MM-FIRMWARE-IMAGE-TYPE-GENERIC:CAPS">MM_FIRMWARE_IMAGE_TYPE_GENERIC</link>
34
will only expose only the mandatory properties.
37
<varlistentry><term><literal>"unique-id"</literal></term>
39
(Required) A user-readable unique ID for the firmware image, given as a
40
string value (signature <literal>"s"</literal>).
43
<varlistentry><term><literal>"gobi-pri-version"</literal></term>
45
(Optional) The version of the PRI firmware image, in images of type
46
<link linkend="MM-FIRMWARE-IMAGE-TYPE-GOBI:CAPS">MM_FIRMWARE_IMAGE_TYPE_GOBI</link>,
47
given as a string value (signature <literal>"s"</literal>).
50
<varlistentry><term><literal>"gobi-pri-info"</literal></term>
52
(Optional) Additional information of the PRI image, in images of type
53
<link linkend="MM-FIRMWARE-IMAGE-TYPE-GOBI:CAPS">MM_FIRMWARE_IMAGE_TYPE_GOBI</link>,
54
given as a string value (signature <literal>"s"</literal>).
57
<varlistentry><term><literal>"gobi-boot-version"</literal></term>
59
(Optional) The boot version of the PRI firmware image, in images of type
60
<link linkend="MM-FIRMWARE-IMAGE-TYPE-GOBI:CAPS">MM_FIRMWARE_IMAGE_TYPE_GOBI</link>,
61
given as a string value (signature <literal>"s"</literal>).
64
<varlistentry><term><literal>"gobi-pri-unique-id"</literal></term>
66
(Optional) The unique ID of the PRI firmware image, in images of type
67
<link linkend="MM-FIRMWARE-IMAGE-TYPE-GOBI:CAPS">MM_FIRMWARE_IMAGE_TYPE_GOBI</link>,
68
given as a string value (signature <literal>"s"</literal>).
71
<varlistentry><term><literal>"gobi-modem-unique-id"</literal></term>
73
(Optional) The unique ID of the Modem firmware image, in images of type
74
<link linkend="MM-FIRMWARE-IMAGE-TYPE-GOBI:CAPS">MM_FIRMWARE_IMAGE_TYPE_GOBI</link>,
75
given as a string value (signature <literal>"s"</literal>).
80
<interface name="org.freedesktop.ModemManager1.Modem.Firmware">
84
@selected: The unique name of the selected firmware image, or the empty string if no image is selected.
85
@installed: An array of dictionaries containing the properties of the installed firmware images.
87
List installed firmware images.
89
Depending on the type of modem, installed images may be stored on the
92
Installed images can be selected non-destructively.
95
<arg name="selected" type="s" direction="out" />
96
<arg name="installed" type="aa{sv}" direction="out" />
101
@uniqueid: The unique ID of the firmware image to select.
103
Selects a different firmware image to use, and immediately resets the
104
modem so that it begins using the new firmware image.
106
The method will fail if the identifier does not match any of the names
108
<link linkend="gdbus-method-org-freedesktop-ModemManager1-Modem-Firmware.List">List()</link>,
109
or if the image could not be selected for some reason.
111
<method name="Select">
112
<arg name="uniqueid" type="s" direction="in" />
117
@image: The identifier of the firmware image to install.
118
@slot: The identifier of the slot into which the firmware should be installed.
120
Install an available firmware image into a slot.
122
It does not guarantee that the image will be installed into the
123
specified slot, but does guarantee that, if the slot is empty, no
124
image will be overwritten, and if the slot is not empty, no image
125
other than the one in that slot will be overwritten.
127
The method will fail if either of the identifiers is invalid, or if the
128
image could not be installed into the slot for some reason.
130
<method name="Install">
131
<arg name="image" type="s" direction="in" />
132
<arg name="slot" type="s" direction="in" />