]> www.pilppa.org Git - linux-2.6-omap-h63xx.git/blob - drivers/input/keyboard/omap-keypad.c
ARM: OMAP: Fix a bug related to key grouping in keypad driver
[linux-2.6-omap-h63xx.git] / drivers / input / keyboard / omap-keypad.c
1 /*
2  * linux/drivers/char/omap-keypad.c
3  *
4  * OMAP Keypad Driver
5  *
6  * Copyright (C) 2003 Nokia Corporation
7  * Written by Timo Teräs <ext-timo.teras@nokia.com>
8  *
9  * Added support for H2 & H3 Keypad
10  * Copyright (C) 2004 Texas Instruments
11  *
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.
16  *
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.
21  *
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
25  */
26
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>
40 #include <asm/io.h>
41 #include <asm/errno.h>
42 #include <asm/mach-types.h>
43 #include <asm/arch/mux.h>
44
45 #undef NEW_BOARD_LEARNING_MODE
46
47 static void omap_kp_tasklet(unsigned long);
48 static void omap_kp_timer(unsigned long);
49
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;
54
55 struct omap_kp {
56         struct input_dev *input;
57         struct timer_list timer;
58         unsigned int irq;
59         unsigned int rows;
60         unsigned int cols;
61 };
62
63 DECLARE_TASKLET_DISABLED(kp_tasklet, omap_kp_tasklet, 0);
64
65 static int *keymap;
66 static unsigned int *row_gpios;
67 static unsigned int *col_gpios;
68
69 #ifdef CONFIG_ARCH_OMAP2
70 static void set_col_gpio_val(struct omap_kp *omap_kp, u8 value)
71 {
72         int col;
73         for (col = 0; col < omap_kp->cols; col++) {
74                 if (value & (1 << col))
75                         omap_set_gpio_dataout(col_gpios[col], 1);
76                 else
77                         omap_set_gpio_dataout(col_gpios[col], 0);
78         }
79 }
80
81 static u8 get_row_gpio_val(struct omap_kp *omap_kp)
82 {
83         int row;
84         u8 value = 0;
85
86         for (row = 0; row < omap_kp->cols; row++) {
87                 if (omap_get_gpio_datain(row_gpios[row]))
88                         value |= (1 << row);
89         }
90         return value;
91 }
92 #else
93 #define         set_col_gpio_val(x, y)  do {} while (0)
94 #define         get_row_gpio_val(x)     0
95 #endif
96
97 static irqreturn_t omap_kp_interrupt(int irq, void *dev_id,
98                                      struct pt_regs *regs)
99 {
100         struct omap_kp *omap_kp = dev_id;
101
102         /* disable keyboard interrupt and schedule for handling */
103         if (cpu_is_omap24xx()) {
104                 int i;
105                 for (i = 0; i < omap_kp->rows; i++)
106                         disable_irq(OMAP_GPIO_IRQ(row_gpios[i]));
107         } else {
108                 /* disable keyboard interrupt and schedule for handling */
109                 omap_writew(1, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
110         }
111
112         tasklet_schedule(&kp_tasklet);
113
114         return IRQ_HANDLED;
115 }
116
117 static void omap_kp_timer(unsigned long data)
118 {
119         tasklet_schedule(&kp_tasklet);
120 }
121
122 static void omap_kp_scan_keypad(struct omap_kp *omap_kp, unsigned char *state)
123 {
124         int col = 0;
125
126         /* read the keypad status */
127         if (cpu_is_omap24xx()) {
128                 int i;
129                 for (i = 0; i < omap_kp->rows; i++)
130                         disable_irq(OMAP_GPIO_IRQ(row_gpios[i]));
131         } else {
132                 /* disable keyboard interrupt and schedule for handling */
133                 omap_writew(1, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
134         }
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);
140
141                         if (machine_is_omap_osk() || machine_is_omap_h2() || machine_is_omap_h3()) {
142                                 udelay(9);
143                         } else {
144                                 udelay(4);
145                         }
146                         state[col] = ~omap_readw(OMAP_MPUIO_BASE + OMAP_MPUIO_KBR_LATCH) & 0xff;
147                 }
148                 omap_writew(0x00, OMAP_MPUIO_BASE + OMAP_MPUIO_KBC);
149                 udelay(2);
150         } else {
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;
155                 }
156                 set_col_gpio_val(omap_kp, 0);
157         }
158 }
159
160 static inline int omap_kp_find_key(int col, int row)
161 {
162         int i, key;
163
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;
168         return -1;
169 }
170
171 static void omap_kp_tasklet(unsigned long data)
172 {
173         struct omap_kp *omap_kp_data = (struct omap_kp *) data;
174         unsigned char new_state[8], changed, key_down = 0;
175         int col, row;
176         int spurious = 0;
177
178         /* check for any changes */
179         omap_kp_scan_keypad(omap_kp_data, new_state);
180
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];
185                 if (changed == 0)
186                         continue;
187
188                 for (row = 0; row < omap_kp_data->rows; row++) {
189                         int key;
190                         if (!(changed & (1 << row)))
191                                 continue;
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");
194 #else
195                         key = omap_kp_find_key(col, row);
196                         if (key < 0) {
197                                 printk(KERN_WARNING "omap-keypad: Spurious key event %d-%d\n",
198                                        col, row);
199                                 /* We scan again after a couple of seconds */
200                                 spurious = 1;
201                                 continue;
202                         }
203
204                         if (!(kp_cur_group == (key & GROUP_MASK) ||
205                               kp_cur_group == -1))
206                                 continue;
207
208                         kp_cur_group = key & GROUP_MASK;
209                         input_report_key(omap_kp_data->input, key & ~GROUP_MASK,
210                                          !!(new_state[col] & (1 << row)));
211 #endif
212                 }
213         }
214         memcpy(keypad_state, new_state, sizeof(keypad_state));
215
216         if (key_down) {
217                 int delay = HZ / 20;
218                 /* some key is pressed - keep irq disabled and use timer
219                  * to poll the keypad */
220                 if (spurious)
221                         delay = 2 * HZ;
222                 mod_timer(&omap_kp_data->timer, jiffies + delay);
223         } else {
224                 /* enable interrupts */
225                 if (cpu_is_omap24xx()) {
226                         int i;
227                         for (i = 0; i < omap_kp_data->rows; i++)
228                                 enable_irq(OMAP_GPIO_IRQ(row_gpios[i]));
229                 } else {
230                         omap_writew(0, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
231                         kp_cur_group = -1;
232                 }
233         }
234 }
235
236 static ssize_t omap_kp_enable_show(struct device *dev, 
237                                    struct device_attribute *attr, char *buf)
238 {
239         return sprintf(buf, "%u\n", kp_enable);
240 }
241
242 static ssize_t omap_kp_enable_store(struct device *dev, struct device_attribute *attr,
243                                     const char *buf, size_t count)
244 {
245         int state;
246
247         if (sscanf(buf, "%u", &state) != 1)
248                 return -EINVAL;
249
250         if ((state != 1) && (state != 0))
251                 return -EINVAL;
252
253         down(&kp_enable_mutex);
254         if (state != kp_enable) {
255                 if (state)
256                         enable_irq(INT_KEYBOARD);
257                 else
258                         disable_irq(INT_KEYBOARD);
259                 kp_enable = state;
260         }
261         up(&kp_enable_mutex);
262
263         return strnlen(buf, count);
264 }
265
266 static DEVICE_ATTR(enable, S_IRUGO | S_IWUSR, omap_kp_enable_show, omap_kp_enable_store);
267
268 #ifdef CONFIG_PM
269 static int omap_kp_suspend(struct platform_device *dev, pm_message_t state)
270 {
271         /* Nothing yet */
272
273         return 0;
274 }
275
276 static int omap_kp_resume(struct platform_device *dev)
277 {
278         /* Nothing yet */
279
280         return 0;
281 }
282 #else
283 #define omap_kp_suspend NULL
284 #define omap_kp_resume  NULL
285 #endif
286
287 static int __init omap_kp_probe(struct platform_device *pdev)
288 {
289         struct omap_kp *omap_kp;
290         struct input_dev *input_dev;
291         struct omap_kp_platform_data *pdata =  pdev->dev.platform_data;
292         int i;
293
294         if (!pdata->rows || !pdata->cols || !pdata->keymap) {
295                 printk(KERN_ERR "No rows, cols or keymap from pdata\n");
296                 return -EINVAL;
297         }
298
299         omap_kp = kzalloc(sizeof(struct omap_kp), GFP_KERNEL);
300         input_dev = input_allocate_device();
301         if (!omap_kp || !input_dev) {
302                 kfree(omap_kp);
303                 input_free_device(input_dev);
304                 return -ENOMEM;
305         }
306
307         platform_set_drvdata(pdev, omap_kp);
308
309         omap_kp->input = input_dev;
310
311         /* Disable the interrupt for the MPUIO keyboard */
312         if (!cpu_is_omap24xx())
313                 omap_writew(1, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
314
315         keymap = pdata->keymap;
316
317         if (pdata->rep)
318                 set_bit(EV_REP, input_dev->evbit);
319
320         if (pdata->row_gpios && pdata->col_gpios) {
321                 row_gpios = pdata->row_gpios;
322                 col_gpios = pdata->col_gpios;
323         }
324
325         omap_kp->rows = pdata->rows;
326         omap_kp->cols = pdata->cols;
327
328         if (cpu_is_omap24xx()) {
329                 /* Cols: outputs */
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",
334                                        col_gpios[i]);
335                                 return -EINVAL;
336                         }
337                         omap_set_gpio_direction(col_gpios[i], 0);
338                 }
339                 /* Rows: inputs */
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",
344                                        row_gpios[i]);
345                                 return -EINVAL;
346                         }
347                         omap_set_gpio_direction(row_gpios[i], 1);
348                 }
349         }
350
351         init_timer(&omap_kp->timer);
352         omap_kp->timer.function = omap_kp_timer;
353         omap_kp->timer.data = (unsigned long) omap_kp;
354
355         /* get the irq and init timer*/
356         tasklet_enable(&kp_tasklet);
357         kp_tasklet.data = (unsigned long) omap_kp;
358
359         omap_kp->irq = platform_get_irq(pdev, 0);
360         if (omap_kp->irq) {
361                 if (request_irq(omap_kp->irq, omap_kp_interrupt, 0,
362                                 "omap-keypad", omap_kp) < 0)
363                         return -EINVAL;
364         }
365
366         device_create_file(&pdev->dev, &dev_attr_enable);
367
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);
376
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);
380         }
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);
385         } else {
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)
389                                 return -EINVAL;
390                 }
391         }
392
393         return 0;
394 }
395
396 static int omap_kp_remove(struct platform_device *pdev)
397 {
398         struct omap_kp *omap_kp = platform_get_drvdata(pdev);
399
400         /* disable keypad interrupt handling */
401         tasklet_disable(&kp_tasklet);
402         if (cpu_is_omap24xx()) {
403                 int i;
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);
409                 }
410         } else {
411                 omap_writew(1, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
412                 free_irq(omap_kp->irq, 0);
413         }
414
415         del_timer_sync(&omap_kp->timer);
416
417         /* unregister everything */
418         input_unregister_device(omap_kp->input);
419
420         kfree(omap_kp);
421
422         return 0;
423 }
424
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,
430         .driver         = {
431                 .name   = "omap-keypad",
432         },
433 };
434
435 static int __devinit omap_kp_init(void)
436 {
437         printk(KERN_INFO "OMAP Keypad Driver\n");
438         return platform_driver_register(&omap_kp_driver);
439 }
440
441 static void __exit omap_kp_exit(void)
442 {
443         platform_driver_unregister(&omap_kp_driver);
444 }
445
446 module_init(omap_kp_init);
447 module_exit(omap_kp_exit);
448
449 MODULE_AUTHOR("Timo Teräs");
450 MODULE_DESCRIPTION("OMAP Keypad Driver");
451 MODULE_LICENSE("GPL");