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