add initial prototype with a few commands
[project/uqmi.git] / data / qmi-service-wms.json
1
2 [
3   // *********************************************************************************
4   {  "name"    : "WMS",
5      "type"    : "Service" },
6
7   // *********************************************************************************
8   {  "name"    : "QMI Client WMS",
9      "type"    : "Client" },
10
11   // *********************************************************************************
12   {  "name"    : "QMI Message WMS",
13      "type"    : "Message-ID-Enum" },
14
15   // *********************************************************************************
16   {  "name"    : "QMI Indication WMS",
17      "type"    : "Indication-ID-Enum" },
18
19   // *********************************************************************************
20   {  "name"    : "Reset",
21      "type"    : "Message",
22      "service" : "WMS",
23      "id"      : "0x0000",
24      "version" : "1.0",
25      "output"  : [ { "common-ref" : "Operation Result" } ] },
26
27   // *********************************************************************************
28   {  "name"    : "Set Event Report",
29      "type"    : "Message",
30      "service" : "WMS",
31      "id"      : "0x0001",
32      "version" : "1.0",
33      "input"   : [ { "name"      : "New MT Message Indicator",
34                      "id"        : "0x10",
35                      "mandatory" : "no",
36                      "type"      : "TLV",
37                      "format"    : "sequence",
38                      "contents"  : [ { "name"          : "Report",
39                                        "format"        : "guint8",
40                                        "public-format" : "gboolean" } ] } ],
41      "output"  : [ { "common-ref" : "Operation Result" } ] },
42
43   {  "name"    : "Event Report",
44      "type"    : "Indication",
45      "service" : "WMS",
46      "id"      : "0x0001",
47      "output"  : [ { "name"      : "MT Message",
48                      "id"        : "0x10",
49                      "mandatory" : "no",
50                      "type"      : "TLV",
51                      "format"    : "sequence",
52                      "contents"  : [ { "name"          : "Storage Type",
53                                        "format"        : "guint8",
54                                        "public-format" : "QmiWmsStorageType" },
55                                      { "name"   : "Memory Index",
56                                        "format" : "guint32" } ] },
57                    { "name"      : "Transfer Route MT Message",
58                      "id"        : "0x11",
59                      "mandatory" : "no",
60                      "type"      : "TLV",
61                      "format"    : "sequence",
62                      "contents"  : [ { "name"          : "Ack Indicator",
63                                        "format"        : "guint8",
64                                        "public-format" : "QmiWmsAckIndicator" },
65                                      { "name"   : "Transaction ID",
66                                        "format" : "guint32" },
67                                      { "name"          : "Format",
68                                        "format"        : "guint8",
69                                        "public-format" : "QmiWmsMessageFormat" },
70                                      { "name"               : "Raw Data",
71                                        "format"             : "array",
72                                        "size-prefix-format" : "guint16",
73                                        "array-element"      : { "format" : "guint8" } } ] },
74                    { "name"          : "Message Mode",
75                      "id"            : "0x12",
76                      "mandatory"     : "no",
77                      "type"          : "TLV",
78                      "format"        : "guint8",
79                      "public-format" : "QmiWmsMessageMode" },
80                    { "name"      : "ETWS Message",
81                      "id"        : "0x13",
82                      "mandatory" : "no",
83                      "type"      : "TLV",
84                      "format"    : "sequence",
85                      "contents"  : [ { "name"          : "Notification Type",
86                                        "format"        : "guint8",
87                                        "public-format" : "QmiWmsNotificationType" },
88                                      { "name"               : "Raw Data",
89                                        "format"             : "array",
90                                        "size-prefix-format" : "guint16",
91                                        "array-element"      : { "format" : "guint8" } } ] },
92                    { "name"      : "ETWS PLMN Information",
93                      "id"        : "0x14",
94                      "mandatory" : "no",
95                      "type"      : "TLV",
96                      "format"    : "sequence",
97                      "contents"  : [ { "name"   : "MCC",
98                                        "format" : "guint16" },
99                                      { "name"   : "MNC",
100                                        "format" : "guint16" } ] },
101                    { "name"          : "SMSC Address",
102                      "id"            : "0x15",
103                      "mandatory"     : "no",
104                      "type"          : "TLV",
105                      "format"        : "string" },
106                    { "name"          : "SMS on IMS",
107                      "id"            : "0x16",
108                      "mandatory"     : "no",
109                      "type"          : "TLV",
110                      "format"        : "guint8",
111                      "public-format" : "gboolean" } ] },
112
113   // *********************************************************************************
114   {  "name"    : "Raw Send",
115      "type"    : "Message",
116      "service" : "WMS",
117      "id"      : "0x0020",
118      "version" : "1.0",
119      "input"   : [ { "name"      : "Raw Message Data",
120                      "id"        : "0x01",
121                      "mandatory" : "yes",
122                      "type"      : "TLV",
123                      "format"    : "sequence",
124                      "contents"  : [ { "name"          : "Format",
125                                        "format"        : "guint8",
126                                        "public-format" : "QmiWmsMessageFormat" },
127                                      { "name"               : "Raw Data",
128                                        "format"             : "array",
129                                        "size-prefix-format" : "guint16",
130                                        "array-element"      : { "format" : "guint8" } } ] },
131                    { "name"      : "CDMA Force On DC",
132                      "id"        : "0x10",
133                      "mandatory" : "no",
134                      "type"      : "TLV",
135                      "format"    : "sequence",
136                      "contents"  : [ { "name"          : "Force",
137                                        "format"        : "guint8",
138                                        "public-format" : "gboolean" },
139                                      { "name"          : "Service Option",
140                                        "format"        : "guint8",
141                                        "public-format" : "QmiWmsCdmaServiceOption" } ] },
142                    { "name"      : "CDMA Follow On DC",
143                      "id"        : "0x11",
144                      "mandatory" : "no",
145                      "type"      : "TLV",
146                      "format"    : "sequence",
147                      "contents"  : [ { "name"          : "Follow",
148                                        "format"        : "guint8",
149                                        "public-format" : "gboolean" } ] },
150                    { "name"      : "GSM WCDMA Link Timer",
151                      "id"        : "0x12",
152                      "mandatory" : "no",
153                      "type"      : "TLV",
154                      "format"    : "guint8" },
155                    { "name"          : "SMS on IMS",
156                      "id"            : "0x13",
157                      "mandatory"     : "no",
158                      "type"          : "TLV",
159                      "format"        : "guint8",
160                      "public-format" : "gboolean" } ],
161      "output"  : [ { "common-ref" : "Operation Result" },
162                    { "name"          : "Message ID",
163                      "id"            : "0x01",
164                      // Even if we have this TLV as mandatory, it seems it really isn't
165                      "mandatory"     : "no",
166                      "type"          : "TLV",
167                      "format"        : "guint16",
168                      "prerequisites" : [ { "common-ref" : "Success" } ] },
169                    { "name"          : "CDMA Cause Code",
170                      "id"            : "0x10",
171                      "mandatory"     : "no",
172                      "type"          : "TLV",
173                      "format"        : "guint16",
174                      "public-format" : "QmiWmsCdmaCauseCode",
175                      "prerequisites" : [ { "field"     : "Result.Error Status",
176                                            "operation" : "!=",
177                                            "value"     : "QMI_STATUS_SUCCESS" },
178                                          { "field"     : "Result.Error Code",
179                                            "operation" : "==",
180                                            "value"     : "QMI_PROTOCOL_ERROR_WMS_CAUSE_CODE" } ] },
181                    { "name"          : "CDMA Error Class",
182                      "id"            : "0x11",
183                      "mandatory"     : "no",
184                      "type"          : "TLV",
185                      "format"        : "guint8",
186                      "public-format" : "QmiWmsCdmaErrorClass",
187                      "prerequisites" : [ { "field"     : "Result.Error Status",
188                                            "operation" : "!=",
189                                            "value"     : "QMI_STATUS_SUCCESS" },
190                                          { "field"     : "Result.Error Code",
191                                            "operation" : "==",
192                                            "value"     : "QMI_PROTOCOL_ERROR_WMS_CAUSE_CODE" } ] },
193                    { "name"          : "GSM WCDMA Cause Info",
194                      "id"            : "0x12",
195                      "mandatory"     : "no",
196                      "type"          : "TLV",
197                      "format"        : "sequence",
198                      "contents"      : [ { "name"          : "RP Cause",
199                                            "format"        : "guint16",
200                                            "public-format" : "QmiWmsGsmUmtsRpCause" },
201                                          { "name"          : "TP Cause",
202                                            "format"        : "guint8",
203                                            "public-format" : "QmiWmsGsmUmtsTpCause" } ],
204                      "prerequisites" : [ { "field"     : "Result.Error Status",
205                                            "operation" : "!=",
206                                            "value"     : "QMI_STATUS_SUCCESS" },
207                                          { "field"     : "Result.Error Code",
208                                            "operation" : "==",
209                                            "value"     : "QMI_PROTOCOL_ERROR_WMS_CAUSE_CODE" } ] },
210                    { "name"          : "Message Delivery Failure Type",
211                      "id"            : "0x13",
212                      "mandatory"     : "no",
213                      "type"          : "TLV",
214                      "format"        : "guint8",
215                      "public-format" : "QmiWmsMessageDeliveryFailureType",
216                      "prerequisites" : [ { "field"     : "Result.Error Status",
217                                            "operation" : "!=",
218                                            "value"     : "QMI_STATUS_SUCCESS" },
219                                          { "field"     : "Result.Error Code",
220                                            "operation" : "==",
221                                            "value"     : "QMI_PROTOCOL_ERROR_WMS_CAUSE_CODE" } ] } ] },
222
223   // *********************************************************************************
224   {  "name"    : "Raw Write",
225      "type"    : "Message",
226      "service" : "WMS",
227      "id"      : "0x0021",
228      "version" : "1.0",
229      "input"   : [ { "name"      : "Raw Message Data",
230                      "id"        : "0x01",
231                      "mandatory" : "yes",
232                      "type"      : "TLV",
233                      "format"    : "sequence",
234                      "contents"  : [ { "name"          : "Storage Type",
235                                        "format"        : "guint8",
236                                        "public-format" : "QmiWmsStorageType" },
237                                      { "name"          : "Format",
238                                        "format"        : "guint8",
239                                        "public-format" : "QmiWmsMessageFormat" },
240                                      { "name"               : "Raw Data",
241                                        "format"             : "array",
242                                        "size-prefix-format" : "guint16",
243                                        "array-element"      : { "format" : "guint8" } } ] } ],
244      "output"  : [ { "common-ref" : "Operation Result" },
245                    { "name"          : "Memory Index",
246                      "id"            : "0x01",
247                      "mandatory"     : "yes",
248                      "type"          : "TLV",
249                      "format"        : "guint32",
250                      "prerequisites" : [ { "common-ref" : "Success" } ] } ] },
251
252   // *********************************************************************************
253   {  "name"    : "Raw Read",
254      "type"    : "Message",
255      "service" : "WMS",
256      "id"      : "0x0022",
257      "version" : "1.0",
258      "input"   : [ { "name"      : "Message Memory Storage ID",
259                      "id"        : "0x01",
260                      "mandatory" : "yes",
261                      "type"      : "TLV",
262                      "format"    : "sequence",
263                      "contents"  : [ { "name"          : "Storage Type",
264                                        "format"        : "guint8",
265                                        "public-format" : "QmiWmsStorageType" },
266                                      { "name"          : "Memory Index",
267                                        "format"        : "guint32" } ] },
268                    { "name"          : "Message Mode",
269                      "id"            : "0x10",
270                      "mandatory"     : "no",
271                      "type"          : "TLV",
272                      "format"        : "guint8",
273                      "public-format" : "QmiWmsMessageMode" },
274                    { "name"          : "SMS on IMS",
275                      "id"            : "0x11",
276                      "mandatory"     : "no",
277                      "type"          : "TLV",
278                      "format"        : "guint8",
279                      "public-format" : "gboolean" } ],
280      "output"   : [ { "common-ref" : "Operation Result" },
281                     { "name"      : "Raw Message Data",
282                       "id"        : "0x01",
283                       "mandatory" : "yes",
284                       "type"      : "TLV",
285                       "format"    : "sequence",
286                       "contents"  : [ { "name"          : "Message Tag",
287                                         "format"        : "guint8",
288                                         "public-format" : "QmiWmsMessageTagType" },
289                                       { "name"          : "Format",
290                                         "format"        : "guint8",
291                                         "public-format" : "QmiWmsMessageFormat" },
292                                       { "name"               : "Raw Data",
293                                         "format"             : "array",
294                                         "size-prefix-format" : "guint16",
295                                         "array-element"      : { "format" : "guint8" } } ],
296                       "prerequisites" : [ { "common-ref" : "Success" } ] } ] },
297
298   // *********************************************************************************
299   {  "name"    : "Modify Tag",
300      "type"    : "Message",
301      "service" : "WMS",
302      "id"      : "0x0023",
303      "version" : "1.0",
304      "input"   : [ { "name"      : "Message Tag",
305                      "id"        : "0x01",
306                      "mandatory" : "yes",
307                      "type"      : "TLV",
308                      "format"    : "sequence",
309                      "contents"  : [ { "name"          : "Storage Type",
310                                        "format"        : "guint8",
311                                        "public-format" : "QmiWmsStorageType" },
312                                      { "name"          : "Memory Index",
313                                        "format"        : "guint32" },
314                                      { "name"          : "Message Tag",
315                                        "format"        : "guint8",
316                                        "public-format" : "QmiWmsMessageTagType" } ] },
317                    { "name"          : "Message Mode",
318                      "id"            : "0x10",
319                      "mandatory"     : "no",
320                      "type"          : "TLV",
321                      "format"        : "guint8",
322                      "public-format" : "QmiWmsMessageMode" } ],
323      "output"   : [ { "common-ref" : "Operation Result" } ] },
324
325   // *********************************************************************************
326   {  "name"    : "Delete",
327      "type"    : "Message",
328      "service" : "WMS",
329      "id"      : "0x0024",
330      "version" : "1.0",
331      "input"   : [ { "name"          : "Memory Storage",
332                      "id"            : "0x01",
333                      "mandatory"     : "yes",
334                      "type"          : "TLV",
335                      "format"        : "guint8",
336                      "public-format" : "QmiWmsStorageType" },
337                    { "name"      : "Memory Index",
338                      "id"        : "0x10",
339                      "mandatory" : "no",
340                      "type"      : "TLV",
341                      "format"    : "guint32" },
342                    { "name"          : "Message Tag",
343                      "id"            : "0x11",
344                      "mandatory"     : "no",
345                      "type"          : "TLV",
346                      "format"        : "guint8",
347                      "public-format" : "QmiWmsMessageTagType" },
348                    { "name"          : "Message Mode",
349                      "id"            : "0x12",
350                      "mandatory"     : "no",
351                      "type"          : "TLV",
352                      "format"        : "guint8",
353                      "public-format" : "QmiWmsMessageMode" } ],
354      "output"   : [ { "common-ref" : "Operation Result" } ] },
355
356   // *********************************************************************************
357   {  "name"    : "Get Message Protocol",
358      "type"    : "Message",
359      "service" : "WMS",
360      "id"      : "0x0030",
361      "version" : "1.0",
362      "output"   : [ { "common-ref" : "Operation Result" },
363                     { "name"          : "Message Protocol",
364                       "id"            : "0x01",
365                       "mandatory"     : "yes",
366                       "type"          : "TLV",
367                       "format"        : "guint8",
368                       "public-format" : "QmiWmsMessageProtocol",
369                       "prerequisites" : [ { "common-ref" : "Success" } ] } ] },
370
371   // *********************************************************************************
372   {  "name"    : "List Messages",
373      "type"    : "Message",
374      "service" : "WMS",
375      "id"      : "0x0031",
376      "version" : "1.0",
377      "input"   : [ { "name"          : "Storage Type",
378                      "id"            : "0x01",
379                      "mandatory"     : "yes",
380                      "type"          : "TLV",
381                      "format"        : "guint8",
382                      "public-format" : "QmiWmsStorageType" },
383                    { "name"          : "Message Tag",
384                      "id"            : "0x11",
385                      "mandatory"     : "no",
386                      "type"          : "TLV",
387                      "format"        : "guint8",
388                      "public-format" : "QmiWmsMessageTagType" },
389                    { "name"          : "Message Mode",
390                      "id"            : "0x12",
391                      "mandatory"     : "no",
392                      "type"          : "TLV",
393                      "format"        : "guint8",
394                      "public-format" : "QmiWmsMessageMode" } ],
395      "output"   : [ { "common-ref" : "Operation Result" },
396                     { "name"               : "Message List",
397                       "id"                 : "0x01",
398                       "mandatory"          : "yes",
399                       "type"               : "TLV",
400                       "format"             : "array",
401                       "size-prefix-format" : "guint32" ,
402                       "array-element"      : { "name"     : "Element",
403                                                "format"   : "struct",
404                                                "contents" : [ { "name"   : "Memory Index",
405                                                                 "format" : "guint32" },
406                                                               { "name"          : "Message Tag",
407                                                                 "format"        : "guint8",
408                                                                 "public-format" : "QmiWmsMessageTagType" } ] },
409                       "prerequisites"      : [ { "common-ref" : "Success" } ] } ] },
410
411   // *********************************************************************************
412   {  "name"    : "Set Routes",
413      "type"    : "Message",
414      "service" : "WMS",
415      "id"      : "0x0032",
416      "version" : "1.0",
417      "input"   : [ { "name"               : "Route List",
418                      "id"                 : "0x01",
419                      "mandatory"          : "yes",
420                      "type"               : "TLV",
421                      "format"             : "array",
422                      "size-prefix-format" : "guint16",
423                      "array-element"      : { "name"     : "Element",
424                                               "format"   : "struct",
425                                               "contents" : [ { "name"          : "Message Type",
426                                                                "format"        : "guint8",
427                                                                "public-format" : "QmiWmsMessageType" },
428                                                              { "name"          : "Message Class",
429                                                                "format"        : "guint8",
430                                                                "public-format" : "QmiWmsMessageClass" },
431                                                              { "name"          : "Storage",
432                                                                "format"        : "guint8",
433                                                                "public-format" : "QmiWmsStorageType" },
434                                                              { "name"          : "Receipt Action",
435                                                                "format"        : "guint8",
436                                                                "public-format" : "QmiWmsReceiptAction" } ] } },
437                    { "name"          : "Transfer Status Report",
438                      "id"            : "0x10",
439                      "mandatory"     : "no",
440                      "type"          : "TLV",
441                      "format"        : "guint8",
442                      "public-format" : "QmiWmsTransferIndication" } ],
443      "output"   : [ { "common-ref" : "Operation Result" } ] },
444
445   // *********************************************************************************
446   {  "name"    : "Get Routes",
447      "type"    : "Message",
448      "service" : "WMS",
449      "id"      : "0x0033",
450      "version" : "1.0",
451      "output"   : [ { "common-ref" : "Operation Result" },
452                     { "name"               : "Route List",
453                       "id"                 : "0x01",
454                       "mandatory"          : "yes",
455                       "type"               : "TLV",
456                       "format"             : "array",
457                       "size-prefix-format" : "guint16",
458                       "array-element"      : { "name"     : "Element",
459                                                "format"   : "struct",
460                                                "contents" : [ { "name"          : "Message Type",
461                                                                 "format"        : "guint8",
462                                                                 "public-format" : "QmiWmsMessageType" },
463                                                               { "name"          : "Message Class",
464                                                                 "format"        : "guint8",
465                                                                 "public-format" : "QmiWmsMessageClass" },
466                                                               { "name"          : "Storage",
467                                                                 "format"        : "guint8",
468                                                                 "public-format" : "QmiWmsStorageType" },
469                                                               { "name"          : "Receipt Action",
470                                                                 "format"        : "guint8",
471                                                                 "public-format" : "QmiWmsReceiptAction" } ] },
472                       "prerequisites"      : [ { "common-ref" : "Success" } ] },
473                     { "name"          : "Transfer Status Report",
474                       "id"            : "0x10",
475                       "mandatory"     : "no",
476                       "type"          : "TLV",
477                       "format"        : "guint8",
478                       "public-format" : "QmiWmsTransferIndication",
479                       "prerequisites" : [ { "common-ref" : "Success" } ] } ] },
480
481   // *********************************************************************************
482   {  "name"    : "Send From Memory Storage",
483      "type"    : "Message",
484      "service" : "WMS",
485      "id"      : "0x0042",
486      "version" : "1.2",
487      "input"   : [ { "name"      : "Information",
488                      "id"        : "0x01",
489                      "mandatory" : "yes",
490                      "type"      : "TLV",
491                      "format"    : "sequence",
492                      "contents"  : [ { "name"          : "Storage Type",
493                                        "format"        : "guint8",
494                                        "public-format" : "QmiWmsStorageType" },
495                                      { "name"   : "Memory Index",
496                                        "format" : "guint32" },
497                                      { "name"          : "Message Mode",
498                                        "format"        : "guint8",
499                                        "public-format" : "QmiWmsMessageMode" } ] },
500                    { "name"          : "SMS on IMS",
501                      "id"            : "0x10",
502                      "mandatory"     : "no",
503                      "type"          : "TLV",
504                      "format"        : "guint8",
505                      "public-format" : "gboolean" } ],
506      "output"  : [ { "common-ref" : "Operation Result" },
507                    { "name"          : "Message ID",
508                      "id"            : "0x10",
509                      "mandatory"     : "no",
510                      "type"          : "TLV",
511                      "format"        : "guint16",
512                      "prerequisites" : [ { "common-ref" : "Success" } ] },
513                    { "name"          : "CDMA Cause Code",
514                      "id"            : "0x11",
515                      "mandatory"     : "no",
516                      "type"          : "TLV",
517                      "format"        : "guint16",
518                      "public-format" : "QmiWmsCdmaCauseCode",
519                      "prerequisites" : [ { "field"     : "Result.Error Status",
520                                            "operation" : "!=",
521                                            "value"     : "QMI_STATUS_SUCCESS" },
522                                          { "field"     : "Result.Error Code",
523                                            "operation" : "==",
524                                            "value"     : "QMI_PROTOCOL_ERROR_WMS_CAUSE_CODE" } ] },
525                    { "name"          : "CDMA Error Class",
526                      "id"            : "0x12",
527                      "mandatory"     : "no",
528                      "type"          : "TLV",
529                      "format"        : "guint8",
530                      "public-format" : "QmiWmsCdmaErrorClass",
531                      "prerequisites" : [ { "field"     : "Result.Error Status",
532                                            "operation" : "!=",
533                                            "value"     : "QMI_STATUS_SUCCESS" },
534                                          { "field"     : "Result.Error Code",
535                                            "operation" : "==",
536                                            "value"     : "QMI_PROTOCOL_ERROR_WMS_CAUSE_CODE" } ] },
537                    { "name"          : "GSM WCDMA Cause Info",
538                      "id"            : "0x13",
539                      "mandatory"     : "no",
540                      "type"          : "TLV",
541                      "format"        : "sequence",
542                      "contents"      : [ { "name"          : "RP Cause",
543                                            "format"        : "guint16",
544                                            "public-format" : "QmiWmsGsmUmtsRpCause" },
545                                          { "name"          : "TP Cause",
546                                            "format"        : "guint8",
547                                            "public-format" : "QmiWmsGsmUmtsTpCause" } ],
548                      "prerequisites" : [ { "field"     : "Result.Error Status",
549                                            "operation" : "!=",
550                                            "value"     : "QMI_STATUS_SUCCESS" },
551                                          { "field"     : "Result.Error Code",
552                                            "operation" : "==",
553                                            "value"     : "QMI_PROTOCOL_ERROR_WMS_CAUSE_CODE" } ] },
554                    { "name"          : "Message Delivery Failure Type",
555                      "id"            : "0x14",
556                      "mandatory"     : "no",
557                      "type"          : "TLV",
558                      "format"        : "guint8",
559                      "public-format" : "QmiWmsMessageDeliveryFailureType",
560                      "prerequisites" : [ { "field"     : "Result.Error Status",
561                                            "operation" : "!=",
562                                            "value"     : "QMI_STATUS_SUCCESS" },
563                                          { "field"     : "Result.Error Code",
564                                            "operation" : "==",
565                                            "value"     : "QMI_PROTOCOL_ERROR_WMS_CAUSE_CODE" } ] } ] }
566
567 ]