4 * Copyright (c) 1998 The NetBSD Foundation, Inc.
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Lennart Augustsson (lennart@augustsson.net) at
9 * Carlstedt Research & Technology.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
41 * HID spec: http://www.usb.org/developers/data/devclass/hid1_1.pdf
47 #include <sys/param.h>
48 #include <sys/systm.h>
49 #include <sys/kernel.h>
50 #include <sys/ioccom.h>
51 #include <sys/module.h>
54 #if __FreeBSD_version >= 500014
55 #include <sys/selinfo.h>
57 #include <sys/select.h>
59 #include <sys/vnode.h>
60 #include <sys/sysctl.h>
62 #include <dev/usb/usb.h>
63 #include <dev/usb/usbhid.h>
64 #include <dev/usb/usbdi.h>
65 #include <dev/usb/usbdi_util.h>
66 #include <dev/usb/usbdevs.h>
67 #include <dev/usb/usb_quirks.h>
68 #include <dev/usb/hid.h>
71 #include <dev/kbd/kbdreg.h>
73 #define UKBD_EMULATE_ATSCANCODE 1
75 #define DRIVER_NAME "ukbd"
77 #define delay(d) DELAY(d)
80 #define DPRINTF(x) if (ukbddebug) logprintf x
81 #define DPRINTFN(n,x) if (ukbddebug>(n)) logprintf x
83 SYSCTL_NODE(_hw_usb, OID_AUTO, ukbd, CTLFLAG_RW, 0, "USB ukbd");
84 SYSCTL_INT(_hw_usb_ukbd, OID_AUTO, debug, CTLFLAG_RW,
85 &ukbddebug, 0, "ukbd debug level");
91 #define UPROTO_BOOT_KEYBOARD 1
97 #define MOD_CONTROL_L 0x01
98 #define MOD_CONTROL_R 0x10
99 #define MOD_SHIFT_L 0x02
100 #define MOD_SHIFT_R 0x20
101 #define MOD_ALT_L 0x04
102 #define MOD_ALT_R 0x40
103 #define MOD_WIN_L 0x08
104 #define MOD_WIN_R 0x80
106 u_int8_t keycode[NKEYCODE];
109 #define MAXKEYS (NMOD+2*NKEYCODE)
111 typedef struct ukbd_softc {
112 device_t sc_dev; /* base device */
115 #define UKBD_CHUNK 128 /* chunk size for read */
116 #define UKBD_BSIZE 1020 /* buffer size */
118 typedef void usbd_intr_t(usbd_xfer_handle, usbd_private_handle, usbd_status);
119 typedef void usbd_disco_t(void *);
121 Static int ukbd_resume(device_t self);
122 Static usbd_intr_t ukbd_intr;
123 Static int ukbd_driver_load(module_t mod, int what, void *arg);
125 USB_DECLARE_DRIVER_INIT(ukbd, DEVMETHOD(device_resume, ukbd_resume));
129 USB_MATCH_START(ukbd, uaa);
131 keyboard_switch_t *sw;
133 int unit = device_get_unit(self);
135 sw = kbd_get_switch(DRIVER_NAME);
137 return (UMATCH_NONE);
139 arg[0] = (void *)uaa;
140 arg[1] = (void *)ukbd_intr;
141 if ((*sw->probe)(unit, (void *)arg, 0))
142 return (UMATCH_NONE);
144 return (UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO);
149 USB_ATTACH_START(ukbd, sc, uaa);
150 usbd_interface_handle iface = uaa->iface;
151 usb_interface_descriptor_t *id;
154 keyboard_switch_t *sw;
157 int unit = device_get_unit(self);
159 sw = kbd_get_switch(DRIVER_NAME);
161 USB_ATTACH_ERROR_RETURN;
163 id = usbd_get_interface_descriptor(iface);
164 usbd_devinfo(uaa->device, 0, devinfo);
166 printf("%s: %s, iclass %d/%d\n", USBDEVNAME(sc->sc_dev),
167 devinfo, id->bInterfaceClass, id->bInterfaceSubClass);
169 arg[0] = (void *)uaa;
170 arg[1] = (void *)ukbd_intr;
172 if ((*sw->probe)(unit, (void *)arg, 0))
173 USB_ATTACH_ERROR_RETURN;
174 if ((*sw->init)(unit, &kbd, (void *)arg, 0))
175 USB_ATTACH_ERROR_RETURN;
178 #ifdef KBD_INSTALL_CDEV
180 USB_ATTACH_ERROR_RETURN;
183 (*sw->diag)(kbd, bootverbose);
185 USB_ATTACH_SUCCESS_RETURN;
189 ukbd_detach(device_t self)
194 kbd = kbd_get_keyboard(kbd_find_keyboard(DRIVER_NAME,
195 device_get_unit(self)));
197 DPRINTF(("%s: keyboard not attached!?\n", USBDEVNAME(self)));
200 (*kbdsw[kbd->kb_index]->disable)(kbd);
202 #ifdef KBD_INSTALL_CDEV
203 error = kbd_detach(kbd);
207 error = (*kbdsw[kbd->kb_index]->term)(kbd);
211 DPRINTF(("%s: disconnected\n", USBDEVNAME(self)));
217 ukbd_resume(device_t self)
221 kbd = kbd_get_keyboard(kbd_find_keyboard(DRIVER_NAME,
222 device_get_unit(self)));
224 (*kbdsw[kbd->kb_index]->clear_state)(kbd);
229 ukbd_intr(usbd_xfer_handle xfer, usbd_private_handle addr, usbd_status status)
231 keyboard_t *kbd = (keyboard_t *)addr;
233 (*kbdsw[kbd->kb_index]->intr)(kbd, (void *)status);
236 DRIVER_MODULE(ukbd, uhub, ukbd_driver, ukbd_devclass, ukbd_driver_load, 0);
238 #include <machine/limits.h>
240 #define UKBD_DEFAULT 0
242 #define KEY_ERROR 0x01
245 #define KEY_RELEASE 0x400
246 #define KEY_INDEX(c) ((c) & ~KEY_RELEASE)
249 #define SCAN_RELEASE 0x80
250 #define SCAN_PREFIX_E0 0x100
251 #define SCAN_PREFIX_E1 0x200
252 #define SCAN_PREFIX_CTL 0x400
253 #define SCAN_PREFIX_SHIFT 0x800
254 #define SCAN_PREFIX (SCAN_PREFIX_E0 | SCAN_PREFIX_E1 | SCAN_PREFIX_CTL \
256 #define SCAN_CHAR(c) ((c) & 0x7f)
261 } ukbd_mods[NMOD] = {
262 { MOD_CONTROL_L, 0xe0 },
263 { MOD_CONTROL_R, 0xe4 },
264 { MOD_SHIFT_L, 0xe1 },
265 { MOD_SHIFT_R, 0xe5 },
272 #define NN 0 /* no translation */
274 * Translate USB keycodes to AT keyboard scancodes.
277 * FIXME: Mac USB keyboard generates:
278 * 0x53: keypad NumLock/Clear
285 Static u_int8_t ukbd_trtab[256] = {
286 0, 0, 0, 0, 30, 48, 46, 32, /* 00 - 07 */
287 18, 33, 34, 35, 23, 36, 37, 38, /* 08 - 0F */
288 50, 49, 24, 25, 16, 19, 31, 20, /* 10 - 17 */
289 22, 47, 17, 45, 21, 44, 2, 3, /* 18 - 1F */
290 4, 5, 6, 7, 8, 9, 10, 11, /* 20 - 27 */
291 28, 1, 14, 15, 57, 12, 13, 26, /* 28 - 2F */
292 27, 43, 43, 39, 40, 41, 51, 52, /* 30 - 37 */
293 53, 58, 59, 60, 61, 62, 63, 64, /* 38 - 3F */
294 65, 66, 67, 68, 87, 88, 92, 70, /* 40 - 47 */
295 104, 102, 94, 96, 103, 99, 101, 98, /* 48 - 4F */
296 97, 100, 95, 69, 91, 55, 74, 78, /* 50 - 57 */
297 89, 79, 80, 81, 75, 76, 77, 71, /* 58 - 5F */
298 72, 73, 82, 83, 86, 107, NN, NN, /* 60 - 67 */
299 NN, NN, NN, NN, NN, NN, NN, NN, /* 68 - 6F */
300 NN, NN, NN, NN, NN, NN, NN, NN, /* 70 - 77 */
301 NN, NN, NN, NN, NN, NN, NN, NN, /* 78 - 7F */
302 NN, NN, NN, NN, NN, NN, NN, 115, /* 80 - 87 */
303 112, 125, 121, 123, NN, NN, NN, NN, /* 88 - 8F */
304 NN, NN, NN, NN, NN, NN, NN, NN, /* 90 - 97 */
305 NN, NN, NN, NN, NN, NN, NN, NN, /* 98 - 9F */
306 NN, NN, NN, NN, NN, NN, NN, NN, /* A0 - A7 */
307 NN, NN, NN, NN, NN, NN, NN, NN, /* A8 - AF */
308 NN, NN, NN, NN, NN, NN, NN, NN, /* B0 - B7 */
309 NN, NN, NN, NN, NN, NN, NN, NN, /* B8 - BF */
310 NN, NN, NN, NN, NN, NN, NN, NN, /* C0 - C7 */
311 NN, NN, NN, NN, NN, NN, NN, NN, /* C8 - CF */
312 NN, NN, NN, NN, NN, NN, NN, NN, /* D0 - D7 */
313 NN, NN, NN, NN, NN, NN, NN, NN, /* D8 - DF */
314 29, 42, 56, 105, 90, 54, 93, 106, /* E0 - E7 */
315 NN, NN, NN, NN, NN, NN, NN, NN, /* E8 - EF */
316 NN, NN, NN, NN, NN, NN, NN, NN, /* F0 - F7 */
317 NN, NN, NN, NN, NN, NN, NN, NN, /* F8 - FF */
320 typedef struct ukbd_state {
321 usbd_interface_handle ks_iface; /* interface */
322 usbd_pipe_handle ks_intrpipe; /* interrupt pipe */
323 struct usb_attach_arg *ks_uaa;
326 struct ukbd_data ks_ndata;
327 struct ukbd_data ks_odata;
328 u_long ks_ntime[NKEYCODE];
329 u_long ks_otime[NKEYCODE];
331 #define INPUTBUFSIZE (NMOD + 2*NKEYCODE)
332 u_int ks_input[INPUTBUFSIZE]; /* input buffer */
338 #define INTRENABLED (1 << 0)
339 #define DISCONNECTED (1 << 1)
341 struct callout_handle ks_timeout_handle;
343 int ks_mode; /* input mode (K_XLATE,K_RAW,K_CODE) */
344 int ks_flags; /* flags */
345 #define COMPOSE (1 << 0)
347 int ks_state; /* shift/lock key state */
348 int ks_accents; /* accent key index (> 0) */
349 u_int ks_composed_char; /* composed char code (> 0) */
350 #ifdef UKBD_EMULATE_ATSCANCODE
351 u_int ks_buffered_char[2];
355 /* keyboard driver declaration */
356 Static int ukbd_configure(int flags);
357 Static kbd_probe_t ukbd_probe;
358 Static kbd_init_t ukbd_init;
359 Static kbd_term_t ukbd_term;
360 Static kbd_intr_t ukbd_interrupt;
361 Static kbd_test_if_t ukbd_test_if;
362 Static kbd_enable_t ukbd_enable;
363 Static kbd_disable_t ukbd_disable;
364 Static kbd_read_t ukbd_read;
365 Static kbd_check_t ukbd_check;
366 Static kbd_read_char_t ukbd_read_char;
367 Static kbd_check_char_t ukbd_check_char;
368 Static kbd_ioctl_t ukbd_ioctl;
369 Static kbd_lock_t ukbd_lock;
370 Static kbd_clear_state_t ukbd_clear_state;
371 Static kbd_get_state_t ukbd_get_state;
372 Static kbd_set_state_t ukbd_set_state;
373 Static kbd_poll_mode_t ukbd_poll;
375 keyboard_switch_t ukbdsw = {
397 KEYBOARD_DRIVER(ukbd, ukbdsw, ukbd_configure);
399 /* local functions */
400 Static int ukbd_enable_intr(keyboard_t *kbd, int on,
402 Static timeout_t ukbd_timeout;
404 Static int ukbd_getc(ukbd_state_t *state);
405 Static int probe_keyboard(struct usb_attach_arg *uaa, int flags);
406 Static int init_keyboard(ukbd_state_t *state, int *type,
408 Static void set_leds(ukbd_state_t *state, int leds);
409 Static int set_typematic(keyboard_t *kbd, int code);
410 #ifdef UKBD_EMULATE_ATSCANCODE
411 Static int keycode2scancode(int keycode, int shift, int up);
414 /* local variables */
416 /* the initial key map, accent map and fkey strings */
417 #ifdef UKBD_DFLT_KEYMAP
418 #define KBD_DFLT_KEYMAP
421 #include <dev/kbd/kbdtables.h>
423 /* structures for the default keyboard */
424 Static keyboard_t default_kbd;
425 Static ukbd_state_t default_kbd_state;
426 Static keymap_t default_keymap;
427 Static accentmap_t default_accentmap;
428 Static fkeytab_t default_fkeytab[NUM_FKEYS];
431 * The back door to the keyboard driver!
432 * This function is called by the console driver, via the kbdio module,
433 * to tickle keyboard drivers when the low-level console is being initialized.
434 * Almost nothing in the kernel has been initialied yet. Try to probe
435 * keyboards if possible.
436 * NOTE: because of the way the low-level conole is initialized, this routine
437 * may be called more than once!!
440 ukbd_configure(int flags)
447 struct usb_attach_arg *uaa;
450 device = devclass_get_device(ukbd_devclass, UKBD_DEFAULT);
453 uaa = (struct usb_attach_arg *)device_get_ivars(device);
457 /* probe the default keyboard */
458 arg[0] = (void *)uaa;
459 arg[1] = (void *)ukbd_intr;
461 if (ukbd_probe(UKBD_DEFAULT, arg, flags))
463 if (ukbd_init(UKBD_DEFAULT, &kbd, arg, flags))
466 /* return the number of found keyboards */
471 /* low-level functions */
473 /* detect a keyboard */
475 ukbd_probe(int unit, void *arg, int flags)
478 struct usb_attach_arg *uaa;
481 uaa = (struct usb_attach_arg *)data[0];
484 if (unit == UKBD_DEFAULT) {
485 if (KBD_IS_PROBED(&default_kbd))
488 if (probe_keyboard(uaa, flags))
493 /* reset and initialize the device */
495 ukbd_init(int unit, keyboard_t **kbdp, void *arg, int flags)
503 void **data = (void **)arg;
504 struct usb_attach_arg *uaa = (struct usb_attach_arg *)data[0];
507 if (unit == UKBD_DEFAULT) {
508 *kbdp = kbd = &default_kbd;
509 if (KBD_IS_INITIALIZED(kbd) && KBD_IS_CONFIGURED(kbd))
511 state = &default_kbd_state;
512 keymap = &default_keymap;
513 accmap = &default_accentmap;
514 fkeymap = default_fkeytab;
516 sizeof(default_fkeytab)/sizeof(default_fkeytab[0]);
517 } else if (*kbdp == NULL) {
518 *kbdp = kbd = malloc(sizeof(*kbd), M_DEVBUF, M_NOWAIT);
521 bzero(kbd, sizeof(*kbd));
522 state = malloc(sizeof(*state), M_DEVBUF, M_NOWAIT);
523 keymap = malloc(sizeof(key_map), M_DEVBUF, M_NOWAIT);
524 accmap = malloc(sizeof(accent_map), M_DEVBUF, M_NOWAIT);
525 fkeymap = malloc(sizeof(fkey_tab), M_DEVBUF, M_NOWAIT);
526 fkeymap_size = sizeof(fkey_tab)/sizeof(fkey_tab[0]);
527 if ((state == NULL) || (keymap == NULL) || (accmap == NULL)
528 || (fkeymap == NULL)) {
530 free(state, M_DEVBUF);
532 free(keymap, M_DEVBUF);
534 free(accmap, M_DEVBUF);
536 free(fkeymap, M_DEVBUF);
540 } else if (KBD_IS_INITIALIZED(*kbdp) && KBD_IS_CONFIGURED(*kbdp)) {
544 state = (ukbd_state_t *)kbd->kb_data;
545 keymap = kbd->kb_keymap;
546 accmap = kbd->kb_accentmap;
547 fkeymap = kbd->kb_fkeytab;
548 fkeymap_size = kbd->kb_fkeytab_size;
551 if (!KBD_IS_PROBED(kbd)) {
552 kbd_init_struct(kbd, DRIVER_NAME, KB_OTHER, unit, flags, 0, 0);
553 bzero(state, sizeof(*state));
554 bcopy(&key_map, keymap, sizeof(key_map));
555 bcopy(&accent_map, accmap, sizeof(accent_map));
556 bcopy(fkey_tab, fkeymap,
557 imin(fkeymap_size*sizeof(fkeymap[0]), sizeof(fkey_tab)));
558 kbd_set_maps(kbd, keymap, accmap, fkeymap, fkeymap_size);
559 kbd->kb_data = (void *)state;
561 if (probe_keyboard(uaa, flags))
564 KBD_FOUND_DEVICE(kbd);
565 ukbd_clear_state(kbd);
566 state->ks_mode = K_XLATE;
567 state->ks_iface = uaa->iface;
569 state->ks_ifstate = 0;
570 callout_handle_init(&state->ks_timeout_handle);
572 * FIXME: set the initial value for lock keys in ks_state
573 * according to the BIOS data?
577 if (!KBD_IS_INITIALIZED(kbd) && !(flags & KB_CONF_PROBE_ONLY)) {
578 if (KBD_HAS_DEVICE(kbd)
579 && init_keyboard((ukbd_state_t *)kbd->kb_data,
580 &kbd->kb_type, kbd->kb_flags))
582 ukbd_ioctl(kbd, KDSETLED, (caddr_t)&(state->ks_state));
585 if (!KBD_IS_CONFIGURED(kbd)) {
586 if (kbd_register(kbd) < 0)
588 if (ukbd_enable_intr(kbd, TRUE, (usbd_intr_t *)data[1]) == 0)
589 ukbd_timeout((void *)kbd);
590 KBD_CONFIG_DONE(kbd);
597 ukbd_enable_intr(keyboard_t *kbd, int on, usbd_intr_t *func)
599 ukbd_state_t *state = (ukbd_state_t *)kbd->kb_data;
603 /* Set up interrupt pipe. */
604 if (state->ks_ifstate & INTRENABLED)
607 state->ks_ifstate |= INTRENABLED;
608 err = usbd_open_pipe_intr(state->ks_iface, state->ks_ep_addr,
610 &state->ks_intrpipe, kbd,
612 sizeof(state->ks_ndata), func,
613 USBD_DEFAULT_INTERVAL);
617 /* Disable interrupts. */
618 usbd_abort_pipe(state->ks_intrpipe);
619 usbd_close_pipe(state->ks_intrpipe);
621 state->ks_ifstate &= ~INTRENABLED;
627 /* finish using this keyboard */
629 ukbd_term(keyboard_t *kbd)
637 state = (ukbd_state_t *)kbd->kb_data;
638 DPRINTF(("ukbd_term: ks_ifstate=0x%x\n", state->ks_ifstate));
640 untimeout(ukbd_timeout, (void *)kbd, state->ks_timeout_handle);
641 callout_handle_init(&state->ks_timeout_handle);
643 if (state->ks_ifstate & INTRENABLED)
644 ukbd_enable_intr(kbd, FALSE, NULL);
645 if (state->ks_ifstate & INTRENABLED) {
647 DPRINTF(("ukbd_term: INTRENABLED!\n"));
651 error = kbd_unregister(kbd);
652 DPRINTF(("ukbd_term: kbd_unregister() %d\n", error));
655 if (kbd != &default_kbd) {
656 free(kbd->kb_keymap, M_DEVBUF);
657 free(kbd->kb_accentmap, M_DEVBUF);
658 free(kbd->kb_fkeytab, M_DEVBUF);
659 free(state, M_DEVBUF);
669 /* keyboard interrupt routine */
672 ukbd_timeout(void *arg)
678 kbd = (keyboard_t *)arg;
679 state = (ukbd_state_t *)kbd->kb_data;
681 (*kbdsw[kbd->kb_index]->intr)(kbd, (void *)USBD_NORMAL_COMPLETION);
682 state->ks_timeout_handle = timeout(ukbd_timeout, arg, hz/40);
687 ukbd_interrupt(keyboard_t *kbd, void *arg)
689 usbd_status status = (usbd_status)arg;
691 struct ukbd_data *ud;
698 DPRINTFN(5, ("ukbd_intr: status=%d\n", status));
699 if (status == USBD_CANCELLED)
702 state = (ukbd_state_t *)kbd->kb_data;
703 ud = &state->ks_ndata;
705 if (status != USBD_NORMAL_COMPLETION) {
706 DPRINTF(("ukbd_intr: status=%d\n", status));
707 if (status == USBD_STALLED)
708 usbd_clear_endpoint_stall_async(state->ks_intrpipe);
712 if (ud->keycode[0] == KEY_ERROR)
713 return 0; /* ignore */
716 now = (u_long)tv.tv_sec*1000 + (u_long)tv.tv_usec/1000;
719 if (state->ks_inputs < INPUTBUFSIZE) { \
720 state->ks_input[state->ks_inputtail] = (c); \
721 ++state->ks_inputs; \
722 state->ks_inputtail = (state->ks_inputtail + 1)%INPUTBUFSIZE; \
726 omod = state->ks_odata.modifiers;
728 for (i = 0; i < NMOD; i++)
729 if (( mod & ukbd_mods[i].mask) !=
730 (omod & ukbd_mods[i].mask))
731 ADDKEY1(ukbd_mods[i].key |
732 (mod & ukbd_mods[i].mask
733 ? KEY_PRESS : KEY_RELEASE));
736 /* Check for released keys. */
737 for (i = 0; i < NKEYCODE; i++) {
738 key = state->ks_odata.keycode[i];
741 for (j = 0; j < NKEYCODE; j++) {
742 if (ud->keycode[j] == 0)
744 if (key == ud->keycode[j])
747 ADDKEY1(key | KEY_RELEASE);
752 /* Check for pressed keys. */
753 for (i = 0; i < NKEYCODE; i++) {
754 key = ud->keycode[i];
757 state->ks_ntime[i] = now + kbd->kb_delay1;
758 for (j = 0; j < NKEYCODE; j++) {
759 if (state->ks_odata.keycode[j] == 0)
761 if (key == state->ks_odata.keycode[j]) {
762 state->ks_ntime[i] = state->ks_otime[j];
763 if (state->ks_otime[j] > now)
765 state->ks_ntime[i] = now + kbd->kb_delay2;
769 ADDKEY1(key | KEY_PRESS);
774 state->ks_odata = *ud;
775 bcopy(state->ks_ntime, state->ks_otime, sizeof(state->ks_ntime));
776 if (state->ks_inputs <= 0)
780 for (i = state->ks_inputhead, j = 0; j < state->ks_inputs; ++j,
781 i = (i + 1)%INPUTBUFSIZE) {
782 c = state->ks_input[i];
783 DPRINTF(("0x%x (%d) %s\n", c, c,
784 (c & KEY_RELEASE) ? "released":"pressed"));
787 DPRINTF(("mod:0x%04x ", ud->modifiers));
788 for (i = 0; i < NKEYCODE; i++) {
790 DPRINTF(("%d ", ud->keycode[i]));
793 #endif /* USB_DEBUG */
795 if (state->ks_polling)
798 if (KBD_IS_ACTIVE(kbd) && KBD_IS_BUSY(kbd)) {
799 /* let the callback function to process the input */
800 (*kbd->kb_callback.kc_func)(kbd, KBDIO_KEYINPUT,
801 kbd->kb_callback.kc_arg);
803 /* read and discard the input; no one is waiting for it */
805 c = ukbd_read_char(kbd, FALSE);
806 } while (c != NOKEY);
813 ukbd_getc(ukbd_state_t *state)
818 if (state->ks_polling) {
819 DPRINTFN(1,("ukbd_getc: polling\n"));
821 while (state->ks_inputs <= 0)
822 usbd_dopoll(state->ks_iface);
826 if (state->ks_inputs <= 0) {
829 c = state->ks_input[state->ks_inputhead];
831 state->ks_inputhead = (state->ks_inputhead + 1)%INPUTBUFSIZE;
837 /* test the interface to the device */
839 ukbd_test_if(keyboard_t *kbd)
845 * Enable the access to the device; until this function is called,
846 * the client cannot read from the keyboard.
849 ukbd_enable(keyboard_t *kbd)
859 /* disallow the access to the device */
861 ukbd_disable(keyboard_t *kbd)
871 /* read one byte from the keyboard if it's allowed */
873 ukbd_read(keyboard_t *kbd, int wait)
877 #ifdef UKBD_EMULATE_ATSCANCODE
882 state = (ukbd_state_t *)kbd->kb_data;
883 #ifdef UKBD_EMULATE_ATSCANCODE
884 if (state->ks_buffered_char[0]) {
885 scancode = state->ks_buffered_char[0];
886 if (scancode & SCAN_PREFIX) {
887 state->ks_buffered_char[0] = scancode & ~SCAN_PREFIX;
888 return ((scancode & SCAN_PREFIX_E0) ? 0xe0 : 0xe1);
890 state->ks_buffered_char[0] = state->ks_buffered_char[1];
891 state->ks_buffered_char[1] = 0;
895 #endif /* UKBD_EMULATE_ATSCANCODE */
898 usbcode = ukbd_getc(state);
899 if (!KBD_IS_ACTIVE(kbd) || (usbcode == -1))
902 #ifdef UKBD_EMULATE_ATSCANCODE
903 keycode = ukbd_trtab[KEY_INDEX(usbcode)];
907 scancode = keycode2scancode(keycode, state->ks_ndata.modifiers,
908 usbcode & KEY_RELEASE);
909 if (scancode & SCAN_PREFIX) {
910 if (scancode & SCAN_PREFIX_CTL) {
911 state->ks_buffered_char[0] =
912 0x1d | (scancode & SCAN_RELEASE); /* Ctrl */
913 state->ks_buffered_char[1] = scancode & ~SCAN_PREFIX;
914 } else if (scancode & SCAN_PREFIX_SHIFT) {
915 state->ks_buffered_char[0] =
916 0x2a | (scancode & SCAN_RELEASE); /* Shift */
917 state->ks_buffered_char[1] =
918 scancode & ~SCAN_PREFIX_SHIFT;
920 state->ks_buffered_char[0] = scancode & ~SCAN_PREFIX;
921 state->ks_buffered_char[1] = 0;
923 return ((scancode & SCAN_PREFIX_E0) ? 0xe0 : 0xe1);
926 #else /* !UKBD_EMULATE_ATSCANCODE */
928 #endif /* UKBD_EMULATE_ATSCANCODE */
931 /* check if data is waiting */
933 ukbd_check(keyboard_t *kbd)
935 if (!KBD_IS_ACTIVE(kbd))
937 #ifdef UKBD_EMULATE_ATSCANCODE
938 if (((ukbd_state_t *)kbd->kb_data)->ks_buffered_char[0])
941 if (((ukbd_state_t *)kbd->kb_data)->ks_inputs > 0)
946 /* read char from the keyboard */
948 ukbd_read_char(keyboard_t *kbd, int wait)
954 #ifdef UKBD_EMULATE_ATSCANCODE
958 state = (ukbd_state_t *)kbd->kb_data;
960 /* do we have a composed char to return? */
961 if (!(state->ks_flags & COMPOSE) && (state->ks_composed_char > 0)) {
962 action = state->ks_composed_char;
963 state->ks_composed_char = 0;
964 if (action > UCHAR_MAX)
969 #ifdef UKBD_EMULATE_ATSCANCODE
970 /* do we have a pending raw scan code? */
971 if (state->ks_mode == K_RAW) {
972 if (state->ks_buffered_char[0]) {
973 scancode = state->ks_buffered_char[0];
974 if (scancode & SCAN_PREFIX) {
975 state->ks_buffered_char[0] =
976 scancode & ~SCAN_PREFIX;
977 return ((scancode & SCAN_PREFIX_E0) ? 0xe0 : 0xe1);
979 state->ks_buffered_char[0] =
980 state->ks_buffered_char[1];
981 state->ks_buffered_char[1] = 0;
986 #endif /* UKBD_EMULATE_ATSCANCODE */
988 /* see if there is something in the keyboard port */
990 usbcode = ukbd_getc(state);
995 #ifdef UKBD_EMULATE_ATSCANCODE
996 /* USB key index -> key code -> AT scan code */
997 keycode = ukbd_trtab[KEY_INDEX(usbcode)];
1001 /* return an AT scan code for the K_RAW mode */
1002 if (state->ks_mode == K_RAW) {
1003 scancode = keycode2scancode(keycode, state->ks_ndata.modifiers,
1004 usbcode & KEY_RELEASE);
1005 if (scancode & SCAN_PREFIX) {
1006 if (scancode & SCAN_PREFIX_CTL) {
1007 state->ks_buffered_char[0] =
1008 0x1d | (scancode & SCAN_RELEASE);
1009 state->ks_buffered_char[1] =
1010 scancode & ~SCAN_PREFIX;
1011 } else if (scancode & SCAN_PREFIX_SHIFT) {
1012 state->ks_buffered_char[0] =
1013 0x2a | (scancode & SCAN_RELEASE);
1014 state->ks_buffered_char[1] =
1015 scancode & ~SCAN_PREFIX_SHIFT;
1017 state->ks_buffered_char[0] =
1018 scancode & ~SCAN_PREFIX;
1019 state->ks_buffered_char[1] = 0;
1021 return ((scancode & SCAN_PREFIX_E0) ? 0xe0 : 0xe1);
1025 #else /* !UKBD_EMULATE_ATSCANCODE */
1026 /* return the byte as is for the K_RAW mode */
1027 if (state->ks_mode == K_RAW)
1030 /* USB key index -> key code */
1031 keycode = ukbd_trtab[KEY_INDEX(usbcode)];
1034 #endif /* UKBD_EMULATE_ATSCANCODE */
1037 case 0x38: /* left alt (compose key) */
1038 if (usbcode & KEY_RELEASE) {
1039 if (state->ks_flags & COMPOSE) {
1040 state->ks_flags &= ~COMPOSE;
1041 if (state->ks_composed_char > UCHAR_MAX)
1042 state->ks_composed_char = 0;
1045 if (!(state->ks_flags & COMPOSE)) {
1046 state->ks_flags |= COMPOSE;
1047 state->ks_composed_char = 0;
1051 /* XXX: I don't like these... */
1052 case 0x5c: /* print screen */
1053 if (state->ks_flags & ALTS)
1054 keycode = 0x54; /* sysrq */
1056 case 0x68: /* pause/break */
1057 if (state->ks_flags & CTLS)
1058 keycode = 0x6c; /* break */
1062 /* return the key code in the K_CODE mode */
1063 if (usbcode & KEY_RELEASE)
1064 keycode |= SCAN_RELEASE;
1065 if (state->ks_mode == K_CODE)
1068 /* compose a character code */
1069 if (state->ks_flags & COMPOSE) {
1071 /* key pressed, process it */
1072 case 0x47: case 0x48: case 0x49: /* keypad 7,8,9 */
1073 state->ks_composed_char *= 10;
1074 state->ks_composed_char += keycode - 0x40;
1075 if (state->ks_composed_char > UCHAR_MAX)
1078 case 0x4B: case 0x4C: case 0x4D: /* keypad 4,5,6 */
1079 state->ks_composed_char *= 10;
1080 state->ks_composed_char += keycode - 0x47;
1081 if (state->ks_composed_char > UCHAR_MAX)
1084 case 0x4F: case 0x50: case 0x51: /* keypad 1,2,3 */
1085 state->ks_composed_char *= 10;
1086 state->ks_composed_char += keycode - 0x4E;
1087 if (state->ks_composed_char > UCHAR_MAX)
1090 case 0x52: /* keypad 0 */
1091 state->ks_composed_char *= 10;
1092 if (state->ks_composed_char > UCHAR_MAX)
1096 /* key released, no interest here */
1097 case SCAN_RELEASE | 0x47:
1098 case SCAN_RELEASE | 0x48:
1099 case SCAN_RELEASE | 0x49: /* keypad 7,8,9 */
1100 case SCAN_RELEASE | 0x4B:
1101 case SCAN_RELEASE | 0x4C:
1102 case SCAN_RELEASE | 0x4D: /* keypad 4,5,6 */
1103 case SCAN_RELEASE | 0x4F:
1104 case SCAN_RELEASE | 0x50:
1105 case SCAN_RELEASE | 0x51: /* keypad 1,2,3 */
1106 case SCAN_RELEASE | 0x52: /* keypad 0 */
1109 case 0x38: /* left alt key */
1113 if (state->ks_composed_char > 0) {
1114 state->ks_flags &= ~COMPOSE;
1115 state->ks_composed_char = 0;
1122 /* keycode to key action */
1123 action = genkbd_keyaction(kbd, SCAN_CHAR(keycode),
1124 keycode & SCAN_RELEASE, &state->ks_state,
1125 &state->ks_accents);
1126 if (action == NOKEY)
1132 /* check if char is waiting */
1134 ukbd_check_char(keyboard_t *kbd)
1136 ukbd_state_t *state;
1138 if (!KBD_IS_ACTIVE(kbd))
1140 state = (ukbd_state_t *)kbd->kb_data;
1141 if (!(state->ks_flags & COMPOSE) && (state->ks_composed_char > 0))
1143 if (state->ks_inputs > 0)
1148 /* some useful control functions */
1150 ukbd_ioctl(keyboard_t *kbd, u_long cmd, caddr_t arg)
1152 /* trasnlate LED_XXX bits into the device specific bits */
1153 static u_char ledmap[8] = {
1154 0, 2, 1, 3, 4, 6, 5, 7,
1156 ukbd_state_t *state = kbd->kb_data;
1163 case KDGKBMODE: /* get keyboard mode */
1164 *(int *)arg = state->ks_mode;
1166 case KDSKBMODE: /* set keyboard mode */
1167 switch (*(int *)arg) {
1169 if (state->ks_mode != K_XLATE) {
1170 /* make lock key state and LED state match */
1171 state->ks_state &= ~LOCK_MASK;
1172 state->ks_state |= KBD_LED_VAL(kbd);
1177 if (state->ks_mode != *(int *)arg) {
1178 ukbd_clear_state(kbd);
1179 state->ks_mode = *(int *)arg;
1188 case KDGETLED: /* get keyboard LED */
1189 *(int *)arg = KBD_LED_VAL(kbd);
1191 case KDSETLED: /* set keyboard LED */
1192 /* NOTE: lock key state in ks_state won't be changed */
1193 if (*(int *)arg & ~LOCK_MASK) {
1198 /* replace CAPS LED with ALTGR LED for ALTGR keyboards */
1199 if (kbd->kb_keymap->n_keys > ALTGR_OFFSET) {
1205 if (KBD_HAS_DEVICE(kbd)) {
1206 set_leds(state, ledmap[i & LED_MASK]);
1207 /* XXX: error check? */
1209 KBD_LED_VAL(kbd) = *(int *)arg;
1212 case KDGKBSTATE: /* get lock key state */
1213 *(int *)arg = state->ks_state & LOCK_MASK;
1215 case KDSKBSTATE: /* set lock key state */
1216 if (*(int *)arg & ~LOCK_MASK) {
1220 state->ks_state &= ~LOCK_MASK;
1221 state->ks_state |= *(int *)arg;
1223 /* set LEDs and quit */
1224 return ukbd_ioctl(kbd, KDSETLED, arg);
1226 case KDSETREPEAT: /* set keyboard repeat rate (new interface) */
1228 if (!KBD_HAS_DEVICE(kbd))
1230 if (((int *)arg)[1] < 0)
1232 if (((int *)arg)[0] < 0)
1234 else if (((int *)arg)[0] == 0) /* fastest possible value */
1235 kbd->kb_delay1 = 200;
1237 kbd->kb_delay1 = ((int *)arg)[0];
1238 kbd->kb_delay2 = ((int *)arg)[1];
1241 case KDSETRAD: /* set keyboard repeat rate (old interface) */
1243 return set_typematic(kbd, *(int *)arg);
1245 case PIO_KEYMAP: /* set keyboard translation table */
1246 case PIO_KEYMAPENT: /* set keyboard translation table entry */
1247 case PIO_DEADKEYMAP: /* set accent key translation table */
1248 state->ks_accents = 0;
1252 return genkbd_commonioctl(kbd, cmd, arg);
1256 ukbddebug = *(int *)arg;
1265 /* lock the access to the keyboard */
1267 ukbd_lock(keyboard_t *kbd, int lock)
1273 /* clear the internal state of the keyboard */
1275 ukbd_clear_state(keyboard_t *kbd)
1277 ukbd_state_t *state;
1279 state = (ukbd_state_t *)kbd->kb_data;
1280 state->ks_flags = 0;
1281 state->ks_polling = 0;
1282 state->ks_state &= LOCK_MASK; /* preserve locking key state */
1283 state->ks_accents = 0;
1284 state->ks_composed_char = 0;
1285 #ifdef UKBD_EMULATE_ATSCANCODE
1286 state->ks_buffered_char[0] = 0;
1287 state->ks_buffered_char[1] = 0;
1289 bzero(&state->ks_ndata, sizeof(state->ks_ndata));
1290 bzero(&state->ks_odata, sizeof(state->ks_odata));
1291 bzero(&state->ks_ntime, sizeof(state->ks_ntime));
1292 bzero(&state->ks_otime, sizeof(state->ks_otime));
1295 /* save the internal state */
1297 ukbd_get_state(keyboard_t *kbd, void *buf, size_t len)
1300 return sizeof(ukbd_state_t);
1301 if (len < sizeof(ukbd_state_t))
1303 bcopy(kbd->kb_data, buf, sizeof(ukbd_state_t));
1307 /* set the internal state */
1309 ukbd_set_state(keyboard_t *kbd, void *buf, size_t len)
1311 if (len < sizeof(ukbd_state_t))
1313 bcopy(buf, kbd->kb_data, sizeof(ukbd_state_t));
1318 ukbd_poll(keyboard_t *kbd, int on)
1320 ukbd_state_t *state;
1321 usbd_device_handle dev;
1324 state = (ukbd_state_t *)kbd->kb_data;
1325 usbd_interface2device_handle(state->ks_iface, &dev);
1329 if (state->ks_polling == 0)
1330 usbd_set_polling(dev, on);
1331 ++state->ks_polling;
1333 --state->ks_polling;
1334 if (state->ks_polling == 0)
1335 usbd_set_polling(dev, on);
1341 /* local functions */
1344 probe_keyboard(struct usb_attach_arg *uaa, int flags)
1346 usb_interface_descriptor_t *id;
1348 if (!uaa->iface) /* we attach to ifaces only */
1351 /* Check that this is a keyboard that speaks the boot protocol. */
1352 id = usbd_get_interface_descriptor(uaa->iface);
1354 && id->bInterfaceClass == UICLASS_HID
1355 && id->bInterfaceSubClass == UISUBCLASS_BOOT
1356 && id->bInterfaceProtocol == UPROTO_BOOT_KEYBOARD)
1357 return 0; /* found it */
1363 init_keyboard(ukbd_state_t *state, int *type, int flags)
1365 usb_endpoint_descriptor_t *ed;
1370 state->ks_ifstate |= DISCONNECTED;
1372 ed = usbd_interface2endpoint_descriptor(state->ks_iface, 0);
1374 printf("ukbd: could not read endpoint descriptor\n");
1378 DPRINTFN(10,("ukbd:init_keyboard: \
1379 bLength=%d bDescriptorType=%d bEndpointAddress=%d-%s bmAttributes=%d wMaxPacketSize=%d bInterval=%d\n",
1380 ed->bLength, ed->bDescriptorType,
1381 UE_GET_ADDR(ed->bEndpointAddress),
1382 UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN ? "in":"out",
1383 UE_GET_XFERTYPE(ed->bmAttributes),
1384 UGETW(ed->wMaxPacketSize), ed->bInterval));
1386 if (UE_GET_DIR(ed->bEndpointAddress) != UE_DIR_IN ||
1387 UE_GET_XFERTYPE(ed->bmAttributes) != UE_INTERRUPT) {
1388 printf("ukbd: unexpected endpoint\n");
1392 if ((usbd_get_quirks(state->ks_uaa->device)->uq_flags & UQ_NO_SET_PROTO) == 0) {
1393 err = usbd_set_protocol(state->ks_iface, 0);
1394 DPRINTFN(5, ("ukbd:init_keyboard: protocol set\n"));
1396 printf("ukbd: set protocol failed\n");
1400 /* Ignore if SETIDLE fails since it is not crucial. */
1401 usbd_set_idle(state->ks_iface, 0, 0);
1403 state->ks_ep_addr = ed->bEndpointAddress;
1404 state->ks_ifstate &= ~DISCONNECTED;
1410 set_leds(ukbd_state_t *state, int leds)
1412 u_int8_t res = leds;
1414 DPRINTF(("ukbd:set_leds: state=%p leds=%d\n", state, leds));
1416 usbd_set_report_async(state->ks_iface, UHID_OUTPUT_REPORT, 0, &res, 1);
1420 set_typematic(keyboard_t *kbd, int code)
1422 static int delays[] = { 250, 500, 750, 1000 };
1423 static int rates[] = { 34, 38, 42, 46, 50, 55, 59, 63,
1424 68, 76, 84, 92, 100, 110, 118, 126,
1425 136, 152, 168, 184, 200, 220, 236, 252,
1426 272, 304, 336, 368, 400, 440, 472, 504 };
1430 kbd->kb_delay1 = delays[(code >> 5) & 3];
1431 kbd->kb_delay2 = rates[code & 0x1f];
1435 #ifdef UKBD_EMULATE_ATSCANCODE
1437 keycode2scancode(int keycode, int shift, int up)
1439 static int scan[] = {
1441 0x37 | SCAN_PREFIX_SHIFT, /* PrintScreen */
1442 0x38, 0x47, 0x48, 0x49, 0x4b, 0x4d, 0x4f,
1443 0x50, 0x51, 0x52, 0x53,
1444 0x46, /* XXX Pause/Break */
1450 if ((keycode >= 89) && (keycode < 89 + sizeof(scan)/sizeof(scan[0])))
1451 scancode = scan[keycode - 89] | SCAN_PREFIX_E0;
1453 if ((keycode == 104) && !(shift & (MOD_CONTROL_L | MOD_CONTROL_R)))
1454 scancode = 0x45 | SCAN_PREFIX_E1 | SCAN_PREFIX_CTL;
1455 if (shift & (MOD_SHIFT_L | MOD_SHIFT_R))
1456 scancode &= ~SCAN_PREFIX_SHIFT;
1457 return (scancode | (up ? SCAN_RELEASE : SCAN_PRESS));
1459 #endif /* UKBD_EMULATE_ATSCANCODE */
1462 ukbd_driver_load(module_t mod, int what, void *arg)
1466 kbd_add_driver(&ukbd_kbd_driver);
1469 kbd_delete_driver(&ukbd_kbd_driver);
1472 return usbd_driver_load(mod, what, 0);