data/qmi-service-wds.json

   1
   2 [
   3   // *********************************************************************************
   4   {  "name"    : "WDS",
   5      "type"    : "Service" },
   6
   7   // *********************************************************************************
   8   {  "name"    : "QMI Client WDS",
   9      "type"    : "Client" },
  10
  11   // *********************************************************************************
  12   {  "name"    : "QMI Message WDS",
  13      "type"    : "Message-ID-Enum" },
  14
  15   // *********************************************************************************
  16   {  "name"    : "Reset",
  17      "type"    : "Message",
  18      "service" : "WDS",
  19      "id"      : "0x0000",
  20      "version" : "1.0",
  21      "output"  : [  { "common-ref" : "Operation Result" } ] },
  22
  23   // *********************************************************************************
  24   {  "name"    : "Abort",
  25      "type"    : "Message",
  26      "service" : "WDS",
  27      "id"      : "0x0002",
  28      "version" : "1.0",
  29      // This magic tag allows us to avoid creating a method in the client
  30      "scope"   : "library-only",
  31      "input"   : [  { "name"      : "Transaction ID",
  32                       "id"        : "0x01",
  33                       "mandatory" : "yes",
  34                       "type"      : "TLV",
  35                       "format"    : "guint16" } ],
  36      "output"  : [  { "common-ref" : "Operation Result" } ] },
  37
  38   // *********************************************************************************
  39   {  "name"    : "Start Network",
  40      "type"    : "Message",
  41      "service" : "WDS",
  42      "id"      : "0x0020",
  43      "version" : "1.0",
  44      // This method may be aborted
  45      "abort"   : "yes",
  46      "input"   : [  { "name"      : "Primary DNS Address Preference",
  47                       "id"        : "0x10",
  48                       "mandatory" : "no",
  49                       "type"      : "TLV",
  50                       "format"    : "guint32" },
  51                     { "name"      : "Secondary DNS Address Preference",
  52                       "id"        : "0x11",
  53                       "mandatory" : "no",
  54                       "type"      : "TLV",
  55                       "format"    : "guint32" },
  56                     { "name"      : "Primary NBNS Address Preference",
  57                       "id"        : "0x12",
  58                       "mandatory" : "no",
  59                       "type"      : "TLV",
  60                       "format"    : "guint32" },
  61                     { "name"      : "Secondary NBNS Address Preference",
  62                       "id"        : "0x13",
  63                       "mandatory" : "no",
  64                       "type"      : "TLV",
  65                       "format"    : "guint32" },
  66                     { "name"      : "APN",
  67                       "id"        : "0x14",
  68                       "mandatory" : "no",
  69                       "type"      : "TLV",
  70                       "format"    : "string" },
  71                     { "name"      : "IPv4 Address Preference",
  72                       "id"        : "0x15",
  73                       "mandatory" : "no",
  74                       "type"      : "TLV",
  75                       "format"    : "guint32" },
  76                     { "name"          : "Authentication Preference",
  77                       "id"            : "0x16",
  78                       "mandatory"     : "no",
  79                       "type"          : "TLV",
  80                       "format"        : "guint8",
  81                       "public-format" : "QmiWdsAuthentication" },
  82                     { "name"      : "Username",
  83                       "id"        : "0x17",
  84                       "mandatory" : "no",
  85                       "type"      : "TLV",
  86                       "format"    : "string" },
  87                     { "name"      : "Password",
  88                       "id"        : "0x18",
  89                       "mandatory" : "no",
  90                       "type"      : "TLV",
  91                       "format"    : "string" },
  92                     { "name"          : "IP Family Preference",
  93                       "id"            : "0x19",
  94                       "mandatory"     : "no",
  95                       "type"          : "TLV",
  96                       "format"        : "guint8",
  97                       "public-format" : "QmiWdsIpFamily" },
  98                     { "name"          : "Technology Preference",
  99                       "id"            : "0x30",
 100                       "mandatory"     : "no",
 101                       "type"          : "TLV",
 102                       "format"        : "guint8",
 103                       "public-format" : "QmiWdsTechnologyPreference" },
 104                     { "name"      : "Profile Index 3GPP",
 105                       "id"        : "0x31",
 106                       "mandatory" : "no",
 107                       "type"      : "TLV",
 108                       "format"    : "guint8" },
 109                     { "name"      : "Profile Index 3GPP2",
 110                       "id"        : "0x32",
 111                       "mandatory" : "no",
 112                       "type"      : "TLV",
 113                       "format"    : "guint8" },
 114                     { "name"          : "Enable Autoconnect",
 115                       "id"            : "0x33",
 116                       "mandatory"     : "no",
 117                       "type"          : "TLV",
 118                       "format"        : "guint8",
 119                       "public-format" : "gboolean" },
 120                     { "name"          : "Extended Technology Preference",
 121                       "id"            : "0x34",
 122                       "mandatory"     : "no",
 123                       "type"          : "TLV",
 124                       "format"        : "guint16",
 125                       "public-format" : "QmiWdsExtendedTechnologyPreference" },
 126                     { "name"          : "Call Type",
 127                       "id"            : "0x35",
 128                       "mandatory"     : "no",
 129                       "type"          : "TLV",
 130                       "format"        : "guint8",
 131                       "public-format" : "QmiWdsCallType" } ],
 132      "output"  : [  { "common-ref" : "Operation Result" },
 133                     { "name"      : "Packet Data Handle",
 134                       "id"        : "0x01",
 135                       "mandatory" : "yes",
 136                       "type"      : "TLV",
 137                       "format"    : "guint32",
 138                       "prerequisites": [ { "common-ref" : "Success" } ] },
 139                     { "name"          : "Call End Reason",
 140                       "id"            : "0x10",
 141                       "mandatory"     : "no",
 142                       "type"          : "TLV",
 143                       "format"        : "guint16",
 144                       "public-format" : "QmiWdsCallEndReason",
 145                       "prerequisites" : [ { "field"     : "Result.Error Status",
 146                                             "operation" : "!=",
 147                                             "value"     : "QMI_STATUS_SUCCESS" },
 148                                           { "field"     : "Result.Error Code",
 149                                             "operation" : "==",
 150                                             "value"     : "QMI_PROTOCOL_ERROR_CALL_FAILED" } ] },
 151                     { "name"      : "Verbose Call End Reason",
 152                       "id"        : "0x11",
 153                       "mandatory" : "no",
 154                       "type"      : "TLV",
 155                       "format"    : "sequence",
 156                       "contents"  : [ { "name"          : "Type",
 157                                         "format"        : "guint16",
 158                                         "public-format" : "QmiWdsVerboseCallEndReasonType" },
 159                                       { "name"   : "Reason",
 160                                         "format" : "gint16" } ],
 161                       "prerequisites": [ { "field"     : "Result.Error Status",
 162                                            "operation" : "!=",
 163                                            "value"     : "QMI_STATUS_SUCCESS" },
 164                                          { "field"     : "Result.Error Code",
 165                                            "operation" : "==",
 166                                            "value"     : "QMI_PROTOCOL_ERROR_CALL_FAILED" } ] } ] },
 167
 168   // *********************************************************************************
 169   {  "name"    : "Stop Network",
 170      "type"    : "Message",
 171      "service" : "WDS",
 172      "id"      : "0x0021",
 173      "version" : "1.0",
 174      "input"   : [  { "name"      : "Packet Data Handle",
 175                       "id"        : "0x01",
 176                       "mandatory" : "yes",
 177                       "type"      : "TLV",
 178                       "format"    : "guint32" },
 179                     { "name"          : "Disable Autoconnect",
 180                       "id"            : "0x10",
 181                       "mandatory"     : "no",
 182                       "type"          : "TLV",
 183                       "format"        : "guint8",
 184                       "public-format" : "gboolean" } ],
 185      "output"  : [  { "common-ref" : "Operation Result" } ] },
 186
 187   // *********************************************************************************
 188   {  "name"    : "Get Packet Service Status",
 189      "type"    : "Message",
 190      "service" : "WDS",
 191      "id"      : "0x0022",
 192      "version" : "1.0",
 193      "output"  : [  { "common-ref" : "Operation Result" },
 194                     { "name"          : "Connection Status",
 195                       "id"            : "0x01",
 196                       "mandatory"     : "yes",
 197                       "type"          : "TLV",
 198                       "format"        : "guint8",
 199                       "public-format" : "QmiWdsConnectionStatus",
 200                       "prerequisites" : [ { "common-ref" : "Success" } ] } ] },
 201
 202   // *********************************************************************************
 203   {  "name"    : "Get Current Settings",
 204      "type"    : "Message",
 205      "service" : "WDS",
 206      "id"      : "0x002D",
 207      "version" : "1.2",
 208      "input"   : [  { "name"          : "Requested Settings",
 209                       "id"            : "0x10",
 210                       "mandatory"     : "yes",
 211                       "type"          : "TLV",
 212                       "format"        : "guint32",
 213                       "public-format" : "QmiWdsGetCurrentSettingsRequestedSettings" } ],
 214      "output"  : [  { "common-ref" : "Operation Result" },
 215                     { "name"      : "Profile Name",
 216                       "id"        : "0x10",
 217                       "mandatory" : "no",
 218                       "type"      : "TLV",
 219                       "format"    : "string",
 220                       "prerequisites" : [ { "common-ref" : "Success" } ] },
 221                     { "name"      : "PDP Type",
 222                       "id"        : "0x11",
 223                       "mandatory" : "no",
 224                       "type"      : "TLV",
 225                       "format"    : "guint8",
 226                       "public-format" : "QmiWdsPdpType",
 227                       "prerequisites" : [ { "common-ref" : "Success" } ] },
 228                     { "name"      : "APN Name",
 229                       "id"        : "0x14",
 230                       "mandatory" : "no",
 231                       "type"      : "TLV",
 232                       "format"    : "string",
 233                       "prerequisites" : [ { "common-ref" : "Success" } ] },
 234                     { "name"      : "Primary IPv4 DNS Address",
 235                       "id"        : "0x15",
 236                       "mandatory" : "no",
 237                       "type"      : "TLV",
 238                       "endian"    : "little",
 239                       "format"    : "guint32",
 240                       "prerequisites" : [ { "common-ref" : "Success" } ] },
 241                     { "name"      : "Secondary IPv4 DNS Address",
 242                       "id"        : "0x16",
 243                       "mandatory" : "no",
 244                       "type"      : "TLV",
 245                       "endian"    : "little",
 246                       "format"    : "guint32",
 247                       "prerequisites" : [ { "common-ref" : "Success" } ] },
 248                     { "name"      : "GPRS Granted QoS",
 249                       "id"        : "0x19",
 250                       "mandatory" : "no",
 251                       "type"      : "TLV",
 252                       "format"    : "sequence",
 253                       "contents"  : [ { "name"   : "Precedence Class",
 254                                         "format" : "guint32" },
 255                                       { "name"   : "Delay Class",
 256                                         "format" : "guint32" },
 257                                       { "name"   : "Reliability Class",
 258                                         "format" : "guint32" },
 259                                       { "name"   : "Peak Throughput Class",
 260                                         "format" : "guint32" },
 261                                       { "name"   : "Mean Throughput Class",
 262                                         "format" : "guint32" } ],
 263                       "prerequisites" : [ { "common-ref" : "Success" } ] },
 264                     { "name"      : "Username",
 265                       "id"        : "0x1B",
 266                       "mandatory" : "no",
 267                       "type"      : "TLV",
 268                       "format"    : "string",
 269                       "prerequisites" : [ { "common-ref" : "Success" } ] },
 270                     { "name"      : "Authentication",
 271                       "id"        : "0x1D",
 272                       "mandatory" : "no",
 273                       "type"      : "TLV",
 274                       "format"    : "guint8",
 275                       "public-format" : "QmiWdsAuthentication",
 276                       "prerequisites" : [ { "common-ref" : "Success" } ] },
 277                     { "name"      : "IPv4 Address",
 278                       "id"        : "0x1E",
 279                       "mandatory" : "no",
 280                       "type"      : "TLV",
 281                       "endian"    : "little",
 282                       "format"    : "guint32",
 283                       "prerequisites" : [ { "common-ref" : "Success" } ] },
 284                     { "name"      : "Profile ID",
 285                       "id"        : "0x1F",
 286                       "mandatory" : "no",
 287                       "type"      : "TLV",
 288                       "format"    : "sequence",
 289                       "contents"  : [ { "name"          : "Profile Type",
 290                                         "format"        : "guint8",
 291                                         "public-format" : "QmiWdsProfileType" },
 292                                       { "name"   : "Profile Index",
 293                                         "format" : "guint8" } ],
 294                       "prerequisites" : [ { "common-ref" : "Success" } ] },
 295                     { "name"      : "IPv4 Gateway Address",
 296                       "id"        : "0x20",
 297                       "mandatory" : "no",
 298                       "type"      : "TLV",
 299                       "endian"    : "little",
 300                       "format"    : "guint32",
 301                       "prerequisites" : [ { "common-ref" : "Success" } ] },
 302                     { "name"      : "IPv4 Gateway Subnet Mask",
 303                       "id"        : "0x21",
 304                       "mandatory" : "no",
 305                       "type"      : "TLV",
 306                       "endian"    : "little",
 307                       "format"    : "guint32",
 308                       "prerequisites" : [ { "common-ref" : "Success" } ] },
 309                     { "name"      : "PCSCF Address Using PCO",
 310                       "id"        : "0x22",
 311                       "mandatory" : "no",
 312                       "type"      : "TLV",
 313                       "format"    : "guint8",
 314                       "prerequisites" : [ { "common-ref" : "Success" } ] },
 315                     { "name"      : "PCSCF Server Address List",
 316                       "id"        : "0x23",
 317                       "mandatory" : "no",
 318                       "type"      : "TLV",
 319                       "format"        : "array",
 320                       "array-element" : { "name"     : "IPv4 Address",
 321                                           "endian"   : "little",
 322                                           "format"   : "guint32" },
 323                       "prerequisites" : [ { "common-ref" : "Success" } ] },
 324                     { "name"      : "PCSCF Domain Name List",
 325                       "id"        : "0x24",
 326                       "mandatory" : "no",
 327                       "type"      : "TLV",
 328                       "format"        : "array",
 329                       "array-element" : { "name"               : "FQDN",
 330                                           "format"             : "string",
 331                                           "size-prefix-format" : "guint16" },
 332                       "prerequisites" : [ { "common-ref" : "Success" } ] },
 333                     { "name"      : "IPv6 Address",
 334                       "id"        : "0x25",
 335                       "mandatory" : "no",
 336                       "type"      : "TLV",
 337                       "format"    : "sequence",
 338                       "contents"  : [ { "name"          : "Address",
 339                                         "format"        : "array",
 340                                         "fixed-size"    : "8",
 341                                         "array-element" : { "format": "guint16", "endian": "network" } },
 342                                       { "name"       : "Prefix Length",
 343                                         "format"     : "guint8" } ],
 344                       "prerequisites" : [ { "common-ref" : "Success" } ] },
 345                     { "name"      : "IPv6 Gateway Address",
 346                       "id"        : "0x26",
 347                       "mandatory" : "no",
 348                       "type"      : "TLV",
 349                       "format"    : "sequence",
 350                       "contents"  : [ { "name"          : "Address",
 351                                         "format"        : "array",
 352                                         "fixed-size"    : "8",
 353                                         "array-element" : { "format": "guint16", "endian": "network" } },
 354                                       { "name"       : "Prefix Length",
 355                                         "format"     : "guint8" } ],
 356                       "prerequisites" : [ { "common-ref" : "Success" } ] },
 357                     { "name"      : "IPv6 Primary DNS Address",
 358                       "id"        : "0x27",
 359                       "mandatory" : "no",
 360                       "type"      : "TLV",
 361                       "format"    : "array",
 362                       "fixed-size": "8",
 363                       "array-element" : { "format": "guint16", "endian": "network" },
 364                       "prerequisites" : [ { "common-ref" : "Success" } ] },
 365                     { "name"      : "IPv6 Secondary DNS Address",
 366                       "id"        : "0x28",
 367                       "mandatory" : "no",
 368                       "type"      : "TLV",
 369                       "format"    : "array",
 370                       "fixed-size": "8",
 371                       "array-element" : { "format": "guint16", "endian": "network" },
 372                       "prerequisites" : [ { "common-ref" : "Success" } ] },
 373                     { "name"      : "MTU",
 374                       "id"        : "0x29",
 375                       "mandatory" : "no",
 376                       "type"      : "TLV",
 377                       "format"    : "guint32",
 378                       "prerequisites" : [ { "common-ref" : "Success" } ] },
 379                     { "name"      : "Domain Name List",
 380                       "id"        : "0x2A",
 381                       "mandatory" : "no",
 382                       "type"      : "TLV",
 383                       "format"        : "array",
 384                       "array-element" : { "name"               : "Domain Name",
 385                                           "format"             : "string",
 386                                           "size-prefix-format" : "guint16" },
 387                       "prerequisites" : [ { "common-ref" : "Success" } ] },
 388                     { "name"      : "IP Family",
 389                       "id"        : "0x2B",
 390                       "mandatory" : "no",
 391                       "type"      : "TLV",
 392                       "format"    : "guint8",
 393                       "public-format" : "QmiWdsIpFamily",
 394                       "prerequisites" : [ { "common-ref" : "Success" } ] },
 395                     { "name"      : "IMCN Flag",
 396                       "id"        : "0x2C",
 397                       "mandatory" : "no",
 398                       "type"      : "TLV",
 399                       "format"    : "gint8",
 400                       "prerequisites" : [ { "common-ref" : "Success" } ] },
 401                     { "name"      : "Extended Technology Preference",
 402                       "id"        : "0x2D",
 403                       "mandatory" : "no",
 404                       "type"      : "TLV",
 405                       "format"    : "guint16",
 406                       "public-format" : "QmiWdsExtendedTechnologyPreference",
 407                       "prerequisites" : [ { "common-ref" : "Success" } ] } ] },
 408
 409   // *********************************************************************************
 410   {  "name"    : "Get Data Bearer Technology",
 411      "type"    : "Message",
 412      "service" : "WDS",
 413      "id"      : "0x0037",
 414      "version" : "1.12",
 415      "output"  : [  { "common-ref" : "Operation Result" },
 416                     { "name"          : "Current",
 417                       "id"            : "0x01",
 418                       "mandatory"     : "yes",
 419                       "type"          : "TLV",
 420                       "format"        : "gint8",
 421                       "public-format" : "QmiWdsDataBearerTechnology",
 422                       "prerequisites" : [ { "common-ref" : "Success" } ] },
 423                     { "name"          : "Last",
 424                       "id"            : "0x10",
 425                       "mandatory"     : "no",
 426                       "type"          : "TLV",
 427                       "format"        : "gint8",
 428                       "public-format" : "QmiWdsDataBearerTechnology",
 429                       "prerequisites" : [ { "field"     : "Result.Error Status",
 430                                            "operation" : "!=",
 431                                            "value"     : "QMI_STATUS_SUCCESS" },
 432                                          { "field"     : "Result.Error Code",
 433                                            "operation" : "==",
 434                                            "value"     : "QMI_PROTOCOL_ERROR_OUT_OF_CALL" } ] } ] },
 435
 436   // *********************************************************************************
 437   {  "name"    : "Get Current Data Bearer Technology",
 438      "type"    : "Message",
 439      "service" : "WDS",
 440      "id"      : "0x0044",
 441      "version" : "1.4",
 442      "output"  : [  { "common-ref" : "Operation Result" },
 443                     { "name"      : "Current",
 444                       "id"        : "0x01",
 445                       "mandatory" : "yes",
 446                       "type"      : "TLV",
 447                       "format"    : "sequence",
 448                       "contents"  : [ { "name"          : "Network Type",
 449                                         "format"        : "guint8",
 450                                         "public-format" : "QmiWdsNetworkType" },
 451                                       { "name"   : "RAT Mask",
 452                                         "format" : "guint32" },
 453                                       { "name"   : "SO Mask",
 454                                         "format" : "guint32" } ],
 455                       "prerequisites": [ { "common-ref" : "Success" } ] },
 456                     { "name"      : "Last",
 457                       "id"        : "0x10",
 458                       "mandatory" : "no",
 459                       "type"      : "TLV",
 460                       "format"    : "sequence",
 461                       "contents"  : [ { "name"          : "Network Type",
 462                                         "format"        : "guint8",
 463                                         "public-format" : "QmiWdsNetworkType" },
 464                                       { "name"   : "RAT Mask",
 465                                         "format" : "guint32" },
 466                                       { "name"   : "SO Mask",
 467                                         "format" : "guint32" } ] } ] },
 468
 469   // *********************************************************************************
 470   {  "name"    : "Set IP Family",
 471      "type"    : "Message",
 472      "service" : "WDS",
 473      "id"      : "0x004D",
 474      "version" : "1.9",
 475      "input"   : [  { "name"          : "Preference",
 476                       "id"            : "0x01",
 477                       "mandatory"     : "yes",
 478                       "type"          : "TLV",
 479                       "format"        : "guint8",
 480                       "public-format" : "QmiWdsIpFamily" } ],
 481      "output"  : [  { "common-ref" : "Operation Result" } ] }
 482
 483 ]