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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
|
/*
* Copyright (c) 2020 Peter Johanson <peter@peterjohanson.com>
*
* SPDX-License-Identifier: Apache-2.0
*/
#define DT_DRV_COMPAT gpio_kscan
#include <device.h>
#include <drivers/kscan.h>
#include <drivers/gpio.h>
#include <logging/log.h>
LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL);
#define MATRIX_NODE_ID DT_DRV_INST(0)
#define MATRIX_ROWS DT_PROP_LEN(MATRIX_NODE_ID, row_gpios)
#define MATRIX_COLS DT_PROP_LEN(MATRIX_NODE_ID, col_gpios)
#if DT_ENUM_IDX(MATRIX_NODE_ID, diode_direction) == 0
#define SCAN_ROW_TO_COLUMN
#else
#define SCAN_COL_TO_ROW
#endif
struct kscan_gpio_item_config
{
char *label;
gpio_pin_t pin;
gpio_flags_t flags;
};
struct kscan_gpio_config
{
u8_t debounce_period;
struct kscan_gpio_item_config rows[MATRIX_ROWS];
struct kscan_gpio_item_config cols[MATRIX_COLS];
};
struct kscan_gpio_data
{
kscan_callback_t callback;
#if DT_PROP(MATRIX_NODE_ID, debounce_id) == 0
struct k_work work;
#else
struct k_delayed_work work;
#endif
bool matrix_state[MATRIX_ROWS][MATRIX_COLS];
struct device *rows[MATRIX_ROWS];
struct device *cols[MATRIX_COLS];
struct device *dev;
};
struct kscan_gpio_irq_callback
{
#if DT_PROP(MATRIX_NODE_ID, debounce_id) == 0
struct k_work *work;
#else
struct k_delayed_work *work;
#endif
struct gpio_callback callback;
};
static int kscan_gpio_config_interrupts(struct device **devices,
const struct kscan_gpio_item_config *configs,
size_t len, gpio_flags_t flags)
{
for (int i = 0; i < len; i++)
{
struct device *dev = devices[i];
const struct kscan_gpio_item_config *cfg = &configs[i];
int err = gpio_pin_interrupt_configure(dev, cfg->pin, flags);
if (err)
{
LOG_ERR("Unable to enable matrix GPIO interrupt");
return err;
}
}
return 0;
}
#ifdef SCAN_ROW_TO_COLUMN
static struct kscan_gpio_irq_callback irq_callbacks[MATRIX_COLS];
static int kscan_gpio_enable_interrupts(struct device *dev)
{
struct kscan_gpio_data *data = dev->driver_data;
const struct kscan_gpio_config *cfg = dev->config_info;
return kscan_gpio_config_interrupts(
data->cols, cfg->cols, MATRIX_COLS,
GPIO_INT_DEBOUNCE | GPIO_INT_EDGE_BOTH);
}
static int kscan_gpio_disable_interrupts(struct device *dev)
{
struct kscan_gpio_data *data = dev->driver_data;
const struct kscan_gpio_config *cfg = dev->config_info;
return kscan_gpio_config_interrupts(
data->cols, cfg->cols, MATRIX_COLS,
GPIO_INT_DISABLE);
}
static void kscan_gpio_set_row_state(struct device *dev, int value)
{
struct kscan_gpio_data *data = dev->driver_data;
const struct kscan_gpio_config *cfg = dev->config_info;
for (int r = 0; r < MATRIX_ROWS; r++)
{
struct device *row = data->rows[r];
const struct kscan_gpio_item_config *row_cfg = &cfg->rows[r];
gpio_pin_set(row, row_cfg->pin, value);
}
}
static int kscan_gpio_read(struct device *dev)
{
struct kscan_gpio_data *data = dev->driver_data;
const struct kscan_gpio_config *cfg = dev->config_info;
static bool read_state[MATRIX_ROWS][MATRIX_COLS];
LOG_DBG("Scanning the matrix for updated state");
/* Disable our interrupts temporarily while we scan, to avoid */
/* re-entry while we iterate columns and set them active one by one */
/* to get pressed state for each matrix cell. */
kscan_gpio_disable_interrupts(dev);
kscan_gpio_set_row_state(dev, 0);
for (int r = 0; r < MATRIX_ROWS; r++)
{
struct device *row = data->rows[r];
const struct kscan_gpio_item_config *row_cfg = &cfg->rows[r];
gpio_pin_set(row, row_cfg->pin, 1);
for (int c = 0; c < MATRIX_COLS; c++)
{
struct device *col = data->cols[c];
const struct kscan_gpio_item_config *col_cfg = &cfg->cols[c];
read_state[r][c] =
gpio_pin_get(col, col_cfg->pin) > 0;
}
gpio_pin_set(row, row_cfg->pin, 0);
}
/* Set all our outputs as active again, then re-enable interrupts, */
/* so we can trigger interrupts again for future press/release */
kscan_gpio_set_row_state(dev, 1);
kscan_gpio_enable_interrupts(dev);
for (int r = 0; r < MATRIX_ROWS; r++)
{
for (int c = 0; c < MATRIX_COLS; c++)
{
bool pressed = read_state[r][c];
if (pressed != data->matrix_state[r][c])
{
LOG_DBG("Sending event at %d,%d state %s",
r, c, (pressed ? "on" : "off"));
data->matrix_state[r][c] = pressed;
data->callback(dev, r, c, pressed);
}
}
}
return 0;
}
#else
static struct kscan_gpio_irq_callback irq_callbacks[MATRIX_ROWS];
static int kscan_gpio_enable_interrupts(struct device *dev)
{
struct kscan_gpio_data *data = dev->driver_data;
const struct kscan_gpio_config *cfg = dev->config_info;
return kscan_gpio_config_interrupts(data->rows, cfg->rows, MATRIX_ROWS,
GPIO_INT_DEBOUNCE | GPIO_INT_EDGE_BOTH);
}
static int kscan_gpio_disable_interrupts(struct device *dev)
{
struct kscan_gpio_data *data = dev->driver_data;
const struct kscan_gpio_config *cfg = dev->config_info;
return kscan_gpio_config_interrupts(data->rows, cfg->rows, MATRIX_ROWS,
GPIO_INT_DISABLE);
}
static void kscan_gpio_set_column_state(struct device *dev, int value)
{
struct kscan_gpio_data *data = dev->driver_data;
const struct kscan_gpio_config *cfg = dev->config_info;
for (int c = 0; c < MATRIX_COLS; c++)
{
struct device *col = data->cols[c];
const struct kscan_gpio_item_config *col_cfg = &cfg->cols[c];
gpio_pin_set(col, col_cfg->pin, value);
}
}
static int kscan_gpio_read(struct device *dev)
{
struct kscan_gpio_data *data = dev->driver_data;
const struct kscan_gpio_config *cfg = dev->config_info;
static bool read_state[MATRIX_ROWS][MATRIX_COLS];
LOG_DBG("Scanning the matrix for updated state");
/* Disable our interrupts temporarily while we scan, to avoid */
/* re-entry while we iterate columns and set them active one by one */
/* to get pressed state for each matrix cell. */
kscan_gpio_disable_interrupts(dev);
kscan_gpio_set_column_state(dev, 0);
for (int c = 0; c < MATRIX_COLS; c++)
{
struct device *col = data->cols[c];
const struct kscan_gpio_item_config *col_cfg = &cfg->cols[c];
gpio_pin_set(col, col_cfg->pin, 1);
for (int r = 0; r < MATRIX_ROWS; r++)
{
struct device *row = data->rows[r];
const struct kscan_gpio_item_config *row_cfg = &cfg->rows[r];
read_state[r][c] =
gpio_pin_get(row, row_cfg->pin) > 0;
}
gpio_pin_set(col, col_cfg->pin, 0);
}
/* Set all our outputs as active again, then re-enable interrupts, */
/* so we can trigger interrupts again for future press/release */
kscan_gpio_set_column_state(dev, 1);
kscan_gpio_enable_interrupts(dev);
for (int r = 0; r < MATRIX_ROWS; r++)
{
for (int c = 0; c < MATRIX_COLS; c++)
{
bool pressed = read_state[r][c];
if (pressed != data->matrix_state[r][c])
{
LOG_DBG("Sending event at %d,%d state %s",
r, c, (pressed ? "on" : "off"));
data->matrix_state[r][c] = pressed;
data->callback(dev, r, c, pressed);
}
}
}
return 0;
}
#endif
static void kscan_gpio_irq_callback_handler(struct device *dev,
struct gpio_callback *cb, gpio_port_pins_t pin)
{
struct kscan_gpio_irq_callback *data =
CONTAINER_OF(cb, struct kscan_gpio_irq_callback, callback);
#if DT_PROP(MATRIX_NODE_ID, debounce_id) == 0
k_work_submit(data->work);
#else
k_delayed_work_cancel(data->work);
k_delayed_work_submit(data->work,
K_MSEC(DT_PROP(MATRIX_NODE_ID, debounce_id)));
#endif
}
static void kscan_gpio_work_handler(struct k_work *work)
{
struct kscan_gpio_data *data =
CONTAINER_OF(work, struct kscan_gpio_data, work);
kscan_gpio_read(data->dev);
}
static int kscan_gpio_configure(struct device *dev, kscan_callback_t callback)
{
struct kscan_gpio_data *data = dev->driver_data;
if (!callback)
{
return -EINVAL;
}
data->callback = callback;
return 0;
}
static int kscan_gpio_init(struct device *dev)
{
struct kscan_gpio_data *data = dev->driver_data;
const struct kscan_gpio_config *cfg = dev->config_info;
int err;
#ifdef SCAN_ROW_TO_COLUMN
gpio_flags_t col_gpio_dir = GPIO_INPUT;
gpio_flags_t row_gpio_dir = GPIO_OUTPUT_ACTIVE;
#else
gpio_flags_t col_gpio_dir = GPIO_OUTPUT_ACTIVE;
gpio_flags_t row_gpio_dir = GPIO_INPUT;
#endif
for (int c = 0; c < MATRIX_COLS; c++)
{
const struct kscan_gpio_item_config *item_cfg = &cfg->cols[c];
data->cols[c] = device_get_binding(item_cfg->label);
if (data->cols[c] == NULL)
{
LOG_ERR("Unable to find column GPIO device\n");
return -EINVAL;
}
err = gpio_pin_configure(data->cols[c],
item_cfg->pin,
col_gpio_dir | item_cfg->flags);
if (err)
{
LOG_ERR("Unable to configure column GPIO pin");
return -EINVAL;
}
#ifdef SCAN_ROW_TO_COLUMN
irq_callbacks[c].work = &data->work;
gpio_init_callback(&irq_callbacks[c].callback,
kscan_gpio_irq_callback_handler,
BIT(item_cfg->pin));
if (gpio_add_callback(data->cols[c], &irq_callbacks[c].callback))
{
LOG_ERR("Error adding the callback to the column device");
}
#endif
}
for (int r = 0; r < MATRIX_ROWS; r++)
{
const struct kscan_gpio_item_config *item_cfg = &cfg->rows[r];
data->rows[r] = device_get_binding(item_cfg->label);
if (data->rows[r] == NULL)
{
LOG_ERR("Unable to find row GPIO device\n");
return -EINVAL;
}
int err = gpio_pin_configure(data->rows[r],
item_cfg->pin,
row_gpio_dir | item_cfg->flags);
if (err)
{
LOG_ERR("Unable to configure row GPIO pin");
return -EINVAL;
}
#ifdef SCAN_COL_TO_ROW
irq_callbacks[r].work = &data->work;
gpio_init_callback(&irq_callbacks[r].callback,
kscan_gpio_irq_callback_handler,
BIT(item_cfg->pin));
gpio_add_callback(data->rows[r], &irq_callbacks[r].callback);
#endif
}
data->dev = dev;
#if DT_PROP(MATRIX_NODE_ID, debounce_id) == 0
k_work_init(&data->work, kscan_gpio_work_handler);
#else
k_delayed_work_init(&data->work, kscan_gpio_work_handler);
#endif
return 0;
}
static const struct kscan_driver_api gpio_driver_api = {
.config = kscan_gpio_configure,
.enable_callback = kscan_gpio_enable_interrupts,
.disable_callback = kscan_gpio_disable_interrupts,
};
#define _KSCAN_GPIO_ITEM_CFG_INIT(prop, idx) \
{ \
.label = DT_GPIO_LABEL_BY_IDX(MATRIX_NODE_ID, prop, idx), \
.pin = DT_GPIO_PIN_BY_IDX(MATRIX_NODE_ID, prop, idx), \
.flags = DT_GPIO_FLAGS_BY_IDX(MATRIX_NODE_ID, prop, idx), \
}
static const struct kscan_gpio_config kscan_gpio_config = {
.rows = {
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, row_gpios, 0)
_KSCAN_GPIO_ITEM_CFG_INIT(row_gpios, 0),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, row_gpios, 1)
_KSCAN_GPIO_ITEM_CFG_INIT(row_gpios, 1),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, row_gpios, 2)
_KSCAN_GPIO_ITEM_CFG_INIT(row_gpios, 2),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, row_gpios, 3)
_KSCAN_GPIO_ITEM_CFG_INIT(row_gpios, 3),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, row_gpios, 4)
_KSCAN_GPIO_ITEM_CFG_INIT(row_gpios, 4),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, row_gpios, 5)
_KSCAN_GPIO_ITEM_CFG_INIT(row_gpios, 5),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, row_gpios, 6)
_KSCAN_GPIO_ITEM_CFG_INIT(row_gpios, 6),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, row_gpios, 7)
_KSCAN_GPIO_ITEM_CFG_INIT(row_gpios, 7),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, row_gpios, 8)
_KSCAN_GPIO_ITEM_CFG_INIT(row_gpios, 8),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, row_gpios, 9)
_KSCAN_GPIO_ITEM_CFG_INIT(row_gpios, 9),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, row_gpios, 10)
_KSCAN_GPIO_ITEM_CFG_INIT(row_gpios, 10),
#endif
},
.cols = {
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, col_gpios, 0)
_KSCAN_GPIO_ITEM_CFG_INIT(col_gpios, 0),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, col_gpios, 1)
_KSCAN_GPIO_ITEM_CFG_INIT(col_gpios, 1),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, col_gpios, 2)
_KSCAN_GPIO_ITEM_CFG_INIT(col_gpios, 2),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, col_gpios, 3)
_KSCAN_GPIO_ITEM_CFG_INIT(col_gpios, 3),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, col_gpios, 4)
_KSCAN_GPIO_ITEM_CFG_INIT(col_gpios, 4),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, col_gpios, 5)
_KSCAN_GPIO_ITEM_CFG_INIT(col_gpios, 5),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, col_gpios, 6)
_KSCAN_GPIO_ITEM_CFG_INIT(col_gpios, 6),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, col_gpios, 7)
_KSCAN_GPIO_ITEM_CFG_INIT(col_gpios, 7),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, col_gpios, 8)
_KSCAN_GPIO_ITEM_CFG_INIT(col_gpios, 8),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, col_gpios, 9)
_KSCAN_GPIO_ITEM_CFG_INIT(col_gpios, 9),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, col_gpios, 10)
_KSCAN_GPIO_ITEM_CFG_INIT(col_gpios, 10),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, col_gpios, 11)
_KSCAN_GPIO_ITEM_CFG_INIT(col_gpios, 11),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, col_gpios, 12)
_KSCAN_GPIO_ITEM_CFG_INIT(col_gpios, 12),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, col_gpios, 13)
_KSCAN_GPIO_ITEM_CFG_INIT(col_gpios, 13),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, col_gpios, 14)
_KSCAN_GPIO_ITEM_CFG_INIT(col_gpios, 14),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, col_gpios, 15)
_KSCAN_GPIO_ITEM_CFG_INIT(col_gpios, 15),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, col_gpios, 16)
_KSCAN_GPIO_ITEM_CFG_INIT(col_gpios, 16),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, col_gpios, 17)
_KSCAN_GPIO_ITEM_CFG_INIT(col_gpios, 17),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, col_gpios, 18)
_KSCAN_GPIO_ITEM_CFG_INIT(col_gpios, 18),
#endif
#if DT_PROP_HAS_IDX(MATRIX_NODE_ID, col_gpios, 19)
_KSCAN_GPIO_ITEM_CFG_INIT(col_gpios, 19),
#endif
}};
static struct kscan_gpio_data kscan_gpio_data;
DEVICE_AND_API_INIT(kscan_gpio, DT_INST_LABEL(0), kscan_gpio_init,
&kscan_gpio_data, &kscan_gpio_config,
POST_KERNEL, CONFIG_ZMK_KSCAN_INIT_PRIORITY,
&gpio_driver_api);
|
