2 * Keyboard class input driver for the NVIDIA Tegra SoC internal matrix
5 * Copyright (c) 2009-2011, NVIDIA Corporation.
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful, but WITHOUT
13 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 #include <linux/module.h>
23 #include <linux/input.h>
24 #include <linux/platform_device.h>
25 #include <linux/delay.h>
27 #include <linux/interrupt.h>
28 #include <linux/clk.h>
29 #include <linux/slab.h>
33 #define KBC_MAX_DEBOUNCE_CNT 0x3ffu
35 /* KBC row scan time and delay for beginning the row scan. */
36 #define KBC_ROW_SCAN_TIME 16
37 #define KBC_ROW_SCAN_DLY 5
39 /* KBC uses a 32KHz clock so a cycle = 1/32Khz */
40 #define KBC_CYCLE_USEC 32
44 /* KBC Control Register */
45 #define KBC_CONTROL_0 0x0
46 #define KBC_FIFO_TH_CNT_SHIFT(cnt) (cnt << 14)
47 #define KBC_DEBOUNCE_CNT_SHIFT(cnt) (cnt << 4)
48 #define KBC_CONTROL_FIFO_CNT_INT_EN (1 << 3)
49 #define KBC_CONTROL_KBC_EN (1 << 0)
51 /* KBC Interrupt Register */
53 #define KBC_INT_FIFO_CNT_INT_STATUS (1 << 2)
55 #define KBC_ROW_CFG0_0 0x8
56 #define KBC_COL_CFG0_0 0x18
57 #define KBC_INIT_DLY_0 0x28
58 #define KBC_RPT_DLY_0 0x2c
59 #define KBC_KP_ENT0_0 0x30
60 #define KBC_KP_ENT1_0 0x34
61 #define KBC_ROW0_MASK_0 0x38
63 #define KBC_ROW_SHIFT 3
67 struct input_dev *idev;
70 unsigned int repoll_dly;
71 unsigned long cp_dly_jiffies;
73 bool use_ghost_filter;
74 const struct tegra_kbc_platform_data *pdata;
75 unsigned short keycode[KBC_MAX_KEY * 2];
76 unsigned short current_keys[KBC_MAX_KPENT];
77 unsigned int num_pressed_keys;
78 struct timer_list timer;
82 static const u32 tegra_kbc_default_keymap[] = {
89 KEY(1, 7, KEY_LEFTMETA),
91 KEY(2, 6, KEY_RIGHTALT),
92 KEY(2, 7, KEY_LEFTALT),
109 KEY(4, 7, KEY_SPACE),
118 KEY(5, 7, KEY_BACKSLASH),
120 KEY(6, 0, KEY_MINUS),
126 KEY(6, 6, KEY_COMMA),
129 KEY(7, 1, KEY_EQUAL),
130 KEY(7, 2, KEY_RIGHTBRACE),
131 KEY(7, 3, KEY_ENTER),
134 KEY(8, 4, KEY_RIGHTSHIFT),
135 KEY(8, 5, KEY_LEFTSHIFT),
137 KEY(9, 5, KEY_RIGHTCTRL),
138 KEY(9, 7, KEY_LEFTCTRL),
140 KEY(11, 0, KEY_LEFTBRACE),
142 KEY(11, 2, KEY_APOSTROPHE),
143 KEY(11, 3, KEY_SEMICOLON),
144 KEY(11, 4, KEY_SLASH),
149 KEY(12, 2, KEY_BACKSPACE),
153 KEY(12, 6, KEY_PRINT),
154 KEY(12, 7, KEY_PAUSE),
156 KEY(13, 0, KEY_INSERT),
157 KEY(13, 1, KEY_DELETE),
158 KEY(13, 3, KEY_PAGEUP),
159 KEY(13, 4, KEY_PAGEDOWN),
160 KEY(13, 5, KEY_RIGHT),
161 KEY(13, 6, KEY_DOWN),
162 KEY(13, 7, KEY_LEFT),
174 KEY(15, 1, KEY_GRAVE),
179 KEY(15, 6, KEY_CAPSLOCK),
182 /* Software Handled Function Keys */
190 KEY(22, 1, KEY_KPSLASH),
197 KEY(27, 1, KEY_KPASTERISK),
198 KEY(27, 3, KEY_KPMINUS),
199 KEY(27, 4, KEY_KPPLUS),
200 KEY(27, 5, KEY_KPDOT),
202 KEY(28, 5, KEY_VOLUMEUP),
204 KEY(29, 3, KEY_HOME),
206 KEY(29, 5, KEY_BRIGHTNESSDOWN),
207 KEY(29, 6, KEY_VOLUMEDOWN),
208 KEY(29, 7, KEY_BRIGHTNESSUP),
210 KEY(30, 0, KEY_NUMLOCK),
211 KEY(30, 1, KEY_SCROLLLOCK),
212 KEY(30, 2, KEY_MUTE),
214 KEY(31, 4, KEY_HELP),
217 static const struct matrix_keymap_data tegra_kbc_default_keymap_data = {
218 .keymap = tegra_kbc_default_keymap,
219 .keymap_size = ARRAY_SIZE(tegra_kbc_default_keymap),
222 static void tegra_kbc_report_released_keys(struct input_dev *input,
223 unsigned short old_keycodes[],
224 unsigned int old_num_keys,
225 unsigned short new_keycodes[],
226 unsigned int new_num_keys)
230 for (i = 0; i < old_num_keys; i++) {
231 for (j = 0; j < new_num_keys; j++)
232 if (old_keycodes[i] == new_keycodes[j])
235 if (j == new_num_keys)
236 input_report_key(input, old_keycodes[i], 0);
240 static void tegra_kbc_report_pressed_keys(struct input_dev *input,
241 unsigned char scancodes[],
242 unsigned short keycodes[],
243 unsigned int num_pressed_keys)
247 for (i = 0; i < num_pressed_keys; i++) {
248 input_event(input, EV_MSC, MSC_SCAN, scancodes[i]);
249 input_report_key(input, keycodes[i], 1);
253 static void tegra_kbc_report_keys(struct tegra_kbc *kbc)
255 unsigned char scancodes[KBC_MAX_KPENT];
256 unsigned short keycodes[KBC_MAX_KPENT];
259 unsigned int num_down = 0;
261 bool fn_keypress = false;
262 bool key_in_same_row = false;
263 bool key_in_same_col = false;
265 spin_lock_irqsave(&kbc->lock, flags);
266 for (i = 0; i < KBC_MAX_KPENT; i++) {
268 val = readl(kbc->mmio + KBC_KP_ENT0_0 + i);
271 unsigned int col = val & 0x07;
272 unsigned int row = (val >> 3) & 0x0f;
273 unsigned char scancode =
274 MATRIX_SCAN_CODE(row, col, KBC_ROW_SHIFT);
276 scancodes[num_down] = scancode;
277 keycodes[num_down] = kbc->keycode[scancode];
278 /* If driver uses Fn map, do not report the Fn key. */
279 if ((keycodes[num_down] == KEY_FN) && kbc->use_fn_map)
289 * Matrix keyboard designs are prone to keyboard ghosting.
290 * Ghosting occurs if there are 3 keys such that -
291 * any 2 of the 3 keys share a row, and any 2 of them share a column.
292 * If so ignore the key presses for this iteration.
294 if ((kbc->use_ghost_filter) && (num_down >= 3)) {
295 for (i = 0; i < num_down; i++) {
297 u8 curr_col = scancodes[i] & 0x07;
298 u8 curr_row = scancodes[i] >> KBC_ROW_SHIFT;
301 * Find 2 keys such that one key is in the same row
302 * and the other is in the same column as the i-th key.
304 for (j = i + 1; j < num_down; j++) {
305 u8 col = scancodes[j] & 0x07;
306 u8 row = scancodes[j] >> KBC_ROW_SHIFT;
309 key_in_same_col = true;
311 key_in_same_row = true;
317 * If the platform uses Fn keymaps, translate keys on a Fn keypress.
318 * Function keycodes are KBC_MAX_KEY apart from the plain keycodes.
321 for (i = 0; i < num_down; i++) {
322 scancodes[i] += KBC_MAX_KEY;
323 keycodes[i] = kbc->keycode[scancodes[i]];
327 spin_unlock_irqrestore(&kbc->lock, flags);
329 /* Ignore the key presses for this iteration? */
330 if (key_in_same_col && key_in_same_row)
333 tegra_kbc_report_released_keys(kbc->idev,
334 kbc->current_keys, kbc->num_pressed_keys,
336 tegra_kbc_report_pressed_keys(kbc->idev, scancodes, keycodes, num_down);
337 input_sync(kbc->idev);
339 memcpy(kbc->current_keys, keycodes, sizeof(kbc->current_keys));
340 kbc->num_pressed_keys = num_down;
343 static void tegra_kbc_keypress_timer(unsigned long data)
345 struct tegra_kbc *kbc = (struct tegra_kbc *)data;
350 val = (readl(kbc->mmio + KBC_INT_0) >> 4) & 0xf;
354 tegra_kbc_report_keys(kbc);
357 * If more than one keys are pressed we need not wait
358 * for the repoll delay.
360 dly = (val == 1) ? kbc->repoll_dly : 1;
361 mod_timer(&kbc->timer, jiffies + msecs_to_jiffies(dly));
363 /* Release any pressed keys and exit the polling loop */
364 for (i = 0; i < kbc->num_pressed_keys; i++)
365 input_report_key(kbc->idev, kbc->current_keys[i], 0);
366 input_sync(kbc->idev);
368 kbc->num_pressed_keys = 0;
370 /* All keys are released so enable the keypress interrupt */
371 spin_lock_irqsave(&kbc->lock, flags);
372 val = readl(kbc->mmio + KBC_CONTROL_0);
373 val |= KBC_CONTROL_FIFO_CNT_INT_EN;
374 writel(val, kbc->mmio + KBC_CONTROL_0);
375 spin_unlock_irqrestore(&kbc->lock, flags);
379 static irqreturn_t tegra_kbc_isr(int irq, void *args)
381 struct tegra_kbc *kbc = args;
385 * Until all keys are released, defer further processing to
386 * the polling loop in tegra_kbc_keypress_timer
388 ctl = readl(kbc->mmio + KBC_CONTROL_0);
389 ctl &= ~KBC_CONTROL_FIFO_CNT_INT_EN;
390 writel(ctl, kbc->mmio + KBC_CONTROL_0);
393 * Quickly bail out & reenable interrupts if the fifo threshold
394 * count interrupt wasn't the interrupt source
396 val = readl(kbc->mmio + KBC_INT_0);
397 writel(val, kbc->mmio + KBC_INT_0);
399 if (val & KBC_INT_FIFO_CNT_INT_STATUS) {
401 * Schedule timer to run when hardware is in continuous
404 mod_timer(&kbc->timer, jiffies + kbc->cp_dly_jiffies);
406 ctl |= KBC_CONTROL_FIFO_CNT_INT_EN;
407 writel(ctl, kbc->mmio + KBC_CONTROL_0);
413 static void tegra_kbc_setup_wakekeys(struct tegra_kbc *kbc, bool filter)
415 const struct tegra_kbc_platform_data *pdata = kbc->pdata;
417 unsigned int rst_val;
419 /* Either mask all keys or none. */
420 rst_val = (filter && !pdata->wakeup) ? ~0 : 0;
422 for (i = 0; i < KBC_MAX_ROW; i++)
423 writel(rst_val, kbc->mmio + KBC_ROW0_MASK_0 + i * 4);
426 static void tegra_kbc_config_pins(struct tegra_kbc *kbc)
428 const struct tegra_kbc_platform_data *pdata = kbc->pdata;
431 for (i = 0; i < KBC_MAX_GPIO; i++) {
432 u32 r_shft = 5 * (i % 6);
433 u32 c_shft = 4 * (i % 8);
434 u32 r_mask = 0x1f << r_shft;
435 u32 c_mask = 0x0f << c_shft;
436 u32 r_offs = (i / 6) * 4 + KBC_ROW_CFG0_0;
437 u32 c_offs = (i / 8) * 4 + KBC_COL_CFG0_0;
438 u32 row_cfg = readl(kbc->mmio + r_offs);
439 u32 col_cfg = readl(kbc->mmio + c_offs);
444 if (pdata->pin_cfg[i].is_row)
445 row_cfg |= ((pdata->pin_cfg[i].num << 1) | 1) << r_shft;
447 col_cfg |= ((pdata->pin_cfg[i].num << 1) | 1) << c_shft;
449 writel(row_cfg, kbc->mmio + r_offs);
450 writel(col_cfg, kbc->mmio + c_offs);
454 static int tegra_kbc_start(struct tegra_kbc *kbc)
456 const struct tegra_kbc_platform_data *pdata = kbc->pdata;
458 unsigned int debounce_cnt;
461 clk_enable(kbc->clk);
463 /* Reset the KBC controller to clear all previous status.*/
464 tegra_periph_reset_assert(kbc->clk);
466 tegra_periph_reset_deassert(kbc->clk);
469 tegra_kbc_config_pins(kbc);
470 tegra_kbc_setup_wakekeys(kbc, false);
472 writel(pdata->repeat_cnt, kbc->mmio + KBC_RPT_DLY_0);
474 /* Keyboard debounce count is maximum of 12 bits. */
475 debounce_cnt = min(pdata->debounce_cnt, KBC_MAX_DEBOUNCE_CNT);
476 val = KBC_DEBOUNCE_CNT_SHIFT(debounce_cnt);
477 val |= KBC_FIFO_TH_CNT_SHIFT(1); /* set fifo interrupt threshold to 1 */
478 val |= KBC_CONTROL_FIFO_CNT_INT_EN; /* interrupt on FIFO threshold */
479 val |= KBC_CONTROL_KBC_EN; /* enable */
480 writel(val, kbc->mmio + KBC_CONTROL_0);
483 * Compute the delay(ns) from interrupt mode to continuous polling
484 * mode so the timer routine is scheduled appropriately.
486 val = readl(kbc->mmio + KBC_INIT_DLY_0);
487 kbc->cp_dly_jiffies = usecs_to_jiffies((val & 0xfffff) * 32);
489 kbc->num_pressed_keys = 0;
492 * Atomically clear out any remaining entries in the key FIFO
493 * and enable keyboard interrupts.
495 spin_lock_irqsave(&kbc->lock, flags);
497 val = readl(kbc->mmio + KBC_INT_0);
502 val = readl(kbc->mmio + KBC_KP_ENT0_0);
503 val = readl(kbc->mmio + KBC_KP_ENT1_0);
505 writel(0x7, kbc->mmio + KBC_INT_0);
506 spin_unlock_irqrestore(&kbc->lock, flags);
508 enable_irq(kbc->irq);
513 static void tegra_kbc_stop(struct tegra_kbc *kbc)
518 spin_lock_irqsave(&kbc->lock, flags);
519 val = readl(kbc->mmio + KBC_CONTROL_0);
521 writel(val, kbc->mmio + KBC_CONTROL_0);
522 spin_unlock_irqrestore(&kbc->lock, flags);
524 disable_irq(kbc->irq);
525 del_timer_sync(&kbc->timer);
527 clk_disable(kbc->clk);
530 static int tegra_kbc_open(struct input_dev *dev)
532 struct tegra_kbc *kbc = input_get_drvdata(dev);
534 return tegra_kbc_start(kbc);
537 static void tegra_kbc_close(struct input_dev *dev)
539 struct tegra_kbc *kbc = input_get_drvdata(dev);
541 return tegra_kbc_stop(kbc);
544 static bool __devinit
545 tegra_kbc_check_pin_cfg(const struct tegra_kbc_platform_data *pdata,
546 struct device *dev, unsigned int *num_rows)
552 for (i = 0; i < KBC_MAX_GPIO; i++) {
553 const struct tegra_kbc_pin_cfg *pin_cfg = &pdata->pin_cfg[i];
555 if (pin_cfg->is_row) {
556 if (pin_cfg->num >= KBC_MAX_ROW) {
558 "pin_cfg[%d]: invalid row number %d\n",
564 if (pin_cfg->num >= KBC_MAX_COL) {
566 "pin_cfg[%d]: invalid column number %d\n",
576 static int __devinit tegra_kbc_probe(struct platform_device *pdev)
578 const struct tegra_kbc_platform_data *pdata = pdev->dev.platform_data;
579 const struct matrix_keymap_data *keymap_data;
580 struct tegra_kbc *kbc;
581 struct input_dev *input_dev;
582 struct resource *res;
586 unsigned int debounce_cnt;
587 unsigned int scan_time_rows;
592 if (!tegra_kbc_check_pin_cfg(pdata, &pdev->dev, &num_rows))
595 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
597 dev_err(&pdev->dev, "failed to get I/O memory\n");
601 irq = platform_get_irq(pdev, 0);
603 dev_err(&pdev->dev, "failed to get keyboard IRQ\n");
607 kbc = kzalloc(sizeof(*kbc), GFP_KERNEL);
608 input_dev = input_allocate_device();
609 if (!kbc || !input_dev) {
615 kbc->idev = input_dev;
617 spin_lock_init(&kbc->lock);
618 setup_timer(&kbc->timer, tegra_kbc_keypress_timer, (unsigned long)kbc);
620 res = request_mem_region(res->start, resource_size(res), pdev->name);
622 dev_err(&pdev->dev, "failed to request I/O memory\n");
627 kbc->mmio = ioremap(res->start, resource_size(res));
629 dev_err(&pdev->dev, "failed to remap I/O memory\n");
631 goto err_free_mem_region;
634 kbc->clk = clk_get(&pdev->dev, NULL);
635 if (IS_ERR(kbc->clk)) {
636 dev_err(&pdev->dev, "failed to get keyboard clock\n");
637 err = PTR_ERR(kbc->clk);
642 * The time delay between two consecutive reads of the FIFO is
643 * the sum of the repeat time and the time taken for scanning
644 * the rows. There is an additional delay before the row scanning
645 * starts. The repoll delay is computed in milliseconds.
647 debounce_cnt = min(pdata->debounce_cnt, KBC_MAX_DEBOUNCE_CNT);
648 scan_time_rows = (KBC_ROW_SCAN_TIME + debounce_cnt) * num_rows;
649 kbc->repoll_dly = KBC_ROW_SCAN_DLY + scan_time_rows + pdata->repeat_cnt;
650 kbc->repoll_dly = ((kbc->repoll_dly * KBC_CYCLE_USEC) + 999) / 1000;
652 input_dev->name = pdev->name;
653 input_dev->id.bustype = BUS_HOST;
654 input_dev->dev.parent = &pdev->dev;
655 input_dev->open = tegra_kbc_open;
656 input_dev->close = tegra_kbc_close;
658 input_set_drvdata(input_dev, kbc);
660 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP);
661 input_set_capability(input_dev, EV_MSC, MSC_SCAN);
663 input_dev->keycode = kbc->keycode;
664 input_dev->keycodesize = sizeof(kbc->keycode[0]);
665 input_dev->keycodemax = KBC_MAX_KEY;
666 if (pdata->use_fn_map)
667 input_dev->keycodemax *= 2;
669 kbc->use_fn_map = pdata->use_fn_map;
670 kbc->use_ghost_filter = pdata->use_ghost_filter;
671 keymap_data = pdata->keymap_data ?: &tegra_kbc_default_keymap_data;
672 matrix_keypad_build_keymap(keymap_data, KBC_ROW_SHIFT,
673 input_dev->keycode, input_dev->keybit);
675 err = request_irq(kbc->irq, tegra_kbc_isr, IRQF_TRIGGER_HIGH,
678 dev_err(&pdev->dev, "failed to request keyboard IRQ\n");
682 disable_irq(kbc->irq);
684 err = input_register_device(kbc->idev);
686 dev_err(&pdev->dev, "failed to register input device\n");
690 platform_set_drvdata(pdev, kbc);
691 device_init_wakeup(&pdev->dev, pdata->wakeup);
696 free_irq(kbc->irq, pdev);
702 release_mem_region(res->start, resource_size(res));
704 input_free_device(kbc->idev);
710 static int __devexit tegra_kbc_remove(struct platform_device *pdev)
712 struct tegra_kbc *kbc = platform_get_drvdata(pdev);
713 struct resource *res;
715 free_irq(kbc->irq, pdev);
718 input_unregister_device(kbc->idev);
720 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
721 release_mem_region(res->start, resource_size(res));
725 platform_set_drvdata(pdev, NULL);
730 #ifdef CONFIG_PM_SLEEP
731 static int tegra_kbc_suspend(struct device *dev)
733 struct platform_device *pdev = to_platform_device(dev);
734 struct tegra_kbc *kbc = platform_get_drvdata(pdev);
736 if (device_may_wakeup(&pdev->dev)) {
737 tegra_kbc_setup_wakekeys(kbc, true);
738 enable_irq_wake(kbc->irq);
739 /* Forcefully clear the interrupt status */
740 writel(0x7, kbc->mmio + KBC_INT_0);
743 mutex_lock(&kbc->idev->mutex);
744 if (kbc->idev->users)
746 mutex_unlock(&kbc->idev->mutex);
752 static int tegra_kbc_resume(struct device *dev)
754 struct platform_device *pdev = to_platform_device(dev);
755 struct tegra_kbc *kbc = platform_get_drvdata(pdev);
758 if (device_may_wakeup(&pdev->dev)) {
759 disable_irq_wake(kbc->irq);
760 tegra_kbc_setup_wakekeys(kbc, false);
762 mutex_lock(&kbc->idev->mutex);
763 if (kbc->idev->users)
764 err = tegra_kbc_start(kbc);
765 mutex_unlock(&kbc->idev->mutex);
772 static SIMPLE_DEV_PM_OPS(tegra_kbc_pm_ops, tegra_kbc_suspend, tegra_kbc_resume);
774 static struct platform_driver tegra_kbc_driver = {
775 .probe = tegra_kbc_probe,
776 .remove = __devexit_p(tegra_kbc_remove),
779 .owner = THIS_MODULE,
780 .pm = &tegra_kbc_pm_ops,
784 static void __exit tegra_kbc_exit(void)
786 platform_driver_unregister(&tegra_kbc_driver);
788 module_exit(tegra_kbc_exit);
790 static int __init tegra_kbc_init(void)
792 return platform_driver_register(&tegra_kbc_driver);
794 module_init(tegra_kbc_init);
796 MODULE_LICENSE("GPL");
797 MODULE_AUTHOR("Rakesh Iyer <riyer@nvidia.com>");
798 MODULE_DESCRIPTION("Tegra matrix keyboard controller driver");
799 MODULE_ALIAS("platform:tegra-kbc");