ukbd.c revision 1.9
1 /* $NetBSD: ukbd.c,v 1.9 1998/08/02 22:27:01 augustss Exp $ */ 2 3 /* 4 * Copyright (c) 1998 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * Author: Lennart Augustsson <augustss (at) carlstedt.se> 8 * Carlstedt Research & Technology 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 3. All advertising materials mentioning features or use of this software 19 * must display the following acknowledgement: 20 * This product includes software developed by the NetBSD 21 * Foundation, Inc. and its contributors. 22 * 4. Neither the name of The NetBSD Foundation nor the names of its 23 * contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 36 * POSSIBILITY OF SUCH DAMAGE. 37 */ 38 39 40 #include <sys/param.h> 41 #include <sys/systm.h> 42 #include <sys/kernel.h> 43 #include <sys/malloc.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/device.h> 52 #include <sys/poll.h> 53 54 #include <dev/usb/usb.h> 55 #include <dev/usb/usbhid.h> 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/hid.h> 61 62 #include <dev/wscons/wsconsio.h> 63 #include <dev/wscons/wskbdvar.h> 64 #include <dev/wscons/wsksymdef.h> 65 #include <dev/wscons/wsksymvar.h> 66 #include <dev/wscons/wskbdmap_mfii.h> 67 68 #include "opt_pckbd_layout.h" 69 #include "opt_wsdisplay_compat.h" 70 71 #ifdef USB_DEBUG 72 #define DPRINTF(x) if (ukbddebug) printf x 73 #define DPRINTFN(n,x) if (ukbddebug>(n)) printf x 74 int ukbddebug = 0; 75 #else 76 #define DPRINTF(x) 77 #define DPRINTFN(n,x) 78 #endif 79 80 #define UPROTO_BOOT_KEYBOARD 1 81 82 #define NKEYCODE 6 83 84 #define NUM_LOCK 0x01 85 #define CAPS_LOCK 0x02 86 #define SCROLL_LOCK 0x04 87 88 struct ukbd_data { 89 u_int8_t modifiers; 90 #define MOD_CONTROL_L 0x01 91 #define MOD_CONTROL_R 0x10 92 #define MOD_SHIFT_L 0x02 93 #define MOD_SHIFT_R 0x20 94 #define MOD_ALT_L 0x04 95 #define MOD_ALT_R 0x40 96 #define MOD_WIN_L 0x08 97 #define MOD_WIN_R 0x80 98 u_int8_t reserved; 99 u_int8_t keycode[NKEYCODE]; 100 }; 101 102 #define PRESS 0 103 #define RELEASE 0x100 104 105 #define NMOD 6 106 static struct { 107 int mask, key; 108 } ukbd_mods[NMOD] = { 109 { MOD_CONTROL_L, 29 }, 110 { MOD_CONTROL_R, 58 }, 111 { MOD_SHIFT_L, 42 }, 112 { MOD_SHIFT_R, 54 }, 113 { MOD_ALT_L, 56 }, 114 { MOD_ALT_R, 184 }, 115 }; 116 117 #define NN 0 /* no translation */ 118 /* Translate USB keycodes to US keyboard AT scancodes. */ 119 static u_int8_t ukbd_trtab[256] = { 120 0, 0, 0, 0, 30, 48, 46, 32, /* 00 - 07 */ 121 18, 33, 34, 35, 23, 36, 37, 38, /* 08 - 0F */ 122 50, 49, 24, 25, 16, 19, 31, 20, /* 10 - 17 */ 123 22, 47, 17, 45, 21, 44, 2, 3, /* 18 - 1F */ 124 4, 5, 6, 7, 8, 9, 10, 11, /* 20 - 27 */ 125 28, 1, 14, 15, 57, 12, 13, 26, /* 28 - 2F */ 126 27, 43, NN, 39, 40, 41, 51, 52, /* 30 - 37 */ 127 53, 58, 59, 60, 61, 62, 63, 64, /* 38 - 3F */ 128 65, 66, 67, 68, 87, 88, 170, 70, /* 40 - 47 */ 129 127, 210, 199, 201, 211, 207, 209, 205, /* 48 - 4F */ 130 203, 208, 200, 69, 181, 55, 74, 78, /* 50 - 57 */ 131 156, 79, 80, 81, 75, 76, 77, 71, /* 58 - 5F */ 132 72, 73, 82, 83, NN, NN, NN, NN, /* 60 - 67 */ 133 NN, NN, NN, NN, NN, NN, NN, NN, /* 68 - 6F */ 134 NN, NN, NN, NN, NN, NN, 221, NN, /* 70 - 77 */ 135 NN, NN, NN, NN, NN, NN, NN, NN, /* 78 - 7F */ 136 NN, NN, NN, NN, NN, NN, NN, NN, /* 80 - 87 */ 137 NN, NN, NN, NN, NN, NN, NN, NN, /* 88 - 8F */ 138 NN, NN, NN, NN, NN, NN, NN, NN, /* 90 - 97 */ 139 NN, NN, NN, NN, NN, NN, NN, NN, /* 98 - 9F */ 140 NN, NN, NN, NN, NN, NN, NN, NN, /* A0 - A7 */ 141 NN, NN, NN, NN, NN, NN, NN, NN, /* A8 - AF */ 142 NN, NN, NN, NN, NN, NN, NN, NN, /* B0 - B7 */ 143 NN, NN, NN, NN, NN, NN, NN, NN, /* B8 - BF */ 144 NN, NN, NN, NN, NN, NN, NN, NN, /* C0 - C7 */ 145 NN, NN, NN, NN, NN, NN, NN, NN, /* C8 - CF */ 146 NN, NN, NN, NN, NN, NN, NN, NN, /* D0 - D7 */ 147 NN, NN, NN, NN, NN, NN, NN, NN, /* D8 - DF */ 148 NN, NN, NN, NN, NN, NN, NN, NN, /* E0 - E7 */ 149 NN, NN, NN, 219, NN, NN, NN, 220, /* E8 - EF */ 150 NN, NN, NN, NN, NN, NN, NN, NN, /* F0 - F7 */ 151 NN, NN, NN, NN, NN, NN, NN, NN, /* F8 - FF */ 152 }; 153 154 #define KEY_ERROR 0x01 155 156 struct ukbd_softc { 157 struct device sc_dev; /* base device */ 158 usbd_interface_handle sc_iface; /* interface */ 159 usbd_pipe_handle sc_intrpipe; /* interrupt pipe */ 160 int sc_ep_addr; 161 162 struct ukbd_data sc_ndata; 163 struct ukbd_data sc_odata; 164 165 char sc_enabled; 166 char sc_disconnected; /* device is gone */ 167 168 int sc_leds; 169 struct device *sc_wskbddev; 170 #ifdef WSDISPLAY_COMPAT_RAWKBD 171 int sc_rawkbd; 172 #endif 173 174 int sc_polling; 175 int sc_pollchar; 176 }; 177 178 #define UKBDUNIT(dev) (minor(dev)) 179 #define UKBD_CHUNK 128 /* chunk size for read */ 180 #define UKBD_BSIZE 1020 /* buffer size */ 181 182 int ukbd_match __P((struct device *, struct cfdata *, void *)); 183 void ukbd_attach __P((struct device *, struct device *, void *)); 184 185 void ukbd_cngetc __P((void *, u_int *, int *)); 186 void ukbd_cnpollc __P((void *, int)); 187 188 const struct wskbd_consops ukbd_consops = { 189 ukbd_cngetc, 190 ukbd_cnpollc, 191 }; 192 193 void ukbd_intr __P((usbd_request_handle, usbd_private_handle, usbd_status)); 194 void ukbd_disco __P((void *)); 195 196 int ukbd_enable __P((void *, int)); 197 void ukbd_set_leds __P((void *, int)); 198 int ukbd_ioctl __P((void *, u_long, caddr_t, int, struct proc *)); 199 200 const struct wskbd_accessops ukbd_accessops = { 201 ukbd_enable, 202 ukbd_set_leds, 203 ukbd_ioctl, 204 }; 205 206 const struct wskbd_mapdata ukbd_keymapdata = { 207 pckbd_keydesctab, 208 sizeof(pckbd_keydesctab)/sizeof(pckbd_keydesctab[0]), 209 #ifdef PCKBD_LAYOUT 210 PCKBD_LAYOUT, 211 #else 212 KB_US, 213 #endif 214 }; 215 216 extern struct cfdriver ukbd_cd; 217 218 struct cfattach ukbd_ca = { 219 sizeof(struct ukbd_softc), ukbd_match, ukbd_attach 220 }; 221 222 int 223 ukbd_match(parent, match, aux) 224 struct device *parent; 225 struct cfdata *match; 226 void *aux; 227 { 228 struct usb_attach_arg *uaa = (struct usb_attach_arg *)aux; 229 usb_interface_descriptor_t *id; 230 231 /* Check that this is a keyboard that speaks the boot protocol. */ 232 if (!uaa->iface) 233 return (UMATCH_NONE); 234 id = usbd_get_interface_descriptor(uaa->iface); 235 if (id->bInterfaceClass != UCLASS_HID || 236 id->bInterfaceSubClass != USUBCLASS_BOOT || 237 id->bInterfaceProtocol != UPROTO_BOOT_KEYBOARD) 238 return (UMATCH_NONE); 239 return (UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO); 240 } 241 242 void 243 ukbd_attach(parent, self, aux) 244 struct device *parent; 245 struct device *self; 246 void *aux; 247 { 248 struct ukbd_softc *sc = (struct ukbd_softc *)self; 249 struct usb_attach_arg *uaa = aux; 250 usbd_interface_handle iface = uaa->iface; 251 usb_interface_descriptor_t *id; 252 usb_endpoint_descriptor_t *ed; 253 usbd_status r; 254 char devinfo[1024]; 255 struct wskbddev_attach_args a; 256 257 sc->sc_disconnected = 1; 258 sc->sc_iface = iface; 259 id = usbd_get_interface_descriptor(iface); 260 usbd_devinfo(uaa->device, 0, devinfo); 261 printf(": %s (interface class %d/%d)\n", devinfo, 262 id->bInterfaceClass, id->bInterfaceSubClass); 263 ed = usbd_interface2endpoint_descriptor(iface, 0); 264 if (!ed) { 265 printf("%s: could not read endpoint descriptor\n", 266 sc->sc_dev.dv_xname); 267 return; 268 } 269 270 DPRINTFN(10,("ukbd_attach: \ 271 bLength=%d bDescriptorType=%d bEndpointAddress=%d-%s bmAttributes=%d wMaxPacketSize=%d bInterval=%d\n", 272 ed->bLength, ed->bDescriptorType, ed->bEndpointAddress & UE_ADDR, 273 ed->bEndpointAddress & UE_IN ? "in" : "out", 274 ed->bmAttributes & UE_XFERTYPE, 275 UGETW(ed->wMaxPacketSize), ed->bInterval)); 276 277 if ((ed->bEndpointAddress & UE_IN) != UE_IN || 278 (ed->bmAttributes & UE_XFERTYPE) != UE_INTERRUPT) { 279 printf("%s: unexpected endpoint\n", 280 sc->sc_dev.dv_xname); 281 return; 282 } 283 284 if ((usbd_get_quirks(uaa->device)->uq_flags & UQ_NO_SET_PROTO) == 0) { 285 r = usbd_set_protocol(iface, 0); 286 DPRINTFN(5, ("ukbd_attach: protocol set\n")); 287 if (r != USBD_NORMAL_COMPLETION) { 288 printf("%s: set protocol failed\n", 289 sc->sc_dev.dv_xname); 290 return; 291 } 292 } 293 /* Ignore if SETIDLE fails since it is not crucial. */ 294 usbd_set_idle(iface, 0, 0); 295 296 sc->sc_ep_addr = ed->bEndpointAddress; 297 sc->sc_disconnected = 0; 298 299 a.console = 0; /* XXX */ 300 301 a.keymap = &ukbd_keymapdata; 302 303 a.accessops = &ukbd_accessops; 304 a.accesscookie = sc; 305 306 sc->sc_wskbddev = config_found(self, &a, wskbddevprint); 307 } 308 309 void 310 ukbd_disco(p) 311 void *p; 312 { 313 struct ukbd_softc *sc = p; 314 315 DPRINTF(("ukbd_disco: sc=%p\n", sc)); 316 usbd_abort_pipe(sc->sc_intrpipe); 317 sc->sc_disconnected = 1; 318 } 319 320 int 321 ukbd_enable(v, on) 322 void *v; 323 int on; 324 { 325 struct ukbd_softc *sc = v; 326 usbd_status r; 327 328 if (on) { 329 /* Set up interrupt pipe. */ 330 if (sc->sc_enabled) 331 return EBUSY; 332 333 sc->sc_enabled = 1; 334 r = usbd_open_pipe_intr(sc->sc_iface, sc->sc_ep_addr, 335 USBD_SHORT_XFER_OK, 336 &sc->sc_intrpipe, sc, &sc->sc_ndata, 337 sizeof(sc->sc_ndata), ukbd_intr); 338 if (r != USBD_NORMAL_COMPLETION) 339 return (EIO); 340 usbd_set_disco(sc->sc_intrpipe, ukbd_disco, sc); 341 } else { 342 /* Disable interrupts. */ 343 usbd_abort_pipe(sc->sc_intrpipe); 344 usbd_close_pipe(sc->sc_intrpipe); 345 346 sc->sc_enabled = 0; 347 } 348 349 return (0); 350 } 351 352 void 353 ukbd_intr(reqh, addr, status) 354 usbd_request_handle reqh; 355 usbd_private_handle addr; 356 usbd_status status; 357 { 358 struct ukbd_softc *sc = addr; 359 struct ukbd_data *ud = &sc->sc_ndata; 360 int mod, omod; 361 int ibuf[NMOD+2*NKEYCODE]; /* chars events */ 362 int nkeys, i, j; 363 int key, c; 364 #define ADDKEY(c) ibuf[nkeys++] = (c) 365 366 DPRINTFN(5, ("ukbd_intr: status=%d\n", status)); 367 if (status == USBD_CANCELLED) 368 return; 369 370 if (status != USBD_NORMAL_COMPLETION) { 371 DPRINTF(("ukbd_intr: status=%d\n", status)); 372 usbd_clear_endpoint_stall_async(sc->sc_intrpipe); 373 return; 374 } 375 376 DPRINTFN(5, (" mod=0x%02x key0=0x%02x key1=0x%02x\n", 377 ud->modifiers, ud->keycode[0], ud->keycode[1])); 378 379 if (ud->keycode[0] == KEY_ERROR) 380 return; /* ignore */ 381 nkeys = 0; 382 mod = ud->modifiers; 383 omod = sc->sc_odata.modifiers; 384 if (mod != omod) 385 for (i = 0; i < NMOD; i++) 386 if (( mod & ukbd_mods[i].mask) != 387 (omod & ukbd_mods[i].mask)) 388 ADDKEY(ukbd_mods[i].key | 389 (mod & ukbd_mods[i].mask 390 ? PRESS : RELEASE)); 391 if (memcmp(ud->keycode, sc->sc_odata.keycode, NKEYCODE) != 0) { 392 /* Check for released keys. */ 393 for (i = 0; i < NKEYCODE; i++) { 394 key = sc->sc_odata.keycode[i]; 395 if (key == 0) 396 continue; 397 for (j = 0; j < NKEYCODE; j++) 398 if (key == ud->keycode[j]) 399 goto rfound; 400 c = ukbd_trtab[key]; 401 if (c) 402 ADDKEY(c | RELEASE); 403 rfound: 404 ; 405 } 406 407 /* Check for pressed keys. */ 408 for (i = 0; i < NKEYCODE; i++) { 409 key = ud->keycode[i]; 410 if (key == 0) 411 continue; 412 for (j = 0; j < NKEYCODE; j++) 413 if (key == sc->sc_odata.keycode[j]) 414 goto pfound; 415 c = ukbd_trtab[key]; 416 DPRINTFN(2,("ukbd_intr: press key=0x%02x -> 0x%02x\n", 417 key, c)); 418 if (c) 419 ADDKEY(c | PRESS); 420 pfound: 421 ; 422 } 423 } 424 sc->sc_odata = *ud; 425 426 if (sc->sc_polling) { 427 if (nkeys > 0) 428 sc->sc_pollchar = ibuf[0]; /* XXX lost keys? */ 429 return; 430 } 431 for (i = 0; i < nkeys; i++) { 432 c = ibuf[i]; 433 wskbd_input(sc->sc_wskbddev, 434 c & RELEASE ? WSCONS_EVENT_KEY_UP : WSCONS_EVENT_KEY_DOWN, 435 c & 0xff); 436 } 437 } 438 439 void 440 ukbd_set_leds(v, leds) 441 void *v; 442 int leds; 443 { 444 struct ukbd_softc *sc = v; 445 u_int8_t res; 446 447 DPRINTF(("ukbd_set_leds: sc=%p leds=%d\n", sc, leds)); 448 449 sc->sc_leds = leds; 450 res = 0; 451 if (leds & WSKBD_LED_SCROLL) 452 res |= SCROLL_LOCK; 453 if (leds & WSKBD_LED_NUM) 454 res |= NUM_LOCK; 455 if (leds & WSKBD_LED_CAPS) 456 res |= CAPS_LOCK; 457 usbd_set_report_async(sc->sc_iface, UHID_OUTPUT_REPORT, 0, &res, 1); 458 } 459 460 int 461 ukbd_ioctl(v, cmd, data, flag, p) 462 void *v; 463 u_long cmd; 464 caddr_t data; 465 int flag; 466 struct proc *p; 467 { 468 struct ukbd_softc *sc = v; 469 470 switch (cmd) { 471 case WSKBDIO_GTYPE: 472 *(int *)data = WSKBD_TYPE_PC_XT; 473 return 0; 474 case WSKBDIO_SETLEDS: 475 ukbd_set_leds(v, *(int *)data); 476 return 0; 477 case WSKBDIO_GETLEDS: 478 *(int *)data = sc->sc_leds; 479 return (0); 480 #ifdef WSDISPLAY_COMPAT_RAWKBD 481 case WSKBDIO_SETMODE: 482 sc->sc_rawkbd = *(int *)data == WSKBD_RAW; 483 return (0); 484 #endif 485 } 486 return -1; 487 } 488 489 /* Console interface. */ 490 /* XXX does not work. */ 491 void 492 ukbd_cngetc(v, type, data) 493 void *v; 494 u_int *type; 495 int *data; 496 { 497 struct ukbd_softc *sc = v; 498 usbd_lock_token s; 499 int c; 500 501 DPRINTFN(1,("ukbd_cngetc: enter\n")); 502 s = usbd_lock(); 503 sc->sc_polling = 1; 504 sc->sc_pollchar = -1; 505 while(sc->sc_pollchar == -1) 506 usbd_dopoll(sc->sc_iface); 507 sc->sc_polling = 0; 508 c = sc->sc_pollchar; 509 *type = c & RELEASE ? WSCONS_EVENT_KEY_UP : WSCONS_EVENT_KEY_DOWN; 510 *data = c & 0xff; 511 usbd_unlock(s); 512 DPRINTFN(1,("ukbd_cngetc: return 0x%02x\n", c)); 513 } 514 515 void 516 ukbd_cnpollc(v, on) 517 void *v; 518 int on; 519 { 520 struct ukbd_softc *sc = v; 521 522 DPRINTFN(1,("ukbd_cnpollc: sc=%p on=%d\n", v, on)); 523 524 usbd_set_polling(sc->sc_iface, on); 525 } 526
Indexes created Thu Sep 25 16:09:42 GMT 2025