atkbd.c revision 43337
1/*- 2 * Copyright (c) 1999 Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp> 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer as 10 * the first lines of this file unmodified. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR 16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, 19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25 * 26 * $Id: atkbd.c,v 1.3 1999/01/19 11:31:14 yokota Exp $ 27 */ 28 29#include "atkbd.h" 30#include "opt_kbd.h" 31#include "opt_devfs.h" 32 33#if NATKBD > 0 34 35#include <sys/param.h> 36#include <sys/systm.h> 37#include <sys/kernel.h> 38#include <sys/conf.h> 39#include <sys/proc.h> 40#include <sys/tty.h> 41#include <sys/fcntl.h> 42#include <sys/malloc.h> 43 44#include <dev/kbd/kbdreg.h> 45#include <dev/kbd/atkbdreg.h> 46#include <dev/kbd/atkbdcreg.h> 47 48#ifndef __i386__ 49 50#include <isa/isareg.h> 51 52#define ATKBD_SOFTC(unit) \ 53 ((atkbd_softc_t *)devclass_get_softc(atkbd_devclass, unit)) 54 55#else /* __i386__ */ 56 57#include <i386/isa/isa.h> 58#include <i386/isa/isa_device.h> 59 60extern struct isa_driver atkbddriver; /* XXX: a kludge; see below */ 61 62static atkbd_softc_t *atkbd_softc[NATKBD]; 63 64#define ATKBD_SOFTC(unit) atkbd_softc[(unit)] 65 66#endif /* __i386__ */ 67 68static timeout_t atkbd_timeout; 69 70#ifdef KBD_INSTALL_CDEV 71 72static d_open_t atkbdopen; 73static d_close_t atkbdclose; 74static d_read_t atkbdread; 75static d_ioctl_t atkbdioctl; 76static d_poll_t atkbdpoll; 77 78static struct cdevsw atkbd_cdevsw = { 79 atkbdopen, atkbdclose, atkbdread, nowrite, 80 atkbdioctl, nostop, nullreset, nodevtotty, 81 atkbdpoll, nommap, NULL, ATKBD_DRIVER_NAME, 82 NULL, -1, 83}; 84 85#endif /* KBD_INSTALL_CDEV */ 86 87#ifdef __i386__ 88 89atkbd_softc_t 90*atkbd_get_softc(int unit) 91{ 92 atkbd_softc_t *sc; 93 94 if (unit >= sizeof(atkbd_softc)/sizeof(atkbd_softc[0])) 95 return NULL; 96 sc = atkbd_softc[unit]; 97 if (sc == NULL) { 98 sc = atkbd_softc[unit] 99 = malloc(sizeof(*sc), M_DEVBUF, M_NOWAIT); 100 if (sc == NULL) 101 return NULL; 102 bzero(sc, sizeof(*sc)); 103 } 104 return sc; 105} 106 107#endif /* __i386__ */ 108 109int 110atkbd_probe_unit(int unit, atkbd_softc_t *sc, int port, int irq, int flags) 111{ 112 keyboard_switch_t *sw; 113 int args[2]; 114 115 if (sc->flags & ATKBD_ATTACHED) 116 return 0; 117 118 sw = kbd_get_switch(ATKBD_DRIVER_NAME); 119 if (sw == NULL) 120 return ENXIO; 121 122 args[0] = port; 123 args[1] = irq; 124 return (*sw->probe)(unit, &sc->kbd, args, flags); 125} 126 127int 128atkbd_attach_unit(int unit, atkbd_softc_t *sc) 129{ 130 keyboard_switch_t *sw; 131 int error; 132 133 if (sc->flags & ATKBD_ATTACHED) 134 return 0; 135 136 sw = kbd_get_switch(ATKBD_DRIVER_NAME); 137 if (sw == NULL) 138 return ENXIO; 139 140 /* reset, initialize and enable the device */ 141 error = (*sw->init)(sc->kbd); 142 if (error) 143 return ENXIO; 144 (*sw->enable)(sc->kbd); 145 146#ifdef KBD_INSTALL_CDEV 147 /* attach a virtual keyboard cdev */ 148 error = kbd_attach(makedev(0, ATKBD_MKMINOR(unit)), sc->kbd, 149 &atkbd_cdevsw); 150 if (error) 151 return error; 152#endif 153 154 /* 155 * This is a kludge to compensate for lost keyboard interrupts. 156 * A similar code used to be in syscons. See below. XXX 157 */ 158 atkbd_timeout(sc->kbd); 159 160 if (bootverbose) 161 (*sw->diag)(sc->kbd, bootverbose); 162 163 sc->flags |= ATKBD_ATTACHED; 164 return 0; 165} 166 167static void 168atkbd_timeout(void *arg) 169{ 170 keyboard_t *kbd; 171 int s; 172 173 /* The following comments are extracted 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 scintr if input is ready for the keyboard 179 * and conveniently hides the problem. XXX 180 */ 181 /* 182 * Try removing anything stuck in the keyboard controller; whether 183 * it's a keyboard scan code or mouse data. `scintr()' doesn't 184 * read the mouse data directly, but `kbdio' routines will, as a 185 * side effect. 186 */ 187 s = spltty(); 188 kbd = (keyboard_t *)arg; 189 if ((*kbdsw[kbd->kb_index]->lock)(kbd, TRUE)) { 190 /* 191 * We have seen the lock flag is not set. Let's reset 192 * the flag early, otherwise the LED update routine fails 193 * which may want the lock during the interrupt routine. 194 */ 195 (*kbdsw[kbd->kb_index]->lock)(kbd, FALSE); 196 if ((*kbdsw[kbd->kb_index]->check_char)(kbd)) 197 (*kbdsw[kbd->kb_index]->intr)(kbd); 198 } 199 splx(s); 200 timeout(atkbd_timeout, arg, hz/10); 201} 202 203/* cdev driver functions */ 204 205#ifdef KBD_INSTALL_CDEV 206 207static int 208atkbdopen(dev_t dev, int flag, int mode, struct proc *p) 209{ 210 atkbd_softc_t *sc; 211 int unit; 212 213 unit = ATKBD_UNIT(dev); 214 if ((unit >= NATKBD) || ((sc = ATKBD_SOFTC(unit)) == NULL)) 215 return ENXIO; 216 if (mode & (FWRITE | O_CREAT | O_APPEND | O_TRUNC)) 217 return ENODEV; 218 219 /* FIXME: set the initial input mode (K_XLATE?) and lock state? */ 220 return genkbdopen(&sc->gensc, sc->kbd, flag, mode, p); 221} 222 223static int 224atkbdclose(dev_t dev, int flag, int mode, struct proc *p) 225{ 226 atkbd_softc_t *sc; 227 228 sc = ATKBD_SOFTC(ATKBD_UNIT(dev)); 229 return genkbdclose(&sc->gensc, sc->kbd, flag, mode, p); 230} 231 232static int 233atkbdread(dev_t dev, struct uio *uio, int flag) 234{ 235 atkbd_softc_t *sc; 236 237 sc = ATKBD_SOFTC(ATKBD_UNIT(dev)); 238 return genkbdread(&sc->gensc, sc->kbd, uio, flag); 239} 240 241static int 242atkbdioctl(dev_t dev, u_long cmd, caddr_t arg, int flag, struct proc *p) 243{ 244 atkbd_softc_t *sc; 245 246 sc = ATKBD_SOFTC(ATKBD_UNIT(dev)); 247 return genkbdioctl(&sc->gensc, sc->kbd, cmd, arg, flag, p); 248} 249 250static int 251atkbdpoll(dev_t dev, int event, struct proc *p) 252{ 253 atkbd_softc_t *sc; 254 255 sc = ATKBD_SOFTC(ATKBD_UNIT(dev)); 256 return genkbdpoll(&sc->gensc, sc->kbd, event, p); 257} 258 259#endif /* KBD_INSTALL_CDEV */ 260 261/* LOW-LEVEL */ 262 263#include <machine/limits.h> 264#include <machine/console.h> 265#include <machine/clock.h> 266 267#define ATKBD_DEFAULT 0 268 269typedef struct atkbd_state { 270 KBDC kbdc; /* keyboard controller */ 271 /* XXX: don't move this field; pcvt 272 * expects `kbdc' to be the first 273 * field in this structure. */ 274 int ks_mode; /* input mode (K_XLATE,K_RAW,K_CODE) */ 275 int ks_flags; /* flags */ 276#define COMPOSE (1 << 0) 277 int ks_state; /* shift/lock key state */ 278 int ks_accents; /* accent key index (> 0) */ 279 u_int ks_composed_char; /* composed char code (> 0) */ 280 u_char ks_prefix; /* AT scan code prefix */ 281} atkbd_state_t; 282 283/* keyboard driver declaration */ 284static int atkbd_configure(int flags); 285static kbd_probe_t atkbd_probe; 286static kbd_init_t atkbd_init; 287static kbd_term_t atkbd_term; 288static kbd_intr_t atkbd_intr; 289static kbd_test_if_t atkbd_test_if; 290static kbd_enable_t atkbd_enable; 291static kbd_disable_t atkbd_disable; 292static kbd_read_t atkbd_read; 293static kbd_check_t atkbd_check; 294static kbd_read_char_t atkbd_read_char; 295static kbd_check_char_t atkbd_check_char; 296static kbd_ioctl_t atkbd_ioctl; 297static kbd_lock_t atkbd_lock; 298static kbd_clear_state_t atkbd_clear_state; 299static kbd_get_state_t atkbd_get_state; 300static kbd_set_state_t atkbd_set_state; 301 302keyboard_switch_t atkbdsw = { 303 atkbd_probe, 304 atkbd_init, 305 atkbd_term, 306 atkbd_intr, 307 atkbd_test_if, 308 atkbd_enable, 309 atkbd_disable, 310 atkbd_read, 311 atkbd_check, 312 atkbd_read_char, 313 atkbd_check_char, 314 atkbd_ioctl, 315 atkbd_lock, 316 atkbd_clear_state, 317 atkbd_get_state, 318 atkbd_set_state, 319 genkbd_get_fkeystr, 320 genkbd_diag, 321}; 322 323KEYBOARD_DRIVER(atkbd, atkbdsw, atkbd_configure); 324 325/* local functions */ 326static int setup_kbd_port(KBDC kbdc, int port, int intr); 327static int get_kbd_echo(KBDC kbdc); 328static int probe_keyboard(KBDC kbdc, int flags); 329static int init_keyboard(KBDC kbdc, int *type, int flags); 330static int write_kbd(KBDC kbdc, int command, int data); 331static int get_kbd_id(KBDC kbdc); 332 333/* local variables */ 334 335/* the initial key map, accent map and fkey strings */ 336#include <dev/kbd/kbdtables.h> 337 338/* structures for the default keyboard */ 339static keyboard_t default_kbd; 340static atkbd_state_t default_kbd_state; 341static keymap_t default_keymap; 342static accentmap_t default_accentmap; 343static fkeytab_t default_fkeytab[NUM_FKEYS]; 344 345/* 346 * The back door to the keyboard driver! 347 * This function is called by the console driver, via the kbdio module, 348 * to tickle keyboard drivers when the low-level console is being initialized. 349 * Almost nothing in the kernel has been initialied yet. Try to probe 350 * keyboards if possible. 351 * NOTE: because of the way the low-level conole is initialized, this routine 352 * may be called more than once!! 353 */ 354static int 355atkbd_configure(int flags) 356{ 357 keyboard_t *kbd; 358 KBDC kbdc; 359 int arg[2]; 360#ifdef __i386__ 361 struct isa_device *dev; 362 363 /* XXX: a kludge to obtain the device configuration flags */ 364 dev = find_isadev(isa_devtab_tty, &atkbddriver, 0); 365 if (dev != NULL) 366 flags |= dev->id_flags; 367#endif 368 369 /* probe the keyboard controller */ 370 atkbdc_configure(); 371 372 /* probe the default keyboard */ 373 arg[0] = -1; 374 arg[1] = -1; 375 if (atkbd_probe(ATKBD_DEFAULT, &kbd, arg, flags)) 376 return 0; 377 378 /* initialize it */ 379 kbdc = ((atkbd_state_t *)kbd->kb_data)->kbdc; 380 if (!(flags & KB_CONF_PROBE_ONLY) && !KBD_IS_INITIALIZED(kbd)) { 381 if (KBD_HAS_DEVICE(kbd) 382 && init_keyboard(kbdc, &kbd->kb_type, flags) 383 && (flags & KB_CONF_FAIL_IF_NO_KBD)) 384 return 0; 385 KBD_INIT_DONE(kbd); 386 } 387 388 /* and register */ 389 if (!KBD_IS_CONFIGURED(kbd)) { 390 if (kbd_register(kbd) < 0) 391 return 0; 392 KBD_CONFIG_DONE(kbd); 393 } 394 395 return 1; /* return the number of found keyboards */ 396} 397 398/* low-level functions */ 399 400/* initialize the keyboard_t structure and try to detect a keyboard */ 401static int 402atkbd_probe(int unit, keyboard_t **kbdp, void *arg, int flags) 403{ 404 keyboard_t *kbd; 405 atkbd_state_t *state; 406 keymap_t *keymap; 407 accentmap_t *accmap; 408 fkeytab_t *fkeymap; 409 int fkeymap_size; 410 KBDC kbdc; 411 int *data = (int *)arg; 412 413 /* XXX */ 414 if (unit == ATKBD_DEFAULT) { 415 *kbdp = kbd = &default_kbd; 416 if (KBD_IS_PROBED(kbd)) 417 return 0; 418 state = &default_kbd_state; 419 keymap = &default_keymap; 420 accmap = &default_accentmap; 421 fkeymap = default_fkeytab; 422 fkeymap_size = 423 sizeof(default_fkeytab)/sizeof(default_fkeytab[0]); 424 } else if (*kbdp == NULL) { 425 *kbdp = kbd = malloc(sizeof(*kbd), M_DEVBUF, M_NOWAIT); 426 if (kbd == NULL) 427 return ENOMEM; 428 bzero(kbd, sizeof(*kbd)); 429 state = malloc(sizeof(*state), M_DEVBUF, M_NOWAIT); 430 keymap = malloc(sizeof(key_map), M_DEVBUF, M_NOWAIT); 431 accmap = malloc(sizeof(accent_map), M_DEVBUF, M_NOWAIT); 432 fkeymap = malloc(sizeof(fkey_tab), M_DEVBUF, M_NOWAIT); 433 fkeymap_size = sizeof(fkey_tab)/sizeof(fkey_tab[0]); 434 if ((state == NULL) || (keymap == NULL) || (accmap == NULL) 435 || (fkeymap == NULL)) { 436 if (state != NULL) 437 free(state, M_DEVBUF); 438 if (keymap != NULL) 439 free(keymap, M_DEVBUF); 440 if (accmap != NULL) 441 free(accmap, M_DEVBUF); 442 if (fkeymap != NULL) 443 free(fkeymap, M_DEVBUF); 444 free(kbd, M_DEVBUF); 445 return ENOMEM; 446 } 447 bzero(state, sizeof(*state)); 448 } else if (KBD_IS_PROBED(*kbdp)) { 449 return 0; 450 } else { 451 kbd = *kbdp; 452 state = (atkbd_state_t *)kbd->kb_data; 453 bzero(state, sizeof(*state)); 454 keymap = kbd->kb_keymap; 455 accmap = kbd->kb_accentmap; 456 fkeymap = kbd->kb_fkeytab; 457 fkeymap_size = kbd->kb_fkeytab_size; 458 } 459 460 state->kbdc = kbdc = kbdc_open(data[0]); 461 if (kbdc == NULL) 462 return ENXIO; 463 kbd_init_struct(kbd, ATKBD_DRIVER_NAME, KB_OTHER, unit, flags, data[0], 464 IO_KBDSIZE); 465 bcopy(&key_map, keymap, sizeof(key_map)); 466 bcopy(&accent_map, accmap, sizeof(accent_map)); 467 bcopy(fkey_tab, fkeymap, 468 imin(fkeymap_size*sizeof(fkeymap[0]), sizeof(fkey_tab))); 469 kbd_set_maps(kbd, keymap, accmap, fkeymap, fkeymap_size); 470 kbd->kb_data = (void *)state; 471 472 if (probe_keyboard(kbdc, flags)) { 473 if (flags & KB_CONF_FAIL_IF_NO_KBD) 474 return ENXIO; 475 } else { 476 KBD_FOUND_DEVICE(kbd); 477 } 478 atkbd_clear_state(kbd); 479 state->ks_mode = K_XLATE; 480 /* 481 * FIXME: set the initial value for lock keys in ks_state 482 * according to the BIOS data? 483 */ 484 485 KBD_PROBE_DONE(kbd); 486 return 0; 487} 488 489/* reset and initialize the device */ 490static int 491atkbd_init(keyboard_t *kbd) 492{ 493 KBDC kbdc; 494 495 if ((kbd == NULL) || !KBD_IS_PROBED(kbd)) 496 return ENXIO; /* shouldn't happen */ 497 kbdc = ((atkbd_state_t *)kbd->kb_data)->kbdc; 498 if (kbdc == NULL) 499 return ENXIO; /* shouldn't happen */ 500 501 if (!KBD_IS_INITIALIZED(kbd)) { 502 if (KBD_HAS_DEVICE(kbd) 503 && init_keyboard(kbdc, &kbd->kb_type, kbd->kb_config) 504 && (kbd->kb_config & KB_CONF_FAIL_IF_NO_KBD)) 505 return ENXIO; 506 atkbd_ioctl(kbd, KDSETLED, 507 (caddr_t)&((atkbd_state_t *)(kbd->kb_data))->ks_state); 508 KBD_INIT_DONE(kbd); 509 } 510 if (!KBD_IS_CONFIGURED(kbd)) { 511 if (kbd_register(kbd) < 0) 512 return ENXIO; 513 KBD_CONFIG_DONE(kbd); 514 } 515 516 return 0; 517} 518 519/* finish using this keyboard */ 520static int 521atkbd_term(keyboard_t *kbd) 522{ 523 kbd_unregister(kbd); 524 return 0; 525} 526 527/* keyboard interrupt routine */ 528static int 529atkbd_intr(keyboard_t *kbd) 530{ 531 atkbd_state_t *state; 532 int c; 533 534 if (KBD_IS_ACTIVE(kbd) && KBD_IS_BUSY(kbd)) { 535 /* let the callback function to process the input */ 536 (*kbd->kb_callback.kc_func)(kbd, KBDIO_KEYINPUT, 537 kbd->kb_callback.kc_arg); 538 } else { 539 /* read and discard the input; no one is waiting for input */ 540 do { 541 c = atkbd_read_char(kbd, FALSE); 542 } while (c != NOKEY); 543 544 if (!KBD_HAS_DEVICE(kbd)) { 545 /* 546 * The keyboard was not detected before; 547 * it must have been reconnected! 548 */ 549 state = (atkbd_state_t *)kbd->kb_data; 550 init_keyboard(state->kbdc, &kbd->kb_type, 551 kbd->kb_config); 552 atkbd_ioctl(kbd, KDSETLED, (caddr_t)&state->ks_state); 553 KBD_FOUND_DEVICE(kbd); 554 } 555 } 556 return 0; 557} 558 559/* test the interface to the device */ 560static int 561atkbd_test_if(keyboard_t *kbd) 562{ 563 int error; 564 int s; 565 566 error = 0; 567 empty_both_buffers(((atkbd_state_t *)kbd->kb_data)->kbdc, 10); 568 s = spltty(); 569 if (!test_controller(((atkbd_state_t *)kbd->kb_data)->kbdc)) 570 error = EIO; 571 else if (test_kbd_port(((atkbd_state_t *)kbd->kb_data)->kbdc) != 0) 572 error = EIO; 573 splx(s); 574 575 return error; 576} 577 578/* 579 * Enable the access to the device; until this function is called, 580 * the client cannot read from the keyboard. 581 */ 582static int 583atkbd_enable(keyboard_t *kbd) 584{ 585 int s; 586 587 s = spltty(); 588 KBD_ACTIVATE(kbd); 589 splx(s); 590 return 0; 591} 592 593/* disallow the access to the device */ 594static int 595atkbd_disable(keyboard_t *kbd) 596{ 597 int s; 598 599 s = spltty(); 600 KBD_DEACTIVATE(kbd); 601 splx(s); 602 return 0; 603} 604 605/* read one byte from the keyboard if it's allowed */ 606static int 607atkbd_read(keyboard_t *kbd, int wait) 608{ 609 int c; 610 611 if (wait) 612 c = read_kbd_data(((atkbd_state_t *)kbd->kb_data)->kbdc); 613 else 614 c = read_kbd_data_no_wait(((atkbd_state_t *)kbd->kb_data)->kbdc); 615 return (KBD_IS_ACTIVE(kbd) ? c : -1); 616} 617 618/* check if data is waiting */ 619static int 620atkbd_check(keyboard_t *kbd) 621{ 622 if (!KBD_IS_ACTIVE(kbd)) 623 return FALSE; 624 return kbdc_data_ready(((atkbd_state_t *)kbd->kb_data)->kbdc); 625} 626 627/* read char from the keyboard */ 628static u_int 629atkbd_read_char(keyboard_t *kbd, int wait) 630{ 631 atkbd_state_t *state; 632 u_int action; 633 int scancode; 634 int keycode; 635 636 state = (atkbd_state_t *)kbd->kb_data; 637next_code: 638 /* do we have a composed char to return? */ 639 if (!(state->ks_flags & COMPOSE) && (state->ks_composed_char > 0)) { 640 action = state->ks_composed_char; 641 state->ks_composed_char = 0; 642 if (action > UCHAR_MAX) 643 return ERRKEY; 644 return action; 645 } 646 647 /* see if there is something in the keyboard port */ 648 if (wait) { 649 do { 650 scancode = read_kbd_data(state->kbdc); 651 } while (scancode == -1); 652 } else { 653 scancode = read_kbd_data_no_wait(state->kbdc); 654 if (scancode == -1) 655 return NOKEY; 656 } 657 658 /* return the byte as is for the K_RAW mode */ 659 if (state->ks_mode == K_RAW) 660 return scancode; 661 662 /* translate the scan code into a keycode */ 663 keycode = scancode & 0x7F; 664 switch (state->ks_prefix) { 665 case 0x00: /* normal scancode */ 666 switch(scancode) { 667 case 0xB8: /* left alt (compose key) released */ 668 if (state->ks_flags & COMPOSE) { 669 state->ks_flags &= ~COMPOSE; 670 if (state->ks_composed_char > UCHAR_MAX) 671 state->ks_composed_char = 0; 672 } 673 break; 674 case 0x38: /* left alt (compose key) pressed */ 675 if (!(state->ks_flags & COMPOSE)) { 676 state->ks_flags |= COMPOSE; 677 state->ks_composed_char = 0; 678 } 679 break; 680 case 0xE0: 681 case 0xE1: 682 state->ks_prefix = scancode; 683 goto next_code; 684 } 685 break; 686 case 0xE0: /* 0xE0 prefix */ 687 state->ks_prefix = 0; 688 switch (keycode) { 689 case 0x1C: /* right enter key */ 690 keycode = 0x59; 691 break; 692 case 0x1D: /* right ctrl key */ 693 keycode = 0x5A; 694 break; 695 case 0x35: /* keypad divide key */ 696 keycode = 0x5B; 697 break; 698 case 0x37: /* print scrn key */ 699 keycode = 0x5C; 700 break; 701 case 0x38: /* right alt key (alt gr) */ 702 keycode = 0x5D; 703 break; 704 case 0x46: /* ctrl-pause/break on AT 101 (see below) */ 705 keycode = 0x68; 706 break; 707 case 0x47: /* grey home key */ 708 keycode = 0x5E; 709 break; 710 case 0x48: /* grey up arrow key */ 711 keycode = 0x5F; 712 break; 713 case 0x49: /* grey page up key */ 714 keycode = 0x60; 715 break; 716 case 0x4B: /* grey left arrow key */ 717 keycode = 0x61; 718 break; 719 case 0x4D: /* grey right arrow key */ 720 keycode = 0x62; 721 break; 722 case 0x4F: /* grey end key */ 723 keycode = 0x63; 724 break; 725 case 0x50: /* grey down arrow key */ 726 keycode = 0x64; 727 break; 728 case 0x51: /* grey page down key */ 729 keycode = 0x65; 730 break; 731 case 0x52: /* grey insert key */ 732 keycode = 0x66; 733 break; 734 case 0x53: /* grey delete key */ 735 keycode = 0x67; 736 break; 737 /* the following 3 are only used on the MS "Natural" keyboard */ 738 case 0x5b: /* left Window key */ 739 keycode = 0x69; 740 break; 741 case 0x5c: /* right Window key */ 742 keycode = 0x6a; 743 break; 744 case 0x5d: /* menu key */ 745 keycode = 0x6b; 746 break; 747 default: /* ignore everything else */ 748 goto next_code; 749 } 750 break; 751 case 0xE1: /* 0xE1 prefix */ 752 /* 753 * The pause/break key on the 101 keyboard produces: 754 * E1-1D-45 E1-9D-C5 755 * Ctrl-pause/break produces: 756 * E0-46 E0-C6 (See above.) 757 */ 758 state->ks_prefix = 0; 759 if (keycode == 0x1D) 760 state->ks_prefix = 0x1D; 761 goto next_code; 762 /* NOT REACHED */ 763 case 0x1D: /* pause / break */ 764 state->ks_prefix = 0; 765 if (keycode != 0x45) 766 goto next_code; 767 keycode = 0x68; 768 break; 769 } 770 771 if (kbd->kb_type == KB_84) { 772 switch (keycode) { 773 case 0x37: /* *(numpad)/print screen */ 774 if (state->ks_flags & SHIFTS) 775 keycode = 0x5c; /* print screen */ 776 break; 777 case 0x45: /* num lock/pause */ 778 if (state->ks_flags & CTLS) 779 keycode = 0x68; /* pause */ 780 break; 781 case 0x46: /* scroll lock/break */ 782 if (state->ks_flags & CTLS) 783 keycode = 0x6c; /* break */ 784 break; 785 } 786 } else if (kbd->kb_type == KB_101) { 787 switch (keycode) { 788 case 0x5c: /* print screen */ 789 if (state->ks_flags & ALTS) 790 keycode = 0x54; /* sysrq */ 791 break; 792 case 0x68: /* pause/break */ 793 if (state->ks_flags & CTLS) 794 keycode = 0x6c; /* break */ 795 break; 796 } 797 } 798 799 /* return the key code in the K_CODE mode */ 800 if (state->ks_mode == K_CODE) 801 return (keycode | (scancode & 0x80)); 802 803 /* compose a character code */ 804 if (state->ks_flags & COMPOSE) { 805 switch (scancode) { 806 /* key pressed, process it */ 807 case 0x47: case 0x48: case 0x49: /* keypad 7,8,9 */ 808 state->ks_composed_char *= 10; 809 state->ks_composed_char += scancode - 0x40; 810 if (state->ks_composed_char > UCHAR_MAX) 811 return ERRKEY; 812 goto next_code; 813 case 0x4B: case 0x4C: case 0x4D: /* keypad 4,5,6 */ 814 state->ks_composed_char *= 10; 815 state->ks_composed_char += scancode - 0x47; 816 if (state->ks_composed_char > UCHAR_MAX) 817 return ERRKEY; 818 goto next_code; 819 case 0x4F: case 0x50: case 0x51: /* keypad 1,2,3 */ 820 state->ks_composed_char *= 10; 821 state->ks_composed_char += scancode - 0x4E; 822 if (state->ks_composed_char > UCHAR_MAX) 823 return ERRKEY; 824 goto next_code; 825 case 0x52: /* keypad 0 */ 826 state->ks_composed_char *= 10; 827 if (state->ks_composed_char > UCHAR_MAX) 828 return ERRKEY; 829 goto next_code; 830 831 /* key released, no interest here */ 832 case 0xC7: case 0xC8: case 0xC9: /* keypad 7,8,9 */ 833 case 0xCB: case 0xCC: case 0xCD: /* keypad 4,5,6 */ 834 case 0xCF: case 0xD0: case 0xD1: /* keypad 1,2,3 */ 835 case 0xD2: /* keypad 0 */ 836 goto next_code; 837 838 case 0x38: /* left alt key */ 839 break; 840 841 default: 842 if (state->ks_composed_char > 0) { 843 state->ks_flags &= ~COMPOSE; 844 state->ks_composed_char = 0; 845 return ERRKEY; 846 } 847 break; 848 } 849 } 850 851 /* keycode to key action */ 852 action = genkbd_keyaction(kbd, keycode, scancode & 0x80, 853 &state->ks_state, &state->ks_accents); 854 if (action == NOKEY) 855 goto next_code; 856 else 857 return action; 858} 859 860/* check if char is waiting */ 861static int 862atkbd_check_char(keyboard_t *kbd) 863{ 864 atkbd_state_t *state; 865 866 if (!KBD_IS_ACTIVE(kbd)) 867 return FALSE; 868 state = (atkbd_state_t *)kbd->kb_data; 869 if (!(state->ks_flags & COMPOSE) && (state->ks_composed_char > 0)) 870 return TRUE; 871 return kbdc_data_ready(state->kbdc); 872} 873 874/* some useful control functions */ 875static int 876atkbd_ioctl(keyboard_t *kbd, u_long cmd, caddr_t arg) 877{ 878 /* trasnlate LED_XXX bits into the device specific bits */ 879 static u_char ledmap[8] = { 880 0, 4, 2, 6, 1, 5, 3, 7, 881 }; 882 atkbd_state_t *state = kbd->kb_data; 883 int error; 884 int s; 885 int i; 886 887 s = spltty(); 888 switch (cmd) { 889 890 case KDGKBMODE: /* get keyboard mode */ 891 *(int *)arg = state->ks_mode; 892 break; 893 case KDSKBMODE: /* set keyboard mode */ 894 switch (*(int *)arg) { 895 case K_XLATE: 896 if (state->ks_mode != K_XLATE) { 897 /* make lock key state and LED state match */ 898 state->ks_state &= ~LOCK_MASK; 899 state->ks_state |= KBD_LED_VAL(kbd); 900 } 901 /* FALL THROUGH */ 902 case K_RAW: 903 case K_CODE: 904 if (state->ks_mode != *(int *)arg) { 905 atkbd_clear_state(kbd); 906 state->ks_mode = *(int *)arg; 907 } 908 break; 909 default: 910 splx(s); 911 return EINVAL; 912 } 913 break; 914 915 case KDGETLED: /* get keyboard LED */ 916 *(int *)arg = KBD_LED_VAL(kbd); 917 break; 918 case KDSETLED: /* set keyboard LED */ 919 /* NOTE: lock key state in ks_state won't be changed */ 920 if (*(int *)arg & ~LOCK_MASK) { 921 splx(s); 922 return EINVAL; 923 } 924 i = *(int *)arg; 925 /* replace CAPS LED with ALTGR LED for ALTGR keyboards */ 926 if (kbd->kb_keymap->n_keys > ALTGR_OFFSET) { 927 if (i & ALKED) 928 i |= CLKED; 929 else 930 i &= ~CLKED; 931 } 932 if (KBD_HAS_DEVICE(kbd)) { 933 error = write_kbd(state->kbdc, KBDC_SET_LEDS, 934 ledmap[i & LED_MASK]); 935 if (error) { 936 splx(s); 937 return error; 938 } 939 } 940 KBD_LED_VAL(kbd) = *(int *)arg; 941 break; 942 943 case KDGKBSTATE: /* get lock key state */ 944 *(int *)arg = state->ks_state & LOCK_MASK; 945 break; 946 case KDSKBSTATE: /* set lock key state */ 947 if (*(int *)arg & ~LOCK_MASK) { 948 splx(s); 949 return EINVAL; 950 } 951 state->ks_state &= ~LOCK_MASK; 952 state->ks_state |= *(int *)arg; 953 splx(s); 954 /* set LEDs and quit */ 955 return atkbd_ioctl(kbd, KDSETLED, arg); 956 957 case KDSETRAD: /* set keyboard repeat rate */ 958 splx(s); 959 if (!KBD_HAS_DEVICE(kbd)) 960 return 0; 961 return write_kbd(state->kbdc, KBDC_SET_TYPEMATIC, 962 *(int *)arg); 963 964 case PIO_KEYMAP: /* set keyboard translation table */ 965 case PIO_KEYMAPENT: /* set keyboard translation table entry */ 966 case PIO_DEADKEYMAP: /* set accent key translation table */ 967 state->ks_accents = 0; 968 /* FALL THROUGH */ 969 default: 970 splx(s); 971 return genkbd_commonioctl(kbd, cmd, arg); 972 } 973 974 splx(s); 975 return 0; 976} 977 978/* lock the access to the keyboard */ 979static int 980atkbd_lock(keyboard_t *kbd, int lock) 981{ 982 return kbdc_lock(((atkbd_state_t *)kbd->kb_data)->kbdc, lock); 983} 984 985/* clear the internal state of the keyboard */ 986static void 987atkbd_clear_state(keyboard_t *kbd) 988{ 989 atkbd_state_t *state; 990 991 state = (atkbd_state_t *)kbd->kb_data; 992 state->ks_flags = 0; 993 state->ks_state &= LOCK_MASK; /* preserve locking key state */ 994 state->ks_accents = 0; 995 state->ks_composed_char = 0; 996#if 0 997 state->ks_prefix = 0; /* XXX */ 998#endif 999} 1000 1001/* save the internal state */ 1002static int 1003atkbd_get_state(keyboard_t *kbd, void *buf, size_t len) 1004{ 1005 if (len == 0) 1006 return sizeof(atkbd_state_t); 1007 if (len < sizeof(atkbd_state_t)) 1008 return -1; 1009 bcopy(kbd->kb_data, buf, sizeof(atkbd_state_t)); 1010 return 0; 1011} 1012 1013/* set the internal state */ 1014static int 1015atkbd_set_state(keyboard_t *kbd, void *buf, size_t len) 1016{ 1017 if (len < sizeof(atkbd_state_t)) 1018 return ENOMEM; 1019 if (((atkbd_state_t *)kbd->kb_data)->kbdc 1020 != ((atkbd_state_t *)buf)->kbdc) 1021 return ENOMEM; 1022 bcopy(buf, kbd->kb_data, sizeof(atkbd_state_t)); 1023 return 0; 1024} 1025 1026/* local functions */ 1027 1028static int 1029setup_kbd_port(KBDC kbdc, int port, int intr) 1030{ 1031 if (!set_controller_command_byte(kbdc, 1032 KBD_KBD_CONTROL_BITS, 1033 ((port) ? KBD_ENABLE_KBD_PORT : KBD_DISABLE_KBD_PORT) 1034 | ((intr) ? KBD_ENABLE_KBD_INT : KBD_DISABLE_KBD_INT))) 1035 return 1; 1036 return 0; 1037} 1038 1039static int 1040get_kbd_echo(KBDC kbdc) 1041{ 1042 /* enable the keyboard port, but disable the keyboard intr. */ 1043 if (setup_kbd_port(kbdc, TRUE, FALSE)) 1044 /* CONTROLLER ERROR: there is very little we can do... */ 1045 return ENXIO; 1046 1047 /* see if something is present */ 1048 write_kbd_command(kbdc, KBDC_ECHO); 1049 if (read_kbd_data(kbdc) != KBD_ECHO) { 1050 empty_both_buffers(kbdc, 10); 1051 test_controller(kbdc); 1052 test_kbd_port(kbdc); 1053 return ENXIO; 1054 } 1055 1056 /* enable the keyboard port and intr. */ 1057 if (setup_kbd_port(kbdc, TRUE, TRUE)) { 1058 /* 1059 * CONTROLLER ERROR 1060 * This is serious; the keyboard intr is left disabled! 1061 */ 1062 return ENXIO; 1063 } 1064 1065 return 0; 1066} 1067 1068static int 1069probe_keyboard(KBDC kbdc, int flags) 1070{ 1071 /* 1072 * Don't try to print anything in this function. The low-level 1073 * console may not have been initialized yet... 1074 */ 1075 int err; 1076 int c; 1077 int m; 1078 1079 if (!kbdc_lock(kbdc, TRUE)) { 1080 /* driver error? */ 1081 return ENXIO; 1082 } 1083 1084 /* flush any noise in the buffer */ 1085 empty_both_buffers(kbdc, 10); 1086 1087 /* save the current keyboard controller command byte */ 1088 m = kbdc_get_device_mask(kbdc) & ~KBD_KBD_CONTROL_BITS; 1089 c = get_controller_command_byte(kbdc); 1090 if (c == -1) { 1091 /* CONTROLLER ERROR */ 1092 kbdc_set_device_mask(kbdc, m); 1093 kbdc_lock(kbdc, FALSE); 1094 return ENXIO; 1095 } 1096 1097 /* 1098 * The keyboard may have been screwed up by the boot block. 1099 * We may just be able to recover from error by testing the controller 1100 * and the keyboard port. The controller command byte needs to be 1101 * saved before this recovery operation, as some controllers seem 1102 * to set the command byte to particular values. 1103 */ 1104 test_controller(kbdc); 1105 test_kbd_port(kbdc); 1106 1107 err = get_kbd_echo(kbdc); 1108 if (err == 0) { 1109 kbdc_set_device_mask(kbdc, m | KBD_KBD_CONTROL_BITS); 1110 } else { 1111 if (c != -1) 1112 /* try to restore the command byte as before */ 1113 set_controller_command_byte(kbdc, 0xff, c); 1114 kbdc_set_device_mask(kbdc, m); 1115 } 1116 1117 kbdc_lock(kbdc, FALSE); 1118 return err; 1119} 1120 1121static int 1122init_keyboard(KBDC kbdc, int *type, int flags) 1123{ 1124 int codeset; 1125 int id; 1126 int c; 1127 1128 if (!kbdc_lock(kbdc, TRUE)) { 1129 /* driver error? */ 1130 return EIO; 1131 } 1132 1133 /* save the current controller command byte */ 1134 empty_both_buffers(kbdc, 10); 1135 c = get_controller_command_byte(kbdc); 1136 if (c == -1) { 1137 /* CONTROLLER ERROR */ 1138 kbdc_lock(kbdc, FALSE); 1139 printf("atkbd: unable to get the current command byte value.\n"); 1140 return EIO; 1141 } 1142 if (bootverbose) 1143 printf("atkbd: the current kbd controller command byte %04x\n", 1144 c); 1145#if 0 1146 /* override the keyboard lock switch */ 1147 c |= KBD_OVERRIDE_KBD_LOCK; 1148#endif 1149 1150 /* enable the keyboard port, but disable the keyboard intr. */ 1151 if (setup_kbd_port(kbdc, TRUE, FALSE)) { 1152 /* CONTROLLER ERROR: there is very little we can do... */ 1153 printf("atkbd: unable to set the command byte.\n"); 1154 kbdc_lock(kbdc, FALSE); 1155 return EIO; 1156 } 1157 1158 /* 1159 * Check if we have an XT keyboard before we attempt to reset it. 1160 * The procedure assumes that the keyboard and the controller have 1161 * been set up properly by BIOS and have not been messed up 1162 * during the boot process. 1163 */ 1164 codeset = -1; 1165 if (flags & KB_CONF_ALT_SCANCODESET) 1166 /* the user says there is a XT keyboard */ 1167 codeset = 1; 1168#ifdef KBD_DETECT_XT_KEYBOARD 1169 else if ((c & KBD_TRANSLATION) == 0) { 1170 /* SET_SCANCODE_SET is not always supported; ignore error */ 1171 if (send_kbd_command_and_data(kbdc, KBDC_SET_SCANCODE_SET, 0) 1172 == KBD_ACK) 1173 codeset = read_kbd_data(kbdc); 1174 } 1175 if (bootverbose) 1176 printf("atkbd: scancode set %d\n", codeset); 1177#endif /* KBD_DETECT_XT_KEYBOARD */ 1178 1179 *type = KB_OTHER; 1180 id = get_kbd_id(kbdc); 1181 switch(id) { 1182 case 0x41ab: 1183 case 0x83ab: 1184 *type = KB_101; 1185 break; 1186 case -1: /* AT 84 keyboard doesn't return ID */ 1187 *type = KB_84; 1188 break; 1189 default: 1190 break; 1191 } 1192 if (bootverbose) 1193 printf("atkbd: keyboard ID 0x%x (%d)\n", id, *type); 1194 1195 /* reset keyboard hardware */ 1196 if (!(flags & KB_CONF_NO_RESET) && !reset_kbd(kbdc)) { 1197 /* 1198 * KEYBOARD ERROR 1199 * Keyboard reset may fail either because the keyboard 1200 * doen't exist, or because the keyboard doesn't pass 1201 * the self-test, or the keyboard controller on the 1202 * motherboard and the keyboard somehow fail to shake hands. 1203 * It is just possible, particularly in the last case, 1204 * that the keyoard controller may be left in a hung state. 1205 * test_controller() and test_kbd_port() appear to bring 1206 * the keyboard controller back (I don't know why and how, 1207 * though.) 1208 */ 1209 empty_both_buffers(kbdc, 10); 1210 test_controller(kbdc); 1211 test_kbd_port(kbdc); 1212 /* 1213 * We could disable the keyboard port and interrupt... but, 1214 * the keyboard may still exist (see above). 1215 */ 1216 set_controller_command_byte(kbdc, 0xff, c); 1217 kbdc_lock(kbdc, FALSE); 1218 if (bootverbose) 1219 printf("atkbd: failed to reset the keyboard.\n"); 1220 return EIO; 1221 } 1222 1223 /* 1224 * Allow us to set the XT_KEYBD flag in UserConfig so that keyboards 1225 * such as those on the IBM ThinkPad laptop computers can be used 1226 * with the standard console driver. 1227 */ 1228 if (codeset == 1) { 1229 if (send_kbd_command_and_data(kbdc, 1230 KBDC_SET_SCANCODE_SET, codeset) == KBD_ACK) { 1231 /* XT kbd doesn't need scan code translation */ 1232 c &= ~KBD_TRANSLATION; 1233 } else { 1234 /* 1235 * KEYBOARD ERROR 1236 * The XT kbd isn't usable unless the proper scan 1237 * code set is selected. 1238 */ 1239 set_controller_command_byte(kbdc, 0xff, c); 1240 kbdc_lock(kbdc, FALSE); 1241 printf("atkbd: unable to set the XT keyboard mode.\n"); 1242 return EIO; 1243 } 1244 } 1245 1246#ifdef __alpha__ 1247 if (send_kbd_command_and_data( 1248 kbdc, KBDC_SET_SCANCODE_SET, 2) != KBD_ACK) { 1249 printf("atkbd: can't set translation.\n"); 1250 1251 } 1252 c |= KBD_TRANSLATION; 1253#endif 1254 1255 /* enable the keyboard port and intr. */ 1256 if (!set_controller_command_byte(kbdc, 1257 KBD_KBD_CONTROL_BITS | KBD_TRANSLATION | KBD_OVERRIDE_KBD_LOCK, 1258 (c & (KBD_TRANSLATION | KBD_OVERRIDE_KBD_LOCK)) 1259 | KBD_ENABLE_KBD_PORT | KBD_ENABLE_KBD_INT)) { 1260 /* 1261 * CONTROLLER ERROR 1262 * This is serious; we are left with the disabled 1263 * keyboard intr. 1264 */ 1265 set_controller_command_byte(kbdc, 0xff, c); 1266 kbdc_lock(kbdc, FALSE); 1267 printf("atkbd: unable to enable the keyboard port and intr.\n"); 1268 return EIO; 1269 } 1270 1271 kbdc_lock(kbdc, FALSE); 1272 return 0; 1273} 1274 1275static int 1276write_kbd(KBDC kbdc, int command, int data) 1277{ 1278 int s; 1279 1280 /* prevent the timeout routine from polling the keyboard */ 1281 if (!kbdc_lock(kbdc, TRUE)) 1282 return EBUSY; 1283 1284 /* disable the keyboard and mouse interrupt */ 1285 s = spltty(); 1286#if 0 1287 c = get_controller_command_byte(kbdc); 1288 if ((c == -1) 1289 || !set_controller_command_byte(kbdc, 1290 kbdc_get_device_mask(kbdc), 1291 KBD_DISABLE_KBD_PORT | KBD_DISABLE_KBD_INT 1292 | KBD_DISABLE_AUX_PORT | KBD_DISABLE_AUX_INT)) { 1293 /* CONTROLLER ERROR */ 1294 kbdc_lock(kbdc, FALSE); 1295 splx(s); 1296 return EIO; 1297 } 1298 /* 1299 * Now that the keyboard controller is told not to generate 1300 * the keyboard and mouse interrupts, call `splx()' to allow 1301 * the other tty interrupts. The clock interrupt may also occur, 1302 * but the timeout routine (`scrn_timer()') will be blocked 1303 * by the lock flag set via `kbdc_lock()' 1304 */ 1305 splx(s); 1306#endif 1307 1308 if (send_kbd_command_and_data(kbdc, command, data) != KBD_ACK) 1309 send_kbd_command(kbdc, KBDC_ENABLE_KBD); 1310 1311#if 0 1312 /* restore the interrupts */ 1313 if (!set_controller_command_byte(kbdc, 1314 kbdc_get_device_mask(kbdc), 1315 c & (KBD_KBD_CONTROL_BITS | KBD_AUX_CONTROL_BITS))) { 1316 /* CONTROLLER ERROR */ 1317 } 1318#else 1319 splx(s); 1320#endif 1321 kbdc_lock(kbdc, FALSE); 1322 1323 return 0; 1324} 1325 1326static int 1327get_kbd_id(KBDC kbdc) 1328{ 1329 int id1, id2; 1330 1331 empty_both_buffers(kbdc, 10); 1332 id1 = id2 = -1; 1333 if (send_kbd_command(kbdc, KBDC_SEND_DEV_ID) != KBD_ACK) 1334 return -1; 1335 1336 DELAY(10000); /* 10 msec delay */ 1337 id1 = read_kbd_data(kbdc); 1338 if (id1 != -1) 1339 id2 = read_kbd_data(kbdc); 1340 1341 if ((id1 == -1) || (id2 == -1)) { 1342 empty_both_buffers(kbdc, 10); 1343 test_controller(kbdc); 1344 test_kbd_port(kbdc); 1345 return -1; 1346 } 1347 return ((id2 << 8) | id1); 1348} 1349 1350#endif /* NATKBD > 0 */ 1351