ukbd.c revision 1.92 1 /* $NetBSD: ukbd.c,v 1.92 2006/09/03 21:17:54 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.92 2006/09/03 21:17:54 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, void *aux)
282 {
283 struct uhidev_attach_arg *uha = aux;
284 int size;
285 void *desc;
286
287 uhidev_get_report_desc(uha->parent, &desc, &size);
288 if (!hid_is_collection(desc, size, uha->reportid,
289 HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_KEYBOARD)))
290 return (UMATCH_NONE);
291
292 return (UMATCH_IFACECLASS);
293 }
294
295 void
296 ukbd_attach(struct device *parent, struct device *self, void *aux)
297 {
298 struct ukbd_softc *sc = (struct ukbd_softc *)self;
299 struct uhidev_attach_arg *uha = aux;
300 u_int32_t qflags;
301 const char *parseerr;
302 #if defined(__NetBSD__)
303 struct wskbddev_attach_args a;
304 #else
305 int i;
306 #endif
307
308 sc->sc_hdev.sc_intr = ukbd_intr;
309 sc->sc_hdev.sc_parent = uha->parent;
310 sc->sc_hdev.sc_report_id = uha->reportid;
311
312 parseerr = ukbd_parse_desc(sc);
313 if (parseerr != NULL) {
314 printf("\n%s: attach failed, %s\n",
315 sc->sc_hdev.sc_dev.dv_xname, parseerr);
316 USB_ATTACH_ERROR_RETURN;
317 }
318
319 #ifdef DIAGNOSTIC
320 printf(": %d modifier keys, %d key codes", sc->sc_nmod,
321 sc->sc_nkeycode);
322 #endif
323 printf("\n");
324
325
326 qflags = usbd_get_quirks(uha->parent->sc_udev)->uq_flags;
327 sc->sc_debounce = (qflags & UQ_SPUR_BUT_UP) != 0;
328
329 /*
330 * Remember if we're the console keyboard.
331 *
332 * XXX This always picks the first keyboard on the
333 * first USB bus, but what else can we really do?
334 */
335 if ((sc->sc_console_keyboard = ukbd_is_console) != 0) {
336 /* Don't let any other keyboard have it. */
337 ukbd_is_console = 0;
338 }
339
340 if (sc->sc_console_keyboard) {
341 DPRINTF(("ukbd_attach: console keyboard sc=%p\n", sc));
342 wskbd_cnattach(&ukbd_consops, sc, &ukbd_keymapdata);
343 ukbd_enable(sc, 1);
344 }
345
346 a.console = sc->sc_console_keyboard;
347
348 a.keymap = &ukbd_keymapdata;
349
350 a.accessops = &ukbd_accessops;
351 a.accesscookie = sc;
352
353 #ifdef UKBD_REPEAT
354 usb_callout_init(sc->sc_rawrepeat_ch);
355 #endif
356
357 usb_callout_init(sc->sc_delay);
358
359 /* Flash the leds; no real purpose, just shows we're alive. */
360 ukbd_set_leds(sc, WSKBD_LED_SCROLL | WSKBD_LED_NUM | WSKBD_LED_CAPS);
361 usbd_delay_ms(uha->parent->sc_udev, 400);
362 ukbd_set_leds(sc, 0);
363
364 sc->sc_wskbddev = config_found(self, &a, wskbddevprint);
365
366 USB_ATTACH_SUCCESS_RETURN;
367 }
368
369 int
370 ukbd_enable(void *v, int on)
371 {
372 struct ukbd_softc *sc = v;
373
374 if (on && sc->sc_dying)
375 return (EIO);
376
377 /* Should only be called to change state */
378 if (sc->sc_enabled == on) {
379 #ifdef DIAGNOSTIC
380 printf("ukbd_enable: %s: bad call on=%d\n",
381 USBDEVNAME(sc->sc_hdev.sc_dev), on);
382 #endif
383 return (EBUSY);
384 }
385
386 DPRINTF(("ukbd_enable: sc=%p on=%d\n", sc, on));
387 sc->sc_enabled = on;
388 if (on) {
389 return (uhidev_open(&sc->sc_hdev));
390 } else {
391 uhidev_close(&sc->sc_hdev);
392 return (0);
393 }
394 }
395
396 int
397 ukbd_activate(device_ptr_t self, enum devact act)
398 {
399 struct ukbd_softc *sc = (struct ukbd_softc *)self;
400 int rv = 0;
401
402 switch (act) {
403 case DVACT_ACTIVATE:
404 return (EOPNOTSUPP);
405
406 case DVACT_DEACTIVATE:
407 if (sc->sc_wskbddev != NULL)
408 rv = config_deactivate(sc->sc_wskbddev);
409 sc->sc_dying = 1;
410 break;
411 }
412 return (rv);
413 }
414
415 int
416 ukbd_detach(struct device *self, int flags)
417 {
418 struct ukbd_softc *sc = (struct ukbd_softc *)self;
419 int rv = 0;
420
421 DPRINTF(("ukbd_detach: sc=%p flags=%d\n", sc, flags));
422
423 if (sc->sc_console_keyboard) {
424 #if 0
425 /*
426 * XXX Should probably disconnect our consops,
427 * XXX and either notify some other keyboard that
428 * XXX it can now be the console, or if there aren't
429 * XXX any more USB keyboards, set ukbd_is_console
430 * XXX back to 1 so that the next USB keyboard attached
431 * XXX to the system will get it.
432 */
433 panic("ukbd_detach: console keyboard");
434 #else
435 /*
436 * Disconnect our consops and set ukbd_is_console
437 * back to 1 so that the next USB keyboard attached
438 * to the system will get it.
439 * XXX Should notify some other keyboard that it can be
440 * XXX console, if there are any other keyboards.
441 */
442 printf("%s: was console keyboard\n",
443 USBDEVNAME(sc->sc_hdev.sc_dev));
444 wskbd_cndetach();
445 ukbd_is_console = 1;
446 #endif
447 }
448 /* No need to do reference counting of ukbd, wskbd has all the goo. */
449 if (sc->sc_wskbddev != NULL)
450 rv = config_detach(sc->sc_wskbddev, flags);
451
452 /* The console keyboard does not get a disable call, so check pipe. */
453 if (sc->sc_hdev.sc_state & UHIDEV_OPEN)
454 uhidev_close(&sc->sc_hdev);
455
456 return (rv);
457 }
458
459 void
460 ukbd_intr(struct uhidev *addr, void *ibuf, u_int len)
461 {
462 struct ukbd_softc *sc = (struct ukbd_softc *)addr;
463 struct ukbd_data *ud = &sc->sc_ndata;
464 int i;
465
466 #ifdef UKBD_DEBUG
467 if (ukbddebug > 5) {
468 printf("ukbd_intr: data");
469 for (i = 0; i < len; i++)
470 printf(" 0x%02x", ((u_char *)ibuf)[i]);
471 printf("\n");
472 }
473 #endif
474
475 ud->modifiers = 0;
476 for (i = 0; i < sc->sc_nmod; i++)
477 if (hid_get_data(ibuf, &sc->sc_modloc[i]))
478 ud->modifiers |= sc->sc_mods[i].mask;
479 memcpy(ud->keycode, (char *)ibuf + sc->sc_keycodeloc.pos / 8,
480 sc->sc_nkeycode);
481
482 if (sc->sc_debounce && !sc->sc_polling) {
483 /*
484 * Some keyboards have a peculiar quirk. They sometimes
485 * generate a key up followed by a key down for the same
486 * key after about 10 ms.
487 * We avoid this bug by holding off decoding for 20 ms.
488 */
489 sc->sc_data = *ud;
490 usb_callout(sc->sc_delay, hz / 50, ukbd_delayed_decode, sc);
491 #ifdef DDB
492 } else if (sc->sc_console_keyboard && !sc->sc_polling) {
493 /*
494 * For the console keyboard we can't deliver CTL-ALT-ESC
495 * from the interrupt routine. Doing so would start
496 * polling from inside the interrupt routine and that
497 * loses bigtime.
498 */
499 sc->sc_data = *ud;
500 usb_callout(sc->sc_delay, 1, ukbd_delayed_decode, sc);
501 #endif
502 } else {
503 ukbd_decode(sc, ud);
504 }
505 }
506
507 void
508 ukbd_delayed_decode(void *addr)
509 {
510 struct ukbd_softc *sc = addr;
511
512 ukbd_decode(sc, &sc->sc_data);
513 }
514
515 void
516 ukbd_decode(struct ukbd_softc *sc, struct ukbd_data *ud)
517 {
518 int mod, omod;
519 u_int16_t ibuf[MAXKEYS]; /* chars events */
520 int s;
521 int nkeys, i, j;
522 int key;
523 #define ADDKEY(c) ibuf[nkeys++] = (c)
524
525 #ifdef UKBD_DEBUG
526 /*
527 * Keep a trace of the last events. Using printf changes the
528 * timing, so this can be useful sometimes.
529 */
530 if (ukbdtrace) {
531 struct ukbdtraceinfo *p = &ukbdtracedata[ukbdtraceindex];
532 p->unit = device_unit(&sc->sc_hdev.sc_dev);
533 microtime(&p->tv);
534 p->ud = *ud;
535 if (++ukbdtraceindex >= UKBDTRACESIZE)
536 ukbdtraceindex = 0;
537 }
538 if (ukbddebug > 5) {
539 struct timeval tv;
540 microtime(&tv);
541 DPRINTF((" at %lu.%06lu mod=0x%02x key0=0x%02x key1=0x%02x "
542 "key2=0x%02x key3=0x%02x\n",
543 tv.tv_sec, tv.tv_usec,
544 ud->modifiers, ud->keycode[0], ud->keycode[1],
545 ud->keycode[2], ud->keycode[3]));
546 }
547 #endif
548
549 if (ud->keycode[0] == KEY_ERROR) {
550 DPRINTF(("ukbd_intr: KEY_ERROR\n"));
551 return; /* ignore */
552 }
553 nkeys = 0;
554 mod = ud->modifiers;
555 omod = sc->sc_odata.modifiers;
556 if (mod != omod)
557 for (i = 0; i < sc->sc_nmod; i++)
558 if (( mod & sc->sc_mods[i].mask) !=
559 (omod & sc->sc_mods[i].mask))
560 ADDKEY(sc->sc_mods[i].key |
561 (mod & sc->sc_mods[i].mask
562 ? PRESS : RELEASE));
563 if (memcmp(ud->keycode, sc->sc_odata.keycode, sc->sc_nkeycode) != 0) {
564 /* Check for released keys. */
565 for (i = 0; i < sc->sc_nkeycode; i++) {
566 key = sc->sc_odata.keycode[i];
567 if (key == 0)
568 continue;
569 for (j = 0; j < sc->sc_nkeycode; j++)
570 if (key == ud->keycode[j])
571 goto rfound;
572 DPRINTFN(3,("ukbd_intr: relse key=0x%02x\n", key));
573 ADDKEY(key | RELEASE);
574 rfound:
575 ;
576 }
577
578 /* Check for pressed keys. */
579 for (i = 0; i < sc->sc_nkeycode; i++) {
580 key = ud->keycode[i];
581 if (key == 0)
582 continue;
583 for (j = 0; j < sc->sc_nkeycode; j++)
584 if (key == sc->sc_odata.keycode[j])
585 goto pfound;
586 DPRINTFN(2,("ukbd_intr: press key=0x%02x\n", key));
587 ADDKEY(key | PRESS);
588 pfound:
589 ;
590 }
591 }
592 sc->sc_odata = *ud;
593
594 if (nkeys == 0)
595 return;
596
597 if (sc->sc_polling) {
598 DPRINTFN(1,("ukbd_intr: pollchar = 0x%03x\n", ibuf[0]));
599 memcpy(sc->sc_pollchars, ibuf, nkeys * sizeof(u_int16_t));
600 sc->sc_npollchar = nkeys;
601 return;
602 }
603 #ifdef WSDISPLAY_COMPAT_RAWKBD
604 if (sc->sc_rawkbd) {
605 u_char cbuf[MAXKEYS * 2];
606 int c;
607 int npress;
608
609 for (npress = i = j = 0; i < nkeys; i++) {
610 key = ibuf[i];
611 c = ukbd_trtab[key & CODEMASK];
612 if (c == NN)
613 continue;
614 if (c & 0x80)
615 cbuf[j++] = 0xe0;
616 cbuf[j] = c & 0x7f;
617 if (key & RELEASE)
618 cbuf[j] |= 0x80;
619 #if defined(UKBD_REPEAT)
620 else {
621 /* remember pressed keys for autorepeat */
622 if (c & 0x80)
623 sc->sc_rep[npress++] = 0xe0;
624 sc->sc_rep[npress++] = c & 0x7f;
625 }
626 #endif
627 DPRINTFN(1,("ukbd_intr: raw = %s0x%02x\n",
628 c & 0x80 ? "0xe0 " : "",
629 cbuf[j]));
630 j++;
631 }
632 s = spltty();
633 wskbd_rawinput(sc->sc_wskbddev, cbuf, j);
634 splx(s);
635 #ifdef UKBD_REPEAT
636 usb_uncallout(sc->sc_rawrepeat_ch, ukbd_rawrepeat, sc);
637 if (npress != 0) {
638 sc->sc_nrep = npress;
639 usb_callout(sc->sc_rawrepeat_ch,
640 hz * REP_DELAY1 / 1000, ukbd_rawrepeat, sc);
641 }
642 #endif
643 return;
644 }
645 #endif
646
647 s = spltty();
648 for (i = 0; i < nkeys; i++) {
649 key = ibuf[i];
650 wskbd_input(sc->sc_wskbddev,
651 key&RELEASE ? WSCONS_EVENT_KEY_UP : WSCONS_EVENT_KEY_DOWN,
652 key&CODEMASK);
653 }
654 splx(s);
655 }
656
657 void
658 ukbd_set_leds(void *v, int leds)
659 {
660 struct ukbd_softc *sc = v;
661 u_int8_t res;
662
663 DPRINTF(("ukbd_set_leds: sc=%p leds=%d, sc_leds=%d\n",
664 sc, leds, sc->sc_leds));
665
666 if (sc->sc_dying)
667 return;
668
669 if (sc->sc_leds == leds)
670 return;
671 sc->sc_leds = leds;
672 res = 0;
673 /* XXX not really right */
674 if ((leds & WSKBD_LED_SCROLL) && sc->sc_scroloc.size == 1)
675 res |= 1 << sc->sc_scroloc.pos;
676 if ((leds & WSKBD_LED_NUM) && sc->sc_numloc.size == 1)
677 res |= 1 << sc->sc_numloc.pos;
678 if ((leds & WSKBD_LED_CAPS) && sc->sc_capsloc.size == 1)
679 res |= 1 << sc->sc_capsloc.pos;
680 uhidev_set_report_async(&sc->sc_hdev, UHID_OUTPUT_REPORT, &res, 1);
681 }
682
683 #if defined(WSDISPLAY_COMPAT_RAWKBD) && defined(UKBD_REPEAT)
684 void
685 ukbd_rawrepeat(void *v)
686 {
687 struct ukbd_softc *sc = v;
688 int s;
689
690 s = spltty();
691 wskbd_rawinput(sc->sc_wskbddev, sc->sc_rep, sc->sc_nrep);
692 splx(s);
693 usb_callout(sc->sc_rawrepeat_ch, hz * REP_DELAYN / 1000,
694 ukbd_rawrepeat, sc);
695 }
696 #endif /* defined(WSDISPLAY_COMPAT_RAWKBD) && defined(UKBD_REPEAT) */
697
698 int
699 ukbd_ioctl(void *v, u_long cmd, caddr_t data, int flag, struct lwp *l)
700 {
701 struct ukbd_softc *sc = v;
702
703 switch (cmd) {
704 case WSKBDIO_GTYPE:
705 *(int *)data = WSKBD_TYPE_USB;
706 return (0);
707 case WSKBDIO_SETLEDS:
708 ukbd_set_leds(v, *(int *)data);
709 return (0);
710 case WSKBDIO_GETLEDS:
711 *(int *)data = sc->sc_leds;
712 return (0);
713 #if defined(WSDISPLAY_COMPAT_RAWKBD)
714 case WSKBDIO_SETMODE:
715 DPRINTF(("ukbd_ioctl: set raw = %d\n", *(int *)data));
716 sc->sc_rawkbd = *(int *)data == WSKBD_RAW;
717 #if defined(UKBD_REPEAT)
718 usb_uncallout(sc->sc_rawrepeat_ch, ukbd_rawrepeat, sc);
719 #endif
720 return (0);
721 #endif
722 }
723 return (EPASSTHROUGH);
724 }
725
726 /*
727 * This is a hack to work around some broken ports that don't call
728 * cnpollc() before cngetc().
729 */
730 static int pollenter, warned;
731
732 /* Console interface. */
733 void
734 ukbd_cngetc(void *v, u_int *type, int *data)
735 {
736 struct ukbd_softc *sc = v;
737 int c;
738 int broken;
739
740 if (pollenter == 0) {
741 if (!warned) {
742 printf("\n"
743 "This port is broken, it does not call cnpollc() before calling cngetc().\n"
744 "This should be fixed, but it will work anyway (for now).\n");
745 warned = 1;
746 }
747 broken = 1;
748 ukbd_cnpollc(v, 1);
749 } else
750 broken = 0;
751
752 DPRINTFN(0,("ukbd_cngetc: enter\n"));
753 sc->sc_polling = 1;
754 while(sc->sc_npollchar <= 0)
755 usbd_dopoll(sc->sc_hdev.sc_parent->sc_iface);
756 sc->sc_polling = 0;
757 c = sc->sc_pollchars[0];
758 sc->sc_npollchar--;
759 memcpy(sc->sc_pollchars, sc->sc_pollchars+1,
760 sc->sc_npollchar * sizeof(u_int16_t));
761 *type = c & RELEASE ? WSCONS_EVENT_KEY_UP : WSCONS_EVENT_KEY_DOWN;
762 *data = c & CODEMASK;
763 DPRINTFN(0,("ukbd_cngetc: return 0x%02x\n", c));
764 if (broken)
765 ukbd_cnpollc(v, 0);
766 }
767
768 void
769 ukbd_cnpollc(void *v, int on)
770 {
771 struct ukbd_softc *sc = v;
772 usbd_device_handle dev;
773
774 DPRINTFN(2,("ukbd_cnpollc: sc=%p on=%d\n", v, on));
775
776 usbd_interface2device_handle(sc->sc_hdev.sc_parent->sc_iface, &dev);
777 if (on) {
778 sc->sc_spl = splusb();
779 pollenter++;
780 } else {
781 splx(sc->sc_spl);
782 pollenter--;
783 }
784 usbd_set_polling(dev, on);
785 }
786
787 int
788 ukbd_cnattach(void)
789 {
790
791 /*
792 * XXX USB requires too many parts of the kernel to be running
793 * XXX in order to work, so we can't do much for the console
794 * XXX keyboard until autconfiguration has run its course.
795 */
796 ukbd_is_console = 1;
797 return (0);
798 }
799
800 const char *
801 ukbd_parse_desc(struct ukbd_softc *sc)
802 {
803 struct hid_data *d;
804 struct hid_item h;
805 int size;
806 void *desc;
807 int imod;
808
809 uhidev_get_report_desc(sc->sc_hdev.sc_parent, &desc, &size);
810 imod = 0;
811 sc->sc_nkeycode = 0;
812 d = hid_start_parse(desc, size, hid_input);
813 while (hid_get_item(d, &h)) {
814 /*printf("ukbd: id=%d kind=%d usage=0x%x flags=0x%x pos=%d size=%d cnt=%d\n",
815 h.report_ID, h.kind, h.usage, h.flags, h.loc.pos, h.loc.size, h.loc.count);*/
816 if (h.kind != hid_input || (h.flags & HIO_CONST) ||
817 HID_GET_USAGE_PAGE(h.usage) != HUP_KEYBOARD ||
818 h.report_ID != sc->sc_hdev.sc_report_id)
819 continue;
820 DPRINTF(("ukbd: imod=%d usage=0x%x flags=0x%x pos=%d size=%d "
821 "cnt=%d\n", imod,
822 h.usage, h.flags, h.loc.pos, h.loc.size, h.loc.count));
823 if (h.flags & HIO_VARIABLE) {
824 if (h.loc.size != 1)
825 return ("bad modifier size");
826 /* Single item */
827 if (imod < MAXMOD) {
828 sc->sc_modloc[imod] = h.loc;
829 sc->sc_mods[imod].mask = 1 << imod;
830 sc->sc_mods[imod].key = HID_GET_USAGE(h.usage);
831 imod++;
832 } else
833 return ("too many modifier keys");
834 } else {
835 /* Array */
836 if (h.loc.size != 8)
837 return ("key code size != 8");
838 if (h.loc.count > MAXKEYCODE)
839 return ("too many key codes");
840 if (h.loc.pos % 8 != 0)
841 return ("key codes not on byte boundary");
842 if (sc->sc_nkeycode != 0)
843 return ("multiple key code arrays\n");
844 sc->sc_keycodeloc = h.loc;
845 sc->sc_nkeycode = h.loc.count;
846 }
847 }
848 sc->sc_nmod = imod;
849 hid_end_parse(d);
850
851 hid_locate(desc, size, HID_USAGE2(HUP_LEDS, HUD_LED_NUM_LOCK),
852 sc->sc_hdev.sc_report_id, hid_output, &sc->sc_numloc, NULL);
853 hid_locate(desc, size, HID_USAGE2(HUP_LEDS, HUD_LED_CAPS_LOCK),
854 sc->sc_hdev.sc_report_id, hid_output, &sc->sc_capsloc, NULL);
855 hid_locate(desc, size, HID_USAGE2(HUP_LEDS, HUD_LED_SCROLL_LOCK),
856 sc->sc_hdev.sc_report_id, hid_output, &sc->sc_scroloc, NULL);
857
858 return (NULL);
859 }
860