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