2 * linux/drivers/input/keyboard/omap-keypad.c
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/spinlock.h>
37 #include <linux/errno.h>
38 #include <linux/i2c/menelaus.h>
39 #include <mach/gpio.h>
40 #include <mach/keypad.h>
42 #include <mach/hardware.h>
44 #include <asm/mach-types.h>
47 #undef NEW_BOARD_LEARNING_MODE
49 static void omap_kp_tasklet(unsigned long);
50 static void omap_kp_timer(unsigned long);
52 static unsigned char keypad_state[8];
53 static DEFINE_MUTEX(kp_enable_mutex);
54 static int kp_enable = 1;
55 static int kp_cur_group = -1;
58 struct input_dev *input;
59 struct timer_list timer;
64 unsigned int debounce;
66 spinlock_t suspend_lock;
69 static DECLARE_TASKLET_DISABLED(kp_tasklet, omap_kp_tasklet, 0);
72 static unsigned int *row_gpios;
73 static unsigned int *col_gpios;
75 #ifdef CONFIG_ARCH_OMAP2
76 static void set_col_gpio_val(struct omap_kp *omap_kp, u8 value)
80 for (col = 0; col < omap_kp->cols; col++)
81 gpio_set_value(col_gpios[col], value & (1 << col));
84 static u8 get_row_gpio_val(struct omap_kp *omap_kp)
89 for (row = 0; row < omap_kp->rows; row++) {
90 if (gpio_get_value(row_gpios[row]))
96 #define set_col_gpio_val(x, y) do {} while (0)
97 #define get_row_gpio_val(x) 0
100 static irqreturn_t omap_kp_interrupt(int irq, void *dev_id)
102 struct omap_kp *omap_kp = dev_id;
105 spin_lock_irqsave(&omap_kp->suspend_lock, flags);
106 if (omap_kp->suspended) {
107 spin_unlock_irqrestore(&omap_kp->suspend_lock, flags);
110 spin_unlock_irqrestore(&omap_kp->suspend_lock, flags);
112 /* disable keyboard interrupt and schedule for handling */
113 if (cpu_is_omap24xx()) {
115 for (i = 0; i < omap_kp->rows; i++)
116 disable_irq(gpio_to_irq(row_gpios[i]));
118 /* disable keyboard interrupt and schedule for handling */
119 omap_writew(1, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
121 tasklet_schedule(&kp_tasklet);
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)
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);
145 /* disable keyboard interrupt and schedule for handling */
146 omap_writew(1, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
148 /* read the keypad status */
149 omap_writew(0xff, OMAP_MPUIO_BASE + OMAP_MPUIO_KBC);
150 for (col = 0; col < omap_kp->cols; col++) {
151 omap_writew(~(1 << col) & 0xff,
152 OMAP_MPUIO_BASE + OMAP_MPUIO_KBC);
154 udelay(omap_kp->delay);
156 state[col] = ~omap_readw(OMAP_MPUIO_BASE +
157 OMAP_MPUIO_KBR_LATCH) & 0xff;
159 omap_writew(0x00, OMAP_MPUIO_BASE + OMAP_MPUIO_KBC);
164 static inline int omap_kp_find_key(int col, int row)
168 key = KEY(col, row, 0);
169 for (i = 0; keymap[i] != 0; i++)
170 if ((keymap[i] & 0xff000000) == key)
171 return keymap[i] & 0x00ffffff;
175 static void omap_kp_tasklet(unsigned long data)
177 struct omap_kp *omap_kp_data = (struct omap_kp *) data;
178 unsigned char new_state[8], changed, key_down = 0;
182 /* check for any changes */
183 omap_kp_scan_keypad(omap_kp_data, new_state);
185 /* check for changes and print those */
186 for (col = 0; col < omap_kp_data->cols; col++) {
187 changed = new_state[col] ^ keypad_state[col];
188 key_down |= new_state[col];
192 for (row = 0; row < omap_kp_data->rows; row++) {
194 if (!(changed & (1 << row)))
196 #ifdef NEW_BOARD_LEARNING_MODE
197 printk(KERN_INFO "omap-keypad: key %d-%d %s\n", col,
198 row, (new_state[col] & (1 << row)) ?
199 "pressed" : "released");
201 key = omap_kp_find_key(col, row);
204 "omap-keypad: Spurious key event %d-%d\n",
206 /* We scan again after a couple of seconds */
211 if (!(kp_cur_group == (key & GROUP_MASK) ||
215 kp_cur_group = key & GROUP_MASK;
216 input_report_key(omap_kp_data->input, key & ~GROUP_MASK,
217 new_state[col] & (1 << row));
221 memcpy(keypad_state, new_state, sizeof(keypad_state));
225 /* some key is pressed - keep irq disabled and use timer
226 * to poll the keypad */
229 mod_timer(&omap_kp_data->timer, jiffies + delay);
231 /* enable interrupts */
232 if (cpu_is_omap24xx()) {
234 for (i = 0; i < omap_kp_data->rows; i++)
235 enable_irq(gpio_to_irq(row_gpios[i]));
237 omap_writew(0, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
243 static ssize_t omap_kp_enable_show(struct device *dev,
244 struct device_attribute *attr, char *buf)
246 return sprintf(buf, "%u\n", kp_enable);
249 static ssize_t omap_kp_enable_store(struct device *dev, struct device_attribute *attr,
250 const char *buf, size_t count)
254 if (sscanf(buf, "%u", &state) != 1)
257 if ((state != 1) && (state != 0))
260 mutex_lock(&kp_enable_mutex);
261 if (state != kp_enable) {
263 enable_irq(INT_KEYBOARD);
265 disable_irq(INT_KEYBOARD);
268 mutex_unlock(&kp_enable_mutex);
270 return strnlen(buf, count);
273 static DEVICE_ATTR(enable, S_IRUGO | S_IWUSR, omap_kp_enable_show, omap_kp_enable_store);
276 static int omap_kp_suspend(struct platform_device *dev, pm_message_t state)
278 struct omap_kp *omap_kp = platform_get_drvdata(dev);
280 spin_lock_irqsave(&omap_kp->suspend_lock, flags);
283 * Re-enable the interrupt in case it has been masked by the
284 * handler and a key is still pressed. We need the interrupt
285 * to wake us up from suspended.
287 if (cpu_class_is_omap1())
288 omap_writew(0, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
290 omap_kp->suspended = 1;
292 spin_unlock_irqrestore(&omap_kp->suspend_lock, flags);
296 static int omap_kp_resume(struct platform_device *dev)
298 struct omap_kp *omap_kp = platform_get_drvdata(dev);
300 omap_kp->suspended = 0;
304 #define omap_kp_suspend NULL
305 #define omap_kp_resume NULL
308 static int __devinit omap_kp_probe(struct platform_device *pdev)
310 struct omap_kp *omap_kp;
311 struct input_dev *input_dev;
312 struct omap_kp_platform_data *pdata = pdev->dev.platform_data;
313 int i, col_idx = 0, row_idx = 0, irq_idx, ret;
315 if (!pdata->rows || !pdata->cols || !pdata->keymap) {
316 printk(KERN_ERR "No rows, cols or keymap from pdata\n");
320 omap_kp = kzalloc(sizeof(struct omap_kp), GFP_KERNEL);
321 input_dev = input_allocate_device();
322 if (!omap_kp || !input_dev) {
324 input_free_device(input_dev);
328 platform_set_drvdata(pdev, omap_kp);
330 spin_lock_init(&omap_kp->suspend_lock);
331 omap_kp->input = input_dev;
332 omap_kp->suspended = 0;
334 /* Disable the interrupt for the MPUIO keyboard */
335 if (!cpu_is_omap24xx())
336 omap_writew(1, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
338 keymap = pdata->keymap;
341 __set_bit(EV_REP, input_dev->evbit);
344 omap_kp->delay = pdata->delay;
346 if (pdata->row_gpios && pdata->col_gpios) {
347 row_gpios = pdata->row_gpios;
348 col_gpios = pdata->col_gpios;
351 omap_kp->rows = pdata->rows;
352 omap_kp->cols = pdata->cols;
354 if (cpu_is_omap24xx()) {
356 for (col_idx = 0; col_idx < omap_kp->cols; col_idx++) {
357 if (gpio_request(col_gpios[col_idx], "omap_kp_col") < 0) {
358 printk(KERN_ERR "Failed to request"
359 "GPIO%d for keypad\n",
363 gpio_direction_output(col_gpios[col_idx], 0);
366 for (row_idx = 0; row_idx < omap_kp->rows; row_idx++) {
367 if (gpio_request(row_gpios[row_idx], "omap_kp_row") < 0) {
368 printk(KERN_ERR "Failed to request"
369 "GPIO%d for keypad\n",
373 gpio_direction_input(row_gpios[row_idx]);
380 setup_timer(&omap_kp->timer, omap_kp_timer, (unsigned long)omap_kp);
382 /* get the irq and init timer*/
383 tasklet_enable(&kp_tasklet);
384 kp_tasklet.data = (unsigned long) omap_kp;
386 ret = device_create_file(&pdev->dev, &dev_attr_enable);
390 /* setup input device */
391 __set_bit(EV_KEY, input_dev->evbit);
392 for (i = 0; keymap[i] != 0; i++)
393 __set_bit(keymap[i] & KEY_MAX, input_dev->keybit);
394 input_dev->name = "omap-keypad";
395 input_dev->phys = "omap-keypad/input0";
396 input_dev->dev.parent = &pdev->dev;
398 input_dev->id.bustype = BUS_HOST;
399 input_dev->id.vendor = 0x0001;
400 input_dev->id.product = 0x0001;
401 input_dev->id.version = 0x0100;
403 ret = input_register_device(omap_kp->input);
405 printk(KERN_ERR "Unable to register omap-keypad input device\n");
410 omap_writew(0xff, OMAP_MPUIO_BASE + OMAP_MPUIO_GPIO_DEBOUNCING);
412 /* scan current status and enable interrupt */
413 omap_kp_scan_keypad(omap_kp, keypad_state);
414 if (!cpu_is_omap24xx()) {
415 omap_kp->irq = platform_get_irq(pdev, 0);
416 if (omap_kp->irq >= 0) {
417 if (request_irq(omap_kp->irq, omap_kp_interrupt, 0,
418 "omap-keypad", omap_kp) < 0)
421 omap_writew(0, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
423 for (irq_idx = 0; irq_idx < omap_kp->rows; irq_idx++) {
424 if (request_irq(gpio_to_irq(row_gpios[irq_idx]),
426 IRQF_TRIGGER_FALLING,
427 "omap-keypad", omap_kp) < 0)
433 for (i = irq_idx - 1; i >=0; i--)
434 free_irq(row_gpios[i], 0);
436 input_unregister_device(omap_kp->input);
439 device_remove_file(&pdev->dev, &dev_attr_enable);
441 for (i = row_idx - 1; i >=0; i--)
442 gpio_free(row_gpios[i]);
444 for (i = col_idx - 1; i >=0; i--)
445 gpio_free(col_gpios[i]);
448 input_free_device(input_dev);
453 static int __devexit omap_kp_remove(struct platform_device *pdev)
455 struct omap_kp *omap_kp = platform_get_drvdata(pdev);
457 /* disable keypad interrupt handling */
458 tasklet_disable(&kp_tasklet);
459 if (cpu_is_omap24xx()) {
461 for (i = 0; i < omap_kp->cols; i++)
462 gpio_free(col_gpios[i]);
463 for (i = 0; i < omap_kp->rows; i++) {
464 gpio_free(row_gpios[i]);
465 free_irq(gpio_to_irq(row_gpios[i]), 0);
468 omap_writew(1, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
469 free_irq(omap_kp->irq, 0);
472 del_timer_sync(&omap_kp->timer);
473 tasklet_kill(&kp_tasklet);
475 /* unregister everything */
476 input_unregister_device(omap_kp->input);
483 static struct platform_driver omap_kp_driver = {
484 .probe = omap_kp_probe,
485 .remove = __devexit_p(omap_kp_remove),
486 .suspend = omap_kp_suspend,
487 .resume = omap_kp_resume,
489 .name = "omap-keypad",
490 .owner = THIS_MODULE,
494 static int __init omap_kp_init(void)
496 printk(KERN_INFO "OMAP Keypad Driver\n");
497 return platform_driver_register(&omap_kp_driver);
500 static void __exit omap_kp_exit(void)
502 platform_driver_unregister(&omap_kp_driver);
505 module_init(omap_kp_init);
506 module_exit(omap_kp_exit);
508 MODULE_AUTHOR("Timo Teräs");
509 MODULE_DESCRIPTION("OMAP Keypad Driver");
510 MODULE_LICENSE("GPL");
511 MODULE_ALIAS("platform:omap-keypad");