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
25 * $FreeBSD: head/sys/dev/usb/gadget/g_audio.c 269664 2014-08-07 12:47:25Z hselasky $
29 * USB audio specs: http://www.usb.org/developers/devclass_docs/audio10.pdf
30 * http://www.usb.org/developers/devclass_docs/frmts10.pdf
31 * http://www.usb.org/developers/devclass_docs/termt10.pdf
34 #include <sys/stdint.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/condvar.h>
43 #include <sys/sysctl.h>
44 #include <sys/unistd.h>
45 #include <sys/callout.h>
46 #include <sys/malloc.h>
49 #include <bus/u4b/usb.h>
50 #include <bus/u4b/usb_cdc.h>
51 #include <bus/u4b/usbdi.h>
52 #include <bus/u4b/usbdi_util.h>
53 #include <bus/u4b/usbhid.h>
56 #define USB_DEBUG_VAR g_audio_debug
57 #include <bus/u4b/usb_debug.h>
59 #include <bus/u4b/gadget/g_audio.h>
69 struct g_audio_softc {
71 struct usb_callout sc_callout;
72 struct usb_callout sc_watchdog;
73 struct usb_xfer *sc_xfer[G_AUDIO_N_TRANSFER];
82 int8_t sc_pattern[G_AUDIO_MAX_STRLEN];
84 uint16_t sc_data_len[2][G_AUDIO_FRAMES];
86 int16_t sc_data_buf[2][G_AUDIO_BUFSIZE / 2];
88 uint8_t sc_volume_setting[32];
89 uint8_t sc_volume_limit[32];
90 uint8_t sc_sample_rate[32];
93 static SYSCTL_NODE(_hw_usb, OID_AUTO, g_audio, CTLFLAG_RW, 0, "USB audio gadget");
96 static int g_audio_debug = 0;
98 SYSCTL_INT(_hw_usb_g_audio, OID_AUTO, debug, CTLFLAG_RW,
99 &g_audio_debug, 0, "Debug level");
102 static int g_audio_mode = 0;
104 SYSCTL_INT(_hw_usb_g_audio, OID_AUTO, mode, CTLFLAG_RW,
105 &g_audio_mode, 0, "Mode selection");
107 static int g_audio_pattern_interval = 1000;
109 SYSCTL_INT(_hw_usb_g_audio, OID_AUTO, pattern_interval, CTLFLAG_RW,
110 &g_audio_pattern_interval, 0, "Pattern interval in milliseconds");
112 static char g_audio_pattern_data[G_AUDIO_MAX_STRLEN];
114 SYSCTL_STRING(_hw_usb_g_audio, OID_AUTO, pattern, CTLFLAG_RW,
115 &g_audio_pattern_data, sizeof(g_audio_pattern_data), "Data pattern");
117 static int g_audio_throughput;
119 SYSCTL_INT(_hw_usb_g_audio, OID_AUTO, throughput, CTLFLAG_RD,
120 &g_audio_throughput, sizeof(g_audio_throughput), "Throughput in bytes per second");
122 static device_probe_t g_audio_probe;
123 static device_attach_t g_audio_attach;
124 static device_detach_t g_audio_detach;
125 static usb_handle_request_t g_audio_handle_request;
127 static usb_callback_t g_audio_isoc_read_callback;
128 static usb_callback_t g_audio_isoc_write_callback;
130 static devclass_t g_audio_devclass;
132 static void g_audio_watchdog(void *arg);
133 static void g_audio_timeout(void *arg);
135 static device_method_t g_audio_methods[] = {
137 DEVMETHOD(usb_handle_request, g_audio_handle_request),
139 /* Device interface */
140 DEVMETHOD(device_probe, g_audio_probe),
141 DEVMETHOD(device_attach, g_audio_attach),
142 DEVMETHOD(device_detach, g_audio_detach),
147 static driver_t g_audio_driver = {
149 .methods = g_audio_methods,
150 .size = sizeof(struct g_audio_softc),
153 DRIVER_MODULE(g_audio, uhub, g_audio_driver, g_audio_devclass, 0, 0);
154 MODULE_DEPEND(g_audio, usb, 1, 1, 1);
156 static const struct usb_config g_audio_config[G_AUDIO_N_TRANSFER] = {
158 [G_AUDIO_ISOC0_RD] = {
159 .type = UE_ISOCHRONOUS,
160 .endpoint = UE_ADDR_ANY,
161 .direction = UE_DIR_RX,
162 .flags = {.ext_buffer = 1,.pipe_bof = 1,.short_xfer_ok = 1,},
163 .bufsize = G_AUDIO_BUFSIZE,
164 .callback = &g_audio_isoc_read_callback,
165 .frames = G_AUDIO_FRAMES,
166 .usb_mode = USB_MODE_DEVICE,
170 [G_AUDIO_ISOC1_RD] = {
171 .type = UE_ISOCHRONOUS,
172 .endpoint = UE_ADDR_ANY,
173 .direction = UE_DIR_RX,
174 .flags = {.ext_buffer = 1,.pipe_bof = 1,.short_xfer_ok = 1,},
175 .bufsize = G_AUDIO_BUFSIZE,
176 .callback = &g_audio_isoc_read_callback,
177 .frames = G_AUDIO_FRAMES,
178 .usb_mode = USB_MODE_DEVICE,
182 [G_AUDIO_ISOC0_WR] = {
183 .type = UE_ISOCHRONOUS,
184 .endpoint = UE_ADDR_ANY,
185 .direction = UE_DIR_TX,
186 .flags = {.ext_buffer = 1,.pipe_bof = 1,},
187 .bufsize = G_AUDIO_BUFSIZE,
188 .callback = &g_audio_isoc_write_callback,
189 .frames = G_AUDIO_FRAMES,
190 .usb_mode = USB_MODE_DEVICE,
194 [G_AUDIO_ISOC1_WR] = {
195 .type = UE_ISOCHRONOUS,
196 .endpoint = UE_ADDR_ANY,
197 .direction = UE_DIR_TX,
198 .flags = {.ext_buffer = 1,.pipe_bof = 1,},
199 .bufsize = G_AUDIO_BUFSIZE,
200 .callback = &g_audio_isoc_write_callback,
201 .frames = G_AUDIO_FRAMES,
202 .usb_mode = USB_MODE_DEVICE,
208 g_audio_timeout_reset(struct g_audio_softc *sc)
210 int i = g_audio_pattern_interval;
212 sc->sc_tx_interval = i;
219 i = USB_MS_TO_TICKS(i);
221 usb_callout_reset(&sc->sc_callout, i, &g_audio_timeout, sc);
225 g_audio_timeout(void *arg)
227 struct g_audio_softc *sc = arg;
229 sc->sc_mode = g_audio_mode;
231 memcpy(sc->sc_pattern, g_audio_pattern_data, sizeof(sc->sc_pattern));
233 sc->sc_pattern[G_AUDIO_MAX_STRLEN - 1] = 0;
235 sc->sc_pattern_len = strlen(sc->sc_pattern);
237 if (sc->sc_mode != G_AUDIO_MODE_LOOP) {
238 usbd_transfer_start(sc->sc_xfer[G_AUDIO_ISOC0_WR]);
239 usbd_transfer_start(sc->sc_xfer[G_AUDIO_ISOC1_WR]);
241 g_audio_timeout_reset(sc);
245 g_audio_watchdog_reset(struct g_audio_softc *sc)
247 usb_callout_reset(&sc->sc_watchdog, hz, &g_audio_watchdog, sc);
251 g_audio_watchdog(void *arg)
253 struct g_audio_softc *sc = arg;
256 i = sc->sc_throughput;
258 sc->sc_throughput = 0;
260 g_audio_throughput = i;
262 g_audio_watchdog_reset(sc);
266 g_audio_probe(device_t dev)
268 struct usb_attach_arg *uaa = device_get_ivars(dev);
272 if (uaa->usb_mode != USB_MODE_DEVICE)
275 if ((uaa->info.bInterfaceClass == UICLASS_AUDIO) &&
276 (uaa->info.bInterfaceSubClass == UISUBCLASS_AUDIOCONTROL))
283 g_audio_attach(device_t dev)
285 struct g_audio_softc *sc = device_get_softc(dev);
286 struct usb_attach_arg *uaa = device_get_ivars(dev);
289 uint8_t iface_index[3];
293 device_set_usb_desc(dev);
295 lockinit(&sc->sc_lock, "g_audio", 0, 0);
297 usb_callout_init_mtx(&sc->sc_callout, &sc->sc_lock, 0);
298 usb_callout_init_mtx(&sc->sc_watchdog, &sc->sc_lock, 0);
300 sc->sc_mode = G_AUDIO_MODE_SILENT;
302 sc->sc_noise_rem = 1;
304 for (i = 0; i != G_AUDIO_FRAMES; i++) {
305 sc->sc_data_len[0][i] = G_AUDIO_BUFSIZE / G_AUDIO_FRAMES;
306 sc->sc_data_len[1][i] = G_AUDIO_BUFSIZE / G_AUDIO_FRAMES;
309 iface_index[0] = uaa->info.bIfaceIndex;
310 iface_index[1] = uaa->info.bIfaceIndex + 1;
311 iface_index[2] = uaa->info.bIfaceIndex + 2;
313 error = usbd_set_alt_interface_index(uaa->device, iface_index[1], 1);
315 DPRINTF("alt iface setting error=%s\n", usbd_errstr(error));
318 error = usbd_set_alt_interface_index(uaa->device, iface_index[2], 1);
320 DPRINTF("alt iface setting error=%s\n", usbd_errstr(error));
323 error = usbd_transfer_setup(uaa->device,
324 iface_index, sc->sc_xfer, g_audio_config,
325 G_AUDIO_N_TRANSFER, sc, &sc->sc_lock);
328 DPRINTF("error=%s\n", usbd_errstr(error));
331 usbd_set_parent_iface(uaa->device, iface_index[1], iface_index[0]);
332 usbd_set_parent_iface(uaa->device, iface_index[2], iface_index[0]);
334 lockmgr(&sc->sc_lock, LK_EXCLUSIVE);
336 usbd_transfer_start(sc->sc_xfer[G_AUDIO_ISOC0_RD]);
337 usbd_transfer_start(sc->sc_xfer[G_AUDIO_ISOC1_RD]);
339 usbd_transfer_start(sc->sc_xfer[G_AUDIO_ISOC0_WR]);
340 usbd_transfer_start(sc->sc_xfer[G_AUDIO_ISOC1_WR]);
342 g_audio_timeout_reset(sc);
344 g_audio_watchdog_reset(sc);
346 lockmgr(&sc->sc_lock, LK_RELEASE);
348 return (0); /* success */
353 return (ENXIO); /* error */
357 g_audio_detach(device_t dev)
359 struct g_audio_softc *sc = device_get_softc(dev);
363 lockmgr(&sc->sc_lock, LK_EXCLUSIVE);
364 usb_callout_stop(&sc->sc_callout);
365 usb_callout_stop(&sc->sc_watchdog);
366 lockmgr(&sc->sc_lock, LK_RELEASE);
368 usbd_transfer_unsetup(sc->sc_xfer, G_AUDIO_N_TRANSFER);
370 usb_callout_drain(&sc->sc_callout);
371 usb_callout_drain(&sc->sc_watchdog);
373 lockuninit(&sc->sc_lock);
380 g_noise(struct g_audio_softc *sc)
383 const uint32_t prime = 0xFFFF1D;
385 if (sc->sc_noise_rem & 1) {
386 sc->sc_noise_rem += prime;
388 sc->sc_noise_rem /= 2;
390 temp = sc->sc_noise_rem;
392 /* unsigned to signed conversion */
395 if (temp & 0x800000) {
402 g_audio_make_samples(struct g_audio_softc *sc, int16_t *ptr, int samples)
407 for (i = 0; i != samples; i++) {
411 if ((sc->sc_state < 0) || (sc->sc_state >= sc->sc_pattern_len))
414 if (sc->sc_pattern_len != 0) {
415 j = (j * sc->sc_pattern[sc->sc_state]) >> 16;
424 g_audio_isoc_write_callback(struct usb_xfer *xfer, usb_error_t error)
426 struct g_audio_softc *sc = usbd_xfer_softc(xfer);
429 int nr = (xfer == sc->sc_xfer[G_AUDIO_ISOC0_WR]) ? 0 : 1;
433 usbd_xfer_status(xfer, &actlen, NULL, &aframes, NULL);
435 DPRINTF("st=%d aframes=%d actlen=%d bytes\n",
436 USB_GET_STATE(xfer), aframes, actlen);
438 switch (USB_GET_STATE(xfer)) {
439 case USB_ST_TRANSFERRED:
441 sc->sc_throughput += actlen;
443 if (sc->sc_mode == G_AUDIO_MODE_LOOP)
444 break; /* sync with RX */
449 ptr = sc->sc_data_buf[nr];
451 if (sc->sc_mode == G_AUDIO_MODE_PATTERN) {
453 for (i = 0; i != G_AUDIO_FRAMES; i++) {
455 usbd_xfer_set_frame_data(xfer, i, ptr, sc->sc_data_len[nr][i]);
457 g_audio_make_samples(sc, ptr, (G_AUDIO_BUFSIZE / G_AUDIO_FRAMES) / 2);
459 ptr += (G_AUDIO_BUFSIZE / G_AUDIO_FRAMES) / 2;
461 } else if (sc->sc_mode == G_AUDIO_MODE_LOOP) {
463 for (i = 0; i != G_AUDIO_FRAMES; i++) {
465 usbd_xfer_set_frame_data(xfer, i, ptr, sc->sc_data_len[nr][i] & ~3);
467 g_audio_make_samples(sc, ptr, sc->sc_data_len[nr][i] / 4);
469 ptr += (G_AUDIO_BUFSIZE / G_AUDIO_FRAMES) / 2;
475 DPRINTF("error=%s\n", usbd_errstr(error));
477 if (error != USB_ERR_CANCELLED) {
478 /* try to clear stall first */
479 usbd_xfer_set_stall(xfer);
487 g_audio_isoc_read_callback(struct usb_xfer *xfer, usb_error_t error)
489 struct g_audio_softc *sc = usbd_xfer_softc(xfer);
492 int nr = (xfer == sc->sc_xfer[G_AUDIO_ISOC0_RD]) ? 0 : 1;
496 usbd_xfer_status(xfer, &actlen, NULL, &aframes, NULL);
498 DPRINTF("st=%d aframes=%d actlen=%d bytes\n",
499 USB_GET_STATE(xfer), aframes, actlen);
501 switch (USB_GET_STATE(xfer)) {
502 case USB_ST_TRANSFERRED:
504 sc->sc_throughput += actlen;
506 for (i = 0; i != G_AUDIO_FRAMES; i++) {
507 sc->sc_data_len[nr][i] = usbd_xfer_frame_len(xfer, i);
510 usbd_transfer_start(sc->sc_xfer[G_AUDIO_ISOC0_WR]);
511 usbd_transfer_start(sc->sc_xfer[G_AUDIO_ISOC1_WR]);
517 ptr = sc->sc_data_buf[nr];
519 for (i = 0; i != G_AUDIO_FRAMES; i++) {
521 usbd_xfer_set_frame_data(xfer, i, ptr,
522 G_AUDIO_BUFSIZE / G_AUDIO_FRAMES);
524 ptr += (G_AUDIO_BUFSIZE / G_AUDIO_FRAMES) / 2;
527 usbd_transfer_submit(xfer);
531 DPRINTF("error=%s\n", usbd_errstr(error));
533 if (error != USB_ERR_CANCELLED) {
534 /* try to clear stall first */
535 usbd_xfer_set_stall(xfer);
544 g_audio_handle_request(device_t dev,
545 const void *preq, void **pptr, uint16_t *plen,
546 uint16_t offset, uint8_t *pstate)
548 struct g_audio_softc *sc = device_get_softc(dev);
549 const struct usb_device_request *req = preq;
550 uint8_t is_complete = *pstate;
553 if ((req->bmRequestType == UT_READ_CLASS_INTERFACE) &&
554 (req->bRequest == 0x82 /* get min */ )) {
557 USETW(sc->sc_volume_limit, 0);
559 *pptr = &sc->sc_volume_limit;
564 } else if ((req->bmRequestType == UT_READ_CLASS_INTERFACE) &&
565 (req->bRequest == 0x83 /* get max */ )) {
568 USETW(sc->sc_volume_limit, 0x2000);
570 *pptr = &sc->sc_volume_limit;
575 } else if ((req->bmRequestType == UT_READ_CLASS_INTERFACE) &&
576 (req->bRequest == 0x84 /* get residue */ )) {
579 USETW(sc->sc_volume_limit, 1);
581 *pptr = &sc->sc_volume_limit;
586 } else if ((req->bmRequestType == UT_READ_CLASS_INTERFACE) &&
587 (req->bRequest == 0x81 /* get value */ )) {
590 USETW(sc->sc_volume_setting, 0x2000);
591 *plen = sizeof(sc->sc_volume_setting);
592 *pptr = &sc->sc_volume_setting;
597 } else if ((req->bmRequestType == UT_WRITE_CLASS_INTERFACE) &&
598 (req->bRequest == 0x01 /* set value */ )) {
601 *plen = sizeof(sc->sc_volume_setting);
602 *pptr = &sc->sc_volume_setting;
607 } else if ((req->bmRequestType == UT_WRITE_CLASS_ENDPOINT) &&
608 (req->bRequest == 0x01 /* set value */ )) {
611 *plen = sizeof(sc->sc_sample_rate);
612 *pptr = &sc->sc_sample_rate;
619 return (ENXIO); /* use builtin handler */