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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
/* Copyright 2013 The ChromiumOS Authors
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
/* Keyboard scanner module for Chrome EC */
#ifndef __CROS_EC_KEYBOARD_SCAN_H
#define __CROS_EC_KEYBOARD_SCAN_H
#include "common.h"
#include "compile_time_macros.h"
#include "keyboard_config.h"
struct keyboard_scan_config {
/* Delay between setting up output and waiting for it to settle */
uint16_t output_settle_us;
/* Times for debouncing key-down and key-up */
uint16_t debounce_down_us;
uint16_t debounce_up_us;
/* Time between start of scans when in polling mode */
uint16_t scan_period_us;
/*
* Minimum time between end of one scan and start of the next one.
* This ensures keyboard scanning doesn't starve the rest of the system
* if the scan period is set too short, or if other higher-priority
* system activity is starving the keyboard scan task too.
*/
uint16_t min_post_scan_delay_us;
/* Revert to interrupt mode after no keyboard activity for this long */
uint32_t poll_timeout_us;
/* Mask with 1 bits only for keys that actually exist */
uint8_t actual_key_mask[KEYBOARD_COLS_MAX];
#ifdef CONFIG_KEYBOARD_SCAN_ADC
/* KSI threshold ADC voltage in mV */
uint16_t ksi_threshold_mv;
#endif
};
/* Boot key list. Must be in same order as enum boot_key. */
struct boot_key_entry {
uint8_t col;
uint8_t row;
};
/**
* Initializes the module.
*/
void keyboard_scan_init(void);
/**
* Return a pointer to the keyboard scan config.
*/
struct keyboard_scan_config *keyboard_scan_get_config(void);
/*
* Which is probably this.
*/
__override_proto extern struct keyboard_scan_config keyscan_config;
/* Key held down at keyboard-controlled reset boot time. */
enum boot_key {
/* No keys other than keyboard-controlled reset keys */
BOOT_KEY_NONE = 0,
BOOT_KEY_ESC = BIT(0),
BOOT_KEY_DOWN_ARROW = BIT(1),
BOOT_KEY_LEFT_SHIFT = BIT(2),
};
#if defined(HAS_TASK_KEYSCAN) && defined(CONFIG_KEYBOARD_BOOT_KEYS)
/**
* Returns mask of all the keys held down at boot time in addition to the
* keyboard-controlled reset keys. If more than one boot key is held, mask bits
* will be set for each of those keys. Since more than one bit can be set,
* caller needs to ensure that boot keys match as intended.
*
* Returns BOOT_NONE if no additional key is held or if none of the keys
* specifically checked was pressed, or reset was not caused by a
* keyboard-controlled reset or if any key *other* than boot keys, power, or
* refresh is also pressed.
*/
uint32_t keyboard_scan_get_boot_keys(void);
#else
static inline uint32_t keyboard_scan_get_boot_keys(void)
{
return BOOT_KEY_NONE;
}
#endif
/**
* Return a pointer to the current debounced keyboard matrix state, which is
* KEYBOARD_COLS_MAX bytes long.
*/
const uint8_t *keyboard_scan_get_state(void);
enum kb_scan_disable_masks {
/* Reasons why keyboard scanning should be disabled */
KB_SCAN_DISABLE_LID_CLOSED = (1 << 0),
KB_SCAN_DISABLE_POWER_BUTTON = (1 << 1),
KB_SCAN_DISABLE_LID_ANGLE = (1 << 2),
KB_SCAN_DISABLE_USB_SUSPENDED = (1 << 3),
};
#ifdef HAS_TASK_KEYSCAN
/**
* Enable/disable keyboard scanning. Scanning will be disabled if any disable
* reason bit is set. Scanning is enabled only if no disable reasons are set.
*
* @param enable Clear(=1) or set(=0) disable-bits from the mask.
* @param mask Disable reasons from kb_scan_disable_masks
*/
void keyboard_scan_enable(int enable, enum kb_scan_disable_masks mask);
/**
* Clears typematic key
*/
void clear_typematic_key(void);
#else
static inline void keyboard_scan_enable(int enable,
enum kb_scan_disable_masks mask)
{
}
#endif
#ifdef CONFIG_KEYBOARD_RUNTIME_KEYS
void set_vol_up_key(uint8_t row, uint8_t col);
#else
static inline void set_vol_up_key(uint8_t row, uint8_t col)
{
}
#endif
#ifdef CONFIG_KEYBOARD_FACTORY_TEST
/*
* Map keyboard connector pins to EC GPIO pins for factory test.
* Pins mapped to {-1, -1} are skipped.
*/
extern const int keyboard_factory_scan_pins[][2];
extern const int keyboard_factory_scan_pins_used;
#endif
#ifdef CONFIG_KEYBOARD_MULTIPLE
extern struct boot_key_entry boot_key_list[3];
struct keyboard_type {
int col_esc;
int row_esc;
int col_down;
int row_down;
int col_left_shift;
int row_left_shift;
int col_refresh;
int row_refresh;
int col_right_alt;
int row_right_alt;
int col_left_alt;
int row_left_alt;
int col_key_r;
int row_key_r;
int col_key_h;
int row_key_h;
};
extern struct keyboard_type key_typ;
#endif
#ifdef TEST_BUILD
/**
* @brief Get the value of print_state_changes
*
* @return non-zero if state change printing is enabled, zero if not.
*/
__test_only int keyboard_scan_get_print_state_changes(void);
/**
* @brief Forcibly set the value of print_state_changes
*
* @param val Value to set
*/
__test_only void keyboard_scan_set_print_state_changes(int val);
/**
* @brief Checks if keyboard scanning is currently enabled.
*
* @return int non-zero if enabled, zero otherwise.
*/
int keyboard_scan_is_enabled(void);
/**
* @brief Reset key debouncing logic
*/
void test_keyboard_scan_debounce_reset(void);
#endif /* TEST_BUILD */
#endif /* __CROS_EC_KEYBOARD_SCAN_H */
|
