1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3 * AT and PS/2 keyboard driver
4 *
5 * Copyright (c) 1999-2002 Vojtech Pavlik
6 */
7
8
9 /*
10 * This driver can handle standard AT keyboards and PS/2 keyboards in
11 * Translated and Raw Set 2 and Set 3, as well as AT keyboards on dumb
12 * input-only controllers and AT keyboards connected over a one way RS232
13 * converter.
14 */
15
16 #include <linux/delay.h>
17 #include <linux/module.h>
18 #include <linux/slab.h>
19 #include <linux/interrupt.h>
20 #include <linux/init.h>
21 #include <linux/input.h>
22 #include <linux/serio.h>
23 #include <linux/workqueue.h>
24 #include <linux/libps2.h>
25 #include <linux/mutex.h>
26 #include <linux/dmi.h>
27
28 #define DRIVER_DESC "AT and PS/2 keyboard driver"
29
30 MODULE_AUTHOR("Vojtech Pavlik <vojtech@suse.cz>");
31 MODULE_DESCRIPTION(DRIVER_DESC);
32 MODULE_LICENSE("GPL");
33
34 static int atkbd_set = 2;
35 module_param_named(set, atkbd_set, int, 0);
36 MODULE_PARM_DESC(set, "Select keyboard code set (2 = default, 3 = PS/2 native)");
37
38 #if defined(__i386__) || defined(__x86_64__) || defined(__hppa__)
39 static bool atkbd_reset;
40 #else
41 static bool atkbd_reset = true;
42 #endif
43 module_param_named(reset, atkbd_reset, bool, 0);
44 MODULE_PARM_DESC(reset, "Reset keyboard during initialization");
45
46 static bool atkbd_softrepeat;
47 module_param_named(softrepeat, atkbd_softrepeat, bool, 0);
48 MODULE_PARM_DESC(softrepeat, "Use software keyboard repeat");
49
50 static bool atkbd_softraw = true;
51 module_param_named(softraw, atkbd_softraw, bool, 0);
52 MODULE_PARM_DESC(softraw, "Use software generated rawmode");
53
54 static bool atkbd_scroll;
55 module_param_named(scroll, atkbd_scroll, bool, 0);
56 MODULE_PARM_DESC(scroll, "Enable scroll-wheel on MS Office and similar keyboards");
57
58 static bool atkbd_extra;
59 module_param_named(extra, atkbd_extra, bool, 0);
60 MODULE_PARM_DESC(extra, "Enable extra LEDs and keys on IBM RapidAcces, EzKey and similar keyboards");
61
62 static bool atkbd_terminal;
63 module_param_named(terminal, atkbd_terminal, bool, 0);
64 MODULE_PARM_DESC(terminal, "Enable break codes on an IBM Terminal keyboard connected via AT/PS2");
65
66 /*
67 * Scancode to keycode tables. These are just the default setting, and
68 * are loadable via a userland utility.
69 */
70
71 #define ATKBD_KEYMAP_SIZE 512
72
73 static const unsigned short atkbd_set2_keycode[ATKBD_KEYMAP_SIZE] = {
74
75 #ifdef CONFIG_KEYBOARD_ATKBD_HP_KEYCODES
76
77 /* XXX: need a more general approach */
78
79 #include "hpps2atkbd.h" /* include the keyboard scancodes */
80
81 #else
82 0, 67, 65, 63, 61, 59, 60, 88, 0, 68, 66, 64, 62, 15, 41,117,
83 0, 56, 42, 93, 29, 16, 2, 0, 0, 0, 44, 31, 30, 17, 3, 0,
84 0, 46, 45, 32, 18, 5, 4, 95, 0, 57, 47, 33, 20, 19, 6,183,
85 0, 49, 48, 35, 34, 21, 7,184, 0, 0, 50, 36, 22, 8, 9,185,
86 0, 51, 37, 23, 24, 11, 10, 0, 0, 52, 53, 38, 39, 25, 12, 0,
87 0, 89, 40, 0, 26, 13, 0, 0, 58, 54, 28, 27, 0, 43, 0, 85,
88 0, 86, 91, 90, 92, 0, 14, 94, 0, 79,124, 75, 71,121, 0, 0,
89 82, 83, 80, 76, 77, 72, 1, 69, 87, 78, 81, 74, 55, 73, 70, 99,
90
91 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
92 217,100,255, 0, 97,165, 0, 0,156, 0, 0, 0, 0, 0, 0,125,
93 173,114, 0,113, 0, 0, 0,126,128, 0, 0,140, 0, 0, 0,127,
94 159, 0,115, 0,164, 0, 0,116,158, 0,172,166, 0, 0, 0,142,
95 157, 0, 0, 0, 0, 0, 0, 0,155, 0, 98, 0, 0,163, 0, 0,
96 226, 0, 0, 0, 0, 0, 0, 0, 0,255, 96, 0, 0, 0,143, 0,
97 0, 0, 0, 0, 0, 0, 0, 0, 0,107, 0,105,102, 0, 0,112,
98 110,111,108,112,106,103, 0,119, 0,118,109, 0, 99,104,119, 0,
99
100 0, 0, 0, 65, 99,
101 #endif
102 };
103
104 static const unsigned short atkbd_set3_keycode[ATKBD_KEYMAP_SIZE] = {
105
106 0, 0, 0, 0, 0, 0, 0, 59, 1,138,128,129,130, 15, 41, 60,
107 131, 29, 42, 86, 58, 16, 2, 61,133, 56, 44, 31, 30, 17, 3, 62,
108 134, 46, 45, 32, 18, 5, 4, 63,135, 57, 47, 33, 20, 19, 6, 64,
109 136, 49, 48, 35, 34, 21, 7, 65,137,100, 50, 36, 22, 8, 9, 66,
110 125, 51, 37, 23, 24, 11, 10, 67,126, 52, 53, 38, 39, 25, 12, 68,
111 113,114, 40, 43, 26, 13, 87, 99, 97, 54, 28, 27, 43, 43, 88, 70,
112 108,105,119,103,111,107, 14,110, 0, 79,106, 75, 71,109,102,104,
113 82, 83, 80, 76, 77, 72, 69, 98, 0, 96, 81, 0, 78, 73, 55,183,
114
115 184,185,186,187, 74, 94, 92, 93, 0, 0, 0,125,126,127,112, 0,
116 0,139,172,163,165,115,152,172,166,140,160,154,113,114,167,168,
117 148,149,147,140
118 };
119
120 static const unsigned short atkbd_unxlate_table[128] = {
121 0,118, 22, 30, 38, 37, 46, 54, 61, 62, 70, 69, 78, 85,102, 13,
122 21, 29, 36, 45, 44, 53, 60, 67, 68, 77, 84, 91, 90, 20, 28, 27,
123 35, 43, 52, 51, 59, 66, 75, 76, 82, 14, 18, 93, 26, 34, 33, 42,
124 50, 49, 58, 65, 73, 74, 89,124, 17, 41, 88, 5, 6, 4, 12, 3,
125 11, 2, 10, 1, 9,119,126,108,117,125,123,107,115,116,121,105,
126 114,122,112,113,127, 96, 97,120, 7, 15, 23, 31, 39, 47, 55, 63,
127 71, 79, 86, 94, 8, 16, 24, 32, 40, 48, 56, 64, 72, 80, 87,111,
128 19, 25, 57, 81, 83, 92, 95, 98, 99,100,101,103,104,106,109,110
129 };
130
131 #define ATKBD_CMD_SETLEDS 0x10ed
132 #define ATKBD_CMD_GSCANSET 0x11f0
133 #define ATKBD_CMD_SSCANSET 0x10f0
134 #define ATKBD_CMD_GETID 0x02f2
135 #define ATKBD_CMD_SETREP 0x10f3
136 #define ATKBD_CMD_ENABLE 0x00f4
137 #define ATKBD_CMD_RESET_DIS 0x00f5 /* Reset to defaults and disable */
138 #define ATKBD_CMD_RESET_DEF 0x00f6 /* Reset to defaults */
139 #define ATKBD_CMD_SETALL_MB 0x00f8 /* Set all keys to give break codes */
140 #define ATKBD_CMD_SETALL_MBR 0x00fa /* ... and repeat */
141 #define ATKBD_CMD_RESET_BAT 0x02ff
142 #define ATKBD_CMD_RESEND 0x00fe
143 #define ATKBD_CMD_EX_ENABLE 0x10ea
144 #define ATKBD_CMD_EX_SETLEDS 0x20eb
145 #define ATKBD_CMD_OK_GETID 0x02e8
146
147 #define ATKBD_RET_ACK 0xfa
148 #define ATKBD_RET_NAK 0xfe
149 #define ATKBD_RET_BAT 0xaa
150 #define ATKBD_RET_EMUL0 0xe0
151 #define ATKBD_RET_EMUL1 0xe1
152 #define ATKBD_RET_RELEASE 0xf0
153 #define ATKBD_RET_HANJA 0xf1
154 #define ATKBD_RET_HANGEUL 0xf2
155 #define ATKBD_RET_ERR 0xff
156
157 #define ATKBD_KEY_UNKNOWN 0
158 #define ATKBD_KEY_NULL 255
159
160 #define ATKBD_SCR_1 0xfffe
161 #define ATKBD_SCR_2 0xfffd
162 #define ATKBD_SCR_4 0xfffc
163 #define ATKBD_SCR_8 0xfffb
164 #define ATKBD_SCR_CLICK 0xfffa
165 #define ATKBD_SCR_LEFT 0xfff9
166 #define ATKBD_SCR_RIGHT 0xfff8
167
168 #define ATKBD_SPECIAL ATKBD_SCR_RIGHT
169
170 #define ATKBD_LED_EVENT_BIT 0
171 #define ATKBD_REP_EVENT_BIT 1
172
173 #define ATKBD_XL_ERR 0x01
174 #define ATKBD_XL_BAT 0x02
175 #define ATKBD_XL_ACK 0x04
176 #define ATKBD_XL_NAK 0x08
177 #define ATKBD_XL_HANGEUL 0x10
178 #define ATKBD_XL_HANJA 0x20
179
180 static const struct {
181 unsigned short keycode;
182 unsigned char set2;
183 } atkbd_scroll_keys[] = {
184 { ATKBD_SCR_1, 0xc5 },
185 { ATKBD_SCR_2, 0x9d },
186 { ATKBD_SCR_4, 0xa4 },
187 { ATKBD_SCR_8, 0x9b },
188 { ATKBD_SCR_CLICK, 0xe0 },
189 { ATKBD_SCR_LEFT, 0xcb },
190 { ATKBD_SCR_RIGHT, 0xd2 },
191 };
192
193 /*
194 * The atkbd control structure
195 */
196
197 struct atkbd {
198
199 struct ps2dev ps2dev;
200 struct input_dev *dev;
201
202 /* Written only during init */
203 char name[64];
204 char phys[32];
205
206 unsigned short id;
207 unsigned short keycode[ATKBD_KEYMAP_SIZE];
208 DECLARE_BITMAP(force_release_mask, ATKBD_KEYMAP_SIZE);
209 unsigned char set;
210 bool translated;
211 bool extra;
212 bool write;
213 bool softrepeat;
214 bool softraw;
215 bool scroll;
216 bool enabled;
217
218 /* Accessed only from interrupt */
219 unsigned char emul;
220 bool resend;
221 bool release;
222 unsigned long xl_bit;
223 unsigned int last;
224 unsigned long time;
225 unsigned long err_count;
226
227 struct delayed_work event_work;
228 unsigned long event_jiffies;
229 unsigned long event_mask;
230
231 /* Serializes reconnect(), attr->set() and event work */
232 struct mutex mutex;
233 };
234
235 /*
236 * System-specific keymap fixup routine
237 */
238 static void (*atkbd_platform_fixup)(struct atkbd *, const void *data);
239 static void *atkbd_platform_fixup_data;
240 static unsigned int (*atkbd_platform_scancode_fixup)(struct atkbd *, unsigned int);
241
242 /*
243 * Certain keyboards to not like ATKBD_CMD_RESET_DIS and stop responding
244 * to many commands until full reset (ATKBD_CMD_RESET_BAT) is performed.
245 */
246 static bool atkbd_skip_deactivate;
247
248 static ssize_t atkbd_attr_show_helper(struct device *dev, char *buf,
249 ssize_t (*handler)(struct atkbd *, char *));
250 static ssize_t atkbd_attr_set_helper(struct device *dev, const char *buf, size_t count,
251 ssize_t (*handler)(struct atkbd *, const char *, size_t));
252 #define ATKBD_DEFINE_ATTR(_name) \
253 static ssize_t atkbd_show_##_name(struct atkbd *, char *); \
254 static ssize_t atkbd_set_##_name(struct atkbd *, const char *, size_t); \
255 static ssize_t atkbd_do_show_##_name(struct device *d, \
256 struct device_attribute *attr, char *b) \
257 { \
258 return atkbd_attr_show_helper(d, b, atkbd_show_##_name); \
259 } \
260 static ssize_t atkbd_do_set_##_name(struct device *d, \
261 struct device_attribute *attr, const char *b, size_t s) \
262 { \
263 return atkbd_attr_set_helper(d, b, s, atkbd_set_##_name); \
264 } \
265 static struct device_attribute atkbd_attr_##_name = \
266 __ATTR(_name, S_IWUSR | S_IRUGO, atkbd_do_show_##_name, atkbd_do_set_##_name);
267
268 ATKBD_DEFINE_ATTR(extra);
269 ATKBD_DEFINE_ATTR(force_release);
270 ATKBD_DEFINE_ATTR(scroll);
271 ATKBD_DEFINE_ATTR(set);
272 ATKBD_DEFINE_ATTR(softrepeat);
273 ATKBD_DEFINE_ATTR(softraw);
274
275 #define ATKBD_DEFINE_RO_ATTR(_name) \
276 static ssize_t atkbd_show_##_name(struct atkbd *, char *); \
277 static ssize_t atkbd_do_show_##_name(struct device *d, \
278 struct device_attribute *attr, char *b) \
279 { \
280 return atkbd_attr_show_helper(d, b, atkbd_show_##_name); \
281 } \
282 static struct device_attribute atkbd_attr_##_name = \
283 __ATTR(_name, S_IRUGO, atkbd_do_show_##_name, NULL);
284
285 ATKBD_DEFINE_RO_ATTR(err_count);
286
287 static struct attribute *atkbd_attributes[] = {
288 &atkbd_attr_extra.attr,
289 &atkbd_attr_force_release.attr,
290 &atkbd_attr_scroll.attr,
291 &atkbd_attr_set.attr,
292 &atkbd_attr_softrepeat.attr,
293 &atkbd_attr_softraw.attr,
294 &atkbd_attr_err_count.attr,
295 NULL
296 };
297
298 static struct attribute_group atkbd_attribute_group = {
299 .attrs = atkbd_attributes,
300 };
301
302 static const unsigned int xl_table[] = {
303 ATKBD_RET_BAT, ATKBD_RET_ERR, ATKBD_RET_ACK,
304 ATKBD_RET_NAK, ATKBD_RET_HANJA, ATKBD_RET_HANGEUL,
305 };
306
307 /*
308 * Checks if we should mangle the scancode to extract 'release' bit
309 * in translated mode.
310 */
atkbd_need_xlate(unsigned long xl_bit,unsigned char code)311 static bool atkbd_need_xlate(unsigned long xl_bit, unsigned char code)
312 {
313 int i;
314
315 if (code == ATKBD_RET_EMUL0 || code == ATKBD_RET_EMUL1)
316 return false;
317
318 for (i = 0; i < ARRAY_SIZE(xl_table); i++)
319 if (code == xl_table[i])
320 return test_bit(i, &xl_bit);
321
322 return true;
323 }
324
325 /*
326 * Calculates new value of xl_bit so the driver can distinguish
327 * between make/break pair of scancodes for select keys and PS/2
328 * protocol responses.
329 */
atkbd_calculate_xl_bit(struct atkbd * atkbd,unsigned char code)330 static void atkbd_calculate_xl_bit(struct atkbd *atkbd, unsigned char code)
331 {
332 int i;
333
334 for (i = 0; i < ARRAY_SIZE(xl_table); i++) {
335 if (!((code ^ xl_table[i]) & 0x7f)) {
336 if (code & 0x80)
337 __clear_bit(i, &atkbd->xl_bit);
338 else
339 __set_bit(i, &atkbd->xl_bit);
340 break;
341 }
342 }
343 }
344
345 /*
346 * Encode the scancode, 0xe0 prefix, and high bit into a single integer,
347 * keeping kernel 2.4 compatibility for set 2
348 */
atkbd_compat_scancode(struct atkbd * atkbd,unsigned int code)349 static unsigned int atkbd_compat_scancode(struct atkbd *atkbd, unsigned int code)
350 {
351 if (atkbd->set == 3) {
352 if (atkbd->emul == 1)
353 code |= 0x100;
354 } else {
355 code = (code & 0x7f) | ((code & 0x80) << 1);
356 if (atkbd->emul == 1)
357 code |= 0x80;
358 }
359
360 return code;
361 }
362
363 /*
364 * atkbd_interrupt(). Here takes place processing of data received from
365 * the keyboard into events.
366 */
367
atkbd_interrupt(struct serio * serio,unsigned char data,unsigned int flags)368 static irqreturn_t atkbd_interrupt(struct serio *serio, unsigned char data,
369 unsigned int flags)
370 {
371 struct atkbd *atkbd = serio_get_drvdata(serio);
372 struct input_dev *dev = atkbd->dev;
373 unsigned int code = data;
374 int scroll = 0, hscroll = 0, click = -1;
375 int value;
376 unsigned short keycode;
377
378 dev_dbg(&serio->dev, "Received %02x flags %02x\n", data, flags);
379
380 #if !defined(__i386__) && !defined (__x86_64__)
381 if ((flags & (SERIO_FRAME | SERIO_PARITY)) && (~flags & SERIO_TIMEOUT) && !atkbd->resend && atkbd->write) {
382 dev_warn(&serio->dev, "Frame/parity error: %02x\n", flags);
383 serio_write(serio, ATKBD_CMD_RESEND);
384 atkbd->resend = true;
385 goto out;
386 }
387
388 if (!flags && data == ATKBD_RET_ACK)
389 atkbd->resend = false;
390 #endif
391
392 if (unlikely(atkbd->ps2dev.flags & PS2_FLAG_ACK))
393 if (ps2_handle_ack(&atkbd->ps2dev, data))
394 goto out;
395
396 if (unlikely(atkbd->ps2dev.flags & PS2_FLAG_CMD))
397 if (ps2_handle_response(&atkbd->ps2dev, data))
398 goto out;
399
400 pm_wakeup_event(&serio->dev, 0);
401
402 if (!atkbd->enabled)
403 goto out;
404
405 input_event(dev, EV_MSC, MSC_RAW, code);
406
407 if (atkbd_platform_scancode_fixup)
408 code = atkbd_platform_scancode_fixup(atkbd, code);
409
410 if (atkbd->translated) {
411
412 if (atkbd->emul || atkbd_need_xlate(atkbd->xl_bit, code)) {
413 atkbd->release = code >> 7;
414 code &= 0x7f;
415 }
416
417 if (!atkbd->emul)
418 atkbd_calculate_xl_bit(atkbd, data);
419 }
420
421 switch (code) {
422 case ATKBD_RET_BAT:
423 atkbd->enabled = false;
424 serio_reconnect(atkbd->ps2dev.serio);
425 goto out;
426 case ATKBD_RET_EMUL0:
427 atkbd->emul = 1;
428 goto out;
429 case ATKBD_RET_EMUL1:
430 atkbd->emul = 2;
431 goto out;
432 case ATKBD_RET_RELEASE:
433 atkbd->release = true;
434 goto out;
435 case ATKBD_RET_ACK:
436 case ATKBD_RET_NAK:
437 if (printk_ratelimit())
438 dev_warn(&serio->dev,
439 "Spurious %s on %s. "
440 "Some program might be trying to access hardware directly.\n",
441 data == ATKBD_RET_ACK ? "ACK" : "NAK", serio->phys);
442 goto out;
443 case ATKBD_RET_ERR:
444 atkbd->err_count++;
445 dev_dbg(&serio->dev, "Keyboard on %s reports too many keys pressed.\n",
446 serio->phys);
447 goto out;
448 }
449
450 code = atkbd_compat_scancode(atkbd, code);
451
452 if (atkbd->emul && --atkbd->emul)
453 goto out;
454
455 keycode = atkbd->keycode[code];
456
457 if (!(atkbd->release && test_bit(code, atkbd->force_release_mask)))
458 if (keycode != ATKBD_KEY_NULL)
459 input_event(dev, EV_MSC, MSC_SCAN, code);
460
461 switch (keycode) {
462 case ATKBD_KEY_NULL:
463 break;
464 case ATKBD_KEY_UNKNOWN:
465 dev_warn(&serio->dev,
466 "Unknown key %s (%s set %d, code %#x on %s).\n",
467 atkbd->release ? "released" : "pressed",
468 atkbd->translated ? "translated" : "raw",
469 atkbd->set, code, serio->phys);
470 dev_warn(&serio->dev,
471 "Use 'setkeycodes %s%02x <keycode>' to make it known.\n",
472 code & 0x80 ? "e0" : "", code & 0x7f);
473 input_sync(dev);
474 break;
475 case ATKBD_SCR_1:
476 scroll = 1;
477 break;
478 case ATKBD_SCR_2:
479 scroll = 2;
480 break;
481 case ATKBD_SCR_4:
482 scroll = 4;
483 break;
484 case ATKBD_SCR_8:
485 scroll = 8;
486 break;
487 case ATKBD_SCR_CLICK:
488 click = !atkbd->release;
489 break;
490 case ATKBD_SCR_LEFT:
491 hscroll = -1;
492 break;
493 case ATKBD_SCR_RIGHT:
494 hscroll = 1;
495 break;
496 default:
497 if (atkbd->release) {
498 value = 0;
499 atkbd->last = 0;
500 } else if (!atkbd->softrepeat && test_bit(keycode, dev->key)) {
501 /* Workaround Toshiba laptop multiple keypress */
502 value = time_before(jiffies, atkbd->time) && atkbd->last == code ? 1 : 2;
503 } else {
504 value = 1;
505 atkbd->last = code;
506 atkbd->time = jiffies + msecs_to_jiffies(dev->rep[REP_DELAY]) / 2;
507 }
508
509 input_event(dev, EV_KEY, keycode, value);
510 input_sync(dev);
511
512 if (value && test_bit(code, atkbd->force_release_mask)) {
513 input_event(dev, EV_MSC, MSC_SCAN, code);
514 input_report_key(dev, keycode, 0);
515 input_sync(dev);
516 }
517 }
518
519 if (atkbd->scroll) {
520 if (click != -1)
521 input_report_key(dev, BTN_MIDDLE, click);
522 input_report_rel(dev, REL_WHEEL,
523 atkbd->release ? -scroll : scroll);
524 input_report_rel(dev, REL_HWHEEL, hscroll);
525 input_sync(dev);
526 }
527
528 atkbd->release = false;
529 out:
530 return IRQ_HANDLED;
531 }
532
atkbd_set_repeat_rate(struct atkbd * atkbd)533 static int atkbd_set_repeat_rate(struct atkbd *atkbd)
534 {
535 const short period[32] =
536 { 33, 37, 42, 46, 50, 54, 58, 63, 67, 75, 83, 92, 100, 109, 116, 125,
537 133, 149, 167, 182, 200, 217, 232, 250, 270, 303, 333, 370, 400, 435, 470, 500 };
538 const short delay[4] =
539 { 250, 500, 750, 1000 };
540
541 struct input_dev *dev = atkbd->dev;
542 unsigned char param;
543 int i = 0, j = 0;
544
545 while (i < ARRAY_SIZE(period) - 1 && period[i] < dev->rep[REP_PERIOD])
546 i++;
547 dev->rep[REP_PERIOD] = period[i];
548
549 while (j < ARRAY_SIZE(delay) - 1 && delay[j] < dev->rep[REP_DELAY])
550 j++;
551 dev->rep[REP_DELAY] = delay[j];
552
553 param = i | (j << 5);
554 return ps2_command(&atkbd->ps2dev, ¶m, ATKBD_CMD_SETREP);
555 }
556
atkbd_set_leds(struct atkbd * atkbd)557 static int atkbd_set_leds(struct atkbd *atkbd)
558 {
559 struct input_dev *dev = atkbd->dev;
560 unsigned char param[2];
561
562 param[0] = (test_bit(LED_SCROLLL, dev->led) ? 1 : 0)
563 | (test_bit(LED_NUML, dev->led) ? 2 : 0)
564 | (test_bit(LED_CAPSL, dev->led) ? 4 : 0);
565 if (ps2_command(&atkbd->ps2dev, param, ATKBD_CMD_SETLEDS))
566 return -1;
567
568 if (atkbd->extra) {
569 param[0] = 0;
570 param[1] = (test_bit(LED_COMPOSE, dev->led) ? 0x01 : 0)
571 | (test_bit(LED_SLEEP, dev->led) ? 0x02 : 0)
572 | (test_bit(LED_SUSPEND, dev->led) ? 0x04 : 0)
573 | (test_bit(LED_MISC, dev->led) ? 0x10 : 0)
574 | (test_bit(LED_MUTE, dev->led) ? 0x20 : 0);
575 if (ps2_command(&atkbd->ps2dev, param, ATKBD_CMD_EX_SETLEDS))
576 return -1;
577 }
578
579 return 0;
580 }
581
582 /*
583 * atkbd_event_work() is used to complete processing of events that
584 * can not be processed by input_event() which is often called from
585 * interrupt context.
586 */
587
atkbd_event_work(struct work_struct * work)588 static void atkbd_event_work(struct work_struct *work)
589 {
590 struct atkbd *atkbd = container_of(work, struct atkbd, event_work.work);
591
592 mutex_lock(&atkbd->mutex);
593
594 if (!atkbd->enabled) {
595 /*
596 * Serio ports are resumed asynchronously so while driver core
597 * thinks that device is already fully operational in reality
598 * it may not be ready yet. In this case we need to keep
599 * rescheduling till reconnect completes.
600 */
601 schedule_delayed_work(&atkbd->event_work,
602 msecs_to_jiffies(100));
603 } else {
604 if (test_and_clear_bit(ATKBD_LED_EVENT_BIT, &atkbd->event_mask))
605 atkbd_set_leds(atkbd);
606
607 if (test_and_clear_bit(ATKBD_REP_EVENT_BIT, &atkbd->event_mask))
608 atkbd_set_repeat_rate(atkbd);
609 }
610
611 mutex_unlock(&atkbd->mutex);
612 }
613
614 /*
615 * Schedule switch for execution. We need to throttle requests,
616 * otherwise keyboard may become unresponsive.
617 */
atkbd_schedule_event_work(struct atkbd * atkbd,int event_bit)618 static void atkbd_schedule_event_work(struct atkbd *atkbd, int event_bit)
619 {
620 unsigned long delay = msecs_to_jiffies(50);
621
622 if (time_after(jiffies, atkbd->event_jiffies + delay))
623 delay = 0;
624
625 atkbd->event_jiffies = jiffies;
626 set_bit(event_bit, &atkbd->event_mask);
627 mb();
628 schedule_delayed_work(&atkbd->event_work, delay);
629 }
630
631 /*
632 * Event callback from the input module. Events that change the state of
633 * the hardware are processed here. If action can not be performed in
634 * interrupt context it is offloaded to atkbd_event_work.
635 */
636
atkbd_event(struct input_dev * dev,unsigned int type,unsigned int code,int value)637 static int atkbd_event(struct input_dev *dev,
638 unsigned int type, unsigned int code, int value)
639 {
640 struct atkbd *atkbd = input_get_drvdata(dev);
641
642 if (!atkbd->write)
643 return -1;
644
645 switch (type) {
646
647 case EV_LED:
648 atkbd_schedule_event_work(atkbd, ATKBD_LED_EVENT_BIT);
649 return 0;
650
651 case EV_REP:
652 if (!atkbd->softrepeat)
653 atkbd_schedule_event_work(atkbd, ATKBD_REP_EVENT_BIT);
654 return 0;
655
656 default:
657 return -1;
658 }
659 }
660
661 /*
662 * atkbd_enable() signals that interrupt handler is allowed to
663 * generate input events.
664 */
665
atkbd_enable(struct atkbd * atkbd)666 static inline void atkbd_enable(struct atkbd *atkbd)
667 {
668 serio_pause_rx(atkbd->ps2dev.serio);
669 atkbd->enabled = true;
670 serio_continue_rx(atkbd->ps2dev.serio);
671 }
672
673 /*
674 * atkbd_disable() tells input handler that all incoming data except
675 * for ACKs and command response should be dropped.
676 */
677
atkbd_disable(struct atkbd * atkbd)678 static inline void atkbd_disable(struct atkbd *atkbd)
679 {
680 serio_pause_rx(atkbd->ps2dev.serio);
681 atkbd->enabled = false;
682 serio_continue_rx(atkbd->ps2dev.serio);
683 }
684
atkbd_activate(struct atkbd * atkbd)685 static int atkbd_activate(struct atkbd *atkbd)
686 {
687 struct ps2dev *ps2dev = &atkbd->ps2dev;
688
689 /*
690 * Enable the keyboard to receive keystrokes.
691 */
692
693 if (ps2_command(ps2dev, NULL, ATKBD_CMD_ENABLE)) {
694 dev_err(&ps2dev->serio->dev,
695 "Failed to enable keyboard on %s\n",
696 ps2dev->serio->phys);
697 return -1;
698 }
699
700 return 0;
701 }
702
703 /*
704 * atkbd_deactivate() resets and disables the keyboard from sending
705 * keystrokes.
706 */
707
atkbd_deactivate(struct atkbd * atkbd)708 static void atkbd_deactivate(struct atkbd *atkbd)
709 {
710 struct ps2dev *ps2dev = &atkbd->ps2dev;
711
712 if (ps2_command(ps2dev, NULL, ATKBD_CMD_RESET_DIS))
713 dev_err(&ps2dev->serio->dev,
714 "Failed to deactivate keyboard on %s\n",
715 ps2dev->serio->phys);
716 }
717
718 #ifdef CONFIG_X86
atkbd_is_portable_device(void)719 static bool atkbd_is_portable_device(void)
720 {
721 static const char * const chassis_types[] = {
722 "8", /* Portable */
723 "9", /* Laptop */
724 "10", /* Notebook */
725 "14", /* Sub-Notebook */
726 "31", /* Convertible */
727 "32", /* Detachable */
728 };
729 int i;
730
731 for (i = 0; i < ARRAY_SIZE(chassis_types); i++)
732 if (dmi_match(DMI_CHASSIS_TYPE, chassis_types[i]))
733 return true;
734
735 return false;
736 }
737
738 /*
739 * On many modern laptops ATKBD_CMD_GETID may cause problems, on these laptops
740 * the controller is always in translated mode. In this mode mice/touchpads will
741 * not work. So in this case simply assume a keyboard is connected to avoid
742 * confusing some laptop keyboards.
743 *
744 * Skipping ATKBD_CMD_GETID ends up using a fake keyboard id. Using the standard
745 * 0xab83 id is ok in translated mode, only atkbd_select_set() checks atkbd->id
746 * and in translated mode that is a no-op.
747 */
atkbd_skip_getid(struct atkbd * atkbd)748 static bool atkbd_skip_getid(struct atkbd *atkbd)
749 {
750 return atkbd->translated && atkbd_is_portable_device();
751 }
752 #else
atkbd_skip_getid(struct atkbd * atkbd)753 static inline bool atkbd_skip_getid(struct atkbd *atkbd) { return false; }
754 #endif
755
756 /*
757 * atkbd_probe() probes for an AT keyboard on a serio port.
758 */
759
atkbd_probe(struct atkbd * atkbd)760 static int atkbd_probe(struct atkbd *atkbd)
761 {
762 struct ps2dev *ps2dev = &atkbd->ps2dev;
763 unsigned char param[2];
764
765 /*
766 * Some systems, where the bit-twiddling when testing the io-lines of the
767 * controller may confuse the keyboard need a full reset of the keyboard. On
768 * these systems the BIOS also usually doesn't do it for us.
769 */
770
771 if (atkbd_reset)
772 if (ps2_command(ps2dev, NULL, ATKBD_CMD_RESET_BAT))
773 dev_warn(&ps2dev->serio->dev,
774 "keyboard reset failed on %s\n",
775 ps2dev->serio->phys);
776
777 if (atkbd_skip_getid(atkbd)) {
778 atkbd->id = 0xab83;
779 return 0;
780 }
781
782 /*
783 * Then we check the keyboard ID. We should get 0xab83 under normal conditions.
784 * Some keyboards report different values, but the first byte is always 0xab or
785 * 0xac. Some old AT keyboards don't report anything. If a mouse is connected, this
786 * should make sure we don't try to set the LEDs on it.
787 */
788
789 param[0] = param[1] = 0xa5; /* initialize with invalid values */
790 if (ps2_command(ps2dev, param, ATKBD_CMD_GETID)) {
791
792 /*
793 * If the get ID command failed, we check if we can at least set
794 * the LEDs on the keyboard. This should work on every keyboard out there.
795 * It also turns the LEDs off, which we want anyway.
796 */
797 param[0] = 0;
798 if (ps2_command(ps2dev, param, ATKBD_CMD_SETLEDS))
799 return -1;
800 atkbd->id = 0xabba;
801 return 0;
802 }
803
804 if (!ps2_is_keyboard_id(param[0]))
805 return -1;
806
807 atkbd->id = (param[0] << 8) | param[1];
808
809 if (atkbd->id == 0xaca1 && atkbd->translated) {
810 dev_err(&ps2dev->serio->dev,
811 "NCD terminal keyboards are only supported on non-translating controllers. "
812 "Use i8042.direct=1 to disable translation.\n");
813 return -1;
814 }
815
816 /*
817 * Make sure nothing is coming from the keyboard and disturbs our
818 * internal state.
819 */
820 if (!atkbd_skip_deactivate)
821 atkbd_deactivate(atkbd);
822
823 return 0;
824 }
825
826 /*
827 * atkbd_select_set checks if a keyboard has a working Set 3 support, and
828 * sets it into that. Unfortunately there are keyboards that can be switched
829 * to Set 3, but don't work well in that (BTC Multimedia ...)
830 */
831
atkbd_select_set(struct atkbd * atkbd,int target_set,int allow_extra)832 static int atkbd_select_set(struct atkbd *atkbd, int target_set, int allow_extra)
833 {
834 struct ps2dev *ps2dev = &atkbd->ps2dev;
835 unsigned char param[2];
836
837 atkbd->extra = false;
838 /*
839 * For known special keyboards we can go ahead and set the correct set.
840 * We check for NCD PS/2 Sun, NorthGate OmniKey 101 and
841 * IBM RapidAccess / IBM EzButton / Chicony KBP-8993 keyboards.
842 */
843
844 if (atkbd->translated)
845 return 2;
846
847 if (atkbd->id == 0xaca1) {
848 param[0] = 3;
849 ps2_command(ps2dev, param, ATKBD_CMD_SSCANSET);
850 return 3;
851 }
852
853 if (allow_extra) {
854 param[0] = 0x71;
855 if (!ps2_command(ps2dev, param, ATKBD_CMD_EX_ENABLE)) {
856 atkbd->extra = true;
857 return 2;
858 }
859 }
860
861 if (atkbd_terminal) {
862 ps2_command(ps2dev, param, ATKBD_CMD_SETALL_MB);
863 return 3;
864 }
865
866 if (target_set != 3)
867 return 2;
868
869 if (!ps2_command(ps2dev, param, ATKBD_CMD_OK_GETID)) {
870 atkbd->id = param[0] << 8 | param[1];
871 return 2;
872 }
873
874 param[0] = 3;
875 if (ps2_command(ps2dev, param, ATKBD_CMD_SSCANSET))
876 return 2;
877
878 param[0] = 0;
879 if (ps2_command(ps2dev, param, ATKBD_CMD_GSCANSET))
880 return 2;
881
882 if (param[0] != 3) {
883 param[0] = 2;
884 if (ps2_command(ps2dev, param, ATKBD_CMD_SSCANSET))
885 return 2;
886 }
887
888 ps2_command(ps2dev, param, ATKBD_CMD_SETALL_MBR);
889
890 return 3;
891 }
892
atkbd_reset_state(struct atkbd * atkbd)893 static int atkbd_reset_state(struct atkbd *atkbd)
894 {
895 struct ps2dev *ps2dev = &atkbd->ps2dev;
896 unsigned char param[1];
897
898 /*
899 * Set the LEDs to a predefined state (all off).
900 */
901
902 param[0] = 0;
903 if (ps2_command(ps2dev, param, ATKBD_CMD_SETLEDS))
904 return -1;
905
906 /*
907 * Set autorepeat to fastest possible.
908 */
909
910 param[0] = 0;
911 if (ps2_command(ps2dev, param, ATKBD_CMD_SETREP))
912 return -1;
913
914 return 0;
915 }
916
917 /*
918 * atkbd_cleanup() restores the keyboard state so that BIOS is happy after a
919 * reboot.
920 */
921
atkbd_cleanup(struct serio * serio)922 static void atkbd_cleanup(struct serio *serio)
923 {
924 struct atkbd *atkbd = serio_get_drvdata(serio);
925
926 atkbd_disable(atkbd);
927 ps2_command(&atkbd->ps2dev, NULL, ATKBD_CMD_RESET_DEF);
928 }
929
930
931 /*
932 * atkbd_disconnect() closes and frees.
933 */
934
atkbd_disconnect(struct serio * serio)935 static void atkbd_disconnect(struct serio *serio)
936 {
937 struct atkbd *atkbd = serio_get_drvdata(serio);
938
939 sysfs_remove_group(&serio->dev.kobj, &atkbd_attribute_group);
940
941 atkbd_disable(atkbd);
942
943 input_unregister_device(atkbd->dev);
944
945 /*
946 * Make sure we don't have a command in flight.
947 * Note that since atkbd->enabled is false event work will keep
948 * rescheduling itself until it gets canceled and will not try
949 * accessing freed input device or serio port.
950 */
951 cancel_delayed_work_sync(&atkbd->event_work);
952
953 serio_close(serio);
954 serio_set_drvdata(serio, NULL);
955 kfree(atkbd);
956 }
957
958 /*
959 * generate release events for the keycodes given in data
960 */
atkbd_apply_forced_release_keylist(struct atkbd * atkbd,const void * data)961 static void atkbd_apply_forced_release_keylist(struct atkbd* atkbd,
962 const void *data)
963 {
964 const unsigned int *keys = data;
965 unsigned int i;
966
967 if (atkbd->set == 2)
968 for (i = 0; keys[i] != -1U; i++)
969 __set_bit(keys[i], atkbd->force_release_mask);
970 }
971
972 /*
973 * Most special keys (Fn+F?) on Dell laptops do not generate release
974 * events so we have to do it ourselves.
975 */
976 static unsigned int atkbd_dell_laptop_forced_release_keys[] = {
977 0x85, 0x86, 0x87, 0x88, 0x89, 0x8a, 0x8b, 0x8f, 0x93, -1U
978 };
979
980 /*
981 * Perform fixup for HP system that doesn't generate release
982 * for its video switch
983 */
984 static unsigned int atkbd_hp_forced_release_keys[] = {
985 0x94, -1U
986 };
987
988 /*
989 * Samsung NC10,NC20 with Fn+F? key release not working
990 */
991 static unsigned int atkbd_samsung_forced_release_keys[] = {
992 0x82, 0x83, 0x84, 0x86, 0x88, 0x89, 0xb3, 0xf7, 0xf9, -1U
993 };
994
995 /*
996 * Amilo Pi 3525 key release for Fn+Volume keys not working
997 */
998 static unsigned int atkbd_amilo_pi3525_forced_release_keys[] = {
999 0x20, 0xa0, 0x2e, 0xae, 0x30, 0xb0, -1U
1000 };
1001
1002 /*
1003 * Amilo Xi 3650 key release for light touch bar not working
1004 */
1005 static unsigned int atkbd_amilo_xi3650_forced_release_keys[] = {
1006 0x67, 0xed, 0x90, 0xa2, 0x99, 0xa4, 0xae, 0xb0, -1U
1007 };
1008
1009 /*
1010 * Soltech TA12 system with broken key release on volume keys and mute key
1011 */
1012 static unsigned int atkdb_soltech_ta12_forced_release_keys[] = {
1013 0xa0, 0xae, 0xb0, -1U
1014 };
1015
1016 /*
1017 * Many notebooks don't send key release event for volume up/down
1018 * keys, with key list below common among them
1019 */
1020 static unsigned int atkbd_volume_forced_release_keys[] = {
1021 0xae, 0xb0, -1U
1022 };
1023
1024 /*
1025 * OQO 01+ multimedia keys (64--66) generate e0 6x upon release whereas
1026 * they should be generating e4-e6 (0x80 | code).
1027 */
atkbd_oqo_01plus_scancode_fixup(struct atkbd * atkbd,unsigned int code)1028 static unsigned int atkbd_oqo_01plus_scancode_fixup(struct atkbd *atkbd,
1029 unsigned int code)
1030 {
1031 if (atkbd->translated && atkbd->emul == 1 &&
1032 (code == 0x64 || code == 0x65 || code == 0x66)) {
1033 atkbd->emul = 0;
1034 code |= 0x80;
1035 }
1036
1037 return code;
1038 }
1039
1040 /*
1041 * atkbd_set_keycode_table() initializes keyboard's keycode table
1042 * according to the selected scancode set
1043 */
1044
atkbd_set_keycode_table(struct atkbd * atkbd)1045 static void atkbd_set_keycode_table(struct atkbd *atkbd)
1046 {
1047 unsigned int scancode;
1048 int i, j;
1049
1050 memset(atkbd->keycode, 0, sizeof(atkbd->keycode));
1051 bitmap_zero(atkbd->force_release_mask, ATKBD_KEYMAP_SIZE);
1052
1053 if (atkbd->translated) {
1054 for (i = 0; i < 128; i++) {
1055 scancode = atkbd_unxlate_table[i];
1056 atkbd->keycode[i] = atkbd_set2_keycode[scancode];
1057 atkbd->keycode[i | 0x80] = atkbd_set2_keycode[scancode | 0x80];
1058 if (atkbd->scroll)
1059 for (j = 0; j < ARRAY_SIZE(atkbd_scroll_keys); j++)
1060 if ((scancode | 0x80) == atkbd_scroll_keys[j].set2)
1061 atkbd->keycode[i | 0x80] = atkbd_scroll_keys[j].keycode;
1062 }
1063 } else if (atkbd->set == 3) {
1064 memcpy(atkbd->keycode, atkbd_set3_keycode, sizeof(atkbd->keycode));
1065 } else {
1066 memcpy(atkbd->keycode, atkbd_set2_keycode, sizeof(atkbd->keycode));
1067
1068 if (atkbd->scroll)
1069 for (i = 0; i < ARRAY_SIZE(atkbd_scroll_keys); i++) {
1070 scancode = atkbd_scroll_keys[i].set2;
1071 atkbd->keycode[scancode] = atkbd_scroll_keys[i].keycode;
1072 }
1073 }
1074
1075 /*
1076 * HANGEUL and HANJA keys do not send release events so we need to
1077 * generate such events ourselves
1078 */
1079 scancode = atkbd_compat_scancode(atkbd, ATKBD_RET_HANGEUL);
1080 atkbd->keycode[scancode] = KEY_HANGEUL;
1081 __set_bit(scancode, atkbd->force_release_mask);
1082
1083 scancode = atkbd_compat_scancode(atkbd, ATKBD_RET_HANJA);
1084 atkbd->keycode[scancode] = KEY_HANJA;
1085 __set_bit(scancode, atkbd->force_release_mask);
1086
1087 /*
1088 * Perform additional fixups
1089 */
1090 if (atkbd_platform_fixup)
1091 atkbd_platform_fixup(atkbd, atkbd_platform_fixup_data);
1092 }
1093
1094 /*
1095 * atkbd_set_device_attrs() sets up keyboard's input device structure
1096 */
1097
atkbd_set_device_attrs(struct atkbd * atkbd)1098 static void atkbd_set_device_attrs(struct atkbd *atkbd)
1099 {
1100 struct input_dev *input_dev = atkbd->dev;
1101 int i;
1102
1103 if (atkbd->extra)
1104 snprintf(atkbd->name, sizeof(atkbd->name),
1105 "AT Set 2 Extra keyboard");
1106 else
1107 snprintf(atkbd->name, sizeof(atkbd->name),
1108 "AT %s Set %d keyboard",
1109 atkbd->translated ? "Translated" : "Raw", atkbd->set);
1110
1111 snprintf(atkbd->phys, sizeof(atkbd->phys),
1112 "%s/input0", atkbd->ps2dev.serio->phys);
1113
1114 input_dev->name = atkbd->name;
1115 input_dev->phys = atkbd->phys;
1116 input_dev->id.bustype = BUS_I8042;
1117 input_dev->id.vendor = 0x0001;
1118 input_dev->id.product = atkbd->translated ? 1 : atkbd->set;
1119 input_dev->id.version = atkbd->id;
1120 input_dev->event = atkbd_event;
1121 input_dev->dev.parent = &atkbd->ps2dev.serio->dev;
1122
1123 input_set_drvdata(input_dev, atkbd);
1124
1125 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP) |
1126 BIT_MASK(EV_MSC);
1127
1128 if (atkbd->write) {
1129 input_dev->evbit[0] |= BIT_MASK(EV_LED);
1130 input_dev->ledbit[0] = BIT_MASK(LED_NUML) |
1131 BIT_MASK(LED_CAPSL) | BIT_MASK(LED_SCROLLL);
1132 }
1133
1134 if (atkbd->extra)
1135 input_dev->ledbit[0] |= BIT_MASK(LED_COMPOSE) |
1136 BIT_MASK(LED_SUSPEND) | BIT_MASK(LED_SLEEP) |
1137 BIT_MASK(LED_MUTE) | BIT_MASK(LED_MISC);
1138
1139 if (!atkbd->softrepeat) {
1140 input_dev->rep[REP_DELAY] = 250;
1141 input_dev->rep[REP_PERIOD] = 33;
1142 }
1143
1144 input_dev->mscbit[0] = atkbd->softraw ? BIT_MASK(MSC_SCAN) :
1145 BIT_MASK(MSC_RAW) | BIT_MASK(MSC_SCAN);
1146
1147 if (atkbd->scroll) {
1148 input_dev->evbit[0] |= BIT_MASK(EV_REL);
1149 input_dev->relbit[0] = BIT_MASK(REL_WHEEL) |
1150 BIT_MASK(REL_HWHEEL);
1151 __set_bit(BTN_MIDDLE, input_dev->keybit);
1152 }
1153
1154 input_dev->keycode = atkbd->keycode;
1155 input_dev->keycodesize = sizeof(unsigned short);
1156 input_dev->keycodemax = ARRAY_SIZE(atkbd_set2_keycode);
1157
1158 for (i = 0; i < ATKBD_KEYMAP_SIZE; i++) {
1159 if (atkbd->keycode[i] != KEY_RESERVED &&
1160 atkbd->keycode[i] != ATKBD_KEY_NULL &&
1161 atkbd->keycode[i] < ATKBD_SPECIAL) {
1162 __set_bit(atkbd->keycode[i], input_dev->keybit);
1163 }
1164 }
1165 }
1166
1167 /*
1168 * atkbd_connect() is called when the serio module finds an interface
1169 * that isn't handled yet by an appropriate device driver. We check if
1170 * there is an AT keyboard out there and if yes, we register ourselves
1171 * to the input module.
1172 */
1173
atkbd_connect(struct serio * serio,struct serio_driver * drv)1174 static int atkbd_connect(struct serio *serio, struct serio_driver *drv)
1175 {
1176 struct atkbd *atkbd;
1177 struct input_dev *dev;
1178 int err = -ENOMEM;
1179
1180 atkbd = kzalloc(sizeof(struct atkbd), GFP_KERNEL);
1181 dev = input_allocate_device();
1182 if (!atkbd || !dev)
1183 goto fail1;
1184
1185 atkbd->dev = dev;
1186 ps2_init(&atkbd->ps2dev, serio);
1187 INIT_DELAYED_WORK(&atkbd->event_work, atkbd_event_work);
1188 mutex_init(&atkbd->mutex);
1189
1190 switch (serio->id.type) {
1191
1192 case SERIO_8042_XL:
1193 atkbd->translated = true;
1194 /* Fall through */
1195
1196 case SERIO_8042:
1197 if (serio->write)
1198 atkbd->write = true;
1199 break;
1200 }
1201
1202 atkbd->softraw = atkbd_softraw;
1203 atkbd->softrepeat = atkbd_softrepeat;
1204 atkbd->scroll = atkbd_scroll;
1205
1206 if (atkbd->softrepeat)
1207 atkbd->softraw = true;
1208
1209 serio_set_drvdata(serio, atkbd);
1210
1211 err = serio_open(serio, drv);
1212 if (err)
1213 goto fail2;
1214
1215 if (atkbd->write) {
1216
1217 if (atkbd_probe(atkbd)) {
1218 err = -ENODEV;
1219 goto fail3;
1220 }
1221
1222 atkbd->set = atkbd_select_set(atkbd, atkbd_set, atkbd_extra);
1223 atkbd_reset_state(atkbd);
1224
1225 } else {
1226 atkbd->set = 2;
1227 atkbd->id = 0xab00;
1228 }
1229
1230 atkbd_set_keycode_table(atkbd);
1231 atkbd_set_device_attrs(atkbd);
1232
1233 err = sysfs_create_group(&serio->dev.kobj, &atkbd_attribute_group);
1234 if (err)
1235 goto fail3;
1236
1237 atkbd_enable(atkbd);
1238 if (serio->write)
1239 atkbd_activate(atkbd);
1240
1241 err = input_register_device(atkbd->dev);
1242 if (err)
1243 goto fail4;
1244
1245 return 0;
1246
1247 fail4: sysfs_remove_group(&serio->dev.kobj, &atkbd_attribute_group);
1248 fail3: serio_close(serio);
1249 fail2: serio_set_drvdata(serio, NULL);
1250 fail1: input_free_device(dev);
1251 kfree(atkbd);
1252 return err;
1253 }
1254
1255 /*
1256 * atkbd_reconnect() tries to restore keyboard into a sane state and is
1257 * most likely called on resume.
1258 */
1259
atkbd_reconnect(struct serio * serio)1260 static int atkbd_reconnect(struct serio *serio)
1261 {
1262 struct atkbd *atkbd = serio_get_drvdata(serio);
1263 struct serio_driver *drv = serio->drv;
1264 int retval = -1;
1265
1266 if (!atkbd || !drv) {
1267 dev_dbg(&serio->dev,
1268 "reconnect request, but serio is disconnected, ignoring...\n");
1269 return -1;
1270 }
1271
1272 mutex_lock(&atkbd->mutex);
1273
1274 atkbd_disable(atkbd);
1275
1276 if (atkbd->write) {
1277 if (atkbd_probe(atkbd))
1278 goto out;
1279
1280 if (atkbd->set != atkbd_select_set(atkbd, atkbd->set, atkbd->extra))
1281 goto out;
1282
1283 /*
1284 * Restore LED state and repeat rate. While input core
1285 * will do this for us at resume time reconnect may happen
1286 * because user requested it via sysfs or simply because
1287 * keyboard was unplugged and plugged in again so we need
1288 * to do it ourselves here.
1289 */
1290 atkbd_set_leds(atkbd);
1291 if (!atkbd->softrepeat)
1292 atkbd_set_repeat_rate(atkbd);
1293
1294 }
1295
1296 /*
1297 * Reset our state machine in case reconnect happened in the middle
1298 * of multi-byte scancode.
1299 */
1300 atkbd->xl_bit = 0;
1301 atkbd->emul = 0;
1302
1303 atkbd_enable(atkbd);
1304 if (atkbd->write)
1305 atkbd_activate(atkbd);
1306
1307 retval = 0;
1308
1309 out:
1310 mutex_unlock(&atkbd->mutex);
1311 return retval;
1312 }
1313
1314 static const struct serio_device_id atkbd_serio_ids[] = {
1315 {
1316 .type = SERIO_8042,
1317 .proto = SERIO_ANY,
1318 .id = SERIO_ANY,
1319 .extra = SERIO_ANY,
1320 },
1321 {
1322 .type = SERIO_8042_XL,
1323 .proto = SERIO_ANY,
1324 .id = SERIO_ANY,
1325 .extra = SERIO_ANY,
1326 },
1327 {
1328 .type = SERIO_RS232,
1329 .proto = SERIO_PS2SER,
1330 .id = SERIO_ANY,
1331 .extra = SERIO_ANY,
1332 },
1333 { 0 }
1334 };
1335
1336 MODULE_DEVICE_TABLE(serio, atkbd_serio_ids);
1337
1338 static struct serio_driver atkbd_drv = {
1339 .driver = {
1340 .name = "atkbd",
1341 },
1342 .description = DRIVER_DESC,
1343 .id_table = atkbd_serio_ids,
1344 .interrupt = atkbd_interrupt,
1345 .connect = atkbd_connect,
1346 .reconnect = atkbd_reconnect,
1347 .disconnect = atkbd_disconnect,
1348 .cleanup = atkbd_cleanup,
1349 };
1350
atkbd_attr_show_helper(struct device * dev,char * buf,ssize_t (* handler)(struct atkbd *,char *))1351 static ssize_t atkbd_attr_show_helper(struct device *dev, char *buf,
1352 ssize_t (*handler)(struct atkbd *, char *))
1353 {
1354 struct serio *serio = to_serio_port(dev);
1355 struct atkbd *atkbd = serio_get_drvdata(serio);
1356
1357 return handler(atkbd, buf);
1358 }
1359
atkbd_attr_set_helper(struct device * dev,const char * buf,size_t count,ssize_t (* handler)(struct atkbd *,const char *,size_t))1360 static ssize_t atkbd_attr_set_helper(struct device *dev, const char *buf, size_t count,
1361 ssize_t (*handler)(struct atkbd *, const char *, size_t))
1362 {
1363 struct serio *serio = to_serio_port(dev);
1364 struct atkbd *atkbd = serio_get_drvdata(serio);
1365 int retval;
1366
1367 retval = mutex_lock_interruptible(&atkbd->mutex);
1368 if (retval)
1369 return retval;
1370
1371 atkbd_disable(atkbd);
1372 retval = handler(atkbd, buf, count);
1373 atkbd_enable(atkbd);
1374
1375 mutex_unlock(&atkbd->mutex);
1376
1377 return retval;
1378 }
1379
atkbd_show_extra(struct atkbd * atkbd,char * buf)1380 static ssize_t atkbd_show_extra(struct atkbd *atkbd, char *buf)
1381 {
1382 return sprintf(buf, "%d\n", atkbd->extra ? 1 : 0);
1383 }
1384
atkbd_set_extra(struct atkbd * atkbd,const char * buf,size_t count)1385 static ssize_t atkbd_set_extra(struct atkbd *atkbd, const char *buf, size_t count)
1386 {
1387 struct input_dev *old_dev, *new_dev;
1388 unsigned int value;
1389 int err;
1390 bool old_extra;
1391 unsigned char old_set;
1392
1393 if (!atkbd->write)
1394 return -EIO;
1395
1396 err = kstrtouint(buf, 10, &value);
1397 if (err)
1398 return err;
1399
1400 if (value > 1)
1401 return -EINVAL;
1402
1403 if (atkbd->extra != value) {
1404 /*
1405 * Since device's properties will change we need to
1406 * unregister old device. But allocate and register
1407 * new one first to make sure we have it.
1408 */
1409 old_dev = atkbd->dev;
1410 old_extra = atkbd->extra;
1411 old_set = atkbd->set;
1412
1413 new_dev = input_allocate_device();
1414 if (!new_dev)
1415 return -ENOMEM;
1416
1417 atkbd->dev = new_dev;
1418 atkbd->set = atkbd_select_set(atkbd, atkbd->set, value);
1419 atkbd_reset_state(atkbd);
1420 atkbd_activate(atkbd);
1421 atkbd_set_keycode_table(atkbd);
1422 atkbd_set_device_attrs(atkbd);
1423
1424 err = input_register_device(atkbd->dev);
1425 if (err) {
1426 input_free_device(new_dev);
1427
1428 atkbd->dev = old_dev;
1429 atkbd->set = atkbd_select_set(atkbd, old_set, old_extra);
1430 atkbd_set_keycode_table(atkbd);
1431 atkbd_set_device_attrs(atkbd);
1432
1433 return err;
1434 }
1435 input_unregister_device(old_dev);
1436
1437 }
1438 return count;
1439 }
1440
atkbd_show_force_release(struct atkbd * atkbd,char * buf)1441 static ssize_t atkbd_show_force_release(struct atkbd *atkbd, char *buf)
1442 {
1443 size_t len = scnprintf(buf, PAGE_SIZE - 1, "%*pbl",
1444 ATKBD_KEYMAP_SIZE, atkbd->force_release_mask);
1445
1446 buf[len++] = '\n';
1447 buf[len] = '\0';
1448
1449 return len;
1450 }
1451
atkbd_set_force_release(struct atkbd * atkbd,const char * buf,size_t count)1452 static ssize_t atkbd_set_force_release(struct atkbd *atkbd,
1453 const char *buf, size_t count)
1454 {
1455 /* 64 bytes on stack should be acceptable */
1456 DECLARE_BITMAP(new_mask, ATKBD_KEYMAP_SIZE);
1457 int err;
1458
1459 err = bitmap_parselist(buf, new_mask, ATKBD_KEYMAP_SIZE);
1460 if (err)
1461 return err;
1462
1463 memcpy(atkbd->force_release_mask, new_mask, sizeof(atkbd->force_release_mask));
1464 return count;
1465 }
1466
1467
atkbd_show_scroll(struct atkbd * atkbd,char * buf)1468 static ssize_t atkbd_show_scroll(struct atkbd *atkbd, char *buf)
1469 {
1470 return sprintf(buf, "%d\n", atkbd->scroll ? 1 : 0);
1471 }
1472
atkbd_set_scroll(struct atkbd * atkbd,const char * buf,size_t count)1473 static ssize_t atkbd_set_scroll(struct atkbd *atkbd, const char *buf, size_t count)
1474 {
1475 struct input_dev *old_dev, *new_dev;
1476 unsigned int value;
1477 int err;
1478 bool old_scroll;
1479
1480 err = kstrtouint(buf, 10, &value);
1481 if (err)
1482 return err;
1483
1484 if (value > 1)
1485 return -EINVAL;
1486
1487 if (atkbd->scroll != value) {
1488 old_dev = atkbd->dev;
1489 old_scroll = atkbd->scroll;
1490
1491 new_dev = input_allocate_device();
1492 if (!new_dev)
1493 return -ENOMEM;
1494
1495 atkbd->dev = new_dev;
1496 atkbd->scroll = value;
1497 atkbd_set_keycode_table(atkbd);
1498 atkbd_set_device_attrs(atkbd);
1499
1500 err = input_register_device(atkbd->dev);
1501 if (err) {
1502 input_free_device(new_dev);
1503
1504 atkbd->scroll = old_scroll;
1505 atkbd->dev = old_dev;
1506 atkbd_set_keycode_table(atkbd);
1507 atkbd_set_device_attrs(atkbd);
1508
1509 return err;
1510 }
1511 input_unregister_device(old_dev);
1512 }
1513 return count;
1514 }
1515
atkbd_show_set(struct atkbd * atkbd,char * buf)1516 static ssize_t atkbd_show_set(struct atkbd *atkbd, char *buf)
1517 {
1518 return sprintf(buf, "%d\n", atkbd->set);
1519 }
1520
atkbd_set_set(struct atkbd * atkbd,const char * buf,size_t count)1521 static ssize_t atkbd_set_set(struct atkbd *atkbd, const char *buf, size_t count)
1522 {
1523 struct input_dev *old_dev, *new_dev;
1524 unsigned int value;
1525 int err;
1526 unsigned char old_set;
1527 bool old_extra;
1528
1529 if (!atkbd->write)
1530 return -EIO;
1531
1532 err = kstrtouint(buf, 10, &value);
1533 if (err)
1534 return err;
1535
1536 if (value != 2 && value != 3)
1537 return -EINVAL;
1538
1539 if (atkbd->set != value) {
1540 old_dev = atkbd->dev;
1541 old_extra = atkbd->extra;
1542 old_set = atkbd->set;
1543
1544 new_dev = input_allocate_device();
1545 if (!new_dev)
1546 return -ENOMEM;
1547
1548 atkbd->dev = new_dev;
1549 atkbd->set = atkbd_select_set(atkbd, value, atkbd->extra);
1550 atkbd_reset_state(atkbd);
1551 atkbd_activate(atkbd);
1552 atkbd_set_keycode_table(atkbd);
1553 atkbd_set_device_attrs(atkbd);
1554
1555 err = input_register_device(atkbd->dev);
1556 if (err) {
1557 input_free_device(new_dev);
1558
1559 atkbd->dev = old_dev;
1560 atkbd->set = atkbd_select_set(atkbd, old_set, old_extra);
1561 atkbd_set_keycode_table(atkbd);
1562 atkbd_set_device_attrs(atkbd);
1563
1564 return err;
1565 }
1566 input_unregister_device(old_dev);
1567 }
1568 return count;
1569 }
1570
atkbd_show_softrepeat(struct atkbd * atkbd,char * buf)1571 static ssize_t atkbd_show_softrepeat(struct atkbd *atkbd, char *buf)
1572 {
1573 return sprintf(buf, "%d\n", atkbd->softrepeat ? 1 : 0);
1574 }
1575
atkbd_set_softrepeat(struct atkbd * atkbd,const char * buf,size_t count)1576 static ssize_t atkbd_set_softrepeat(struct atkbd *atkbd, const char *buf, size_t count)
1577 {
1578 struct input_dev *old_dev, *new_dev;
1579 unsigned int value;
1580 int err;
1581 bool old_softrepeat, old_softraw;
1582
1583 if (!atkbd->write)
1584 return -EIO;
1585
1586 err = kstrtouint(buf, 10, &value);
1587 if (err)
1588 return err;
1589
1590 if (value > 1)
1591 return -EINVAL;
1592
1593 if (atkbd->softrepeat != value) {
1594 old_dev = atkbd->dev;
1595 old_softrepeat = atkbd->softrepeat;
1596 old_softraw = atkbd->softraw;
1597
1598 new_dev = input_allocate_device();
1599 if (!new_dev)
1600 return -ENOMEM;
1601
1602 atkbd->dev = new_dev;
1603 atkbd->softrepeat = value;
1604 if (atkbd->softrepeat)
1605 atkbd->softraw = true;
1606 atkbd_set_device_attrs(atkbd);
1607
1608 err = input_register_device(atkbd->dev);
1609 if (err) {
1610 input_free_device(new_dev);
1611
1612 atkbd->dev = old_dev;
1613 atkbd->softrepeat = old_softrepeat;
1614 atkbd->softraw = old_softraw;
1615 atkbd_set_device_attrs(atkbd);
1616
1617 return err;
1618 }
1619 input_unregister_device(old_dev);
1620 }
1621 return count;
1622 }
1623
1624
atkbd_show_softraw(struct atkbd * atkbd,char * buf)1625 static ssize_t atkbd_show_softraw(struct atkbd *atkbd, char *buf)
1626 {
1627 return sprintf(buf, "%d\n", atkbd->softraw ? 1 : 0);
1628 }
1629
atkbd_set_softraw(struct atkbd * atkbd,const char * buf,size_t count)1630 static ssize_t atkbd_set_softraw(struct atkbd *atkbd, const char *buf, size_t count)
1631 {
1632 struct input_dev *old_dev, *new_dev;
1633 unsigned int value;
1634 int err;
1635 bool old_softraw;
1636
1637 err = kstrtouint(buf, 10, &value);
1638 if (err)
1639 return err;
1640
1641 if (value > 1)
1642 return -EINVAL;
1643
1644 if (atkbd->softraw != value) {
1645 old_dev = atkbd->dev;
1646 old_softraw = atkbd->softraw;
1647
1648 new_dev = input_allocate_device();
1649 if (!new_dev)
1650 return -ENOMEM;
1651
1652 atkbd->dev = new_dev;
1653 atkbd->softraw = value;
1654 atkbd_set_device_attrs(atkbd);
1655
1656 err = input_register_device(atkbd->dev);
1657 if (err) {
1658 input_free_device(new_dev);
1659
1660 atkbd->dev = old_dev;
1661 atkbd->softraw = old_softraw;
1662 atkbd_set_device_attrs(atkbd);
1663
1664 return err;
1665 }
1666 input_unregister_device(old_dev);
1667 }
1668 return count;
1669 }
1670
atkbd_show_err_count(struct atkbd * atkbd,char * buf)1671 static ssize_t atkbd_show_err_count(struct atkbd *atkbd, char *buf)
1672 {
1673 return sprintf(buf, "%lu\n", atkbd->err_count);
1674 }
1675
atkbd_setup_forced_release(const struct dmi_system_id * id)1676 static int __init atkbd_setup_forced_release(const struct dmi_system_id *id)
1677 {
1678 atkbd_platform_fixup = atkbd_apply_forced_release_keylist;
1679 atkbd_platform_fixup_data = id->driver_data;
1680
1681 return 1;
1682 }
1683
atkbd_setup_scancode_fixup(const struct dmi_system_id * id)1684 static int __init atkbd_setup_scancode_fixup(const struct dmi_system_id *id)
1685 {
1686 atkbd_platform_scancode_fixup = id->driver_data;
1687
1688 return 1;
1689 }
1690
atkbd_deactivate_fixup(const struct dmi_system_id * id)1691 static int __init atkbd_deactivate_fixup(const struct dmi_system_id *id)
1692 {
1693 atkbd_skip_deactivate = true;
1694 return 1;
1695 }
1696
1697 /*
1698 * NOTE: do not add any more "force release" quirks to this table. The
1699 * task of adjusting list of keys that should be "released" automatically
1700 * by the driver is now delegated to userspace tools, such as udev, so
1701 * submit such quirks there.
1702 */
1703 static const struct dmi_system_id atkbd_dmi_quirk_table[] __initconst = {
1704 {
1705 .matches = {
1706 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
1707 DMI_MATCH(DMI_CHASSIS_TYPE, "8"), /* Portable */
1708 },
1709 .callback = atkbd_setup_forced_release,
1710 .driver_data = atkbd_dell_laptop_forced_release_keys,
1711 },
1712 {
1713 .matches = {
1714 DMI_MATCH(DMI_SYS_VENDOR, "Dell Computer Corporation"),
1715 DMI_MATCH(DMI_CHASSIS_TYPE, "8"), /* Portable */
1716 },
1717 .callback = atkbd_setup_forced_release,
1718 .driver_data = atkbd_dell_laptop_forced_release_keys,
1719 },
1720 {
1721 .matches = {
1722 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
1723 DMI_MATCH(DMI_PRODUCT_NAME, "HP 2133"),
1724 },
1725 .callback = atkbd_setup_forced_release,
1726 .driver_data = atkbd_hp_forced_release_keys,
1727 },
1728 {
1729 .matches = {
1730 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
1731 DMI_MATCH(DMI_PRODUCT_NAME, "Pavilion ZV6100"),
1732 },
1733 .callback = atkbd_setup_forced_release,
1734 .driver_data = atkbd_volume_forced_release_keys,
1735 },
1736 {
1737 .matches = {
1738 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
1739 DMI_MATCH(DMI_PRODUCT_NAME, "Presario R4000"),
1740 },
1741 .callback = atkbd_setup_forced_release,
1742 .driver_data = atkbd_volume_forced_release_keys,
1743 },
1744 {
1745 .matches = {
1746 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
1747 DMI_MATCH(DMI_PRODUCT_NAME, "Presario R4100"),
1748 },
1749 .callback = atkbd_setup_forced_release,
1750 .driver_data = atkbd_volume_forced_release_keys,
1751 },
1752 {
1753 .matches = {
1754 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
1755 DMI_MATCH(DMI_PRODUCT_NAME, "Presario R4200"),
1756 },
1757 .callback = atkbd_setup_forced_release,
1758 .driver_data = atkbd_volume_forced_release_keys,
1759 },
1760 {
1761 /* Inventec Symphony */
1762 .matches = {
1763 DMI_MATCH(DMI_SYS_VENDOR, "INVENTEC"),
1764 DMI_MATCH(DMI_PRODUCT_NAME, "SYMPHONY 6.0/7.0"),
1765 },
1766 .callback = atkbd_setup_forced_release,
1767 .driver_data = atkbd_volume_forced_release_keys,
1768 },
1769 {
1770 /* Samsung NC10 */
1771 .matches = {
1772 DMI_MATCH(DMI_SYS_VENDOR, "SAMSUNG ELECTRONICS CO., LTD."),
1773 DMI_MATCH(DMI_PRODUCT_NAME, "NC10"),
1774 },
1775 .callback = atkbd_setup_forced_release,
1776 .driver_data = atkbd_samsung_forced_release_keys,
1777 },
1778 {
1779 /* Samsung NC20 */
1780 .matches = {
1781 DMI_MATCH(DMI_SYS_VENDOR, "SAMSUNG ELECTRONICS CO., LTD."),
1782 DMI_MATCH(DMI_PRODUCT_NAME, "NC20"),
1783 },
1784 .callback = atkbd_setup_forced_release,
1785 .driver_data = atkbd_samsung_forced_release_keys,
1786 },
1787 {
1788 /* Samsung SQ45S70S */
1789 .matches = {
1790 DMI_MATCH(DMI_SYS_VENDOR, "SAMSUNG ELECTRONICS CO., LTD."),
1791 DMI_MATCH(DMI_PRODUCT_NAME, "SQ45S70S"),
1792 },
1793 .callback = atkbd_setup_forced_release,
1794 .driver_data = atkbd_samsung_forced_release_keys,
1795 },
1796 {
1797 /* Fujitsu Amilo PA 1510 */
1798 .matches = {
1799 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU SIEMENS"),
1800 DMI_MATCH(DMI_PRODUCT_NAME, "AMILO Pa 1510"),
1801 },
1802 .callback = atkbd_setup_forced_release,
1803 .driver_data = atkbd_volume_forced_release_keys,
1804 },
1805 {
1806 /* Fujitsu Amilo Pi 3525 */
1807 .matches = {
1808 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU SIEMENS"),
1809 DMI_MATCH(DMI_PRODUCT_NAME, "AMILO Pi 3525"),
1810 },
1811 .callback = atkbd_setup_forced_release,
1812 .driver_data = atkbd_amilo_pi3525_forced_release_keys,
1813 },
1814 {
1815 /* Fujitsu Amilo Xi 3650 */
1816 .matches = {
1817 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU SIEMENS"),
1818 DMI_MATCH(DMI_PRODUCT_NAME, "AMILO Xi 3650"),
1819 },
1820 .callback = atkbd_setup_forced_release,
1821 .driver_data = atkbd_amilo_xi3650_forced_release_keys,
1822 },
1823 {
1824 .matches = {
1825 DMI_MATCH(DMI_SYS_VENDOR, "Soltech Corporation"),
1826 DMI_MATCH(DMI_PRODUCT_NAME, "TA12"),
1827 },
1828 .callback = atkbd_setup_forced_release,
1829 .driver_data = atkdb_soltech_ta12_forced_release_keys,
1830 },
1831 {
1832 /* OQO Model 01+ */
1833 .matches = {
1834 DMI_MATCH(DMI_SYS_VENDOR, "OQO"),
1835 DMI_MATCH(DMI_PRODUCT_NAME, "ZEPTO"),
1836 },
1837 .callback = atkbd_setup_scancode_fixup,
1838 .driver_data = atkbd_oqo_01plus_scancode_fixup,
1839 },
1840 {
1841 .matches = {
1842 DMI_MATCH(DMI_SYS_VENDOR, "LG Electronics"),
1843 },
1844 .callback = atkbd_deactivate_fixup,
1845 },
1846 { }
1847 };
1848
atkbd_init(void)1849 static int __init atkbd_init(void)
1850 {
1851 dmi_check_system(atkbd_dmi_quirk_table);
1852
1853 return serio_register_driver(&atkbd_drv);
1854 }
1855
atkbd_exit(void)1856 static void __exit atkbd_exit(void)
1857 {
1858 serio_unregister_driver(&atkbd_drv);
1859 }
1860
1861 module_init(atkbd_init);
1862 module_exit(atkbd_exit);
1863