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