2 * Copyright (C) 2004 by Jan-Benedict Glaw <jbglaw@lug-owl.de>
6 * LK keyboard driver for Linux, based on sunkbd.c (C) by Vojtech Pavlik
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
14 * DISCLAIMER: This works for _me_. If you break anything by using the
15 * information given below, I will _not_ be liable!
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!!!
23 * Pin numbers for DE9 and DB25 are noted on the plug (quite small:). For
24 * RJ10, it's like this:
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:)
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).
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
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.
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.
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
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>
73 #define DRIVER_DESC "LK keyboard driver"
75 MODULE_AUTHOR ("Jan-Benedict Glaw <jbglaw@lug-owl.de>");
76 MODULE_DESCRIPTION (DRIVER_DESC
);
77 MODULE_LICENSE ("GPL");
85 * Please notice that there's not yet an API to set these at runtime.
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%");
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%");
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%");
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");
108 #define DBG(x...) printk (x)
110 #define DBG(x...) do {} while (0)
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
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))
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
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
153 #define LK_NUM_KEYCODES 256
154 #define LK_NUM_IGNORE_BYTES 6
155 typedef u_int16_t lk_keycode_t
;
159 static lk_keycode_t lkkbd_keycode
[LK_NUM_KEYCODES
] = {
185 [0x8f] = KEY_PAGEDOWN
,
188 [0x95] = KEY_KPENTER
,
195 [0x9c] = KEY_KPCOMMA
,
199 [0xa0] = KEY_KPMINUS
,
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
,
260 [0xf2] = KEY_SEMICOLON
,
263 [0xf6] = KEY_RIGHTBRACE
,
264 [0xf7] = KEY_BACKSLASH
,
266 [0xfa] = KEY_LEFTBRACE
,
267 [0xfb] = KEY_APOSTROPHE
,
270 #define CHECK_LED(LK, VAR_ON, VAR_OFF, LED, BITS) do { \
271 if (test_bit (LED, (LK)->dev->led)) \
281 lk_keycode_t keycode
[LK_NUM_KEYCODES
];
283 unsigned char id
[LK_NUM_IGNORE_BYTES
];
284 struct input_dev
*dev
;
286 struct work_struct tq
;
292 int ctrlclick_volume
;
297 * Responses from the keyboard and mapping back to their names.
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
),
318 static unsigned char *
319 response_name (unsigned char value
)
323 for (i
= 0; i
< ARRAY_SIZE (lk_response
); i
++)
324 if (lk_response
[i
].value
== value
)
325 return lk_response
[i
].name
;
329 #endif /* LKKBD_DEBUG */
332 * Calculate volume parameter byte for a given volume.
335 volume_to_hw (int volume_percent
)
337 unsigned char ret
= 0;
339 if (volume_percent
< 0)
341 if (volume_percent
> 100)
342 volume_percent
= 100;
344 if (volume_percent
>= 0)
346 if (volume_percent
>= 13) /* 12.5 */
348 if (volume_percent
>= 25)
350 if (volume_percent
>= 38) /* 37.5 */
352 if (volume_percent
>= 50)
354 if (volume_percent
>= 63) /* 62.5 */
355 ret
= 2; /* This is the default volume */
356 if (volume_percent
>= 75)
358 if (volume_percent
>= 88) /* 87.5 */
367 lkkbd_detection_done (struct lkkbd
*lk
)
372 * Reset setting for Compose key. Let Compose be KEY_COMPOSE.
374 lk
->keycode
[0xb1] = KEY_COMPOSE
;
377 * Print keyboard name and modify Compose=Alt on user's request.
381 strlcpy (lk
->name
, "DEC LK201 keyboard",
384 if (lk201_compose_is_alt
)
385 lk
->keycode
[0xb1] = KEY_LEFTALT
;
389 strlcpy (lk
->name
, "DEC LK401 keyboard",
394 strlcpy (lk
->name
, "Unknown DEC keyboard",
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
]);
405 printk (KERN_INFO
"lkkbd: keyboard on %s identified as: %s\n",
409 * Report errors during keyboard boot-up.
417 printk (KERN_ERR
"lkkbd: Stuck key on keyboard at "
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
);
428 printk (KERN_ERR
"lkkbd: Unknown error %02x on "
429 "keyboard at %s\n", lk
->id
[2],
435 * Try to hint user if there's a stuck key.
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]]);
446 * lkkbd_interrupt() is called by the low level driver when a character
450 lkkbd_interrupt (struct serio
*serio
, unsigned char data
, unsigned int flags
)
452 struct lkkbd
*lk
= serio_get_drvdata (serio
);
455 DBG (KERN_INFO
"Got byte 0x%02x\n", data
);
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
;
461 if (lk
->ignore_bytes
== 0)
462 lkkbd_detection_done (lk
);
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
);
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
);
483 case LK_OUTPUT_ERROR
:
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
));
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);
499 input_report_key (lk
->dev
, lk
->keycode
[data
], 0);
500 input_sync (lk
->dev
);
502 printk (KERN_WARNING
"%s: Unknown key with "
503 "scancode 0x%02x on %s.\n",
504 __FILE__
, data
, lk
->name
);
511 * lkkbd_event() handles events from the input module.
514 lkkbd_event (struct input_dev
*dev
, unsigned int type
, unsigned int code
,
517 struct lkkbd
*lk
= input_get_drvdata (dev
);
518 unsigned char leds_on
= 0;
519 unsigned char leds_off
= 0;
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
);
528 lk
->serio
->write (lk
->serio
, LK_CMD_LED_ON
);
529 lk
->serio
->write (lk
->serio
, leds_on
);
532 lk
->serio
->write (lk
->serio
, LK_CMD_LED_OFF
);
533 lk
->serio
->write (lk
->serio
, leds_off
);
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
);
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
));
555 lk
->serio
->write (lk
->serio
, LK_CMD_SOUND_BELL
);
562 printk (KERN_ERR
"%s (): Got unknown type %d, code %d, value %d\n",
563 __func__
, type
, code
, value
);
570 * lkkbd_reinit() sets leds and beeps to a state the computer remembers they
574 lkkbd_reinit (struct work_struct
*work
)
576 struct lkkbd
*lk
= container_of(work
, struct lkkbd
, tq
);
578 unsigned char leds_on
= 0;
579 unsigned char leds_off
= 0;
582 lk
->serio
->write (lk
->serio
, LK_CMD_REQUEST_ID
);
584 /* Reset parameters */
585 lk
->serio
->write (lk
->serio
, LK_CMD_SET_DEFAULTS
);
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
);
593 lk
->serio
->write (lk
->serio
, LK_CMD_LED_ON
);
594 lk
->serio
->write (lk
->serio
, leds_on
);
597 lk
->serio
->write (lk
->serio
, LK_CMD_LED_OFF
);
598 lk
->serio
->write (lk
->serio
, leds_off
);
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.
606 lk
->serio
->write (lk
->serio
, LK_CMD_ENABLE_LK401
);
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
,
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
));
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
));
624 lk
->serio
->write (lk
->serio
, LK_CMD_DISABLE_KEYCLICK
);
625 lk
->serio
->write (lk
->serio
, LK_CMD_DISABLE_CTRCLICK
);
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
);
634 * lkkbd_connect() probes for a LK keyboard and fills the necessary structures.
637 lkkbd_connect (struct serio
*serio
, struct serio_driver
*drv
)
640 struct input_dev
*input_dev
;
644 lk
= kzalloc (sizeof (struct lkkbd
), GFP_KERNEL
);
645 input_dev
= input_allocate_device ();
646 if (!lk
|| !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
);
659 strlcpy (lk
->name
, "DEC LK keyboard", sizeof(lk
->name
));
660 snprintf (lk
->phys
, sizeof(lk
->phys
), "%s/input0", serio
->phys
);
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
;
671 input_set_drvdata (input_dev
, lk
);
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
);
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
);
690 serio_set_drvdata (serio
, lk
);
692 err
= serio_open (serio
, drv
);
696 err
= input_register_device (lk
->dev
);
700 lk
->serio
->write (lk
->serio
, LK_CMD_POWERCYCLE_RESET
);
704 fail3
: serio_close (serio
);
705 fail2
: serio_set_drvdata (serio
, NULL
);
706 fail1
: input_free_device (input_dev
);
712 * lkkbd_disconnect() unregisters and closes behind us.
715 lkkbd_disconnect (struct serio
*serio
)
717 struct lkkbd
*lk
= serio_get_drvdata (serio
);
719 input_get_device (lk
->dev
);
720 input_unregister_device (lk
->dev
);
722 serio_set_drvdata (serio
, NULL
);
723 input_put_device (lk
->dev
);
727 static struct serio_device_id lkkbd_serio_ids
[] = {
730 .proto
= SERIO_LKKBD
,
737 MODULE_DEVICE_TABLE(serio
, lkkbd_serio_ids
);
739 static struct serio_driver lkkbd_drv
= {
743 .description
= DRIVER_DESC
,
744 .id_table
= lkkbd_serio_ids
,
745 .connect
= lkkbd_connect
,
746 .disconnect
= lkkbd_disconnect
,
747 .interrupt
= lkkbd_interrupt
,
751 * The functions for insering/removing us as a module.
756 return serio_register_driver(&lkkbd_drv
);
762 serio_unregister_driver(&lkkbd_drv
);
765 module_init (lkkbd_init
);
766 module_exit (lkkbd_exit
);