drivers/input/keyboard/sunkbd.c

   1 /*
   2  *  Copyright (c) 1999-2001 Vojtech Pavlik
   3  */
   4
   5 /*
   6  * Sun keyboard driver for Linux
   7  */
   8
   9 /*
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  23  */
  24
  25 #include <linux/delay.h>
  26 #include <linux/sched.h>
  27 #include <linux/slab.h>
  28 #include <linux/module.h>
  29 #include <linux/interrupt.h>
  30 #include <linux/input.h>
  31 #include <linux/serio.h>
  32 #include <linux/workqueue.h>
  33
  34 #define DRIVER_DESC     "Sun keyboard driver"
  35
  36 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
  37 MODULE_DESCRIPTION(DRIVER_DESC);
  38 MODULE_LICENSE("GPL");
  39
  40 static unsigned char sunkbd_keycode[128] = {
  41           0,128,114,129,115, 59, 60, 68, 61, 87, 62, 88, 63,100, 64,112,
  42          65, 66, 67, 56,103,119, 99, 70,105,130,131,108,106,  1,  2,  3,
  43           4,  5,  6,  7,  8,  9, 10, 11, 12, 13, 41, 14,110,113, 98, 55,
  44         116,132, 83,133,102, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25,
  45          26, 27,111,127, 71, 72, 73, 74,134,135,107,  0, 29, 30, 31, 32,
  46          33, 34, 35, 36, 37, 38, 39, 40, 43, 28, 96, 75, 76, 77, 82,136,
  47         104,137, 69, 42, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54,101,
  48          79, 80, 81,  0,  0,  0,138, 58,125, 57,126,109, 86, 78
  49 };
  50
  51 #define SUNKBD_CMD_RESET        0x1
  52 #define SUNKBD_CMD_BELLON       0x2
  53 #define SUNKBD_CMD_BELLOFF      0x3
  54 #define SUNKBD_CMD_CLICK        0xa
  55 #define SUNKBD_CMD_NOCLICK      0xb
  56 #define SUNKBD_CMD_SETLED       0xe
  57 #define SUNKBD_CMD_LAYOUT       0xf
  58
  59 #define SUNKBD_RET_RESET        0xff
  60 #define SUNKBD_RET_ALLUP        0x7f
  61 #define SUNKBD_RET_LAYOUT       0xfe
  62
  63 #define SUNKBD_LAYOUT_5_MASK    0x20
  64 #define SUNKBD_RELEASE          0x80
  65 #define SUNKBD_KEY              0x7f
  66
  67 /*
  68  * Per-keyboard data.
  69  */
  70
  71 struct sunkbd {
  72         unsigned char keycode[ARRAY_SIZE(sunkbd_keycode)];
  73         struct input_dev *dev;
  74         struct serio *serio;
  75         struct work_struct tq;
  76         wait_queue_head_t wait;
  77         char name[64];
  78         char phys[32];
  79         char type;
  80         bool enabled;
  81         volatile s8 reset;
  82         volatile s8 layout;
  83 };
  84
  85 /*
  86  * sunkbd_interrupt() is called by the low level driver when a character
  87  * is received.
  88  */
  89
  90 static irqreturn_t sunkbd_interrupt(struct serio *serio,
  91                 unsigned char data, unsigned int flags)
  92 {
  93         struct sunkbd *sunkbd = serio_get_drvdata(serio);
  94
  95         if (sunkbd->reset <= -1) {
  96                 /*
  97                  * If cp[i] is 0xff, sunkbd->reset will stay -1.
  98                  * The keyboard sends 0xff 0xff 0xID on powerup.
  99                  */
 100                 sunkbd->reset = data;
 101                 wake_up_interruptible(&sunkbd->wait);
 102                 goto out;
 103         }
 104
 105         if (sunkbd->layout == -1) {
 106                 sunkbd->layout = data;
 107                 wake_up_interruptible(&sunkbd->wait);
 108                 goto out;
 109         }
 110
 111         switch (data) {
 112
 113         case SUNKBD_RET_RESET:
 114                 if (sunkbd->enabled)
 115                         schedule_work(&sunkbd->tq);
 116                 sunkbd->reset = -1;
 117                 break;
 118
 119         case SUNKBD_RET_LAYOUT:
 120                 sunkbd->layout = -1;
 121                 break;
 122
 123         case SUNKBD_RET_ALLUP: /* All keys released */
 124                 break;
 125
 126         default:
 127                 if (!sunkbd->enabled)
 128                         break;
 129
 130                 if (sunkbd->keycode[data & SUNKBD_KEY]) {
 131                         input_report_key(sunkbd->dev,
 132                                          sunkbd->keycode[data & SUNKBD_KEY],
 133                                          !(data & SUNKBD_RELEASE));
 134                         input_sync(sunkbd->dev);
 135                 } else {
 136                         printk(KERN_WARNING
 137                                 "sunkbd.c: Unknown key (scancode %#x) %s.\n",
 138                                 data & SUNKBD_KEY,
 139                                 data & SUNKBD_RELEASE ? "released" : "pressed");
 140                 }
 141         }
 142 out:
 143         return IRQ_HANDLED;
 144 }
 145
 146 /*
 147  * sunkbd_event() handles events from the input module.
 148  */
 149
 150 static int sunkbd_event(struct input_dev *dev,
 151                         unsigned int type, unsigned int code, int value)
 152 {
 153         struct sunkbd *sunkbd = input_get_drvdata(dev);
 154
 155         switch (type) {
 156
 157         case EV_LED:
 158
 159                 serio_write(sunkbd->serio, SUNKBD_CMD_SETLED);
 160                 serio_write(sunkbd->serio,
 161                         (!!test_bit(LED_CAPSL,   dev->led) << 3) |
 162                         (!!test_bit(LED_SCROLLL, dev->led) << 2) |
 163                         (!!test_bit(LED_COMPOSE, dev->led) << 1) |
 164                          !!test_bit(LED_NUML,    dev->led));
 165                 return 0;
 166
 167         case EV_SND:
 168
 169                 switch (code) {
 170
 171                 case SND_CLICK:
 172                         serio_write(sunkbd->serio, SUNKBD_CMD_NOCLICK - value);
 173                         return 0;
 174
 175                 case SND_BELL:
 176                         serio_write(sunkbd->serio, SUNKBD_CMD_BELLOFF - value);
 177                         return 0;
 178                 }
 179
 180                 break;
 181         }
 182
 183         return -1;
 184 }
 185
 186 /*
 187  * sunkbd_initialize() checks for a Sun keyboard attached, and determines
 188  * its type.
 189  */
 190
 191 static int sunkbd_initialize(struct sunkbd *sunkbd)
 192 {
 193         sunkbd->reset = -2;
 194         serio_write(sunkbd->serio, SUNKBD_CMD_RESET);
 195         wait_event_interruptible_timeout(sunkbd->wait, sunkbd->reset >= 0, HZ);
 196         if (sunkbd->reset < 0)
 197                 return -1;
 198
 199         sunkbd->type = sunkbd->reset;
 200
 201         if (sunkbd->type == 4) {        /* Type 4 keyboard */
 202                 sunkbd->layout = -2;
 203                 serio_write(sunkbd->serio, SUNKBD_CMD_LAYOUT);
 204                 wait_event_interruptible_timeout(sunkbd->wait,
 205                                                  sunkbd->layout >= 0, HZ / 4);
 206                 if (sunkbd->layout < 0)
 207                         return -1;
 208                 if (sunkbd->layout & SUNKBD_LAYOUT_5_MASK)
 209                         sunkbd->type = 5;
 210         }
 211
 212         return 0;
 213 }
 214
 215 /*
 216  * sunkbd_set_leds_beeps() sets leds and beeps to a state the computer remembers
 217  * they were in.
 218  */
 219
 220 static void sunkbd_set_leds_beeps(struct sunkbd *sunkbd)
 221 {
 222         serio_write(sunkbd->serio, SUNKBD_CMD_SETLED);
 223         serio_write(sunkbd->serio,
 224                 (!!test_bit(LED_CAPSL,   sunkbd->dev->led) << 3) |
 225                 (!!test_bit(LED_SCROLLL, sunkbd->dev->led) << 2) |
 226                 (!!test_bit(LED_COMPOSE, sunkbd->dev->led) << 1) |
 227                  !!test_bit(LED_NUML,    sunkbd->dev->led));
 228         serio_write(sunkbd->serio,
 229                 SUNKBD_CMD_NOCLICK - !!test_bit(SND_CLICK, sunkbd->dev->snd));
 230         serio_write(sunkbd->serio,
 231                 SUNKBD_CMD_BELLOFF - !!test_bit(SND_BELL, sunkbd->dev->snd));
 232 }
 233
 234
 235 /*
 236  * sunkbd_reinit() wait for the keyboard reset to complete and restores state
 237  * of leds and beeps.
 238  */
 239
 240 static void sunkbd_reinit(struct work_struct *work)
 241 {
 242         struct sunkbd *sunkbd = container_of(work, struct sunkbd, tq);
 243
 244         /*
 245          * It is OK that we check sunkbd->enabled without pausing serio,
 246          * as we only want to catch true->false transition that will
 247          * happen once and we will be woken up for it.
 248          */
 249         wait_event_interruptible_timeout(sunkbd->wait,
 250                                          sunkbd->reset >= 0 || !sunkbd->enabled,
 251                                          HZ);
 252
 253         if (sunkbd->reset >= 0 && sunkbd->enabled)
 254                 sunkbd_set_leds_beeps(sunkbd);
 255 }
 256
 257 static void sunkbd_enable(struct sunkbd *sunkbd, bool enable)
 258 {
 259         serio_pause_rx(sunkbd->serio);
 260         sunkbd->enabled = enable;
 261         serio_continue_rx(sunkbd->serio);
 262
 263         if (!enable) {
 264                 wake_up_interruptible(&sunkbd->wait);
 265                 cancel_work_sync(&sunkbd->tq);
 266         }
 267 }
 268
 269 /*
 270  * sunkbd_connect() probes for a Sun keyboard and fills the necessary
 271  * structures.
 272  */
 273
 274 static int sunkbd_connect(struct serio *serio, struct serio_driver *drv)
 275 {
 276         struct sunkbd *sunkbd;
 277         struct input_dev *input_dev;
 278         int err = -ENOMEM;
 279         int i;
 280
 281         sunkbd = kzalloc(sizeof(struct sunkbd), GFP_KERNEL);
 282         input_dev = input_allocate_device();
 283         if (!sunkbd || !input_dev)
 284                 goto fail1;
 285
 286         sunkbd->serio = serio;
 287         sunkbd->dev = input_dev;
 288         init_waitqueue_head(&sunkbd->wait);
 289         INIT_WORK(&sunkbd->tq, sunkbd_reinit);
 290         snprintf(sunkbd->phys, sizeof(sunkbd->phys), "%s/input0", serio->phys);
 291
 292         serio_set_drvdata(serio, sunkbd);
 293
 294         err = serio_open(serio, drv);
 295         if (err)
 296                 goto fail2;
 297
 298         if (sunkbd_initialize(sunkbd) < 0) {
 299                 err = -ENODEV;
 300                 goto fail3;
 301         }
 302
 303         snprintf(sunkbd->name, sizeof(sunkbd->name),
 304                  "Sun Type %d keyboard", sunkbd->type);
 305         memcpy(sunkbd->keycode, sunkbd_keycode, sizeof(sunkbd->keycode));
 306
 307         input_dev->name = sunkbd->name;
 308         input_dev->phys = sunkbd->phys;
 309         input_dev->id.bustype = BUS_RS232;
 310         input_dev->id.vendor  = SERIO_SUNKBD;
 311         input_dev->id.product = sunkbd->type;
 312         input_dev->id.version = 0x0100;
 313         input_dev->dev.parent = &serio->dev;
 314
 315         input_set_drvdata(input_dev, sunkbd);
 316
 317         input_dev->event = sunkbd_event;
 318
 319         input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_LED) |
 320                 BIT_MASK(EV_SND) | BIT_MASK(EV_REP);
 321         input_dev->ledbit[0] = BIT_MASK(LED_CAPSL) | BIT_MASK(LED_COMPOSE) |
 322                 BIT_MASK(LED_SCROLLL) | BIT_MASK(LED_NUML);
 323         input_dev->sndbit[0] = BIT_MASK(SND_CLICK) | BIT_MASK(SND_BELL);
 324
 325         input_dev->keycode = sunkbd->keycode;
 326         input_dev->keycodesize = sizeof(unsigned char);
 327         input_dev->keycodemax = ARRAY_SIZE(sunkbd_keycode);
 328         for (i = 0; i < ARRAY_SIZE(sunkbd_keycode); i++)
 329                 __set_bit(sunkbd->keycode[i], input_dev->keybit);
 330         __clear_bit(KEY_RESERVED, input_dev->keybit);
 331
 332         sunkbd_enable(sunkbd, true);
 333
 334         err = input_register_device(sunkbd->dev);
 335         if (err)
 336                 goto fail4;
 337
 338         return 0;
 339
 340  fail4: sunkbd_enable(sunkbd, false);
 341  fail3: serio_close(serio);
 342  fail2: serio_set_drvdata(serio, NULL);
 343  fail1: input_free_device(input_dev);
 344         kfree(sunkbd);
 345         return err;
 346 }
 347
 348 /*
 349  * sunkbd_disconnect() unregisters and closes behind us.
 350  */
 351
 352 static void sunkbd_disconnect(struct serio *serio)
 353 {
 354         struct sunkbd *sunkbd = serio_get_drvdata(serio);
 355
 356         sunkbd_enable(sunkbd, false);
 357         input_unregister_device(sunkbd->dev);
 358         serio_close(serio);
 359         serio_set_drvdata(serio, NULL);
 360         kfree(sunkbd);
 361 }
 362
 363 static const struct serio_device_id sunkbd_serio_ids[] = {
 364         {
 365                 .type   = SERIO_RS232,
 366                 .proto  = SERIO_SUNKBD,
 367                 .id     = SERIO_ANY,
 368                 .extra  = SERIO_ANY,
 369         },
 370         {
 371                 .type   = SERIO_RS232,
 372                 .proto  = SERIO_UNKNOWN, /* sunkbd does probe */
 373                 .id     = SERIO_ANY,
 374                 .extra  = SERIO_ANY,
 375         },
 376         { 0 }
 377 };
 378
 379 MODULE_DEVICE_TABLE(serio, sunkbd_serio_ids);
 380
 381 static struct serio_driver sunkbd_drv = {
 382         .driver         = {
 383                 .name   = "sunkbd",
 384         },
 385         .description    = DRIVER_DESC,
 386         .id_table       = sunkbd_serio_ids,
 387         .interrupt      = sunkbd_interrupt,
 388         .connect        = sunkbd_connect,
 389         .disconnect     = sunkbd_disconnect,
 390 };
 391
 392 module_serio_driver(sunkbd_drv);