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
|
/* Copyright 2019 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.
*/
#ifndef __CROS_EC_FPC_SENSOR_SPI_H
#define __CROS_EC_FPC_SENSOR_SPI_H
/**
* @file fpc_sensor_spi.h
* @brief Driver for SPI controller.
*
* Driver for SPI controller. Intended for communication with
* fingerprint sensor.
*/
#include <stdint.h>
#include <stdbool.h>
typedef bool (*fpc_wfi_check_t)(void);
/**
* @brief Writes and reads SPI data.
*
* Writes data to SPI interface and reads data from SPI interface, with chip
* select control. The caller is blocked until the operation is complete. By use
* of the chip select control parameter a single SPI transaction can be split in
* several calls.
*
* @param[in] write Data to write. Must not be NULL if size > 0.
* @param[in,out] read Receive data buffer. The caller is responsible for
* allocating buffer. NULL => response is thrown away.
* @param[in] size Number of bytes to write (same as bytes received).
* 0 => Only chip select control.
* @param[in] leave_cs_asserted True => chip select is left in asserted
* state.
* False => chip select is de-asserted before
* return.
* @return ::fpc_bep_result_t
*/
int __unused fpc_sensor_spi_write_read(uint8_t *write, uint8_t *read,
size_t size, bool leave_cs_asserted);
/**
* @brief Read sensor IRQ status.
*
* Returns status of the sensor IRQ.
*
* @return true if the sensor IRQ is currently active, otherwise false.
*/
bool __unused fpc_sensor_spi_check_irq(void);
/**
* @brief Read sensor IRQ status and then set status to false.
*
* Returns status of the sensor IRQ and sets the status to false.
*
* @return true if the sensor IRQ has been active, otherwise false.
*/
bool __unused fpc_sensor_spi_read_irq(void);
/**
* @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 fpc_sensor_spi_reset(bool state);
/**
* @brief Initializes SPI controller.
*
* @param[in] speed_hz Maximum SPI clock speed according to sensor HW spec
* (unit Hz).
*
*/
void __unused fpc_sensor_spi_init(uint32_t speed_hz);
/**
* @brief Set system in WFI mode while waiting sensor IRQ.
*
* @note This mode only requires the system to be able to wake up from Sensor
* IRQ pin, all other peripheral can be turned off.
*
* @note The system time must be adjusted upon WFI return.
*
* @param[in] timeout_ms Time in ms before waking up, 0 if no timeout.
* @param[in] enter_wfi Function pointer to check WFI entry.
* @param[in] enter_wfi_mode Bool that is used when comparing the value returned
* by enter_wfi.
* @return FPC_RESULT_OK, FPC_RESULT_TIMEOUT
*/
int __unused fpc_sensor_wfi(uint16_t timeout_ms, fpc_wfi_check_t enter_wfi,
bool enter_wfi_mode);
#endif /* __CROS_EC_FPC_SENSOR_SPI_H */
|
