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 <asm/arch/gpio.h>
39 #include <asm/arch/keypad.h>
40 #include <asm/arch/menelaus.h>
42 #include <asm/hardware.h>
44 #include <asm/mach-types.h>
45 #include <asm/arch/mux.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 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)
79 for (col = 0; col < omap_kp->cols; col++) {
80 if (value & (1 << col))
81 omap_set_gpio_dataout(col_gpios[col], 1);
83 omap_set_gpio_dataout(col_gpios[col], 0);
87 static u8 get_row_gpio_val(struct omap_kp *omap_kp)
92 for (row = 0; row < omap_kp->rows; row++) {
93 if (omap_get_gpio_datain(row_gpios[row]))
99 #define set_col_gpio_val(x, y) do {} while (0)
100 #define get_row_gpio_val(x) 0
103 static irqreturn_t omap_kp_interrupt(int irq, void *dev_id)
105 struct omap_kp *omap_kp = dev_id;
108 spin_lock_irqsave(&omap_kp->suspend_lock, flags);
109 if (omap_kp->suspended) {
110 spin_unlock_irqrestore(&omap_kp->suspend_lock, flags);
113 spin_unlock_irqrestore(&omap_kp->suspend_lock, flags);
115 /* disable keyboard interrupt and schedule for handling */
116 if (cpu_is_omap24xx()) {
118 for (i = 0; i < omap_kp->rows; i++)
119 disable_irq(OMAP_GPIO_IRQ(row_gpios[i]));
121 /* disable keyboard interrupt and schedule for handling */
122 omap_writew(1, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
124 tasklet_schedule(&kp_tasklet);
129 static void omap_kp_timer(unsigned long data)
131 tasklet_schedule(&kp_tasklet);
134 static void omap_kp_scan_keypad(struct omap_kp *omap_kp, unsigned char *state)
138 /* read the keypad status */
139 if (cpu_is_omap24xx()) {
141 for (i = 0; i < omap_kp->rows; i++)
142 disable_irq(OMAP_GPIO_IRQ(row_gpios[i]));
144 /* read the keypad status */
145 for (col = 0; col < omap_kp->cols; col++) {
146 set_col_gpio_val(omap_kp, ~(1 << col));
147 state[col] = ~(get_row_gpio_val(omap_kp)) & 0x3f;
149 set_col_gpio_val(omap_kp, 0);
152 /* disable keyboard interrupt and schedule for handling */
153 omap_writew(1, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
155 /* read the keypad status */
156 omap_writew(0xff, OMAP_MPUIO_BASE + OMAP_MPUIO_KBC);
157 for (col = 0; col < omap_kp->cols; col++) {
158 omap_writew(~(1 << col) & 0xff,
159 OMAP_MPUIO_BASE + OMAP_MPUIO_KBC);
161 udelay(omap_kp->delay);
163 state[col] = ~omap_readw(OMAP_MPUIO_BASE +
164 OMAP_MPUIO_KBR_LATCH) & 0xff;
166 omap_writew(0x00, OMAP_MPUIO_BASE + OMAP_MPUIO_KBC);
171 static inline int omap_kp_find_key(int col, int row)
175 key = KEY(col, row, 0);
176 for (i = 0; keymap[i] != 0; i++)
177 if ((keymap[i] & 0xff000000) == key)
178 return keymap[i] & 0x00ffffff;
182 static void omap_kp_tasklet(unsigned long data)
184 struct omap_kp *omap_kp_data = (struct omap_kp *) data;
185 unsigned char new_state[8], changed, key_down = 0;
189 /* check for any changes */
190 omap_kp_scan_keypad(omap_kp_data, new_state);
192 /* check for changes and print those */
193 for (col = 0; col < omap_kp_data->cols; col++) {
194 changed = new_state[col] ^ keypad_state[col];
195 key_down |= new_state[col];
199 for (row = 0; row < omap_kp_data->rows; row++) {
201 if (!(changed & (1 << row)))
203 #ifdef NEW_BOARD_LEARNING_MODE
204 printk(KERN_INFO "omap-keypad: key %d-%d %s\n", col,
205 row, (new_state[col] & (1 << row)) ?
206 "pressed" : "released");
208 key = omap_kp_find_key(col, row);
211 "omap-keypad: Spurious key event %d-%d\n",
213 /* We scan again after a couple of seconds */
218 if (!(kp_cur_group == (key & GROUP_MASK) ||
222 kp_cur_group = key & GROUP_MASK;
223 input_report_key(omap_kp_data->input, key & ~GROUP_MASK,
224 new_state[col] & (1 << row));
228 memcpy(keypad_state, new_state, sizeof(keypad_state));
232 /* some key is pressed - keep irq disabled and use timer
233 * to poll the keypad */
236 mod_timer(&omap_kp_data->timer, jiffies + delay);
238 /* enable interrupts */
239 if (cpu_is_omap24xx()) {
241 for (i = 0; i < omap_kp_data->rows; i++)
242 enable_irq(OMAP_GPIO_IRQ(row_gpios[i]));
244 omap_writew(0, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
250 static ssize_t omap_kp_enable_show(struct device *dev,
251 struct device_attribute *attr, char *buf)
253 return sprintf(buf, "%u\n", kp_enable);
256 static ssize_t omap_kp_enable_store(struct device *dev, struct device_attribute *attr,
257 const char *buf, size_t count)
261 if (sscanf(buf, "%u", &state) != 1)
264 if ((state != 1) && (state != 0))
267 mutex_lock(&kp_enable_mutex);
268 if (state != kp_enable) {
270 enable_irq(INT_KEYBOARD);
272 disable_irq(INT_KEYBOARD);
275 mutex_unlock(&kp_enable_mutex);
277 return strnlen(buf, count);
280 static DEVICE_ATTR(enable, S_IRUGO | S_IWUSR, omap_kp_enable_show, omap_kp_enable_store);
283 static int omap_kp_suspend(struct platform_device *dev, pm_message_t state)
285 struct omap_kp *omap_kp = platform_get_drvdata(dev);
287 spin_lock_irqsave(&omap_kp->suspend_lock, flags);
290 * Re-enable the interrupt in case it has been masked by the
291 * handler and a key is still pressed. We need the interrupt
292 * to wake us up from suspended.
294 if (cpu_class_is_omap1())
295 omap_writew(0, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
297 omap_kp->suspended = 1;
299 spin_unlock_irqrestore(&omap_kp->suspend_lock, flags);
303 static int omap_kp_resume(struct platform_device *dev)
305 struct omap_kp *omap_kp = platform_get_drvdata(dev);
307 omap_kp->suspended = 0;
311 #define omap_kp_suspend NULL
312 #define omap_kp_resume NULL
315 static int __init omap_kp_probe(struct platform_device *pdev)
317 struct omap_kp *omap_kp;
318 struct input_dev *input_dev;
319 struct omap_kp_platform_data *pdata = pdev->dev.platform_data;
320 int i, col_idx = 0, row_idx = 0, irq_idx, ret;
322 if (!pdata->rows || !pdata->cols || !pdata->keymap) {
323 printk(KERN_ERR "No rows, cols or keymap from pdata\n");
327 omap_kp = kzalloc(sizeof(struct omap_kp), GFP_KERNEL);
328 input_dev = input_allocate_device();
329 if (!omap_kp || !input_dev) {
331 input_free_device(input_dev);
335 platform_set_drvdata(pdev, omap_kp);
337 spin_lock_init(&omap_kp->suspend_lock);
338 omap_kp->input = input_dev;
339 omap_kp->suspended = 0;
341 /* Disable the interrupt for the MPUIO keyboard */
342 if (!cpu_is_omap24xx())
343 omap_writew(1, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
345 keymap = pdata->keymap;
348 set_bit(EV_REP, input_dev->evbit);
351 omap_kp->delay = pdata->delay;
353 if (pdata->row_gpios && pdata->col_gpios) {
354 row_gpios = pdata->row_gpios;
355 col_gpios = pdata->col_gpios;
358 omap_kp->rows = pdata->rows;
359 omap_kp->cols = pdata->cols;
361 if (cpu_is_omap24xx()) {
363 for (col_idx = 0; col_idx < omap_kp->cols; col_idx++) {
364 if (omap_request_gpio(col_gpios[col_idx]) < 0) {
365 printk(KERN_ERR "Failed to request"
366 "GPIO%d for keypad\n",
370 omap_set_gpio_direction(col_gpios[col_idx], 0);
373 for (row_idx = 0; row_idx < omap_kp->rows; row_idx++) {
374 if (omap_request_gpio(row_gpios[row_idx]) < 0) {
375 printk(KERN_ERR "Failed to request"
376 "GPIO%d for keypad\n",
380 omap_set_gpio_direction(row_gpios[row_idx], 1);
384 setup_timer(&omap_kp->timer, omap_kp_timer, (unsigned long)omap_kp);
386 /* get the irq and init timer*/
387 tasklet_enable(&kp_tasklet);
388 kp_tasklet.data = (unsigned long) omap_kp;
390 ret = device_create_file(&pdev->dev, &dev_attr_enable);
394 /* setup input device */
395 set_bit(EV_KEY, input_dev->evbit);
396 for (i = 0; keymap[i] != 0; i++)
397 set_bit(keymap[i] & KEY_MAX, input_dev->keybit);
398 input_dev->name = "omap-keypad";
399 input_dev->phys = "omap-keypad/input0";
400 input_dev->dev.parent = &pdev->dev;
402 input_dev->id.bustype = BUS_HOST;
403 input_dev->id.vendor = 0x0001;
404 input_dev->id.product = 0x0001;
405 input_dev->id.version = 0x0100;
407 input_dev->keycode = keymap;
408 input_dev->keycodesize = sizeof(unsigned int);
409 input_dev->keycodemax = pdata->keymapsize;
411 ret = input_register_device(omap_kp->input);
413 printk(KERN_ERR "Unable to register omap-keypad input device\n");
418 omap_writew(0xff, OMAP_MPUIO_BASE + OMAP_MPUIO_GPIO_DEBOUNCING);
420 /* scan current status and enable interrupt */
421 omap_kp_scan_keypad(omap_kp, keypad_state);
422 if (!cpu_is_omap24xx()) {
423 omap_kp->irq = platform_get_irq(pdev, 0);
424 if (omap_kp->irq >= 0) {
425 if (request_irq(omap_kp->irq, omap_kp_interrupt, 0,
426 "omap-keypad", omap_kp) < 0)
429 omap_writew(0, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
431 for (irq_idx = 0; irq_idx < omap_kp->rows; irq_idx++) {
432 if (request_irq(OMAP_GPIO_IRQ(row_gpios[irq_idx]),
434 IRQF_TRIGGER_FALLING,
435 "omap-keypad", omap_kp) < 0)
441 for (i = irq_idx-1; i >=0; i--)
442 free_irq(row_gpios[i], 0);
444 input_unregister_device(omap_kp->input);
447 device_remove_file(&pdev->dev, &dev_attr_enable);
449 for (i = row_idx-1; i >=0; i--)
450 omap_free_gpio(row_gpios[i]);
452 for (i = col_idx-1; i >=0; i--)
453 omap_free_gpio(col_gpios[i]);
456 input_free_device(input_dev);
461 static int omap_kp_remove(struct platform_device *pdev)
463 struct omap_kp *omap_kp = platform_get_drvdata(pdev);
465 /* disable keypad interrupt handling */
466 tasklet_disable(&kp_tasklet);
467 if (cpu_is_omap24xx()) {
469 for (i = 0; i < omap_kp->cols; i++)
470 omap_free_gpio(col_gpios[i]);
471 for (i = 0; i < omap_kp->rows; i++) {
472 omap_free_gpio(row_gpios[i]);
473 free_irq(OMAP_GPIO_IRQ(row_gpios[i]), 0);
476 omap_writew(1, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
477 free_irq(omap_kp->irq, 0);
480 del_timer_sync(&omap_kp->timer);
481 tasklet_kill(&kp_tasklet);
483 /* unregister everything */
484 input_unregister_device(omap_kp->input);
491 static struct platform_driver omap_kp_driver = {
492 .probe = omap_kp_probe,
493 .remove = omap_kp_remove,
494 .suspend = omap_kp_suspend,
495 .resume = omap_kp_resume,
497 .name = "omap-keypad",
501 static int __devinit omap_kp_init(void)
503 printk(KERN_INFO "OMAP Keypad Driver\n");
504 return platform_driver_register(&omap_kp_driver);
507 static void __exit omap_kp_exit(void)
509 platform_driver_unregister(&omap_kp_driver);
512 module_init(omap_kp_init);
513 module_exit(omap_kp_exit);
515 MODULE_AUTHOR("Timo Teräs");
516 MODULE_DESCRIPTION("OMAP Keypad Driver");
517 MODULE_LICENSE("GPL");