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