usb_generic.c revision 220304
117721Speter/* $FreeBSD: head/sys/dev/usb/usb_generic.c 220304 2011-04-03 20:22:49Z hselasky $ */ 217721Speter/*- 317721Speter * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 417721Speter * 517721Speter * Redistribution and use in source and binary forms, with or without 632785Speter * modification, are permitted provided that the following conditions 717721Speter * are met: 817721Speter * 1. Redistributions of source code must retain the above copyright 917721Speter * notice, this list of conditions and the following disclaimer. 1017721Speter * 2. Redistributions in binary form must reproduce the above copyright 1117721Speter * notice, this list of conditions and the following disclaimer in the 1217721Speter * documentation and/or other materials provided with the distribution. 13131688Sdes * 14131688Sdes * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1517721Speter * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1617721Speter * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 1717721Speter * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 1817721Speter * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 1925839Speter * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2017721Speter * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2125839Speter * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2225839Speter * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2325839Speter * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2425839Speter * SUCH DAMAGE. 2525839Speter */ 2625839Speter 2725839Speter#include <sys/stdint.h> 2825839Speter#include <sys/stddef.h> 2925839Speter#include <sys/param.h> 3025839Speter#include <sys/queue.h> 3125839Speter#include <sys/types.h> 3225839Speter#include <sys/systm.h> 3325839Speter#include <sys/kernel.h> 3425839Speter#include <sys/bus.h> 3581404Speter#include <sys/module.h> 3681404Speter#include <sys/lock.h> 3725839Speter#include <sys/mutex.h> 3825839Speter#include <sys/condvar.h> 3925839Speter#include <sys/sysctl.h> 4025839Speter#include <sys/sx.h> 4125839Speter#include <sys/unistd.h> 4225839Speter#include <sys/callout.h> 4325839Speter#include <sys/malloc.h> 4425839Speter#include <sys/priv.h> 4525839Speter#include <sys/conf.h> 4625839Speter#include <sys/fcntl.h> 4725839Speter 4825839Speter#include <dev/usb/usb.h> 4925839Speter#include <dev/usb/usb_ioctl.h> 5025839Speter#include <dev/usb/usbdi.h> 5125839Speter#include <dev/usb/usbdi_util.h> 5225839Speter 5381404Speter#define USB_DEBUG_VAR ugen_debug 5481404Speter 5525839Speter#include <dev/usb/usb_core.h> 5625839Speter#include <dev/usb/usb_dev.h> 5725839Speter#include <dev/usb/usb_mbuf.h> 5825839Speter#include <dev/usb/usb_process.h> 5925839Speter#include <dev/usb/usb_device.h> 6025839Speter#include <dev/usb/usb_debug.h> 6125839Speter#include <dev/usb/usb_request.h> 6225839Speter#include <dev/usb/usb_busdma.h> 6325839Speter#include <dev/usb/usb_util.h> 6425839Speter#include <dev/usb/usb_hub.h> 6525839Speter#include <dev/usb/usb_generic.h> 6625839Speter#include <dev/usb/usb_transfer.h> 6725839Speter 6825839Speter#include <dev/usb/usb_controller.h> 6925839Speter#include <dev/usb/usb_bus.h> 7025839Speter 7125839Speter#if USB_HAVE_UGEN 7225839Speter 7325839Speter/* defines */ 7425839Speter 7525839Speter#define UGEN_BULK_FS_BUFFER_SIZE (64*32) /* bytes */ 7625839Speter#define UGEN_BULK_HS_BUFFER_SIZE (1024*32) /* bytes */ 7725839Speter#define UGEN_HW_FRAMES 50 /* number of milliseconds per transfer */ 7825839Speter 7925839Speter/* function prototypes */ 8025839Speter 8125839Speterstatic usb_callback_t ugen_read_clear_stall_callback; 8225839Speterstatic usb_callback_t ugen_write_clear_stall_callback; 8325839Speterstatic usb_callback_t ugen_ctrl_read_callback; 8425839Speterstatic usb_callback_t ugen_ctrl_write_callback; 8525839Speterstatic usb_callback_t ugen_isoc_read_callback; 8625839Speterstatic usb_callback_t ugen_isoc_write_callback; 8725839Speterstatic usb_callback_t ugen_ctrl_fs_callback; 8825839Speter 89102840Speterstatic usb_fifo_open_t ugen_open; 90102840Speterstatic usb_fifo_close_t ugen_close; 91102840Speterstatic usb_fifo_ioctl_t ugen_ioctl; 9225839Speterstatic usb_fifo_ioctl_t ugen_ioctl_post; 9325839Speterstatic usb_fifo_cmd_t ugen_start_read; 9425839Speterstatic usb_fifo_cmd_t ugen_start_write; 9525839Speterstatic usb_fifo_cmd_t ugen_stop_io; 9625839Speter 9725839Speterstatic int ugen_transfer_setup(struct usb_fifo *, 9825839Speter const struct usb_config *, uint8_t); 9925839Speterstatic int ugen_open_pipe_write(struct usb_fifo *); 10025839Speterstatic int ugen_open_pipe_read(struct usb_fifo *); 10125839Speterstatic int ugen_set_config(struct usb_fifo *, uint8_t); 10225839Speterstatic int ugen_set_interface(struct usb_fifo *, uint8_t, uint8_t); 10325839Speterstatic int ugen_get_cdesc(struct usb_fifo *, struct usb_gen_descriptor *); 10425839Speterstatic int ugen_get_sdesc(struct usb_fifo *, struct usb_gen_descriptor *); 10525839Speterstatic int ugen_get_iface_driver(struct usb_fifo *f, struct usb_gen_descriptor *ugd); 10625839Speterstatic int usb_gen_fill_deviceinfo(struct usb_fifo *, 10725839Speter struct usb_device_info *); 10825839Speterstatic int ugen_re_enumerate(struct usb_fifo *); 10925839Speterstatic int ugen_iface_ioctl(struct usb_fifo *, u_long, void *, int); 11025839Speterstatic uint8_t ugen_fs_get_complete(struct usb_fifo *, uint8_t *); 11125839Speterstatic int ugen_fs_uninit(struct usb_fifo *f); 11225839Speter 11325839Speter/* structures */ 11425839Speter 11525839Speterstruct usb_fifo_methods usb_ugen_methods = { 11625839Speter .f_open = &ugen_open, 11781404Speter .f_close = &ugen_close, 11881404Speter .f_ioctl = &ugen_ioctl, 11981404Speter .f_ioctl_post = &ugen_ioctl_post, 120128266Speter .f_start_read = &ugen_start_read, 121128266Speter .f_stop_read = &ugen_stop_io, 122128266Speter .f_start_write = &ugen_start_write, 123128266Speter .f_stop_write = &ugen_stop_io, 12425839Speter}; 12525839Speter 12625839Speter#ifdef USB_DEBUG 12725839Speterstatic int ugen_debug = 0; 12825839Speter 12925839SpeterSYSCTL_NODE(_hw_usb, OID_AUTO, ugen, CTLFLAG_RW, 0, "USB generic"); 13025839SpeterSYSCTL_INT(_hw_usb_ugen, OID_AUTO, debug, CTLFLAG_RW, &ugen_debug, 13125839Speter 0, "Debug level"); 13225839Speter 13325839SpeterTUNABLE_INT("hw.usb.ugen.debug", &ugen_debug); 13425839Speter#endif 13525839Speter 13625839Speter 13725839Speter/* prototypes */ 13825839Speter 13925839Speterstatic int 14025839Speterugen_transfer_setup(struct usb_fifo *f, 14125839Speter const struct usb_config *setup, uint8_t n_setup) 14225839Speter{ 14325839Speter struct usb_endpoint *ep = usb_fifo_softc(f); 14425839Speter struct usb_device *udev = f->udev; 14525839Speter uint8_t iface_index = ep->iface_index; 14625839Speter int error; 14781404Speter 14881404Speter mtx_unlock(f->priv_mtx); 14981404Speter 15017721Speter /* 15117721Speter * "usbd_transfer_setup()" can sleep so one needs to make a wrapper, 15225839Speter * exiting the mutex and checking things 15325839Speter */ 15417721Speter error = usbd_transfer_setup(udev, &iface_index, f->xfer, 15525839Speter setup, n_setup, f, f->priv_mtx); 15625839Speter if (error == 0) { 15725839Speter 15825839Speter if (f->xfer[0]->nframes == 1) { 159102840Speter error = usb_fifo_alloc_buffer(f, 16025839Speter f->xfer[0]->max_data_length, 2); 161102840Speter } else { 16281404Speter error = usb_fifo_alloc_buffer(f, 163102840Speter f->xfer[0]->max_frame_size, 16481404Speter 2 * f->xfer[0]->nframes); 16581404Speter } 16681404Speter if (error) { 167102840Speter usbd_transfer_unsetup(f->xfer, n_setup); 16881404Speter } 16981404Speter } 17081404Speter mtx_lock(f->priv_mtx); 171102840Speter 172102840Speter return (error); 17325839Speter} 17425839Speter 17532785Speterstatic int 17617721Speterugen_open(struct usb_fifo *f, int fflags) 17717721Speter{ 17817721Speter struct usb_endpoint *ep = usb_fifo_softc(f); 17966525Speter struct usb_endpoint_descriptor *ed = ep->edesc; 18066525Speter uint8_t type; 18166525Speter 18266525Speter DPRINTFN(6, "flag=0x%x\n", fflags); 18366525Speter 18466525Speter mtx_lock(f->priv_mtx); 18566525Speter switch (usbd_get_speed(f->udev)) { 18666525Speter case USB_SPEED_LOW: 18766525Speter case USB_SPEED_FULL: 18866525Speter f->nframes = UGEN_HW_FRAMES; 18966525Speter f->bufsize = UGEN_BULK_FS_BUFFER_SIZE; 19066525Speter break; 19166525Speter default: 19266525Speter f->nframes = UGEN_HW_FRAMES * 8; 19366525Speter f->bufsize = UGEN_BULK_HS_BUFFER_SIZE; 19466525Speter break; 19566525Speter } 19666525Speter 19766525Speter type = ed->bmAttributes & UE_XFERTYPE; 19866525Speter if (type == UE_INTERRUPT) { 19966525Speter f->bufsize = 0; /* use "wMaxPacketSize" */ 20066525Speter } 20166525Speter f->timeout = USB_NO_TIMEOUT; 20266525Speter f->flag_short = 0; 20366525Speter f->fifo_zlp = 0; 20466525Speter mtx_unlock(f->priv_mtx); 20566525Speter 20666525Speter return (0); 20766525Speter} 20866525Speter 20966525Speterstatic void 21066525Speterugen_close(struct usb_fifo *f, int fflags) 21166525Speter{ 21266525Speter DPRINTFN(6, "flag=0x%x\n", fflags); 21366525Speter 21466525Speter /* cleanup */ 21566525Speter 21666525Speter mtx_lock(f->priv_mtx); 21766525Speter usbd_transfer_stop(f->xfer[0]); 21866525Speter usbd_transfer_stop(f->xfer[1]); 21966525Speter mtx_unlock(f->priv_mtx); 22017721Speter 22117721Speter usbd_transfer_unsetup(f->xfer, 2); 22217721Speter usb_fifo_free_buffer(f); 22317721Speter 22417721Speter if (ugen_fs_uninit(f)) { 22525839Speter /* ignore any errors - we are closing */ 22617721Speter DPRINTFN(6, "no FIFOs\n"); 22717721Speter } 22866525Speter} 22917721Speter 230128266Speterstatic int 23181404Speterugen_open_pipe_write(struct usb_fifo *f) 23217721Speter{ 23317721Speter struct usb_config usb_config[2]; 23417721Speter struct usb_endpoint *ep = usb_fifo_softc(f); 23525839Speter struct usb_endpoint_descriptor *ed = ep->edesc; 23666525Speter 23717721Speter mtx_assert(f->priv_mtx, MA_OWNED); 23826065Speter 239102840Speter if (f->xfer[0] || f->xfer[1]) { 24025839Speter /* transfers are already opened */ 24125839Speter return (0); 24225839Speter } 24325839Speter bzero(usb_config, sizeof(usb_config)); 24425839Speter 24525839Speter usb_config[1].type = UE_CONTROL; 24625839Speter usb_config[1].endpoint = 0; 24725839Speter usb_config[1].direction = UE_DIR_ANY; 24825839Speter usb_config[1].timeout = 1000; /* 1 second */ 24925839Speter usb_config[1].interval = 50;/* 50 milliseconds */ 25025839Speter usb_config[1].bufsize = sizeof(struct usb_device_request); 25125839Speter usb_config[1].callback = &ugen_write_clear_stall_callback; 25225839Speter usb_config[1].usb_mode = USB_MODE_HOST; 25325839Speter 25425839Speter usb_config[0].type = ed->bmAttributes & UE_XFERTYPE; 25525839Speter usb_config[0].endpoint = ed->bEndpointAddress & UE_ADDR; 25625839Speter usb_config[0].direction = UE_DIR_TX; 25725839Speter usb_config[0].interval = USB_DEFAULT_INTERVAL; 258102840Speter usb_config[0].flags.proxy_buffer = 1; 259102840Speter usb_config[0].usb_mode = USB_MODE_DUAL; /* both modes */ 260102840Speter 26125839Speter switch (ed->bmAttributes & UE_XFERTYPE) { 26225839Speter case UE_INTERRUPT: 26325839Speter case UE_BULK: 26425839Speter if (f->flag_short) { 26566525Speter usb_config[0].flags.force_short_xfer = 1; 26666525Speter } 26725839Speter usb_config[0].callback = &ugen_ctrl_write_callback; 26825839Speter usb_config[0].timeout = f->timeout; 26925839Speter usb_config[0].frames = 1; 27025839Speter usb_config[0].bufsize = f->bufsize; 27125839Speter if (ugen_transfer_setup(f, usb_config, 2)) { 27225839Speter return (EIO); 27325839Speter } 27425839Speter /* first transfer does not clear stall */ 27525839Speter f->flag_stall = 0; 27625839Speter break; 27725839Speter 27866525Speter case UE_ISOCHRONOUS: 27925839Speter usb_config[0].flags.short_xfer_ok = 1; 28025839Speter usb_config[0].bufsize = 0; /* use default */ 28125839Speter usb_config[0].frames = f->nframes; 28225839Speter usb_config[0].callback = &ugen_isoc_write_callback; 28325839Speter usb_config[0].timeout = 0; 28425839Speter 28525839Speter /* clone configuration */ 28681404Speter usb_config[1] = usb_config[0]; 28781404Speter 28825839Speter if (ugen_transfer_setup(f, usb_config, 2)) { 28917721Speter return (EIO); 29017721Speter } 29117721Speter break; 29281404Speter default: 29325839Speter return (EINVAL); 29466525Speter } 29566525Speter return (0); 29666525Speter} 29725839Speter 29817721Speterstatic int 29917721Speterugen_open_pipe_read(struct usb_fifo *f) 30081404Speter{ 30181404Speter struct usb_config usb_config[2]; 30281404Speter struct usb_endpoint *ep = usb_fifo_softc(f); 30381404Speter struct usb_endpoint_descriptor *ed = ep->edesc; 30417721Speter 30517721Speter mtx_assert(f->priv_mtx, MA_OWNED); 30666525Speter 30766525Speter if (f->xfer[0] || f->xfer[1]) { 30817721Speter /* transfers are already opened */ 30966525Speter return (0); 31066525Speter } 31166525Speter bzero(usb_config, sizeof(usb_config)); 31266525Speter 31366525Speter usb_config[1].type = UE_CONTROL; 31466525Speter usb_config[1].endpoint = 0; 31566525Speter usb_config[1].direction = UE_DIR_ANY; 31666525Speter usb_config[1].timeout = 1000; /* 1 second */ 31766525Speter usb_config[1].interval = 50;/* 50 milliseconds */ 31866525Speter usb_config[1].bufsize = sizeof(struct usb_device_request); 31966525Speter usb_config[1].callback = &ugen_read_clear_stall_callback; 32066525Speter usb_config[1].usb_mode = USB_MODE_HOST; 32166525Speter 32266525Speter usb_config[0].type = ed->bmAttributes & UE_XFERTYPE; 32366525Speter usb_config[0].endpoint = ed->bEndpointAddress & UE_ADDR; 32466525Speter usb_config[0].direction = UE_DIR_RX; 32566525Speter usb_config[0].interval = USB_DEFAULT_INTERVAL; 32666525Speter usb_config[0].flags.proxy_buffer = 1; 32766525Speter usb_config[0].usb_mode = USB_MODE_DUAL; /* both modes */ 32866525Speter 32966525Speter switch (ed->bmAttributes & UE_XFERTYPE) { 33066525Speter case UE_INTERRUPT: 33166525Speter case UE_BULK: 33266525Speter if (f->flag_short) { 33366525Speter usb_config[0].flags.short_xfer_ok = 1; 33466525Speter } 33566525Speter usb_config[0].timeout = f->timeout; 33666525Speter usb_config[0].frames = 1; 33766525Speter usb_config[0].callback = &ugen_ctrl_read_callback; 33866525Speter usb_config[0].bufsize = f->bufsize; 33966525Speter 34066525Speter if (ugen_transfer_setup(f, usb_config, 2)) { 34166525Speter return (EIO); 34266525Speter } 34366525Speter /* first transfer does not clear stall */ 34466525Speter f->flag_stall = 0; 34566525Speter break; 34666525Speter 34766525Speter case UE_ISOCHRONOUS: 34866525Speter usb_config[0].flags.short_xfer_ok = 1; 34966525Speter usb_config[0].bufsize = 0; /* use default */ 350102840Speter usb_config[0].frames = f->nframes; 351102840Speter usb_config[0].callback = &ugen_isoc_read_callback; 35266525Speter usb_config[0].timeout = 0; 35366525Speter 35466525Speter /* clone configuration */ 35566525Speter usb_config[1] = usb_config[0]; 35617721Speter 35766525Speter if (ugen_transfer_setup(f, usb_config, 2)) { 35866525Speter return (EIO); 35966525Speter } 36066525Speter break; 36166525Speter 36266525Speter default: 36366525Speter return (EINVAL); 36466525Speter } 36566525Speter return (0); 36666525Speter} 36766525Speter 36866525Speterstatic void 36966525Speterugen_start_read(struct usb_fifo *f) 37066525Speter{ 37166525Speter /* check that pipes are open */ 37266525Speter if (ugen_open_pipe_read(f)) { 37381404Speter /* signal error */ 37481404Speter usb_fifo_put_data_error(f); 37566525Speter } 37666525Speter /* start transfers */ 37766525Speter usbd_transfer_start(f->xfer[0]); 37866525Speter usbd_transfer_start(f->xfer[1]); 37966525Speter} 38066525Speter 38166525Speterstatic void 38266525Speterugen_start_write(struct usb_fifo *f) 38366525Speter{ 38466525Speter /* check that pipes are open */ 38566525Speter if (ugen_open_pipe_write(f)) { 38666525Speter /* signal error */ 38766525Speter usb_fifo_get_data_error(f); 38866525Speter } 389107484Speter /* start transfers */ 39066525Speter usbd_transfer_start(f->xfer[0]); 39181404Speter usbd_transfer_start(f->xfer[1]); 39281404Speter} 39381404Speter 39481404Speterstatic void 39581404Speterugen_stop_io(struct usb_fifo *f) 39681404Speter{ 39781404Speter /* stop transfers */ 39881404Speter usbd_transfer_stop(f->xfer[0]); 39981404Speter usbd_transfer_stop(f->xfer[1]); 40081404Speter} 40181404Speter 40281404Speterstatic void 40381404Speterugen_ctrl_read_callback(struct usb_xfer *xfer, usb_error_t error) 40417721Speter{ 40517721Speter struct usb_fifo *f = usbd_xfer_softc(xfer); 40617721Speter struct usb_mbuf *m; 40717721Speter 40817721Speter DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes); 40966525Speter 41066525Speter switch (USB_GET_STATE(xfer)) { 41166525Speter case USB_ST_TRANSFERRED: 41266525Speter if (xfer->actlen == 0) { 41366525Speter if (f->fifo_zlp != 4) { 41481404Speter f->fifo_zlp++; 41581404Speter } else { 41681404Speter /* 41781404Speter * Throttle a little bit we have multiple ZLPs 41881404Speter * in a row! 41981404Speter */ 42081404Speter xfer->interval = 64; /* ms */ 42181404Speter } 422102840Speter } else { 42381404Speter /* clear throttle */ 42481404Speter xfer->interval = 0; 42581404Speter f->fifo_zlp = 0; 42681404Speter } 42781404Speter usb_fifo_put_data(f, xfer->frbuffers, 0, 42881404Speter xfer->actlen, 1); 429102840Speter 43081404Speter case USB_ST_SETUP: 43181404Speter if (f->flag_stall) { 43266525Speter usbd_transfer_start(f->xfer[1]); 43366525Speter break; 43466525Speter } 43566525Speter USB_IF_POLL(&f->free_q, m); 43666525Speter if (m) { 43766525Speter usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer)); 43866525Speter usbd_transfer_submit(xfer); 43966525Speter } 44066525Speter break; 44166525Speter 44266525Speter default: /* Error */ 44366525Speter if (xfer->error != USB_ERR_CANCELLED) { 44466525Speter /* send a zero length packet to userland */ 44566525Speter usb_fifo_put_data(f, xfer->frbuffers, 0, 0, 1); 44666525Speter f->flag_stall = 1; 44766525Speter f->fifo_zlp = 0; 44866525Speter usbd_transfer_start(f->xfer[1]); 44966525Speter } 45066525Speter break; 45166525Speter } 45266525Speter} 45366525Speter 45466525Speterstatic void 45566525Speterugen_ctrl_write_callback(struct usb_xfer *xfer, usb_error_t error) 45666525Speter{ 45766525Speter struct usb_fifo *f = usbd_xfer_softc(xfer); 45866525Speter usb_frlength_t actlen; 45966525Speter 46066525Speter DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes); 46166525Speter 46266525Speter switch (USB_GET_STATE(xfer)) { 46366525Speter case USB_ST_SETUP: 46466525Speter case USB_ST_TRANSFERRED: 46566525Speter /* 46617721Speter * If writing is in stall, just jump to clear stall 46717721Speter * callback and solve the situation. 46817721Speter */ 46981404Speter if (f->flag_stall) { 47081404Speter usbd_transfer_start(f->xfer[1]); 47181404Speter break; 47281404Speter } 47381404Speter /* 47481404Speter * Write data, setup and perform hardware transfer. 47581404Speter */ 47681404Speter if (usb_fifo_get_data(f, xfer->frbuffers, 0, 47781404Speter xfer->max_data_length, &actlen, 0)) { 47881404Speter usbd_xfer_set_frame_len(xfer, 0, actlen); 47981404Speter usbd_transfer_submit(xfer); 48081404Speter } 48181404Speter break; 48281404Speter 48381404Speter default: /* Error */ 48481404Speter if (xfer->error != USB_ERR_CANCELLED) { 48581404Speter f->flag_stall = 1; 48681404Speter usbd_transfer_start(f->xfer[1]); 48781404Speter } 48881404Speter break; 48981404Speter } 49081404Speter} 49181404Speter 492128266Speterstatic void 493128266Speterugen_read_clear_stall_callback(struct usb_xfer *xfer, usb_error_t error) 49481404Speter{ 495128266Speter struct usb_fifo *f = usbd_xfer_softc(xfer); 496128266Speter struct usb_xfer *xfer_other = f->xfer[0]; 497128266Speter 498128266Speter if (f->flag_stall == 0) { 49981404Speter /* nothing to do */ 50081404Speter return; 50181404Speter } 502128266Speter if (usbd_clear_stall_callback(xfer, xfer_other)) { 503128266Speter DPRINTFN(5, "f=%p: stall cleared\n", f); 504128266Speter f->flag_stall = 0; 50581404Speter usbd_transfer_start(xfer_other); 50681404Speter } 50781404Speter} 50881404Speter 50981404Speterstatic void 510128266Speterugen_write_clear_stall_callback(struct usb_xfer *xfer, usb_error_t error) 511128266Speter{ 512128266Speter struct usb_fifo *f = usbd_xfer_softc(xfer); 51381404Speter struct usb_xfer *xfer_other = f->xfer[0]; 51481404Speter 51581404Speter if (f->flag_stall == 0) { 516128266Speter /* nothing to do */ 517128266Speter return; 518128266Speter } 519128266Speter if (usbd_clear_stall_callback(xfer, xfer_other)) { 52081404Speter DPRINTFN(5, "f=%p: stall cleared\n", f); 52181404Speter f->flag_stall = 0; 52281404Speter usbd_transfer_start(xfer_other); 52381404Speter } 52481404Speter} 525128266Speter 52681404Speterstatic void 52781404Speterugen_isoc_read_callback(struct usb_xfer *xfer, usb_error_t error) 52881404Speter{ 529128266Speter struct usb_fifo *f = usbd_xfer_softc(xfer); 530128266Speter usb_frlength_t offset; 531128266Speter usb_frcount_t n; 53281404Speter 53381404Speter DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes); 53481404Speter 53581404Speter switch (USB_GET_STATE(xfer)) { 53681404Speter case USB_ST_TRANSFERRED: 53781404Speter 53881404Speter DPRINTFN(6, "actlen=%d\n", xfer->actlen); 53981404Speter 54081404Speter offset = 0; 54181404Speter 54281404Speter for (n = 0; n != xfer->aframes; n++) { 54381404Speter usb_fifo_put_data(f, xfer->frbuffers, offset, 544128266Speter xfer->frlengths[n], 1); 54581404Speter offset += xfer->max_frame_size; 54681404Speter } 54781404Speter 548128266Speter case USB_ST_SETUP: 549128266Spetertr_setup: 55081404Speter for (n = 0; n != xfer->nframes; n++) { 55181404Speter /* setup size for next transfer */ 55281404Speter usbd_xfer_set_frame_len(xfer, n, xfer->max_frame_size); 55381404Speter } 55481404Speter usbd_transfer_submit(xfer); 55581404Speter break; 55681404Speter 557128266Speter default: /* Error */ 55881404Speter if (xfer->error == USB_ERR_CANCELLED) { 55981404Speter break; 56081404Speter } 56181404Speter goto tr_setup; 56281404Speter } 56381404Speter} 564109655Speter 565128266Speterstatic void 566128266Speterugen_isoc_write_callback(struct usb_xfer *xfer, usb_error_t error) 567128266Speter{ 568128266Speter struct usb_fifo *f = usbd_xfer_softc(xfer); 569128266Speter usb_frlength_t actlen; 57081404Speter usb_frlength_t offset; 57181404Speter usb_frcount_t n; 57281404Speter 57381404Speter DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes); 574128266Speter 57525839Speter switch (USB_GET_STATE(xfer)) { 57625839Speter case USB_ST_TRANSFERRED: 57725839Speter case USB_ST_SETUP: 57825839Spetertr_setup: 57925839Speter offset = 0; 58025839Speter for (n = 0; n != xfer->nframes; n++) { 58125839Speter if (usb_fifo_get_data(f, xfer->frbuffers, offset, 58266525Speter xfer->max_frame_size, &actlen, 1)) { 58325839Speter usbd_xfer_set_frame_len(xfer, n, actlen); 58425839Speter offset += actlen; 58525839Speter } else { 58625839Speter break; 58725839Speter } 58825839Speter } 58966525Speter 59025839Speter for (; n != xfer->nframes; n++) { 59125839Speter /* fill in zero frames */ 59225839Speter usbd_xfer_set_frame_len(xfer, n, 0); 59325839Speter } 59425839Speter usbd_transfer_submit(xfer); 59525839Speter break; 59666525Speter 59766525Speter default: /* Error */ 59825839Speter if (xfer->error == USB_ERR_CANCELLED) { 59925839Speter break; 60025839Speter } 60125839Speter goto tr_setup; 60225839Speter } 60325839Speter} 60425839Speter 60525839Speterstatic int 60625839Speterugen_set_config(struct usb_fifo *f, uint8_t index) 60725839Speter{ 60825839Speter DPRINTFN(2, "index %u\n", index); 60966525Speter 61066525Speter if (f->udev->flags.usb_mode != USB_MODE_HOST) { 61166525Speter /* not possible in device side mode */ 61266525Speter return (ENOTTY); 61381404Speter } 61466525Speter if (f->udev->curr_config_index == index) { 61581404Speter /* no change needed */ 61681404Speter return (0); 61781404Speter } 61881404Speter /* make sure all FIFO's are gone */ 61925839Speter /* else there can be a deadlock */ 62025839Speter if (ugen_fs_uninit(f)) { 62166525Speter /* ignore any errors */ 62281404Speter DPRINTFN(6, "no FIFOs\n"); 62366525Speter } 62466525Speter /* change setting - will free generic FIFOs, if any */ 62566525Speter if (usbd_set_config_index(f->udev, index)) { 62666525Speter return (EIO); 62766525Speter } 62825839Speter /* probe and attach */ 62925839Speter if (usb_probe_and_attach(f->udev, USB_IFACE_INDEX_ANY)) { 63066525Speter return (EIO); 63166525Speter } 63266525Speter return (0); 63366525Speter} 63466525Speter 63566525Speterstatic int 63666525Speterugen_set_interface(struct usb_fifo *f, 63766525Speter uint8_t iface_index, uint8_t alt_index) 63866525Speter{ 63966525Speter DPRINTFN(2, "%u, %u\n", iface_index, alt_index); 64025839Speter 64125839Speter if (f->udev->flags.usb_mode != USB_MODE_HOST) { 64225839Speter /* not possible in device side mode */ 64325839Speter return (ENOTTY); 64425839Speter } 64525839Speter /* make sure all FIFO's are gone */ 64666525Speter /* else there can be a deadlock */ 64725839Speter if (ugen_fs_uninit(f)) { 64825839Speter /* ignore any errors */ 64925839Speter DPRINTFN(6, "no FIFOs\n"); 65017721Speter } 65125839Speter /* change setting - will free generic FIFOs, if any */ 65225839Speter if (usbd_set_alt_interface_index(f->udev, iface_index, alt_index)) { 65325839Speter return (EIO); 65425839Speter } 65525839Speter /* probe and attach */ 65625839Speter if (usb_probe_and_attach(f->udev, iface_index)) { 65725839Speter return (EIO); 65825839Speter } 65925839Speter return (0); 66025839Speter} 66125839Speter 66225839Speter/*------------------------------------------------------------------------* 66366525Speter * ugen_get_cdesc 66425839Speter * 66525839Speter * This function will retrieve the complete configuration descriptor 66625839Speter * at the given index. 66725839Speter *------------------------------------------------------------------------*/ 66825839Speterstatic int 66925839Speterugen_get_cdesc(struct usb_fifo *f, struct usb_gen_descriptor *ugd) 67025839Speter{ 67125839Speter struct usb_config_descriptor *cdesc; 67225839Speter struct usb_device *udev = f->udev; 67325839Speter int error; 67425839Speter uint16_t len; 67525839Speter uint8_t free_data; 67625839Speter 67725839Speter DPRINTFN(6, "\n"); 67825839Speter 67925839Speter if (ugd->ugd_data == NULL) { 68025839Speter /* userland pointer should not be zero */ 68125839Speter return (EINVAL); 68225839Speter } 68325839Speter if ((ugd->ugd_config_index == USB_UNCONFIG_INDEX) || 68425839Speter (ugd->ugd_config_index == udev->curr_config_index)) { 68525839Speter cdesc = usbd_get_config_descriptor(udev); 68625839Speter if (cdesc == NULL) { 68725839Speter return (ENXIO); 68825839Speter } 68925839Speter free_data = 0; 69025839Speter 69125839Speter } else { 69225839Speter if (usbd_req_get_config_desc_full(udev, 69325839Speter NULL, &cdesc, M_USBDEV, 69425839Speter ugd->ugd_config_index)) { 69525839Speter return (ENXIO); 69625839Speter } 69725839Speter free_data = 1; 69825839Speter } 69925839Speter 70025839Speter len = UGETW(cdesc->wTotalLength); 70125839Speter if (len > ugd->ugd_maxlen) { 70225839Speter len = ugd->ugd_maxlen; 70325839Speter } 70425839Speter DPRINTFN(6, "len=%u\n", len); 70525839Speter 70625839Speter ugd->ugd_actlen = len; 70725839Speter ugd->ugd_offset = 0; 70825839Speter 70925839Speter error = copyout(cdesc, ugd->ugd_data, len); 71025839Speter 71125839Speter if (free_data) { 71225839Speter free(cdesc, M_USBDEV); 71325839Speter } 71425839Speter return (error); 71525839Speter} 71625839Speter 71725839Speterstatic int 71825839Speterugen_get_sdesc(struct usb_fifo *f, struct usb_gen_descriptor *ugd) 71925839Speter{ 72025839Speter void *ptr = f->udev->bus->scratch[0].data; 72125839Speter uint16_t size = sizeof(f->udev->bus->scratch[0].data); 72225839Speter int error; 72325839Speter 72425839Speter if (usbd_req_get_string_desc(f->udev, NULL, ptr, 72525839Speter size, ugd->ugd_lang_id, ugd->ugd_string_index)) { 72625839Speter error = EINVAL; 72725839Speter } else { 72825839Speter 72925839Speter if (size > ((uint8_t *)ptr)[0]) { 73025839Speter size = ((uint8_t *)ptr)[0]; 73125839Speter } 73225839Speter if (size > ugd->ugd_maxlen) { 73325839Speter size = ugd->ugd_maxlen; 73425839Speter } 73525839Speter ugd->ugd_actlen = size; 73625839Speter ugd->ugd_offset = 0; 73725839Speter 73825839Speter error = copyout(ptr, ugd->ugd_data, size); 73925839Speter } 74025839Speter return (error); 74125839Speter} 74225839Speter 74325839Speter/*------------------------------------------------------------------------* 74425839Speter * ugen_get_iface_driver 74525839Speter * 74625839Speter * This function generates an USB interface description for userland. 74725839Speter * 74825839Speter * Returns: 74925839Speter * 0: Success 75025839Speter * Else: Failure 75125839Speter *------------------------------------------------------------------------*/ 75225839Speterstatic int 75325839Speterugen_get_iface_driver(struct usb_fifo *f, struct usb_gen_descriptor *ugd) 75425839Speter{ 75525839Speter struct usb_device *udev = f->udev; 75625839Speter struct usb_interface *iface; 75725839Speter const char *ptr; 75825839Speter const char *desc; 75925839Speter unsigned int len; 76025839Speter unsigned int maxlen; 76125839Speter char buf[128]; 76225839Speter int error; 76325839Speter 76425839Speter DPRINTFN(6, "\n"); 76525839Speter 76625839Speter if ((ugd->ugd_data == NULL) || (ugd->ugd_maxlen == 0)) { 76725839Speter /* userland pointer should not be zero */ 76825839Speter return (EINVAL); 76925839Speter } 77025839Speter 77125839Speter iface = usbd_get_iface(udev, ugd->ugd_iface_index); 772107484Speter if ((iface == NULL) || (iface->idesc == NULL)) { 77325839Speter /* invalid interface index */ 77425839Speter return (EINVAL); 77525839Speter } 77625839Speter 77725839Speter /* read out device nameunit string, if any */ 77825839Speter if ((iface->subdev != NULL) && 77925839Speter device_is_attached(iface->subdev) && 78025839Speter (ptr = device_get_nameunit(iface->subdev)) && 78125839Speter (desc = device_get_desc(iface->subdev))) { 78225839Speter 78325839Speter /* print description */ 78425839Speter snprintf(buf, sizeof(buf), "%s: <%s>", ptr, desc); 78525839Speter 78625839Speter /* range checks */ 78732785Speter maxlen = ugd->ugd_maxlen - 1; 78832785Speter len = strlen(buf); 78932785Speter if (len > maxlen) 79032785Speter len = maxlen; 79132785Speter 79232785Speter /* update actual length, including terminating zero */ 79332785Speter ugd->ugd_actlen = len + 1; 79432785Speter 79532785Speter /* copy out interface description */ 79632785Speter error = copyout(buf, ugd->ugd_data, ugd->ugd_actlen); 79732785Speter } else { 79832785Speter /* zero length string is default */ 79932785Speter error = copyout("", ugd->ugd_data, 1); 80032785Speter } 801128266Speter return (error); 802128266Speter} 80325839Speter 80417721Speter/*------------------------------------------------------------------------* 80517721Speter * usb_gen_fill_deviceinfo 80617721Speter * 80725839Speter * This function dumps information about an USB device to the 80825839Speter * structure pointed to by the "di" argument. 80917721Speter * 81017721Speter * Returns: 81125839Speter * 0: Success 81217721Speter * Else: Failure 813102840Speter *------------------------------------------------------------------------*/ 81417721Speterstatic int 81525839Speterusb_gen_fill_deviceinfo(struct usb_fifo *f, struct usb_device_info *di) 816128266Speter{ 81725839Speter struct usb_device *udev; 81817721Speter struct usb_device *hub; 81917721Speter 82017721Speter udev = f->udev; 82117721Speter 82217721Speter bzero(di, sizeof(di[0])); 82317721Speter 82417721Speter di->udi_bus = device_get_unit(udev->bus->bdev); 825128266Speter di->udi_addr = udev->address; 826128266Speter di->udi_index = udev->device_index; 82732785Speter strlcpy(di->udi_serial, usb_get_serial(udev), sizeof(di->udi_serial)); 82817721Speter strlcpy(di->udi_vendor, usb_get_manufacturer(udev), sizeof(di->udi_vendor)); 82917721Speter strlcpy(di->udi_product, usb_get_product(udev), sizeof(di->udi_product)); 83017721Speter usb_printbcd(di->udi_release, sizeof(di->udi_release), 83117721Speter UGETW(udev->ddesc.bcdDevice)); 832128266Speter di->udi_vendorNo = UGETW(udev->ddesc.idVendor); 83317721Speter di->udi_productNo = UGETW(udev->ddesc.idProduct); 83417721Speter di->udi_releaseNo = UGETW(udev->ddesc.bcdDevice); 83517721Speter di->udi_class = udev->ddesc.bDeviceClass; 83617721Speter di->udi_subclass = udev->ddesc.bDeviceSubClass; 83717721Speter di->udi_protocol = udev->ddesc.bDeviceProtocol; 83817721Speter di->udi_config_no = udev->curr_config_no; 839128266Speter di->udi_config_index = udev->curr_config_index; 84017721Speter di->udi_power = udev->flags.self_powered ? 0 : udev->power; 84117721Speter di->udi_speed = udev->speed; 842102840Speter di->udi_mode = udev->flags.usb_mode; 843102840Speter di->udi_power_mode = udev->power_mode; 844102840Speter di->udi_suspended = udev->flags.peer_suspended; 845102840Speter 846102840Speter hub = udev->parent_hub; 847102840Speter if (hub) { 848102840Speter di->udi_hubaddr = hub->address; 849102840Speter di->udi_hubindex = hub->device_index; 850102840Speter di->udi_hubport = udev->port_no; 851102840Speter } 852128266Speter return (0); 853128266Speter} 854102840Speter 855102840Speter/*------------------------------------------------------------------------* 856102840Speter * ugen_check_request 857102840Speter * 858102840Speter * Return values: 859102840Speter * 0: Access allowed 860102840Speter * Else: No access 861102840Speter *------------------------------------------------------------------------*/ 862102840Speterstatic int 863102840Speterugen_check_request(struct usb_device *udev, struct usb_device_request *req) 864102840Speter{ 865102840Speter struct usb_endpoint *ep; 866128266Speter int error; 867102840Speter 868102840Speter /* 869128266Speter * Avoid requests that would damage the bus integrity: 870128266Speter */ 871128266Speter if (((req->bmRequestType == UT_WRITE_DEVICE) && 872128266Speter (req->bRequest == UR_SET_ADDRESS)) || 873128266Speter ((req->bmRequestType == UT_WRITE_DEVICE) && 874128266Speter (req->bRequest == UR_SET_CONFIG)) || 875102840Speter ((req->bmRequestType == UT_WRITE_INTERFACE) && 876102840Speter (req->bRequest == UR_SET_INTERFACE))) { 877102840Speter /* 878102840Speter * These requests can be useful for testing USB drivers. 87925839Speter */ 88017721Speter error = priv_check(curthread, PRIV_DRIVER); 88125839Speter if (error) { 88225839Speter return (error); 883128266Speter } 88425839Speter } 88517721Speter /* 88617721Speter * Special case - handle clearing of stall 88725839Speter */ 88825839Speter if (req->bmRequestType == UT_WRITE_ENDPOINT) { 88925839Speter 89025839Speter ep = usbd_get_ep_by_addr(udev, req->wIndex[0]); 89125839Speter if (ep == NULL) { 89225839Speter return (EINVAL); 89325839Speter } 89425839Speter if ((req->bRequest == UR_CLEAR_FEATURE) && 89525839Speter (UGETW(req->wValue) == UF_ENDPOINT_HALT)) { 89625839Speter usbd_clear_data_toggle(udev, ep); 89725839Speter } 89881404Speter } 89917721Speter /* TODO: add more checks to verify the interface index */ 90081404Speter 90181404Speter return (0); 90281404Speter} 90381404Speter 90481404Speterint 90581404Speterugen_do_request(struct usb_fifo *f, struct usb_ctl_request *ur) 90625839Speter{ 90717721Speter int error; 90817721Speter uint16_t len; 90925839Speter uint16_t actlen; 91025839Speter 91117721Speter if (ugen_check_request(f->udev, &ur->ucr_request)) { 91225839Speter return (EPERM); 91325839Speter } 91417721Speter len = UGETW(ur->ucr_request.wLength); 91525839Speter 91625839Speter /* check if "ucr_data" is valid */ 91725839Speter if (len != 0) { 91825839Speter if (ur->ucr_data == NULL) { 91925839Speter return (EFAULT); 92025839Speter } 92125839Speter } 92225839Speter /* do the USB request */ 92325839Speter error = usbd_do_request_flags 92432785Speter (f->udev, NULL, &ur->ucr_request, ur->ucr_data, 92532785Speter (ur->ucr_flags & USB_SHORT_XFER_OK) | 92632785Speter USB_USER_DATA_PTR, &actlen, 92725839Speter USB_DEFAULT_TIMEOUT); 92825839Speter 92932785Speter ur->ucr_actlen = actlen; 93025839Speter 93132785Speter if (error) { 93232785Speter error = EIO; 93332785Speter } 93432785Speter return (error); 93525839Speter} 93625839Speter 93725839Speter/*------------------------------------------------------------------------ 93825839Speter * ugen_re_enumerate 93925839Speter *------------------------------------------------------------------------*/ 940128266Speterstatic int 94125839Speterugen_re_enumerate(struct usb_fifo *f) 94225839Speter{ 94325839Speter struct usb_device *udev = f->udev; 94454427Speter int error; 94525839Speter 94625839Speter /* 94725839Speter * This request can be useful for testing USB drivers: 94825839Speter */ 949128266Speter error = priv_check(curthread, PRIV_DRIVER); 95025839Speter if (error) { 95125839Speter return (error); 95225839Speter } 95325839Speter if (udev->flags.usb_mode != USB_MODE_HOST) { 95425839Speter /* not possible in device side mode */ 95525839Speter DPRINTFN(6, "device mode\n"); 95625839Speter return (ENOTTY); 95725839Speter } 95825839Speter if (udev->parent_hub == NULL) { 95925839Speter /* the root HUB cannot be re-enumerated */ 96025839Speter DPRINTFN(6, "cannot reset root HUB\n"); 96125839Speter return (EINVAL); 96225839Speter } 96325839Speter /* make sure all FIFO's are gone */ 96425839Speter /* else there can be a deadlock */ 96525839Speter if (ugen_fs_uninit(f)) { 96625839Speter /* ignore any errors */ 96725839Speter DPRINTFN(6, "no FIFOs\n"); 968102840Speter } 96925839Speter if (udev->re_enumerate_wait == 0) { 97025839Speter udev->re_enumerate_wait = 1; 971102840Speter usb_needs_explore(udev->bus, 0); 97225839Speter } 97325839Speter return (0); 97425839Speter} 97525839Speter 97625839Speterint 977128266Speterugen_fs_uninit(struct usb_fifo *f) 97825839Speter{ 97925839Speter if (f->fs_xfer == NULL) { 98032785Speter return (EINVAL); 98132785Speter } 98225839Speter usbd_transfer_unsetup(f->fs_xfer, f->fs_ep_max); 98325839Speter free(f->fs_xfer, M_USB); 984128266Speter f->fs_xfer = NULL; 98525839Speter f->fs_ep_max = 0; 98625839Speter f->fs_ep_ptr = NULL; 98725839Speter f->flag_iscomplete = 0; 98825839Speter usb_fifo_free_buffer(f); 98925839Speter return (0); 99025839Speter} 99125839Speter 992128266Speterstatic uint8_t 99325839Speterugen_fs_get_complete(struct usb_fifo *f, uint8_t *pindex) 99425839Speter{ 99525839Speter struct usb_mbuf *m; 99625839Speter 99725839Speter USB_IF_DEQUEUE(&f->used_q, m); 99825839Speter 99925839Speter if (m) { 100025839Speter *pindex = *((uint8_t *)(m->cur_data_ptr)); 100125839Speter 100225839Speter USB_IF_ENQUEUE(&f->free_q, m); 100325839Speter 100425839Speter return (0); /* success */ 100525839Speter } else { 100625839Speter 100725839Speter *pindex = 0; /* fix compiler warning */ 100825839Speter 100925839Speter f->flag_iscomplete = 0; 101025839Speter } 101125839Speter return (1); /* failure */ 101225839Speter} 101325839Speter 101425839Speterstatic void 101525839Speterugen_fs_set_complete(struct usb_fifo *f, uint8_t index) 101625839Speter{ 101725839Speter struct usb_mbuf *m; 101825839Speter 101925839Speter USB_IF_DEQUEUE(&f->free_q, m); 102025839Speter 102125839Speter if (m == NULL) { 102225839Speter /* can happen during close */ 102325839Speter DPRINTF("out of buffers\n"); 102425839Speter return; 102525839Speter } 102625839Speter USB_MBUF_RESET(m); 102725839Speter 102825839Speter *((uint8_t *)(m->cur_data_ptr)) = index; 102925839Speter 103025839Speter USB_IF_ENQUEUE(&f->used_q, m); 103117721Speter 103217721Speter f->flag_iscomplete = 1; 1033128266Speter 1034128266Speter usb_fifo_wakeup(f); 103517721Speter} 103625839Speter 103725839Speterstatic int 103825839Speterugen_fs_copy_in(struct usb_fifo *f, uint8_t ep_index) 103925839Speter{ 104025839Speter struct usb_device_request *req; 104125839Speter struct usb_xfer *xfer; 104225839Speter struct usb_fs_endpoint fs_ep; 104325839Speter void *uaddr; /* userland pointer */ 104425839Speter void *kaddr; 104525839Speter usb_frlength_t offset; 104625839Speter usb_frlength_t rem; 104725839Speter usb_frcount_t n; 104825839Speter uint32_t length; 104925839Speter int error; 105025839Speter uint8_t isread; 105125839Speter 105225839Speter if (ep_index >= f->fs_ep_max) { 105325839Speter return (EINVAL); 105425839Speter } 105581404Speter xfer = f->fs_xfer[ep_index]; 105625839Speter if (xfer == NULL) { 105725839Speter return (EINVAL); 105825839Speter } 105925839Speter mtx_lock(f->priv_mtx); 106025839Speter if (usbd_transfer_pending(xfer)) { 106125839Speter mtx_unlock(f->priv_mtx); 106225839Speter return (EBUSY); /* should not happen */ 106325839Speter } 106425839Speter mtx_unlock(f->priv_mtx); 106525839Speter 106625839Speter error = copyin(f->fs_ep_ptr + 106725839Speter ep_index, &fs_ep, sizeof(fs_ep)); 106825839Speter if (error) { 106925839Speter return (error); 107054427Speter } 107125839Speter /* security checks */ 107225839Speter 107325839Speter if (fs_ep.nFrames > xfer->max_frame_count) { 107425839Speter xfer->error = USB_ERR_INVAL; 107525839Speter goto complete; 1076102840Speter } 1077102840Speter if (fs_ep.nFrames == 0) { 107825839Speter xfer->error = USB_ERR_INVAL; 1079102840Speter goto complete; 1080102840Speter } 108125839Speter error = copyin(fs_ep.ppBuffer, 108225839Speter &uaddr, sizeof(uaddr)); 1083130303Speter if (error) { 108425839Speter return (error); 1085102840Speter } 108625839Speter /* reset first frame */ 1087102840Speter usbd_xfer_set_frame_offset(xfer, 0, 0); 1088102840Speter 108925839Speter if (xfer->flags_int.control_xfr) { 1090102840Speter 1091102840Speter req = xfer->frbuffers[0].buffer; 1092102840Speter 1093102840Speter error = copyin(fs_ep.pLength, 1094102840Speter &length, sizeof(length)); 109525839Speter if (error) { 109625839Speter return (error); 109725839Speter } 109854427Speter if (length != sizeof(*req)) { 109925839Speter xfer->error = USB_ERR_INVAL; 110025839Speter goto complete; 110125839Speter } 110225839Speter if (length != 0) { 110325839Speter error = copyin(uaddr, req, length); 110425839Speter if (error) { 110525839Speter return (error); 1106130303Speter } 110725839Speter } 110825839Speter if (ugen_check_request(f->udev, req)) { 110925839Speter xfer->error = USB_ERR_INVAL; 111025839Speter goto complete; 111125839Speter } 111225839Speter usbd_xfer_set_frame_len(xfer, 0, length); 1113102840Speter 1114102840Speter /* Host mode only ! */ 111525839Speter if ((req->bmRequestType & 111654427Speter (UT_READ | UT_WRITE)) == UT_READ) { 111725839Speter isread = 1; 111825839Speter } else { 111925839Speter isread = 0; 112025839Speter } 112125839Speter n = 1; 112225839Speter offset = sizeof(*req); 112325839Speter 1124130303Speter } else { 112525839Speter /* Device and Host mode */ 112625839Speter if (USB_GET_DATA_ISREAD(xfer)) { 112725839Speter isread = 1; 112825839Speter } else { 112925839Speter isread = 0; 113025839Speter } 113125839Speter n = 0; 113225839Speter offset = 0; 113325839Speter } 113425839Speter 1135128266Speter rem = usbd_xfer_max_len(xfer); 113625839Speter xfer->nframes = fs_ep.nFrames; 1137128266Speter xfer->timeout = fs_ep.timeout; 1138128266Speter if (xfer->timeout > 65535) { 1139128266Speter xfer->timeout = 65535; 114025839Speter } 114125839Speter if (fs_ep.flags & USB_FS_FLAG_SINGLE_SHORT_OK) 1142128266Speter xfer->flags.short_xfer_ok = 1; 114325839Speter else 1144128266Speter xfer->flags.short_xfer_ok = 0; 1145128266Speter 1146128266Speter if (fs_ep.flags & USB_FS_FLAG_MULTI_SHORT_OK) 114725839Speter xfer->flags.short_frames_ok = 1; 114825839Speter else 1149128266Speter xfer->flags.short_frames_ok = 0; 115025839Speter 115125839Speter if (fs_ep.flags & USB_FS_FLAG_FORCE_SHORT) 115225839Speter xfer->flags.force_short_xfer = 1; 115325839Speter else 115425839Speter xfer->flags.force_short_xfer = 0; 115525839Speter 115625839Speter if (fs_ep.flags & USB_FS_FLAG_CLEAR_STALL) 115725839Speter usbd_xfer_set_stall(xfer); 115825839Speter else 115925839Speter xfer->flags.stall_pipe = 0; 116025839Speter 116125839Speter for (; n != xfer->nframes; n++) { 116225839Speter 1163107484Speter error = copyin(fs_ep.pLength + n, 1164107484Speter &length, sizeof(length)); 1165107484Speter if (error) { 1166107484Speter break; 1167107484Speter } 116825839Speter usbd_xfer_set_frame_len(xfer, n, length); 1169107484Speter 1170107484Speter if (length > rem) { 1171107484Speter xfer->error = USB_ERR_INVAL; 1172107484Speter goto complete; 1173107484Speter } 117425839Speter rem -= length; 1175107484Speter 1176107484Speter if (!isread) { 1177107484Speter 1178107484Speter /* we need to know the source buffer */ 1179107484Speter error = copyin(fs_ep.ppBuffer + n, 1180107484Speter &uaddr, sizeof(uaddr)); 1181107484Speter if (error) { 1182107484Speter break; 1183107484Speter } 1184107484Speter if (xfer->flags_int.isochronous_xfr) { 1185107484Speter /* get kernel buffer address */ 1186107484Speter kaddr = xfer->frbuffers[0].buffer; 1187107484Speter kaddr = USB_ADD_BYTES(kaddr, offset); 118825839Speter } else { 118925839Speter /* set current frame offset */ 119025839Speter usbd_xfer_set_frame_offset(xfer, offset, n); 119125839Speter 1192102840Speter /* get kernel buffer address */ 119325839Speter kaddr = xfer->frbuffers[n].buffer; 1194102840Speter } 1195102840Speter 119625839Speter /* move data */ 1197107484Speter error = copyin(uaddr, kaddr, length); 119825839Speter if (error) { 1199107484Speter break; 1200107484Speter } 1201107484Speter } 1202107484Speter offset += length; 1203107484Speter } 1204107484Speter return (error); 1205107484Speter 1206107484Spetercomplete: 1207107484Speter mtx_lock(f->priv_mtx); 1208107484Speter ugen_fs_set_complete(f, ep_index); 1209107484Speter mtx_unlock(f->priv_mtx); 1210107484Speter return (0); 1211107484Speter} 121225839Speter 1213107484Speterstatic int 1214107484Speterugen_fs_copy_out(struct usb_fifo *f, uint8_t ep_index) 1215107484Speter{ 1216107484Speter struct usb_device_request *req; 1217107484Speter struct usb_xfer *xfer; 1218107484Speter struct usb_fs_endpoint fs_ep; 1219107484Speter struct usb_fs_endpoint *fs_ep_uptr; /* userland ptr */ 1220107484Speter void *uaddr; /* userland ptr */ 1221107484Speter void *kaddr; 1222107484Speter usb_frlength_t offset; 1223107484Speter usb_frlength_t rem; 1224107484Speter usb_frcount_t n; 1225107484Speter uint32_t length; 1226107484Speter uint32_t temp; 1227107484Speter int error; 1228107484Speter uint8_t isread; 1229107484Speter 1230107484Speter if (ep_index >= f->fs_ep_max) 1231107484Speter return (EINVAL); 1232107484Speter 1233107484Speter xfer = f->fs_xfer[ep_index]; 1234107484Speter if (xfer == NULL) 123525839Speter return (EINVAL); 123625839Speter 123725839Speter mtx_lock(f->priv_mtx); 123825839Speter if (usbd_transfer_pending(xfer)) { 123925839Speter mtx_unlock(f->priv_mtx); 124025839Speter return (EBUSY); /* should not happen */ 124125839Speter } 124225839Speter mtx_unlock(f->priv_mtx); 124325839Speter 124425839Speter fs_ep_uptr = f->fs_ep_ptr + ep_index; 124525839Speter error = copyin(fs_ep_uptr, &fs_ep, sizeof(fs_ep)); 124625839Speter if (error) { 124725839Speter return (error); 124825839Speter } 124925839Speter fs_ep.status = xfer->error; 125025839Speter fs_ep.aFrames = xfer->aframes; 125125839Speter fs_ep.isoc_time_complete = xfer->isoc_time_complete; 125225839Speter if (xfer->error) { 125325839Speter goto complete; 125425839Speter } 125525839Speter if (xfer->flags_int.control_xfr) { 125625839Speter req = xfer->frbuffers[0].buffer; 125725839Speter 125825839Speter /* Host mode only ! */ 125925839Speter if ((req->bmRequestType & (UT_READ | UT_WRITE)) == UT_READ) { 126025839Speter isread = 1; 126125839Speter } else { 126225839Speter isread = 0; 126325839Speter } 126481404Speter if (xfer->nframes == 0) 126525839Speter n = 0; /* should never happen */ 126625839Speter else 126725839Speter n = 1; 126825839Speter } else { 126925839Speter /* Device and Host mode */ 127025839Speter if (USB_GET_DATA_ISREAD(xfer)) { 127125839Speter isread = 1; 127225839Speter } else { 127325839Speter isread = 0; 127425839Speter } 127525839Speter n = 0; 127625839Speter } 127725839Speter 127825839Speter /* Update lengths and copy out data */ 127925839Speter 128025839Speter rem = usbd_xfer_max_len(xfer); 128125839Speter offset = 0; 128225839Speter 128325839Speter for (; n != xfer->nframes; n++) { 128425839Speter 128525839Speter /* get initial length into "temp" */ 128625839Speter error = copyin(fs_ep.pLength + n, 128725839Speter &temp, sizeof(temp)); 128825839Speter if (error) { 128925839Speter return (error); 129025839Speter } 129125839Speter if (temp > rem) { 129225839Speter /* the userland length has been corrupted */ 129325839Speter DPRINTF("corrupt userland length " 129425839Speter "%u > %u\n", temp, rem); 129525839Speter fs_ep.status = USB_ERR_INVAL; 129625839Speter goto complete; 129725839Speter } 129825839Speter rem -= temp; 129925839Speter 130025839Speter /* get actual transfer length */ 130125839Speter length = xfer->frlengths[n]; 130225839Speter if (length > temp) { 130325839Speter /* data overflow */ 130425839Speter fs_ep.status = USB_ERR_INVAL; 130525839Speter DPRINTF("data overflow %u > %u\n", 130625839Speter length, temp); 130725839Speter goto complete; 130825839Speter } 130925839Speter if (isread) { 131025839Speter 131125839Speter /* we need to know the destination buffer */ 131225839Speter error = copyin(fs_ep.ppBuffer + n, 131325839Speter &uaddr, sizeof(uaddr)); 131425839Speter if (error) { 131525839Speter return (error); 131625839Speter } 131725839Speter if (xfer->flags_int.isochronous_xfr) { 131825839Speter /* only one frame buffer */ 131925839Speter kaddr = USB_ADD_BYTES( 132025839Speter xfer->frbuffers[0].buffer, offset); 132125839Speter } else { 132225839Speter /* multiple frame buffers */ 132325839Speter kaddr = xfer->frbuffers[n].buffer; 132425839Speter } 132525839Speter 132625839Speter /* move data */ 132725839Speter error = copyout(kaddr, uaddr, length); 132825839Speter if (error) { 132925839Speter return (error); 133025839Speter } 133125839Speter } 133225839Speter /* 133325839Speter * Update offset according to initial length, which is 133425839Speter * needed by isochronous transfers! 133525839Speter */ 133625839Speter offset += temp; 133725839Speter 133825839Speter /* update length */ 133925839Speter error = copyout(&length, 134025839Speter fs_ep.pLength + n, sizeof(length)); 134125839Speter if (error) { 134225839Speter return (error); 134325839Speter } 134425839Speter } 134525839Speter 134625839Spetercomplete: 134725839Speter /* update "aFrames" */ 134825839Speter error = copyout(&fs_ep.aFrames, &fs_ep_uptr->aFrames, 134925839Speter sizeof(fs_ep.aFrames)); 135025839Speter if (error) 135125839Speter goto done; 135225839Speter 135325839Speter /* update "isoc_time_complete" */ 135425839Speter error = copyout(&fs_ep.isoc_time_complete, 135525839Speter &fs_ep_uptr->isoc_time_complete, 135625839Speter sizeof(fs_ep.isoc_time_complete)); 135725839Speter if (error) 135825839Speter goto done; 135925839Speter /* update "status" */ 136025839Speter error = copyout(&fs_ep.status, &fs_ep_uptr->status, 136125839Speter sizeof(fs_ep.status)); 136225839Speterdone: 136325839Speter return (error); 136425839Speter} 136525839Speter 136625839Speterstatic uint8_t 136725839Speterugen_fifo_in_use(struct usb_fifo *f, int fflags) 136825839Speter{ 136925839Speter struct usb_fifo *f_rx; 137025839Speter struct usb_fifo *f_tx; 137125839Speter 137225839Speter f_rx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_RX]; 137325839Speter f_tx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_TX]; 137425839Speter 137525839Speter if ((fflags & FREAD) && f_rx && 137625839Speter (f_rx->xfer[0] || f_rx->xfer[1])) { 137725839Speter return (1); /* RX FIFO in use */ 137825839Speter } 137981404Speter if ((fflags & FWRITE) && f_tx && 1380102840Speter (f_tx->xfer[0] || f_tx->xfer[1])) { 1381102840Speter return (1); /* TX FIFO in use */ 1382102840Speter } 138325839Speter return (0); /* not in use */ 138425839Speter} 138525839Speter 138625839Speterstatic int 138725839Speterugen_ioctl(struct usb_fifo *f, u_long cmd, void *addr, int fflags) 138825839Speter{ 138925839Speter struct usb_config usb_config[1]; 139025839Speter struct usb_device_request req; 139125839Speter union { 139225839Speter struct usb_fs_complete *pcomp; 139325839Speter struct usb_fs_start *pstart; 139425839Speter struct usb_fs_stop *pstop; 139525839Speter struct usb_fs_open *popen; 139625839Speter struct usb_fs_close *pclose; 139725839Speter struct usb_fs_clear_stall_sync *pstall; 1398128266Speter void *addr; 1399128266Speter } u; 140025839Speter struct usb_endpoint *ep; 140125839Speter struct usb_endpoint_descriptor *ed; 140225839Speter struct usb_xfer *xfer; 140325839Speter int error = 0; 140425839Speter uint8_t iface_index; 140525839Speter uint8_t isread; 140625839Speter uint8_t ep_index; 140725839Speter uint8_t pre_scale; 140825839Speter 140925839Speter u.addr = addr; 141025839Speter 141125839Speter DPRINTFN(6, "cmd=0x%08lx\n", cmd); 141225839Speter 141325839Speter switch (cmd) { 141425839Speter case USB_FS_COMPLETE: 141525839Speter mtx_lock(f->priv_mtx); 1416128266Speter error = ugen_fs_get_complete(f, &ep_index); 1417128266Speter mtx_unlock(f->priv_mtx); 141825839Speter 141925839Speter if (error) { 142025839Speter error = EBUSY; 142125839Speter break; 142225839Speter } 142325839Speter u.pcomp->ep_index = ep_index; 142425839Speter error = ugen_fs_copy_out(f, u.pcomp->ep_index); 142525839Speter break; 142625839Speter 142725839Speter case USB_FS_START: 142825839Speter error = ugen_fs_copy_in(f, u.pstart->ep_index); 142925839Speter if (error) 1430128266Speter break; 1431128266Speter mtx_lock(f->priv_mtx); 143225839Speter xfer = f->fs_xfer[u.pstart->ep_index]; 143325839Speter usbd_transfer_start(xfer); 143425839Speter mtx_unlock(f->priv_mtx); 143525839Speter break; 143625839Speter 143725839Speter case USB_FS_STOP: 143825839Speter if (u.pstop->ep_index >= f->fs_ep_max) { 143925839Speter error = EINVAL; 144025839Speter break; 144125839Speter } 144225839Speter mtx_lock(f->priv_mtx); 144325839Speter xfer = f->fs_xfer[u.pstart->ep_index]; 144425839Speter if (usbd_transfer_pending(xfer)) { 144525839Speter usbd_transfer_stop(xfer); 144625839Speter /* 144725839Speter * Check if the USB transfer was stopped 144825839Speter * before it was even started. Else a cancel 144925839Speter * callback will be pending. 145025839Speter */ 1451128266Speter if (!xfer->flags_int.transferring) { 145225839Speter ugen_fs_set_complete(xfer->priv_sc, 145325839Speter USB_P2U(xfer->priv_fifo)); 145425839Speter } 145525839Speter } 145625839Speter mtx_unlock(f->priv_mtx); 145725839Speter break; 145825839Speter 145925839Speter case USB_FS_OPEN: 146025839Speter if (u.popen->ep_index >= f->fs_ep_max) { 146125839Speter error = EINVAL; 146225839Speter break; 146325839Speter } 146425839Speter if (f->fs_xfer[u.popen->ep_index] != NULL) { 146525839Speter error = EBUSY; 146625839Speter break; 146725839Speter } 146825839Speter if (u.popen->max_bufsize > USB_FS_MAX_BUFSIZE) { 146925839Speter u.popen->max_bufsize = USB_FS_MAX_BUFSIZE; 147025839Speter } 147125839Speter if (u.popen->max_frames & USB_FS_MAX_FRAMES_PRE_SCALE) { 147225839Speter pre_scale = 1; 147325839Speter u.popen->max_frames &= ~USB_FS_MAX_FRAMES_PRE_SCALE; 147425839Speter } else { 147525839Speter pre_scale = 0; 147625839Speter } 147725839Speter if (u.popen->max_frames > USB_FS_MAX_FRAMES) { 147825839Speter u.popen->max_frames = USB_FS_MAX_FRAMES; 147925839Speter break; 148025839Speter } 148125839Speter if (u.popen->max_frames == 0) { 148225839Speter error = EINVAL; 148325839Speter break; 148425839Speter } 148525839Speter ep = usbd_get_ep_by_addr(f->udev, u.popen->ep_no); 148625839Speter if (ep == NULL) { 148725839Speter error = EINVAL; 148825839Speter break; 148925839Speter } 149025839Speter ed = ep->edesc; 1491128266Speter if (ed == NULL) { 1492128266Speter error = ENXIO; 149325839Speter break; 149425839Speter } 149525839Speter iface_index = ep->iface_index; 149625839Speter 149725839Speter memset(usb_config, 0, sizeof(usb_config)); 149825839Speter 149925839Speter usb_config[0].type = ed->bmAttributes & UE_XFERTYPE; 150025839Speter usb_config[0].endpoint = ed->bEndpointAddress & UE_ADDR; 150125839Speter usb_config[0].direction = ed->bEndpointAddress & (UE_DIR_OUT | UE_DIR_IN); 150225839Speter usb_config[0].interval = USB_DEFAULT_INTERVAL; 150325839Speter usb_config[0].flags.proxy_buffer = 1; 150425839Speter if (pre_scale != 0) 150525839Speter usb_config[0].flags.pre_scale_frames = 1; 150625839Speter usb_config[0].callback = &ugen_ctrl_fs_callback; 150725839Speter usb_config[0].timeout = 0; /* no timeout */ 150825839Speter usb_config[0].frames = u.popen->max_frames; 1509128266Speter usb_config[0].bufsize = u.popen->max_bufsize; 151025839Speter usb_config[0].usb_mode = USB_MODE_DUAL; /* both modes */ 151125839Speter 151225839Speter if (usb_config[0].type == UE_CONTROL) { 151325839Speter if (f->udev->flags.usb_mode != USB_MODE_HOST) { 151425839Speter error = EINVAL; 151525839Speter break; 151625839Speter } 151725839Speter } else { 151825839Speter 151925839Speter isread = ((usb_config[0].endpoint & 152025839Speter (UE_DIR_IN | UE_DIR_OUT)) == UE_DIR_IN); 152125839Speter 152225839Speter if (f->udev->flags.usb_mode != USB_MODE_HOST) { 152325839Speter isread = !isread; 152425839Speter } 152525839Speter /* check permissions */ 152625839Speter if (isread) { 152725839Speter if (!(fflags & FREAD)) { 152825839Speter error = EPERM; 152925839Speter break; 153025839Speter } 153125839Speter } else { 153225839Speter if (!(fflags & FWRITE)) { 1533128266Speter error = EPERM; 153425839Speter break; 153525839Speter } 153625839Speter } 153725839Speter } 153825839Speter error = usbd_transfer_setup(f->udev, &iface_index, 153925839Speter f->fs_xfer + u.popen->ep_index, usb_config, 1, 154025839Speter f, f->priv_mtx); 154125839Speter if (error == 0) { 154225839Speter /* update maximums */ 154325839Speter u.popen->max_packet_length = 154425839Speter f->fs_xfer[u.popen->ep_index]->max_frame_size; 154525839Speter u.popen->max_bufsize = 154625839Speter f->fs_xfer[u.popen->ep_index]->max_data_length; 154725839Speter /* update number of frames */ 154825839Speter u.popen->max_frames = 154925839Speter f->fs_xfer[u.popen->ep_index]->nframes; 155025839Speter /* store index of endpoint */ 155125839Speter f->fs_xfer[u.popen->ep_index]->priv_fifo = 155225839Speter ((uint8_t *)0) + u.popen->ep_index; 155325839Speter } else { 155425839Speter error = ENOMEM; 155525839Speter } 155625839Speter break; 155725839Speter 155825839Speter case USB_FS_CLOSE: 155925839Speter if (u.pclose->ep_index >= f->fs_ep_max) { 156025839Speter error = EINVAL; 156125839Speter break; 156225839Speter } 156325839Speter if (f->fs_xfer[u.pclose->ep_index] == NULL) { 156425839Speter error = EINVAL; 156525839Speter break; 156625839Speter } 156725839Speter usbd_transfer_unsetup(f->fs_xfer + u.pclose->ep_index, 1); 156825839Speter break; 1569128266Speter 157025839Speter case USB_FS_CLEAR_STALL_SYNC: 157125839Speter if (u.pstall->ep_index >= f->fs_ep_max) { 157225839Speter error = EINVAL; 157325839Speter break; 157425839Speter } 157525839Speter if (f->fs_xfer[u.pstall->ep_index] == NULL) { 157625839Speter error = EINVAL; 157725839Speter break; 157825839Speter } 157925839Speter if (f->udev->flags.usb_mode != USB_MODE_HOST) { 158025839Speter error = EINVAL; 158125839Speter break; 158225839Speter } 158325839Speter mtx_lock(f->priv_mtx); 158425839Speter error = usbd_transfer_pending(f->fs_xfer[u.pstall->ep_index]); 158525839Speter mtx_unlock(f->priv_mtx); 158625839Speter 158725839Speter if (error) { 158825839Speter return (EBUSY); 158925839Speter } 159025839Speter ep = f->fs_xfer[u.pstall->ep_index]->endpoint; 159125839Speter 159225839Speter /* setup a clear-stall packet */ 159325839Speter req.bmRequestType = UT_WRITE_ENDPOINT; 159425839Speter req.bRequest = UR_CLEAR_FEATURE; 159525839Speter USETW(req.wValue, UF_ENDPOINT_HALT); 159625839Speter req.wIndex[0] = ep->edesc->bEndpointAddress; 159732785Speter req.wIndex[1] = 0; 159825839Speter USETW(req.wLength, 0); 159925839Speter 160025839Speter error = usbd_do_request(f->udev, NULL, &req, NULL); 160125839Speter if (error == 0) { 160225839Speter usbd_clear_data_toggle(f->udev, ep); 160325839Speter } else { 160425839Speter error = ENXIO; 160525839Speter } 160625839Speter break; 160725839Speter 160825839Speter default: 160925839Speter error = ENOIOCTL; 1610131688Sdes break; 1611131688Sdes } 161225839Speter 161325839Speter DPRINTFN(6, "error=%d\n", error); 161425839Speter 161525839Speter return (error); 161625839Speter} 161725839Speter 161825839Speterstatic int 161925839Speterugen_set_short_xfer(struct usb_fifo *f, void *addr) 162025839Speter{ 162125839Speter uint8_t t; 162225839Speter 162325839Speter if (*(int *)addr) 162425839Speter t = 1; 162525839Speter else 162625839Speter t = 0; 162725839Speter 162825839Speter if (f->flag_short == t) { 162925839Speter /* same value like before - accept */ 163025839Speter return (0); 163125839Speter } 163225839Speter if (f->xfer[0] || f->xfer[1]) { 163325839Speter /* cannot change this during transfer */ 163425839Speter return (EBUSY); 163525839Speter } 163625839Speter f->flag_short = t; 163725839Speter return (0); 163825839Speter} 163925839Speter 1640128266Speterstatic int 164125839Speterugen_set_timeout(struct usb_fifo *f, void *addr) 164225839Speter{ 164325839Speter f->timeout = *(int *)addr; 164425839Speter if (f->timeout > 65535) { 164525839Speter /* limit user input */ 164625839Speter f->timeout = 65535; 164725839Speter } 164825839Speter return (0); 164925839Speter} 165025839Speter 165125839Speterstatic int 165225839Speterugen_get_frame_size(struct usb_fifo *f, void *addr) 165325839Speter{ 165425839Speter if (f->xfer[0]) { 165525839Speter *(int *)addr = f->xfer[0]->max_frame_size; 165625839Speter } else { 165725839Speter return (EINVAL); 165825839Speter } 165925839Speter return (0); 166025839Speter} 166125839Speter 166232785Speterstatic int 166332785Speterugen_set_buffer_size(struct usb_fifo *f, void *addr) 166432785Speter{ 166532785Speter usb_frlength_t t; 166632785Speter 166732785Speter if (*(int *)addr < 0) 166832785Speter t = 0; /* use "wMaxPacketSize" */ 1669128266Speter else if (*(int *)addr < (256 * 1024)) 167025839Speter t = *(int *)addr; 167125839Speter else 167225839Speter t = 256 * 1024; 167325839Speter 167425839Speter if (f->bufsize == t) { 167525839Speter /* same value like before - accept */ 1676128266Speter return (0); 167725839Speter } 167825839Speter if (f->xfer[0] || f->xfer[1]) { 167925839Speter /* cannot change this during transfer */ 168025839Speter return (EBUSY); 168125839Speter } 168225839Speter f->bufsize = t; 168325839Speter return (0); 168425839Speter} 168525839Speter 168625839Speterstatic int 168725839Speterugen_get_buffer_size(struct usb_fifo *f, void *addr) 168825839Speter{ 168925839Speter *(int *)addr = f->bufsize; 169025839Speter return (0); 169125839Speter} 169225839Speter 169325839Speterstatic int 169425839Speterugen_get_iface_desc(struct usb_fifo *f, 169525839Speter struct usb_interface_descriptor *idesc) 169625839Speter{ 169725839Speter struct usb_interface *iface; 169825839Speter 169925839Speter iface = usbd_get_iface(f->udev, f->iface_index); 170025839Speter if (iface && iface->idesc) { 170125839Speter *idesc = *(iface->idesc); 170225839Speter } else { 170325839Speter return (EIO); 170425839Speter } 170525839Speter return (0); 170625839Speter} 170725839Speter 170817721Speterstatic int 170917721Speterugen_get_endpoint_desc(struct usb_fifo *f, 171017721Speter struct usb_endpoint_descriptor *ed) 171117721Speter{ 171225839Speter struct usb_endpoint *ep; 171325839Speter 1714128266Speter ep = usb_fifo_softc(f); 1715128266Speter 1716128266Speter if (ep && ep->edesc) { 171725839Speter *ed = *ep->edesc; 171817721Speter } else { 171917721Speter return (EINVAL); 172017721Speter } 172117721Speter return (0); 172217721Speter} 172317721Speter 172417721Speterstatic int 172517721Speterugen_set_power_mode(struct usb_fifo *f, int mode) 172625839Speter{ 172725839Speter struct usb_device *udev = f->udev; 172825839Speter int err; 172925839Speter uint8_t old_mode; 173025839Speter 173125839Speter if ((udev == NULL) || 173225839Speter (udev->parent_hub == NULL)) { 173325839Speter return (EINVAL); 173425839Speter } 173525839Speter err = priv_check(curthread, PRIV_DRIVER); 173625839Speter if (err) 173725839Speter return (err); 173825839Speter 173925839Speter /* get old power mode */ 174025839Speter old_mode = udev->power_mode; 174125839Speter 174225839Speter /* if no change, then just return */ 174325839Speter if (old_mode == mode) 174425839Speter return (0); 174525839Speter 174625839Speter switch (mode) { 174754427Speter case USB_POWER_MODE_OFF: 174825839Speter /* get the device unconfigured */ 174925839Speter err = ugen_set_config(f, USB_UNCONFIG_INDEX); 175025839Speter if (err) { 175125839Speter DPRINTFN(0, "Could not unconfigure " 175254427Speter "device (ignored)\n"); 175325839Speter } 175425839Speter 175525839Speter /* clear port enable */ 175625839Speter err = usbd_req_clear_port_feature(udev->parent_hub, 175725839Speter NULL, udev->port_no, UHF_PORT_ENABLE); 175825839Speter break; 175925839Speter 176025839Speter case USB_POWER_MODE_ON: 176125839Speter case USB_POWER_MODE_SAVE: 176225839Speter break; 176325839Speter 176425839Speter case USB_POWER_MODE_RESUME: 176525839Speter#if USB_HAVE_POWERD 176625839Speter /* let USB-powerd handle resume */ 176725839Speter USB_BUS_LOCK(udev->bus); 176825839Speter udev->pwr_save.write_refs++; 176925839Speter udev->pwr_save.last_xfer_time = ticks; 177025839Speter USB_BUS_UNLOCK(udev->bus); 177125839Speter 177225839Speter /* set new power mode */ 177325839Speter usbd_set_power_mode(udev, USB_POWER_MODE_SAVE); 177425839Speter 1775 /* wait for resume to complete */ 1776 usb_pause_mtx(NULL, hz / 4); 1777 1778 /* clear write reference */ 1779 USB_BUS_LOCK(udev->bus); 1780 udev->pwr_save.write_refs--; 1781 USB_BUS_UNLOCK(udev->bus); 1782#endif 1783 mode = USB_POWER_MODE_SAVE; 1784 break; 1785 1786 case USB_POWER_MODE_SUSPEND: 1787#if USB_HAVE_POWERD 1788 /* let USB-powerd handle suspend */ 1789 USB_BUS_LOCK(udev->bus); 1790 udev->pwr_save.last_xfer_time = ticks - (256 * hz); 1791 USB_BUS_UNLOCK(udev->bus); 1792#endif 1793 mode = USB_POWER_MODE_SAVE; 1794 break; 1795 1796 default: 1797 return (EINVAL); 1798 } 1799 1800 if (err) 1801 return (ENXIO); /* I/O failure */ 1802 1803 /* if we are powered off we need to re-enumerate first */ 1804 if (old_mode == USB_POWER_MODE_OFF) { 1805 if (udev->flags.usb_mode == USB_MODE_HOST) { 1806 if (udev->re_enumerate_wait == 0) 1807 udev->re_enumerate_wait = 1; 1808 } 1809 /* set power mode will wake up the explore thread */ 1810 } 1811 1812 /* set new power mode */ 1813 usbd_set_power_mode(udev, mode); 1814 1815 return (0); /* success */ 1816} 1817 1818static int 1819ugen_get_power_mode(struct usb_fifo *f) 1820{ 1821 struct usb_device *udev = f->udev; 1822 1823 if (udev == NULL) 1824 return (USB_POWER_MODE_ON); 1825 1826 return (udev->power_mode); 1827} 1828 1829static int 1830ugen_do_port_feature(struct usb_fifo *f, uint8_t port_no, 1831 uint8_t set, uint16_t feature) 1832{ 1833 struct usb_device *udev = f->udev; 1834 struct usb_hub *hub; 1835 int err; 1836 1837 err = priv_check(curthread, PRIV_DRIVER); 1838 if (err) { 1839 return (err); 1840 } 1841 if (port_no == 0) { 1842 return (EINVAL); 1843 } 1844 if ((udev == NULL) || 1845 (udev->hub == NULL)) { 1846 return (EINVAL); 1847 } 1848 hub = udev->hub; 1849 1850 if (port_no > hub->nports) { 1851 return (EINVAL); 1852 } 1853 if (set) 1854 err = usbd_req_set_port_feature(udev, 1855 NULL, port_no, feature); 1856 else 1857 err = usbd_req_clear_port_feature(udev, 1858 NULL, port_no, feature); 1859 1860 if (err) 1861 return (ENXIO); /* failure */ 1862 1863 return (0); /* success */ 1864} 1865 1866static int 1867ugen_iface_ioctl(struct usb_fifo *f, u_long cmd, void *addr, int fflags) 1868{ 1869 struct usb_fifo *f_rx; 1870 struct usb_fifo *f_tx; 1871 int error = 0; 1872 1873 f_rx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_RX]; 1874 f_tx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_TX]; 1875 1876 switch (cmd) { 1877 case USB_SET_RX_SHORT_XFER: 1878 if (fflags & FREAD) { 1879 error = ugen_set_short_xfer(f_rx, addr); 1880 } else { 1881 error = EINVAL; 1882 } 1883 break; 1884 1885 case USB_SET_TX_FORCE_SHORT: 1886 if (fflags & FWRITE) { 1887 error = ugen_set_short_xfer(f_tx, addr); 1888 } else { 1889 error = EINVAL; 1890 } 1891 break; 1892 1893 case USB_SET_RX_TIMEOUT: 1894 if (fflags & FREAD) { 1895 error = ugen_set_timeout(f_rx, addr); 1896 } else { 1897 error = EINVAL; 1898 } 1899 break; 1900 1901 case USB_SET_TX_TIMEOUT: 1902 if (fflags & FWRITE) { 1903 error = ugen_set_timeout(f_tx, addr); 1904 } else { 1905 error = EINVAL; 1906 } 1907 break; 1908 1909 case USB_GET_RX_FRAME_SIZE: 1910 if (fflags & FREAD) { 1911 error = ugen_get_frame_size(f_rx, addr); 1912 } else { 1913 error = EINVAL; 1914 } 1915 break; 1916 1917 case USB_GET_TX_FRAME_SIZE: 1918 if (fflags & FWRITE) { 1919 error = ugen_get_frame_size(f_tx, addr); 1920 } else { 1921 error = EINVAL; 1922 } 1923 break; 1924 1925 case USB_SET_RX_BUFFER_SIZE: 1926 if (fflags & FREAD) { 1927 error = ugen_set_buffer_size(f_rx, addr); 1928 } else { 1929 error = EINVAL; 1930 } 1931 break; 1932 1933 case USB_SET_TX_BUFFER_SIZE: 1934 if (fflags & FWRITE) { 1935 error = ugen_set_buffer_size(f_tx, addr); 1936 } else { 1937 error = EINVAL; 1938 } 1939 break; 1940 1941 case USB_GET_RX_BUFFER_SIZE: 1942 if (fflags & FREAD) { 1943 error = ugen_get_buffer_size(f_rx, addr); 1944 } else { 1945 error = EINVAL; 1946 } 1947 break; 1948 1949 case USB_GET_TX_BUFFER_SIZE: 1950 if (fflags & FWRITE) { 1951 error = ugen_get_buffer_size(f_tx, addr); 1952 } else { 1953 error = EINVAL; 1954 } 1955 break; 1956 1957 case USB_GET_RX_INTERFACE_DESC: 1958 if (fflags & FREAD) { 1959 error = ugen_get_iface_desc(f_rx, addr); 1960 } else { 1961 error = EINVAL; 1962 } 1963 break; 1964 1965 case USB_GET_TX_INTERFACE_DESC: 1966 if (fflags & FWRITE) { 1967 error = ugen_get_iface_desc(f_tx, addr); 1968 } else { 1969 error = EINVAL; 1970 } 1971 break; 1972 1973 case USB_GET_RX_ENDPOINT_DESC: 1974 if (fflags & FREAD) { 1975 error = ugen_get_endpoint_desc(f_rx, addr); 1976 } else { 1977 error = EINVAL; 1978 } 1979 break; 1980 1981 case USB_GET_TX_ENDPOINT_DESC: 1982 if (fflags & FWRITE) { 1983 error = ugen_get_endpoint_desc(f_tx, addr); 1984 } else { 1985 error = EINVAL; 1986 } 1987 break; 1988 1989 case USB_SET_RX_STALL_FLAG: 1990 if ((fflags & FREAD) && (*(int *)addr)) { 1991 f_rx->flag_stall = 1; 1992 } 1993 break; 1994 1995 case USB_SET_TX_STALL_FLAG: 1996 if ((fflags & FWRITE) && (*(int *)addr)) { 1997 f_tx->flag_stall = 1; 1998 } 1999 break; 2000 2001 default: 2002 error = ENOIOCTL; 2003 break; 2004 } 2005 return (error); 2006} 2007 2008static int 2009ugen_ioctl_post(struct usb_fifo *f, u_long cmd, void *addr, int fflags) 2010{ 2011 union { 2012 struct usb_interface_descriptor *idesc; 2013 struct usb_alt_interface *ai; 2014 struct usb_device_descriptor *ddesc; 2015 struct usb_config_descriptor *cdesc; 2016 struct usb_device_stats *stat; 2017 struct usb_fs_init *pinit; 2018 struct usb_fs_uninit *puninit; 2019 uint32_t *ptime; 2020 void *addr; 2021 int *pint; 2022 } u; 2023 struct usb_device_descriptor *dtemp; 2024 struct usb_config_descriptor *ctemp; 2025 struct usb_interface *iface; 2026 int error = 0; 2027 uint8_t n; 2028 2029 u.addr = addr; 2030 2031 DPRINTFN(6, "cmd=0x%08lx\n", cmd); 2032 2033 switch (cmd) { 2034 case USB_DISCOVER: 2035 usb_needs_explore_all(); 2036 break; 2037 2038 case USB_SETDEBUG: 2039 if (!(fflags & FWRITE)) { 2040 error = EPERM; 2041 break; 2042 } 2043 usb_debug = *(int *)addr; 2044 break; 2045 2046 case USB_GET_CONFIG: 2047 *(int *)addr = f->udev->curr_config_index; 2048 break; 2049 2050 case USB_SET_CONFIG: 2051 if (!(fflags & FWRITE)) { 2052 error = EPERM; 2053 break; 2054 } 2055 error = ugen_set_config(f, *(int *)addr); 2056 break; 2057 2058 case USB_GET_ALTINTERFACE: 2059 iface = usbd_get_iface(f->udev, 2060 u.ai->uai_interface_index); 2061 if (iface && iface->idesc) { 2062 u.ai->uai_alt_index = iface->alt_index; 2063 } else { 2064 error = EINVAL; 2065 } 2066 break; 2067 2068 case USB_SET_ALTINTERFACE: 2069 if (!(fflags & FWRITE)) { 2070 error = EPERM; 2071 break; 2072 } 2073 error = ugen_set_interface(f, 2074 u.ai->uai_interface_index, u.ai->uai_alt_index); 2075 break; 2076 2077 case USB_GET_DEVICE_DESC: 2078 dtemp = usbd_get_device_descriptor(f->udev); 2079 if (!dtemp) { 2080 error = EIO; 2081 break; 2082 } 2083 *u.ddesc = *dtemp; 2084 break; 2085 2086 case USB_GET_CONFIG_DESC: 2087 ctemp = usbd_get_config_descriptor(f->udev); 2088 if (!ctemp) { 2089 error = EIO; 2090 break; 2091 } 2092 *u.cdesc = *ctemp; 2093 break; 2094 2095 case USB_GET_FULL_DESC: 2096 error = ugen_get_cdesc(f, addr); 2097 break; 2098 2099 case USB_GET_STRING_DESC: 2100 error = ugen_get_sdesc(f, addr); 2101 break; 2102 2103 case USB_GET_IFACE_DRIVER: 2104 error = ugen_get_iface_driver(f, addr); 2105 break; 2106 2107 case USB_REQUEST: 2108 case USB_DO_REQUEST: 2109 if (!(fflags & FWRITE)) { 2110 error = EPERM; 2111 break; 2112 } 2113 error = ugen_do_request(f, addr); 2114 break; 2115 2116 case USB_DEVICEINFO: 2117 case USB_GET_DEVICEINFO: 2118 error = usb_gen_fill_deviceinfo(f, addr); 2119 break; 2120 2121 case USB_DEVICESTATS: 2122 for (n = 0; n != 4; n++) { 2123 2124 u.stat->uds_requests_fail[n] = 2125 f->udev->bus->stats_err.uds_requests[n]; 2126 2127 u.stat->uds_requests_ok[n] = 2128 f->udev->bus->stats_ok.uds_requests[n]; 2129 } 2130 break; 2131 2132 case USB_DEVICEENUMERATE: 2133 error = ugen_re_enumerate(f); 2134 break; 2135 2136 case USB_GET_PLUGTIME: 2137 *u.ptime = f->udev->plugtime; 2138 break; 2139 2140 case USB_CLAIM_INTERFACE: 2141 case USB_RELEASE_INTERFACE: 2142 /* TODO */ 2143 break; 2144 2145 case USB_IFACE_DRIVER_ACTIVE: 2146 2147 n = *u.pint & 0xFF; 2148 2149 iface = usbd_get_iface(f->udev, n); 2150 2151 if (iface && iface->subdev) 2152 error = 0; 2153 else 2154 error = ENXIO; 2155 break; 2156 2157 case USB_IFACE_DRIVER_DETACH: 2158 2159 error = priv_check(curthread, PRIV_DRIVER); 2160 2161 if (error) 2162 break; 2163 2164 n = *u.pint & 0xFF; 2165 2166 if (n == USB_IFACE_INDEX_ANY) { 2167 error = EINVAL; 2168 break; 2169 } 2170 2171 usb_detach_device(f->udev, n, 0); 2172 break; 2173 2174 case USB_SET_POWER_MODE: 2175 error = ugen_set_power_mode(f, *u.pint); 2176 break; 2177 2178 case USB_GET_POWER_MODE: 2179 *u.pint = ugen_get_power_mode(f); 2180 break; 2181 2182 case USB_SET_PORT_ENABLE: 2183 error = ugen_do_port_feature(f, 2184 *u.pint, 1, UHF_PORT_ENABLE); 2185 break; 2186 2187 case USB_SET_PORT_DISABLE: 2188 error = ugen_do_port_feature(f, 2189 *u.pint, 0, UHF_PORT_ENABLE); 2190 break; 2191 2192 case USB_FS_INIT: 2193 /* verify input parameters */ 2194 if (u.pinit->pEndpoints == NULL) { 2195 error = EINVAL; 2196 break; 2197 } 2198 if (u.pinit->ep_index_max > 127) { 2199 error = EINVAL; 2200 break; 2201 } 2202 if (u.pinit->ep_index_max == 0) { 2203 error = EINVAL; 2204 break; 2205 } 2206 if (f->fs_xfer != NULL) { 2207 error = EBUSY; 2208 break; 2209 } 2210 if (f->dev_ep_index != 0) { 2211 error = EINVAL; 2212 break; 2213 } 2214 if (ugen_fifo_in_use(f, fflags)) { 2215 error = EBUSY; 2216 break; 2217 } 2218 error = usb_fifo_alloc_buffer(f, 1, u.pinit->ep_index_max); 2219 if (error) { 2220 break; 2221 } 2222 f->fs_xfer = malloc(sizeof(f->fs_xfer[0]) * 2223 u.pinit->ep_index_max, M_USB, M_WAITOK | M_ZERO); 2224 if (f->fs_xfer == NULL) { 2225 usb_fifo_free_buffer(f); 2226 error = ENOMEM; 2227 break; 2228 } 2229 f->fs_ep_max = u.pinit->ep_index_max; 2230 f->fs_ep_ptr = u.pinit->pEndpoints; 2231 break; 2232 2233 case USB_FS_UNINIT: 2234 if (u.puninit->dummy != 0) { 2235 error = EINVAL; 2236 break; 2237 } 2238 error = ugen_fs_uninit(f); 2239 break; 2240 2241 default: 2242 mtx_lock(f->priv_mtx); 2243 error = ugen_iface_ioctl(f, cmd, addr, fflags); 2244 mtx_unlock(f->priv_mtx); 2245 break; 2246 } 2247 DPRINTFN(6, "error=%d\n", error); 2248 return (error); 2249} 2250 2251static void 2252ugen_ctrl_fs_callback(struct usb_xfer *xfer, usb_error_t error) 2253{ 2254 ; /* workaround for a bug in "indent" */ 2255 2256 DPRINTF("st=%u alen=%u aframes=%u\n", 2257 USB_GET_STATE(xfer), xfer->actlen, xfer->aframes); 2258 2259 switch (USB_GET_STATE(xfer)) { 2260 case USB_ST_SETUP: 2261 usbd_transfer_submit(xfer); 2262 break; 2263 default: 2264 ugen_fs_set_complete(xfer->priv_sc, USB_P2U(xfer->priv_fifo)); 2265 break; 2266 } 2267} 2268#endif /* USB_HAVE_UGEN */ 2269