1 /* $NetBSD: ukbd.c,v 1.101 2008/09/09 17:40:40 jmcneill Exp $ */ 2 3 /* 4 * Copyright (c) 1998 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Lennart Augustsson (lennart@augustsson.net) at 9 * Carlstedt Research & Technology. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30 * POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33 /* 34 * HID spec: http://www.usb.org/developers/devclass_docs/HID1_11.pdf 35 */ 36 37 #include <sys/cdefs.h> 38 __KERNEL_RCSID(0, "$NetBSD: ukbd.c,v 1.101 2008/09/09 17:40:40 jmcneill Exp $"); 39 40 #include <sys/param.h> 41 #include <sys/systm.h> 42 #include <sys/callout.h> 43 #include <sys/kernel.h> 44 #include <sys/device.h> 45 #include <sys/ioctl.h> 46 #include <sys/tty.h> 47 #include <sys/file.h> 48 #include <sys/select.h> 49 #include <sys/proc.h> 50 #include <sys/vnode.h> 51 #include <sys/poll.h> 52 53 #include <dev/usb/usb.h> 54 #include <dev/usb/usbhid.h> 55 56 #include <dev/usb/usbdi.h> 57 #include <dev/usb/usbdi_util.h> 58 #include <dev/usb/usbdevs.h> 59 #include <dev/usb/usb_quirks.h> 60 #include <dev/usb/uhidev.h> 61 #include <dev/usb/hid.h> 62 #include <dev/usb/ukbdvar.h> 63 64 #include <dev/wscons/wsconsio.h> 65 #include <dev/wscons/wskbdvar.h> 66 #include <dev/wscons/wsksymdef.h> 67 #include <dev/wscons/wsksymvar.h> 68 69 #include "opt_ukbd_layout.h" 70 #include "opt_wsdisplay_compat.h" 71 #include "opt_ddb.h" 72 73 #ifdef UKBD_DEBUG 74 #define DPRINTF(x) if (ukbddebug) logprintf x 75 #define DPRINTFN(n,x) if (ukbddebug>(n)) logprintf x 76 int ukbddebug = 0; 77 #else 78 #define DPRINTF(x) 79 #define DPRINTFN(n,x) 80 #endif 81 82 #define MAXKEYCODE 6 83 #define MAXMOD 8 /* max 32 */ 84 85 struct ukbd_data { 86 u_int32_t modifiers; 87 u_int8_t keycode[MAXKEYCODE]; 88 }; 89 90 #define PRESS 0x000 91 #define RELEASE 0x100 92 #define CODEMASK 0x0ff 93 94 #if defined(__NetBSD__) && defined(WSDISPLAY_COMPAT_RAWKBD) 95 #define NN 0 /* no translation */ 96 /* 97 * Translate USB keycodes to US keyboard XT scancodes. 98 * Scancodes >= 0x80 represent EXTENDED keycodes. 99 * 100 * See http://www.microsoft.com/whdc/device/input/Scancode.mspx 101 */ 102 Static const u_int8_t ukbd_trtab[256] = { 103 NN, NN, NN, NN, 0x1e, 0x30, 0x2e, 0x20, /* 00 - 07 */ 104 0x12, 0x21, 0x22, 0x23, 0x17, 0x24, 0x25, 0x26, /* 08 - 0f */ 105 0x32, 0x31, 0x18, 0x19, 0x10, 0x13, 0x1f, 0x14, /* 10 - 17 */ 106 0x16, 0x2f, 0x11, 0x2d, 0x15, 0x2c, 0x02, 0x03, /* 18 - 1f */ 107 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b, /* 20 - 27 */ 108 0x1c, 0x01, 0x0e, 0x0f, 0x39, 0x0c, 0x0d, 0x1a, /* 28 - 2f */ 109 0x1b, 0x2b, 0x2b, 0x27, 0x28, 0x29, 0x33, 0x34, /* 30 - 37 */ 110 0x35, 0x3a, 0x3b, 0x3c, 0x3d, 0x3e, 0x3f, 0x40, /* 38 - 3f */ 111 0x41, 0x42, 0x43, 0x44, 0x57, 0x58, 0xaa, 0x46, /* 40 - 47 */ 112 0x7f, 0xd2, 0xc7, 0xc9, 0xd3, 0xcf, 0xd1, 0xcd, /* 48 - 4f */ 113 0xcb, 0xd0, 0xc8, 0x45, 0xb5, 0x37, 0x4a, 0x4e, /* 50 - 57 */ 114 0x9c, 0x4f, 0x50, 0x51, 0x4b, 0x4c, 0x4d, 0x47, /* 58 - 5f */ 115 0x48, 0x49, 0x52, 0x53, 0x56, 0xdd, NN, 0x59, /* 60 - 67 */ 116 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x6a, NN, /* 68 - 6f */ 117 NN, NN, NN, NN, NN, NN, NN, NN, /* 70 - 77 */ 118 NN, NN, NN, NN, NN, NN, NN, NN, /* 78 - 7f */ 119 NN, NN, NN, NN, NN, 0x7e, NN, 0x73, /* 80 - 87 */ 120 0x70, 0x7d, 0x79, 0x7b, 0x5c, NN, NN, NN, /* 88 - 8f */ 121 NN, NN, 0x78, 0x77, 0x76, NN, NN, NN, /* 90 - 97 */ 122 NN, NN, NN, NN, NN, NN, NN, NN, /* 98 - 9f */ 123 NN, NN, NN, NN, NN, NN, NN, NN, /* a0 - a7 */ 124 NN, NN, NN, NN, NN, NN, NN, NN, /* a8 - af */ 125 NN, NN, NN, NN, NN, NN, NN, NN, /* b0 - b7 */ 126 NN, NN, NN, NN, NN, NN, NN, NN, /* b8 - bf */ 127 NN, NN, NN, NN, NN, NN, NN, NN, /* c0 - c7 */ 128 NN, NN, NN, NN, NN, NN, NN, NN, /* c8 - cf */ 129 NN, NN, NN, NN, NN, NN, NN, NN, /* d0 - d7 */ 130 NN, NN, NN, NN, NN, NN, NN, NN, /* d8 - df */ 131 0x1d, 0x2a, 0x38, 0xdb, 0x9d, 0x36, 0xb8, 0xdc, /* e0 - e7 */ 132 NN, NN, NN, NN, NN, NN, NN, NN, /* e8 - ef */ 133 NN, NN, NN, NN, NN, NN, NN, NN, /* f0 - f7 */ 134 NN, NN, NN, NN, NN, NN, NN, NN, /* f8 - ff */ 135 }; 136 #endif /* defined(__NetBSD__) && defined(WSDISPLAY_COMPAT_RAWKBD) */ 137 138 #define KEY_ERROR 0x01 139 140 #define MAXKEYS (MAXMOD+2*MAXKEYCODE) 141 142 struct ukbd_softc { 143 struct uhidev sc_hdev; 144 145 struct ukbd_data sc_ndata; 146 struct ukbd_data sc_odata; 147 struct hid_location sc_modloc[MAXMOD]; 148 u_int sc_nmod; 149 struct { 150 u_int32_t mask; 151 u_int8_t key; 152 } sc_mods[MAXMOD]; 153 154 struct hid_location sc_keycodeloc; 155 u_int sc_nkeycode; 156 157 char sc_enabled; 158 159 int sc_console_keyboard; /* we are the console keyboard */ 160 161 char sc_debounce; /* for quirk handling */ 162 usb_callout_t sc_delay; /* for quirk handling */ 163 struct ukbd_data sc_data; /* for quirk handling */ 164 165 struct hid_location sc_numloc; 166 struct hid_location sc_capsloc; 167 struct hid_location sc_scroloc; 168 int sc_leds; 169 #if defined(__NetBSD__) 170 device_t sc_wskbddev; 171 172 #if defined(WSDISPLAY_COMPAT_RAWKBD) 173 int sc_rawkbd; 174 #if defined(UKBD_REPEAT) 175 usb_callout_t sc_rawrepeat_ch; 176 #define REP_DELAY1 400 177 #define REP_DELAYN 100 178 int sc_nrep; 179 char sc_rep[MAXKEYS]; 180 #endif /* defined(UKBD_REPEAT) */ 181 #endif /* defined(WSDISPLAY_COMPAT_RAWKBD) */ 182 183 int sc_spl; 184 int sc_polling; 185 int sc_npollchar; 186 u_int16_t sc_pollchars[MAXKEYS]; 187 #endif /* defined(__NetBSD__) */ 188 189 u_char sc_dying; 190 }; 191 192 #ifdef UKBD_DEBUG 193 #define UKBDTRACESIZE 64 194 struct ukbdtraceinfo { 195 int unit; 196 struct timeval tv; 197 struct ukbd_data ud; 198 }; 199 struct ukbdtraceinfo ukbdtracedata[UKBDTRACESIZE]; 200 int ukbdtraceindex = 0; 201 int ukbdtrace = 0; 202 void ukbdtracedump(void); 203 void 204 ukbdtracedump(void) 205 { 206 int i; 207 for (i = 0; i < UKBDTRACESIZE; i++) { 208 struct ukbdtraceinfo *p = 209 &ukbdtracedata[(i+ukbdtraceindex)%UKBDTRACESIZE]; 210 printf("%lu.%06lu: mod=0x%02x key0=0x%02x key1=0x%02x " 211 "key2=0x%02x key3=0x%02x\n", 212 p->tv.tv_sec, p->tv.tv_usec, 213 p->ud.modifiers, p->ud.keycode[0], p->ud.keycode[1], 214 p->ud.keycode[2], p->ud.keycode[3]); 215 } 216 } 217 #endif 218 219 #define UKBDUNIT(dev) (minor(dev)) 220 #define UKBD_CHUNK 128 /* chunk size for read */ 221 #define UKBD_BSIZE 1020 /* buffer size */ 222 223 Static int ukbd_is_console; 224 225 Static void ukbd_cngetc(void *, u_int *, int *); 226 Static void ukbd_cnpollc(void *, int); 227 228 #if defined(__NetBSD__) 229 const struct wskbd_consops ukbd_consops = { 230 ukbd_cngetc, 231 ukbd_cnpollc, 232 NULL, /* bell */ 233 }; 234 #endif 235 236 Static const char *ukbd_parse_desc(struct ukbd_softc *sc); 237 238 Static void ukbd_intr(struct uhidev *addr, void *ibuf, u_int len); 239 Static void ukbd_decode(struct ukbd_softc *sc, struct ukbd_data *ud); 240 Static void ukbd_delayed_decode(void *addr); 241 242 Static int ukbd_enable(void *, int); 243 Static void ukbd_set_leds(void *, int); 244 245 #if defined(__NetBSD__) 246 Static int ukbd_ioctl(void *, u_long, void *, int, struct lwp *); 247 #if defined(WSDISPLAY_COMPAT_RAWKBD) && defined(UKBD_REPEAT) 248 Static void ukbd_rawrepeat(void *v); 249 #endif 250 251 const struct wskbd_accessops ukbd_accessops = { 252 ukbd_enable, 253 ukbd_set_leds, 254 ukbd_ioctl, 255 }; 256 257 extern const struct wscons_keydesc ukbd_keydesctab[]; 258 259 const struct wskbd_mapdata ukbd_keymapdata = { 260 ukbd_keydesctab, 261 #if defined(UKBD_LAYOUT) 262 UKBD_LAYOUT, 263 #elif defined(PCKBD_LAYOUT) 264 PCKBD_LAYOUT, 265 #else 266 KB_US, 267 #endif 268 }; 269 #endif 270 271 static int ukbd_match(device_t, cfdata_t, void *); 272 static void ukbd_attach(device_t, device_t, void *); 273 static int ukbd_detach(device_t, int); 274 static int ukbd_activate(device_t, enum devact); 275 static void ukbd_childdet(device_t, device_t); 276 277 extern struct cfdriver ukbd_cd; 278 279 CFATTACH_DECL2_NEW(ukbd, sizeof(struct ukbd_softc), ukbd_match, ukbd_attach, 280 ukbd_detach, ukbd_activate, NULL, ukbd_childdet); 281 282 int 283 ukbd_match(device_t parent, cfdata_t match, void *aux) 284 { 285 struct uhidev_attach_arg *uha = aux; 286 int size; 287 void *desc; 288 289 uhidev_get_report_desc(uha->parent, &desc, &size); 290 if (!hid_is_collection(desc, size, uha->reportid, 291 HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_KEYBOARD))) 292 return (UMATCH_NONE); 293 294 return (UMATCH_IFACECLASS); 295 } 296 297 void 298 ukbd_attach(device_t parent, device_t self, void *aux) 299 { 300 struct ukbd_softc *sc = device_private(self); 301 struct uhidev_attach_arg *uha = aux; 302 u_int32_t qflags; 303 const char *parseerr; 304 #if defined(__NetBSD__) 305 struct wskbddev_attach_args a; 306 #else 307 int i; 308 #endif 309 310 sc->sc_hdev.sc_dev = self; 311 sc->sc_hdev.sc_intr = ukbd_intr; 312 sc->sc_hdev.sc_parent = uha->parent; 313 sc->sc_hdev.sc_report_id = uha->reportid; 314 315 if (!pmf_device_register(self, NULL, NULL)) { 316 aprint_normal("\n"); 317 aprint_error_dev(self, "couldn't establish power handler\n"); 318 } 319 320 parseerr = ukbd_parse_desc(sc); 321 if (parseerr != NULL) { 322 aprint_normal("\n"); 323 aprint_error_dev(self, "attach failed, %s\n", parseerr); 324 USB_ATTACH_ERROR_RETURN; 325 } 326 327 #ifdef DIAGNOSTIC 328 aprint_normal(": %d modifier keys, %d key codes", sc->sc_nmod, 329 sc->sc_nkeycode); 330 #endif 331 aprint_normal("\n"); 332 333 qflags = usbd_get_quirks(uha->parent->sc_udev)->uq_flags; 334 sc->sc_debounce = (qflags & UQ_SPUR_BUT_UP) != 0; 335 336 /* 337 * Remember if we're the console keyboard. 338 * 339 * XXX This always picks the first keyboard on the 340 * first USB bus, but what else can we really do? 341 */ 342 if ((sc->sc_console_keyboard = ukbd_is_console) != 0) { 343 /* Don't let any other keyboard have it. */ 344 ukbd_is_console = 0; 345 } 346 347 if (sc->sc_console_keyboard) { 348 DPRINTF(("ukbd_attach: console keyboard sc=%p\n", sc)); 349 wskbd_cnattach(&ukbd_consops, sc, &ukbd_keymapdata); 350 ukbd_enable(sc, 1); 351 } 352 353 a.console = sc->sc_console_keyboard; 354 355 a.keymap = &ukbd_keymapdata; 356 357 a.accessops = &ukbd_accessops; 358 a.accesscookie = sc; 359 360 #ifdef UKBD_REPEAT 361 usb_callout_init(sc->sc_rawrepeat_ch); 362 #endif 363 364 usb_callout_init(sc->sc_delay); 365 366 /* Flash the leds; no real purpose, just shows we're alive. */ 367 ukbd_set_leds(sc, WSKBD_LED_SCROLL | WSKBD_LED_NUM | WSKBD_LED_CAPS); 368 usbd_delay_ms(uha->parent->sc_udev, 400); 369 ukbd_set_leds(sc, 0); 370 371 sc->sc_wskbddev = config_found(self, &a, wskbddevprint); 372 373 USB_ATTACH_SUCCESS_RETURN; 374 } 375 376 int 377 ukbd_enable(void *v, int on) 378 { 379 struct ukbd_softc *sc = v; 380 381 if (on && sc->sc_dying) 382 return (EIO); 383 384 /* Should only be called to change state */ 385 if (sc->sc_enabled == on) { 386 #ifdef DIAGNOSTIC 387 printf("ukbd_enable: %s: bad call on=%d\n", 388 USBDEVNAME(sc->sc_hdev.sc_dev), on); 389 #endif 390 return (EBUSY); 391 } 392 393 DPRINTF(("ukbd_enable: sc=%p on=%d\n", sc, on)); 394 sc->sc_enabled = on; 395 if (on) { 396 return (uhidev_open(&sc->sc_hdev)); 397 } else { 398 uhidev_close(&sc->sc_hdev); 399 return (0); 400 } 401 } 402 403 404 static void 405 ukbd_childdet(device_t self, device_t child) 406 { 407 struct ukbd_softc *sc = device_private(self); 408 409 KASSERT(sc->sc_wskbddev == child); 410 sc->sc_wskbddev = NULL; 411 } 412 413 int 414 ukbd_activate(device_t self, enum devact act) 415 { 416 struct ukbd_softc *sc = device_private(self); 417 int rv = 0; 418 419 switch (act) { 420 case DVACT_ACTIVATE: 421 return (EOPNOTSUPP); 422 423 case DVACT_DEACTIVATE: 424 if (sc->sc_wskbddev != NULL) 425 rv = config_deactivate(sc->sc_wskbddev); 426 sc->sc_dying = 1; 427 break; 428 } 429 return (rv); 430 } 431 432 int 433 ukbd_detach(device_t self, int flags) 434 { 435 struct ukbd_softc *sc = device_private(self); 436 int rv = 0; 437 438 DPRINTF(("ukbd_detach: sc=%p flags=%d\n", sc, flags)); 439 440 pmf_device_deregister(self); 441 442 if (sc->sc_console_keyboard) { 443 #if 0 444 /* 445 * XXX Should probably disconnect our consops, 446 * XXX and either notify some other keyboard that 447 * XXX it can now be the console, or if there aren't 448 * XXX any more USB keyboards, set ukbd_is_console 449 * XXX back to 1 so that the next USB keyboard attached 450 * XXX to the system will get it. 451 */ 452 panic("ukbd_detach: console keyboard"); 453 #else 454 /* 455 * Disconnect our consops and set ukbd_is_console 456 * back to 1 so that the next USB keyboard attached 457 * to the system will get it. 458 * XXX Should notify some other keyboard that it can be 459 * XXX console, if there are any other keyboards. 460 */ 461 printf("%s: was console keyboard\n", 462 USBDEVNAME(sc->sc_hdev.sc_dev)); 463 wskbd_cndetach(); 464 ukbd_is_console = 1; 465 #endif 466 } 467 /* No need to do reference counting of ukbd, wskbd has all the goo. */ 468 if (sc->sc_wskbddev != NULL) 469 rv = config_detach(sc->sc_wskbddev, flags); 470 471 /* The console keyboard does not get a disable call, so check pipe. */ 472 if (sc->sc_hdev.sc_state & UHIDEV_OPEN) 473 uhidev_close(&sc->sc_hdev); 474 475 return (rv); 476 } 477 478 void 479 ukbd_intr(struct uhidev *addr, void *ibuf, u_int len) 480 { 481 struct ukbd_softc *sc = (struct ukbd_softc *)addr; 482 struct ukbd_data *ud = &sc->sc_ndata; 483 int i; 484 485 #ifdef UKBD_DEBUG 486 if (ukbddebug > 5) { 487 printf("ukbd_intr: data"); 488 for (i = 0; i < len; i++) 489 printf(" 0x%02x", ((u_char *)ibuf)[i]); 490 printf("\n"); 491 } 492 #endif 493 494 ud->modifiers = 0; 495 for (i = 0; i < sc->sc_nmod; i++) 496 if (hid_get_data(ibuf, &sc->sc_modloc[i])) 497 ud->modifiers |= sc->sc_mods[i].mask; 498 memcpy(ud->keycode, (char *)ibuf + sc->sc_keycodeloc.pos / 8, 499 sc->sc_nkeycode); 500 501 if (sc->sc_debounce && !sc->sc_polling) { 502 /* 503 * Some keyboards have a peculiar quirk. They sometimes 504 * generate a key up followed by a key down for the same 505 * key after about 10 ms. 506 * We avoid this bug by holding off decoding for 20 ms. 507 */ 508 sc->sc_data = *ud; 509 usb_callout(sc->sc_delay, hz / 50, ukbd_delayed_decode, sc); 510 #ifdef DDB 511 } else if (sc->sc_console_keyboard && !sc->sc_polling) { 512 /* 513 * For the console keyboard we can't deliver CTL-ALT-ESC 514 * from the interrupt routine. Doing so would start 515 * polling from inside the interrupt routine and that 516 * loses bigtime. 517 */ 518 sc->sc_data = *ud; 519 usb_callout(sc->sc_delay, 1, ukbd_delayed_decode, sc); 520 #endif 521 } else { 522 ukbd_decode(sc, ud); 523 } 524 } 525 526 void 527 ukbd_delayed_decode(void *addr) 528 { 529 struct ukbd_softc *sc = addr; 530 531 ukbd_decode(sc, &sc->sc_data); 532 } 533 534 void 535 ukbd_decode(struct ukbd_softc *sc, struct ukbd_data *ud) 536 { 537 int mod, omod; 538 u_int16_t ibuf[MAXKEYS]; /* chars events */ 539 int s; 540 int nkeys, i, j; 541 int key; 542 #define ADDKEY(c) ibuf[nkeys++] = (c) 543 544 #ifdef UKBD_DEBUG 545 /* 546 * Keep a trace of the last events. Using printf changes the 547 * timing, so this can be useful sometimes. 548 */ 549 if (ukbdtrace) { 550 struct ukbdtraceinfo *p = &ukbdtracedata[ukbdtraceindex]; 551 p->unit = device_unit(sc->sc_hdev.sc_dev); 552 microtime(&p->tv); 553 p->ud = *ud; 554 if (++ukbdtraceindex >= UKBDTRACESIZE) 555 ukbdtraceindex = 0; 556 } 557 if (ukbddebug > 5) { 558 struct timeval tv; 559 microtime(&tv); 560 DPRINTF((" at %lu.%06lu mod=0x%02x key0=0x%02x key1=0x%02x " 561 "key2=0x%02x key3=0x%02x\n", 562 tv.tv_sec, tv.tv_usec, 563 ud->modifiers, ud->keycode[0], ud->keycode[1], 564 ud->keycode[2], ud->keycode[3])); 565 } 566 #endif 567 568 if (ud->keycode[0] == KEY_ERROR) { 569 DPRINTF(("ukbd_intr: KEY_ERROR\n")); 570 return; /* ignore */ 571 } 572 nkeys = 0; 573 mod = ud->modifiers; 574 omod = sc->sc_odata.modifiers; 575 if (mod != omod) 576 for (i = 0; i < sc->sc_nmod; i++) 577 if (( mod & sc->sc_mods[i].mask) != 578 (omod & sc->sc_mods[i].mask)) 579 ADDKEY(sc->sc_mods[i].key | 580 (mod & sc->sc_mods[i].mask 581 ? PRESS : RELEASE)); 582 if (memcmp(ud->keycode, sc->sc_odata.keycode, sc->sc_nkeycode) != 0) { 583 /* Check for released keys. */ 584 for (i = 0; i < sc->sc_nkeycode; i++) { 585 key = sc->sc_odata.keycode[i]; 586 if (key == 0) 587 continue; 588 for (j = 0; j < sc->sc_nkeycode; j++) 589 if (key == ud->keycode[j]) 590 goto rfound; 591 DPRINTFN(3,("ukbd_intr: relse key=0x%02x\n", key)); 592 ADDKEY(key | RELEASE); 593 rfound: 594 ; 595 } 596 597 /* Check for pressed keys. */ 598 for (i = 0; i < sc->sc_nkeycode; i++) { 599 key = ud->keycode[i]; 600 if (key == 0) 601 continue; 602 for (j = 0; j < sc->sc_nkeycode; j++) 603 if (key == sc->sc_odata.keycode[j]) 604 goto pfound; 605 DPRINTFN(2,("ukbd_intr: press key=0x%02x\n", key)); 606 ADDKEY(key | PRESS); 607 pfound: 608 ; 609 } 610 } 611 sc->sc_odata = *ud; 612 613 if (nkeys == 0) 614 return; 615 616 if (sc->sc_polling) { 617 DPRINTFN(1,("ukbd_intr: pollchar = 0x%03x\n", ibuf[0])); 618 memcpy(sc->sc_pollchars, ibuf, nkeys * sizeof(u_int16_t)); 619 sc->sc_npollchar = nkeys; 620 return; 621 } 622 #ifdef WSDISPLAY_COMPAT_RAWKBD 623 if (sc->sc_rawkbd) { 624 u_char cbuf[MAXKEYS * 2]; 625 int c; 626 int npress; 627 628 for (npress = i = j = 0; i < nkeys; i++) { 629 key = ibuf[i]; 630 c = ukbd_trtab[key & CODEMASK]; 631 if (c == NN) 632 continue; 633 if (c & 0x80) 634 cbuf[j++] = 0xe0; 635 cbuf[j] = c & 0x7f; 636 if (key & RELEASE) 637 cbuf[j] |= 0x80; 638 #if defined(UKBD_REPEAT) 639 else { 640 /* remember pressed keys for autorepeat */ 641 if (c & 0x80) 642 sc->sc_rep[npress++] = 0xe0; 643 sc->sc_rep[npress++] = c & 0x7f; 644 } 645 #endif 646 DPRINTFN(1,("ukbd_intr: raw = %s0x%02x\n", 647 c & 0x80 ? "0xe0 " : "", 648 cbuf[j])); 649 j++; 650 } 651 s = spltty(); 652 wskbd_rawinput(sc->sc_wskbddev, cbuf, j); 653 splx(s); 654 #ifdef UKBD_REPEAT 655 usb_uncallout(sc->sc_rawrepeat_ch, ukbd_rawrepeat, sc); 656 if (npress != 0) { 657 sc->sc_nrep = npress; 658 usb_callout(sc->sc_rawrepeat_ch, 659 hz * REP_DELAY1 / 1000, ukbd_rawrepeat, sc); 660 } 661 #endif 662 return; 663 } 664 #endif 665 666 s = spltty(); 667 for (i = 0; i < nkeys; i++) { 668 key = ibuf[i]; 669 wskbd_input(sc->sc_wskbddev, 670 key&RELEASE ? WSCONS_EVENT_KEY_UP : WSCONS_EVENT_KEY_DOWN, 671 key&CODEMASK); 672 } 673 splx(s); 674 } 675 676 void 677 ukbd_set_leds(void *v, int leds) 678 { 679 struct ukbd_softc *sc = v; 680 u_int8_t res; 681 682 DPRINTF(("ukbd_set_leds: sc=%p leds=%d, sc_leds=%d\n", 683 sc, leds, sc->sc_leds)); 684 685 if (sc->sc_dying) 686 return; 687 688 if (sc->sc_leds == leds) 689 return; 690 sc->sc_leds = leds; 691 res = 0; 692 /* XXX not really right */ 693 if ((leds & WSKBD_LED_SCROLL) && sc->sc_scroloc.size == 1) 694 res |= 1 << sc->sc_scroloc.pos; 695 if ((leds & WSKBD_LED_NUM) && sc->sc_numloc.size == 1) 696 res |= 1 << sc->sc_numloc.pos; 697 if ((leds & WSKBD_LED_CAPS) && sc->sc_capsloc.size == 1) 698 res |= 1 << sc->sc_capsloc.pos; 699 uhidev_set_report_async(&sc->sc_hdev, UHID_OUTPUT_REPORT, &res, 1); 700 } 701 702 #if defined(WSDISPLAY_COMPAT_RAWKBD) && defined(UKBD_REPEAT) 703 void 704 ukbd_rawrepeat(void *v) 705 { 706 struct ukbd_softc *sc = v; 707 int s; 708 709 s = spltty(); 710 wskbd_rawinput(sc->sc_wskbddev, sc->sc_rep, sc->sc_nrep); 711 splx(s); 712 usb_callout(sc->sc_rawrepeat_ch, hz * REP_DELAYN / 1000, 713 ukbd_rawrepeat, sc); 714 } 715 #endif /* defined(WSDISPLAY_COMPAT_RAWKBD) && defined(UKBD_REPEAT) */ 716 717 int 718 ukbd_ioctl(void *v, u_long cmd, void *data, int flag, 719 struct lwp *l) 720 { 721 struct ukbd_softc *sc = v; 722 723 switch (cmd) { 724 case WSKBDIO_GTYPE: 725 *(int *)data = WSKBD_TYPE_USB; 726 return (0); 727 case WSKBDIO_SETLEDS: 728 ukbd_set_leds(v, *(int *)data); 729 return (0); 730 case WSKBDIO_GETLEDS: 731 *(int *)data = sc->sc_leds; 732 return (0); 733 #if defined(WSDISPLAY_COMPAT_RAWKBD) 734 case WSKBDIO_SETMODE: 735 DPRINTF(("ukbd_ioctl: set raw = %d\n", *(int *)data)); 736 sc->sc_rawkbd = *(int *)data == WSKBD_RAW; 737 #if defined(UKBD_REPEAT) 738 usb_uncallout(sc->sc_rawrepeat_ch, ukbd_rawrepeat, sc); 739 #endif 740 return (0); 741 #endif 742 } 743 return (EPASSTHROUGH); 744 } 745 746 /* 747 * This is a hack to work around some broken ports that don't call 748 * cnpollc() before cngetc(). 749 */ 750 static int pollenter, warned; 751 752 /* Console interface. */ 753 void 754 ukbd_cngetc(void *v, u_int *type, int *data) 755 { 756 struct ukbd_softc *sc = v; 757 int c; 758 int broken; 759 760 if (pollenter == 0) { 761 if (!warned) { 762 printf("\n" 763 "This port is broken, it does not call cnpollc() before calling cngetc().\n" 764 "This should be fixed, but it will work anyway (for now).\n"); 765 warned = 1; 766 } 767 broken = 1; 768 ukbd_cnpollc(v, 1); 769 } else 770 broken = 0; 771 772 DPRINTFN(0,("ukbd_cngetc: enter\n")); 773 sc->sc_polling = 1; 774 while(sc->sc_npollchar <= 0) 775 usbd_dopoll(sc->sc_hdev.sc_parent->sc_iface); 776 sc->sc_polling = 0; 777 c = sc->sc_pollchars[0]; 778 sc->sc_npollchar--; 779 memcpy(sc->sc_pollchars, sc->sc_pollchars+1, 780 sc->sc_npollchar * sizeof(u_int16_t)); 781 *type = c & RELEASE ? WSCONS_EVENT_KEY_UP : WSCONS_EVENT_KEY_DOWN; 782 *data = c & CODEMASK; 783 DPRINTFN(0,("ukbd_cngetc: return 0x%02x\n", c)); 784 if (broken) 785 ukbd_cnpollc(v, 0); 786 } 787 788 void 789 ukbd_cnpollc(void *v, int on) 790 { 791 struct ukbd_softc *sc = v; 792 usbd_device_handle dev; 793 794 DPRINTFN(2,("ukbd_cnpollc: sc=%p on=%d\n", v, on)); 795 796 usbd_interface2device_handle(sc->sc_hdev.sc_parent->sc_iface, &dev); 797 if (on) { 798 sc->sc_spl = splusb(); 799 pollenter++; 800 } else { 801 splx(sc->sc_spl); 802 pollenter--; 803 } 804 usbd_set_polling(dev, on); 805 } 806 807 int 808 ukbd_cnattach(void) 809 { 810 811 /* 812 * XXX USB requires too many parts of the kernel to be running 813 * XXX in order to work, so we can't do much for the console 814 * XXX keyboard until autconfiguration has run its course. 815 */ 816 ukbd_is_console = 1; 817 return (0); 818 } 819 820 const char * 821 ukbd_parse_desc(struct ukbd_softc *sc) 822 { 823 struct hid_data *d; 824 struct hid_item h; 825 int size; 826 void *desc; 827 int imod; 828 829 uhidev_get_report_desc(sc->sc_hdev.sc_parent, &desc, &size); 830 imod = 0; 831 sc->sc_nkeycode = 0; 832 d = hid_start_parse(desc, size, hid_input); 833 while (hid_get_item(d, &h)) { 834 /*printf("ukbd: id=%d kind=%d usage=0x%x flags=0x%x pos=%d size=%d cnt=%d\n", 835 h.report_ID, h.kind, h.usage, h.flags, h.loc.pos, h.loc.size, h.loc.count);*/ 836 if (h.kind != hid_input || (h.flags & HIO_CONST) || 837 HID_GET_USAGE_PAGE(h.usage) != HUP_KEYBOARD || 838 h.report_ID != sc->sc_hdev.sc_report_id) 839 continue; 840 DPRINTF(("ukbd: imod=%d usage=0x%x flags=0x%x pos=%d size=%d " 841 "cnt=%d\n", imod, 842 h.usage, h.flags, h.loc.pos, h.loc.size, h.loc.count)); 843 if (h.flags & HIO_VARIABLE) { 844 if (h.loc.size != 1) 845 return ("bad modifier size"); 846 /* Single item */ 847 if (imod < MAXMOD) { 848 sc->sc_modloc[imod] = h.loc; 849 sc->sc_mods[imod].mask = 1 << imod; 850 sc->sc_mods[imod].key = HID_GET_USAGE(h.usage); 851 imod++; 852 } else 853 return ("too many modifier keys"); 854 } else { 855 /* Array */ 856 if (h.loc.size != 8) 857 return ("key code size != 8"); 858 if (h.loc.count > MAXKEYCODE) 859 return ("too many key codes"); 860 if (h.loc.pos % 8 != 0) 861 return ("key codes not on byte boundary"); 862 if (sc->sc_nkeycode != 0) 863 return ("multiple key code arrays\n"); 864 sc->sc_keycodeloc = h.loc; 865 sc->sc_nkeycode = h.loc.count; 866 } 867 } 868 sc->sc_nmod = imod; 869 hid_end_parse(d); 870 871 hid_locate(desc, size, HID_USAGE2(HUP_LEDS, HUD_LED_NUM_LOCK), 872 sc->sc_hdev.sc_report_id, hid_output, &sc->sc_numloc, NULL); 873 hid_locate(desc, size, HID_USAGE2(HUP_LEDS, HUD_LED_CAPS_LOCK), 874 sc->sc_hdev.sc_report_id, hid_output, &sc->sc_capsloc, NULL); 875 hid_locate(desc, size, HID_USAGE2(HUP_LEDS, HUD_LED_SCROLL_LOCK), 876 sc->sc_hdev.sc_report_id, hid_output, &sc->sc_scroloc, NULL); 877 878 return (NULL); 879 } 880