2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2010 Hans Petter Selasky. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * HID spec: http://www.usb.org/developers/devclass_docs/HID1_11.pdf
32 #include <sys/param.h>
33 __FBSDID("$FreeBSD$");
35 #include <sys/stdint.h>
36 #include <sys/stddef.h>
37 #include <sys/queue.h>
38 #include <sys/systm.h>
39 #include <sys/kernel.h>
41 #include <sys/linker_set.h>
42 #include <sys/module.h>
44 #include <sys/mutex.h>
45 #include <sys/condvar.h>
46 #include <sys/sysctl.h>
48 #include <sys/unistd.h>
49 #include <sys/callout.h>
50 #include <sys/malloc.h>
53 #include <dev/usb/usb.h>
54 #include <dev/usb/usbdi.h>
55 #include <dev/usb/usbdi_util.h>
56 #include <dev/usb/usbhid.h>
59 #define USB_DEBUG_VAR g_keyboard_debug
60 #include <dev/usb/usb_debug.h>
62 #include <dev/usb/gadget/g_keyboard.h>
64 static SYSCTL_NODE(_hw_usb, OID_AUTO, g_keyboard, CTLFLAG_RW, 0, "USB keyboard gadget");
67 static int g_keyboard_debug = 0;
69 SYSCTL_INT(_hw_usb_g_keyboard, OID_AUTO, debug, CTLFLAG_RWTUN,
70 &g_keyboard_debug, 0, "Debug level");
73 static int g_keyboard_mode = 0;
75 SYSCTL_INT(_hw_usb_g_keyboard, OID_AUTO, mode, CTLFLAG_RWTUN,
76 &g_keyboard_mode, 0, "Mode selection");
78 static int g_keyboard_key_press_interval = 1000;
80 SYSCTL_INT(_hw_usb_g_keyboard, OID_AUTO, key_press_interval, CTLFLAG_RWTUN,
81 &g_keyboard_key_press_interval, 0, "Key Press Interval in milliseconds");
83 static char g_keyboard_key_press_pattern[G_KEYBOARD_MAX_STRLEN];
85 SYSCTL_STRING(_hw_usb_g_keyboard, OID_AUTO, key_press_pattern, CTLFLAG_RW,
86 g_keyboard_key_press_pattern, sizeof(g_keyboard_key_press_pattern),
87 "Key Press Patterns");
89 #define UPROTO_BOOT_KEYBOARD 1
91 #define G_KEYBOARD_NMOD 8 /* units */
92 #define G_KEYBOARD_NKEYCODE 6 /* units */
94 struct g_keyboard_data {
96 #define MOD_CONTROL_L 0x01
97 #define MOD_CONTROL_R 0x10
98 #define MOD_SHIFT_L 0x02
99 #define MOD_SHIFT_R 0x20
100 #define MOD_ALT_L 0x04
101 #define MOD_ALT_R 0x40
102 #define MOD_WIN_L 0x08
103 #define MOD_WIN_R 0x80
105 uint8_t keycode[G_KEYBOARD_NKEYCODE];
110 G_KEYBOARD_N_TRANSFER,
113 struct g_keyboard_softc {
115 struct usb_callout sc_callout;
116 struct g_keyboard_data sc_data[2];
117 struct usb_xfer *sc_xfer[G_KEYBOARD_N_TRANSFER];
123 char sc_pattern[G_KEYBOARD_MAX_STRLEN];
125 uint8_t sc_led_state[4];
128 static device_probe_t g_keyboard_probe;
129 static device_attach_t g_keyboard_attach;
130 static device_detach_t g_keyboard_detach;
131 static usb_handle_request_t g_keyboard_handle_request;
132 static usb_callback_t g_keyboard_intr_callback;
134 static devclass_t g_keyboard_devclass;
136 static device_method_t g_keyboard_methods[] = {
138 DEVMETHOD(usb_handle_request, g_keyboard_handle_request),
140 /* Device interface */
141 DEVMETHOD(device_probe, g_keyboard_probe),
142 DEVMETHOD(device_attach, g_keyboard_attach),
143 DEVMETHOD(device_detach, g_keyboard_detach),
148 static driver_t g_keyboard_driver = {
149 .name = "g_keyboard",
150 .methods = g_keyboard_methods,
151 .size = sizeof(struct g_keyboard_softc),
154 DRIVER_MODULE(g_keyboard, uhub, g_keyboard_driver, g_keyboard_devclass, 0, 0);
155 MODULE_DEPEND(g_keyboard, usb, 1, 1, 1);
157 static const struct usb_config g_keyboard_config[G_KEYBOARD_N_TRANSFER] = {
158 [G_KEYBOARD_INTR_DT] = {
159 .type = UE_INTERRUPT,
160 .endpoint = UE_ADDR_ANY,
161 .direction = UE_DIR_IN,
162 .flags = {.ext_buffer = 1,.pipe_bof = 1,},
163 .bufsize = sizeof(struct g_keyboard_data),
164 .callback = &g_keyboard_intr_callback,
166 .usb_mode = USB_MODE_DEVICE,
170 static void g_keyboard_timeout(void *arg);
173 g_keyboard_timeout_reset(struct g_keyboard_softc *sc)
175 int i = g_keyboard_key_press_interval;
182 i = USB_MS_TO_TICKS(i);
184 usb_callout_reset(&sc->sc_callout, i, &g_keyboard_timeout, sc);
188 g_keyboard_timeout(void *arg)
190 struct g_keyboard_softc *sc = arg;
192 sc->sc_mode = g_keyboard_mode;
194 memcpy(sc->sc_pattern, g_keyboard_key_press_pattern, sizeof(sc->sc_pattern));
196 sc->sc_pattern[G_KEYBOARD_MAX_STRLEN - 1] = 0;
198 sc->sc_pattern_len = strlen(sc->sc_pattern);
200 DPRINTFN(11, "Timeout %p\n", sc->sc_xfer[G_KEYBOARD_INTR_DT]);
202 usbd_transfer_start(sc->sc_xfer[G_KEYBOARD_INTR_DT]);
204 g_keyboard_timeout_reset(sc);
208 g_keyboard_probe(device_t dev)
210 struct usb_attach_arg *uaa = device_get_ivars(dev);
214 if (uaa->usb_mode != USB_MODE_DEVICE)
217 if ((uaa->info.bInterfaceClass == UICLASS_HID) &&
218 (uaa->info.bInterfaceSubClass == UISUBCLASS_BOOT) &&
219 (uaa->info.bInterfaceProtocol == UPROTO_BOOT_KEYBOARD))
226 g_keyboard_attach(device_t dev)
228 struct g_keyboard_softc *sc = device_get_softc(dev);
229 struct usb_attach_arg *uaa = device_get_ivars(dev);
234 device_set_usb_desc(dev);
236 mtx_init(&sc->sc_mtx, "g_keyboard", NULL, MTX_DEF);
238 usb_callout_init_mtx(&sc->sc_callout, &sc->sc_mtx, 0);
240 sc->sc_mode = G_KEYBOARD_MODE_SILENT;
242 error = usbd_transfer_setup(uaa->device,
243 &uaa->info.bIfaceIndex, sc->sc_xfer, g_keyboard_config,
244 G_KEYBOARD_N_TRANSFER, sc, &sc->sc_mtx);
247 DPRINTF("error=%s\n", usbd_errstr(error));
250 mtx_lock(&sc->sc_mtx);
251 g_keyboard_timeout_reset(sc);
252 mtx_unlock(&sc->sc_mtx);
254 return (0); /* success */
257 g_keyboard_detach(dev);
259 return (ENXIO); /* error */
263 g_keyboard_detach(device_t dev)
265 struct g_keyboard_softc *sc = device_get_softc(dev);
269 mtx_lock(&sc->sc_mtx);
270 usb_callout_stop(&sc->sc_callout);
271 mtx_unlock(&sc->sc_mtx);
273 usbd_transfer_unsetup(sc->sc_xfer, G_KEYBOARD_N_TRANSFER);
275 usb_callout_drain(&sc->sc_callout);
277 mtx_destroy(&sc->sc_mtx);
283 g_keyboard_get_keycode(struct g_keyboard_softc *sc, int index)
286 int mod = sc->sc_pattern_len;
293 if ((index >= 0) && (index < sc->sc_pattern_len))
294 key = sc->sc_pattern[index];
298 if (key >= 'a' && key <= 'z')
299 return (key - 'a' + 0x04);
305 g_keyboard_intr_callback(struct usb_xfer *xfer, usb_error_t error)
307 struct g_keyboard_softc *sc = usbd_xfer_softc(xfer);
311 usbd_xfer_status(xfer, &actlen, NULL, &aframes, NULL);
313 DPRINTF("st=%d aframes=%d actlen=%d bytes\n",
314 USB_GET_STATE(xfer), aframes, actlen);
316 switch (USB_GET_STATE(xfer)) {
317 case USB_ST_TRANSFERRED:
322 if (sc->sc_mode == G_KEYBOARD_MODE_SILENT) {
323 memset(&sc->sc_data, 0, sizeof(sc->sc_data));
324 usbd_xfer_set_frame_data(xfer, 0, &sc->sc_data[0], sizeof(sc->sc_data[0]));
325 usbd_xfer_set_frame_data(xfer, 1, &sc->sc_data[1], sizeof(sc->sc_data[1]));
326 usbd_xfer_set_frames(xfer, 2);
327 usbd_transfer_submit(xfer);
329 } else if (sc->sc_mode == G_KEYBOARD_MODE_PATTERN) {
331 memset(&sc->sc_data, 0, sizeof(sc->sc_data));
333 if ((sc->sc_state < 0) || (sc->sc_state >= G_KEYBOARD_MAX_STRLEN))
336 switch (sc->sc_state % 6) {
338 sc->sc_data[0].keycode[0] =
339 g_keyboard_get_keycode(sc, sc->sc_state + 0);
341 sc->sc_data[0].keycode[1] =
342 g_keyboard_get_keycode(sc, sc->sc_state + 1);
344 sc->sc_data[0].keycode[2] =
345 g_keyboard_get_keycode(sc, sc->sc_state + 2);
347 sc->sc_data[0].keycode[3] =
348 g_keyboard_get_keycode(sc, sc->sc_state + 3);
350 sc->sc_data[0].keycode[4] =
351 g_keyboard_get_keycode(sc, sc->sc_state + 4);
353 sc->sc_data[0].keycode[5] =
354 g_keyboard_get_keycode(sc, sc->sc_state + 5);
359 usbd_xfer_set_frame_data(xfer, 0, &sc->sc_data[0], sizeof(sc->sc_data[0]));
360 usbd_xfer_set_frame_data(xfer, 1, &sc->sc_data[1], sizeof(sc->sc_data[1]));
361 usbd_xfer_set_frames(xfer, 2);
362 usbd_transfer_submit(xfer);
367 DPRINTF("error=%s\n", usbd_errstr(error));
369 if (error != USB_ERR_CANCELLED) {
370 /* try to clear stall first */
371 usbd_xfer_set_stall(xfer);
379 g_keyboard_handle_request(device_t dev,
380 const void *preq, void **pptr, uint16_t *plen,
381 uint16_t offset, uint8_t *pstate)
383 struct g_keyboard_softc *sc = device_get_softc(dev);
384 const struct usb_device_request *req = preq;
385 uint8_t is_complete = *pstate;
388 if ((req->bmRequestType == UT_WRITE_CLASS_INTERFACE) &&
389 (req->bRequest == UR_SET_REPORT) &&
390 (req->wValue[0] == 0x00) &&
391 (req->wValue[1] == 0x02)) {
394 *plen = sizeof(sc->sc_led_state);
395 *pptr = &sc->sc_led_state;
400 } else if ((req->bmRequestType == UT_WRITE_CLASS_INTERFACE) &&
401 (req->bRequest == UR_SET_PROTOCOL) &&
402 (req->wValue[0] == 0x00) &&
403 (req->wValue[1] == 0x00)) {
406 } else if ((req->bmRequestType == UT_WRITE_CLASS_INTERFACE) &&
407 (req->bRequest == UR_SET_IDLE)) {
412 return (ENXIO); /* use builtin handler */