Gitiles
Code Review Sign In
review.blissroms.org / platform_hardware_interfaces / 20105c8b71859c7dc4567053b72ab4861e8a2d8a / . / biometrics / fingerprint / 2.1 / vts / BiometricsFingerprint.vts
blob: 475333ef04351885a20644b284dc264812e8ba5f [file] [log] [blame]
Nick Desaulniers20105c82017-02-06 15:13:36 -0800[diff] [blame^]1component_class: HAL_HIDL
2component_type_version: 2.1
3component_name: "IBiometricsFingerprint"
4
5package: "android.hardware.biometrics.fingerprint"
6
7import: "android.hardware.biometrics.fingerprint@2.1::IBiometricsFingerprintClientCallback"
8import: "android.hardware.biometrics.fingerprint@2.1::types"
9import: "android.hidl.base@1.0::types"
10
11interface: {
12 attribute: {
13 name: "::android::hardware::biometrics::fingerprint::V2_1::RequestStatus"
14 type: TYPE_ENUM
15 enum_value: {
16 scalar_type: "int32_t"
17
18 enumerator: "SYS_UNKNOWN"
19 scalar_value: {
20 int32_t: 1
21 }
22 enumerator: "SYS_OK"
23 scalar_value: {
24 int32_t: 0
25 }
26 enumerator: "SYS_ENOENT"
27 scalar_value: {
28 int32_t: -2
29 }
30 enumerator: "SYS_EINTR"
31 scalar_value: {
32 int32_t: -4
33 }
34 enumerator: "SYS_EIO"
35 scalar_value: {
36 int32_t: -5
37 }
38 enumerator: "SYS_EAGAIN"
39 scalar_value: {
40 int32_t: -11
41 }
42 enumerator: "SYS_ENOMEM"
43 scalar_value: {
44 int32_t: -12
45 }
46 enumerator: "SYS_EACCES"
47 scalar_value: {
48 int32_t: -13
49 }
50 enumerator: "SYS_EFAULT"
51 scalar_value: {
52 int32_t: -14
53 }
54 enumerator: "SYS_EBUSY"
55 scalar_value: {
56 int32_t: -16
57 }
58 enumerator: "SYS_EINVAL"
59 scalar_value: {
60 int32_t: -22
61 }
62 enumerator: "SYS_ENOSPC"
63 scalar_value: {
64 int32_t: -28
65 }
66 enumerator: "SYS_ETIMEDOUT"
67 scalar_value: {
68 int32_t: -110
69 }
70 }
71 }
72
73 attribute: {
74 name: "::android::hardware::biometrics::fingerprint::V2_1::FingerprintError"
75 type: TYPE_ENUM
76 enum_value: {
77 scalar_type: "int32_t"
78
79 enumerator: "ERROR_NO_ERROR"
80 scalar_value: {
81 int32_t: 0
82 }
83 enumerator: "ERROR_HW_UNAVAILABLE"
84 scalar_value: {
85 int32_t: 1
86 }
87 enumerator: "ERROR_UNABLE_TO_PROCESS"
88 scalar_value: {
89 int32_t: 2
90 }
91 enumerator: "ERROR_TIMEOUT"
92 scalar_value: {
93 int32_t: 3
94 }
95 enumerator: "ERROR_NO_SPACE"
96 scalar_value: {
97 int32_t: 4
98 }
99 enumerator: "ERROR_CANCELED"
100 scalar_value: {
101 int32_t: 5
102 }
103 enumerator: "ERROR_UNABLE_TO_REMOVE"
104 scalar_value: {
105 int32_t: 6
106 }
107 enumerator: "ERROR_LOCKOUT"
108 scalar_value: {
109 int32_t: 7
110 }
111 enumerator: "ERROR_VENDOR"
112 scalar_value: {
113 int32_t: 8
114 }
115 }
116 }
117
118 attribute: {
119 name: "::android::hardware::biometrics::fingerprint::V2_1::FingerprintAcquiredInfo"
120 type: TYPE_ENUM
121 enum_value: {
122 scalar_type: "int32_t"
123
124 enumerator: "ACQUIRED_GOOD"
125 scalar_value: {
126 int32_t: 0
127 }
128 enumerator: "ACQUIRED_PARTIAL"
129 scalar_value: {
130 int32_t: 1
131 }
132 enumerator: "ACQUIRED_INSUFFICIENT"
133 scalar_value: {
134 int32_t: 2
135 }
136 enumerator: "ACQUIRED_IMAGER_DIRTY"
137 scalar_value: {
138 int32_t: 3
139 }
140 enumerator: "ACQUIRED_TOO_SLOW"
141 scalar_value: {
142 int32_t: 4
143 }
144 enumerator: "ACQUIRED_TOO_FAST"
145 scalar_value: {
146 int32_t: 5
147 }
148 enumerator: "ACQUIRED_VENDOR"
149 scalar_value: {
150 int32_t: 6
151 }
152 }
153 }
154
155 attribute: {
156 name: "::android::hardware::biometrics::fingerprint::V2_1::FingerprintFingerId"
157 type: TYPE_STRUCT
158 struct_value: {
159 name: "gid"
160 type: TYPE_SCALAR
161 scalar_type: "uint32_t"
162 }
163 struct_value: {
164 name: "fid"
165 type: TYPE_SCALAR
166 scalar_type: "uint32_t"
167 }
168 }
169
170 attribute: {
171 name: "::android::hardware::biometrics::fingerprint::V2_1::FingerprintEnroll"
172 type: TYPE_STRUCT
173 struct_value: {
174 name: "finger"
175 type: TYPE_STRUCT
176 predefined_type: "::android::hardware::biometrics::fingerprint::V2_1::FingerprintFingerId"
177 }
178 struct_value: {
179 name: "samplesRemaining"
180 type: TYPE_SCALAR
181 scalar_type: "uint32_t"
182 }
183 struct_value: {
184 name: "msg"
185 type: TYPE_SCALAR
186 scalar_type: "uint64_t"
187 }
188 }
189
190 attribute: {
191 name: "::android::hardware::biometrics::fingerprint::V2_1::FingerprintIterator"
192 type: TYPE_STRUCT
193 struct_value: {
194 name: "finger"
195 type: TYPE_STRUCT
196 predefined_type: "::android::hardware::biometrics::fingerprint::V2_1::FingerprintFingerId"
197 }
198 struct_value: {
199 name: "remainingTemplates"
200 type: TYPE_SCALAR
201 scalar_type: "uint32_t"
202 }
203 }
204
205 attribute: {
206 name: "::android::hardware::biometrics::fingerprint::V2_1::FingerprintAcquired"
207 type: TYPE_STRUCT
208 struct_value: {
209 name: "acquiredInfo"
210 type: TYPE_ENUM
211 predefined_type: "::android::hardware::biometrics::fingerprint::V2_1::FingerprintAcquiredInfo"
212 }
213 }
214
215 attribute: {
216 name: "::android::hardware::biometrics::fingerprint::V2_1::FingerprintAuthenticated"
217 type: TYPE_STRUCT
218 struct_value: {
219 name: "finger"
220 type: TYPE_STRUCT
221 predefined_type: "::android::hardware::biometrics::fingerprint::V2_1::FingerprintFingerId"
222 }
223 struct_value: {
224 name: "hat"
225 type: TYPE_ARRAY
226 vector_size: 69
227 vector_value: {
228 type: TYPE_SCALAR
229 scalar_type: "uint8_t"
230 }
231 }
232 }
233
234 attribute: {
235 name: "::android::hardware::biometrics::fingerprint::V2_1::FingerprintMsgType"
236 type: TYPE_ENUM
237 enum_value: {
238 scalar_type: "int32_t"
239
240 enumerator: "ERROR"
241 scalar_value: {
242 int32_t: -1
243 }
244 enumerator: "ACQUIRED"
245 scalar_value: {
246 int32_t: 1
247 }
248 enumerator: "TEMPLATE_ENROLLING"
249 scalar_value: {
250 int32_t: 3
251 }
252 enumerator: "TEMPLATE_REMOVED"
253 scalar_value: {
254 int32_t: 4
255 }
256 enumerator: "AUTHENTICATED"
257 scalar_value: {
258 int32_t: 5
259 }
260 enumerator: "TEMPLATE_ENUMERATING"
261 scalar_value: {
262 int32_t: 6
263 }
264 }
265 }
266
267 attribute: {
268 name: "::android::hidl::base::V1_0::DebugInfo"
269 type: TYPE_STRUCT
270 struct_value: {
271 name: "pid"
272 type: TYPE_SCALAR
273 scalar_type: "int32_t"
274 }
275 struct_value: {
276 name: "ptr"
277 type: TYPE_SCALAR
278 scalar_type: "uint64_t"
279 }
280 }
281
282 api: {
283 name: "setNotify"
284 return_type_hidl: {
285 type: TYPE_SCALAR
286 scalar_type: "uint64_t"
287 }
288 arg: {
289 type: TYPE_HIDL_CALLBACK
290 predefined_type: "::android::hardware::biometrics::fingerprint::V2_1::IBiometricsFingerprintClientCallback"
291 }
292 callflow: {
293 next: "setActiveGroup"
294 }
295 callflow: {
296 entry: true
297 }
298 }
299
300 api: {
301 name: "preEnroll"
302 return_type_hidl: {
303 type: TYPE_SCALAR
304 scalar_type: "uint64_t"
305 }
306 callflow: {
307 next: "enroll"
308 next: "postEnroll"
309 }
310 }
311
312 api: {
313 name: "enroll"
314 return_type_hidl: {
315 type: TYPE_ENUM
316 predefined_type: "::android::hardware::biometrics::fingerprint::V2_1::RequestStatus"
317 }
318 arg: {
319 type: TYPE_ARRAY
320 vector_size: 69
321 vector_value: {
322 type: TYPE_SCALAR
323 scalar_type: "uint8_t"
324 }
325 }
326 arg: {
327 type: TYPE_SCALAR
328 scalar_type: "uint32_t"
329 }
330 arg: {
331 type: TYPE_SCALAR
332 scalar_type: "uint32_t"
333 }
334 callflow: {
335 next: "cancel"
336 next: "enroll"
337 next: "postEnroll"
338 next: "remove"
339 }
340 }
341
342 api: {
343 name: "postEnroll"
344 return_type_hidl: {
345 type: TYPE_ENUM
346 predefined_type: "::android::hardware::biometrics::fingerprint::V2_1::RequestStatus"
347 }
348 callflow: {
349 next: "authenticate"
350 next: "setActiveGroup"
351 next: "enumerate"
352 next: "remove"
353 }
354 }
355
356 api: {
357 name: "getAuthenticatorId"
358 return_type_hidl: {
359 type: TYPE_SCALAR
360 scalar_type: "uint64_t"
361 }
362 callflow: {
363 next: "authenticate"
364 }
365 }
366
367 api: {
368 name: "cancel"
369 return_type_hidl: {
370 type: TYPE_ENUM
371 predefined_type: "::android::hardware::biometrics::fingerprint::V2_1::RequestStatus"
372 }
373 callflow: {
374 next: "authenticate"
375 next: "enroll"
376 next: "enumerate"
377 next: "remove"
378 next: "setActiveGroup"
379 }
380 }
381
382 api: {
383 name: "enumerate"
384 return_type_hidl: {
385 type: TYPE_ENUM
386 predefined_type: "::android::hardware::biometrics::fingerprint::V2_1::RequestStatus"
387 }
388 callflow: {
389 next: "remove"
390 next: "enroll"
391 next: "authenticate"
392 next: "setActiveGroup"
393 }
394 }
395
396 api: {
397 name: "remove"
398 return_type_hidl: {
399 type: TYPE_ENUM
400 predefined_type: "::android::hardware::biometrics::fingerprint::V2_1::RequestStatus"
401 }
402 arg: {
403 type: TYPE_SCALAR
404 scalar_type: "uint32_t"
405 }
406 arg: {
407 type: TYPE_SCALAR
408 scalar_type: "uint32_t"
409 }
410 callflow: {
411 next: "enumerate"
412 next: "authenticate"
413 next: "cancel"
414 next: "getAuthenticatorId"
415 next: "setActiveGroup"
416 }
417 }
418
419 api: {
420 name: "setActiveGroup"
421 return_type_hidl: {
422 type: TYPE_ENUM
423 predefined_type: "::android::hardware::biometrics::fingerprint::V2_1::RequestStatus"
424 }
425 arg: {
426 type: TYPE_SCALAR
427 scalar_type: "uint32_t"
428 }
429 arg: {
430 type: TYPE_STRING
431 }
432 callflow: {
433 next: "authenticate"
434 next: "preEnroll"
435 next: "enumerate"
436 next: "remove"
437 }
438 }
439
440 api: {
441 name: "authenticate"
442 return_type_hidl: {
443 type: TYPE_ENUM
444 predefined_type: "::android::hardware::biometrics::fingerprint::V2_1::RequestStatus"
445 }
446 arg: {
447 type: TYPE_SCALAR
448 scalar_type: "uint64_t"
449 }
450 arg: {
451 type: TYPE_SCALAR
452 scalar_type: "uint32_t"
453 }
454 callflow: {
455 next: "cancel"
456 next: "preEnroll"
457 next: "remove"
458 }
459 }
460
461}