Dan Williams
7c70ad55bb
Main changes are cleaning up the API and allowing for multi-mode devices that support two or more of CDMA/EVDO, GSM/UMTS, and LTE at the same time. This provides a starting discussion point for the new MM 0.6 API.
185 lines
6.9 KiB
XML
185 lines
6.9 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
|
|
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
|
|
<interface name="org.freedesktop.ModemManager1.Modem.Cdma">
|
|
|
|
<!-- METHODS -->
|
|
|
|
<method name="Activate">
|
|
<tp:docstring>
|
|
Provisions the modem for use with a given carrier using the modem's
|
|
Over-The-Air (OTA) activation functionality, if any. In the event of
|
|
immediate failure, returns an error value instead of setting a DBus error.
|
|
</tp:docstring>
|
|
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
|
|
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_cdma_activate"/>
|
|
<arg name="carrier" type="s" direction="in">
|
|
<tp:docstring>
|
|
Name of carrier.
|
|
</tp:docstring>
|
|
</arg>
|
|
<arg name="immediate_error" type="u" direction="out">
|
|
<tp:docstring>
|
|
An enum from MM_MODEM_CDMA_ACTIVATION_ERROR. This is
|
|
returned for immediate errors. Delayed errors are returned
|
|
via an ActivationStateChanged signal
|
|
</tp:docstring>
|
|
</arg>
|
|
</method>
|
|
|
|
<method name="ActivateManual">
|
|
<tp:docstring>
|
|
Sets the modem provisioning data directly, without contacting the
|
|
carrier over the air. Some modems will reboot after this call is made.
|
|
</tp:docstring>
|
|
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
|
|
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_cdma_activate_manual"/>
|
|
<arg name="properties" type="a{sv}" direction="in">
|
|
<tp:docstring>
|
|
A dictionary of properties to set on the modem. Keys include 'mdn', 'min'
|
|
</tp:docstring>
|
|
</arg>
|
|
</method>
|
|
|
|
<!-- SIGNALS -->
|
|
|
|
<signal name="ActivationStateChanged">
|
|
<tp:docstring>
|
|
The device activation state changed.
|
|
</tp:docstring>
|
|
<arg name="activation_state" type="u" tp:type="MM_MODEM_CDMA_ACTIVATION_STATE">
|
|
<tp:docstring>Current activation state</tp:docstring>
|
|
</arg>
|
|
<arg name="activation_error" type="u" tp:type="MM_MODEM_CDMA_ACTIVATION_ERROR">
|
|
<tp:docstring>Carrier-specific error code</tp:docstring>
|
|
</arg>
|
|
<arg name="status_changes" type="a{sv}">
|
|
<tp:docstring>
|
|
Selected Modem.Simple.GetStatus keys that have changed as a result of
|
|
this activation state change. Will include 'mdn' and 'min'.
|
|
</tp:docstring>
|
|
</arg>
|
|
</signal>
|
|
|
|
<!-- PROPERTIES -->
|
|
|
|
<property name="Meid" type="s" access="read">
|
|
<tp:docstring>
|
|
The modem's Mobile Equipment Identifier.
|
|
</tp:docstring>
|
|
</property>
|
|
|
|
<property name="Esn" type="s" access="read">
|
|
<tp:docstring>
|
|
The modem's Electronic Serial Number (superceded by the MEID but still
|
|
used by older devices).
|
|
</tp:docstring>
|
|
</property>
|
|
|
|
<property name="Sid" type="u" access="read">
|
|
<tp:docstring>
|
|
The System Identifier of the serving CDMA 1x network, if known, and
|
|
if the modem is registered with a CDMA 1x network. See ifast.org or
|
|
the mobile broadband provider database for mappings of SIDs to network
|
|
providers.
|
|
</tp:docstring>
|
|
</property>
|
|
|
|
<property name="Nid" type="u" access="read">
|
|
<tp:docstring>
|
|
The Network Identifier of the serving CDMA 1x network, if known, and
|
|
if the modem is registered with a CDMA 1x network.
|
|
</tp:docstring>
|
|
</property>
|
|
|
|
<property name="Cdma1xRegState" type="u" access="read" tp:type="MM_MODEM_CDMA_REGISTRATION_STATE">
|
|
<tp:docstring>CDMA 1x registration state.</tp:docstring>
|
|
</property>
|
|
|
|
<property name="EvdoRegState" type="u" access="read" tp:type="MM_MODEM_CDMA_REGISTRATION_STATE">
|
|
<tp:docstring>EVDO registration state.</tp:docstring>
|
|
</property>
|
|
|
|
<!-- ENUMS -->
|
|
|
|
<tp:enum name="MM_MODEM_CDMA_REGISTRATION_STATE" type="u">
|
|
<tp:enumvalue suffix="UNKNOWN" value="0">
|
|
<tp:docstring>Registration status is unknown or the device is not registered.</tp:docstring>
|
|
</tp:enumvalue>
|
|
<tp:enumvalue suffix="REGISTERED" value="1">
|
|
<tp:docstring>Registered, but roaming status is unknown or cannot be provided by the device. The device may or may not be roaming.</tp:docstring>
|
|
</tp:enumvalue>
|
|
<tp:enumvalue suffix="HOME" value="2">
|
|
<tp:docstring>Currently registered on the home network.</tp:docstring>
|
|
</tp:enumvalue>
|
|
<tp:enumvalue suffix="ROAMING" value="3">
|
|
<tp:docstring>Currently registered on a roaming network.</tp:docstring>
|
|
</tp:enumvalue>
|
|
</tp:enum>
|
|
|
|
<tp:enum name="MM_MODEM_CDMA_ACTIVATION_STATE" type="u">
|
|
<tp:enumvalue suffix="NOT_ACTIVATED" value="0">
|
|
<tp:docstring>Device is not activated</tp:docstring>
|
|
</tp:enumvalue>
|
|
<tp:enumvalue suffix="ACTIVATING" value="1">
|
|
<tp:docstring>Device is activating</tp:docstring>
|
|
</tp:enumvalue>
|
|
<tp:enumvalue suffix="PARTIALLY_ACTIVATED" value="2">
|
|
<tp:docstring>Device is partially activated; carrier-specific steps required to continue.</tp:docstring>
|
|
</tp:enumvalue>
|
|
<tp:enumvalue suffix="ACTIVATED" value="3">
|
|
<tp:docstring>Device is ready for use.</tp:docstring>
|
|
</tp:enumvalue>
|
|
</tp:enum>
|
|
|
|
<tp:enum name="MM_MODEM_CDMA_ACTIVATION_ERROR" type="u">
|
|
<tp:enumvalue suffix="NO_ERROR" value="0"/>
|
|
<tp:enumvalue suffix="ROAMING" value="1">
|
|
<tp:docstring>
|
|
Device cannot activate while roaming.
|
|
</tp:docstring>
|
|
</tp:enumvalue>
|
|
<tp:enumvalue suffix="WRONG_RADIO_INTERFACE" value="2">
|
|
<tp:docstring>
|
|
Device cannot activate on this network type (eg EVDO vs 1xRTT).
|
|
</tp:docstring>
|
|
</tp:enumvalue>
|
|
<tp:enumvalue suffix="COULD_NOT_CONNECT" value="3">
|
|
<tp:docstring>
|
|
Device could not connect to the network for activation.
|
|
</tp:docstring>
|
|
</tp:enumvalue>
|
|
<tp:enumvalue suffix="SECURITY_AUTHENTICATION_FAILED" value="4">
|
|
<tp:docstring>
|
|
Device could not authenticate to the network for activation.
|
|
</tp:docstring>
|
|
</tp:enumvalue>
|
|
<tp:enumvalue suffix="PROVISIONING_FAILED" value="5">
|
|
<tp:docstring>
|
|
Later stages of device provisioning failed.
|
|
</tp:docstring>
|
|
</tp:enumvalue>
|
|
<tp:enumvalue suffix="NO_SIGNAL" value="6">
|
|
<tp:docstring>
|
|
No signal available.
|
|
</tp:docstring>
|
|
</tp:enumvalue>
|
|
<tp:enumvalue suffix="UNKNOWN" value="7">
|
|
<tp:docstring>
|
|
An error occurred.
|
|
</tp:docstring>
|
|
</tp:enumvalue>
|
|
<tp:enumvalue suffix="TIMED_OUT" value="8">
|
|
<tp:docstring>
|
|
Activation timed out.
|
|
</tp:docstring>
|
|
</tp:enumvalue>
|
|
<tp:enumvalue suffix="START_FAILED" value="9">
|
|
<tp:docstring>
|
|
API call for initial activation failed.
|
|
</tp:docstring>
|
|
</tp:enumvalue>
|
|
</tp:enum>
|
|
</interface>
|
|
</node>
|