Input: atkbd - restore repeat rate when resuming
[deliverable/linux.git] / drivers / input / keyboard / atkbd.c
1 /*
2 * AT and PS/2 keyboard driver
3 *
4 * Copyright (c) 1999-2002 Vojtech Pavlik
5 */
6
7 /*
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.
11 */
12
13 /*
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
17 * converter.
18 */
19
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>
31
32 #define DRIVER_DESC "AT and PS/2 keyboard driver"
33
34 MODULE_AUTHOR("Vojtech Pavlik <vojtech@suse.cz>");
35 MODULE_DESCRIPTION(DRIVER_DESC);
36 MODULE_LICENSE("GPL");
37
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)");
41
42 #if defined(__i386__) || defined(__x86_64__) || defined(__hppa__)
43 static int atkbd_reset;
44 #else
45 static int atkbd_reset = 1;
46 #endif
47 module_param_named(reset, atkbd_reset, bool, 0);
48 MODULE_PARM_DESC(reset, "Reset keyboard during initialization");
49
50 static int atkbd_softrepeat;
51 module_param_named(softrepeat, atkbd_softrepeat, bool, 0);
52 MODULE_PARM_DESC(softrepeat, "Use software keyboard repeat");
53
54 static int atkbd_softraw = 1;
55 module_param_named(softraw, atkbd_softraw, bool, 0);
56 MODULE_PARM_DESC(softraw, "Use software generated rawmode");
57
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");
61
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");
65
66 __obsolete_setup("atkbd_set=");
67 __obsolete_setup("atkbd_reset");
68 __obsolete_setup("atkbd_softrepeat=");
69
70 /*
71 * Scancode to keycode tables. These are just the default setting, and
72 * are loadable via an userland utility.
73 */
74
75 static unsigned char atkbd_set2_keycode[512] = {
76
77 #ifdef CONFIG_KEYBOARD_ATKBD_HP_KEYCODES
78
79 /* XXX: need a more general approach */
80
81 #include "hpps2atkbd.h" /* include the keyboard scancodes */
82
83 #else
84 0, 67, 65, 63, 61, 59, 60, 88, 0, 68, 66, 64, 62, 15, 41,117,
85 0, 56, 42, 93, 29, 16, 2, 0, 0, 0, 44, 31, 30, 17, 3, 0,
86 0, 46, 45, 32, 18, 5, 4, 95, 0, 57, 47, 33, 20, 19, 6,183,
87 0, 49, 48, 35, 34, 21, 7,184, 0, 0, 50, 36, 22, 8, 9,185,
88 0, 51, 37, 23, 24, 11, 10, 0, 0, 52, 53, 38, 39, 25, 12, 0,
89 0, 89, 40, 0, 26, 13, 0, 0, 58, 54, 28, 27, 0, 43, 0, 85,
90 0, 86, 91, 90, 92, 0, 14, 94, 0, 79,124, 75, 71,121, 0, 0,
91 82, 83, 80, 76, 77, 72, 1, 69, 87, 78, 81, 74, 55, 73, 70, 99,
92
93 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
94 217,100,255, 0, 97,165, 0, 0,156, 0, 0, 0, 0, 0, 0,125,
95 173,114, 0,113, 0, 0, 0,126,128, 0, 0,140, 0, 0, 0,127,
96 159, 0,115, 0,164, 0, 0,116,158, 0,150,166, 0, 0, 0,142,
97 157, 0, 0, 0, 0, 0, 0, 0,155, 0, 98, 0, 0,163, 0, 0,
98 226, 0, 0, 0, 0, 0, 0, 0, 0,255, 96, 0, 0, 0,143, 0,
99 0, 0, 0, 0, 0, 0, 0, 0, 0,107, 0,105,102, 0, 0,112,
100 110,111,108,112,106,103, 0,119, 0,118,109, 0, 99,104,119, 0,
101
102 0, 0, 0, 65, 99,
103 #endif
104 };
105
106 static unsigned char atkbd_set3_keycode[512] = {
107
108 0, 0, 0, 0, 0, 0, 0, 59, 1,138,128,129,130, 15, 41, 60,
109 131, 29, 42, 86, 58, 16, 2, 61,133, 56, 44, 31, 30, 17, 3, 62,
110 134, 46, 45, 32, 18, 5, 4, 63,135, 57, 47, 33, 20, 19, 6, 64,
111 136, 49, 48, 35, 34, 21, 7, 65,137,100, 50, 36, 22, 8, 9, 66,
112 125, 51, 37, 23, 24, 11, 10, 67,126, 52, 53, 38, 39, 25, 12, 68,
113 113,114, 40, 43, 26, 13, 87, 99, 97, 54, 28, 27, 43, 43, 88, 70,
114 108,105,119,103,111,107, 14,110, 0, 79,106, 75, 71,109,102,104,
115 82, 83, 80, 76, 77, 72, 69, 98, 0, 96, 81, 0, 78, 73, 55,183,
116
117 184,185,186,187, 74, 94, 92, 93, 0, 0, 0,125,126,127,112, 0,
118 0,139,150,163,165,115,152,150,166,140,160,154,113,114,167,168,
119 148,149,147,140
120 };
121
122 static unsigned char atkbd_unxlate_table[128] = {
123 0,118, 22, 30, 38, 37, 46, 54, 61, 62, 70, 69, 78, 85,102, 13,
124 21, 29, 36, 45, 44, 53, 60, 67, 68, 77, 84, 91, 90, 20, 28, 27,
125 35, 43, 52, 51, 59, 66, 75, 76, 82, 14, 18, 93, 26, 34, 33, 42,
126 50, 49, 58, 65, 73, 74, 89,124, 17, 41, 88, 5, 6, 4, 12, 3,
127 11, 2, 10, 1, 9,119,126,108,117,125,123,107,115,116,121,105,
128 114,122,112,113,127, 96, 97,120, 7, 15, 23, 31, 39, 47, 55, 63,
129 71, 79, 86, 94, 8, 16, 24, 32, 40, 48, 56, 64, 72, 80, 87,111,
130 19, 25, 57, 81, 83, 92, 95, 98, 99,100,101,103,104,106,109,110
131 };
132
133 #define ATKBD_CMD_SETLEDS 0x10ed
134 #define ATKBD_CMD_GSCANSET 0x11f0
135 #define ATKBD_CMD_SSCANSET 0x10f0
136 #define ATKBD_CMD_GETID 0x02f2
137 #define ATKBD_CMD_SETREP 0x10f3
138 #define ATKBD_CMD_ENABLE 0x00f4
139 #define ATKBD_CMD_RESET_DIS 0x00f5
140 #define ATKBD_CMD_SETALL_MBR 0x00fa
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 254
161 #define ATKBD_SCR_2 253
162 #define ATKBD_SCR_4 252
163 #define ATKBD_SCR_8 251
164 #define ATKBD_SCR_CLICK 250
165 #define ATKBD_SCR_LEFT 249
166 #define ATKBD_SCR_RIGHT 248
167
168 #define ATKBD_SPECIAL 248
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 struct {
181 unsigned char 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 char keycode[512];
208 unsigned char set;
209 unsigned char translated;
210 unsigned char extra;
211 unsigned char write;
212 unsigned char softrepeat;
213 unsigned char softraw;
214 unsigned char scroll;
215 unsigned char enabled;
216
217 /* Accessed only from interrupt */
218 unsigned char emul;
219 unsigned char resend;
220 unsigned char release;
221 unsigned long xl_bit;
222 unsigned int last;
223 unsigned long time;
224
225 struct work_struct event_work;
226 struct mutex event_mutex;
227 unsigned long event_mask;
228 };
229
230 static ssize_t atkbd_attr_show_helper(struct device *dev, char *buf,
231 ssize_t (*handler)(struct atkbd *, char *));
232 static ssize_t atkbd_attr_set_helper(struct device *dev, const char *buf, size_t count,
233 ssize_t (*handler)(struct atkbd *, const char *, size_t));
234 #define ATKBD_DEFINE_ATTR(_name) \
235 static ssize_t atkbd_show_##_name(struct atkbd *, char *); \
236 static ssize_t atkbd_set_##_name(struct atkbd *, const char *, size_t); \
237 static ssize_t atkbd_do_show_##_name(struct device *d, struct device_attribute *attr, char *b) \
238 { \
239 return atkbd_attr_show_helper(d, b, atkbd_show_##_name); \
240 } \
241 static ssize_t atkbd_do_set_##_name(struct device *d, struct device_attribute *attr, const char *b, size_t s) \
242 { \
243 return atkbd_attr_set_helper(d, b, s, atkbd_set_##_name); \
244 } \
245 static struct device_attribute atkbd_attr_##_name = \
246 __ATTR(_name, S_IWUSR | S_IRUGO, atkbd_do_show_##_name, atkbd_do_set_##_name);
247
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);
253
254 static const unsigned int xl_table[] = {
255 ATKBD_RET_BAT, ATKBD_RET_ERR, ATKBD_RET_ACK,
256 ATKBD_RET_NAK, ATKBD_RET_HANJA, ATKBD_RET_HANGEUL,
257 };
258
259 /*
260 * Checks if we should mangle the scancode to extract 'release' bit
261 * in translated mode.
262 */
263 static int atkbd_need_xlate(unsigned long xl_bit, unsigned char code)
264 {
265 int i;
266
267 if (code == ATKBD_RET_EMUL0 || code == ATKBD_RET_EMUL1)
268 return 0;
269
270 for (i = 0; i < ARRAY_SIZE(xl_table); i++)
271 if (code == xl_table[i])
272 return test_bit(i, &xl_bit);
273
274 return 1;
275 }
276
277 /*
278 * Calculates new value of xl_bit so the driver can distinguish
279 * between make/break pair of scancodes for select keys and PS/2
280 * protocol responses.
281 */
282 static void atkbd_calculate_xl_bit(struct atkbd *atkbd, unsigned char code)
283 {
284 int i;
285
286 for (i = 0; i < ARRAY_SIZE(xl_table); i++) {
287 if (!((code ^ xl_table[i]) & 0x7f)) {
288 if (code & 0x80)
289 __clear_bit(i, &atkbd->xl_bit);
290 else
291 __set_bit(i, &atkbd->xl_bit);
292 break;
293 }
294 }
295 }
296
297 /*
298 * Encode the scancode, 0xe0 prefix, and high bit into a single integer,
299 * keeping kernel 2.4 compatibility for set 2
300 */
301 static unsigned int atkbd_compat_scancode(struct atkbd *atkbd, unsigned int code)
302 {
303 if (atkbd->set == 3) {
304 if (atkbd->emul == 1)
305 code |= 0x100;
306 } else {
307 code = (code & 0x7f) | ((code & 0x80) << 1);
308 if (atkbd->emul == 1)
309 code |= 0x80;
310 }
311
312 return code;
313 }
314
315 /*
316 * atkbd_interrupt(). Here takes place processing of data received from
317 * the keyboard into events.
318 */
319
320 static irqreturn_t atkbd_interrupt(struct serio *serio, unsigned char data,
321 unsigned int flags, struct pt_regs *regs)
322 {
323 struct atkbd *atkbd = serio_get_drvdata(serio);
324 struct input_dev *dev = atkbd->dev;
325 unsigned int code = data;
326 int scroll = 0, hscroll = 0, click = -1, add_release_event = 0;
327 int value;
328 unsigned char keycode;
329
330 #ifdef ATKBD_DEBUG
331 printk(KERN_DEBUG "atkbd.c: Received %02x flags %02x\n", data, flags);
332 #endif
333
334 #if !defined(__i386__) && !defined (__x86_64__)
335 if ((flags & (SERIO_FRAME | SERIO_PARITY)) && (~flags & SERIO_TIMEOUT) && !atkbd->resend && atkbd->write) {
336 printk(KERN_WARNING "atkbd.c: frame/parity error: %02x\n", flags);
337 serio_write(serio, ATKBD_CMD_RESEND);
338 atkbd->resend = 1;
339 goto out;
340 }
341
342 if (!flags && data == ATKBD_RET_ACK)
343 atkbd->resend = 0;
344 #endif
345
346 if (unlikely(atkbd->ps2dev.flags & PS2_FLAG_ACK))
347 if (ps2_handle_ack(&atkbd->ps2dev, data))
348 goto out;
349
350 if (unlikely(atkbd->ps2dev.flags & PS2_FLAG_CMD))
351 if (ps2_handle_response(&atkbd->ps2dev, data))
352 goto out;
353
354 if (!atkbd->enabled)
355 goto out;
356
357 input_event(dev, EV_MSC, MSC_RAW, code);
358
359 if (atkbd->translated) {
360
361 if (atkbd->emul || atkbd_need_xlate(atkbd->xl_bit, code)) {
362 atkbd->release = code >> 7;
363 code &= 0x7f;
364 }
365
366 if (!atkbd->emul)
367 atkbd_calculate_xl_bit(atkbd, data);
368 }
369
370 switch (code) {
371 case ATKBD_RET_BAT:
372 atkbd->enabled = 0;
373 serio_reconnect(atkbd->ps2dev.serio);
374 goto out;
375 case ATKBD_RET_EMUL0:
376 atkbd->emul = 1;
377 goto out;
378 case ATKBD_RET_EMUL1:
379 atkbd->emul = 2;
380 goto out;
381 case ATKBD_RET_RELEASE:
382 atkbd->release = 1;
383 goto out;
384 case ATKBD_RET_ACK:
385 case ATKBD_RET_NAK:
386 printk(KERN_WARNING "atkbd.c: Spurious %s on %s. "
387 "Some program might be trying access hardware directly.\n",
388 data == ATKBD_RET_ACK ? "ACK" : "NAK", serio->phys);
389 goto out;
390 case ATKBD_RET_HANGEUL:
391 case ATKBD_RET_HANJA:
392 /*
393 * These keys do not report release and thus need to be
394 * flagged properly
395 */
396 add_release_event = 1;
397 break;
398 case ATKBD_RET_ERR:
399 printk(KERN_DEBUG "atkbd.c: Keyboard on %s reports too many keys pressed.\n", serio->phys);
400 goto out;
401 }
402
403 code = atkbd_compat_scancode(atkbd, code);
404
405 if (atkbd->emul && --atkbd->emul)
406 goto out;
407
408 keycode = atkbd->keycode[code];
409
410 if (keycode != ATKBD_KEY_NULL)
411 input_event(dev, EV_MSC, MSC_SCAN, code);
412
413 switch (keycode) {
414 case ATKBD_KEY_NULL:
415 break;
416 case ATKBD_KEY_UNKNOWN:
417 printk(KERN_WARNING
418 "atkbd.c: Unknown key %s (%s set %d, code %#x on %s).\n",
419 atkbd->release ? "released" : "pressed",
420 atkbd->translated ? "translated" : "raw",
421 atkbd->set, code, serio->phys);
422 printk(KERN_WARNING
423 "atkbd.c: Use 'setkeycodes %s%02x <keycode>' to make it known.\n",
424 code & 0x80 ? "e0" : "", code & 0x7f);
425 input_sync(dev);
426 break;
427 case ATKBD_SCR_1:
428 scroll = 1 - atkbd->release * 2;
429 break;
430 case ATKBD_SCR_2:
431 scroll = 2 - atkbd->release * 4;
432 break;
433 case ATKBD_SCR_4:
434 scroll = 4 - atkbd->release * 8;
435 break;
436 case ATKBD_SCR_8:
437 scroll = 8 - atkbd->release * 16;
438 break;
439 case ATKBD_SCR_CLICK:
440 click = !atkbd->release;
441 break;
442 case ATKBD_SCR_LEFT:
443 hscroll = -1;
444 break;
445 case ATKBD_SCR_RIGHT:
446 hscroll = 1;
447 break;
448 default:
449 if (atkbd->release) {
450 value = 0;
451 atkbd->last = 0;
452 } else if (!atkbd->softrepeat && test_bit(keycode, dev->key)) {
453 /* Workaround Toshiba laptop multiple keypress */
454 value = time_before(jiffies, atkbd->time) && atkbd->last == code ? 1 : 2;
455 } else {
456 value = 1;
457 atkbd->last = code;
458 atkbd->time = jiffies + msecs_to_jiffies(dev->rep[REP_DELAY]) / 2;
459 }
460
461 input_regs(dev, regs);
462 input_event(dev, EV_KEY, keycode, value);
463 input_sync(dev);
464
465 if (value && add_release_event) {
466 input_report_key(dev, keycode, 0);
467 input_sync(dev);
468 }
469 }
470
471 if (atkbd->scroll) {
472 input_regs(dev, regs);
473 if (click != -1)
474 input_report_key(dev, BTN_MIDDLE, click);
475 input_report_rel(dev, REL_WHEEL, scroll);
476 input_report_rel(dev, REL_HWHEEL, hscroll);
477 input_sync(dev);
478 }
479
480 atkbd->release = 0;
481 out:
482 return IRQ_HANDLED;
483 }
484
485 static int atkbd_set_repeat_rate(struct atkbd *atkbd)
486 {
487 const short period[32] =
488 { 33, 37, 42, 46, 50, 54, 58, 63, 67, 75, 83, 92, 100, 109, 116, 125,
489 133, 149, 167, 182, 200, 217, 232, 250, 270, 303, 333, 370, 400, 435, 470, 500 };
490 const short delay[4] =
491 { 250, 500, 750, 1000 };
492
493 struct input_dev *dev = atkbd->dev;
494 unsigned char param;
495 int i = 0, j = 0;
496
497 while (i < ARRAY_SIZE(period) - 1 && period[i] < dev->rep[REP_PERIOD])
498 i++;
499 dev->rep[REP_PERIOD] = period[i];
500
501 while (j < ARRAY_SIZE(period) - 1 && delay[j] < dev->rep[REP_DELAY])
502 j++;
503 dev->rep[REP_DELAY] = delay[j];
504
505 param = i | (j << 5);
506 return ps2_command(&atkbd->ps2dev, &param, ATKBD_CMD_SETREP);
507 }
508
509 static int atkbd_set_leds(struct atkbd *atkbd)
510 {
511 struct input_dev *dev = atkbd->dev;
512 unsigned char param[2];
513
514 param[0] = (test_bit(LED_SCROLLL, dev->led) ? 1 : 0)
515 | (test_bit(LED_NUML, dev->led) ? 2 : 0)
516 | (test_bit(LED_CAPSL, dev->led) ? 4 : 0);
517 if (ps2_command(&atkbd->ps2dev, param, ATKBD_CMD_SETLEDS))
518 return -1;
519
520 if (atkbd->extra) {
521 param[0] = 0;
522 param[1] = (test_bit(LED_COMPOSE, dev->led) ? 0x01 : 0)
523 | (test_bit(LED_SLEEP, dev->led) ? 0x02 : 0)
524 | (test_bit(LED_SUSPEND, dev->led) ? 0x04 : 0)
525 | (test_bit(LED_MISC, dev->led) ? 0x10 : 0)
526 | (test_bit(LED_MUTE, dev->led) ? 0x20 : 0);
527 if (ps2_command(&atkbd->ps2dev, param, ATKBD_CMD_EX_SETLEDS))
528 return -1;
529 }
530
531 return 0;
532 }
533
534 /*
535 * atkbd_event_work() is used to complete processing of events that
536 * can not be processed by input_event() which is often called from
537 * interrupt context.
538 */
539
540 static void atkbd_event_work(void *data)
541 {
542 struct atkbd *atkbd = data;
543
544 mutex_lock(&atkbd->event_mutex);
545
546 if (test_and_clear_bit(ATKBD_LED_EVENT_BIT, &atkbd->event_mask))
547 atkbd_set_leds(atkbd);
548
549 if (test_and_clear_bit(ATKBD_REP_EVENT_BIT, &atkbd->event_mask))
550 atkbd_set_repeat_rate(atkbd);
551
552 mutex_unlock(&atkbd->event_mutex);
553 }
554
555 /*
556 * Event callback from the input module. Events that change the state of
557 * the hardware are processed here. If action can not be performed in
558 * interrupt context it is offloaded to atkbd_event_work.
559 */
560
561 static int atkbd_event(struct input_dev *dev, unsigned int type, unsigned int code, int value)
562 {
563 struct atkbd *atkbd = dev->private;
564
565 if (!atkbd->write)
566 return -1;
567
568 switch (type) {
569
570 case EV_LED:
571 set_bit(ATKBD_LED_EVENT_BIT, &atkbd->event_mask);
572 wmb();
573 schedule_work(&atkbd->event_work);
574 return 0;
575
576 case EV_REP:
577
578 if (!atkbd->softrepeat) {
579 set_bit(ATKBD_REP_EVENT_BIT, &atkbd->event_mask);
580 wmb();
581 schedule_work(&atkbd->event_work);
582 }
583
584 return 0;
585 }
586
587 return -1;
588 }
589
590 /*
591 * atkbd_enable() signals that interrupt handler is allowed to
592 * generate input events.
593 */
594
595 static inline void atkbd_enable(struct atkbd *atkbd)
596 {
597 serio_pause_rx(atkbd->ps2dev.serio);
598 atkbd->enabled = 1;
599 serio_continue_rx(atkbd->ps2dev.serio);
600 }
601
602 /*
603 * atkbd_disable() tells input handler that all incoming data except
604 * for ACKs and command response should be dropped.
605 */
606
607 static inline void atkbd_disable(struct atkbd *atkbd)
608 {
609 serio_pause_rx(atkbd->ps2dev.serio);
610 atkbd->enabled = 0;
611 serio_continue_rx(atkbd->ps2dev.serio);
612 }
613
614 /*
615 * atkbd_probe() probes for an AT keyboard on a serio port.
616 */
617
618 static int atkbd_probe(struct atkbd *atkbd)
619 {
620 struct ps2dev *ps2dev = &atkbd->ps2dev;
621 unsigned char param[2];
622
623 /*
624 * Some systems, where the bit-twiddling when testing the io-lines of the
625 * controller may confuse the keyboard need a full reset of the keyboard. On
626 * these systems the BIOS also usually doesn't do it for us.
627 */
628
629 if (atkbd_reset)
630 if (ps2_command(ps2dev, NULL, ATKBD_CMD_RESET_BAT))
631 printk(KERN_WARNING "atkbd.c: keyboard reset failed on %s\n", ps2dev->serio->phys);
632
633 /*
634 * Then we check the keyboard ID. We should get 0xab83 under normal conditions.
635 * Some keyboards report different values, but the first byte is always 0xab or
636 * 0xac. Some old AT keyboards don't report anything. If a mouse is connected, this
637 * should make sure we don't try to set the LEDs on it.
638 */
639
640 param[0] = param[1] = 0xa5; /* initialize with invalid values */
641 if (ps2_command(ps2dev, param, ATKBD_CMD_GETID)) {
642
643 /*
644 * If the get ID command failed, we check if we can at least set the LEDs on
645 * the keyboard. This should work on every keyboard out there. It also turns
646 * the LEDs off, which we want anyway.
647 */
648 param[0] = 0;
649 if (ps2_command(ps2dev, param, ATKBD_CMD_SETLEDS))
650 return -1;
651 atkbd->id = 0xabba;
652 return 0;
653 }
654
655 if (param[0] != 0xab && param[0] != 0xac && /* Regular and NCD Sun keyboards */
656 param[0] != 0x2b && param[0] != 0x5d && /* Trust keyboard, raw and translated */
657 param[0] != 0x60 && param[0] != 0x47) /* NMB SGI keyboard, raw and translated */
658 return -1;
659
660 atkbd->id = (param[0] << 8) | param[1];
661
662 if (atkbd->id == 0xaca1 && atkbd->translated) {
663 printk(KERN_ERR "atkbd.c: NCD terminal keyboards are only supported on non-translating\n");
664 printk(KERN_ERR "atkbd.c: controllers. Use i8042.direct=1 to disable translation.\n");
665 return -1;
666 }
667
668 return 0;
669 }
670
671 /*
672 * atkbd_select_set checks if a keyboard has a working Set 3 support, and
673 * sets it into that. Unfortunately there are keyboards that can be switched
674 * to Set 3, but don't work well in that (BTC Multimedia ...)
675 */
676
677 static int atkbd_select_set(struct atkbd *atkbd, int target_set, int allow_extra)
678 {
679 struct ps2dev *ps2dev = &atkbd->ps2dev;
680 unsigned char param[2];
681
682 atkbd->extra = 0;
683 /*
684 * For known special keyboards we can go ahead and set the correct set.
685 * We check for NCD PS/2 Sun, NorthGate OmniKey 101 and
686 * IBM RapidAccess / IBM EzButton / Chicony KBP-8993 keyboards.
687 */
688
689 if (atkbd->translated)
690 return 2;
691
692 if (atkbd->id == 0xaca1) {
693 param[0] = 3;
694 ps2_command(ps2dev, param, ATKBD_CMD_SSCANSET);
695 return 3;
696 }
697
698 if (allow_extra) {
699 param[0] = 0x71;
700 if (!ps2_command(ps2dev, param, ATKBD_CMD_EX_ENABLE)) {
701 atkbd->extra = 1;
702 return 2;
703 }
704 }
705
706 if (target_set != 3)
707 return 2;
708
709 if (!ps2_command(ps2dev, param, ATKBD_CMD_OK_GETID)) {
710 atkbd->id = param[0] << 8 | param[1];
711 return 2;
712 }
713
714 param[0] = 3;
715 if (ps2_command(ps2dev, param, ATKBD_CMD_SSCANSET))
716 return 2;
717
718 param[0] = 0;
719 if (ps2_command(ps2dev, param, ATKBD_CMD_GSCANSET))
720 return 2;
721
722 if (param[0] != 3) {
723 param[0] = 2;
724 if (ps2_command(ps2dev, param, ATKBD_CMD_SSCANSET))
725 return 2;
726 }
727
728 ps2_command(ps2dev, param, ATKBD_CMD_SETALL_MBR);
729
730 return 3;
731 }
732
733 static int atkbd_activate(struct atkbd *atkbd)
734 {
735 struct ps2dev *ps2dev = &atkbd->ps2dev;
736 unsigned char param[1];
737
738 /*
739 * Set the LEDs to a defined state.
740 */
741
742 param[0] = 0;
743 if (ps2_command(ps2dev, param, ATKBD_CMD_SETLEDS))
744 return -1;
745
746 /*
747 * Set autorepeat to fastest possible.
748 */
749
750 param[0] = 0;
751 if (ps2_command(ps2dev, param, ATKBD_CMD_SETREP))
752 return -1;
753
754 /*
755 * Enable the keyboard to receive keystrokes.
756 */
757
758 if (ps2_command(ps2dev, NULL, ATKBD_CMD_ENABLE)) {
759 printk(KERN_ERR "atkbd.c: Failed to enable keyboard on %s\n",
760 ps2dev->serio->phys);
761 return -1;
762 }
763
764 return 0;
765 }
766
767 /*
768 * atkbd_cleanup() restores the keyboard state so that BIOS is happy after a
769 * reboot.
770 */
771
772 static void atkbd_cleanup(struct serio *serio)
773 {
774 struct atkbd *atkbd = serio_get_drvdata(serio);
775 ps2_command(&atkbd->ps2dev, NULL, ATKBD_CMD_RESET_BAT);
776 }
777
778
779 /*
780 * atkbd_disconnect() closes and frees.
781 */
782
783 static void atkbd_disconnect(struct serio *serio)
784 {
785 struct atkbd *atkbd = serio_get_drvdata(serio);
786
787 atkbd_disable(atkbd);
788
789 /* make sure we don't have a command in flight */
790 synchronize_sched(); /* Allow atkbd_interrupt()s to complete. */
791 flush_scheduled_work();
792
793 device_remove_file(&serio->dev, &atkbd_attr_extra);
794 device_remove_file(&serio->dev, &atkbd_attr_scroll);
795 device_remove_file(&serio->dev, &atkbd_attr_set);
796 device_remove_file(&serio->dev, &atkbd_attr_softrepeat);
797 device_remove_file(&serio->dev, &atkbd_attr_softraw);
798
799 input_unregister_device(atkbd->dev);
800 serio_close(serio);
801 serio_set_drvdata(serio, NULL);
802 kfree(atkbd);
803 }
804
805
806 /*
807 * atkbd_set_keycode_table() initializes keyboard's keycode table
808 * according to the selected scancode set
809 */
810
811 static void atkbd_set_keycode_table(struct atkbd *atkbd)
812 {
813 int i, j;
814
815 memset(atkbd->keycode, 0, sizeof(atkbd->keycode));
816
817 if (atkbd->translated) {
818 for (i = 0; i < 128; i++) {
819 atkbd->keycode[i] = atkbd_set2_keycode[atkbd_unxlate_table[i]];
820 atkbd->keycode[i | 0x80] = atkbd_set2_keycode[atkbd_unxlate_table[i] | 0x80];
821 if (atkbd->scroll)
822 for (j = 0; j < ARRAY_SIZE(atkbd_scroll_keys); j++)
823 if ((atkbd_unxlate_table[i] | 0x80) == atkbd_scroll_keys[j].set2)
824 atkbd->keycode[i | 0x80] = atkbd_scroll_keys[j].keycode;
825 }
826 } else if (atkbd->set == 3) {
827 memcpy(atkbd->keycode, atkbd_set3_keycode, sizeof(atkbd->keycode));
828 } else {
829 memcpy(atkbd->keycode, atkbd_set2_keycode, sizeof(atkbd->keycode));
830
831 if (atkbd->scroll)
832 for (i = 0; i < ARRAY_SIZE(atkbd_scroll_keys); i++)
833 atkbd->keycode[atkbd_scroll_keys[i].set2] = atkbd_scroll_keys[i].keycode;
834 }
835
836 atkbd->keycode[atkbd_compat_scancode(atkbd, ATKBD_RET_HANGEUL)] = KEY_HANGUEL;
837 atkbd->keycode[atkbd_compat_scancode(atkbd, ATKBD_RET_HANJA)] = KEY_HANJA;
838 }
839
840 /*
841 * atkbd_set_device_attrs() sets up keyboard's input device structure
842 */
843
844 static void atkbd_set_device_attrs(struct atkbd *atkbd)
845 {
846 struct input_dev *input_dev = atkbd->dev;
847 int i;
848
849 if (atkbd->extra)
850 snprintf(atkbd->name, sizeof(atkbd->name),
851 "AT Set 2 Extra keyboard");
852 else
853 snprintf(atkbd->name, sizeof(atkbd->name),
854 "AT %s Set %d keyboard",
855 atkbd->translated ? "Translated" : "Raw", atkbd->set);
856
857 snprintf(atkbd->phys, sizeof(atkbd->phys),
858 "%s/input0", atkbd->ps2dev.serio->phys);
859
860 input_dev->name = atkbd->name;
861 input_dev->phys = atkbd->phys;
862 input_dev->id.bustype = BUS_I8042;
863 input_dev->id.vendor = 0x0001;
864 input_dev->id.product = atkbd->translated ? 1 : atkbd->set;
865 input_dev->id.version = atkbd->id;
866 input_dev->event = atkbd_event;
867 input_dev->private = atkbd;
868 input_dev->cdev.dev = &atkbd->ps2dev.serio->dev;
869
870 input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_REP) | BIT(EV_MSC);
871
872 if (atkbd->write) {
873 input_dev->evbit[0] |= BIT(EV_LED);
874 input_dev->ledbit[0] = BIT(LED_NUML) | BIT(LED_CAPSL) | BIT(LED_SCROLLL);
875 }
876
877 if (atkbd->extra)
878 input_dev->ledbit[0] |= BIT(LED_COMPOSE) | BIT(LED_SUSPEND) |
879 BIT(LED_SLEEP) | BIT(LED_MUTE) | BIT(LED_MISC);
880
881 if (!atkbd->softrepeat) {
882 input_dev->rep[REP_DELAY] = 250;
883 input_dev->rep[REP_PERIOD] = 33;
884 }
885
886 input_dev->mscbit[0] = atkbd->softraw ? BIT(MSC_SCAN) : BIT(MSC_RAW) | BIT(MSC_SCAN);
887
888 if (atkbd->scroll) {
889 input_dev->evbit[0] |= BIT(EV_REL);
890 input_dev->relbit[0] = BIT(REL_WHEEL) | BIT(REL_HWHEEL);
891 set_bit(BTN_MIDDLE, input_dev->keybit);
892 }
893
894 input_dev->keycode = atkbd->keycode;
895 input_dev->keycodesize = sizeof(unsigned char);
896 input_dev->keycodemax = ARRAY_SIZE(atkbd_set2_keycode);
897
898 for (i = 0; i < 512; i++)
899 if (atkbd->keycode[i] && atkbd->keycode[i] < ATKBD_SPECIAL)
900 set_bit(atkbd->keycode[i], input_dev->keybit);
901 }
902
903 /*
904 * atkbd_connect() is called when the serio module finds an interface
905 * that isn't handled yet by an appropriate device driver. We check if
906 * there is an AT keyboard out there and if yes, we register ourselves
907 * to the input module.
908 */
909
910 static int atkbd_connect(struct serio *serio, struct serio_driver *drv)
911 {
912 struct atkbd *atkbd;
913 struct input_dev *dev;
914 int err = -ENOMEM;
915
916 atkbd = kzalloc(sizeof(struct atkbd), GFP_KERNEL);
917 dev = input_allocate_device();
918 if (!atkbd || !dev)
919 goto fail;
920
921 atkbd->dev = dev;
922 ps2_init(&atkbd->ps2dev, serio);
923 INIT_WORK(&atkbd->event_work, atkbd_event_work, atkbd);
924 mutex_init(&atkbd->event_mutex);
925
926 switch (serio->id.type) {
927
928 case SERIO_8042_XL:
929 atkbd->translated = 1;
930 case SERIO_8042:
931 if (serio->write)
932 atkbd->write = 1;
933 break;
934 }
935
936 atkbd->softraw = atkbd_softraw;
937 atkbd->softrepeat = atkbd_softrepeat;
938 atkbd->scroll = atkbd_scroll;
939
940 if (atkbd->softrepeat)
941 atkbd->softraw = 1;
942
943 serio_set_drvdata(serio, atkbd);
944
945 err = serio_open(serio, drv);
946 if (err)
947 goto fail;
948
949 if (atkbd->write) {
950
951 if (atkbd_probe(atkbd)) {
952 serio_close(serio);
953 err = -ENODEV;
954 goto fail;
955 }
956
957 atkbd->set = atkbd_select_set(atkbd, atkbd_set, atkbd_extra);
958 atkbd_activate(atkbd);
959
960 } else {
961 atkbd->set = 2;
962 atkbd->id = 0xab00;
963 }
964
965 atkbd_set_keycode_table(atkbd);
966 atkbd_set_device_attrs(atkbd);
967
968 device_create_file(&serio->dev, &atkbd_attr_extra);
969 device_create_file(&serio->dev, &atkbd_attr_scroll);
970 device_create_file(&serio->dev, &atkbd_attr_set);
971 device_create_file(&serio->dev, &atkbd_attr_softrepeat);
972 device_create_file(&serio->dev, &atkbd_attr_softraw);
973
974 atkbd_enable(atkbd);
975
976 input_register_device(atkbd->dev);
977
978 return 0;
979
980 fail: serio_set_drvdata(serio, NULL);
981 input_free_device(dev);
982 kfree(atkbd);
983 return err;
984 }
985
986 /*
987 * atkbd_reconnect() tries to restore keyboard into a sane state and is
988 * most likely called on resume.
989 */
990
991 static int atkbd_reconnect(struct serio *serio)
992 {
993 struct atkbd *atkbd = serio_get_drvdata(serio);
994 struct serio_driver *drv = serio->drv;
995
996 if (!atkbd || !drv) {
997 printk(KERN_DEBUG "atkbd: reconnect request, but serio is disconnected, ignoring...\n");
998 return -1;
999 }
1000
1001 atkbd_disable(atkbd);
1002
1003 if (atkbd->write) {
1004 if (atkbd_probe(atkbd))
1005 return -1;
1006 if (atkbd->set != atkbd_select_set(atkbd, atkbd->set, atkbd->extra))
1007 return -1;
1008
1009 atkbd_activate(atkbd);
1010
1011 /*
1012 * Restore repeat rate and LEDs (that were reset by atkbd_activate)
1013 * to pre-resume state
1014 */
1015 if (!atkbd->softrepeat)
1016 atkbd_set_repeat_rate(atkbd);
1017 atkbd_set_leds(atkbd);
1018 }
1019
1020 atkbd_enable(atkbd);
1021
1022 return 0;
1023 }
1024
1025 static struct serio_device_id atkbd_serio_ids[] = {
1026 {
1027 .type = SERIO_8042,
1028 .proto = SERIO_ANY,
1029 .id = SERIO_ANY,
1030 .extra = SERIO_ANY,
1031 },
1032 {
1033 .type = SERIO_8042_XL,
1034 .proto = SERIO_ANY,
1035 .id = SERIO_ANY,
1036 .extra = SERIO_ANY,
1037 },
1038 {
1039 .type = SERIO_RS232,
1040 .proto = SERIO_PS2SER,
1041 .id = SERIO_ANY,
1042 .extra = SERIO_ANY,
1043 },
1044 { 0 }
1045 };
1046
1047 MODULE_DEVICE_TABLE(serio, atkbd_serio_ids);
1048
1049 static struct serio_driver atkbd_drv = {
1050 .driver = {
1051 .name = "atkbd",
1052 },
1053 .description = DRIVER_DESC,
1054 .id_table = atkbd_serio_ids,
1055 .interrupt = atkbd_interrupt,
1056 .connect = atkbd_connect,
1057 .reconnect = atkbd_reconnect,
1058 .disconnect = atkbd_disconnect,
1059 .cleanup = atkbd_cleanup,
1060 };
1061
1062 static ssize_t atkbd_attr_show_helper(struct device *dev, char *buf,
1063 ssize_t (*handler)(struct atkbd *, char *))
1064 {
1065 struct serio *serio = to_serio_port(dev);
1066 int retval;
1067
1068 retval = serio_pin_driver(serio);
1069 if (retval)
1070 return retval;
1071
1072 if (serio->drv != &atkbd_drv) {
1073 retval = -ENODEV;
1074 goto out;
1075 }
1076
1077 retval = handler((struct atkbd *)serio_get_drvdata(serio), buf);
1078
1079 out:
1080 serio_unpin_driver(serio);
1081 return retval;
1082 }
1083
1084 static ssize_t atkbd_attr_set_helper(struct device *dev, const char *buf, size_t count,
1085 ssize_t (*handler)(struct atkbd *, const char *, size_t))
1086 {
1087 struct serio *serio = to_serio_port(dev);
1088 struct atkbd *atkbd;
1089 int retval;
1090
1091 retval = serio_pin_driver(serio);
1092 if (retval)
1093 return retval;
1094
1095 if (serio->drv != &atkbd_drv) {
1096 retval = -ENODEV;
1097 goto out;
1098 }
1099
1100 atkbd = serio_get_drvdata(serio);
1101 atkbd_disable(atkbd);
1102 retval = handler(atkbd, buf, count);
1103 atkbd_enable(atkbd);
1104
1105 out:
1106 serio_unpin_driver(serio);
1107 return retval;
1108 }
1109
1110 static ssize_t atkbd_show_extra(struct atkbd *atkbd, char *buf)
1111 {
1112 return sprintf(buf, "%d\n", atkbd->extra ? 1 : 0);
1113 }
1114
1115 static ssize_t atkbd_set_extra(struct atkbd *atkbd, const char *buf, size_t count)
1116 {
1117 struct input_dev *new_dev;
1118 unsigned long value;
1119 char *rest;
1120
1121 if (!atkbd->write)
1122 return -EIO;
1123
1124 value = simple_strtoul(buf, &rest, 10);
1125 if (*rest || value > 1)
1126 return -EINVAL;
1127
1128 if (atkbd->extra != value) {
1129 /*
1130 * Since device's properties will change we need to
1131 * unregister old device. But allocate new one first
1132 * to make sure we have it.
1133 */
1134 if (!(new_dev = input_allocate_device()))
1135 return -ENOMEM;
1136 input_unregister_device(atkbd->dev);
1137 atkbd->dev = new_dev;
1138 atkbd->set = atkbd_select_set(atkbd, atkbd->set, value);
1139 atkbd_activate(atkbd);
1140 atkbd_set_device_attrs(atkbd);
1141 input_register_device(atkbd->dev);
1142 }
1143 return count;
1144 }
1145
1146 static ssize_t atkbd_show_scroll(struct atkbd *atkbd, char *buf)
1147 {
1148 return sprintf(buf, "%d\n", atkbd->scroll ? 1 : 0);
1149 }
1150
1151 static ssize_t atkbd_set_scroll(struct atkbd *atkbd, const char *buf, size_t count)
1152 {
1153 struct input_dev *new_dev;
1154 unsigned long value;
1155 char *rest;
1156
1157 value = simple_strtoul(buf, &rest, 10);
1158 if (*rest || value > 1)
1159 return -EINVAL;
1160
1161 if (atkbd->scroll != value) {
1162 if (!(new_dev = input_allocate_device()))
1163 return -ENOMEM;
1164 input_unregister_device(atkbd->dev);
1165 atkbd->dev = new_dev;
1166 atkbd->scroll = value;
1167 atkbd_set_keycode_table(atkbd);
1168 atkbd_set_device_attrs(atkbd);
1169 input_register_device(atkbd->dev);
1170 }
1171 return count;
1172 }
1173
1174 static ssize_t atkbd_show_set(struct atkbd *atkbd, char *buf)
1175 {
1176 return sprintf(buf, "%d\n", atkbd->set);
1177 }
1178
1179 static ssize_t atkbd_set_set(struct atkbd *atkbd, const char *buf, size_t count)
1180 {
1181 struct input_dev *new_dev;
1182 unsigned long value;
1183 char *rest;
1184
1185 if (!atkbd->write)
1186 return -EIO;
1187
1188 value = simple_strtoul(buf, &rest, 10);
1189 if (*rest || (value != 2 && value != 3))
1190 return -EINVAL;
1191
1192 if (atkbd->set != value) {
1193 if (!(new_dev = input_allocate_device()))
1194 return -ENOMEM;
1195 input_unregister_device(atkbd->dev);
1196 atkbd->dev = new_dev;
1197 atkbd->set = atkbd_select_set(atkbd, value, atkbd->extra);
1198 atkbd_activate(atkbd);
1199 atkbd_set_keycode_table(atkbd);
1200 atkbd_set_device_attrs(atkbd);
1201 input_register_device(atkbd->dev);
1202 }
1203 return count;
1204 }
1205
1206 static ssize_t atkbd_show_softrepeat(struct atkbd *atkbd, char *buf)
1207 {
1208 return sprintf(buf, "%d\n", atkbd->softrepeat ? 1 : 0);
1209 }
1210
1211 static ssize_t atkbd_set_softrepeat(struct atkbd *atkbd, const char *buf, size_t count)
1212 {
1213 struct input_dev *new_dev;
1214 unsigned long value;
1215 char *rest;
1216
1217 if (!atkbd->write)
1218 return -EIO;
1219
1220 value = simple_strtoul(buf, &rest, 10);
1221 if (*rest || value > 1)
1222 return -EINVAL;
1223
1224 if (atkbd->softrepeat != value) {
1225 if (!(new_dev = input_allocate_device()))
1226 return -ENOMEM;
1227 input_unregister_device(atkbd->dev);
1228 atkbd->dev = new_dev;
1229 atkbd->softrepeat = value;
1230 if (atkbd->softrepeat)
1231 atkbd->softraw = 1;
1232 atkbd_set_device_attrs(atkbd);
1233 input_register_device(atkbd->dev);
1234 }
1235 return count;
1236 }
1237
1238
1239 static ssize_t atkbd_show_softraw(struct atkbd *atkbd, char *buf)
1240 {
1241 return sprintf(buf, "%d\n", atkbd->softraw ? 1 : 0);
1242 }
1243
1244 static ssize_t atkbd_set_softraw(struct atkbd *atkbd, const char *buf, size_t count)
1245 {
1246 struct input_dev *new_dev;
1247 unsigned long value;
1248 char *rest;
1249
1250 value = simple_strtoul(buf, &rest, 10);
1251 if (*rest || value > 1)
1252 return -EINVAL;
1253
1254 if (atkbd->softraw != value) {
1255 if (!(new_dev = input_allocate_device()))
1256 return -ENOMEM;
1257 input_unregister_device(atkbd->dev);
1258 atkbd->dev = new_dev;
1259 atkbd->softraw = value;
1260 atkbd_set_device_attrs(atkbd);
1261 input_register_device(atkbd->dev);
1262 }
1263 return count;
1264 }
1265
1266
1267 static int __init atkbd_init(void)
1268 {
1269 serio_register_driver(&atkbd_drv);
1270 return 0;
1271 }
1272
1273 static void __exit atkbd_exit(void)
1274 {
1275 serio_unregister_driver(&atkbd_drv);
1276 }
1277
1278 module_init(atkbd_init);
1279 module_exit(atkbd_exit);
This page took 0.083196 seconds and 5 git commands to generate.