sys/dev/atkbdc/atkbd.c

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