13#ifndef ZEPHYR_INCLUDE_INPUT_KBD_MATRIX_H_
14#define ZEPHYR_INCLUDE_INPUT_KBD_MATRIX_H_
31#define INPUT_KBD_MATRIX_COLUMN_DRIVE_NONE -1
34#define INPUT_KBD_MATRIX_COLUMN_DRIVE_ALL -2
37#define INPUT_KBD_MATRIX_SCAN_OCURRENCES 30U
40#if CONFIG_INPUT_KBD_MATRIX_16_BIT_ROW
42#define PRIkbdrow "04" PRIx16
45#define PRIkbdrow "02" PRIx8
48#if defined(CONFIG_INPUT_KBD_ACTUAL_KEY_MASK_DYNAMIC) || defined(__DOXYGEN__)
49#define INPUT_KBD_ACTUAL_KEY_MASK_CONST
71#define INPUT_KBD_ACTUAL_KEY_MASK_CONST const
75#define INPUT_KBD_MATRIX_ROW_BITS NUM_BITS(kbd_row_t)
137#define INPUT_KBD_MATRIX_DATA_NAME(node_id, name) \
138 _CONCAT(__input_kbd_matrix_, \
139 _CONCAT(name, DEVICE_DT_NAME_GET(node_id)))
145#define INPUT_KBD_MATRIX_DT_DEFINE_ROW_COL(node_id, _row_size, _col_size) \
146 BUILD_ASSERT(IN_RANGE(_row_size, 1, INPUT_KBD_MATRIX_ROW_BITS), "invalid row-size"); \
147 BUILD_ASSERT(IN_RANGE(_col_size, 1, UINT8_MAX), "invalid col-size"); \
148 IF_ENABLED(DT_NODE_HAS_PROP(node_id, actual_key_mask), ( \
149 BUILD_ASSERT(DT_PROP_LEN(node_id, actual_key_mask) == _col_size, \
150 "actual-key-mask size does not match the number of columns"); \
151 static INPUT_KBD_ACTUAL_KEY_MASK_CONST kbd_row_t \
152 INPUT_KBD_MATRIX_DATA_NAME(node_id, actual_key_mask)[_col_size] = \
153 DT_PROP(node_id, actual_key_mask); \
155 static kbd_row_t INPUT_KBD_MATRIX_DATA_NAME(node_id, stable_state)[_col_size]; \
156 static kbd_row_t INPUT_KBD_MATRIX_DATA_NAME(node_id, unstable_state)[_col_size]; \
157 static kbd_row_t INPUT_KBD_MATRIX_DATA_NAME(node_id, previous_state)[_col_size]; \
158 static kbd_row_t INPUT_KBD_MATRIX_DATA_NAME(node_id, new_state)[_col_size]; \
159 static uint8_t INPUT_KBD_MATRIX_DATA_NAME(node_id, scan_cycle_idx)[_row_size * _col_size];
164#define INPUT_KBD_MATRIX_DT_DEFINE(node_id) \
165 INPUT_KBD_MATRIX_DT_DEFINE_ROW_COL( \
166 node_id, DT_PROP(node_id, row_size), DT_PROP(node_id, col_size))
176#define INPUT_KBD_MATRIX_DT_INST_DEFINE_ROW_COL(inst, row_size, col_size) \
177 INPUT_KBD_MATRIX_DT_DEFINE_ROW_COL(DT_DRV_INST(inst), row_size, col_size)
184#define INPUT_KBD_MATRIX_DT_INST_DEFINE(inst) \
185 INPUT_KBD_MATRIX_DT_DEFINE(DT_DRV_INST(inst))
195#define INPUT_KBD_MATRIX_DT_COMMON_CONFIG_INIT_ROW_COL(node_id, _api, _row_size, _col_size) \
198 .row_size = _row_size, \
199 .col_size = _col_size, \
200 .poll_period_us = DT_PROP(node_id, poll_period_ms) * USEC_PER_MSEC, \
201 .stable_poll_period_us = DT_PROP_OR(node_id, stable_poll_period_ms, \
202 DT_PROP(node_id, poll_period_ms)) * \
204 .poll_timeout_ms = DT_PROP(node_id, poll_timeout_ms), \
205 .debounce_down_us = DT_PROP(node_id, debounce_down_ms) * USEC_PER_MSEC, \
206 .debounce_up_us = DT_PROP(node_id, debounce_up_ms) * USEC_PER_MSEC, \
207 .settle_time_us = DT_PROP(node_id, settle_time_us), \
208 .ghostkey_check = !DT_PROP(node_id, no_ghostkey_check), \
209 IF_ENABLED(DT_NODE_HAS_PROP(node_id, actual_key_mask), ( \
210 .actual_key_mask = INPUT_KBD_MATRIX_DATA_NAME(node_id, actual_key_mask), \
213 .matrix_stable_state = INPUT_KBD_MATRIX_DATA_NAME(node_id, stable_state), \
214 .matrix_unstable_state = INPUT_KBD_MATRIX_DATA_NAME(node_id, unstable_state), \
215 .matrix_previous_state = INPUT_KBD_MATRIX_DATA_NAME(node_id, previous_state), \
216 .matrix_new_state = INPUT_KBD_MATRIX_DATA_NAME(node_id, new_state), \
217 .scan_cycle_idx = INPUT_KBD_MATRIX_DATA_NAME(node_id, scan_cycle_idx), \
226#define INPUT_KBD_MATRIX_DT_COMMON_CONFIG_INIT(node_id, api) \
227 INPUT_KBD_MATRIX_DT_COMMON_CONFIG_INIT_ROW_COL( \
228 node_id, api, DT_PROP(node_id, row_size), DT_PROP(node_id, col_size))
239#define INPUT_KBD_MATRIX_DT_INST_COMMON_CONFIG_INIT_ROW_COL(inst, api, row_size, col_size) \
240 INPUT_KBD_MATRIX_DT_COMMON_CONFIG_INIT_ROW_COL(DT_DRV_INST(inst), api, row_size, col_size)
248#define INPUT_KBD_MATRIX_DT_INST_COMMON_CONFIG_INIT(inst, api) \
249 INPUT_KBD_MATRIX_DT_COMMON_CONFIG_INIT(DT_DRV_INST(inst), api)
262#ifdef CONFIG_PM_DEVICE
269 CONFIG_INPUT_KBD_MATRIX_THREAD_STACK_SIZE);
278#define INPUT_KBD_STRUCT_CHECK(config, data) \
279 BUILD_ASSERT(offsetof(config, common) == 0, \
280 "struct input_kbd_matrix_common_config must be placed first"); \
281 BUILD_ASSERT(offsetof(data, common) == 0, \
282 "struct input_kbd_matrix_common_data must be placed first")
294#if defined(CONFIG_INPUT_KBD_DRIVE_COLUMN_HOOK) || defined(__DOXYGEN__)
322#ifdef CONFIG_PM_DEVICE
332int input_kbd_matrix_pm_action(
const struct device *dev,
long atomic_t
Definition atomic_types.h:15
pm_device_action
Device PM actions.
Definition device.h:144
__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:510
Semaphore structure.
Definition kernel.h:3275
Thread Structure.
Definition thread.h:262