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