1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 1999 Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp> 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer as 12 * the first lines of this file unmodified. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR 18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, 21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 * 28 */ 29 30 #include <sys/cdefs.h> 31 __FBSDID("$FreeBSD$"); 32 33 #include "opt_kbd.h" 34 #include "opt_atkbd.h" 35 #include "opt_evdev.h" 36 37 #include <sys/param.h> 38 #include <sys/systm.h> 39 #include <sys/kernel.h> 40 #include <sys/bus.h> 41 #include <sys/eventhandler.h> 42 #include <sys/proc.h> 43 #include <sys/limits.h> 44 #include <sys/malloc.h> 45 #include <sys/sysctl.h> 46 47 #include <machine/bus.h> 48 #include <machine/resource.h> 49 50 #include <sys/kbio.h> 51 #include <dev/kbd/kbdreg.h> 52 #include <dev/atkbdc/atkbdreg.h> 53 #include <dev/atkbdc/atkbdcreg.h> 54 55 #ifdef EVDEV_SUPPORT 56 #include <dev/evdev/evdev.h> 57 #include <dev/evdev/input.h> 58 #endif 59 60 typedef struct atkbd_state { 61 KBDC kbdc; /* keyboard controller */ 62 int ks_mode; /* input mode (K_XLATE,K_RAW,K_CODE) */ 63 int ks_flags; /* flags */ 64 #define COMPOSE (1 << 0) 65 int ks_polling; 66 int ks_state; /* shift/lock key state */ 67 int ks_accents; /* accent key index (> 0) */ 68 u_int ks_composed_char; /* composed char code (> 0) */ 69 u_char ks_prefix; /* AT scan code prefix */ 70 struct callout ks_timer; 71 #ifdef EVDEV_SUPPORT 72 struct evdev_dev *ks_evdev; 73 int ks_evdev_state; 74 #endif 75 } atkbd_state_t; 76 77 static SYSCTL_NODE(_hw, OID_AUTO, atkbd, CTLFLAG_RD | CTLFLAG_MPSAFE, 0, 78 "AT keyboard"); 79 80 static int atkbdhz = 0; 81 SYSCTL_INT(_hw_atkbd, OID_AUTO, hz, CTLFLAG_RWTUN, &atkbdhz, 0, 82 "Polling frequency (in hz)"); 83 84 static void atkbd_timeout(void *arg); 85 static int atkbd_reset(KBDC kbdc, int flags, int c); 86 87 #define HAS_QUIRK(p, q) (((atkbdc_softc_t *)(p))->quirks & q) 88 #define ALLOW_DISABLE_KBD(kbdc) !HAS_QUIRK(kbdc, KBDC_QUIRK_KEEP_ACTIVATED) 89 90 #define DEFAULT_DELAY 0x1 /* 500ms */ 91 #define DEFAULT_RATE 0x10 /* 14Hz */ 92 93 #ifdef EVDEV_SUPPORT 94 #define PS2_KEYBOARD_VENDOR 1 95 #define PS2_KEYBOARD_PRODUCT 1 96 #endif 97 98 int 99 atkbd_probe_unit(device_t dev, int irq, int flags) 100 { 101 keyboard_switch_t *sw; 102 int args[2]; 103 int error; 104 105 sw = kbd_get_switch(ATKBD_DRIVER_NAME); 106 if (sw == NULL) 107 return ENXIO; 108 109 args[0] = device_get_unit(device_get_parent(dev)); 110 args[1] = irq; 111 error = (*sw->probe)(device_get_unit(dev), args, flags); 112 if (error) 113 return error; 114 return 0; 115 } 116 117 int 118 atkbd_attach_unit(device_t dev, keyboard_t **kbd, int irq, int flags) 119 { 120 keyboard_switch_t *sw; 121 atkbd_state_t *state; 122 int args[2]; 123 int error; 124 int unit; 125 126 sw = kbd_get_switch(ATKBD_DRIVER_NAME); 127 if (sw == NULL) 128 return ENXIO; 129 130 /* reset, initialize and enable the device */ 131 unit = device_get_unit(dev); 132 args[0] = device_get_unit(device_get_parent(dev)); 133 args[1] = irq; 134 *kbd = NULL; 135 error = (*sw->probe)(unit, args, flags); 136 if (error) 137 return error; 138 error = (*sw->init)(unit, kbd, args, flags); 139 if (error) 140 return error; 141 (*sw->enable)(*kbd); 142 143 #ifdef KBD_INSTALL_CDEV 144 /* attach a virtual keyboard cdev */ 145 error = kbd_attach(*kbd); 146 if (error) 147 return error; 148 #endif 149 150 /* 151 * This is a kludge to compensate for lost keyboard interrupts. 152 * A similar code used to be in syscons. See below. XXX 153 */ 154 state = (atkbd_state_t *)(*kbd)->kb_data; 155 callout_init(&state->ks_timer, 0); 156 atkbd_timeout(*kbd); 157 158 if (bootverbose) 159 (*sw->diag)(*kbd, bootverbose); 160 161 return 0; 162 } 163 164 static void 165 atkbd_timeout(void *arg) 166 { 167 atkbd_state_t *state; 168 keyboard_t *kbd; 169 int s; 170 171 /* 172 * The original text of the following comments are extracted 173 * from syscons.c (1.287) 174 * 175 * With release 2.1 of the Xaccel server, the keyboard is left 176 * hanging pretty often. Apparently an interrupt from the 177 * keyboard is lost, and I don't know why (yet). 178 * This ugly hack calls the low-level interrupt routine if input 179 * is ready for the keyboard and conveniently hides the problem. XXX 180 * 181 * Try removing anything stuck in the keyboard controller; whether 182 * it's a keyboard scan code or mouse data. The low-level 183 * interrupt routine doesn't read the mouse data directly, 184 * but the keyboard controller driver will, as a side effect. 185 */ 186 /* 187 * And here is bde's original comment about this: 188 * 189 * This is necessary to handle edge triggered interrupts - if we 190 * returned when our IRQ is high due to unserviced input, then there 191 * would be no more keyboard IRQs until the keyboard is reset by 192 * external powers. 193 * 194 * The keyboard apparently unwedges the irq in most cases. 195 */ 196 s = spltty(); 197 kbd = (keyboard_t *)arg; 198 if (kbdd_lock(kbd, TRUE)) { 199 /* 200 * We have seen the lock flag is not set. Let's reset 201 * the flag early, otherwise the LED update routine fails 202 * which may want the lock during the interrupt routine. 203 */ 204 kbdd_lock(kbd, FALSE); 205 if (kbdd_check_char(kbd)) 206 kbdd_intr(kbd, NULL); 207 } 208 splx(s); 209 if (atkbdhz > 0) { 210 state = (atkbd_state_t *)kbd->kb_data; 211 callout_reset_sbt(&state->ks_timer, SBT_1S / atkbdhz, 0, 212 atkbd_timeout, arg, C_PREL(1)); 213 } 214 } 215 216 /* LOW-LEVEL */ 217 218 #define ATKBD_DEFAULT 0 219 220 /* keyboard driver declaration */ 221 static int atkbd_configure(int flags); 222 static kbd_probe_t atkbd_probe; 223 static kbd_init_t atkbd_init; 224 static kbd_term_t atkbd_term; 225 static kbd_intr_t atkbd_intr; 226 static kbd_test_if_t atkbd_test_if; 227 static kbd_enable_t atkbd_enable; 228 static kbd_disable_t atkbd_disable; 229 static kbd_read_t atkbd_read; 230 static kbd_check_t atkbd_check; 231 static kbd_read_char_t atkbd_read_char; 232 static kbd_check_char_t atkbd_check_char; 233 static kbd_ioctl_t atkbd_ioctl; 234 static kbd_lock_t atkbd_lock; 235 static kbd_clear_state_t atkbd_clear_state; 236 static kbd_get_state_t atkbd_get_state; 237 static kbd_set_state_t atkbd_set_state; 238 static kbd_poll_mode_t atkbd_poll; 239 240 static keyboard_switch_t atkbdsw = { 241 .probe = atkbd_probe, 242 .init = atkbd_init, 243 .term = atkbd_term, 244 .intr = atkbd_intr, 245 .test_if = atkbd_test_if, 246 .enable = atkbd_enable, 247 .disable = atkbd_disable, 248 .read = atkbd_read, 249 .check = atkbd_check, 250 .read_char = atkbd_read_char, 251 .check_char = atkbd_check_char, 252 .ioctl = atkbd_ioctl, 253 .lock = atkbd_lock, 254 .clear_state = atkbd_clear_state, 255 .get_state = atkbd_get_state, 256 .set_state = atkbd_set_state, 257 .poll = atkbd_poll, 258 }; 259 260 KEYBOARD_DRIVER(atkbd, atkbdsw, atkbd_configure); 261 262 /* local functions */ 263 static int set_typematic(keyboard_t *kbd); 264 static int setup_kbd_port(KBDC kbdc, int port, int intr); 265 static int get_kbd_echo(KBDC kbdc); 266 static int probe_keyboard(KBDC kbdc, int flags); 267 static int init_keyboard(KBDC kbdc, int *type, int flags); 268 static int write_kbd(KBDC kbdc, int command, int data); 269 static int get_kbd_id(KBDC kbdc); 270 static int typematic(int delay, int rate); 271 static int typematic_delay(int delay); 272 static int typematic_rate(int rate); 273 274 #ifdef EVDEV_SUPPORT 275 static evdev_event_t atkbd_ev_event; 276 277 static const struct evdev_methods atkbd_evdev_methods = { 278 .ev_event = atkbd_ev_event, 279 }; 280 #endif 281 282 /* local variables */ 283 284 /* the initial key map, accent map and fkey strings */ 285 #ifdef ATKBD_DFLT_KEYMAP 286 #define KBD_DFLT_KEYMAP 287 #include "atkbdmap.h" 288 #endif 289 #include <dev/kbd/kbdtables.h> 290 291 /* structures for the default keyboard */ 292 static keyboard_t default_kbd; 293 static atkbd_state_t default_kbd_state; 294 static keymap_t default_keymap; 295 static accentmap_t default_accentmap; 296 static fkeytab_t default_fkeytab[NUM_FKEYS]; 297 298 /* 299 * The back door to the keyboard driver! 300 * This function is called by the console driver, via the kbdio module, 301 * to tickle keyboard drivers when the low-level console is being initialized. 302 * Almost nothing in the kernel has been initialied yet. Try to probe 303 * keyboards if possible. 304 * NOTE: because of the way the low-level console is initialized, this routine 305 * may be called more than once!! 306 */ 307 static int 308 atkbd_configure(int flags) 309 { 310 keyboard_t *kbd; 311 int arg[2]; 312 int i; 313 314 /* 315 * Probe the keyboard controller, if not present or if the driver 316 * is disabled, unregister the keyboard if any. 317 */ 318 if (atkbdc_configure() != 0 || 319 resource_disabled("atkbd", ATKBD_DEFAULT)) { 320 i = kbd_find_keyboard(ATKBD_DRIVER_NAME, ATKBD_DEFAULT); 321 if (i >= 0) { 322 kbd = kbd_get_keyboard(i); 323 kbd_unregister(kbd); 324 kbd->kb_flags &= ~KB_REGISTERED; 325 } 326 return 0; 327 } 328 329 /* XXX: a kludge to obtain the device configuration flags */ 330 if (resource_int_value("atkbd", ATKBD_DEFAULT, "flags", &i) == 0) 331 flags |= i; 332 333 /* probe the default keyboard */ 334 arg[0] = -1; 335 arg[1] = -1; 336 kbd = NULL; 337 if (atkbd_probe(ATKBD_DEFAULT, arg, flags)) 338 return 0; 339 if (atkbd_init(ATKBD_DEFAULT, &kbd, arg, flags)) 340 return 0; 341 342 /* return the number of found keyboards */ 343 return 1; 344 } 345 346 /* low-level functions */ 347 348 /* detect a keyboard */ 349 static int 350 atkbd_probe(int unit, void *arg, int flags) 351 { 352 KBDC kbdc; 353 int *data = (int *)arg; /* data[0]: controller, data[1]: irq */ 354 355 /* XXX */ 356 if (unit == ATKBD_DEFAULT) { 357 if (KBD_IS_PROBED(&default_kbd)) 358 return 0; 359 } 360 361 kbdc = atkbdc_open(data[0]); 362 if (kbdc == NULL) 363 return ENXIO; 364 if (probe_keyboard(kbdc, flags)) { 365 if (flags & KB_CONF_FAIL_IF_NO_KBD) 366 return ENXIO; 367 } 368 return 0; 369 } 370 371 /* reset and initialize the device */ 372 static int 373 atkbd_init(int unit, keyboard_t **kbdp, void *arg, int flags) 374 { 375 keyboard_t *kbd; 376 atkbd_state_t *state; 377 keymap_t *keymap; 378 accentmap_t *accmap; 379 fkeytab_t *fkeymap; 380 int fkeymap_size; 381 int delay[2]; 382 int *data = (int *)arg; /* data[0]: controller, data[1]: irq */ 383 int error, needfree; 384 #ifdef EVDEV_SUPPORT 385 struct evdev_dev *evdev; 386 char phys_loc[8]; 387 #endif 388 389 /* XXX */ 390 if (unit == ATKBD_DEFAULT) { 391 *kbdp = kbd = &default_kbd; 392 if (KBD_IS_INITIALIZED(kbd) && KBD_IS_CONFIGURED(kbd)) 393 return 0; 394 state = &default_kbd_state; 395 keymap = &default_keymap; 396 accmap = &default_accentmap; 397 fkeymap = default_fkeytab; 398 fkeymap_size = nitems(default_fkeytab); 399 needfree = 0; 400 } else if (*kbdp == NULL) { 401 *kbdp = kbd = malloc(sizeof(*kbd), M_DEVBUF, M_NOWAIT | M_ZERO); 402 state = malloc(sizeof(*state), M_DEVBUF, M_NOWAIT | M_ZERO); 403 /* NB: these will always be initialized 'cuz !KBD_IS_PROBED */ 404 keymap = malloc(sizeof(key_map), M_DEVBUF, M_NOWAIT); 405 accmap = malloc(sizeof(accent_map), M_DEVBUF, M_NOWAIT); 406 fkeymap = malloc(sizeof(fkey_tab), M_DEVBUF, M_NOWAIT); 407 fkeymap_size = sizeof(fkey_tab)/sizeof(fkey_tab[0]); 408 needfree = 1; 409 if ((kbd == NULL) || (state == NULL) || (keymap == NULL) 410 || (accmap == NULL) || (fkeymap == NULL)) { 411 error = ENOMEM; 412 goto bad; 413 } 414 } else if (KBD_IS_INITIALIZED(*kbdp) && KBD_IS_CONFIGURED(*kbdp)) { 415 return 0; 416 } else { 417 kbd = *kbdp; 418 state = (atkbd_state_t *)kbd->kb_data; 419 bzero(state, sizeof(*state)); 420 keymap = kbd->kb_keymap; 421 accmap = kbd->kb_accentmap; 422 fkeymap = kbd->kb_fkeytab; 423 fkeymap_size = kbd->kb_fkeytab_size; 424 needfree = 0; 425 } 426 427 if (!KBD_IS_PROBED(kbd)) { 428 state->kbdc = atkbdc_open(data[0]); 429 if (state->kbdc == NULL) { 430 error = ENXIO; 431 goto bad; 432 } 433 kbd_init_struct(kbd, ATKBD_DRIVER_NAME, KB_OTHER, unit, flags, 434 0, 0); 435 bcopy(&key_map, keymap, sizeof(key_map)); 436 bcopy(&accent_map, accmap, sizeof(accent_map)); 437 bcopy(fkey_tab, fkeymap, 438 imin(fkeymap_size * sizeof(fkeymap[0]), sizeof(fkey_tab))); 439 kbd_set_maps(kbd, keymap, accmap, fkeymap, fkeymap_size); 440 kbd->kb_data = (void *)state; 441 442 if (probe_keyboard(state->kbdc, flags)) { /* shouldn't happen */ 443 if (flags & KB_CONF_FAIL_IF_NO_KBD) { 444 error = ENXIO; 445 goto bad; 446 } 447 } else { 448 KBD_FOUND_DEVICE(kbd); 449 } 450 atkbd_clear_state(kbd); 451 state->ks_mode = K_XLATE; 452 /* 453 * FIXME: set the initial value for lock keys in ks_state 454 * according to the BIOS data? 455 */ 456 KBD_PROBE_DONE(kbd); 457 } 458 if (!KBD_IS_INITIALIZED(kbd) && !(flags & KB_CONF_PROBE_ONLY)) { 459 kbd->kb_config = flags & ~KB_CONF_PROBE_ONLY; 460 if (KBD_HAS_DEVICE(kbd) 461 && init_keyboard(state->kbdc, &kbd->kb_type, kbd->kb_config) 462 && (kbd->kb_config & KB_CONF_FAIL_IF_NO_KBD)) { 463 kbd_unregister(kbd); 464 error = ENXIO; 465 goto bad; 466 } 467 atkbd_ioctl(kbd, KDSETLED, (caddr_t)&state->ks_state); 468 set_typematic(kbd); 469 delay[0] = kbd->kb_delay1; 470 delay[1] = kbd->kb_delay2; 471 atkbd_ioctl(kbd, KDSETREPEAT, (caddr_t)delay); 472 473 #ifdef EVDEV_SUPPORT 474 /* register as evdev provider on first init */ 475 if (state->ks_evdev == NULL) { 476 snprintf(phys_loc, sizeof(phys_loc), "atkbd%d", unit); 477 evdev = evdev_alloc(); 478 evdev_set_name(evdev, "AT keyboard"); 479 evdev_set_phys(evdev, phys_loc); 480 evdev_set_id(evdev, BUS_I8042, PS2_KEYBOARD_VENDOR, 481 PS2_KEYBOARD_PRODUCT, 0); 482 evdev_set_methods(evdev, kbd, &atkbd_evdev_methods); 483 evdev_support_event(evdev, EV_SYN); 484 evdev_support_event(evdev, EV_KEY); 485 evdev_support_event(evdev, EV_LED); 486 evdev_support_event(evdev, EV_REP); 487 evdev_support_all_known_keys(evdev); 488 evdev_support_led(evdev, LED_NUML); 489 evdev_support_led(evdev, LED_CAPSL); 490 evdev_support_led(evdev, LED_SCROLLL); 491 492 if (evdev_register_mtx(evdev, &Giant)) 493 evdev_free(evdev); 494 else 495 state->ks_evdev = evdev; 496 state->ks_evdev_state = 0; 497 } 498 #endif 499 500 KBD_INIT_DONE(kbd); 501 } 502 if (!KBD_IS_CONFIGURED(kbd)) { 503 if (kbd_register(kbd) < 0) { 504 error = ENXIO; 505 goto bad; 506 } 507 KBD_CONFIG_DONE(kbd); 508 } 509 510 return 0; 511 bad: 512 if (needfree) { 513 if (state != NULL) 514 free(state, M_DEVBUF); 515 if (keymap != NULL) 516 free(keymap, M_DEVBUF); 517 if (accmap != NULL) 518 free(accmap, M_DEVBUF); 519 if (fkeymap != NULL) 520 free(fkeymap, M_DEVBUF); 521 if (kbd != NULL) { 522 free(kbd, M_DEVBUF); 523 *kbdp = NULL; /* insure ref doesn't leak to caller */ 524 } 525 } 526 return error; 527 } 528 529 /* finish using this keyboard */ 530 static int 531 atkbd_term(keyboard_t *kbd) 532 { 533 atkbd_state_t *state = (atkbd_state_t *)kbd->kb_data; 534 535 kbd_unregister(kbd); 536 callout_drain(&state->ks_timer); 537 return 0; 538 } 539 540 /* keyboard interrupt routine */ 541 static int 542 atkbd_intr(keyboard_t *kbd, void *arg) 543 { 544 atkbd_state_t *state = (atkbd_state_t *)kbd->kb_data; 545 int delay[2]; 546 int c; 547 548 if (!KBD_HAS_DEVICE(kbd)) { 549 /* 550 * The keyboard was not detected before; 551 * it must have been reconnected! 552 */ 553 init_keyboard(state->kbdc, &kbd->kb_type, kbd->kb_config); 554 KBD_FOUND_DEVICE(kbd); 555 atkbd_ioctl(kbd, KDSETLED, (caddr_t)&state->ks_state); 556 set_typematic(kbd); 557 delay[0] = kbd->kb_delay1; 558 delay[1] = kbd->kb_delay2; 559 atkbd_ioctl(kbd, KDSETREPEAT, (caddr_t)delay); 560 } 561 562 if (state->ks_polling) 563 return 0; 564 565 if (KBD_IS_ACTIVE(kbd) && KBD_IS_BUSY(kbd)) { 566 /* let the callback function to process the input */ 567 (*kbd->kb_callback.kc_func)(kbd, KBDIO_KEYINPUT, 568 kbd->kb_callback.kc_arg); 569 } else { 570 /* read and discard the input; no one is waiting for input */ 571 do { 572 c = atkbd_read_char(kbd, FALSE); 573 } while (c != NOKEY); 574 } 575 return 0; 576 } 577 578 /* test the interface to the device */ 579 static int 580 atkbd_test_if(keyboard_t *kbd) 581 { 582 int error; 583 int s; 584 585 error = 0; 586 empty_both_buffers(((atkbd_state_t *)kbd->kb_data)->kbdc, 10); 587 s = spltty(); 588 if (!test_controller(((atkbd_state_t *)kbd->kb_data)->kbdc)) 589 error = EIO; 590 else if (test_kbd_port(((atkbd_state_t *)kbd->kb_data)->kbdc) != 0) 591 error = EIO; 592 splx(s); 593 594 return error; 595 } 596 597 /* 598 * Enable the access to the device; until this function is called, 599 * the client cannot read from the keyboard. 600 */ 601 static int 602 atkbd_enable(keyboard_t *kbd) 603 { 604 int s; 605 606 s = spltty(); 607 KBD_ACTIVATE(kbd); 608 splx(s); 609 return 0; 610 } 611 612 /* disallow the access to the device */ 613 static int 614 atkbd_disable(keyboard_t *kbd) 615 { 616 int s; 617 618 s = spltty(); 619 KBD_DEACTIVATE(kbd); 620 splx(s); 621 return 0; 622 } 623 624 /* read one byte from the keyboard if it's allowed */ 625 static int 626 atkbd_read(keyboard_t *kbd, int wait) 627 { 628 int c; 629 630 if (wait) 631 c = read_kbd_data(((atkbd_state_t *)kbd->kb_data)->kbdc); 632 else 633 c = read_kbd_data_no_wait(((atkbd_state_t *)kbd->kb_data)->kbdc); 634 if (c != -1) 635 ++kbd->kb_count; 636 return (KBD_IS_ACTIVE(kbd) ? c : -1); 637 } 638 639 /* check if data is waiting */ 640 static int 641 atkbd_check(keyboard_t *kbd) 642 { 643 if (!KBD_IS_ACTIVE(kbd)) 644 return FALSE; 645 return kbdc_data_ready(((atkbd_state_t *)kbd->kb_data)->kbdc); 646 } 647 648 /* read char from the keyboard */ 649 static u_int 650 atkbd_read_char(keyboard_t *kbd, int wait) 651 { 652 atkbd_state_t *state; 653 u_int action; 654 int scancode; 655 int keycode; 656 657 state = (atkbd_state_t *)kbd->kb_data; 658 next_code: 659 /* do we have a composed char to return? */ 660 if (!(state->ks_flags & COMPOSE) && (state->ks_composed_char > 0)) { 661 action = state->ks_composed_char; 662 state->ks_composed_char = 0; 663 if (action > UCHAR_MAX) 664 return ERRKEY; 665 return action; 666 } 667 668 /* see if there is something in the keyboard port */ 669 if (wait) { 670 do { 671 scancode = read_kbd_data(state->kbdc); 672 } while (scancode == -1); 673 } else { 674 scancode = read_kbd_data_no_wait(state->kbdc); 675 if (scancode == -1) 676 return NOKEY; 677 } 678 ++kbd->kb_count; 679 680 #if KBDIO_DEBUG >= 10 681 printf("atkbd_read_char(): scancode:0x%x\n", scancode); 682 #endif 683 684 #ifdef EVDEV_SUPPORT 685 /* push evdev event */ 686 if (evdev_rcpt_mask & EVDEV_RCPT_HW_KBD && state->ks_evdev != NULL) { 687 /* "hancha" and "han/yong" korean keys handling */ 688 if (state->ks_evdev_state == 0 && 689 (scancode == 0xF1 || scancode == 0xF2)) { 690 keycode = evdev_scancode2key(&state->ks_evdev_state, 691 scancode & 0x7F); 692 evdev_push_event(state->ks_evdev, EV_KEY, 693 (uint16_t)keycode, 1); 694 evdev_sync(state->ks_evdev); 695 } 696 697 keycode = evdev_scancode2key(&state->ks_evdev_state, 698 scancode); 699 700 if (keycode != KEY_RESERVED) { 701 evdev_push_event(state->ks_evdev, EV_KEY, 702 (uint16_t)keycode, scancode & 0x80 ? 0 : 1); 703 evdev_sync(state->ks_evdev); 704 } 705 } 706 707 if (state->ks_evdev != NULL && evdev_is_grabbed(state->ks_evdev)) 708 return (NOKEY); 709 #endif 710 711 /* return the byte as is for the K_RAW mode */ 712 if (state->ks_mode == K_RAW) 713 return scancode; 714 715 /* translate the scan code into a keycode */ 716 keycode = scancode & 0x7F; 717 switch (state->ks_prefix) { 718 case 0x00: /* normal scancode */ 719 switch(scancode) { 720 case 0xB8: /* left alt (compose key) released */ 721 if (state->ks_flags & COMPOSE) { 722 state->ks_flags &= ~COMPOSE; 723 if (state->ks_composed_char > UCHAR_MAX) 724 state->ks_composed_char = 0; 725 } 726 break; 727 case 0x38: /* left alt (compose key) pressed */ 728 if (!(state->ks_flags & COMPOSE)) { 729 state->ks_flags |= COMPOSE; 730 state->ks_composed_char = 0; 731 } 732 break; 733 case 0xE0: 734 case 0xE1: 735 state->ks_prefix = scancode; 736 goto next_code; 737 } 738 break; 739 case 0xE0: /* 0xE0 prefix */ 740 state->ks_prefix = 0; 741 switch (keycode) { 742 case 0x1C: /* right enter key */ 743 keycode = 0x59; 744 break; 745 case 0x1D: /* right ctrl key */ 746 keycode = 0x5A; 747 break; 748 case 0x35: /* keypad divide key */ 749 keycode = 0x5B; 750 break; 751 case 0x37: /* print scrn key */ 752 keycode = 0x5C; 753 break; 754 case 0x38: /* right alt key (alt gr) */ 755 keycode = 0x5D; 756 break; 757 case 0x46: /* ctrl-pause/break on AT 101 (see below) */ 758 keycode = 0x68; 759 break; 760 case 0x47: /* grey home key */ 761 keycode = 0x5E; 762 break; 763 case 0x48: /* grey up arrow key */ 764 keycode = 0x5F; 765 break; 766 case 0x49: /* grey page up key */ 767 keycode = 0x60; 768 break; 769 case 0x4B: /* grey left arrow key */ 770 keycode = 0x61; 771 break; 772 case 0x4D: /* grey right arrow key */ 773 keycode = 0x62; 774 break; 775 case 0x4F: /* grey end key */ 776 keycode = 0x63; 777 break; 778 case 0x50: /* grey down arrow key */ 779 keycode = 0x64; 780 break; 781 case 0x51: /* grey page down key */ 782 keycode = 0x65; 783 break; 784 case 0x52: /* grey insert key */ 785 keycode = 0x66; 786 break; 787 case 0x53: /* grey delete key */ 788 keycode = 0x67; 789 break; 790 /* the following 3 are only used on the MS "Natural" keyboard */ 791 case 0x5b: /* left Window key */ 792 keycode = 0x69; 793 break; 794 case 0x5c: /* right Window key */ 795 keycode = 0x6a; 796 break; 797 case 0x5d: /* menu key */ 798 keycode = 0x6b; 799 break; 800 case 0x5e: /* power key */ 801 keycode = 0x6d; 802 break; 803 case 0x5f: /* sleep key */ 804 keycode = 0x6e; 805 break; 806 case 0x63: /* wake key */ 807 keycode = 0x6f; 808 break; 809 default: /* ignore everything else */ 810 goto next_code; 811 } 812 break; 813 case 0xE1: /* 0xE1 prefix */ 814 /* 815 * The pause/break key on the 101 keyboard produces: 816 * E1-1D-45 E1-9D-C5 817 * Ctrl-pause/break produces: 818 * E0-46 E0-C6 (See above.) 819 */ 820 state->ks_prefix = 0; 821 if (keycode == 0x1D) 822 state->ks_prefix = 0x1D; 823 goto next_code; 824 /* NOT REACHED */ 825 case 0x1D: /* pause / break */ 826 state->ks_prefix = 0; 827 if (keycode != 0x45) 828 goto next_code; 829 keycode = 0x68; 830 break; 831 } 832 833 if (kbd->kb_type == KB_84) { 834 switch (keycode) { 835 case 0x37: /* *(numpad)/print screen */ 836 if (state->ks_flags & SHIFTS) 837 keycode = 0x5c; /* print screen */ 838 break; 839 case 0x45: /* num lock/pause */ 840 if (state->ks_flags & CTLS) 841 keycode = 0x68; /* pause */ 842 break; 843 case 0x46: /* scroll lock/break */ 844 if (state->ks_flags & CTLS) 845 keycode = 0x6c; /* break */ 846 break; 847 } 848 } else if (kbd->kb_type == KB_101) { 849 switch (keycode) { 850 case 0x5c: /* print screen */ 851 if (state->ks_flags & ALTS) 852 keycode = 0x54; /* sysrq */ 853 break; 854 case 0x68: /* pause/break */ 855 if (state->ks_flags & CTLS) 856 keycode = 0x6c; /* break */ 857 break; 858 } 859 } 860 861 /* return the key code in the K_CODE mode */ 862 if (state->ks_mode == K_CODE) 863 return (keycode | (scancode & 0x80)); 864 865 /* compose a character code */ 866 if (state->ks_flags & COMPOSE) { 867 switch (keycode | (scancode & 0x80)) { 868 /* key pressed, process it */ 869 case 0x47: case 0x48: case 0x49: /* keypad 7,8,9 */ 870 state->ks_composed_char *= 10; 871 state->ks_composed_char += keycode - 0x40; 872 if (state->ks_composed_char > UCHAR_MAX) 873 return ERRKEY; 874 goto next_code; 875 case 0x4B: case 0x4C: case 0x4D: /* keypad 4,5,6 */ 876 state->ks_composed_char *= 10; 877 state->ks_composed_char += keycode - 0x47; 878 if (state->ks_composed_char > UCHAR_MAX) 879 return ERRKEY; 880 goto next_code; 881 case 0x4F: case 0x50: case 0x51: /* keypad 1,2,3 */ 882 state->ks_composed_char *= 10; 883 state->ks_composed_char += keycode - 0x4E; 884 if (state->ks_composed_char > UCHAR_MAX) 885 return ERRKEY; 886 goto next_code; 887 case 0x52: /* keypad 0 */ 888 state->ks_composed_char *= 10; 889 if (state->ks_composed_char > UCHAR_MAX) 890 return ERRKEY; 891 goto next_code; 892 893 /* key released, no interest here */ 894 case 0xC7: case 0xC8: case 0xC9: /* keypad 7,8,9 */ 895 case 0xCB: case 0xCC: case 0xCD: /* keypad 4,5,6 */ 896 case 0xCF: case 0xD0: case 0xD1: /* keypad 1,2,3 */ 897 case 0xD2: /* keypad 0 */ 898 goto next_code; 899 900 case 0x38: /* left alt key */ 901 break; 902 903 default: 904 if (state->ks_composed_char > 0) { 905 state->ks_flags &= ~COMPOSE; 906 state->ks_composed_char = 0; 907 return ERRKEY; 908 } 909 break; 910 } 911 } 912 913 /* keycode to key action */ 914 action = genkbd_keyaction(kbd, keycode, scancode & 0x80, 915 &state->ks_state, &state->ks_accents); 916 if (action == NOKEY) 917 goto next_code; 918 else 919 return action; 920 } 921 922 /* check if char is waiting */ 923 static int 924 atkbd_check_char(keyboard_t *kbd) 925 { 926 atkbd_state_t *state; 927 928 if (!KBD_IS_ACTIVE(kbd)) 929 return FALSE; 930 state = (atkbd_state_t *)kbd->kb_data; 931 if (!(state->ks_flags & COMPOSE) && (state->ks_composed_char > 0)) 932 return TRUE; 933 return kbdc_data_ready(state->kbdc); 934 } 935 936 /* some useful control functions */ 937 static int 938 atkbd_ioctl(keyboard_t *kbd, u_long cmd, caddr_t arg) 939 { 940 /* translate LED_XXX bits into the device specific bits */ 941 static u_char ledmap[8] = { 942 0, 4, 2, 6, 1, 5, 3, 7, 943 }; 944 atkbd_state_t *state = kbd->kb_data; 945 int error; 946 int s; 947 int i; 948 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \ 949 defined(COMPAT_FREEBSD4) || defined(COMPAT_43) 950 int ival; 951 #endif 952 953 s = spltty(); 954 switch (cmd) { 955 case KDGKBMODE: /* get keyboard mode */ 956 *(int *)arg = state->ks_mode; 957 break; 958 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \ 959 defined(COMPAT_FREEBSD4) || defined(COMPAT_43) 960 case _IO('K', 7): 961 ival = IOCPARM_IVAL(arg); 962 arg = (caddr_t)&ival; 963 /* FALLTHROUGH */ 964 #endif 965 case KDSKBMODE: /* set keyboard mode */ 966 switch (*(int *)arg) { 967 case K_XLATE: 968 if (state->ks_mode != K_XLATE) { 969 /* make lock key state and LED state match */ 970 state->ks_state &= ~LOCK_MASK; 971 state->ks_state |= KBD_LED_VAL(kbd); 972 } 973 /* FALLTHROUGH */ 974 case K_RAW: 975 case K_CODE: 976 if (state->ks_mode != *(int *)arg) { 977 atkbd_clear_state(kbd); 978 state->ks_mode = *(int *)arg; 979 } 980 break; 981 default: 982 splx(s); 983 return EINVAL; 984 } 985 break; 986 987 case KDGETLED: /* get keyboard LED */ 988 *(int *)arg = KBD_LED_VAL(kbd); 989 break; 990 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \ 991 defined(COMPAT_FREEBSD4) || defined(COMPAT_43) 992 case _IO('K', 66): 993 ival = IOCPARM_IVAL(arg); 994 arg = (caddr_t)&ival; 995 /* FALLTHROUGH */ 996 #endif 997 case KDSETLED: /* set keyboard LED */ 998 /* NOTE: lock key state in ks_state won't be changed */ 999 if (*(int *)arg & ~LOCK_MASK) { 1000 splx(s); 1001 return EINVAL; 1002 } 1003 i = *(int *)arg; 1004 /* replace CAPS LED with ALTGR LED for ALTGR keyboards */ 1005 if (state->ks_mode == K_XLATE && 1006 kbd->kb_keymap->n_keys > ALTGR_OFFSET) { 1007 if (i & ALKED) 1008 i |= CLKED; 1009 else 1010 i &= ~CLKED; 1011 } 1012 if (KBD_HAS_DEVICE(kbd)) { 1013 error = write_kbd(state->kbdc, KBDC_SET_LEDS, 1014 ledmap[i & LED_MASK]); 1015 if (error) { 1016 splx(s); 1017 return error; 1018 } 1019 } 1020 #ifdef EVDEV_SUPPORT 1021 /* push LED states to evdev */ 1022 if (state->ks_evdev != NULL && 1023 evdev_rcpt_mask & EVDEV_RCPT_HW_KBD) 1024 evdev_push_leds(state->ks_evdev, *(int *)arg); 1025 #endif 1026 KBD_LED_VAL(kbd) = *(int *)arg; 1027 break; 1028 1029 case KDGKBSTATE: /* get lock key state */ 1030 *(int *)arg = state->ks_state & LOCK_MASK; 1031 break; 1032 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \ 1033 defined(COMPAT_FREEBSD4) || defined(COMPAT_43) 1034 case _IO('K', 20): 1035 ival = IOCPARM_IVAL(arg); 1036 arg = (caddr_t)&ival; 1037 /* FALLTHROUGH */ 1038 #endif 1039 case KDSKBSTATE: /* set lock key state */ 1040 if (*(int *)arg & ~LOCK_MASK) { 1041 splx(s); 1042 return EINVAL; 1043 } 1044 state->ks_state &= ~LOCK_MASK; 1045 state->ks_state |= *(int *)arg; 1046 splx(s); 1047 /* set LEDs and quit */ 1048 return atkbd_ioctl(kbd, KDSETLED, arg); 1049 1050 case KDSETREPEAT: /* set keyboard repeat rate (new interface) */ 1051 splx(s); 1052 if (!KBD_HAS_DEVICE(kbd)) 1053 return 0; 1054 i = typematic(((int *)arg)[0], ((int *)arg)[1]); 1055 error = write_kbd(state->kbdc, KBDC_SET_TYPEMATIC, i); 1056 if (error == 0) { 1057 kbd->kb_delay1 = typematic_delay(i); 1058 kbd->kb_delay2 = typematic_rate(i); 1059 #ifdef EVDEV_SUPPORT 1060 if (state->ks_evdev != NULL && 1061 evdev_rcpt_mask & EVDEV_RCPT_HW_KBD) 1062 evdev_push_repeats(state->ks_evdev, kbd); 1063 #endif 1064 } 1065 return error; 1066 1067 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \ 1068 defined(COMPAT_FREEBSD4) || defined(COMPAT_43) 1069 case _IO('K', 67): 1070 ival = IOCPARM_IVAL(arg); 1071 arg = (caddr_t)&ival; 1072 /* FALLTHROUGH */ 1073 #endif 1074 case KDSETRAD: /* set keyboard repeat rate (old interface) */ 1075 splx(s); 1076 if (!KBD_HAS_DEVICE(kbd)) 1077 return 0; 1078 error = write_kbd(state->kbdc, KBDC_SET_TYPEMATIC, *(int *)arg); 1079 if (error == 0) { 1080 kbd->kb_delay1 = typematic_delay(*(int *)arg); 1081 kbd->kb_delay2 = typematic_rate(*(int *)arg); 1082 #ifdef EVDEV_SUPPORT 1083 if (state->ks_evdev != NULL && 1084 evdev_rcpt_mask & EVDEV_RCPT_HW_KBD) 1085 evdev_push_repeats(state->ks_evdev, kbd); 1086 #endif 1087 } 1088 return error; 1089 1090 case PIO_KEYMAP: /* set keyboard translation table */ 1091 case PIO_KEYMAPENT: /* set keyboard translation table entry */ 1092 case PIO_DEADKEYMAP: /* set accent key translation table */ 1093 #ifdef COMPAT_FREEBSD13 1094 case OPIO_KEYMAP: /* set keyboard translation table (compat) */ 1095 case OPIO_DEADKEYMAP: /* set accent key translation table (compat) */ 1096 #endif /* COMPAT_FREEBSD13 */ 1097 state->ks_accents = 0; 1098 /* FALLTHROUGH */ 1099 default: 1100 splx(s); 1101 return genkbd_commonioctl(kbd, cmd, arg); 1102 } 1103 1104 splx(s); 1105 return 0; 1106 } 1107 1108 /* lock the access to the keyboard */ 1109 static int 1110 atkbd_lock(keyboard_t *kbd, int lock) 1111 { 1112 return kbdc_lock(((atkbd_state_t *)kbd->kb_data)->kbdc, lock); 1113 } 1114 1115 /* clear the internal state of the keyboard */ 1116 static void 1117 atkbd_clear_state(keyboard_t *kbd) 1118 { 1119 atkbd_state_t *state; 1120 1121 state = (atkbd_state_t *)kbd->kb_data; 1122 state->ks_flags = 0; 1123 state->ks_polling = 0; 1124 state->ks_state &= LOCK_MASK; /* preserve locking key state */ 1125 state->ks_accents = 0; 1126 state->ks_composed_char = 0; 1127 #if 0 1128 state->ks_prefix = 0; /* XXX */ 1129 #endif 1130 } 1131 1132 /* save the internal state */ 1133 static int 1134 atkbd_get_state(keyboard_t *kbd, void *buf, size_t len) 1135 { 1136 if (len == 0) 1137 return sizeof(atkbd_state_t); 1138 if (len < sizeof(atkbd_state_t)) 1139 return -1; 1140 bcopy(kbd->kb_data, buf, sizeof(atkbd_state_t)); 1141 return 0; 1142 } 1143 1144 /* set the internal state */ 1145 static int 1146 atkbd_set_state(keyboard_t *kbd, void *buf, size_t len) 1147 { 1148 if (len < sizeof(atkbd_state_t)) 1149 return ENOMEM; 1150 if (((atkbd_state_t *)kbd->kb_data)->kbdc 1151 != ((atkbd_state_t *)buf)->kbdc) 1152 return ENOMEM; 1153 bcopy(buf, kbd->kb_data, sizeof(atkbd_state_t)); 1154 return 0; 1155 } 1156 1157 static int 1158 atkbd_poll(keyboard_t *kbd, int on) 1159 { 1160 atkbd_state_t *state; 1161 int s; 1162 1163 state = (atkbd_state_t *)kbd->kb_data; 1164 s = spltty(); 1165 if (on) 1166 ++state->ks_polling; 1167 else 1168 --state->ks_polling; 1169 splx(s); 1170 return 0; 1171 } 1172 1173 static int 1174 atkbd_reset(KBDC kbdc, int flags, int c) 1175 { 1176 /* reset keyboard hardware */ 1177 if (!(flags & KB_CONF_NO_RESET) && !reset_kbd(kbdc)) { 1178 /* 1179 * KEYBOARD ERROR 1180 * Keyboard reset may fail either because the keyboard 1181 * doen't exist, or because the keyboard doesn't pass 1182 * the self-test, or the keyboard controller on the 1183 * motherboard and the keyboard somehow fail to shake hands. 1184 * It is just possible, particularly in the last case, 1185 * that the keyboard controller may be left in a hung state. 1186 * test_controller() and test_kbd_port() appear to bring 1187 * the keyboard controller back (I don't know why and how, 1188 * though.) 1189 */ 1190 empty_both_buffers(kbdc, 10); 1191 test_controller(kbdc); 1192 test_kbd_port(kbdc); 1193 /* 1194 * We could disable the keyboard port and interrupt... but, 1195 * the keyboard may still exist (see above). 1196 */ 1197 set_controller_command_byte(kbdc, 1198 ALLOW_DISABLE_KBD(kbdc) ? 0xff : KBD_KBD_CONTROL_BITS, c); 1199 if (bootverbose) 1200 printf("atkbd: failed to reset the keyboard.\n"); 1201 return (EIO); 1202 } 1203 return (0); 1204 } 1205 1206 #ifdef EVDEV_SUPPORT 1207 static void 1208 atkbd_ev_event(struct evdev_dev *evdev, uint16_t type, uint16_t code, 1209 int32_t value) 1210 { 1211 keyboard_t *kbd = evdev_get_softc(evdev); 1212 1213 if (evdev_rcpt_mask & EVDEV_RCPT_HW_KBD && 1214 (type == EV_LED || type == EV_REP)) { 1215 mtx_lock(&Giant); 1216 kbd_ev_event(kbd, type, code, value); 1217 mtx_unlock(&Giant); 1218 } 1219 } 1220 #endif 1221 1222 /* local functions */ 1223 1224 static int 1225 set_typematic(keyboard_t *kbd) 1226 { 1227 int val, error; 1228 atkbd_state_t *state = kbd->kb_data; 1229 1230 val = typematic(DEFAULT_DELAY, DEFAULT_RATE); 1231 error = write_kbd(state->kbdc, KBDC_SET_TYPEMATIC, val); 1232 if (error == 0) { 1233 kbd->kb_delay1 = typematic_delay(val); 1234 kbd->kb_delay2 = typematic_rate(val); 1235 } 1236 1237 return (error); 1238 } 1239 1240 static int 1241 setup_kbd_port(KBDC kbdc, int port, int intr) 1242 { 1243 if (!set_controller_command_byte(kbdc, 1244 KBD_KBD_CONTROL_BITS, 1245 ((port) ? KBD_ENABLE_KBD_PORT : KBD_DISABLE_KBD_PORT) 1246 | ((intr) ? KBD_ENABLE_KBD_INT : KBD_DISABLE_KBD_INT))) 1247 return 1; 1248 return 0; 1249 } 1250 1251 static int 1252 get_kbd_echo(KBDC kbdc) 1253 { 1254 /* enable the keyboard port, but disable the keyboard intr. */ 1255 if (setup_kbd_port(kbdc, TRUE, FALSE)) 1256 /* CONTROLLER ERROR: there is very little we can do... */ 1257 return ENXIO; 1258 1259 /* see if something is present */ 1260 write_kbd_command(kbdc, KBDC_ECHO); 1261 if (read_kbd_data(kbdc) != KBD_ECHO) { 1262 empty_both_buffers(kbdc, 10); 1263 test_controller(kbdc); 1264 test_kbd_port(kbdc); 1265 return ENXIO; 1266 } 1267 1268 /* enable the keyboard port and intr. */ 1269 if (setup_kbd_port(kbdc, TRUE, TRUE)) { 1270 /* 1271 * CONTROLLER ERROR 1272 * This is serious; the keyboard intr is left disabled! 1273 */ 1274 return ENXIO; 1275 } 1276 1277 return 0; 1278 } 1279 1280 static int 1281 probe_keyboard(KBDC kbdc, int flags) 1282 { 1283 /* 1284 * Don't try to print anything in this function. The low-level 1285 * console may not have been initialized yet... 1286 */ 1287 int err; 1288 int c; 1289 int m; 1290 1291 if (!kbdc_lock(kbdc, TRUE)) { 1292 /* driver error? */ 1293 return ENXIO; 1294 } 1295 1296 /* temporarily block data transmission from the keyboard */ 1297 write_controller_command(kbdc, KBDC_DISABLE_KBD_PORT); 1298 1299 /* flush any noise in the buffer */ 1300 empty_both_buffers(kbdc, 100); 1301 1302 /* save the current keyboard controller command byte */ 1303 m = kbdc_get_device_mask(kbdc) & ~KBD_KBD_CONTROL_BITS; 1304 c = get_controller_command_byte(kbdc); 1305 if (c == -1) { 1306 /* CONTROLLER ERROR */ 1307 kbdc_set_device_mask(kbdc, m); 1308 kbdc_lock(kbdc, FALSE); 1309 return ENXIO; 1310 } 1311 1312 /* 1313 * The keyboard may have been screwed up by the boot block. 1314 * We may just be able to recover from error by testing the controller 1315 * and the keyboard port. The controller command byte needs to be 1316 * saved before this recovery operation, as some controllers seem 1317 * to set the command byte to particular values. 1318 */ 1319 test_controller(kbdc); 1320 if (!(flags & KB_CONF_NO_PROBE_TEST)) 1321 test_kbd_port(kbdc); 1322 1323 err = get_kbd_echo(kbdc); 1324 1325 /* 1326 * Even if the keyboard doesn't seem to be present (err != 0), 1327 * we shall enable the keyboard port and interrupt so that 1328 * the driver will be operable when the keyboard is attached 1329 * to the system later. It is NOT recommended to hot-plug 1330 * the AT keyboard, but many people do so... 1331 */ 1332 kbdc_set_device_mask(kbdc, m | KBD_KBD_CONTROL_BITS); 1333 setup_kbd_port(kbdc, TRUE, TRUE); 1334 #if 0 1335 if (err == 0) { 1336 kbdc_set_device_mask(kbdc, m | KBD_KBD_CONTROL_BITS); 1337 } else { 1338 /* try to restore the command byte as before */ 1339 set_controller_command_byte(kbdc, 1340 ALLOW_DISABLE_KBD(kbdc) ? 0xff : KBD_KBD_CONTROL_BITS, c); 1341 kbdc_set_device_mask(kbdc, m); 1342 } 1343 #endif 1344 1345 kbdc_lock(kbdc, FALSE); 1346 return (HAS_QUIRK(kbdc, KBDC_QUIRK_IGNORE_PROBE_RESULT) ? 0 : err); 1347 } 1348 1349 static int 1350 init_keyboard(KBDC kbdc, int *type, int flags) 1351 { 1352 int codeset; 1353 int id; 1354 int c; 1355 1356 if (!kbdc_lock(kbdc, TRUE)) { 1357 /* driver error? */ 1358 return EIO; 1359 } 1360 1361 /* temporarily block data transmission from the keyboard */ 1362 write_controller_command(kbdc, KBDC_DISABLE_KBD_PORT); 1363 1364 /* save the current controller command byte */ 1365 empty_both_buffers(kbdc, 200); 1366 c = get_controller_command_byte(kbdc); 1367 if (c == -1) { 1368 /* CONTROLLER ERROR */ 1369 kbdc_lock(kbdc, FALSE); 1370 printf("atkbd: unable to get the current command byte value.\n"); 1371 return EIO; 1372 } 1373 if (bootverbose) 1374 printf("atkbd: the current kbd controller command byte %04x\n", 1375 c); 1376 #if 0 1377 /* override the keyboard lock switch */ 1378 c |= KBD_OVERRIDE_KBD_LOCK; 1379 #endif 1380 1381 /* enable the keyboard port, but disable the keyboard intr. */ 1382 if (setup_kbd_port(kbdc, TRUE, FALSE)) { 1383 /* CONTROLLER ERROR: there is very little we can do... */ 1384 printf("atkbd: unable to set the command byte.\n"); 1385 kbdc_lock(kbdc, FALSE); 1386 return EIO; 1387 } 1388 1389 if (HAS_QUIRK(kbdc, KBDC_QUIRK_RESET_AFTER_PROBE) && 1390 atkbd_reset(kbdc, flags, c)) { 1391 kbdc_lock(kbdc, FALSE); 1392 return EIO; 1393 } 1394 1395 /* 1396 * Check if we have an XT keyboard before we attempt to reset it. 1397 * The procedure assumes that the keyboard and the controller have 1398 * been set up properly by BIOS and have not been messed up 1399 * during the boot process. 1400 */ 1401 codeset = -1; 1402 if (flags & KB_CONF_ALT_SCANCODESET) 1403 /* the user says there is a XT keyboard */ 1404 codeset = 1; 1405 #ifdef KBD_DETECT_XT_KEYBOARD 1406 else if ((c & KBD_TRANSLATION) == 0) { 1407 /* SET_SCANCODE_SET is not always supported; ignore error */ 1408 if (send_kbd_command_and_data(kbdc, KBDC_SET_SCANCODE_SET, 0) 1409 == KBD_ACK) 1410 codeset = read_kbd_data(kbdc); 1411 } 1412 if (bootverbose) 1413 printf("atkbd: scancode set %d\n", codeset); 1414 #endif /* KBD_DETECT_XT_KEYBOARD */ 1415 1416 *type = KB_OTHER; 1417 id = get_kbd_id(kbdc); 1418 switch(id) { 1419 case 0x41ab: /* 101/102/... Enhanced */ 1420 case 0x83ab: /* ditto */ 1421 case 0x54ab: /* SpaceSaver */ 1422 case 0x84ab: /* ditto */ 1423 #if 0 1424 case 0x90ab: /* 'G' */ 1425 case 0x91ab: /* 'P' */ 1426 case 0x92ab: /* 'A' */ 1427 #endif 1428 *type = KB_101; 1429 break; 1430 case -1: /* AT 84 keyboard doesn't return ID */ 1431 *type = KB_84; 1432 break; 1433 default: 1434 break; 1435 } 1436 if (bootverbose) 1437 printf("atkbd: keyboard ID 0x%x (%d)\n", id, *type); 1438 1439 if (!HAS_QUIRK(kbdc, KBDC_QUIRK_RESET_AFTER_PROBE) && 1440 atkbd_reset(kbdc, flags, c)) { 1441 kbdc_lock(kbdc, FALSE); 1442 return EIO; 1443 } 1444 1445 /* 1446 * Allow us to set the XT_KEYBD flag so that keyboards 1447 * such as those on the IBM ThinkPad laptop computers can be used 1448 * with the standard console driver. 1449 */ 1450 if (codeset == 1) { 1451 if (send_kbd_command_and_data(kbdc, 1452 KBDC_SET_SCANCODE_SET, codeset) == KBD_ACK) { 1453 /* XT kbd doesn't need scan code translation */ 1454 c &= ~KBD_TRANSLATION; 1455 } else { 1456 /* 1457 * KEYBOARD ERROR 1458 * The XT kbd isn't usable unless the proper scan 1459 * code set is selected. 1460 */ 1461 set_controller_command_byte(kbdc, ALLOW_DISABLE_KBD(kbdc) 1462 ? 0xff : KBD_KBD_CONTROL_BITS, c); 1463 kbdc_lock(kbdc, FALSE); 1464 printf("atkbd: unable to set the XT keyboard mode.\n"); 1465 return EIO; 1466 } 1467 } 1468 1469 /* 1470 * Some keyboards require a SETLEDS command to be sent after 1471 * the reset command before they will send keystrokes to us 1472 */ 1473 if (HAS_QUIRK(kbdc, KBDC_QUIRK_SETLEDS_ON_INIT) && 1474 send_kbd_command_and_data(kbdc, KBDC_SET_LEDS, 0) != KBD_ACK) { 1475 printf("atkbd: setleds failed\n"); 1476 } 1477 if (!ALLOW_DISABLE_KBD(kbdc)) 1478 send_kbd_command(kbdc, KBDC_ENABLE_KBD); 1479 1480 /* enable the keyboard port and intr. */ 1481 if (!set_controller_command_byte(kbdc, 1482 KBD_KBD_CONTROL_BITS | KBD_TRANSLATION | KBD_OVERRIDE_KBD_LOCK, 1483 (c & (KBD_TRANSLATION | KBD_OVERRIDE_KBD_LOCK)) 1484 | KBD_ENABLE_KBD_PORT | KBD_ENABLE_KBD_INT)) { 1485 /* 1486 * CONTROLLER ERROR 1487 * This is serious; we are left with the disabled 1488 * keyboard intr. 1489 */ 1490 set_controller_command_byte(kbdc, ALLOW_DISABLE_KBD(kbdc) 1491 ? 0xff : (KBD_KBD_CONTROL_BITS | KBD_TRANSLATION | 1492 KBD_OVERRIDE_KBD_LOCK), c); 1493 kbdc_lock(kbdc, FALSE); 1494 printf("atkbd: unable to enable the keyboard port and intr.\n"); 1495 return EIO; 1496 } 1497 1498 kbdc_lock(kbdc, FALSE); 1499 return 0; 1500 } 1501 1502 static int 1503 write_kbd(KBDC kbdc, int command, int data) 1504 { 1505 int s; 1506 1507 /* prevent the timeout routine from polling the keyboard */ 1508 if (!kbdc_lock(kbdc, TRUE)) 1509 return EBUSY; 1510 1511 /* disable the keyboard and mouse interrupt */ 1512 s = spltty(); 1513 #if 0 1514 c = get_controller_command_byte(kbdc); 1515 if ((c == -1) 1516 || !set_controller_command_byte(kbdc, 1517 kbdc_get_device_mask(kbdc), 1518 KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT 1519 | KBD_DISABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) { 1520 /* CONTROLLER ERROR */ 1521 kbdc_lock(kbdc, FALSE); 1522 splx(s); 1523 return EIO; 1524 } 1525 /* 1526 * Now that the keyboard controller is told not to generate 1527 * the keyboard and mouse interrupts, call `splx()' to allow 1528 * the other tty interrupts. The clock interrupt may also occur, 1529 * but the timeout routine (`scrn_timer()') will be blocked 1530 * by the lock flag set via `kbdc_lock()' 1531 */ 1532 splx(s); 1533 #endif 1534 if (send_kbd_command_and_data(kbdc, command, data) != KBD_ACK) 1535 send_kbd_command(kbdc, KBDC_ENABLE_KBD); 1536 #if 0 1537 /* restore the interrupts */ 1538 if (!set_controller_command_byte(kbdc, kbdc_get_device_mask(kbdc), 1539 c & (KBD_KBD_CONTROL_BITS | KBD_AUX_CONTROL_BITS))) { 1540 /* CONTROLLER ERROR */ 1541 } 1542 #else 1543 splx(s); 1544 #endif 1545 kbdc_lock(kbdc, FALSE); 1546 1547 return 0; 1548 } 1549 1550 static int 1551 get_kbd_id(KBDC kbdc) 1552 { 1553 int id1, id2; 1554 1555 empty_both_buffers(kbdc, 10); 1556 id1 = id2 = -1; 1557 if (send_kbd_command(kbdc, KBDC_SEND_DEV_ID) != KBD_ACK) 1558 return -1; 1559 1560 DELAY(10000); /* 10 msec delay */ 1561 id1 = read_kbd_data(kbdc); 1562 if (id1 != -1) 1563 id2 = read_kbd_data(kbdc); 1564 1565 if ((id1 == -1) || (id2 == -1)) { 1566 empty_both_buffers(kbdc, 10); 1567 test_controller(kbdc); 1568 test_kbd_port(kbdc); 1569 return -1; 1570 } 1571 return ((id2 << 8) | id1); 1572 } 1573 1574 static int delays[] = { 250, 500, 750, 1000 }; 1575 static int rates[] = { 34, 38, 42, 46, 50, 55, 59, 63, 1576 68, 76, 84, 92, 100, 110, 118, 126, 1577 136, 152, 168, 184, 200, 220, 236, 252, 1578 272, 304, 336, 368, 400, 440, 472, 504 }; 1579 1580 static int 1581 typematic_delay(int i) 1582 { 1583 return delays[(i >> 5) & 3]; 1584 } 1585 1586 static int 1587 typematic_rate(int i) 1588 { 1589 return rates[i & 0x1f]; 1590 } 1591 1592 static int 1593 typematic(int delay, int rate) 1594 { 1595 int value; 1596 int i; 1597 1598 for (i = nitems(delays) - 1; i > 0; --i) { 1599 if (delay >= delays[i]) 1600 break; 1601 } 1602 value = i << 5; 1603 for (i = nitems(rates) - 1; i > 0; --i) { 1604 if (rate >= rates[i]) 1605 break; 1606 } 1607 value |= i; 1608 return value; 1609 } 1610