Loading...
1/*
2 * GPIO driven matrix keyboard driver
3 *
4 * Copyright (c) 2008 Marek Vasut <marek.vasut@gmail.com>
5 *
6 * Based on corgikbd.c
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 *
12 */
13
14#include <linux/types.h>
15#include <linux/delay.h>
16#include <linux/platform_device.h>
17#include <linux/input.h>
18#include <linux/irq.h>
19#include <linux/interrupt.h>
20#include <linux/jiffies.h>
21#include <linux/module.h>
22#include <linux/gpio.h>
23#include <linux/input/matrix_keypad.h>
24#include <linux/slab.h>
25#include <linux/of.h>
26#include <linux/of_gpio.h>
27#include <linux/of_platform.h>
28
29struct matrix_keypad {
30 const struct matrix_keypad_platform_data *pdata;
31 struct input_dev *input_dev;
32 unsigned int row_shift;
33
34 DECLARE_BITMAP(disabled_gpios, MATRIX_MAX_ROWS);
35
36 uint32_t last_key_state[MATRIX_MAX_COLS];
37 struct delayed_work work;
38 spinlock_t lock;
39 bool scan_pending;
40 bool stopped;
41 bool gpio_all_disabled;
42};
43
44/*
45 * NOTE: normally the GPIO has to be put into HiZ when de-activated to cause
46 * minmal side effect when scanning other columns, here it is configured to
47 * be input, and it should work on most platforms.
48 */
49static void __activate_col(const struct matrix_keypad_platform_data *pdata,
50 int col, bool on)
51{
52 bool level_on = !pdata->active_low;
53
54 if (on) {
55 gpio_direction_output(pdata->col_gpios[col], level_on);
56 } else {
57 gpio_set_value_cansleep(pdata->col_gpios[col], !level_on);
58 gpio_direction_input(pdata->col_gpios[col]);
59 }
60}
61
62static void activate_col(const struct matrix_keypad_platform_data *pdata,
63 int col, bool on)
64{
65 __activate_col(pdata, col, on);
66
67 if (on && pdata->col_scan_delay_us)
68 udelay(pdata->col_scan_delay_us);
69}
70
71static void activate_all_cols(const struct matrix_keypad_platform_data *pdata,
72 bool on)
73{
74 int col;
75
76 for (col = 0; col < pdata->num_col_gpios; col++)
77 __activate_col(pdata, col, on);
78}
79
80static bool row_asserted(const struct matrix_keypad_platform_data *pdata,
81 int row)
82{
83 return gpio_get_value_cansleep(pdata->row_gpios[row]) ?
84 !pdata->active_low : pdata->active_low;
85}
86
87static void enable_row_irqs(struct matrix_keypad *keypad)
88{
89 const struct matrix_keypad_platform_data *pdata = keypad->pdata;
90 int i;
91
92 if (pdata->clustered_irq > 0)
93 enable_irq(pdata->clustered_irq);
94 else {
95 for (i = 0; i < pdata->num_row_gpios; i++)
96 enable_irq(gpio_to_irq(pdata->row_gpios[i]));
97 }
98}
99
100static void disable_row_irqs(struct matrix_keypad *keypad)
101{
102 const struct matrix_keypad_platform_data *pdata = keypad->pdata;
103 int i;
104
105 if (pdata->clustered_irq > 0)
106 disable_irq_nosync(pdata->clustered_irq);
107 else {
108 for (i = 0; i < pdata->num_row_gpios; i++)
109 disable_irq_nosync(gpio_to_irq(pdata->row_gpios[i]));
110 }
111}
112
113/*
114 * This gets the keys from keyboard and reports it to input subsystem
115 */
116static void matrix_keypad_scan(struct work_struct *work)
117{
118 struct matrix_keypad *keypad =
119 container_of(work, struct matrix_keypad, work.work);
120 struct input_dev *input_dev = keypad->input_dev;
121 const unsigned short *keycodes = input_dev->keycode;
122 const struct matrix_keypad_platform_data *pdata = keypad->pdata;
123 uint32_t new_state[MATRIX_MAX_COLS];
124 int row, col, code;
125
126 /* de-activate all columns for scanning */
127 activate_all_cols(pdata, false);
128
129 memset(new_state, 0, sizeof(new_state));
130
131 /* assert each column and read the row status out */
132 for (col = 0; col < pdata->num_col_gpios; col++) {
133
134 activate_col(pdata, col, true);
135
136 for (row = 0; row < pdata->num_row_gpios; row++)
137 new_state[col] |=
138 row_asserted(pdata, row) ? (1 << row) : 0;
139
140 activate_col(pdata, col, false);
141 }
142
143 for (col = 0; col < pdata->num_col_gpios; col++) {
144 uint32_t bits_changed;
145
146 bits_changed = keypad->last_key_state[col] ^ new_state[col];
147 if (bits_changed == 0)
148 continue;
149
150 for (row = 0; row < pdata->num_row_gpios; row++) {
151 if ((bits_changed & (1 << row)) == 0)
152 continue;
153
154 code = MATRIX_SCAN_CODE(row, col, keypad->row_shift);
155 input_event(input_dev, EV_MSC, MSC_SCAN, code);
156 input_report_key(input_dev,
157 keycodes[code],
158 new_state[col] & (1 << row));
159 }
160 }
161 input_sync(input_dev);
162
163 memcpy(keypad->last_key_state, new_state, sizeof(new_state));
164
165 activate_all_cols(pdata, true);
166
167 /* Enable IRQs again */
168 spin_lock_irq(&keypad->lock);
169 keypad->scan_pending = false;
170 enable_row_irqs(keypad);
171 spin_unlock_irq(&keypad->lock);
172}
173
174static irqreturn_t matrix_keypad_interrupt(int irq, void *id)
175{
176 struct matrix_keypad *keypad = id;
177 unsigned long flags;
178
179 spin_lock_irqsave(&keypad->lock, flags);
180
181 /*
182 * See if another IRQ beaten us to it and scheduled the
183 * scan already. In that case we should not try to
184 * disable IRQs again.
185 */
186 if (unlikely(keypad->scan_pending || keypad->stopped))
187 goto out;
188
189 disable_row_irqs(keypad);
190 keypad->scan_pending = true;
191 schedule_delayed_work(&keypad->work,
192 msecs_to_jiffies(keypad->pdata->debounce_ms));
193
194out:
195 spin_unlock_irqrestore(&keypad->lock, flags);
196 return IRQ_HANDLED;
197}
198
199static int matrix_keypad_start(struct input_dev *dev)
200{
201 struct matrix_keypad *keypad = input_get_drvdata(dev);
202
203 keypad->stopped = false;
204 mb();
205
206 /*
207 * Schedule an immediate key scan to capture current key state;
208 * columns will be activated and IRQs be enabled after the scan.
209 */
210 schedule_delayed_work(&keypad->work, 0);
211
212 return 0;
213}
214
215static void matrix_keypad_stop(struct input_dev *dev)
216{
217 struct matrix_keypad *keypad = input_get_drvdata(dev);
218
219 keypad->stopped = true;
220 mb();
221 flush_work(&keypad->work.work);
222 /*
223 * matrix_keypad_scan() will leave IRQs enabled;
224 * we should disable them now.
225 */
226 disable_row_irqs(keypad);
227}
228
229#ifdef CONFIG_PM_SLEEP
230static void matrix_keypad_enable_wakeup(struct matrix_keypad *keypad)
231{
232 const struct matrix_keypad_platform_data *pdata = keypad->pdata;
233 unsigned int gpio;
234 int i;
235
236 if (pdata->clustered_irq > 0) {
237 if (enable_irq_wake(pdata->clustered_irq) == 0)
238 keypad->gpio_all_disabled = true;
239 } else {
240
241 for (i = 0; i < pdata->num_row_gpios; i++) {
242 if (!test_bit(i, keypad->disabled_gpios)) {
243 gpio = pdata->row_gpios[i];
244
245 if (enable_irq_wake(gpio_to_irq(gpio)) == 0)
246 __set_bit(i, keypad->disabled_gpios);
247 }
248 }
249 }
250}
251
252static void matrix_keypad_disable_wakeup(struct matrix_keypad *keypad)
253{
254 const struct matrix_keypad_platform_data *pdata = keypad->pdata;
255 unsigned int gpio;
256 int i;
257
258 if (pdata->clustered_irq > 0) {
259 if (keypad->gpio_all_disabled) {
260 disable_irq_wake(pdata->clustered_irq);
261 keypad->gpio_all_disabled = false;
262 }
263 } else {
264 for (i = 0; i < pdata->num_row_gpios; i++) {
265 if (test_and_clear_bit(i, keypad->disabled_gpios)) {
266 gpio = pdata->row_gpios[i];
267 disable_irq_wake(gpio_to_irq(gpio));
268 }
269 }
270 }
271}
272
273static int matrix_keypad_suspend(struct device *dev)
274{
275 struct platform_device *pdev = to_platform_device(dev);
276 struct matrix_keypad *keypad = platform_get_drvdata(pdev);
277
278 matrix_keypad_stop(keypad->input_dev);
279
280 if (device_may_wakeup(&pdev->dev))
281 matrix_keypad_enable_wakeup(keypad);
282
283 return 0;
284}
285
286static int matrix_keypad_resume(struct device *dev)
287{
288 struct platform_device *pdev = to_platform_device(dev);
289 struct matrix_keypad *keypad = platform_get_drvdata(pdev);
290
291 if (device_may_wakeup(&pdev->dev))
292 matrix_keypad_disable_wakeup(keypad);
293
294 matrix_keypad_start(keypad->input_dev);
295
296 return 0;
297}
298#endif
299
300static SIMPLE_DEV_PM_OPS(matrix_keypad_pm_ops,
301 matrix_keypad_suspend, matrix_keypad_resume);
302
303static int matrix_keypad_init_gpio(struct platform_device *pdev,
304 struct matrix_keypad *keypad)
305{
306 const struct matrix_keypad_platform_data *pdata = keypad->pdata;
307 int i, err;
308
309 /* initialized strobe lines as outputs, activated */
310 for (i = 0; i < pdata->num_col_gpios; i++) {
311 err = gpio_request(pdata->col_gpios[i], "matrix_kbd_col");
312 if (err) {
313 dev_err(&pdev->dev,
314 "failed to request GPIO%d for COL%d\n",
315 pdata->col_gpios[i], i);
316 goto err_free_cols;
317 }
318
319 gpio_direction_output(pdata->col_gpios[i], !pdata->active_low);
320 }
321
322 for (i = 0; i < pdata->num_row_gpios; i++) {
323 err = gpio_request(pdata->row_gpios[i], "matrix_kbd_row");
324 if (err) {
325 dev_err(&pdev->dev,
326 "failed to request GPIO%d for ROW%d\n",
327 pdata->row_gpios[i], i);
328 goto err_free_rows;
329 }
330
331 gpio_direction_input(pdata->row_gpios[i]);
332 }
333
334 if (pdata->clustered_irq > 0) {
335 err = request_any_context_irq(pdata->clustered_irq,
336 matrix_keypad_interrupt,
337 pdata->clustered_irq_flags,
338 "matrix-keypad", keypad);
339 if (err < 0) {
340 dev_err(&pdev->dev,
341 "Unable to acquire clustered interrupt\n");
342 goto err_free_rows;
343 }
344 } else {
345 for (i = 0; i < pdata->num_row_gpios; i++) {
346 err = request_any_context_irq(
347 gpio_to_irq(pdata->row_gpios[i]),
348 matrix_keypad_interrupt,
349 IRQF_TRIGGER_RISING |
350 IRQF_TRIGGER_FALLING,
351 "matrix-keypad", keypad);
352 if (err < 0) {
353 dev_err(&pdev->dev,
354 "Unable to acquire interrupt for GPIO line %i\n",
355 pdata->row_gpios[i]);
356 goto err_free_irqs;
357 }
358 }
359 }
360
361 /* initialized as disabled - enabled by input->open */
362 disable_row_irqs(keypad);
363 return 0;
364
365err_free_irqs:
366 while (--i >= 0)
367 free_irq(gpio_to_irq(pdata->row_gpios[i]), keypad);
368 i = pdata->num_row_gpios;
369err_free_rows:
370 while (--i >= 0)
371 gpio_free(pdata->row_gpios[i]);
372 i = pdata->num_col_gpios;
373err_free_cols:
374 while (--i >= 0)
375 gpio_free(pdata->col_gpios[i]);
376
377 return err;
378}
379
380static void matrix_keypad_free_gpio(struct matrix_keypad *keypad)
381{
382 const struct matrix_keypad_platform_data *pdata = keypad->pdata;
383 int i;
384
385 if (pdata->clustered_irq > 0) {
386 free_irq(pdata->clustered_irq, keypad);
387 } else {
388 for (i = 0; i < pdata->num_row_gpios; i++)
389 free_irq(gpio_to_irq(pdata->row_gpios[i]), keypad);
390 }
391
392 for (i = 0; i < pdata->num_row_gpios; i++)
393 gpio_free(pdata->row_gpios[i]);
394
395 for (i = 0; i < pdata->num_col_gpios; i++)
396 gpio_free(pdata->col_gpios[i]);
397}
398
399#ifdef CONFIG_OF
400static struct matrix_keypad_platform_data *
401matrix_keypad_parse_dt(struct device *dev)
402{
403 struct matrix_keypad_platform_data *pdata;
404 struct device_node *np = dev->of_node;
405 unsigned int *gpios;
406 int i, nrow, ncol;
407
408 if (!np) {
409 dev_err(dev, "device lacks DT data\n");
410 return ERR_PTR(-ENODEV);
411 }
412
413 pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
414 if (!pdata) {
415 dev_err(dev, "could not allocate memory for platform data\n");
416 return ERR_PTR(-ENOMEM);
417 }
418
419 pdata->num_row_gpios = nrow = of_gpio_named_count(np, "row-gpios");
420 pdata->num_col_gpios = ncol = of_gpio_named_count(np, "col-gpios");
421 if (nrow <= 0 || ncol <= 0) {
422 dev_err(dev, "number of keypad rows/columns not specified\n");
423 return ERR_PTR(-EINVAL);
424 }
425
426 if (of_get_property(np, "linux,no-autorepeat", NULL))
427 pdata->no_autorepeat = true;
428
429 pdata->wakeup = of_property_read_bool(np, "wakeup-source") ||
430 of_property_read_bool(np, "linux,wakeup"); /* legacy */
431
432 if (of_get_property(np, "gpio-activelow", NULL))
433 pdata->active_low = true;
434
435 of_property_read_u32(np, "debounce-delay-ms", &pdata->debounce_ms);
436 of_property_read_u32(np, "col-scan-delay-us",
437 &pdata->col_scan_delay_us);
438
439 gpios = devm_kzalloc(dev,
440 sizeof(unsigned int) *
441 (pdata->num_row_gpios + pdata->num_col_gpios),
442 GFP_KERNEL);
443 if (!gpios) {
444 dev_err(dev, "could not allocate memory for gpios\n");
445 return ERR_PTR(-ENOMEM);
446 }
447
448 for (i = 0; i < pdata->num_row_gpios; i++)
449 gpios[i] = of_get_named_gpio(np, "row-gpios", i);
450
451 for (i = 0; i < pdata->num_col_gpios; i++)
452 gpios[pdata->num_row_gpios + i] =
453 of_get_named_gpio(np, "col-gpios", i);
454
455 pdata->row_gpios = gpios;
456 pdata->col_gpios = &gpios[pdata->num_row_gpios];
457
458 return pdata;
459}
460#else
461static inline struct matrix_keypad_platform_data *
462matrix_keypad_parse_dt(struct device *dev)
463{
464 dev_err(dev, "no platform data defined\n");
465
466 return ERR_PTR(-EINVAL);
467}
468#endif
469
470static int matrix_keypad_probe(struct platform_device *pdev)
471{
472 const struct matrix_keypad_platform_data *pdata;
473 struct matrix_keypad *keypad;
474 struct input_dev *input_dev;
475 int err;
476
477 pdata = dev_get_platdata(&pdev->dev);
478 if (!pdata) {
479 pdata = matrix_keypad_parse_dt(&pdev->dev);
480 if (IS_ERR(pdata)) {
481 dev_err(&pdev->dev, "no platform data defined\n");
482 return PTR_ERR(pdata);
483 }
484 } else if (!pdata->keymap_data) {
485 dev_err(&pdev->dev, "no keymap data defined\n");
486 return -EINVAL;
487 }
488
489 keypad = kzalloc(sizeof(struct matrix_keypad), GFP_KERNEL);
490 input_dev = input_allocate_device();
491 if (!keypad || !input_dev) {
492 err = -ENOMEM;
493 goto err_free_mem;
494 }
495
496 keypad->input_dev = input_dev;
497 keypad->pdata = pdata;
498 keypad->row_shift = get_count_order(pdata->num_col_gpios);
499 keypad->stopped = true;
500 INIT_DELAYED_WORK(&keypad->work, matrix_keypad_scan);
501 spin_lock_init(&keypad->lock);
502
503 input_dev->name = pdev->name;
504 input_dev->id.bustype = BUS_HOST;
505 input_dev->dev.parent = &pdev->dev;
506 input_dev->open = matrix_keypad_start;
507 input_dev->close = matrix_keypad_stop;
508
509 err = matrix_keypad_build_keymap(pdata->keymap_data, NULL,
510 pdata->num_row_gpios,
511 pdata->num_col_gpios,
512 NULL, input_dev);
513 if (err) {
514 dev_err(&pdev->dev, "failed to build keymap\n");
515 goto err_free_mem;
516 }
517
518 if (!pdata->no_autorepeat)
519 __set_bit(EV_REP, input_dev->evbit);
520 input_set_capability(input_dev, EV_MSC, MSC_SCAN);
521 input_set_drvdata(input_dev, keypad);
522
523 err = matrix_keypad_init_gpio(pdev, keypad);
524 if (err)
525 goto err_free_mem;
526
527 err = input_register_device(keypad->input_dev);
528 if (err)
529 goto err_free_gpio;
530
531 device_init_wakeup(&pdev->dev, pdata->wakeup);
532 platform_set_drvdata(pdev, keypad);
533
534 return 0;
535
536err_free_gpio:
537 matrix_keypad_free_gpio(keypad);
538err_free_mem:
539 input_free_device(input_dev);
540 kfree(keypad);
541 return err;
542}
543
544static int matrix_keypad_remove(struct platform_device *pdev)
545{
546 struct matrix_keypad *keypad = platform_get_drvdata(pdev);
547
548 device_init_wakeup(&pdev->dev, 0);
549
550 matrix_keypad_free_gpio(keypad);
551 input_unregister_device(keypad->input_dev);
552 kfree(keypad);
553
554 return 0;
555}
556
557#ifdef CONFIG_OF
558static const struct of_device_id matrix_keypad_dt_match[] = {
559 { .compatible = "gpio-matrix-keypad" },
560 { }
561};
562MODULE_DEVICE_TABLE(of, matrix_keypad_dt_match);
563#endif
564
565static struct platform_driver matrix_keypad_driver = {
566 .probe = matrix_keypad_probe,
567 .remove = matrix_keypad_remove,
568 .driver = {
569 .name = "matrix-keypad",
570 .pm = &matrix_keypad_pm_ops,
571 .of_match_table = of_match_ptr(matrix_keypad_dt_match),
572 },
573};
574module_platform_driver(matrix_keypad_driver);
575
576MODULE_AUTHOR("Marek Vasut <marek.vasut@gmail.com>");
577MODULE_DESCRIPTION("GPIO Driven Matrix Keypad Driver");
578MODULE_LICENSE("GPL v2");
579MODULE_ALIAS("platform:matrix-keypad");
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * GPIO driven matrix keyboard driver
4 *
5 * Copyright (c) 2008 Marek Vasut <marek.vasut@gmail.com>
6 *
7 * Based on corgikbd.c
8 */
9
10#include <linux/types.h>
11#include <linux/delay.h>
12#include <linux/gpio/consumer.h>
13#include <linux/platform_device.h>
14#include <linux/input.h>
15#include <linux/irq.h>
16#include <linux/interrupt.h>
17#include <linux/jiffies.h>
18#include <linux/module.h>
19#include <linux/gpio.h>
20#include <linux/input/matrix_keypad.h>
21#include <linux/slab.h>
22#include <linux/of.h>
23#include <linux/of_gpio.h>
24#include <linux/of_platform.h>
25
26struct matrix_keypad {
27 const struct matrix_keypad_platform_data *pdata;
28 struct input_dev *input_dev;
29 unsigned int row_shift;
30
31 DECLARE_BITMAP(disabled_gpios, MATRIX_MAX_ROWS);
32
33 uint32_t last_key_state[MATRIX_MAX_COLS];
34 struct delayed_work work;
35 spinlock_t lock;
36 bool scan_pending;
37 bool stopped;
38 bool gpio_all_disabled;
39};
40
41/*
42 * NOTE: If drive_inactive_cols is false, then the GPIO has to be put into
43 * HiZ when de-activated to cause minmal side effect when scanning other
44 * columns. In that case it is configured here to be input, otherwise it is
45 * driven with the inactive value.
46 */
47static void __activate_col(const struct matrix_keypad_platform_data *pdata,
48 int col, bool on)
49{
50 bool level_on = !pdata->active_low;
51
52 if (on) {
53 gpio_direction_output(pdata->col_gpios[col], level_on);
54 } else {
55 gpio_set_value_cansleep(pdata->col_gpios[col], !level_on);
56 if (!pdata->drive_inactive_cols)
57 gpio_direction_input(pdata->col_gpios[col]);
58 }
59}
60
61static void activate_col(const struct matrix_keypad_platform_data *pdata,
62 int col, bool on)
63{
64 __activate_col(pdata, col, on);
65
66 if (on && pdata->col_scan_delay_us)
67 udelay(pdata->col_scan_delay_us);
68}
69
70static void activate_all_cols(const struct matrix_keypad_platform_data *pdata,
71 bool on)
72{
73 int col;
74
75 for (col = 0; col < pdata->num_col_gpios; col++)
76 __activate_col(pdata, col, on);
77}
78
79static bool row_asserted(const struct matrix_keypad_platform_data *pdata,
80 int row)
81{
82 return gpio_get_value_cansleep(pdata->row_gpios[row]) ?
83 !pdata->active_low : pdata->active_low;
84}
85
86static void enable_row_irqs(struct matrix_keypad *keypad)
87{
88 const struct matrix_keypad_platform_data *pdata = keypad->pdata;
89 int i;
90
91 if (pdata->clustered_irq > 0)
92 enable_irq(pdata->clustered_irq);
93 else {
94 for (i = 0; i < pdata->num_row_gpios; i++)
95 enable_irq(gpio_to_irq(pdata->row_gpios[i]));
96 }
97}
98
99static void disable_row_irqs(struct matrix_keypad *keypad)
100{
101 const struct matrix_keypad_platform_data *pdata = keypad->pdata;
102 int i;
103
104 if (pdata->clustered_irq > 0)
105 disable_irq_nosync(pdata->clustered_irq);
106 else {
107 for (i = 0; i < pdata->num_row_gpios; i++)
108 disable_irq_nosync(gpio_to_irq(pdata->row_gpios[i]));
109 }
110}
111
112/*
113 * This gets the keys from keyboard and reports it to input subsystem
114 */
115static void matrix_keypad_scan(struct work_struct *work)
116{
117 struct matrix_keypad *keypad =
118 container_of(work, struct matrix_keypad, work.work);
119 struct input_dev *input_dev = keypad->input_dev;
120 const unsigned short *keycodes = input_dev->keycode;
121 const struct matrix_keypad_platform_data *pdata = keypad->pdata;
122 uint32_t new_state[MATRIX_MAX_COLS];
123 int row, col, code;
124
125 /* de-activate all columns for scanning */
126 activate_all_cols(pdata, false);
127
128 memset(new_state, 0, sizeof(new_state));
129
130 for (row = 0; row < pdata->num_row_gpios; row++)
131 gpio_direction_input(pdata->row_gpios[row]);
132
133 /* assert each column and read the row status out */
134 for (col = 0; col < pdata->num_col_gpios; col++) {
135
136 activate_col(pdata, col, true);
137
138 for (row = 0; row < pdata->num_row_gpios; row++)
139 new_state[col] |=
140 row_asserted(pdata, row) ? (1 << row) : 0;
141
142 activate_col(pdata, col, false);
143 }
144
145 for (col = 0; col < pdata->num_col_gpios; col++) {
146 uint32_t bits_changed;
147
148 bits_changed = keypad->last_key_state[col] ^ new_state[col];
149 if (bits_changed == 0)
150 continue;
151
152 for (row = 0; row < pdata->num_row_gpios; row++) {
153 if ((bits_changed & (1 << row)) == 0)
154 continue;
155
156 code = MATRIX_SCAN_CODE(row, col, keypad->row_shift);
157 input_event(input_dev, EV_MSC, MSC_SCAN, code);
158 input_report_key(input_dev,
159 keycodes[code],
160 new_state[col] & (1 << row));
161 }
162 }
163 input_sync(input_dev);
164
165 memcpy(keypad->last_key_state, new_state, sizeof(new_state));
166
167 activate_all_cols(pdata, true);
168
169 /* Enable IRQs again */
170 spin_lock_irq(&keypad->lock);
171 keypad->scan_pending = false;
172 enable_row_irqs(keypad);
173 spin_unlock_irq(&keypad->lock);
174}
175
176static irqreturn_t matrix_keypad_interrupt(int irq, void *id)
177{
178 struct matrix_keypad *keypad = id;
179 unsigned long flags;
180
181 spin_lock_irqsave(&keypad->lock, flags);
182
183 /*
184 * See if another IRQ beaten us to it and scheduled the
185 * scan already. In that case we should not try to
186 * disable IRQs again.
187 */
188 if (unlikely(keypad->scan_pending || keypad->stopped))
189 goto out;
190
191 disable_row_irqs(keypad);
192 keypad->scan_pending = true;
193 schedule_delayed_work(&keypad->work,
194 msecs_to_jiffies(keypad->pdata->debounce_ms));
195
196out:
197 spin_unlock_irqrestore(&keypad->lock, flags);
198 return IRQ_HANDLED;
199}
200
201static int matrix_keypad_start(struct input_dev *dev)
202{
203 struct matrix_keypad *keypad = input_get_drvdata(dev);
204
205 keypad->stopped = false;
206 mb();
207
208 /*
209 * Schedule an immediate key scan to capture current key state;
210 * columns will be activated and IRQs be enabled after the scan.
211 */
212 schedule_delayed_work(&keypad->work, 0);
213
214 return 0;
215}
216
217static void matrix_keypad_stop(struct input_dev *dev)
218{
219 struct matrix_keypad *keypad = input_get_drvdata(dev);
220
221 spin_lock_irq(&keypad->lock);
222 keypad->stopped = true;
223 spin_unlock_irq(&keypad->lock);
224
225 flush_delayed_work(&keypad->work);
226 /*
227 * matrix_keypad_scan() will leave IRQs enabled;
228 * we should disable them now.
229 */
230 disable_row_irqs(keypad);
231}
232
233static void matrix_keypad_enable_wakeup(struct matrix_keypad *keypad)
234{
235 const struct matrix_keypad_platform_data *pdata = keypad->pdata;
236 unsigned int gpio;
237 int i;
238
239 if (pdata->clustered_irq > 0) {
240 if (enable_irq_wake(pdata->clustered_irq) == 0)
241 keypad->gpio_all_disabled = true;
242 } else {
243
244 for (i = 0; i < pdata->num_row_gpios; i++) {
245 if (!test_bit(i, keypad->disabled_gpios)) {
246 gpio = pdata->row_gpios[i];
247
248 if (enable_irq_wake(gpio_to_irq(gpio)) == 0)
249 __set_bit(i, keypad->disabled_gpios);
250 }
251 }
252 }
253}
254
255static void matrix_keypad_disable_wakeup(struct matrix_keypad *keypad)
256{
257 const struct matrix_keypad_platform_data *pdata = keypad->pdata;
258 unsigned int gpio;
259 int i;
260
261 if (pdata->clustered_irq > 0) {
262 if (keypad->gpio_all_disabled) {
263 disable_irq_wake(pdata->clustered_irq);
264 keypad->gpio_all_disabled = false;
265 }
266 } else {
267 for (i = 0; i < pdata->num_row_gpios; i++) {
268 if (test_and_clear_bit(i, keypad->disabled_gpios)) {
269 gpio = pdata->row_gpios[i];
270 disable_irq_wake(gpio_to_irq(gpio));
271 }
272 }
273 }
274}
275
276static int matrix_keypad_suspend(struct device *dev)
277{
278 struct platform_device *pdev = to_platform_device(dev);
279 struct matrix_keypad *keypad = platform_get_drvdata(pdev);
280
281 matrix_keypad_stop(keypad->input_dev);
282
283 if (device_may_wakeup(&pdev->dev))
284 matrix_keypad_enable_wakeup(keypad);
285
286 return 0;
287}
288
289static int matrix_keypad_resume(struct device *dev)
290{
291 struct platform_device *pdev = to_platform_device(dev);
292 struct matrix_keypad *keypad = platform_get_drvdata(pdev);
293
294 if (device_may_wakeup(&pdev->dev))
295 matrix_keypad_disable_wakeup(keypad);
296
297 matrix_keypad_start(keypad->input_dev);
298
299 return 0;
300}
301
302static DEFINE_SIMPLE_DEV_PM_OPS(matrix_keypad_pm_ops,
303 matrix_keypad_suspend, matrix_keypad_resume);
304
305static int matrix_keypad_init_gpio(struct platform_device *pdev,
306 struct matrix_keypad *keypad)
307{
308 const struct matrix_keypad_platform_data *pdata = keypad->pdata;
309 int i, err;
310
311 /* initialized strobe lines as outputs, activated */
312 for (i = 0; i < pdata->num_col_gpios; i++) {
313 err = gpio_request(pdata->col_gpios[i], "matrix_kbd_col");
314 if (err) {
315 dev_err(&pdev->dev,
316 "failed to request GPIO%d for COL%d\n",
317 pdata->col_gpios[i], i);
318 goto err_free_cols;
319 }
320
321 gpio_direction_output(pdata->col_gpios[i], !pdata->active_low);
322 }
323
324 for (i = 0; i < pdata->num_row_gpios; i++) {
325 err = gpio_request(pdata->row_gpios[i], "matrix_kbd_row");
326 if (err) {
327 dev_err(&pdev->dev,
328 "failed to request GPIO%d for ROW%d\n",
329 pdata->row_gpios[i], i);
330 goto err_free_rows;
331 }
332
333 gpio_direction_input(pdata->row_gpios[i]);
334 }
335
336 if (pdata->clustered_irq > 0) {
337 err = request_any_context_irq(pdata->clustered_irq,
338 matrix_keypad_interrupt,
339 pdata->clustered_irq_flags,
340 "matrix-keypad", keypad);
341 if (err < 0) {
342 dev_err(&pdev->dev,
343 "Unable to acquire clustered interrupt\n");
344 goto err_free_rows;
345 }
346 } else {
347 for (i = 0; i < pdata->num_row_gpios; i++) {
348 err = request_any_context_irq(
349 gpio_to_irq(pdata->row_gpios[i]),
350 matrix_keypad_interrupt,
351 IRQF_TRIGGER_RISING |
352 IRQF_TRIGGER_FALLING,
353 "matrix-keypad", keypad);
354 if (err < 0) {
355 dev_err(&pdev->dev,
356 "Unable to acquire interrupt for GPIO line %i\n",
357 pdata->row_gpios[i]);
358 goto err_free_irqs;
359 }
360 }
361 }
362
363 /* initialized as disabled - enabled by input->open */
364 disable_row_irqs(keypad);
365 return 0;
366
367err_free_irqs:
368 while (--i >= 0)
369 free_irq(gpio_to_irq(pdata->row_gpios[i]), keypad);
370 i = pdata->num_row_gpios;
371err_free_rows:
372 while (--i >= 0)
373 gpio_free(pdata->row_gpios[i]);
374 i = pdata->num_col_gpios;
375err_free_cols:
376 while (--i >= 0)
377 gpio_free(pdata->col_gpios[i]);
378
379 return err;
380}
381
382static void matrix_keypad_free_gpio(struct matrix_keypad *keypad)
383{
384 const struct matrix_keypad_platform_data *pdata = keypad->pdata;
385 int i;
386
387 if (pdata->clustered_irq > 0) {
388 free_irq(pdata->clustered_irq, keypad);
389 } else {
390 for (i = 0; i < pdata->num_row_gpios; i++)
391 free_irq(gpio_to_irq(pdata->row_gpios[i]), keypad);
392 }
393
394 for (i = 0; i < pdata->num_row_gpios; i++)
395 gpio_free(pdata->row_gpios[i]);
396
397 for (i = 0; i < pdata->num_col_gpios; i++)
398 gpio_free(pdata->col_gpios[i]);
399}
400
401#ifdef CONFIG_OF
402static struct matrix_keypad_platform_data *
403matrix_keypad_parse_dt(struct device *dev)
404{
405 struct matrix_keypad_platform_data *pdata;
406 struct device_node *np = dev->of_node;
407 unsigned int *gpios;
408 int ret, i, nrow, ncol;
409
410 if (!np) {
411 dev_err(dev, "device lacks DT data\n");
412 return ERR_PTR(-ENODEV);
413 }
414
415 pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
416 if (!pdata) {
417 dev_err(dev, "could not allocate memory for platform data\n");
418 return ERR_PTR(-ENOMEM);
419 }
420
421 pdata->num_row_gpios = nrow = gpiod_count(dev, "row");
422 pdata->num_col_gpios = ncol = gpiod_count(dev, "col");
423 if (nrow < 0 || ncol < 0) {
424 dev_err(dev, "number of keypad rows/columns not specified\n");
425 return ERR_PTR(-EINVAL);
426 }
427
428 pdata->no_autorepeat = of_property_read_bool(np, "linux,no-autorepeat");
429
430 pdata->wakeup = of_property_read_bool(np, "wakeup-source") ||
431 of_property_read_bool(np, "linux,wakeup"); /* legacy */
432
433 pdata->active_low = of_property_read_bool(np, "gpio-activelow");
434
435 pdata->drive_inactive_cols =
436 of_property_read_bool(np, "drive-inactive-cols");
437
438 of_property_read_u32(np, "debounce-delay-ms", &pdata->debounce_ms);
439 of_property_read_u32(np, "col-scan-delay-us",
440 &pdata->col_scan_delay_us);
441
442 gpios = devm_kcalloc(dev,
443 pdata->num_row_gpios + pdata->num_col_gpios,
444 sizeof(unsigned int),
445 GFP_KERNEL);
446 if (!gpios) {
447 dev_err(dev, "could not allocate memory for gpios\n");
448 return ERR_PTR(-ENOMEM);
449 }
450
451 for (i = 0; i < nrow; i++) {
452 ret = of_get_named_gpio(np, "row-gpios", i);
453 if (ret < 0)
454 return ERR_PTR(ret);
455 gpios[i] = ret;
456 }
457
458 for (i = 0; i < ncol; i++) {
459 ret = of_get_named_gpio(np, "col-gpios", i);
460 if (ret < 0)
461 return ERR_PTR(ret);
462 gpios[nrow + i] = ret;
463 }
464
465 pdata->row_gpios = gpios;
466 pdata->col_gpios = &gpios[pdata->num_row_gpios];
467
468 return pdata;
469}
470#else
471static inline struct matrix_keypad_platform_data *
472matrix_keypad_parse_dt(struct device *dev)
473{
474 dev_err(dev, "no platform data defined\n");
475
476 return ERR_PTR(-EINVAL);
477}
478#endif
479
480static int matrix_keypad_probe(struct platform_device *pdev)
481{
482 const struct matrix_keypad_platform_data *pdata;
483 struct matrix_keypad *keypad;
484 struct input_dev *input_dev;
485 int err;
486
487 pdata = dev_get_platdata(&pdev->dev);
488 if (!pdata) {
489 pdata = matrix_keypad_parse_dt(&pdev->dev);
490 if (IS_ERR(pdata))
491 return PTR_ERR(pdata);
492 } else if (!pdata->keymap_data) {
493 dev_err(&pdev->dev, "no keymap data defined\n");
494 return -EINVAL;
495 }
496
497 keypad = kzalloc(sizeof(struct matrix_keypad), GFP_KERNEL);
498 input_dev = input_allocate_device();
499 if (!keypad || !input_dev) {
500 err = -ENOMEM;
501 goto err_free_mem;
502 }
503
504 keypad->input_dev = input_dev;
505 keypad->pdata = pdata;
506 keypad->row_shift = get_count_order(pdata->num_col_gpios);
507 keypad->stopped = true;
508 INIT_DELAYED_WORK(&keypad->work, matrix_keypad_scan);
509 spin_lock_init(&keypad->lock);
510
511 input_dev->name = pdev->name;
512 input_dev->id.bustype = BUS_HOST;
513 input_dev->dev.parent = &pdev->dev;
514 input_dev->open = matrix_keypad_start;
515 input_dev->close = matrix_keypad_stop;
516
517 err = matrix_keypad_build_keymap(pdata->keymap_data, NULL,
518 pdata->num_row_gpios,
519 pdata->num_col_gpios,
520 NULL, input_dev);
521 if (err) {
522 dev_err(&pdev->dev, "failed to build keymap\n");
523 goto err_free_mem;
524 }
525
526 if (!pdata->no_autorepeat)
527 __set_bit(EV_REP, input_dev->evbit);
528 input_set_capability(input_dev, EV_MSC, MSC_SCAN);
529 input_set_drvdata(input_dev, keypad);
530
531 err = matrix_keypad_init_gpio(pdev, keypad);
532 if (err)
533 goto err_free_mem;
534
535 err = input_register_device(keypad->input_dev);
536 if (err)
537 goto err_free_gpio;
538
539 device_init_wakeup(&pdev->dev, pdata->wakeup);
540 platform_set_drvdata(pdev, keypad);
541
542 return 0;
543
544err_free_gpio:
545 matrix_keypad_free_gpio(keypad);
546err_free_mem:
547 input_free_device(input_dev);
548 kfree(keypad);
549 return err;
550}
551
552static void matrix_keypad_remove(struct platform_device *pdev)
553{
554 struct matrix_keypad *keypad = platform_get_drvdata(pdev);
555
556 matrix_keypad_free_gpio(keypad);
557 input_unregister_device(keypad->input_dev);
558 kfree(keypad);
559}
560
561#ifdef CONFIG_OF
562static const struct of_device_id matrix_keypad_dt_match[] = {
563 { .compatible = "gpio-matrix-keypad" },
564 { }
565};
566MODULE_DEVICE_TABLE(of, matrix_keypad_dt_match);
567#endif
568
569static struct platform_driver matrix_keypad_driver = {
570 .probe = matrix_keypad_probe,
571 .remove_new = matrix_keypad_remove,
572 .driver = {
573 .name = "matrix-keypad",
574 .pm = pm_sleep_ptr(&matrix_keypad_pm_ops),
575 .of_match_table = of_match_ptr(matrix_keypad_dt_match),
576 },
577};
578module_platform_driver(matrix_keypad_driver);
579
580MODULE_AUTHOR("Marek Vasut <marek.vasut@gmail.com>");
581MODULE_DESCRIPTION("GPIO Driven Matrix Keypad Driver");
582MODULE_LICENSE("GPL v2");
583MODULE_ALIAS("platform:matrix-keypad");