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