1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
/* Copyright 2021 The Chromium OS Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
/* Fingerprint sensor interface */
#ifndef __CROS_EC_FPSENSOR_FPC_H
#define __CROS_EC_FPSENSOR_FPC_H
#include <stdint.h>
extern struct fp_sensor_interface fp_driver_fpc;
/* Initialize the connected sensor hardware and put it in a low power mode. */
int fp_sensor_init_fpc(void);
/* De-initialize the sensor hardware. */
int fp_sensor_deinit_fpc(void);
/*
* Fill the 'ec_response_fp_info' buffer with the sensor information
* as required by the EC_CMD_FP_INFO host command.
*
* Put both the static information and the ones read from the sensor at runtime.
*/
int fp_sensor_get_info_fpc(struct ec_response_fp_info *resp);
/*
* Put the sensor in its lowest power state.
*
* fp_sensor_configure_detect needs to be called to restore finger detection
* functionality.
*/
void fp_sensor_low_power_fpc(void);
/*
* Configure finger detection.
*
* Send the settings to the sensor, so it is properly configured to detect
* the presence of a finger.
*/
void fp_sensor_configure_detect(void);
/*
* Returns the status of the finger on the sensor.
* (assumes fp_sensor_configure_detect was called before)
*/
enum finger_state fp_sensor_finger_status(void);
/*
* Acquires a fingerprint image with specific capture mode.
*
* Same as the fp_sensor_acquire_image function above,
* excepted 'mode' can be set to one of the FP_CAPTURE_ constants
* to get a specific image type (e.g. a pattern) rather than the default one.
*/
int fp_sensor_acquire_image_with_mode(uint8_t *image_data, int mode);
/*
* Adds fingerprint image to the current enrollment session.
*
* @return a negative value on error or one of the following codes:
* - EC_MKBP_FP_ERR_ENROLL_OK when image was successfully enrolled
* - EC_MKBP_FP_ERR_ENROLL_IMMOBILE when image added, but user should be
* advised to move finger
* - EC_MKBP_FP_ERR_ENROLL_LOW_QUALITY when image could not be used due to low
* image quality
* - EC_MKBP_FP_ERR_ENROLL_LOW_COVERAGE when image could not be used due to
* finger covering too little area of the sensor
*/
int fp_finger_enroll_fpc(uint8_t *image, int *completion);
/*
* Compares given finger image against enrolled templates.
*
* The matching algorithm can update the template with additional biometric data
* from the image, if it chooses to do so.
*
* @param templ a pointer to the array of template buffers.
* @param templ_count the number of buffers in the array of templates.
* @param image the buffer containing the finger image
* @param match_index index of the matched finger in the template array if any.
* @param update_bitmap contains one bit per template, the bit is set if the
* match has updated the given template.
* @return negative value on error, else one of the following code :
* - EC_MKBP_FP_ERR_MATCH_NO on non-match
* - EC_MKBP_FP_ERR_MATCH_YES for match when template was not updated with
* new data
* - EC_MKBP_FP_ERR_MATCH_YES_UPDATED for match when template was updated
* - EC_MKBP_FP_ERR_MATCH_YES_UPDATE_FAILED match, but update failed (not saved)
* - EC_MKBP_FP_ERR_MATCH_LOW_QUALITY when matching could not be performed due
* to low image quality
* - EC_MKBP_FP_ERR_MATCH_LOW_COVERAGE when matching could not be performed
* due to finger covering too little area of the sensor
*/
int fp_finger_match_fpc(void *templ, uint32_t templ_count, uint8_t *image,
int32_t *match_index, uint32_t *update_bitmap);
/*
* Start a finger enrollment session.
*
* @return 0 on success or a negative error code.
*/
int fp_enrollment_begin_fpc(void);
/*
* Generate a template from the finger whose enrollment has just being
* completed.
*
* @param templ the buffer which will receive the template.
* templ can be set to NULL to abort the current enrollment process.
*
* @return 0 on success or a negative error code.
*/
int fp_enrollment_finish_fpc(void *templ);
/**
* Runs a test for defective pixels.
*
* Should be triggered periodically by the client. The maintenance command can
* take several hundred milliseconds to run.
*
* @return EC_ERROR_HW_INTERNAL on error (such as finger on sensor)
* @return EC_SUCCESS on success
*/
int fp_maintenance_fpc(void);
#endif /* __CROS_EC_FPSENSOR_FPC_H */
|
