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@fluxnic.net>. 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 #include <linux/input/matrix_keypad.h> 29 #include <linux/slab.h> 30 31 #include <asm/mach/arch.h> 32 #include <asm/mach/map.h> 33 34 #include <mach/hardware.h> 35 #include <plat/pxa27x_keypad.h> 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 (MAX_MATRIX_KEY_ROWS * MAX_MATRIX_KEY_COLS) 100 #define MAX_KEYPAD_KEYS (MAX_MATRIX_KEY_NUM + MAX_DIRECT_KEY_NUM) 101 102 struct pxa27x_keypad { 103 struct pxa27x_keypad_platform_data *pdata; 104 105 struct clk *clk; 106 struct input_dev *input_dev; 107 void __iomem *mmio_base; 108 109 int irq; 110 111 unsigned short keycodes[MAX_KEYPAD_KEYS]; 112 int rotary_rel_code[2]; 113 114 /* state row bits of each column scan */ 115 uint32_t matrix_key_state[MAX_MATRIX_KEY_COLS]; 116 uint32_t direct_key_state; 117 118 unsigned int direct_key_mask; 119 }; 120 121 static void pxa27x_keypad_build_keycode(struct pxa27x_keypad *keypad) 122 { 123 struct pxa27x_keypad_platform_data *pdata = keypad->pdata; 124 struct input_dev *input_dev = keypad->input_dev; 125 unsigned short keycode; 126 int i; 127 128 for (i = 0; i < pdata->matrix_key_map_size; i++) { 129 unsigned int key = pdata->matrix_key_map[i]; 130 unsigned int row = KEY_ROW(key); 131 unsigned int col = KEY_COL(key); 132 unsigned int scancode = MATRIX_SCAN_CODE(row, col, 133 MATRIX_ROW_SHIFT); 134 135 keycode = KEY_VAL(key); 136 keypad->keycodes[scancode] = keycode; 137 __set_bit(keycode, input_dev->keybit); 138 } 139 140 for (i = 0; i < pdata->direct_key_num; i++) { 141 keycode = pdata->direct_key_map[i]; 142 keypad->keycodes[MAX_MATRIX_KEY_NUM + i] = keycode; 143 __set_bit(keycode, input_dev->keybit); 144 } 145 146 if (pdata->enable_rotary0) { 147 if (pdata->rotary0_up_key && pdata->rotary0_down_key) { 148 keycode = pdata->rotary0_up_key; 149 keypad->keycodes[MAX_MATRIX_KEY_NUM + 0] = keycode; 150 __set_bit(keycode, input_dev->keybit); 151 152 keycode = pdata->rotary0_down_key; 153 keypad->keycodes[MAX_MATRIX_KEY_NUM + 1] = keycode; 154 __set_bit(keycode, input_dev->keybit); 155 156 keypad->rotary_rel_code[0] = -1; 157 } else { 158 keypad->rotary_rel_code[0] = pdata->rotary0_rel_code; 159 __set_bit(pdata->rotary0_rel_code, input_dev->relbit); 160 } 161 } 162 163 if (pdata->enable_rotary1) { 164 if (pdata->rotary1_up_key && pdata->rotary1_down_key) { 165 keycode = pdata->rotary1_up_key; 166 keypad->keycodes[MAX_MATRIX_KEY_NUM + 2] = keycode; 167 __set_bit(keycode, input_dev->keybit); 168 169 keycode = pdata->rotary1_down_key; 170 keypad->keycodes[MAX_MATRIX_KEY_NUM + 3] = keycode; 171 __set_bit(keycode, input_dev->keybit); 172 173 keypad->rotary_rel_code[1] = -1; 174 } else { 175 keypad->rotary_rel_code[1] = pdata->rotary1_rel_code; 176 __set_bit(pdata->rotary1_rel_code, input_dev->relbit); 177 } 178 } 179 180 __clear_bit(KEY_RESERVED, input_dev->keybit); 181 } 182 183 static void pxa27x_keypad_scan_matrix(struct pxa27x_keypad *keypad) 184 { 185 struct pxa27x_keypad_platform_data *pdata = keypad->pdata; 186 struct input_dev *input_dev = keypad->input_dev; 187 int row, col, num_keys_pressed = 0; 188 uint32_t new_state[MAX_MATRIX_KEY_COLS]; 189 uint32_t kpas = keypad_readl(KPAS); 190 191 num_keys_pressed = KPAS_MUKP(kpas); 192 193 memset(new_state, 0, sizeof(new_state)); 194 195 if (num_keys_pressed == 0) 196 goto scan; 197 198 if (num_keys_pressed == 1) { 199 col = KPAS_CP(kpas); 200 row = KPAS_RP(kpas); 201 202 /* if invalid row/col, treat as no key pressed */ 203 if (col >= pdata->matrix_key_cols || 204 row >= pdata->matrix_key_rows) 205 goto scan; 206 207 new_state[col] = (1 << row); 208 goto scan; 209 } 210 211 if (num_keys_pressed > 1) { 212 uint32_t kpasmkp0 = keypad_readl(KPASMKP0); 213 uint32_t kpasmkp1 = keypad_readl(KPASMKP1); 214 uint32_t kpasmkp2 = keypad_readl(KPASMKP2); 215 uint32_t kpasmkp3 = keypad_readl(KPASMKP3); 216 217 new_state[0] = kpasmkp0 & KPASMKP_MKC_MASK; 218 new_state[1] = (kpasmkp0 >> 16) & KPASMKP_MKC_MASK; 219 new_state[2] = kpasmkp1 & KPASMKP_MKC_MASK; 220 new_state[3] = (kpasmkp1 >> 16) & KPASMKP_MKC_MASK; 221 new_state[4] = kpasmkp2 & KPASMKP_MKC_MASK; 222 new_state[5] = (kpasmkp2 >> 16) & KPASMKP_MKC_MASK; 223 new_state[6] = kpasmkp3 & KPASMKP_MKC_MASK; 224 new_state[7] = (kpasmkp3 >> 16) & KPASMKP_MKC_MASK; 225 } 226 scan: 227 for (col = 0; col < pdata->matrix_key_cols; col++) { 228 uint32_t bits_changed; 229 int code; 230 231 bits_changed = keypad->matrix_key_state[col] ^ new_state[col]; 232 if (bits_changed == 0) 233 continue; 234 235 for (row = 0; row < pdata->matrix_key_rows; row++) { 236 if ((bits_changed & (1 << row)) == 0) 237 continue; 238 239 code = MATRIX_SCAN_CODE(row, col, MATRIX_ROW_SHIFT); 240 input_event(input_dev, EV_MSC, MSC_SCAN, code); 241 input_report_key(input_dev, keypad->keycodes[code], 242 new_state[col] & (1 << row)); 243 } 244 } 245 input_sync(input_dev); 246 memcpy(keypad->matrix_key_state, new_state, sizeof(new_state)); 247 } 248 249 #define DEFAULT_KPREC (0x007f007f) 250 251 static inline int rotary_delta(uint32_t kprec) 252 { 253 if (kprec & KPREC_OF0) 254 return (kprec & 0xff) + 0x7f; 255 else if (kprec & KPREC_UF0) 256 return (kprec & 0xff) - 0x7f - 0xff; 257 else 258 return (kprec & 0xff) - 0x7f; 259 } 260 261 static void report_rotary_event(struct pxa27x_keypad *keypad, int r, int delta) 262 { 263 struct input_dev *dev = keypad->input_dev; 264 265 if (delta == 0) 266 return; 267 268 if (keypad->rotary_rel_code[r] == -1) { 269 int code = MAX_MATRIX_KEY_NUM + 2 * r + (delta > 0 ? 0 : 1); 270 unsigned char keycode = keypad->keycodes[code]; 271 272 /* simulate a press-n-release */ 273 input_event(dev, EV_MSC, MSC_SCAN, code); 274 input_report_key(dev, keycode, 1); 275 input_sync(dev); 276 input_event(dev, EV_MSC, MSC_SCAN, code); 277 input_report_key(dev, keycode, 0); 278 input_sync(dev); 279 } else { 280 input_report_rel(dev, keypad->rotary_rel_code[r], delta); 281 input_sync(dev); 282 } 283 } 284 285 static void pxa27x_keypad_scan_rotary(struct pxa27x_keypad *keypad) 286 { 287 struct pxa27x_keypad_platform_data *pdata = keypad->pdata; 288 uint32_t kprec; 289 290 /* read and reset to default count value */ 291 kprec = keypad_readl(KPREC); 292 keypad_writel(KPREC, DEFAULT_KPREC); 293 294 if (pdata->enable_rotary0) 295 report_rotary_event(keypad, 0, rotary_delta(kprec)); 296 297 if (pdata->enable_rotary1) 298 report_rotary_event(keypad, 1, rotary_delta(kprec >> 16)); 299 } 300 301 static void pxa27x_keypad_scan_direct(struct pxa27x_keypad *keypad) 302 { 303 struct pxa27x_keypad_platform_data *pdata = keypad->pdata; 304 struct input_dev *input_dev = keypad->input_dev; 305 unsigned int new_state; 306 uint32_t kpdk, bits_changed; 307 int i; 308 309 kpdk = keypad_readl(KPDK); 310 311 if (pdata->enable_rotary0 || pdata->enable_rotary1) 312 pxa27x_keypad_scan_rotary(keypad); 313 314 new_state = KPDK_DK(kpdk) & keypad->direct_key_mask; 315 bits_changed = keypad->direct_key_state ^ new_state; 316 317 if (bits_changed == 0) 318 return; 319 320 for (i = 0; i < pdata->direct_key_num; i++) { 321 if (bits_changed & (1 << i)) { 322 int code = MAX_MATRIX_KEY_NUM + i; 323 324 input_event(input_dev, EV_MSC, MSC_SCAN, code); 325 input_report_key(input_dev, keypad->keycodes[code], 326 new_state & (1 << i)); 327 } 328 } 329 input_sync(input_dev); 330 keypad->direct_key_state = new_state; 331 } 332 333 static void clear_wakeup_event(struct pxa27x_keypad *keypad) 334 { 335 struct pxa27x_keypad_platform_data *pdata = keypad->pdata; 336 337 if (pdata->clear_wakeup_event) 338 (pdata->clear_wakeup_event)(); 339 } 340 341 static irqreturn_t pxa27x_keypad_irq_handler(int irq, void *dev_id) 342 { 343 struct pxa27x_keypad *keypad = dev_id; 344 unsigned long kpc = keypad_readl(KPC); 345 346 clear_wakeup_event(keypad); 347 348 if (kpc & KPC_DI) 349 pxa27x_keypad_scan_direct(keypad); 350 351 if (kpc & KPC_MI) 352 pxa27x_keypad_scan_matrix(keypad); 353 354 return IRQ_HANDLED; 355 } 356 357 static void pxa27x_keypad_config(struct pxa27x_keypad *keypad) 358 { 359 struct pxa27x_keypad_platform_data *pdata = keypad->pdata; 360 unsigned int mask = 0, direct_key_num = 0; 361 unsigned long kpc = 0; 362 363 /* enable matrix keys with automatic scan */ 364 if (pdata->matrix_key_rows && pdata->matrix_key_cols) { 365 kpc |= KPC_ASACT | KPC_MIE | KPC_ME | KPC_MS_ALL; 366 kpc |= KPC_MKRN(pdata->matrix_key_rows) | 367 KPC_MKCN(pdata->matrix_key_cols); 368 } 369 370 /* enable rotary key, debounce interval same as direct keys */ 371 if (pdata->enable_rotary0) { 372 mask |= 0x03; 373 direct_key_num = 2; 374 kpc |= KPC_REE0; 375 } 376 377 if (pdata->enable_rotary1) { 378 mask |= 0x0c; 379 direct_key_num = 4; 380 kpc |= KPC_REE1; 381 } 382 383 if (pdata->direct_key_num > direct_key_num) 384 direct_key_num = pdata->direct_key_num; 385 386 keypad->direct_key_mask = ((2 << direct_key_num) - 1) & ~mask; 387 388 /* enable direct key */ 389 if (direct_key_num) 390 kpc |= KPC_DE | KPC_DIE | KPC_DKN(direct_key_num); 391 392 keypad_writel(KPC, kpc | KPC_RE_ZERO_DEB); 393 keypad_writel(KPREC, DEFAULT_KPREC); 394 keypad_writel(KPKDI, pdata->debounce_interval); 395 } 396 397 static int pxa27x_keypad_open(struct input_dev *dev) 398 { 399 struct pxa27x_keypad *keypad = input_get_drvdata(dev); 400 401 /* Enable unit clock */ 402 clk_enable(keypad->clk); 403 pxa27x_keypad_config(keypad); 404 405 return 0; 406 } 407 408 static void pxa27x_keypad_close(struct input_dev *dev) 409 { 410 struct pxa27x_keypad *keypad = input_get_drvdata(dev); 411 412 /* Disable clock unit */ 413 clk_disable(keypad->clk); 414 } 415 416 #ifdef CONFIG_PM 417 static int pxa27x_keypad_suspend(struct device *dev) 418 { 419 struct platform_device *pdev = to_platform_device(dev); 420 struct pxa27x_keypad *keypad = platform_get_drvdata(pdev); 421 422 clk_disable(keypad->clk); 423 424 if (device_may_wakeup(&pdev->dev)) 425 enable_irq_wake(keypad->irq); 426 427 return 0; 428 } 429 430 static int pxa27x_keypad_resume(struct device *dev) 431 { 432 struct platform_device *pdev = to_platform_device(dev); 433 struct pxa27x_keypad *keypad = platform_get_drvdata(pdev); 434 struct input_dev *input_dev = keypad->input_dev; 435 436 if (device_may_wakeup(&pdev->dev)) 437 disable_irq_wake(keypad->irq); 438 439 mutex_lock(&input_dev->mutex); 440 441 if (input_dev->users) { 442 /* Enable unit clock */ 443 clk_enable(keypad->clk); 444 pxa27x_keypad_config(keypad); 445 } 446 447 mutex_unlock(&input_dev->mutex); 448 449 return 0; 450 } 451 452 static const struct dev_pm_ops pxa27x_keypad_pm_ops = { 453 .suspend = pxa27x_keypad_suspend, 454 .resume = pxa27x_keypad_resume, 455 }; 456 #endif 457 458 static int __devinit pxa27x_keypad_probe(struct platform_device *pdev) 459 { 460 struct pxa27x_keypad_platform_data *pdata = pdev->dev.platform_data; 461 struct pxa27x_keypad *keypad; 462 struct input_dev *input_dev; 463 struct resource *res; 464 int irq, error; 465 466 if (pdata == NULL) { 467 dev_err(&pdev->dev, "no platform data defined\n"); 468 return -EINVAL; 469 } 470 471 irq = platform_get_irq(pdev, 0); 472 if (irq < 0) { 473 dev_err(&pdev->dev, "failed to get keypad irq\n"); 474 return -ENXIO; 475 } 476 477 res = platform_get_resource(pdev, IORESOURCE_MEM, 0); 478 if (res == NULL) { 479 dev_err(&pdev->dev, "failed to get I/O memory\n"); 480 return -ENXIO; 481 } 482 483 keypad = kzalloc(sizeof(struct pxa27x_keypad), GFP_KERNEL); 484 input_dev = input_allocate_device(); 485 if (!keypad || !input_dev) { 486 dev_err(&pdev->dev, "failed to allocate memory\n"); 487 error = -ENOMEM; 488 goto failed_free; 489 } 490 491 keypad->pdata = pdata; 492 keypad->input_dev = input_dev; 493 keypad->irq = irq; 494 495 res = request_mem_region(res->start, resource_size(res), pdev->name); 496 if (res == NULL) { 497 dev_err(&pdev->dev, "failed to request I/O memory\n"); 498 error = -EBUSY; 499 goto failed_free; 500 } 501 502 keypad->mmio_base = ioremap(res->start, resource_size(res)); 503 if (keypad->mmio_base == NULL) { 504 dev_err(&pdev->dev, "failed to remap I/O memory\n"); 505 error = -ENXIO; 506 goto failed_free_mem; 507 } 508 509 keypad->clk = clk_get(&pdev->dev, NULL); 510 if (IS_ERR(keypad->clk)) { 511 dev_err(&pdev->dev, "failed to get keypad clock\n"); 512 error = PTR_ERR(keypad->clk); 513 goto failed_free_io; 514 } 515 516 input_dev->name = pdev->name; 517 input_dev->id.bustype = BUS_HOST; 518 input_dev->open = pxa27x_keypad_open; 519 input_dev->close = pxa27x_keypad_close; 520 input_dev->dev.parent = &pdev->dev; 521 522 input_dev->keycode = keypad->keycodes; 523 input_dev->keycodesize = sizeof(keypad->keycodes[0]); 524 input_dev->keycodemax = ARRAY_SIZE(keypad->keycodes); 525 526 input_set_drvdata(input_dev, keypad); 527 528 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP); 529 input_set_capability(input_dev, EV_MSC, MSC_SCAN); 530 531 pxa27x_keypad_build_keycode(keypad); 532 533 if ((pdata->enable_rotary0 && keypad->rotary_rel_code[0] != -1) || 534 (pdata->enable_rotary1 && keypad->rotary_rel_code[1] != -1)) { 535 input_dev->evbit[0] |= BIT_MASK(EV_REL); 536 } 537 538 error = request_irq(irq, pxa27x_keypad_irq_handler, 0, 539 pdev->name, keypad); 540 if (error) { 541 dev_err(&pdev->dev, "failed to request IRQ\n"); 542 goto failed_put_clk; 543 } 544 545 /* Register the input device */ 546 error = input_register_device(input_dev); 547 if (error) { 548 dev_err(&pdev->dev, "failed to register input device\n"); 549 goto failed_free_irq; 550 } 551 552 platform_set_drvdata(pdev, keypad); 553 device_init_wakeup(&pdev->dev, 1); 554 555 return 0; 556 557 failed_free_irq: 558 free_irq(irq, pdev); 559 failed_put_clk: 560 clk_put(keypad->clk); 561 failed_free_io: 562 iounmap(keypad->mmio_base); 563 failed_free_mem: 564 release_mem_region(res->start, resource_size(res)); 565 failed_free: 566 input_free_device(input_dev); 567 kfree(keypad); 568 return error; 569 } 570 571 static int __devexit pxa27x_keypad_remove(struct platform_device *pdev) 572 { 573 struct pxa27x_keypad *keypad = platform_get_drvdata(pdev); 574 struct resource *res; 575 576 free_irq(keypad->irq, pdev); 577 clk_put(keypad->clk); 578 579 input_unregister_device(keypad->input_dev); 580 iounmap(keypad->mmio_base); 581 582 res = platform_get_resource(pdev, IORESOURCE_MEM, 0); 583 release_mem_region(res->start, resource_size(res)); 584 585 platform_set_drvdata(pdev, NULL); 586 kfree(keypad); 587 588 return 0; 589 } 590 591 /* work with hotplug and coldplug */ 592 MODULE_ALIAS("platform:pxa27x-keypad"); 593 594 static struct platform_driver pxa27x_keypad_driver = { 595 .probe = pxa27x_keypad_probe, 596 .remove = __devexit_p(pxa27x_keypad_remove), 597 .driver = { 598 .name = "pxa27x-keypad", 599 .owner = THIS_MODULE, 600 #ifdef CONFIG_PM 601 .pm = &pxa27x_keypad_pm_ops, 602 #endif 603 }, 604 }; 605 606 static int __init pxa27x_keypad_init(void) 607 { 608 return platform_driver_register(&pxa27x_keypad_driver); 609 } 610 611 static void __exit pxa27x_keypad_exit(void) 612 { 613 platform_driver_unregister(&pxa27x_keypad_driver); 614 } 615 616 module_init(pxa27x_keypad_init); 617 module_exit(pxa27x_keypad_exit); 618 619 MODULE_DESCRIPTION("PXA27x Keypad Controller Driver"); 620 MODULE_LICENSE("GPL"); 621