Warning, /frameworks/modemmanager-qt/src/dbus/introspection/org.freedesktop.ModemManager1.Modem.Firmware.xml is written in an unsupported language. File is not indexed.
0001 <?xml version="1.0" encoding="UTF-8" ?>
0002
0003 <!--
0004 ModemManager 1.0 Interface Specification
0005
0006 Copyright (C) 2011-2013 Red Hat, Inc.
0007 Copyright (C) 2011-2013 Google, Inc.
0008 Copyright (C) 2011-2013 Lanedo GmbH
0009 -->
0010
0011 <node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
0012
0013 <!--
0014 org.freedesktop.ModemManager1.Modem.Firmware:
0015 @short_description: The ModemManager Firmware interface.
0016
0017 This interface allows clients to select or install firmware images on
0018 modems.
0019
0020 Firmware slots and firmware images are identified by arbitrary opaque
0021 strings.
0022
0023 Firmware images are represented as dictionaries of properties.
0024 Certain properties are pre-defined, and some are required:
0025
0026 <variablelist>
0027 <varlistentry><term><literal>"image-type"</literal></term>
0028 <listitem>
0029 (Required) Type of the firmware image, given as a
0030 <link linkend="MMFirmwareImageType">MMFirmwareImageType</link> value
0031 (signature <literal>"u"</literal>). Firmware images of type
0032 <link linkend="MM-FIRMWARE-IMAGE-TYPE-GENERIC:CAPS">MM_FIRMWARE_IMAGE_TYPE_GENERIC</link>
0033 will only expose only the mandatory properties.
0034 </listitem>
0035 </varlistentry>
0036 <varlistentry><term><literal>"unique-id"</literal></term>
0037 <listitem>
0038 (Required) A user-readable unique ID for the firmware image, given as a
0039 string value (signature <literal>"s"</literal>).
0040 </listitem>
0041 </varlistentry>
0042 <varlistentry><term><literal>"gobi-pri-version"</literal></term>
0043 <listitem>
0044 (Optional) The version of the PRI firmware image, in images of type
0045 <link linkend="MM-FIRMWARE-IMAGE-TYPE-GOBI:CAPS">MM_FIRMWARE_IMAGE_TYPE_GOBI</link>,
0046 given as a string value (signature <literal>"s"</literal>).
0047 </listitem>
0048 </varlistentry>
0049 <varlistentry><term><literal>"gobi-pri-info"</literal></term>
0050 <listitem>
0051 (Optional) Additional information of the PRI image, in images of type
0052 <link linkend="MM-FIRMWARE-IMAGE-TYPE-GOBI:CAPS">MM_FIRMWARE_IMAGE_TYPE_GOBI</link>,
0053 given as a string value (signature <literal>"s"</literal>).
0054 </listitem>
0055 </varlistentry>
0056 <varlistentry><term><literal>"gobi-boot-version"</literal></term>
0057 <listitem>
0058 (Optional) The boot version of the PRI firmware image, in images of type
0059 <link linkend="MM-FIRMWARE-IMAGE-TYPE-GOBI:CAPS">MM_FIRMWARE_IMAGE_TYPE_GOBI</link>,
0060 given as a string value (signature <literal>"s"</literal>).
0061 </listitem>
0062 </varlistentry>
0063 <varlistentry><term><literal>"gobi-pri-unique-id"</literal></term>
0064 <listitem>
0065 (Optional) The unique ID of the PRI firmware image, in images of type
0066 <link linkend="MM-FIRMWARE-IMAGE-TYPE-GOBI:CAPS">MM_FIRMWARE_IMAGE_TYPE_GOBI</link>,
0067 given as a string value (signature <literal>"s"</literal>).
0068 </listitem>
0069 </varlistentry>
0070 <varlistentry><term><literal>"gobi-modem-unique-id"</literal></term>
0071 <listitem>
0072 (Optional) The unique ID of the Modem firmware image, in images of type
0073 <link linkend="MM-FIRMWARE-IMAGE-TYPE-GOBI:CAPS">MM_FIRMWARE_IMAGE_TYPE_GOBI</link>,
0074 given as a string value (signature <literal>"s"</literal>).
0075 </listitem>
0076 </varlistentry>
0077 </variablelist>
0078 -->
0079 <interface name="org.freedesktop.ModemManager1.Modem.Firmware">
0080
0081 <!--
0082 List:
0083 @selected: The unique name of the selected firmware image, or the empty string if no image is selected.
0084 @installed: An array of dictionaries containing the properties of the installed firmware images.
0085
0086 List installed firmware images.
0087
0088 Depending on the type of modem, installed images may be stored on the
0089 host or the modem.
0090
0091 Installed images can be selected non-destructively.
0092 -->
0093 <method name="List">
0094 <arg name="selected" type="s" direction="out" />
0095 <arg name="installed" type="aa{sv}" direction="out" />
0096 <annotation name="org.qtproject.QtDBus.QtTypeName.Out1" value="QVariantMapList"/>
0097 </method>
0098
0099 <!--
0100 Select:
0101 @uniqueid: The unique ID of the firmware image to select.
0102
0103 Selects a different firmware image to use, and immediately resets the
0104 modem so that it begins using the new firmware image.
0105
0106 The method will fail if the identifier does not match any of the names
0107 returned by
0108 <link linkend="gdbus-method-org-freedesktop-ModemManager1-Modem-Firmware.List">List()</link>,
0109 or if the image could not be selected for some reason.
0110 -->
0111 <method name="Select">
0112 <arg name="uniqueid" type="s" direction="in" />
0113 </method>
0114
0115 <!--
0116 Install:
0117 @image: The identifier of the firmware image to install.
0118 @slot: The identifier of the slot into which the firmware should be installed.
0119
0120 Install an available firmware image into a slot.
0121
0122 It does not guarantee that the image will be installed into the
0123 specified slot, but does guarantee that, if the slot is empty, no
0124 image will be overwritten, and if the slot is not empty, no image
0125 other than the one in that slot will be overwritten.
0126
0127 The method will fail if either of the identifiers is invalid, or if the
0128 image could not be installed into the slot for some reason.
0129
0130 <method name="Install">
0131 <arg name="image" type="s" direction="in" />
0132 <arg name="slot" type="s" direction="in" />
0133 </method-->
0134
0135 </interface>
0136 </node>