drivers/input/keyboard/corgikbd.c

   1 /*
   2  *  Keyboard driver for Sharp Corgi models (SL-C7xx)
   3  *
   4  *  Copyright (c) 2004-2005 Richard Purdie
   5  *
   6  *  Based on xtkbd.c/locomkbd.c
   7  *
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License version 2 as
  10  *  published by the Free Software Foundation.
  11  *
  12  */
  13
  14 #include <linux/delay.h>
  15 #include <linux/platform_device.h>
  16 #include <linux/init.h>
  17 #include <linux/input.h>
  18 #include <linux/interrupt.h>
  19 #include <linux/jiffies.h>
  20 #include <linux/module.h>
  21 #include <linux/slab.h>
  22
  23 #include <asm/arch/corgi.h>
  24 #include <asm/arch/hardware.h>
  25 #include <asm/arch/pxa-regs.h>
  26 #include <asm/hardware/scoop.h>
  27
  28 #define KB_ROWS                         8
  29 #define KB_COLS                         12
  30 #define KB_ROWMASK(r)           (1 << (r))
  31 #define SCANCODE(r,c)           ( ((r)<<4) + (c) + 1 )
  32 /* zero code, 124 scancodes + 3 hinge combinations */
  33 #define NR_SCANCODES            ( SCANCODE(KB_ROWS-1,KB_COLS-1) +1 +1 +3 )
  34 #define SCAN_INTERVAL           (HZ/10)
  35
  36 #define HINGE_SCAN_INTERVAL             (HZ/4)
  37
  38 #define CORGI_KEY_CALENDER      KEY_F1
  39 #define CORGI_KEY_ADDRESS       KEY_F2
  40 #define CORGI_KEY_FN            KEY_F3
  41 #define CORGI_KEY_CANCEL        KEY_F4
  42 #define CORGI_KEY_OFF           KEY_SUSPEND
  43 #define CORGI_KEY_EXOK          KEY_F5
  44 #define CORGI_KEY_EXCANCEL      KEY_F6
  45 #define CORGI_KEY_EXJOGDOWN     KEY_F7
  46 #define CORGI_KEY_EXJOGUP       KEY_F8
  47 #define CORGI_KEY_JAP1          KEY_LEFTCTRL
  48 #define CORGI_KEY_JAP2          KEY_LEFTALT
  49 #define CORGI_KEY_MAIL          KEY_F10
  50 #define CORGI_KEY_OK            KEY_F11
  51 #define CORGI_KEY_MENU          KEY_F12
  52 #define CORGI_HINGE_0           KEY_KP0
  53 #define CORGI_HINGE_1           KEY_KP1
  54 #define CORGI_HINGE_2           KEY_KP2
  55
  56 static unsigned char corgikbd_keycode[NR_SCANCODES] = {
  57         0,                                                                                                                /* 0 */
  58         0, KEY_1, KEY_3, KEY_5, KEY_6, KEY_7, KEY_9, KEY_0, KEY_BACKSPACE, 0, 0, 0, 0, 0, 0, 0,                               /* 1-16 */
  59         0, KEY_2, KEY_4, KEY_R, KEY_Y, KEY_8, KEY_I, KEY_O, KEY_P, 0, 0, 0, 0, 0, 0, 0,                                   /* 17-32 */
  60         KEY_TAB, KEY_Q, KEY_E, KEY_T, KEY_G, KEY_U, KEY_J, KEY_K, 0, 0, 0, 0, 0, 0, 0, 0,                                 /* 33-48 */
  61         CORGI_KEY_CALENDER, KEY_W, KEY_S, KEY_F, KEY_V, KEY_H, KEY_M, KEY_L, 0, KEY_RIGHTSHIFT, 0, 0, 0, 0, 0, 0,         /* 49-64 */
  62         CORGI_KEY_ADDRESS, KEY_A, KEY_D, KEY_C, KEY_B, KEY_N, KEY_DOT, 0, KEY_ENTER, 0, KEY_LEFTSHIFT, 0, 0, 0, 0, 0,     /* 65-80 */
  63         CORGI_KEY_MAIL, KEY_Z, KEY_X, KEY_MINUS, KEY_SPACE, KEY_COMMA, 0, KEY_UP, 0, 0, 0, CORGI_KEY_FN, 0, 0, 0, 0,            /* 81-96 */
  64         KEY_SYSRQ, CORGI_KEY_JAP1, CORGI_KEY_JAP2, CORGI_KEY_CANCEL, CORGI_KEY_OK, CORGI_KEY_MENU, KEY_LEFT, KEY_DOWN, KEY_RIGHT, 0, 0, 0, 0, 0, 0, 0,  /* 97-112 */
  65         CORGI_KEY_OFF, CORGI_KEY_EXOK, CORGI_KEY_EXCANCEL, CORGI_KEY_EXJOGDOWN, CORGI_KEY_EXJOGUP, 0, 0, 0, 0, 0, 0, 0,   /* 113-124 */
  66         CORGI_HINGE_0, CORGI_HINGE_1, CORGI_HINGE_2       /* 125-127 */
  67 };
  68
  69
  70 struct corgikbd {
  71         unsigned char keycode[ARRAY_SIZE(corgikbd_keycode)];
  72         struct input_dev *input;
  73
  74         spinlock_t lock;
  75         struct timer_list timer;
  76         struct timer_list htimer;
  77
  78         unsigned int suspended;
  79         unsigned long suspend_jiffies;
  80 };
  81
  82 #define KB_DISCHARGE_DELAY      10
  83 #define KB_ACTIVATE_DELAY       10
  84
  85 /* Helper functions for reading the keyboard matrix
  86  * Note: We should really be using pxa_gpio_mode to alter GPDR but it
  87  *       requires a function call per GPIO bit which is excessive
  88  *       when we need to access 12 bits at once multiple times.
  89  * These functions must be called within local_irq_save()/local_irq_restore()
  90  * or similar.
  91  */
  92 static inline void corgikbd_discharge_all(void)
  93 {
  94         /* STROBE All HiZ */
  95         GPCR2  = CORGI_GPIO_ALL_STROBE_BIT;
  96         GPDR2 &= ~CORGI_GPIO_ALL_STROBE_BIT;
  97 }
  98
  99 static inline void corgikbd_activate_all(void)
 100 {
 101         /* STROBE ALL -> High */
 102         GPSR2  = CORGI_GPIO_ALL_STROBE_BIT;
 103         GPDR2 |= CORGI_GPIO_ALL_STROBE_BIT;
 104
 105         udelay(KB_DISCHARGE_DELAY);
 106
 107         /* Clear any interrupts we may have triggered when altering the GPIO lines */
 108         GEDR1 = CORGI_GPIO_HIGH_SENSE_BIT;
 109         GEDR2 = CORGI_GPIO_LOW_SENSE_BIT;
 110 }
 111
 112 static inline void corgikbd_activate_col(int col)
 113 {
 114         /* STROBE col -> High, not col -> HiZ */
 115         GPSR2 = CORGI_GPIO_STROBE_BIT(col);
 116         GPDR2 = (GPDR2 & ~CORGI_GPIO_ALL_STROBE_BIT) | CORGI_GPIO_STROBE_BIT(col);
 117 }
 118
 119 static inline void corgikbd_reset_col(int col)
 120 {
 121         /* STROBE col -> Low */
 122         GPCR2 = CORGI_GPIO_STROBE_BIT(col);
 123         /* STROBE col -> out, not col -> HiZ */
 124         GPDR2 = (GPDR2 & ~CORGI_GPIO_ALL_STROBE_BIT) | CORGI_GPIO_STROBE_BIT(col);
 125 }
 126
 127 #define GET_ROWS_STATUS(c)      (((GPLR1 & CORGI_GPIO_HIGH_SENSE_BIT) >> CORGI_GPIO_HIGH_SENSE_RSHIFT) | ((GPLR2 & CORGI_GPIO_LOW_SENSE_BIT) << CORGI_GPIO_LOW_SENSE_LSHIFT))
 128
 129 /*
 130  * The corgi keyboard only generates interrupts when a key is pressed.
 131  * When a key is pressed, we enable a timer which then scans the
 132  * keyboard to detect when the key is released.
 133  */
 134
 135 /* Scan the hardware keyboard and push any changes up through the input layer */
 136 static void corgikbd_scankeyboard(struct corgikbd *corgikbd_data, struct pt_regs *regs)
 137 {
 138         unsigned int row, col, rowd;
 139         unsigned long flags;
 140         unsigned int num_pressed;
 141
 142         if (corgikbd_data->suspended)
 143                 return;
 144
 145         spin_lock_irqsave(&corgikbd_data->lock, flags);
 146
 147         if (regs)
 148                 input_regs(corgikbd_data->input, regs);
 149
 150         num_pressed = 0;
 151         for (col = 0; col < KB_COLS; col++) {
 152                 /*
 153                  * Discharge the output driver capacitatance
 154                  * in the keyboard matrix. (Yes it is significant..)
 155                  */
 156
 157                 corgikbd_discharge_all();
 158                 udelay(KB_DISCHARGE_DELAY);
 159
 160                 corgikbd_activate_col(col);
 161                 udelay(KB_ACTIVATE_DELAY);
 162
 163                 rowd = GET_ROWS_STATUS(col);
 164                 for (row = 0; row < KB_ROWS; row++) {
 165                         unsigned int scancode, pressed;
 166
 167                         scancode = SCANCODE(row, col);
 168                         pressed = rowd & KB_ROWMASK(row);
 169
 170                         input_report_key(corgikbd_data->input, corgikbd_data->keycode[scancode], pressed);
 171
 172                         if (pressed)
 173                                 num_pressed++;
 174
 175                         if (pressed && (corgikbd_data->keycode[scancode] == CORGI_KEY_OFF)
 176                                         && time_after(jiffies, corgikbd_data->suspend_jiffies + HZ)) {
 177                                 input_event(corgikbd_data->input, EV_PWR, CORGI_KEY_OFF, 1);
 178                                 corgikbd_data->suspend_jiffies=jiffies;
 179                         }
 180                 }
 181                 corgikbd_reset_col(col);
 182         }
 183
 184         corgikbd_activate_all();
 185
 186         input_sync(corgikbd_data->input);
 187
 188         /* if any keys are pressed, enable the timer */
 189         if (num_pressed)
 190                 mod_timer(&corgikbd_data->timer, jiffies + SCAN_INTERVAL);
 191
 192         spin_unlock_irqrestore(&corgikbd_data->lock, flags);
 193 }
 194
 195 /*
 196  * corgi keyboard interrupt handler.
 197  */
 198 static irqreturn_t corgikbd_interrupt(int irq, void *dev_id, struct pt_regs *regs)
 199 {
 200         struct corgikbd *corgikbd_data = dev_id;
 201
 202         if (!timer_pending(&corgikbd_data->timer)) {
 203                 /** wait chattering delay **/
 204                 udelay(20);
 205                 corgikbd_scankeyboard(corgikbd_data, regs);
 206         }
 207
 208         return IRQ_HANDLED;
 209 }
 210
 211 /*
 212  * corgi timer checking for released keys
 213  */
 214 static void corgikbd_timer_callback(unsigned long data)
 215 {
 216         struct corgikbd *corgikbd_data = (struct corgikbd *) data;
 217         corgikbd_scankeyboard(corgikbd_data, NULL);
 218 }
 219
 220 /*
 221  * The hinge switches generate no interrupt so they need to be
 222  * monitored by a timer.
 223  *
 224  * We debounce the switches and pass them to the input system.
 225  *
 226  *  gprr == 0x00 - Keyboard with Landscape Screen
 227  *          0x08 - No Keyboard with Portrait Screen
 228  *          0x0c - Keyboard and Screen Closed
 229  */
 230
 231 #define HINGE_STABLE_COUNT 2
 232 static int sharpsl_hinge_state;
 233 static int hinge_count;
 234
 235 static void corgikbd_hinge_timer(unsigned long data)
 236 {
 237         struct corgikbd *corgikbd_data = (struct corgikbd *) data;
 238         unsigned long gprr;
 239         unsigned long flags;
 240
 241         gprr = read_scoop_reg(&corgiscoop_device.dev, SCOOP_GPRR) & (CORGI_SCP_SWA | CORGI_SCP_SWB);
 242         if (gprr != sharpsl_hinge_state) {
 243                 hinge_count = 0;
 244                 sharpsl_hinge_state = gprr;
 245         } else if (hinge_count < HINGE_STABLE_COUNT) {
 246                 hinge_count++;
 247                 if (hinge_count >= HINGE_STABLE_COUNT) {
 248                         spin_lock_irqsave(&corgikbd_data->lock, flags);
 249
 250                         input_report_switch(corgikbd_data->input, SW_0, ((sharpsl_hinge_state & CORGI_SCP_SWA) != 0));
 251                         input_report_switch(corgikbd_data->input, SW_1, ((sharpsl_hinge_state & CORGI_SCP_SWB) != 0));
 252                         input_sync(corgikbd_data->input);
 253
 254                         spin_unlock_irqrestore(&corgikbd_data->lock, flags);
 255                 }
 256         }
 257         mod_timer(&corgikbd_data->htimer, jiffies + HINGE_SCAN_INTERVAL);
 258 }
 259
 260 #ifdef CONFIG_PM
 261 static int corgikbd_suspend(struct platform_device *dev, pm_message_t state)
 262 {
 263         struct corgikbd *corgikbd = platform_get_drvdata(dev);
 264         corgikbd->suspended = 1;
 265
 266         return 0;
 267 }
 268
 269 static int corgikbd_resume(struct platform_device *dev)
 270 {
 271         struct corgikbd *corgikbd = platform_get_drvdata(dev);
 272
 273         /* Upon resume, ignore the suspend key for a short while */
 274         corgikbd->suspend_jiffies=jiffies;
 275         corgikbd->suspended = 0;
 276
 277         return 0;
 278 }
 279 #else
 280 #define corgikbd_suspend        NULL
 281 #define corgikbd_resume         NULL
 282 #endif
 283
 284 static int __init corgikbd_probe(struct platform_device *pdev)
 285 {
 286         struct corgikbd *corgikbd;
 287         struct input_dev *input_dev;
 288         int i;
 289
 290         corgikbd = kzalloc(sizeof(struct corgikbd), GFP_KERNEL);
 291         input_dev = input_allocate_device();
 292         if (!corgikbd || !input_dev) {
 293                 kfree(corgikbd);
 294                 input_free_device(input_dev);
 295                 return -ENOMEM;
 296         }
 297
 298         platform_set_drvdata(pdev, corgikbd);
 299
 300         corgikbd->input = input_dev;
 301         spin_lock_init(&corgikbd->lock);
 302
 303         /* Init Keyboard rescan timer */
 304         init_timer(&corgikbd->timer);
 305         corgikbd->timer.function = corgikbd_timer_callback;
 306         corgikbd->timer.data = (unsigned long) corgikbd;
 307
 308         /* Init Hinge Timer */
 309         init_timer(&corgikbd->htimer);
 310         corgikbd->htimer.function = corgikbd_hinge_timer;
 311         corgikbd->htimer.data = (unsigned long) corgikbd;
 312
 313         corgikbd->suspend_jiffies=jiffies;
 314
 315         memcpy(corgikbd->keycode, corgikbd_keycode, sizeof(corgikbd->keycode));
 316
 317         input_dev->name = "Corgi Keyboard";
 318         input_dev->phys = "corgikbd/input0";
 319         input_dev->id.bustype = BUS_HOST;
 320         input_dev->id.vendor = 0x0001;
 321         input_dev->id.product = 0x0001;
 322         input_dev->id.version = 0x0100;
 323         input_dev->cdev.dev = &pdev->dev;
 324         input_dev->private = corgikbd;
 325
 326         input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_REP) | BIT(EV_PWR) | BIT(EV_SW);
 327         input_dev->keycode = corgikbd->keycode;
 328         input_dev->keycodesize = sizeof(unsigned char);
 329         input_dev->keycodemax = ARRAY_SIZE(corgikbd_keycode);
 330
 331         for (i = 0; i < ARRAY_SIZE(corgikbd_keycode); i++)
 332                 set_bit(corgikbd->keycode[i], input_dev->keybit);
 333         clear_bit(0, input_dev->keybit);
 334         set_bit(SW_0, input_dev->swbit);
 335         set_bit(SW_1, input_dev->swbit);
 336
 337         input_register_device(corgikbd->input);
 338
 339         mod_timer(&corgikbd->htimer, jiffies + HINGE_SCAN_INTERVAL);
 340
 341         /* Setup sense interrupts - RisingEdge Detect, sense lines as inputs */
 342         for (i = 0; i < CORGI_KEY_SENSE_NUM; i++) {
 343                 pxa_gpio_mode(CORGI_GPIO_KEY_SENSE(i) | GPIO_IN);
 344                 if (request_irq(CORGI_IRQ_GPIO_KEY_SENSE(i), corgikbd_interrupt,
 345                                 SA_INTERRUPT | SA_TRIGGER_RISING,
 346                                 "corgikbd", corgikbd))
 347                         printk(KERN_WARNING "corgikbd: Can't get IRQ: %d!\n", i);
 348         }
 349
 350         /* Set Strobe lines as outputs - set high */
 351         for (i = 0; i < CORGI_KEY_STROBE_NUM; i++)
 352                 pxa_gpio_mode(CORGI_GPIO_KEY_STROBE(i) | GPIO_OUT | GPIO_DFLT_HIGH);
 353
 354         return 0;
 355 }
 356
 357 static int corgikbd_remove(struct platform_device *pdev)
 358 {
 359         int i;
 360         struct corgikbd *corgikbd = platform_get_drvdata(pdev);
 361
 362         for (i = 0; i < CORGI_KEY_SENSE_NUM; i++)
 363                 free_irq(CORGI_IRQ_GPIO_KEY_SENSE(i), corgikbd);
 364
 365         del_timer_sync(&corgikbd->htimer);
 366         del_timer_sync(&corgikbd->timer);
 367
 368         input_unregister_device(corgikbd->input);
 369
 370         kfree(corgikbd);
 371
 372         return 0;
 373 }
 374
 375 static struct platform_driver corgikbd_driver = {
 376         .probe          = corgikbd_probe,
 377         .remove         = corgikbd_remove,
 378         .suspend        = corgikbd_suspend,
 379         .resume         = corgikbd_resume,
 380         .driver         = {
 381                 .name   = "corgi-keyboard",
 382         },
 383 };
 384
 385 static int __devinit corgikbd_init(void)
 386 {
 387         return platform_driver_register(&corgikbd_driver);
 388 }
 389
 390 static void __exit corgikbd_exit(void)
 391 {
 392         platform_driver_unregister(&corgikbd_driver);
 393 }
 394
 395 module_init(corgikbd_init);
 396 module_exit(corgikbd_exit);
 397
 398 MODULE_AUTHOR("Richard Purdie <rpurdie@rpsys.net>");
 399 MODULE_DESCRIPTION("Corgi Keyboard Driver");
 400 MODULE_LICENSE("GPLv2");