2 * linux/drivers/char/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 <asm/arch/irqs.h>
36 #include <asm/arch/gpio.h>
37 #include <asm/arch/hardware.h>
38 #include <asm/arch/keypad.h>
39 #include <asm/arch/menelaus.h>
41 #include <asm/errno.h>
42 #include <asm/mach-types.h>
43 #include <asm/arch/mux.h>
45 #undef NEW_BOARD_LEARNING_MODE
47 static void omap_kp_tasklet(unsigned long);
48 static void omap_kp_timer(unsigned long);
50 static unsigned char keypad_state[8];
51 static DECLARE_MUTEX(kp_enable_mutex);
52 static int kp_enable = 1;
53 static int kp_cur_group = -1;
56 struct input_dev *input;
57 struct timer_list timer;
63 DECLARE_TASKLET_DISABLED(kp_tasklet, omap_kp_tasklet, 0);
66 static unsigned int *row_gpios;
67 static unsigned int *col_gpios;
69 #ifdef CONFIG_ARCH_OMAP2
70 static void set_col_gpio_val(struct omap_kp *omap_kp, u8 value)
73 for (col = 0; col < omap_kp->cols; col++) {
74 if (value & (1 << col))
75 omap_set_gpio_dataout(col_gpios[col], 1);
77 omap_set_gpio_dataout(col_gpios[col], 0);
81 static u8 get_row_gpio_val(struct omap_kp *omap_kp)
86 for (row = 0; row < omap_kp->cols; row++) {
87 if (omap_get_gpio_datain(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,
100 struct omap_kp *omap_kp = dev_id;
102 /* disable keyboard interrupt and schedule for handling */
103 if (cpu_is_omap24xx()) {
105 for (i = 0; i < omap_kp->rows; i++)
106 disable_irq(OMAP_GPIO_IRQ(row_gpios[i]));
108 /* disable keyboard interrupt and schedule for handling */
109 omap_writew(1, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
112 tasklet_schedule(&kp_tasklet);
117 static void omap_kp_timer(unsigned long data)
119 tasklet_schedule(&kp_tasklet);
122 static void omap_kp_scan_keypad(struct omap_kp *omap_kp, unsigned char *state)
126 /* read the keypad status */
127 if (cpu_is_omap24xx()) {
129 for (i = 0; i < omap_kp->rows; i++)
130 disable_irq(OMAP_GPIO_IRQ(row_gpios[i]));
132 /* disable keyboard interrupt and schedule for handling */
133 omap_writew(1, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
135 if (!cpu_is_omap24xx()) {
136 /* read the keypad status */
137 omap_writew(0xff, OMAP_MPUIO_BASE + OMAP_MPUIO_KBC);
138 for (col = 0; col < omap_kp->cols; col++) {
139 omap_writew(~(1 << col) & 0xff, OMAP_MPUIO_BASE + OMAP_MPUIO_KBC);
141 if (machine_is_omap_osk() || machine_is_omap_h2() || machine_is_omap_h3()) {
146 state[col] = ~omap_readw(OMAP_MPUIO_BASE + OMAP_MPUIO_KBR_LATCH) & 0xff;
148 omap_writew(0x00, OMAP_MPUIO_BASE + OMAP_MPUIO_KBC);
151 /* read the keypad status */
152 for (col = 0; col < omap_kp->cols; col++) {
153 set_col_gpio_val(omap_kp, ~(1 << col));
154 state[col] = ~(get_row_gpio_val(omap_kp)) & 0x3f;
156 set_col_gpio_val(omap_kp, 0);
160 static inline int omap_kp_find_key(int col, int row)
164 key = KEY(col, row, 0);
165 for (i = 0; keymap[i] != 0; i++)
166 if ((keymap[i] & 0xff000000) == key)
167 return keymap[i] & 0x00ffffff;
171 static void omap_kp_tasklet(unsigned long data)
173 struct omap_kp *omap_kp_data = (struct omap_kp *) data;
174 unsigned char new_state[8], changed, key_down = 0;
178 /* check for any changes */
179 omap_kp_scan_keypad(omap_kp_data, new_state);
181 /* check for changes and print those */
182 for (col = 0; col < omap_kp_data->cols; col++) {
183 changed = new_state[col] ^ keypad_state[col];
184 key_down |= new_state[col];
188 for (row = 0; row < omap_kp_data->rows; row++) {
190 if (!(changed & (1 << row)))
192 #ifdef NEW_BOARD_LEARNING_MODE
193 printk(KERN_INFO "omap-keypad: key %d-%d %s\n", col, row, (new_state[col] & (1 << row)) ? "pressed" : "released");
195 key = omap_kp_find_key(col, row);
197 printk(KERN_WARNING "omap-keypad: Spurious key event %d-%d\n",
199 /* We scan again after a couple of seconds */
204 if (!(kp_cur_group == (key & GROUP_MASK) ||
208 kp_cur_group = key & GROUP_MASK;
209 input_report_key(omap_kp_data->input, key & ~GROUP_MASK,
210 !!(new_state[col] & (1 << row)));
214 memcpy(keypad_state, new_state, sizeof(keypad_state));
218 /* some key is pressed - keep irq disabled and use timer
219 * to poll the keypad */
222 mod_timer(&omap_kp_data->timer, jiffies + delay);
224 /* enable interrupts */
225 if (cpu_is_omap24xx()) {
227 for (i = 0; i < omap_kp_data->rows; i++)
228 enable_irq(OMAP_GPIO_IRQ(row_gpios[i]));
230 omap_writew(0, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
236 static ssize_t omap_kp_enable_show(struct device *dev,
237 struct device_attribute *attr, char *buf)
239 return sprintf(buf, "%u\n", kp_enable);
242 static ssize_t omap_kp_enable_store(struct device *dev, struct device_attribute *attr,
243 const char *buf, size_t count)
247 if (sscanf(buf, "%u", &state) != 1)
250 if ((state != 1) && (state != 0))
253 down(&kp_enable_mutex);
254 if (state != kp_enable) {
256 enable_irq(INT_KEYBOARD);
258 disable_irq(INT_KEYBOARD);
261 up(&kp_enable_mutex);
263 return strnlen(buf, count);
266 static DEVICE_ATTR(enable, S_IRUGO | S_IWUSR, omap_kp_enable_show, omap_kp_enable_store);
269 static int omap_kp_suspend(struct platform_device *dev, pm_message_t state)
276 static int omap_kp_resume(struct platform_device *dev)
283 #define omap_kp_suspend NULL
284 #define omap_kp_resume NULL
287 static int __init omap_kp_probe(struct platform_device *pdev)
289 struct omap_kp *omap_kp;
290 struct input_dev *input_dev;
291 struct omap_kp_platform_data *pdata = pdev->dev.platform_data;
294 if (!pdata->rows || !pdata->cols || !pdata->keymap) {
295 printk(KERN_ERR "No rows, cols or keymap from pdata\n");
299 omap_kp = kzalloc(sizeof(struct omap_kp), GFP_KERNEL);
300 input_dev = input_allocate_device();
301 if (!omap_kp || !input_dev) {
303 input_free_device(input_dev);
307 platform_set_drvdata(pdev, omap_kp);
309 omap_kp->input = input_dev;
311 /* Disable the interrupt for the MPUIO keyboard */
312 if (!cpu_is_omap24xx())
313 omap_writew(1, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
315 keymap = pdata->keymap;
318 set_bit(EV_REP, input_dev->evbit);
320 if (pdata->row_gpios && pdata->col_gpios) {
321 row_gpios = pdata->row_gpios;
322 col_gpios = pdata->col_gpios;
325 omap_kp->rows = pdata->rows;
326 omap_kp->cols = pdata->cols;
328 if (cpu_is_omap24xx()) {
330 for (i = 0; i < omap_kp->cols; i++) {
331 if (omap_request_gpio(col_gpios[i]) < 0) {
332 printk(KERN_ERR "Failed to request"
333 "GPIO%d for keypad\n",
337 omap_set_gpio_direction(col_gpios[i], 0);
340 for (i = 0; i < omap_kp->rows; i++) {
341 if (omap_request_gpio(row_gpios[i]) < 0) {
342 printk(KERN_ERR "Failed to request"
343 "GPIO%d for keypad\n",
347 omap_set_gpio_direction(row_gpios[i], 1);
351 init_timer(&omap_kp->timer);
352 omap_kp->timer.function = omap_kp_timer;
353 omap_kp->timer.data = (unsigned long) omap_kp;
355 /* get the irq and init timer*/
356 tasklet_enable(&kp_tasklet);
357 kp_tasklet.data = (unsigned long) omap_kp;
359 omap_kp->irq = platform_get_irq(pdev, 0);
361 if (request_irq(omap_kp->irq, omap_kp_interrupt, 0,
362 "omap-keypad", omap_kp) < 0)
366 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->cdev.dev = &pdev->dev;
374 input_dev->private = omap_kp;
375 input_register_device(omap_kp->input);
377 if (machine_is_omap_h2() || machine_is_omap_h3() ||
378 machine_is_omap_perseus2()) {
379 omap_writew(0xff, OMAP_MPUIO_BASE + OMAP_MPUIO_GPIO_DEBOUNCING);
381 /* scan current status and enable interrupt */
382 omap_kp_scan_keypad(omap_kp, keypad_state);
383 if (!cpu_is_omap24xx()) {
384 omap_writew(0, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
386 for (i = 0; i < omap_kp->rows; i++) {
387 if (request_irq(OMAP_GPIO_IRQ(row_gpios[i]), omap_kp_interrupt,
388 SA_TRIGGER_FALLING, "omap-keypad", omap_kp) < 0)
396 static int omap_kp_remove(struct platform_device *pdev)
398 struct omap_kp *omap_kp = platform_get_drvdata(pdev);
400 /* disable keypad interrupt handling */
401 tasklet_disable(&kp_tasklet);
402 if (cpu_is_omap24xx()) {
404 for (i = 0; i < omap_kp->cols; i++)
405 omap_free_gpio(col_gpios[i]);
406 for (i = 0; i < omap_kp->rows; i++) {
407 omap_free_gpio(row_gpios[i]);
408 free_irq(OMAP_GPIO_IRQ(row_gpios[i]), 0);
411 omap_writew(1, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
412 free_irq(omap_kp->irq, 0);
415 del_timer_sync(&omap_kp->timer);
417 /* unregister everything */
418 input_unregister_device(omap_kp->input);
425 static struct platform_driver omap_kp_driver = {
426 .probe = omap_kp_probe,
427 .remove = omap_kp_remove,
428 .suspend = omap_kp_suspend,
429 .resume = omap_kp_resume,
431 .name = "omap-keypad",
435 static int __devinit omap_kp_init(void)
437 printk(KERN_INFO "OMAP Keypad Driver\n");
438 return platform_driver_register(&omap_kp_driver);
441 static void __exit omap_kp_exit(void)
443 platform_driver_unregister(&omap_kp_driver);
446 module_init(omap_kp_init);
447 module_exit(omap_kp_exit);
449 MODULE_AUTHOR("Timo Teräs");
450 MODULE_DESCRIPTION("OMAP Keypad Driver");
451 MODULE_LICENSE("GPL");