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