SAFE public projects git trees. - safe/jmp/linux-2.6/blob - drivers/input/keyboard/pxa27x_keypad.c

   1 /*
   2  * linux/drivers/input/keyboard/pxa27x_keypad.c
   3  *
   4  * Driver for the pxa27x matrix keyboard controller.
   5  *
   6  * Created:     Feb 22, 2007
   7  * Author:      Rodolfo Giometti <giometti@linux.it>
   8  *
   9  * Based on a previous implementations by Kevin O'Connor
  10  * <kevin_at_koconnor.net> and Alex Osborne <bobofdoom@gmail.com> and
  11  * on some suggestions by Nicolas Pitre <nico@cam.org>.
  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 version 2 as
  15  * published by the Free Software Foundation.
  16  */
  17
  18
  19 #include <linux/kernel.h>
  20 #include <linux/module.h>
  21 #include <linux/init.h>
  22 #include <linux/interrupt.h>
  23 #include <linux/input.h>
  24 #include <linux/device.h>
  25 #include <linux/platform_device.h>
  26 #include <linux/clk.h>
  27 #include <linux/err.h>
  28
  29 #include <asm/mach-types.h>
  30 #include <asm/mach/arch.h>
  31 #include <asm/mach/map.h>
  32
  33 #include <asm/arch/hardware.h>
  34 #include <asm/arch/pxa27x_keypad.h>
  35
  36 /*
  37  * Keypad Controller registers
  38  */
  39 #define KPC             0x0000 /* Keypad Control register */
  40 #define KPDK            0x0008 /* Keypad Direct Key register */
  41 #define KPREC           0x0010 /* Keypad Rotary Encoder register */
  42 #define KPMK            0x0018 /* Keypad Matrix Key register */
  43 #define KPAS            0x0020 /* Keypad Automatic Scan register */
  44
  45 /* Keypad Automatic Scan Multiple Key Presser register 0-3 */
  46 #define KPASMKP0        0x0028
  47 #define KPASMKP1        0x0030
  48 #define KPASMKP2        0x0038
  49 #define KPASMKP3        0x0040
  50 #define KPKDI           0x0048
  51
  52 /* bit definitions */
  53 #define KPC_MKRN(n)     ((((n) - 1) & 0x7) << 26) /* matrix key row number */
  54 #define KPC_MKCN(n)     ((((n) - 1) & 0x7) << 23) /* matrix key column number */
  55 #define KPC_DKN(n)      ((((n) - 1) & 0x7) << 6)  /* direct key number */
  56
  57 #define KPC_AS          (0x1 << 30)  /* Automatic Scan bit */
  58 #define KPC_ASACT       (0x1 << 29)  /* Automatic Scan on Activity */
  59 #define KPC_MI          (0x1 << 22)  /* Matrix interrupt bit */
  60 #define KPC_IMKP        (0x1 << 21)  /* Ignore Multiple Key Press */
  61
  62 #define KPC_MS(n)       (0x1 << (13 + (n)))     /* Matrix scan line 'n' */
  63 #define KPC_MS_ALL      (0xff << 13)
  64
  65 #define KPC_ME          (0x1 << 12)  /* Matrix Keypad Enable */
  66 #define KPC_MIE         (0x1 << 11)  /* Matrix Interrupt Enable */
  67 #define KPC_DK_DEB_SEL  (0x1 <<  9)  /* Direct Keypad Debounce Select */
  68 #define KPC_DI          (0x1 <<  5)  /* Direct key interrupt bit */
  69 #define KPC_RE_ZERO_DEB (0x1 <<  4)  /* Rotary Encoder Zero Debounce */
  70 #define KPC_REE1        (0x1 <<  3)  /* Rotary Encoder1 Enable */
  71 #define KPC_REE0        (0x1 <<  2)  /* Rotary Encoder0 Enable */
  72 #define KPC_DE          (0x1 <<  1)  /* Direct Keypad Enable */
  73 #define KPC_DIE         (0x1 <<  0)  /* Direct Keypad interrupt Enable */
  74
  75 #define KPDK_DKP        (0x1 << 31)
  76 #define KPDK_DK(n)      ((n) & 0xff)
  77
  78 #define KPREC_OF1       (0x1 << 31)
  79 #define kPREC_UF1       (0x1 << 30)
  80 #define KPREC_OF0       (0x1 << 15)
  81 #define KPREC_UF0       (0x1 << 14)
  82
  83 #define KPREC_RECOUNT0(n)       ((n) & 0xff)
  84 #define KPREC_RECOUNT1(n)       (((n) >> 16) & 0xff)
  85
  86 #define KPMK_MKP        (0x1 << 31)
  87 #define KPAS_SO         (0x1 << 31)
  88 #define KPASMKPx_SO     (0x1 << 31)
  89
  90 #define KPAS_MUKP(n)    (((n) >> 26) & 0x1f)
  91 #define KPAS_RP(n)      (((n) >> 4) & 0xf)
  92 #define KPAS_CP(n)      ((n) & 0xf)
  93
  94 #define KPASMKP_MKC_MASK        (0xff)
  95
  96 #define keypad_readl(off)       __raw_readl(keypad->mmio_base + (off))
  97 #define keypad_writel(off, v)   __raw_writel((v), keypad->mmio_base + (off))
  98
  99 #define MAX_MATRIX_KEY_NUM      (8 * 8)
 100
 101 struct pxa27x_keypad {
 102         struct pxa27x_keypad_platform_data *pdata;
 103
 104         struct clk *clk;
 105         struct input_dev *input_dev;
 106         void __iomem *mmio_base;
 107
 108         int irq;
 109
 110         /* matrix key code map */
 111         unsigned int matrix_keycodes[MAX_MATRIX_KEY_NUM];
 112
 113         /* state row bits of each column scan */
 114         uint32_t matrix_key_state[MAX_MATRIX_KEY_COLS];
 115         uint32_t direct_key_state;
 116
 117         unsigned int direct_key_mask;
 118
 119         int rotary_rel_code[2];
 120         int rotary_up_key[2];
 121         int rotary_down_key[2];
 122 };
 123
 124 static void pxa27x_keypad_build_keycode(struct pxa27x_keypad *keypad)
 125 {
 126         struct pxa27x_keypad_platform_data *pdata = keypad->pdata;
 127         struct input_dev *input_dev = keypad->input_dev;
 128         unsigned int *key;
 129         int i;
 130
 131         key = &pdata->matrix_key_map[0];
 132         for (i = 0; i < pdata->matrix_key_map_size; i++, key++) {
 133                 int row = ((*key) >> 28) & 0xf;
 134                 int col = ((*key) >> 24) & 0xf;
 135                 int code = (*key) & 0xffffff;
 136
 137                 keypad->matrix_keycodes[(row << 3) + col] = code;
 138                 set_bit(code, input_dev->keybit);
 139         }
 140
 141         keypad->rotary_up_key[0] = pdata->rotary0_up_key;
 142         keypad->rotary_up_key[1] = pdata->rotary1_up_key;
 143         keypad->rotary_down_key[0] = pdata->rotary0_down_key;
 144         keypad->rotary_down_key[1] = pdata->rotary1_down_key;
 145         keypad->rotary_rel_code[0] = pdata->rotary0_rel_code;
 146         keypad->rotary_rel_code[1] = pdata->rotary1_rel_code;
 147
 148         if (pdata->rotary0_up_key && pdata->rotary0_down_key) {
 149                 set_bit(pdata->rotary0_up_key, input_dev->keybit);
 150                 set_bit(pdata->rotary0_down_key, input_dev->keybit);
 151         } else
 152                 set_bit(pdata->rotary0_rel_code, input_dev->relbit);
 153
 154         if (pdata->rotary1_up_key && pdata->rotary1_down_key) {
 155                 set_bit(pdata->rotary1_up_key, input_dev->keybit);
 156                 set_bit(pdata->rotary1_down_key, input_dev->keybit);
 157         } else
 158                 set_bit(pdata->rotary1_rel_code, input_dev->relbit);
 159 }
 160
 161 static inline unsigned int lookup_matrix_keycode(
 162                 struct pxa27x_keypad *keypad, int row, int col)
 163 {
 164         return keypad->matrix_keycodes[(row << 3) + col];
 165 }
 166
 167 static void pxa27x_keypad_scan_matrix(struct pxa27x_keypad *keypad)
 168 {
 169         struct pxa27x_keypad_platform_data *pdata = keypad->pdata;
 170         int row, col, num_keys_pressed = 0;
 171         uint32_t new_state[MAX_MATRIX_KEY_COLS];
 172         uint32_t kpas = keypad_readl(KPAS);
 173
 174         num_keys_pressed = KPAS_MUKP(kpas);
 175
 176         memset(new_state, 0, sizeof(new_state));
 177
 178         if (num_keys_pressed == 0)
 179                 goto scan;
 180
 181         if (num_keys_pressed == 1) {
 182                 col = KPAS_CP(kpas);
 183                 row = KPAS_RP(kpas);
 184
 185                 /* if invalid row/col, treat as no key pressed */
 186                 if (col >= pdata->matrix_key_cols ||
 187                     row >= pdata->matrix_key_rows)
 188                         goto scan;
 189
 190                 new_state[col] = (1 << row);
 191                 goto scan;
 192         }
 193
 194         if (num_keys_pressed > 1) {
 195                 uint32_t kpasmkp0 = keypad_readl(KPASMKP0);
 196                 uint32_t kpasmkp1 = keypad_readl(KPASMKP1);
 197                 uint32_t kpasmkp2 = keypad_readl(KPASMKP2);
 198                 uint32_t kpasmkp3 = keypad_readl(KPASMKP3);
 199
 200                 new_state[0] = kpasmkp0 & KPASMKP_MKC_MASK;
 201                 new_state[1] = (kpasmkp0 >> 16) & KPASMKP_MKC_MASK;
 202                 new_state[2] = kpasmkp1 & KPASMKP_MKC_MASK;
 203                 new_state[3] = (kpasmkp1 >> 16) & KPASMKP_MKC_MASK;
 204                 new_state[4] = kpasmkp2 & KPASMKP_MKC_MASK;
 205                 new_state[5] = (kpasmkp2 >> 16) & KPASMKP_MKC_MASK;
 206                 new_state[6] = kpasmkp3 & KPASMKP_MKC_MASK;
 207                 new_state[7] = (kpasmkp3 >> 16) & KPASMKP_MKC_MASK;
 208         }
 209 scan:
 210         for (col = 0; col < pdata->matrix_key_cols; col++) {
 211                 uint32_t bits_changed;
 212
 213                 bits_changed = keypad->matrix_key_state[col] ^ new_state[col];
 214                 if (bits_changed == 0)
 215                         continue;
 216
 217                 for (row = 0; row < pdata->matrix_key_rows; row++) {
 218                         if ((bits_changed & (1 << row)) == 0)
 219                                 continue;
 220
 221                         input_report_key(keypad->input_dev,
 222                                 lookup_matrix_keycode(keypad, row, col),
 223                                 new_state[col] & (1 << row));
 224                 }
 225         }
 226         input_sync(keypad->input_dev);
 227         memcpy(keypad->matrix_key_state, new_state, sizeof(new_state));
 228 }
 229
 230 #define DEFAULT_KPREC   (0x007f007f)
 231
 232 static inline int rotary_delta(uint32_t kprec)
 233 {
 234         if (kprec & KPREC_OF0)
 235                 return (kprec & 0xff) + 0x7f;
 236         else if (kprec & KPREC_UF0)
 237                 return (kprec & 0xff) - 0x7f - 0xff;
 238         else
 239                 return (kprec & 0xff) - 0x7f;
 240 }
 241
 242 static void report_rotary_event(struct pxa27x_keypad *keypad, int r, int delta)
 243 {
 244         struct input_dev *dev = keypad->input_dev;
 245
 246         if (delta == 0)
 247                 return;
 248
 249         if (keypad->rotary_up_key[r] && keypad->rotary_down_key[r]) {
 250                 int keycode = (delta > 0) ? keypad->rotary_up_key[r] :
 251                                             keypad->rotary_down_key[r];
 252
 253                 /* simulate a press-n-release */
 254                 input_report_key(dev, keycode, 1);
 255                 input_sync(dev);
 256                 input_report_key(dev, keycode, 0);
 257                 input_sync(dev);
 258         } else {
 259                 input_report_rel(dev, keypad->rotary_rel_code[r], delta);
 260                 input_sync(dev);
 261         }
 262 }
 263
 264 static void pxa27x_keypad_scan_rotary(struct pxa27x_keypad *keypad)
 265 {
 266         struct pxa27x_keypad_platform_data *pdata = keypad->pdata;
 267         uint32_t kprec;
 268
 269         /* read and reset to default count value */
 270         kprec = keypad_readl(KPREC);
 271         keypad_writel(KPREC, DEFAULT_KPREC);
 272
 273         if (pdata->enable_rotary0)
 274                 report_rotary_event(keypad, 0, rotary_delta(kprec));
 275
 276         if (pdata->enable_rotary1)
 277                 report_rotary_event(keypad, 1, rotary_delta(kprec >> 16));
 278 }
 279
 280 static void pxa27x_keypad_scan_direct(struct pxa27x_keypad *keypad)
 281 {
 282         struct pxa27x_keypad_platform_data *pdata = keypad->pdata;
 283         unsigned int new_state;
 284         uint32_t kpdk, bits_changed;
 285         int i;
 286
 287         kpdk = keypad_readl(KPDK);
 288
 289         if (pdata->enable_rotary0 || pdata->enable_rotary1)
 290                 pxa27x_keypad_scan_rotary(keypad);
 291
 292         if (pdata->direct_key_map == NULL)
 293                 return;
 294
 295         new_state = KPDK_DK(kpdk) & keypad->direct_key_mask;
 296         bits_changed = keypad->direct_key_state ^ new_state;
 297
 298         if (bits_changed == 0)
 299                 return;
 300
 301         for (i = 0; i < pdata->direct_key_num; i++) {
 302                 if (bits_changed & (1 << i))
 303                         input_report_key(keypad->input_dev,
 304                                         pdata->direct_key_map[i],
 305                                         (new_state & (1 << i)));
 306         }
 307         input_sync(keypad->input_dev);
 308         keypad->direct_key_state = new_state;
 309 }
 310
 311 static irqreturn_t pxa27x_keypad_irq_handler(int irq, void *dev_id)
 312 {
 313         struct pxa27x_keypad *keypad = dev_id;
 314         unsigned long kpc = keypad_readl(KPC);
 315
 316         if (kpc & KPC_DI)
 317                 pxa27x_keypad_scan_direct(keypad);
 318
 319         if (kpc & KPC_MI)
 320                 pxa27x_keypad_scan_matrix(keypad);
 321
 322         return IRQ_HANDLED;
 323 }
 324
 325 static void pxa27x_keypad_config(struct pxa27x_keypad *keypad)
 326 {
 327         struct pxa27x_keypad_platform_data *pdata = keypad->pdata;
 328         unsigned int mask = 0, direct_key_num = 0;
 329         unsigned long kpc = 0;
 330
 331         /* enable matrix keys with automatic scan */
 332         if (pdata->matrix_key_rows && pdata->matrix_key_cols) {
 333                 kpc |= KPC_ASACT | KPC_MIE | KPC_ME | KPC_MS_ALL;
 334                 kpc |= KPC_MKRN(pdata->matrix_key_rows) |
 335                        KPC_MKCN(pdata->matrix_key_cols);
 336         }
 337
 338         /* enable rotary key, debounce interval same as direct keys */
 339         if (pdata->enable_rotary0) {
 340                 mask |= 0x03;
 341                 direct_key_num = 2;
 342                 kpc |= KPC_REE0;
 343         }
 344
 345         if (pdata->enable_rotary1) {
 346                 mask |= 0x0c;
 347                 direct_key_num = 4;
 348                 kpc |= KPC_REE1;
 349         }
 350
 351         if (pdata->direct_key_num > direct_key_num)
 352                 direct_key_num = pdata->direct_key_num;
 353
 354         keypad->direct_key_mask = ((2 << direct_key_num) - 1) & ~mask;
 355
 356         /* enable direct key */
 357         if (direct_key_num)
 358                 kpc |= KPC_DE | KPC_DIE | KPC_DKN(direct_key_num);
 359
 360         keypad_writel(KPC, kpc | KPC_RE_ZERO_DEB);
 361         keypad_writel(KPREC, DEFAULT_KPREC);
 362         keypad_writel(KPKDI, pdata->debounce_interval);
 363 }
 364
 365 static int pxa27x_keypad_open(struct input_dev *dev)
 366 {
 367         struct pxa27x_keypad *keypad = input_get_drvdata(dev);
 368
 369         /* Enable unit clock */
 370         clk_enable(keypad->clk);
 371         pxa27x_keypad_config(keypad);
 372
 373         return 0;
 374 }
 375
 376 static void pxa27x_keypad_close(struct input_dev *dev)
 377 {
 378         struct pxa27x_keypad *keypad = input_get_drvdata(dev);
 379
 380         /* Disable clock unit */
 381         clk_disable(keypad->clk);
 382 }
 383
 384 #ifdef CONFIG_PM
 385 static int pxa27x_keypad_suspend(struct platform_device *pdev, pm_message_t state)
 386 {
 387         struct pxa27x_keypad *keypad = platform_get_drvdata(pdev);
 388
 389         clk_disable(keypad->clk);
 390
 391         if (device_may_wakeup(&pdev->dev))
 392                 enable_irq_wake(keypad->irq);
 393
 394         return 0;
 395 }
 396
 397 static int pxa27x_keypad_resume(struct platform_device *pdev)
 398 {
 399         struct pxa27x_keypad *keypad = platform_get_drvdata(pdev);
 400         struct input_dev *input_dev = keypad->input_dev;
 401
 402         if (device_may_wakeup(&pdev->dev))
 403                 disable_irq_wake(keypad->irq);
 404
 405         mutex_lock(&input_dev->mutex);
 406
 407         if (input_dev->users) {
 408                 /* Enable unit clock */
 409                 clk_enable(keypad->clk);
 410                 pxa27x_keypad_config(keypad);
 411         }
 412
 413         mutex_unlock(&input_dev->mutex);
 414
 415         return 0;
 416 }
 417 #else
 418 #define pxa27x_keypad_suspend   NULL
 419 #define pxa27x_keypad_resume    NULL
 420 #endif
 421
 422 #define res_size(res)   ((res)->end - (res)->start + 1)
 423
 424 static int __devinit pxa27x_keypad_probe(struct platform_device *pdev)
 425 {
 426         struct pxa27x_keypad *keypad;
 427         struct input_dev *input_dev;
 428         struct resource *res;
 429         int irq, error;
 430
 431         keypad = kzalloc(sizeof(struct pxa27x_keypad), GFP_KERNEL);
 432         if (keypad == NULL) {
 433                 dev_err(&pdev->dev, "failed to allocate driver data\n");
 434                 return -ENOMEM;
 435         }
 436
 437         keypad->pdata = pdev->dev.platform_data;
 438         if (keypad->pdata == NULL) {
 439                 dev_err(&pdev->dev, "no platform data defined\n");
 440                 error = -EINVAL;
 441                 goto failed_free;
 442         }
 443
 444         irq = platform_get_irq(pdev, 0);
 445         if (irq < 0) {
 446                 dev_err(&pdev->dev, "failed to get keypad irq\n");
 447                 error = -ENXIO;
 448                 goto failed_free;
 449         }
 450
 451         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 452         if (res == NULL) {
 453                 dev_err(&pdev->dev, "failed to get I/O memory\n");
 454                 error = -ENXIO;
 455                 goto failed_free;
 456         }
 457
 458         res = request_mem_region(res->start, res_size(res), pdev->name);
 459         if (res == NULL) {
 460                 dev_err(&pdev->dev, "failed to request I/O memory\n");
 461                 error = -EBUSY;
 462                 goto failed_free;
 463         }
 464
 465         keypad->mmio_base = ioremap(res->start, res_size(res));
 466         if (keypad->mmio_base == NULL) {
 467                 dev_err(&pdev->dev, "failed to remap I/O memory\n");
 468                 error = -ENXIO;
 469                 goto failed_free_mem;
 470         }
 471
 472         keypad->clk = clk_get(&pdev->dev, "KBDCLK");
 473         if (IS_ERR(keypad->clk)) {
 474                 dev_err(&pdev->dev, "failed to get keypad clock\n");
 475                 error = PTR_ERR(keypad->clk);
 476                 goto failed_free_io;
 477         }
 478
 479         /* Create and register the input driver. */
 480         input_dev = input_allocate_device();
 481         if (!input_dev) {
 482                 dev_err(&pdev->dev, "failed to allocate input device\n");
 483                 error = -ENOMEM;
 484                 goto failed_put_clk;
 485         }
 486
 487         input_dev->name = pdev->name;
 488         input_dev->id.bustype = BUS_HOST;
 489         input_dev->open = pxa27x_keypad_open;
 490         input_dev->close = pxa27x_keypad_close;
 491         input_dev->dev.parent = &pdev->dev;
 492
 493         keypad->input_dev = input_dev;
 494         input_set_drvdata(input_dev, keypad);
 495
 496         input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP) |
 497                 BIT_MASK(EV_REL);
 498
 499         pxa27x_keypad_build_keycode(keypad);
 500         platform_set_drvdata(pdev, keypad);
 501
 502         error = request_irq(irq, pxa27x_keypad_irq_handler, IRQF_DISABLED,
 503                             pdev->name, keypad);
 504         if (error) {
 505                 dev_err(&pdev->dev, "failed to request IRQ\n");
 506                 goto failed_free_dev;
 507         }
 508
 509         keypad->irq = irq;
 510
 511         /* Register the input device */
 512         error = input_register_device(input_dev);
 513         if (error) {
 514                 dev_err(&pdev->dev, "failed to register input device\n");
 515                 goto failed_free_irq;
 516         }
 517
 518         device_init_wakeup(&pdev->dev, 1);
 519
 520         return 0;
 521
 522 failed_free_irq:
 523         free_irq(irq, pdev);
 524         platform_set_drvdata(pdev, NULL);
 525 failed_free_dev:
 526         input_free_device(input_dev);
 527 failed_put_clk:
 528         clk_put(keypad->clk);
 529 failed_free_io:
 530         iounmap(keypad->mmio_base);
 531 failed_free_mem:
 532         release_mem_region(res->start, res_size(res));
 533 failed_free:
 534         kfree(keypad);
 535         return error;
 536 }
 537
 538 static int __devexit pxa27x_keypad_remove(struct platform_device *pdev)
 539 {
 540         struct pxa27x_keypad *keypad = platform_get_drvdata(pdev);
 541         struct resource *res;
 542
 543         free_irq(keypad->irq, pdev);
 544
 545         clk_disable(keypad->clk);
 546         clk_put(keypad->clk);
 547
 548         input_unregister_device(keypad->input_dev);
 549         input_free_device(keypad->input_dev);
 550
 551         iounmap(keypad->mmio_base);
 552
 553         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 554         release_mem_region(res->start, res_size(res));
 555
 556         platform_set_drvdata(pdev, NULL);
 557         kfree(keypad);
 558         return 0;
 559 }
 560
 561 /* work with hotplug and coldplug */
 562 MODULE_ALIAS("platform:pxa27x-keypad");
 563
 564 static struct platform_driver pxa27x_keypad_driver = {
 565         .probe          = pxa27x_keypad_probe,
 566         .remove         = __devexit_p(pxa27x_keypad_remove),
 567         .suspend        = pxa27x_keypad_suspend,
 568         .resume         = pxa27x_keypad_resume,
 569         .driver         = {
 570                 .name   = "pxa27x-keypad",
 571                 .owner  = THIS_MODULE,
 572         },
 573 };
 574
 575 static int __init pxa27x_keypad_init(void)
 576 {
 577         return platform_driver_register(&pxa27x_keypad_driver);
 578 }
 579
 580 static void __exit pxa27x_keypad_exit(void)
 581 {
 582         platform_driver_unregister(&pxa27x_keypad_driver);
 583 }
 584
 585 module_init(pxa27x_keypad_init);
 586 module_exit(pxa27x_keypad_exit);
 587
 588 MODULE_DESCRIPTION("PXA27x Keypad Controller Driver");
 589 MODULE_LICENSE("GPL");