drivers/input/keyboard/lkkbd.c

   1 /*
   2  *  Copyright (C) 2004 by Jan-Benedict Glaw <jbglaw@lug-owl.de>
   3  */
   4
   5 /*
   6  * LK keyboard driver for Linux, based on sunkbd.c (C) by Vojtech Pavlik
   7  */
   8
   9 /*
  10  * DEC LK201 and LK401 keyboard driver for Linux (primary for DECstations
  11  * and VAXstations, but can also be used on any standard RS232 with an
  12  * adaptor).
  13  *
  14  * DISCLAIMER: This works for _me_. If you break anything by using the
  15  * information given below, I will _not_ be liable!
  16  *
  17  * RJ10 pinout:         To DE9:         Or DB25:
  18  *      1 - RxD <---->  Pin 3 (TxD) <-> Pin 2 (TxD)
  19  *      2 - GND <---->  Pin 5 (GND) <-> Pin 7 (GND)
  20  *      4 - TxD <---->  Pin 2 (RxD) <-> Pin 3 (RxD)
  21  *      3 - +12V (from HDD drive connector), DON'T connect to DE9 or DB25!!!
  22  *
  23  * Pin numbers for DE9 and DB25 are noted on the plug (quite small:). For
  24  * RJ10, it's like this:
  25  *
  26  *      __=__   Hold the plug in front of you, cable downwards,
  27  *     /___/|   nose is hidden behind the plug. Now, pin 1 is at
  28  *    |1234||   the left side, pin 4 at the right and 2 and 3 are
  29  *    |IIII||   in between, of course:)
  30  *    |    ||
  31  *    |____|/
  32  *      ||      So the adaptor consists of three connected cables
  33  *      ||      for data transmission (RxD and TxD) and signal ground.
  34  *              Additionally, you have to get +12V from somewhere.
  35  * Most easily, you'll get that from a floppy or HDD power connector.
  36  * It's the yellow cable there (black is ground and red is +5V).
  37  *
  38  * The keyboard and all the commands it understands are documented in
  39  * "VCB02 Video Subsystem - Technical Manual", EK-104AA-TM-001. This
  40  * document is LK201 specific, but LK401 is mostly compatible. It comes
  41  * up in LK201 mode and doesn't report any of the additional keys it
  42  * has. These need to be switched on with the LK_CMD_ENABLE_LK401
  43  * command. You'll find this document (scanned .pdf file) on MANX,
  44  * a search engine specific to DEC documentation. Try
  45  * http://www.vt100.net/manx/details?pn=EK-104AA-TM-001;id=21;cp=1
  46  */
  47
  48 /*
  49  * This program is free software; you can redistribute it and/or modify
  50  * it under the terms of the GNU General Public License as published by
  51  * the Free Software Foundation; either version 2 of the License, or
  52  * (at your option) any later version.
  53  *
  54  * This program is distributed in the hope that it will be useful,
  55  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  56  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  57  * GNU General Public License for more details.
  58  *
  59  * You should have received a copy of the GNU General Public License
  60  * along with this program; if not, write to the Free Software
  61  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  62  */
  63
  64 #include <linux/delay.h>
  65 #include <linux/slab.h>
  66 #include <linux/module.h>
  67 #include <linux/interrupt.h>
  68 #include <linux/init.h>
  69 #include <linux/input.h>
  70 #include <linux/serio.h>
  71 #include <linux/workqueue.h>
  72
  73 #define DRIVER_DESC     "LK keyboard driver"
  74
  75 MODULE_AUTHOR ("Jan-Benedict Glaw <jbglaw@lug-owl.de>");
  76 MODULE_DESCRIPTION (DRIVER_DESC);
  77 MODULE_LICENSE ("GPL");
  78
  79 /*
  80  * Known parameters:
  81  *      bell_volume
  82  *      keyclick_volume
  83  *      ctrlclick_volume
  84  *
  85  * Please notice that there's not yet an API to set these at runtime.
  86  */
  87 static int bell_volume = 100; /* % */
  88 module_param (bell_volume, int, 0);
  89 MODULE_PARM_DESC (bell_volume, "Bell volume (in %). default is 100%");
  90
  91 static int keyclick_volume = 100; /* % */
  92 module_param (keyclick_volume, int, 0);
  93 MODULE_PARM_DESC (keyclick_volume, "Keyclick volume (in %), default is 100%");
  94
  95 static int ctrlclick_volume = 100; /* % */
  96 module_param (ctrlclick_volume, int, 0);
  97 MODULE_PARM_DESC (ctrlclick_volume, "Ctrlclick volume (in %), default is 100%");
  98
  99 static int lk201_compose_is_alt;
 100 module_param (lk201_compose_is_alt, int, 0);
 101 MODULE_PARM_DESC (lk201_compose_is_alt, "If set non-zero, LK201' Compose key "
 102                 "will act as an Alt key");
 103
 104
 105
 106 #undef LKKBD_DEBUG
 107 #ifdef LKKBD_DEBUG
 108 #define DBG(x...) printk (x)
 109 #else
 110 #define DBG(x...) do {} while (0)
 111 #endif
 112
 113 /* LED control */
 114 #define LK_LED_WAIT             0x81
 115 #define LK_LED_COMPOSE          0x82
 116 #define LK_LED_SHIFTLOCK        0x84
 117 #define LK_LED_SCROLLLOCK       0x88
 118 #define LK_CMD_LED_ON           0x13
 119 #define LK_CMD_LED_OFF          0x11
 120
 121 /* Mode control */
 122 #define LK_MODE_DOWN            0x80
 123 #define LK_MODE_AUTODOWN        0x82
 124 #define LK_MODE_UPDOWN          0x86
 125 #define LK_CMD_SET_MODE(mode,div)       ((mode) | ((div) << 3))
 126
 127 /* Misc commands */
 128 #define LK_CMD_ENABLE_KEYCLICK  0x1b
 129 #define LK_CMD_DISABLE_KEYCLICK 0x99
 130 #define LK_CMD_DISABLE_BELL     0xa1
 131 #define LK_CMD_SOUND_BELL       0xa7
 132 #define LK_CMD_ENABLE_BELL      0x23
 133 #define LK_CMD_DISABLE_CTRCLICK 0xb9
 134 #define LK_CMD_ENABLE_CTRCLICK  0xbb
 135 #define LK_CMD_SET_DEFAULTS     0xd3
 136 #define LK_CMD_POWERCYCLE_RESET 0xfd
 137 #define LK_CMD_ENABLE_LK401     0xe9
 138 #define LK_CMD_REQUEST_ID       0xab
 139
 140 /* Misc responses from keyboard */
 141 #define LK_STUCK_KEY            0x3d
 142 #define LK_SELFTEST_FAILED      0x3e
 143 #define LK_ALL_KEYS_UP          0xb3
 144 #define LK_METRONOME            0xb4
 145 #define LK_OUTPUT_ERROR         0xb5
 146 #define LK_INPUT_ERROR          0xb6
 147 #define LK_KBD_LOCKED           0xb7
 148 #define LK_KBD_TEST_MODE_ACK    0xb8
 149 #define LK_PREFIX_KEY_DOWN      0xb9
 150 #define LK_MODE_CHANGE_ACK      0xba
 151 #define LK_RESPONSE_RESERVED    0xbb
 152
 153 #define LK_NUM_KEYCODES         256
 154 #define LK_NUM_IGNORE_BYTES     6
 155 typedef u_int16_t lk_keycode_t;
 156
 157
 158
 159 static lk_keycode_t lkkbd_keycode[LK_NUM_KEYCODES] = {
 160         [0x56] = KEY_F1,
 161         [0x57] = KEY_F2,
 162         [0x58] = KEY_F3,
 163         [0x59] = KEY_F4,
 164         [0x5a] = KEY_F5,
 165         [0x64] = KEY_F6,
 166         [0x65] = KEY_F7,
 167         [0x66] = KEY_F8,
 168         [0x67] = KEY_F9,
 169         [0x68] = KEY_F10,
 170         [0x71] = KEY_F11,
 171         [0x72] = KEY_F12,
 172         [0x73] = KEY_F13,
 173         [0x74] = KEY_F14,
 174         [0x7c] = KEY_F15,
 175         [0x7d] = KEY_F16,
 176         [0x80] = KEY_F17,
 177         [0x81] = KEY_F18,
 178         [0x82] = KEY_F19,
 179         [0x83] = KEY_F20,
 180         [0x8a] = KEY_FIND,
 181         [0x8b] = KEY_INSERT,
 182         [0x8c] = KEY_DELETE,
 183         [0x8d] = KEY_SELECT,
 184         [0x8e] = KEY_PAGEUP,
 185         [0x8f] = KEY_PAGEDOWN,
 186         [0x92] = KEY_KP0,
 187         [0x94] = KEY_KPDOT,
 188         [0x95] = KEY_KPENTER,
 189         [0x96] = KEY_KP1,
 190         [0x97] = KEY_KP2,
 191         [0x98] = KEY_KP3,
 192         [0x99] = KEY_KP4,
 193         [0x9a] = KEY_KP5,
 194         [0x9b] = KEY_KP6,
 195         [0x9c] = KEY_KPCOMMA,
 196         [0x9d] = KEY_KP7,
 197         [0x9e] = KEY_KP8,
 198         [0x9f] = KEY_KP9,
 199         [0xa0] = KEY_KPMINUS,
 200         [0xa1] = KEY_PROG1,
 201         [0xa2] = KEY_PROG2,
 202         [0xa3] = KEY_PROG3,
 203         [0xa4] = KEY_PROG4,
 204         [0xa7] = KEY_LEFT,
 205         [0xa8] = KEY_RIGHT,
 206         [0xa9] = KEY_DOWN,
 207         [0xaa] = KEY_UP,
 208         [0xab] = KEY_RIGHTSHIFT,
 209         [0xac] = KEY_LEFTALT,
 210         [0xad] = KEY_COMPOSE, /* Right Compose, that is. */
 211         [0xae] = KEY_LEFTSHIFT, /* Same as KEY_RIGHTSHIFT on LK201 */
 212         [0xaf] = KEY_LEFTCTRL,
 213         [0xb0] = KEY_CAPSLOCK,
 214         [0xb1] = KEY_COMPOSE, /* Left Compose, that is. */
 215         [0xb2] = KEY_RIGHTALT,
 216         [0xbc] = KEY_BACKSPACE,
 217         [0xbd] = KEY_ENTER,
 218         [0xbe] = KEY_TAB,
 219         [0xbf] = KEY_ESC,
 220         [0xc0] = KEY_1,
 221         [0xc1] = KEY_Q,
 222         [0xc2] = KEY_A,
 223         [0xc3] = KEY_Z,
 224         [0xc5] = KEY_2,
 225         [0xc6] = KEY_W,
 226         [0xc7] = KEY_S,
 227         [0xc8] = KEY_X,
 228         [0xc9] = KEY_102ND,
 229         [0xcb] = KEY_3,
 230         [0xcc] = KEY_E,
 231         [0xcd] = KEY_D,
 232         [0xce] = KEY_C,
 233         [0xd0] = KEY_4,
 234         [0xd1] = KEY_R,
 235         [0xd2] = KEY_F,
 236         [0xd3] = KEY_V,
 237         [0xd4] = KEY_SPACE,
 238         [0xd6] = KEY_5,
 239         [0xd7] = KEY_T,
 240         [0xd8] = KEY_G,
 241         [0xd9] = KEY_B,
 242         [0xdb] = KEY_6,
 243         [0xdc] = KEY_Y,
 244         [0xdd] = KEY_H,
 245         [0xde] = KEY_N,
 246         [0xe0] = KEY_7,
 247         [0xe1] = KEY_U,
 248         [0xe2] = KEY_J,
 249         [0xe3] = KEY_M,
 250         [0xe5] = KEY_8,
 251         [0xe6] = KEY_I,
 252         [0xe7] = KEY_K,
 253         [0xe8] = KEY_COMMA,
 254         [0xea] = KEY_9,
 255         [0xeb] = KEY_O,
 256         [0xec] = KEY_L,
 257         [0xed] = KEY_DOT,
 258         [0xef] = KEY_0,
 259         [0xf0] = KEY_P,
 260         [0xf2] = KEY_SEMICOLON,
 261         [0xf3] = KEY_SLASH,
 262         [0xf5] = KEY_EQUAL,
 263         [0xf6] = KEY_RIGHTBRACE,
 264         [0xf7] = KEY_BACKSLASH,
 265         [0xf9] = KEY_MINUS,
 266         [0xfa] = KEY_LEFTBRACE,
 267         [0xfb] = KEY_APOSTROPHE,
 268 };
 269
 270 #define CHECK_LED(LK, VAR_ON, VAR_OFF, LED, BITS) do {          \
 271         if (test_bit (LED, (LK)->dev->led))                     \
 272                 VAR_ON |= BITS;                                 \
 273         else                                                    \
 274                 VAR_OFF |= BITS;                                \
 275         } while (0)
 276
 277 /*
 278  * Per-keyboard data
 279  */
 280 struct lkkbd {
 281         lk_keycode_t keycode[LK_NUM_KEYCODES];
 282         int ignore_bytes;
 283         unsigned char id[LK_NUM_IGNORE_BYTES];
 284         struct input_dev *dev;
 285         struct serio *serio;
 286         struct work_struct tq;
 287         char name[64];
 288         char phys[32];
 289         char type;
 290         int bell_volume;
 291         int keyclick_volume;
 292         int ctrlclick_volume;
 293 };
 294
 295 #ifdef LKKBD_DEBUG
 296 /*
 297  * Responses from the keyboard and mapping back to their names.
 298  */
 299 static struct {
 300         unsigned char value;
 301         unsigned char *name;
 302 } lk_response[] = {
 303 #define RESPONSE(x) { .value = (x), .name = #x, }
 304         RESPONSE (LK_STUCK_KEY),
 305         RESPONSE (LK_SELFTEST_FAILED),
 306         RESPONSE (LK_ALL_KEYS_UP),
 307         RESPONSE (LK_METRONOME),
 308         RESPONSE (LK_OUTPUT_ERROR),
 309         RESPONSE (LK_INPUT_ERROR),
 310         RESPONSE (LK_KBD_LOCKED),
 311         RESPONSE (LK_KBD_TEST_MODE_ACK),
 312         RESPONSE (LK_PREFIX_KEY_DOWN),
 313         RESPONSE (LK_MODE_CHANGE_ACK),
 314         RESPONSE (LK_RESPONSE_RESERVED),
 315 #undef RESPONSE
 316 };
 317
 318 static unsigned char *
 319 response_name (unsigned char value)
 320 {
 321         int i;
 322
 323         for (i = 0; i < ARRAY_SIZE (lk_response); i++)
 324                 if (lk_response[i].value == value)
 325                         return lk_response[i].name;
 326
 327         return "<unknown>";
 328 }
 329 #endif /* LKKBD_DEBUG */
 330
 331 /*
 332  * Calculate volume parameter byte for a given volume.
 333  */
 334 static unsigned char
 335 volume_to_hw (int volume_percent)
 336 {
 337         unsigned char ret = 0;
 338
 339         if (volume_percent < 0)
 340                 volume_percent = 0;
 341         if (volume_percent > 100)
 342                 volume_percent = 100;
 343
 344         if (volume_percent >= 0)
 345                 ret = 7;
 346         if (volume_percent >= 13)       /* 12.5 */
 347                 ret = 6;
 348         if (volume_percent >= 25)
 349                 ret = 5;
 350         if (volume_percent >= 38)       /* 37.5 */
 351                 ret = 4;
 352         if (volume_percent >= 50)
 353                 ret = 3;
 354         if (volume_percent >= 63)       /* 62.5 */
 355                 ret = 2;                /* This is the default volume */
 356         if (volume_percent >= 75)
 357                 ret = 1;
 358         if (volume_percent >= 88)       /* 87.5 */
 359                 ret = 0;
 360
 361         ret |= 0x80;
 362
 363         return ret;
 364 }
 365
 366 static void
 367 lkkbd_detection_done (struct lkkbd *lk)
 368 {
 369         int i;
 370
 371         /*
 372          * Reset setting for Compose key. Let Compose be KEY_COMPOSE.
 373          */
 374         lk->keycode[0xb1] = KEY_COMPOSE;
 375
 376         /*
 377          * Print keyboard name and modify Compose=Alt on user's request.
 378          */
 379         switch (lk->id[4]) {
 380                 case 1:
 381                         strlcpy (lk->name, "DEC LK201 keyboard",
 382                                  sizeof (lk->name));
 383
 384                         if (lk201_compose_is_alt)
 385                                 lk->keycode[0xb1] = KEY_LEFTALT;
 386                         break;
 387
 388                 case 2:
 389                         strlcpy (lk->name, "DEC LK401 keyboard",
 390                                  sizeof (lk->name));
 391                         break;
 392
 393                 default:
 394                         strlcpy (lk->name, "Unknown DEC keyboard",
 395                                  sizeof (lk->name));
 396                         printk (KERN_ERR "lkkbd: keyboard on %s is unknown, "
 397                                         "please report to Jan-Benedict Glaw "
 398                                         "<jbglaw@lug-owl.de>\n", lk->phys);
 399                         printk (KERN_ERR "lkkbd: keyboard ID'ed as:");
 400                         for (i = 0; i < LK_NUM_IGNORE_BYTES; i++)
 401                                 printk (" 0x%02x", lk->id[i]);
 402                         printk ("\n");
 403                         break;
 404         }
 405         printk (KERN_INFO "lkkbd: keyboard on %s identified as: %s\n",
 406                         lk->phys, lk->name);
 407
 408         /*
 409          * Report errors during keyboard boot-up.
 410          */
 411         switch (lk->id[2]) {
 412                 case 0x00:
 413                         /* All okay */
 414                         break;
 415
 416                 case LK_STUCK_KEY:
 417                         printk (KERN_ERR "lkkbd: Stuck key on keyboard at "
 418                                         "%s\n", lk->phys);
 419                         break;
 420
 421                 case LK_SELFTEST_FAILED:
 422                         printk (KERN_ERR "lkkbd: Selftest failed on keyboard "
 423                                         "at %s, keyboard may not work "
 424                                         "properly\n", lk->phys);
 425                         break;
 426
 427                 default:
 428                         printk (KERN_ERR "lkkbd: Unknown error %02x on "
 429                                         "keyboard at %s\n", lk->id[2],
 430                                         lk->phys);
 431                         break;
 432         }
 433
 434         /*
 435          * Try to hint user if there's a stuck key.
 436          */
 437         if (lk->id[2] == LK_STUCK_KEY && lk->id[3] != 0)
 438                 printk (KERN_ERR "Scancode of stuck key is 0x%02x, keycode "
 439                                 "is 0x%04x\n", lk->id[3],
 440                                 lk->keycode[lk->id[3]]);
 441
 442         return;
 443 }
 444
 445 /*
 446  * lkkbd_interrupt() is called by the low level driver when a character
 447  * is received.
 448  */
 449 static irqreturn_t
 450 lkkbd_interrupt (struct serio *serio, unsigned char data, unsigned int flags)
 451 {
 452         struct lkkbd *lk = serio_get_drvdata (serio);
 453         int i;
 454
 455         DBG (KERN_INFO "Got byte 0x%02x\n", data);
 456
 457         if (lk->ignore_bytes > 0) {
 458                 DBG (KERN_INFO "Ignoring a byte on %s\n", lk->name);
 459                 lk->id[LK_NUM_IGNORE_BYTES - lk->ignore_bytes--] = data;
 460
 461                 if (lk->ignore_bytes == 0)
 462                         lkkbd_detection_done (lk);
 463
 464                 return IRQ_HANDLED;
 465         }
 466
 467         switch (data) {
 468                 case LK_ALL_KEYS_UP:
 469                         for (i = 0; i < ARRAY_SIZE (lkkbd_keycode); i++)
 470                                 if (lk->keycode[i] != KEY_RESERVED)
 471                                         input_report_key (lk->dev, lk->keycode[i], 0);
 472                         input_sync (lk->dev);
 473                         break;
 474
 475                 case 0x01:
 476                         DBG (KERN_INFO "Got 0x01, scheduling re-initialization\n");
 477                         lk->ignore_bytes = LK_NUM_IGNORE_BYTES;
 478                         lk->id[LK_NUM_IGNORE_BYTES - lk->ignore_bytes--] = data;
 479                         schedule_work (&lk->tq);
 480                         break;
 481
 482                 case LK_METRONOME:
 483                 case LK_OUTPUT_ERROR:
 484                 case LK_INPUT_ERROR:
 485                 case LK_KBD_LOCKED:
 486                 case LK_KBD_TEST_MODE_ACK:
 487                 case LK_PREFIX_KEY_DOWN:
 488                 case LK_MODE_CHANGE_ACK:
 489                 case LK_RESPONSE_RESERVED:
 490                         DBG (KERN_INFO "Got %s and don't know how to handle...\n",
 491                                         response_name (data));
 492                         break;
 493
 494                 default:
 495                         if (lk->keycode[data] != KEY_RESERVED) {
 496                                 if (!test_bit (lk->keycode[data], lk->dev->key))
 497                                         input_report_key (lk->dev, lk->keycode[data], 1);
 498                                 else
 499                                         input_report_key (lk->dev, lk->keycode[data], 0);
 500                                 input_sync (lk->dev);
 501                         } else
 502                                 printk (KERN_WARNING "%s: Unknown key with "
 503                                                 "scancode 0x%02x on %s.\n",
 504                                                 __FILE__, data, lk->name);
 505         }
 506
 507         return IRQ_HANDLED;
 508 }
 509
 510 /*
 511  * lkkbd_event() handles events from the input module.
 512  */
 513 static int
 514 lkkbd_event (struct input_dev *dev, unsigned int type, unsigned int code,
 515                 int value)
 516 {
 517         struct lkkbd *lk = input_get_drvdata (dev);
 518         unsigned char leds_on = 0;
 519         unsigned char leds_off = 0;
 520
 521         switch (type) {
 522                 case EV_LED:
 523                         CHECK_LED (lk, leds_on, leds_off, LED_CAPSL, LK_LED_SHIFTLOCK);
 524                         CHECK_LED (lk, leds_on, leds_off, LED_COMPOSE, LK_LED_COMPOSE);
 525                         CHECK_LED (lk, leds_on, leds_off, LED_SCROLLL, LK_LED_SCROLLLOCK);
 526                         CHECK_LED (lk, leds_on, leds_off, LED_SLEEP, LK_LED_WAIT);
 527                         if (leds_on != 0) {
 528                                 lk->serio->write (lk->serio, LK_CMD_LED_ON);
 529                                 lk->serio->write (lk->serio, leds_on);
 530                         }
 531                         if (leds_off != 0) {
 532                                 lk->serio->write (lk->serio, LK_CMD_LED_OFF);
 533                                 lk->serio->write (lk->serio, leds_off);
 534                         }
 535                         return 0;
 536
 537                 case EV_SND:
 538                         switch (code) {
 539                                 case SND_CLICK:
 540                                         if (value == 0) {
 541                                                 DBG ("%s: Deactivating key clicks\n", __func__);
 542                                                 lk->serio->write (lk->serio, LK_CMD_DISABLE_KEYCLICK);
 543                                                 lk->serio->write (lk->serio, LK_CMD_DISABLE_CTRCLICK);
 544                                         } else {
 545                                                 DBG ("%s: Activating key clicks\n", __func__);
 546                                                 lk->serio->write (lk->serio, LK_CMD_ENABLE_KEYCLICK);
 547                                                 lk->serio->write (lk->serio, volume_to_hw (lk->keyclick_volume));
 548                                                 lk->serio->write (lk->serio, LK_CMD_ENABLE_CTRCLICK);
 549                                                 lk->serio->write (lk->serio, volume_to_hw (lk->ctrlclick_volume));
 550                                         }
 551                                         return 0;
 552
 553                                 case SND_BELL:
 554                                         if (value != 0)
 555                                                 lk->serio->write (lk->serio, LK_CMD_SOUND_BELL);
 556
 557                                         return 0;
 558                         }
 559                         break;
 560
 561                 default:
 562                         printk (KERN_ERR "%s (): Got unknown type %d, code %d, value %d\n",
 563                                         __func__, type, code, value);
 564         }
 565
 566         return -1;
 567 }
 568
 569 /*
 570  * lkkbd_reinit() sets leds and beeps to a state the computer remembers they
 571  * were in.
 572  */
 573 static void
 574 lkkbd_reinit (struct work_struct *work)
 575 {
 576         struct lkkbd *lk = container_of(work, struct lkkbd, tq);
 577         int division;
 578         unsigned char leds_on = 0;
 579         unsigned char leds_off = 0;
 580
 581         /* Ask for ID */
 582         lk->serio->write (lk->serio, LK_CMD_REQUEST_ID);
 583
 584         /* Reset parameters */
 585         lk->serio->write (lk->serio, LK_CMD_SET_DEFAULTS);
 586
 587         /* Set LEDs */
 588         CHECK_LED (lk, leds_on, leds_off, LED_CAPSL, LK_LED_SHIFTLOCK);
 589         CHECK_LED (lk, leds_on, leds_off, LED_COMPOSE, LK_LED_COMPOSE);
 590         CHECK_LED (lk, leds_on, leds_off, LED_SCROLLL, LK_LED_SCROLLLOCK);
 591         CHECK_LED (lk, leds_on, leds_off, LED_SLEEP, LK_LED_WAIT);
 592         if (leds_on != 0) {
 593                 lk->serio->write (lk->serio, LK_CMD_LED_ON);
 594                 lk->serio->write (lk->serio, leds_on);
 595         }
 596         if (leds_off != 0) {
 597                 lk->serio->write (lk->serio, LK_CMD_LED_OFF);
 598                 lk->serio->write (lk->serio, leds_off);
 599         }
 600
 601         /*
 602          * Try to activate extended LK401 mode. This command will
 603          * only work with a LK401 keyboard and grants access to
 604          * LAlt, RAlt, RCompose and RShift.
 605          */
 606         lk->serio->write (lk->serio, LK_CMD_ENABLE_LK401);
 607
 608         /* Set all keys to UPDOWN mode */
 609         for (division = 1; division <= 14; division++)
 610                 lk->serio->write (lk->serio, LK_CMD_SET_MODE (LK_MODE_UPDOWN,
 611                                         division));
 612
 613         /* Enable bell and set volume */
 614         lk->serio->write (lk->serio, LK_CMD_ENABLE_BELL);
 615         lk->serio->write (lk->serio, volume_to_hw (lk->bell_volume));
 616
 617         /* Enable/disable keyclick (and possibly set volume) */
 618         if (test_bit (SND_CLICK, lk->dev->snd)) {
 619                 lk->serio->write (lk->serio, LK_CMD_ENABLE_KEYCLICK);
 620                 lk->serio->write (lk->serio, volume_to_hw (lk->keyclick_volume));
 621                 lk->serio->write (lk->serio, LK_CMD_ENABLE_CTRCLICK);
 622                 lk->serio->write (lk->serio, volume_to_hw (lk->ctrlclick_volume));
 623         } else {
 624                 lk->serio->write (lk->serio, LK_CMD_DISABLE_KEYCLICK);
 625                 lk->serio->write (lk->serio, LK_CMD_DISABLE_CTRCLICK);
 626         }
 627
 628         /* Sound the bell if needed */
 629         if (test_bit (SND_BELL, lk->dev->snd))
 630                 lk->serio->write (lk->serio, LK_CMD_SOUND_BELL);
 631 }
 632
 633 /*
 634  * lkkbd_connect() probes for a LK keyboard and fills the necessary structures.
 635  */
 636 static int
 637 lkkbd_connect (struct serio *serio, struct serio_driver *drv)
 638 {
 639         struct lkkbd *lk;
 640         struct input_dev *input_dev;
 641         int i;
 642         int err;
 643
 644         lk = kzalloc (sizeof (struct lkkbd), GFP_KERNEL);
 645         input_dev = input_allocate_device ();
 646         if (!lk || !input_dev) {
 647                 err = -ENOMEM;
 648                 goto fail1;
 649         }
 650
 651         lk->serio = serio;
 652         lk->dev = input_dev;
 653         INIT_WORK (&lk->tq, lkkbd_reinit);
 654         lk->bell_volume = bell_volume;
 655         lk->keyclick_volume = keyclick_volume;
 656         lk->ctrlclick_volume = ctrlclick_volume;
 657         memcpy (lk->keycode, lkkbd_keycode, sizeof (lk_keycode_t) * LK_NUM_KEYCODES);
 658
 659         strlcpy (lk->name, "DEC LK keyboard", sizeof(lk->name));
 660         snprintf (lk->phys, sizeof(lk->phys), "%s/input0", serio->phys);
 661
 662         input_dev->name = lk->name;
 663         input_dev->phys = lk->phys;
 664         input_dev->id.bustype = BUS_RS232;
 665         input_dev->id.vendor = SERIO_LKKBD;
 666         input_dev->id.product = 0;
 667         input_dev->id.version = 0x0100;
 668         input_dev->dev.parent = &serio->dev;
 669         input_dev->event = lkkbd_event;
 670
 671         input_set_drvdata (input_dev, lk);
 672
 673         set_bit (EV_KEY, input_dev->evbit);
 674         set_bit (EV_LED, input_dev->evbit);
 675         set_bit (EV_SND, input_dev->evbit);
 676         set_bit (EV_REP, input_dev->evbit);
 677         set_bit (LED_CAPSL, input_dev->ledbit);
 678         set_bit (LED_SLEEP, input_dev->ledbit);
 679         set_bit (LED_COMPOSE, input_dev->ledbit);
 680         set_bit (LED_SCROLLL, input_dev->ledbit);
 681         set_bit (SND_BELL, input_dev->sndbit);
 682         set_bit (SND_CLICK, input_dev->sndbit);
 683
 684         input_dev->keycode = lk->keycode;
 685         input_dev->keycodesize = sizeof (lk_keycode_t);
 686         input_dev->keycodemax = LK_NUM_KEYCODES;
 687         for (i = 0; i < LK_NUM_KEYCODES; i++)
 688                 set_bit (lk->keycode[i], input_dev->keybit);
 689
 690         serio_set_drvdata (serio, lk);
 691
 692         err = serio_open (serio, drv);
 693         if (err)
 694                 goto fail2;
 695
 696         err = input_register_device (lk->dev);
 697         if (err)
 698                 goto fail3;
 699
 700         lk->serio->write (lk->serio, LK_CMD_POWERCYCLE_RESET);
 701
 702         return 0;
 703
 704  fail3: serio_close (serio);
 705  fail2: serio_set_drvdata (serio, NULL);
 706  fail1: input_free_device (input_dev);
 707         kfree (lk);
 708         return err;
 709 }
 710
 711 /*
 712  * lkkbd_disconnect() unregisters and closes behind us.
 713  */
 714 static void
 715 lkkbd_disconnect (struct serio *serio)
 716 {
 717         struct lkkbd *lk = serio_get_drvdata (serio);
 718
 719         input_get_device (lk->dev);
 720         input_unregister_device (lk->dev);
 721         serio_close (serio);
 722         serio_set_drvdata (serio, NULL);
 723         input_put_device (lk->dev);
 724         kfree (lk);
 725 }
 726
 727 static struct serio_device_id lkkbd_serio_ids[] = {
 728         {
 729                 .type   = SERIO_RS232,
 730                 .proto  = SERIO_LKKBD,
 731                 .id     = SERIO_ANY,
 732                 .extra  = SERIO_ANY,
 733         },
 734         { 0 }
 735 };
 736
 737 MODULE_DEVICE_TABLE(serio, lkkbd_serio_ids);
 738
 739 static struct serio_driver lkkbd_drv = {
 740         .driver         = {
 741                 .name   = "lkkbd",
 742         },
 743         .description    = DRIVER_DESC,
 744         .id_table       = lkkbd_serio_ids,
 745         .connect        = lkkbd_connect,
 746         .disconnect     = lkkbd_disconnect,
 747         .interrupt      = lkkbd_interrupt,
 748 };
 749
 750 /*
 751  * The functions for insering/removing us as a module.
 752  */
 753 static int __init
 754 lkkbd_init (void)
 755 {
 756         return serio_register_driver(&lkkbd_drv);
 757 }
 758
 759 static void __exit
 760 lkkbd_exit (void)
 761 {
 762         serio_unregister_driver(&lkkbd_drv);
 763 }
 764
 765 module_init (lkkbd_init);
 766 module_exit (lkkbd_exit);
 767