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