Pileus Git - ~andy/linux/blob - drivers/input/keyboard/tegra-kbc.c

   1 /*
   2  * Keyboard class input driver for the NVIDIA Tegra SoC internal matrix
   3  * keyboard controller
   4  *
   5  * Copyright (c) 2009-2011, NVIDIA Corporation.
   6  *
   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.
  11  *
  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
  15  * more details.
  16  *
  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.
  20  */
  21
  22 #include <linux/kernel.h>
  23 #include <linux/module.h>
  24 #include <linux/input.h>
  25 #include <linux/platform_device.h>
  26 #include <linux/delay.h>
  27 #include <linux/io.h>
  28 #include <linux/interrupt.h>
  29 #include <linux/of.h>
  30 #include <linux/clk.h>
  31 #include <linux/slab.h>
  32 #include <mach/clk.h>
  33 #include <mach/kbc.h>
  34
  35 #define KBC_MAX_DEBOUNCE_CNT    0x3ffu
  36
  37 /* KBC row scan time and delay for beginning the row scan. */
  38 #define KBC_ROW_SCAN_TIME       16
  39 #define KBC_ROW_SCAN_DLY        5
  40
  41 /* KBC uses a 32KHz clock so a cycle = 1/32Khz */
  42 #define KBC_CYCLE_MS    32
  43
  44 /* KBC Registers */
  45
  46 /* KBC Control Register */
  47 #define KBC_CONTROL_0   0x0
  48 #define KBC_FIFO_TH_CNT_SHIFT(cnt)      (cnt << 14)
  49 #define KBC_DEBOUNCE_CNT_SHIFT(cnt)     (cnt << 4)
  50 #define KBC_CONTROL_FIFO_CNT_INT_EN     (1 << 3)
  51 #define KBC_CONTROL_KEYPRESS_INT_EN     (1 << 1)
  52 #define KBC_CONTROL_KBC_EN              (1 << 0)
  53
  54 /* KBC Interrupt Register */
  55 #define KBC_INT_0       0x4
  56 #define KBC_INT_FIFO_CNT_INT_STATUS     (1 << 2)
  57 #define KBC_INT_KEYPRESS_INT_STATUS     (1 << 0)
  58
  59 #define KBC_ROW_CFG0_0  0x8
  60 #define KBC_COL_CFG0_0  0x18
  61 #define KBC_TO_CNT_0    0x24
  62 #define KBC_INIT_DLY_0  0x28
  63 #define KBC_RPT_DLY_0   0x2c
  64 #define KBC_KP_ENT0_0   0x30
  65 #define KBC_KP_ENT1_0   0x34
  66 #define KBC_ROW0_MASK_0 0x38
  67
  68 #define KBC_ROW_SHIFT   3
  69
  70 struct tegra_kbc {
  71         void __iomem *mmio;
  72         struct input_dev *idev;
  73         unsigned int irq;
  74         spinlock_t lock;
  75         unsigned int repoll_dly;
  76         unsigned long cp_dly_jiffies;
  77         unsigned int cp_to_wkup_dly;
  78         bool use_fn_map;
  79         bool use_ghost_filter;
  80         bool keypress_caused_wake;
  81         const struct tegra_kbc_platform_data *pdata;
  82         unsigned short keycode[KBC_MAX_KEY * 2];
  83         unsigned short current_keys[KBC_MAX_KPENT];
  84         unsigned int num_pressed_keys;
  85         u32 wakeup_key;
  86         struct timer_list timer;
  87         struct clk *clk;
  88 };
  89
  90 static const u32 tegra_kbc_default_keymap[] __devinitdata = {
  91         KEY(0, 2, KEY_W),
  92         KEY(0, 3, KEY_S),
  93         KEY(0, 4, KEY_A),
  94         KEY(0, 5, KEY_Z),
  95         KEY(0, 7, KEY_FN),
  96
  97         KEY(1, 7, KEY_LEFTMETA),
  98
  99         KEY(2, 6, KEY_RIGHTALT),
 100         KEY(2, 7, KEY_LEFTALT),
 101
 102         KEY(3, 0, KEY_5),
 103         KEY(3, 1, KEY_4),
 104         KEY(3, 2, KEY_R),
 105         KEY(3, 3, KEY_E),
 106         KEY(3, 4, KEY_F),
 107         KEY(3, 5, KEY_D),
 108         KEY(3, 6, KEY_X),
 109
 110         KEY(4, 0, KEY_7),
 111         KEY(4, 1, KEY_6),
 112         KEY(4, 2, KEY_T),
 113         KEY(4, 3, KEY_H),
 114         KEY(4, 4, KEY_G),
 115         KEY(4, 5, KEY_V),
 116         KEY(4, 6, KEY_C),
 117         KEY(4, 7, KEY_SPACE),
 118
 119         KEY(5, 0, KEY_9),
 120         KEY(5, 1, KEY_8),
 121         KEY(5, 2, KEY_U),
 122         KEY(5, 3, KEY_Y),
 123         KEY(5, 4, KEY_J),
 124         KEY(5, 5, KEY_N),
 125         KEY(5, 6, KEY_B),
 126         KEY(5, 7, KEY_BACKSLASH),
 127
 128         KEY(6, 0, KEY_MINUS),
 129         KEY(6, 1, KEY_0),
 130         KEY(6, 2, KEY_O),
 131         KEY(6, 3, KEY_I),
 132         KEY(6, 4, KEY_L),
 133         KEY(6, 5, KEY_K),
 134         KEY(6, 6, KEY_COMMA),
 135         KEY(6, 7, KEY_M),
 136
 137         KEY(7, 1, KEY_EQUAL),
 138         KEY(7, 2, KEY_RIGHTBRACE),
 139         KEY(7, 3, KEY_ENTER),
 140         KEY(7, 7, KEY_MENU),
 141
 142         KEY(8, 4, KEY_RIGHTSHIFT),
 143         KEY(8, 5, KEY_LEFTSHIFT),
 144
 145         KEY(9, 5, KEY_RIGHTCTRL),
 146         KEY(9, 7, KEY_LEFTCTRL),
 147
 148         KEY(11, 0, KEY_LEFTBRACE),
 149         KEY(11, 1, KEY_P),
 150         KEY(11, 2, KEY_APOSTROPHE),
 151         KEY(11, 3, KEY_SEMICOLON),
 152         KEY(11, 4, KEY_SLASH),
 153         KEY(11, 5, KEY_DOT),
 154
 155         KEY(12, 0, KEY_F10),
 156         KEY(12, 1, KEY_F9),
 157         KEY(12, 2, KEY_BACKSPACE),
 158         KEY(12, 3, KEY_3),
 159         KEY(12, 4, KEY_2),
 160         KEY(12, 5, KEY_UP),
 161         KEY(12, 6, KEY_PRINT),
 162         KEY(12, 7, KEY_PAUSE),
 163
 164         KEY(13, 0, KEY_INSERT),
 165         KEY(13, 1, KEY_DELETE),
 166         KEY(13, 3, KEY_PAGEUP),
 167         KEY(13, 4, KEY_PAGEDOWN),
 168         KEY(13, 5, KEY_RIGHT),
 169         KEY(13, 6, KEY_DOWN),
 170         KEY(13, 7, KEY_LEFT),
 171
 172         KEY(14, 0, KEY_F11),
 173         KEY(14, 1, KEY_F12),
 174         KEY(14, 2, KEY_F8),
 175         KEY(14, 3, KEY_Q),
 176         KEY(14, 4, KEY_F4),
 177         KEY(14, 5, KEY_F3),
 178         KEY(14, 6, KEY_1),
 179         KEY(14, 7, KEY_F7),
 180
 181         KEY(15, 0, KEY_ESC),
 182         KEY(15, 1, KEY_GRAVE),
 183         KEY(15, 2, KEY_F5),
 184         KEY(15, 3, KEY_TAB),
 185         KEY(15, 4, KEY_F1),
 186         KEY(15, 5, KEY_F2),
 187         KEY(15, 6, KEY_CAPSLOCK),
 188         KEY(15, 7, KEY_F6),
 189
 190         /* Software Handled Function Keys */
 191         KEY(20, 0, KEY_KP7),
 192
 193         KEY(21, 0, KEY_KP9),
 194         KEY(21, 1, KEY_KP8),
 195         KEY(21, 2, KEY_KP4),
 196         KEY(21, 4, KEY_KP1),
 197
 198         KEY(22, 1, KEY_KPSLASH),
 199         KEY(22, 2, KEY_KP6),
 200         KEY(22, 3, KEY_KP5),
 201         KEY(22, 4, KEY_KP3),
 202         KEY(22, 5, KEY_KP2),
 203         KEY(22, 7, KEY_KP0),
 204
 205         KEY(27, 1, KEY_KPASTERISK),
 206         KEY(27, 3, KEY_KPMINUS),
 207         KEY(27, 4, KEY_KPPLUS),
 208         KEY(27, 5, KEY_KPDOT),
 209
 210         KEY(28, 5, KEY_VOLUMEUP),
 211
 212         KEY(29, 3, KEY_HOME),
 213         KEY(29, 4, KEY_END),
 214         KEY(29, 5, KEY_BRIGHTNESSDOWN),
 215         KEY(29, 6, KEY_VOLUMEDOWN),
 216         KEY(29, 7, KEY_BRIGHTNESSUP),
 217
 218         KEY(30, 0, KEY_NUMLOCK),
 219         KEY(30, 1, KEY_SCROLLLOCK),
 220         KEY(30, 2, KEY_MUTE),
 221
 222         KEY(31, 4, KEY_HELP),
 223 };
 224
 225 static const
 226 struct matrix_keymap_data tegra_kbc_default_keymap_data __devinitdata = {
 227         .keymap         = tegra_kbc_default_keymap,
 228         .keymap_size    = ARRAY_SIZE(tegra_kbc_default_keymap),
 229 };
 230
 231 static void tegra_kbc_report_released_keys(struct input_dev *input,
 232                                            unsigned short old_keycodes[],
 233                                            unsigned int old_num_keys,
 234                                            unsigned short new_keycodes[],
 235                                            unsigned int new_num_keys)
 236 {
 237         unsigned int i, j;
 238
 239         for (i = 0; i < old_num_keys; i++) {
 240                 for (j = 0; j < new_num_keys; j++)
 241                         if (old_keycodes[i] == new_keycodes[j])
 242                                 break;
 243
 244                 if (j == new_num_keys)
 245                         input_report_key(input, old_keycodes[i], 0);
 246         }
 247 }
 248
 249 static void tegra_kbc_report_pressed_keys(struct input_dev *input,
 250                                           unsigned char scancodes[],
 251                                           unsigned short keycodes[],
 252                                           unsigned int num_pressed_keys)
 253 {
 254         unsigned int i;
 255
 256         for (i = 0; i < num_pressed_keys; i++) {
 257                 input_event(input, EV_MSC, MSC_SCAN, scancodes[i]);
 258                 input_report_key(input, keycodes[i], 1);
 259         }
 260 }
 261
 262 static void tegra_kbc_report_keys(struct tegra_kbc *kbc)
 263 {
 264         unsigned char scancodes[KBC_MAX_KPENT];
 265         unsigned short keycodes[KBC_MAX_KPENT];
 266         u32 val = 0;
 267         unsigned int i;
 268         unsigned int num_down = 0;
 269         bool fn_keypress = false;
 270         bool key_in_same_row = false;
 271         bool key_in_same_col = false;
 272
 273         for (i = 0; i < KBC_MAX_KPENT; i++) {
 274                 if ((i % 4) == 0)
 275                         val = readl(kbc->mmio + KBC_KP_ENT0_0 + i);
 276
 277                 if (val & 0x80) {
 278                         unsigned int col = val & 0x07;
 279                         unsigned int row = (val >> 3) & 0x0f;
 280                         unsigned char scancode =
 281                                 MATRIX_SCAN_CODE(row, col, KBC_ROW_SHIFT);
 282
 283                         scancodes[num_down] = scancode;
 284                         keycodes[num_down] = kbc->keycode[scancode];
 285                         /* If driver uses Fn map, do not report the Fn key. */
 286                         if ((keycodes[num_down] == KEY_FN) && kbc->use_fn_map)
 287                                 fn_keypress = true;
 288                         else
 289                                 num_down++;
 290                 }
 291
 292                 val >>= 8;
 293         }
 294
 295         /*
 296          * Matrix keyboard designs are prone to keyboard ghosting.
 297          * Ghosting occurs if there are 3 keys such that -
 298          * any 2 of the 3 keys share a row, and any 2 of them share a column.
 299          * If so ignore the key presses for this iteration.
 300          */
 301         if (kbc->use_ghost_filter && num_down >= 3) {
 302                 for (i = 0; i < num_down; i++) {
 303                         unsigned int j;
 304                         u8 curr_col = scancodes[i] & 0x07;
 305                         u8 curr_row = scancodes[i] >> KBC_ROW_SHIFT;
 306
 307                         /*
 308                          * Find 2 keys such that one key is in the same row
 309                          * and the other is in the same column as the i-th key.
 310                          */
 311                         for (j = i + 1; j < num_down; j++) {
 312                                 u8 col = scancodes[j] & 0x07;
 313                                 u8 row = scancodes[j] >> KBC_ROW_SHIFT;
 314
 315                                 if (col == curr_col)
 316                                         key_in_same_col = true;
 317                                 if (row == curr_row)
 318                                         key_in_same_row = true;
 319                         }
 320                 }
 321         }
 322
 323         /*
 324          * If the platform uses Fn keymaps, translate keys on a Fn keypress.
 325          * Function keycodes are KBC_MAX_KEY apart from the plain keycodes.
 326          */
 327         if (fn_keypress) {
 328                 for (i = 0; i < num_down; i++) {
 329                         scancodes[i] += KBC_MAX_KEY;
 330                         keycodes[i] = kbc->keycode[scancodes[i]];
 331                 }
 332         }
 333
 334         /* Ignore the key presses for this iteration? */
 335         if (key_in_same_col && key_in_same_row)
 336                 return;
 337
 338         tegra_kbc_report_released_keys(kbc->idev,
 339                                        kbc->current_keys, kbc->num_pressed_keys,
 340                                        keycodes, num_down);
 341         tegra_kbc_report_pressed_keys(kbc->idev, scancodes, keycodes, num_down);
 342         input_sync(kbc->idev);
 343
 344         memcpy(kbc->current_keys, keycodes, sizeof(kbc->current_keys));
 345         kbc->num_pressed_keys = num_down;
 346 }
 347
 348 static void tegra_kbc_set_fifo_interrupt(struct tegra_kbc *kbc, bool enable)
 349 {
 350         u32 val;
 351
 352         val = readl(kbc->mmio + KBC_CONTROL_0);
 353         if (enable)
 354                 val |= KBC_CONTROL_FIFO_CNT_INT_EN;
 355         else
 356                 val &= ~KBC_CONTROL_FIFO_CNT_INT_EN;
 357         writel(val, kbc->mmio + KBC_CONTROL_0);
 358 }
 359
 360 static void tegra_kbc_set_keypress_interrupt(struct tegra_kbc *kbc, bool enable)
 361 {
 362         u32 val;
 363
 364         val = readl(kbc->mmio + KBC_CONTROL_0);
 365         if (enable)
 366                 val |= KBC_CONTROL_KEYPRESS_INT_EN;
 367         else
 368                 val &= ~KBC_CONTROL_KEYPRESS_INT_EN;
 369         writel(val, kbc->mmio + KBC_CONTROL_0);
 370 }
 371
 372 static void tegra_kbc_keypress_timer(unsigned long data)
 373 {
 374         struct tegra_kbc *kbc = (struct tegra_kbc *)data;
 375         unsigned long flags;
 376         u32 val;
 377         unsigned int i;
 378
 379         spin_lock_irqsave(&kbc->lock, flags);
 380
 381         val = (readl(kbc->mmio + KBC_INT_0) >> 4) & 0xf;
 382         if (val) {
 383                 unsigned long dly;
 384
 385                 tegra_kbc_report_keys(kbc);
 386
 387                 /*
 388                  * If more than one keys are pressed we need not wait
 389                  * for the repoll delay.
 390                  */
 391                 dly = (val == 1) ? kbc->repoll_dly : 1;
 392                 mod_timer(&kbc->timer, jiffies + msecs_to_jiffies(dly));
 393         } else {
 394                 /* Release any pressed keys and exit the polling loop */
 395                 for (i = 0; i < kbc->num_pressed_keys; i++)
 396                         input_report_key(kbc->idev, kbc->current_keys[i], 0);
 397                 input_sync(kbc->idev);
 398
 399                 kbc->num_pressed_keys = 0;
 400
 401                 /* All keys are released so enable the keypress interrupt */
 402                 tegra_kbc_set_fifo_interrupt(kbc, true);
 403         }
 404
 405         spin_unlock_irqrestore(&kbc->lock, flags);
 406 }
 407
 408 static irqreturn_t tegra_kbc_isr(int irq, void *args)
 409 {
 410         struct tegra_kbc *kbc = args;
 411         unsigned long flags;
 412         u32 val;
 413
 414         spin_lock_irqsave(&kbc->lock, flags);
 415
 416         /*
 417          * Quickly bail out & reenable interrupts if the fifo threshold
 418          * count interrupt wasn't the interrupt source
 419          */
 420         val = readl(kbc->mmio + KBC_INT_0);
 421         writel(val, kbc->mmio + KBC_INT_0);
 422
 423         if (val & KBC_INT_FIFO_CNT_INT_STATUS) {
 424                 /*
 425                  * Until all keys are released, defer further processing to
 426                  * the polling loop in tegra_kbc_keypress_timer.
 427                  */
 428                 tegra_kbc_set_fifo_interrupt(kbc, false);
 429                 mod_timer(&kbc->timer, jiffies + kbc->cp_dly_jiffies);
 430         } else if (val & KBC_INT_KEYPRESS_INT_STATUS) {
 431                 /* We can be here only through system resume path */
 432                 kbc->keypress_caused_wake = true;
 433         }
 434
 435         spin_unlock_irqrestore(&kbc->lock, flags);
 436
 437         return IRQ_HANDLED;
 438 }
 439
 440 static void tegra_kbc_setup_wakekeys(struct tegra_kbc *kbc, bool filter)
 441 {
 442         const struct tegra_kbc_platform_data *pdata = kbc->pdata;
 443         int i;
 444         unsigned int rst_val;
 445
 446         /* Either mask all keys or none. */
 447         rst_val = (filter && !pdata->wakeup) ? ~0 : 0;
 448
 449         for (i = 0; i < KBC_MAX_ROW; i++)
 450                 writel(rst_val, kbc->mmio + KBC_ROW0_MASK_0 + i * 4);
 451 }
 452
 453 static void tegra_kbc_config_pins(struct tegra_kbc *kbc)
 454 {
 455         const struct tegra_kbc_platform_data *pdata = kbc->pdata;
 456         int i;
 457
 458         for (i = 0; i < KBC_MAX_GPIO; i++) {
 459                 u32 r_shft = 5 * (i % 6);
 460                 u32 c_shft = 4 * (i % 8);
 461                 u32 r_mask = 0x1f << r_shft;
 462                 u32 c_mask = 0x0f << c_shft;
 463                 u32 r_offs = (i / 6) * 4 + KBC_ROW_CFG0_0;
 464                 u32 c_offs = (i / 8) * 4 + KBC_COL_CFG0_0;
 465                 u32 row_cfg = readl(kbc->mmio + r_offs);
 466                 u32 col_cfg = readl(kbc->mmio + c_offs);
 467
 468                 row_cfg &= ~r_mask;
 469                 col_cfg &= ~c_mask;
 470
 471                 switch (pdata->pin_cfg[i].type) {
 472                 case PIN_CFG_ROW:
 473                         row_cfg |= ((pdata->pin_cfg[i].num << 1) | 1) << r_shft;
 474                         break;
 475
 476                 case PIN_CFG_COL:
 477                         col_cfg |= ((pdata->pin_cfg[i].num << 1) | 1) << c_shft;
 478                         break;
 479
 480                 case PIN_CFG_IGNORE:
 481                         break;
 482                 }
 483
 484                 writel(row_cfg, kbc->mmio + r_offs);
 485                 writel(col_cfg, kbc->mmio + c_offs);
 486         }
 487 }
 488
 489 static int tegra_kbc_start(struct tegra_kbc *kbc)
 490 {
 491         const struct tegra_kbc_platform_data *pdata = kbc->pdata;
 492         unsigned int debounce_cnt;
 493         u32 val = 0;
 494
 495         clk_enable(kbc->clk);
 496
 497         /* Reset the KBC controller to clear all previous status.*/
 498         tegra_periph_reset_assert(kbc->clk);
 499         udelay(100);
 500         tegra_periph_reset_deassert(kbc->clk);
 501         udelay(100);
 502
 503         tegra_kbc_config_pins(kbc);
 504         tegra_kbc_setup_wakekeys(kbc, false);
 505
 506         writel(pdata->repeat_cnt, kbc->mmio + KBC_RPT_DLY_0);
 507
 508         /* Keyboard debounce count is maximum of 12 bits. */
 509         debounce_cnt = min(pdata->debounce_cnt, KBC_MAX_DEBOUNCE_CNT);
 510         val = KBC_DEBOUNCE_CNT_SHIFT(debounce_cnt);
 511         val |= KBC_FIFO_TH_CNT_SHIFT(1); /* set fifo interrupt threshold to 1 */
 512         val |= KBC_CONTROL_FIFO_CNT_INT_EN;  /* interrupt on FIFO threshold */
 513         val |= KBC_CONTROL_KBC_EN;     /* enable */
 514         writel(val, kbc->mmio + KBC_CONTROL_0);
 515
 516         /*
 517          * Compute the delay(ns) from interrupt mode to continuous polling
 518          * mode so the timer routine is scheduled appropriately.
 519          */
 520         val = readl(kbc->mmio + KBC_INIT_DLY_0);
 521         kbc->cp_dly_jiffies = usecs_to_jiffies((val & 0xfffff) * 32);
 522
 523         kbc->num_pressed_keys = 0;
 524
 525         /*
 526          * Atomically clear out any remaining entries in the key FIFO
 527          * and enable keyboard interrupts.
 528          */
 529         while (1) {
 530                 val = readl(kbc->mmio + KBC_INT_0);
 531                 val >>= 4;
 532                 if (!val)
 533                         break;
 534
 535                 val = readl(kbc->mmio + KBC_KP_ENT0_0);
 536                 val = readl(kbc->mmio + KBC_KP_ENT1_0);
 537         }
 538         writel(0x7, kbc->mmio + KBC_INT_0);
 539
 540         enable_irq(kbc->irq);
 541
 542         return 0;
 543 }
 544
 545 static void tegra_kbc_stop(struct tegra_kbc *kbc)
 546 {
 547         unsigned long flags;
 548         u32 val;
 549
 550         spin_lock_irqsave(&kbc->lock, flags);
 551         val = readl(kbc->mmio + KBC_CONTROL_0);
 552         val &= ~1;
 553         writel(val, kbc->mmio + KBC_CONTROL_0);
 554         spin_unlock_irqrestore(&kbc->lock, flags);
 555
 556         disable_irq(kbc->irq);
 557         del_timer_sync(&kbc->timer);
 558
 559         clk_disable(kbc->clk);
 560 }
 561
 562 static int tegra_kbc_open(struct input_dev *dev)
 563 {
 564         struct tegra_kbc *kbc = input_get_drvdata(dev);
 565
 566         return tegra_kbc_start(kbc);
 567 }
 568
 569 static void tegra_kbc_close(struct input_dev *dev)
 570 {
 571         struct tegra_kbc *kbc = input_get_drvdata(dev);
 572
 573         return tegra_kbc_stop(kbc);
 574 }
 575
 576 static bool __devinit
 577 tegra_kbc_check_pin_cfg(const struct tegra_kbc_platform_data *pdata,
 578                         struct device *dev, unsigned int *num_rows)
 579 {
 580         int i;
 581
 582         *num_rows = 0;
 583
 584         for (i = 0; i < KBC_MAX_GPIO; i++) {
 585                 const struct tegra_kbc_pin_cfg *pin_cfg = &pdata->pin_cfg[i];
 586
 587                 switch (pin_cfg->type) {
 588                 case PIN_CFG_ROW:
 589                         if (pin_cfg->num >= KBC_MAX_ROW) {
 590                                 dev_err(dev,
 591                                         "pin_cfg[%d]: invalid row number %d\n",
 592                                         i, pin_cfg->num);
 593                                 return false;
 594                         }
 595                         (*num_rows)++;
 596                         break;
 597
 598                 case PIN_CFG_COL:
 599                         if (pin_cfg->num >= KBC_MAX_COL) {
 600                                 dev_err(dev,
 601                                         "pin_cfg[%d]: invalid column number %d\n",
 602                                         i, pin_cfg->num);
 603                                 return false;
 604                         }
 605                         break;
 606
 607                 case PIN_CFG_IGNORE:
 608                         break;
 609
 610                 default:
 611                         dev_err(dev,
 612                                 "pin_cfg[%d]: invalid entry type %d\n",
 613                                 pin_cfg->type, pin_cfg->num);
 614                         return false;
 615                 }
 616         }
 617
 618         return true;
 619 }
 620
 621 #ifdef CONFIG_OF
 622 static struct tegra_kbc_platform_data * __devinit
 623 tegra_kbc_dt_parse_pdata(struct platform_device *pdev)
 624 {
 625         struct tegra_kbc_platform_data *pdata;
 626         struct device_node *np = pdev->dev.of_node;
 627         u32 prop;
 628         int i;
 629
 630         if (!np)
 631                 return NULL;
 632
 633         pdata = kzalloc(sizeof(*pdata), GFP_KERNEL);
 634         if (!pdata)
 635                 return NULL;
 636
 637         if (!of_property_read_u32(np, "nvidia,debounce-delay-ms", &prop))
 638                 pdata->debounce_cnt = prop;
 639
 640         if (!of_property_read_u32(np, "nvidia,repeat-delay-ms", &prop))
 641                 pdata->repeat_cnt = prop;
 642
 643         if (of_find_property(np, "nvidia,needs-ghost-filter", NULL))
 644                 pdata->use_ghost_filter = true;
 645
 646         if (of_find_property(np, "nvidia,wakeup-source", NULL))
 647                 pdata->wakeup = true;
 648
 649         /*
 650          * All currently known keymaps with device tree support use the same
 651          * pin_cfg, so set it up here.
 652          */
 653         for (i = 0; i < KBC_MAX_ROW; i++) {
 654                 pdata->pin_cfg[i].num = i;
 655                 pdata->pin_cfg[i].type = PIN_CFG_ROW;
 656         }
 657
 658         for (i = 0; i < KBC_MAX_COL; i++) {
 659                 pdata->pin_cfg[KBC_MAX_ROW + i].num = i;
 660                 pdata->pin_cfg[KBC_MAX_ROW + i].type = PIN_CFG_COL;
 661         }
 662
 663         pdata->keymap_data = matrix_keyboard_of_fill_keymap(np, "linux,keymap");
 664
 665         /* FIXME: Add handling of linux,fn-keymap here */
 666
 667         return pdata;
 668 }
 669 #else
 670 static inline struct tegra_kbc_platform_data *tegra_kbc_dt_parse_pdata(
 671         struct platform_device *pdev)
 672 {
 673         return NULL;
 674 }
 675 #endif
 676
 677 static int __devinit tegra_kbc_probe(struct platform_device *pdev)
 678 {
 679         const struct tegra_kbc_platform_data *pdata = pdev->dev.platform_data;
 680         const struct matrix_keymap_data *keymap_data;
 681         struct tegra_kbc *kbc;
 682         struct input_dev *input_dev;
 683         struct resource *res;
 684         int irq;
 685         int err;
 686         int num_rows = 0;
 687         unsigned int debounce_cnt;
 688         unsigned int scan_time_rows;
 689
 690         if (!pdata)
 691                 pdata = tegra_kbc_dt_parse_pdata(pdev);
 692
 693         if (!pdata)
 694                 return -EINVAL;
 695
 696         if (!tegra_kbc_check_pin_cfg(pdata, &pdev->dev, &num_rows)) {
 697                 err = -EINVAL;
 698                 goto err_free_pdata;
 699         }
 700
 701         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 702         if (!res) {
 703                 dev_err(&pdev->dev, "failed to get I/O memory\n");
 704                 err = -ENXIO;
 705                 goto err_free_pdata;
 706         }
 707
 708         irq = platform_get_irq(pdev, 0);
 709         if (irq < 0) {
 710                 dev_err(&pdev->dev, "failed to get keyboard IRQ\n");
 711                 err = -ENXIO;
 712                 goto err_free_pdata;
 713         }
 714
 715         kbc = kzalloc(sizeof(*kbc), GFP_KERNEL);
 716         input_dev = input_allocate_device();
 717         if (!kbc || !input_dev) {
 718                 err = -ENOMEM;
 719                 goto err_free_mem;
 720         }
 721
 722         kbc->pdata = pdata;
 723         kbc->idev = input_dev;
 724         kbc->irq = irq;
 725         spin_lock_init(&kbc->lock);
 726         setup_timer(&kbc->timer, tegra_kbc_keypress_timer, (unsigned long)kbc);
 727
 728         res = request_mem_region(res->start, resource_size(res), pdev->name);
 729         if (!res) {
 730                 dev_err(&pdev->dev, "failed to request I/O memory\n");
 731                 err = -EBUSY;
 732                 goto err_free_mem;
 733         }
 734
 735         kbc->mmio = ioremap(res->start, resource_size(res));
 736         if (!kbc->mmio) {
 737                 dev_err(&pdev->dev, "failed to remap I/O memory\n");
 738                 err = -ENXIO;
 739                 goto err_free_mem_region;
 740         }
 741
 742         kbc->clk = clk_get(&pdev->dev, NULL);
 743         if (IS_ERR(kbc->clk)) {
 744                 dev_err(&pdev->dev, "failed to get keyboard clock\n");
 745                 err = PTR_ERR(kbc->clk);
 746                 goto err_iounmap;
 747         }
 748
 749         /*
 750          * The time delay between two consecutive reads of the FIFO is
 751          * the sum of the repeat time and the time taken for scanning
 752          * the rows. There is an additional delay before the row scanning
 753          * starts. The repoll delay is computed in milliseconds.
 754          */
 755         debounce_cnt = min(pdata->debounce_cnt, KBC_MAX_DEBOUNCE_CNT);
 756         scan_time_rows = (KBC_ROW_SCAN_TIME + debounce_cnt) * num_rows;
 757         kbc->repoll_dly = KBC_ROW_SCAN_DLY + scan_time_rows + pdata->repeat_cnt;
 758         kbc->repoll_dly = DIV_ROUND_UP(kbc->repoll_dly, KBC_CYCLE_MS);
 759
 760         input_dev->name = pdev->name;
 761         input_dev->id.bustype = BUS_HOST;
 762         input_dev->dev.parent = &pdev->dev;
 763         input_dev->open = tegra_kbc_open;
 764         input_dev->close = tegra_kbc_close;
 765
 766         input_set_drvdata(input_dev, kbc);
 767
 768         input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP);
 769         input_set_capability(input_dev, EV_MSC, MSC_SCAN);
 770
 771         input_dev->keycode = kbc->keycode;
 772         input_dev->keycodesize = sizeof(kbc->keycode[0]);
 773         input_dev->keycodemax = KBC_MAX_KEY;
 774         if (pdata->use_fn_map)
 775                 input_dev->keycodemax *= 2;
 776
 777         kbc->use_fn_map = pdata->use_fn_map;
 778         kbc->use_ghost_filter = pdata->use_ghost_filter;
 779         keymap_data = pdata->keymap_data ?: &tegra_kbc_default_keymap_data;
 780         matrix_keypad_build_keymap(keymap_data, KBC_ROW_SHIFT,
 781                                    input_dev->keycode, input_dev->keybit);
 782         kbc->wakeup_key = pdata->wakeup_key;
 783
 784         err = request_irq(kbc->irq, tegra_kbc_isr,
 785                           IRQF_NO_SUSPEND | IRQF_TRIGGER_HIGH, pdev->name, kbc);
 786         if (err) {
 787                 dev_err(&pdev->dev, "failed to request keyboard IRQ\n");
 788                 goto err_put_clk;
 789         }
 790
 791         disable_irq(kbc->irq);
 792
 793         err = input_register_device(kbc->idev);
 794         if (err) {
 795                 dev_err(&pdev->dev, "failed to register input device\n");
 796                 goto err_free_irq;
 797         }
 798
 799         platform_set_drvdata(pdev, kbc);
 800         device_init_wakeup(&pdev->dev, pdata->wakeup);
 801
 802         if (!pdev->dev.platform_data)
 803                 matrix_keyboard_of_free_keymap(pdata->keymap_data);
 804
 805         return 0;
 806
 807 err_free_irq:
 808         free_irq(kbc->irq, pdev);
 809 err_put_clk:
 810         clk_put(kbc->clk);
 811 err_iounmap:
 812         iounmap(kbc->mmio);
 813 err_free_mem_region:
 814         release_mem_region(res->start, resource_size(res));
 815 err_free_mem:
 816         input_free_device(input_dev);
 817         kfree(kbc);
 818 err_free_pdata:
 819         if (!pdev->dev.platform_data) {
 820                 matrix_keyboard_of_free_keymap(pdata->keymap_data);
 821                 kfree(pdata);
 822         }
 823
 824         return err;
 825 }
 826
 827 static int __devexit tegra_kbc_remove(struct platform_device *pdev)
 828 {
 829         struct tegra_kbc *kbc = platform_get_drvdata(pdev);
 830         struct resource *res;
 831
 832         platform_set_drvdata(pdev, NULL);
 833
 834         free_irq(kbc->irq, pdev);
 835         clk_put(kbc->clk);
 836
 837         input_unregister_device(kbc->idev);
 838         iounmap(kbc->mmio);
 839         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 840         release_mem_region(res->start, resource_size(res));
 841
 842         /*
 843          * If we do not have platform data attached to the device we
 844          * allocated it ourselves and thus need to free it.
 845          */
 846         if (!pdev->dev.platform_data)
 847                 kfree(kbc->pdata);
 848
 849         kfree(kbc);
 850
 851         return 0;
 852 }
 853
 854 #ifdef CONFIG_PM_SLEEP
 855 static int tegra_kbc_suspend(struct device *dev)
 856 {
 857         struct platform_device *pdev = to_platform_device(dev);
 858         struct tegra_kbc *kbc = platform_get_drvdata(pdev);
 859
 860         mutex_lock(&kbc->idev->mutex);
 861         if (device_may_wakeup(&pdev->dev)) {
 862                 disable_irq(kbc->irq);
 863                 del_timer_sync(&kbc->timer);
 864                 tegra_kbc_set_fifo_interrupt(kbc, false);
 865
 866                 /* Forcefully clear the interrupt status */
 867                 writel(0x7, kbc->mmio + KBC_INT_0);
 868                 /*
 869                  * Store the previous resident time of continuous polling mode.
 870                  * Force the keyboard into interrupt mode.
 871                  */
 872                 kbc->cp_to_wkup_dly = readl(kbc->mmio + KBC_TO_CNT_0);
 873                 writel(0, kbc->mmio + KBC_TO_CNT_0);
 874
 875                 tegra_kbc_setup_wakekeys(kbc, true);
 876                 msleep(30);
 877
 878                 kbc->keypress_caused_wake = false;
 879                 /* Enable keypress interrupt before going into suspend. */
 880                 tegra_kbc_set_keypress_interrupt(kbc, true);
 881                 enable_irq(kbc->irq);
 882                 enable_irq_wake(kbc->irq);
 883         } else {
 884                 if (kbc->idev->users)
 885                         tegra_kbc_stop(kbc);
 886         }
 887         mutex_unlock(&kbc->idev->mutex);
 888
 889         return 0;
 890 }
 891
 892 static int tegra_kbc_resume(struct device *dev)
 893 {
 894         struct platform_device *pdev = to_platform_device(dev);
 895         struct tegra_kbc *kbc = platform_get_drvdata(pdev);
 896         int err = 0;
 897
 898         mutex_lock(&kbc->idev->mutex);
 899         if (device_may_wakeup(&pdev->dev)) {
 900                 disable_irq_wake(kbc->irq);
 901                 tegra_kbc_setup_wakekeys(kbc, false);
 902                 /* We will use fifo interrupts for key detection. */
 903                 tegra_kbc_set_keypress_interrupt(kbc, false);
 904
 905                 /* Restore the resident time of continuous polling mode. */
 906                 writel(kbc->cp_to_wkup_dly, kbc->mmio + KBC_TO_CNT_0);
 907
 908                 tegra_kbc_set_fifo_interrupt(kbc, true);
 909
 910                 if (kbc->keypress_caused_wake && kbc->wakeup_key) {
 911                         /*
 912                          * We can't report events directly from the ISR
 913                          * because timekeeping is stopped when processing
 914                          * wakeup request and we get a nasty warning when
 915                          * we try to call do_gettimeofday() in evdev
 916                          * handler.
 917                          */
 918                         input_report_key(kbc->idev, kbc->wakeup_key, 1);
 919                         input_sync(kbc->idev);
 920                         input_report_key(kbc->idev, kbc->wakeup_key, 0);
 921                         input_sync(kbc->idev);
 922                 }
 923         } else {
 924                 if (kbc->idev->users)
 925                         err = tegra_kbc_start(kbc);
 926         }
 927         mutex_unlock(&kbc->idev->mutex);
 928
 929         return err;
 930 }
 931 #endif
 932
 933 static SIMPLE_DEV_PM_OPS(tegra_kbc_pm_ops, tegra_kbc_suspend, tegra_kbc_resume);
 934
 935 static const struct of_device_id tegra_kbc_of_match[] = {
 936         { .compatible = "nvidia,tegra20-kbc", },
 937         { },
 938 };
 939 MODULE_DEVICE_TABLE(of, tegra_kbc_of_match);
 940
 941 static struct platform_driver tegra_kbc_driver = {
 942         .probe          = tegra_kbc_probe,
 943         .remove         = __devexit_p(tegra_kbc_remove),
 944         .driver = {
 945                 .name   = "tegra-kbc",
 946                 .owner  = THIS_MODULE,
 947                 .pm     = &tegra_kbc_pm_ops,
 948                 .of_match_table = tegra_kbc_of_match,
 949         },
 950 };
 951 module_platform_driver(tegra_kbc_driver);
 952
 953 MODULE_LICENSE("GPL");
 954 MODULE_AUTHOR("Rakesh Iyer <riyer@nvidia.com>");
 955 MODULE_DESCRIPTION("Tegra matrix keyboard controller driver");
 956 MODULE_ALIAS("platform:tegra-kbc");