blob: 13f03c5eea875d0b0ad5927dfce1dd2715508304 [file] [log] [blame]
Ilya Matyukhin45856012020-06-23 01:20:24 -07001/*
2 * Copyright 2020 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.hardware.biometrics.fingerprint@2.3;
18
19import @2.2::IBiometricsFingerprint;
20
21/**
22 * The interface for biometric fingerprint authentication.
23 */
24interface IBiometricsFingerprint extends @2.2::IBiometricsFingerprint {
Ilya Matyukhin134ace02020-06-26 10:47:46 -070025 /**
26 * Returns whether the fingerprint sensor is an under-display fingerprint
27 * sensor.
28 * @param sensorId the unique sensor ID for which the operation should be
29 * performed.
30 * @return isUdfps indicating whether the specified sensor is an
31 * under-display fingerprint sensor.
32 */
33 isUdfps(uint32_t sensorId) generates (bool isUdfps);
Ilya Matyukhin45856012020-06-23 01:20:24 -070034
Ilya Matyukhin134ace02020-06-26 10:47:46 -070035 /**
36 * Notifies about a touch occurring within the under-display fingerprint
37 * sensor area.
38 *
39 * It it assumed that the device can only have one active under-display
40 * fingerprint sensor at a time.
41 *
42 * If multiple fingers are detected within the sensor area, only the
43 * chronologically first event will be reported.
44 *
45 * @param x The screen x-coordinate of the center of the touch contact area, in
46 * display pixels.
47 * @param y The screen y-coordinate of the center of the touch contact area, in
48 * display pixels.
49 * @param minor The length of the minor axis of an ellipse that describes the
50 * touch area, in display pixels.
51 * @param major The length of the major axis of an ellipse that describes the
52 * touch area, in display pixels.
53 */
54 onFingerDown(uint32_t x, uint32_t y, float minor, float major);
55
56 /**
57 * Notifies about a finger leaving the under-display fingerprint sensor area.
58 *
59 * It it assumed that the device can only have one active under-display
60 * fingerprint sensor at a time.
61 *
62 * If multiple fingers have left the sensor area, only the finger which
63 * previously caused a "finger down" event will be reported.
64 */
65 onFingerUp();
Ilya Matyukhin45856012020-06-23 01:20:24 -070066};