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_mouse_debug
58 #include <dev/usb/usb_debug.h>
60 #include <dev/usb/gadget/g_mouse.h>
62 static SYSCTL_NODE(_hw_usb, OID_AUTO, g_mouse, CTLFLAG_RW, 0, "USB mouse gadget");
65 static int g_mouse_debug = 0;
67 SYSCTL_INT(_hw_usb_g_mouse, OID_AUTO, debug, CTLFLAG_RW,
68 &g_mouse_debug, 0, "Debug level");
71 static int g_mouse_mode = 0;
73 SYSCTL_INT(_hw_usb_g_mouse, OID_AUTO, mode, CTLFLAG_RW,
74 &g_mouse_mode, 0, "Mode selection");
76 static int g_mouse_button_press_interval = 0;
78 SYSCTL_INT(_hw_usb_g_mouse, OID_AUTO, button_press_interval, CTLFLAG_RW,
79 &g_mouse_button_press_interval, 0, "Mouse button update interval in milliseconds");
81 static int g_mouse_cursor_update_interval = 1023;
83 SYSCTL_INT(_hw_usb_g_mouse, OID_AUTO, cursor_update_interval, CTLFLAG_RW,
84 &g_mouse_cursor_update_interval, 0, "Mouse cursor update interval in milliseconds");
86 static int g_mouse_cursor_radius = 128;
88 SYSCTL_INT(_hw_usb_g_mouse, OID_AUTO, cursor_radius, CTLFLAG_RW,
89 &g_mouse_cursor_radius, 0, "Mouse cursor radius in pixels");
106 struct g_mouse_softc {
108 struct usb_callout sc_button_press_callout;
109 struct usb_callout sc_cursor_update_callout;
110 struct g_mouse_data sc_data;
111 struct usb_xfer *sc_xfer[G_MOUSE_N_TRANSFER];
121 uint8_t sc_do_cursor_update;
122 uint8_t sc_do_button_update;
125 static device_probe_t g_mouse_probe;
126 static device_attach_t g_mouse_attach;
127 static device_detach_t g_mouse_detach;
128 static usb_handle_request_t g_mouse_handle_request;
129 static usb_callback_t g_mouse_intr_callback;
131 static devclass_t g_mouse_devclass;
133 static device_method_t g_mouse_methods[] = {
135 DEVMETHOD(usb_handle_request, g_mouse_handle_request),
137 /* Device interface */
138 DEVMETHOD(device_probe, g_mouse_probe),
139 DEVMETHOD(device_attach, g_mouse_attach),
140 DEVMETHOD(device_detach, g_mouse_detach),
145 static driver_t g_mouse_driver = {
147 .methods = g_mouse_methods,
148 .size = sizeof(struct g_mouse_softc),
151 DRIVER_MODULE(g_mouse, uhub, g_mouse_driver, g_mouse_devclass, 0, 0);
152 MODULE_DEPEND(g_mouse, usb, 1, 1, 1);
154 static const struct usb_config g_mouse_config[G_MOUSE_N_TRANSFER] = {
156 [G_MOUSE_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_mouse_data),
162 .callback = &g_mouse_intr_callback,
164 .usb_mode = USB_MODE_DEVICE,
168 static void g_mouse_button_press_timeout(void *arg);
169 static void g_mouse_cursor_update_timeout(void *arg);
172 g_mouse_button_press_timeout_reset(struct g_mouse_softc *sc)
174 int i = g_mouse_button_press_interval;
177 sc->sc_data.buttons = 0;
178 sc->sc_do_button_update = 0;
180 sc->sc_do_button_update = 1;
183 if ((i <= 0) || (i > 1023))
186 i = USB_MS_TO_TICKS(i);
188 usb_callout_reset(&sc->sc_button_press_callout, i,
189 &g_mouse_button_press_timeout, sc);
193 g_mouse_cursor_update_timeout_reset(struct g_mouse_softc *sc)
195 int i = g_mouse_cursor_update_interval;
200 sc->sc_do_cursor_update = 0;
203 sc->sc_do_cursor_update = 1;
206 if ((i <= 0) || (i > 1023))
209 i = USB_MS_TO_TICKS(i);
211 usb_callout_reset(&sc->sc_cursor_update_callout, i,
212 &g_mouse_cursor_update_timeout, sc);
216 g_mouse_update_mode_radius(struct g_mouse_softc *sc)
218 sc->sc_mode = g_mouse_mode;
219 sc->sc_radius = g_mouse_cursor_radius;
221 if (sc->sc_radius < 0)
223 else if (sc->sc_radius > 1023)
224 sc->sc_radius = 1023;
228 g_mouse_button_press_timeout(void *arg)
230 struct g_mouse_softc *sc = arg;
232 g_mouse_update_mode_radius(sc);
234 DPRINTFN(11, "Timeout %p (button press)\n", sc->sc_xfer[G_MOUSE_INTR_DT]);
236 g_mouse_button_press_timeout_reset(sc);
238 usbd_transfer_start(sc->sc_xfer[G_MOUSE_INTR_DT]);
242 g_mouse_cursor_update_timeout(void *arg)
244 struct g_mouse_softc *sc = arg;
246 g_mouse_update_mode_radius(sc);
248 DPRINTFN(11, "Timeout %p (cursor update)\n", sc->sc_xfer[G_MOUSE_INTR_DT]);
250 g_mouse_cursor_update_timeout_reset(sc);
252 usbd_transfer_start(sc->sc_xfer[G_MOUSE_INTR_DT]);
256 g_mouse_probe(device_t dev)
258 struct usb_attach_arg *uaa = device_get_ivars(dev);
262 if (uaa->usb_mode != USB_MODE_DEVICE)
265 if ((uaa->info.bInterfaceClass == UICLASS_HID) &&
266 (uaa->info.bInterfaceSubClass == UISUBCLASS_BOOT) &&
267 (uaa->info.bInterfaceProtocol == UIPROTO_MOUSE))
274 g_mouse_attach(device_t dev)
276 struct g_mouse_softc *sc = device_get_softc(dev);
277 struct usb_attach_arg *uaa = device_get_ivars(dev);
282 device_set_usb_desc(dev);
284 mtx_init(&sc->sc_mtx, "g_mouse", NULL, MTX_DEF);
286 usb_callout_init_mtx(&sc->sc_button_press_callout, &sc->sc_mtx, 0);
287 usb_callout_init_mtx(&sc->sc_cursor_update_callout, &sc->sc_mtx, 0);
289 sc->sc_mode = G_MOUSE_MODE_SILENT;
291 error = usbd_transfer_setup(uaa->device,
292 &uaa->info.bIfaceIndex, sc->sc_xfer, g_mouse_config,
293 G_MOUSE_N_TRANSFER, sc, &sc->sc_mtx);
296 DPRINTF("error=%s\n", usbd_errstr(error));
300 mtx_lock(&sc->sc_mtx);
301 g_mouse_button_press_timeout_reset(sc);
302 g_mouse_cursor_update_timeout_reset(sc);
303 mtx_unlock(&sc->sc_mtx);
305 return (0); /* success */
310 return (ENXIO); /* error */
314 g_mouse_detach(device_t dev)
316 struct g_mouse_softc *sc = device_get_softc(dev);
320 mtx_lock(&sc->sc_mtx);
321 usb_callout_stop(&sc->sc_button_press_callout);
322 usb_callout_stop(&sc->sc_cursor_update_callout);
323 mtx_unlock(&sc->sc_mtx);
325 usbd_transfer_unsetup(sc->sc_xfer, G_MOUSE_N_TRANSFER);
327 usb_callout_drain(&sc->sc_button_press_callout);
328 usb_callout_drain(&sc->sc_cursor_update_callout);
330 mtx_destroy(&sc->sc_mtx);
336 g_mouse_intr_callback(struct usb_xfer *xfer, usb_error_t error)
338 struct g_mouse_softc *sc = usbd_xfer_softc(xfer);
345 usbd_xfer_status(xfer, &actlen, NULL, &aframes, NULL);
347 DPRINTF("st=%d aframes=%d actlen=%d bytes\n",
348 USB_GET_STATE(xfer), aframes, actlen);
350 switch (USB_GET_STATE(xfer)) {
351 case USB_ST_TRANSFERRED:
352 if (!(sc->sc_do_cursor_update || sc->sc_do_button_update))
358 if (sc->sc_do_cursor_update) {
359 sc->sc_do_cursor_update = 0;
361 if ((sc->sc_tick < 0) || (sc->sc_tick > 7999))
365 if (sc->sc_do_button_update) {
366 sc->sc_do_button_update = 0;
367 sc->sc_data.buttons ^= BUT_0;
370 radius = sc->sc_radius;
372 switch (sc->sc_mode) {
373 case G_MOUSE_MODE_SILENT:
374 sc->sc_data.buttons = 0;
376 case G_MOUSE_MODE_SPIRAL:
377 radius = (radius * (8000-sc->sc_tick)) / 8000;
378 case G_MOUSE_MODE_CIRCLE:
380 sc->sc_curr_y_state = 0;
381 sc->sc_curr_x_state = 0;
383 case G_MOUSE_MODE_BOX:
384 if (sc->sc_tick < 2000) {
385 sc->sc_curr_x_state = (sc->sc_tick * radius) / 2000;
386 sc->sc_curr_y_state = 0;
387 } else if (sc->sc_tick < 4000) {
388 sc->sc_curr_x_state = radius;
389 sc->sc_curr_y_state = -(((sc->sc_tick - 2000) * radius) / 2000);
390 } else if (sc->sc_tick < 6000) {
391 sc->sc_curr_x_state = radius - (((sc->sc_tick - 4000) * radius) / 2000);
392 sc->sc_curr_y_state = -radius;
394 sc->sc_curr_x_state = 0;
395 sc->sc_curr_y_state = -radius + (((sc->sc_tick - 6000) * radius) / 2000);
402 dx = sc->sc_curr_x_state - sc->sc_last_x_state;
403 dy = sc->sc_curr_y_state - sc->sc_last_y_state;
415 sc->sc_last_x_state += dx;
416 sc->sc_last_y_state += dy;
421 usbd_xfer_set_frame_data(xfer, 0, &sc->sc_data, sizeof(sc->sc_data));
422 usbd_xfer_set_frames(xfer, 1);
423 usbd_transfer_submit(xfer);
427 DPRINTF("error=%s\n", usbd_errstr(error));
429 if (error != USB_ERR_CANCELLED) {
430 /* try to clear stall first */
431 usbd_xfer_set_stall(xfer);
439 g_mouse_handle_request(device_t dev,
440 const void *preq, void **pptr, uint16_t *plen,
441 uint16_t offset, uint8_t *pstate)
443 const struct usb_device_request *req = preq;
444 uint8_t is_complete = *pstate;
447 if ((req->bmRequestType == UT_WRITE_CLASS_INTERFACE) &&
448 (req->bRequest == UR_SET_PROTOCOL) &&
449 (req->wValue[0] == 0x00) &&
450 (req->wValue[1] == 0x00)) {
455 return (ENXIO); /* use builtin handler */