xref: /aosp_15_r20/hardware/interfaces/biometrics/fingerprint/2.1/default/BiometricsFingerprint.h (revision 4d7e907c777eeecc4c5bd7cf640a754fac206ff7)
1*4d7e907cSAndroid Build Coastguard Worker /*
2*4d7e907cSAndroid Build Coastguard Worker  * Copyright (C) 2017 The Android Open Source Project
3*4d7e907cSAndroid Build Coastguard Worker  *
4*4d7e907cSAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*4d7e907cSAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*4d7e907cSAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*4d7e907cSAndroid Build Coastguard Worker  *
8*4d7e907cSAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*4d7e907cSAndroid Build Coastguard Worker  *
10*4d7e907cSAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*4d7e907cSAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*4d7e907cSAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*4d7e907cSAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*4d7e907cSAndroid Build Coastguard Worker  * limitations under the License.
15*4d7e907cSAndroid Build Coastguard Worker  */
16*4d7e907cSAndroid Build Coastguard Worker 
17*4d7e907cSAndroid Build Coastguard Worker #ifndef ANDROID_HARDWARE_BIOMETRICS_FINGERPRINT_V2_1_BIOMETRICSFINGERPRINT_H
18*4d7e907cSAndroid Build Coastguard Worker #define ANDROID_HARDWARE_BIOMETRICS_FINGERPRINT_V2_1_BIOMETRICSFINGERPRINT_H
19*4d7e907cSAndroid Build Coastguard Worker 
20*4d7e907cSAndroid Build Coastguard Worker #include <log/log.h>
21*4d7e907cSAndroid Build Coastguard Worker #include <android/log.h>
22*4d7e907cSAndroid Build Coastguard Worker #include <hardware/hardware.h>
23*4d7e907cSAndroid Build Coastguard Worker #include <hardware/fingerprint.h>
24*4d7e907cSAndroid Build Coastguard Worker #include <hidl/MQDescriptor.h>
25*4d7e907cSAndroid Build Coastguard Worker #include <hidl/Status.h>
26*4d7e907cSAndroid Build Coastguard Worker #include <android/hardware/biometrics/fingerprint/2.1/IBiometricsFingerprint.h>
27*4d7e907cSAndroid Build Coastguard Worker 
28*4d7e907cSAndroid Build Coastguard Worker namespace android {
29*4d7e907cSAndroid Build Coastguard Worker namespace hardware {
30*4d7e907cSAndroid Build Coastguard Worker namespace biometrics {
31*4d7e907cSAndroid Build Coastguard Worker namespace fingerprint {
32*4d7e907cSAndroid Build Coastguard Worker namespace V2_1 {
33*4d7e907cSAndroid Build Coastguard Worker namespace implementation {
34*4d7e907cSAndroid Build Coastguard Worker 
35*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::biometrics::fingerprint::V2_1::IBiometricsFingerprint;
36*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::biometrics::fingerprint::V2_1::IBiometricsFingerprintClientCallback;
37*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::biometrics::fingerprint::V2_1::RequestStatus;
38*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::Return;
39*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::Void;
40*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::hidl_vec;
41*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::hidl_string;
42*4d7e907cSAndroid Build Coastguard Worker using ::android::sp;
43*4d7e907cSAndroid Build Coastguard Worker 
44*4d7e907cSAndroid Build Coastguard Worker struct BiometricsFingerprint : public IBiometricsFingerprint {
45*4d7e907cSAndroid Build Coastguard Worker public:
46*4d7e907cSAndroid Build Coastguard Worker     BiometricsFingerprint();
47*4d7e907cSAndroid Build Coastguard Worker     ~BiometricsFingerprint();
48*4d7e907cSAndroid Build Coastguard Worker 
49*4d7e907cSAndroid Build Coastguard Worker     // Method to wrap legacy HAL with BiometricsFingerprint class
50*4d7e907cSAndroid Build Coastguard Worker     static IBiometricsFingerprint* getInstance();
51*4d7e907cSAndroid Build Coastguard Worker 
52*4d7e907cSAndroid Build Coastguard Worker     // Methods from ::android::hardware::biometrics::fingerprint::V2_1::IBiometricsFingerprint follow.
53*4d7e907cSAndroid Build Coastguard Worker     Return<uint64_t> setNotify(const sp<IBiometricsFingerprintClientCallback>& clientCallback) override;
54*4d7e907cSAndroid Build Coastguard Worker     Return<uint64_t> preEnroll() override;
55*4d7e907cSAndroid Build Coastguard Worker     Return<RequestStatus> enroll(const hidl_array<uint8_t, 69>& hat, uint32_t gid, uint32_t timeoutSec) override;
56*4d7e907cSAndroid Build Coastguard Worker     Return<RequestStatus> postEnroll() override;
57*4d7e907cSAndroid Build Coastguard Worker     Return<uint64_t> getAuthenticatorId() override;
58*4d7e907cSAndroid Build Coastguard Worker     Return<RequestStatus> cancel() override;
59*4d7e907cSAndroid Build Coastguard Worker     Return<RequestStatus> enumerate() override;
60*4d7e907cSAndroid Build Coastguard Worker     Return<RequestStatus> remove(uint32_t gid, uint32_t fid) override;
61*4d7e907cSAndroid Build Coastguard Worker     Return<RequestStatus> setActiveGroup(uint32_t gid, const hidl_string& storePath) override;
62*4d7e907cSAndroid Build Coastguard Worker     Return<RequestStatus> authenticate(uint64_t operationId, uint32_t gid) override;
63*4d7e907cSAndroid Build Coastguard Worker 
64*4d7e907cSAndroid Build Coastguard Worker private:
65*4d7e907cSAndroid Build Coastguard Worker     static fingerprint_device_t* openHal();
66*4d7e907cSAndroid Build Coastguard Worker     static void notify(const fingerprint_msg_t *msg); /* Static callback for legacy HAL implementation */
67*4d7e907cSAndroid Build Coastguard Worker     static Return<RequestStatus> ErrorFilter(int32_t error);
68*4d7e907cSAndroid Build Coastguard Worker     static FingerprintError VendorErrorFilter(int32_t error, int32_t* vendorCode);
69*4d7e907cSAndroid Build Coastguard Worker     static FingerprintAcquiredInfo VendorAcquiredFilter(int32_t error, int32_t* vendorCode);
70*4d7e907cSAndroid Build Coastguard Worker     static BiometricsFingerprint* sInstance;
71*4d7e907cSAndroid Build Coastguard Worker 
72*4d7e907cSAndroid Build Coastguard Worker     std::mutex mClientCallbackMutex;
73*4d7e907cSAndroid Build Coastguard Worker     sp<IBiometricsFingerprintClientCallback> mClientCallback;
74*4d7e907cSAndroid Build Coastguard Worker     fingerprint_device_t *mDevice;
75*4d7e907cSAndroid Build Coastguard Worker };
76*4d7e907cSAndroid Build Coastguard Worker 
77*4d7e907cSAndroid Build Coastguard Worker }  // namespace implementation
78*4d7e907cSAndroid Build Coastguard Worker }  // namespace V2_1
79*4d7e907cSAndroid Build Coastguard Worker }  // namespace fingerprint
80*4d7e907cSAndroid Build Coastguard Worker }  // namespace biometrics
81*4d7e907cSAndroid Build Coastguard Worker }  // namespace hardware
82*4d7e907cSAndroid Build Coastguard Worker }  // namespace android
83*4d7e907cSAndroid Build Coastguard Worker 
84*4d7e907cSAndroid Build Coastguard Worker #endif  // ANDROID_HARDWARE_BIOMETRICS_FINGERPRINT_V2_1_BIOMETRICSFINGERPRINT_H
85