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  * RJ11 pinout:         To DB9:         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 DB9 or DB25!!!
  22  *
  23  * Pin numbers for DB9 and DB25 are noted on the plug (quite small:). For
  24  * RJ11, 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  * Should you need to contact me, the author, you can do so either by
  64  * email or by paper mail:
  65  * Jan-Benedict Glaw, Lilienstraße 16, 33790 Hörste (near Halle/Westf.),
  66  * Germany.
  67  */
  68
  69 #include <linux/delay.h>
  70 #include <linux/slab.h>
  71 #include <linux/module.h>
  72 #include <linux/moduleparam.h>
  73 #include <linux/interrupt.h>
  74 #include <linux/init.h>
  75 #include <linux/input.h>
  76 #include <linux/serio.h>
  77 #include <linux/workqueue.h>
  78
  79 MODULE_AUTHOR ("Jan-Benedict Glaw <jbglaw@lug-owl.de>");
  80 MODULE_DESCRIPTION ("LK keyboard driver");
  81 MODULE_LICENSE ("GPL");
  82
  83 /*
  84  * Known parameters:
  85  *      bell_volume
  86  *      keyclick_volume
  87  *      ctrlclick_volume
  88  *
  89  * Please notice that there's not yet an API to set these at runtime.
  90  */
  91 static int bell_volume = 100; /* % */
  92 module_param (bell_volume, int, 0);
  93 MODULE_PARM_DESC (bell_volume, "Bell volume (in %). default is 100%");
  94
  95 static int keyclick_volume = 100; /* % */
  96 module_param (keyclick_volume, int, 0);
  97 MODULE_PARM_DESC (keyclick_volume, "Keyclick volume (in %), default is 100%");
  98
  99 static int ctrlclick_volume = 100; /* % */
 100 module_param (ctrlclick_volume, int, 0);
 101 MODULE_PARM_DESC (ctrlclick_volume, "Ctrlclick volume (in %), default is 100%");
 102
 103 static int lk201_compose_is_alt = 0;
 104 module_param (lk201_compose_is_alt, int, 0);
 105 MODULE_PARM_DESC (lk201_compose_is_alt, "If set non-zero, LK201' Compose key "
 106                 "will act as an Alt key");
 107
 108
 109
 110 #undef LKKBD_DEBUG
 111 #ifdef LKKBD_DEBUG
 112 #define DBG(x...) printk (x)
 113 #else
 114 #define DBG(x...) do {} while (0)
 115 #endif
 116
 117 /* LED control */
 118 #define LK_LED_WAIT             0x81
 119 #define LK_LED_COMPOSE          0x82
 120 #define LK_LED_SHIFTLOCK        0x84
 121 #define LK_LED_SCROLLLOCK       0x88
 122 #define LK_CMD_LED_ON           0x13
 123 #define LK_CMD_LED_OFF          0x11
 124
 125 /* Mode control */
 126 #define LK_MODE_DOWN            0x80
 127 #define LK_MODE_AUTODOWN        0x82
 128 #define LK_MODE_UPDOWN          0x86
 129 #define LK_CMD_SET_MODE(mode,div)       ((mode) | ((div) << 3))
 130
 131 /* Misc commands */
 132 #define LK_CMD_ENABLE_KEYCLICK  0x1b
 133 #define LK_CMD_DISABLE_KEYCLICK 0x99
 134 #define LK_CMD_DISABLE_BELL     0xa1
 135 #define LK_CMD_SOUND_BELL       0xa7
 136 #define LK_CMD_ENABLE_BELL      0x23
 137 #define LK_CMD_DISABLE_CTRCLICK 0xb9
 138 #define LK_CMD_ENABLE_CTRCLICK  0xbb
 139 #define LK_CMD_SET_DEFAULTS     0xd3
 140 #define LK_CMD_POWERCYCLE_RESET 0xfd
 141 #define LK_CMD_ENABLE_LK401     0xe9
 142 #define LK_CMD_REQUEST_ID       0xab
 143
 144 /* Misc responses from keyboard */
 145 #define LK_STUCK_KEY            0x3d
 146 #define LK_SELFTEST_FAILED      0x3e
 147 #define LK_ALL_KEYS_UP          0xb3
 148 #define LK_METRONOME            0xb4
 149 #define LK_OUTPUT_ERROR         0xb5
 150 #define LK_INPUT_ERROR          0xb6
 151 #define LK_KBD_LOCKED           0xb7
 152 #define LK_KBD_TEST_MODE_ACK    0xb8
 153 #define LK_PREFIX_KEY_DOWN      0xb9
 154 #define LK_MODE_CHANGE_ACK      0xba
 155 #define LK_RESPONSE_RESERVED    0xbb
 156
 157 #define LK_NUM_KEYCODES         256
 158 #define LK_NUM_IGNORE_BYTES     6
 159 typedef u_int16_t lk_keycode_t;
 160
 161
 162
 163 static lk_keycode_t lkkbd_keycode[LK_NUM_KEYCODES] = {
 164         [0x56] = KEY_F1,
 165         [0x57] = KEY_F2,
 166         [0x58] = KEY_F3,
 167         [0x59] = KEY_F4,
 168         [0x5a] = KEY_F5,
 169         [0x64] = KEY_F6,
 170         [0x65] = KEY_F7,
 171         [0x66] = KEY_F8,
 172         [0x67] = KEY_F9,
 173         [0x68] = KEY_F10,
 174         [0x71] = KEY_F11,
 175         [0x72] = KEY_F12,
 176         [0x73] = KEY_F13,
 177         [0x74] = KEY_F14,
 178         [0x7c] = KEY_F15,
 179         [0x7d] = KEY_F16,
 180         [0x80] = KEY_F17,
 181         [0x81] = KEY_F18,
 182         [0x82] = KEY_F19,
 183         [0x83] = KEY_F20,
 184         [0x8a] = KEY_FIND,
 185         [0x8b] = KEY_INSERT,
 186         [0x8c] = KEY_DELETE,
 187         [0x8d] = KEY_SELECT,
 188         [0x8e] = KEY_PAGEUP,
 189         [0x8f] = KEY_PAGEDOWN,
 190         [0x92] = KEY_KP0,
 191         [0x94] = KEY_KPDOT,
 192         [0x95] = KEY_KPENTER,
 193         [0x96] = KEY_KP1,
 194         [0x97] = KEY_KP2,
 195         [0x98] = KEY_KP3,
 196         [0x99] = KEY_KP4,
 197         [0x9a] = KEY_KP5,
 198         [0x9b] = KEY_KP6,
 199         [0x9c] = KEY_KPCOMMA,
 200         [0x9d] = KEY_KP7,
 201         [0x9e] = KEY_KP8,
 202         [0x9f] = KEY_KP9,
 203         [0xa0] = KEY_KPMINUS,
 204         [0xa1] = KEY_PROG1,
 205         [0xa2] = KEY_PROG2,
 206         [0xa3] = KEY_PROG3,
 207         [0xa4] = KEY_PROG4,
 208         [0xa7] = KEY_LEFT,
 209         [0xa8] = KEY_RIGHT,
 210         [0xa9] = KEY_DOWN,
 211         [0xaa] = KEY_UP,
 212         [0xab] = KEY_RIGHTSHIFT,
 213         [0xac] = KEY_LEFTALT,
 214         [0xad] = KEY_COMPOSE, /* Right Compose, that is. */
 215         [0xae] = KEY_LEFTSHIFT, /* Same as KEY_RIGHTSHIFT on LK201 */
 216         [0xaf] = KEY_LEFTCTRL,
 217         [0xb0] = KEY_CAPSLOCK,
 218         [0xb1] = KEY_COMPOSE, /* Left Compose, that is. */
 219         [0xb2] = KEY_RIGHTALT,
 220         [0xbc] = KEY_BACKSPACE,
 221         [0xbd] = KEY_ENTER,
 222         [0xbe] = KEY_TAB,
 223         [0xbf] = KEY_ESC,
 224         [0xc0] = KEY_1,
 225         [0xc1] = KEY_Q,
 226         [0xc2] = KEY_A,
 227         [0xc3] = KEY_Z,
 228         [0xc5] = KEY_2,
 229         [0xc6] = KEY_W,
 230         [0xc7] = KEY_S,
 231         [0xc8] = KEY_X,
 232         [0xc9] = KEY_102ND,
 233         [0xcb] = KEY_3,
 234         [0xcc] = KEY_E,
 235         [0xcd] = KEY_D,
 236         [0xce] = KEY_C,
 237         [0xd0] = KEY_4,
 238         [0xd1] = KEY_R,
 239         [0xd2] = KEY_F,
 240         [0xd3] = KEY_V,
 241         [0xd4] = KEY_SPACE,
 242         [0xd6] = KEY_5,
 243         [0xd7] = KEY_T,
 244         [0xd8] = KEY_G,
 245         [0xd9] = KEY_B,
 246         [0xdb] = KEY_6,
 247         [0xdc] = KEY_Y,
 248         [0xdd] = KEY_H,
 249         [0xde] = KEY_N,
 250         [0xe0] = KEY_7,
 251         [0xe1] = KEY_U,
 252         [0xe2] = KEY_J,
 253         [0xe3] = KEY_M,
 254         [0xe5] = KEY_8,
 255         [0xe6] = KEY_I,
 256         [0xe7] = KEY_K,
 257         [0xe8] = KEY_COMMA,
 258         [0xea] = KEY_9,
 259         [0xeb] = KEY_O,
 260         [0xec] = KEY_L,
 261         [0xed] = KEY_DOT,
 262         [0xef] = KEY_0,
 263         [0xf0] = KEY_P,
 264         [0xf2] = KEY_SEMICOLON,
 265         [0xf3] = KEY_SLASH,
 266         [0xf5] = KEY_EQUAL,
 267         [0xf6] = KEY_RIGHTBRACE,
 268         [0xf7] = KEY_BACKSLASH,
 269         [0xf9] = KEY_MINUS,
 270         [0xfa] = KEY_LEFTBRACE,
 271         [0xfb] = KEY_APOSTROPHE,
 272 };
 273
 274 #define CHECK_LED(LED, BITS) do {               \
 275         if (test_bit (LED, lk->dev.led))        \
 276                 leds_on |= BITS;                \
 277         else                                    \
 278                 leds_off |= BITS;               \
 279         } while (0)
 280
 281 /*
 282  * Per-keyboard data
 283  */
 284 struct lkkbd {
 285         lk_keycode_t keycode[LK_NUM_KEYCODES];
 286         int ignore_bytes;
 287         unsigned char id[LK_NUM_IGNORE_BYTES];
 288         struct input_dev dev;
 289         struct serio *serio;
 290         struct work_struct tq;
 291         char name[64];
 292         char phys[32];
 293         char type;
 294         int bell_volume;
 295         int keyclick_volume;
 296         int ctrlclick_volume;
 297 };
 298
 299 /*
 300  * Calculate volume parameter byte for a given volume.
 301  */
 302 static unsigned char
 303 volume_to_hw (int volume_percent)
 304 {
 305         unsigned char ret = 0;
 306
 307         if (volume_percent < 0)
 308                 volume_percent = 0;
 309         if (volume_percent > 100)
 310                 volume_percent = 100;
 311
 312         if (volume_percent >= 0)
 313                 ret = 7;
 314         if (volume_percent >= 13)       /* 12.5 */
 315                 ret = 6;
 316         if (volume_percent >= 25)
 317                 ret = 5;
 318         if (volume_percent >= 38)       /* 37.5 */
 319                 ret = 4;
 320         if (volume_percent >= 50)
 321                 ret = 3;
 322         if (volume_percent >= 63)       /* 62.5 */
 323                 ret = 2;                /* This is the default volume */
 324         if (volume_percent >= 75)
 325                 ret = 1;
 326         if (volume_percent >= 88)       /* 87.5 */
 327                 ret = 0;
 328
 329         ret |= 0x80;
 330
 331         return ret;
 332 }
 333
 334 static void
 335 lkkbd_detection_done (struct lkkbd *lk)
 336 {
 337         int i;
 338
 339         /*
 340          * Reset setting for Compose key. Let Compose be KEY_COMPOSE.
 341          */
 342         lk->keycode[0xb1] = KEY_COMPOSE;
 343
 344         /*
 345          * Print keyboard name and modify Compose=Alt on user's request.
 346          */
 347         switch (lk->id[4]) {
 348                 case 1:
 349                         sprintf (lk->name, "DEC LK201 keyboard");
 350
 351                         if (lk201_compose_is_alt)
 352                                 lk->keycode[0xb1] = KEY_LEFTALT;
 353                         break;
 354
 355                 case 2:
 356                         sprintf (lk->name, "DEC LK401 keyboard");
 357                         break;
 358
 359                 default:
 360                         sprintf (lk->name, "Unknown DEC keyboard");
 361                         printk (KERN_ERR "lkkbd: keyboard on %s is unknown, "
 362                                         "please report to Jan-Benedict Glaw "
 363                                         "<jbglaw@lug-owl.de>\n", lk->phys);
 364                         printk (KERN_ERR "lkkbd: keyboard ID'ed as:");
 365                         for (i = 0; i < LK_NUM_IGNORE_BYTES; i++)
 366                                 printk (" 0x%02x", lk->id[i]);
 367                         printk ("\n");
 368                         break;
 369         }
 370         printk (KERN_INFO "lkkbd: keyboard on %s identified as: %s\n",
 371                         lk->phys, lk->name);
 372
 373         /*
 374          * Report errors during keyboard boot-up.
 375          */
 376         switch (lk->id[2]) {
 377                 case 0x00:
 378                         /* All okay */
 379                         break;
 380
 381                 case LK_STUCK_KEY:
 382                         printk (KERN_ERR "lkkbd: Stuck key on keyboard at "
 383                                         "%s\n", lk->phys);
 384                         break;
 385
 386                 case LK_SELFTEST_FAILED:
 387                         printk (KERN_ERR "lkkbd: Selftest failed on keyboard "
 388                                         "at %s, keyboard may not work "
 389                                         "properly\n", lk->phys);
 390                         break;
 391
 392                 default:
 393                         printk (KERN_ERR "lkkbd: Unknown error %02x on "
 394                                         "keyboard at %s\n", lk->id[2],
 395                                         lk->phys);
 396                         break;
 397         }
 398
 399         /*
 400          * Try to hint user if there's a stuck key.
 401          */
 402         if (lk->id[2] == LK_STUCK_KEY && lk->id[3] != 0)
 403                 printk (KERN_ERR "Scancode of stuck key is 0x%02x, keycode "
 404                                 "is 0x%04x\n", lk->id[3],
 405                                 lk->keycode[lk->id[3]]);
 406
 407         return;
 408 }
 409
 410 /*
 411  * lkkbd_interrupt() is called by the low level driver when a character
 412  * is received.
 413  */
 414 static irqreturn_t
 415 lkkbd_interrupt (struct serio *serio, unsigned char data, unsigned int flags,
 416                 struct pt_regs *regs)
 417 {
 418         struct lkkbd *lk = serio->private;
 419         int i;
 420
 421         DBG (KERN_INFO "Got byte 0x%02x\n", data);
 422
 423         if (lk->ignore_bytes > 0) {
 424                 DBG (KERN_INFO "Ignoring a byte on %s\n",
 425                                 lk->name);
 426                 lk->id[LK_NUM_IGNORE_BYTES - lk->ignore_bytes--] = data;
 427
 428                 if (lk->ignore_bytes == 0)
 429                         lkkbd_detection_done (lk);
 430
 431                 return IRQ_HANDLED;
 432         }
 433
 434         switch (data) {
 435                 case LK_ALL_KEYS_UP:
 436                         input_regs (&lk->dev, regs);
 437                         for (i = 0; i < ARRAY_SIZE (lkkbd_keycode); i++)
 438                                 if (lk->keycode[i] != KEY_RESERVED)
 439                                         input_report_key (&lk->dev, lk->keycode[i], 0);
 440                         input_sync (&lk->dev);
 441                         break;
 442                 case LK_METRONOME:
 443                         DBG (KERN_INFO "Got LK_METRONOME and don't "
 444                                         "know how to handle...\n");
 445                         break;
 446                 case LK_OUTPUT_ERROR:
 447                         DBG (KERN_INFO "Got LK_OUTPUT_ERROR and don't "
 448                                         "know how to handle...\n");
 449                         break;
 450                 case LK_INPUT_ERROR:
 451                         DBG (KERN_INFO "Got LK_INPUT_ERROR and don't "
 452                                         "know how to handle...\n");
 453                         break;
 454                 case LK_KBD_LOCKED:
 455                         DBG (KERN_INFO "Got LK_KBD_LOCKED and don't "
 456                                         "know how to handle...\n");
 457                         break;
 458                 case LK_KBD_TEST_MODE_ACK:
 459                         DBG (KERN_INFO "Got LK_KBD_TEST_MODE_ACK and don't "
 460                                         "know how to handle...\n");
 461                         break;
 462                 case LK_PREFIX_KEY_DOWN:
 463                         DBG (KERN_INFO "Got LK_PREFIX_KEY_DOWN and don't "
 464                                         "know how to handle...\n");
 465                         break;
 466                 case LK_MODE_CHANGE_ACK:
 467                         DBG (KERN_INFO "Got LK_MODE_CHANGE_ACK and ignored "
 468                                         "it properly...\n");
 469                         break;
 470                 case LK_RESPONSE_RESERVED:
 471                         DBG (KERN_INFO "Got LK_RESPONSE_RESERVED and don't "
 472                                         "know how to handle...\n");
 473                         break;
 474                 case 0x01:
 475                         DBG (KERN_INFO "Got 0x01, scheduling re-initialization\n");
 476                         lk->ignore_bytes = LK_NUM_IGNORE_BYTES;
 477                         lk->id[LK_NUM_IGNORE_BYTES - lk->ignore_bytes--] = data;
 478                         schedule_work (&lk->tq);
 479                         break;
 480
 481                 default:
 482                         if (lk->keycode[data] != KEY_RESERVED) {
 483                                 input_regs (&lk->dev, regs);
 484                                 if (!test_bit (lk->keycode[data], lk->dev.key))
 485                                         input_report_key (&lk->dev, lk->keycode[data], 1);
 486                                 else
 487                                         input_report_key (&lk->dev, lk->keycode[data], 0);
 488                                 input_sync (&lk->dev);
 489                         } else
 490                                 printk (KERN_WARNING "%s: Unknown key with "
 491                                                 "scancode 0x%02x on %s.\n",
 492                                                 __FILE__, data, lk->name);
 493         }
 494
 495         return IRQ_HANDLED;
 496 }
 497
 498 /*
 499  * lkkbd_event() handles events from the input module.
 500  */
 501 static int
 502 lkkbd_event (struct input_dev *dev, unsigned int type, unsigned int code,
 503                 int value)
 504 {
 505         struct lkkbd *lk = dev->private;
 506         unsigned char leds_on = 0;
 507         unsigned char leds_off = 0;
 508
 509         switch (type) {
 510                 case EV_LED:
 511                         CHECK_LED (LED_CAPSL, LK_LED_SHIFTLOCK);
 512                         CHECK_LED (LED_COMPOSE, LK_LED_COMPOSE);
 513                         CHECK_LED (LED_SCROLLL, LK_LED_SCROLLLOCK);
 514                         CHECK_LED (LED_SLEEP, LK_LED_WAIT);
 515                         if (leds_on != 0) {
 516                                 lk->serio->write (lk->serio, LK_CMD_LED_ON);
 517                                 lk->serio->write (lk->serio, leds_on);
 518                         }
 519                         if (leds_off != 0) {
 520                                 lk->serio->write (lk->serio, LK_CMD_LED_OFF);
 521                                 lk->serio->write (lk->serio, leds_off);
 522                         }
 523                         return 0;
 524
 525                 case EV_SND:
 526                         switch (code) {
 527                                 case SND_CLICK:
 528                                         if (value == 0) {
 529                                                 DBG ("%s: Deactivating key clicks\n", __FUNCTION__);
 530                                                 lk->serio->write (lk->serio, LK_CMD_DISABLE_KEYCLICK);
 531                                                 lk->serio->write (lk->serio, LK_CMD_DISABLE_CTRCLICK);
 532                                         } else {
 533                                                 DBG ("%s: Activating key clicks\n", __FUNCTION__);
 534                                                 lk->serio->write (lk->serio, LK_CMD_ENABLE_KEYCLICK);
 535                                                 lk->serio->write (lk->serio, volume_to_hw (lk->keyclick_volume));
 536                                                 lk->serio->write (lk->serio, LK_CMD_ENABLE_CTRCLICK);
 537                                                 lk->serio->write (lk->serio, volume_to_hw (lk->ctrlclick_volume));
 538                                         }
 539                                         return 0;
 540
 541                                 case SND_BELL:
 542                                         if (value != 0)
 543                                                 lk->serio->write (lk->serio, LK_CMD_SOUND_BELL);
 544
 545                                         return 0;
 546                         }
 547                         break;
 548
 549                 default:
 550                         printk (KERN_ERR "%s (): Got unknown type %d, code %d, value %d\n",
 551                                         __FUNCTION__, type, code, value);
 552         }
 553
 554         return -1;
 555 }
 556
 557 /*
 558  * lkkbd_reinit() sets leds and beeps to a state the computer remembers they
 559  * were in.
 560  */
 561 static void
 562 lkkbd_reinit (void *data)
 563 {
 564         struct lkkbd *lk = data;
 565         int division;
 566         unsigned char leds_on = 0;
 567         unsigned char leds_off = 0;
 568
 569         /* Ask for ID */
 570         lk->serio->write (lk->serio, LK_CMD_REQUEST_ID);
 571
 572         /* Reset parameters */
 573         lk->serio->write (lk->serio, LK_CMD_SET_DEFAULTS);
 574
 575         /* Set LEDs */
 576         CHECK_LED (LED_CAPSL, LK_LED_SHIFTLOCK);
 577         CHECK_LED (LED_COMPOSE, LK_LED_COMPOSE);
 578         CHECK_LED (LED_SCROLLL, LK_LED_SCROLLLOCK);
 579         CHECK_LED (LED_SLEEP, LK_LED_WAIT);
 580         if (leds_on != 0) {
 581                 lk->serio->write (lk->serio, LK_CMD_LED_ON);
 582                 lk->serio->write (lk->serio, leds_on);
 583         }
 584         if (leds_off != 0) {
 585                 lk->serio->write (lk->serio, LK_CMD_LED_OFF);
 586                 lk->serio->write (lk->serio, leds_off);
 587         }
 588
 589         /*
 590          * Try to activate extended LK401 mode. This command will
 591          * only work with a LK401 keyboard and grants access to
 592          * LAlt, RAlt, RCompose and RShift.
 593          */
 594         lk->serio->write (lk->serio, LK_CMD_ENABLE_LK401);
 595
 596         /* Set all keys to UPDOWN mode */
 597         for (division = 1; division <= 14; division++)
 598                 lk->serio->write (lk->serio, LK_CMD_SET_MODE (LK_MODE_UPDOWN,
 599                                         division));
 600
 601         /* Enable bell and set volume */
 602         lk->serio->write (lk->serio, LK_CMD_ENABLE_BELL);
 603         lk->serio->write (lk->serio, volume_to_hw (lk->bell_volume));
 604
 605         /* Enable/disable keyclick (and possibly set volume) */
 606         if (test_bit (SND_CLICK, lk->dev.snd)) {
 607                 lk->serio->write (lk->serio, LK_CMD_ENABLE_KEYCLICK);
 608                 lk->serio->write (lk->serio, volume_to_hw (lk->keyclick_volume));
 609                 lk->serio->write (lk->serio, LK_CMD_ENABLE_CTRCLICK);
 610                 lk->serio->write (lk->serio, volume_to_hw (lk->ctrlclick_volume));
 611         } else {
 612                 lk->serio->write (lk->serio, LK_CMD_DISABLE_KEYCLICK);
 613                 lk->serio->write (lk->serio, LK_CMD_DISABLE_CTRCLICK);
 614         }
 615
 616         /* Sound the bell if needed */
 617         if (test_bit (SND_BELL, lk->dev.snd))
 618                 lk->serio->write (lk->serio, LK_CMD_SOUND_BELL);
 619 }
 620
 621 /*
 622  * lkkbd_connect() probes for a LK keyboard and fills the necessary structures.
 623  */
 624 static void
 625 lkkbd_connect (struct serio *serio, struct serio_dev *dev)
 626 {
 627         struct lkkbd *lk;
 628         int i;
 629
 630         if ((serio->type & SERIO_TYPE) != SERIO_RS232)
 631                 return;
 632         if ((serio->type & SERIO_PROTO) != SERIO_LKKBD)
 633                 return;
 634
 635         if (!(lk = kmalloc (sizeof (struct lkkbd), GFP_KERNEL)))
 636                 return;
 637         memset (lk, 0, sizeof (struct lkkbd));
 638
 639         init_input_dev (&lk->dev);
 640         set_bit (EV_KEY, lk->dev.evbit);
 641         set_bit (EV_LED, lk->dev.evbit);
 642         set_bit (EV_SND, lk->dev.evbit);
 643         set_bit (EV_REP, lk->dev.evbit);
 644         set_bit (LED_CAPSL, lk->dev.ledbit);
 645         set_bit (LED_SLEEP, lk->dev.ledbit);
 646         set_bit (LED_COMPOSE, lk->dev.ledbit);
 647         set_bit (LED_SCROLLL, lk->dev.ledbit);
 648         set_bit (SND_BELL, lk->dev.sndbit);
 649         set_bit (SND_CLICK, lk->dev.sndbit);
 650
 651         lk->serio = serio;
 652
 653         INIT_WORK (&lk->tq, lkkbd_reinit, lk);
 654
 655         lk->bell_volume = bell_volume;
 656         lk->keyclick_volume = keyclick_volume;
 657         lk->ctrlclick_volume = ctrlclick_volume;
 658
 659         lk->dev.keycode = lk->keycode;
 660         lk->dev.keycodesize = sizeof (lk_keycode_t);
 661         lk->dev.keycodemax = LK_NUM_KEYCODES;
 662
 663         lk->dev.event = lkkbd_event;
 664         lk->dev.private = lk;
 665
 666         serio->private = lk;
 667
 668         if (serio_open (serio, dev)) {
 669                 kfree (lk);
 670                 return;
 671         }
 672
 673         sprintf (lk->name, "DEC LK keyboard");
 674         sprintf (lk->phys, "%s/input0", serio->phys);
 675
 676         memcpy (lk->keycode, lkkbd_keycode, sizeof (lk_keycode_t) * LK_NUM_KEYCODES);
 677         for (i = 0; i < LK_NUM_KEYCODES; i++)
 678                 set_bit (lk->keycode[i], lk->dev.keybit);
 679
 680         lk->dev.name = lk->name;
 681         lk->dev.phys = lk->phys;
 682         lk->dev.id.bustype = BUS_RS232;
 683         lk->dev.id.vendor = SERIO_LKKBD;
 684         lk->dev.id.product = 0;
 685         lk->dev.id.version = 0x0100;
 686
 687         input_register_device (&lk->dev);
 688
 689         printk (KERN_INFO "input: %s on %s, initiating reset\n", lk->name, serio->phys);
 690         lk->serio->write (lk->serio, LK_CMD_POWERCYCLE_RESET);
 691 }
 692
 693 /*
 694  * lkkbd_disconnect() unregisters and closes behind us.
 695  */
 696 static void
 697 lkkbd_disconnect (struct serio *serio)
 698 {
 699         struct lkkbd *lk = serio->private;
 700
 701         input_unregister_device (&lk->dev);
 702         serio_close (serio);
 703         kfree (lk);
 704 }
 705
 706 static struct serio_dev lkkbd_dev = {
 707         .connect = lkkbd_connect,
 708         .disconnect = lkkbd_disconnect,
 709         .interrupt = lkkbd_interrupt,
 710 };
 711
 712 /*
 713  * The functions for insering/removing us as a module.
 714  */
 715 int __init
 716 lkkbd_init (void)
 717 {
 718         serio_register_device (&lkkbd_dev);
 719         return 0;
 720 }
 721
 722 void __exit
 723 lkkbd_exit (void)
 724 {
 725         serio_unregister_device (&lkkbd_dev);
 726 }
 727
 728 module_init (lkkbd_init);
 729 module_exit (lkkbd_exit);
 730