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/moduleparam.h>
23 #include <linux/slab.h>
24 #include <linux/interrupt.h>
25 #include <linux/init.h>
26 #include <linux/input.h>
27 #include <linux/serio.h>
28 #include <linux/workqueue.h>
29 #include <linux/libps2.h>
30 #include <linux/mutex.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 unsigned char 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,150,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 unsigned char 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,150,163,165,115,152,150,166,140,160,154,113,114,167,168,
118 static unsigned char 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 248
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
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 char keycode[512];
205 unsigned char translated;
208 unsigned char softrepeat;
209 unsigned char softraw;
210 unsigned char scroll;
211 unsigned char enabled;
213 /* Accessed only from interrupt */
215 unsigned char resend;
216 unsigned char release;
217 unsigned long xl_bit;
220 unsigned long err_count;
222 struct delayed_work event_work;
223 unsigned long event_jiffies;
224 struct mutex event_mutex;
225 unsigned long event_mask;
228 static ssize_t atkbd_attr_show_helper(struct device *dev, char *buf,
229 ssize_t (*handler)(struct atkbd *, char *));
230 static ssize_t atkbd_attr_set_helper(struct device *dev, const char *buf, size_t count,
231 ssize_t (*handler)(struct atkbd *, const char *, size_t));
232 #define ATKBD_DEFINE_ATTR(_name) \
233 static ssize_t atkbd_show_##_name(struct atkbd *, char *); \
234 static ssize_t atkbd_set_##_name(struct atkbd *, const char *, size_t); \
235 static ssize_t atkbd_do_show_##_name(struct device *d, \
236 struct device_attribute *attr, char *b) \
238 return atkbd_attr_show_helper(d, b, atkbd_show_##_name); \
240 static ssize_t atkbd_do_set_##_name(struct device *d, \
241 struct device_attribute *attr, const char *b, size_t s) \
243 return atkbd_attr_set_helper(d, b, s, atkbd_set_##_name); \
245 static struct device_attribute atkbd_attr_##_name = \
246 __ATTR(_name, S_IWUSR | S_IRUGO, atkbd_do_show_##_name, atkbd_do_set_##_name);
248 ATKBD_DEFINE_ATTR(extra);
249 ATKBD_DEFINE_ATTR(scroll);
250 ATKBD_DEFINE_ATTR(set);
251 ATKBD_DEFINE_ATTR(softrepeat);
252 ATKBD_DEFINE_ATTR(softraw);
254 #define ATKBD_DEFINE_RO_ATTR(_name) \
255 static ssize_t atkbd_show_##_name(struct atkbd *, char *); \
256 static ssize_t atkbd_do_show_##_name(struct device *d, \
257 struct device_attribute *attr, char *b) \
259 return atkbd_attr_show_helper(d, b, atkbd_show_##_name); \
261 static struct device_attribute atkbd_attr_##_name = \
262 __ATTR(_name, S_IRUGO, atkbd_do_show_##_name, NULL);
264 ATKBD_DEFINE_RO_ATTR(err_count);
266 static struct attribute *atkbd_attributes[] = {
267 &atkbd_attr_extra.attr,
268 &atkbd_attr_scroll.attr,
269 &atkbd_attr_set.attr,
270 &atkbd_attr_softrepeat.attr,
271 &atkbd_attr_softraw.attr,
272 &atkbd_attr_err_count.attr,
276 static struct attribute_group atkbd_attribute_group = {
277 .attrs = atkbd_attributes,
280 static const unsigned int xl_table[] = {
281 ATKBD_RET_BAT, ATKBD_RET_ERR, ATKBD_RET_ACK,
282 ATKBD_RET_NAK, ATKBD_RET_HANJA, ATKBD_RET_HANGEUL,
286 * Checks if we should mangle the scancode to extract 'release' bit
287 * in translated mode.
289 static int atkbd_need_xlate(unsigned long xl_bit, unsigned char code)
293 if (code == ATKBD_RET_EMUL0 || code == ATKBD_RET_EMUL1)
296 for (i = 0; i < ARRAY_SIZE(xl_table); i++)
297 if (code == xl_table[i])
298 return test_bit(i, &xl_bit);
304 * Calculates new value of xl_bit so the driver can distinguish
305 * between make/break pair of scancodes for select keys and PS/2
306 * protocol responses.
308 static void atkbd_calculate_xl_bit(struct atkbd *atkbd, unsigned char code)
312 for (i = 0; i < ARRAY_SIZE(xl_table); i++) {
313 if (!((code ^ xl_table[i]) & 0x7f)) {
315 __clear_bit(i, &atkbd->xl_bit);
317 __set_bit(i, &atkbd->xl_bit);
324 * Encode the scancode, 0xe0 prefix, and high bit into a single integer,
325 * keeping kernel 2.4 compatibility for set 2
327 static unsigned int atkbd_compat_scancode(struct atkbd *atkbd, unsigned int code)
329 if (atkbd->set == 3) {
330 if (atkbd->emul == 1)
333 code = (code & 0x7f) | ((code & 0x80) << 1);
334 if (atkbd->emul == 1)
342 * atkbd_interrupt(). Here takes place processing of data received from
343 * the keyboard into events.
346 static irqreturn_t atkbd_interrupt(struct serio *serio, unsigned char data,
349 struct atkbd *atkbd = serio_get_drvdata(serio);
350 struct input_dev *dev = atkbd->dev;
351 unsigned int code = data;
352 int scroll = 0, hscroll = 0, click = -1, add_release_event = 0;
354 unsigned char keycode;
357 printk(KERN_DEBUG "atkbd.c: Received %02x flags %02x\n", data, flags);
360 #if !defined(__i386__) && !defined (__x86_64__)
361 if ((flags & (SERIO_FRAME | SERIO_PARITY)) && (~flags & SERIO_TIMEOUT) && !atkbd->resend && atkbd->write) {
362 printk(KERN_WARNING "atkbd.c: frame/parity error: %02x\n", flags);
363 serio_write(serio, ATKBD_CMD_RESEND);
368 if (!flags && data == ATKBD_RET_ACK)
372 if (unlikely(atkbd->ps2dev.flags & PS2_FLAG_ACK))
373 if (ps2_handle_ack(&atkbd->ps2dev, data))
376 if (unlikely(atkbd->ps2dev.flags & PS2_FLAG_CMD))
377 if (ps2_handle_response(&atkbd->ps2dev, data))
383 input_event(dev, EV_MSC, MSC_RAW, code);
385 if (atkbd->translated) {
387 if (atkbd->emul || atkbd_need_xlate(atkbd->xl_bit, code)) {
388 atkbd->release = code >> 7;
393 atkbd_calculate_xl_bit(atkbd, data);
399 serio_reconnect(atkbd->ps2dev.serio);
401 case ATKBD_RET_EMUL0:
404 case ATKBD_RET_EMUL1:
407 case ATKBD_RET_RELEASE:
412 printk(KERN_WARNING "atkbd.c: Spurious %s on %s. "
413 "Some program might be trying access hardware directly.\n",
414 data == ATKBD_RET_ACK ? "ACK" : "NAK", serio->phys);
416 case ATKBD_RET_HANGEUL:
417 case ATKBD_RET_HANJA:
419 * These keys do not report release and thus need to be
422 add_release_event = 1;
427 printk(KERN_DEBUG "atkbd.c: Keyboard on %s reports too many keys pressed.\n", serio->phys);
432 code = atkbd_compat_scancode(atkbd, code);
434 if (atkbd->emul && --atkbd->emul)
437 keycode = atkbd->keycode[code];
439 if (keycode != ATKBD_KEY_NULL)
440 input_event(dev, EV_MSC, MSC_SCAN, code);
445 case ATKBD_KEY_UNKNOWN:
447 "atkbd.c: Unknown key %s (%s set %d, code %#x on %s).\n",
448 atkbd->release ? "released" : "pressed",
449 atkbd->translated ? "translated" : "raw",
450 atkbd->set, code, serio->phys);
452 "atkbd.c: Use 'setkeycodes %s%02x <keycode>' to make it known.\n",
453 code & 0x80 ? "e0" : "", code & 0x7f);
457 scroll = 1 - atkbd->release * 2;
460 scroll = 2 - atkbd->release * 4;
463 scroll = 4 - atkbd->release * 8;
466 scroll = 8 - atkbd->release * 16;
468 case ATKBD_SCR_CLICK:
469 click = !atkbd->release;
474 case ATKBD_SCR_RIGHT:
478 if (atkbd->release) {
481 } else if (!atkbd->softrepeat && test_bit(keycode, dev->key)) {
482 /* Workaround Toshiba laptop multiple keypress */
483 value = time_before(jiffies, atkbd->time) && atkbd->last == code ? 1 : 2;
487 atkbd->time = jiffies + msecs_to_jiffies(dev->rep[REP_DELAY]) / 2;
490 input_event(dev, EV_KEY, keycode, value);
493 if (value && add_release_event) {
494 input_report_key(dev, keycode, 0);
501 input_report_key(dev, BTN_MIDDLE, click);
502 input_report_rel(dev, REL_WHEEL, scroll);
503 input_report_rel(dev, REL_HWHEEL, hscroll);
512 static int atkbd_set_repeat_rate(struct atkbd *atkbd)
514 const short period[32] =
515 { 33, 37, 42, 46, 50, 54, 58, 63, 67, 75, 83, 92, 100, 109, 116, 125,
516 133, 149, 167, 182, 200, 217, 232, 250, 270, 303, 333, 370, 400, 435, 470, 500 };
517 const short delay[4] =
518 { 250, 500, 750, 1000 };
520 struct input_dev *dev = atkbd->dev;
524 while (i < ARRAY_SIZE(period) - 1 && period[i] < dev->rep[REP_PERIOD])
526 dev->rep[REP_PERIOD] = period[i];
528 while (j < ARRAY_SIZE(delay) - 1 && delay[j] < dev->rep[REP_DELAY])
530 dev->rep[REP_DELAY] = delay[j];
532 param = i | (j << 5);
533 return ps2_command(&atkbd->ps2dev, ¶m, ATKBD_CMD_SETREP);
536 static int atkbd_set_leds(struct atkbd *atkbd)
538 struct input_dev *dev = atkbd->dev;
539 unsigned char param[2];
541 param[0] = (test_bit(LED_SCROLLL, dev->led) ? 1 : 0)
542 | (test_bit(LED_NUML, dev->led) ? 2 : 0)
543 | (test_bit(LED_CAPSL, dev->led) ? 4 : 0);
544 if (ps2_command(&atkbd->ps2dev, param, ATKBD_CMD_SETLEDS))
549 param[1] = (test_bit(LED_COMPOSE, dev->led) ? 0x01 : 0)
550 | (test_bit(LED_SLEEP, dev->led) ? 0x02 : 0)
551 | (test_bit(LED_SUSPEND, dev->led) ? 0x04 : 0)
552 | (test_bit(LED_MISC, dev->led) ? 0x10 : 0)
553 | (test_bit(LED_MUTE, dev->led) ? 0x20 : 0);
554 if (ps2_command(&atkbd->ps2dev, param, ATKBD_CMD_EX_SETLEDS))
562 * atkbd_event_work() is used to complete processing of events that
563 * can not be processed by input_event() which is often called from
567 static void atkbd_event_work(struct work_struct *work)
569 struct atkbd *atkbd = container_of(work, struct atkbd, event_work.work);
571 mutex_lock(&atkbd->event_mutex);
573 if (test_and_clear_bit(ATKBD_LED_EVENT_BIT, &atkbd->event_mask))
574 atkbd_set_leds(atkbd);
576 if (test_and_clear_bit(ATKBD_REP_EVENT_BIT, &atkbd->event_mask))
577 atkbd_set_repeat_rate(atkbd);
579 mutex_unlock(&atkbd->event_mutex);
583 * Schedule switch for execution. We need to throttle requests,
584 * otherwise keyboard may become unresponsive.
586 static void atkbd_schedule_event_work(struct atkbd *atkbd, int event_bit)
588 unsigned long delay = msecs_to_jiffies(50);
590 if (time_after(jiffies, atkbd->event_jiffies + delay))
593 atkbd->event_jiffies = jiffies;
594 set_bit(event_bit, &atkbd->event_mask);
596 schedule_delayed_work(&atkbd->event_work, delay);
600 * Event callback from the input module. Events that change the state of
601 * the hardware are processed here. If action can not be performed in
602 * interrupt context it is offloaded to atkbd_event_work.
605 static int atkbd_event(struct input_dev *dev,
606 unsigned int type, unsigned int code, int value)
608 struct atkbd *atkbd = input_get_drvdata(dev);
616 atkbd_schedule_event_work(atkbd, ATKBD_LED_EVENT_BIT);
620 if (!atkbd->softrepeat)
621 atkbd_schedule_event_work(atkbd, ATKBD_REP_EVENT_BIT);
629 * atkbd_enable() signals that interrupt handler is allowed to
630 * generate input events.
633 static inline void atkbd_enable(struct atkbd *atkbd)
635 serio_pause_rx(atkbd->ps2dev.serio);
637 serio_continue_rx(atkbd->ps2dev.serio);
641 * atkbd_disable() tells input handler that all incoming data except
642 * for ACKs and command response should be dropped.
645 static inline void atkbd_disable(struct atkbd *atkbd)
647 serio_pause_rx(atkbd->ps2dev.serio);
649 serio_continue_rx(atkbd->ps2dev.serio);
653 * atkbd_probe() probes for an AT keyboard on a serio port.
656 static int atkbd_probe(struct atkbd *atkbd)
658 struct ps2dev *ps2dev = &atkbd->ps2dev;
659 unsigned char param[2];
662 * Some systems, where the bit-twiddling when testing the io-lines of the
663 * controller may confuse the keyboard need a full reset of the keyboard. On
664 * these systems the BIOS also usually doesn't do it for us.
668 if (ps2_command(ps2dev, NULL, ATKBD_CMD_RESET_BAT))
669 printk(KERN_WARNING "atkbd.c: keyboard reset failed on %s\n", ps2dev->serio->phys);
672 * Then we check the keyboard ID. We should get 0xab83 under normal conditions.
673 * Some keyboards report different values, but the first byte is always 0xab or
674 * 0xac. Some old AT keyboards don't report anything. If a mouse is connected, this
675 * should make sure we don't try to set the LEDs on it.
678 param[0] = param[1] = 0xa5; /* initialize with invalid values */
679 if (ps2_command(ps2dev, param, ATKBD_CMD_GETID)) {
682 * If the get ID command failed, we check if we can at least set the LEDs on
683 * the keyboard. This should work on every keyboard out there. It also turns
684 * the LEDs off, which we want anyway.
687 if (ps2_command(ps2dev, param, ATKBD_CMD_SETLEDS))
693 if (!ps2_is_keyboard_id(param[0]))
696 atkbd->id = (param[0] << 8) | param[1];
698 if (atkbd->id == 0xaca1 && atkbd->translated) {
699 printk(KERN_ERR "atkbd.c: NCD terminal keyboards are only supported on non-translating\n");
700 printk(KERN_ERR "atkbd.c: controllers. Use i8042.direct=1 to disable translation.\n");
708 * atkbd_select_set checks if a keyboard has a working Set 3 support, and
709 * sets it into that. Unfortunately there are keyboards that can be switched
710 * to Set 3, but don't work well in that (BTC Multimedia ...)
713 static int atkbd_select_set(struct atkbd *atkbd, int target_set, int allow_extra)
715 struct ps2dev *ps2dev = &atkbd->ps2dev;
716 unsigned char param[2];
720 * For known special keyboards we can go ahead and set the correct set.
721 * We check for NCD PS/2 Sun, NorthGate OmniKey 101 and
722 * IBM RapidAccess / IBM EzButton / Chicony KBP-8993 keyboards.
725 if (atkbd->translated)
728 if (atkbd->id == 0xaca1) {
730 ps2_command(ps2dev, param, ATKBD_CMD_SSCANSET);
736 if (!ps2_command(ps2dev, param, ATKBD_CMD_EX_ENABLE)) {
745 if (!ps2_command(ps2dev, param, ATKBD_CMD_OK_GETID)) {
746 atkbd->id = param[0] << 8 | param[1];
751 if (ps2_command(ps2dev, param, ATKBD_CMD_SSCANSET))
755 if (ps2_command(ps2dev, param, ATKBD_CMD_GSCANSET))
760 if (ps2_command(ps2dev, param, ATKBD_CMD_SSCANSET))
764 ps2_command(ps2dev, param, ATKBD_CMD_SETALL_MBR);
769 static int atkbd_activate(struct atkbd *atkbd)
771 struct ps2dev *ps2dev = &atkbd->ps2dev;
772 unsigned char param[1];
775 * Set the LEDs to a defined state.
779 if (ps2_command(ps2dev, param, ATKBD_CMD_SETLEDS))
783 * Set autorepeat to fastest possible.
787 if (ps2_command(ps2dev, param, ATKBD_CMD_SETREP))
791 * Enable the keyboard to receive keystrokes.
794 if (ps2_command(ps2dev, NULL, ATKBD_CMD_ENABLE)) {
795 printk(KERN_ERR "atkbd.c: Failed to enable keyboard on %s\n",
796 ps2dev->serio->phys);
804 * atkbd_cleanup() restores the keyboard state so that BIOS is happy after a
808 static void atkbd_cleanup(struct serio *serio)
810 struct atkbd *atkbd = serio_get_drvdata(serio);
811 ps2_command(&atkbd->ps2dev, NULL, ATKBD_CMD_RESET_BAT);
816 * atkbd_disconnect() closes and frees.
819 static void atkbd_disconnect(struct serio *serio)
821 struct atkbd *atkbd = serio_get_drvdata(serio);
823 atkbd_disable(atkbd);
825 /* make sure we don't have a command in flight */
826 synchronize_sched(); /* Allow atkbd_interrupt()s to complete. */
827 flush_scheduled_work();
829 sysfs_remove_group(&serio->dev.kobj, &atkbd_attribute_group);
830 input_unregister_device(atkbd->dev);
832 serio_set_drvdata(serio, NULL);
838 * atkbd_set_keycode_table() initializes keyboard's keycode table
839 * according to the selected scancode set
842 static void atkbd_set_keycode_table(struct atkbd *atkbd)
846 memset(atkbd->keycode, 0, sizeof(atkbd->keycode));
848 if (atkbd->translated) {
849 for (i = 0; i < 128; i++) {
850 atkbd->keycode[i] = atkbd_set2_keycode[atkbd_unxlate_table[i]];
851 atkbd->keycode[i | 0x80] = atkbd_set2_keycode[atkbd_unxlate_table[i] | 0x80];
853 for (j = 0; j < ARRAY_SIZE(atkbd_scroll_keys); j++)
854 if ((atkbd_unxlate_table[i] | 0x80) == atkbd_scroll_keys[j].set2)
855 atkbd->keycode[i | 0x80] = atkbd_scroll_keys[j].keycode;
857 } else if (atkbd->set == 3) {
858 memcpy(atkbd->keycode, atkbd_set3_keycode, sizeof(atkbd->keycode));
860 memcpy(atkbd->keycode, atkbd_set2_keycode, sizeof(atkbd->keycode));
863 for (i = 0; i < ARRAY_SIZE(atkbd_scroll_keys); i++)
864 atkbd->keycode[atkbd_scroll_keys[i].set2] = atkbd_scroll_keys[i].keycode;
867 atkbd->keycode[atkbd_compat_scancode(atkbd, ATKBD_RET_HANGEUL)] = KEY_HANGUEL;
868 atkbd->keycode[atkbd_compat_scancode(atkbd, ATKBD_RET_HANJA)] = KEY_HANJA;
872 * atkbd_set_device_attrs() sets up keyboard's input device structure
875 static void atkbd_set_device_attrs(struct atkbd *atkbd)
877 struct input_dev *input_dev = atkbd->dev;
881 snprintf(atkbd->name, sizeof(atkbd->name),
882 "AT Set 2 Extra keyboard");
884 snprintf(atkbd->name, sizeof(atkbd->name),
885 "AT %s Set %d keyboard",
886 atkbd->translated ? "Translated" : "Raw", atkbd->set);
888 snprintf(atkbd->phys, sizeof(atkbd->phys),
889 "%s/input0", atkbd->ps2dev.serio->phys);
891 input_dev->name = atkbd->name;
892 input_dev->phys = atkbd->phys;
893 input_dev->id.bustype = BUS_I8042;
894 input_dev->id.vendor = 0x0001;
895 input_dev->id.product = atkbd->translated ? 1 : atkbd->set;
896 input_dev->id.version = atkbd->id;
897 input_dev->event = atkbd_event;
898 input_dev->dev.parent = &atkbd->ps2dev.serio->dev;
900 input_set_drvdata(input_dev, atkbd);
902 input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_REP) | BIT(EV_MSC);
905 input_dev->evbit[0] |= BIT(EV_LED);
906 input_dev->ledbit[0] = BIT(LED_NUML) | BIT(LED_CAPSL) | BIT(LED_SCROLLL);
910 input_dev->ledbit[0] |= BIT(LED_COMPOSE) | BIT(LED_SUSPEND) |
911 BIT(LED_SLEEP) | BIT(LED_MUTE) | BIT(LED_MISC);
913 if (!atkbd->softrepeat) {
914 input_dev->rep[REP_DELAY] = 250;
915 input_dev->rep[REP_PERIOD] = 33;
918 input_dev->mscbit[0] = atkbd->softraw ? BIT(MSC_SCAN) : BIT(MSC_RAW) | BIT(MSC_SCAN);
921 input_dev->evbit[0] |= BIT(EV_REL);
922 input_dev->relbit[0] = BIT(REL_WHEEL) | BIT(REL_HWHEEL);
923 set_bit(BTN_MIDDLE, input_dev->keybit);
926 input_dev->keycode = atkbd->keycode;
927 input_dev->keycodesize = sizeof(unsigned char);
928 input_dev->keycodemax = ARRAY_SIZE(atkbd_set2_keycode);
930 for (i = 0; i < 512; i++)
931 if (atkbd->keycode[i] && atkbd->keycode[i] < ATKBD_SPECIAL)
932 set_bit(atkbd->keycode[i], input_dev->keybit);
936 * atkbd_connect() is called when the serio module finds an interface
937 * that isn't handled yet by an appropriate device driver. We check if
938 * there is an AT keyboard out there and if yes, we register ourselves
939 * to the input module.
942 static int atkbd_connect(struct serio *serio, struct serio_driver *drv)
945 struct input_dev *dev;
948 atkbd = kzalloc(sizeof(struct atkbd), GFP_KERNEL);
949 dev = input_allocate_device();
954 ps2_init(&atkbd->ps2dev, serio);
955 INIT_DELAYED_WORK(&atkbd->event_work, atkbd_event_work);
956 mutex_init(&atkbd->event_mutex);
958 switch (serio->id.type) {
961 atkbd->translated = 1;
968 atkbd->softraw = atkbd_softraw;
969 atkbd->softrepeat = atkbd_softrepeat;
970 atkbd->scroll = atkbd_scroll;
972 if (atkbd->softrepeat)
975 serio_set_drvdata(serio, atkbd);
977 err = serio_open(serio, drv);
983 if (atkbd_probe(atkbd)) {
988 atkbd->set = atkbd_select_set(atkbd, atkbd_set, atkbd_extra);
989 atkbd_activate(atkbd);
996 atkbd_set_keycode_table(atkbd);
997 atkbd_set_device_attrs(atkbd);
999 err = sysfs_create_group(&serio->dev.kobj, &atkbd_attribute_group);
1003 atkbd_enable(atkbd);
1005 err = input_register_device(atkbd->dev);
1011 fail4: sysfs_remove_group(&serio->dev.kobj, &atkbd_attribute_group);
1012 fail3: serio_close(serio);
1013 fail2: serio_set_drvdata(serio, NULL);
1014 fail1: input_free_device(dev);
1020 * atkbd_reconnect() tries to restore keyboard into a sane state and is
1021 * most likely called on resume.
1024 static int atkbd_reconnect(struct serio *serio)
1026 struct atkbd *atkbd = serio_get_drvdata(serio);
1027 struct serio_driver *drv = serio->drv;
1029 if (!atkbd || !drv) {
1030 printk(KERN_DEBUG "atkbd: reconnect request, but serio is disconnected, ignoring...\n");
1034 atkbd_disable(atkbd);
1037 if (atkbd_probe(atkbd))
1039 if (atkbd->set != atkbd_select_set(atkbd, atkbd->set, atkbd->extra))
1042 atkbd_activate(atkbd);
1045 * Restore repeat rate and LEDs (that were reset by atkbd_activate)
1046 * to pre-resume state
1048 if (!atkbd->softrepeat)
1049 atkbd_set_repeat_rate(atkbd);
1050 atkbd_set_leds(atkbd);
1053 atkbd_enable(atkbd);
1058 static struct serio_device_id atkbd_serio_ids[] = {
1066 .type = SERIO_8042_XL,
1072 .type = SERIO_RS232,
1073 .proto = SERIO_PS2SER,
1080 MODULE_DEVICE_TABLE(serio, atkbd_serio_ids);
1082 static struct serio_driver atkbd_drv = {
1086 .description = DRIVER_DESC,
1087 .id_table = atkbd_serio_ids,
1088 .interrupt = atkbd_interrupt,
1089 .connect = atkbd_connect,
1090 .reconnect = atkbd_reconnect,
1091 .disconnect = atkbd_disconnect,
1092 .cleanup = atkbd_cleanup,
1095 static ssize_t atkbd_attr_show_helper(struct device *dev, char *buf,
1096 ssize_t (*handler)(struct atkbd *, char *))
1098 struct serio *serio = to_serio_port(dev);
1101 retval = serio_pin_driver(serio);
1105 if (serio->drv != &atkbd_drv) {
1110 retval = handler((struct atkbd *)serio_get_drvdata(serio), buf);
1113 serio_unpin_driver(serio);
1117 static ssize_t atkbd_attr_set_helper(struct device *dev, const char *buf, size_t count,
1118 ssize_t (*handler)(struct atkbd *, const char *, size_t))
1120 struct serio *serio = to_serio_port(dev);
1121 struct atkbd *atkbd;
1124 retval = serio_pin_driver(serio);
1128 if (serio->drv != &atkbd_drv) {
1133 atkbd = serio_get_drvdata(serio);
1134 atkbd_disable(atkbd);
1135 retval = handler(atkbd, buf, count);
1136 atkbd_enable(atkbd);
1139 serio_unpin_driver(serio);
1143 static ssize_t atkbd_show_extra(struct atkbd *atkbd, char *buf)
1145 return sprintf(buf, "%d\n", atkbd->extra ? 1 : 0);
1148 static ssize_t atkbd_set_extra(struct atkbd *atkbd, const char *buf, size_t count)
1150 struct input_dev *old_dev, *new_dev;
1151 unsigned long value;
1154 unsigned char old_extra, old_set;
1159 value = simple_strtoul(buf, &rest, 10);
1160 if (*rest || value > 1)
1163 if (atkbd->extra != value) {
1165 * Since device's properties will change we need to
1166 * unregister old device. But allocate and register
1167 * new one first to make sure we have it.
1169 old_dev = atkbd->dev;
1170 old_extra = atkbd->extra;
1171 old_set = atkbd->set;
1173 new_dev = input_allocate_device();
1177 atkbd->dev = new_dev;
1178 atkbd->set = atkbd_select_set(atkbd, atkbd->set, value);
1179 atkbd_activate(atkbd);
1180 atkbd_set_keycode_table(atkbd);
1181 atkbd_set_device_attrs(atkbd);
1183 err = input_register_device(atkbd->dev);
1185 input_free_device(new_dev);
1187 atkbd->dev = old_dev;
1188 atkbd->set = atkbd_select_set(atkbd, old_set, old_extra);
1189 atkbd_set_keycode_table(atkbd);
1190 atkbd_set_device_attrs(atkbd);
1194 input_unregister_device(old_dev);
1200 static ssize_t atkbd_show_scroll(struct atkbd *atkbd, char *buf)
1202 return sprintf(buf, "%d\n", atkbd->scroll ? 1 : 0);
1205 static ssize_t atkbd_set_scroll(struct atkbd *atkbd, const char *buf, size_t count)
1207 struct input_dev *old_dev, *new_dev;
1208 unsigned long value;
1211 unsigned char old_scroll;
1213 value = simple_strtoul(buf, &rest, 10);
1214 if (*rest || value > 1)
1217 if (atkbd->scroll != value) {
1218 old_dev = atkbd->dev;
1219 old_scroll = atkbd->scroll;
1221 new_dev = input_allocate_device();
1225 atkbd->dev = new_dev;
1226 atkbd->scroll = value;
1227 atkbd_set_keycode_table(atkbd);
1228 atkbd_set_device_attrs(atkbd);
1230 err = input_register_device(atkbd->dev);
1232 input_free_device(new_dev);
1234 atkbd->scroll = old_scroll;
1235 atkbd->dev = old_dev;
1236 atkbd_set_keycode_table(atkbd);
1237 atkbd_set_device_attrs(atkbd);
1241 input_unregister_device(old_dev);
1246 static ssize_t atkbd_show_set(struct atkbd *atkbd, char *buf)
1248 return sprintf(buf, "%d\n", atkbd->set);
1251 static ssize_t atkbd_set_set(struct atkbd *atkbd, const char *buf, size_t count)
1253 struct input_dev *old_dev, *new_dev;
1254 unsigned long value;
1257 unsigned char old_set, old_extra;
1262 value = simple_strtoul(buf, &rest, 10);
1263 if (*rest || (value != 2 && value != 3))
1266 if (atkbd->set != value) {
1267 old_dev = atkbd->dev;
1268 old_extra = atkbd->extra;
1269 old_set = atkbd->set;
1271 new_dev = input_allocate_device();
1275 atkbd->dev = new_dev;
1276 atkbd->set = atkbd_select_set(atkbd, value, atkbd->extra);
1277 atkbd_activate(atkbd);
1278 atkbd_set_keycode_table(atkbd);
1279 atkbd_set_device_attrs(atkbd);
1281 err = input_register_device(atkbd->dev);
1283 input_free_device(new_dev);
1285 atkbd->dev = old_dev;
1286 atkbd->set = atkbd_select_set(atkbd, old_set, old_extra);
1287 atkbd_set_keycode_table(atkbd);
1288 atkbd_set_device_attrs(atkbd);
1292 input_unregister_device(old_dev);
1297 static ssize_t atkbd_show_softrepeat(struct atkbd *atkbd, char *buf)
1299 return sprintf(buf, "%d\n", atkbd->softrepeat ? 1 : 0);
1302 static ssize_t atkbd_set_softrepeat(struct atkbd *atkbd, const char *buf, size_t count)
1304 struct input_dev *old_dev, *new_dev;
1305 unsigned long value;
1308 unsigned char old_softrepeat, old_softraw;
1313 value = simple_strtoul(buf, &rest, 10);
1314 if (*rest || value > 1)
1317 if (atkbd->softrepeat != value) {
1318 old_dev = atkbd->dev;
1319 old_softrepeat = atkbd->softrepeat;
1320 old_softraw = atkbd->softraw;
1322 new_dev = input_allocate_device();
1326 atkbd->dev = new_dev;
1327 atkbd->softrepeat = value;
1328 if (atkbd->softrepeat)
1330 atkbd_set_device_attrs(atkbd);
1332 err = input_register_device(atkbd->dev);
1334 input_free_device(new_dev);
1336 atkbd->dev = old_dev;
1337 atkbd->softrepeat = old_softrepeat;
1338 atkbd->softraw = old_softraw;
1339 atkbd_set_device_attrs(atkbd);
1343 input_unregister_device(old_dev);
1349 static ssize_t atkbd_show_softraw(struct atkbd *atkbd, char *buf)
1351 return sprintf(buf, "%d\n", atkbd->softraw ? 1 : 0);
1354 static ssize_t atkbd_set_softraw(struct atkbd *atkbd, const char *buf, size_t count)
1356 struct input_dev *old_dev, *new_dev;
1357 unsigned long value;
1360 unsigned char old_softraw;
1362 value = simple_strtoul(buf, &rest, 10);
1363 if (*rest || value > 1)
1366 if (atkbd->softraw != value) {
1367 old_dev = atkbd->dev;
1368 old_softraw = atkbd->softraw;
1370 new_dev = input_allocate_device();
1374 atkbd->dev = new_dev;
1375 atkbd->softraw = value;
1376 atkbd_set_device_attrs(atkbd);
1378 err = input_register_device(atkbd->dev);
1380 input_free_device(new_dev);
1382 atkbd->dev = old_dev;
1383 atkbd->softraw = old_softraw;
1384 atkbd_set_device_attrs(atkbd);
1388 input_unregister_device(old_dev);
1393 static ssize_t atkbd_show_err_count(struct atkbd *atkbd, char *buf)
1395 return sprintf(buf, "%lu\n", atkbd->err_count);
1399 static int __init atkbd_init(void)
1401 return serio_register_driver(&atkbd_drv);
1404 static void __exit atkbd_exit(void)
1406 serio_unregister_driver(&atkbd_drv);
1409 module_init(atkbd_init);
1410 module_exit(atkbd_exit);