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/of_device.h>
  31 #include <linux/clk.h>
  32 #include <linux/slab.h>
  33 #include <linux/input/matrix_keypad.h>
  34 #include <linux/reset.h>
  35 #include <linux/err.h>
  36
  37 #define KBC_MAX_KPENT   8
  38
  39 /* Maximum row/column supported by Tegra KBC yet  is 16x8 */
  40 #define KBC_MAX_GPIO    24
  41 /* Maximum keys supported by Tegra KBC yet is 16 x 8*/
  42 #define KBC_MAX_KEY     (16 * 8)
  43
  44 #define KBC_MAX_DEBOUNCE_CNT    0x3ffu
  45
  46 /* KBC row scan time and delay for beginning the row scan. */
  47 #define KBC_ROW_SCAN_TIME       16
  48 #define KBC_ROW_SCAN_DLY        5
  49
  50 /* KBC uses a 32KHz clock so a cycle = 1/32Khz */
  51 #define KBC_CYCLE_MS    32
  52
  53 /* KBC Registers */
  54
  55 /* KBC Control Register */
  56 #define KBC_CONTROL_0   0x0
  57 #define KBC_FIFO_TH_CNT_SHIFT(cnt)      (cnt << 14)
  58 #define KBC_DEBOUNCE_CNT_SHIFT(cnt)     (cnt << 4)
  59 #define KBC_CONTROL_FIFO_CNT_INT_EN     (1 << 3)
  60 #define KBC_CONTROL_KEYPRESS_INT_EN     (1 << 1)
  61 #define KBC_CONTROL_KBC_EN              (1 << 0)
  62
  63 /* KBC Interrupt Register */
  64 #define KBC_INT_0       0x4
  65 #define KBC_INT_FIFO_CNT_INT_STATUS     (1 << 2)
  66 #define KBC_INT_KEYPRESS_INT_STATUS     (1 << 0)
  67
  68 #define KBC_ROW_CFG0_0  0x8
  69 #define KBC_COL_CFG0_0  0x18
  70 #define KBC_TO_CNT_0    0x24
  71 #define KBC_INIT_DLY_0  0x28
  72 #define KBC_RPT_DLY_0   0x2c
  73 #define KBC_KP_ENT0_0   0x30
  74 #define KBC_KP_ENT1_0   0x34
  75 #define KBC_ROW0_MASK_0 0x38
  76
  77 #define KBC_ROW_SHIFT   3
  78
  79 enum tegra_pin_type {
  80         PIN_CFG_IGNORE,
  81         PIN_CFG_COL,
  82         PIN_CFG_ROW,
  83 };
  84
  85 /* Tegra KBC hw support */
  86 struct tegra_kbc_hw_support {
  87         int max_rows;
  88         int max_columns;
  89 };
  90
  91 struct tegra_kbc_pin_cfg {
  92         enum tegra_pin_type type;
  93         unsigned char num;
  94 };
  95
  96 struct tegra_kbc {
  97         struct device *dev;
  98         unsigned int debounce_cnt;
  99         unsigned int repeat_cnt;
 100         struct tegra_kbc_pin_cfg pin_cfg[KBC_MAX_GPIO];
 101         const struct matrix_keymap_data *keymap_data;
 102         bool wakeup;
 103         void __iomem *mmio;
 104         struct input_dev *idev;
 105         int irq;
 106         spinlock_t lock;
 107         unsigned int repoll_dly;
 108         unsigned long cp_dly_jiffies;
 109         unsigned int cp_to_wkup_dly;
 110         bool use_fn_map;
 111         bool use_ghost_filter;
 112         bool keypress_caused_wake;
 113         unsigned short keycode[KBC_MAX_KEY * 2];
 114         unsigned short current_keys[KBC_MAX_KPENT];
 115         unsigned int num_pressed_keys;
 116         u32 wakeup_key;
 117         struct timer_list timer;
 118         struct clk *clk;
 119         struct reset_control *rst;
 120         const struct tegra_kbc_hw_support *hw_support;
 121         int max_keys;
 122         int num_rows_and_columns;
 123 };
 124
 125 static void tegra_kbc_report_released_keys(struct input_dev *input,
 126                                            unsigned short old_keycodes[],
 127                                            unsigned int old_num_keys,
 128                                            unsigned short new_keycodes[],
 129                                            unsigned int new_num_keys)
 130 {
 131         unsigned int i, j;
 132
 133         for (i = 0; i < old_num_keys; i++) {
 134                 for (j = 0; j < new_num_keys; j++)
 135                         if (old_keycodes[i] == new_keycodes[j])
 136                                 break;
 137
 138                 if (j == new_num_keys)
 139                         input_report_key(input, old_keycodes[i], 0);
 140         }
 141 }
 142
 143 static void tegra_kbc_report_pressed_keys(struct input_dev *input,
 144                                           unsigned char scancodes[],
 145                                           unsigned short keycodes[],
 146                                           unsigned int num_pressed_keys)
 147 {
 148         unsigned int i;
 149
 150         for (i = 0; i < num_pressed_keys; i++) {
 151                 input_event(input, EV_MSC, MSC_SCAN, scancodes[i]);
 152                 input_report_key(input, keycodes[i], 1);
 153         }
 154 }
 155
 156 static void tegra_kbc_report_keys(struct tegra_kbc *kbc)
 157 {
 158         unsigned char scancodes[KBC_MAX_KPENT];
 159         unsigned short keycodes[KBC_MAX_KPENT];
 160         u32 val = 0;
 161         unsigned int i;
 162         unsigned int num_down = 0;
 163         bool fn_keypress = false;
 164         bool key_in_same_row = false;
 165         bool key_in_same_col = false;
 166
 167         for (i = 0; i < KBC_MAX_KPENT; i++) {
 168                 if ((i % 4) == 0)
 169                         val = readl(kbc->mmio + KBC_KP_ENT0_0 + i);
 170
 171                 if (val & 0x80) {
 172                         unsigned int col = val & 0x07;
 173                         unsigned int row = (val >> 3) & 0x0f;
 174                         unsigned char scancode =
 175                                 MATRIX_SCAN_CODE(row, col, KBC_ROW_SHIFT);
 176
 177                         scancodes[num_down] = scancode;
 178                         keycodes[num_down] = kbc->keycode[scancode];
 179                         /* If driver uses Fn map, do not report the Fn key. */
 180                         if ((keycodes[num_down] == KEY_FN) && kbc->use_fn_map)
 181                                 fn_keypress = true;
 182                         else
 183                                 num_down++;
 184                 }
 185
 186                 val >>= 8;
 187         }
 188
 189         /*
 190          * Matrix keyboard designs are prone to keyboard ghosting.
 191          * Ghosting occurs if there are 3 keys such that -
 192          * any 2 of the 3 keys share a row, and any 2 of them share a column.
 193          * If so ignore the key presses for this iteration.
 194          */
 195         if (kbc->use_ghost_filter && num_down >= 3) {
 196                 for (i = 0; i < num_down; i++) {
 197                         unsigned int j;
 198                         u8 curr_col = scancodes[i] & 0x07;
 199                         u8 curr_row = scancodes[i] >> KBC_ROW_SHIFT;
 200
 201                         /*
 202                          * Find 2 keys such that one key is in the same row
 203                          * and the other is in the same column as the i-th key.
 204                          */
 205                         for (j = i + 1; j < num_down; j++) {
 206                                 u8 col = scancodes[j] & 0x07;
 207                                 u8 row = scancodes[j] >> KBC_ROW_SHIFT;
 208
 209                                 if (col == curr_col)
 210                                         key_in_same_col = true;
 211                                 if (row == curr_row)
 212                                         key_in_same_row = true;
 213                         }
 214                 }
 215         }
 216
 217         /*
 218          * If the platform uses Fn keymaps, translate keys on a Fn keypress.
 219          * Function keycodes are max_keys apart from the plain keycodes.
 220          */
 221         if (fn_keypress) {
 222                 for (i = 0; i < num_down; i++) {
 223                         scancodes[i] += kbc->max_keys;
 224                         keycodes[i] = kbc->keycode[scancodes[i]];
 225                 }
 226         }
 227
 228         /* Ignore the key presses for this iteration? */
 229         if (key_in_same_col && key_in_same_row)
 230                 return;
 231
 232         tegra_kbc_report_released_keys(kbc->idev,
 233                                        kbc->current_keys, kbc->num_pressed_keys,
 234                                        keycodes, num_down);
 235         tegra_kbc_report_pressed_keys(kbc->idev, scancodes, keycodes, num_down);
 236         input_sync(kbc->idev);
 237
 238         memcpy(kbc->current_keys, keycodes, sizeof(kbc->current_keys));
 239         kbc->num_pressed_keys = num_down;
 240 }
 241
 242 static void tegra_kbc_set_fifo_interrupt(struct tegra_kbc *kbc, bool enable)
 243 {
 244         u32 val;
 245
 246         val = readl(kbc->mmio + KBC_CONTROL_0);
 247         if (enable)
 248                 val |= KBC_CONTROL_FIFO_CNT_INT_EN;
 249         else
 250                 val &= ~KBC_CONTROL_FIFO_CNT_INT_EN;
 251         writel(val, kbc->mmio + KBC_CONTROL_0);
 252 }
 253
 254 static void tegra_kbc_keypress_timer(unsigned long data)
 255 {
 256         struct tegra_kbc *kbc = (struct tegra_kbc *)data;
 257         unsigned long flags;
 258         u32 val;
 259         unsigned int i;
 260
 261         spin_lock_irqsave(&kbc->lock, flags);
 262
 263         val = (readl(kbc->mmio + KBC_INT_0) >> 4) & 0xf;
 264         if (val) {
 265                 unsigned long dly;
 266
 267                 tegra_kbc_report_keys(kbc);
 268
 269                 /*
 270                  * If more than one keys are pressed we need not wait
 271                  * for the repoll delay.
 272                  */
 273                 dly = (val == 1) ? kbc->repoll_dly : 1;
 274                 mod_timer(&kbc->timer, jiffies + msecs_to_jiffies(dly));
 275         } else {
 276                 /* Release any pressed keys and exit the polling loop */
 277                 for (i = 0; i < kbc->num_pressed_keys; i++)
 278                         input_report_key(kbc->idev, kbc->current_keys[i], 0);
 279                 input_sync(kbc->idev);
 280
 281                 kbc->num_pressed_keys = 0;
 282
 283                 /* All keys are released so enable the keypress interrupt */
 284                 tegra_kbc_set_fifo_interrupt(kbc, true);
 285         }
 286
 287         spin_unlock_irqrestore(&kbc->lock, flags);
 288 }
 289
 290 static irqreturn_t tegra_kbc_isr(int irq, void *args)
 291 {
 292         struct tegra_kbc *kbc = args;
 293         unsigned long flags;
 294         u32 val;
 295
 296         spin_lock_irqsave(&kbc->lock, flags);
 297
 298         /*
 299          * Quickly bail out & reenable interrupts if the fifo threshold
 300          * count interrupt wasn't the interrupt source
 301          */
 302         val = readl(kbc->mmio + KBC_INT_0);
 303         writel(val, kbc->mmio + KBC_INT_0);
 304
 305         if (val & KBC_INT_FIFO_CNT_INT_STATUS) {
 306                 /*
 307                  * Until all keys are released, defer further processing to
 308                  * the polling loop in tegra_kbc_keypress_timer.
 309                  */
 310                 tegra_kbc_set_fifo_interrupt(kbc, false);
 311                 mod_timer(&kbc->timer, jiffies + kbc->cp_dly_jiffies);
 312         } else if (val & KBC_INT_KEYPRESS_INT_STATUS) {
 313                 /* We can be here only through system resume path */
 314                 kbc->keypress_caused_wake = true;
 315         }
 316
 317         spin_unlock_irqrestore(&kbc->lock, flags);
 318
 319         return IRQ_HANDLED;
 320 }
 321
 322 static void tegra_kbc_setup_wakekeys(struct tegra_kbc *kbc, bool filter)
 323 {
 324         int i;
 325         unsigned int rst_val;
 326
 327         /* Either mask all keys or none. */
 328         rst_val = (filter && !kbc->wakeup) ? ~0 : 0;
 329
 330         for (i = 0; i < kbc->hw_support->max_rows; i++)
 331                 writel(rst_val, kbc->mmio + KBC_ROW0_MASK_0 + i * 4);
 332 }
 333
 334 static void tegra_kbc_config_pins(struct tegra_kbc *kbc)
 335 {
 336         int i;
 337
 338         for (i = 0; i < KBC_MAX_GPIO; i++) {
 339                 u32 r_shft = 5 * (i % 6);
 340                 u32 c_shft = 4 * (i % 8);
 341                 u32 r_mask = 0x1f << r_shft;
 342                 u32 c_mask = 0x0f << c_shft;
 343                 u32 r_offs = (i / 6) * 4 + KBC_ROW_CFG0_0;
 344                 u32 c_offs = (i / 8) * 4 + KBC_COL_CFG0_0;
 345                 u32 row_cfg = readl(kbc->mmio + r_offs);
 346                 u32 col_cfg = readl(kbc->mmio + c_offs);
 347
 348                 row_cfg &= ~r_mask;
 349                 col_cfg &= ~c_mask;
 350
 351                 switch (kbc->pin_cfg[i].type) {
 352                 case PIN_CFG_ROW:
 353                         row_cfg |= ((kbc->pin_cfg[i].num << 1) | 1) << r_shft;
 354                         break;
 355
 356                 case PIN_CFG_COL:
 357                         col_cfg |= ((kbc->pin_cfg[i].num << 1) | 1) << c_shft;
 358                         break;
 359
 360                 case PIN_CFG_IGNORE:
 361                         break;
 362                 }
 363
 364                 writel(row_cfg, kbc->mmio + r_offs);
 365                 writel(col_cfg, kbc->mmio + c_offs);
 366         }
 367 }
 368
 369 static int tegra_kbc_start(struct tegra_kbc *kbc)
 370 {
 371         unsigned int debounce_cnt;
 372         u32 val = 0;
 373
 374         clk_prepare_enable(kbc->clk);
 375
 376         /* Reset the KBC controller to clear all previous status.*/
 377         reset_control_assert(kbc->rst);
 378         udelay(100);
 379         reset_control_assert(kbc->rst);
 380         udelay(100);
 381
 382         tegra_kbc_config_pins(kbc);
 383         tegra_kbc_setup_wakekeys(kbc, false);
 384
 385         writel(kbc->repeat_cnt, kbc->mmio + KBC_RPT_DLY_0);
 386
 387         /* Keyboard debounce count is maximum of 12 bits. */
 388         debounce_cnt = min(kbc->debounce_cnt, KBC_MAX_DEBOUNCE_CNT);
 389         val = KBC_DEBOUNCE_CNT_SHIFT(debounce_cnt);
 390         val |= KBC_FIFO_TH_CNT_SHIFT(1); /* set fifo interrupt threshold to 1 */
 391         val |= KBC_CONTROL_FIFO_CNT_INT_EN;  /* interrupt on FIFO threshold */
 392         val |= KBC_CONTROL_KBC_EN;     /* enable */
 393         writel(val, kbc->mmio + KBC_CONTROL_0);
 394
 395         /*
 396          * Compute the delay(ns) from interrupt mode to continuous polling
 397          * mode so the timer routine is scheduled appropriately.
 398          */
 399         val = readl(kbc->mmio + KBC_INIT_DLY_0);
 400         kbc->cp_dly_jiffies = usecs_to_jiffies((val & 0xfffff) * 32);
 401
 402         kbc->num_pressed_keys = 0;
 403
 404         /*
 405          * Atomically clear out any remaining entries in the key FIFO
 406          * and enable keyboard interrupts.
 407          */
 408         while (1) {
 409                 val = readl(kbc->mmio + KBC_INT_0);
 410                 val >>= 4;
 411                 if (!val)
 412                         break;
 413
 414                 val = readl(kbc->mmio + KBC_KP_ENT0_0);
 415                 val = readl(kbc->mmio + KBC_KP_ENT1_0);
 416         }
 417         writel(0x7, kbc->mmio + KBC_INT_0);
 418
 419         enable_irq(kbc->irq);
 420
 421         return 0;
 422 }
 423
 424 static void tegra_kbc_stop(struct tegra_kbc *kbc)
 425 {
 426         unsigned long flags;
 427         u32 val;
 428
 429         spin_lock_irqsave(&kbc->lock, flags);
 430         val = readl(kbc->mmio + KBC_CONTROL_0);
 431         val &= ~1;
 432         writel(val, kbc->mmio + KBC_CONTROL_0);
 433         spin_unlock_irqrestore(&kbc->lock, flags);
 434
 435         disable_irq(kbc->irq);
 436         del_timer_sync(&kbc->timer);
 437
 438         clk_disable_unprepare(kbc->clk);
 439 }
 440
 441 static int tegra_kbc_open(struct input_dev *dev)
 442 {
 443         struct tegra_kbc *kbc = input_get_drvdata(dev);
 444
 445         return tegra_kbc_start(kbc);
 446 }
 447
 448 static void tegra_kbc_close(struct input_dev *dev)
 449 {
 450         struct tegra_kbc *kbc = input_get_drvdata(dev);
 451
 452         return tegra_kbc_stop(kbc);
 453 }
 454
 455 static bool tegra_kbc_check_pin_cfg(const struct tegra_kbc *kbc,
 456                                         unsigned int *num_rows)
 457 {
 458         int i;
 459
 460         *num_rows = 0;
 461
 462         for (i = 0; i < KBC_MAX_GPIO; i++) {
 463                 const struct tegra_kbc_pin_cfg *pin_cfg = &kbc->pin_cfg[i];
 464
 465                 switch (pin_cfg->type) {
 466                 case PIN_CFG_ROW:
 467                         if (pin_cfg->num >= kbc->hw_support->max_rows) {
 468                                 dev_err(kbc->dev,
 469                                         "pin_cfg[%d]: invalid row number %d\n",
 470                                         i, pin_cfg->num);
 471                                 return false;
 472                         }
 473                         (*num_rows)++;
 474                         break;
 475
 476                 case PIN_CFG_COL:
 477                         if (pin_cfg->num >= kbc->hw_support->max_columns) {
 478                                 dev_err(kbc->dev,
 479                                         "pin_cfg[%d]: invalid column number %d\n",
 480                                         i, pin_cfg->num);
 481                                 return false;
 482                         }
 483                         break;
 484
 485                 case PIN_CFG_IGNORE:
 486                         break;
 487
 488                 default:
 489                         dev_err(kbc->dev,
 490                                 "pin_cfg[%d]: invalid entry type %d\n",
 491                                 pin_cfg->type, pin_cfg->num);
 492                         return false;
 493                 }
 494         }
 495
 496         return true;
 497 }
 498
 499 static int tegra_kbc_parse_dt(struct tegra_kbc *kbc)
 500 {
 501         struct device_node *np = kbc->dev->of_node;
 502         u32 prop;
 503         int i;
 504         u32 num_rows = 0;
 505         u32 num_cols = 0;
 506         u32 cols_cfg[KBC_MAX_GPIO];
 507         u32 rows_cfg[KBC_MAX_GPIO];
 508         int proplen;
 509         int ret;
 510
 511         if (!of_property_read_u32(np, "nvidia,debounce-delay-ms", &prop))
 512                 kbc->debounce_cnt = prop;
 513
 514         if (!of_property_read_u32(np, "nvidia,repeat-delay-ms", &prop))
 515                 kbc->repeat_cnt = prop;
 516
 517         if (of_find_property(np, "nvidia,needs-ghost-filter", NULL))
 518                 kbc->use_ghost_filter = true;
 519
 520         if (of_find_property(np, "nvidia,wakeup-source", NULL))
 521                 kbc->wakeup = true;
 522
 523         if (!of_get_property(np, "nvidia,kbc-row-pins", &proplen)) {
 524                 dev_err(kbc->dev, "property nvidia,kbc-row-pins not found\n");
 525                 return -ENOENT;
 526         }
 527         num_rows = proplen / sizeof(u32);
 528
 529         if (!of_get_property(np, "nvidia,kbc-col-pins", &proplen)) {
 530                 dev_err(kbc->dev, "property nvidia,kbc-col-pins not found\n");
 531                 return -ENOENT;
 532         }
 533         num_cols = proplen / sizeof(u32);
 534
 535         if (num_rows > kbc->hw_support->max_rows) {
 536                 dev_err(kbc->dev,
 537                         "Number of rows is more than supported by hardware\n");
 538                 return -EINVAL;
 539         }
 540
 541         if (num_cols > kbc->hw_support->max_columns) {
 542                 dev_err(kbc->dev,
 543                         "Number of cols is more than supported by hardware\n");
 544                 return -EINVAL;
 545         }
 546
 547         if (!of_get_property(np, "linux,keymap", &proplen)) {
 548                 dev_err(kbc->dev, "property linux,keymap not found\n");
 549                 return -ENOENT;
 550         }
 551
 552         if (!num_rows || !num_cols || ((num_rows + num_cols) > KBC_MAX_GPIO)) {
 553                 dev_err(kbc->dev,
 554                         "keypad rows/columns not porperly specified\n");
 555                 return -EINVAL;
 556         }
 557
 558         /* Set all pins as non-configured */
 559         for (i = 0; i < kbc->num_rows_and_columns; i++)
 560                 kbc->pin_cfg[i].type = PIN_CFG_IGNORE;
 561
 562         ret = of_property_read_u32_array(np, "nvidia,kbc-row-pins",
 563                                 rows_cfg, num_rows);
 564         if (ret < 0) {
 565                 dev_err(kbc->dev, "Rows configurations are not proper\n");
 566                 return -EINVAL;
 567         }
 568
 569         ret = of_property_read_u32_array(np, "nvidia,kbc-col-pins",
 570                                 cols_cfg, num_cols);
 571         if (ret < 0) {
 572                 dev_err(kbc->dev, "Cols configurations are not proper\n");
 573                 return -EINVAL;
 574         }
 575
 576         for (i = 0; i < num_rows; i++) {
 577                 kbc->pin_cfg[rows_cfg[i]].type = PIN_CFG_ROW;
 578                 kbc->pin_cfg[rows_cfg[i]].num = i;
 579         }
 580
 581         for (i = 0; i < num_cols; i++) {
 582                 kbc->pin_cfg[cols_cfg[i]].type = PIN_CFG_COL;
 583                 kbc->pin_cfg[cols_cfg[i]].num = i;
 584         }
 585
 586         return 0;
 587 }
 588
 589 static const struct tegra_kbc_hw_support tegra20_kbc_hw_support = {
 590         .max_rows       = 16,
 591         .max_columns    = 8,
 592 };
 593
 594 static const struct tegra_kbc_hw_support tegra11_kbc_hw_support = {
 595         .max_rows       = 11,
 596         .max_columns    = 8,
 597 };
 598
 599 static const struct of_device_id tegra_kbc_of_match[] = {
 600         { .compatible = "nvidia,tegra114-kbc", .data = &tegra11_kbc_hw_support},
 601         { .compatible = "nvidia,tegra30-kbc", .data = &tegra20_kbc_hw_support},
 602         { .compatible = "nvidia,tegra20-kbc", .data = &tegra20_kbc_hw_support},
 603         { },
 604 };
 605 MODULE_DEVICE_TABLE(of, tegra_kbc_of_match);
 606
 607 static int tegra_kbc_probe(struct platform_device *pdev)
 608 {
 609         struct tegra_kbc *kbc;
 610         struct resource *res;
 611         int err;
 612         int num_rows = 0;
 613         unsigned int debounce_cnt;
 614         unsigned int scan_time_rows;
 615         unsigned int keymap_rows;
 616         const struct of_device_id *match;
 617
 618         match = of_match_device(tegra_kbc_of_match, &pdev->dev);
 619
 620         kbc = devm_kzalloc(&pdev->dev, sizeof(*kbc), GFP_KERNEL);
 621         if (!kbc) {
 622                 dev_err(&pdev->dev, "failed to alloc memory for kbc\n");
 623                 return -ENOMEM;
 624         }
 625
 626         kbc->dev = &pdev->dev;
 627         kbc->hw_support = match->data;
 628         kbc->max_keys = kbc->hw_support->max_rows *
 629                                 kbc->hw_support->max_columns;
 630         kbc->num_rows_and_columns = kbc->hw_support->max_rows +
 631                                         kbc->hw_support->max_columns;
 632         keymap_rows = kbc->max_keys;
 633         spin_lock_init(&kbc->lock);
 634
 635         err = tegra_kbc_parse_dt(kbc);
 636         if (err)
 637                 return err;
 638
 639         if (!tegra_kbc_check_pin_cfg(kbc, &num_rows))
 640                 return -EINVAL;
 641
 642         kbc->irq = platform_get_irq(pdev, 0);
 643         if (kbc->irq < 0) {
 644                 dev_err(&pdev->dev, "failed to get keyboard IRQ\n");
 645                 return -ENXIO;
 646         }
 647
 648         kbc->idev = devm_input_allocate_device(&pdev->dev);
 649         if (!kbc->idev) {
 650                 dev_err(&pdev->dev, "failed to allocate input device\n");
 651                 return -ENOMEM;
 652         }
 653
 654         setup_timer(&kbc->timer, tegra_kbc_keypress_timer, (unsigned long)kbc);
 655
 656         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 657         kbc->mmio = devm_ioremap_resource(&pdev->dev, res);
 658         if (IS_ERR(kbc->mmio))
 659                 return PTR_ERR(kbc->mmio);
 660
 661         kbc->clk = devm_clk_get(&pdev->dev, NULL);
 662         if (IS_ERR(kbc->clk)) {
 663                 dev_err(&pdev->dev, "failed to get keyboard clock\n");
 664                 return PTR_ERR(kbc->clk);
 665         }
 666
 667         kbc->rst = devm_reset_control_get(&pdev->dev, "kbc");
 668         if (IS_ERR(kbc->rst)) {
 669                 dev_err(&pdev->dev, "failed to get keyboard reset\n");
 670                 return PTR_ERR(kbc->rst);
 671         }
 672
 673         /*
 674          * The time delay between two consecutive reads of the FIFO is
 675          * the sum of the repeat time and the time taken for scanning
 676          * the rows. There is an additional delay before the row scanning
 677          * starts. The repoll delay is computed in milliseconds.
 678          */
 679         debounce_cnt = min(kbc->debounce_cnt, KBC_MAX_DEBOUNCE_CNT);
 680         scan_time_rows = (KBC_ROW_SCAN_TIME + debounce_cnt) * num_rows;
 681         kbc->repoll_dly = KBC_ROW_SCAN_DLY + scan_time_rows + kbc->repeat_cnt;
 682         kbc->repoll_dly = DIV_ROUND_UP(kbc->repoll_dly, KBC_CYCLE_MS);
 683
 684         kbc->idev->name = pdev->name;
 685         kbc->idev->id.bustype = BUS_HOST;
 686         kbc->idev->dev.parent = &pdev->dev;
 687         kbc->idev->open = tegra_kbc_open;
 688         kbc->idev->close = tegra_kbc_close;
 689
 690         if (kbc->keymap_data && kbc->use_fn_map)
 691                 keymap_rows *= 2;
 692
 693         err = matrix_keypad_build_keymap(kbc->keymap_data, NULL,
 694                                          keymap_rows,
 695                                          kbc->hw_support->max_columns,
 696                                          kbc->keycode, kbc->idev);
 697         if (err) {
 698                 dev_err(&pdev->dev, "failed to setup keymap\n");
 699                 return err;
 700         }
 701
 702         __set_bit(EV_REP, kbc->idev->evbit);
 703         input_set_capability(kbc->idev, EV_MSC, MSC_SCAN);
 704
 705         input_set_drvdata(kbc->idev, kbc);
 706
 707         err = devm_request_irq(&pdev->dev, kbc->irq, tegra_kbc_isr,
 708                           IRQF_NO_SUSPEND | IRQF_TRIGGER_HIGH, pdev->name, kbc);
 709         if (err) {
 710                 dev_err(&pdev->dev, "failed to request keyboard IRQ\n");
 711                 return err;
 712         }
 713
 714         disable_irq(kbc->irq);
 715
 716         err = input_register_device(kbc->idev);
 717         if (err) {
 718                 dev_err(&pdev->dev, "failed to register input device\n");
 719                 return err;
 720         }
 721
 722         platform_set_drvdata(pdev, kbc);
 723         device_init_wakeup(&pdev->dev, kbc->wakeup);
 724
 725         return 0;
 726 }
 727
 728 #ifdef CONFIG_PM_SLEEP
 729 static void tegra_kbc_set_keypress_interrupt(struct tegra_kbc *kbc, bool enable)
 730 {
 731         u32 val;
 732
 733         val = readl(kbc->mmio + KBC_CONTROL_0);
 734         if (enable)
 735                 val |= KBC_CONTROL_KEYPRESS_INT_EN;
 736         else
 737                 val &= ~KBC_CONTROL_KEYPRESS_INT_EN;
 738         writel(val, kbc->mmio + KBC_CONTROL_0);
 739 }
 740
 741 static int tegra_kbc_suspend(struct device *dev)
 742 {
 743         struct platform_device *pdev = to_platform_device(dev);
 744         struct tegra_kbc *kbc = platform_get_drvdata(pdev);
 745
 746         mutex_lock(&kbc->idev->mutex);
 747         if (device_may_wakeup(&pdev->dev)) {
 748                 disable_irq(kbc->irq);
 749                 del_timer_sync(&kbc->timer);
 750                 tegra_kbc_set_fifo_interrupt(kbc, false);
 751
 752                 /* Forcefully clear the interrupt status */
 753                 writel(0x7, kbc->mmio + KBC_INT_0);
 754                 /*
 755                  * Store the previous resident time of continuous polling mode.
 756                  * Force the keyboard into interrupt mode.
 757                  */
 758                 kbc->cp_to_wkup_dly = readl(kbc->mmio + KBC_TO_CNT_0);
 759                 writel(0, kbc->mmio + KBC_TO_CNT_0);
 760
 761                 tegra_kbc_setup_wakekeys(kbc, true);
 762                 msleep(30);
 763
 764                 kbc->keypress_caused_wake = false;
 765                 /* Enable keypress interrupt before going into suspend. */
 766                 tegra_kbc_set_keypress_interrupt(kbc, true);
 767                 enable_irq(kbc->irq);
 768                 enable_irq_wake(kbc->irq);
 769         } else {
 770                 if (kbc->idev->users)
 771                         tegra_kbc_stop(kbc);
 772         }
 773         mutex_unlock(&kbc->idev->mutex);
 774
 775         return 0;
 776 }
 777
 778 static int tegra_kbc_resume(struct device *dev)
 779 {
 780         struct platform_device *pdev = to_platform_device(dev);
 781         struct tegra_kbc *kbc = platform_get_drvdata(pdev);
 782         int err = 0;
 783
 784         mutex_lock(&kbc->idev->mutex);
 785         if (device_may_wakeup(&pdev->dev)) {
 786                 disable_irq_wake(kbc->irq);
 787                 tegra_kbc_setup_wakekeys(kbc, false);
 788                 /* We will use fifo interrupts for key detection. */
 789                 tegra_kbc_set_keypress_interrupt(kbc, false);
 790
 791                 /* Restore the resident time of continuous polling mode. */
 792                 writel(kbc->cp_to_wkup_dly, kbc->mmio + KBC_TO_CNT_0);
 793
 794                 tegra_kbc_set_fifo_interrupt(kbc, true);
 795
 796                 if (kbc->keypress_caused_wake && kbc->wakeup_key) {
 797                         /*
 798                          * We can't report events directly from the ISR
 799                          * because timekeeping is stopped when processing
 800                          * wakeup request and we get a nasty warning when
 801                          * we try to call do_gettimeofday() in evdev
 802                          * handler.
 803                          */
 804                         input_report_key(kbc->idev, kbc->wakeup_key, 1);
 805                         input_sync(kbc->idev);
 806                         input_report_key(kbc->idev, kbc->wakeup_key, 0);
 807                         input_sync(kbc->idev);
 808                 }
 809         } else {
 810                 if (kbc->idev->users)
 811                         err = tegra_kbc_start(kbc);
 812         }
 813         mutex_unlock(&kbc->idev->mutex);
 814
 815         return err;
 816 }
 817 #endif
 818
 819 static SIMPLE_DEV_PM_OPS(tegra_kbc_pm_ops, tegra_kbc_suspend, tegra_kbc_resume);
 820
 821 static struct platform_driver tegra_kbc_driver = {
 822         .probe          = tegra_kbc_probe,
 823         .driver = {
 824                 .name   = "tegra-kbc",
 825                 .pm     = &tegra_kbc_pm_ops,
 826                 .of_match_table = tegra_kbc_of_match,
 827         },
 828 };
 829 module_platform_driver(tegra_kbc_driver);
 830
 831 MODULE_LICENSE("GPL");
 832 MODULE_AUTHOR("Rakesh Iyer <riyer@nvidia.com>");
 833 MODULE_DESCRIPTION("Tegra matrix keyboard controller driver");
 834 MODULE_ALIAS("platform:tegra-kbc");