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
130
131
132
133
134
135
136
137
138
139
140
141
|
/* 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.
*/
/* ELAN Platform Abstraction Layer callbacks */
#ifndef ELAN_SENSOR_PAL_H_
#define ELAN_SENSOR_PAL_H_
/* ELAN error codes */
enum elan_error_code {
ELAN_ERROR_NONE = 0,
ELAN_ERROR_SPI = 1,
ELAN_ERROR_SCAN = 2,
ELAN_ERROR_CAL = 3,
ELAN_ERROR_DEFECT_NUM = 4,
ELAN_ERROR_DEFECT_X = 5,
ELAN_ERROR_DEFECT_Y = 6
};
/* ELAN error info */
typedef struct {
uint32_t num_defective_pixels;
uint16_t sensor_error_code;
} fp_sensor_info_t;
/**
* @brief Write fp command to the sensor
*
* @param[in] fp_cmd One byte fp command to write
*
* @return 0 on success.
* negative value on error.
*/
int elan_write_cmd(uint8_t fp_cmd);
/**
* @brief Read fp register data from the sensor
*
* @param[in] fp_cmd One byte fp command to read
* @param[out] regdata One byte data where register's data will be stored
*
* @return 0 on success.
* negative value on error.
*/
int elan_read_cmd(uint8_t fp_cmd, uint8_t *regdata);
/**
* @brief Transfers and receives SPI data.
*
* @param[in] tx The buffer to transfer
* @param[in] tx_len The length to transfer
* @param[out] rx The buffer where read data will be stored
* @param[in] rx_len The length to receive
* @return 0 on success.
* negative value on error.
*/
int elan_spi_transaction(uint8_t *tx, int tx_len, uint8_t *rx, int rx_len);
/**
* @brief Write fp register data to sensor
*
* @param[in] regaddr One byte register address to write
* @param[in] regdata Data to write to register
*
* @return 0 on success.
* negative value on error.
*/
int elan_write_register(uint8_t regaddr, uint8_t regdata);
/**
* @brief Select sensor RAM page of register
*
* @param[in] page The number of RAM page control registers
*
* @return 0 on success.
* negative value on error.
*/
int elan_write_page(uint8_t page);
/**
* @brief Write register table to fp sensor
*
* Using a table to write data to sensor register.
* This table contains multiple pairs of address and data to
* be written.
*
* @param[in] reg_table The register address to write
* @param[in] length The data to write to register
*
* @return 0 on success.
* negative value on error.
*/
int elan_write_reg_vector(const uint8_t *reg_table, int length);
/**
* Get 14bits raw image data from ELAN fingerprint sensor
*
* @param[out] short_raw The memory buffer to receive fingerprint image
* raw data, buffer length is:
* (IMAGE_WIDTH*IMAGE_HEIGHT)*sizeof(uint16_t)
*
* @return 0 on success.
* negative value on error.
*/
int raw_capture(uint16_t *short_raw);
/**
* Execute calibrate ELAN fingerprint sensor flow.
*
* @return 0 on success.
* negative value on error.
*/
int elan_execute_calibration(void);
/**
* Execute reset ELAN fingerprint sensor flow.
*/
void elan_execute_reset(void);
/**
* Runs a test for defective pixels.
*
* @param[out] fp_sensor_info Structure containing output data.
*
* @return 0 on success.
* negative value on error.
*/
int fp_sensor_maintenance(fp_sensor_info_t *fp_sensor_info);
/**
* @brief Set sensor reset state.
*
* Set sensor reset state.
*
* @param[in] state Reset state.
* true => reset sensor, i.e. low GPIO state
* false => normal operation, i.e. high GPIO state
*/
void __unused elan_sensor_set_rst(bool state);
#endif
|
