1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
]>
<refentry id="gdbus-org.freedesktop.ModemManager1.Modem.Firmware">
<refmeta> <refentrytitle role="top_of_page" id="gdbus-interface-org-freedesktop-ModemManager1-Modem-Firmware.top_of_page">org.freedesktop.ModemManager1.Modem.Firmware</refentrytitle>
<indexterm zone="gdbus-interface-org-freedesktop-ModemManager1-Modem-Firmware.top_of_page"><primary sortas="Modem.Firmware">org.freedesktop.ModemManager1.Modem.Firmware</primary></indexterm>
</refmeta> <refnamediv> <refname>org.freedesktop.ModemManager1.Modem.Firmware</refname> <refpurpose>The ModemManager Firmware interface.</refpurpose> </refnamediv> <refsynopsisdiv role="synopsis">
<title role="synopsis.title">Methods</title>
<synopsis>
<link linkend="gdbus-method-org-freedesktop-ModemManager1-Modem-Firmware.List">List</link> (OUT s selected,
OUT aa{sv} installed);
<link linkend="gdbus-method-org-freedesktop-ModemManager1-Modem-Firmware.Select">Select</link> (IN s uniqueid);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc" id="gdbus-interface-org-freedesktop-ModemManager1-Modem-Firmware">
<title role="desc.title">Description</title>
<para> This interface allows clients to select or install firmware images on
modems.
</para><para> Firmware slots and firmware images are identified by arbitrary opaque
strings.
</para><para> Firmware images are represented as dictionaries of properties.
Certain properties are pre-defined, and some are required:
</para><para> <variablelist>
<varlistentry><term><literal>"image-type"</literal></term>
<listitem>
(Required) Type of the firmware image, given as a
<link linkend="MMFirmwareImageType">MMFirmwareImageType</link> value
(signature <literal>"u"</literal>). Firmware images of type
<link linkend="MM-FIRMWARE-IMAGE-TYPE-GENERIC:CAPS">MM_FIRMWARE_IMAGE_TYPE_GENERIC</link>
will only expose only the mandatory properties.
</listitem>
</varlistentry>
<varlistentry><term><literal>"unique-id"</literal></term>
<listitem>
(Required) A user-readable unique ID for the firmware image, given as a
string value (signature <literal>"s"</literal>).
</listitem>
</varlistentry>
<varlistentry><term><literal>"gobi-pri-version"</literal></term>
<listitem>
(Optional) The version of the PRI firmware image, in images of type
<link linkend="MM-FIRMWARE-IMAGE-TYPE-GOBI:CAPS">MM_FIRMWARE_IMAGE_TYPE_GOBI</link>,
given as a string value (signature <literal>"s"</literal>).
</listitem>
</varlistentry>
<varlistentry><term><literal>"gobi-pri-info"</literal></term>
<listitem>
(Optional) Additional information of the PRI image, in images of type
<link linkend="MM-FIRMWARE-IMAGE-TYPE-GOBI:CAPS">MM_FIRMWARE_IMAGE_TYPE_GOBI</link>,
given as a string value (signature <literal>"s"</literal>).
</listitem>
</varlistentry>
<varlistentry><term><literal>"gobi-boot-version"</literal></term>
<listitem>
(Optional) The boot version of the PRI firmware image, in images of type
<link linkend="MM-FIRMWARE-IMAGE-TYPE-GOBI:CAPS">MM_FIRMWARE_IMAGE_TYPE_GOBI</link>,
given as a string value (signature <literal>"s"</literal>).
</listitem>
</varlistentry>
<varlistentry><term><literal>"gobi-pri-unique-id"</literal></term>
<listitem>
(Optional) The unique ID of the PRI firmware image, in images of type
<link linkend="MM-FIRMWARE-IMAGE-TYPE-GOBI:CAPS">MM_FIRMWARE_IMAGE_TYPE_GOBI</link>,
given as a string value (signature <literal>"s"</literal>).
</listitem>
</varlistentry>
<varlistentry><term><literal>"gobi-modem-unique-id"</literal></term>
<listitem>
(Optional) The unique ID of the Modem firmware image, in images of type
<link linkend="MM-FIRMWARE-IMAGE-TYPE-GOBI:CAPS">MM_FIRMWARE_IMAGE_TYPE_GOBI</link>,
given as a string value (signature <literal>"s"</literal>).
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="details" id="gdbus-methods-org.freedesktop.ModemManager1.Modem.Firmware">
<title role="details.title">Method Details</title>
<refsect2 role="method" id="gdbus-method-org-freedesktop-ModemManager1-Modem-Firmware.List">
<title>The List() method</title>
<indexterm zone="gdbus-method-org-freedesktop-ModemManager1-Modem-Firmware.List"><primary sortas="Modem.Firmware.List">org.freedesktop.ModemManager1.Modem.Firmware.List()</primary></indexterm>
<programlisting>
List (OUT s selected,
OUT aa{sv} installed);
</programlisting>
<para> List installed firmware images.
</para><para> Depending on the type of modem, installed images may be stored on the
host or the modem.
</para><para> Installed images can be selected non-destructively.
</para>
<variablelist role="params">
<varlistentry>
<term><literal>OUT s <parameter>selected</parameter></literal>:</term>
<listitem><para>The unique name of the selected firmware image, or the empty string if no image is selected.</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>OUT aa{sv} <parameter>installed</parameter></literal>:</term>
<listitem><para>An array of dictionaries containing the properties of the installed firmware images.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 role="method" id="gdbus-method-org-freedesktop-ModemManager1-Modem-Firmware.Select">
<title>The Select() method</title>
<indexterm zone="gdbus-method-org-freedesktop-ModemManager1-Modem-Firmware.Select"><primary sortas="Modem.Firmware.Select">org.freedesktop.ModemManager1.Modem.Firmware.Select()</primary></indexterm>
<programlisting>
Select (IN s uniqueid);
</programlisting>
<para> Selects a different firmware image to use, and immediately resets the
modem so that it begins using the new firmware image.
</para><para> The method will fail if the identifier does not match any of the names
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.
</para>
<variablelist role="params">
<varlistentry>
<term><literal>IN s <parameter>uniqueid</parameter></literal>:</term>
<listitem><para>The unique ID of the firmware image to select.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
</refentry>
|
