2 * Copyright (c) 1998 The NetBSD Foundation, Inc.
5 * This code is derived from software contributed to The NetBSD Foundation
6 * by Lennart Augustsson (lennart@augustsson.net) at
7 * Carlstedt Research & Technology.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. All advertising materials mentioning features or use of this software
18 * must display the following acknowledgement:
19 * This product includes software developed by the NetBSD
20 * Foundation, Inc. and its contributors.
21 * 4. Neither the name of The NetBSD Foundation nor the names of its
22 * contributors may be used to endorse or promote products derived
23 * from this software without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 * POSSIBILITY OF SUCH DAMAGE.
37 * Modifications for SUN TYPE 6 USB Keyboard by
38 * Jörg Peter Schley (jps@scxnet.de)
41 #include <sys/cdefs.h>
42 __FBSDID("$FreeBSD$");
45 * HID spec: http://www.usb.org/developers/devclass_docs/HID1_11.pdf
51 #include <sys/param.h>
52 #include <sys/systm.h>
53 #include <sys/kernel.h>
54 #include <sys/ioccom.h>
55 #include <sys/module.h>
58 #if __FreeBSD_version >= 500000
59 #include <sys/limits.h>
61 #include <machine/limits.h>
63 #if __FreeBSD_version >= 500014
64 #include <sys/selinfo.h>
66 #include <sys/select.h>
68 #include <sys/sysctl.h>
71 #include <dev/usb/usb.h>
72 #include <dev/usb/usbhid.h>
73 #include <dev/usb/usbdi.h>
74 #include <dev/usb/usbdi_util.h>
76 #include <dev/usb/usb_quirks.h>
77 #include <dev/usb/hid.h>
80 #include <dev/kbd/kbdreg.h>
82 #define UKBD_EMULATE_ATSCANCODE 1
84 #define DRIVER_NAME "ukbd"
86 #define delay(d) DELAY(d)
89 #define DPRINTF(x) if (ukbddebug) logprintf x
90 #define DPRINTFN(n,x) if (ukbddebug>(n)) logprintf x
92 SYSCTL_NODE(_hw_usb, OID_AUTO, ukbd, CTLFLAG_RW, 0, "USB ukbd");
93 SYSCTL_INT(_hw_usb_ukbd, OID_AUTO, debug, CTLFLAG_RW,
94 &ukbddebug, 0, "ukbd debug level");
100 #define UPROTO_BOOT_KEYBOARD 1
106 #define MOD_CONTROL_L 0x01
107 #define MOD_CONTROL_R 0x10
108 #define MOD_SHIFT_L 0x02
109 #define MOD_SHIFT_R 0x20
110 #define MOD_ALT_L 0x04
111 #define MOD_ALT_R 0x40
112 #define MOD_WIN_L 0x08
113 #define MOD_WIN_R 0x80
115 u_int8_t keycode[NKEYCODE];
118 #define MAXKEYS (NMOD+2*NKEYCODE)
120 typedef struct ukbd_softc {
121 device_t sc_dev; /* base device */
124 #define UKBD_CHUNK 128 /* chunk size for read */
125 #define UKBD_BSIZE 1020 /* buffer size */
127 typedef void usbd_intr_t(usbd_xfer_handle, usbd_private_handle, usbd_status);
128 typedef void usbd_disco_t(void *);
130 Static int ukbd_resume(device_t self);
131 Static usbd_intr_t ukbd_intr;
132 Static int ukbd_driver_load(module_t mod, int what, void *arg);
134 USB_DECLARE_DRIVER_INIT(ukbd, DEVMETHOD(device_resume, ukbd_resume));
138 USB_MATCH_START(ukbd, uaa);
140 keyboard_switch_t *sw;
142 int unit = device_get_unit(self);
144 sw = kbd_get_switch(DRIVER_NAME);
146 return (UMATCH_NONE);
148 arg[0] = (void *)uaa;
149 arg[1] = (void *)ukbd_intr;
150 if ((*sw->probe)(unit, (void *)arg, 0))
151 return (UMATCH_NONE);
153 return (UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO);
158 USB_ATTACH_START(ukbd, sc, uaa);
159 usbd_interface_handle iface = uaa->iface;
160 usb_interface_descriptor_t *id;
163 keyboard_switch_t *sw;
166 int unit = device_get_unit(self);
168 sw = kbd_get_switch(DRIVER_NAME);
170 USB_ATTACH_ERROR_RETURN;
172 id = usbd_get_interface_descriptor(iface);
173 usbd_devinfo(uaa->device, USBD_SHOW_INTERFACE_CLASS, devinfo);
176 arg[0] = (void *)uaa;
177 arg[1] = (void *)ukbd_intr;
179 if ((*sw->probe)(unit, (void *)arg, 0))
180 USB_ATTACH_ERROR_RETURN;
181 if ((*sw->init)(unit, &kbd, (void *)arg, 0))
182 USB_ATTACH_ERROR_RETURN;
185 #ifdef KBD_INSTALL_CDEV
187 USB_ATTACH_ERROR_RETURN;
190 (*sw->diag)(kbd, bootverbose);
192 USB_ATTACH_SUCCESS_RETURN;
196 ukbd_detach(device_t self)
201 kbd = kbd_get_keyboard(kbd_find_keyboard(DRIVER_NAME,
202 device_get_unit(self)));
204 DPRINTF(("%s: keyboard not attached!?\n", USBDEVNAME(self)));
207 (*kbdsw[kbd->kb_index]->disable)(kbd);
209 #ifdef KBD_INSTALL_CDEV
210 error = kbd_detach(kbd);
214 error = (*kbdsw[kbd->kb_index]->term)(kbd);
218 DPRINTF(("%s: disconnected\n", USBDEVNAME(self)));
224 ukbd_resume(device_t self)
228 kbd = kbd_get_keyboard(kbd_find_keyboard(DRIVER_NAME,
229 device_get_unit(self)));
231 (*kbdsw[kbd->kb_index]->clear_state)(kbd);
236 ukbd_intr(usbd_xfer_handle xfer, usbd_private_handle addr, usbd_status status)
238 keyboard_t *kbd = (keyboard_t *)addr;
240 (*kbdsw[kbd->kb_index]->intr)(kbd, (void *)status);
243 DRIVER_MODULE(ukbd, uhub, ukbd_driver, ukbd_devclass, ukbd_driver_load, 0);
246 #define UKBD_DEFAULT 0
248 #define KEY_ERROR 0x01
251 #define KEY_RELEASE 0x400
252 #define KEY_INDEX(c) ((c) & ~KEY_RELEASE)
255 #define SCAN_RELEASE 0x80
256 #define SCAN_PREFIX_E0 0x100
257 #define SCAN_PREFIX_E1 0x200
258 #define SCAN_PREFIX_CTL 0x400
259 #define SCAN_PREFIX_SHIFT 0x800
260 #define SCAN_PREFIX (SCAN_PREFIX_E0 | SCAN_PREFIX_E1 | SCAN_PREFIX_CTL \
262 #define SCAN_CHAR(c) ((c) & 0x7f)
267 } ukbd_mods[NMOD] = {
268 { MOD_CONTROL_L, 0xe0 },
269 { MOD_CONTROL_R, 0xe4 },
270 { MOD_SHIFT_L, 0xe1 },
271 { MOD_SHIFT_R, 0xe5 },
278 #define NN 0 /* no translation */
280 * Translate USB keycodes to AT keyboard scancodes.
283 * FIXME: Mac USB keyboard generates:
284 * 0x53: keypad NumLock/Clear
291 Static u_int8_t ukbd_trtab[256] = {
292 0, 0, 0, 0, 30, 48, 46, 32, /* 00 - 07 */
293 18, 33, 34, 35, 23, 36, 37, 38, /* 08 - 0F */
294 50, 49, 24, 25, 16, 19, 31, 20, /* 10 - 17 */
295 22, 47, 17, 45, 21, 44, 2, 3, /* 18 - 1F */
296 4, 5, 6, 7, 8, 9, 10, 11, /* 20 - 27 */
297 28, 1, 14, 15, 57, 12, 13, 26, /* 28 - 2F */
298 27, 43, 43, 39, 40, 41, 51, 52, /* 30 - 37 */
299 53, 58, 59, 60, 61, 62, 63, 64, /* 38 - 3F */
300 65, 66, 67, 68, 87, 88, 92, 70, /* 40 - 47 */
301 104, 102, 94, 96, 103, 99, 101, 98, /* 48 - 4F */
302 97, 100, 95, 69, 91, 55, 74, 78, /* 50 - 57 */
303 89, 79, 80, 81, 75, 76, 77, 71, /* 58 - 5F */
304 72, 73, 82, 83, 86, 107, 122, NN, /* 60 - 67 */
305 NN, NN, NN, NN, NN, NN, NN, NN, /* 68 - 6F */
306 NN, NN, NN, NN, 115, 108, 111, 113, /* 70 - 77 */
307 109, 110, 112, 118, 114, 116, 117, 119, /* 78 - 7F */
308 121, 120, NN, NN, NN, NN, NN, 115, /* 80 - 87 */
309 112, 125, 121, 123, NN, NN, NN, NN, /* 88 - 8F */
310 NN, NN, NN, NN, NN, NN, NN, NN, /* 90 - 97 */
311 NN, NN, NN, NN, NN, NN, NN, NN, /* 98 - 9F */
312 NN, NN, NN, NN, NN, NN, NN, NN, /* A0 - A7 */
313 NN, NN, NN, NN, NN, NN, NN, NN, /* A8 - AF */
314 NN, NN, NN, NN, NN, NN, NN, NN, /* B0 - B7 */
315 NN, NN, NN, NN, NN, NN, NN, NN, /* B8 - BF */
316 NN, NN, NN, NN, NN, NN, NN, NN, /* C0 - C7 */
317 NN, NN, NN, NN, NN, NN, NN, NN, /* C8 - CF */
318 NN, NN, NN, NN, NN, NN, NN, NN, /* D0 - D7 */
319 NN, NN, NN, NN, NN, NN, NN, NN, /* D8 - DF */
320 29, 42, 56, 105, 90, 54, 93, 106, /* E0 - E7 */
321 NN, NN, NN, NN, NN, NN, NN, NN, /* E8 - EF */
322 NN, NN, NN, NN, NN, NN, NN, NN, /* F0 - F7 */
323 NN, NN, NN, NN, NN, NN, NN, NN, /* F8 - FF */
326 typedef struct ukbd_state {
327 usbd_interface_handle ks_iface; /* interface */
328 usbd_pipe_handle ks_intrpipe; /* interrupt pipe */
329 struct usb_attach_arg *ks_uaa;
332 struct ukbd_data ks_ndata;
333 struct ukbd_data ks_odata;
334 u_long ks_ntime[NKEYCODE];
335 u_long ks_otime[NKEYCODE];
337 #define INPUTBUFSIZE (NMOD + 2*NKEYCODE)
338 u_int ks_input[INPUTBUFSIZE]; /* input buffer */
344 #define INTRENABLED (1 << 0)
345 #define DISCONNECTED (1 << 1)
347 usb_callout_t ks_timeout_handle;
349 int ks_mode; /* input mode (K_XLATE,K_RAW,K_CODE) */
350 int ks_flags; /* flags */
351 #define COMPOSE (1 << 0)
353 int ks_state; /* shift/lock key state */
354 int ks_accents; /* accent key index (> 0) */
355 u_int ks_composed_char; /* composed char code (> 0) */
356 #ifdef UKBD_EMULATE_ATSCANCODE
357 u_int ks_buffered_char[2];
361 /* keyboard driver declaration */
362 Static int ukbd_configure(int flags);
363 Static kbd_probe_t ukbd_probe;
364 Static kbd_init_t ukbd_init;
365 Static kbd_term_t ukbd_term;
366 Static kbd_intr_t ukbd_interrupt;
367 Static kbd_test_if_t ukbd_test_if;
368 Static kbd_enable_t ukbd_enable;
369 Static kbd_disable_t ukbd_disable;
370 Static kbd_read_t ukbd_read;
371 Static kbd_check_t ukbd_check;
372 Static kbd_read_char_t ukbd_read_char;
373 Static kbd_check_char_t ukbd_check_char;
374 Static kbd_ioctl_t ukbd_ioctl;
375 Static kbd_lock_t ukbd_lock;
376 Static kbd_clear_state_t ukbd_clear_state;
377 Static kbd_get_state_t ukbd_get_state;
378 Static kbd_set_state_t ukbd_set_state;
379 Static kbd_poll_mode_t ukbd_poll;
381 keyboard_switch_t ukbdsw = {
403 KEYBOARD_DRIVER(ukbd, ukbdsw, ukbd_configure);
405 /* local functions */
406 Static int ukbd_enable_intr(keyboard_t *kbd, int on,
408 Static void ukbd_timeout(void *arg);
410 Static int ukbd_getc(ukbd_state_t *state);
411 Static int probe_keyboard(struct usb_attach_arg *uaa, int flags);
412 Static int init_keyboard(ukbd_state_t *state, int *type,
414 Static void set_leds(ukbd_state_t *state, int leds);
415 Static int set_typematic(keyboard_t *kbd, int code);
416 #ifdef UKBD_EMULATE_ATSCANCODE
417 Static int keycode2scancode(int keycode, int shift, int up);
420 /* local variables */
422 /* the initial key map, accent map and fkey strings */
423 #ifdef UKBD_DFLT_KEYMAP
424 #define KBD_DFLT_KEYMAP
427 #include <dev/kbd/kbdtables.h>
429 /* structures for the default keyboard */
430 Static keyboard_t default_kbd;
431 Static ukbd_state_t default_kbd_state;
432 Static keymap_t default_keymap;
433 Static accentmap_t default_accentmap;
434 Static fkeytab_t default_fkeytab[NUM_FKEYS];
437 * The back door to the keyboard driver!
438 * This function is called by the console driver, via the kbdio module,
439 * to tickle keyboard drivers when the low-level console is being initialized.
440 * Almost nothing in the kernel has been initialied yet. Try to probe
441 * keyboards if possible.
442 * NOTE: because of the way the low-level conole is initialized, this routine
443 * may be called more than once!!
446 ukbd_configure(int flags)
453 struct usb_attach_arg *uaa;
456 device = devclass_get_device(ukbd_devclass, UKBD_DEFAULT);
459 uaa = (struct usb_attach_arg *)device_get_ivars(device);
463 /* probe the default keyboard */
464 arg[0] = (void *)uaa;
465 arg[1] = (void *)ukbd_intr;
467 if (ukbd_probe(UKBD_DEFAULT, arg, flags))
469 if (ukbd_init(UKBD_DEFAULT, &kbd, arg, flags))
472 /* return the number of found keyboards */
477 /* low-level functions */
479 /* detect a keyboard */
481 ukbd_probe(int unit, void *arg, int flags)
484 struct usb_attach_arg *uaa;
487 uaa = (struct usb_attach_arg *)data[0];
490 if (unit == UKBD_DEFAULT) {
491 if (KBD_IS_PROBED(&default_kbd))
494 if (probe_keyboard(uaa, flags))
499 /* reset and initialize the device */
501 ukbd_init(int unit, keyboard_t **kbdp, void *arg, int flags)
509 void **data = (void **)arg;
510 struct usb_attach_arg *uaa = (struct usb_attach_arg *)data[0];
513 if (unit == UKBD_DEFAULT) {
514 *kbdp = kbd = &default_kbd;
515 if (KBD_IS_INITIALIZED(kbd) && KBD_IS_CONFIGURED(kbd))
517 state = &default_kbd_state;
518 keymap = &default_keymap;
519 accmap = &default_accentmap;
520 fkeymap = default_fkeytab;
522 sizeof(default_fkeytab)/sizeof(default_fkeytab[0]);
523 } else if (*kbdp == NULL) {
524 *kbdp = kbd = malloc(sizeof(*kbd), M_DEVBUF, M_NOWAIT);
527 bzero(kbd, sizeof(*kbd));
528 state = malloc(sizeof(*state), M_DEVBUF, M_NOWAIT);
529 keymap = malloc(sizeof(key_map), M_DEVBUF, M_NOWAIT);
530 accmap = malloc(sizeof(accent_map), M_DEVBUF, M_NOWAIT);
531 fkeymap = malloc(sizeof(fkey_tab), M_DEVBUF, M_NOWAIT);
532 fkeymap_size = sizeof(fkey_tab)/sizeof(fkey_tab[0]);
533 if ((state == NULL) || (keymap == NULL) || (accmap == NULL)
534 || (fkeymap == NULL)) {
536 free(state, M_DEVBUF);
538 free(keymap, M_DEVBUF);
540 free(accmap, M_DEVBUF);
542 free(fkeymap, M_DEVBUF);
546 } else if (KBD_IS_INITIALIZED(*kbdp) && KBD_IS_CONFIGURED(*kbdp)) {
550 state = (ukbd_state_t *)kbd->kb_data;
551 keymap = kbd->kb_keymap;
552 accmap = kbd->kb_accentmap;
553 fkeymap = kbd->kb_fkeytab;
554 fkeymap_size = kbd->kb_fkeytab_size;
557 if (!KBD_IS_PROBED(kbd)) {
558 kbd_init_struct(kbd, DRIVER_NAME, KB_OTHER, unit, flags, 0, 0);
559 bzero(state, sizeof(*state));
560 bcopy(&key_map, keymap, sizeof(key_map));
561 bcopy(&accent_map, accmap, sizeof(accent_map));
562 bcopy(fkey_tab, fkeymap,
563 imin(fkeymap_size*sizeof(fkeymap[0]), sizeof(fkey_tab)));
564 kbd_set_maps(kbd, keymap, accmap, fkeymap, fkeymap_size);
565 kbd->kb_data = (void *)state;
567 if (probe_keyboard(uaa, flags))
570 KBD_FOUND_DEVICE(kbd);
571 ukbd_clear_state(kbd);
572 state->ks_mode = K_XLATE;
573 state->ks_iface = uaa->iface;
575 state->ks_ifstate = 0;
576 usb_callout_init(state->ks_timeout_handle);
578 * FIXME: set the initial value for lock keys in ks_state
579 * according to the BIOS data?
583 if (!KBD_IS_INITIALIZED(kbd) && !(flags & KB_CONF_PROBE_ONLY)) {
584 if (KBD_HAS_DEVICE(kbd)
585 && init_keyboard((ukbd_state_t *)kbd->kb_data,
586 &kbd->kb_type, kbd->kb_flags))
588 ukbd_ioctl(kbd, KDSETLED, (caddr_t)&(state->ks_state));
591 if (!KBD_IS_CONFIGURED(kbd)) {
592 if (kbd_register(kbd) < 0)
594 if (ukbd_enable_intr(kbd, TRUE, (usbd_intr_t *)data[1]) == 0)
595 ukbd_timeout((void *)kbd);
596 KBD_CONFIG_DONE(kbd);
603 ukbd_enable_intr(keyboard_t *kbd, int on, usbd_intr_t *func)
605 ukbd_state_t *state = (ukbd_state_t *)kbd->kb_data;
609 /* Set up interrupt pipe. */
610 if (state->ks_ifstate & INTRENABLED)
613 state->ks_ifstate |= INTRENABLED;
614 err = usbd_open_pipe_intr(state->ks_iface, state->ks_ep_addr,
616 &state->ks_intrpipe, kbd,
618 sizeof(state->ks_ndata), func,
619 USBD_DEFAULT_INTERVAL);
623 /* Disable interrupts. */
624 usbd_abort_pipe(state->ks_intrpipe);
625 usbd_close_pipe(state->ks_intrpipe);
627 state->ks_ifstate &= ~INTRENABLED;
633 /* finish using this keyboard */
635 ukbd_term(keyboard_t *kbd)
643 state = (ukbd_state_t *)kbd->kb_data;
644 DPRINTF(("ukbd_term: ks_ifstate=0x%x\n", state->ks_ifstate));
646 usb_uncallout(state->ks_timeout_handle, ukbd_timeout, kbd);
648 if (state->ks_ifstate & INTRENABLED)
649 ukbd_enable_intr(kbd, FALSE, NULL);
650 if (state->ks_ifstate & INTRENABLED) {
652 DPRINTF(("ukbd_term: INTRENABLED!\n"));
656 error = kbd_unregister(kbd);
657 DPRINTF(("ukbd_term: kbd_unregister() %d\n", error));
660 if (kbd != &default_kbd) {
661 free(kbd->kb_keymap, M_DEVBUF);
662 free(kbd->kb_accentmap, M_DEVBUF);
663 free(kbd->kb_fkeytab, M_DEVBUF);
664 free(state, M_DEVBUF);
674 /* keyboard interrupt routine */
677 ukbd_timeout(void *arg)
683 kbd = (keyboard_t *)arg;
684 state = (ukbd_state_t *)kbd->kb_data;
686 (*kbdsw[kbd->kb_index]->intr)(kbd, (void *)USBD_NORMAL_COMPLETION);
687 usb_callout(state->ks_timeout_handle, hz / 40, ukbd_timeout, arg);
692 ukbd_interrupt(keyboard_t *kbd, void *arg)
694 usbd_status status = (usbd_status)arg;
696 struct ukbd_data *ud;
703 DPRINTFN(5, ("ukbd_intr: status=%d\n", status));
704 if (status == USBD_CANCELLED)
707 state = (ukbd_state_t *)kbd->kb_data;
708 ud = &state->ks_ndata;
710 if (status != USBD_NORMAL_COMPLETION) {
711 DPRINTF(("ukbd_intr: status=%d\n", status));
712 if (status == USBD_STALLED)
713 usbd_clear_endpoint_stall_async(state->ks_intrpipe);
717 if (ud->keycode[0] == KEY_ERROR)
718 return 0; /* ignore */
721 now = (u_long)tv.tv_sec*1000 + (u_long)tv.tv_usec/1000;
724 if (state->ks_inputs < INPUTBUFSIZE) { \
725 state->ks_input[state->ks_inputtail] = (c); \
726 ++state->ks_inputs; \
727 state->ks_inputtail = (state->ks_inputtail + 1)%INPUTBUFSIZE; \
731 omod = state->ks_odata.modifiers;
733 for (i = 0; i < NMOD; i++)
734 if (( mod & ukbd_mods[i].mask) !=
735 (omod & ukbd_mods[i].mask))
736 ADDKEY1(ukbd_mods[i].key |
737 (mod & ukbd_mods[i].mask
738 ? KEY_PRESS : KEY_RELEASE));
741 /* Check for released keys. */
742 for (i = 0; i < NKEYCODE; i++) {
743 key = state->ks_odata.keycode[i];
746 for (j = 0; j < NKEYCODE; j++) {
747 if (ud->keycode[j] == 0)
749 if (key == ud->keycode[j])
752 ADDKEY1(key | KEY_RELEASE);
757 /* Check for pressed keys. */
758 for (i = 0; i < NKEYCODE; i++) {
759 key = ud->keycode[i];
762 state->ks_ntime[i] = now + kbd->kb_delay1;
763 for (j = 0; j < NKEYCODE; j++) {
764 if (state->ks_odata.keycode[j] == 0)
766 if (key == state->ks_odata.keycode[j]) {
767 state->ks_ntime[i] = state->ks_otime[j];
768 if (state->ks_otime[j] > now)
770 state->ks_ntime[i] = now + kbd->kb_delay2;
774 ADDKEY1(key | KEY_PRESS);
779 state->ks_odata = *ud;
780 bcopy(state->ks_ntime, state->ks_otime, sizeof(state->ks_ntime));
781 if (state->ks_inputs <= 0)
785 for (i = state->ks_inputhead, j = 0; j < state->ks_inputs; ++j,
786 i = (i + 1)%INPUTBUFSIZE) {
787 c = state->ks_input[i];
788 DPRINTF(("0x%x (%d) %s\n", c, c,
789 (c & KEY_RELEASE) ? "released":"pressed"));
792 DPRINTF(("mod:0x%04x ", ud->modifiers));
793 for (i = 0; i < NKEYCODE; i++) {
795 DPRINTF(("%d ", ud->keycode[i]));
798 #endif /* USB_DEBUG */
800 if (state->ks_polling)
803 if (KBD_IS_ACTIVE(kbd) && KBD_IS_BUSY(kbd)) {
804 /* let the callback function to process the input */
805 (*kbd->kb_callback.kc_func)(kbd, KBDIO_KEYINPUT,
806 kbd->kb_callback.kc_arg);
808 /* read and discard the input; no one is waiting for it */
810 c = ukbd_read_char(kbd, FALSE);
811 } while (c != NOKEY);
818 ukbd_getc(ukbd_state_t *state)
823 if (state->ks_polling) {
824 DPRINTFN(1,("ukbd_getc: polling\n"));
826 while (state->ks_inputs <= 0)
827 usbd_dopoll(state->ks_iface);
831 if (state->ks_inputs <= 0) {
834 c = state->ks_input[state->ks_inputhead];
836 state->ks_inputhead = (state->ks_inputhead + 1)%INPUTBUFSIZE;
842 /* test the interface to the device */
844 ukbd_test_if(keyboard_t *kbd)
850 * Enable the access to the device; until this function is called,
851 * the client cannot read from the keyboard.
854 ukbd_enable(keyboard_t *kbd)
864 /* disallow the access to the device */
866 ukbd_disable(keyboard_t *kbd)
876 /* read one byte from the keyboard if it's allowed */
878 ukbd_read(keyboard_t *kbd, int wait)
882 #ifdef UKBD_EMULATE_ATSCANCODE
887 state = (ukbd_state_t *)kbd->kb_data;
888 #ifdef UKBD_EMULATE_ATSCANCODE
889 if (state->ks_buffered_char[0]) {
890 scancode = state->ks_buffered_char[0];
891 if (scancode & SCAN_PREFIX) {
892 state->ks_buffered_char[0] = scancode & ~SCAN_PREFIX;
893 return ((scancode & SCAN_PREFIX_E0) ? 0xe0 : 0xe1);
895 state->ks_buffered_char[0] = state->ks_buffered_char[1];
896 state->ks_buffered_char[1] = 0;
900 #endif /* UKBD_EMULATE_ATSCANCODE */
903 usbcode = ukbd_getc(state);
904 if (!KBD_IS_ACTIVE(kbd) || (usbcode == -1))
907 #ifdef UKBD_EMULATE_ATSCANCODE
908 keycode = ukbd_trtab[KEY_INDEX(usbcode)];
912 scancode = keycode2scancode(keycode, state->ks_ndata.modifiers,
913 usbcode & KEY_RELEASE);
914 if (scancode & SCAN_PREFIX) {
915 if (scancode & SCAN_PREFIX_CTL) {
916 state->ks_buffered_char[0] =
917 0x1d | (scancode & SCAN_RELEASE); /* Ctrl */
918 state->ks_buffered_char[1] = scancode & ~SCAN_PREFIX;
919 } else if (scancode & SCAN_PREFIX_SHIFT) {
920 state->ks_buffered_char[0] =
921 0x2a | (scancode & SCAN_RELEASE); /* Shift */
922 state->ks_buffered_char[1] =
923 scancode & ~SCAN_PREFIX_SHIFT;
925 state->ks_buffered_char[0] = scancode & ~SCAN_PREFIX;
926 state->ks_buffered_char[1] = 0;
928 return ((scancode & SCAN_PREFIX_E0) ? 0xe0 : 0xe1);
931 #else /* !UKBD_EMULATE_ATSCANCODE */
933 #endif /* UKBD_EMULATE_ATSCANCODE */
936 /* check if data is waiting */
938 ukbd_check(keyboard_t *kbd)
940 if (!KBD_IS_ACTIVE(kbd))
942 #ifdef UKBD_EMULATE_ATSCANCODE
943 if (((ukbd_state_t *)kbd->kb_data)->ks_buffered_char[0])
946 if (((ukbd_state_t *)kbd->kb_data)->ks_inputs > 0)
951 /* read char from the keyboard */
953 ukbd_read_char(keyboard_t *kbd, int wait)
959 #ifdef UKBD_EMULATE_ATSCANCODE
963 state = (ukbd_state_t *)kbd->kb_data;
965 /* do we have a composed char to return? */
966 if (!(state->ks_flags & COMPOSE) && (state->ks_composed_char > 0)) {
967 action = state->ks_composed_char;
968 state->ks_composed_char = 0;
969 if (action > UCHAR_MAX)
974 #ifdef UKBD_EMULATE_ATSCANCODE
975 /* do we have a pending raw scan code? */
976 if (state->ks_mode == K_RAW) {
977 if (state->ks_buffered_char[0]) {
978 scancode = state->ks_buffered_char[0];
979 if (scancode & SCAN_PREFIX) {
980 state->ks_buffered_char[0] =
981 scancode & ~SCAN_PREFIX;
982 return ((scancode & SCAN_PREFIX_E0) ? 0xe0 : 0xe1);
984 state->ks_buffered_char[0] =
985 state->ks_buffered_char[1];
986 state->ks_buffered_char[1] = 0;
991 #endif /* UKBD_EMULATE_ATSCANCODE */
993 /* see if there is something in the keyboard port */
995 usbcode = ukbd_getc(state);
1000 #ifdef UKBD_EMULATE_ATSCANCODE
1001 /* USB key index -> key code -> AT scan code */
1002 keycode = ukbd_trtab[KEY_INDEX(usbcode)];
1006 /* return an AT scan code for the K_RAW mode */
1007 if (state->ks_mode == K_RAW) {
1008 scancode = keycode2scancode(keycode, state->ks_ndata.modifiers,
1009 usbcode & KEY_RELEASE);
1010 if (scancode & SCAN_PREFIX) {
1011 if (scancode & SCAN_PREFIX_CTL) {
1012 state->ks_buffered_char[0] =
1013 0x1d | (scancode & SCAN_RELEASE);
1014 state->ks_buffered_char[1] =
1015 scancode & ~SCAN_PREFIX;
1016 } else if (scancode & SCAN_PREFIX_SHIFT) {
1017 state->ks_buffered_char[0] =
1018 0x2a | (scancode & SCAN_RELEASE);
1019 state->ks_buffered_char[1] =
1020 scancode & ~SCAN_PREFIX_SHIFT;
1022 state->ks_buffered_char[0] =
1023 scancode & ~SCAN_PREFIX;
1024 state->ks_buffered_char[1] = 0;
1026 return ((scancode & SCAN_PREFIX_E0) ? 0xe0 : 0xe1);
1030 #else /* !UKBD_EMULATE_ATSCANCODE */
1031 /* return the byte as is for the K_RAW mode */
1032 if (state->ks_mode == K_RAW)
1035 /* USB key index -> key code */
1036 keycode = ukbd_trtab[KEY_INDEX(usbcode)];
1039 #endif /* UKBD_EMULATE_ATSCANCODE */
1042 case 0x38: /* left alt (compose key) */
1043 if (usbcode & KEY_RELEASE) {
1044 if (state->ks_flags & COMPOSE) {
1045 state->ks_flags &= ~COMPOSE;
1046 if (state->ks_composed_char > UCHAR_MAX)
1047 state->ks_composed_char = 0;
1050 if (!(state->ks_flags & COMPOSE)) {
1051 state->ks_flags |= COMPOSE;
1052 state->ks_composed_char = 0;
1056 /* XXX: I don't like these... */
1057 case 0x5c: /* print screen */
1058 if (state->ks_flags & ALTS)
1059 keycode = 0x54; /* sysrq */
1061 case 0x68: /* pause/break */
1062 if (state->ks_flags & CTLS)
1063 keycode = 0x6c; /* break */
1067 /* return the key code in the K_CODE mode */
1068 if (usbcode & KEY_RELEASE)
1069 keycode |= SCAN_RELEASE;
1070 if (state->ks_mode == K_CODE)
1073 /* compose a character code */
1074 if (state->ks_flags & COMPOSE) {
1076 /* key pressed, process it */
1077 case 0x47: case 0x48: case 0x49: /* keypad 7,8,9 */
1078 state->ks_composed_char *= 10;
1079 state->ks_composed_char += keycode - 0x40;
1080 if (state->ks_composed_char > UCHAR_MAX)
1083 case 0x4B: case 0x4C: case 0x4D: /* keypad 4,5,6 */
1084 state->ks_composed_char *= 10;
1085 state->ks_composed_char += keycode - 0x47;
1086 if (state->ks_composed_char > UCHAR_MAX)
1089 case 0x4F: case 0x50: case 0x51: /* keypad 1,2,3 */
1090 state->ks_composed_char *= 10;
1091 state->ks_composed_char += keycode - 0x4E;
1092 if (state->ks_composed_char > UCHAR_MAX)
1095 case 0x52: /* keypad 0 */
1096 state->ks_composed_char *= 10;
1097 if (state->ks_composed_char > UCHAR_MAX)
1101 /* key released, no interest here */
1102 case SCAN_RELEASE | 0x47:
1103 case SCAN_RELEASE | 0x48:
1104 case SCAN_RELEASE | 0x49: /* keypad 7,8,9 */
1105 case SCAN_RELEASE | 0x4B:
1106 case SCAN_RELEASE | 0x4C:
1107 case SCAN_RELEASE | 0x4D: /* keypad 4,5,6 */
1108 case SCAN_RELEASE | 0x4F:
1109 case SCAN_RELEASE | 0x50:
1110 case SCAN_RELEASE | 0x51: /* keypad 1,2,3 */
1111 case SCAN_RELEASE | 0x52: /* keypad 0 */
1114 case 0x38: /* left alt key */
1118 if (state->ks_composed_char > 0) {
1119 state->ks_flags &= ~COMPOSE;
1120 state->ks_composed_char = 0;
1127 /* keycode to key action */
1128 action = genkbd_keyaction(kbd, SCAN_CHAR(keycode),
1129 keycode & SCAN_RELEASE, &state->ks_state,
1130 &state->ks_accents);
1131 if (action == NOKEY)
1137 /* check if char is waiting */
1139 ukbd_check_char(keyboard_t *kbd)
1141 ukbd_state_t *state;
1143 if (!KBD_IS_ACTIVE(kbd))
1145 state = (ukbd_state_t *)kbd->kb_data;
1146 if (!(state->ks_flags & COMPOSE) && (state->ks_composed_char > 0))
1148 if (state->ks_inputs > 0)
1153 /* some useful control functions */
1155 ukbd_ioctl(keyboard_t *kbd, u_long cmd, caddr_t arg)
1157 /* trasnlate LED_XXX bits into the device specific bits */
1158 static u_char ledmap[8] = {
1159 0, 2, 1, 3, 4, 6, 5, 7,
1161 ukbd_state_t *state = kbd->kb_data;
1168 case KDGKBMODE: /* get keyboard mode */
1169 *(int *)arg = state->ks_mode;
1171 case KDSKBMODE: /* set keyboard mode */
1172 switch (*(int *)arg) {
1174 if (state->ks_mode != K_XLATE) {
1175 /* make lock key state and LED state match */
1176 state->ks_state &= ~LOCK_MASK;
1177 state->ks_state |= KBD_LED_VAL(kbd);
1182 if (state->ks_mode != *(int *)arg) {
1183 ukbd_clear_state(kbd);
1184 state->ks_mode = *(int *)arg;
1193 case KDGETLED: /* get keyboard LED */
1194 *(int *)arg = KBD_LED_VAL(kbd);
1196 case KDSETLED: /* set keyboard LED */
1197 /* NOTE: lock key state in ks_state won't be changed */
1198 if (*(int *)arg & ~LOCK_MASK) {
1203 /* replace CAPS LED with ALTGR LED for ALTGR keyboards */
1204 if (kbd->kb_keymap->n_keys > ALTGR_OFFSET) {
1210 if (KBD_HAS_DEVICE(kbd)) {
1211 set_leds(state, ledmap[i & LED_MASK]);
1212 /* XXX: error check? */
1214 KBD_LED_VAL(kbd) = *(int *)arg;
1217 case KDGKBSTATE: /* get lock key state */
1218 *(int *)arg = state->ks_state & LOCK_MASK;
1220 case KDSKBSTATE: /* set lock key state */
1221 if (*(int *)arg & ~LOCK_MASK) {
1225 state->ks_state &= ~LOCK_MASK;
1226 state->ks_state |= *(int *)arg;
1228 /* set LEDs and quit */
1229 return ukbd_ioctl(kbd, KDSETLED, arg);
1231 case KDSETREPEAT: /* set keyboard repeat rate (new interface) */
1233 if (!KBD_HAS_DEVICE(kbd))
1235 if (((int *)arg)[1] < 0)
1237 if (((int *)arg)[0] < 0)
1239 else if (((int *)arg)[0] == 0) /* fastest possible value */
1240 kbd->kb_delay1 = 200;
1242 kbd->kb_delay1 = ((int *)arg)[0];
1243 kbd->kb_delay2 = ((int *)arg)[1];
1246 case KDSETRAD: /* set keyboard repeat rate (old interface) */
1248 return set_typematic(kbd, *(int *)arg);
1250 case PIO_KEYMAP: /* set keyboard translation table */
1251 case PIO_KEYMAPENT: /* set keyboard translation table entry */
1252 case PIO_DEADKEYMAP: /* set accent key translation table */
1253 state->ks_accents = 0;
1257 return genkbd_commonioctl(kbd, cmd, arg);
1261 ukbddebug = *(int *)arg;
1270 /* lock the access to the keyboard */
1272 ukbd_lock(keyboard_t *kbd, int lock)
1278 /* clear the internal state of the keyboard */
1280 ukbd_clear_state(keyboard_t *kbd)
1282 ukbd_state_t *state;
1284 state = (ukbd_state_t *)kbd->kb_data;
1285 state->ks_flags = 0;
1286 state->ks_polling = 0;
1287 state->ks_state &= LOCK_MASK; /* preserve locking key state */
1288 state->ks_accents = 0;
1289 state->ks_composed_char = 0;
1290 #ifdef UKBD_EMULATE_ATSCANCODE
1291 state->ks_buffered_char[0] = 0;
1292 state->ks_buffered_char[1] = 0;
1294 bzero(&state->ks_ndata, sizeof(state->ks_ndata));
1295 bzero(&state->ks_odata, sizeof(state->ks_odata));
1296 bzero(&state->ks_ntime, sizeof(state->ks_ntime));
1297 bzero(&state->ks_otime, sizeof(state->ks_otime));
1300 /* save the internal state */
1302 ukbd_get_state(keyboard_t *kbd, void *buf, size_t len)
1305 return sizeof(ukbd_state_t);
1306 if (len < sizeof(ukbd_state_t))
1308 bcopy(kbd->kb_data, buf, sizeof(ukbd_state_t));
1312 /* set the internal state */
1314 ukbd_set_state(keyboard_t *kbd, void *buf, size_t len)
1316 if (len < sizeof(ukbd_state_t))
1318 bcopy(buf, kbd->kb_data, sizeof(ukbd_state_t));
1323 ukbd_poll(keyboard_t *kbd, int on)
1325 ukbd_state_t *state;
1326 usbd_device_handle dev;
1329 state = (ukbd_state_t *)kbd->kb_data;
1330 usbd_interface2device_handle(state->ks_iface, &dev);
1334 if (state->ks_polling == 0)
1335 usbd_set_polling(dev, on);
1336 ++state->ks_polling;
1338 --state->ks_polling;
1339 if (state->ks_polling == 0)
1340 usbd_set_polling(dev, on);
1346 /* local functions */
1349 probe_keyboard(struct usb_attach_arg *uaa, int flags)
1351 usb_interface_descriptor_t *id;
1353 if (!uaa->iface) /* we attach to ifaces only */
1356 /* Check that this is a keyboard that speaks the boot protocol. */
1357 id = usbd_get_interface_descriptor(uaa->iface);
1359 && id->bInterfaceClass == UICLASS_HID
1360 && id->bInterfaceSubClass == UISUBCLASS_BOOT
1361 && id->bInterfaceProtocol == UPROTO_BOOT_KEYBOARD)
1362 return 0; /* found it */
1368 init_keyboard(ukbd_state_t *state, int *type, int flags)
1370 usb_endpoint_descriptor_t *ed;
1375 state->ks_ifstate |= DISCONNECTED;
1377 ed = usbd_interface2endpoint_descriptor(state->ks_iface, 0);
1379 printf("ukbd: could not read endpoint descriptor\n");
1383 DPRINTFN(10,("ukbd:init_keyboard: \
1384 bLength=%d bDescriptorType=%d bEndpointAddress=%d-%s bmAttributes=%d wMaxPacketSize=%d bInterval=%d\n",
1385 ed->bLength, ed->bDescriptorType,
1386 UE_GET_ADDR(ed->bEndpointAddress),
1387 UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN ? "in":"out",
1388 UE_GET_XFERTYPE(ed->bmAttributes),
1389 UGETW(ed->wMaxPacketSize), ed->bInterval));
1391 if (UE_GET_DIR(ed->bEndpointAddress) != UE_DIR_IN ||
1392 UE_GET_XFERTYPE(ed->bmAttributes) != UE_INTERRUPT) {
1393 printf("ukbd: unexpected endpoint\n");
1397 if ((usbd_get_quirks(state->ks_uaa->device)->uq_flags & UQ_NO_SET_PROTO) == 0) {
1398 err = usbd_set_protocol(state->ks_iface, 0);
1399 DPRINTFN(5, ("ukbd:init_keyboard: protocol set\n"));
1401 printf("ukbd: set protocol failed\n");
1405 /* Ignore if SETIDLE fails since it is not crucial. */
1406 usbd_set_idle(state->ks_iface, 0, 0);
1408 state->ks_ep_addr = ed->bEndpointAddress;
1409 state->ks_ifstate &= ~DISCONNECTED;
1415 set_leds(ukbd_state_t *state, int leds)
1417 u_int8_t res = leds;
1419 DPRINTF(("ukbd:set_leds: state=%p leds=%d\n", state, leds));
1421 usbd_set_report_async(state->ks_iface, UHID_OUTPUT_REPORT, 0, &res, 1);
1425 set_typematic(keyboard_t *kbd, int code)
1427 static int delays[] = { 250, 500, 750, 1000 };
1428 static int rates[] = { 34, 38, 42, 46, 50, 55, 59, 63,
1429 68, 76, 84, 92, 100, 110, 118, 126,
1430 136, 152, 168, 184, 200, 220, 236, 252,
1431 272, 304, 336, 368, 400, 440, 472, 504 };
1435 kbd->kb_delay1 = delays[(code >> 5) & 3];
1436 kbd->kb_delay2 = rates[code & 0x1f];
1440 #ifdef UKBD_EMULATE_ATSCANCODE
1442 keycode2scancode(int keycode, int shift, int up)
1444 static int scan[] = {
1446 0x37 | SCAN_PREFIX_SHIFT, /* PrintScreen */
1447 0x38, 0x47, 0x48, 0x49, 0x4b, 0x4d, 0x4f,
1448 0x50, 0x51, 0x52, 0x53,
1449 0x46, /* XXX Pause/Break */
1451 /* SUN TYPE 6 USB KEYBOARD */
1452 0x68, 0x5e, 0x5f, 0x60, 0x61, 0x62, 0x63,
1453 0x64, 0x65, 0x66, 0x67, 0x25, 0x1f, 0x1e,
1459 if ((keycode >= 89) && (keycode < 89 + sizeof(scan)/sizeof(scan[0])))
1460 scancode = scan[keycode - 89] | SCAN_PREFIX_E0;
1462 if ((keycode == 104) && !(shift & (MOD_CONTROL_L | MOD_CONTROL_R)))
1463 scancode = 0x45 | SCAN_PREFIX_E1 | SCAN_PREFIX_CTL;
1464 if (shift & (MOD_SHIFT_L | MOD_SHIFT_R))
1465 scancode &= ~SCAN_PREFIX_SHIFT;
1466 return (scancode | (up ? SCAN_RELEASE : SCAN_PRESS));
1468 #endif /* UKBD_EMULATE_ATSCANCODE */
1471 ukbd_driver_load(module_t mod, int what, void *arg)
1475 kbd_add_driver(&ukbd_kbd_driver);
1478 kbd_delete_driver(&ukbd_kbd_driver);
1481 return usbd_driver_load(mod, what, 0);