Merge remote-tracking branch 's5p/for-next'
[linux-2.6/next.git] / drivers / input / keyboard / omap-keypad.c
blob323bcdfff2484b6d3ddf22fddcb343216c879ee6
1 /*
2 * linux/drivers/input/keyboard/omap-keypad.c
4 * OMAP Keypad Driver
6 * Copyright (C) 2003 Nokia Corporation
7 * Written by Timo Teräs <ext-timo.teras@nokia.com>
9 * Added support for H2 & H3 Keypad
10 * Copyright (C) 2004 Texas Instruments
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 #include <linux/module.h>
28 #include <linux/init.h>
29 #include <linux/interrupt.h>
30 #include <linux/types.h>
31 #include <linux/input.h>
32 #include <linux/kernel.h>
33 #include <linux/delay.h>
34 #include <linux/platform_device.h>
35 #include <linux/mutex.h>
36 #include <linux/errno.h>
37 #include <linux/slab.h>
38 #include <asm/gpio.h>
39 #include <plat/keypad.h>
40 #include <plat/menelaus.h>
41 #include <asm/irq.h>
42 #include <mach/hardware.h>
43 #include <asm/io.h>
44 #include <plat/mux.h>
46 #undef NEW_BOARD_LEARNING_MODE
48 static void omap_kp_tasklet(unsigned long);
49 static void omap_kp_timer(unsigned long);
51 static unsigned char keypad_state[8];
52 static DEFINE_MUTEX(kp_enable_mutex);
53 static int kp_enable = 1;
54 static int kp_cur_group = -1;
56 struct omap_kp {
57 struct input_dev *input;
58 struct timer_list timer;
59 int irq;
60 unsigned int rows;
61 unsigned int cols;
62 unsigned long delay;
63 unsigned int debounce;
66 static DECLARE_TASKLET_DISABLED(kp_tasklet, omap_kp_tasklet, 0);
68 static unsigned int *row_gpios;
69 static unsigned int *col_gpios;
71 #ifdef CONFIG_ARCH_OMAP2
72 static void set_col_gpio_val(struct omap_kp *omap_kp, u8 value)
74 int col;
76 for (col = 0; col < omap_kp->cols; col++)
77 gpio_set_value(col_gpios[col], value & (1 << col));
80 static u8 get_row_gpio_val(struct omap_kp *omap_kp)
82 int row;
83 u8 value = 0;
85 for (row = 0; row < omap_kp->rows; row++) {
86 if (gpio_get_value(row_gpios[row]))
87 value |= (1 << row);
89 return value;
91 #else
92 #define set_col_gpio_val(x, y) do {} while (0)
93 #define get_row_gpio_val(x) 0
94 #endif
96 static irqreturn_t omap_kp_interrupt(int irq, void *dev_id)
98 struct omap_kp *omap_kp = dev_id;
100 /* disable keyboard interrupt and schedule for handling */
101 if (cpu_is_omap24xx()) {
102 int i;
104 for (i = 0; i < omap_kp->rows; i++) {
105 int gpio_irq = gpio_to_irq(row_gpios[i]);
107 * The interrupt which we're currently handling should
108 * be disabled _nosync() to avoid deadlocks waiting
109 * for this handler to complete. All others should
110 * be disabled the regular way for SMP safety.
112 if (gpio_irq == irq)
113 disable_irq_nosync(gpio_irq);
114 else
115 disable_irq(gpio_irq);
117 } else
118 /* disable keyboard interrupt and schedule for handling */
119 omap_writew(1, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
121 tasklet_schedule(&kp_tasklet);
123 return IRQ_HANDLED;
126 static void omap_kp_timer(unsigned long data)
128 tasklet_schedule(&kp_tasklet);
131 static void omap_kp_scan_keypad(struct omap_kp *omap_kp, unsigned char *state)
133 int col = 0;
135 /* read the keypad status */
136 if (cpu_is_omap24xx()) {
137 /* read the keypad status */
138 for (col = 0; col < omap_kp->cols; col++) {
139 set_col_gpio_val(omap_kp, ~(1 << col));
140 state[col] = ~(get_row_gpio_val(omap_kp)) & 0xff;
142 set_col_gpio_val(omap_kp, 0);
144 } else {
145 /* disable keyboard interrupt and schedule for handling */
146 omap_writew(1, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
148 /* read the keypad status */
149 omap_writew(0xff, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBC);
150 for (col = 0; col < omap_kp->cols; col++) {
151 omap_writew(~(1 << col) & 0xff,
152 OMAP1_MPUIO_BASE + OMAP_MPUIO_KBC);
154 udelay(omap_kp->delay);
156 state[col] = ~omap_readw(OMAP1_MPUIO_BASE +
157 OMAP_MPUIO_KBR_LATCH) & 0xff;
159 omap_writew(0x00, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBC);
160 udelay(2);
164 static void omap_kp_tasklet(unsigned long data)
166 struct omap_kp *omap_kp_data = (struct omap_kp *) data;
167 unsigned short *keycodes = omap_kp_data->input->keycode;
168 unsigned int row_shift = get_count_order(omap_kp_data->cols);
169 unsigned char new_state[8], changed, key_down = 0;
170 int col, row;
171 int spurious = 0;
173 /* check for any changes */
174 omap_kp_scan_keypad(omap_kp_data, new_state);
176 /* check for changes and print those */
177 for (col = 0; col < omap_kp_data->cols; col++) {
178 changed = new_state[col] ^ keypad_state[col];
179 key_down |= new_state[col];
180 if (changed == 0)
181 continue;
183 for (row = 0; row < omap_kp_data->rows; row++) {
184 int key;
185 if (!(changed & (1 << row)))
186 continue;
187 #ifdef NEW_BOARD_LEARNING_MODE
188 printk(KERN_INFO "omap-keypad: key %d-%d %s\n", col,
189 row, (new_state[col] & (1 << row)) ?
190 "pressed" : "released");
191 #else
192 key = keycodes[MATRIX_SCAN_CODE(row, col, row_shift)];
193 if (key < 0) {
194 printk(KERN_WARNING
195 "omap-keypad: Spurious key event %d-%d\n",
196 col, row);
197 /* We scan again after a couple of seconds */
198 spurious = 1;
199 continue;
202 if (!(kp_cur_group == (key & GROUP_MASK) ||
203 kp_cur_group == -1))
204 continue;
206 kp_cur_group = key & GROUP_MASK;
207 input_report_key(omap_kp_data->input, key & ~GROUP_MASK,
208 new_state[col] & (1 << row));
209 #endif
212 input_sync(omap_kp_data->input);
213 memcpy(keypad_state, new_state, sizeof(keypad_state));
215 if (key_down) {
216 int delay = HZ / 20;
217 /* some key is pressed - keep irq disabled and use timer
218 * to poll the keypad */
219 if (spurious)
220 delay = 2 * HZ;
221 mod_timer(&omap_kp_data->timer, jiffies + delay);
222 } else {
223 /* enable interrupts */
224 if (cpu_is_omap24xx()) {
225 int i;
226 for (i = 0; i < omap_kp_data->rows; i++)
227 enable_irq(gpio_to_irq(row_gpios[i]));
228 } else {
229 omap_writew(0, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
230 kp_cur_group = -1;
235 static ssize_t omap_kp_enable_show(struct device *dev,
236 struct device_attribute *attr, char *buf)
238 return sprintf(buf, "%u\n", kp_enable);
241 static ssize_t omap_kp_enable_store(struct device *dev, struct device_attribute *attr,
242 const char *buf, size_t count)
244 int state;
246 if (sscanf(buf, "%u", &state) != 1)
247 return -EINVAL;
249 if ((state != 1) && (state != 0))
250 return -EINVAL;
252 mutex_lock(&kp_enable_mutex);
253 if (state != kp_enable) {
254 if (state)
255 enable_irq(INT_KEYBOARD);
256 else
257 disable_irq(INT_KEYBOARD);
258 kp_enable = state;
260 mutex_unlock(&kp_enable_mutex);
262 return strnlen(buf, count);
265 static DEVICE_ATTR(enable, S_IRUGO | S_IWUSR, omap_kp_enable_show, omap_kp_enable_store);
267 #ifdef CONFIG_PM
268 static int omap_kp_suspend(struct platform_device *dev, pm_message_t state)
270 /* Nothing yet */
272 return 0;
275 static int omap_kp_resume(struct platform_device *dev)
277 /* Nothing yet */
279 return 0;
281 #else
282 #define omap_kp_suspend NULL
283 #define omap_kp_resume NULL
284 #endif
286 static int __devinit omap_kp_probe(struct platform_device *pdev)
288 struct omap_kp *omap_kp;
289 struct input_dev *input_dev;
290 struct omap_kp_platform_data *pdata = pdev->dev.platform_data;
291 int i, col_idx, row_idx, irq_idx, ret;
292 unsigned int row_shift, keycodemax;
294 if (!pdata->rows || !pdata->cols || !pdata->keymap_data) {
295 printk(KERN_ERR "No rows, cols or keymap_data from pdata\n");
296 return -EINVAL;
299 row_shift = get_count_order(pdata->cols);
300 keycodemax = pdata->rows << row_shift;
302 omap_kp = kzalloc(sizeof(struct omap_kp) +
303 keycodemax * sizeof(unsigned short), GFP_KERNEL);
304 input_dev = input_allocate_device();
305 if (!omap_kp || !input_dev) {
306 kfree(omap_kp);
307 input_free_device(input_dev);
308 return -ENOMEM;
311 platform_set_drvdata(pdev, omap_kp);
313 omap_kp->input = input_dev;
315 /* Disable the interrupt for the MPUIO keyboard */
316 if (!cpu_is_omap24xx())
317 omap_writew(1, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
319 input_dev->keycode = &omap_kp[1];
320 input_dev->keycodesize = sizeof(unsigned short);
321 input_dev->keycodemax = keycodemax;
323 if (pdata->rep)
324 __set_bit(EV_REP, input_dev->evbit);
326 if (pdata->delay)
327 omap_kp->delay = pdata->delay;
329 if (pdata->row_gpios && pdata->col_gpios) {
330 row_gpios = pdata->row_gpios;
331 col_gpios = pdata->col_gpios;
334 omap_kp->rows = pdata->rows;
335 omap_kp->cols = pdata->cols;
337 if (cpu_is_omap24xx()) {
338 /* Cols: outputs */
339 for (col_idx = 0; col_idx < omap_kp->cols; col_idx++) {
340 if (gpio_request(col_gpios[col_idx], "omap_kp_col") < 0) {
341 printk(KERN_ERR "Failed to request"
342 "GPIO%d for keypad\n",
343 col_gpios[col_idx]);
344 goto err1;
346 gpio_direction_output(col_gpios[col_idx], 0);
348 /* Rows: inputs */
349 for (row_idx = 0; row_idx < omap_kp->rows; row_idx++) {
350 if (gpio_request(row_gpios[row_idx], "omap_kp_row") < 0) {
351 printk(KERN_ERR "Failed to request"
352 "GPIO%d for keypad\n",
353 row_gpios[row_idx]);
354 goto err2;
356 gpio_direction_input(row_gpios[row_idx]);
358 } else {
359 col_idx = 0;
360 row_idx = 0;
363 setup_timer(&omap_kp->timer, omap_kp_timer, (unsigned long)omap_kp);
365 /* get the irq and init timer*/
366 tasklet_enable(&kp_tasklet);
367 kp_tasklet.data = (unsigned long) omap_kp;
369 ret = device_create_file(&pdev->dev, &dev_attr_enable);
370 if (ret < 0)
371 goto err2;
373 /* setup input device */
374 __set_bit(EV_KEY, input_dev->evbit);
375 matrix_keypad_build_keymap(pdata->keymap_data, row_shift,
376 input_dev->keycode, input_dev->keybit);
377 input_dev->name = "omap-keypad";
378 input_dev->phys = "omap-keypad/input0";
379 input_dev->dev.parent = &pdev->dev;
381 input_dev->id.bustype = BUS_HOST;
382 input_dev->id.vendor = 0x0001;
383 input_dev->id.product = 0x0001;
384 input_dev->id.version = 0x0100;
386 ret = input_register_device(omap_kp->input);
387 if (ret < 0) {
388 printk(KERN_ERR "Unable to register omap-keypad input device\n");
389 goto err3;
392 if (pdata->dbounce)
393 omap_writew(0xff, OMAP1_MPUIO_BASE + OMAP_MPUIO_GPIO_DEBOUNCING);
395 /* scan current status and enable interrupt */
396 omap_kp_scan_keypad(omap_kp, keypad_state);
397 if (!cpu_is_omap24xx()) {
398 omap_kp->irq = platform_get_irq(pdev, 0);
399 if (omap_kp->irq >= 0) {
400 if (request_irq(omap_kp->irq, omap_kp_interrupt, 0,
401 "omap-keypad", omap_kp) < 0)
402 goto err4;
404 omap_writew(0, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
405 } else {
406 for (irq_idx = 0; irq_idx < omap_kp->rows; irq_idx++) {
407 if (request_irq(gpio_to_irq(row_gpios[irq_idx]),
408 omap_kp_interrupt,
409 IRQF_TRIGGER_FALLING,
410 "omap-keypad", omap_kp) < 0)
411 goto err5;
414 return 0;
415 err5:
416 for (i = irq_idx - 1; i >=0; i--)
417 free_irq(row_gpios[i], omap_kp);
418 err4:
419 input_unregister_device(omap_kp->input);
420 input_dev = NULL;
421 err3:
422 device_remove_file(&pdev->dev, &dev_attr_enable);
423 err2:
424 for (i = row_idx - 1; i >=0; i--)
425 gpio_free(row_gpios[i]);
426 err1:
427 for (i = col_idx - 1; i >=0; i--)
428 gpio_free(col_gpios[i]);
430 kfree(omap_kp);
431 input_free_device(input_dev);
433 return -EINVAL;
436 static int __devexit omap_kp_remove(struct platform_device *pdev)
438 struct omap_kp *omap_kp = platform_get_drvdata(pdev);
440 /* disable keypad interrupt handling */
441 tasklet_disable(&kp_tasklet);
442 if (cpu_is_omap24xx()) {
443 int i;
444 for (i = 0; i < omap_kp->cols; i++)
445 gpio_free(col_gpios[i]);
446 for (i = 0; i < omap_kp->rows; i++) {
447 gpio_free(row_gpios[i]);
448 free_irq(gpio_to_irq(row_gpios[i]), omap_kp);
450 } else {
451 omap_writew(1, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
452 free_irq(omap_kp->irq, omap_kp);
455 del_timer_sync(&omap_kp->timer);
456 tasklet_kill(&kp_tasklet);
458 /* unregister everything */
459 input_unregister_device(omap_kp->input);
461 kfree(omap_kp);
463 return 0;
466 static struct platform_driver omap_kp_driver = {
467 .probe = omap_kp_probe,
468 .remove = __devexit_p(omap_kp_remove),
469 .suspend = omap_kp_suspend,
470 .resume = omap_kp_resume,
471 .driver = {
472 .name = "omap-keypad",
473 .owner = THIS_MODULE,
477 static int __init omap_kp_init(void)
479 printk(KERN_INFO "OMAP Keypad Driver\n");
480 return platform_driver_register(&omap_kp_driver);
483 static void __exit omap_kp_exit(void)
485 platform_driver_unregister(&omap_kp_driver);
488 module_init(omap_kp_init);
489 module_exit(omap_kp_exit);
491 MODULE_AUTHOR("Timo Teräs");
492 MODULE_DESCRIPTION("OMAP Keypad Driver");
493 MODULE_LICENSE("GPL");
494 MODULE_ALIAS("platform:omap-keypad");