Input: matrix-keypad - allocate keycodes with keypad structure
[linux-2.6-block.git] / drivers / input / keyboard / matrix_keypad.c
CommitLineData
bab7614d
EM
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>
5a0e3ad6 25#include <linux/slab.h>
bab7614d
EM
26
27struct matrix_keypad {
28 const struct matrix_keypad_platform_data *pdata;
29 struct input_dev *input_dev;
d82f1c35 30 unsigned int row_shift;
bab7614d 31
dd219234
DT
32 DECLARE_BITMAP(disabled_gpios, MATRIX_MAX_ROWS);
33
bab7614d
EM
34 uint32_t last_key_state[MATRIX_MAX_COLS];
35 struct delayed_work work;
dd219234 36 spinlock_t lock;
bab7614d
EM
37 bool scan_pending;
38 bool stopped;
fb76dd10 39 bool gpio_all_disabled;
01111fcd
DT
40
41 unsigned short keycodes[];
bab7614d
EM
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
fb76dd10
LF
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 }
bab7614d
EM
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
fb76dd10
LF
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 }
bab7614d
EM
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 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 /* assert each column and read the row status out */
131 for (col = 0; col < pdata->num_col_gpios; col++) {
132
133 activate_col(pdata, col, true);
134
135 for (row = 0; row < pdata->num_row_gpios; row++)
136 new_state[col] |=
137 row_asserted(pdata, row) ? (1 << row) : 0;
138
139 activate_col(pdata, col, false);
140 }
141
142 for (col = 0; col < pdata->num_col_gpios; col++) {
143 uint32_t bits_changed;
144
145 bits_changed = keypad->last_key_state[col] ^ new_state[col];
146 if (bits_changed == 0)
147 continue;
148
149 for (row = 0; row < pdata->num_row_gpios; row++) {
150 if ((bits_changed & (1 << row)) == 0)
151 continue;
152
d82f1c35 153 code = MATRIX_SCAN_CODE(row, col, keypad->row_shift);
bab7614d
EM
154 input_event(input_dev, EV_MSC, MSC_SCAN, code);
155 input_report_key(input_dev,
156 keypad->keycodes[code],
157 new_state[col] & (1 << row));
158 }
159 }
160 input_sync(input_dev);
161
162 memcpy(keypad->last_key_state, new_state, sizeof(new_state));
163
164 activate_all_cols(pdata, true);
165
166 /* Enable IRQs again */
167 spin_lock_irq(&keypad->lock);
168 keypad->scan_pending = false;
169 enable_row_irqs(keypad);
170 spin_unlock_irq(&keypad->lock);
171}
172
173static irqreturn_t matrix_keypad_interrupt(int irq, void *id)
174{
175 struct matrix_keypad *keypad = id;
176 unsigned long flags;
177
178 spin_lock_irqsave(&keypad->lock, flags);
179
180 /*
181 * See if another IRQ beaten us to it and scheduled the
182 * scan already. In that case we should not try to
183 * disable IRQs again.
184 */
185 if (unlikely(keypad->scan_pending || keypad->stopped))
186 goto out;
187
188 disable_row_irqs(keypad);
189 keypad->scan_pending = true;
190 schedule_delayed_work(&keypad->work,
191 msecs_to_jiffies(keypad->pdata->debounce_ms));
192
193out:
194 spin_unlock_irqrestore(&keypad->lock, flags);
195 return IRQ_HANDLED;
196}
197
198static int matrix_keypad_start(struct input_dev *dev)
199{
200 struct matrix_keypad *keypad = input_get_drvdata(dev);
201
202 keypad->stopped = false;
203 mb();
204
205 /*
206 * Schedule an immediate key scan to capture current key state;
207 * columns will be activated and IRQs be enabled after the scan.
208 */
209 schedule_delayed_work(&keypad->work, 0);
210
211 return 0;
212}
213
214static void matrix_keypad_stop(struct input_dev *dev)
215{
216 struct matrix_keypad *keypad = input_get_drvdata(dev);
217
218 keypad->stopped = true;
219 mb();
220 flush_work(&keypad->work.work);
221 /*
222 * matrix_keypad_scan() will leave IRQs enabled;
223 * we should disable them now.
224 */
225 disable_row_irqs(keypad);
226}
227
0508c19a 228#ifdef CONFIG_PM_SLEEP
fb76dd10 229static void matrix_keypad_enable_wakeup(struct matrix_keypad *keypad)
bab7614d 230{
bab7614d 231 const struct matrix_keypad_platform_data *pdata = keypad->pdata;
fb76dd10 232 unsigned int gpio;
bab7614d
EM
233 int i;
234
fb76dd10
LF
235 if (pdata->clustered_irq > 0) {
236 if (enable_irq_wake(pdata->clustered_irq) == 0)
237 keypad->gpio_all_disabled = true;
238 } else {
bab7614d 239
dd219234
DT
240 for (i = 0; i < pdata->num_row_gpios; i++) {
241 if (!test_bit(i, keypad->disabled_gpios)) {
fb76dd10 242 gpio = pdata->row_gpios[i];
dd219234
DT
243
244 if (enable_irq_wake(gpio_to_irq(gpio)) == 0)
245 __set_bit(i, keypad->disabled_gpios);
246 }
247 }
248 }
bab7614d
EM
249}
250
fb76dd10 251static void matrix_keypad_disable_wakeup(struct matrix_keypad *keypad)
bab7614d 252{
bab7614d 253 const struct matrix_keypad_platform_data *pdata = keypad->pdata;
fb76dd10 254 unsigned int gpio;
bab7614d
EM
255 int i;
256
fb76dd10
LF
257 if (pdata->clustered_irq > 0) {
258 if (keypad->gpio_all_disabled) {
259 disable_irq_wake(pdata->clustered_irq);
260 keypad->gpio_all_disabled = false;
261 }
262 } else {
dd219234
DT
263 for (i = 0; i < pdata->num_row_gpios; i++) {
264 if (test_and_clear_bit(i, keypad->disabled_gpios)) {
fb76dd10 265 gpio = pdata->row_gpios[i];
dd219234
DT
266 disable_irq_wake(gpio_to_irq(gpio));
267 }
268 }
269 }
fb76dd10
LF
270}
271
272static int matrix_keypad_suspend(struct device *dev)
273{
274 struct platform_device *pdev = to_platform_device(dev);
275 struct matrix_keypad *keypad = platform_get_drvdata(pdev);
276
277 matrix_keypad_stop(keypad->input_dev);
278
279 if (device_may_wakeup(&pdev->dev))
280 matrix_keypad_enable_wakeup(keypad);
281
282 return 0;
283}
284
285static int matrix_keypad_resume(struct device *dev)
286{
287 struct platform_device *pdev = to_platform_device(dev);
288 struct matrix_keypad *keypad = platform_get_drvdata(pdev);
289
290 if (device_may_wakeup(&pdev->dev))
291 matrix_keypad_disable_wakeup(keypad);
bab7614d
EM
292
293 matrix_keypad_start(keypad->input_dev);
294
295 return 0;
296}
bab7614d
EM
297#endif
298
0508c19a
DT
299static SIMPLE_DEV_PM_OPS(matrix_keypad_pm_ops,
300 matrix_keypad_suspend, matrix_keypad_resume);
301
bab7614d
EM
302static int __devinit init_matrix_gpio(struct platform_device *pdev,
303 struct matrix_keypad *keypad)
304{
305 const struct matrix_keypad_platform_data *pdata = keypad->pdata;
306 int i, err = -EINVAL;
307
308 /* initialized strobe lines as outputs, activated */
309 for (i = 0; i < pdata->num_col_gpios; i++) {
310 err = gpio_request(pdata->col_gpios[i], "matrix_kbd_col");
311 if (err) {
312 dev_err(&pdev->dev,
313 "failed to request GPIO%d for COL%d\n",
314 pdata->col_gpios[i], i);
315 goto err_free_cols;
316 }
317
318 gpio_direction_output(pdata->col_gpios[i], !pdata->active_low);
319 }
320
321 for (i = 0; i < pdata->num_row_gpios; i++) {
322 err = gpio_request(pdata->row_gpios[i], "matrix_kbd_row");
323 if (err) {
324 dev_err(&pdev->dev,
325 "failed to request GPIO%d for ROW%d\n",
326 pdata->row_gpios[i], i);
327 goto err_free_rows;
328 }
329
330 gpio_direction_input(pdata->row_gpios[i]);
331 }
332
fb76dd10
LF
333 if (pdata->clustered_irq > 0) {
334 err = request_irq(pdata->clustered_irq,
bab7614d 335 matrix_keypad_interrupt,
fb76dd10 336 pdata->clustered_irq_flags,
bab7614d
EM
337 "matrix-keypad", keypad);
338 if (err) {
339 dev_err(&pdev->dev,
fb76dd10
LF
340 "Unable to acquire clustered interrupt\n");
341 goto err_free_rows;
342 }
343 } else {
344 for (i = 0; i < pdata->num_row_gpios; i++) {
345 err = request_irq(gpio_to_irq(pdata->row_gpios[i]),
346 matrix_keypad_interrupt,
fb76dd10
LF
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 }
bab7614d
EM
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;
d82f1c35 385 unsigned int row_shift;
01111fcd 386 size_t keymap_size;
bab7614d
EM
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
d82f1c35 401 row_shift = get_count_order(pdata->num_col_gpios);
01111fcd
DT
402 keymap_size = (pdata->num_row_gpios << row_shift) *
403 sizeof(keypad->keycodes[0]);
404 keypad = kzalloc(sizeof(struct matrix_keypad) + keymap_size,
405 GFP_KERNEL);
bab7614d 406 input_dev = input_allocate_device();
01111fcd 407 if (!keypad || !input_dev) {
bab7614d
EM
408 err = -ENOMEM;
409 goto err_free_mem;
410 }
411
412 keypad->input_dev = input_dev;
413 keypad->pdata = pdata;
d82f1c35 414 keypad->row_shift = row_shift;
bab7614d
EM
415 keypad->stopped = true;
416 INIT_DELAYED_WORK(&keypad->work, matrix_keypad_scan);
417 spin_lock_init(&keypad->lock);
418
419 input_dev->name = pdev->name;
420 input_dev->id.bustype = BUS_HOST;
421 input_dev->dev.parent = &pdev->dev;
9d32c305
HS
422 input_dev->evbit[0] = BIT_MASK(EV_KEY);
423 if (!pdata->no_autorepeat)
424 input_dev->evbit[0] |= BIT_MASK(EV_REP);
bab7614d
EM
425 input_dev->open = matrix_keypad_start;
426 input_dev->close = matrix_keypad_stop;
427
01111fcd
DT
428 input_dev->keycode = keypad->keycodes;
429 input_dev->keycodesize = sizeof(keypad->keycodes[0]);
77a53fd2 430 input_dev->keycodemax = pdata->num_row_gpios << row_shift;
bab7614d 431
77a53fd2
DT
432 matrix_keypad_build_keymap(keymap_data, row_shift,
433 input_dev->keycode, input_dev->keybit);
bab7614d
EM
434
435 input_set_capability(input_dev, EV_MSC, MSC_SCAN);
436 input_set_drvdata(input_dev, keypad);
437
438 err = init_matrix_gpio(pdev, keypad);
439 if (err)
440 goto err_free_mem;
441
442 err = input_register_device(keypad->input_dev);
443 if (err)
444 goto err_free_mem;
445
446 device_init_wakeup(&pdev->dev, pdata->wakeup);
447 platform_set_drvdata(pdev, keypad);
448
449 return 0;
450
451err_free_mem:
452 input_free_device(input_dev);
bab7614d
EM
453 kfree(keypad);
454 return err;
455}
456
457static int __devexit matrix_keypad_remove(struct platform_device *pdev)
458{
459 struct matrix_keypad *keypad = platform_get_drvdata(pdev);
460 const struct matrix_keypad_platform_data *pdata = keypad->pdata;
461 int i;
462
463 device_init_wakeup(&pdev->dev, 0);
464
fb76dd10
LF
465 if (pdata->clustered_irq > 0) {
466 free_irq(pdata->clustered_irq, keypad);
467 } else {
468 for (i = 0; i < pdata->num_row_gpios; i++)
469 free_irq(gpio_to_irq(pdata->row_gpios[i]), keypad);
bab7614d
EM
470 }
471
fb76dd10
LF
472 for (i = 0; i < pdata->num_row_gpios; i++)
473 gpio_free(pdata->row_gpios[i]);
474
bab7614d
EM
475 for (i = 0; i < pdata->num_col_gpios; i++)
476 gpio_free(pdata->col_gpios[i]);
477
478 input_unregister_device(keypad->input_dev);
479 platform_set_drvdata(pdev, NULL);
bab7614d
EM
480 kfree(keypad);
481
482 return 0;
483}
484
485static struct platform_driver matrix_keypad_driver = {
486 .probe = matrix_keypad_probe,
487 .remove = __devexit_p(matrix_keypad_remove),
bab7614d
EM
488 .driver = {
489 .name = "matrix-keypad",
490 .owner = THIS_MODULE,
f72a28ab 491 .pm = &matrix_keypad_pm_ops,
bab7614d
EM
492 },
493};
5146c84f 494module_platform_driver(matrix_keypad_driver);
bab7614d
EM
495
496MODULE_AUTHOR("Marek Vasut <marek.vasut@gmail.com>");
497MODULE_DESCRIPTION("GPIO Driven Matrix Keypad Driver");
498MODULE_LICENSE("GPL v2");
499MODULE_ALIAS("platform:matrix-keypad");