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 /* 486 * atkbd_event_work() is used to complete processing of events that 487 * can not be processed by input_event() which is often called from 488 * interrupt context. 489 */ 490 491 static void atkbd_event_work(void *data) 492 { 493 const short period[32] = 494 { 33, 37, 42, 46, 50, 54, 58, 63, 67, 75, 83, 92, 100, 109, 116, 125, 495 133, 149, 167, 182, 200, 217, 232, 250, 270, 303, 333, 370, 400, 435, 470, 500 }; 496 const short delay[4] = 497 { 250, 500, 750, 1000 }; 498 499 struct atkbd *atkbd = data; 500 struct input_dev *dev = atkbd->dev; 501 unsigned char param[2]; 502 int i, j; 503 504 mutex_lock(&atkbd->event_mutex); 505 506 if (test_and_clear_bit(ATKBD_LED_EVENT_BIT, &atkbd->event_mask)) { 507 param[0] = (test_bit(LED_SCROLLL, dev->led) ? 1 : 0) 508 | (test_bit(LED_NUML, dev->led) ? 2 : 0) 509 | (test_bit(LED_CAPSL, dev->led) ? 4 : 0); 510 ps2_command(&atkbd->ps2dev, param, ATKBD_CMD_SETLEDS); 511 512 if (atkbd->extra) { 513 param[0] = 0; 514 param[1] = (test_bit(LED_COMPOSE, dev->led) ? 0x01 : 0) 515 | (test_bit(LED_SLEEP, dev->led) ? 0x02 : 0) 516 | (test_bit(LED_SUSPEND, dev->led) ? 0x04 : 0) 517 | (test_bit(LED_MISC, dev->led) ? 0x10 : 0) 518 | (test_bit(LED_MUTE, dev->led) ? 0x20 : 0); 519 ps2_command(&atkbd->ps2dev, param, ATKBD_CMD_EX_SETLEDS); 520 } 521 } 522 523 if (test_and_clear_bit(ATKBD_REP_EVENT_BIT, &atkbd->event_mask)) { 524 i = j = 0; 525 while (i < 31 && period[i] < dev->rep[REP_PERIOD]) 526 i++; 527 while (j < 3 && delay[j] < dev->rep[REP_DELAY]) 528 j++; 529 dev->rep[REP_PERIOD] = period[i]; 530 dev->rep[REP_DELAY] = delay[j]; 531 param[0] = i | (j << 5); 532 ps2_command(&atkbd->ps2dev, param, ATKBD_CMD_SETREP); 533 } 534 535 mutex_unlock(&atkbd->event_mutex); 536 } 537 538 /* 539 * Event callback from the input module. Events that change the state of 540 * the hardware are processed here. If action can not be performed in 541 * interrupt context it is offloaded to atkbd_event_work. 542 */ 543 544 static int atkbd_event(struct input_dev *dev, unsigned int type, unsigned int code, int value) 545 { 546 struct atkbd *atkbd = dev->private; 547 548 if (!atkbd->write) 549 return -1; 550 551 switch (type) { 552 553 case EV_LED: 554 set_bit(ATKBD_LED_EVENT_BIT, &atkbd->event_mask); 555 wmb(); 556 schedule_work(&atkbd->event_work); 557 return 0; 558 559 case EV_REP: 560 561 if (!atkbd->softrepeat) { 562 set_bit(ATKBD_REP_EVENT_BIT, &atkbd->event_mask); 563 wmb(); 564 schedule_work(&atkbd->event_work); 565 } 566 567 return 0; 568 } 569 570 return -1; 571 } 572 573 /* 574 * atkbd_enable() signals that interrupt handler is allowed to 575 * generate input events. 576 */ 577 578 static inline void atkbd_enable(struct atkbd *atkbd) 579 { 580 serio_pause_rx(atkbd->ps2dev.serio); 581 atkbd->enabled = 1; 582 serio_continue_rx(atkbd->ps2dev.serio); 583 } 584 585 /* 586 * atkbd_disable() tells input handler that all incoming data except 587 * for ACKs and command response should be dropped. 588 */ 589 590 static inline void atkbd_disable(struct atkbd *atkbd) 591 { 592 serio_pause_rx(atkbd->ps2dev.serio); 593 atkbd->enabled = 0; 594 serio_continue_rx(atkbd->ps2dev.serio); 595 } 596 597 /* 598 * atkbd_probe() probes for an AT keyboard on a serio port. 599 */ 600 601 static int atkbd_probe(struct atkbd *atkbd) 602 { 603 struct ps2dev *ps2dev = &atkbd->ps2dev; 604 unsigned char param[2]; 605 606 /* 607 * Some systems, where the bit-twiddling when testing the io-lines of the 608 * controller may confuse the keyboard need a full reset of the keyboard. On 609 * these systems the BIOS also usually doesn't do it for us. 610 */ 611 612 if (atkbd_reset) 613 if (ps2_command(ps2dev, NULL, ATKBD_CMD_RESET_BAT)) 614 printk(KERN_WARNING "atkbd.c: keyboard reset failed on %s\n", ps2dev->serio->phys); 615 616 /* 617 * Then we check the keyboard ID. We should get 0xab83 under normal conditions. 618 * Some keyboards report different values, but the first byte is always 0xab or 619 * 0xac. Some old AT keyboards don't report anything. If a mouse is connected, this 620 * should make sure we don't try to set the LEDs on it. 621 */ 622 623 param[0] = param[1] = 0xa5; /* initialize with invalid values */ 624 if (ps2_command(ps2dev, param, ATKBD_CMD_GETID)) { 625 626 /* 627 * If the get ID command failed, we check if we can at least set the LEDs on 628 * the keyboard. This should work on every keyboard out there. It also turns 629 * the LEDs off, which we want anyway. 630 */ 631 param[0] = 0; 632 if (ps2_command(ps2dev, param, ATKBD_CMD_SETLEDS)) 633 return -1; 634 atkbd->id = 0xabba; 635 return 0; 636 } 637 638 if (param[0] != 0xab && param[0] != 0xac && /* Regular and NCD Sun keyboards */ 639 param[0] != 0x2b && param[0] != 0x5d && /* Trust keyboard, raw and translated */ 640 param[0] != 0x60 && param[0] != 0x47) /* NMB SGI keyboard, raw and translated */ 641 return -1; 642 643 atkbd->id = (param[0] << 8) | param[1]; 644 645 if (atkbd->id == 0xaca1 && atkbd->translated) { 646 printk(KERN_ERR "atkbd.c: NCD terminal keyboards are only supported on non-translating\n"); 647 printk(KERN_ERR "atkbd.c: controllers. Use i8042.direct=1 to disable translation.\n"); 648 return -1; 649 } 650 651 return 0; 652 } 653 654 /* 655 * atkbd_select_set checks if a keyboard has a working Set 3 support, and 656 * sets it into that. Unfortunately there are keyboards that can be switched 657 * to Set 3, but don't work well in that (BTC Multimedia ...) 658 */ 659 660 static int atkbd_select_set(struct atkbd *atkbd, int target_set, int allow_extra) 661 { 662 struct ps2dev *ps2dev = &atkbd->ps2dev; 663 unsigned char param[2]; 664 665 atkbd->extra = 0; 666 /* 667 * For known special keyboards we can go ahead and set the correct set. 668 * We check for NCD PS/2 Sun, NorthGate OmniKey 101 and 669 * IBM RapidAccess / IBM EzButton / Chicony KBP-8993 keyboards. 670 */ 671 672 if (atkbd->translated) 673 return 2; 674 675 if (atkbd->id == 0xaca1) { 676 param[0] = 3; 677 ps2_command(ps2dev, param, ATKBD_CMD_SSCANSET); 678 return 3; 679 } 680 681 if (allow_extra) { 682 param[0] = 0x71; 683 if (!ps2_command(ps2dev, param, ATKBD_CMD_EX_ENABLE)) { 684 atkbd->extra = 1; 685 return 2; 686 } 687 } 688 689 if (target_set != 3) 690 return 2; 691 692 if (!ps2_command(ps2dev, param, ATKBD_CMD_OK_GETID)) { 693 atkbd->id = param[0] << 8 | param[1]; 694 return 2; 695 } 696 697 param[0] = 3; 698 if (ps2_command(ps2dev, param, ATKBD_CMD_SSCANSET)) 699 return 2; 700 701 param[0] = 0; 702 if (ps2_command(ps2dev, param, ATKBD_CMD_GSCANSET)) 703 return 2; 704 705 if (param[0] != 3) { 706 param[0] = 2; 707 if (ps2_command(ps2dev, param, ATKBD_CMD_SSCANSET)) 708 return 2; 709 } 710 711 ps2_command(ps2dev, param, ATKBD_CMD_SETALL_MBR); 712 713 return 3; 714 } 715 716 static int atkbd_activate(struct atkbd *atkbd) 717 { 718 struct ps2dev *ps2dev = &atkbd->ps2dev; 719 unsigned char param[1]; 720 721 /* 722 * Set the LEDs to a defined state. 723 */ 724 725 param[0] = 0; 726 if (ps2_command(ps2dev, param, ATKBD_CMD_SETLEDS)) 727 return -1; 728 729 /* 730 * Set autorepeat to fastest possible. 731 */ 732 733 param[0] = 0; 734 if (ps2_command(ps2dev, param, ATKBD_CMD_SETREP)) 735 return -1; 736 737 /* 738 * Enable the keyboard to receive keystrokes. 739 */ 740 741 if (ps2_command(ps2dev, NULL, ATKBD_CMD_ENABLE)) { 742 printk(KERN_ERR "atkbd.c: Failed to enable keyboard on %s\n", 743 ps2dev->serio->phys); 744 return -1; 745 } 746 747 return 0; 748 } 749 750 /* 751 * atkbd_cleanup() restores the keyboard state so that BIOS is happy after a 752 * reboot. 753 */ 754 755 static void atkbd_cleanup(struct serio *serio) 756 { 757 struct atkbd *atkbd = serio_get_drvdata(serio); 758 ps2_command(&atkbd->ps2dev, NULL, ATKBD_CMD_RESET_BAT); 759 } 760 761 762 /* 763 * atkbd_disconnect() closes and frees. 764 */ 765 766 static void atkbd_disconnect(struct serio *serio) 767 { 768 struct atkbd *atkbd = serio_get_drvdata(serio); 769 770 atkbd_disable(atkbd); 771 772 /* make sure we don't have a command in flight */ 773 synchronize_sched(); /* Allow atkbd_interrupt()s to complete. */ 774 flush_scheduled_work(); 775 776 device_remove_file(&serio->dev, &atkbd_attr_extra); 777 device_remove_file(&serio->dev, &atkbd_attr_scroll); 778 device_remove_file(&serio->dev, &atkbd_attr_set); 779 device_remove_file(&serio->dev, &atkbd_attr_softrepeat); 780 device_remove_file(&serio->dev, &atkbd_attr_softraw); 781 782 input_unregister_device(atkbd->dev); 783 serio_close(serio); 784 serio_set_drvdata(serio, NULL); 785 kfree(atkbd); 786 } 787 788 789 /* 790 * atkbd_set_keycode_table() initializes keyboard's keycode table 791 * according to the selected scancode set 792 */ 793 794 static void atkbd_set_keycode_table(struct atkbd *atkbd) 795 { 796 int i, j; 797 798 memset(atkbd->keycode, 0, sizeof(atkbd->keycode)); 799 800 if (atkbd->translated) { 801 for (i = 0; i < 128; i++) { 802 atkbd->keycode[i] = atkbd_set2_keycode[atkbd_unxlate_table[i]]; 803 atkbd->keycode[i | 0x80] = atkbd_set2_keycode[atkbd_unxlate_table[i] | 0x80]; 804 if (atkbd->scroll) 805 for (j = 0; j < ARRAY_SIZE(atkbd_scroll_keys); j++) 806 if ((atkbd_unxlate_table[i] | 0x80) == atkbd_scroll_keys[j].set2) 807 atkbd->keycode[i | 0x80] = atkbd_scroll_keys[j].keycode; 808 } 809 } else if (atkbd->set == 3) { 810 memcpy(atkbd->keycode, atkbd_set3_keycode, sizeof(atkbd->keycode)); 811 } else { 812 memcpy(atkbd->keycode, atkbd_set2_keycode, sizeof(atkbd->keycode)); 813 814 if (atkbd->scroll) 815 for (i = 0; i < ARRAY_SIZE(atkbd_scroll_keys); i++) 816 atkbd->keycode[atkbd_scroll_keys[i].set2] = atkbd_scroll_keys[i].keycode; 817 } 818 819 atkbd->keycode[atkbd_compat_scancode(atkbd, ATKBD_RET_HANGEUL)] = KEY_HANGUEL; 820 atkbd->keycode[atkbd_compat_scancode(atkbd, ATKBD_RET_HANJA)] = KEY_HANJA; 821 } 822 823 /* 824 * atkbd_set_device_attrs() sets up keyboard's input device structure 825 */ 826 827 static void atkbd_set_device_attrs(struct atkbd *atkbd) 828 { 829 struct input_dev *input_dev = atkbd->dev; 830 int i; 831 832 if (atkbd->extra) 833 snprintf(atkbd->name, sizeof(atkbd->name), 834 "AT Set 2 Extra keyboard"); 835 else 836 snprintf(atkbd->name, sizeof(atkbd->name), 837 "AT %s Set %d keyboard", 838 atkbd->translated ? "Translated" : "Raw", atkbd->set); 839 840 snprintf(atkbd->phys, sizeof(atkbd->phys), 841 "%s/input0", atkbd->ps2dev.serio->phys); 842 843 input_dev->name = atkbd->name; 844 input_dev->phys = atkbd->phys; 845 input_dev->id.bustype = BUS_I8042; 846 input_dev->id.vendor = 0x0001; 847 input_dev->id.product = atkbd->translated ? 1 : atkbd->set; 848 input_dev->id.version = atkbd->id; 849 input_dev->event = atkbd_event; 850 input_dev->private = atkbd; 851 input_dev->cdev.dev = &atkbd->ps2dev.serio->dev; 852 853 input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_REP) | BIT(EV_MSC); 854 855 if (atkbd->write) { 856 input_dev->evbit[0] |= BIT(EV_LED); 857 input_dev->ledbit[0] = BIT(LED_NUML) | BIT(LED_CAPSL) | BIT(LED_SCROLLL); 858 } 859 860 if (atkbd->extra) 861 input_dev->ledbit[0] |= BIT(LED_COMPOSE) | BIT(LED_SUSPEND) | 862 BIT(LED_SLEEP) | BIT(LED_MUTE) | BIT(LED_MISC); 863 864 if (!atkbd->softrepeat) { 865 input_dev->rep[REP_DELAY] = 250; 866 input_dev->rep[REP_PERIOD] = 33; 867 } 868 869 input_dev->mscbit[0] = atkbd->softraw ? BIT(MSC_SCAN) : BIT(MSC_RAW) | BIT(MSC_SCAN); 870 871 if (atkbd->scroll) { 872 input_dev->evbit[0] |= BIT(EV_REL); 873 input_dev->relbit[0] = BIT(REL_WHEEL) | BIT(REL_HWHEEL); 874 set_bit(BTN_MIDDLE, input_dev->keybit); 875 } 876 877 input_dev->keycode = atkbd->keycode; 878 input_dev->keycodesize = sizeof(unsigned char); 879 input_dev->keycodemax = ARRAY_SIZE(atkbd_set2_keycode); 880 881 for (i = 0; i < 512; i++) 882 if (atkbd->keycode[i] && atkbd->keycode[i] < ATKBD_SPECIAL) 883 set_bit(atkbd->keycode[i], input_dev->keybit); 884 } 885 886 /* 887 * atkbd_connect() is called when the serio module finds an interface 888 * that isn't handled yet by an appropriate device driver. We check if 889 * there is an AT keyboard out there and if yes, we register ourselves 890 * to the input module. 891 */ 892 893 static int atkbd_connect(struct serio *serio, struct serio_driver *drv) 894 { 895 struct atkbd *atkbd; 896 struct input_dev *dev; 897 int err = -ENOMEM; 898 899 atkbd = kzalloc(sizeof(struct atkbd), GFP_KERNEL); 900 dev = input_allocate_device(); 901 if (!atkbd || !dev) 902 goto fail; 903 904 atkbd->dev = dev; 905 ps2_init(&atkbd->ps2dev, serio); 906 INIT_WORK(&atkbd->event_work, atkbd_event_work, atkbd); 907 mutex_init(&atkbd->event_mutex); 908 909 switch (serio->id.type) { 910 911 case SERIO_8042_XL: 912 atkbd->translated = 1; 913 case SERIO_8042: 914 if (serio->write) 915 atkbd->write = 1; 916 break; 917 } 918 919 atkbd->softraw = atkbd_softraw; 920 atkbd->softrepeat = atkbd_softrepeat; 921 atkbd->scroll = atkbd_scroll; 922 923 if (atkbd->softrepeat) 924 atkbd->softraw = 1; 925 926 serio_set_drvdata(serio, atkbd); 927 928 err = serio_open(serio, drv); 929 if (err) 930 goto fail; 931 932 if (atkbd->write) { 933 934 if (atkbd_probe(atkbd)) { 935 serio_close(serio); 936 err = -ENODEV; 937 goto fail; 938 } 939 940 atkbd->set = atkbd_select_set(atkbd, atkbd_set, atkbd_extra); 941 atkbd_activate(atkbd); 942 943 } else { 944 atkbd->set = 2; 945 atkbd->id = 0xab00; 946 } 947 948 atkbd_set_keycode_table(atkbd); 949 atkbd_set_device_attrs(atkbd); 950 951 device_create_file(&serio->dev, &atkbd_attr_extra); 952 device_create_file(&serio->dev, &atkbd_attr_scroll); 953 device_create_file(&serio->dev, &atkbd_attr_set); 954 device_create_file(&serio->dev, &atkbd_attr_softrepeat); 955 device_create_file(&serio->dev, &atkbd_attr_softraw); 956 957 atkbd_enable(atkbd); 958 959 input_register_device(atkbd->dev); 960 961 return 0; 962 963 fail: serio_set_drvdata(serio, NULL); 964 input_free_device(dev); 965 kfree(atkbd); 966 return err; 967 } 968 969 /* 970 * atkbd_reconnect() tries to restore keyboard into a sane state and is 971 * most likely called on resume. 972 */ 973 974 static int atkbd_reconnect(struct serio *serio) 975 { 976 struct atkbd *atkbd = serio_get_drvdata(serio); 977 struct serio_driver *drv = serio->drv; 978 unsigned char param[1]; 979 980 if (!atkbd || !drv) { 981 printk(KERN_DEBUG "atkbd: reconnect request, but serio is disconnected, ignoring...\n"); 982 return -1; 983 } 984 985 atkbd_disable(atkbd); 986 987 if (atkbd->write) { 988 param[0] = (test_bit(LED_SCROLLL, atkbd->dev->led) ? 1 : 0) 989 | (test_bit(LED_NUML, atkbd->dev->led) ? 2 : 0) 990 | (test_bit(LED_CAPSL, atkbd->dev->led) ? 4 : 0); 991 992 if (atkbd_probe(atkbd)) 993 return -1; 994 if (atkbd->set != atkbd_select_set(atkbd, atkbd->set, atkbd->extra)) 995 return -1; 996 997 atkbd_activate(atkbd); 998 999 if (ps2_command(&atkbd->ps2dev, param, ATKBD_CMD_SETLEDS)) 1000 return -1; 1001 } 1002 1003 atkbd_enable(atkbd); 1004 1005 return 0; 1006 } 1007 1008 static struct serio_device_id atkbd_serio_ids[] = { 1009 { 1010 .type = SERIO_8042, 1011 .proto = SERIO_ANY, 1012 .id = SERIO_ANY, 1013 .extra = SERIO_ANY, 1014 }, 1015 { 1016 .type = SERIO_8042_XL, 1017 .proto = SERIO_ANY, 1018 .id = SERIO_ANY, 1019 .extra = SERIO_ANY, 1020 }, 1021 { 1022 .type = SERIO_RS232, 1023 .proto = SERIO_PS2SER, 1024 .id = SERIO_ANY, 1025 .extra = SERIO_ANY, 1026 }, 1027 { 0 } 1028 }; 1029 1030 MODULE_DEVICE_TABLE(serio, atkbd_serio_ids); 1031 1032 static struct serio_driver atkbd_drv = { 1033 .driver = { 1034 .name = "atkbd", 1035 }, 1036 .description = DRIVER_DESC, 1037 .id_table = atkbd_serio_ids, 1038 .interrupt = atkbd_interrupt, 1039 .connect = atkbd_connect, 1040 .reconnect = atkbd_reconnect, 1041 .disconnect = atkbd_disconnect, 1042 .cleanup = atkbd_cleanup, 1043 }; 1044 1045 static ssize_t atkbd_attr_show_helper(struct device *dev, char *buf, 1046 ssize_t (*handler)(struct atkbd *, char *)) 1047 { 1048 struct serio *serio = to_serio_port(dev); 1049 int retval; 1050 1051 retval = serio_pin_driver(serio); 1052 if (retval) 1053 return retval; 1054 1055 if (serio->drv != &atkbd_drv) { 1056 retval = -ENODEV; 1057 goto out; 1058 } 1059 1060 retval = handler((struct atkbd *)serio_get_drvdata(serio), buf); 1061 1062 out: 1063 serio_unpin_driver(serio); 1064 return retval; 1065 } 1066 1067 static ssize_t atkbd_attr_set_helper(struct device *dev, const char *buf, size_t count, 1068 ssize_t (*handler)(struct atkbd *, const char *, size_t)) 1069 { 1070 struct serio *serio = to_serio_port(dev); 1071 struct atkbd *atkbd; 1072 int retval; 1073 1074 retval = serio_pin_driver(serio); 1075 if (retval) 1076 return retval; 1077 1078 if (serio->drv != &atkbd_drv) { 1079 retval = -ENODEV; 1080 goto out; 1081 } 1082 1083 atkbd = serio_get_drvdata(serio); 1084 atkbd_disable(atkbd); 1085 retval = handler(atkbd, buf, count); 1086 atkbd_enable(atkbd); 1087 1088 out: 1089 serio_unpin_driver(serio); 1090 return retval; 1091 } 1092 1093 static ssize_t atkbd_show_extra(struct atkbd *atkbd, char *buf) 1094 { 1095 return sprintf(buf, "%d\n", atkbd->extra ? 1 : 0); 1096 } 1097 1098 static ssize_t atkbd_set_extra(struct atkbd *atkbd, const char *buf, size_t count) 1099 { 1100 struct input_dev *new_dev; 1101 unsigned long value; 1102 char *rest; 1103 1104 if (!atkbd->write) 1105 return -EIO; 1106 1107 value = simple_strtoul(buf, &rest, 10); 1108 if (*rest || value > 1) 1109 return -EINVAL; 1110 1111 if (atkbd->extra != value) { 1112 /* 1113 * Since device's properties will change we need to 1114 * unregister old device. But allocate new one first 1115 * to make sure we have it. 1116 */ 1117 if (!(new_dev = input_allocate_device())) 1118 return -ENOMEM; 1119 input_unregister_device(atkbd->dev); 1120 atkbd->dev = new_dev; 1121 atkbd->set = atkbd_select_set(atkbd, atkbd->set, value); 1122 atkbd_activate(atkbd); 1123 atkbd_set_device_attrs(atkbd); 1124 input_register_device(atkbd->dev); 1125 } 1126 return count; 1127 } 1128 1129 static ssize_t atkbd_show_scroll(struct atkbd *atkbd, char *buf) 1130 { 1131 return sprintf(buf, "%d\n", atkbd->scroll ? 1 : 0); 1132 } 1133 1134 static ssize_t atkbd_set_scroll(struct atkbd *atkbd, const char *buf, size_t count) 1135 { 1136 struct input_dev *new_dev; 1137 unsigned long value; 1138 char *rest; 1139 1140 value = simple_strtoul(buf, &rest, 10); 1141 if (*rest || value > 1) 1142 return -EINVAL; 1143 1144 if (atkbd->scroll != value) { 1145 if (!(new_dev = input_allocate_device())) 1146 return -ENOMEM; 1147 input_unregister_device(atkbd->dev); 1148 atkbd->dev = new_dev; 1149 atkbd->scroll = value; 1150 atkbd_set_keycode_table(atkbd); 1151 atkbd_set_device_attrs(atkbd); 1152 input_register_device(atkbd->dev); 1153 } 1154 return count; 1155 } 1156 1157 static ssize_t atkbd_show_set(struct atkbd *atkbd, char *buf) 1158 { 1159 return sprintf(buf, "%d\n", atkbd->set); 1160 } 1161 1162 static ssize_t atkbd_set_set(struct atkbd *atkbd, const char *buf, size_t count) 1163 { 1164 struct input_dev *new_dev; 1165 unsigned long value; 1166 char *rest; 1167 1168 if (!atkbd->write) 1169 return -EIO; 1170 1171 value = simple_strtoul(buf, &rest, 10); 1172 if (*rest || (value != 2 && value != 3)) 1173 return -EINVAL; 1174 1175 if (atkbd->set != value) { 1176 if (!(new_dev = input_allocate_device())) 1177 return -ENOMEM; 1178 input_unregister_device(atkbd->dev); 1179 atkbd->dev = new_dev; 1180 atkbd->set = atkbd_select_set(atkbd, value, atkbd->extra); 1181 atkbd_activate(atkbd); 1182 atkbd_set_keycode_table(atkbd); 1183 atkbd_set_device_attrs(atkbd); 1184 input_register_device(atkbd->dev); 1185 } 1186 return count; 1187 } 1188 1189 static ssize_t atkbd_show_softrepeat(struct atkbd *atkbd, char *buf) 1190 { 1191 return sprintf(buf, "%d\n", atkbd->softrepeat ? 1 : 0); 1192 } 1193 1194 static ssize_t atkbd_set_softrepeat(struct atkbd *atkbd, const char *buf, size_t count) 1195 { 1196 struct input_dev *new_dev; 1197 unsigned long value; 1198 char *rest; 1199 1200 if (!atkbd->write) 1201 return -EIO; 1202 1203 value = simple_strtoul(buf, &rest, 10); 1204 if (*rest || value > 1) 1205 return -EINVAL; 1206 1207 if (atkbd->softrepeat != value) { 1208 if (!(new_dev = input_allocate_device())) 1209 return -ENOMEM; 1210 input_unregister_device(atkbd->dev); 1211 atkbd->dev = new_dev; 1212 atkbd->softrepeat = value; 1213 if (atkbd->softrepeat) 1214 atkbd->softraw = 1; 1215 atkbd_set_device_attrs(atkbd); 1216 input_register_device(atkbd->dev); 1217 } 1218 return count; 1219 } 1220 1221 1222 static ssize_t atkbd_show_softraw(struct atkbd *atkbd, char *buf) 1223 { 1224 return sprintf(buf, "%d\n", atkbd->softraw ? 1 : 0); 1225 } 1226 1227 static ssize_t atkbd_set_softraw(struct atkbd *atkbd, const char *buf, size_t count) 1228 { 1229 struct input_dev *new_dev; 1230 unsigned long value; 1231 char *rest; 1232 1233 value = simple_strtoul(buf, &rest, 10); 1234 if (*rest || value > 1) 1235 return -EINVAL; 1236 1237 if (atkbd->softraw != value) { 1238 if (!(new_dev = input_allocate_device())) 1239 return -ENOMEM; 1240 input_unregister_device(atkbd->dev); 1241 atkbd->dev = new_dev; 1242 atkbd->softraw = value; 1243 atkbd_set_device_attrs(atkbd); 1244 input_register_device(atkbd->dev); 1245 } 1246 return count; 1247 } 1248 1249 1250 static int __init atkbd_init(void) 1251 { 1252 serio_register_driver(&atkbd_drv); 1253 return 0; 1254 } 1255 1256 static void __exit atkbd_exit(void) 1257 { 1258 serio_unregister_driver(&atkbd_drv); 1259 } 1260 1261 module_init(atkbd_init); 1262 module_exit(atkbd_exit); 1263