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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
|
<?xml version="1.0" encoding="UTF-8" ?>
<!--
ModemManager 1.0 Interface Specification
Copyright (C) 2008 Novell, Inc.
Copyright (C) 2008-2013 Red Hat, Inc.
Copyright (C) 2011-2013 Google, Inc.
Copyright (C) 2011-2013 Lanedo GmbH
-->
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
<!--
org.freedesktop.ModemManager1.Modem.Modem3gpp:
@short_description: The ModemManager 3GPP interface.
This interface provides access to specific actions that may be performed
in modems with 3GPP capabilities.
This interface will only be available once the modem is ready to be
registered in the cellular network. 3GPP devices will require a valid
unlocked SIM card before any of the features in the interface can be
used.
-->
<interface name="org.freedesktop.ModemManager1.Modem.Modem3gpp">
<!--
Register:
@operator_id: The operator ID (ie, <literal>"MCCMNC"</literal>, like <literal>"310260"</literal>) to register. An empty string can be used to register to the home network.
Request registration with a given mobile network.
Since: 1.0
-->
<method name="Register">
<arg name="operator_id" type="s" direction="in" />
</method>
<!--
Scan:
@results: Array of dictionaries with the found networks.
Scan for available networks.
@results is an array of dictionaries with each array element describing
a mobile network found in the scan. Each dictionary may include one or
more of the following keys:
<variablelist>
<varlistentry><term><literal>"status"</literal></term>
<listitem>
A <link linkend="MMModem3gppNetworkAvailability">MMModem3gppNetworkAvailability</link>
value representing network availability status, given as an
unsigned integer (signature <literal>"u"</literal>). This key will
always be present.
</listitem>
</varlistentry>
<varlistentry><term><literal>"operator-long"</literal></term>
<listitem>
Long-format name of operator, given as a string value (signature
<literal>"s"</literal>). If the name is unknown, this field
should not be present.
</listitem>
</varlistentry>
<varlistentry><term><literal>"operator-short"</literal></term>
<listitem>
Short-format name of operator, given as a string value (signature
<literal>"s"</literal>). If the name is unknown, this field
should not be present.
</listitem>
</varlistentry>
<varlistentry><term><literal>"operator-code"</literal></term>
<listitem>
Mobile code of the operator, given as a string value (signature
<literal>"s"</literal>). Returned in the format
<literal>"MCCMNC"</literal>, where <literal>MCC</literal> is the
three-digit ITU E.212 Mobile Country Code and <literal>MNC</literal>
is the two- or three-digit GSM Mobile Network Code. e.g.
<literal>"31026"</literal> or <literal>"310260"</literal>.
</listitem>
</varlistentry>
<varlistentry><term><literal>"access-technology"</literal></term>
<listitem>
A <link linkend="MMModemAccessTechnology">MMModemAccessTechnology</link> value
representing the generic access technology used by this mobile network,
given as an unsigned integer (signature <literal>"u"</literal>).
</listitem>
</varlistentry>
</variablelist>
Since: 1.0
-->
<method name="Scan">
<arg name="results" type="aa{sv}" direction="out" />
</method>
<!--
SetEpsUeModeOperation:
@mode: a <link linkend="MMModem3gppEpsUeModeOperation">MMModem3gppEpsUeModeOperation</link>.
Sets the UE mode of operation for EPS.
Since: 1.10
-->
<method name="SetEpsUeModeOperation">
<arg name="mode" type="u" direction="in" />
</method>
<!--
SetInitialEpsBearerSettings:
@settings: List of properties to use when requesting the LTE attach procedure.
Updates the default settings to be used in the initial default EPS bearer when registering to the LTE network.
The allowed properties in this method are all the 3GPP-specific ones specified
in the <link linkend="gdbus-property-org-freedesktop-ModemManager1-Bearer.Properties">bearer properties</link>;
i.e.: <literal>"apn"</literal>, <literal>"ip-type"</literal>,
<literal>"allowed-auth"</literal>, <literal>"user"</literal>, and
<literal>"password"</literal>.
Since: 1.10
-->
<method name="SetInitialEpsBearerSettings">
<arg name="settings" type="a{sv}" direction="in" />
</method>
<!--
SetNr5gRegistrationSettings:
@properties: List of 5G specific registration settings.
Updates the 5G specific registration settings configured in the device.
The allowed properties in this method are all the ones specified in the
<link linkend="gdbus-property-org-freedesktop-ModemManager1-Modem-Modem3gpp.Nr5gRegistrationSettings">Nr5gRegistrationSettings</link>;
i.e.: <literal>"mico-mode"</literal> and <literal>"drx-cycle"</literal>.
Since: 1.20
-->
<method name="SetNr5gRegistrationSettings">
<arg name="properties" type="a{sv}" direction="in" />
</method>
<!--
Imei:
The <ulink url="http://en.wikipedia.org/wiki/Imei">IMEI</ulink> of the device.
Since: 1.0
-->
<property name="Imei" type="s" access="read" />
<!--
RegistrationState:
A <link linkend="MMModem3gppRegistrationState">MMModem3gppRegistrationState</link>
value specifying the mobile registration status as defined in 3GPP TS 27.007
section 10.1.19.
Since: 1.0
-->
<property name="RegistrationState" type="u" access="read" />
<!--
NetworkRejection:
This property holds the latest network rejection information received from the
network during registration failure, and it will be cleared whenever the modem
successfully registers.
Network errors are defined in 3GPP TS 24.008 in sections 10.5.3.6 and
10.5.5.14 (detailed in annex G) and in 3GPP TS 24.301 in section 9.9.3.9.
Mandatory items include:
<variablelist>
<varlistentry><term><literal>"error"</literal></term>
<listitem>
A <link linkend="MMNetworkError">MMNetworkError</link>,
specifying the reason why a request from the mobile station
is rejected by the network, given as an unsigned integer value
(signature <literal>"u"</literal>).
</listitem>
</varlistentry>
</variablelist>
Optionally following items could be included if reported by modem along
with network error.
<variablelist>
<varlistentry><term><literal>"operator-id"</literal></term>
<listitem>
Operator id reported along with network error, given as a string value (signature <literal>"s"</literal>).
</listitem>
</varlistentry>
<varlistentry><term><literal>"operator-name"</literal></term>
<listitem>
Operator name reported along with network error, given as a string value (signature <literal>"s"</literal>).
</listitem>
</varlistentry>
<varlistentry><term><literal>"access-technology"</literal></term>
<listitem>
A <link linkend="MMModemAccessTechnology">MMModemAccessTechnology</link>,
specifying the available data class reported along with network error,
given as an unsigned integer value (signature <literal>"u"</literal>).
</listitem>
</varlistentry>
</variablelist>
Since: 1.24
-->
<property name="NetworkRejection" type="a{sv}" access="read" />
<!--
OperatorCode:
Code of the operator to which the mobile is currently registered.
Returned in the format <literal>"MCCMNC"</literal>, where
<literal>MCC</literal> is the three-digit ITU E.212 Mobile Country Code
and <literal>MNC</literal> is the two- or three-digit GSM Mobile Network
Code. e.g. e<literal>"31026"</literal> or <literal>"310260"</literal>.
If the <literal>MCC</literal> and <literal>MNC</literal> are not known
or the mobile is not registered to a mobile network, this property will
be a zero-length (blank) string.
Since: 1.0
-->
<property name="OperatorCode" type="s" access="read" />
<!--
OperatorName:
Name of the operator to which the mobile is currently registered.
If the operator name is not known or the mobile is not
registered to a mobile network, this property will be a zero-length
(blank) string.
Since: 1.0
-->
<property name="OperatorName" type="s" access="read" />
<!--
EnabledFacilityLocks:
Bitmask of <link linkend="MMModem3gppFacility">MMModem3gppFacility</link> values
for which PIN locking is enabled.
Since: 1.0
-->
<property name="EnabledFacilityLocks" type="u" access="read" />
<!--
DisableFacilityLock:
@properties: A tuple of facility type and control key.
Sends control key to modem to disable selected facility lock
<variablelist>
<varlistentry><term>"facility"</term>
<listitem>
<para>
A <link linkend="MMModem3gppFacility">MMModem3gppFacility</link> value
representing the type of the facility lock to disable.
</para>
</listitem>
</varlistentry>
<varlistentry><term>"control key"</term>
<listitem>
<para>
Alphanumeric key required to unlock facility.
</para>
</listitem>
</varlistentry>
</variablelist>
-->
<method name="DisableFacilityLock">
<arg name="properties" type="(us)" direction="in" />
</method>
<!--
SetCarrierLock:
@data: The list of carrier network information to be sent to be configured.
Command to send the list of carrier network information to the modem.
Since: 1.22
-->
<method name="SetCarrierLock">
<arg name="data" type="ay" direction="in">
<annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
</arg>
</method>
<!--
SetPacketServiceState:
@state: a <link linkend="MMModem3gppPacketServiceState">MMModem3gppPacketServiceState</link>.
Explicitly attach or detach packet service on the current registered network.
Since: 1.20
-->
<method name="SetPacketServiceState">
<arg name="state" type="u" direction="in" />
</method>
<!--
SubscriptionState:
A <link linkend="MMModem3gppSubscriptionState">MMModem3gppSubscriptionState</link>
value representing the subscription status of the account and whether there
is any data remaining, given as an unsigned integer (signature <literal>"u"</literal>).
Since: 1.2
Deprecated: 1.10.0. The value of this property can only be obtained with operator
specific logic (e.g. processing specific PCO info), and therefore it doesn't make sense
to expose it in the ModemManager interface.
-->
<property name="SubscriptionState" type="u" access="read" />
<!--
EpsUeModeOperation:
A <link linkend="MMModem3gppEpsUeModeOperation">MMModem3gppEpsUeModeOperation</link>
value representing the UE mode of operation for EPS, given as an unsigned integer
(signature <literal>"u"</literal>).
Since: 1.10
-->
<property name="EpsUeModeOperation" type="u" access="read" />
<!--
Pco:
The raw PCOs received from the network, given as array of PCO
elements (signature <literal>"a(ubay)"</literal>).
Each PCO is defined as a sequence of 3 fields:
<orderedlist>
<listitem>
The session ID associated with the PCO, given as an
unsigned integer value (signature <literal>"u"</literal>).
</listitem>
<listitem>
The flag that indicates whether the PCO data contains the
complete PCO structure received from the network, given as
a boolean value (signature <literal>"b"</literal>).
</listitem>
<listitem>
The raw PCO data, given as an array of bytes (signature
<literal>"ay"</literal>).
</listitem>
</orderedlist>
Since: 1.10
-->
<property name="Pco" type="a(ubay)" access="read" />
<!--
InitialEpsBearer:
The object path for the initial default EPS bearer.
Since: 1.10
-->
<property name="InitialEpsBearer" type="o" access="read" />
<!--
InitialEpsBearerSettings:
List of properties requested by the device for the initial EPS bearer during
LTE network attach procedure.
The network may decide to use different settings during the actual device attach
procedure, e.g. if the device is roaming or no explicit settings were requested,
so the values shown in the
#org.freedesktop.ModemManager1.Modem.Modem3gpp:InitialEpsBearer
bearer object may be totally different.
This is a read-only property, updating these settings should be done using the
<link linkend="gdbus-method-org-freedesktop-ModemManager1-Modem-Modem3gpp.SetInitialEpsBearerSettings">SetInitialEpsBearerSettings()</link>
method.
Since: 1.10
-->
<property name="InitialEpsBearerSettings" type="a{sv}" access="read" />
<!--
PacketServiceState:
A <link linkend="MMModem3gppPacketServiceState">MMModem3gppPacketServiceState</link>
value specifying the packet domain service state.
Since: 1.20
-->
<property name="PacketServiceState" type="u" access="read" />
<!--
Nr5gRegistrationSettings:
5G specific registration settings.
This is a read-only property, updating these settings should be done using the
<link linkend="gdbus-method-org-freedesktop-ModemManager1-Modem-Modem3gpp.SetNr5gRegistrationSettings">Set5gNrRegistrationSettings()</link>
method.
<variablelist>
<varlistentry><term>"mico-mode"</term>
<listitem>
<para>
A <link linkend="MMModem3gppMicoMode">MMModem3gppMicoMode</link> value
representing the Mobile Initiated Connection (MICO) mode requested by the host,
given as an unsigned integer (signature <literal>"u"</literal>).
</para>
</listitem>
</varlistentry>
<varlistentry><term>"drx-cycle"</term>
<listitem>
<para>
A <link linkend="MMModem3gppDrxCycle">MMModem3gppDrxCycle</link> value,
representing the DRX settings requested by the host, given as an
unsigned integer (signature <literal>"u"</literal>).
</para>
</listitem>
</varlistentry>
</variablelist>
Since: 1.20
-->
<property name="Nr5gRegistrationSettings" type="a{sv}" access="read" />
</interface>
</node>
|
