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 <linux/gpio.h>
  39 #include <linux/platform_data/gpio-omap.h>
  40 #include <linux/platform_data/keypad-omap.h>
  41
  42 #undef NEW_BOARD_LEARNING_MODE
  43
  44 static void omap_kp_tasklet(unsigned long);
  45 static void omap_kp_timer(unsigned long);
  46
  47 static unsigned char keypad_state[8];
  48 static DEFINE_MUTEX(kp_enable_mutex);
  49 static int kp_enable = 1;
  50 static int kp_cur_group = -1;
  51
  52 struct omap_kp {
  53         struct input_dev *input;
  54         struct timer_list timer;
  55         int irq;
  56         unsigned int rows;
  57         unsigned int cols;
  58         unsigned long delay;
  59         unsigned int debounce;
  60         unsigned short keymap[];
  61 };
  62
  63 static DECLARE_TASKLET_DISABLED(kp_tasklet, omap_kp_tasklet, 0);
  64
  65 static unsigned int *row_gpios;
  66 static unsigned int *col_gpios;
  67
  68 #ifdef CONFIG_ARCH_OMAP2
  69 static void set_col_gpio_val(struct omap_kp *omap_kp, u8 value)
  70 {
  71         int col;
  72
  73         for (col = 0; col < omap_kp->cols; col++)
  74                 gpio_set_value(col_gpios[col], value & (1 << col));
  75 }
  76
  77 static u8 get_row_gpio_val(struct omap_kp *omap_kp)
  78 {
  79         int row;
  80         u8 value = 0;
  81
  82         for (row = 0; row < omap_kp->rows; row++) {
  83                 if (gpio_get_value(row_gpios[row]))
  84                         value |= (1 << row);
  85         }
  86         return value;
  87 }
  88 #else
  89 #define         set_col_gpio_val(x, y)  do {} while (0)
  90 #define         get_row_gpio_val(x)     0
  91 #endif
  92
  93 static irqreturn_t omap_kp_interrupt(int irq, void *dev_id)
  94 {
  95         /* disable keyboard interrupt and schedule for handling */
  96         omap_writew(1, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
  97
  98         tasklet_schedule(&kp_tasklet);
  99
 100         return IRQ_HANDLED;
 101 }
 102
 103 static void omap_kp_timer(unsigned long data)
 104 {
 105         tasklet_schedule(&kp_tasklet);
 106 }
 107
 108 static void omap_kp_scan_keypad(struct omap_kp *omap_kp, unsigned char *state)
 109 {
 110         int col = 0;
 111
 112         /* disable keyboard interrupt and schedule for handling */
 113         omap_writew(1, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
 114
 115         /* read the keypad status */
 116         omap_writew(0xff, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBC);
 117         for (col = 0; col < omap_kp->cols; col++) {
 118                 omap_writew(~(1 << col) & 0xff,
 119                             OMAP1_MPUIO_BASE + OMAP_MPUIO_KBC);
 120
 121                 udelay(omap_kp->delay);
 122
 123                 state[col] = ~omap_readw(OMAP1_MPUIO_BASE +
 124                                          OMAP_MPUIO_KBR_LATCH) & 0xff;
 125         }
 126         omap_writew(0x00, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBC);
 127         udelay(2);
 128 }
 129
 130 static void omap_kp_tasklet(unsigned long data)
 131 {
 132         struct omap_kp *omap_kp_data = (struct omap_kp *) data;
 133         unsigned short *keycodes = omap_kp_data->input->keycode;
 134         unsigned int row_shift = get_count_order(omap_kp_data->cols);
 135         unsigned char new_state[8], changed, key_down = 0;
 136         int col, row;
 137         int spurious = 0;
 138
 139         /* check for any changes */
 140         omap_kp_scan_keypad(omap_kp_data, new_state);
 141
 142         /* check for changes and print those */
 143         for (col = 0; col < omap_kp_data->cols; col++) {
 144                 changed = new_state[col] ^ keypad_state[col];
 145                 key_down |= new_state[col];
 146                 if (changed == 0)
 147                         continue;
 148
 149                 for (row = 0; row < omap_kp_data->rows; row++) {
 150                         int key;
 151                         if (!(changed & (1 << row)))
 152                                 continue;
 153 #ifdef NEW_BOARD_LEARNING_MODE
 154                         printk(KERN_INFO "omap-keypad: key %d-%d %s\n", col,
 155                                row, (new_state[col] & (1 << row)) ?
 156                                "pressed" : "released");
 157 #else
 158                         key = keycodes[MATRIX_SCAN_CODE(row, col, row_shift)];
 159                         if (key < 0) {
 160                                 printk(KERN_WARNING
 161                                       "omap-keypad: Spurious key event %d-%d\n",
 162                                        col, row);
 163                                 /* We scan again after a couple of seconds */
 164                                 spurious = 1;
 165                                 continue;
 166                         }
 167
 168                         if (!(kp_cur_group == (key & GROUP_MASK) ||
 169                               kp_cur_group == -1))
 170                                 continue;
 171
 172                         kp_cur_group = key & GROUP_MASK;
 173                         input_report_key(omap_kp_data->input, key & ~GROUP_MASK,
 174                                          new_state[col] & (1 << row));
 175 #endif
 176                 }
 177         }
 178         input_sync(omap_kp_data->input);
 179         memcpy(keypad_state, new_state, sizeof(keypad_state));
 180
 181         if (key_down) {
 182                 int delay = HZ / 20;
 183                 /* some key is pressed - keep irq disabled and use timer
 184                  * to poll the keypad */
 185                 if (spurious)
 186                         delay = 2 * HZ;
 187                 mod_timer(&omap_kp_data->timer, jiffies + delay);
 188         } else {
 189                 /* enable interrupts */
 190                 omap_writew(0, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
 191                 kp_cur_group = -1;
 192         }
 193 }
 194
 195 static ssize_t omap_kp_enable_show(struct device *dev,
 196                                    struct device_attribute *attr, char *buf)
 197 {
 198         return sprintf(buf, "%u\n", kp_enable);
 199 }
 200
 201 static ssize_t omap_kp_enable_store(struct device *dev, struct device_attribute *attr,
 202                                     const char *buf, size_t count)
 203 {
 204         struct omap_kp *omap_kp = dev_get_drvdata(dev);
 205         int state;
 206
 207         if (sscanf(buf, "%u", &state) != 1)
 208                 return -EINVAL;
 209
 210         if ((state != 1) && (state != 0))
 211                 return -EINVAL;
 212
 213         mutex_lock(&kp_enable_mutex);
 214         if (state != kp_enable) {
 215                 if (state)
 216                         enable_irq(omap_kp->irq);
 217                 else
 218                         disable_irq(omap_kp->irq);
 219                 kp_enable = state;
 220         }
 221         mutex_unlock(&kp_enable_mutex);
 222
 223         return strnlen(buf, count);
 224 }
 225
 226 static DEVICE_ATTR(enable, S_IRUGO | S_IWUSR, omap_kp_enable_show, omap_kp_enable_store);
 227
 228 #ifdef CONFIG_PM
 229 static int omap_kp_suspend(struct platform_device *dev, pm_message_t state)
 230 {
 231         /* Nothing yet */
 232
 233         return 0;
 234 }
 235
 236 static int omap_kp_resume(struct platform_device *dev)
 237 {
 238         /* Nothing yet */
 239
 240         return 0;
 241 }
 242 #else
 243 #define omap_kp_suspend NULL
 244 #define omap_kp_resume  NULL
 245 #endif
 246
 247 static int omap_kp_probe(struct platform_device *pdev)
 248 {
 249         struct omap_kp *omap_kp;
 250         struct input_dev *input_dev;
 251         struct omap_kp_platform_data *pdata =  pdev->dev.platform_data;
 252         int i, col_idx, row_idx, ret;
 253         unsigned int row_shift, keycodemax;
 254
 255         if (!pdata->rows || !pdata->cols || !pdata->keymap_data) {
 256                 printk(KERN_ERR "No rows, cols or keymap_data from pdata\n");
 257                 return -EINVAL;
 258         }
 259
 260         row_shift = get_count_order(pdata->cols);
 261         keycodemax = pdata->rows << row_shift;
 262
 263         omap_kp = kzalloc(sizeof(struct omap_kp) +
 264                         keycodemax * sizeof(unsigned short), GFP_KERNEL);
 265         input_dev = input_allocate_device();
 266         if (!omap_kp || !input_dev) {
 267                 kfree(omap_kp);
 268                 input_free_device(input_dev);
 269                 return -ENOMEM;
 270         }
 271
 272         platform_set_drvdata(pdev, omap_kp);
 273
 274         omap_kp->input = input_dev;
 275
 276         /* Disable the interrupt for the MPUIO keyboard */
 277         omap_writew(1, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
 278
 279         if (pdata->delay)
 280                 omap_kp->delay = pdata->delay;
 281
 282         if (pdata->row_gpios && pdata->col_gpios) {
 283                 row_gpios = pdata->row_gpios;
 284                 col_gpios = pdata->col_gpios;
 285         }
 286
 287         omap_kp->rows = pdata->rows;
 288         omap_kp->cols = pdata->cols;
 289
 290         col_idx = 0;
 291         row_idx = 0;
 292
 293         setup_timer(&omap_kp->timer, omap_kp_timer, (unsigned long)omap_kp);
 294
 295         /* get the irq and init timer*/
 296         tasklet_enable(&kp_tasklet);
 297         kp_tasklet.data = (unsigned long) omap_kp;
 298
 299         ret = device_create_file(&pdev->dev, &dev_attr_enable);
 300         if (ret < 0)
 301                 goto err2;
 302
 303         /* setup input device */
 304         input_dev->name = "omap-keypad";
 305         input_dev->phys = "omap-keypad/input0";
 306         input_dev->dev.parent = &pdev->dev;
 307
 308         input_dev->id.bustype = BUS_HOST;
 309         input_dev->id.vendor = 0x0001;
 310         input_dev->id.product = 0x0001;
 311         input_dev->id.version = 0x0100;
 312
 313         if (pdata->rep)
 314                 __set_bit(EV_REP, input_dev->evbit);
 315
 316         ret = matrix_keypad_build_keymap(pdata->keymap_data, NULL,
 317                                          pdata->rows, pdata->cols,
 318                                          omap_kp->keymap, input_dev);
 319         if (ret < 0)
 320                 goto err3;
 321
 322         ret = input_register_device(omap_kp->input);
 323         if (ret < 0) {
 324                 printk(KERN_ERR "Unable to register omap-keypad input device\n");
 325                 goto err3;
 326         }
 327
 328         if (pdata->dbounce)
 329                 omap_writew(0xff, OMAP1_MPUIO_BASE + OMAP_MPUIO_GPIO_DEBOUNCING);
 330
 331         /* scan current status and enable interrupt */
 332         omap_kp_scan_keypad(omap_kp, keypad_state);
 333         omap_kp->irq = platform_get_irq(pdev, 0);
 334         if (omap_kp->irq >= 0) {
 335                 if (request_irq(omap_kp->irq, omap_kp_interrupt, 0,
 336                                 "omap-keypad", omap_kp) < 0)
 337                         goto err4;
 338         }
 339         omap_writew(0, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
 340
 341         return 0;
 342
 343 err4:
 344         input_unregister_device(omap_kp->input);
 345         input_dev = NULL;
 346 err3:
 347         device_remove_file(&pdev->dev, &dev_attr_enable);
 348 err2:
 349         for (i = row_idx - 1; i >= 0; i--)
 350                 gpio_free(row_gpios[i]);
 351         for (i = col_idx - 1; i >= 0; i--)
 352                 gpio_free(col_gpios[i]);
 353
 354         kfree(omap_kp);
 355         input_free_device(input_dev);
 356
 357         return -EINVAL;
 358 }
 359
 360 static int omap_kp_remove(struct platform_device *pdev)
 361 {
 362         struct omap_kp *omap_kp = platform_get_drvdata(pdev);
 363
 364         /* disable keypad interrupt handling */
 365         tasklet_disable(&kp_tasklet);
 366         omap_writew(1, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
 367         free_irq(omap_kp->irq, omap_kp);
 368
 369         del_timer_sync(&omap_kp->timer);
 370         tasklet_kill(&kp_tasklet);
 371
 372         /* unregister everything */
 373         input_unregister_device(omap_kp->input);
 374
 375         kfree(omap_kp);
 376
 377         return 0;
 378 }
 379
 380 static struct platform_driver omap_kp_driver = {
 381         .probe          = omap_kp_probe,
 382         .remove         = omap_kp_remove,
 383         .suspend        = omap_kp_suspend,
 384         .resume         = omap_kp_resume,
 385         .driver         = {
 386                 .name   = "omap-keypad",
 387                 .owner  = THIS_MODULE,
 388         },
 389 };
 390 module_platform_driver(omap_kp_driver);
 391
 392 MODULE_AUTHOR("Timo Teräs");
 393 MODULE_DESCRIPTION("OMAP Keypad Driver");
 394 MODULE_LICENSE("GPL");
 395 MODULE_ALIAS("platform:omap-keypad");