2 * Copyright (c) 2010 Hans Petter Selasky. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * HID spec: http://www.usb.org/developers/devclass_docs/HID1_11.pdf
30 #include <sys/param.h>
31 __FBSDID("$FreeBSD$");
33 #include <sys/stdint.h>
34 #include <sys/stddef.h>
35 #include <sys/queue.h>
36 #include <sys/systm.h>
37 #include <sys/kernel.h>
39 #include <sys/linker_set.h>
40 #include <sys/module.h>
42 #include <sys/mutex.h>
43 #include <sys/condvar.h>
44 #include <sys/sysctl.h>
46 #include <sys/unistd.h>
47 #include <sys/callout.h>
48 #include <sys/malloc.h>
51 #include <dev/usb/usb.h>
52 #include <dev/usb/usbdi.h>
53 #include <dev/usb/usbdi_util.h>
54 #include <dev/usb/usbhid.h>
57 #define USB_DEBUG_VAR g_keyboard_debug
58 #include <dev/usb/usb_debug.h>
60 #include <dev/usb/gadget/g_keyboard.h>
62 static SYSCTL_NODE(_hw_usb, OID_AUTO, g_keyboard, CTLFLAG_RW, 0, "USB keyboard gadget");
65 static int g_keyboard_debug = 0;
67 SYSCTL_INT(_hw_usb_g_keyboard, OID_AUTO, debug, CTLFLAG_RW,
68 &g_keyboard_debug, 0, "Debug level");
71 static int g_keyboard_mode = 0;
73 SYSCTL_INT(_hw_usb_g_keyboard, OID_AUTO, mode, CTLFLAG_RW,
74 &g_keyboard_mode, 0, "Mode selection");
76 static int g_keyboard_key_press_interval = 1000;
78 SYSCTL_INT(_hw_usb_g_keyboard, OID_AUTO, key_press_interval, CTLFLAG_RW,
79 &g_keyboard_key_press_interval, 0, "Key Press Interval in milliseconds");
81 static char g_keyboard_key_press_pattern[G_KEYBOARD_MAX_STRLEN];
83 SYSCTL_STRING(_hw_usb_g_keyboard, OID_AUTO, key_press_pattern, CTLFLAG_RW,
84 g_keyboard_key_press_pattern, sizeof(g_keyboard_key_press_pattern),
85 "Key Press Patterns");
87 #define UPROTO_BOOT_KEYBOARD 1
89 #define G_KEYBOARD_NMOD 8 /* units */
90 #define G_KEYBOARD_NKEYCODE 6 /* units */
92 struct g_keyboard_data {
94 #define MOD_CONTROL_L 0x01
95 #define MOD_CONTROL_R 0x10
96 #define MOD_SHIFT_L 0x02
97 #define MOD_SHIFT_R 0x20
98 #define MOD_ALT_L 0x04
99 #define MOD_ALT_R 0x40
100 #define MOD_WIN_L 0x08
101 #define MOD_WIN_R 0x80
103 uint8_t keycode[G_KEYBOARD_NKEYCODE];
108 G_KEYBOARD_N_TRANSFER,
111 struct g_keyboard_softc {
113 struct usb_callout sc_callout;
114 struct g_keyboard_data sc_data[2];
115 struct usb_xfer *sc_xfer[G_KEYBOARD_N_TRANSFER];
121 char sc_pattern[G_KEYBOARD_MAX_STRLEN];
123 uint8_t sc_led_state[4];
126 static device_probe_t g_keyboard_probe;
127 static device_attach_t g_keyboard_attach;
128 static device_detach_t g_keyboard_detach;
129 static usb_handle_request_t g_keyboard_handle_request;
130 static usb_callback_t g_keyboard_intr_callback;
132 static devclass_t g_keyboard_devclass;
134 static device_method_t g_keyboard_methods[] = {
136 DEVMETHOD(usb_handle_request, g_keyboard_handle_request),
138 /* Device interface */
139 DEVMETHOD(device_probe, g_keyboard_probe),
140 DEVMETHOD(device_attach, g_keyboard_attach),
141 DEVMETHOD(device_detach, g_keyboard_detach),
146 static driver_t g_keyboard_driver = {
147 .name = "g_keyboard",
148 .methods = g_keyboard_methods,
149 .size = sizeof(struct g_keyboard_softc),
152 DRIVER_MODULE(g_keyboard, uhub, g_keyboard_driver, g_keyboard_devclass, 0, 0);
153 MODULE_DEPEND(g_keyboard, usb, 1, 1, 1);
155 static const struct usb_config g_keyboard_config[G_KEYBOARD_N_TRANSFER] = {
156 [G_KEYBOARD_INTR_DT] = {
157 .type = UE_INTERRUPT,
158 .endpoint = UE_ADDR_ANY,
159 .direction = UE_DIR_IN,
160 .flags = {.ext_buffer = 1,.pipe_bof = 1,},
161 .bufsize = sizeof(struct g_keyboard_data),
162 .callback = &g_keyboard_intr_callback,
164 .usb_mode = USB_MODE_DEVICE,
168 static void g_keyboard_timeout(void *arg);
171 g_keyboard_timeout_reset(struct g_keyboard_softc *sc)
173 int i = g_keyboard_key_press_interval;
180 i = USB_MS_TO_TICKS(i);
182 usb_callout_reset(&sc->sc_callout, i, &g_keyboard_timeout, sc);
186 g_keyboard_timeout(void *arg)
188 struct g_keyboard_softc *sc = arg;
190 sc->sc_mode = g_keyboard_mode;
192 memcpy(sc->sc_pattern, g_keyboard_key_press_pattern, sizeof(sc->sc_pattern));
194 sc->sc_pattern[G_KEYBOARD_MAX_STRLEN - 1] = 0;
196 sc->sc_pattern_len = strlen(sc->sc_pattern);
198 DPRINTFN(11, "Timeout %p\n", sc->sc_xfer[G_KEYBOARD_INTR_DT]);
200 usbd_transfer_start(sc->sc_xfer[G_KEYBOARD_INTR_DT]);
202 g_keyboard_timeout_reset(sc);
206 g_keyboard_probe(device_t dev)
208 struct usb_attach_arg *uaa = device_get_ivars(dev);
212 if (uaa->usb_mode != USB_MODE_DEVICE)
215 if ((uaa->info.bInterfaceClass == UICLASS_HID) &&
216 (uaa->info.bInterfaceSubClass == UISUBCLASS_BOOT) &&
217 (uaa->info.bInterfaceProtocol == UPROTO_BOOT_KEYBOARD))
224 g_keyboard_attach(device_t dev)
226 struct g_keyboard_softc *sc = device_get_softc(dev);
227 struct usb_attach_arg *uaa = device_get_ivars(dev);
232 device_set_usb_desc(dev);
234 mtx_init(&sc->sc_mtx, "g_keyboard", NULL, MTX_DEF);
236 usb_callout_init_mtx(&sc->sc_callout, &sc->sc_mtx, 0);
238 sc->sc_mode = G_KEYBOARD_MODE_SILENT;
240 error = usbd_transfer_setup(uaa->device,
241 &uaa->info.bIfaceIndex, sc->sc_xfer, g_keyboard_config,
242 G_KEYBOARD_N_TRANSFER, sc, &sc->sc_mtx);
245 DPRINTF("error=%s\n", usbd_errstr(error));
248 mtx_lock(&sc->sc_mtx);
249 g_keyboard_timeout_reset(sc);
250 mtx_unlock(&sc->sc_mtx);
252 return (0); /* success */
255 g_keyboard_detach(dev);
257 return (ENXIO); /* error */
261 g_keyboard_detach(device_t dev)
263 struct g_keyboard_softc *sc = device_get_softc(dev);
267 mtx_lock(&sc->sc_mtx);
268 usb_callout_stop(&sc->sc_callout);
269 mtx_unlock(&sc->sc_mtx);
271 usbd_transfer_unsetup(sc->sc_xfer, G_KEYBOARD_N_TRANSFER);
273 usb_callout_drain(&sc->sc_callout);
275 mtx_destroy(&sc->sc_mtx);
281 g_keyboard_get_keycode(struct g_keyboard_softc *sc, int index)
284 int mod = sc->sc_pattern_len;
291 if ((index >= 0) && (index < sc->sc_pattern_len))
292 key = sc->sc_pattern[index];
296 if (key >= 'a' && key <= 'z')
297 return (key - 'a' + 0x04);
303 g_keyboard_intr_callback(struct usb_xfer *xfer, usb_error_t error)
305 struct g_keyboard_softc *sc = usbd_xfer_softc(xfer);
309 usbd_xfer_status(xfer, &actlen, NULL, &aframes, NULL);
311 DPRINTF("st=%d aframes=%d actlen=%d bytes\n",
312 USB_GET_STATE(xfer), aframes, actlen);
314 switch (USB_GET_STATE(xfer)) {
315 case USB_ST_TRANSFERRED:
320 if (sc->sc_mode == G_KEYBOARD_MODE_SILENT) {
321 memset(&sc->sc_data, 0, sizeof(sc->sc_data));
322 usbd_xfer_set_frame_data(xfer, 0, &sc->sc_data[0], sizeof(sc->sc_data[0]));
323 usbd_xfer_set_frame_data(xfer, 1, &sc->sc_data[1], sizeof(sc->sc_data[1]));
324 usbd_xfer_set_frames(xfer, 2);
325 usbd_transfer_submit(xfer);
327 } else if (sc->sc_mode == G_KEYBOARD_MODE_PATTERN) {
329 memset(&sc->sc_data, 0, sizeof(sc->sc_data));
331 if ((sc->sc_state < 0) || (sc->sc_state >= G_KEYBOARD_MAX_STRLEN))
334 switch (sc->sc_state % 6) {
336 sc->sc_data[0].keycode[0] =
337 g_keyboard_get_keycode(sc, sc->sc_state + 0);
339 sc->sc_data[0].keycode[1] =
340 g_keyboard_get_keycode(sc, sc->sc_state + 1);
342 sc->sc_data[0].keycode[2] =
343 g_keyboard_get_keycode(sc, sc->sc_state + 2);
345 sc->sc_data[0].keycode[3] =
346 g_keyboard_get_keycode(sc, sc->sc_state + 3);
348 sc->sc_data[0].keycode[4] =
349 g_keyboard_get_keycode(sc, sc->sc_state + 4);
351 sc->sc_data[0].keycode[5] =
352 g_keyboard_get_keycode(sc, sc->sc_state + 5);
357 usbd_xfer_set_frame_data(xfer, 0, &sc->sc_data[0], sizeof(sc->sc_data[0]));
358 usbd_xfer_set_frame_data(xfer, 1, &sc->sc_data[1], sizeof(sc->sc_data[1]));
359 usbd_xfer_set_frames(xfer, 2);
360 usbd_transfer_submit(xfer);
365 DPRINTF("error=%s\n", usbd_errstr(error));
367 if (error != USB_ERR_CANCELLED) {
368 /* try to clear stall first */
369 usbd_xfer_set_stall(xfer);
377 g_keyboard_handle_request(device_t dev,
378 const void *preq, void **pptr, uint16_t *plen,
379 uint16_t offset, uint8_t *pstate)
381 struct g_keyboard_softc *sc = device_get_softc(dev);
382 const struct usb_device_request *req = preq;
383 uint8_t is_complete = *pstate;
386 if ((req->bmRequestType == UT_WRITE_CLASS_INTERFACE) &&
387 (req->bRequest == UR_SET_REPORT) &&
388 (req->wValue[0] == 0x00) &&
389 (req->wValue[1] == 0x02)) {
392 *plen = sizeof(sc->sc_led_state);
393 *pptr = &sc->sc_led_state;
398 } else if ((req->bmRequestType == UT_WRITE_CLASS_INTERFACE) &&
399 (req->bRequest == UR_SET_PROTOCOL) &&
400 (req->wValue[0] == 0x00) &&
401 (req->wValue[1] == 0x00)) {
404 } else if ((req->bmRequestType == UT_WRITE_CLASS_INTERFACE) &&
405 (req->bRequest == UR_SET_IDLE)) {
410 return (ENXIO); /* use builtin handler */