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/errno.h>
37 #include <linux/slab.h>
38 #include <mach/gpio.h>
39 #include <plat/keypad.h>
40 #include <plat/menelaus.h>
42 #include <mach/hardware.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;
57 struct input_dev *input;
58 struct timer_list timer;
63 unsigned int debounce;
66 static DECLARE_TASKLET_DISABLED(kp_tasklet, omap_kp_tasklet, 0);
69 static unsigned int *row_gpios;
70 static unsigned int *col_gpios;
72 #ifdef CONFIG_ARCH_OMAP2
73 static void set_col_gpio_val(struct omap_kp *omap_kp, u8 value)
77 for (col = 0; col < omap_kp->cols; col++)
78 gpio_set_value(col_gpios[col], value & (1 << col));
81 static u8 get_row_gpio_val(struct omap_kp *omap_kp)
86 for (row = 0; row < omap_kp->rows; row++) {
87 if (gpio_get_value(row_gpios[row]))
93 #define set_col_gpio_val(x, y) do {} while (0)
94 #define get_row_gpio_val(x) 0
97 static irqreturn_t omap_kp_interrupt(int irq, void *dev_id)
99 struct omap_kp *omap_kp = dev_id;
101 /* disable keyboard interrupt and schedule for handling */
102 if (cpu_is_omap24xx()) {
105 for (i = 0; i < omap_kp->rows; i++) {
106 int gpio_irq = gpio_to_irq(row_gpios[i]);
108 * The interrupt which we're currently handling should
109 * be disabled _nosync() to avoid deadlocks waiting
110 * for this handler to complete. All others should
111 * be disabled the regular way for SMP safety.
114 disable_irq_nosync(gpio_irq);
116 disable_irq(gpio_irq);
119 /* disable keyboard interrupt and schedule for handling */
120 omap_writew(1, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
122 tasklet_schedule(&kp_tasklet);
127 static void omap_kp_timer(unsigned long data)
129 tasklet_schedule(&kp_tasklet);
132 static void omap_kp_scan_keypad(struct omap_kp *omap_kp, unsigned char *state)
136 /* read the keypad status */
137 if (cpu_is_omap24xx()) {
138 /* read the keypad status */
139 for (col = 0; col < omap_kp->cols; col++) {
140 set_col_gpio_val(omap_kp, ~(1 << col));
141 state[col] = ~(get_row_gpio_val(omap_kp)) & 0xff;
143 set_col_gpio_val(omap_kp, 0);
146 /* disable keyboard interrupt and schedule for handling */
147 omap_writew(1, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
149 /* read the keypad status */
150 omap_writew(0xff, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBC);
151 for (col = 0; col < omap_kp->cols; col++) {
152 omap_writew(~(1 << col) & 0xff,
153 OMAP1_MPUIO_BASE + OMAP_MPUIO_KBC);
155 udelay(omap_kp->delay);
157 state[col] = ~omap_readw(OMAP1_MPUIO_BASE +
158 OMAP_MPUIO_KBR_LATCH) & 0xff;
160 omap_writew(0x00, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBC);
165 static inline int omap_kp_find_key(int col, int row)
169 key = KEY(col, row, 0);
170 for (i = 0; keymap[i] != 0; i++)
171 if ((keymap[i] & 0xff000000) == key)
172 return keymap[i] & 0x00ffffff;
176 static void omap_kp_tasklet(unsigned long data)
178 struct omap_kp *omap_kp_data = (struct omap_kp *) data;
179 unsigned char new_state[8], changed, key_down = 0;
183 /* check for any changes */
184 omap_kp_scan_keypad(omap_kp_data, new_state);
186 /* check for changes and print those */
187 for (col = 0; col < omap_kp_data->cols; col++) {
188 changed = new_state[col] ^ keypad_state[col];
189 key_down |= new_state[col];
193 for (row = 0; row < omap_kp_data->rows; row++) {
195 if (!(changed & (1 << row)))
197 #ifdef NEW_BOARD_LEARNING_MODE
198 printk(KERN_INFO "omap-keypad: key %d-%d %s\n", col,
199 row, (new_state[col] & (1 << row)) ?
200 "pressed" : "released");
202 key = omap_kp_find_key(col, row);
205 "omap-keypad: Spurious key event %d-%d\n",
207 /* We scan again after a couple of seconds */
212 if (!(kp_cur_group == (key & GROUP_MASK) ||
216 kp_cur_group = key & GROUP_MASK;
217 input_report_key(omap_kp_data->input, key & ~GROUP_MASK,
218 new_state[col] & (1 << row));
222 memcpy(keypad_state, new_state, sizeof(keypad_state));
226 /* some key is pressed - keep irq disabled and use timer
227 * to poll the keypad */
230 mod_timer(&omap_kp_data->timer, jiffies + delay);
232 /* enable interrupts */
233 if (cpu_is_omap24xx()) {
235 for (i = 0; i < omap_kp_data->rows; i++)
236 enable_irq(gpio_to_irq(row_gpios[i]));
238 omap_writew(0, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
244 static ssize_t omap_kp_enable_show(struct device *dev,
245 struct device_attribute *attr, char *buf)
247 return sprintf(buf, "%u\n", kp_enable);
250 static ssize_t omap_kp_enable_store(struct device *dev, struct device_attribute *attr,
251 const char *buf, size_t count)
255 if (sscanf(buf, "%u", &state) != 1)
258 if ((state != 1) && (state != 0))
261 mutex_lock(&kp_enable_mutex);
262 if (state != kp_enable) {
264 enable_irq(INT_KEYBOARD);
266 disable_irq(INT_KEYBOARD);
269 mutex_unlock(&kp_enable_mutex);
271 return strnlen(buf, count);
274 static DEVICE_ATTR(enable, S_IRUGO | S_IWUSR, omap_kp_enable_show, omap_kp_enable_store);
277 static int omap_kp_suspend(struct platform_device *dev, pm_message_t state)
284 static int omap_kp_resume(struct platform_device *dev)
291 #define omap_kp_suspend NULL
292 #define omap_kp_resume NULL
295 static int __devinit omap_kp_probe(struct platform_device *pdev)
297 struct omap_kp *omap_kp;
298 struct input_dev *input_dev;
299 struct omap_kp_platform_data *pdata = pdev->dev.platform_data;
300 int i, col_idx, row_idx, irq_idx, ret;
302 if (!pdata->rows || !pdata->cols || !pdata->keymap) {
303 printk(KERN_ERR "No rows, cols or keymap from pdata\n");
307 omap_kp = kzalloc(sizeof(struct omap_kp), GFP_KERNEL);
308 input_dev = input_allocate_device();
309 if (!omap_kp || !input_dev) {
311 input_free_device(input_dev);
315 platform_set_drvdata(pdev, omap_kp);
317 omap_kp->input = input_dev;
319 /* Disable the interrupt for the MPUIO keyboard */
320 if (!cpu_is_omap24xx())
321 omap_writew(1, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
323 keymap = pdata->keymap;
326 __set_bit(EV_REP, input_dev->evbit);
329 omap_kp->delay = pdata->delay;
331 if (pdata->row_gpios && pdata->col_gpios) {
332 row_gpios = pdata->row_gpios;
333 col_gpios = pdata->col_gpios;
336 omap_kp->rows = pdata->rows;
337 omap_kp->cols = pdata->cols;
339 if (cpu_is_omap24xx()) {
341 for (col_idx = 0; col_idx < omap_kp->cols; col_idx++) {
342 if (gpio_request(col_gpios[col_idx], "omap_kp_col") < 0) {
343 printk(KERN_ERR "Failed to request"
344 "GPIO%d for keypad\n",
348 gpio_direction_output(col_gpios[col_idx], 0);
351 for (row_idx = 0; row_idx < omap_kp->rows; row_idx++) {
352 if (gpio_request(row_gpios[row_idx], "omap_kp_row") < 0) {
353 printk(KERN_ERR "Failed to request"
354 "GPIO%d for keypad\n",
358 gpio_direction_input(row_gpios[row_idx]);
365 setup_timer(&omap_kp->timer, omap_kp_timer, (unsigned long)omap_kp);
367 /* get the irq and init timer*/
368 tasklet_enable(&kp_tasklet);
369 kp_tasklet.data = (unsigned long) omap_kp;
371 ret = device_create_file(&pdev->dev, &dev_attr_enable);
375 /* setup input device */
376 __set_bit(EV_KEY, input_dev->evbit);
377 for (i = 0; keymap[i] != 0; i++)
378 __set_bit(keymap[i] & KEY_MAX, input_dev->keybit);
379 input_dev->name = "omap-keypad";
380 input_dev->phys = "omap-keypad/input0";
381 input_dev->dev.parent = &pdev->dev;
383 input_dev->id.bustype = BUS_HOST;
384 input_dev->id.vendor = 0x0001;
385 input_dev->id.product = 0x0001;
386 input_dev->id.version = 0x0100;
388 ret = input_register_device(omap_kp->input);
390 printk(KERN_ERR "Unable to register omap-keypad input device\n");
395 omap_writew(0xff, OMAP1_MPUIO_BASE + OMAP_MPUIO_GPIO_DEBOUNCING);
397 /* scan current status and enable interrupt */
398 omap_kp_scan_keypad(omap_kp, keypad_state);
399 if (!cpu_is_omap24xx()) {
400 omap_kp->irq = platform_get_irq(pdev, 0);
401 if (omap_kp->irq >= 0) {
402 if (request_irq(omap_kp->irq, omap_kp_interrupt, 0,
403 "omap-keypad", omap_kp) < 0)
406 omap_writew(0, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
408 for (irq_idx = 0; irq_idx < omap_kp->rows; irq_idx++) {
409 if (request_irq(gpio_to_irq(row_gpios[irq_idx]),
411 IRQF_TRIGGER_FALLING,
412 "omap-keypad", omap_kp) < 0)
418 for (i = irq_idx - 1; i >=0; i--)
419 free_irq(row_gpios[i], 0);
421 input_unregister_device(omap_kp->input);
424 device_remove_file(&pdev->dev, &dev_attr_enable);
426 for (i = row_idx - 1; i >=0; i--)
427 gpio_free(row_gpios[i]);
429 for (i = col_idx - 1; i >=0; i--)
430 gpio_free(col_gpios[i]);
433 input_free_device(input_dev);
438 static int __devexit omap_kp_remove(struct platform_device *pdev)
440 struct omap_kp *omap_kp = platform_get_drvdata(pdev);
442 /* disable keypad interrupt handling */
443 tasklet_disable(&kp_tasklet);
444 if (cpu_is_omap24xx()) {
446 for (i = 0; i < omap_kp->cols; i++)
447 gpio_free(col_gpios[i]);
448 for (i = 0; i < omap_kp->rows; i++) {
449 gpio_free(row_gpios[i]);
450 free_irq(gpio_to_irq(row_gpios[i]), 0);
453 omap_writew(1, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
454 free_irq(omap_kp->irq, 0);
457 del_timer_sync(&omap_kp->timer);
458 tasklet_kill(&kp_tasklet);
460 /* unregister everything */
461 input_unregister_device(omap_kp->input);
468 static struct platform_driver omap_kp_driver = {
469 .probe = omap_kp_probe,
470 .remove = __devexit_p(omap_kp_remove),
471 .suspend = omap_kp_suspend,
472 .resume = omap_kp_resume,
474 .name = "omap-keypad",
475 .owner = THIS_MODULE,
479 static int __init omap_kp_init(void)
481 printk(KERN_INFO "OMAP Keypad Driver\n");
482 return platform_driver_register(&omap_kp_driver);
485 static void __exit omap_kp_exit(void)
487 platform_driver_unregister(&omap_kp_driver);
490 module_init(omap_kp_init);
491 module_exit(omap_kp_exit);
493 MODULE_AUTHOR("Timo Teräs");
494 MODULE_DESCRIPTION("OMAP Keypad Driver");
495 MODULE_LICENSE("GPL");
496 MODULE_ALIAS("platform:omap-keypad");