464 lines
17 KiB
C
464 lines
17 KiB
C
/*
|
|
* Copyright (c) 2020-2021 The ZMK Contributors
|
|
*
|
|
* SPDX-License-Identifier: MIT
|
|
*/
|
|
|
|
#include "debounce.h"
|
|
|
|
#include <device.h>
|
|
#include <devicetree.h>
|
|
#include <drivers/gpio.h>
|
|
#include <drivers/kscan.h>
|
|
#include <kernel.h>
|
|
#include <logging/log.h>
|
|
#include <sys/__assert.h>
|
|
#include <sys/util.h>
|
|
|
|
LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL);
|
|
|
|
#define DT_DRV_COMPAT zmk_kscan_gpio_matrix
|
|
|
|
#define INST_DIODE_DIR(n) DT_ENUM_IDX(DT_DRV_INST(n), diode_direction)
|
|
#define COND_DIODE_DIR(n, row2col_code, col2row_code) \
|
|
COND_CODE_0(INST_DIODE_DIR(n), row2col_code, col2row_code)
|
|
|
|
#define INST_ROWS_LEN(n) DT_INST_PROP_LEN(n, row_gpios)
|
|
#define INST_COLS_LEN(n) DT_INST_PROP_LEN(n, col_gpios)
|
|
#define INST_MATRIX_LEN(n) (INST_ROWS_LEN(n) * INST_COLS_LEN(n))
|
|
#define INST_INPUTS_LEN(n) COND_DIODE_DIR(n, (INST_COLS_LEN(n)), (INST_ROWS_LEN(n)))
|
|
|
|
#if CONFIG_ZMK_KSCAN_DEBOUNCE_PRESS_MS >= 0
|
|
#define INST_DEBOUNCE_PRESS_MS(n) CONFIG_ZMK_KSCAN_DEBOUNCE_PRESS_MS
|
|
#else
|
|
#define INST_DEBOUNCE_PRESS_MS(n) \
|
|
DT_INST_PROP_OR(n, debounce_period, DT_INST_PROP(n, debounce_press_ms))
|
|
#endif
|
|
|
|
#if CONFIG_ZMK_KSCAN_DEBOUNCE_RELEASE_MS >= 0
|
|
#define INST_DEBOUNCE_RELEASE_MS(n) CONFIG_ZMK_KSCAN_DEBOUNCE_RELEASE_MS
|
|
#else
|
|
#define INST_DEBOUNCE_RELEASE_MS(n) \
|
|
DT_INST_PROP_OR(n, debounce_period, DT_INST_PROP(n, debounce_release_ms))
|
|
#endif
|
|
|
|
#define USE_POLLING IS_ENABLED(CONFIG_ZMK_KSCAN_MATRIX_POLLING)
|
|
#define USE_INTERRUPTS (!USE_POLLING)
|
|
|
|
#define COND_INTERRUPTS(code) COND_CODE_1(CONFIG_ZMK_KSCAN_MATRIX_POLLING, (), code)
|
|
#define COND_POLL_OR_INTERRUPTS(pollcode, intcode) \
|
|
COND_CODE_1(CONFIG_ZMK_KSCAN_MATRIX_POLLING, pollcode, intcode)
|
|
|
|
#define KSCAN_GPIO_ROW_CFG_INIT(idx, inst_idx) \
|
|
GPIO_DT_SPEC_GET_BY_IDX(DT_DRV_INST(inst_idx), row_gpios, idx),
|
|
#define KSCAN_GPIO_COL_CFG_INIT(idx, inst_idx) \
|
|
GPIO_DT_SPEC_GET_BY_IDX(DT_DRV_INST(inst_idx), col_gpios, idx),
|
|
|
|
enum kscan_diode_direction {
|
|
KSCAN_ROW2COL,
|
|
KSCAN_COL2ROW,
|
|
};
|
|
|
|
struct kscan_matrix_irq_callback {
|
|
const struct device *dev;
|
|
struct gpio_callback callback;
|
|
};
|
|
|
|
struct kscan_matrix_data {
|
|
const struct device *dev;
|
|
kscan_callback_t callback;
|
|
struct k_work_delayable work;
|
|
#if USE_INTERRUPTS
|
|
/** Array of length config->inputs.len */
|
|
struct kscan_matrix_irq_callback *irqs;
|
|
#endif
|
|
/** Timestamp of the current or scheduled scan. */
|
|
int64_t scan_time;
|
|
/**
|
|
* Current state of the matrix as a flattened 2D array of length
|
|
* (config->rows.len * config->cols.len)
|
|
*/
|
|
struct debounce_state *matrix_state;
|
|
};
|
|
|
|
struct kscan_gpio_list {
|
|
const struct gpio_dt_spec *gpios;
|
|
size_t len;
|
|
};
|
|
|
|
/** Define a kscan_gpio_list from a compile-time GPIO array. */
|
|
#define KSCAN_GPIO_LIST(gpio_array) \
|
|
((struct kscan_gpio_list){.gpios = gpio_array, .len = ARRAY_SIZE(gpio_array)})
|
|
|
|
struct kscan_matrix_config {
|
|
struct kscan_gpio_list rows;
|
|
struct kscan_gpio_list cols;
|
|
struct kscan_gpio_list inputs;
|
|
struct kscan_gpio_list outputs;
|
|
struct debounce_config debounce_config;
|
|
int32_t debounce_scan_period_ms;
|
|
int32_t poll_period_ms;
|
|
enum kscan_diode_direction diode_direction;
|
|
};
|
|
|
|
/**
|
|
* Get the index into a matrix state array from a row and column.
|
|
*/
|
|
static int state_index_rc(const struct kscan_matrix_config *config, const int row, const int col) {
|
|
__ASSERT(row < config->rows.len, "Invalid row %i", row);
|
|
__ASSERT(col < config->cols.len, "Invalid column %i", col);
|
|
|
|
return (col * config->rows.len) + row;
|
|
}
|
|
|
|
/**
|
|
* Get the index into a matrix state array from input/output pin indices.
|
|
*/
|
|
static int state_index_io(const struct kscan_matrix_config *config, const int input_idx,
|
|
const int output_idx) {
|
|
return (config->diode_direction == KSCAN_ROW2COL)
|
|
? state_index_rc(config, output_idx, input_idx)
|
|
: state_index_rc(config, input_idx, output_idx);
|
|
}
|
|
|
|
static int kscan_matrix_set_all_outputs(const struct device *dev, const int value) {
|
|
const struct kscan_matrix_config *config = dev->config;
|
|
|
|
for (int i = 0; i < config->outputs.len; i++) {
|
|
const struct gpio_dt_spec *gpio = &config->outputs.gpios[i];
|
|
|
|
int err = gpio_pin_set_dt(gpio, value);
|
|
if (err) {
|
|
LOG_ERR("Failed to set output %i to %i: %i", i, value, err);
|
|
return err;
|
|
}
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
#if USE_INTERRUPTS
|
|
static int kscan_matrix_interrupt_configure(const struct device *dev, const gpio_flags_t flags) {
|
|
const struct kscan_matrix_config *config = dev->config;
|
|
|
|
for (int i = 0; i < config->inputs.len; i++) {
|
|
const struct gpio_dt_spec *gpio = &config->inputs.gpios[i];
|
|
|
|
int err = gpio_pin_interrupt_configure_dt(gpio, flags);
|
|
if (err) {
|
|
LOG_ERR("Unable to configure interrupt for pin %u on %s", gpio->pin, gpio->port->name);
|
|
return err;
|
|
}
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
#endif
|
|
|
|
#if USE_INTERRUPTS
|
|
static int kscan_matrix_interrupt_enable(const struct device *dev) {
|
|
int err = kscan_matrix_interrupt_configure(dev, GPIO_INT_LEVEL_ACTIVE);
|
|
if (err) {
|
|
return err;
|
|
}
|
|
|
|
// While interrupts are enabled, set all outputs active so a pressed key
|
|
// will trigger an interrupt.
|
|
return kscan_matrix_set_all_outputs(dev, 1);
|
|
}
|
|
#endif
|
|
|
|
#if USE_INTERRUPTS
|
|
static int kscan_matrix_interrupt_disable(const struct device *dev) {
|
|
int err = kscan_matrix_interrupt_configure(dev, GPIO_INT_DISABLE);
|
|
if (err) {
|
|
return err;
|
|
}
|
|
|
|
// While interrupts are disabled, set all outputs inactive so
|
|
// kscan_matrix_read() can scan them one by one.
|
|
return kscan_matrix_set_all_outputs(dev, 0);
|
|
}
|
|
#endif
|
|
|
|
#if USE_INTERRUPTS
|
|
static void kscan_matrix_irq_callback_handler(const struct device *port, struct gpio_callback *cb,
|
|
const gpio_port_pins_t pin) {
|
|
struct kscan_matrix_irq_callback *irq_data =
|
|
CONTAINER_OF(cb, struct kscan_matrix_irq_callback, callback);
|
|
struct kscan_matrix_data *data = irq_data->dev->data;
|
|
|
|
// Disable our interrupts temporarily to avoid re-entry while we scan.
|
|
kscan_matrix_interrupt_disable(data->dev);
|
|
|
|
data->scan_time = k_uptime_get();
|
|
|
|
k_work_reschedule(&data->work, K_NO_WAIT);
|
|
}
|
|
#endif
|
|
|
|
static void kscan_matrix_read_continue(const struct device *dev) {
|
|
const struct kscan_matrix_config *config = dev->config;
|
|
struct kscan_matrix_data *data = dev->data;
|
|
|
|
data->scan_time += config->debounce_scan_period_ms;
|
|
|
|
k_work_reschedule(&data->work, K_TIMEOUT_ABS_MS(data->scan_time));
|
|
}
|
|
|
|
static void kscan_matrix_read_end(const struct device *dev) {
|
|
#if USE_INTERRUPTS
|
|
// Return to waiting for an interrupt.
|
|
kscan_matrix_interrupt_enable(dev);
|
|
#else
|
|
struct kscan_matrix_data *data = dev->data;
|
|
const struct kscan_matrix_config *config = dev->config;
|
|
|
|
data->scan_time += config->poll_period_ms;
|
|
|
|
// Return to polling slowly.
|
|
k_work_reschedule(&data->work, K_TIMEOUT_ABS_MS(data->scan_time));
|
|
#endif
|
|
}
|
|
|
|
static int kscan_matrix_read(const struct device *dev) {
|
|
struct kscan_matrix_data *data = dev->data;
|
|
const struct kscan_matrix_config *config = dev->config;
|
|
|
|
// Scan the matrix.
|
|
for (int o = 0; o < config->outputs.len; o++) {
|
|
const struct gpio_dt_spec *out_gpio = &config->outputs.gpios[o];
|
|
|
|
int err = gpio_pin_set_dt(out_gpio, 1);
|
|
if (err) {
|
|
LOG_ERR("Failed to set output %i active: %i", o, err);
|
|
return err;
|
|
}
|
|
|
|
for (int i = 0; i < config->inputs.len; i++) {
|
|
const struct gpio_dt_spec *in_gpio = &config->inputs.gpios[i];
|
|
|
|
const int index = state_index_io(config, i, o);
|
|
const bool active = gpio_pin_get_dt(in_gpio);
|
|
|
|
debounce_update(&data->matrix_state[index], active, config->debounce_scan_period_ms,
|
|
&config->debounce_config);
|
|
}
|
|
|
|
err = gpio_pin_set_dt(out_gpio, 0);
|
|
if (err) {
|
|
LOG_ERR("Failed to set output %i inactive: %i", o, err);
|
|
return err;
|
|
}
|
|
}
|
|
|
|
// Process the new state.
|
|
bool continue_scan = false;
|
|
|
|
for (int r = 0; r < config->rows.len; r++) {
|
|
for (int c = 0; c < config->cols.len; c++) {
|
|
const int index = state_index_rc(config, r, c);
|
|
struct debounce_state *state = &data->matrix_state[index];
|
|
|
|
if (debounce_get_changed(state)) {
|
|
const bool pressed = debounce_is_pressed(state);
|
|
|
|
LOG_DBG("Sending event at %i,%i state %s", r, c, pressed ? "on" : "off");
|
|
data->callback(dev, r, c, pressed);
|
|
}
|
|
|
|
continue_scan = continue_scan || debounce_is_active(state);
|
|
}
|
|
}
|
|
|
|
if (continue_scan) {
|
|
// At least one key is pressed or the debouncer has not yet decided if
|
|
// it is pressed. Poll quickly until everything is released.
|
|
kscan_matrix_read_continue(dev);
|
|
} else {
|
|
// All keys are released. Return to normal.
|
|
kscan_matrix_read_end(dev);
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
static void kscan_matrix_work_handler(struct k_work *work) {
|
|
struct k_work_delayable *dwork = CONTAINER_OF(work, struct k_work_delayable, work);
|
|
struct kscan_matrix_data *data = CONTAINER_OF(dwork, struct kscan_matrix_data, work);
|
|
kscan_matrix_read(data->dev);
|
|
}
|
|
|
|
static int kscan_matrix_configure(const struct device *dev, const kscan_callback_t callback) {
|
|
struct kscan_matrix_data *data = dev->data;
|
|
|
|
if (!callback) {
|
|
return -EINVAL;
|
|
}
|
|
|
|
data->callback = callback;
|
|
return 0;
|
|
}
|
|
|
|
static int kscan_matrix_enable(const struct device *dev) {
|
|
struct kscan_matrix_data *data = dev->data;
|
|
|
|
data->scan_time = k_uptime_get();
|
|
|
|
// Read will automatically start interrupts/polling once done.
|
|
return kscan_matrix_read(dev);
|
|
}
|
|
|
|
static int kscan_matrix_disable(const struct device *dev) {
|
|
struct kscan_matrix_data *data = dev->data;
|
|
|
|
k_work_cancel_delayable(&data->work);
|
|
|
|
#if USE_INTERRUPTS
|
|
return kscan_matrix_interrupt_disable(dev);
|
|
#else
|
|
return 0;
|
|
#endif
|
|
}
|
|
|
|
static int kscan_matrix_init_input_inst(const struct device *dev, const struct gpio_dt_spec *gpio,
|
|
const int index) {
|
|
if (!device_is_ready(gpio->port)) {
|
|
LOG_ERR("GPIO is not ready: %s", gpio->port->name);
|
|
return -ENODEV;
|
|
}
|
|
|
|
int err = gpio_pin_configure_dt(gpio, GPIO_INPUT);
|
|
if (err) {
|
|
LOG_ERR("Unable to configure pin %u on %s for input", gpio->pin, gpio->port->name);
|
|
return err;
|
|
}
|
|
|
|
LOG_DBG("Configured pin %u on %s for input", gpio->pin, gpio->port->name);
|
|
|
|
#if USE_INTERRUPTS
|
|
struct kscan_matrix_data *data = dev->data;
|
|
struct kscan_matrix_irq_callback *irq = &data->irqs[index];
|
|
|
|
irq->dev = dev;
|
|
gpio_init_callback(&irq->callback, kscan_matrix_irq_callback_handler, BIT(gpio->pin));
|
|
err = gpio_add_callback(gpio->port, &irq->callback);
|
|
if (err) {
|
|
LOG_ERR("Error adding the callback to the input device: %i", err);
|
|
return err;
|
|
}
|
|
#endif
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int kscan_matrix_init_inputs(const struct device *dev) {
|
|
const struct kscan_matrix_config *config = dev->config;
|
|
|
|
for (int i = 0; i < config->inputs.len; i++) {
|
|
const struct gpio_dt_spec *gpio = &config->inputs.gpios[i];
|
|
int err = kscan_matrix_init_input_inst(dev, gpio, i);
|
|
if (err) {
|
|
return err;
|
|
}
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int kscan_matrix_init_output_inst(const struct device *dev,
|
|
const struct gpio_dt_spec *gpio) {
|
|
if (!device_is_ready(gpio->port)) {
|
|
LOG_ERR("GPIO is not ready: %s", gpio->port->name);
|
|
return -ENODEV;
|
|
}
|
|
|
|
int err = gpio_pin_configure_dt(gpio, GPIO_OUTPUT);
|
|
if (err) {
|
|
LOG_ERR("Unable to configure pin %u on %s for output", gpio->pin, gpio->port->name);
|
|
return err;
|
|
}
|
|
|
|
LOG_DBG("Configured pin %u on %s for output", gpio->pin, gpio->port->name);
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int kscan_matrix_init_outputs(const struct device *dev) {
|
|
const struct kscan_matrix_config *config = dev->config;
|
|
|
|
for (int i = 0; i < config->outputs.len; i++) {
|
|
const struct gpio_dt_spec *gpio = &config->outputs.gpios[i];
|
|
int err = kscan_matrix_init_output_inst(dev, gpio);
|
|
if (err) {
|
|
return err;
|
|
}
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int kscan_matrix_init(const struct device *dev) {
|
|
struct kscan_matrix_data *data = dev->data;
|
|
|
|
data->dev = dev;
|
|
|
|
kscan_matrix_init_inputs(dev);
|
|
kscan_matrix_init_outputs(dev);
|
|
kscan_matrix_set_all_outputs(dev, 0);
|
|
|
|
k_work_init_delayable(&data->work, kscan_matrix_work_handler);
|
|
|
|
return 0;
|
|
}
|
|
|
|
static const struct kscan_driver_api kscan_matrix_api = {
|
|
.config = kscan_matrix_configure,
|
|
.enable_callback = kscan_matrix_enable,
|
|
.disable_callback = kscan_matrix_disable,
|
|
};
|
|
|
|
#define KSCAN_MATRIX_INIT(index) \
|
|
BUILD_ASSERT(INST_DEBOUNCE_PRESS_MS(index) <= DEBOUNCE_COUNTER_MAX, \
|
|
"ZMK_KSCAN_DEBOUNCE_PRESS_MS or debounce-press-ms is too large"); \
|
|
BUILD_ASSERT(INST_DEBOUNCE_RELEASE_MS(index) <= DEBOUNCE_COUNTER_MAX, \
|
|
"ZMK_KSCAN_DEBOUNCE_RELEASE_MS or debounce-release-ms is too large"); \
|
|
\
|
|
static const struct gpio_dt_spec kscan_matrix_rows_##index[] = { \
|
|
UTIL_LISTIFY(INST_ROWS_LEN(index), KSCAN_GPIO_ROW_CFG_INIT, index)}; \
|
|
\
|
|
static const struct gpio_dt_spec kscan_matrix_cols_##index[] = { \
|
|
UTIL_LISTIFY(INST_COLS_LEN(index), KSCAN_GPIO_COL_CFG_INIT, index)}; \
|
|
\
|
|
static struct debounce_state kscan_matrix_state_##index[INST_MATRIX_LEN(index)]; \
|
|
\
|
|
COND_INTERRUPTS((static struct kscan_matrix_irq_callback \
|
|
kscan_matrix_irqs_##index[INST_INPUTS_LEN(index)];)) \
|
|
\
|
|
static struct kscan_matrix_data kscan_matrix_data_##index = { \
|
|
.matrix_state = kscan_matrix_state_##index, \
|
|
COND_INTERRUPTS((.irqs = kscan_matrix_irqs_##index, ))}; \
|
|
\
|
|
static struct kscan_matrix_config kscan_matrix_config_##index = { \
|
|
.rows = KSCAN_GPIO_LIST(kscan_matrix_rows_##index), \
|
|
.cols = KSCAN_GPIO_LIST(kscan_matrix_cols_##index), \
|
|
.inputs = KSCAN_GPIO_LIST( \
|
|
COND_DIODE_DIR(index, (kscan_matrix_cols_##index), (kscan_matrix_rows_##index))), \
|
|
.outputs = KSCAN_GPIO_LIST( \
|
|
COND_DIODE_DIR(index, (kscan_matrix_rows_##index), (kscan_matrix_cols_##index))), \
|
|
.debounce_config = \
|
|
{ \
|
|
.debounce_press_ms = INST_DEBOUNCE_PRESS_MS(index), \
|
|
.debounce_release_ms = INST_DEBOUNCE_RELEASE_MS(index), \
|
|
}, \
|
|
.debounce_scan_period_ms = DT_INST_PROP(index, debounce_scan_period_ms), \
|
|
.poll_period_ms = DT_INST_PROP(index, poll_period_ms), \
|
|
.diode_direction = INST_DIODE_DIR(index), \
|
|
}; \
|
|
\
|
|
DEVICE_DT_INST_DEFINE(index, &kscan_matrix_init, NULL, &kscan_matrix_data_##index, \
|
|
&kscan_matrix_config_##index, APPLICATION, \
|
|
CONFIG_APPLICATION_INIT_PRIORITY, &kscan_matrix_api);
|
|
|
|
DT_INST_FOREACH_STATUS_OKAY(KSCAN_MATRIX_INIT);
|