596ed3e9930b563dd6048bfce1feb24e8156efc2
[project/uqmi.git] / data / qmi-service-uim.json
1
2 [
3 // *********************************************************************************
4 { "name" : "UIM",
5 "type" : "Service" },
6
7 // *********************************************************************************
8 { "name" : "QMI Client UIM",
9 "type" : "Client" },
10
11 // *********************************************************************************
12 { "name" : "QMI Message UIM",
13 "type" : "Message-ID-Enum" },
14
15 // *********************************************************************************
16 { "name" : "Reset",
17 "type" : "Message",
18 "service" : "UIM",
19 "id" : "0x0000",
20 "version" : "1.0",
21 "output" : [ { "common-ref" : "Operation Result" } ] },
22
23 // *********************************************************************************
24 { "name" : "Read Transparent",
25 "type" : "Message",
26 "service" : "UIM",
27 "id" : "0x0020",
28 "version" : "1.0",
29 "input" : [ { "name" : "Session Information",
30 "id" : "0x01",
31 "mandatory" : "yes",
32 "type" : "TLV",
33 "format" : "sequence",
34 "contents" : [ { "name" : "Session Type",
35 "format" : "guint8",
36 "public-format" : "QmiUimSessionType" },
37 { "name" : "Application Identifier",
38 "format" : "string" } ] },
39 { "name" : "File",
40 "id" : "0x02",
41 "mandatory" : "yes",
42 "type" : "TLV",
43 "format" : "sequence",
44 "contents" : [ { "name" : "File ID",
45 "format" : "guint16" },
46 { "name" : "File Path",
47 "format" : "array",
48 "array-element" : { "format" : "guint8" } } ] },
49 { "name" : "Read Information",
50 "id" : "0x03",
51 "mandatory" : "yes",
52 "type" : "TLV",
53 "format" : "sequence",
54 "contents" : [ { "name" : "Offset",
55 "format" : "guint16" },
56 { "name" : "Length",
57 "format" : "guint16" } ] },
58 { "name" : "Response In Indication Token",
59 "id" : "0x10",
60 "mandatory" : "no",
61 "type" : "TLV",
62 "format" : "guint32" },
63 { "name" : "Encrypt Data",
64 "id" : "0x11",
65 "mandatory" : "no",
66 "type" : "TLV",
67 "format" : "guint8",
68 "public-format" : "gboolean" } ],
69 "output" : [ { "common-ref" : "Operation Result" },
70 { "name" : "Card result",
71 "id" : "0x10",
72 "mandatory" : "no",
73 "type" : "TLV",
74 "format" : "sequence",
75 "contents" : [ { "name" : "SW1",
76 "format" : "guint8" },
77 { "name" : "SW2",
78 "format" : "guint8" } ] },
79 { "name" : "Read result",
80 "id" : "0x11",
81 "mandatory" : "no",
82 "type" : "TLV",
83 "format" : "array",
84 "size-prefix-format" : "guint16",
85 "array-element" : { "format" : "guint8" },
86 "prerequisites" : [ { "common-ref" : "Success" } ] },
87 { "name" : "Response In Indication Token",
88 "id" : "0x12",
89 "mandatory" : "no",
90 "type" : "TLV",
91 "format" : "guint32",
92 "prerequisites" : [ { "common-ref" : "Success" } ] },
93 { "name" : "Encrypted Data",
94 "id" : "0x13",
95 "mandatory" : "no",
96 "type" : "TLV",
97 "format" : "guint8",
98 "public-format" : "gboolean",
99 "prerequisites" : [ { "common-ref" : "Success" } ] } ] },
100
101 // *********************************************************************************
102 { "name" : "Read Record",
103 "type" : "Message",
104 "service" : "UIM",
105 "id" : "0x0021",
106 "version" : "1.0",
107 "input" : [ { "name" : "Session Information",
108 "id" : "0x01",
109 "mandatory" : "yes",
110 "type" : "TLV",
111 "format" : "sequence",
112 "contents" : [ { "name" : "Session Type",
113 "format" : "guint8",
114 "public-format" : "QmiUimSessionType" },
115 { "name" : "Application Identifier",
116 "format" : "string" } ] },
117 { "name" : "File",
118 "id" : "0x02",
119 "mandatory" : "yes",
120 "type" : "TLV",
121 "format" : "sequence",
122 "contents" : [ { "name" : "File ID",
123 "format" : "guint16" },
124 { "name" : "File Path",
125 "format" : "array",
126 "array-element" : { "format" : "guint8" } } ] },
127 { "name" : "Record",
128 "id" : "0x03",
129 "mandatory" : "yes",
130 "type" : "TLV",
131 "format" : "sequence",
132 "contents" : [ { "name" : "Record Number",
133 "format" : "guint16" },
134 { "name" : "Record Length",
135 "format" : "guint16" } ] },
136 { "name" : "Last Record",
137 "id" : "0x10",
138 "mandatory" : "no",
139 "type" : "TLV",
140 "format" : "guint16" },
141 { "name" : "Response In Indication Token",
142 "id" : "0x11",
143 "mandatory" : "no",
144 "type" : "TLV",
145 "format" : "guint32" } ],
146 "output" : [ { "common-ref" : "Operation Result" },
147 { "name" : "Card result",
148 "id" : "0x10",
149 "mandatory" : "no",
150 "type" : "TLV",
151 "format" : "sequence",
152 "contents" : [ { "name" : "SW1",
153 "format" : "guint8" },
154 { "name" : "SW2",
155 "format" : "guint8" } ] },
156 { "name" : "Read Result",
157 "id" : "0x11",
158 "mandatory" : "no",
159 "type" : "TLV",
160 "format" : "array",
161 "size-prefix-format" : "guint16",
162 "array-element" : { "format" : "guint8" },
163 "prerequisites" : [ { "common-ref" : "Success" } ] },
164 { "name" : "Additional Read Result",
165 "id" : "0x12",
166 "mandatory" : "no",
167 "type" : "TLV",
168 "format" : "array",
169 "size-prefix-format" : "guint16",
170 "array-element" : { "format" : "guint8" },
171 "prerequisites" : [ { "common-ref" : "Success" } ] },
172 { "name" : "Response In Indication Token",
173 "id" : "0x13",
174 "mandatory" : "no",
175 "type" : "TLV",
176 "format" : "guint32",
177 "prerequisites" : [ { "common-ref" : "Success" } ] } ] },
178
179 // *********************************************************************************
180 { "name" : "Get File Attributes",
181 "type" : "Message",
182 "service" : "UIM",
183 "id" : "0x0024",
184 "version" : "1.0",
185 "input" : [ { "name" : "Session Information",
186 "id" : "0x01",
187 "mandatory" : "yes",
188 "type" : "TLV",
189 "format" : "sequence",
190 "contents" : [ { "name" : "Session Type",
191 "format" : "guint8",
192 "public-format" : "QmiUimSessionType" },
193 { "name" : "Application Identifier",
194 "format" : "string" } ] },
195 { "name" : "File",
196 "id" : "0x02",
197 "mandatory" : "yes",
198 "type" : "TLV",
199 "format" : "sequence",
200 "contents" : [ { "name" : "File ID",
201 "format" : "guint16" },
202 { "name" : "File Path",
203 "format" : "array",
204 "array-element" : { "format" : "guint8" } } ] },
205 { "name" : "Response In Indication Token",
206 "id" : "0x10",
207 "mandatory" : "no",
208 "type" : "TLV",
209 "format" : "guint32" } ],
210 "output" : [ { "common-ref" : "Operation Result" },
211 { "name" : "Card result",
212 "id" : "0x10",
213 "mandatory" : "no",
214 "type" : "TLV",
215 "format" : "sequence",
216 "contents" : [ { "name" : "SW1",
217 "format" : "guint8" },
218 { "name" : "SW2",
219 "format" : "guint8" } ] },
220 { "name" : "File Attributes",
221 "id" : "0x11",
222 "mandatory" : "no",
223 "type" : "TLV",
224 "format" : "sequence",
225 "contents" : [ { "name" : "File Size",
226 "format" : "guint16" },
227 { "name" : "File ID",
228 "format" : "guint16" },
229 { "name" : "File Type",
230 "format" : "guint8",
231 "public-format" : "QmiUimFileType" },
232 { "name" : "Record Size",
233 "format" : "guint16" },
234 { "name" : "Record Count",
235 "format" : "guint16" },
236 { "name" : "Read Security Attributes Logic",
237 "format" : "guint8",
238 "public-format" : "QmiUimSecurityAttributeLogic" },
239 { "name" : "Read Security Attributes",
240 "format" : "guint16",
241 "public-format" : "QmiUimSecurityAttribute" },
242 { "name" : "Write Security Attributes Logic",
243 "format" : "guint8",
244 "public-format" : "QmiUimSecurityAttributeLogic" },
245 { "name" : "Write Security Attributes",
246 "format" : "guint16",
247 "public-format" : "QmiUimSecurityAttribute" },
248 { "name" : "Increase Security Attributes Logic",
249 "format" : "guint8",
250 "public-format" : "QmiUimSecurityAttributeLogic" },
251 { "name" : "Increase Security Attributes",
252 "format" : "guint16",
253 "public-format" : "QmiUimSecurityAttribute" },
254 { "name" : "Deactivate Security Attributes Logic",
255 "format" : "guint8",
256 "public-format" : "QmiUimSecurityAttributeLogic" },
257 { "name" : "Deactivate Security Attributes",
258 "format" : "guint16",
259 "public-format" : "QmiUimSecurityAttribute" },
260 { "name" : "Activate Security Attributes Logic",
261 "format" : "guint8",
262 "public-format" : "QmiUimSecurityAttributeLogic" },
263 { "name" : "Activate Security Attributes",
264 "format" : "guint16",
265 "public-format" : "QmiUimSecurityAttribute" },
266 { "name" : "Raw Data",
267 "format" : "array",
268 "size-prefix-format" : "guint16",
269 "array-element" : { "format" : "guint8" } } ],
270 "prerequisites" : [ { "common-ref" : "Success" } ] },
271 { "name" : "Response In Indication Token",
272 "id" : "0x12",
273 "mandatory" : "no",
274 "type" : "TLV",
275 "format" : "guint32",
276 "prerequisites" : [ { "common-ref" : "Success" } ] } ] },
277
278 // *********************************************************************************
279 { "name" : "Get Card Status",
280 "type" : "Message",
281 "service" : "UIM",
282 "id" : "0x002F",
283 "version" : "1.0",
284 "output" : [ { "common-ref" : "Operation Result" },
285 { "name" : "Card Status",
286 "id" : "0x10",
287 "mandatory" : "no",
288 "type" : "TLV",
289 "format" : "sequence",
290 "contents" : [ { "name" : "Index GW Primary",
291 "format" : "guint16" },
292 { "name" : "Index 1x Primary",
293 "format" : "guint16" },
294 { "name" : "Index GW Secondary ",
295 "format" : "guint16" },
296 { "name" : "Index 1x Secondary",
297 "format" : "guint16" },
298 { "name" : "Cards",
299 "format" : "array",
300 "size-prefix-format" : "guint8",
301 "array-element" : { "name" : "Element",
302 "format" : "struct",
303 "contents" : [ { "name" : "Card State",
304 "format" : "guint8",
305 "public-format" : "QmiUimCardState" },
306 { "name" : "UPIN State",
307 "format" : "guint8",
308 "public-format" : "QmiUimPinState" },
309 { "name" : "UPIN Retries",
310 "format" : "guint8" },
311 { "name" : "UPUK Retries",
312 "format" : "guint8" },
313 { "name" : "Error code",
314 "format" : "guint8",
315 "public-format" : "QmiUimCardError" },
316 { "name" : "Applications",
317 "format" : "array",
318 "size-prefix-format" : "guint8",
319 "array-element" : { "name" : "Element",
320 "format" : "struct",
321 "contents" : [ { "name" : "Type",
322 "format" : "guint8",
323 "public-format" : "QmiUimCardApplicationType" },
324 { "name" : "State",
325 "format" : "guint8",
326 "public-format" : "QmiUimCardApplicationState" },
327 { "name" : "Personalization State",
328 "format" : "guint8",
329 "public-format" : "QmiUimCardApplicationPersonalizationState" },
330 { "name" : "Personalization Feature",
331 "format" : "guint8",
332 "public-format" : "QmiUimCardApplicationPersonalizationFeature" },
333 { "name" : "Personalization Retries",
334 "format" : "guint8" },
335 { "name" : "Personalization Unblock Retries",
336 "format" : "guint8" },
337 { "name" : "Application Identifier Value",
338 "format" : "array",
339 "size-prefix-format" : "guint8",
340 "array-element" : { "format" : "guint8" } },
341 { "name" : "UPIN replaces PIN1",
342 "format" : "guint8",
343 "public-format" : "gboolean" },
344 { "name" : "PIN1 State",
345 "format" : "guint8",
346 "public-format" : "QmiUimPinState" },
347 { "name" : "PIN1 Retries",
348 "format" : "guint8" },
349 { "name" : "PUK1 Retries",
350 "format" : "guint8" },
351 { "name" : "PIN2 State",
352 "format" : "guint8",
353 "public-format" : "QmiUimPinState" },
354 { "name" : "PIN2 Retries",
355 "format" : "guint8" },
356 { "name" : "PUK2 Retries",
357 "format" : "guint8" } ] } } ] } } ] } ] }
358
359 ]