From owner-svn-src-head@FreeBSD.ORG Mon Jul 22 13:39:34 2013 Return-Path: Delivered-To: svn-src-head@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by hub.freebsd.org (Postfix) with ESMTP id 627D7D0E; Mon, 22 Jul 2013 13:39:34 +0000 (UTC) (envelope-from hselasky@FreeBSD.org) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:1900:2254:2068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mx1.freebsd.org (Postfix) with ESMTPS id 441A42ECE; Mon, 22 Jul 2013 13:39:34 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.7/8.14.7) with ESMTP id r6MDdY6C078042; Mon, 22 Jul 2013 13:39:34 GMT (envelope-from hselasky@svn.freebsd.org) Received: (from hselasky@localhost) by svn.freebsd.org (8.14.7/8.14.5/Submit) id r6MDdXWc078038; Mon, 22 Jul 2013 13:39:33 GMT (envelope-from hselasky@svn.freebsd.org) Message-Id: <201307221339.r6MDdXWc078038@svn.freebsd.org> From: Hans Petter Selasky Date: Mon, 22 Jul 2013 13:39:33 +0000 (UTC) To: src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org Subject: svn commit: r253544 - in head/sys: dev/usb/gadget modules/usb modules/usb/g_audio modules/usb/g_keyboard modules/usb/g_modem modules/usb/g_mouse X-SVN-Group: head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-src-head@freebsd.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: SVN commit messages for the src tree for head/-current List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 22 Jul 2013 13:39:34 -0000 Author: hselasky Date: Mon Jul 22 13:39:33 2013 New Revision: 253544 URL: http://svnweb.freebsd.org/changeset/base/253544 Log: Add some USB gadget example drivers for USB audio, USB keyboard, USB mouse and USB modem classes. Hopefully someone will find these examples useful when implementing USB device side drivers using the FreeBSD USB stack. Added: head/sys/dev/usb/gadget/ head/sys/dev/usb/gadget/g_audio.c (contents, props changed) head/sys/dev/usb/gadget/g_audio.h (contents, props changed) head/sys/dev/usb/gadget/g_keyboard.c (contents, props changed) head/sys/dev/usb/gadget/g_keyboard.h (contents, props changed) head/sys/dev/usb/gadget/g_modem.c (contents, props changed) head/sys/dev/usb/gadget/g_modem.h (contents, props changed) head/sys/dev/usb/gadget/g_mouse.c (contents, props changed) head/sys/dev/usb/gadget/g_mouse.h (contents, props changed) head/sys/modules/usb/g_audio/ head/sys/modules/usb/g_audio/Makefile (contents, props changed) head/sys/modules/usb/g_keyboard/ head/sys/modules/usb/g_keyboard/Makefile (contents, props changed) head/sys/modules/usb/g_modem/ head/sys/modules/usb/g_modem/Makefile (contents, props changed) head/sys/modules/usb/g_mouse/ head/sys/modules/usb/g_mouse/Makefile (contents, props changed) Modified: head/sys/modules/usb/Makefile Added: head/sys/dev/usb/gadget/g_audio.c ============================================================================== --- /dev/null 00:00:00 1970 (empty, because file is newly added) +++ head/sys/dev/usb/gadget/g_audio.c Mon Jul 22 13:39:33 2013 (r253544) @@ -0,0 +1,613 @@ +/* $FreeBSD$ */ +/*- + * Copyright (c) 2010 Hans Petter Selasky. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + */ + +/* + * USB audio specs: http://www.usb.org/developers/devclass_docs/audio10.pdf + * http://www.usb.org/developers/devclass_docs/frmts10.pdf + * http://www.usb.org/developers/devclass_docs/termt10.pdf + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include "usb_if.h" + +#define USB_DEBUG_VAR g_audio_debug +#include + +#include + +enum { + G_AUDIO_ISOC0_RD, + G_AUDIO_ISOC1_RD, + G_AUDIO_ISOC0_WR, + G_AUDIO_ISOC1_WR, + G_AUDIO_N_TRANSFER, +}; + +struct g_audio_softc { + struct mtx sc_mtx; + struct usb_callout sc_callout; + struct usb_callout sc_watchdog; + struct usb_xfer *sc_xfer[G_AUDIO_N_TRANSFER]; + + int sc_mode; + int sc_pattern_len; + int sc_throughput; + int sc_tx_interval; + int sc_state; + int sc_noise_rem; + + int8_t sc_pattern[G_AUDIO_MAX_STRLEN]; + + uint16_t sc_data_len[2][G_AUDIO_FRAMES]; + + int16_t sc_data_buf[2][G_AUDIO_BUFSIZE / 2]; + + uint8_t sc_volume_setting[32]; + uint8_t sc_volume_limit[32]; + uint8_t sc_sample_rate[32]; +}; + +static SYSCTL_NODE(_hw_usb, OID_AUTO, g_audio, CTLFLAG_RW, 0, "USB audio gadget"); + +#ifdef USB_DEBUG +static int g_audio_debug = 0; + +SYSCTL_INT(_hw_usb_g_audio, OID_AUTO, debug, CTLFLAG_RW, + &g_audio_debug, 0, "Debug level"); +#endif + +static int g_audio_mode = 0; + +SYSCTL_INT(_hw_usb_g_audio, OID_AUTO, mode, CTLFLAG_RW, + &g_audio_mode, 0, "Mode selection"); + +static int g_audio_pattern_interval = 1000; + +SYSCTL_INT(_hw_usb_g_audio, OID_AUTO, pattern_interval, CTLFLAG_RW, + &g_audio_pattern_interval, 0, "Pattern interval in milliseconds"); + +static char g_audio_pattern_data[G_AUDIO_MAX_STRLEN]; + +SYSCTL_STRING(_hw_usb_g_audio, OID_AUTO, pattern, CTLFLAG_RW, + &g_audio_pattern_data, sizeof(g_audio_pattern_data), "Data pattern"); + +static int g_audio_throughput; + +SYSCTL_INT(_hw_usb_g_audio, OID_AUTO, throughput, CTLFLAG_RD, + &g_audio_throughput, sizeof(g_audio_throughput), "Throughput in bytes per second"); + +static device_probe_t g_audio_probe; +static device_attach_t g_audio_attach; +static device_detach_t g_audio_detach; +static usb_handle_request_t g_audio_handle_request; + +static usb_callback_t g_audio_isoc_read_callback; +static usb_callback_t g_audio_isoc_write_callback; + +static devclass_t g_audio_devclass; + +static void g_audio_watchdog(void *arg); +static void g_audio_timeout(void *arg); + +static device_method_t g_audio_methods[] = { + /* USB interface */ + DEVMETHOD(usb_handle_request, g_audio_handle_request), + + /* Device interface */ + DEVMETHOD(device_probe, g_audio_probe), + DEVMETHOD(device_attach, g_audio_attach), + DEVMETHOD(device_detach, g_audio_detach), + + DEVMETHOD_END +}; + +static driver_t g_audio_driver = { + .name = "g_audio", + .methods = g_audio_methods, + .size = sizeof(struct g_audio_softc), +}; + +DRIVER_MODULE(g_audio, uhub, g_audio_driver, g_audio_devclass, 0, 0); +MODULE_DEPEND(g_audio, usb, 1, 1, 1); + +static const struct usb_config g_audio_config[G_AUDIO_N_TRANSFER] = { + + [G_AUDIO_ISOC0_RD] = { + .type = UE_ISOCHRONOUS, + .endpoint = UE_ADDR_ANY, + .direction = UE_DIR_RX, + .flags = {.ext_buffer = 1,.pipe_bof = 1,.short_xfer_ok = 1,}, + .bufsize = G_AUDIO_BUFSIZE, + .callback = &g_audio_isoc_read_callback, + .frames = G_AUDIO_FRAMES, + .usb_mode = USB_MODE_DEVICE, + .if_index = 1, + }, + + [G_AUDIO_ISOC1_RD] = { + .type = UE_ISOCHRONOUS, + .endpoint = UE_ADDR_ANY, + .direction = UE_DIR_RX, + .flags = {.ext_buffer = 1,.pipe_bof = 1,.short_xfer_ok = 1,}, + .bufsize = G_AUDIO_BUFSIZE, + .callback = &g_audio_isoc_read_callback, + .frames = G_AUDIO_FRAMES, + .usb_mode = USB_MODE_DEVICE, + .if_index = 1, + }, + + [G_AUDIO_ISOC0_WR] = { + .type = UE_ISOCHRONOUS, + .endpoint = UE_ADDR_ANY, + .direction = UE_DIR_TX, + .flags = {.ext_buffer = 1,.pipe_bof = 1,}, + .bufsize = G_AUDIO_BUFSIZE, + .callback = &g_audio_isoc_write_callback, + .frames = G_AUDIO_FRAMES, + .usb_mode = USB_MODE_DEVICE, + .if_index = 2, + }, + + [G_AUDIO_ISOC1_WR] = { + .type = UE_ISOCHRONOUS, + .endpoint = UE_ADDR_ANY, + .direction = UE_DIR_TX, + .flags = {.ext_buffer = 1,.pipe_bof = 1,}, + .bufsize = G_AUDIO_BUFSIZE, + .callback = &g_audio_isoc_write_callback, + .frames = G_AUDIO_FRAMES, + .usb_mode = USB_MODE_DEVICE, + .if_index = 2, + }, +}; + +static void +g_audio_timeout_reset(struct g_audio_softc *sc) +{ + int i = g_audio_pattern_interval; + + sc->sc_tx_interval = i; + + if (i <= 0) + i = 1; + else if (i > 1023) + i = 1023; + + i = USB_MS_TO_TICKS(i); + + usb_callout_reset(&sc->sc_callout, i, &g_audio_timeout, sc); +} + +static void +g_audio_timeout(void *arg) +{ + struct g_audio_softc *sc = arg; + + sc->sc_mode = g_audio_mode; + + memcpy(sc->sc_pattern, g_audio_pattern_data, sizeof(sc->sc_pattern)); + + sc->sc_pattern[G_AUDIO_MAX_STRLEN - 1] = 0; + + sc->sc_pattern_len = strlen(sc->sc_pattern); + + if (sc->sc_mode != G_AUDIO_MODE_LOOP) { + usbd_transfer_start(sc->sc_xfer[G_AUDIO_ISOC0_WR]); + usbd_transfer_start(sc->sc_xfer[G_AUDIO_ISOC1_WR]); + } + g_audio_timeout_reset(sc); +} + +static void +g_audio_watchdog_reset(struct g_audio_softc *sc) +{ + usb_callout_reset(&sc->sc_watchdog, hz, &g_audio_watchdog, sc); +} + +static void +g_audio_watchdog(void *arg) +{ + struct g_audio_softc *sc = arg; + int i; + + i = sc->sc_throughput; + + sc->sc_throughput = 0; + + g_audio_throughput = i; + + g_audio_watchdog_reset(sc); +} + +static int +g_audio_probe(device_t dev) +{ + struct usb_attach_arg *uaa = device_get_ivars(dev); + + DPRINTFN(11, "\n"); + + if (uaa->usb_mode != USB_MODE_DEVICE) + return (ENXIO); + + if ((uaa->info.bInterfaceClass == UICLASS_AUDIO) && + (uaa->info.bInterfaceSubClass == UISUBCLASS_AUDIOCONTROL)) + return (0); + + return (ENXIO); +} + +static int +g_audio_attach(device_t dev) +{ + struct g_audio_softc *sc = device_get_softc(dev); + struct usb_attach_arg *uaa = device_get_ivars(dev); + int error; + int i; + uint8_t iface_index[3]; + + DPRINTFN(11, "\n"); + + device_set_usb_desc(dev); + + mtx_init(&sc->sc_mtx, "g_audio", NULL, MTX_DEF); + + usb_callout_init_mtx(&sc->sc_callout, &sc->sc_mtx, 0); + usb_callout_init_mtx(&sc->sc_watchdog, &sc->sc_mtx, 0); + + sc->sc_mode = G_AUDIO_MODE_SILENT; + + sc->sc_noise_rem = 1; + + for (i = 0; i != G_AUDIO_FRAMES; i++) { + sc->sc_data_len[0][i] = G_AUDIO_BUFSIZE / G_AUDIO_FRAMES; + sc->sc_data_len[1][i] = G_AUDIO_BUFSIZE / G_AUDIO_FRAMES; + } + + iface_index[0] = uaa->info.bIfaceIndex; + iface_index[1] = uaa->info.bIfaceIndex + 1; + iface_index[2] = uaa->info.bIfaceIndex + 2; + + error = usbd_set_alt_interface_index(uaa->device, iface_index[1], 1); + if (error) { + DPRINTF("alt iface setting error=%s\n", usbd_errstr(error)); + goto detach; + } + error = usbd_set_alt_interface_index(uaa->device, iface_index[2], 1); + if (error) { + DPRINTF("alt iface setting error=%s\n", usbd_errstr(error)); + goto detach; + } + error = usbd_transfer_setup(uaa->device, + iface_index, sc->sc_xfer, g_audio_config, + G_AUDIO_N_TRANSFER, sc, &sc->sc_mtx); + + if (error) { + DPRINTF("error=%s\n", usbd_errstr(error)); + goto detach; + } + usbd_set_parent_iface(uaa->device, iface_index[1], iface_index[0]); + usbd_set_parent_iface(uaa->device, iface_index[2], iface_index[0]); + + mtx_lock(&sc->sc_mtx); + + usbd_transfer_start(sc->sc_xfer[G_AUDIO_ISOC0_RD]); + usbd_transfer_start(sc->sc_xfer[G_AUDIO_ISOC1_RD]); + + usbd_transfer_start(sc->sc_xfer[G_AUDIO_ISOC0_WR]); + usbd_transfer_start(sc->sc_xfer[G_AUDIO_ISOC1_WR]); + + g_audio_timeout_reset(sc); + + g_audio_watchdog_reset(sc); + + mtx_unlock(&sc->sc_mtx); + + return (0); /* success */ + +detach: + g_audio_detach(dev); + + return (ENXIO); /* error */ +} + +static int +g_audio_detach(device_t dev) +{ + struct g_audio_softc *sc = device_get_softc(dev); + + DPRINTF("\n"); + + mtx_lock(&sc->sc_mtx); + usb_callout_stop(&sc->sc_callout); + usb_callout_stop(&sc->sc_watchdog); + mtx_unlock(&sc->sc_mtx); + + usbd_transfer_unsetup(sc->sc_xfer, G_AUDIO_N_TRANSFER); + + usb_callout_drain(&sc->sc_callout); + usb_callout_drain(&sc->sc_watchdog); + + mtx_destroy(&sc->sc_mtx); + + return (0); +} + + +static int32_t +g_noise(struct g_audio_softc *sc) +{ + uint32_t temp; + const uint32_t prime = 0xFFFF1D; + + if (sc->sc_noise_rem & 1) { + sc->sc_noise_rem += prime; + } + sc->sc_noise_rem /= 2; + + temp = sc->sc_noise_rem; + + /* unsigned to signed conversion */ + + temp ^= 0x800000; + if (temp & 0x800000) { + temp |= (-0x800000); + } + return temp; +} + +static void +g_audio_make_samples(struct g_audio_softc *sc, int16_t *ptr, int samples) +{ + int i; + int j; + + for (i = 0; i != samples; i++) { + + j = g_noise(sc); + + if ((sc->sc_state < 0) || (sc->sc_state >= sc->sc_pattern_len)) + sc->sc_state = 0; + + if (sc->sc_pattern_len != 0) { + j = (j * sc->sc_pattern[sc->sc_state]) >> 16; + sc->sc_state++; + } + *ptr++ = j / 256; + *ptr++ = j / 256; + } +} + +static void +g_audio_isoc_write_callback(struct usb_xfer *xfer, usb_error_t error) +{ + struct g_audio_softc *sc = usbd_xfer_softc(xfer); + int actlen; + int aframes; + int nr = (xfer == sc->sc_xfer[G_AUDIO_ISOC0_WR]) ? 0 : 1; + int16_t *ptr; + int i; + + usbd_xfer_status(xfer, &actlen, NULL, &aframes, NULL); + + DPRINTF("st=%d aframes=%d actlen=%d bytes\n", + USB_GET_STATE(xfer), aframes, actlen); + + switch (USB_GET_STATE(xfer)) { + case USB_ST_TRANSFERRED: + + sc->sc_throughput += actlen; + + if (sc->sc_mode == G_AUDIO_MODE_LOOP) + break; /* sync with RX */ + + case USB_ST_SETUP: +tr_setup: + + ptr = sc->sc_data_buf[nr]; + + if (sc->sc_mode == G_AUDIO_MODE_PATTERN) { + + for (i = 0; i != G_AUDIO_FRAMES; i++) { + + usbd_xfer_set_frame_data(xfer, i, ptr, sc->sc_data_len[nr][i]); + + g_audio_make_samples(sc, ptr, (G_AUDIO_BUFSIZE / G_AUDIO_FRAMES) / 2); + + ptr += (G_AUDIO_BUFSIZE / G_AUDIO_FRAMES) / 2; + } + } else if (sc->sc_mode == G_AUDIO_MODE_LOOP) { + + for (i = 0; i != G_AUDIO_FRAMES; i++) { + + usbd_xfer_set_frame_data(xfer, i, ptr, sc->sc_data_len[nr][i] & ~3); + + g_audio_make_samples(sc, ptr, sc->sc_data_len[nr][i] / 4); + + ptr += (G_AUDIO_BUFSIZE / G_AUDIO_FRAMES) / 2; + } + } + break; + + default: /* Error */ + DPRINTF("error=%s\n", usbd_errstr(error)); + + if (error != USB_ERR_CANCELLED) { + /* try to clear stall first */ + usbd_xfer_set_stall(xfer); + goto tr_setup; + } + break; + } +} + +static void +g_audio_isoc_read_callback(struct usb_xfer *xfer, usb_error_t error) +{ + struct g_audio_softc *sc = usbd_xfer_softc(xfer); + int actlen; + int aframes; + int nr = (xfer == sc->sc_xfer[G_AUDIO_ISOC0_RD]) ? 0 : 1; + int16_t *ptr; + int i; + + usbd_xfer_status(xfer, &actlen, NULL, &aframes, NULL); + + DPRINTF("st=%d aframes=%d actlen=%d bytes\n", + USB_GET_STATE(xfer), aframes, actlen); + + switch (USB_GET_STATE(xfer)) { + case USB_ST_TRANSFERRED: + + sc->sc_throughput += actlen; + + for (i = 0; i != G_AUDIO_FRAMES; i++) { + sc->sc_data_len[nr][i] = usbd_xfer_frame_len(xfer, i); + } + + usbd_transfer_start(sc->sc_xfer[G_AUDIO_ISOC0_WR]); + usbd_transfer_start(sc->sc_xfer[G_AUDIO_ISOC1_WR]); + + break; + + case USB_ST_SETUP: +tr_setup: + ptr = sc->sc_data_buf[nr]; + + for (i = 0; i != G_AUDIO_FRAMES; i++) { + + usbd_xfer_set_frame_data(xfer, i, ptr, + G_AUDIO_BUFSIZE / G_AUDIO_FRAMES); + + ptr += (G_AUDIO_BUFSIZE / G_AUDIO_FRAMES) / 2; + } + + usbd_transfer_submit(xfer); + break; + + default: /* Error */ + DPRINTF("error=%s\n", usbd_errstr(error)); + + if (error != USB_ERR_CANCELLED) { + /* try to clear stall first */ + usbd_xfer_set_stall(xfer); + goto tr_setup; + } + break; + } +} + + +static int +g_audio_handle_request(device_t dev, + const void *preq, void **pptr, uint16_t *plen, + uint16_t offset, uint8_t *pstate) +{ + struct g_audio_softc *sc = device_get_softc(dev); + const struct usb_device_request *req = preq; + uint8_t is_complete = *pstate; + + if (!is_complete) { + if ((req->bmRequestType == UT_READ_CLASS_INTERFACE) && + (req->bRequest == 0x82 /* get min */ )) { + + if (offset == 0) { + USETW(sc->sc_volume_limit, 0); + *plen = 2; + *pptr = &sc->sc_volume_limit; + } else { + *plen = 0; + } + return (0); + } else if ((req->bmRequestType == UT_READ_CLASS_INTERFACE) && + (req->bRequest == 0x83 /* get max */ )) { + + if (offset == 0) { + USETW(sc->sc_volume_limit, 0x2000); + *plen = 2; + *pptr = &sc->sc_volume_limit; + } else { + *plen = 0; + } + return (0); + } else if ((req->bmRequestType == UT_READ_CLASS_INTERFACE) && + (req->bRequest == 0x84 /* get residue */ )) { + + if (offset == 0) { + USETW(sc->sc_volume_limit, 0); + *plen = 2; + *pptr = &sc->sc_volume_limit; + } else { + *plen = 0; + } + return (0); + } else if ((req->bmRequestType == UT_WRITE_CLASS_INTERFACE) && + (req->bRequest == 0x01 /* set value */ )) { + + if (offset == 0) { + *plen = sizeof(sc->sc_volume_setting); + *pptr = &sc->sc_volume_setting; + } else { + *plen = 0; + } + return (0); + } else if ((req->bmRequestType == UT_WRITE_CLASS_ENDPOINT) && + (req->bRequest == 0x01 /* set value */ )) { + + if (offset == 0) { + *plen = sizeof(sc->sc_sample_rate); + *pptr = &sc->sc_sample_rate; + } else { + *plen = 0; + } + return (0); + } + } + return (ENXIO); /* use builtin handler */ +} Added: head/sys/dev/usb/gadget/g_audio.h ============================================================================== --- /dev/null 00:00:00 1970 (empty, because file is newly added) +++ head/sys/dev/usb/gadget/g_audio.h Mon Jul 22 13:39:33 2013 (r253544) @@ -0,0 +1,40 @@ +/* $FreeBSD$ */ +/*- + * Copyright (c) 2010 Hans Petter Selasky. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + */ + +#ifndef _G_AUDIO_H_ +#define _G_AUDIO_H_ + +#define G_AUDIO_MAX_STRLEN 32 /* chars */ +#define G_AUDIO_FRAMES 8 +#define G_AUDIO_BUFSIZE (G_AUDIO_FRAMES * 2 * 2 * 48) /* units */ + +#define G_AUDIO_MODE_SILENT 0 +#define G_AUDIO_MODE_DUMP 1 +#define G_AUDIO_MODE_LOOP 2 +#define G_AUDIO_MODE_PATTERN 3 +#define G_AUDIO_MODE_MAX 4 + +#endif /* _G_AUDIO_H_ */ Added: head/sys/dev/usb/gadget/g_keyboard.c ============================================================================== --- /dev/null 00:00:00 1970 (empty, because file is newly added) +++ head/sys/dev/usb/gadget/g_keyboard.c Mon Jul 22 13:39:33 2013 (r253544) @@ -0,0 +1,411 @@ +/* $FreeBSD$ */ +/*- + * Copyright (c) 2010 Hans Petter Selasky. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + */ + +/* + * HID spec: http://www.usb.org/developers/devclass_docs/HID1_11.pdf + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include "usb_if.h" + +#define USB_DEBUG_VAR g_keyboard_debug +#include + +#include + +static SYSCTL_NODE(_hw_usb, OID_AUTO, g_keyboard, CTLFLAG_RW, 0, "USB keyboard gadget"); + +#ifdef USB_DEBUG +static int g_keyboard_debug = 0; + +SYSCTL_INT(_hw_usb_g_keyboard, OID_AUTO, debug, CTLFLAG_RW, + &g_keyboard_debug, 0, "Debug level"); +#endif + +static int g_keyboard_mode = 0; + +SYSCTL_INT(_hw_usb_g_keyboard, OID_AUTO, mode, CTLFLAG_RW, + &g_keyboard_mode, 0, "Mode selection"); + +static int g_keyboard_key_press_interval = 1000; + +SYSCTL_INT(_hw_usb_g_keyboard, OID_AUTO, key_press_interval, CTLFLAG_RW, + &g_keyboard_key_press_interval, 0, "Key Press Interval in milliseconds"); + +static char g_keyboard_key_press_pattern[G_KEYBOARD_MAX_STRLEN]; + +SYSCTL_STRING(_hw_usb_g_keyboard, OID_AUTO, key_press_pattern, CTLFLAG_RW, + g_keyboard_key_press_pattern, sizeof(g_keyboard_key_press_pattern), + "Key Press Patterns"); + +#define UPROTO_BOOT_KEYBOARD 1 + +#define G_KEYBOARD_NMOD 8 /* units */ +#define G_KEYBOARD_NKEYCODE 6 /* units */ + +struct g_keyboard_data { + uint8_t modifiers; +#define MOD_CONTROL_L 0x01 +#define MOD_CONTROL_R 0x10 +#define MOD_SHIFT_L 0x02 +#define MOD_SHIFT_R 0x20 +#define MOD_ALT_L 0x04 +#define MOD_ALT_R 0x40 +#define MOD_WIN_L 0x08 +#define MOD_WIN_R 0x80 + uint8_t reserved; + uint8_t keycode[G_KEYBOARD_NKEYCODE]; +}; + +enum { + G_KEYBOARD_INTR_DT, + G_KEYBOARD_N_TRANSFER, +}; + +struct g_keyboard_softc { + struct mtx sc_mtx; + struct usb_callout sc_callout; + struct g_keyboard_data sc_data[2]; + struct usb_xfer *sc_xfer[G_KEYBOARD_N_TRANSFER]; + + int sc_mode; + int sc_state; + int sc_pattern_len; + + char sc_pattern[G_KEYBOARD_MAX_STRLEN]; + + uint8_t sc_led_state[4]; +}; + +static device_probe_t g_keyboard_probe; +static device_attach_t g_keyboard_attach; +static device_detach_t g_keyboard_detach; +static usb_handle_request_t g_keyboard_handle_request; +static usb_callback_t g_keyboard_intr_callback; + +static devclass_t g_keyboard_devclass; + +static device_method_t g_keyboard_methods[] = { + /* USB interface */ + DEVMETHOD(usb_handle_request, g_keyboard_handle_request), + + /* Device interface */ + DEVMETHOD(device_probe, g_keyboard_probe), + DEVMETHOD(device_attach, g_keyboard_attach), + DEVMETHOD(device_detach, g_keyboard_detach), + + DEVMETHOD_END +}; + +static driver_t g_keyboard_driver = { + .name = "g_keyboard", + .methods = g_keyboard_methods, + .size = sizeof(struct g_keyboard_softc), +}; + +DRIVER_MODULE(g_keyboard, uhub, g_keyboard_driver, g_keyboard_devclass, 0, 0); +MODULE_DEPEND(g_keyboard, usb, 1, 1, 1); + +static const struct usb_config g_keyboard_config[G_KEYBOARD_N_TRANSFER] = { + [G_KEYBOARD_INTR_DT] = { + .type = UE_INTERRUPT, + .endpoint = UE_ADDR_ANY, + .direction = UE_DIR_IN, + .flags = {.ext_buffer = 1,.pipe_bof = 1,}, + .bufsize = sizeof(struct g_keyboard_data), + .callback = &g_keyboard_intr_callback, + .frames = 2, + .usb_mode = USB_MODE_DEVICE, + }, +}; + +static void g_keyboard_timeout(void *arg); + +static void +g_keyboard_timeout_reset(struct g_keyboard_softc *sc) +{ + int i = g_keyboard_key_press_interval; + + if (i <= 0) + i = 1; + else if (i > 1023) + i = 1023; + + i = USB_MS_TO_TICKS(i); + + usb_callout_reset(&sc->sc_callout, i, &g_keyboard_timeout, sc); +} + +static void +g_keyboard_timeout(void *arg) +{ + struct g_keyboard_softc *sc = arg; + + sc->sc_mode = g_keyboard_mode; + + memcpy(sc->sc_pattern, g_keyboard_key_press_pattern, sizeof(sc->sc_pattern)); + + sc->sc_pattern[G_KEYBOARD_MAX_STRLEN - 1] = 0; + + sc->sc_pattern_len = strlen(sc->sc_pattern); + + DPRINTFN(11, "Timeout %p\n", sc->sc_xfer[G_KEYBOARD_INTR_DT]); + + usbd_transfer_start(sc->sc_xfer[G_KEYBOARD_INTR_DT]); + + g_keyboard_timeout_reset(sc); +} + +static int +g_keyboard_probe(device_t dev) +{ + struct usb_attach_arg *uaa = device_get_ivars(dev); + + DPRINTFN(11, "\n"); + + if (uaa->usb_mode != USB_MODE_DEVICE) + return (ENXIO); + + if ((uaa->info.bInterfaceClass == UICLASS_HID) && + (uaa->info.bInterfaceSubClass == UISUBCLASS_BOOT) && + (uaa->info.bInterfaceProtocol == UPROTO_BOOT_KEYBOARD)) + return (0); + + return (ENXIO); +} + +static int +g_keyboard_attach(device_t dev) +{ + struct g_keyboard_softc *sc = device_get_softc(dev); + struct usb_attach_arg *uaa = device_get_ivars(dev); + int error; + + DPRINTFN(11, "\n"); + + device_set_usb_desc(dev); + + mtx_init(&sc->sc_mtx, "g_keyboard", NULL, MTX_DEF); + + usb_callout_init_mtx(&sc->sc_callout, &sc->sc_mtx, 0); + + sc->sc_mode = G_KEYBOARD_MODE_SILENT; + + error = usbd_transfer_setup(uaa->device, + &uaa->info.bIfaceIndex, sc->sc_xfer, g_keyboard_config, + G_KEYBOARD_N_TRANSFER, sc, &sc->sc_mtx); + + if (error) { + DPRINTF("error=%s\n", usbd_errstr(error)); + goto detach; + } + mtx_lock(&sc->sc_mtx); + g_keyboard_timeout_reset(sc); + mtx_unlock(&sc->sc_mtx); + + return (0); /* success */ + +detach: + g_keyboard_detach(dev); + + return (ENXIO); /* error */ +} + +static int +g_keyboard_detach(device_t dev) +{ + struct g_keyboard_softc *sc = device_get_softc(dev); + + DPRINTF("\n"); + + mtx_lock(&sc->sc_mtx); + usb_callout_stop(&sc->sc_callout); + mtx_unlock(&sc->sc_mtx); + + usbd_transfer_unsetup(sc->sc_xfer, G_KEYBOARD_N_TRANSFER); + + usb_callout_drain(&sc->sc_callout); + + mtx_destroy(&sc->sc_mtx); + + return (0); +} + +static uint8_t +g_keyboard_get_keycode(struct g_keyboard_softc *sc, int index) +{ + int key; + int mod = sc->sc_pattern_len; + + if (mod == 0) + index = 0; + else + index %= mod; + + if ((index >= 0) && (index < sc->sc_pattern_len)) + key = sc->sc_pattern[index]; + else + key = 'a'; + + if (key >= 'a' && key <= 'z') + return (key - 'a' + 0x04); + else + return (0x04); +} + +static void +g_keyboard_intr_callback(struct usb_xfer *xfer, usb_error_t error) +{ + struct g_keyboard_softc *sc = usbd_xfer_softc(xfer); + int actlen; + int aframes; + + usbd_xfer_status(xfer, &actlen, NULL, &aframes, NULL); + + DPRINTF("st=%d aframes=%d actlen=%d bytes\n", + USB_GET_STATE(xfer), aframes, actlen); + + switch (USB_GET_STATE(xfer)) { + case USB_ST_TRANSFERRED: + break; + + case USB_ST_SETUP: +tr_setup: + if (sc->sc_mode == G_KEYBOARD_MODE_SILENT) { + memset(&sc->sc_data, 0, sizeof(sc->sc_data)); + usbd_xfer_set_frame_data(xfer, 0, &sc->sc_data[0], sizeof(sc->sc_data[0])); + usbd_xfer_set_frame_data(xfer, 1, &sc->sc_data[1], sizeof(sc->sc_data[1])); + usbd_xfer_set_frames(xfer, 2); + usbd_transfer_submit(xfer); + + } else if (sc->sc_mode == G_KEYBOARD_MODE_PATTERN) { + + memset(&sc->sc_data, 0, sizeof(sc->sc_data)); + + if ((sc->sc_state < 0) || (sc->sc_state >= G_KEYBOARD_MAX_STRLEN)) + sc->sc_state = 0; + + switch (sc->sc_state % 6) { + case 0: + sc->sc_data[0].keycode[0] = + g_keyboard_get_keycode(sc, sc->sc_state + 0); + case 1: *** DIFF OUTPUT TRUNCATED AT 1000 LINES ***