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_mouse_debug
60 #include <dev/usb/usb_debug.h>
62 #include <dev/usb/gadget/g_mouse.h>
64 static SYSCTL_NODE(_hw_usb, OID_AUTO, g_mouse, CTLFLAG_RW, 0, "USB mouse gadget");
67 static int g_mouse_debug = 0;
69 SYSCTL_INT(_hw_usb_g_mouse, OID_AUTO, debug, CTLFLAG_RWTUN,
70 &g_mouse_debug, 0, "Debug level");
73 static int g_mouse_mode = 0;
75 SYSCTL_INT(_hw_usb_g_mouse, OID_AUTO, mode, CTLFLAG_RWTUN,
76 &g_mouse_mode, 0, "Mode selection");
78 static int g_mouse_button_press_interval = 0;
80 SYSCTL_INT(_hw_usb_g_mouse, OID_AUTO, button_press_interval, CTLFLAG_RWTUN,
81 &g_mouse_button_press_interval, 0, "Mouse button update interval in milliseconds");
83 static int g_mouse_cursor_update_interval = 1023;
85 SYSCTL_INT(_hw_usb_g_mouse, OID_AUTO, cursor_update_interval, CTLFLAG_RWTUN,
86 &g_mouse_cursor_update_interval, 0, "Mouse cursor update interval in milliseconds");
88 static int g_mouse_cursor_radius = 128;
90 SYSCTL_INT(_hw_usb_g_mouse, OID_AUTO, cursor_radius, CTLFLAG_RWTUN,
91 &g_mouse_cursor_radius, 0, "Mouse cursor radius in pixels");
108 struct g_mouse_softc {
110 struct usb_callout sc_button_press_callout;
111 struct usb_callout sc_cursor_update_callout;
112 struct g_mouse_data sc_data;
113 struct usb_xfer *sc_xfer[G_MOUSE_N_TRANSFER];
123 uint8_t sc_do_cursor_update;
124 uint8_t sc_do_button_update;
127 static device_probe_t g_mouse_probe;
128 static device_attach_t g_mouse_attach;
129 static device_detach_t g_mouse_detach;
130 static usb_handle_request_t g_mouse_handle_request;
131 static usb_callback_t g_mouse_intr_callback;
133 static devclass_t g_mouse_devclass;
135 static device_method_t g_mouse_methods[] = {
137 DEVMETHOD(usb_handle_request, g_mouse_handle_request),
139 /* Device interface */
140 DEVMETHOD(device_probe, g_mouse_probe),
141 DEVMETHOD(device_attach, g_mouse_attach),
142 DEVMETHOD(device_detach, g_mouse_detach),
147 static driver_t g_mouse_driver = {
149 .methods = g_mouse_methods,
150 .size = sizeof(struct g_mouse_softc),
153 DRIVER_MODULE(g_mouse, uhub, g_mouse_driver, g_mouse_devclass, 0, 0);
154 MODULE_DEPEND(g_mouse, usb, 1, 1, 1);
156 static const struct usb_config g_mouse_config[G_MOUSE_N_TRANSFER] = {
158 [G_MOUSE_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_mouse_data),
164 .callback = &g_mouse_intr_callback,
166 .usb_mode = USB_MODE_DEVICE,
170 static void g_mouse_button_press_timeout(void *arg);
171 static void g_mouse_cursor_update_timeout(void *arg);
174 g_mouse_button_press_timeout_reset(struct g_mouse_softc *sc)
176 int i = g_mouse_button_press_interval;
179 sc->sc_data.buttons = 0;
180 sc->sc_do_button_update = 0;
182 sc->sc_do_button_update = 1;
185 if ((i <= 0) || (i > 1023))
188 i = USB_MS_TO_TICKS(i);
190 usb_callout_reset(&sc->sc_button_press_callout, i,
191 &g_mouse_button_press_timeout, sc);
195 g_mouse_cursor_update_timeout_reset(struct g_mouse_softc *sc)
197 int i = g_mouse_cursor_update_interval;
202 sc->sc_do_cursor_update = 0;
205 sc->sc_do_cursor_update = 1;
208 if ((i <= 0) || (i > 1023))
211 i = USB_MS_TO_TICKS(i);
213 usb_callout_reset(&sc->sc_cursor_update_callout, i,
214 &g_mouse_cursor_update_timeout, sc);
218 g_mouse_update_mode_radius(struct g_mouse_softc *sc)
220 sc->sc_mode = g_mouse_mode;
221 sc->sc_radius = g_mouse_cursor_radius;
223 if (sc->sc_radius < 0)
225 else if (sc->sc_radius > 1023)
226 sc->sc_radius = 1023;
230 g_mouse_button_press_timeout(void *arg)
232 struct g_mouse_softc *sc = arg;
234 g_mouse_update_mode_radius(sc);
236 DPRINTFN(11, "Timeout %p (button press)\n", sc->sc_xfer[G_MOUSE_INTR_DT]);
238 g_mouse_button_press_timeout_reset(sc);
240 usbd_transfer_start(sc->sc_xfer[G_MOUSE_INTR_DT]);
244 g_mouse_cursor_update_timeout(void *arg)
246 struct g_mouse_softc *sc = arg;
248 g_mouse_update_mode_radius(sc);
250 DPRINTFN(11, "Timeout %p (cursor update)\n", sc->sc_xfer[G_MOUSE_INTR_DT]);
252 g_mouse_cursor_update_timeout_reset(sc);
254 usbd_transfer_start(sc->sc_xfer[G_MOUSE_INTR_DT]);
258 g_mouse_probe(device_t dev)
260 struct usb_attach_arg *uaa = device_get_ivars(dev);
264 if (uaa->usb_mode != USB_MODE_DEVICE)
267 if ((uaa->info.bInterfaceClass == UICLASS_HID) &&
268 (uaa->info.bInterfaceSubClass == UISUBCLASS_BOOT) &&
269 (uaa->info.bInterfaceProtocol == UIPROTO_MOUSE))
276 g_mouse_attach(device_t dev)
278 struct g_mouse_softc *sc = device_get_softc(dev);
279 struct usb_attach_arg *uaa = device_get_ivars(dev);
284 device_set_usb_desc(dev);
286 mtx_init(&sc->sc_mtx, "g_mouse", NULL, MTX_DEF);
288 usb_callout_init_mtx(&sc->sc_button_press_callout, &sc->sc_mtx, 0);
289 usb_callout_init_mtx(&sc->sc_cursor_update_callout, &sc->sc_mtx, 0);
291 sc->sc_mode = G_MOUSE_MODE_SILENT;
293 error = usbd_transfer_setup(uaa->device,
294 &uaa->info.bIfaceIndex, sc->sc_xfer, g_mouse_config,
295 G_MOUSE_N_TRANSFER, sc, &sc->sc_mtx);
298 DPRINTF("error=%s\n", usbd_errstr(error));
302 mtx_lock(&sc->sc_mtx);
303 g_mouse_button_press_timeout_reset(sc);
304 g_mouse_cursor_update_timeout_reset(sc);
305 mtx_unlock(&sc->sc_mtx);
307 return (0); /* success */
312 return (ENXIO); /* error */
316 g_mouse_detach(device_t dev)
318 struct g_mouse_softc *sc = device_get_softc(dev);
322 mtx_lock(&sc->sc_mtx);
323 usb_callout_stop(&sc->sc_button_press_callout);
324 usb_callout_stop(&sc->sc_cursor_update_callout);
325 mtx_unlock(&sc->sc_mtx);
327 usbd_transfer_unsetup(sc->sc_xfer, G_MOUSE_N_TRANSFER);
329 usb_callout_drain(&sc->sc_button_press_callout);
330 usb_callout_drain(&sc->sc_cursor_update_callout);
332 mtx_destroy(&sc->sc_mtx);
338 g_mouse_intr_callback(struct usb_xfer *xfer, usb_error_t error)
340 struct g_mouse_softc *sc = usbd_xfer_softc(xfer);
347 usbd_xfer_status(xfer, &actlen, NULL, &aframes, NULL);
349 DPRINTF("st=%d aframes=%d actlen=%d bytes\n",
350 USB_GET_STATE(xfer), aframes, actlen);
352 switch (USB_GET_STATE(xfer)) {
353 case USB_ST_TRANSFERRED:
354 if (!(sc->sc_do_cursor_update || sc->sc_do_button_update))
360 if (sc->sc_do_cursor_update) {
361 sc->sc_do_cursor_update = 0;
363 if ((sc->sc_tick < 0) || (sc->sc_tick > 7999))
367 if (sc->sc_do_button_update) {
368 sc->sc_do_button_update = 0;
369 sc->sc_data.buttons ^= BUT_0;
372 radius = sc->sc_radius;
374 switch (sc->sc_mode) {
375 case G_MOUSE_MODE_SILENT:
376 sc->sc_data.buttons = 0;
378 case G_MOUSE_MODE_SPIRAL:
379 radius = (radius * (8000-sc->sc_tick)) / 8000;
380 case G_MOUSE_MODE_CIRCLE:
382 sc->sc_curr_y_state = 0;
383 sc->sc_curr_x_state = 0;
385 case G_MOUSE_MODE_BOX:
386 if (sc->sc_tick < 2000) {
387 sc->sc_curr_x_state = (sc->sc_tick * radius) / 2000;
388 sc->sc_curr_y_state = 0;
389 } else if (sc->sc_tick < 4000) {
390 sc->sc_curr_x_state = radius;
391 sc->sc_curr_y_state = -(((sc->sc_tick - 2000) * radius) / 2000);
392 } else if (sc->sc_tick < 6000) {
393 sc->sc_curr_x_state = radius - (((sc->sc_tick - 4000) * radius) / 2000);
394 sc->sc_curr_y_state = -radius;
396 sc->sc_curr_x_state = 0;
397 sc->sc_curr_y_state = -radius + (((sc->sc_tick - 6000) * radius) / 2000);
404 dx = sc->sc_curr_x_state - sc->sc_last_x_state;
405 dy = sc->sc_curr_y_state - sc->sc_last_y_state;
417 sc->sc_last_x_state += dx;
418 sc->sc_last_y_state += dy;
423 usbd_xfer_set_frame_data(xfer, 0, &sc->sc_data, sizeof(sc->sc_data));
424 usbd_xfer_set_frames(xfer, 1);
425 usbd_transfer_submit(xfer);
429 DPRINTF("error=%s\n", usbd_errstr(error));
431 if (error != USB_ERR_CANCELLED) {
432 /* try to clear stall first */
433 usbd_xfer_set_stall(xfer);
441 g_mouse_handle_request(device_t dev,
442 const void *preq, void **pptr, uint16_t *plen,
443 uint16_t offset, uint8_t *pstate)
445 const struct usb_device_request *req = preq;
446 uint8_t is_complete = *pstate;
449 if ((req->bmRequestType == UT_WRITE_CLASS_INTERFACE) &&
450 (req->bRequest == UR_SET_PROTOCOL) &&
451 (req->wValue[0] == 0x00) &&
452 (req->wValue[1] == 0x00)) {
457 return (ENXIO); /* use builtin handler */