sys/dev/usbmisc/ukbd/ukbd.c

   1 /*
   2  * $FreeBSD: src/sys/dev/usb/ukbd.c,v 1.45 2003/10/04 21:41:01 joe Exp $
   3  * $DragonFly: src/sys/dev/usbmisc/ukbd/ukbd.c,v 1.27 2008/08/14 20:55:53 hasso Exp $
   4  */
   5
   6 /*
   7  * Copyright (c) 1998 The NetBSD Foundation, Inc.
   8  * All rights reserved.
   9  *
  10  * This code is derived from software contributed to The NetBSD Foundation
  11  * by Lennart Augustsson (lennart@augustsson.net) at
  12  * Carlstedt Research & Technology.
  13  *
  14  * Redistribution and use in source and binary forms, with or without
  15  * modification, are permitted provided that the following conditions
  16  * are met:
  17  * 1. Redistributions of source code must retain the above copyright
  18  *    notice, this list of conditions and the following disclaimer.
  19  * 2. Redistributions in binary form must reproduce the above copyright
  20  *    notice, this list of conditions and the following disclaimer in the
  21  *    documentation and/or other materials provided with the distribution.
  22  * 3. All advertising materials mentioning features or use of this software
  23  *    must display the following acknowledgement:
  24  *        This product includes software developed by the NetBSD
  25  *        Foundation, Inc. and its contributors.
  26  * 4. Neither the name of The NetBSD Foundation nor the names of its
  27  *    contributors may be used to endorse or promote products derived
  28  *    from this software without specific prior written permission.
  29  *
  30  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  31  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  32  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  33  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  34  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  35  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  36  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  37  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  38  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  39  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  40  * POSSIBILITY OF SUCH DAMAGE.
  41  */
  42
  43 /*
  44  * HID spec: http://www.usb.org/developers/devclass_docs/HID1_11.pdf
  45  */
  46
  47 #include "opt_kbd.h"
  48 #include "opt_ukbd.h"
  49
  50 #include <sys/param.h>
  51 #include <sys/systm.h>
  52 #include <sys/kernel.h>
  53 #include <sys/module.h>
  54 #include <sys/bus.h>
  55 #include <sys/file.h>
  56 #include <machine/limits.h>
  57 #include <sys/select.h>
  58 #include <sys/sysctl.h>
  59 #include <sys/thread2.h>
  60
  61 #include <bus/usb/usb.h>
  62 #include <bus/usb/usbhid.h>
  63 #include <bus/usb/usbdi.h>
  64 #include <bus/usb/usbdi_util.h>
  65 #include <bus/usb/usb_quirks.h>
  66 #include <bus/usb/hid.h>
  67
  68 #include <sys/kbio.h>
  69 #include <dev/misc/kbd/kbdreg.h>
  70
  71 #define UKBD_EMULATE_ATSCANCODE 1
  72
  73 #define DRIVER_NAME     "ukbd"
  74
  75 #define delay(d)         DELAY(d)
  76
  77 #ifdef USB_DEBUG
  78 #define DPRINTF(x)      if (ukbddebug) kprintf x
  79 #define DPRINTFN(n,x)   if (ukbddebug>(n)) kprintf x
  80 int     ukbddebug = 0;
  81 SYSCTL_NODE(_hw_usb, OID_AUTO, ukbd, CTLFLAG_RW, 0, "USB ukbd");
  82 SYSCTL_INT(_hw_usb_ukbd, OID_AUTO, debug, CTLFLAG_RW,
  83            &ukbddebug, 0, "ukbd debug level");
  84 #else
  85 #define DPRINTF(x)
  86 #define DPRINTFN(n,x)
  87 #endif
  88
  89 #define UPROTO_BOOT_KEYBOARD 1
  90
  91 #define NKEYCODE 6
  92
  93 struct ukbd_data {
  94         u_int8_t        modifiers;
  95 #define MOD_CONTROL_L   0x01
  96 #define MOD_CONTROL_R   0x10
  97 #define MOD_SHIFT_L     0x02
  98 #define MOD_SHIFT_R     0x20
  99 #define MOD_ALT_L       0x04
 100 #define MOD_ALT_R       0x40
 101 #define MOD_WIN_L       0x08
 102 #define MOD_WIN_R       0x80
 103         u_int8_t        reserved;
 104         u_int8_t        keycode[NKEYCODE];
 105 };
 106
 107 #define MAXKEYS (NMOD+2*NKEYCODE)
 108
 109 typedef struct ukbd_softc {
 110         device_t                sc_dev;         /* base device */
 111 } ukbd_softc_t;
 112
 113 #define UKBD_CHUNK      128     /* chunk size for read */
 114 #define UKBD_BSIZE      1020    /* buffer size */
 115
 116 typedef void usbd_intr_t(usbd_xfer_handle, usbd_private_handle, usbd_status);
 117 typedef void usbd_disco_t(void *);
 118
 119 static int              ukbd_resume(device_t self);
 120 static usbd_intr_t      ukbd_intr;
 121 static int              ukbd_driver_load(module_t mod, int what, void *arg);
 122 static int              ukbd_default_term(keyboard_t *kbd);
 123
 124 static keyboard_t       default_kbd;
 125
 126 static device_probe_t ukbd_match;
 127 static device_attach_t ukbd_attach;
 128 static device_detach_t ukbd_detach;
 129
 130 static devclass_t ukbd_devclass;
 131
 132 static kobj_method_t ukbd_methods[] = {
 133         DEVMETHOD(device_probe, ukbd_match),
 134         DEVMETHOD(device_attach, ukbd_attach),
 135         DEVMETHOD(device_detach, ukbd_detach),
 136         DEVMETHOD(device_resume, ukbd_resume),
 137         {0,0}
 138 };
 139
 140 static driver_t ukbd_driver = {
 141         "ukbd",
 142         ukbd_methods,
 143         sizeof(struct ukbd_softc)
 144 };
 145
 146 MODULE_DEPEND(ukbd, usb, 1, 1, 1);
 147
 148 static int
 149 ukbd_match(device_t self)
 150 {
 151         struct usb_attach_arg *uaa = device_get_ivars(self);
 152
 153         keyboard_switch_t *sw;
 154         void *arg[2];
 155         int unit = device_get_unit(self);
 156
 157         sw = kbd_get_switch(DRIVER_NAME);
 158         if (sw == NULL)
 159                 return (UMATCH_NONE);
 160
 161         arg[0] = (void *)uaa;
 162         arg[1] = (void *)ukbd_intr;
 163         if ((*sw->probe)(unit, (void *)arg, 0))
 164                 return (UMATCH_NONE);
 165
 166         return (UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO);
 167 }
 168
 169 static int
 170 ukbd_attach(device_t self)
 171 {
 172         struct ukbd_softc *sc = device_get_softc(self);
 173         struct usb_attach_arg *uaa = device_get_ivars(self);
 174
 175         keyboard_switch_t *sw;
 176         keyboard_t *kbd;
 177         void *arg[2];
 178         int unit = device_get_unit(self);
 179
 180         sw = kbd_get_switch(DRIVER_NAME);
 181         if (sw == NULL)
 182                 return ENXIO;
 183
 184         sc->sc_dev = self;
 185
 186         arg[0] = (void *)uaa;
 187         arg[1] = (void *)ukbd_intr;
 188         kbd = NULL;
 189         if ((*sw->probe)(unit, (void *)arg, 0))
 190                 return ENXIO;
 191         if ((*sw->init)(unit, &kbd, (void *)arg, 0))
 192                 return ENXIO;
 193         (*sw->enable)(kbd);
 194
 195 #ifdef KBD_INSTALL_CDEV
 196         if (kbd_attach(kbd))
 197                 return ENXIO;
 198 #endif
 199         if (bootverbose)
 200                 (*sw->diag)(kbd, bootverbose);
 201
 202         return 0;
 203 }
 204
 205 int
 206 ukbd_detach(device_t self)
 207 {
 208         keyboard_t *kbd;
 209         int error;
 210
 211         kbd = kbd_get_keyboard(kbd_find_keyboard(DRIVER_NAME,
 212                                                  device_get_unit(self)));
 213         if (kbd == NULL) {
 214                 DPRINTF(("%s: keyboard not attached!?\n", device_get_nameunit(self)));
 215                 return ENXIO;
 216         }
 217         (*kbdsw[kbd->kb_index]->disable)(kbd);
 218
 219 #ifdef KBD_INSTALL_CDEV
 220         if (kbd != &default_kbd) {
 221                 error = kbd_detach(kbd);
 222                 if (error)
 223                         return error;
 224         }
 225 #endif
 226         if (kbd == &default_kbd) {
 227                 ukbd_default_term(kbd);
 228         } else {
 229                 error = (*kbdsw[kbd->kb_index]->term)(kbd);
 230                 if (error)
 231                         return error;
 232         }
 233
 234         DPRINTF(("%s: disconnected\n", device_get_nameunit(self)));
 235
 236         return (0);
 237 }
 238
 239 static int
 240 ukbd_resume(device_t self)
 241 {
 242         keyboard_t *kbd;
 243
 244         kbd = kbd_get_keyboard(kbd_find_keyboard(DRIVER_NAME,
 245                                                  device_get_unit(self)));
 246         if (kbd)
 247                 (*kbdsw[kbd->kb_index]->clear_state)(kbd);
 248         return (0);
 249 }
 250
 251 void
 252 ukbd_intr(usbd_xfer_handle xfer, usbd_private_handle addr, usbd_status status)
 253 {
 254         keyboard_t *kbd = (keyboard_t *)addr;
 255
 256         (*kbdsw[kbd->kb_index]->intr)(kbd, (void *)status);
 257 }
 258
 259 DRIVER_MODULE(ukbd, uhub, ukbd_driver, ukbd_devclass, ukbd_driver_load, 0);
 260
 261
 262 #define UKBD_DEFAULT    0
 263
 264 #define KEY_ERROR       0x01
 265
 266 #define KEY_PRESS       0
 267 #define KEY_RELEASE     0x400
 268 #define KEY_INDEX(c)    ((c) & ~KEY_RELEASE)
 269
 270 #define SCAN_PRESS      0
 271 #define SCAN_RELEASE    0x80
 272 #define SCAN_PREFIX_E0  0x100
 273 #define SCAN_PREFIX_E1  0x200
 274 #define SCAN_PREFIX_CTL 0x400
 275 #define SCAN_PREFIX_SHIFT 0x800
 276 #define SCAN_PREFIX     (SCAN_PREFIX_E0 | SCAN_PREFIX_E1 | SCAN_PREFIX_CTL \
 277                          | SCAN_PREFIX_SHIFT)
 278 #define SCAN_CHAR(c)    ((c) & 0x7f)
 279
 280 #define NMOD 8
 281 static struct {
 282         int mask, key;
 283 } ukbd_mods[NMOD] = {
 284         { MOD_CONTROL_L, 0xe0 },
 285         { MOD_CONTROL_R, 0xe4 },
 286         { MOD_SHIFT_L,   0xe1 },
 287         { MOD_SHIFT_R,   0xe5 },
 288         { MOD_ALT_L,     0xe2 },
 289         { MOD_ALT_R,     0xe6 },
 290         { MOD_WIN_L,     0xe3 },
 291         { MOD_WIN_R,     0xe7 },
 292 };
 293
 294 #define NN 0                    /* no translation */
 295 /*
 296  * Translate USB keycodes to AT keyboard scancodes.
 297  */
 298 /*
 299  * FIXME: Mac USB keyboard generates:
 300  * 0x53: keypad NumLock/Clear
 301  * 0x66: Power
 302  * 0x67: keypad =
 303  * 0x68: F13
 304  * 0x69: F14
 305  * 0x6a: F15
 306  */
 307 static u_int8_t ukbd_trtab[256] = {
 308            0,   0,   0,   0,  30,  48,  46,  32, /* 00 - 07 */
 309           18,  33,  34,  35,  23,  36,  37,  38, /* 08 - 0F */
 310           50,  49,  24,  25,  16,  19,  31,  20, /* 10 - 17 */
 311           22,  47,  17,  45,  21,  44,   2,   3, /* 18 - 1F */
 312            4,   5,   6,   7,   8,   9,  10,  11, /* 20 - 27 */
 313           28,   1,  14,  15,  57,  12,  13,  26, /* 28 - 2F */
 314           27,  43,  43,  39,  40,  41,  51,  52, /* 30 - 37 */
 315           53,  58,  59,  60,  61,  62,  63,  64, /* 38 - 3F */
 316           65,  66,  67,  68,  87,  88,  92,  70, /* 40 - 47 */
 317          104, 102,  94,  96, 103,  99, 101,  98, /* 48 - 4F */
 318           97, 100,  95,  69,  91,  55,  74,  78, /* 50 - 57 */
 319           89,  79,  80,  81,  75,  76,  77,  71, /* 58 - 5F */
 320           72,  73,  82,  83,  86, 107,  NN,  NN, /* 60 - 67 */
 321           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* 68 - 6F */
 322           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* 70 - 77 */
 323           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* 78 - 7F */
 324           NN,  NN,  NN,  NN,  NN,  NN,  NN, 115, /* 80 - 87 */
 325          112, 125, 121, 123,  NN,  NN,  NN,  NN, /* 88 - 8F */
 326           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* 90 - 97 */
 327           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* 98 - 9F */
 328           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* A0 - A7 */
 329           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* A8 - AF */
 330           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* B0 - B7 */
 331           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* B8 - BF */
 332           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* C0 - C7 */
 333           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* C8 - CF */
 334           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* D0 - D7 */
 335           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* D8 - DF */
 336           29,  42,  56, 105,  90,  54,  93, 106, /* E0 - E7 */
 337           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* E8 - EF */
 338           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* F0 - F7 */
 339           NN,  NN,  NN,  NN,  NN,  NN,  NN,  NN, /* F8 - FF */
 340 };
 341
 342 typedef struct ukbd_state {
 343         usbd_interface_handle ks_iface; /* interface */
 344         usbd_pipe_handle ks_intrpipe;   /* interrupt pipe */
 345         struct usb_attach_arg *ks_uaa;
 346         int ks_ep_addr;
 347
 348         struct ukbd_data ks_ndata;
 349         struct ukbd_data ks_odata;
 350         u_long          ks_ntime[NKEYCODE];
 351         u_long          ks_otime[NKEYCODE];
 352
 353 #define INPUTBUFSIZE    (NMOD + 2*NKEYCODE)
 354         u_int           ks_input[INPUTBUFSIZE]; /* input buffer */
 355         int             ks_inputs;
 356         int             ks_inputhead;
 357         int             ks_inputtail;
 358
 359         int             ks_ifstate;
 360 #define INTRENABLED     (1 << 0)
 361 #define DISCONNECTED    (1 << 1)
 362
 363         struct callout ks_timeout;
 364
 365         int             ks_mode;        /* input mode (K_XLATE,K_RAW,K_CODE) */
 366         int             ks_flags;       /* flags */
 367 #define COMPOSE         (1 << 0)
 368         int             ks_polling;
 369         int             ks_state;       /* shift/lock key state */
 370         int             ks_accents;     /* accent key index (> 0) */
 371         u_int           ks_composed_char; /* composed char code (> 0) */
 372 #ifdef UKBD_EMULATE_ATSCANCODE
 373         u_int           ks_buffered_char[2];
 374 #endif
 375 } ukbd_state_t;
 376
 377 /* keyboard driver declaration */
 378 static int              ukbd_configure(int flags);
 379 static kbd_probe_t      ukbd_probe;
 380 static kbd_init_t       ukbd_init;
 381 static kbd_term_t       ukbd_term;
 382 static kbd_intr_t       ukbd_interrupt;
 383 static kbd_test_if_t    ukbd_test_if;
 384 static kbd_enable_t     ukbd_enable;
 385 static kbd_disable_t    ukbd_disable;
 386 static kbd_read_t       ukbd_read;
 387 static kbd_check_t      ukbd_check;
 388 static kbd_read_char_t  ukbd_read_char;
 389 static kbd_check_char_t ukbd_check_char;
 390 static kbd_ioctl_t      ukbd_ioctl;
 391 static kbd_lock_t       ukbd_lock;
 392 static kbd_clear_state_t ukbd_clear_state;
 393 static kbd_get_state_t  ukbd_get_state;
 394 static kbd_set_state_t  ukbd_set_state;
 395 static kbd_poll_mode_t  ukbd_poll;
 396
 397 keyboard_switch_t ukbdsw = {
 398         ukbd_probe,
 399         ukbd_init,
 400         ukbd_term,
 401         ukbd_interrupt,
 402         ukbd_test_if,
 403         ukbd_enable,
 404         ukbd_disable,
 405         ukbd_read,
 406         ukbd_check,
 407         ukbd_read_char,
 408         ukbd_check_char,
 409         ukbd_ioctl,
 410         ukbd_lock,
 411         ukbd_clear_state,
 412         ukbd_get_state,
 413         ukbd_set_state,
 414         genkbd_get_fkeystr,
 415         ukbd_poll,
 416         genkbd_diag,
 417 };
 418
 419 KEYBOARD_DRIVER(ukbd, ukbdsw, ukbd_configure);
 420
 421 /* local functions */
 422 static int              ukbd_enable_intr(keyboard_t *kbd, int on,
 423                                          usbd_intr_t *func);
 424 static timeout_t        ukbd_timeout;
 425
 426 static int              ukbd_getc(ukbd_state_t *state, int wait);
 427 static int              probe_keyboard(struct usb_attach_arg *uaa, int flags);
 428 static int              init_keyboard(ukbd_state_t *state, int *type,
 429                                       int flags);
 430 static void             set_leds(ukbd_state_t *state, int leds);
 431 static int              set_typematic(keyboard_t *kbd, int code);
 432 #ifdef UKBD_EMULATE_ATSCANCODE
 433 static int              keycode2scancode(int keycode, int shift, int up);
 434 #endif
 435
 436 /* local variables */
 437
 438 /* the initial key map, accent map and fkey strings */
 439 #if defined(UKBD_DFLT_KEYMAP) && !defined(KLD_MODULE)
 440 #define KBD_DFLT_KEYMAP
 441 #include "ukbdmap.h"
 442 #endif
 443 #include <dev/misc/kbd/kbdtables.h>
 444
 445 /* structures for the default keyboard */
 446 static ukbd_state_t     default_kbd_state;
 447 static keymap_t         default_keymap;
 448 static accentmap_t      default_accentmap;
 449 static fkeytab_t        default_fkeytab[NUM_FKEYS];
 450
 451 /*
 452  * The back door to the keyboard driver!
 453  * This function is called by the console driver, via the kbdio module,
 454  * to tickle keyboard drivers when the low-level console is being initialized.
 455  * Almost nothing in the kernel has been initialied yet.  Try to probe
 456  * keyboards if possible.
 457  * NOTE: because of the way the low-level conole is initialized, this routine
 458  * may be called more than once!!
 459  */
 460 static int
 461 ukbd_configure(int flags)
 462 {
 463         return 0;
 464
 465 #if 0 /* not yet */
 466         keyboard_t *kbd;
 467         device_t device;
 468         struct usb_attach_arg *uaa;
 469         void *arg[2];
 470
 471         device = devclass_get_device(ukbd_devclass, UKBD_DEFAULT);
 472         if (device == NULL)
 473                 return 0;
 474         uaa = (struct usb_attach_arg *)device_get_ivars(device);
 475         if (uaa == NULL)
 476                 return 0;
 477
 478         /* probe the default keyboard */
 479         arg[0] = (void *)uaa;
 480         arg[1] = (void *)ukbd_intr;
 481         kbd = NULL;
 482         if (ukbd_probe(UKBD_DEFAULT, arg, flags))
 483                 return 0;
 484         if (ukbd_init(UKBD_DEFAULT, &kbd, arg, flags))
 485                 return 0;
 486
 487         /* return the number of found keyboards */
 488         return 1;
 489 #endif
 490 }
 491
 492 /* low-level functions */
 493
 494 /* detect a keyboard */
 495 static int
 496 ukbd_probe(int unit, void *arg, int flags)
 497 {
 498         void **data;
 499         struct usb_attach_arg *uaa;
 500
 501         data = (void **)arg;
 502         uaa = (struct usb_attach_arg *)data[0];
 503
 504         if (unit == UKBD_DEFAULT) {
 505                 if (KBD_IS_PROBED(&default_kbd))
 506                         return 0;
 507         }
 508         if (probe_keyboard(uaa, flags))
 509                 return ENXIO;
 510         return 0;
 511 }
 512
 513 /*
 514  * Reset and initialize the device.  Note that unit 0 (UKBD_DEFAULT) is an
 515  * always-connected device once it has been initially detected.  We do not
 516  * deregister it if the usb keyboard is unplugged to avoid losing the
 517  * connection to the console.  This feature also handles the USB bus reset
 518  * which detaches and reattaches USB devices during boot.
 519  */
 520 static int
 521 ukbd_init(int unit, keyboard_t **kbdp, void *arg, int flags)
 522 {
 523         keyboard_t *kbd;
 524         ukbd_state_t *state;
 525         keymap_t *keymap;
 526         accentmap_t *accmap;
 527         fkeytab_t *fkeymap;
 528         int fkeymap_size;
 529         void **data = (void **)arg;
 530         struct usb_attach_arg *uaa = (struct usb_attach_arg *)data[0];
 531
 532         if (unit == UKBD_DEFAULT) {
 533                 *kbdp = kbd = &default_kbd;
 534                 if (KBD_IS_INITIALIZED(kbd) && KBD_IS_CONFIGURED(kbd))
 535                         return 0;
 536                 state = &default_kbd_state;
 537                 keymap = &default_keymap;
 538                 accmap = &default_accentmap;
 539                 fkeymap = default_fkeytab;
 540                 fkeymap_size =
 541                         sizeof(default_fkeytab)/sizeof(default_fkeytab[0]);
 542         } else if (*kbdp == NULL) {
 543                 *kbdp = kbd = kmalloc(sizeof(*kbd), M_DEVBUF, M_INTWAIT | M_ZERO);
 544                 state = kmalloc(sizeof(*state), M_DEVBUF, M_INTWAIT);
 545                 keymap = kmalloc(sizeof(key_map), M_DEVBUF, M_INTWAIT);
 546                 accmap = kmalloc(sizeof(accent_map), M_DEVBUF, M_INTWAIT);
 547                 fkeymap = kmalloc(sizeof(fkey_tab), M_DEVBUF, M_INTWAIT);
 548                 fkeymap_size = sizeof(fkey_tab)/sizeof(fkey_tab[0]);
 549                 if ((state == NULL) || (keymap == NULL) || (accmap == NULL)
 550                      || (fkeymap == NULL)) {
 551                         if (state != NULL)
 552                                 kfree(state, M_DEVBUF);
 553                         if (keymap != NULL)
 554                                 kfree(keymap, M_DEVBUF);
 555                         if (accmap != NULL)
 556                                 kfree(accmap, M_DEVBUF);
 557                         if (fkeymap != NULL)
 558                                 kfree(fkeymap, M_DEVBUF);
 559                         kfree(kbd, M_DEVBUF);
 560                         return ENOMEM;
 561                 }
 562         } else if (KBD_IS_INITIALIZED(*kbdp) && KBD_IS_CONFIGURED(*kbdp)) {
 563                 return 0;
 564         } else {
 565                 kbd = *kbdp;
 566                 state = (ukbd_state_t *)kbd->kb_data;
 567                 keymap = kbd->kb_keymap;
 568                 accmap = kbd->kb_accentmap;
 569                 fkeymap = kbd->kb_fkeytab;
 570                 fkeymap_size = kbd->kb_fkeytab_size;
 571         }
 572
 573         if (!KBD_IS_PROBED(kbd)) {
 574                 if (KBD_IS_CONFIGURED(kbd)) {
 575                         kbd_reinit_struct(kbd, flags, KB_PRI_USB);
 576                 } else {
 577                         kbd_init_struct(kbd, DRIVER_NAME, KB_OTHER,
 578                                         unit, flags, KB_PRI_USB,
 579                                         0, 0);
 580                 }
 581                 bzero(state, sizeof(*state));
 582                 bcopy(&key_map, keymap, sizeof(key_map));
 583                 bcopy(&accent_map, accmap, sizeof(accent_map));
 584                 bcopy(fkey_tab, fkeymap,
 585                       imin(fkeymap_size*sizeof(fkeymap[0]), sizeof(fkey_tab)));
 586                 kbd_set_maps(kbd, keymap, accmap, fkeymap, fkeymap_size);
 587                 kbd->kb_data = (void *)state;
 588
 589                 if (probe_keyboard(uaa, flags))
 590                         return ENXIO;
 591                 else
 592                         KBD_FOUND_DEVICE(kbd);
 593                 ukbd_clear_state(kbd);
 594
 595                 /*
 596                  * If reattatching to an already open keyboard (e.g. console),
 597                  * try to restore the translation mode.  Otherwise set the
 598                  * translation mode to, well, translation mode so we don't
 599                  * get garbage.
 600                  */
 601                 if (!KBD_IS_CONFIGURED(kbd)) {
 602                         state->ks_mode = K_XLATE;
 603                         kbd->kb_savemode = state->ks_mode;
 604                 } else {
 605                         state->ks_mode = kbd->kb_savemode;
 606                 }
 607                 state->ks_iface = uaa->iface;
 608                 state->ks_uaa = uaa;
 609                 state->ks_ifstate = 0;
 610                 callout_init(&state->ks_timeout);
 611                 /*
 612                  * FIXME: set the initial value for lock keys in ks_state
 613                  * according to the BIOS data?
 614                  */
 615                 KBD_PROBE_DONE(kbd);
 616         }
 617         if (!KBD_IS_INITIALIZED(kbd) && !(flags & KB_CONF_PROBE_ONLY)) {
 618                 if (KBD_HAS_DEVICE(kbd)
 619                     && init_keyboard((ukbd_state_t *)kbd->kb_data,
 620                                      &kbd->kb_type, kbd->kb_flags))
 621                         return ENXIO;
 622                 ukbd_ioctl(kbd, KDSETLED, (caddr_t)&(state->ks_state));
 623         }
 624         if (!KBD_IS_CONFIGURED(kbd)) {
 625                 if (kbd_register(kbd) < 0)
 626                         return ENXIO;
 627                 KBD_CONFIG_DONE(kbd);
 628         }
 629         if (!KBD_IS_INITIALIZED(kbd) && !(flags & KB_CONF_PROBE_ONLY)) {
 630                 if (ukbd_enable_intr(kbd, TRUE, (usbd_intr_t *)data[1]) == 0)
 631                         ukbd_timeout((void *)kbd);
 632                 KBD_INIT_DONE(kbd);
 633         }
 634         return 0;
 635 }
 636
 637 static int
 638 ukbd_enable_intr(keyboard_t *kbd, int on, usbd_intr_t *func)
 639 {
 640         ukbd_state_t *state = (ukbd_state_t *)kbd->kb_data;
 641         usbd_status err;
 642
 643         if (on) {
 644                 /* Set up interrupt pipe. */
 645                 if (state->ks_ifstate & INTRENABLED)
 646                         return EBUSY;
 647
 648                 state->ks_ifstate |= INTRENABLED;
 649                 err = usbd_open_pipe_intr(state->ks_iface, state->ks_ep_addr,
 650                                         USBD_SHORT_XFER_OK | USBD_CALLBACK_LAST,
 651                                         &state->ks_intrpipe, kbd,
 652                                         &state->ks_ndata,
 653                                         sizeof(state->ks_ndata), func,
 654                                         USBD_DEFAULT_INTERVAL);
 655                 if (err)
 656                         return (EIO);
 657         } else {
 658                 /* Disable interrupts. */
 659                 usbd_abort_pipe(state->ks_intrpipe);
 660                 usbd_close_pipe(state->ks_intrpipe);
 661
 662                 state->ks_ifstate &= ~INTRENABLED;
 663         }
 664
 665         return (0);
 666 }
 667
 668 /* finish using this keyboard */
 669 static int
 670 ukbd_term(keyboard_t *kbd)
 671 {
 672         ukbd_state_t *state;
 673         int error;
 674
 675         crit_enter();
 676         state = (ukbd_state_t *)kbd->kb_data;
 677         DPRINTF(("ukbd_term: ks_ifstate=0x%x\n", state->ks_ifstate));
 678
 679         callout_stop(&state->ks_timeout);
 680
 681         if (state->ks_ifstate & INTRENABLED)
 682                 ukbd_enable_intr(kbd, FALSE, NULL);
 683         if (state->ks_ifstate & INTRENABLED) {
 684                 crit_exit();
 685                 DPRINTF(("ukbd_term: INTRENABLED!\n"));
 686                 return ENXIO;
 687         }
 688
 689         error = kbd_unregister(kbd);
 690         DPRINTF(("ukbd_term: kbd_unregister() %d\n", error));
 691         if (error == 0) {
 692                 kbd->kb_flags = 0;
 693                 if (kbd != &default_kbd) {
 694                         kfree(kbd->kb_keymap, M_DEVBUF);
 695                         kfree(kbd->kb_accentmap, M_DEVBUF);
 696                         kfree(kbd->kb_fkeytab, M_DEVBUF);
 697                         kfree(state, M_DEVBUF);
 698                         kfree(kbd, M_DEVBUF);
 699                 }
 700         }
 701         crit_exit();
 702         return error;
 703 }
 704
 705 /*
 706  * Finish using the default keyboard.  Shutdown the USB side of the keyboard
 707  * but do not unregister it.
 708  */
 709 static int
 710 ukbd_default_term(keyboard_t *kbd)
 711 {
 712         ukbd_state_t *state;
 713
 714         crit_enter();
 715
 716         state = (ukbd_state_t *)kbd->kb_data;
 717         DPRINTF(("ukbd_default_term: ks_ifstate=0x%x\n", state->ks_ifstate));
 718
 719         callout_stop(&state->ks_timeout);
 720
 721         if (state->ks_ifstate & INTRENABLED)
 722                 ukbd_enable_intr(kbd, FALSE, NULL);
 723         if (state->ks_ifstate & INTRENABLED) {
 724                 crit_exit();
 725                 DPRINTF(("ukbd_term: INTRENABLED!\n"));
 726                 return ENXIO;
 727         }
 728         KBD_LOST_DEVICE(kbd);
 729         KBD_LOST_PROBE(kbd);
 730         KBD_LOST_INIT(kbd);
 731         crit_exit();
 732         return (0);
 733 }
 734
 735 /* keyboard interrupt routine */
 736
 737 static void
 738 ukbd_timeout(void *arg)
 739 {
 740         keyboard_t *kbd;
 741         ukbd_state_t *state;
 742
 743         kbd = (keyboard_t *)arg;
 744         state = (ukbd_state_t *)kbd->kb_data;
 745         crit_enter();
 746         (*kbdsw[kbd->kb_index]->intr)(kbd, (void *)USBD_NORMAL_COMPLETION);
 747         callout_reset(&state->ks_timeout, hz / 40, ukbd_timeout, arg);
 748         crit_exit();
 749 }
 750
 751 static int
 752 ukbd_interrupt(keyboard_t *kbd, void *arg)
 753 {
 754         usbd_status status = (usbd_status)arg;
 755         ukbd_state_t *state;
 756         struct ukbd_data *ud;
 757         struct timeval tv;
 758         u_long now;
 759         int mod, omod;
 760         int key, c;
 761         int i, j;
 762
 763         DPRINTFN(5, ("ukbd_intr: status=%d\n", status));
 764         if (status == USBD_CANCELLED)
 765                 return 0;
 766
 767         state = (ukbd_state_t *)kbd->kb_data;
 768         ud = &state->ks_ndata;
 769
 770         if (status != USBD_NORMAL_COMPLETION) {
 771                 DPRINTF(("ukbd_intr: status=%d\n", status));
 772                 if (status == USBD_STALLED)
 773                     usbd_clear_endpoint_stall_async(state->ks_intrpipe);
 774                 return 0;
 775         }
 776
 777         if (ud->keycode[0] == KEY_ERROR)
 778                 return 0;               /* ignore  */
 779
 780         getmicrouptime(&tv);
 781         now = (u_long)tv.tv_sec*1000 + (u_long)tv.tv_usec/1000;
 782
 783 #define ADDKEY1(c)              \
 784         if (state->ks_inputs < INPUTBUFSIZE) {                          \
 785                 state->ks_input[state->ks_inputtail] = (c);             \
 786                 ++state->ks_inputs;                                     \
 787                 state->ks_inputtail = (state->ks_inputtail + 1)%INPUTBUFSIZE; \
 788         }
 789
 790         mod = ud->modifiers;
 791         omod = state->ks_odata.modifiers;
 792         if (mod != omod) {
 793                 for (i = 0; i < NMOD; i++)
 794                         if (( mod & ukbd_mods[i].mask) !=
 795                             (omod & ukbd_mods[i].mask))
 796                                 ADDKEY1(ukbd_mods[i].key |
 797                                        (mod & ukbd_mods[i].mask
 798                                           ? KEY_PRESS : KEY_RELEASE));
 799         }
 800
 801         /* Check for released keys. */
 802         for (i = 0; i < NKEYCODE; i++) {
 803                 key = state->ks_odata.keycode[i];
 804                 if (key == 0)
 805                         continue;
 806                 for (j = 0; j < NKEYCODE; j++) {
 807                         if (ud->keycode[j] == 0)
 808                                 continue;
 809                         if (key == ud->keycode[j])
 810                                 goto rfound;
 811                 }
 812                 ADDKEY1(key | KEY_RELEASE);
 813         rfound:
 814                 ;
 815         }
 816
 817         /* Check for pressed keys. */
 818         for (i = 0; i < NKEYCODE; i++) {
 819                 key = ud->keycode[i];
 820                 if (key == 0)
 821                         continue;
 822                 state->ks_ntime[i] = now + kbd->kb_delay1;
 823                 for (j = 0; j < NKEYCODE; j++) {
 824                         if (state->ks_odata.keycode[j] == 0)
 825                                 continue;
 826                         if (key == state->ks_odata.keycode[j]) {
 827                                 state->ks_ntime[i] = state->ks_otime[j];
 828                                 if (state->ks_otime[j] > now)
 829                                         goto pfound;
 830                                 state->ks_ntime[i] = now + kbd->kb_delay2;
 831                                 break;
 832                         }
 833                 }
 834                 ADDKEY1(key | KEY_PRESS);
 835         pfound:
 836                 ;
 837         }
 838
 839         state->ks_odata = *ud;
 840         bcopy(state->ks_ntime, state->ks_otime, sizeof(state->ks_ntime));
 841         if (state->ks_inputs <= 0)
 842                 return 0;
 843
 844 #ifdef USB_DEBUG
 845         for (i = state->ks_inputhead, j = 0; j < state->ks_inputs; ++j,
 846                 i = (i + 1)%INPUTBUFSIZE) {
 847                 c = state->ks_input[i];
 848                 DPRINTF(("0x%x (%d) %s\n", c, c,
 849                         (c & KEY_RELEASE) ? "released":"pressed"));
 850         }
 851         if (ud->modifiers)
 852                 DPRINTF(("mod:0x%04x ", ud->modifiers));
 853         for (i = 0; i < NKEYCODE; i++) {
 854                 if (ud->keycode[i])
 855                         DPRINTF(("%d ", ud->keycode[i]));
 856         }
 857         DPRINTF(("\n"));
 858 #endif /* USB_DEBUG */
 859
 860         if (state->ks_polling)
 861                 return 0;
 862
 863         if (KBD_IS_ACTIVE(kbd) && KBD_IS_BUSY(kbd)) {
 864                 /* let the callback function to process the input */
 865                 (*kbd->kb_callback.kc_func)(kbd, KBDIO_KEYINPUT,
 866                                             kbd->kb_callback.kc_arg);
 867         } else {
 868                 /* read and discard the input; no one is waiting for it */
 869                 do {
 870                         c = ukbd_read_char(kbd, FALSE);
 871                 } while (c != NOKEY);
 872         }
 873
 874         return 0;
 875 }
 876
 877 static int
 878 ukbd_getc(ukbd_state_t *state, int wait)
 879 {
 880         int c;
 881
 882         if (state->ks_polling) {
 883                 DPRINTFN(1,("ukbd_getc: polling\n"));
 884                 crit_enter();
 885                 while (state->ks_inputs <= 0) {
 886                         usbd_dopoll(state->ks_iface);
 887                         if (wait == 0)
 888                                 break;
 889                 }
 890                 crit_exit();
 891         }
 892         crit_enter();
 893         if (state->ks_inputs <= 0) {
 894                 c = -1;
 895         } else {
 896                 c = state->ks_input[state->ks_inputhead];
 897                 --state->ks_inputs;
 898                 state->ks_inputhead = (state->ks_inputhead + 1)%INPUTBUFSIZE;
 899         }
 900         crit_exit();
 901         return c;
 902 }
 903
 904 /* test the interface to the device */
 905 static int
 906 ukbd_test_if(keyboard_t *kbd)
 907 {
 908         return 0;
 909 }
 910
 911 /*
 912  * Enable the access to the device; until this function is called,
 913  * the client cannot read from the keyboard.
 914  */
 915 static int
 916 ukbd_enable(keyboard_t *kbd)
 917 {
 918         crit_enter();
 919         KBD_ACTIVATE(kbd);
 920         crit_exit();
 921         return 0;
 922 }
 923
 924 /* disallow the access to the device */
 925 static int
 926 ukbd_disable(keyboard_t *kbd)
 927 {
 928         crit_enter();
 929         KBD_DEACTIVATE(kbd);
 930         crit_exit();
 931         return 0;
 932 }
 933
 934 /* read one byte from the keyboard if it's allowed */
 935 static int
 936 ukbd_read(keyboard_t *kbd, int wait)
 937 {
 938         ukbd_state_t *state;
 939         int usbcode;
 940 #ifdef UKBD_EMULATE_ATSCANCODE
 941         int keycode;
 942         int scancode;
 943 #endif
 944
 945         state = (ukbd_state_t *)kbd->kb_data;
 946 #ifdef UKBD_EMULATE_ATSCANCODE
 947         if (state->ks_buffered_char[0]) {
 948                 scancode = state->ks_buffered_char[0];
 949                 if (scancode & SCAN_PREFIX) {
 950                         state->ks_buffered_char[0] = scancode & ~SCAN_PREFIX;
 951                         return ((scancode & SCAN_PREFIX_E0) ? 0xe0 : 0xe1);
 952                 } else {
 953                         state->ks_buffered_char[0] = state->ks_buffered_char[1];
 954                         state->ks_buffered_char[1] = 0;
 955                         return scancode;
 956                 }
 957         }
 958 #endif /* UKBD_EMULATE_ATSCANCODE */
 959
 960         usbcode = ukbd_getc(state, wait);
 961         if (!KBD_IS_ACTIVE(kbd) || !KBD_HAS_DEVICE(kbd) || (usbcode == -1))
 962                 return -1;
 963         ++kbd->kb_count;
 964 #ifdef UKBD_EMULATE_ATSCANCODE
 965         keycode = ukbd_trtab[KEY_INDEX(usbcode)];
 966         if (keycode == NN)
 967                 return -1;
 968
 969         scancode = keycode2scancode(keycode, state->ks_ndata.modifiers,
 970                                     usbcode & KEY_RELEASE);
 971         if (scancode & SCAN_PREFIX) {
 972                 if (scancode & SCAN_PREFIX_CTL) {
 973                         state->ks_buffered_char[0] =
 974                                 0x1d | (scancode & SCAN_RELEASE); /* Ctrl */
 975                         state->ks_buffered_char[1] = scancode & ~SCAN_PREFIX;
 976                 } else if (scancode & SCAN_PREFIX_SHIFT) {
 977                         state->ks_buffered_char[0] =
 978                                 0x2a | (scancode & SCAN_RELEASE); /* Shift */
 979                         state->ks_buffered_char[1] =
 980                                 scancode & ~SCAN_PREFIX_SHIFT;
 981                 } else {
 982                         state->ks_buffered_char[0] = scancode & ~SCAN_PREFIX;
 983                         state->ks_buffered_char[1] = 0;
 984                 }
 985                 return ((scancode & SCAN_PREFIX_E0) ? 0xe0 : 0xe1);
 986         }
 987         return scancode;
 988 #else /* !UKBD_EMULATE_ATSCANCODE */
 989         return usbcode;
 990 #endif /* UKBD_EMULATE_ATSCANCODE */
 991 }
 992
 993 /* check if data is waiting */
 994 static int
 995 ukbd_check(keyboard_t *kbd)
 996 {
 997         if (!KBD_IS_ACTIVE(kbd) || !KBD_HAS_DEVICE(kbd))
 998                 return FALSE;
 999 #ifdef UKBD_EMULATE_ATSCANCODE
1000         if (((ukbd_state_t *)kbd->kb_data)->ks_buffered_char[0])
1001                 return TRUE;
1002 #endif
1003         if (((ukbd_state_t *)kbd->kb_data)->ks_inputs > 0)
1004                 return TRUE;
1005         return FALSE;
1006 }
1007
1008 /* read char from the keyboard */
1009 static u_int
1010 ukbd_read_char(keyboard_t *kbd, int wait)
1011 {
1012         ukbd_state_t *state;
1013         u_int action;
1014         int usbcode;
1015         int keycode;
1016 #ifdef UKBD_EMULATE_ATSCANCODE
1017         int scancode;
1018 #endif
1019
1020         state = (ukbd_state_t *)kbd->kb_data;
1021 next_code:
1022         /* do we have a composed char to return? */
1023         if (!(state->ks_flags & COMPOSE) && (state->ks_composed_char > 0)) {
1024                 action = state->ks_composed_char;
1025                 state->ks_composed_char = 0;
1026                 if (action > UCHAR_MAX)
1027                         return ERRKEY;
1028                 return action;
1029         }
1030
1031 #ifdef UKBD_EMULATE_ATSCANCODE
1032         /* do we have a pending raw scan code? */
1033         if (state->ks_mode == K_RAW) {
1034                 if (state->ks_buffered_char[0]) {
1035                         scancode = state->ks_buffered_char[0];
1036                         if (scancode & SCAN_PREFIX) {
1037                                 state->ks_buffered_char[0] =
1038                                         scancode & ~SCAN_PREFIX;
1039                                 return ((scancode & SCAN_PREFIX_E0) ? 0xe0 : 0xe1);
1040                         } else {
1041                                 state->ks_buffered_char[0] =
1042                                         state->ks_buffered_char[1];
1043                                 state->ks_buffered_char[1] = 0;
1044                                 return scancode;
1045                         }
1046                 }
1047         }
1048 #endif /* UKBD_EMULATE_ATSCANCODE */
1049
1050         /* see if there is something in the keyboard port */
1051         /* XXX */
1052         usbcode = ukbd_getc(state, wait);
1053         if (usbcode == -1)
1054                 return NOKEY;
1055         ++kbd->kb_count;
1056
1057 #ifdef UKBD_EMULATE_ATSCANCODE
1058         /* USB key index -> key code -> AT scan code */
1059         keycode = ukbd_trtab[KEY_INDEX(usbcode)];
1060         if (keycode == NN)
1061                 return NOKEY;
1062
1063         /* return an AT scan code for the K_RAW mode */
1064         if (state->ks_mode == K_RAW) {
1065                 scancode = keycode2scancode(keycode, state->ks_ndata.modifiers,
1066                                             usbcode & KEY_RELEASE);
1067                 if (scancode & SCAN_PREFIX) {
1068                         if (scancode & SCAN_PREFIX_CTL) {
1069                                 state->ks_buffered_char[0] =
1070                                         0x1d | (scancode & SCAN_RELEASE);
1071                                 state->ks_buffered_char[1] =
1072                                         scancode & ~SCAN_PREFIX;
1073                         } else if (scancode & SCAN_PREFIX_SHIFT) {
1074                                 state->ks_buffered_char[0] =
1075                                         0x2a | (scancode & SCAN_RELEASE);
1076                                 state->ks_buffered_char[1] =
1077                                         scancode & ~SCAN_PREFIX_SHIFT;
1078                         } else {
1079                                 state->ks_buffered_char[0] =
1080                                         scancode & ~SCAN_PREFIX;
1081                                 state->ks_buffered_char[1] = 0;
1082                         }
1083                         return ((scancode & SCAN_PREFIX_E0) ? 0xe0 : 0xe1);
1084                 }
1085                 return scancode;
1086         }
1087 #else /* !UKBD_EMULATE_ATSCANCODE */
1088         /* return the byte as is for the K_RAW mode */
1089         if (state->ks_mode == K_RAW)
1090                 return usbcode;
1091
1092         /* USB key index -> key code */
1093         keycode = ukbd_trtab[KEY_INDEX(usbcode)];
1094         if (keycode == NN)
1095                 return NOKEY;
1096 #endif /* UKBD_EMULATE_ATSCANCODE */
1097
1098         switch (keycode) {
1099         case 0x38:      /* left alt (compose key) */
1100                 if (usbcode & KEY_RELEASE) {
1101                         if (state->ks_flags & COMPOSE) {
1102                                 state->ks_flags &= ~COMPOSE;
1103                                 if (state->ks_composed_char > UCHAR_MAX)
1104                                         state->ks_composed_char = 0;
1105                         }
1106                 } else {
1107                         if (!(state->ks_flags & COMPOSE)) {
1108                                 state->ks_flags |= COMPOSE;
1109                                 state->ks_composed_char = 0;
1110                         }
1111                 }
1112                 break;
1113         /* XXX: I don't like these... */
1114         case 0x5c:      /* print screen */
1115                 if (state->ks_flags & ALTS)
1116                         keycode = 0x54; /* sysrq */
1117                 break;
1118         case 0x68:      /* pause/break */
1119                 if (state->ks_flags & CTLS)
1120                         keycode = 0x6c; /* break */
1121                 break;
1122         }
1123
1124         /* return the key code in the K_CODE mode */
1125         if (usbcode & KEY_RELEASE)
1126                 keycode |= SCAN_RELEASE;
1127         if (state->ks_mode == K_CODE)
1128                 return keycode;
1129
1130         /* compose a character code */
1131         if (state->ks_flags & COMPOSE) {
1132                 switch (keycode) {
1133                 /* key pressed, process it */
1134                 case 0x47: case 0x48: case 0x49:        /* keypad 7,8,9 */
1135                         state->ks_composed_char *= 10;
1136                         state->ks_composed_char += keycode - 0x40;
1137                         if (state->ks_composed_char > UCHAR_MAX)
1138                                 return ERRKEY;
1139                         goto next_code;
1140                 case 0x4B: case 0x4C: case 0x4D:        /* keypad 4,5,6 */
1141                         state->ks_composed_char *= 10;
1142                         state->ks_composed_char += keycode - 0x47;
1143                         if (state->ks_composed_char > UCHAR_MAX)
1144                                 return ERRKEY;
1145                         goto next_code;
1146                 case 0x4F: case 0x50: case 0x51:        /* keypad 1,2,3 */
1147                         state->ks_composed_char *= 10;
1148                         state->ks_composed_char += keycode - 0x4E;
1149                         if (state->ks_composed_char > UCHAR_MAX)
1150                                 return ERRKEY;
1151                         goto next_code;
1152                 case 0x52:                              /* keypad 0 */
1153                         state->ks_composed_char *= 10;
1154                         if (state->ks_composed_char > UCHAR_MAX)
1155                                 return ERRKEY;
1156                         goto next_code;
1157
1158                 /* key released, no interest here */
1159                 case SCAN_RELEASE | 0x47:
1160                 case SCAN_RELEASE | 0x48:
1161                 case SCAN_RELEASE | 0x49:               /* keypad 7,8,9 */
1162                 case SCAN_RELEASE | 0x4B:
1163                 case SCAN_RELEASE | 0x4C:
1164                 case SCAN_RELEASE | 0x4D:               /* keypad 4,5,6 */
1165                 case SCAN_RELEASE | 0x4F:
1166                 case SCAN_RELEASE | 0x50:
1167                 case SCAN_RELEASE | 0x51:               /* keypad 1,2,3 */
1168                 case SCAN_RELEASE | 0x52:               /* keypad 0 */
1169                         goto next_code;
1170
1171                 case 0x38:                              /* left alt key */
1172                         break;
1173
1174                 default:
1175                         if (state->ks_composed_char > 0) {
1176                                 state->ks_flags &= ~COMPOSE;
1177                                 state->ks_composed_char = 0;
1178                                 return ERRKEY;
1179                         }
1180                         break;
1181                 }
1182         }
1183
1184         /* keycode to key action */
1185         action = genkbd_keyaction(kbd, SCAN_CHAR(keycode),
1186                                   keycode & SCAN_RELEASE, &state->ks_state,
1187                                   &state->ks_accents);
1188         if (action == NOKEY)
1189                 goto next_code;
1190         else
1191                 return action;
1192 }
1193
1194 /* check if char is waiting */
1195 static int
1196 ukbd_check_char(keyboard_t *kbd)
1197 {
1198         ukbd_state_t *state;
1199
1200         if (!KBD_IS_ACTIVE(kbd) || !KBD_HAS_DEVICE(kbd))
1201                 return FALSE;
1202         state = (ukbd_state_t *)kbd->kb_data;
1203         if (!(state->ks_flags & COMPOSE) && (state->ks_composed_char > 0))
1204                 return TRUE;
1205         return (ukbd_check(kbd));
1206 }
1207
1208 /* some useful control functions */
1209 static int
1210 ukbd_ioctl(keyboard_t *kbd, u_long cmd, caddr_t arg)
1211 {
1212         /* trasnlate LED_XXX bits into the device specific bits */
1213         static u_char ledmap[8] = {
1214                 0, 2, 1, 3, 4, 6, 5, 7,
1215         };
1216         ukbd_state_t *state = kbd->kb_data;
1217         int i;
1218
1219         crit_enter();
1220         switch (cmd) {
1221         case KDGKBMODE:         /* get keyboard mode */
1222                 *(int *)arg = state->ks_mode;
1223                 break;
1224         case KDSKBMODE:         /* set keyboard mode */
1225                 switch (*(int *)arg) {
1226                 case K_XLATE:
1227                         if (state->ks_mode != K_XLATE) {
1228                                 /* make lock key state and LED state match */
1229                                 state->ks_state &= ~LOCK_MASK;
1230                                 state->ks_state |= KBD_LED_VAL(kbd);
1231                         }
1232                         /* FALLTHROUGH */
1233                 case K_RAW:
1234                 case K_CODE:
1235                         if (state->ks_mode != *(int *)arg) {
1236                                 ukbd_clear_state(kbd);
1237                                 state->ks_mode = *(int *)arg;
1238                                 kbd->kb_savemode = state->ks_mode;
1239                         }
1240                         break;
1241                 default:
1242                         crit_exit();
1243                         return EINVAL;
1244                 }
1245                 break;
1246
1247         case KDGETLED:          /* get keyboard LED */
1248                 *(int *)arg = KBD_LED_VAL(kbd);
1249                 break;
1250         case KDSETLED:          /* set keyboard LED */
1251                 /* NOTE: lock key state in ks_state won't be changed */
1252                 if (*(int *)arg & ~LOCK_MASK) {
1253                         crit_exit();
1254                         return EINVAL;
1255                 }
1256                 i = *(int *)arg;
1257                 /* replace CAPS LED with ALTGR LED for ALTGR keyboards */
1258                 if (kbd->kb_keymap->n_keys > ALTGR_OFFSET) {
1259                         if (i & ALKED)
1260                                 i |= CLKED;
1261                         else
1262                                 i &= ~CLKED;
1263                 }
1264                 if (KBD_HAS_DEVICE(kbd)) {
1265                         set_leds(state, ledmap[i & LED_MASK]);
1266                         /* XXX: error check? */
1267                 }
1268                 KBD_LED_VAL(kbd) = *(int *)arg;
1269                 break;
1270
1271         case KDGKBSTATE:        /* get lock key state */
1272                 *(int *)arg = state->ks_state & LOCK_MASK;
1273                 break;
1274         case KDSKBSTATE:        /* set lock key state */
1275                 if (*(int *)arg & ~LOCK_MASK) {
1276                         crit_exit();
1277                         return EINVAL;
1278                 }
1279                 state->ks_state &= ~LOCK_MASK;
1280                 state->ks_state |= *(int *)arg;
1281                 crit_exit();
1282                 /* set LEDs and quit */
1283                 return ukbd_ioctl(kbd, KDSETLED, arg);
1284
1285         case KDSETREPEAT:       /* set keyboard repeat rate (new interface) */
1286                 crit_exit();
1287                 if (!KBD_HAS_DEVICE(kbd))
1288                         return 0;
1289                 if (((int *)arg)[1] < 0)
1290                         return EINVAL;
1291                 if (((int *)arg)[0] < 0)
1292                         return EINVAL;
1293                 else if (((int *)arg)[0] == 0)  /* fastest possible value */
1294                         kbd->kb_delay1 = 200;
1295                 else
1296                         kbd->kb_delay1 = ((int *)arg)[0];
1297                 kbd->kb_delay2 = ((int *)arg)[1];
1298                 return 0;
1299
1300         case KDSETRAD:          /* set keyboard repeat rate (old interface) */
1301                 crit_exit();
1302                 return set_typematic(kbd, *(int *)arg);
1303
1304         case PIO_KEYMAP:        /* set keyboard translation table */
1305         case PIO_KEYMAPENT:     /* set keyboard translation table entry */
1306         case PIO_DEADKEYMAP:    /* set accent key translation table */
1307                 state->ks_accents = 0;
1308                 /* FALLTHROUGH */
1309         default:
1310                 crit_exit();
1311                 return genkbd_commonioctl(kbd, cmd, arg);
1312
1313 #ifdef USB_DEBUG
1314         case USB_SETDEBUG:
1315                 ukbddebug = *(int *)arg;
1316                 break;
1317 #endif
1318         }
1319
1320         crit_exit();
1321         return 0;
1322 }
1323
1324 /* lock the access to the keyboard */
1325 static int
1326 ukbd_lock(keyboard_t *kbd, int lock)
1327 {
1328         /* XXX ? */
1329         return TRUE;
1330 }
1331
1332 /* clear the internal state of the keyboard */
1333 static void
1334 ukbd_clear_state(keyboard_t *kbd)
1335 {
1336         ukbd_state_t *state;
1337
1338         state = (ukbd_state_t *)kbd->kb_data;
1339         state->ks_flags = 0;
1340         state->ks_polling = 0;
1341         state->ks_state &= LOCK_MASK;   /* preserve locking key state */
1342         state->ks_accents = 0;
1343         state->ks_composed_char = 0;
1344 #ifdef UKBD_EMULATE_ATSCANCODE
1345         state->ks_buffered_char[0] = 0;
1346         state->ks_buffered_char[1] = 0;
1347 #endif
1348         bzero(&state->ks_ndata, sizeof(state->ks_ndata));
1349         bzero(&state->ks_odata, sizeof(state->ks_odata));
1350         bzero(&state->ks_ntime, sizeof(state->ks_ntime));
1351         bzero(&state->ks_otime, sizeof(state->ks_otime));
1352 }
1353
1354 /* save the internal state */
1355 static int
1356 ukbd_get_state(keyboard_t *kbd, void *buf, size_t len)
1357 {
1358         if (len == 0)
1359                 return sizeof(ukbd_state_t);
1360         if (len < sizeof(ukbd_state_t))
1361                 return -1;
1362         bcopy(kbd->kb_data, buf, sizeof(ukbd_state_t));
1363         return 0;
1364 }
1365
1366 /* set the internal state */
1367 static int
1368 ukbd_set_state(keyboard_t *kbd, void *buf, size_t len)
1369 {
1370         if (len < sizeof(ukbd_state_t))
1371                 return ENOMEM;
1372         bcopy(buf, kbd->kb_data, sizeof(ukbd_state_t));
1373         return 0;
1374 }
1375
1376 static int
1377 ukbd_poll(keyboard_t *kbd, int on)
1378 {
1379         ukbd_state_t *state;
1380         usbd_device_handle dev;
1381
1382         state = (ukbd_state_t *)kbd->kb_data;
1383         usbd_interface2device_handle(state->ks_iface, &dev);
1384
1385         crit_enter();
1386         if (on) {
1387                 if (state->ks_polling == 0)
1388                         usbd_set_polling(dev, on);
1389                 ++state->ks_polling;
1390         } else {
1391                 --state->ks_polling;
1392                 if (state->ks_polling == 0)
1393                         usbd_set_polling(dev, on);
1394         }
1395         crit_exit();
1396         return 0;
1397 }
1398
1399 /* local functions */
1400
1401 static int
1402 probe_keyboard(struct usb_attach_arg *uaa, int flags)
1403 {
1404         usb_interface_descriptor_t *id;
1405
1406         if (!uaa->iface)        /* we attach to ifaces only */
1407                 return EINVAL;
1408
1409         /* Check that this is a keyboard that speaks the boot protocol. */
1410         id = usbd_get_interface_descriptor(uaa->iface);
1411         if (id
1412             && id->bInterfaceClass == UICLASS_HID
1413             && id->bInterfaceSubClass == UISUBCLASS_BOOT
1414             && id->bInterfaceProtocol == UPROTO_BOOT_KEYBOARD)
1415                 return 0;       /* found it */
1416
1417         return EINVAL;
1418 }
1419
1420 static int
1421 init_keyboard(ukbd_state_t *state, int *type, int flags)
1422 {
1423         usb_endpoint_descriptor_t *ed;
1424         usbd_status err;
1425
1426         *type = KB_OTHER;
1427
1428         state->ks_ifstate |= DISCONNECTED;
1429
1430         ed = usbd_interface2endpoint_descriptor(state->ks_iface, 0);
1431         if (!ed) {
1432                 kprintf("ukbd: could not read endpoint descriptor\n");
1433                 return EIO;
1434         }
1435
1436         DPRINTFN(10,("ukbd:init_keyboard: \
1437 bLength=%d bDescriptorType=%d bEndpointAddress=%d-%s bmAttributes=%d wMaxPacketSize=%d bInterval=%d\n",
1438                ed->bLength, ed->bDescriptorType,
1439                UE_GET_ADDR(ed->bEndpointAddress),
1440                UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN ? "in":"out",
1441                UE_GET_XFERTYPE(ed->bmAttributes),
1442                UGETW(ed->wMaxPacketSize), ed->bInterval));
1443
1444         if (UE_GET_DIR(ed->bEndpointAddress) != UE_DIR_IN ||
1445             UE_GET_XFERTYPE(ed->bmAttributes) != UE_INTERRUPT) {
1446                 kprintf("ukbd: unexpected endpoint\n");
1447                 return EINVAL;
1448         }
1449
1450         if ((usbd_get_quirks(state->ks_uaa->device)->uq_flags & UQ_NO_SET_PROTO) == 0) {
1451                 err = usbd_set_protocol(state->ks_iface, 0);
1452                 DPRINTFN(5, ("ukbd:init_keyboard: protocol set\n"));
1453                 if (err) {
1454                         kprintf("ukbd: set protocol failed\n");
1455                         return EIO;
1456                 }
1457         }
1458         /* Ignore if SETIDLE fails since it is not crucial. */
1459         usbd_set_idle(state->ks_iface, 0, 0);
1460
1461         state->ks_ep_addr = ed->bEndpointAddress;
1462         state->ks_ifstate &= ~DISCONNECTED;
1463
1464         return 0;
1465 }
1466
1467 static void
1468 set_leds(ukbd_state_t *state, int leds)
1469 {
1470         u_int8_t res = leds;
1471
1472         DPRINTF(("ukbd:set_leds: state=%p leds=%d\n", state, leds));
1473
1474         usbd_set_report_async(state->ks_iface, UHID_OUTPUT_REPORT, 0, &res, 1);
1475 }
1476
1477 static int
1478 set_typematic(keyboard_t *kbd, int code)
1479 {
1480         static int delays[] = { 250, 500, 750, 1000 };
1481         static int rates[] = {  34,  38,  42,  46,  50,  55,  59,  63,
1482                                 68,  76,  84,  92, 100, 110, 118, 126,
1483                                136, 152, 168, 184, 200, 220, 236, 252,
1484                                272, 304, 336, 368, 400, 440, 472, 504 };
1485
1486         if (code & ~0x7f)
1487                 return EINVAL;
1488         kbd->kb_delay1 = delays[(code >> 5) & 3];
1489         kbd->kb_delay2 = rates[code & 0x1f];
1490         return 0;
1491 }
1492
1493 #ifdef UKBD_EMULATE_ATSCANCODE
1494 static int
1495 keycode2scancode(int keycode, int shift, int up)
1496 {
1497         static int scan[] = {
1498                 0x1c, 0x1d, 0x35,
1499                 0x37 | SCAN_PREFIX_SHIFT, /* PrintScreen */
1500                 0x38, 0x47, 0x48, 0x49, 0x4b, 0x4d, 0x4f,
1501                 0x50, 0x51, 0x52, 0x53,
1502                 0x46,   /* XXX Pause/Break */
1503                 0x5b, 0x5c, 0x5d,
1504         };
1505         int scancode;
1506
1507         scancode = keycode;
1508         if ((keycode >= 89) && (keycode < 89 + sizeof(scan)/sizeof(scan[0])))
1509                 scancode = scan[keycode - 89] | SCAN_PREFIX_E0;
1510         /* Pause/Break */
1511         if ((keycode == 104) && !(shift & (MOD_CONTROL_L | MOD_CONTROL_R)))
1512                 scancode = 0x45 | SCAN_PREFIX_E1 | SCAN_PREFIX_CTL;
1513         if (shift & (MOD_SHIFT_L | MOD_SHIFT_R))
1514                 scancode &= ~SCAN_PREFIX_SHIFT;
1515         return (scancode | (up ? SCAN_RELEASE : SCAN_PRESS));
1516 }
1517 #endif /* UKBD_EMULATE_ATSCANCODE */
1518
1519 static int
1520 ukbd_driver_load(module_t mod, int what, void *arg)
1521 {
1522         switch (what) {
1523                 case MOD_LOAD:
1524                         kbd_add_driver(&ukbd_kbd_driver);
1525                         break;
1526                 case MOD_UNLOAD:
1527                         kbd_delete_driver(&ukbd_kbd_driver);
1528                         break;
1529         }
1530         return usbd_driver_load(mod, what, 0);
1531 }