1 /* $NetBSD: ukbd.c,v 1.130 2015/03/07 20:20:55 mrg 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.130 2015/03/07 20:20:55 mrg Exp $"); 39 40 #ifdef _KERNEL_OPT 41 #include "opt_ukbd.h" 42 #include "opt_ukbd_layout.h" 43 #include "opt_wsdisplay_compat.h" 44 #include "opt_ddb.h" 45 #endif /* _KERNEL_OPT */ 46 47 #include <sys/param.h> 48 #include <sys/systm.h> 49 #include <sys/callout.h> 50 #include <sys/kernel.h> 51 #include <sys/device.h> 52 #include <sys/ioctl.h> 53 #include <sys/file.h> 54 #include <sys/select.h> 55 #include <sys/proc.h> 56 #include <sys/vnode.h> 57 #include <sys/poll.h> 58 59 #include <dev/usb/usb.h> 60 #include <dev/usb/usbhid.h> 61 62 #include <dev/usb/usbdi.h> 63 #include <dev/usb/usbdi_util.h> 64 #include <dev/usb/usbdivar.h> 65 #include <dev/usb/usbdevs.h> 66 #include <dev/usb/usb_quirks.h> 67 #include <dev/usb/uhidev.h> 68 #include <dev/usb/hid.h> 69 #include <dev/usb/ukbdvar.h> 70 71 #include <dev/wscons/wsconsio.h> 72 #include <dev/wscons/wskbdvar.h> 73 #include <dev/wscons/wsksymdef.h> 74 #include <dev/wscons/wsksymvar.h> 75 76 #ifdef UKBD_DEBUG 77 #define DPRINTF(x) if (ukbddebug) printf x 78 #define DPRINTFN(n,x) if (ukbddebug>(n)) printf x 79 int ukbddebug = 0; 80 #else 81 #define DPRINTF(x) 82 #define DPRINTFN(n,x) 83 #endif 84 85 #define MAXKEYCODE 6 86 #define MAXMOD 8 /* max 32 */ 87 88 struct ukbd_data { 89 u_int32_t modifiers; 90 u_int8_t keycode[MAXKEYCODE]; 91 }; 92 93 #define PRESS 0x000 94 #define RELEASE 0x100 95 #define CODEMASK 0x0ff 96 97 struct ukbd_keycodetrans { 98 u_int16_t from; 99 u_int16_t to; 100 }; 101 102 #define IS_PMF 0x8000 103 104 Static const struct ukbd_keycodetrans trtab_apple_fn[] = { 105 { 0x0c, 0x5d }, /* i -> KP 5 */ 106 { 0x0d, 0x59 }, /* j -> KP 1 */ 107 { 0x0e, 0x5a }, /* k -> KP 2 */ 108 { 0x0f, 0x5b }, /* l -> KP 3 */ 109 { 0x10, 0x62 }, /* m -> KP 0 */ 110 { 0x12, 0x5e }, /* o -> KP 6 */ 111 { 0x13, 0x55 }, /* o -> KP * */ 112 { 0x18, 0x5c }, /* u -> KP 4 */ 113 { 0x0c, 0x5d }, /* i -> KP 5 */ 114 { 0x2a, 0x4c }, /* Backspace -> Delete */ 115 { 0x28, 0x49 }, /* Return -> Insert */ 116 { 0x24, 0x5f }, /* 7 -> KP 7 */ 117 { 0x25, 0x60 }, /* 8 -> KP 8 */ 118 { 0x26, 0x61 }, /* 9 -> KP 9 */ 119 { 0x27, 0x54 }, /* 0 -> KP / */ 120 { 0x2d, 0x67 }, /* - -> KP = */ 121 { 0x33, 0x56 }, /* ; -> KP - */ 122 { 0x37, 0x63 }, /* . -> KP . */ 123 { 0x38, 0x57 }, /* / -> KP + */ 124 { 0x3a, 0xd1 }, /* F1..F12 mapped to reserved codes 0xd1..0xdc */ 125 { 0x3b, 0xd2 }, 126 { 0x3c, 0xd3 }, 127 { 0x3d, 0xd4 }, 128 { 0x3e, 0xd5 }, 129 { 0x3f, 0xd6 }, 130 { 0x40, 0xd7 }, 131 { 0x41, 0xd8 }, 132 { 0x42, 0xd9 }, 133 { 0x43, 0xda }, 134 { 0x44, 0xdb }, 135 { 0x45, 0xdc }, 136 { 0x4f, 0x4d }, /* Right -> End */ 137 { 0x50, 0x4a }, /* Left -> Home */ 138 { 0x51, 0x4e }, /* Down -> PageDown */ 139 { 0x52, 0x4b }, /* Up -> PageUp */ 140 { 0x00, 0x00 } 141 }; 142 143 Static const struct ukbd_keycodetrans trtab_apple_iso[] = { 144 { 0x35, 0x64 }, /* swap the key above tab with key right of shift */ 145 { 0x64, 0x35 }, 146 { 0x31, 0x32 }, /* key left of return is Europe1, not "\|" */ 147 { 0x00, 0x00 } 148 }; 149 150 #ifdef GDIUM_KEYBOARD_HACK 151 Static const struct ukbd_keycodetrans trtab_gdium_fn[] = { 152 #ifdef notyet 153 { 58, 0 }, /* F1 -> toggle camera */ 154 { 59, 0 }, /* F2 -> toggle wireless */ 155 #endif 156 { 60, IS_PMF | PMFE_AUDIO_VOLUME_TOGGLE }, 157 { 61, IS_PMF | PMFE_AUDIO_VOLUME_UP }, 158 { 62, IS_PMF | PMFE_AUDIO_VOLUME_DOWN }, 159 #ifdef notyet 160 { 63, 0 }, /* F6 -> toggle ext. video */ 161 { 64, 0 }, /* F7 -> toggle mouse */ 162 #endif 163 { 65, IS_PMF | PMFE_DISPLAY_BRIGHTNESS_UP }, 164 { 66, IS_PMF | PMFE_DISPLAY_BRIGHTNESS_DOWN }, 165 #ifdef notyet 166 { 67, 0 }, /* F10 -> suspend */ 167 { 68, 0 }, /* F11 -> user1 */ 168 { 69, 0 }, /* F12 -> user2 */ 169 { 70, 0 }, /* print screen -> sysrq */ 170 #endif 171 { 76, 71 }, /* delete -> scroll lock */ 172 { 81, 78 }, /* down -> page down */ 173 { 82, 75 }, /* up -> page up */ 174 { 0, 0 } 175 }; 176 #endif 177 178 Static const struct ukbd_keycodetrans trtab_generic[] = { 179 { 0x7f, IS_PMF | PMFE_AUDIO_VOLUME_TOGGLE }, 180 { 0x80, IS_PMF | PMFE_AUDIO_VOLUME_UP }, 181 { 0x81, IS_PMF | PMFE_AUDIO_VOLUME_DOWN }, 182 { 0x00, 0x00 } 183 }; 184 185 #if defined(WSDISPLAY_COMPAT_RAWKBD) 186 #define NN 0 /* no translation */ 187 /* 188 * Translate USB keycodes to US keyboard XT scancodes. 189 * Scancodes >= 0x80 represent EXTENDED keycodes. 190 * 191 * See http://www.microsoft.com/whdc/archive/scancode.mspx 192 * 193 * Note: a real pckbd(4) has more complexity in its 194 * protocol for some keys than this translation implements. 195 * For example, some keys generate Fake ShiftL events (e0 2a) 196 * before the actual key sequence. 197 */ 198 Static const u_int8_t ukbd_trtab[256] = { 199 NN, NN, NN, NN, 0x1e, 0x30, 0x2e, 0x20, /* 00 - 07 */ 200 0x12, 0x21, 0x22, 0x23, 0x17, 0x24, 0x25, 0x26, /* 08 - 0f */ 201 0x32, 0x31, 0x18, 0x19, 0x10, 0x13, 0x1f, 0x14, /* 10 - 17 */ 202 0x16, 0x2f, 0x11, 0x2d, 0x15, 0x2c, 0x02, 0x03, /* 18 - 1f */ 203 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b, /* 20 - 27 */ 204 0x1c, 0x01, 0x0e, 0x0f, 0x39, 0x0c, 0x0d, 0x1a, /* 28 - 2f */ 205 0x1b, 0x2b, 0x2b, 0x27, 0x28, 0x29, 0x33, 0x34, /* 30 - 37 */ 206 0x35, 0x3a, 0x3b, 0x3c, 0x3d, 0x3e, 0x3f, 0x40, /* 38 - 3f */ 207 0x41, 0x42, 0x43, 0x44, 0x57, 0x58, 0xb7, 0x46, /* 40 - 47 */ 208 0x7f, 0xd2, 0xc7, 0xc9, 0xd3, 0xcf, 0xd1, 0xcd, /* 48 - 4f */ 209 0xcb, 0xd0, 0xc8, 0x45, 0xb5, 0x37, 0x4a, 0x4e, /* 50 - 57 */ 210 0x9c, 0x4f, 0x50, 0x51, 0x4b, 0x4c, 0x4d, 0x47, /* 58 - 5f */ 211 0x48, 0x49, 0x52, 0x53, 0x56, 0xdd, 0xdf, 0x59, /* 60 - 67 */ 212 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x6a, NN, /* 68 - 6f */ 213 NN, NN, NN, NN, 0x84, 0x85, 0x87, 0x88, /* 70 - 77 */ 214 0x89, 0x8a, 0x8b, 0x8c, 0x8d, 0x8e, 0x8f, NN, /* 78 - 7f */ 215 NN, NN, NN, NN, NN, 0x7e, NN, 0x73, /* 80 - 87 */ 216 0x70, 0x7d, 0x79, 0x7b, 0x5c, NN, NN, NN, /* 88 - 8f */ 217 NN, NN, 0x78, 0x77, 0x76, NN, NN, NN, /* 90 - 97 */ 218 NN, NN, NN, NN, NN, NN, NN, NN, /* 98 - 9f */ 219 NN, NN, NN, NN, NN, NN, NN, NN, /* a0 - a7 */ 220 NN, NN, NN, NN, NN, NN, NN, NN, /* a8 - af */ 221 NN, NN, NN, NN, NN, NN, NN, NN, /* b0 - b7 */ 222 NN, NN, NN, NN, NN, NN, NN, NN, /* b8 - bf */ 223 NN, NN, NN, NN, NN, NN, NN, NN, /* c0 - c7 */ 224 NN, NN, NN, NN, NN, NN, NN, NN, /* c8 - cf */ 225 NN, NN, NN, NN, NN, NN, NN, NN, /* d0 - d7 */ 226 NN, NN, NN, NN, NN, NN, NN, NN, /* d8 - df */ 227 0x1d, 0x2a, 0x38, 0xdb, 0x9d, 0x36, 0xb8, 0xdc, /* e0 - e7 */ 228 NN, NN, NN, NN, NN, NN, NN, NN, /* e8 - ef */ 229 NN, NN, NN, NN, NN, NN, NN, NN, /* f0 - f7 */ 230 NN, NN, NN, NN, NN, NN, NN, NN, /* f8 - ff */ 231 }; 232 #endif /* defined(WSDISPLAY_COMPAT_RAWKBD) */ 233 234 #define KEY_ERROR 0x01 235 236 #define MAXKEYS (MAXMOD+2*MAXKEYCODE) 237 238 struct ukbd_softc { 239 struct uhidev sc_hdev; 240 241 struct ukbd_data sc_ndata; 242 struct ukbd_data sc_odata; 243 struct hid_location sc_modloc[MAXMOD]; 244 u_int sc_nmod; 245 struct { 246 u_int32_t mask; 247 u_int8_t key; 248 } sc_mods[MAXMOD]; 249 250 struct hid_location sc_keycodeloc; 251 u_int sc_nkeycode; 252 253 u_int sc_flags; /* flags */ 254 #define FLAG_ENABLED 0x0001 255 #define FLAG_POLLING 0x0002 256 #define FLAG_DEBOUNCE 0x0004 /* for quirk handling */ 257 #define FLAG_APPLE_FIX_ISO 0x0008 258 #define FLAG_APPLE_FN 0x0010 259 #define FLAG_GDIUM_FN 0x0020 260 #define FLAG_FN_PRESSED 0x0100 /* FN key is held down */ 261 #define FLAG_FN_ALT 0x0200 /* Last Alt key was FN-Alt = AltGr */ 262 263 int sc_console_keyboard; /* we are the console keyboard */ 264 265 struct callout sc_delay; /* for quirk handling */ 266 struct ukbd_data sc_data; /* for quirk handling */ 267 268 struct hid_location sc_apple_fn; 269 struct hid_location sc_numloc; 270 struct hid_location sc_capsloc; 271 struct hid_location sc_scroloc; 272 struct hid_location sc_compose; 273 int sc_leds; 274 struct usb_task sc_ledtask; 275 device_t sc_wskbddev; 276 277 #if defined(WSDISPLAY_COMPAT_RAWKBD) 278 int sc_rawkbd; 279 #if defined(UKBD_REPEAT) 280 struct callout sc_rawrepeat_ch; 281 #define REP_DELAY1 400 282 #define REP_DELAYN 100 283 int sc_nrep; 284 char sc_rep[MAXKEYS]; 285 #endif /* defined(UKBD_REPEAT) */ 286 #endif /* defined(WSDISPLAY_COMPAT_RAWKBD) */ 287 288 int sc_spl; 289 int sc_npollchar; 290 u_int16_t sc_pollchars[MAXKEYS]; 291 292 u_char sc_dying; 293 }; 294 295 #ifdef UKBD_DEBUG 296 #define UKBDTRACESIZE 64 297 struct ukbdtraceinfo { 298 int unit; 299 struct timeval tv; 300 struct ukbd_data ud; 301 }; 302 struct ukbdtraceinfo ukbdtracedata[UKBDTRACESIZE]; 303 int ukbdtraceindex = 0; 304 int ukbdtrace = 0; 305 void ukbdtracedump(void); 306 void 307 ukbdtracedump(void) 308 { 309 int i; 310 for (i = 0; i < UKBDTRACESIZE; i++) { 311 struct ukbdtraceinfo *p = 312 &ukbdtracedata[(i+ukbdtraceindex)%UKBDTRACESIZE]; 313 printf("%"PRIu64".%06"PRIu64": mod=0x%02x key0=0x%02x key1=0x%02x " 314 "key2=0x%02x key3=0x%02x\n", 315 p->tv.tv_sec, (uint64_t)p->tv.tv_usec, 316 p->ud.modifiers, p->ud.keycode[0], p->ud.keycode[1], 317 p->ud.keycode[2], p->ud.keycode[3]); 318 } 319 } 320 #endif 321 322 #define UKBDUNIT(dev) (minor(dev)) 323 #define UKBD_CHUNK 128 /* chunk size for read */ 324 #define UKBD_BSIZE 1020 /* buffer size */ 325 326 Static int ukbd_is_console; 327 328 Static void ukbd_cngetc(void *, u_int *, int *); 329 Static void ukbd_cnpollc(void *, int); 330 331 const struct wskbd_consops ukbd_consops = { 332 .getc = ukbd_cngetc, 333 .pollc = ukbd_cnpollc, 334 .bell = NULL, 335 }; 336 337 Static const char *ukbd_parse_desc(struct ukbd_softc *sc); 338 339 Static void ukbd_intr(struct uhidev *addr, void *ibuf, u_int len); 340 Static void ukbd_decode(struct ukbd_softc *sc, struct ukbd_data *ud); 341 Static void ukbd_delayed_decode(void *addr); 342 343 Static int ukbd_enable(void *, int); 344 Static void ukbd_set_leds(void *, int); 345 Static void ukbd_set_leds_task(void *); 346 347 Static int ukbd_ioctl(void *, u_long, void *, int, struct lwp *); 348 #if defined(WSDISPLAY_COMPAT_RAWKBD) && defined(UKBD_REPEAT) 349 Static void ukbd_rawrepeat(void *v); 350 #endif 351 352 const struct wskbd_accessops ukbd_accessops = { 353 ukbd_enable, 354 ukbd_set_leds, 355 ukbd_ioctl, 356 }; 357 358 extern const struct wscons_keydesc ukbd_keydesctab[]; 359 360 const struct wskbd_mapdata ukbd_keymapdata = { 361 ukbd_keydesctab, 362 #if defined(UKBD_LAYOUT) 363 UKBD_LAYOUT, 364 #elif defined(PCKBD_LAYOUT) 365 PCKBD_LAYOUT, 366 #else 367 KB_US, 368 #endif 369 }; 370 371 static int ukbd_match(device_t, cfdata_t, void *); 372 static void ukbd_attach(device_t, device_t, void *); 373 static int ukbd_detach(device_t, int); 374 static int ukbd_activate(device_t, enum devact); 375 static void ukbd_childdet(device_t, device_t); 376 377 extern struct cfdriver ukbd_cd; 378 379 CFATTACH_DECL2_NEW(ukbd, sizeof(struct ukbd_softc), ukbd_match, ukbd_attach, 380 ukbd_detach, ukbd_activate, NULL, ukbd_childdet); 381 382 int 383 ukbd_match(device_t parent, cfdata_t match, void *aux) 384 { 385 struct uhidev_attach_arg *uha = aux; 386 int size; 387 void *desc; 388 389 uhidev_get_report_desc(uha->parent, &desc, &size); 390 if (!hid_is_collection(desc, size, uha->reportid, 391 HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_KEYBOARD))) 392 return (UMATCH_NONE); 393 394 return (UMATCH_IFACECLASS); 395 } 396 397 void 398 ukbd_attach(device_t parent, device_t self, void *aux) 399 { 400 struct ukbd_softc *sc = device_private(self); 401 struct uhidev_attach_arg *uha = aux; 402 u_int32_t qflags; 403 const char *parseerr; 404 struct wskbddev_attach_args a; 405 406 sc->sc_hdev.sc_dev = self; 407 sc->sc_hdev.sc_intr = ukbd_intr; 408 sc->sc_hdev.sc_parent = uha->parent; 409 sc->sc_hdev.sc_report_id = uha->reportid; 410 sc->sc_flags = 0; 411 412 aprint_naive("\n"); 413 414 if (!pmf_device_register(self, NULL, NULL)) { 415 aprint_normal("\n"); 416 aprint_error_dev(self, "couldn't establish power handler\n"); 417 } 418 419 parseerr = ukbd_parse_desc(sc); 420 if (parseerr != NULL) { 421 aprint_normal("\n"); 422 aprint_error_dev(self, "attach failed, %s\n", parseerr); 423 return; 424 } 425 426 /* Quirks */ 427 qflags = usbd_get_quirks(uha->parent->sc_udev)->uq_flags; 428 if (qflags & UQ_SPUR_BUT_UP) 429 sc->sc_flags |= FLAG_DEBOUNCE; 430 if (qflags & UQ_APPLE_ISO) 431 sc->sc_flags |= FLAG_APPLE_FIX_ISO; 432 433 #ifdef GDIUM_KEYBOARD_HACK 434 if (uha->uaa->vendor == USB_VENDOR_CYPRESS && 435 uha->uaa->product == USB_PRODUCT_CYPRESS_LPRDK) 436 sc->sc_flags = FLAG_GDIUM_FN; 437 #endif 438 439 #ifdef DIAGNOSTIC 440 aprint_normal(": %d modifier keys, %d key codes", sc->sc_nmod, 441 sc->sc_nkeycode); 442 if (sc->sc_flags & FLAG_APPLE_FN) 443 aprint_normal(", apple fn key"); 444 if (sc->sc_flags & FLAG_APPLE_FIX_ISO) 445 aprint_normal(", fix apple iso"); 446 if (sc->sc_flags & FLAG_GDIUM_FN) 447 aprint_normal(", Gdium fn key"); 448 #endif 449 aprint_normal("\n"); 450 451 /* 452 * Remember if we're the console keyboard. 453 * 454 * XXX This always picks the first keyboard on the 455 * first USB bus, but what else can we really do? 456 */ 457 if ((sc->sc_console_keyboard = ukbd_is_console) != 0) { 458 /* Don't let any other keyboard have it. */ 459 ukbd_is_console = 0; 460 } 461 462 if (sc->sc_console_keyboard) { 463 DPRINTF(("ukbd_attach: console keyboard sc=%p\n", sc)); 464 wskbd_cnattach(&ukbd_consops, sc, &ukbd_keymapdata); 465 ukbd_enable(sc, 1); 466 } 467 468 a.console = sc->sc_console_keyboard; 469 470 a.keymap = &ukbd_keymapdata; 471 472 a.accessops = &ukbd_accessops; 473 a.accesscookie = sc; 474 475 #ifdef UKBD_REPEAT 476 callout_init(&sc->sc_rawrepeat_ch, 0); 477 #endif 478 479 callout_init(&sc->sc_delay, 0); 480 481 usb_init_task(&sc->sc_ledtask, ukbd_set_leds_task, sc, 0); 482 483 /* Flash the leds; no real purpose, just shows we're alive. */ 484 ukbd_set_leds(sc, WSKBD_LED_SCROLL | WSKBD_LED_NUM | WSKBD_LED_CAPS 485 | WSKBD_LED_COMPOSE); 486 usbd_delay_ms(uha->parent->sc_udev, 400); 487 ukbd_set_leds(sc, 0); 488 489 sc->sc_wskbddev = config_found(self, &a, wskbddevprint); 490 491 return; 492 } 493 494 int 495 ukbd_enable(void *v, int on) 496 { 497 struct ukbd_softc *sc = v; 498 499 if (on && sc->sc_dying) 500 return (EIO); 501 502 /* Should only be called to change state */ 503 if ((sc->sc_flags & FLAG_ENABLED) != 0 && on != 0) { 504 #ifdef DIAGNOSTIC 505 printf("ukbd_enable: %s: bad call on=%d\n", 506 device_xname(sc->sc_hdev.sc_dev), on); 507 #endif 508 return (EBUSY); 509 } 510 511 DPRINTF(("ukbd_enable: sc=%p on=%d\n", sc, on)); 512 if (on) { 513 sc->sc_flags |= FLAG_ENABLED; 514 return (uhidev_open(&sc->sc_hdev)); 515 } else { 516 sc->sc_flags &= ~FLAG_ENABLED; 517 uhidev_close(&sc->sc_hdev); 518 return (0); 519 } 520 } 521 522 523 static void 524 ukbd_childdet(device_t self, device_t child) 525 { 526 struct ukbd_softc *sc = device_private(self); 527 528 KASSERT(sc->sc_wskbddev == child); 529 sc->sc_wskbddev = NULL; 530 } 531 532 int 533 ukbd_activate(device_t self, enum devact act) 534 { 535 struct ukbd_softc *sc = device_private(self); 536 537 switch (act) { 538 case DVACT_DEACTIVATE: 539 sc->sc_dying = 1; 540 return 0; 541 default: 542 return EOPNOTSUPP; 543 } 544 } 545 546 int 547 ukbd_detach(device_t self, int flags) 548 { 549 struct ukbd_softc *sc = device_private(self); 550 int rv = 0; 551 552 DPRINTF(("ukbd_detach: sc=%p flags=%d\n", sc, flags)); 553 554 pmf_device_deregister(self); 555 556 if (sc->sc_console_keyboard) { 557 #if 0 558 /* 559 * XXX Should probably disconnect our consops, 560 * XXX and either notify some other keyboard that 561 * XXX it can now be the console, or if there aren't 562 * XXX any more USB keyboards, set ukbd_is_console 563 * XXX back to 1 so that the next USB keyboard attached 564 * XXX to the system will get it. 565 */ 566 panic("ukbd_detach: console keyboard"); 567 #else 568 /* 569 * Disconnect our consops and set ukbd_is_console 570 * back to 1 so that the next USB keyboard attached 571 * to the system will get it. 572 * XXX Should notify some other keyboard that it can be 573 * XXX console, if there are any other keyboards. 574 */ 575 printf("%s: was console keyboard\n", 576 device_xname(sc->sc_hdev.sc_dev)); 577 wskbd_cndetach(); 578 ukbd_is_console = 1; 579 #endif 580 } 581 /* No need to do reference counting of ukbd, wskbd has all the goo. */ 582 if (sc->sc_wskbddev != NULL) 583 rv = config_detach(sc->sc_wskbddev, flags); 584 585 /* The console keyboard does not get a disable call, so check pipe. */ 586 if (sc->sc_hdev.sc_state & UHIDEV_OPEN) 587 uhidev_close(&sc->sc_hdev); 588 589 return (rv); 590 } 591 592 static void 593 ukbd_translate_keycodes(struct ukbd_softc *sc, struct ukbd_data *ud, 594 const struct ukbd_keycodetrans *tab) 595 { 596 const struct ukbd_keycodetrans *tp; 597 int i; 598 u_int8_t key; 599 600 for (i = 0; i < sc->sc_nkeycode; i++) { 601 key = ud->keycode[i]; 602 if (key) 603 for (tp = tab; tp->from; tp++) 604 if (tp->from == key) { 605 if (tp->to & IS_PMF) { 606 pmf_event_inject( 607 sc->sc_hdev.sc_dev, 608 tp->to & 0xff); 609 ud->keycode[i] = 0; 610 } else 611 ud->keycode[i] = tp->to; 612 break; 613 } 614 } 615 } 616 617 static u_int16_t 618 ukbd_translate_modifier(struct ukbd_softc *sc, u_int16_t key) 619 { 620 if ((sc->sc_flags & FLAG_APPLE_FN) && (key & CODEMASK) == 0x00e2) { 621 if ((key & ~CODEMASK) == PRESS) { 622 if (sc->sc_flags & FLAG_FN_PRESSED) { 623 /* pressed FN-Alt, translate to AltGr */ 624 key = 0x00e6 | PRESS; 625 sc->sc_flags |= FLAG_FN_ALT; 626 } 627 } else { 628 if (sc->sc_flags & FLAG_FN_ALT) { 629 /* released Alt, which was treated as FN-Alt */ 630 key = 0x00e6 | RELEASE; 631 sc->sc_flags &= ~FLAG_FN_ALT; 632 } 633 } 634 } 635 return key; 636 } 637 638 void 639 ukbd_intr(struct uhidev *addr, void *ibuf, u_int len) 640 { 641 struct ukbd_softc *sc = (struct ukbd_softc *)addr; 642 struct ukbd_data *ud = &sc->sc_ndata; 643 int i; 644 645 #ifdef UKBD_DEBUG 646 if (ukbddebug > 5) { 647 printf("ukbd_intr: data"); 648 for (i = 0; i < len; i++) 649 printf(" 0x%02x", ((u_char *)ibuf)[i]); 650 printf("\n"); 651 } 652 #endif 653 654 ud->modifiers = 0; 655 for (i = 0; i < sc->sc_nmod; i++) 656 if (hid_get_data(ibuf, &sc->sc_modloc[i])) 657 ud->modifiers |= sc->sc_mods[i].mask; 658 memcpy(ud->keycode, (char *)ibuf + sc->sc_keycodeloc.pos / 8, 659 sc->sc_nkeycode); 660 661 if (sc->sc_flags & FLAG_APPLE_FN) { 662 if (hid_get_data(ibuf, &sc->sc_apple_fn)) { 663 sc->sc_flags |= FLAG_FN_PRESSED; 664 ukbd_translate_keycodes(sc, ud, trtab_apple_fn); 665 } 666 else 667 sc->sc_flags &= ~FLAG_FN_PRESSED; 668 } 669 670 #ifdef GDIUM_KEYBOARD_HACK 671 if (sc->sc_flags & FLAG_GDIUM_FN) { 672 if (sc->sc_flags & FLAG_FN_PRESSED) { 673 ukbd_translate_keycodes(sc, ud, trtab_gdium_fn); 674 } 675 } 676 #endif 677 678 ukbd_translate_keycodes(sc, ud, trtab_generic); 679 680 if ((sc->sc_flags & FLAG_DEBOUNCE) && !(sc->sc_flags & FLAG_POLLING)) { 681 /* 682 * Some keyboards have a peculiar quirk. They sometimes 683 * generate a key up followed by a key down for the same 684 * key after about 10 ms. 685 * We avoid this bug by holding off decoding for 20 ms. 686 */ 687 sc->sc_data = *ud; 688 callout_reset(&sc->sc_delay, hz / 50, ukbd_delayed_decode, sc); 689 #ifdef DDB 690 } else if (sc->sc_console_keyboard && !(sc->sc_flags & FLAG_POLLING)) { 691 /* 692 * For the console keyboard we can't deliver CTL-ALT-ESC 693 * from the interrupt routine. Doing so would start 694 * polling from inside the interrupt routine and that 695 * loses bigtime. 696 */ 697 sc->sc_data = *ud; 698 callout_reset(&sc->sc_delay, 1, ukbd_delayed_decode, sc); 699 #endif 700 } else { 701 ukbd_decode(sc, ud); 702 } 703 } 704 705 void 706 ukbd_delayed_decode(void *addr) 707 { 708 struct ukbd_softc *sc = addr; 709 710 ukbd_decode(sc, &sc->sc_data); 711 } 712 713 void 714 ukbd_decode(struct ukbd_softc *sc, struct ukbd_data *ud) 715 { 716 int mod, omod; 717 u_int16_t ibuf[MAXKEYS]; /* chars events */ 718 int s; 719 int nkeys, i, j; 720 int key; 721 #define ADDKEY(c) ibuf[nkeys++] = (c) 722 723 #ifdef UKBD_DEBUG 724 /* 725 * Keep a trace of the last events. Using printf changes the 726 * timing, so this can be useful sometimes. 727 */ 728 if (ukbdtrace) { 729 struct ukbdtraceinfo *p = &ukbdtracedata[ukbdtraceindex]; 730 p->unit = device_unit(sc->sc_hdev.sc_dev); 731 microtime(&p->tv); 732 p->ud = *ud; 733 if (++ukbdtraceindex >= UKBDTRACESIZE) 734 ukbdtraceindex = 0; 735 } 736 if (ukbddebug > 5) { 737 struct timeval tv; 738 microtime(&tv); 739 DPRINTF((" at %"PRIu64".%06"PRIu64" mod=0x%02x key0=0x%02x key1=0x%02x " 740 "key2=0x%02x key3=0x%02x\n", 741 tv.tv_sec, (uint64_t)tv.tv_usec, 742 ud->modifiers, ud->keycode[0], ud->keycode[1], 743 ud->keycode[2], ud->keycode[3])); 744 } 745 #endif 746 747 if (ud->keycode[0] == KEY_ERROR) { 748 DPRINTF(("ukbd_intr: KEY_ERROR\n")); 749 return; /* ignore */ 750 } 751 752 if (sc->sc_flags & FLAG_APPLE_FIX_ISO) 753 ukbd_translate_keycodes(sc, ud, trtab_apple_iso); 754 755 nkeys = 0; 756 mod = ud->modifiers; 757 omod = sc->sc_odata.modifiers; 758 if (mod != omod) 759 for (i = 0; i < sc->sc_nmod; i++) 760 if (( mod & sc->sc_mods[i].mask) != 761 (omod & sc->sc_mods[i].mask)) { 762 key = sc->sc_mods[i].key | 763 ((mod & sc->sc_mods[i].mask) ? 764 PRESS : RELEASE); 765 ADDKEY(ukbd_translate_modifier(sc, key)); 766 } 767 if (memcmp(ud->keycode, sc->sc_odata.keycode, sc->sc_nkeycode) != 0) { 768 /* Check for released keys. */ 769 for (i = 0; i < sc->sc_nkeycode; i++) { 770 key = sc->sc_odata.keycode[i]; 771 if (key == 0) 772 continue; 773 for (j = 0; j < sc->sc_nkeycode; j++) 774 if (key == ud->keycode[j]) 775 goto rfound; 776 DPRINTFN(3,("ukbd_intr: relse key=0x%02x\n", key)); 777 #ifdef GDIUM_KEYBOARD_HACK 778 if (sc->sc_flags & FLAG_GDIUM_FN) { 779 if (key == 0x82) { 780 sc->sc_flags &= ~FLAG_FN_PRESSED; 781 goto rfound; 782 } 783 } 784 #endif 785 ADDKEY(key | RELEASE); 786 rfound: 787 ; 788 } 789 790 /* Check for pressed keys. */ 791 for (i = 0; i < sc->sc_nkeycode; i++) { 792 key = ud->keycode[i]; 793 if (key == 0) 794 continue; 795 for (j = 0; j < sc->sc_nkeycode; j++) 796 if (key == sc->sc_odata.keycode[j]) 797 goto pfound; 798 DPRINTFN(2,("ukbd_intr: press key=0x%02x\n", key)); 799 #ifdef GDIUM_KEYBOARD_HACK 800 if (sc->sc_flags & FLAG_GDIUM_FN) { 801 if (key == 0x82) { 802 sc->sc_flags |= FLAG_FN_PRESSED; 803 goto pfound; 804 } 805 } 806 #endif 807 ADDKEY(key | PRESS); 808 pfound: 809 ; 810 } 811 } 812 sc->sc_odata = *ud; 813 814 if (nkeys == 0) 815 return; 816 817 if (sc->sc_flags & FLAG_POLLING) { 818 DPRINTFN(1,("ukbd_intr: pollchar = 0x%03x\n", ibuf[0])); 819 memcpy(sc->sc_pollchars, ibuf, nkeys * sizeof(u_int16_t)); 820 sc->sc_npollchar = nkeys; 821 return; 822 } 823 #ifdef WSDISPLAY_COMPAT_RAWKBD 824 if (sc->sc_rawkbd) { 825 u_char cbuf[MAXKEYS * 2]; 826 int c; 827 #if defined(UKBD_REPEAT) 828 int npress = 0; 829 #endif 830 831 for (i = j = 0; i < nkeys; i++) { 832 key = ibuf[i]; 833 c = ukbd_trtab[key & CODEMASK]; 834 if (c == NN) 835 continue; 836 if (c == 0x7f) { 837 /* pause key */ 838 cbuf[j++] = 0xe1; 839 cbuf[j++] = 0x1d; 840 cbuf[j-1] |= (key & RELEASE) ? 0x80 : 0; 841 cbuf[j] = 0x45; 842 } else { 843 if (c & 0x80) 844 cbuf[j++] = 0xe0; 845 cbuf[j] = c & 0x7f; 846 } 847 if (key & RELEASE) 848 cbuf[j] |= 0x80; 849 #if defined(UKBD_REPEAT) 850 else { 851 /* remember pressed keys for autorepeat */ 852 if (c & 0x80) 853 sc->sc_rep[npress++] = 0xe0; 854 sc->sc_rep[npress++] = c & 0x7f; 855 } 856 #endif 857 DPRINTFN(1,("ukbd_intr: raw = %s0x%02x\n", 858 c & 0x80 ? "0xe0 " : "", 859 cbuf[j])); 860 j++; 861 } 862 s = spltty(); 863 wskbd_rawinput(sc->sc_wskbddev, cbuf, j); 864 splx(s); 865 #ifdef UKBD_REPEAT 866 callout_stop(&sc->sc_rawrepeat_ch); 867 if (npress != 0) { 868 sc->sc_nrep = npress; 869 callout_reset(&sc->sc_rawrepeat_ch, 870 hz * REP_DELAY1 / 1000, ukbd_rawrepeat, sc); 871 } 872 #endif 873 return; 874 } 875 #endif 876 877 s = spltty(); 878 for (i = 0; i < nkeys; i++) { 879 key = ibuf[i]; 880 wskbd_input(sc->sc_wskbddev, 881 key&RELEASE ? WSCONS_EVENT_KEY_UP : WSCONS_EVENT_KEY_DOWN, 882 key&CODEMASK); 883 } 884 splx(s); 885 } 886 887 void 888 ukbd_set_leds(void *v, int leds) 889 { 890 struct ukbd_softc *sc = v; 891 usbd_device_handle udev = sc->sc_hdev.sc_parent->sc_udev; 892 893 DPRINTF(("ukbd_set_leds: sc=%p leds=%d, sc_leds=%d\n", 894 sc, leds, sc->sc_leds)); 895 896 if (sc->sc_dying) 897 return; 898 899 if (sc->sc_leds == leds) 900 return; 901 902 sc->sc_leds = leds; 903 usb_add_task(udev, &sc->sc_ledtask, USB_TASKQ_DRIVER); 904 } 905 906 void 907 ukbd_set_leds_task(void *v) 908 { 909 struct ukbd_softc *sc = v; 910 int leds = sc->sc_leds; 911 uint8_t res = 0; 912 913 /* XXX not really right */ 914 if ((leds & WSKBD_LED_COMPOSE) && sc->sc_compose.size == 1) 915 res |= 1 << sc->sc_compose.pos; 916 if ((leds & WSKBD_LED_SCROLL) && sc->sc_scroloc.size == 1) 917 res |= 1 << sc->sc_scroloc.pos; 918 if ((leds & WSKBD_LED_NUM) && sc->sc_numloc.size == 1) 919 res |= 1 << sc->sc_numloc.pos; 920 if ((leds & WSKBD_LED_CAPS) && sc->sc_capsloc.size == 1) 921 res |= 1 << sc->sc_capsloc.pos; 922 923 uhidev_set_report(&sc->sc_hdev, UHID_OUTPUT_REPORT, &res, 1); 924 } 925 926 #if defined(WSDISPLAY_COMPAT_RAWKBD) && defined(UKBD_REPEAT) 927 void 928 ukbd_rawrepeat(void *v) 929 { 930 struct ukbd_softc *sc = v; 931 int s; 932 933 s = spltty(); 934 wskbd_rawinput(sc->sc_wskbddev, sc->sc_rep, sc->sc_nrep); 935 splx(s); 936 callout_reset(&sc->sc_rawrepeat_ch, hz * REP_DELAYN / 1000, 937 ukbd_rawrepeat, sc); 938 } 939 #endif /* defined(WSDISPLAY_COMPAT_RAWKBD) && defined(UKBD_REPEAT) */ 940 941 int 942 ukbd_ioctl(void *v, u_long cmd, void *data, int flag, 943 struct lwp *l) 944 { 945 struct ukbd_softc *sc = v; 946 947 switch (cmd) { 948 case WSKBDIO_GTYPE: 949 *(int *)data = WSKBD_TYPE_USB; 950 return (0); 951 case WSKBDIO_SETLEDS: 952 ukbd_set_leds(v, *(int *)data); 953 return (0); 954 case WSKBDIO_GETLEDS: 955 *(int *)data = sc->sc_leds; 956 return (0); 957 #if defined(WSDISPLAY_COMPAT_RAWKBD) 958 case WSKBDIO_SETMODE: 959 DPRINTF(("ukbd_ioctl: set raw = %d\n", *(int *)data)); 960 sc->sc_rawkbd = *(int *)data == WSKBD_RAW; 961 #if defined(UKBD_REPEAT) 962 callout_stop(&sc->sc_rawrepeat_ch); 963 #endif 964 return (0); 965 #endif 966 } 967 return (EPASSTHROUGH); 968 } 969 970 /* 971 * This is a hack to work around some broken ports that don't call 972 * cnpollc() before cngetc(). 973 */ 974 static int pollenter, warned; 975 976 /* Console interface. */ 977 void 978 ukbd_cngetc(void *v, u_int *type, int *data) 979 { 980 struct ukbd_softc *sc = v; 981 int c; 982 int broken; 983 984 if (pollenter == 0) { 985 if (!warned) { 986 printf("\n" 987 "This port is broken, it does not call cnpollc() before calling cngetc().\n" 988 "This should be fixed, but it will work anyway (for now).\n"); 989 warned = 1; 990 } 991 broken = 1; 992 ukbd_cnpollc(v, 1); 993 } else 994 broken = 0; 995 996 DPRINTFN(0,("ukbd_cngetc: enter\n")); 997 sc->sc_flags |= FLAG_POLLING; 998 while (sc->sc_npollchar <= 0) 999 usbd_dopoll(sc->sc_hdev.sc_parent->sc_iface); 1000 sc->sc_flags &= ~FLAG_POLLING; 1001 c = sc->sc_pollchars[0]; 1002 sc->sc_npollchar--; 1003 memcpy(sc->sc_pollchars, sc->sc_pollchars+1, 1004 sc->sc_npollchar * sizeof(u_int16_t)); 1005 *type = c & RELEASE ? WSCONS_EVENT_KEY_UP : WSCONS_EVENT_KEY_DOWN; 1006 *data = c & CODEMASK; 1007 DPRINTFN(0,("ukbd_cngetc: return 0x%02x\n", c)); 1008 if (broken) 1009 ukbd_cnpollc(v, 0); 1010 } 1011 1012 void 1013 ukbd_cnpollc(void *v, int on) 1014 { 1015 struct ukbd_softc *sc = v; 1016 usbd_device_handle dev; 1017 1018 DPRINTFN(2,("ukbd_cnpollc: sc=%p on=%d\n", v, on)); 1019 1020 usbd_interface2device_handle(sc->sc_hdev.sc_parent->sc_iface, &dev); 1021 if (on) { 1022 sc->sc_spl = splusb(); 1023 pollenter++; 1024 } else { 1025 splx(sc->sc_spl); 1026 pollenter--; 1027 } 1028 usbd_set_polling(dev, on); 1029 } 1030 1031 int 1032 ukbd_cnattach(void) 1033 { 1034 1035 /* 1036 * XXX USB requires too many parts of the kernel to be running 1037 * XXX in order to work, so we can't do much for the console 1038 * XXX keyboard until autconfiguration has run its course. 1039 */ 1040 ukbd_is_console = 1; 1041 return (0); 1042 } 1043 1044 const char * 1045 ukbd_parse_desc(struct ukbd_softc *sc) 1046 { 1047 struct hid_data *d; 1048 struct hid_item h; 1049 int size; 1050 void *desc; 1051 int imod; 1052 1053 uhidev_get_report_desc(sc->sc_hdev.sc_parent, &desc, &size); 1054 imod = 0; 1055 sc->sc_nkeycode = 0; 1056 d = hid_start_parse(desc, size, hid_input); 1057 while (hid_get_item(d, &h)) { 1058 /*printf("ukbd: id=%d kind=%d usage=0x%x flags=0x%x pos=%d size=%d cnt=%d\n", 1059 h.report_ID, h.kind, h.usage, h.flags, h.loc.pos, h.loc.size, h.loc.count);*/ 1060 1061 /* Check for special Apple notebook FN key */ 1062 if (HID_GET_USAGE_PAGE(h.usage) == 0x00ff && 1063 HID_GET_USAGE(h.usage) == 0x0003 && 1064 h.kind == hid_input && (h.flags & HIO_VARIABLE)) { 1065 sc->sc_flags |= FLAG_APPLE_FN; 1066 sc->sc_apple_fn = h.loc; 1067 } 1068 1069 if (h.kind != hid_input || (h.flags & HIO_CONST) || 1070 HID_GET_USAGE_PAGE(h.usage) != HUP_KEYBOARD || 1071 h.report_ID != sc->sc_hdev.sc_report_id) 1072 continue; 1073 DPRINTF(("ukbd: imod=%d usage=0x%x flags=0x%x pos=%d size=%d " 1074 "cnt=%d\n", imod, 1075 h.usage, h.flags, h.loc.pos, h.loc.size, h.loc.count)); 1076 if (h.flags & HIO_VARIABLE) { 1077 if (h.loc.size != 1) 1078 return ("bad modifier size"); 1079 /* Single item */ 1080 if (imod < MAXMOD) { 1081 sc->sc_modloc[imod] = h.loc; 1082 sc->sc_mods[imod].mask = 1 << imod; 1083 sc->sc_mods[imod].key = HID_GET_USAGE(h.usage); 1084 imod++; 1085 } else 1086 return ("too many modifier keys"); 1087 } else { 1088 /* Array */ 1089 if (h.loc.size != 8) 1090 return ("key code size != 8"); 1091 if (h.loc.count > MAXKEYCODE) 1092 h.loc.count = MAXKEYCODE; 1093 if (h.loc.pos % 8 != 0) 1094 return ("key codes not on byte boundary"); 1095 if (sc->sc_nkeycode != 0) 1096 return ("multiple key code arrays\n"); 1097 sc->sc_keycodeloc = h.loc; 1098 sc->sc_nkeycode = h.loc.count; 1099 } 1100 } 1101 sc->sc_nmod = imod; 1102 hid_end_parse(d); 1103 1104 hid_locate(desc, size, HID_USAGE2(HUP_LEDS, HUD_LED_NUM_LOCK), 1105 sc->sc_hdev.sc_report_id, hid_output, &sc->sc_numloc, NULL); 1106 hid_locate(desc, size, HID_USAGE2(HUP_LEDS, HUD_LED_CAPS_LOCK), 1107 sc->sc_hdev.sc_report_id, hid_output, &sc->sc_capsloc, NULL); 1108 hid_locate(desc, size, HID_USAGE2(HUP_LEDS, HUD_LED_SCROLL_LOCK), 1109 sc->sc_hdev.sc_report_id, hid_output, &sc->sc_scroloc, NULL); 1110 hid_locate(desc, size, HID_USAGE2(HUP_LEDS, HUD_LED_COMPOSE), 1111 sc->sc_hdev.sc_report_id, hid_output, &sc->sc_compose, NULL); 1112 1113 return (NULL); 1114 } 1115