2 * AT and PS/2 keyboard driver
4 * Copyright (c) 1999-2002 Vojtech Pavlik
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License version 2 as published by
10 * the Free Software Foundation.
14 * This driver can handle standard AT keyboards and PS/2 keyboards in
15 * Translated and Raw Set 2 and Set 3, as well as AT keyboards on dumb
16 * input-only controllers and AT keyboards connected over a one way RS232
20 #include <linux/delay.h>
21 #include <linux/module.h>
22 #include <linux/slab.h>
23 #include <linux/interrupt.h>
24 #include <linux/init.h>
25 #include <linux/input.h>
26 #include <linux/serio.h>
27 #include <linux/workqueue.h>
28 #include <linux/libps2.h>
29 #include <linux/mutex.h>
30 #include <linux/dmi.h>
32 #define DRIVER_DESC "AT and PS/2 keyboard driver"
34 MODULE_AUTHOR("Vojtech Pavlik <vojtech@suse.cz>");
35 MODULE_DESCRIPTION(DRIVER_DESC);
36 MODULE_LICENSE("GPL");
38 static int atkbd_set = 2;
39 module_param_named(set, atkbd_set, int, 0);
40 MODULE_PARM_DESC(set, "Select keyboard code set (2 = default, 3 = PS/2 native)");
42 #if defined(__i386__) || defined(__x86_64__) || defined(__hppa__)
43 static int atkbd_reset;
45 static int atkbd_reset = 1;
47 module_param_named(reset, atkbd_reset, bool, 0);
48 MODULE_PARM_DESC(reset, "Reset keyboard during initialization");
50 static int atkbd_softrepeat;
51 module_param_named(softrepeat, atkbd_softrepeat, bool, 0);
52 MODULE_PARM_DESC(softrepeat, "Use software keyboard repeat");
54 static int atkbd_softraw = 1;
55 module_param_named(softraw, atkbd_softraw, bool, 0);
56 MODULE_PARM_DESC(softraw, "Use software generated rawmode");
58 static int atkbd_scroll;
59 module_param_named(scroll, atkbd_scroll, bool, 0);
60 MODULE_PARM_DESC(scroll, "Enable scroll-wheel on MS Office and similar keyboards");
62 static int atkbd_extra;
63 module_param_named(extra, atkbd_extra, bool, 0);
64 MODULE_PARM_DESC(extra, "Enable extra LEDs and keys on IBM RapidAcces, EzKey and similar keyboards");
67 * Scancode to keycode tables. These are just the default setting, and
68 * are loadable via an userland utility.
71 static const unsigned short atkbd_set2_keycode[512] = {
73 #ifdef CONFIG_KEYBOARD_ATKBD_HP_KEYCODES
75 /* XXX: need a more general approach */
77 #include "hpps2atkbd.h" /* include the keyboard scancodes */
80 0, 67, 65, 63, 61, 59, 60, 88, 0, 68, 66, 64, 62, 15, 41,117,
81 0, 56, 42, 93, 29, 16, 2, 0, 0, 0, 44, 31, 30, 17, 3, 0,
82 0, 46, 45, 32, 18, 5, 4, 95, 0, 57, 47, 33, 20, 19, 6,183,
83 0, 49, 48, 35, 34, 21, 7,184, 0, 0, 50, 36, 22, 8, 9,185,
84 0, 51, 37, 23, 24, 11, 10, 0, 0, 52, 53, 38, 39, 25, 12, 0,
85 0, 89, 40, 0, 26, 13, 0, 0, 58, 54, 28, 27, 0, 43, 0, 85,
86 0, 86, 91, 90, 92, 0, 14, 94, 0, 79,124, 75, 71,121, 0, 0,
87 82, 83, 80, 76, 77, 72, 1, 69, 87, 78, 81, 74, 55, 73, 70, 99,
89 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
90 217,100,255, 0, 97,165, 0, 0,156, 0, 0, 0, 0, 0, 0,125,
91 173,114, 0,113, 0, 0, 0,126,128, 0, 0,140, 0, 0, 0,127,
92 159, 0,115, 0,164, 0, 0,116,158, 0,172,166, 0, 0, 0,142,
93 157, 0, 0, 0, 0, 0, 0, 0,155, 0, 98, 0, 0,163, 0, 0,
94 226, 0, 0, 0, 0, 0, 0, 0, 0,255, 96, 0, 0, 0,143, 0,
95 0, 0, 0, 0, 0, 0, 0, 0, 0,107, 0,105,102, 0, 0,112,
96 110,111,108,112,106,103, 0,119, 0,118,109, 0, 99,104,119, 0,
102 static const unsigned short atkbd_set3_keycode[512] = {
104 0, 0, 0, 0, 0, 0, 0, 59, 1,138,128,129,130, 15, 41, 60,
105 131, 29, 42, 86, 58, 16, 2, 61,133, 56, 44, 31, 30, 17, 3, 62,
106 134, 46, 45, 32, 18, 5, 4, 63,135, 57, 47, 33, 20, 19, 6, 64,
107 136, 49, 48, 35, 34, 21, 7, 65,137,100, 50, 36, 22, 8, 9, 66,
108 125, 51, 37, 23, 24, 11, 10, 67,126, 52, 53, 38, 39, 25, 12, 68,
109 113,114, 40, 43, 26, 13, 87, 99, 97, 54, 28, 27, 43, 43, 88, 70,
110 108,105,119,103,111,107, 14,110, 0, 79,106, 75, 71,109,102,104,
111 82, 83, 80, 76, 77, 72, 69, 98, 0, 96, 81, 0, 78, 73, 55,183,
113 184,185,186,187, 74, 94, 92, 93, 0, 0, 0,125,126,127,112, 0,
114 0,139,172,163,165,115,152,172,166,140,160,154,113,114,167,168,
118 static const unsigned short atkbd_unxlate_table[128] = {
119 0,118, 22, 30, 38, 37, 46, 54, 61, 62, 70, 69, 78, 85,102, 13,
120 21, 29, 36, 45, 44, 53, 60, 67, 68, 77, 84, 91, 90, 20, 28, 27,
121 35, 43, 52, 51, 59, 66, 75, 76, 82, 14, 18, 93, 26, 34, 33, 42,
122 50, 49, 58, 65, 73, 74, 89,124, 17, 41, 88, 5, 6, 4, 12, 3,
123 11, 2, 10, 1, 9,119,126,108,117,125,123,107,115,116,121,105,
124 114,122,112,113,127, 96, 97,120, 7, 15, 23, 31, 39, 47, 55, 63,
125 71, 79, 86, 94, 8, 16, 24, 32, 40, 48, 56, 64, 72, 80, 87,111,
126 19, 25, 57, 81, 83, 92, 95, 98, 99,100,101,103,104,106,109,110
129 #define ATKBD_CMD_SETLEDS 0x10ed
130 #define ATKBD_CMD_GSCANSET 0x11f0
131 #define ATKBD_CMD_SSCANSET 0x10f0
132 #define ATKBD_CMD_GETID 0x02f2
133 #define ATKBD_CMD_SETREP 0x10f3
134 #define ATKBD_CMD_ENABLE 0x00f4
135 #define ATKBD_CMD_RESET_DIS 0x00f5
136 #define ATKBD_CMD_SETALL_MBR 0x00fa
137 #define ATKBD_CMD_RESET_BAT 0x02ff
138 #define ATKBD_CMD_RESEND 0x00fe
139 #define ATKBD_CMD_EX_ENABLE 0x10ea
140 #define ATKBD_CMD_EX_SETLEDS 0x20eb
141 #define ATKBD_CMD_OK_GETID 0x02e8
143 #define ATKBD_RET_ACK 0xfa
144 #define ATKBD_RET_NAK 0xfe
145 #define ATKBD_RET_BAT 0xaa
146 #define ATKBD_RET_EMUL0 0xe0
147 #define ATKBD_RET_EMUL1 0xe1
148 #define ATKBD_RET_RELEASE 0xf0
149 #define ATKBD_RET_HANJA 0xf1
150 #define ATKBD_RET_HANGEUL 0xf2
151 #define ATKBD_RET_ERR 0xff
153 #define ATKBD_KEY_UNKNOWN 0
154 #define ATKBD_KEY_NULL 255
156 #define ATKBD_SCR_1 254
157 #define ATKBD_SCR_2 253
158 #define ATKBD_SCR_4 252
159 #define ATKBD_SCR_8 251
160 #define ATKBD_SCR_CLICK 250
161 #define ATKBD_SCR_LEFT 249
162 #define ATKBD_SCR_RIGHT 248
164 #define ATKBD_SPECIAL ATKBD_SCR_RIGHT
166 #define ATKBD_LED_EVENT_BIT 0
167 #define ATKBD_REP_EVENT_BIT 1
169 #define ATKBD_XL_ERR 0x01
170 #define ATKBD_XL_BAT 0x02
171 #define ATKBD_XL_ACK 0x04
172 #define ATKBD_XL_NAK 0x08
173 #define ATKBD_XL_HANGEUL 0x10
174 #define ATKBD_XL_HANJA 0x20
176 static const struct {
177 unsigned char keycode;
179 } atkbd_scroll_keys[] = {
180 { ATKBD_SCR_1, 0xc5 },
181 { ATKBD_SCR_2, 0x9d },
182 { ATKBD_SCR_4, 0xa4 },
183 { ATKBD_SCR_8, 0x9b },
184 { ATKBD_SCR_CLICK, 0xe0 },
185 { ATKBD_SCR_LEFT, 0xcb },
186 { ATKBD_SCR_RIGHT, 0xd2 },
190 * The atkbd control structure
195 struct ps2dev ps2dev;
196 struct input_dev *dev;
198 /* Written only during init */
203 unsigned short keycode[512];
204 DECLARE_BITMAP(force_release_mask, 512);
206 unsigned char translated;
209 unsigned char softrepeat;
210 unsigned char softraw;
211 unsigned char scroll;
212 unsigned char enabled;
214 /* Accessed only from interrupt */
216 unsigned char resend;
217 unsigned char release;
218 unsigned long xl_bit;
221 unsigned long err_count;
223 struct delayed_work event_work;
224 unsigned long event_jiffies;
225 struct mutex event_mutex;
226 unsigned long event_mask;
230 * System-specific ketymap fixup routine
232 static void (*atkbd_platform_fixup)(struct atkbd *);
234 static ssize_t atkbd_attr_show_helper(struct device *dev, char *buf,
235 ssize_t (*handler)(struct atkbd *, char *));
236 static ssize_t atkbd_attr_set_helper(struct device *dev, const char *buf, size_t count,
237 ssize_t (*handler)(struct atkbd *, const char *, size_t));
238 #define ATKBD_DEFINE_ATTR(_name) \
239 static ssize_t atkbd_show_##_name(struct atkbd *, char *); \
240 static ssize_t atkbd_set_##_name(struct atkbd *, const char *, size_t); \
241 static ssize_t atkbd_do_show_##_name(struct device *d, \
242 struct device_attribute *attr, char *b) \
244 return atkbd_attr_show_helper(d, b, atkbd_show_##_name); \
246 static ssize_t atkbd_do_set_##_name(struct device *d, \
247 struct device_attribute *attr, const char *b, size_t s) \
249 return atkbd_attr_set_helper(d, b, s, atkbd_set_##_name); \
251 static struct device_attribute atkbd_attr_##_name = \
252 __ATTR(_name, S_IWUSR | S_IRUGO, atkbd_do_show_##_name, atkbd_do_set_##_name);
254 ATKBD_DEFINE_ATTR(extra);
255 ATKBD_DEFINE_ATTR(scroll);
256 ATKBD_DEFINE_ATTR(set);
257 ATKBD_DEFINE_ATTR(softrepeat);
258 ATKBD_DEFINE_ATTR(softraw);
260 #define ATKBD_DEFINE_RO_ATTR(_name) \
261 static ssize_t atkbd_show_##_name(struct atkbd *, char *); \
262 static ssize_t atkbd_do_show_##_name(struct device *d, \
263 struct device_attribute *attr, char *b) \
265 return atkbd_attr_show_helper(d, b, atkbd_show_##_name); \
267 static struct device_attribute atkbd_attr_##_name = \
268 __ATTR(_name, S_IRUGO, atkbd_do_show_##_name, NULL);
270 ATKBD_DEFINE_RO_ATTR(err_count);
272 static struct attribute *atkbd_attributes[] = {
273 &atkbd_attr_extra.attr,
274 &atkbd_attr_scroll.attr,
275 &atkbd_attr_set.attr,
276 &atkbd_attr_softrepeat.attr,
277 &atkbd_attr_softraw.attr,
278 &atkbd_attr_err_count.attr,
282 static struct attribute_group atkbd_attribute_group = {
283 .attrs = atkbd_attributes,
286 static const unsigned int xl_table[] = {
287 ATKBD_RET_BAT, ATKBD_RET_ERR, ATKBD_RET_ACK,
288 ATKBD_RET_NAK, ATKBD_RET_HANJA, ATKBD_RET_HANGEUL,
292 * Checks if we should mangle the scancode to extract 'release' bit
293 * in translated mode.
295 static int atkbd_need_xlate(unsigned long xl_bit, unsigned char code)
299 if (code == ATKBD_RET_EMUL0 || code == ATKBD_RET_EMUL1)
302 for (i = 0; i < ARRAY_SIZE(xl_table); i++)
303 if (code == xl_table[i])
304 return test_bit(i, &xl_bit);
310 * Calculates new value of xl_bit so the driver can distinguish
311 * between make/break pair of scancodes for select keys and PS/2
312 * protocol responses.
314 static void atkbd_calculate_xl_bit(struct atkbd *atkbd, unsigned char code)
318 for (i = 0; i < ARRAY_SIZE(xl_table); i++) {
319 if (!((code ^ xl_table[i]) & 0x7f)) {
321 __clear_bit(i, &atkbd->xl_bit);
323 __set_bit(i, &atkbd->xl_bit);
330 * Encode the scancode, 0xe0 prefix, and high bit into a single integer,
331 * keeping kernel 2.4 compatibility for set 2
333 static unsigned int atkbd_compat_scancode(struct atkbd *atkbd, unsigned int code)
335 if (atkbd->set == 3) {
336 if (atkbd->emul == 1)
339 code = (code & 0x7f) | ((code & 0x80) << 1);
340 if (atkbd->emul == 1)
348 * atkbd_interrupt(). Here takes place processing of data received from
349 * the keyboard into events.
352 static irqreturn_t atkbd_interrupt(struct serio *serio, unsigned char data,
355 struct atkbd *atkbd = serio_get_drvdata(serio);
356 struct input_dev *dev = atkbd->dev;
357 unsigned int code = data;
358 int scroll = 0, hscroll = 0, click = -1;
360 unsigned short keycode;
363 printk(KERN_DEBUG "atkbd.c: Received %02x flags %02x\n", data, flags);
366 #if !defined(__i386__) && !defined (__x86_64__)
367 if ((flags & (SERIO_FRAME | SERIO_PARITY)) && (~flags & SERIO_TIMEOUT) && !atkbd->resend && atkbd->write) {
368 printk(KERN_WARNING "atkbd.c: frame/parity error: %02x\n", flags);
369 serio_write(serio, ATKBD_CMD_RESEND);
374 if (!flags && data == ATKBD_RET_ACK)
378 if (unlikely(atkbd->ps2dev.flags & PS2_FLAG_ACK))
379 if (ps2_handle_ack(&atkbd->ps2dev, data))
382 if (unlikely(atkbd->ps2dev.flags & PS2_FLAG_CMD))
383 if (ps2_handle_response(&atkbd->ps2dev, data))
389 input_event(dev, EV_MSC, MSC_RAW, code);
391 if (atkbd->translated) {
393 if (atkbd->emul || atkbd_need_xlate(atkbd->xl_bit, code)) {
394 atkbd->release = code >> 7;
399 atkbd_calculate_xl_bit(atkbd, data);
405 serio_reconnect(atkbd->ps2dev.serio);
407 case ATKBD_RET_EMUL0:
410 case ATKBD_RET_EMUL1:
413 case ATKBD_RET_RELEASE:
418 if (printk_ratelimit())
419 printk(KERN_WARNING "atkbd.c: Spurious %s on %s. "
420 "Some program might be trying access hardware directly.\n",
421 data == ATKBD_RET_ACK ? "ACK" : "NAK", serio->phys);
426 printk(KERN_DEBUG "atkbd.c: Keyboard on %s reports too many keys pressed.\n", serio->phys);
431 code = atkbd_compat_scancode(atkbd, code);
433 if (atkbd->emul && --atkbd->emul)
436 keycode = atkbd->keycode[code];
438 if (keycode != ATKBD_KEY_NULL)
439 input_event(dev, EV_MSC, MSC_SCAN, code);
444 case ATKBD_KEY_UNKNOWN:
446 "atkbd.c: Unknown key %s (%s set %d, code %#x on %s).\n",
447 atkbd->release ? "released" : "pressed",
448 atkbd->translated ? "translated" : "raw",
449 atkbd->set, code, serio->phys);
451 "atkbd.c: Use 'setkeycodes %s%02x <keycode>' to make it known.\n",
452 code & 0x80 ? "e0" : "", code & 0x7f);
456 scroll = 1 - atkbd->release * 2;
459 scroll = 2 - atkbd->release * 4;
462 scroll = 4 - atkbd->release * 8;
465 scroll = 8 - atkbd->release * 16;
467 case ATKBD_SCR_CLICK:
468 click = !atkbd->release;
473 case ATKBD_SCR_RIGHT:
477 if (atkbd->release) {
480 } else if (!atkbd->softrepeat && test_bit(keycode, dev->key)) {
481 /* Workaround Toshiba laptop multiple keypress */
482 value = time_before(jiffies, atkbd->time) && atkbd->last == code ? 1 : 2;
486 atkbd->time = jiffies + msecs_to_jiffies(dev->rep[REP_DELAY]) / 2;
489 input_event(dev, EV_KEY, keycode, value);
492 if (value && test_bit(code, atkbd->force_release_mask)) {
493 input_report_key(dev, keycode, 0);
500 input_report_key(dev, BTN_MIDDLE, click);
501 input_report_rel(dev, REL_WHEEL, scroll);
502 input_report_rel(dev, REL_HWHEEL, hscroll);
511 static int atkbd_set_repeat_rate(struct atkbd *atkbd)
513 const short period[32] =
514 { 33, 37, 42, 46, 50, 54, 58, 63, 67, 75, 83, 92, 100, 109, 116, 125,
515 133, 149, 167, 182, 200, 217, 232, 250, 270, 303, 333, 370, 400, 435, 470, 500 };
516 const short delay[4] =
517 { 250, 500, 750, 1000 };
519 struct input_dev *dev = atkbd->dev;
523 while (i < ARRAY_SIZE(period) - 1 && period[i] < dev->rep[REP_PERIOD])
525 dev->rep[REP_PERIOD] = period[i];
527 while (j < ARRAY_SIZE(delay) - 1 && delay[j] < dev->rep[REP_DELAY])
529 dev->rep[REP_DELAY] = delay[j];
531 param = i | (j << 5);
532 return ps2_command(&atkbd->ps2dev, ¶m, ATKBD_CMD_SETREP);
535 static int atkbd_set_leds(struct atkbd *atkbd)
537 struct input_dev *dev = atkbd->dev;
538 unsigned char param[2];
540 param[0] = (test_bit(LED_SCROLLL, dev->led) ? 1 : 0)
541 | (test_bit(LED_NUML, dev->led) ? 2 : 0)
542 | (test_bit(LED_CAPSL, dev->led) ? 4 : 0);
543 if (ps2_command(&atkbd->ps2dev, param, ATKBD_CMD_SETLEDS))
548 param[1] = (test_bit(LED_COMPOSE, dev->led) ? 0x01 : 0)
549 | (test_bit(LED_SLEEP, dev->led) ? 0x02 : 0)
550 | (test_bit(LED_SUSPEND, dev->led) ? 0x04 : 0)
551 | (test_bit(LED_MISC, dev->led) ? 0x10 : 0)
552 | (test_bit(LED_MUTE, dev->led) ? 0x20 : 0);
553 if (ps2_command(&atkbd->ps2dev, param, ATKBD_CMD_EX_SETLEDS))
561 * atkbd_event_work() is used to complete processing of events that
562 * can not be processed by input_event() which is often called from
566 static void atkbd_event_work(struct work_struct *work)
568 struct atkbd *atkbd = container_of(work, struct atkbd, event_work.work);
570 mutex_lock(&atkbd->event_mutex);
572 if (test_and_clear_bit(ATKBD_LED_EVENT_BIT, &atkbd->event_mask))
573 atkbd_set_leds(atkbd);
575 if (test_and_clear_bit(ATKBD_REP_EVENT_BIT, &atkbd->event_mask))
576 atkbd_set_repeat_rate(atkbd);
578 mutex_unlock(&atkbd->event_mutex);
582 * Schedule switch for execution. We need to throttle requests,
583 * otherwise keyboard may become unresponsive.
585 static void atkbd_schedule_event_work(struct atkbd *atkbd, int event_bit)
587 unsigned long delay = msecs_to_jiffies(50);
589 if (time_after(jiffies, atkbd->event_jiffies + delay))
592 atkbd->event_jiffies = jiffies;
593 set_bit(event_bit, &atkbd->event_mask);
595 schedule_delayed_work(&atkbd->event_work, delay);
599 * Event callback from the input module. Events that change the state of
600 * the hardware are processed here. If action can not be performed in
601 * interrupt context it is offloaded to atkbd_event_work.
604 static int atkbd_event(struct input_dev *dev,
605 unsigned int type, unsigned int code, int value)
607 struct atkbd *atkbd = input_get_drvdata(dev);
615 atkbd_schedule_event_work(atkbd, ATKBD_LED_EVENT_BIT);
619 if (!atkbd->softrepeat)
620 atkbd_schedule_event_work(atkbd, ATKBD_REP_EVENT_BIT);
628 * atkbd_enable() signals that interrupt handler is allowed to
629 * generate input events.
632 static inline void atkbd_enable(struct atkbd *atkbd)
634 serio_pause_rx(atkbd->ps2dev.serio);
636 serio_continue_rx(atkbd->ps2dev.serio);
640 * atkbd_disable() tells input handler that all incoming data except
641 * for ACKs and command response should be dropped.
644 static inline void atkbd_disable(struct atkbd *atkbd)
646 serio_pause_rx(atkbd->ps2dev.serio);
648 serio_continue_rx(atkbd->ps2dev.serio);
652 * atkbd_probe() probes for an AT keyboard on a serio port.
655 static int atkbd_probe(struct atkbd *atkbd)
657 struct ps2dev *ps2dev = &atkbd->ps2dev;
658 unsigned char param[2];
661 * Some systems, where the bit-twiddling when testing the io-lines of the
662 * controller may confuse the keyboard need a full reset of the keyboard. On
663 * these systems the BIOS also usually doesn't do it for us.
667 if (ps2_command(ps2dev, NULL, ATKBD_CMD_RESET_BAT))
668 printk(KERN_WARNING "atkbd.c: keyboard reset failed on %s\n", ps2dev->serio->phys);
671 * Then we check the keyboard ID. We should get 0xab83 under normal conditions.
672 * Some keyboards report different values, but the first byte is always 0xab or
673 * 0xac. Some old AT keyboards don't report anything. If a mouse is connected, this
674 * should make sure we don't try to set the LEDs on it.
677 param[0] = param[1] = 0xa5; /* initialize with invalid values */
678 if (ps2_command(ps2dev, param, ATKBD_CMD_GETID)) {
681 * If the get ID command failed, we check if we can at least set the LEDs on
682 * the keyboard. This should work on every keyboard out there. It also turns
683 * the LEDs off, which we want anyway.
686 if (ps2_command(ps2dev, param, ATKBD_CMD_SETLEDS))
692 if (!ps2_is_keyboard_id(param[0]))
695 atkbd->id = (param[0] << 8) | param[1];
697 if (atkbd->id == 0xaca1 && atkbd->translated) {
698 printk(KERN_ERR "atkbd.c: NCD terminal keyboards are only supported on non-translating\n");
699 printk(KERN_ERR "atkbd.c: controllers. Use i8042.direct=1 to disable translation.\n");
707 * atkbd_select_set checks if a keyboard has a working Set 3 support, and
708 * sets it into that. Unfortunately there are keyboards that can be switched
709 * to Set 3, but don't work well in that (BTC Multimedia ...)
712 static int atkbd_select_set(struct atkbd *atkbd, int target_set, int allow_extra)
714 struct ps2dev *ps2dev = &atkbd->ps2dev;
715 unsigned char param[2];
719 * For known special keyboards we can go ahead and set the correct set.
720 * We check for NCD PS/2 Sun, NorthGate OmniKey 101 and
721 * IBM RapidAccess / IBM EzButton / Chicony KBP-8993 keyboards.
724 if (atkbd->translated)
727 if (atkbd->id == 0xaca1) {
729 ps2_command(ps2dev, param, ATKBD_CMD_SSCANSET);
735 if (!ps2_command(ps2dev, param, ATKBD_CMD_EX_ENABLE)) {
744 if (!ps2_command(ps2dev, param, ATKBD_CMD_OK_GETID)) {
745 atkbd->id = param[0] << 8 | param[1];
750 if (ps2_command(ps2dev, param, ATKBD_CMD_SSCANSET))
754 if (ps2_command(ps2dev, param, ATKBD_CMD_GSCANSET))
759 if (ps2_command(ps2dev, param, ATKBD_CMD_SSCANSET))
763 ps2_command(ps2dev, param, ATKBD_CMD_SETALL_MBR);
768 static int atkbd_activate(struct atkbd *atkbd)
770 struct ps2dev *ps2dev = &atkbd->ps2dev;
771 unsigned char param[1];
774 * Set the LEDs to a defined state.
778 if (ps2_command(ps2dev, param, ATKBD_CMD_SETLEDS))
782 * Set autorepeat to fastest possible.
786 if (ps2_command(ps2dev, param, ATKBD_CMD_SETREP))
790 * Enable the keyboard to receive keystrokes.
793 if (ps2_command(ps2dev, NULL, ATKBD_CMD_ENABLE)) {
794 printk(KERN_ERR "atkbd.c: Failed to enable keyboard on %s\n",
795 ps2dev->serio->phys);
803 * atkbd_cleanup() restores the keyboard state so that BIOS is happy after a
807 static void atkbd_cleanup(struct serio *serio)
809 struct atkbd *atkbd = serio_get_drvdata(serio);
811 atkbd_disable(atkbd);
812 ps2_command(&atkbd->ps2dev, NULL, ATKBD_CMD_RESET_BAT);
817 * atkbd_disconnect() closes and frees.
820 static void atkbd_disconnect(struct serio *serio)
822 struct atkbd *atkbd = serio_get_drvdata(serio);
824 atkbd_disable(atkbd);
826 /* make sure we don't have a command in flight */
827 cancel_delayed_work_sync(&atkbd->event_work);
829 sysfs_remove_group(&serio->dev.kobj, &atkbd_attribute_group);
830 input_unregister_device(atkbd->dev);
832 serio_set_drvdata(serio, NULL);
837 * Most special keys (Fn+F?) on Dell laptops do not generate release
838 * events so we have to do it ourselves.
840 static void atkbd_dell_laptop_keymap_fixup(struct atkbd *atkbd)
842 const unsigned int forced_release_keys[] = {
843 0x85, 0x86, 0x87, 0x88, 0x89, 0x8a, 0x8b, 0x8f, 0x93,
848 for (i = 0; i < ARRAY_SIZE(forced_release_keys); i++)
849 __set_bit(forced_release_keys[i],
850 atkbd->force_release_mask);
854 * Perform fixup for HP system that doesn't generate release
855 * for its video switch
857 static void atkbd_hp_keymap_fixup(struct atkbd *atkbd)
859 const unsigned int forced_release_keys[] = {
865 for (i = 0; i < ARRAY_SIZE(forced_release_keys); i++)
866 __set_bit(forced_release_keys[i],
867 atkbd->force_release_mask);
871 * Inventec system with broken key release on volume keys
873 static void atkbd_inventec_keymap_fixup(struct atkbd *atkbd)
875 const unsigned int forced_release_keys[] = {
881 for (i = 0; i < ARRAY_SIZE(forced_release_keys); i++)
882 __set_bit(forced_release_keys[i],
883 atkbd->force_release_mask);
887 * atkbd_set_keycode_table() initializes keyboard's keycode table
888 * according to the selected scancode set
891 static void atkbd_set_keycode_table(struct atkbd *atkbd)
893 unsigned int scancode;
896 memset(atkbd->keycode, 0, sizeof(atkbd->keycode));
897 bitmap_zero(atkbd->force_release_mask, 512);
899 if (atkbd->translated) {
900 for (i = 0; i < 128; i++) {
901 scancode = atkbd_unxlate_table[i];
902 atkbd->keycode[i] = atkbd_set2_keycode[scancode];
903 atkbd->keycode[i | 0x80] = atkbd_set2_keycode[scancode | 0x80];
905 for (j = 0; j < ARRAY_SIZE(atkbd_scroll_keys); j++)
906 if ((scancode | 0x80) == atkbd_scroll_keys[j].set2)
907 atkbd->keycode[i | 0x80] = atkbd_scroll_keys[j].keycode;
909 } else if (atkbd->set == 3) {
910 memcpy(atkbd->keycode, atkbd_set3_keycode, sizeof(atkbd->keycode));
912 memcpy(atkbd->keycode, atkbd_set2_keycode, sizeof(atkbd->keycode));
915 for (i = 0; i < ARRAY_SIZE(atkbd_scroll_keys); i++) {
916 scancode = atkbd_scroll_keys[i].set2;
917 atkbd->keycode[scancode] = atkbd_scroll_keys[i].keycode;
922 * HANGEUL and HANJA keys do not send release events so we need to
923 * generate such events ourselves
925 scancode = atkbd_compat_scancode(atkbd, ATKBD_RET_HANGEUL);
926 atkbd->keycode[scancode] = KEY_HANGEUL;
927 __set_bit(scancode, atkbd->force_release_mask);
929 scancode = atkbd_compat_scancode(atkbd, ATKBD_RET_HANJA);
930 atkbd->keycode[scancode] = KEY_HANJA;
931 __set_bit(scancode, atkbd->force_release_mask);
934 * Perform additional fixups
936 if (atkbd_platform_fixup)
937 atkbd_platform_fixup(atkbd);
941 * atkbd_set_device_attrs() sets up keyboard's input device structure
944 static void atkbd_set_device_attrs(struct atkbd *atkbd)
946 struct input_dev *input_dev = atkbd->dev;
950 snprintf(atkbd->name, sizeof(atkbd->name),
951 "AT Set 2 Extra keyboard");
953 snprintf(atkbd->name, sizeof(atkbd->name),
954 "AT %s Set %d keyboard",
955 atkbd->translated ? "Translated" : "Raw", atkbd->set);
957 snprintf(atkbd->phys, sizeof(atkbd->phys),
958 "%s/input0", atkbd->ps2dev.serio->phys);
960 input_dev->name = atkbd->name;
961 input_dev->phys = atkbd->phys;
962 input_dev->id.bustype = BUS_I8042;
963 input_dev->id.vendor = 0x0001;
964 input_dev->id.product = atkbd->translated ? 1 : atkbd->set;
965 input_dev->id.version = atkbd->id;
966 input_dev->event = atkbd_event;
967 input_dev->dev.parent = &atkbd->ps2dev.serio->dev;
969 input_set_drvdata(input_dev, atkbd);
971 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP) |
975 input_dev->evbit[0] |= BIT_MASK(EV_LED);
976 input_dev->ledbit[0] = BIT_MASK(LED_NUML) |
977 BIT_MASK(LED_CAPSL) | BIT_MASK(LED_SCROLLL);
981 input_dev->ledbit[0] |= BIT_MASK(LED_COMPOSE) |
982 BIT_MASK(LED_SUSPEND) | BIT_MASK(LED_SLEEP) |
983 BIT_MASK(LED_MUTE) | BIT_MASK(LED_MISC);
985 if (!atkbd->softrepeat) {
986 input_dev->rep[REP_DELAY] = 250;
987 input_dev->rep[REP_PERIOD] = 33;
990 input_dev->mscbit[0] = atkbd->softraw ? BIT_MASK(MSC_SCAN) :
991 BIT_MASK(MSC_RAW) | BIT_MASK(MSC_SCAN);
994 input_dev->evbit[0] |= BIT_MASK(EV_REL);
995 input_dev->relbit[0] = BIT_MASK(REL_WHEEL) |
996 BIT_MASK(REL_HWHEEL);
997 __set_bit(BTN_MIDDLE, input_dev->keybit);
1000 input_dev->keycode = atkbd->keycode;
1001 input_dev->keycodesize = sizeof(unsigned short);
1002 input_dev->keycodemax = ARRAY_SIZE(atkbd_set2_keycode);
1004 for (i = 0; i < 512; i++)
1005 if (atkbd->keycode[i] && atkbd->keycode[i] < ATKBD_SPECIAL)
1006 __set_bit(atkbd->keycode[i], input_dev->keybit);
1010 * atkbd_connect() is called when the serio module finds an interface
1011 * that isn't handled yet by an appropriate device driver. We check if
1012 * there is an AT keyboard out there and if yes, we register ourselves
1013 * to the input module.
1016 static int atkbd_connect(struct serio *serio, struct serio_driver *drv)
1018 struct atkbd *atkbd;
1019 struct input_dev *dev;
1022 atkbd = kzalloc(sizeof(struct atkbd), GFP_KERNEL);
1023 dev = input_allocate_device();
1028 ps2_init(&atkbd->ps2dev, serio);
1029 INIT_DELAYED_WORK(&atkbd->event_work, atkbd_event_work);
1030 mutex_init(&atkbd->event_mutex);
1032 switch (serio->id.type) {
1035 atkbd->translated = 1;
1042 atkbd->softraw = atkbd_softraw;
1043 atkbd->softrepeat = atkbd_softrepeat;
1044 atkbd->scroll = atkbd_scroll;
1046 if (atkbd->softrepeat)
1049 serio_set_drvdata(serio, atkbd);
1051 err = serio_open(serio, drv);
1057 if (atkbd_probe(atkbd)) {
1062 atkbd->set = atkbd_select_set(atkbd, atkbd_set, atkbd_extra);
1063 atkbd_activate(atkbd);
1070 atkbd_set_keycode_table(atkbd);
1071 atkbd_set_device_attrs(atkbd);
1073 err = sysfs_create_group(&serio->dev.kobj, &atkbd_attribute_group);
1077 atkbd_enable(atkbd);
1079 err = input_register_device(atkbd->dev);
1085 fail4: sysfs_remove_group(&serio->dev.kobj, &atkbd_attribute_group);
1086 fail3: serio_close(serio);
1087 fail2: serio_set_drvdata(serio, NULL);
1088 fail1: input_free_device(dev);
1094 * atkbd_reconnect() tries to restore keyboard into a sane state and is
1095 * most likely called on resume.
1098 static int atkbd_reconnect(struct serio *serio)
1100 struct atkbd *atkbd = serio_get_drvdata(serio);
1101 struct serio_driver *drv = serio->drv;
1103 if (!atkbd || !drv) {
1104 printk(KERN_DEBUG "atkbd: reconnect request, but serio is disconnected, ignoring...\n");
1108 atkbd_disable(atkbd);
1111 if (atkbd_probe(atkbd))
1113 if (atkbd->set != atkbd_select_set(atkbd, atkbd->set, atkbd->extra))
1116 atkbd_activate(atkbd);
1119 * Restore repeat rate and LEDs (that were reset by atkbd_activate)
1120 * to pre-resume state
1122 if (!atkbd->softrepeat)
1123 atkbd_set_repeat_rate(atkbd);
1124 atkbd_set_leds(atkbd);
1127 atkbd_enable(atkbd);
1132 static struct serio_device_id atkbd_serio_ids[] = {
1140 .type = SERIO_8042_XL,
1146 .type = SERIO_RS232,
1147 .proto = SERIO_PS2SER,
1154 MODULE_DEVICE_TABLE(serio, atkbd_serio_ids);
1156 static struct serio_driver atkbd_drv = {
1160 .description = DRIVER_DESC,
1161 .id_table = atkbd_serio_ids,
1162 .interrupt = atkbd_interrupt,
1163 .connect = atkbd_connect,
1164 .reconnect = atkbd_reconnect,
1165 .disconnect = atkbd_disconnect,
1166 .cleanup = atkbd_cleanup,
1169 static ssize_t atkbd_attr_show_helper(struct device *dev, char *buf,
1170 ssize_t (*handler)(struct atkbd *, char *))
1172 struct serio *serio = to_serio_port(dev);
1175 retval = serio_pin_driver(serio);
1179 if (serio->drv != &atkbd_drv) {
1184 retval = handler((struct atkbd *)serio_get_drvdata(serio), buf);
1187 serio_unpin_driver(serio);
1191 static ssize_t atkbd_attr_set_helper(struct device *dev, const char *buf, size_t count,
1192 ssize_t (*handler)(struct atkbd *, const char *, size_t))
1194 struct serio *serio = to_serio_port(dev);
1195 struct atkbd *atkbd;
1198 retval = serio_pin_driver(serio);
1202 if (serio->drv != &atkbd_drv) {
1207 atkbd = serio_get_drvdata(serio);
1208 atkbd_disable(atkbd);
1209 retval = handler(atkbd, buf, count);
1210 atkbd_enable(atkbd);
1213 serio_unpin_driver(serio);
1217 static ssize_t atkbd_show_extra(struct atkbd *atkbd, char *buf)
1219 return sprintf(buf, "%d\n", atkbd->extra ? 1 : 0);
1222 static ssize_t atkbd_set_extra(struct atkbd *atkbd, const char *buf, size_t count)
1224 struct input_dev *old_dev, *new_dev;
1225 unsigned long value;
1227 unsigned char old_extra, old_set;
1232 if (strict_strtoul(buf, 10, &value) || value > 1)
1235 if (atkbd->extra != value) {
1237 * Since device's properties will change we need to
1238 * unregister old device. But allocate and register
1239 * new one first to make sure we have it.
1241 old_dev = atkbd->dev;
1242 old_extra = atkbd->extra;
1243 old_set = atkbd->set;
1245 new_dev = input_allocate_device();
1249 atkbd->dev = new_dev;
1250 atkbd->set = atkbd_select_set(atkbd, atkbd->set, value);
1251 atkbd_activate(atkbd);
1252 atkbd_set_keycode_table(atkbd);
1253 atkbd_set_device_attrs(atkbd);
1255 err = input_register_device(atkbd->dev);
1257 input_free_device(new_dev);
1259 atkbd->dev = old_dev;
1260 atkbd->set = atkbd_select_set(atkbd, old_set, old_extra);
1261 atkbd_set_keycode_table(atkbd);
1262 atkbd_set_device_attrs(atkbd);
1266 input_unregister_device(old_dev);
1272 static ssize_t atkbd_show_scroll(struct atkbd *atkbd, char *buf)
1274 return sprintf(buf, "%d\n", atkbd->scroll ? 1 : 0);
1277 static ssize_t atkbd_set_scroll(struct atkbd *atkbd, const char *buf, size_t count)
1279 struct input_dev *old_dev, *new_dev;
1280 unsigned long value;
1282 unsigned char old_scroll;
1284 if (strict_strtoul(buf, 10, &value) || value > 1)
1287 if (atkbd->scroll != value) {
1288 old_dev = atkbd->dev;
1289 old_scroll = atkbd->scroll;
1291 new_dev = input_allocate_device();
1295 atkbd->dev = new_dev;
1296 atkbd->scroll = value;
1297 atkbd_set_keycode_table(atkbd);
1298 atkbd_set_device_attrs(atkbd);
1300 err = input_register_device(atkbd->dev);
1302 input_free_device(new_dev);
1304 atkbd->scroll = old_scroll;
1305 atkbd->dev = old_dev;
1306 atkbd_set_keycode_table(atkbd);
1307 atkbd_set_device_attrs(atkbd);
1311 input_unregister_device(old_dev);
1316 static ssize_t atkbd_show_set(struct atkbd *atkbd, char *buf)
1318 return sprintf(buf, "%d\n", atkbd->set);
1321 static ssize_t atkbd_set_set(struct atkbd *atkbd, const char *buf, size_t count)
1323 struct input_dev *old_dev, *new_dev;
1324 unsigned long value;
1326 unsigned char old_set, old_extra;
1331 if (strict_strtoul(buf, 10, &value) || (value != 2 && value != 3))
1334 if (atkbd->set != value) {
1335 old_dev = atkbd->dev;
1336 old_extra = atkbd->extra;
1337 old_set = atkbd->set;
1339 new_dev = input_allocate_device();
1343 atkbd->dev = new_dev;
1344 atkbd->set = atkbd_select_set(atkbd, value, atkbd->extra);
1345 atkbd_activate(atkbd);
1346 atkbd_set_keycode_table(atkbd);
1347 atkbd_set_device_attrs(atkbd);
1349 err = input_register_device(atkbd->dev);
1351 input_free_device(new_dev);
1353 atkbd->dev = old_dev;
1354 atkbd->set = atkbd_select_set(atkbd, old_set, old_extra);
1355 atkbd_set_keycode_table(atkbd);
1356 atkbd_set_device_attrs(atkbd);
1360 input_unregister_device(old_dev);
1365 static ssize_t atkbd_show_softrepeat(struct atkbd *atkbd, char *buf)
1367 return sprintf(buf, "%d\n", atkbd->softrepeat ? 1 : 0);
1370 static ssize_t atkbd_set_softrepeat(struct atkbd *atkbd, const char *buf, size_t count)
1372 struct input_dev *old_dev, *new_dev;
1373 unsigned long value;
1375 unsigned char old_softrepeat, old_softraw;
1380 if (strict_strtoul(buf, 10, &value) || value > 1)
1383 if (atkbd->softrepeat != value) {
1384 old_dev = atkbd->dev;
1385 old_softrepeat = atkbd->softrepeat;
1386 old_softraw = atkbd->softraw;
1388 new_dev = input_allocate_device();
1392 atkbd->dev = new_dev;
1393 atkbd->softrepeat = value;
1394 if (atkbd->softrepeat)
1396 atkbd_set_device_attrs(atkbd);
1398 err = input_register_device(atkbd->dev);
1400 input_free_device(new_dev);
1402 atkbd->dev = old_dev;
1403 atkbd->softrepeat = old_softrepeat;
1404 atkbd->softraw = old_softraw;
1405 atkbd_set_device_attrs(atkbd);
1409 input_unregister_device(old_dev);
1415 static ssize_t atkbd_show_softraw(struct atkbd *atkbd, char *buf)
1417 return sprintf(buf, "%d\n", atkbd->softraw ? 1 : 0);
1420 static ssize_t atkbd_set_softraw(struct atkbd *atkbd, const char *buf, size_t count)
1422 struct input_dev *old_dev, *new_dev;
1423 unsigned long value;
1425 unsigned char old_softraw;
1427 if (strict_strtoul(buf, 10, &value) || value > 1)
1430 if (atkbd->softraw != value) {
1431 old_dev = atkbd->dev;
1432 old_softraw = atkbd->softraw;
1434 new_dev = input_allocate_device();
1438 atkbd->dev = new_dev;
1439 atkbd->softraw = value;
1440 atkbd_set_device_attrs(atkbd);
1442 err = input_register_device(atkbd->dev);
1444 input_free_device(new_dev);
1446 atkbd->dev = old_dev;
1447 atkbd->softraw = old_softraw;
1448 atkbd_set_device_attrs(atkbd);
1452 input_unregister_device(old_dev);
1457 static ssize_t atkbd_show_err_count(struct atkbd *atkbd, char *buf)
1459 return sprintf(buf, "%lu\n", atkbd->err_count);
1462 static int __init atkbd_setup_fixup(const struct dmi_system_id *id)
1464 atkbd_platform_fixup = id->driver_data;
1468 static struct dmi_system_id atkbd_dmi_quirk_table[] __initdata = {
1470 .ident = "Dell Laptop",
1472 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
1473 DMI_MATCH(DMI_CHASSIS_TYPE, "8"), /* Portable */
1475 .callback = atkbd_setup_fixup,
1476 .driver_data = atkbd_dell_laptop_keymap_fixup,
1481 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
1482 DMI_MATCH(DMI_PRODUCT_NAME, "HP 2133"),
1484 .callback = atkbd_setup_fixup,
1485 .driver_data = atkbd_hp_keymap_fixup,
1488 .ident = "Inventec Symphony",
1490 DMI_MATCH(DMI_SYS_VENDOR, "INVENTEC"),
1491 DMI_MATCH(DMI_PRODUCT_NAME, "SYMPHONY 6.0/7.0"),
1493 .callback = atkbd_setup_fixup,
1494 .driver_data = atkbd_inventec_keymap_fixup,
1499 static int __init atkbd_init(void)
1501 dmi_check_system(atkbd_dmi_quirk_table);
1503 return serio_register_driver(&atkbd_drv);
1506 static void __exit atkbd_exit(void)
1508 serio_unregister_driver(&atkbd_drv);
1511 module_init(atkbd_init);
1512 module_exit(atkbd_exit);