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