uqmi: sync data from libqmi project
[project/uqmi.git] / data / qmi-service-dms.json
index 0a226b0c60e176c43532519a164c178ba521eae2..a45a7b5bf9574ccf5429c0138ec0c9029d05e2da 100644 (file)
                                         "format"        : "guint8",
                                         "public-format" : "QmiDmsSimCapability" },
                                       { "name"   : "Radio Interface List",
-                                        "format" : "array",
-                                        "array-element" : { "format"        : "guint8",
-                                                            "public-format" : "QmiDmsRadioInterface" } } ],
+                                        "format"             : "array",
+                                        "size-prefix-format" : "guint8",
+                                        "array-element"      : { "format"        : "guint8",
+                                                                 "public-format" : "QmiDmsRadioInterface" } } ],
                       "prerequisites": [ { "common-ref" : "Success" } ] } ] },
 
   // *********************************************************************************
      "id"      : "0x0025",
      "since"   : "1.0",
      "output"  : [  { "common-ref" : "Operation Result" },
-                    { "name"      : "Esn",
-                      "id"        : "0x10",
-                      "type"      : "TLV",
-                      "since"     : "1.0",
-                      "format"    : "string",
-                      "prerequisites": [ { "common-ref" : "Success" } ] },
-                    { "name"      : "Imei",
-                      "id"        : "0x11",
-                      "type"      : "TLV",
-                      "since"     : "1.0",
-                      "format"    : "string",
-                      "max-size"  : "15",
-                      "prerequisites": [ { "common-ref" : "Success" } ] },
-                    { "name"      : "Meid",
-                      "id"        : "0x12",
-                      "type"      : "TLV",
-                      "since"     : "1.0",
-                      "format"    : "string",
-                      "prerequisites": [ { "common-ref" : "Success" } ] },
+                    { "name"          : "Esn",
+                      "id"            : "0x10",
+                      "type"          : "TLV",
+                      "since"         : "1.0",
+                      "format"        : "string",
+                      "prerequisites" : [ { "common-ref" : "Success" } ] },
+                    { "name"          : "Imei",
+                      "id"            : "0x11",
+                      "type"          : "TLV",
+                      "since"         : "1.0",
+                      "format"        : "string",
+                      "max-size"      : "15",
+                      "personal-info" : "true",
+                      "prerequisites" : [ { "common-ref" : "Success" } ] },
+                    { "name"          : "Meid",
+                      "id"            : "0x12",
+                      "type"          : "TLV",
+                      "since"         : "1.0",
+                      "format"        : "string",
+                      "personal-info" : "true",
+                      "prerequisites" : [ { "common-ref" : "Success" } ] },
                     { "name"      : "Imei Software Version",
                       "id"        : "0x13",
                       "type"      : "TLV",
                                       { "name"          : "Protection Enabled",
                                         "format"        : "guint8",
                                         "public-format" : "gboolean" },
-                                      { "name"   : "PIN",
-                                        "format" : "string" } ] } ],
+                                      { "name"          : "PIN",
+                                        "format"        : "string",
+                                        "personal-info" : "true" } ] } ],
      "output"  : [  { "common-ref" : "Operation Result" },
                     { "name"      : "Pin Retries Status",
                       "id"        : "0x10",
                       "contents"  : [ { "name"          : "Pin ID",
                                         "format"        : "guint8",
                                         "public-format" : "QmiDmsUimPinId" },
-                                      { "name"   : "PIN",
-                                        "format" : "string" } ] } ],
+                                      { "name"          : "PIN",
+                                        "format"        : "string",
+                                        "personal-info" : "true" } ] } ],
      "output"  : [  { "common-ref" : "Operation Result" },
                     { "name"      : "Pin Retries Status",
                       "id"        : "0x10",
                       "contents"  : [ { "name"          : "Pin ID",
                                         "format"        : "guint8",
                                         "public-format" : "QmiDmsUimPinId" },
-                                      { "name"   : "PUK",
-                                        "format" : "string" },
-                                      { "name"   : "New PIN",
-                                        "format" : "string" } ] } ],
+                                      { "name"          : "PUK",
+                                        "format"        : "string",
+                                        "personal-info" : "true" },
+                                      { "name"          : "New PIN",
+                                        "format"        : "string",
+                                        "personal-info" : "true" } ] } ],
      "output"  : [  { "common-ref" : "Operation Result" },
                     { "name"      : "Pin Retries Status",
                       "id"        : "0x10",
                       "contents"  : [ { "name"          : "Pin ID",
                                         "format"        : "guint8",
                                         "public-format" : "QmiDmsUimPinId" },
-                                      { "name"   : "Old PIN",
-                                        "format" : "string" },
-                                      { "name"   : "New PIN",
-                                        "format" : "string" } ] } ],
+                                      { "name"          : "Old PIN",
+                                        "format"        : "string",
+                                        "personal-info" : "true" },
+                                      { "name"          : "New PIN",
+                                        "format"        : "string",
+                                        "personal-info" : "true" } ] } ],
      "output"  : [  { "common-ref" : "Operation Result" },
                     { "name"      : "Pin Retries Status",
                       "id"        : "0x10",
      "service" : "DMS",
      "id"      : "0x0033",
      "since"   : "1.0",
-     "input"   : [  { "name"      : "Info",
-                      "id"        : "0x01",
-                      "type"      : "TLV",
+     "input"   : [  { "name"          : "Info",
+                      "id"            : "0x01",
+                      "type"          : "TLV",
                       // API updated in 1.6
-                      "since"     : "1.6",
-                      "format"    : "sequence",
-                      "contents"  : [ { "name"       : "Service Programming Code",
-                                        "format"     : "string",
-                                        "fixed-size" : "6" },
-                                      { "name"   : "System Identification Number",
-                                        "format" : "guint16" },
-                                      { "name"     : "Mobile Directory Number",
-                                        "format"   : "string",
-                                        "max-size" : "15" },
-                                      { "name"     : "Mobile Identification Number",
-                                        "format"   : "string",
-                                        "max-size" : "15" } ] },
+                      "since"         : "1.6",
+                      "format"        : "sequence",
+                      "contents"      : [ { "name"       : "Service Programming Code",
+                                            "format"     : "string",
+                                            "fixed-size" : "6" },
+                                          { "name"   : "System Identification Number",
+                                            "format" : "guint16" },
+                                          { "name"     : "Mobile Directory Number",
+                                            "format"   : "string",
+                                            "max-size" : "15" },
+                                          { "name"     : "Mobile Identification Number",
+                                            "format"   : "string",
+                                            "max-size" : "15" } ],
+                      "personal-info" : "true" },
                     { "name"               : "MN HA key",
                       "id"                 : "0x11",
                       "type"               : "TLV",
                       "since"              : "1.0",
                       "format"             : "string",
                       "max-size"           : "16",
-                      "size-prefix-format" : "guint8" },
+                      "size-prefix-format" : "guint8",
+                      "personal-info"      : "true" },
                     { "name"               : "MN AAA key",
                       "id"                 : "0x12",
                       "type"               : "TLV",
                       "since"              : "1.0",
                       "format"             : "string",
                       "max-size"           : "16",
-                      "size-prefix-format" : "guint8" },
+                      "size-prefix-format" : "guint8",
+                      "personal-info"      : "true" },
                     { "name"      : "PRL",
                       "id"        : "0x13",
                       "type"      : "TLV",
                       "format"    : "sequence",
                       "contents"  : [ { "name"   : "PRL total length",
                                         "format" : "guint16" },
-                                      { "name"   : "PRL segment",
+                                      { "name"                   : "PRL segment",
                                         "format"                 : "array",
                                         "size-prefix-format"     : "guint16",
                                         "sequence-prefix-format" : "guint8",
                       "contents"  : [ { "name"          : "Enabled",
                                         "format"        : "guint8",
                                         "public-format" : "gboolean" },
-                                      { "name"       : "Lock Code",
-                                        "format"     : "string",
-                                        "fixed-size" : "4" } ] } ],
+                                      { "name"          : "Lock Code",
+                                        "format"        : "string",
+                                        "fixed-size"    : "4",
+                                        "personal-info" : "true" } ] } ],
      "output"  : [  { "common-ref" : "Operation Result" } ] },
 
   // *********************************************************************************
      "id"      : "0x003C",
      "since"   : "1.0",
      "output"  : [  { "common-ref" : "Operation Result" },
-                    { "name"      : "ICCID",
-                      "id"        : "0x01",
-                      "type"      : "TLV",
-                      "since"     : "1.0",
-                      "format"    : "string",
-                      "prerequisites": [ { "common-ref" : "Success" } ] } ] },
+                    { "name"          : "ICCID",
+                      "id"            : "0x01",
+                      "type"          : "TLV",
+                      "since"         : "1.0",
+                      "format"        : "string",
+                      "personal-info" : "true",
+                      "prerequisites" : [ { "common-ref" : "Success" } ] } ] },
 
   // *********************************************************************************
   {  "name"    : "Set Firmware ID",
      "id"      : "0x0043",
      "since"   : "1.0",
      "output"  : [  { "common-ref" : "Operation Result" },
-                    { "name"      : "IMSI",
-                      "id"        : "0x01",
-                      "type"      : "TLV",
-                      "since"     : "1.0",
-                      "format"    : "string",
-                      "prerequisites": [ { "common-ref" : "Success" } ] } ] },
+                    { "name"          : "IMSI",
+                      "id"            : "0x01",
+                      "type"          : "TLV",
+                      "since"         : "1.0",
+                      "format"        : "string",
+                      "personal-info" : "true",
+                      "prerequisites" : [ { "common-ref" : "Success" } ] } ] },
 
   // *********************************************************************************
   {  "name"    : "UIM Get State",
                       "format"             : "array",
                       "size-prefix-format" : "guint16",
                       "array-element"      : { "format" : "guint16" },
+                      "prerequisites"      : [ { "common-ref" : "Success" } ] },
+                    { "name"               : "NR5G Band Capability",
+                      "id"                 : "0x13",
+                      "type"               : "TLV",
+                      "since"              : "1.32",
+                      "format"             : "array",
+                      "size-prefix-format" : "guint16",
+                      "array-element"      : { "format" : "guint16" },
                       "prerequisites"      : [ { "common-ref" : "Success" } ] } ] },
 
   // *********************************************************************************
      "id"      : "0x0047",
      "since"   : "1.0",
      "output"  : [ { "common-ref" : "Operation Result" },
-                   { "name"          : "List",
-                     "id"            : "0x01",
-                     "type"          : "TLV",
-                     "since"        : "1.0",
-                     "format"        : "array",
-                     "array-element" : { "name"     : "Image",
-                                         "format"   : "struct",
-                                         "contents" : [ { "name"          : "Type",
-                                                          "format"        : "guint8",
-                                                          "public-format" : "QmiDmsFirmwareImageType" },
-                                                        { "name"          : "Unique ID",
-                                                          "format"        : "array",
-                                                          "fixed-size"    : "16",
-                                                          "array-element" : { "format": "guint8" } },
-                                                        { "name"   : "Build ID",
-                                                          "format" : "string" } ] },
-                     "prerequisites"   : [ { "common-ref" : "Success" } ] } ] },
+                   { "name"               : "List",
+                     "id"                 : "0x01",
+                     "type"               : "TLV",
+                     "since"              : "1.0",
+                     "format"             : "array",
+                     "size-prefix-format" : "guint8",
+                     "array-element"      : { "name"     : "Image",
+                                              "format"   : "struct",
+                                              "contents" : [ { "name"          : "Type",
+                                                               "format"        : "guint8",
+                                                               "public-format" : "QmiDmsFirmwareImageType" },
+                                                             { "name"          : "Unique ID",
+                                                               "format"        : "array",
+                                                               "fixed-size"    : "16",
+                                                               "array-element" : { "format": "guint8" } },
+                                                             { "name"   : "Build ID",
+                                                               "format" : "string" } ] },
+                     "prerequisites"      : [ { "common-ref" : "Success" } ] } ] },
 
   // *********************************************************************************
   {  "name"    : "Set Firmware Preference",
      "service" : "DMS",
      "id"      : "0x0048",
      "since"   : "1.0",
-     "input"   : [ { "name"          : "List",
-                     "id"            : "0x01",
-                     "type"          : "TLV",
-                     "since"         : "1.0",
-                     "format"        : "array",
-                     "array-element" : { "name"     : "Image",
-                                         "format"   : "struct",
-                                         "contents" : [ { "name"          : "Type",
-                                                          "format"        : "guint8",
-                                                          "public-format" : "QmiDmsFirmwareImageType" },
-                                                        { "name"          : "Unique ID",
-                                                          "format"        : "array",
-                                                          "fixed-size"    : "16",
-                                                          "array-element" : { "format": "guint8" } },
-                                                        { "name"   : "Build ID",
-                                                          "format" : "string" } ] } },
+     "input"   : [ { "name"               : "List",
+                     "id"                 : "0x01",
+                     "type"               : "TLV",
+                     "since"              : "1.0",
+                     "format"             : "array",
+                     "size-prefix-format" : "guint8",
+                     "array-element"      : { "name"     : "Image",
+                                              "format"   : "struct",
+                                              "contents" : [ { "name"          : "Type",
+                                                               "format"        : "guint8",
+                                                               "public-format" : "QmiDmsFirmwareImageType" },
+                                                             { "name"          : "Unique ID",
+                                                               "format"        : "array",
+                                                               "fixed-size"    : "16",
+                                                               "array-element" : { "format": "guint8" } },
+                                                             { "name"   : "Build ID",
+                                                               "format" : "string" } ] } },
                    { "name"          : "Download Override",
                      "id"            : "0x10",
                      "type"          : "TLV",
                      "since"         : "1.0",
                      "format"        : "guint8" } ],
      "output"  : [ { "common-ref" : "Operation Result" },
-                   { "name"          : "Image Download List",
-                     "id"            : "0x01",
-                     "type"          : "TLV",
-                     "since"         : "1.0",
-                     "format"        : "array",
-                     "array-element" : { "name"     : "Image Type",
-                                         "format"   : "guint8",
-                                         "public-format" : "QmiDmsFirmwareImageType" },
-                     "prerequisites"   : [ { "common-ref" : "Success" } ] } ] },
+                   { "name"               : "Image Download List",
+                     "id"                 : "0x01",
+                     "type"               : "TLV",
+                     "since"              : "1.0",
+                     "format"             : "array",
+                     "size-prefix-format" : "guint8",
+                     "array-element"      : { "name"     : "Image Type",
+                                              "format"   : "guint8",
+                                              "public-format" : "QmiDmsFirmwareImageType" },
+                     "prerequisites"      : [ { "common-ref" : "Success" } ] } ] },
 
   // *********************************************************************************
   {  "name"    : "List Stored Images",
      "id"      : "0x0049",
      "since"   : "1.0",
      "output"  : [ { "common-ref" : "Operation Result" },
-                   { "name"          : "List",
-                     "id"            : "0x01",
-                     "type"          : "TLV",
-                     "since"         : "1.0",
-                     "format"        : "array",
-                     "array-element" : { "name"     : "Image",
-                                         "format"   : "struct",
-                                         "contents" : [ { "name"          : "Type",
-                                                          "format"        : "guint8",
-                                                          "public-format" : "QmiDmsFirmwareImageType" },
-                                                        { "name"   : "Maximum Images",
-                                                          "format" : "guint8" },
-                                                        { "name"   : "Index Of Running Image",
-                                                          "format" : "guint8" },
-                                                        { "name"          : "Sublist",
-                                                          "format"        : "array",
-                                                          "array-element" : { "name"     : "Sublist Element",
-                                                                              "format"   : "struct",
-                                                                              "contents" : [ { "name"   : "Storage Index",
-                                                                                               "format" : "guint8" },
-                                                                                             { "name"   : "Failure Count",
-                                                                                               "format" : "guint8" },
-                                                                                             { "name"          : "Unique ID",
-                                                                                               "format"        : "array",
-                                                                                               "fixed-size"    : "16",
-                                                                                               "array-element" : { "format": "guint8" } },
-                                                                                             { "name"   : "Build ID",
-                                                                                               "format" : "string" } ] } } ] },
-                     "prerequisites" : [ { "common-ref" : "Success" } ] } ] },
+                   { "name"               : "List",
+                     "id"                 : "0x01",
+                     "type"               : "TLV",
+                     "since"              : "1.0",
+                     "format"             : "array",
+                     "size-prefix-format" : "guint8",
+                     "array-element"      : { "name"     : "Image",
+                                              "format"   : "struct",
+                                              "contents" : [ { "name"          : "Type",
+                                                               "format"        : "guint8",
+                                                               "public-format" : "QmiDmsFirmwareImageType" },
+                                                             { "name"   : "Maximum Images",
+                                                               "format" : "guint8" },
+                                                             { "name"   : "Index Of Running Image",
+                                                               "format" : "guint8" },
+                                                             { "name"               : "Sublist",
+                                                               "format"             : "array",
+                                                               "size-prefix-format" : "guint8",
+                                                               "array-element"      : { "name"     : "Sublist Element",
+                                                                                        "format"   : "struct",
+                                                                                        "contents" : [ { "name"   : "Storage Index",
+                                                                                                         "format" : "guint8" },
+                                                                                                       { "name"   : "Failure Count",
+                                                                                                         "format" : "guint8" },
+                                                                                                       { "name"          : "Unique ID",
+                                                                                                         "format"        : "array",
+                                                                                                         "fixed-size"    : "16",
+                                                                                                         "array-element" : { "format": "guint8" } },
+                                                                                                       { "name"   : "Build ID",
+                                                                                                         "format" : "string" } ] } } ] },
+                     "prerequisites"      : [ { "common-ref" : "Success" } ] } ] },
 
   // *********************************************************************************
   {  "name"    : "Delete Stored Image",
      "service" : "DMS",
      "id"      : "0x004A",
      "since"   : "1.0",
-     "input"   : [ { "name"      : "Image",
+     "input"   : [ { "name"      : "Image Details",
                      "id"        : "0x01",
                      "type"      : "TLV",
-                     "since"     : "1.0",
-                     "format"    : "struct",
+                     "since"     : "1.32",
+                     "format"    : "sequence",
                      "contents"  : [ { "name"          : "Type",
                                        "format"        : "guint8",
                                        "public-format" : "QmiDmsFirmwareImageType" },
      "service" : "DMS",
      "id"      : "0x004C",
      "since"   : "1.0",
-     "input"   : [ { "name"      : "Image",
+     "input"   : [ { "name"      : "Image Details",
                      "id"        : "0x01",
                      "type"      : "TLV",
-                     "since"     : "1.0",
-                     "format"    : "struct",
+                     "since"     : "1.32",
+                     "format"    : "sequence",
                      "contents"  : [ { "name"          : "Type",
                                        "format"        : "guint8",
                                        "public-format" : "QmiDmsFirmwareImageType" },
                       "format"        : "guint32",
                       "public-format" : "QmiDmsMacType" } ],
      "output"  : [  { "common-ref" : "Operation Result" },
-                    { "name"          : "MAC Address",
-                      "id"            : "0x10",
-                      "type"          : "TLV",
-                      "since"         : "1.26",
-                      "format"        : "array",
-                      "array-element" : { "format": "guint8" },
-                      "prerequisites": [ { "common-ref" : "Success" } ] } ] },
+                    { "name"               : "MAC Address",
+                      "id"                 : "0x10",
+                      "type"               : "TLV",
+                      "since"              : "1.26",
+                      "format"             : "array",
+                      "size-prefix-format" : "guint8",
+                      "array-element"      : { "format": "guint8" },
+                      "prerequisites"      : [ { "common-ref" : "Success" } ] } ] },
 
   // *********************************************************************************
   {  "name"    : "Get Supported Messages",
                      "format"        : "guint8",
                      "public-format" : "QmiDmsSwiUsbComposition",
                      "prerequisites" : [ { "common-ref" : "Success" } ] },
-                   { "name"          : "Supported",
-                     "id"            : "0x11",
-                     "type"          : "TLV",
-                     "since"         : "1.20",
-                     "format"        : "array",
-                     "array-element" : { "format"        : "guint8",
-                                         "public-format" : "QmiDmsSwiUsbComposition" },
-                     "prerequisites" : [ { "common-ref" : "Success" } ] } ] },
+                   { "name"               : "Supported",
+                     "id"                 : "0x11",
+                     "type"               : "TLV",
+                     "since"              : "1.20",
+                     "format"             : "array",
+                     "size-prefix-format" : "guint8",
+                     "array-element"      : { "format"        : "guint8",
+                                              "public-format" : "QmiDmsSwiUsbComposition" },
+                     "prerequisites"      : [ { "common-ref" : "Success" } ] } ] },
 
   // *********************************************************************************
   {  "name"    : "Swi Set USB Composition",
                      "type"          : "TLV",
                      "since"         : "1.28.6",
                      "format"        : "guint8" } ],
-     "output"  : [ { "common-ref" : "Operation Result" } ] }
+     "output"  : [ { "common-ref" : "Operation Result" } ] },
 
+  // *********************************************************************************
+  {  "name"    : "Foxconn Set FCC Authentication v2",
+     "type"    : "Message",
+     "service" : "DMS",
+     "id"      : "0x5571",
+     // this vendor id number just needs to be different to any other one
+     // defined in other messages; in this case both are foxconn messages, so
+     // we +1 the foxconn vid. A better solution would be to rename this field
+     // to something like "unique-id" and forget about defining any vendor id
+     // there.
+     "vendor"  : "0x0490",
+     "since"   : "1.32",
+     "input"   : [ { "name"          : "Magic String",
+                     "id"            : "0x01",
+                     "type"          : "TLV",
+                     "since"         : "1.32",
+                     "format"        : "string" },
+                   { "name"          : "Magic Number",
+                     "id"            : "0x02",
+                     "type"          : "TLV",
+                     "since"         : "1.32",
+                     "format"        : "guint8",
+                     "prerequisites" : "0x01-first" } ],
+     "output"  : [ { "common-ref" : "Operation Result" } ] }
 ]