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