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