db22fd9b4cf2ca29243035e48ae1312d1dd341ed
[sfrench/cifs-2.6.git] / drivers / input / keyboard / omap-keypad.c
1 /*
2  * linux/drivers/input/keyboard/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 <linux/mutex.h>
36 #include <linux/errno.h>
37 #include <mach/gpio.h>
38 #include <mach/keypad.h>
39 #include <mach/menelaus.h>
40 #include <asm/irq.h>
41 #include <mach/hardware.h>
42 #include <asm/io.h>
43 #include <mach/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 DEFINE_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         int irq;
59         unsigned int rows;
60         unsigned int cols;
61         unsigned long delay;
62         unsigned int debounce;
63 };
64
65 static DECLARE_TASKLET_DISABLED(kp_tasklet, omap_kp_tasklet, 0);
66
67 static int *keymap;
68 static unsigned int *row_gpios;
69 static unsigned int *col_gpios;
70
71 #ifdef CONFIG_ARCH_OMAP2
72 static void set_col_gpio_val(struct omap_kp *omap_kp, u8 value)
73 {
74         int col;
75
76         for (col = 0; col < omap_kp->cols; col++)
77                 gpio_set_value(col_gpios[col], value & (1 << col));
78 }
79
80 static u8 get_row_gpio_val(struct omap_kp *omap_kp)
81 {
82         int row;
83         u8 value = 0;
84
85         for (row = 0; row < omap_kp->rows; row++) {
86                 if (gpio_get_value(row_gpios[row]))
87                         value |= (1 << row);
88         }
89         return value;
90 }
91 #else
92 #define         set_col_gpio_val(x, y)  do {} while (0)
93 #define         get_row_gpio_val(x)     0
94 #endif
95
96 static irqreturn_t omap_kp_interrupt(int irq, void *dev_id)
97 {
98         struct omap_kp *omap_kp = dev_id;
99
100         /* disable keyboard interrupt and schedule for handling */
101         if (cpu_is_omap24xx()) {
102                 int i;
103                 for (i = 0; i < omap_kp->rows; i++)
104                         disable_irq(gpio_to_irq(row_gpios[i]));
105         } else
106                 /* disable keyboard interrupt and schedule for handling */
107                 omap_writew(1, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
108
109         tasklet_schedule(&kp_tasklet);
110
111         return IRQ_HANDLED;
112 }
113
114 static void omap_kp_timer(unsigned long data)
115 {
116         tasklet_schedule(&kp_tasklet);
117 }
118
119 static void omap_kp_scan_keypad(struct omap_kp *omap_kp, unsigned char *state)
120 {
121         int col = 0;
122
123         /* read the keypad status */
124         if (cpu_is_omap24xx()) {
125                 int i;
126                 for (i = 0; i < omap_kp->rows; i++)
127                         disable_irq(OMAP_GPIO_IRQ(row_gpios[i]));
128
129                 /* read the keypad status */
130                 for (col = 0; col < omap_kp->cols; col++) {
131                         set_col_gpio_val(omap_kp, ~(1 << col));
132                         state[col] = ~(get_row_gpio_val(omap_kp)) & 0x3f;
133                 }
134                 set_col_gpio_val(omap_kp, 0);
135
136         } else {
137                 /* disable keyboard interrupt and schedule for handling */
138                 omap_writew(1, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
139
140                 /* read the keypad status */
141                 omap_writew(0xff, OMAP_MPUIO_BASE + OMAP_MPUIO_KBC);
142                 for (col = 0; col < omap_kp->cols; col++) {
143                         omap_writew(~(1 << col) & 0xff,
144                                     OMAP_MPUIO_BASE + OMAP_MPUIO_KBC);
145
146                         udelay(omap_kp->delay);
147
148                         state[col] = ~omap_readw(OMAP_MPUIO_BASE +
149                                                  OMAP_MPUIO_KBR_LATCH) & 0xff;
150                 }
151                 omap_writew(0x00, OMAP_MPUIO_BASE + OMAP_MPUIO_KBC);
152                 udelay(2);
153         }
154 }
155
156 static inline int omap_kp_find_key(int col, int row)
157 {
158         int i, key;
159
160         key = KEY(col, row, 0);
161         for (i = 0; keymap[i] != 0; i++)
162                 if ((keymap[i] & 0xff000000) == key)
163                         return keymap[i] & 0x00ffffff;
164         return -1;
165 }
166
167 static void omap_kp_tasklet(unsigned long data)
168 {
169         struct omap_kp *omap_kp_data = (struct omap_kp *) data;
170         unsigned char new_state[8], changed, key_down = 0;
171         int col, row;
172         int spurious = 0;
173
174         /* check for any changes */
175         omap_kp_scan_keypad(omap_kp_data, new_state);
176
177         /* check for changes and print those */
178         for (col = 0; col < omap_kp_data->cols; col++) {
179                 changed = new_state[col] ^ keypad_state[col];
180                 key_down |= new_state[col];
181                 if (changed == 0)
182                         continue;
183
184                 for (row = 0; row < omap_kp_data->rows; row++) {
185                         int key;
186                         if (!(changed & (1 << row)))
187                                 continue;
188 #ifdef NEW_BOARD_LEARNING_MODE
189                         printk(KERN_INFO "omap-keypad: key %d-%d %s\n", col,
190                                row, (new_state[col] & (1 << row)) ?
191                                "pressed" : "released");
192 #else
193                         key = omap_kp_find_key(col, row);
194                         if (key < 0) {
195                                 printk(KERN_WARNING
196                                       "omap-keypad: Spurious key event %d-%d\n",
197                                        col, row);
198                                 /* We scan again after a couple of seconds */
199                                 spurious = 1;
200                                 continue;
201                         }
202
203                         if (!(kp_cur_group == (key & GROUP_MASK) ||
204                               kp_cur_group == -1))
205                                 continue;
206
207                         kp_cur_group = key & GROUP_MASK;
208                         input_report_key(omap_kp_data->input, key & ~GROUP_MASK,
209                                          new_state[col] & (1 << row));
210 #endif
211                 }
212         }
213         memcpy(keypad_state, new_state, sizeof(keypad_state));
214
215         if (key_down) {
216                 int delay = HZ / 20;
217                 /* some key is pressed - keep irq disabled and use timer
218                  * to poll the keypad */
219                 if (spurious)
220                         delay = 2 * HZ;
221                 mod_timer(&omap_kp_data->timer, jiffies + delay);
222         } else {
223                 /* enable interrupts */
224                 if (cpu_is_omap24xx()) {
225                         int i;
226                         for (i = 0; i < omap_kp_data->rows; i++)
227                                 enable_irq(gpio_to_irq(row_gpios[i]));
228                 } else {
229                         omap_writew(0, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
230                         kp_cur_group = -1;
231                 }
232         }
233 }
234
235 static ssize_t omap_kp_enable_show(struct device *dev,
236                                    struct device_attribute *attr, char *buf)
237 {
238         return sprintf(buf, "%u\n", kp_enable);
239 }
240
241 static ssize_t omap_kp_enable_store(struct device *dev, struct device_attribute *attr,
242                                     const char *buf, size_t count)
243 {
244         int state;
245
246         if (sscanf(buf, "%u", &state) != 1)
247                 return -EINVAL;
248
249         if ((state != 1) && (state != 0))
250                 return -EINVAL;
251
252         mutex_lock(&kp_enable_mutex);
253         if (state != kp_enable) {
254                 if (state)
255                         enable_irq(INT_KEYBOARD);
256                 else
257                         disable_irq(INT_KEYBOARD);
258                 kp_enable = state;
259         }
260         mutex_unlock(&kp_enable_mutex);
261
262         return strnlen(buf, count);
263 }
264
265 static DEVICE_ATTR(enable, S_IRUGO | S_IWUSR, omap_kp_enable_show, omap_kp_enable_store);
266
267 #ifdef CONFIG_PM
268 static int omap_kp_suspend(struct platform_device *dev, pm_message_t state)
269 {
270         /* Nothing yet */
271
272         return 0;
273 }
274
275 static int omap_kp_resume(struct platform_device *dev)
276 {
277         /* Nothing yet */
278
279         return 0;
280 }
281 #else
282 #define omap_kp_suspend NULL
283 #define omap_kp_resume  NULL
284 #endif
285
286 static int __init omap_kp_probe(struct platform_device *pdev)
287 {
288         struct omap_kp *omap_kp;
289         struct input_dev *input_dev;
290         struct omap_kp_platform_data *pdata =  pdev->dev.platform_data;
291         int i, col_idx, row_idx, irq_idx, ret;
292
293         if (!pdata->rows || !pdata->cols || !pdata->keymap) {
294                 printk(KERN_ERR "No rows, cols or keymap from pdata\n");
295                 return -EINVAL;
296         }
297
298         omap_kp = kzalloc(sizeof(struct omap_kp), GFP_KERNEL);
299         input_dev = input_allocate_device();
300         if (!omap_kp || !input_dev) {
301                 kfree(omap_kp);
302                 input_free_device(input_dev);
303                 return -ENOMEM;
304         }
305
306         platform_set_drvdata(pdev, omap_kp);
307
308         omap_kp->input = input_dev;
309
310         /* Disable the interrupt for the MPUIO keyboard */
311         if (!cpu_is_omap24xx())
312                 omap_writew(1, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
313
314         keymap = pdata->keymap;
315
316         if (pdata->rep)
317                 __set_bit(EV_REP, input_dev->evbit);
318
319         if (pdata->delay)
320                 omap_kp->delay = pdata->delay;
321
322         if (pdata->row_gpios && pdata->col_gpios) {
323                 row_gpios = pdata->row_gpios;
324                 col_gpios = pdata->col_gpios;
325         }
326
327         omap_kp->rows = pdata->rows;
328         omap_kp->cols = pdata->cols;
329
330         if (cpu_is_omap24xx()) {
331                 /* Cols: outputs */
332                 for (col_idx = 0; col_idx < omap_kp->cols; col_idx++) {
333                         if (gpio_request(col_gpios[col_idx], "omap_kp_col") < 0) {
334                                 printk(KERN_ERR "Failed to request"
335                                        "GPIO%d for keypad\n",
336                                        col_gpios[col_idx]);
337                                 goto err1;
338                         }
339                         gpio_direction_output(col_gpios[col_idx], 0);
340                 }
341                 /* Rows: inputs */
342                 for (row_idx = 0; row_idx < omap_kp->rows; row_idx++) {
343                         if (gpio_request(row_gpios[row_idx], "omap_kp_row") < 0) {
344                                 printk(KERN_ERR "Failed to request"
345                                        "GPIO%d for keypad\n",
346                                        row_gpios[row_idx]);
347                                 goto err2;
348                         }
349                         gpio_direction_input(row_gpios[row_idx]);
350                 }
351         } else {
352                 col_idx = 0;
353                 row_idx = 0;
354         }
355
356         setup_timer(&omap_kp->timer, omap_kp_timer, (unsigned long)omap_kp);
357
358         /* get the irq and init timer*/
359         tasklet_enable(&kp_tasklet);
360         kp_tasklet.data = (unsigned long) omap_kp;
361
362         ret = device_create_file(&pdev->dev, &dev_attr_enable);
363         if (ret < 0)
364                 goto err2;
365
366         /* setup input device */
367         __set_bit(EV_KEY, input_dev->evbit);
368         for (i = 0; keymap[i] != 0; i++)
369                 __set_bit(keymap[i] & KEY_MAX, input_dev->keybit);
370         input_dev->name = "omap-keypad";
371         input_dev->phys = "omap-keypad/input0";
372         input_dev->dev.parent = &pdev->dev;
373
374         input_dev->id.bustype = BUS_HOST;
375         input_dev->id.vendor = 0x0001;
376         input_dev->id.product = 0x0001;
377         input_dev->id.version = 0x0100;
378
379         ret = input_register_device(omap_kp->input);
380         if (ret < 0) {
381                 printk(KERN_ERR "Unable to register omap-keypad input device\n");
382                 goto err3;
383         }
384
385         if (pdata->dbounce)
386                 omap_writew(0xff, OMAP_MPUIO_BASE + OMAP_MPUIO_GPIO_DEBOUNCING);
387
388         /* scan current status and enable interrupt */
389         omap_kp_scan_keypad(omap_kp, keypad_state);
390         if (!cpu_is_omap24xx()) {
391                 omap_kp->irq = platform_get_irq(pdev, 0);
392                 if (omap_kp->irq >= 0) {
393                         if (request_irq(omap_kp->irq, omap_kp_interrupt, 0,
394                                         "omap-keypad", omap_kp) < 0)
395                                 goto err4;
396                 }
397                 omap_writew(0, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
398         } else {
399                 for (irq_idx = 0; irq_idx < omap_kp->rows; irq_idx++) {
400                         if (request_irq(gpio_to_irq(row_gpios[irq_idx]),
401                                         omap_kp_interrupt,
402                                         IRQF_TRIGGER_FALLING,
403                                         "omap-keypad", omap_kp) < 0)
404                                 goto err5;
405                 }
406         }
407         return 0;
408 err5:
409         for (i = irq_idx - 1; i >=0; i--)
410                 free_irq(row_gpios[i], 0);
411 err4:
412         input_unregister_device(omap_kp->input);
413         input_dev = NULL;
414 err3:
415         device_remove_file(&pdev->dev, &dev_attr_enable);
416 err2:
417         for (i = row_idx - 1; i >=0; i--)
418                 gpio_free(row_gpios[i]);
419 err1:
420         for (i = col_idx - 1; i >=0; i--)
421                 gpio_free(col_gpios[i]);
422
423         kfree(omap_kp);
424         input_free_device(input_dev);
425
426         return -EINVAL;
427 }
428
429 static int omap_kp_remove(struct platform_device *pdev)
430 {
431         struct omap_kp *omap_kp = platform_get_drvdata(pdev);
432
433         /* disable keypad interrupt handling */
434         tasklet_disable(&kp_tasklet);
435         if (cpu_is_omap24xx()) {
436                 int i;
437                 for (i = 0; i < omap_kp->cols; i++)
438                         gpio_free(col_gpios[i]);
439                 for (i = 0; i < omap_kp->rows; i++) {
440                         gpio_free(row_gpios[i]);
441                         free_irq(gpio_to_irq(row_gpios[i]), 0);
442                 }
443         } else {
444                 omap_writew(1, OMAP_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
445                 free_irq(omap_kp->irq, 0);
446         }
447
448         del_timer_sync(&omap_kp->timer);
449         tasklet_kill(&kp_tasklet);
450
451         /* unregister everything */
452         input_unregister_device(omap_kp->input);
453
454         kfree(omap_kp);
455
456         return 0;
457 }
458
459 static struct platform_driver omap_kp_driver = {
460         .probe          = omap_kp_probe,
461         .remove         = omap_kp_remove,
462         .suspend        = omap_kp_suspend,
463         .resume         = omap_kp_resume,
464         .driver         = {
465                 .name   = "omap-keypad",
466                 .owner  = THIS_MODULE,
467         },
468 };
469
470 static int __devinit omap_kp_init(void)
471 {
472         printk(KERN_INFO "OMAP Keypad Driver\n");
473         return platform_driver_register(&omap_kp_driver);
474 }
475
476 static void __exit omap_kp_exit(void)
477 {
478         platform_driver_unregister(&omap_kp_driver);
479 }
480
481 module_init(omap_kp_init);
482 module_exit(omap_kp_exit);
483
484 MODULE_AUTHOR("Timo Teräs");
485 MODULE_DESCRIPTION("OMAP Keypad Driver");
486 MODULE_LICENSE("GPL");
487 MODULE_ALIAS("platform:omap-keypad");