drivers/input/keyboard/omap-twl4030keypad.c

   1 /*
   2  * drivers/input/keyboard/omap-twl4030keypad.c
   3  *
   4  * Copyright (C) 2007 Texas Instruments, Inc.
   5  * Copyright (C) 2008 Nokia Corporation
   6  *
   7  * Code re-written for 2430SDP by:
   8  * Syed Mohammed Khasim <x0khasim@ti.com>
   9  *
  10  * Initial Code:
  11  * Manjunatha G K <manjugk@ti.com>
  12  *
  13  * This program is free software; you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation; either version 2 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  21  * GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License
  24  * along with this program; if not, write to the Free Software
  25  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  26  */
  27
  28 #include <linux/kernel.h>
  29 #include <linux/module.h>
  30 #include <linux/init.h>
  31 #include <linux/interrupt.h>
  32 #include <linux/input.h>
  33 #include <linux/platform_device.h>
  34 #include <linux/i2c/twl4030.h>
  35
  36 /*
  37  * The TWL4030 family chips include a keypad controller that supports
  38  * up to an 8x8 switch matrix.  The controller can issue system wakeup
  39  * events, since it uses only the always-on 32KiHz oscillator, and has
  40  * an internal state machine that decodes pressed keys, including
  41  * multi-key combinations.
  42  *
  43  * This driver lets boards define what keycodes they wish to report for
  44  * which scancodes, as part of the "struct twl4030_keypad_data" used in
  45  * the probe() routine.
  46  *
  47  * See the TPS65950 documentation; that's the general availability
  48  * version of the TWL5030 second generation part.
  49  */
  50 #define MAX_ROWS                8       /* TWL4030 hard limit */
  51
  52 struct twl4030_keypad {
  53         unsigned        *keymap;
  54         unsigned int    keymapsize;
  55         u16             kp_state[MAX_ROWS];
  56         unsigned        n_rows;
  57         unsigned        n_cols;
  58         unsigned        irq;
  59
  60         struct device   *dbg_dev;
  61         struct input_dev *input;
  62 };
  63
  64 #define ROWCOL_MASK     KEY(0xf, 0xf, 0)
  65 #define KEYNUM_MASK     ~PERSISTENT_KEY(0xf, 0xf)
  66
  67 /*----------------------------------------------------------------------*/
  68
  69 /* arbitrary prescaler value 0..7 */
  70 #define PTV_PRESCALER                   4
  71
  72 /* Register Offsets */
  73 #define KEYP_CTRL                       0x00
  74 #define KEYP_DEB                        0x01
  75 #define KEYP_LONG_KEY                   0x02
  76 #define KEYP_LK_PTV                     0x03
  77 #define KEYP_TIMEOUT_L                  0x04
  78 #define KEYP_TIMEOUT_H                  0x05
  79 #define KEYP_KBC                        0x06
  80 #define KEYP_KBR                        0x07
  81 #define KEYP_SMS                        0x08
  82 #define KEYP_FULL_CODE_7_0              0x09    /* row 0 column status */
  83 #define KEYP_FULL_CODE_15_8             0x0a    /* ... row 1 ... */
  84 #define KEYP_FULL_CODE_23_16            0x0b
  85 #define KEYP_FULL_CODE_31_24            0x0c
  86 #define KEYP_FULL_CODE_39_32            0x0d
  87 #define KEYP_FULL_CODE_47_40            0x0e
  88 #define KEYP_FULL_CODE_55_48            0x0f
  89 #define KEYP_FULL_CODE_63_56            0x10
  90 #define KEYP_ISR1                       0x11
  91 #define KEYP_IMR1                       0x12
  92 #define KEYP_ISR2                       0x13
  93 #define KEYP_IMR2                       0x14
  94 #define KEYP_SIR                        0x15
  95 #define KEYP_EDR                        0x16    /* edge triggers */
  96 #define KEYP_SIH_CTRL                   0x17
  97
  98 /* KEYP_CTRL_REG Fields */
  99 #define KEYP_CTRL_SOFT_NRST             BIT(0)
 100 #define KEYP_CTRL_SOFTMODEN             BIT(1)
 101 #define KEYP_CTRL_LK_EN                 BIT(2)
 102 #define KEYP_CTRL_TOE_EN                BIT(3)
 103 #define KEYP_CTRL_TOLE_EN               BIT(4)
 104 #define KEYP_CTRL_RP_EN                 BIT(5)
 105 #define KEYP_CTRL_KBD_ON                BIT(6)
 106
 107 /* KEYP_DEB, KEYP_LONG_KEY, KEYP_TIMEOUT_x*/
 108 #define KEYP_PERIOD_US(t, prescale)     ((t) / (31 << (prescale + 1)) - 1)
 109
 110 /* KEYP_LK_PTV_REG Fields */
 111 #define KEYP_LK_PTV_PTV_SHIFT           5
 112
 113 /* KEYP_{IMR,ISR,SIR} Fields */
 114 #define KEYP_IMR1_MIS                   BIT(3)
 115 #define KEYP_IMR1_TO                    BIT(2)
 116 #define KEYP_IMR1_LK                    BIT(1)
 117 #define KEYP_IMR1_KP                    BIT(0)
 118
 119 /* KEYP_EDR Fields */
 120 #define KEYP_EDR_KP_FALLING             0x01
 121 #define KEYP_EDR_KP_RISING              0x02
 122 #define KEYP_EDR_KP_BOTH                0x03
 123 #define KEYP_EDR_LK_FALLING             0x04
 124 #define KEYP_EDR_LK_RISING              0x08
 125 #define KEYP_EDR_TO_FALLING             0x10
 126 #define KEYP_EDR_TO_RISING              0x20
 127 #define KEYP_EDR_MIS_FALLING            0x40
 128 #define KEYP_EDR_MIS_RISING             0x80
 129
 130
 131 /*----------------------------------------------------------------------*/
 132
 133 static int twl4030_kpread(struct twl4030_keypad *kp,
 134                 u8 *data, u32 reg, u8 num_bytes)
 135 {
 136         int ret;
 137
 138         ret = twl4030_i2c_read(TWL4030_MODULE_KEYPAD, data, reg, num_bytes);
 139         if (ret < 0) {
 140                 dev_warn(kp->dbg_dev,
 141                         "Couldn't read TWL4030: %X - ret %d[%x]\n",
 142                          reg, ret, ret);
 143                 return ret;
 144         }
 145         return ret;
 146 }
 147
 148 static int twl4030_kpwrite_u8(struct twl4030_keypad *kp, u8 data, u32 reg)
 149 {
 150         int ret;
 151
 152         ret = twl4030_i2c_write_u8(TWL4030_MODULE_KEYPAD, data, reg);
 153         if (ret < 0) {
 154                 dev_warn(kp->dbg_dev,
 155                         "Could not write TWL4030: %X - ret %d[%x]\n",
 156                          reg, ret, ret);
 157                 return ret;
 158         }
 159         return ret;
 160 }
 161
 162 static int twl4030_find_key(struct twl4030_keypad *kp, int col, int row)
 163 {
 164         int i, rc;
 165
 166         rc = KEY(col, row, 0);
 167         for (i = 0; i < kp->keymapsize; i++)
 168                 if ((kp->keymap[i] & ROWCOL_MASK) == rc)
 169                         return kp->keymap[i] & (KEYNUM_MASK | KEY_PERSISTENT);
 170
 171         return -EINVAL;
 172 }
 173
 174 static inline u16 twl4030_col_xlate(struct twl4030_keypad *kp, u8 col)
 175 {
 176         /* If all bits in a row are active for all coloumns then
 177          * we have that row line connected to gnd. Mark this
 178          * key on as if it was on matrix position n_cols (ie
 179          * one higher than the size of the matrix).
 180          */
 181         if (col == 0xFF)
 182                 return 1 << kp->n_cols;
 183         else
 184                 return col & ((1 << kp->n_cols) - 1);
 185 }
 186
 187 static int twl4030_read_kp_matrix_state(struct twl4030_keypad *kp, u16 *state)
 188 {
 189         u8 new_state[MAX_ROWS];
 190         int row;
 191         int ret = twl4030_kpread(kp,
 192                                  new_state, KEYP_FULL_CODE_7_0, kp->n_rows);
 193         if (ret >= 0) {
 194                 for (row = 0; row < kp->n_rows; row++)
 195                         state[row] = twl4030_col_xlate(kp, new_state[row]);
 196         }
 197         return ret;
 198 }
 199
 200 static int twl4030_is_in_ghost_state(struct twl4030_keypad *kp, u16 *key_state)
 201 {
 202         int i;
 203         u16 check = 0;
 204
 205         for (i = 0; i < kp->n_rows; i++) {
 206                 u16 col = key_state[i];
 207
 208                 if ((col & check) && hweight16(col) > 1)
 209                         return 1;
 210                 check |= col;
 211         }
 212
 213         return 0;
 214 }
 215
 216 static void twl4030_kp_scan(struct twl4030_keypad *kp, int release_all)
 217 {
 218         u16 new_state[MAX_ROWS];
 219         int col, row;
 220
 221         if (release_all)
 222                 memset(new_state, 0, sizeof(new_state));
 223         else {
 224                 /* check for any changes */
 225                 int ret = twl4030_read_kp_matrix_state(kp, new_state);
 226
 227                 if (ret < 0)    /* panic ... */
 228                         return;
 229                 if (twl4030_is_in_ghost_state(kp, new_state))
 230                         return;
 231         }
 232
 233         /* check for changes and print those */
 234         for (row = 0; row < kp->n_rows; row++) {
 235                 int changed = new_state[row] ^ kp->kp_state[row];
 236
 237                 if (!changed)
 238                         continue;
 239
 240                 for (col = 0; col < kp->n_cols; col++) {
 241                         int key;
 242
 243                         if (!(changed & (1 << col)))
 244                                 continue;
 245
 246                         dev_dbg(kp->dbg_dev, "key [%d:%d] %s\n", row, col,
 247                                 (new_state[row] & (1 << col)) ?
 248                                 "press" : "release");
 249
 250                         key = twl4030_find_key(kp, col, row);
 251                         if (key < 0)
 252                                 dev_warn(kp->dbg_dev,
 253                                         "Spurious key event %d-%d\n",
 254                                          col, row);
 255                         else if (key & KEY_PERSISTENT)
 256                                 continue;
 257                         else
 258                                 input_report_key(kp->input, key,
 259                                                  new_state[row] & (1 << col));
 260                 }
 261                 kp->kp_state[row] = new_state[row];
 262         }
 263         input_sync(kp->input);
 264 }
 265
 266 /*
 267  * Keypad interrupt handler
 268  */
 269 static irqreturn_t do_kp_irq(int irq, void *_kp)
 270 {
 271         struct twl4030_keypad *kp = _kp;
 272         u8 reg;
 273         int ret;
 274
 275 #ifdef CONFIG_LOCKDEP
 276         /* WORKAROUND for lockdep forcing IRQF_DISABLED on us, which
 277          * we don't want and can't tolerate.  Although it might be
 278          * friendlier not to borrow this thread context...
 279          */
 280         local_irq_enable();
 281 #endif
 282
 283         /* Read & Clear TWL4030 pending interrupt */
 284         ret = twl4030_kpread(kp, &reg, KEYP_ISR1, 1);
 285
 286         /* Release all keys if I2C has gone bad or
 287          * the KEYP has gone to idle state */
 288         if ((ret >= 0) && (reg & KEYP_IMR1_KP))
 289                 twl4030_kp_scan(kp, 0);
 290         else
 291                 twl4030_kp_scan(kp, 1);
 292
 293         return IRQ_HANDLED;
 294 }
 295
 296 /*
 297  * Registers keypad device with input subsystem
 298  * and configures TWL4030 keypad registers
 299  */
 300 static int __devinit twl4030_kp_probe(struct platform_device *pdev)
 301 {
 302         u8 reg;
 303         int i;
 304         int ret = 0;
 305         struct twl4030_keypad *kp;
 306         struct twl4030_keypad_data *pdata = pdev->dev.platform_data;
 307
 308         if (!pdata || !pdata->rows || !pdata->cols || !pdata->keymap
 309                         || pdata->rows > 8 || pdata->cols > 8) {
 310                 dev_err(&pdev->dev, "Invalid platform_data\n");
 311                 return -EINVAL;
 312         }
 313
 314         kp = kzalloc(sizeof(*kp), GFP_KERNEL);
 315         if (!kp)
 316                 return -ENOMEM;
 317
 318         platform_set_drvdata(pdev, kp);
 319
 320         /* Get the debug Device */
 321         kp->dbg_dev = &pdev->dev;
 322
 323         kp->input = input_allocate_device();
 324         if (!kp->input) {
 325                 kfree(kp);
 326                 return -ENOMEM;
 327         }
 328
 329         kp->keymap = pdata->keymap;
 330         kp->keymapsize = pdata->keymapsize;
 331         kp->n_rows = pdata->rows;
 332         kp->n_cols = pdata->cols;
 333         kp->irq = platform_get_irq(pdev, 0);
 334
 335         /* setup input device */
 336         __set_bit(EV_KEY, kp->input->evbit);
 337
 338         /* Enable auto repeat feature of Linux input subsystem */
 339         if (pdata->rep)
 340                 __set_bit(EV_REP, kp->input->evbit);
 341
 342         for (i = 0; i < kp->keymapsize; i++)
 343                 __set_bit(kp->keymap[i] & KEYNUM_MASK,
 344                                 kp->input->keybit);
 345
 346         kp->input->name         = "TWL4030 Keypad";
 347         kp->input->phys         = "twl4030_keypad/input0";
 348         kp->input->dev.parent   = &pdev->dev;
 349
 350         kp->input->id.bustype   = BUS_HOST;
 351         kp->input->id.vendor    = 0x0001;
 352         kp->input->id.product   = 0x0001;
 353         kp->input->id.version   = 0x0003;
 354
 355         kp->input->keycode      = kp->keymap;
 356         kp->input->keycodesize  = sizeof(unsigned int);
 357         kp->input->keycodemax   = kp->keymapsize;
 358
 359         ret = input_register_device(kp->input);
 360         if (ret < 0) {
 361                 dev_err(kp->dbg_dev,
 362                         "Unable to register twl4030 keypad device\n");
 363                 goto err2;
 364         }
 365
 366         /* Enable controller, with hardware decoding but not autorepeat */
 367         reg = KEYP_CTRL_SOFT_NRST | KEYP_CTRL_SOFTMODEN
 368                 | KEYP_CTRL_TOE_EN | KEYP_CTRL_KBD_ON;
 369         ret = twl4030_kpwrite_u8(kp, reg, KEYP_CTRL);
 370         if (ret < 0)
 371                 goto err3;
 372
 373         /* NOTE:  we could use sih_setup() here to package keypad
 374          * event sources as four different IRQs ... but we don't.
 375          */
 376
 377         /* Enable TO rising and KP rising and falling edge detection */
 378         reg = KEYP_EDR_KP_BOTH | KEYP_EDR_TO_RISING;
 379         ret = twl4030_kpwrite_u8(kp, reg, KEYP_EDR);
 380         if (ret < 0)
 381                 goto err3;
 382
 383         /* Set PTV prescaler Field */
 384         reg = (PTV_PRESCALER << KEYP_LK_PTV_PTV_SHIFT);
 385         ret = twl4030_kpwrite_u8(kp, reg, KEYP_LK_PTV);
 386         if (ret < 0)
 387                 goto err3;
 388
 389         /* Set key debounce time to 20 ms */
 390         i = KEYP_PERIOD_US(20000, PTV_PRESCALER);
 391         ret = twl4030_kpwrite_u8(kp, i, KEYP_DEB);
 392         if (ret < 0)
 393                 goto err3;
 394
 395         /* Set timeout period to 100 ms */
 396         i = KEYP_PERIOD_US(200000, PTV_PRESCALER);
 397         ret = twl4030_kpwrite_u8(kp, (i & 0xFF), KEYP_TIMEOUT_L);
 398         if (ret < 0)
 399                 goto err3;
 400         ret = twl4030_kpwrite_u8(kp, (i >> 8), KEYP_TIMEOUT_H);
 401         if (ret < 0)
 402                 goto err3;
 403
 404         /* Enable Clear-on-Read; disable remembering events that fire
 405          * after the IRQ but before our handler acks (reads) them,
 406          */
 407         reg = TWL4030_SIH_CTRL_COR_MASK | TWL4030_SIH_CTRL_PENDDIS_MASK;
 408         ret = twl4030_kpwrite_u8(kp, reg, KEYP_SIH_CTRL);
 409         if (ret < 0)
 410                 goto err3;
 411
 412         /* initialize key state; irqs update it from here on */
 413         ret = twl4030_read_kp_matrix_state(kp, kp->kp_state);
 414         if (ret < 0)
 415                 goto err3;
 416
 417         /*
 418          * This ISR will always execute in kernel thread context because of
 419          * the need to access the TWL4030 over the I2C bus.
 420          *
 421          * NOTE:  we assume this host is wired to TWL4040 INT1, not INT2 ...
 422          */
 423         ret = request_irq(kp->irq, do_kp_irq, 0, pdev->name, kp);
 424         if (ret < 0) {
 425                 dev_info(kp->dbg_dev, "request_irq failed for irq no=%d\n",
 426                         kp->irq);
 427                 goto err3;
 428         } else {
 429                 /* Enable KP and TO interrupts now. */
 430                 reg = (u8) ~(KEYP_IMR1_KP | KEYP_IMR1_TO);
 431                 ret = twl4030_kpwrite_u8(kp, reg, KEYP_IMR1);
 432                 if (ret < 0)
 433                         goto err5;
 434         }
 435
 436         return ret;
 437 err5:
 438         /* mask all events - we don't care about the result */
 439         (void) twl4030_kpwrite_u8(kp, 0xff, KEYP_IMR1);
 440         free_irq(kp->irq, NULL);
 441 err3:
 442         input_unregister_device(kp->input);
 443         kp->input = NULL;
 444 err2:
 445         input_free_device(kp->input);
 446         kfree(kp);
 447         return -ENODEV;
 448 }
 449
 450 static int __devexit twl4030_kp_remove(struct platform_device *pdev)
 451 {
 452         struct twl4030_keypad *kp = platform_get_drvdata(pdev);
 453
 454         free_irq(kp->irq, kp);
 455         input_unregister_device(kp->input);
 456         kfree(kp);
 457
 458         return 0;
 459 }
 460
 461 MODULE_ALIAS("platform:twl4030_keypad");
 462
 463 static struct platform_driver twl4030_kp_driver = {
 464         .probe          = twl4030_kp_probe,
 465         .remove         = __devexit_p(twl4030_kp_remove),
 466         .driver         = {
 467                 .name   = "twl4030_keypad",
 468                 .owner  = THIS_MODULE,
 469         },
 470 };
 471
 472 /*
 473  * OMAP TWL4030 Keypad init
 474  */
 475 static int __init twl4030_kp_init(void)
 476 {
 477         return platform_driver_register(&twl4030_kp_driver);
 478 }
 479 module_init(twl4030_kp_init);
 480
 481 static void __exit twl4030_kp_exit(void)
 482 {
 483         platform_driver_unregister(&twl4030_kp_driver);
 484 }
 485 module_exit(twl4030_kp_exit);
 486
 487 MODULE_AUTHOR("Texas Instruments");
 488 MODULE_DESCRIPTION("TWL4030 Keypad Driver");
 489 MODULE_LICENSE("GPL");