Zephyr API Documentation 4.0.0-rc2
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
input_kbd_matrix.h
Go to the documentation of this file.
1/*
2 * Copyright 2023 Google LLC
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7#ifndef ZEPHYR_INCLUDE_INPUT_KBD_MATRIX_H_
8#define ZEPHYR_INCLUDE_INPUT_KBD_MATRIX_H_
9
17#include <zephyr/device.h>
18#include <zephyr/kernel.h>
19#include <zephyr/pm/device.h>
20#include <zephyr/sys/atomic.h>
21#include <zephyr/sys/util.h>
22#include <zephyr/sys_clock.h>
23#include <zephyr/toolchain.h>
24
26#define INPUT_KBD_MATRIX_COLUMN_DRIVE_NONE -1
27
29#define INPUT_KBD_MATRIX_COLUMN_DRIVE_ALL -2
30
32#define INPUT_KBD_MATRIX_SCAN_OCURRENCES 30U
33
35#if CONFIG_INPUT_KBD_MATRIX_16_BIT_ROW
36typedef uint16_t kbd_row_t;
37#define PRIkbdrow "04" PRIx16
38#else
40#define PRIkbdrow "02" PRIx8
41#endif
42
43#if defined(CONFIG_INPUT_KBD_ACTUAL_KEY_MASK_DYNAMIC) || defined(__DOXYGEN__)
44#define INPUT_KBD_ACTUAL_KEY_MASK_CONST
64 uint8_t row, uint8_t col, bool enabled);
65#else
66#define INPUT_KBD_ACTUAL_KEY_MASK_CONST const
67#endif
68
70#define INPUT_KBD_MATRIX_ROW_BITS NUM_BITS(kbd_row_t)
71
86 void (*drive_column)(const struct device *dev, int col);
92 kbd_row_t (*read_row)(const struct device *dev);
103 void (*set_detect_mode)(const struct device *dev, bool enabled);
104};
105
130
131#define INPUT_KBD_MATRIX_DATA_NAME(node_id, name) \
132 _CONCAT(__input_kbd_matrix_, \
133 _CONCAT(name, DEVICE_DT_NAME_GET(node_id)))
134
139#define INPUT_KBD_MATRIX_DT_DEFINE_ROW_COL(node_id, _row_size, _col_size) \
140 BUILD_ASSERT(IN_RANGE(_row_size, 1, INPUT_KBD_MATRIX_ROW_BITS), "invalid row-size"); \
141 BUILD_ASSERT(IN_RANGE(_col_size, 1, UINT8_MAX), "invalid col-size"); \
142 IF_ENABLED(DT_NODE_HAS_PROP(node_id, actual_key_mask), ( \
143 BUILD_ASSERT(DT_PROP_LEN(node_id, actual_key_mask) == _col_size, \
144 "actual-key-mask size does not match the number of columns"); \
145 static INPUT_KBD_ACTUAL_KEY_MASK_CONST kbd_row_t \
146 INPUT_KBD_MATRIX_DATA_NAME(node_id, actual_key_mask)[_col_size] = \
147 DT_PROP(node_id, actual_key_mask); \
148 )) \
149 static kbd_row_t INPUT_KBD_MATRIX_DATA_NAME(node_id, stable_state)[_col_size]; \
150 static kbd_row_t INPUT_KBD_MATRIX_DATA_NAME(node_id, unstable_state)[_col_size]; \
151 static kbd_row_t INPUT_KBD_MATRIX_DATA_NAME(node_id, previous_state)[_col_size]; \
152 static kbd_row_t INPUT_KBD_MATRIX_DATA_NAME(node_id, new_state)[_col_size]; \
153 static uint8_t INPUT_KBD_MATRIX_DATA_NAME(node_id, scan_cycle_idx)[_row_size * _col_size];
154
158#define INPUT_KBD_MATRIX_DT_DEFINE(node_id) \
159 INPUT_KBD_MATRIX_DT_DEFINE_ROW_COL( \
160 node_id, DT_PROP(node_id, row_size), DT_PROP(node_id, col_size))
161
170#define INPUT_KBD_MATRIX_DT_INST_DEFINE_ROW_COL(inst, row_size, col_size) \
171 INPUT_KBD_MATRIX_DT_DEFINE_ROW_COL(DT_DRV_INST(inst), row_size, col_size)
172
178#define INPUT_KBD_MATRIX_DT_INST_DEFINE(inst) \
179 INPUT_KBD_MATRIX_DT_DEFINE(DT_DRV_INST(inst))
180
189#define INPUT_KBD_MATRIX_DT_COMMON_CONFIG_INIT_ROW_COL(node_id, _api, _row_size, _col_size) \
190 { \
191 .api = _api, \
192 .row_size = _row_size, \
193 .col_size = _col_size, \
194 .poll_period_us = DT_PROP(node_id, poll_period_ms) * USEC_PER_MSEC, \
195 .poll_timeout_ms = DT_PROP(node_id, poll_timeout_ms), \
196 .debounce_down_us = DT_PROP(node_id, debounce_down_ms) * USEC_PER_MSEC, \
197 .debounce_up_us = DT_PROP(node_id, debounce_up_ms) * USEC_PER_MSEC, \
198 .settle_time_us = DT_PROP(node_id, settle_time_us), \
199 .ghostkey_check = !DT_PROP(node_id, no_ghostkey_check), \
200 IF_ENABLED(DT_NODE_HAS_PROP(node_id, actual_key_mask), ( \
201 .actual_key_mask = INPUT_KBD_MATRIX_DATA_NAME(node_id, actual_key_mask), \
202 )) \
203 \
204 .matrix_stable_state = INPUT_KBD_MATRIX_DATA_NAME(node_id, stable_state), \
205 .matrix_unstable_state = INPUT_KBD_MATRIX_DATA_NAME(node_id, unstable_state), \
206 .matrix_previous_state = INPUT_KBD_MATRIX_DATA_NAME(node_id, previous_state), \
207 .matrix_new_state = INPUT_KBD_MATRIX_DATA_NAME(node_id, new_state), \
208 .scan_cycle_idx = INPUT_KBD_MATRIX_DATA_NAME(node_id, scan_cycle_idx), \
209 }
210
217#define INPUT_KBD_MATRIX_DT_COMMON_CONFIG_INIT(node_id, api) \
218 INPUT_KBD_MATRIX_DT_COMMON_CONFIG_INIT_ROW_COL( \
219 node_id, api, DT_PROP(node_id, row_size), DT_PROP(node_id, col_size))
220
230#define INPUT_KBD_MATRIX_DT_INST_COMMON_CONFIG_INIT_ROW_COL(inst, api, row_size, col_size) \
231 INPUT_KBD_MATRIX_DT_COMMON_CONFIG_INIT_ROW_COL(DT_DRV_INST(inst), api, row_size, col_size)
232
239#define INPUT_KBD_MATRIX_DT_INST_COMMON_CONFIG_INIT(inst, api) \
240 INPUT_KBD_MATRIX_DT_COMMON_CONFIG_INIT(DT_DRV_INST(inst), api)
241
248 /* Track previous cycles, used for debouncing. */
251
252 struct k_sem poll_lock;
253#ifdef CONFIG_PM_DEVICE
254 atomic_t suspended;
255#endif
256
258
260 CONFIG_INPUT_KBD_MATRIX_THREAD_STACK_SIZE);
261};
262
269#define INPUT_KBD_STRUCT_CHECK(config, data) \
270 BUILD_ASSERT(offsetof(config, common) == 0, \
271 "struct input_kbd_matrix_common_config must be placed first"); \
272 BUILD_ASSERT(offsetof(data, common) == 0, \
273 "struct input_kbd_matrix_common_data must be placed first")
274
283void input_kbd_matrix_poll_start(const struct device *dev);
284
285#if defined(CONFIG_INPUT_KBD_DRIVE_COLUMN_HOOK) || defined(__DOXYGEN__)
298void input_kbd_matrix_drive_column_hook(const struct device *dev, int col);
299#endif
300
312
313#ifdef CONFIG_PM_DEVICE
323int input_kbd_matrix_pm_action(const struct device *dev,
324 enum pm_device_action action);
325#endif
326
329#endif /* ZEPHYR_INCLUDE_INPUT_KBD_MATRIX_H_ */
long atomic_t
Definition atomic_types.h:15
void input_kbd_matrix_drive_column_hook(const struct device *dev, int col)
Drive column hook.
#define INPUT_KBD_MATRIX_SCAN_OCURRENCES
Number of tracked scan cycles.
Definition input_kbd_matrix.h:32
int input_kbd_matrix_common_init(const struct device *dev)
Common function to initialize a keyboard matrix device at init time.
int input_kbd_matrix_actual_key_mask_set(const struct device *dev, uint8_t row, uint8_t col, bool enabled)
Enables or disables a specific row, column combination in the actual key mask.
uint8_t kbd_row_t
Row entry data type.
Definition input_kbd_matrix.h:39
#define INPUT_KBD_ACTUAL_KEY_MASK_CONST
Definition input_kbd_matrix.h:44
void input_kbd_matrix_poll_start(const struct device *dev)
Start scanning the keyboard matrix.
pm_device_action
Device PM actions.
Definition device.h:90
Public kernel APIs.
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
Runtime device structure (in ROM) per driver instance.
Definition device.h:412
Keyboard matrix internal APIs.
Definition input_kbd_matrix.h:75
void(* set_detect_mode)(const struct device *dev, bool enabled)
Request to put the matrix in detection mode.
Definition input_kbd_matrix.h:103
kbd_row_t(* read_row)(const struct device *dev)
Read the matrix row.
Definition input_kbd_matrix.h:92
void(* drive_column)(const struct device *dev, int col)
Request to drive a specific column.
Definition input_kbd_matrix.h:86
Common keyboard matrix config.
Definition input_kbd_matrix.h:111
uint32_t debounce_down_us
Definition input_kbd_matrix.h:117
uint8_t * scan_cycle_idx
Definition input_kbd_matrix.h:128
uint32_t settle_time_us
Definition input_kbd_matrix.h:119
bool ghostkey_check
Definition input_kbd_matrix.h:120
uint32_t poll_period_us
Definition input_kbd_matrix.h:115
kbd_row_t * matrix_previous_state
Definition input_kbd_matrix.h:126
kbd_row_t * matrix_unstable_state
Definition input_kbd_matrix.h:125
uint32_t debounce_up_us
Definition input_kbd_matrix.h:118
kbd_row_t * matrix_new_state
Definition input_kbd_matrix.h:127
uint32_t poll_timeout_ms
Definition input_kbd_matrix.h:116
kbd_row_t * matrix_stable_state
Definition input_kbd_matrix.h:124
kbd_row_t * actual_key_mask
Definition input_kbd_matrix.h:121
const struct input_kbd_matrix_api * api
Definition input_kbd_matrix.h:112
uint8_t col_size
Definition input_kbd_matrix.h:114
uint8_t row_size
Definition input_kbd_matrix.h:113
Common keyboard matrix data.
Definition input_kbd_matrix.h:247
struct k_thread thread
Definition input_kbd_matrix.h:257
uint8_t scan_cycles_idx
Definition input_kbd_matrix.h:250
uint32_t scan_clk_cycle[30U]
Definition input_kbd_matrix.h:249
K_KERNEL_STACK_MEMBER(thread_stack, CONFIG_INPUT_KBD_MATRIX_THREAD_STACK_SIZE)
struct k_sem poll_lock
Definition input_kbd_matrix.h:252
Thread Structure.
Definition thread.h:259
Misc utilities.
Variables needed for system clock.
Macros to abstract toolchain specific capabilities.