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 <asm/arch/gpio.h>
38 #include <asm/arch/keypad.h>
39 #include <asm/arch/menelaus.h>
41 #include <asm/hardware.h>
43 #include <asm/mach-types.h>
44 #include <asm/arch/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;
57 struct input_dev *input;
58 struct timer_list timer;
63 unsigned int debounce;
66 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)
76 for (col = 0; col < omap_kp->cols; col++) {
77 if (value & (1 << col))
78 omap_set_gpio_dataout(col_gpios[col], 1);
80 omap_set_gpio_dataout(col_gpios[col], 0);
84 static u8 get_row_gpio_val(struct omap_kp *omap_kp)
89 for (row = 0; row < omap_kp->rows; row++) {
90 if (omap_get_gpio_datain(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,
101 struct pt_regs *regs)
103 struct omap_kp *omap_kp = dev_id;
105 /* disable keyboard interrupt and schedule for handling */
106 if (cpu_is_omap24xx()) {
108 for (i = 0; i < omap_kp->rows; i++)
109 disable_irq(OMAP_GPIO_IRQ(row_gpios[i]));
111 /* disable keyboard interrupt and schedule for handling */
112 omap_writew(1, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
114 tasklet_schedule(&kp_tasklet);
119 static void omap_kp_timer(unsigned long data)
121 tasklet_schedule(&kp_tasklet);
124 static void omap_kp_scan_keypad(struct omap_kp *omap_kp, unsigned char *state)
128 /* read the keypad status */
129 if (cpu_is_omap24xx()) {
131 for (i = 0; i < omap_kp->rows; i++)
132 disable_irq(OMAP_GPIO_IRQ(row_gpios[i]));
134 /* read the keypad status */
135 for (col = 0; col < omap_kp->cols; col++) {
136 set_col_gpio_val(omap_kp, ~(1 << col));
137 state[col] = ~(get_row_gpio_val(omap_kp)) & 0x3f;
139 set_col_gpio_val(omap_kp, 0);
142 /* disable keyboard interrupt and schedule for handling */
143 omap_writew(1, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
145 /* read the keypad status */
146 omap_writew(0xff, OMAP_MPUIO_BASE + OMAP_MPUIO_KBC);
147 for (col = 0; col < omap_kp->cols; col++) {
148 omap_writew(~(1 << col) & 0xff,
149 OMAP_MPUIO_BASE + OMAP_MPUIO_KBC);
151 udelay(omap_kp->delay);
153 state[col] = ~omap_readw(OMAP_MPUIO_BASE +
154 OMAP_MPUIO_KBR_LATCH) & 0xff;
156 omap_writew(0x00, OMAP_MPUIO_BASE + OMAP_MPUIO_KBC);
161 static inline int omap_kp_find_key(int col, int row)
165 key = KEY(col, row, 0);
166 for (i = 0; keymap[i] != 0; i++)
167 if ((keymap[i] & 0xff000000) == key)
168 return keymap[i] & 0x00ffffff;
172 static void omap_kp_tasklet(unsigned long data)
174 struct omap_kp *omap_kp_data = (struct omap_kp *) data;
175 unsigned char new_state[8], changed, key_down = 0;
179 /* check for any changes */
180 omap_kp_scan_keypad(omap_kp_data, new_state);
182 /* check for changes and print those */
183 for (col = 0; col < omap_kp_data->cols; col++) {
184 changed = new_state[col] ^ keypad_state[col];
185 key_down |= new_state[col];
189 for (row = 0; row < omap_kp_data->rows; row++) {
191 if (!(changed & (1 << row)))
193 #ifdef NEW_BOARD_LEARNING_MODE
194 printk(KERN_INFO "omap-keypad: key %d-%d %s\n", col,
195 row, (new_state[col] & (1 << row)) ?
196 "pressed" : "released");
198 key = omap_kp_find_key(col, row);
201 "omap-keypad: Spurious key event %d-%d\n",
203 /* We scan again after a couple of seconds */
208 if (!(kp_cur_group == (key & GROUP_MASK) ||
212 kp_cur_group = key & GROUP_MASK;
213 input_report_key(omap_kp_data->input, key & ~GROUP_MASK,
214 new_state[col] & (1 << row));
218 memcpy(keypad_state, new_state, sizeof(keypad_state));
222 /* some key is pressed - keep irq disabled and use timer
223 * to poll the keypad */
226 mod_timer(&omap_kp_data->timer, jiffies + delay);
228 /* enable interrupts */
229 if (cpu_is_omap24xx()) {
231 for (i = 0; i < omap_kp_data->rows; i++)
232 enable_irq(OMAP_GPIO_IRQ(row_gpios[i]));
234 omap_writew(0, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
240 static ssize_t omap_kp_enable_show(struct device *dev,
241 struct device_attribute *attr, char *buf)
243 return sprintf(buf, "%u\n", kp_enable);
246 static ssize_t omap_kp_enable_store(struct device *dev, struct device_attribute *attr,
247 const char *buf, size_t count)
251 if (sscanf(buf, "%u", &state) != 1)
254 if ((state != 1) && (state != 0))
257 mutex_lock(&kp_enable_mutex);
258 if (state != kp_enable) {
260 enable_irq(INT_KEYBOARD);
262 disable_irq(INT_KEYBOARD);
265 mutex_unlock(&kp_enable_mutex);
267 return strnlen(buf, count);
270 static DEVICE_ATTR(enable, S_IRUGO | S_IWUSR, omap_kp_enable_show, omap_kp_enable_store);
273 static int omap_kp_suspend(struct platform_device *dev, pm_message_t state)
280 static int omap_kp_resume(struct platform_device *dev)
287 #define omap_kp_suspend NULL
288 #define omap_kp_resume NULL
291 static int __init omap_kp_probe(struct platform_device *pdev)
293 struct omap_kp *omap_kp;
294 struct input_dev *input_dev;
295 struct omap_kp_platform_data *pdata = pdev->dev.platform_data;
296 int i, col_idx, row_idx, irq_idx, ret;
298 if (!pdata->rows || !pdata->cols || !pdata->keymap) {
299 printk(KERN_ERR "No rows, cols or keymap from pdata\n");
303 omap_kp = kzalloc(sizeof(struct omap_kp), GFP_KERNEL);
304 input_dev = input_allocate_device();
305 if (!omap_kp || !input_dev) {
307 input_free_device(input_dev);
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, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
319 keymap = pdata->keymap;
322 set_bit(EV_REP, input_dev->evbit);
325 omap_kp->delay = pdata->delay;
327 if (pdata->row_gpios && pdata->col_gpios) {
328 row_gpios = pdata->row_gpios;
329 col_gpios = pdata->col_gpios;
332 omap_kp->rows = pdata->rows;
333 omap_kp->cols = pdata->cols;
335 if (cpu_is_omap24xx()) {
337 for (col_idx = 0; col_idx < omap_kp->cols; col_idx++) {
338 if (omap_request_gpio(col_gpios[col_idx]) < 0) {
339 printk(KERN_ERR "Failed to request"
340 "GPIO%d for keypad\n",
344 omap_set_gpio_direction(col_gpios[col_idx], 0);
347 for (row_idx = 0; row_idx < omap_kp->rows; row_idx++) {
348 if (omap_request_gpio(row_gpios[row_idx]) < 0) {
349 printk(KERN_ERR "Failed to request"
350 "GPIO%d for keypad\n",
354 omap_set_gpio_direction(row_gpios[row_idx], 1);
358 setup_timer(&omap_kp->timer, omap_kp_timer, (unsigned long)omap_kp);
360 /* get the irq and init timer*/
361 tasklet_enable(&kp_tasklet);
362 kp_tasklet.data = (unsigned long) omap_kp;
364 ret = device_create_file(&pdev->dev, &dev_attr_enable);
368 /* setup input device */
369 set_bit(EV_KEY, input_dev->evbit);
370 for (i = 0; keymap[i] != 0; i++)
371 set_bit(keymap[i] & KEY_MAX, input_dev->keybit);
372 input_dev->name = "omap-keypad";
373 input_dev->phys = "omap-keypad/input0";
374 input_dev->cdev.dev = &pdev->dev;
375 input_dev->private = omap_kp;
377 input_dev->id.bustype = BUS_HOST;
378 input_dev->id.vendor = 0x0001;
379 input_dev->id.product = 0x0001;
380 input_dev->id.version = 0x0100;
382 input_dev->keycode = keymap;
383 input_dev->keycodesize = sizeof(unsigned int);
384 input_dev->keycodemax = pdata->keymapsize;
386 ret = input_register_device(omap_kp->input);
388 printk(KERN_ERR "Unable to register omap-keypad input device\n");
393 omap_writew(0xff, OMAP_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)
404 omap_writew(0, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
406 for (irq_idx = 0; irq_idx < omap_kp->rows; irq_idx++) {
407 if (request_irq(OMAP_GPIO_IRQ(row_gpios[irq_idx]),
409 IRQF_TRIGGER_FALLING,
410 "omap-keypad", omap_kp) < 0)
416 for (i = irq_idx-1; i >=0; i--)
417 free_irq(row_gpios[i], 0);
419 input_unregister_device(omap_kp->input);
422 device_remove_file(&pdev->dev, &dev_attr_enable);
424 for (i = row_idx-1; i >=0; i--)
425 omap_free_gpio(row_gpios[i]);
427 for (i = col_idx-1; i >=0; i--)
428 omap_free_gpio(col_gpios[i]);
431 input_free_device(input_dev);
436 static int 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()) {
444 for (i = 0; i < omap_kp->cols; i++)
445 omap_free_gpio(col_gpios[i]);
446 for (i = 0; i < omap_kp->rows; i++) {
447 omap_free_gpio(row_gpios[i]);
448 free_irq(OMAP_GPIO_IRQ(row_gpios[i]), 0);
451 omap_writew(1, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
452 free_irq(omap_kp->irq, 0);
455 del_timer_sync(&omap_kp->timer);
456 tasklet_kill(&kp_tasklet);
458 /* unregister everything */
459 input_unregister_device(omap_kp->input);
466 static struct platform_driver omap_kp_driver = {
467 .probe = omap_kp_probe,
468 .remove = omap_kp_remove,
469 .suspend = omap_kp_suspend,
470 .resume = omap_kp_resume,
472 .name = "omap-keypad",
476 static int __devinit omap_kp_init(void)
478 printk(KERN_INFO "OMAP Keypad Driver\n");
479 return platform_driver_register(&omap_kp_driver);
482 static void __exit omap_kp_exit(void)
484 platform_driver_unregister(&omap_kp_driver);
487 module_init(omap_kp_init);
488 module_exit(omap_kp_exit);
490 MODULE_AUTHOR("Timo Teräs");
491 MODULE_DESCRIPTION("OMAP Keypad Driver");
492 MODULE_LICENSE("GPL");