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 <mach/gpio.h>
38 #include <mach/keypad.h>
39 #include <mach/menelaus.h>
41 #include <mach/hardware.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 DEFINE_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
;
62 unsigned int debounce
;
65 static DECLARE_TASKLET_DISABLED(kp_tasklet
, omap_kp_tasklet
, 0);
68 static unsigned int *row_gpios
;
69 static unsigned int *col_gpios
;
71 #ifdef CONFIG_ARCH_OMAP2
72 static void set_col_gpio_val(struct omap_kp
*omap_kp
, u8 value
)
76 for (col
= 0; col
< omap_kp
->cols
; col
++)
77 gpio_set_value(col_gpios
[col
], value
& (1 << col
));
80 static u8
get_row_gpio_val(struct omap_kp
*omap_kp
)
85 for (row
= 0; row
< omap_kp
->rows
; row
++) {
86 if (gpio_get_value(row_gpios
[row
]))
92 #define set_col_gpio_val(x, y) do {} while (0)
93 #define get_row_gpio_val(x) 0
96 static irqreturn_t
omap_kp_interrupt(int irq
, void *dev_id
)
98 struct omap_kp
*omap_kp
= dev_id
;
100 /* disable keyboard interrupt and schedule for handling */
101 if (cpu_is_omap24xx()) {
104 for (i
= 0; i
< omap_kp
->rows
; i
++) {
105 int gpio_irq
= gpio_to_irq(row_gpios
[i
]);
107 * The interrupt which we're currently handling should
108 * be disabled _nosync() to avoid deadlocks waiting
109 * for this handler to complete. All others should
110 * be disabled the regular way for SMP safety.
113 disable_irq_nosync(gpio_irq
);
115 disable_irq(gpio_irq
);
118 /* disable keyboard interrupt and schedule for handling */
119 omap_writew(1, OMAP1_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, OMAP1_MPUIO_BASE
+ OMAP_MPUIO_KBD_MASKIT
);
148 /* read the keypad status */
149 omap_writew(0xff, OMAP1_MPUIO_BASE
+ OMAP_MPUIO_KBC
);
150 for (col
= 0; col
< omap_kp
->cols
; col
++) {
151 omap_writew(~(1 << col
) & 0xff,
152 OMAP1_MPUIO_BASE
+ OMAP_MPUIO_KBC
);
154 udelay(omap_kp
->delay
);
156 state
[col
] = ~omap_readw(OMAP1_MPUIO_BASE
+
157 OMAP_MPUIO_KBR_LATCH
) & 0xff;
159 omap_writew(0x00, OMAP1_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, OMAP1_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
)
283 static int omap_kp_resume(struct platform_device
*dev
)
290 #define omap_kp_suspend NULL
291 #define omap_kp_resume NULL
294 static int __devinit
omap_kp_probe(struct platform_device
*pdev
)
296 struct omap_kp
*omap_kp
;
297 struct input_dev
*input_dev
;
298 struct omap_kp_platform_data
*pdata
= pdev
->dev
.platform_data
;
299 int i
, col_idx
, row_idx
, irq_idx
, ret
;
301 if (!pdata
->rows
|| !pdata
->cols
|| !pdata
->keymap
) {
302 printk(KERN_ERR
"No rows, cols or keymap from pdata\n");
306 omap_kp
= kzalloc(sizeof(struct omap_kp
), GFP_KERNEL
);
307 input_dev
= input_allocate_device();
308 if (!omap_kp
|| !input_dev
) {
310 input_free_device(input_dev
);
314 platform_set_drvdata(pdev
, omap_kp
);
316 omap_kp
->input
= input_dev
;
318 /* Disable the interrupt for the MPUIO keyboard */
319 if (!cpu_is_omap24xx())
320 omap_writew(1, OMAP1_MPUIO_BASE
+ OMAP_MPUIO_KBD_MASKIT
);
322 keymap
= pdata
->keymap
;
325 __set_bit(EV_REP
, input_dev
->evbit
);
328 omap_kp
->delay
= pdata
->delay
;
330 if (pdata
->row_gpios
&& pdata
->col_gpios
) {
331 row_gpios
= pdata
->row_gpios
;
332 col_gpios
= pdata
->col_gpios
;
335 omap_kp
->rows
= pdata
->rows
;
336 omap_kp
->cols
= pdata
->cols
;
338 if (cpu_is_omap24xx()) {
340 for (col_idx
= 0; col_idx
< omap_kp
->cols
; col_idx
++) {
341 if (gpio_request(col_gpios
[col_idx
], "omap_kp_col") < 0) {
342 printk(KERN_ERR
"Failed to request"
343 "GPIO%d for keypad\n",
347 gpio_direction_output(col_gpios
[col_idx
], 0);
350 for (row_idx
= 0; row_idx
< omap_kp
->rows
; row_idx
++) {
351 if (gpio_request(row_gpios
[row_idx
], "omap_kp_row") < 0) {
352 printk(KERN_ERR
"Failed to request"
353 "GPIO%d for keypad\n",
357 gpio_direction_input(row_gpios
[row_idx
]);
364 setup_timer(&omap_kp
->timer
, omap_kp_timer
, (unsigned long)omap_kp
);
366 /* get the irq and init timer*/
367 tasklet_enable(&kp_tasklet
);
368 kp_tasklet
.data
= (unsigned long) omap_kp
;
370 ret
= device_create_file(&pdev
->dev
, &dev_attr_enable
);
374 /* setup input device */
375 __set_bit(EV_KEY
, input_dev
->evbit
);
376 for (i
= 0; keymap
[i
] != 0; i
++)
377 __set_bit(keymap
[i
] & KEY_MAX
, input_dev
->keybit
);
378 input_dev
->name
= "omap-keypad";
379 input_dev
->phys
= "omap-keypad/input0";
380 input_dev
->dev
.parent
= &pdev
->dev
;
382 input_dev
->id
.bustype
= BUS_HOST
;
383 input_dev
->id
.vendor
= 0x0001;
384 input_dev
->id
.product
= 0x0001;
385 input_dev
->id
.version
= 0x0100;
387 ret
= input_register_device(omap_kp
->input
);
389 printk(KERN_ERR
"Unable to register omap-keypad input device\n");
394 omap_writew(0xff, OMAP1_MPUIO_BASE
+ OMAP_MPUIO_GPIO_DEBOUNCING
);
396 /* scan current status and enable interrupt */
397 omap_kp_scan_keypad(omap_kp
, keypad_state
);
398 if (!cpu_is_omap24xx()) {
399 omap_kp
->irq
= platform_get_irq(pdev
, 0);
400 if (omap_kp
->irq
>= 0) {
401 if (request_irq(omap_kp
->irq
, omap_kp_interrupt
, 0,
402 "omap-keypad", omap_kp
) < 0)
405 omap_writew(0, OMAP1_MPUIO_BASE
+ OMAP_MPUIO_KBD_MASKIT
);
407 for (irq_idx
= 0; irq_idx
< omap_kp
->rows
; irq_idx
++) {
408 if (request_irq(gpio_to_irq(row_gpios
[irq_idx
]),
410 IRQF_TRIGGER_FALLING
,
411 "omap-keypad", omap_kp
) < 0)
417 for (i
= irq_idx
- 1; i
>=0; i
--)
418 free_irq(row_gpios
[i
], 0);
420 input_unregister_device(omap_kp
->input
);
423 device_remove_file(&pdev
->dev
, &dev_attr_enable
);
425 for (i
= row_idx
- 1; i
>=0; i
--)
426 gpio_free(row_gpios
[i
]);
428 for (i
= col_idx
- 1; i
>=0; i
--)
429 gpio_free(col_gpios
[i
]);
432 input_free_device(input_dev
);
437 static int __devexit
omap_kp_remove(struct platform_device
*pdev
)
439 struct omap_kp
*omap_kp
= platform_get_drvdata(pdev
);
441 /* disable keypad interrupt handling */
442 tasklet_disable(&kp_tasklet
);
443 if (cpu_is_omap24xx()) {
445 for (i
= 0; i
< omap_kp
->cols
; i
++)
446 gpio_free(col_gpios
[i
]);
447 for (i
= 0; i
< omap_kp
->rows
; i
++) {
448 gpio_free(row_gpios
[i
]);
449 free_irq(gpio_to_irq(row_gpios
[i
]), 0);
452 omap_writew(1, OMAP1_MPUIO_BASE
+ OMAP_MPUIO_KBD_MASKIT
);
453 free_irq(omap_kp
->irq
, 0);
456 del_timer_sync(&omap_kp
->timer
);
457 tasklet_kill(&kp_tasklet
);
459 /* unregister everything */
460 input_unregister_device(omap_kp
->input
);
467 static struct platform_driver omap_kp_driver
= {
468 .probe
= omap_kp_probe
,
469 .remove
= __devexit_p(omap_kp_remove
),
470 .suspend
= omap_kp_suspend
,
471 .resume
= omap_kp_resume
,
473 .name
= "omap-keypad",
474 .owner
= THIS_MODULE
,
478 static int __init
omap_kp_init(void)
480 printk(KERN_INFO
"OMAP Keypad Driver\n");
481 return platform_driver_register(&omap_kp_driver
);
484 static void __exit
omap_kp_exit(void)
486 platform_driver_unregister(&omap_kp_driver
);
489 module_init(omap_kp_init
);
490 module_exit(omap_kp_exit
);
492 MODULE_AUTHOR("Timo Teräs");
493 MODULE_DESCRIPTION("OMAP Keypad Driver");
494 MODULE_LICENSE("GPL");
495 MODULE_ALIAS("platform:omap-keypad");