drivers/input/keyboard/omap4-keypad.c

   1 /*
   2  * OMAP4 Keypad Driver
   3  *
   4  * Copyright (C) 2010 Texas Instruments
   5  *
   6  * Author: Abraham Arce <x0066660@ti.com>
   7  * Initial Code: Syed Rafiuddin <rafiuddin.syed@ti.com>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  22  */
  23
  24 #include <linux/module.h>
  25 #include <linux/interrupt.h>
  26 #include <linux/platform_device.h>
  27 #include <linux/errno.h>
  28 #include <linux/io.h>
  29 #include <linux/of.h>
  30 #include <linux/input.h>
  31 #include <linux/input/matrix_keypad.h>
  32 #include <linux/slab.h>
  33 #include <linux/pm_runtime.h>
  34
  35 /* OMAP4 registers */
  36 #define OMAP4_KBD_REVISION              0x00
  37 #define OMAP4_KBD_SYSCONFIG             0x10
  38 #define OMAP4_KBD_SYSSTATUS             0x14
  39 #define OMAP4_KBD_IRQSTATUS             0x18
  40 #define OMAP4_KBD_IRQENABLE             0x1C
  41 #define OMAP4_KBD_WAKEUPENABLE          0x20
  42 #define OMAP4_KBD_PENDING               0x24
  43 #define OMAP4_KBD_CTRL                  0x28
  44 #define OMAP4_KBD_DEBOUNCINGTIME        0x2C
  45 #define OMAP4_KBD_LONGKEYTIME           0x30
  46 #define OMAP4_KBD_TIMEOUT               0x34
  47 #define OMAP4_KBD_STATEMACHINE          0x38
  48 #define OMAP4_KBD_ROWINPUTS             0x3C
  49 #define OMAP4_KBD_COLUMNOUTPUTS         0x40
  50 #define OMAP4_KBD_FULLCODE31_0          0x44
  51 #define OMAP4_KBD_FULLCODE63_32         0x48
  52
  53 /* OMAP4 bit definitions */
  54 #define OMAP4_DEF_IRQENABLE_EVENTEN     BIT(0)
  55 #define OMAP4_DEF_IRQENABLE_LONGKEY     BIT(1)
  56 #define OMAP4_DEF_WUP_EVENT_ENA         BIT(0)
  57 #define OMAP4_DEF_WUP_LONG_KEY_ENA      BIT(1)
  58 #define OMAP4_DEF_CTRL_NOSOFTMODE       BIT(1)
  59 #define OMAP4_DEF_CTRL_PTV_SHIFT        2
  60
  61 /* OMAP4 values */
  62 #define OMAP4_VAL_IRQDISABLE            0x0
  63
  64 /*
  65  * Errata i689: If a key is released for a time shorter than debounce time,
  66  * the keyboard will idle and never detect the key release. The workaround
  67  * is to use at least a 12ms debounce time. See omap5432 TRM chapter
  68  * "26.4.6.2 Keyboard Controller Timer" for more information.
  69  */
  70 #define OMAP4_KEYPAD_PTV_DIV_128        0x6
  71 #define OMAP4_KEYPAD_DEBOUNCINGTIME_MS(dbms, ptv)     \
  72         ((((dbms) * 1000) / ((1 << ((ptv) + 1)) * (1000000 / 32768))) - 1)
  73 #define OMAP4_VAL_DEBOUNCINGTIME_16MS                                   \
  74         OMAP4_KEYPAD_DEBOUNCINGTIME_MS(16, OMAP4_KEYPAD_PTV_DIV_128)
  75
  76 enum {
  77         KBD_REVISION_OMAP4 = 0,
  78         KBD_REVISION_OMAP5,
  79 };
  80
  81 struct omap4_keypad {
  82         struct input_dev *input;
  83
  84         void __iomem *base;
  85         bool irq_wake_enabled;
  86         unsigned int irq;
  87
  88         unsigned int rows;
  89         unsigned int cols;
  90         u32 reg_offset;
  91         u32 irqreg_offset;
  92         unsigned int row_shift;
  93         bool no_autorepeat;
  94         unsigned char key_state[8];
  95         unsigned short *keymap;
  96 };
  97
  98 static int kbd_readl(struct omap4_keypad *keypad_data, u32 offset)
  99 {
 100         return __raw_readl(keypad_data->base +
 101                                 keypad_data->reg_offset + offset);
 102 }
 103
 104 static void kbd_writel(struct omap4_keypad *keypad_data, u32 offset, u32 value)
 105 {
 106         __raw_writel(value,
 107                      keypad_data->base + keypad_data->reg_offset + offset);
 108 }
 109
 110 static int kbd_read_irqreg(struct omap4_keypad *keypad_data, u32 offset)
 111 {
 112         return __raw_readl(keypad_data->base +
 113                                 keypad_data->irqreg_offset + offset);
 114 }
 115
 116 static void kbd_write_irqreg(struct omap4_keypad *keypad_data,
 117                              u32 offset, u32 value)
 118 {
 119         __raw_writel(value,
 120                      keypad_data->base + keypad_data->irqreg_offset + offset);
 121 }
 122
 123
 124 /* Interrupt handlers */
 125 static irqreturn_t omap4_keypad_irq_handler(int irq, void *dev_id)
 126 {
 127         struct omap4_keypad *keypad_data = dev_id;
 128
 129         if (kbd_read_irqreg(keypad_data, OMAP4_KBD_IRQSTATUS))
 130                 return IRQ_WAKE_THREAD;
 131
 132         return IRQ_NONE;
 133 }
 134
 135 static irqreturn_t omap4_keypad_irq_thread_fn(int irq, void *dev_id)
 136 {
 137         struct omap4_keypad *keypad_data = dev_id;
 138         struct input_dev *input_dev = keypad_data->input;
 139         unsigned char key_state[ARRAY_SIZE(keypad_data->key_state)];
 140         unsigned int col, row, code, changed;
 141         u32 *new_state = (u32 *) key_state;
 142
 143         *new_state = kbd_readl(keypad_data, OMAP4_KBD_FULLCODE31_0);
 144         *(new_state + 1) = kbd_readl(keypad_data, OMAP4_KBD_FULLCODE63_32);
 145
 146         for (row = 0; row < keypad_data->rows; row++) {
 147                 changed = key_state[row] ^ keypad_data->key_state[row];
 148                 if (!changed)
 149                         continue;
 150
 151                 for (col = 0; col < keypad_data->cols; col++) {
 152                         if (changed & (1 << col)) {
 153                                 code = MATRIX_SCAN_CODE(row, col,
 154                                                 keypad_data->row_shift);
 155                                 input_event(input_dev, EV_MSC, MSC_SCAN, code);
 156                                 input_report_key(input_dev,
 157                                                  keypad_data->keymap[code],
 158                                                  key_state[row] & (1 << col));
 159                         }
 160                 }
 161         }
 162
 163         input_sync(input_dev);
 164
 165         memcpy(keypad_data->key_state, key_state,
 166                 sizeof(keypad_data->key_state));
 167
 168         /* clear pending interrupts */
 169         kbd_write_irqreg(keypad_data, OMAP4_KBD_IRQSTATUS,
 170                          kbd_read_irqreg(keypad_data, OMAP4_KBD_IRQSTATUS));
 171
 172         return IRQ_HANDLED;
 173 }
 174
 175 static int omap4_keypad_open(struct input_dev *input)
 176 {
 177         struct omap4_keypad *keypad_data = input_get_drvdata(input);
 178
 179         pm_runtime_get_sync(input->dev.parent);
 180
 181         disable_irq(keypad_data->irq);
 182
 183         kbd_writel(keypad_data, OMAP4_KBD_CTRL,
 184                         OMAP4_DEF_CTRL_NOSOFTMODE |
 185                         (OMAP4_KEYPAD_PTV_DIV_128 << OMAP4_DEF_CTRL_PTV_SHIFT));
 186         kbd_writel(keypad_data, OMAP4_KBD_DEBOUNCINGTIME,
 187                         OMAP4_VAL_DEBOUNCINGTIME_16MS);
 188         /* clear pending interrupts */
 189         kbd_write_irqreg(keypad_data, OMAP4_KBD_IRQSTATUS,
 190                          kbd_read_irqreg(keypad_data, OMAP4_KBD_IRQSTATUS));
 191         kbd_write_irqreg(keypad_data, OMAP4_KBD_IRQENABLE,
 192                         OMAP4_DEF_IRQENABLE_EVENTEN |
 193                                 OMAP4_DEF_IRQENABLE_LONGKEY);
 194         kbd_writel(keypad_data, OMAP4_KBD_WAKEUPENABLE,
 195                         OMAP4_DEF_WUP_EVENT_ENA | OMAP4_DEF_WUP_LONG_KEY_ENA);
 196
 197         enable_irq(keypad_data->irq);
 198
 199         return 0;
 200 }
 201
 202 static void omap4_keypad_stop(struct omap4_keypad *keypad_data)
 203 {
 204         /* Disable interrupts and wake-up events */
 205         kbd_write_irqreg(keypad_data, OMAP4_KBD_IRQENABLE,
 206                          OMAP4_VAL_IRQDISABLE);
 207         kbd_writel(keypad_data, OMAP4_KBD_WAKEUPENABLE, 0);
 208
 209         /* clear pending interrupts */
 210         kbd_write_irqreg(keypad_data, OMAP4_KBD_IRQSTATUS,
 211                          kbd_read_irqreg(keypad_data, OMAP4_KBD_IRQSTATUS));
 212 }
 213
 214 static void omap4_keypad_close(struct input_dev *input)
 215 {
 216         struct omap4_keypad *keypad_data;
 217
 218         keypad_data = input_get_drvdata(input);
 219         disable_irq(keypad_data->irq);
 220         omap4_keypad_stop(keypad_data);
 221         enable_irq(keypad_data->irq);
 222
 223         pm_runtime_put_sync(input->dev.parent);
 224 }
 225
 226 static int omap4_keypad_parse_dt(struct device *dev,
 227                                  struct omap4_keypad *keypad_data)
 228 {
 229         struct device_node *np = dev->of_node;
 230         int err;
 231
 232         err = matrix_keypad_parse_properties(dev, &keypad_data->rows,
 233                                              &keypad_data->cols);
 234         if (err)
 235                 return err;
 236
 237         if (of_get_property(np, "linux,input-no-autorepeat", NULL))
 238                 keypad_data->no_autorepeat = true;
 239
 240         return 0;
 241 }
 242
 243 static int omap4_keypad_check_revision(struct device *dev,
 244                                        struct omap4_keypad *keypad_data)
 245 {
 246         unsigned int rev;
 247
 248         rev = __raw_readl(keypad_data->base + OMAP4_KBD_REVISION);
 249         rev &= 0x03 << 30;
 250         rev >>= 30;
 251         switch (rev) {
 252         case KBD_REVISION_OMAP4:
 253                 keypad_data->reg_offset = 0x00;
 254                 keypad_data->irqreg_offset = 0x00;
 255                 break;
 256         case KBD_REVISION_OMAP5:
 257                 keypad_data->reg_offset = 0x10;
 258                 keypad_data->irqreg_offset = 0x0c;
 259                 break;
 260         default:
 261                 dev_err(dev, "Keypad reports unsupported revision %d", rev);
 262                 return -EINVAL;
 263         }
 264
 265         return 0;
 266 }
 267
 268 static int omap4_keypad_probe(struct platform_device *pdev)
 269 {
 270         struct omap4_keypad *keypad_data;
 271         struct input_dev *input_dev;
 272         struct resource *res;
 273         unsigned int max_keys;
 274         int irq;
 275         int error;
 276
 277         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 278         if (!res) {
 279                 dev_err(&pdev->dev, "no base address specified\n");
 280                 return -EINVAL;
 281         }
 282
 283         irq = platform_get_irq(pdev, 0);
 284         if (irq < 0)
 285                 return irq;
 286
 287         keypad_data = kzalloc(sizeof(struct omap4_keypad), GFP_KERNEL);
 288         if (!keypad_data) {
 289                 dev_err(&pdev->dev, "keypad_data memory allocation failed\n");
 290                 return -ENOMEM;
 291         }
 292
 293         keypad_data->irq = irq;
 294
 295         error = omap4_keypad_parse_dt(&pdev->dev, keypad_data);
 296         if (error)
 297                 goto err_free_keypad;
 298
 299         res = request_mem_region(res->start, resource_size(res), pdev->name);
 300         if (!res) {
 301                 dev_err(&pdev->dev, "can't request mem region\n");
 302                 error = -EBUSY;
 303                 goto err_free_keypad;
 304         }
 305
 306         keypad_data->base = ioremap(res->start, resource_size(res));
 307         if (!keypad_data->base) {
 308                 dev_err(&pdev->dev, "can't ioremap mem resource\n");
 309                 error = -ENOMEM;
 310                 goto err_release_mem;
 311         }
 312
 313         pm_runtime_enable(&pdev->dev);
 314
 315         /*
 316          * Enable clocks for the keypad module so that we can read
 317          * revision register.
 318          */
 319         error = pm_runtime_get_sync(&pdev->dev);
 320         if (error) {
 321                 dev_err(&pdev->dev, "pm_runtime_get_sync() failed\n");
 322                 pm_runtime_put_noidle(&pdev->dev);
 323         } else {
 324                 error = omap4_keypad_check_revision(&pdev->dev,
 325                                                     keypad_data);
 326                 if (!error) {
 327                         /* Ensure device does not raise interrupts */
 328                         omap4_keypad_stop(keypad_data);
 329                 }
 330                 pm_runtime_put_sync(&pdev->dev);
 331         }
 332         if (error)
 333                 goto err_pm_disable;
 334
 335         /* input device allocation */
 336         keypad_data->input = input_dev = input_allocate_device();
 337         if (!input_dev) {
 338                 error = -ENOMEM;
 339                 goto err_pm_disable;
 340         }
 341
 342         input_dev->name = pdev->name;
 343         input_dev->dev.parent = &pdev->dev;
 344         input_dev->id.bustype = BUS_HOST;
 345         input_dev->id.vendor = 0x0001;
 346         input_dev->id.product = 0x0001;
 347         input_dev->id.version = 0x0001;
 348
 349         input_dev->open = omap4_keypad_open;
 350         input_dev->close = omap4_keypad_close;
 351
 352         input_set_capability(input_dev, EV_MSC, MSC_SCAN);
 353         if (!keypad_data->no_autorepeat)
 354                 __set_bit(EV_REP, input_dev->evbit);
 355
 356         input_set_drvdata(input_dev, keypad_data);
 357
 358         keypad_data->row_shift = get_count_order(keypad_data->cols);
 359         max_keys = keypad_data->rows << keypad_data->row_shift;
 360         keypad_data->keymap = kzalloc(max_keys * sizeof(keypad_data->keymap[0]),
 361                                       GFP_KERNEL);
 362         if (!keypad_data->keymap) {
 363                 dev_err(&pdev->dev, "Not enough memory for keymap\n");
 364                 error = -ENOMEM;
 365                 goto err_free_input;
 366         }
 367
 368         error = matrix_keypad_build_keymap(NULL, NULL,
 369                                            keypad_data->rows, keypad_data->cols,
 370                                            keypad_data->keymap, input_dev);
 371         if (error) {
 372                 dev_err(&pdev->dev, "failed to build keymap\n");
 373                 goto err_free_keymap;
 374         }
 375
 376         error = request_threaded_irq(keypad_data->irq, omap4_keypad_irq_handler,
 377                                      omap4_keypad_irq_thread_fn, IRQF_ONESHOT,
 378                                      "omap4-keypad", keypad_data);
 379         if (error) {
 380                 dev_err(&pdev->dev, "failed to register interrupt\n");
 381                 goto err_free_keymap;
 382         }
 383
 384         error = input_register_device(keypad_data->input);
 385         if (error < 0) {
 386                 dev_err(&pdev->dev, "failed to register input device\n");
 387                 goto err_free_irq;
 388         }
 389
 390         device_init_wakeup(&pdev->dev, true);
 391         platform_set_drvdata(pdev, keypad_data);
 392
 393         return 0;
 394
 395 err_free_irq:
 396         free_irq(keypad_data->irq, keypad_data);
 397 err_free_keymap:
 398         kfree(keypad_data->keymap);
 399 err_free_input:
 400         input_free_device(input_dev);
 401 err_pm_disable:
 402         pm_runtime_disable(&pdev->dev);
 403         iounmap(keypad_data->base);
 404 err_release_mem:
 405         release_mem_region(res->start, resource_size(res));
 406 err_free_keypad:
 407         kfree(keypad_data);
 408         return error;
 409 }
 410
 411 static int omap4_keypad_remove(struct platform_device *pdev)
 412 {
 413         struct omap4_keypad *keypad_data = platform_get_drvdata(pdev);
 414         struct resource *res;
 415
 416         free_irq(keypad_data->irq, keypad_data);
 417
 418         pm_runtime_disable(&pdev->dev);
 419
 420         input_unregister_device(keypad_data->input);
 421
 422         iounmap(keypad_data->base);
 423
 424         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 425         release_mem_region(res->start, resource_size(res));
 426
 427         kfree(keypad_data->keymap);
 428         kfree(keypad_data);
 429
 430         return 0;
 431 }
 432
 433 static const struct of_device_id omap_keypad_dt_match[] = {
 434         { .compatible = "ti,omap4-keypad" },
 435         {},
 436 };
 437 MODULE_DEVICE_TABLE(of, omap_keypad_dt_match);
 438
 439 #ifdef CONFIG_PM_SLEEP
 440 static int omap4_keypad_suspend(struct device *dev)
 441 {
 442         struct platform_device *pdev = to_platform_device(dev);
 443         struct omap4_keypad *keypad_data = platform_get_drvdata(pdev);
 444         int error;
 445
 446         if (device_may_wakeup(&pdev->dev)) {
 447                 error = enable_irq_wake(keypad_data->irq);
 448                 if (!error)
 449                         keypad_data->irq_wake_enabled = true;
 450         }
 451
 452         return 0;
 453 }
 454
 455 static int omap4_keypad_resume(struct device *dev)
 456 {
 457         struct platform_device *pdev = to_platform_device(dev);
 458         struct omap4_keypad *keypad_data = platform_get_drvdata(pdev);
 459
 460         if (device_may_wakeup(&pdev->dev) && keypad_data->irq_wake_enabled) {
 461                 disable_irq_wake(keypad_data->irq);
 462                 keypad_data->irq_wake_enabled = false;
 463         }
 464
 465         return 0;
 466 }
 467 #endif
 468
 469 static SIMPLE_DEV_PM_OPS(omap4_keypad_pm_ops,
 470                          omap4_keypad_suspend, omap4_keypad_resume);
 471
 472 static struct platform_driver omap4_keypad_driver = {
 473         .probe          = omap4_keypad_probe,
 474         .remove         = omap4_keypad_remove,
 475         .driver         = {
 476                 .name   = "omap4-keypad",
 477                 .pm     = &omap4_keypad_pm_ops,
 478                 .of_match_table = omap_keypad_dt_match,
 479         },
 480 };
 481 module_platform_driver(omap4_keypad_driver);
 482
 483 MODULE_AUTHOR("Texas Instruments");
 484 MODULE_DESCRIPTION("OMAP4 Keypad Driver");
 485 MODULE_LICENSE("GPL");
 486 MODULE_ALIAS("platform:omap4-keypad");