1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 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 keycode = evdev_scancode2key(&state->ks_evdev_state, 688 scancode); 689 690 if (keycode != KEY_RESERVED) { 691 evdev_push_event(state->ks_evdev, EV_KEY, 692 (uint16_t)keycode, scancode & 0x80 ? 0 : 1); 693 evdev_sync(state->ks_evdev); 694 } 695 } 696 #endif 697 698 /* return the byte as is for the K_RAW mode */ 699 if (state->ks_mode == K_RAW) 700 return scancode; 701 702 /* translate the scan code into a keycode */ 703 keycode = scancode & 0x7F; 704 switch (state->ks_prefix) { 705 case 0x00: /* normal scancode */ 706 switch(scancode) { 707 case 0xB8: /* left alt (compose key) released */ 708 if (state->ks_flags & COMPOSE) { 709 state->ks_flags &= ~COMPOSE; 710 if (state->ks_composed_char > UCHAR_MAX) 711 state->ks_composed_char = 0; 712 } 713 break; 714 case 0x38: /* left alt (compose key) pressed */ 715 if (!(state->ks_flags & COMPOSE)) { 716 state->ks_flags |= COMPOSE; 717 state->ks_composed_char = 0; 718 } 719 break; 720 case 0xE0: 721 case 0xE1: 722 state->ks_prefix = scancode; 723 goto next_code; 724 } 725 break; 726 case 0xE0: /* 0xE0 prefix */ 727 state->ks_prefix = 0; 728 switch (keycode) { 729 case 0x1C: /* right enter key */ 730 keycode = 0x59; 731 break; 732 case 0x1D: /* right ctrl key */ 733 keycode = 0x5A; 734 break; 735 case 0x35: /* keypad divide key */ 736 keycode = 0x5B; 737 break; 738 case 0x37: /* print scrn key */ 739 keycode = 0x5C; 740 break; 741 case 0x38: /* right alt key (alt gr) */ 742 keycode = 0x5D; 743 break; 744 case 0x46: /* ctrl-pause/break on AT 101 (see below) */ 745 keycode = 0x68; 746 break; 747 case 0x47: /* grey home key */ 748 keycode = 0x5E; 749 break; 750 case 0x48: /* grey up arrow key */ 751 keycode = 0x5F; 752 break; 753 case 0x49: /* grey page up key */ 754 keycode = 0x60; 755 break; 756 case 0x4B: /* grey left arrow key */ 757 keycode = 0x61; 758 break; 759 case 0x4D: /* grey right arrow key */ 760 keycode = 0x62; 761 break; 762 case 0x4F: /* grey end key */ 763 keycode = 0x63; 764 break; 765 case 0x50: /* grey down arrow key */ 766 keycode = 0x64; 767 break; 768 case 0x51: /* grey page down key */ 769 keycode = 0x65; 770 break; 771 case 0x52: /* grey insert key */ 772 keycode = 0x66; 773 break; 774 case 0x53: /* grey delete key */ 775 keycode = 0x67; 776 break; 777 /* the following 3 are only used on the MS "Natural" keyboard */ 778 case 0x5b: /* left Window key */ 779 keycode = 0x69; 780 break; 781 case 0x5c: /* right Window key */ 782 keycode = 0x6a; 783 break; 784 case 0x5d: /* menu key */ 785 keycode = 0x6b; 786 break; 787 case 0x5e: /* power key */ 788 keycode = 0x6d; 789 break; 790 case 0x5f: /* sleep key */ 791 keycode = 0x6e; 792 break; 793 case 0x63: /* wake key */ 794 keycode = 0x6f; 795 break; 796 default: /* ignore everything else */ 797 goto next_code; 798 } 799 break; 800 case 0xE1: /* 0xE1 prefix */ 801 /* 802 * The pause/break key on the 101 keyboard produces: 803 * E1-1D-45 E1-9D-C5 804 * Ctrl-pause/break produces: 805 * E0-46 E0-C6 (See above.) 806 */ 807 state->ks_prefix = 0; 808 if (keycode == 0x1D) 809 state->ks_prefix = 0x1D; 810 goto next_code; 811 /* NOT REACHED */ 812 case 0x1D: /* pause / break */ 813 state->ks_prefix = 0; 814 if (keycode != 0x45) 815 goto next_code; 816 keycode = 0x68; 817 break; 818 } 819 820 if (kbd->kb_type == KB_84) { 821 switch (keycode) { 822 case 0x37: /* *(numpad)/print screen */ 823 if (state->ks_flags & SHIFTS) 824 keycode = 0x5c; /* print screen */ 825 break; 826 case 0x45: /* num lock/pause */ 827 if (state->ks_flags & CTLS) 828 keycode = 0x68; /* pause */ 829 break; 830 case 0x46: /* scroll lock/break */ 831 if (state->ks_flags & CTLS) 832 keycode = 0x6c; /* break */ 833 break; 834 } 835 } else if (kbd->kb_type == KB_101) { 836 switch (keycode) { 837 case 0x5c: /* print screen */ 838 if (state->ks_flags & ALTS) 839 keycode = 0x54; /* sysrq */ 840 break; 841 case 0x68: /* pause/break */ 842 if (state->ks_flags & CTLS) 843 keycode = 0x6c; /* break */ 844 break; 845 } 846 } 847 848 /* return the key code in the K_CODE mode */ 849 if (state->ks_mode == K_CODE) 850 return (keycode | (scancode & 0x80)); 851 852 /* compose a character code */ 853 if (state->ks_flags & COMPOSE) { 854 switch (keycode | (scancode & 0x80)) { 855 /* key pressed, process it */ 856 case 0x47: case 0x48: case 0x49: /* keypad 7,8,9 */ 857 state->ks_composed_char *= 10; 858 state->ks_composed_char += keycode - 0x40; 859 if (state->ks_composed_char > UCHAR_MAX) 860 return ERRKEY; 861 goto next_code; 862 case 0x4B: case 0x4C: case 0x4D: /* keypad 4,5,6 */ 863 state->ks_composed_char *= 10; 864 state->ks_composed_char += keycode - 0x47; 865 if (state->ks_composed_char > UCHAR_MAX) 866 return ERRKEY; 867 goto next_code; 868 case 0x4F: case 0x50: case 0x51: /* keypad 1,2,3 */ 869 state->ks_composed_char *= 10; 870 state->ks_composed_char += keycode - 0x4E; 871 if (state->ks_composed_char > UCHAR_MAX) 872 return ERRKEY; 873 goto next_code; 874 case 0x52: /* keypad 0 */ 875 state->ks_composed_char *= 10; 876 if (state->ks_composed_char > UCHAR_MAX) 877 return ERRKEY; 878 goto next_code; 879 880 /* key released, no interest here */ 881 case 0xC7: case 0xC8: case 0xC9: /* keypad 7,8,9 */ 882 case 0xCB: case 0xCC: case 0xCD: /* keypad 4,5,6 */ 883 case 0xCF: case 0xD0: case 0xD1: /* keypad 1,2,3 */ 884 case 0xD2: /* keypad 0 */ 885 goto next_code; 886 887 case 0x38: /* left alt key */ 888 break; 889 890 default: 891 if (state->ks_composed_char > 0) { 892 state->ks_flags &= ~COMPOSE; 893 state->ks_composed_char = 0; 894 return ERRKEY; 895 } 896 break; 897 } 898 } 899 900 /* keycode to key action */ 901 action = genkbd_keyaction(kbd, keycode, scancode & 0x80, 902 &state->ks_state, &state->ks_accents); 903 if (action == NOKEY) 904 goto next_code; 905 else 906 return action; 907 } 908 909 /* check if char is waiting */ 910 static int 911 atkbd_check_char(keyboard_t *kbd) 912 { 913 atkbd_state_t *state; 914 915 if (!KBD_IS_ACTIVE(kbd)) 916 return FALSE; 917 state = (atkbd_state_t *)kbd->kb_data; 918 if (!(state->ks_flags & COMPOSE) && (state->ks_composed_char > 0)) 919 return TRUE; 920 return kbdc_data_ready(state->kbdc); 921 } 922 923 /* some useful control functions */ 924 static int 925 atkbd_ioctl(keyboard_t *kbd, u_long cmd, caddr_t arg) 926 { 927 /* translate LED_XXX bits into the device specific bits */ 928 static u_char ledmap[8] = { 929 0, 4, 2, 6, 1, 5, 3, 7, 930 }; 931 atkbd_state_t *state = kbd->kb_data; 932 int error; 933 int s; 934 int i; 935 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \ 936 defined(COMPAT_FREEBSD4) || defined(COMPAT_43) 937 int ival; 938 #endif 939 940 s = spltty(); 941 switch (cmd) { 942 case KDGKBMODE: /* get keyboard mode */ 943 *(int *)arg = state->ks_mode; 944 break; 945 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \ 946 defined(COMPAT_FREEBSD4) || defined(COMPAT_43) 947 case _IO('K', 7): 948 ival = IOCPARM_IVAL(arg); 949 arg = (caddr_t)&ival; 950 /* FALLTHROUGH */ 951 #endif 952 case KDSKBMODE: /* set keyboard mode */ 953 switch (*(int *)arg) { 954 case K_XLATE: 955 if (state->ks_mode != K_XLATE) { 956 /* make lock key state and LED state match */ 957 state->ks_state &= ~LOCK_MASK; 958 state->ks_state |= KBD_LED_VAL(kbd); 959 } 960 /* FALLTHROUGH */ 961 case K_RAW: 962 case K_CODE: 963 if (state->ks_mode != *(int *)arg) { 964 atkbd_clear_state(kbd); 965 state->ks_mode = *(int *)arg; 966 } 967 break; 968 default: 969 splx(s); 970 return EINVAL; 971 } 972 break; 973 974 case KDGETLED: /* get keyboard LED */ 975 *(int *)arg = KBD_LED_VAL(kbd); 976 break; 977 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \ 978 defined(COMPAT_FREEBSD4) || defined(COMPAT_43) 979 case _IO('K', 66): 980 ival = IOCPARM_IVAL(arg); 981 arg = (caddr_t)&ival; 982 /* FALLTHROUGH */ 983 #endif 984 case KDSETLED: /* set keyboard LED */ 985 /* NOTE: lock key state in ks_state won't be changed */ 986 if (*(int *)arg & ~LOCK_MASK) { 987 splx(s); 988 return EINVAL; 989 } 990 i = *(int *)arg; 991 /* replace CAPS LED with ALTGR LED for ALTGR keyboards */ 992 if (state->ks_mode == K_XLATE && 993 kbd->kb_keymap->n_keys > ALTGR_OFFSET) { 994 if (i & ALKED) 995 i |= CLKED; 996 else 997 i &= ~CLKED; 998 } 999 if (KBD_HAS_DEVICE(kbd)) { 1000 error = write_kbd(state->kbdc, KBDC_SET_LEDS, 1001 ledmap[i & LED_MASK]); 1002 if (error) { 1003 splx(s); 1004 return error; 1005 } 1006 } 1007 #ifdef EVDEV_SUPPORT 1008 /* push LED states to evdev */ 1009 if (state->ks_evdev != NULL && 1010 evdev_rcpt_mask & EVDEV_RCPT_HW_KBD) 1011 evdev_push_leds(state->ks_evdev, *(int *)arg); 1012 #endif 1013 KBD_LED_VAL(kbd) = *(int *)arg; 1014 break; 1015 1016 case KDGKBSTATE: /* get lock key state */ 1017 *(int *)arg = state->ks_state & LOCK_MASK; 1018 break; 1019 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \ 1020 defined(COMPAT_FREEBSD4) || defined(COMPAT_43) 1021 case _IO('K', 20): 1022 ival = IOCPARM_IVAL(arg); 1023 arg = (caddr_t)&ival; 1024 /* FALLTHROUGH */ 1025 #endif 1026 case KDSKBSTATE: /* set lock key state */ 1027 if (*(int *)arg & ~LOCK_MASK) { 1028 splx(s); 1029 return EINVAL; 1030 } 1031 state->ks_state &= ~LOCK_MASK; 1032 state->ks_state |= *(int *)arg; 1033 splx(s); 1034 /* set LEDs and quit */ 1035 return atkbd_ioctl(kbd, KDSETLED, arg); 1036 1037 case KDSETREPEAT: /* set keyboard repeat rate (new interface) */ 1038 splx(s); 1039 if (!KBD_HAS_DEVICE(kbd)) 1040 return 0; 1041 i = typematic(((int *)arg)[0], ((int *)arg)[1]); 1042 error = write_kbd(state->kbdc, KBDC_SET_TYPEMATIC, i); 1043 if (error == 0) { 1044 kbd->kb_delay1 = typematic_delay(i); 1045 kbd->kb_delay2 = typematic_rate(i); 1046 #ifdef EVDEV_SUPPORT 1047 if (state->ks_evdev != NULL && 1048 evdev_rcpt_mask & EVDEV_RCPT_HW_KBD) 1049 evdev_push_repeats(state->ks_evdev, kbd); 1050 #endif 1051 } 1052 return error; 1053 1054 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \ 1055 defined(COMPAT_FREEBSD4) || defined(COMPAT_43) 1056 case _IO('K', 67): 1057 ival = IOCPARM_IVAL(arg); 1058 arg = (caddr_t)&ival; 1059 /* FALLTHROUGH */ 1060 #endif 1061 case KDSETRAD: /* set keyboard repeat rate (old interface) */ 1062 splx(s); 1063 if (!KBD_HAS_DEVICE(kbd)) 1064 return 0; 1065 error = write_kbd(state->kbdc, KBDC_SET_TYPEMATIC, *(int *)arg); 1066 if (error == 0) { 1067 kbd->kb_delay1 = typematic_delay(*(int *)arg); 1068 kbd->kb_delay2 = typematic_rate(*(int *)arg); 1069 #ifdef EVDEV_SUPPORT 1070 if (state->ks_evdev != NULL && 1071 evdev_rcpt_mask & EVDEV_RCPT_HW_KBD) 1072 evdev_push_repeats(state->ks_evdev, kbd); 1073 #endif 1074 } 1075 return error; 1076 1077 case PIO_KEYMAP: /* set keyboard translation table */ 1078 case OPIO_KEYMAP: /* set keyboard translation table (compat) */ 1079 case PIO_KEYMAPENT: /* set keyboard translation table entry */ 1080 case PIO_DEADKEYMAP: /* set accent key translation table */ 1081 state->ks_accents = 0; 1082 /* FALLTHROUGH */ 1083 default: 1084 splx(s); 1085 return genkbd_commonioctl(kbd, cmd, arg); 1086 } 1087 1088 splx(s); 1089 return 0; 1090 } 1091 1092 /* lock the access to the keyboard */ 1093 static int 1094 atkbd_lock(keyboard_t *kbd, int lock) 1095 { 1096 return kbdc_lock(((atkbd_state_t *)kbd->kb_data)->kbdc, lock); 1097 } 1098 1099 /* clear the internal state of the keyboard */ 1100 static void 1101 atkbd_clear_state(keyboard_t *kbd) 1102 { 1103 atkbd_state_t *state; 1104 1105 state = (atkbd_state_t *)kbd->kb_data; 1106 state->ks_flags = 0; 1107 state->ks_polling = 0; 1108 state->ks_state &= LOCK_MASK; /* preserve locking key state */ 1109 state->ks_accents = 0; 1110 state->ks_composed_char = 0; 1111 #if 0 1112 state->ks_prefix = 0; /* XXX */ 1113 #endif 1114 } 1115 1116 /* save the internal state */ 1117 static int 1118 atkbd_get_state(keyboard_t *kbd, void *buf, size_t len) 1119 { 1120 if (len == 0) 1121 return sizeof(atkbd_state_t); 1122 if (len < sizeof(atkbd_state_t)) 1123 return -1; 1124 bcopy(kbd->kb_data, buf, sizeof(atkbd_state_t)); 1125 return 0; 1126 } 1127 1128 /* set the internal state */ 1129 static int 1130 atkbd_set_state(keyboard_t *kbd, void *buf, size_t len) 1131 { 1132 if (len < sizeof(atkbd_state_t)) 1133 return ENOMEM; 1134 if (((atkbd_state_t *)kbd->kb_data)->kbdc 1135 != ((atkbd_state_t *)buf)->kbdc) 1136 return ENOMEM; 1137 bcopy(buf, kbd->kb_data, sizeof(atkbd_state_t)); 1138 return 0; 1139 } 1140 1141 static int 1142 atkbd_poll(keyboard_t *kbd, int on) 1143 { 1144 atkbd_state_t *state; 1145 int s; 1146 1147 state = (atkbd_state_t *)kbd->kb_data; 1148 s = spltty(); 1149 if (on) 1150 ++state->ks_polling; 1151 else 1152 --state->ks_polling; 1153 splx(s); 1154 return 0; 1155 } 1156 1157 static int 1158 atkbd_reset(KBDC kbdc, int flags, int c) 1159 { 1160 /* reset keyboard hardware */ 1161 if (!(flags & KB_CONF_NO_RESET) && !reset_kbd(kbdc)) { 1162 /* 1163 * KEYBOARD ERROR 1164 * Keyboard reset may fail either because the keyboard 1165 * doen't exist, or because the keyboard doesn't pass 1166 * the self-test, or the keyboard controller on the 1167 * motherboard and the keyboard somehow fail to shake hands. 1168 * It is just possible, particularly in the last case, 1169 * that the keyboard controller may be left in a hung state. 1170 * test_controller() and test_kbd_port() appear to bring 1171 * the keyboard controller back (I don't know why and how, 1172 * though.) 1173 */ 1174 empty_both_buffers(kbdc, 10); 1175 test_controller(kbdc); 1176 test_kbd_port(kbdc); 1177 /* 1178 * We could disable the keyboard port and interrupt... but, 1179 * the keyboard may still exist (see above). 1180 */ 1181 set_controller_command_byte(kbdc, 1182 ALLOW_DISABLE_KBD(kbdc) ? 0xff : KBD_KBD_CONTROL_BITS, c); 1183 if (bootverbose) 1184 printf("atkbd: failed to reset the keyboard.\n"); 1185 return (EIO); 1186 } 1187 return (0); 1188 } 1189 1190 #ifdef EVDEV_SUPPORT 1191 static void 1192 atkbd_ev_event(struct evdev_dev *evdev, uint16_t type, uint16_t code, 1193 int32_t value) 1194 { 1195 keyboard_t *kbd = evdev_get_softc(evdev); 1196 1197 if (evdev_rcpt_mask & EVDEV_RCPT_HW_KBD && 1198 (type == EV_LED || type == EV_REP)) { 1199 mtx_lock(&Giant); 1200 kbd_ev_event(kbd, type, code, value); 1201 mtx_unlock(&Giant); 1202 } 1203 } 1204 #endif 1205 1206 /* local functions */ 1207 1208 static int 1209 set_typematic(keyboard_t *kbd) 1210 { 1211 int val, error; 1212 atkbd_state_t *state = kbd->kb_data; 1213 1214 val = typematic(DEFAULT_DELAY, DEFAULT_RATE); 1215 error = write_kbd(state->kbdc, KBDC_SET_TYPEMATIC, val); 1216 if (error == 0) { 1217 kbd->kb_delay1 = typematic_delay(val); 1218 kbd->kb_delay2 = typematic_rate(val); 1219 } 1220 1221 return (error); 1222 } 1223 1224 static int 1225 setup_kbd_port(KBDC kbdc, int port, int intr) 1226 { 1227 if (!set_controller_command_byte(kbdc, 1228 KBD_KBD_CONTROL_BITS, 1229 ((port) ? KBD_ENABLE_KBD_PORT : KBD_DISABLE_KBD_PORT) 1230 | ((intr) ? KBD_ENABLE_KBD_INT : KBD_DISABLE_KBD_INT))) 1231 return 1; 1232 return 0; 1233 } 1234 1235 static int 1236 get_kbd_echo(KBDC kbdc) 1237 { 1238 /* enable the keyboard port, but disable the keyboard intr. */ 1239 if (setup_kbd_port(kbdc, TRUE, FALSE)) 1240 /* CONTROLLER ERROR: there is very little we can do... */ 1241 return ENXIO; 1242 1243 /* see if something is present */ 1244 write_kbd_command(kbdc, KBDC_ECHO); 1245 if (read_kbd_data(kbdc) != KBD_ECHO) { 1246 empty_both_buffers(kbdc, 10); 1247 test_controller(kbdc); 1248 test_kbd_port(kbdc); 1249 return ENXIO; 1250 } 1251 1252 /* enable the keyboard port and intr. */ 1253 if (setup_kbd_port(kbdc, TRUE, TRUE)) { 1254 /* 1255 * CONTROLLER ERROR 1256 * This is serious; the keyboard intr is left disabled! 1257 */ 1258 return ENXIO; 1259 } 1260 1261 return 0; 1262 } 1263 1264 static int 1265 probe_keyboard(KBDC kbdc, int flags) 1266 { 1267 /* 1268 * Don't try to print anything in this function. The low-level 1269 * console may not have been initialized yet... 1270 */ 1271 int err; 1272 int c; 1273 int m; 1274 1275 if (!kbdc_lock(kbdc, TRUE)) { 1276 /* driver error? */ 1277 return ENXIO; 1278 } 1279 1280 /* temporarily block data transmission from the keyboard */ 1281 write_controller_command(kbdc, KBDC_DISABLE_KBD_PORT); 1282 1283 /* flush any noise in the buffer */ 1284 empty_both_buffers(kbdc, 100); 1285 1286 /* save the current keyboard controller command byte */ 1287 m = kbdc_get_device_mask(kbdc) & ~KBD_KBD_CONTROL_BITS; 1288 c = get_controller_command_byte(kbdc); 1289 if (c == -1) { 1290 /* CONTROLLER ERROR */ 1291 kbdc_set_device_mask(kbdc, m); 1292 kbdc_lock(kbdc, FALSE); 1293 return ENXIO; 1294 } 1295 1296 /* 1297 * The keyboard may have been screwed up by the boot block. 1298 * We may just be able to recover from error by testing the controller 1299 * and the keyboard port. The controller command byte needs to be 1300 * saved before this recovery operation, as some controllers seem 1301 * to set the command byte to particular values. 1302 */ 1303 test_controller(kbdc); 1304 if (!(flags & KB_CONF_NO_PROBE_TEST)) 1305 test_kbd_port(kbdc); 1306 1307 err = get_kbd_echo(kbdc); 1308 1309 /* 1310 * Even if the keyboard doesn't seem to be present (err != 0), 1311 * we shall enable the keyboard port and interrupt so that 1312 * the driver will be operable when the keyboard is attached 1313 * to the system later. It is NOT recommended to hot-plug 1314 * the AT keyboard, but many people do so... 1315 */ 1316 kbdc_set_device_mask(kbdc, m | KBD_KBD_CONTROL_BITS); 1317 setup_kbd_port(kbdc, TRUE, TRUE); 1318 #if 0 1319 if (err == 0) { 1320 kbdc_set_device_mask(kbdc, m | KBD_KBD_CONTROL_BITS); 1321 } else { 1322 /* try to restore the command byte as before */ 1323 set_controller_command_byte(kbdc, 1324 ALLOW_DISABLE_KBD(kbdc) ? 0xff : KBD_KBD_CONTROL_BITS, c); 1325 kbdc_set_device_mask(kbdc, m); 1326 } 1327 #endif 1328 1329 kbdc_lock(kbdc, FALSE); 1330 return (HAS_QUIRK(kbdc, KBDC_QUIRK_IGNORE_PROBE_RESULT) ? 0 : err); 1331 } 1332 1333 static int 1334 init_keyboard(KBDC kbdc, int *type, int flags) 1335 { 1336 int codeset; 1337 int id; 1338 int c; 1339 1340 if (!kbdc_lock(kbdc, TRUE)) { 1341 /* driver error? */ 1342 return EIO; 1343 } 1344 1345 /* temporarily block data transmission from the keyboard */ 1346 write_controller_command(kbdc, KBDC_DISABLE_KBD_PORT); 1347 1348 /* save the current controller command byte */ 1349 empty_both_buffers(kbdc, 200); 1350 c = get_controller_command_byte(kbdc); 1351 if (c == -1) { 1352 /* CONTROLLER ERROR */ 1353 kbdc_lock(kbdc, FALSE); 1354 printf("atkbd: unable to get the current command byte value.\n"); 1355 return EIO; 1356 } 1357 if (bootverbose) 1358 printf("atkbd: the current kbd controller command byte %04x\n", 1359 c); 1360 #if 0 1361 /* override the keyboard lock switch */ 1362 c |= KBD_OVERRIDE_KBD_LOCK; 1363 #endif 1364 1365 /* enable the keyboard port, but disable the keyboard intr. */ 1366 if (setup_kbd_port(kbdc, TRUE, FALSE)) { 1367 /* CONTROLLER ERROR: there is very little we can do... */ 1368 printf("atkbd: unable to set the command byte.\n"); 1369 kbdc_lock(kbdc, FALSE); 1370 return EIO; 1371 } 1372 1373 if (HAS_QUIRK(kbdc, KBDC_QUIRK_RESET_AFTER_PROBE) && 1374 atkbd_reset(kbdc, flags, c)) { 1375 kbdc_lock(kbdc, FALSE); 1376 return EIO; 1377 } 1378 1379 /* 1380 * Check if we have an XT keyboard before we attempt to reset it. 1381 * The procedure assumes that the keyboard and the controller have 1382 * been set up properly by BIOS and have not been messed up 1383 * during the boot process. 1384 */ 1385 codeset = -1; 1386 if (flags & KB_CONF_ALT_SCANCODESET) 1387 /* the user says there is a XT keyboard */ 1388 codeset = 1; 1389 #ifdef KBD_DETECT_XT_KEYBOARD 1390 else if ((c & KBD_TRANSLATION) == 0) { 1391 /* SET_SCANCODE_SET is not always supported; ignore error */ 1392 if (send_kbd_command_and_data(kbdc, KBDC_SET_SCANCODE_SET, 0) 1393 == KBD_ACK) 1394 codeset = read_kbd_data(kbdc); 1395 } 1396 if (bootverbose) 1397 printf("atkbd: scancode set %d\n", codeset); 1398 #endif /* KBD_DETECT_XT_KEYBOARD */ 1399 1400 *type = KB_OTHER; 1401 id = get_kbd_id(kbdc); 1402 switch(id) { 1403 case 0x41ab: /* 101/102/... Enhanced */ 1404 case 0x83ab: /* ditto */ 1405 case 0x54ab: /* SpaceSaver */ 1406 case 0x84ab: /* ditto */ 1407 #if 0 1408 case 0x90ab: /* 'G' */ 1409 case 0x91ab: /* 'P' */ 1410 case 0x92ab: /* 'A' */ 1411 #endif 1412 *type = KB_101; 1413 break; 1414 case -1: /* AT 84 keyboard doesn't return ID */ 1415 *type = KB_84; 1416 break; 1417 default: 1418 break; 1419 } 1420 if (bootverbose) 1421 printf("atkbd: keyboard ID 0x%x (%d)\n", id, *type); 1422 1423 if (!HAS_QUIRK(kbdc, KBDC_QUIRK_RESET_AFTER_PROBE) && 1424 atkbd_reset(kbdc, flags, c)) { 1425 kbdc_lock(kbdc, FALSE); 1426 return EIO; 1427 } 1428 1429 /* 1430 * Allow us to set the XT_KEYBD flag so that keyboards 1431 * such as those on the IBM ThinkPad laptop computers can be used 1432 * with the standard console driver. 1433 */ 1434 if (codeset == 1) { 1435 if (send_kbd_command_and_data(kbdc, 1436 KBDC_SET_SCANCODE_SET, codeset) == KBD_ACK) { 1437 /* XT kbd doesn't need scan code translation */ 1438 c &= ~KBD_TRANSLATION; 1439 } else { 1440 /* 1441 * KEYBOARD ERROR 1442 * The XT kbd isn't usable unless the proper scan 1443 * code set is selected. 1444 */ 1445 set_controller_command_byte(kbdc, ALLOW_DISABLE_KBD(kbdc) 1446 ? 0xff : KBD_KBD_CONTROL_BITS, c); 1447 kbdc_lock(kbdc, FALSE); 1448 printf("atkbd: unable to set the XT keyboard mode.\n"); 1449 return EIO; 1450 } 1451 } 1452 1453 /* 1454 * Some keyboards require a SETLEDS command to be sent after 1455 * the reset command before they will send keystrokes to us 1456 */ 1457 if (HAS_QUIRK(kbdc, KBDC_QUIRK_SETLEDS_ON_INIT) && 1458 send_kbd_command_and_data(kbdc, KBDC_SET_LEDS, 0) != KBD_ACK) { 1459 printf("atkbd: setleds failed\n"); 1460 } 1461 if (!ALLOW_DISABLE_KBD(kbdc)) 1462 send_kbd_command(kbdc, KBDC_ENABLE_KBD); 1463 1464 /* enable the keyboard port and intr. */ 1465 if (!set_controller_command_byte(kbdc, 1466 KBD_KBD_CONTROL_BITS | KBD_TRANSLATION | KBD_OVERRIDE_KBD_LOCK, 1467 (c & (KBD_TRANSLATION | KBD_OVERRIDE_KBD_LOCK)) 1468 | KBD_ENABLE_KBD_PORT | KBD_ENABLE_KBD_INT)) { 1469 /* 1470 * CONTROLLER ERROR 1471 * This is serious; we are left with the disabled 1472 * keyboard intr. 1473 */ 1474 set_controller_command_byte(kbdc, ALLOW_DISABLE_KBD(kbdc) 1475 ? 0xff : (KBD_KBD_CONTROL_BITS | KBD_TRANSLATION | 1476 KBD_OVERRIDE_KBD_LOCK), c); 1477 kbdc_lock(kbdc, FALSE); 1478 printf("atkbd: unable to enable the keyboard port and intr.\n"); 1479 return EIO; 1480 } 1481 1482 kbdc_lock(kbdc, FALSE); 1483 return 0; 1484 } 1485 1486 static int 1487 write_kbd(KBDC kbdc, int command, int data) 1488 { 1489 int s; 1490 1491 /* prevent the timeout routine from polling the keyboard */ 1492 if (!kbdc_lock(kbdc, TRUE)) 1493 return EBUSY; 1494 1495 /* disable the keyboard and mouse interrupt */ 1496 s = spltty(); 1497 #if 0 1498 c = get_controller_command_byte(kbdc); 1499 if ((c == -1) 1500 || !set_controller_command_byte(kbdc, 1501 kbdc_get_device_mask(kbdc), 1502 KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT 1503 | KBD_DISABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) { 1504 /* CONTROLLER ERROR */ 1505 kbdc_lock(kbdc, FALSE); 1506 splx(s); 1507 return EIO; 1508 } 1509 /* 1510 * Now that the keyboard controller is told not to generate 1511 * the keyboard and mouse interrupts, call `splx()' to allow 1512 * the other tty interrupts. The clock interrupt may also occur, 1513 * but the timeout routine (`scrn_timer()') will be blocked 1514 * by the lock flag set via `kbdc_lock()' 1515 */ 1516 splx(s); 1517 #endif 1518 if (send_kbd_command_and_data(kbdc, command, data) != KBD_ACK) 1519 send_kbd_command(kbdc, KBDC_ENABLE_KBD); 1520 #if 0 1521 /* restore the interrupts */ 1522 if (!set_controller_command_byte(kbdc, kbdc_get_device_mask(kbdc), 1523 c & (KBD_KBD_CONTROL_BITS | KBD_AUX_CONTROL_BITS))) { 1524 /* CONTROLLER ERROR */ 1525 } 1526 #else 1527 splx(s); 1528 #endif 1529 kbdc_lock(kbdc, FALSE); 1530 1531 return 0; 1532 } 1533 1534 static int 1535 get_kbd_id(KBDC kbdc) 1536 { 1537 int id1, id2; 1538 1539 empty_both_buffers(kbdc, 10); 1540 id1 = id2 = -1; 1541 if (send_kbd_command(kbdc, KBDC_SEND_DEV_ID) != KBD_ACK) 1542 return -1; 1543 1544 DELAY(10000); /* 10 msec delay */ 1545 id1 = read_kbd_data(kbdc); 1546 if (id1 != -1) 1547 id2 = read_kbd_data(kbdc); 1548 1549 if ((id1 == -1) || (id2 == -1)) { 1550 empty_both_buffers(kbdc, 10); 1551 test_controller(kbdc); 1552 test_kbd_port(kbdc); 1553 return -1; 1554 } 1555 return ((id2 << 8) | id1); 1556 } 1557 1558 static int delays[] = { 250, 500, 750, 1000 }; 1559 static int rates[] = { 34, 38, 42, 46, 50, 55, 59, 63, 1560 68, 76, 84, 92, 100, 110, 118, 126, 1561 136, 152, 168, 184, 200, 220, 236, 252, 1562 272, 304, 336, 368, 400, 440, 472, 504 }; 1563 1564 static int 1565 typematic_delay(int i) 1566 { 1567 return delays[(i >> 5) & 3]; 1568 } 1569 1570 static int 1571 typematic_rate(int i) 1572 { 1573 return rates[i & 0x1f]; 1574 } 1575 1576 static int 1577 typematic(int delay, int rate) 1578 { 1579 int value; 1580 int i; 1581 1582 for (i = nitems(delays) - 1; i > 0; --i) { 1583 if (delay >= delays[i]) 1584 break; 1585 } 1586 value = i << 5; 1587 for (i = nitems(rates) - 1; i > 0; --i) { 1588 if (rate >= rates[i]) 1589 break; 1590 } 1591 value |= i; 1592 return value; 1593 } 1594