usb_generic.c

Version: - FREEBSD - FREEBSD-13-STABLE - FREEBSD-13-0 - FREEBSD-12-STABLE - FREEBSD-12-0 - FREEBSD-11-STABLE - FREEBSD-11-0 - FREEBSD-10-STABLE - FREEBSD-10-0 - FREEBSD-9-STABLE - FREEBSD-9-0 - FREEBSD-8-STABLE - FREEBSD-8-0 - FREEBSD-7-STABLE - FREEBSD-7-0 - FREEBSD-6-STABLE - FREEBSD-6-0 - FREEBSD-5-STABLE - FREEBSD-5-0 - FREEBSD-4-STABLE - FREEBSD-3-STABLE - FREEBSD22 - l41 - OPENBSD - linux-2.6 - MK84 - PLAN9 - xnu-8792
SearchContext: - none - 3 - 10
    1 /* $FreeBSD: releng/10.3/sys/dev/usb/usb_generic.c 277845 2015-01-28 19:41:31Z hselasky $ */
    2 /*-
    3  * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
    4  *
    5  * Redistribution and use in source and binary forms, with or without
    6  * modification, are permitted provided that the following conditions
    7  * are met:
    8  * 1. Redistributions of source code must retain the above copyright
    9  *    notice, this list of conditions and the following disclaimer.
   10  * 2. Redistributions in binary form must reproduce the above copyright
   11  *    notice, this list of conditions and the following disclaimer in the
   12  *    documentation and/or other materials provided with the distribution.
   13  *
   14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
   15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
   18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   24  * SUCH DAMAGE.
   25  */
   26 
   27 #ifdef USB_GLOBAL_INCLUDE_FILE
   28 #include USB_GLOBAL_INCLUDE_FILE
   29 #else
   30 #include <sys/stdint.h>
   31 #include <sys/stddef.h>
   32 #include <sys/param.h>
   33 #include <sys/queue.h>
   34 #include <sys/types.h>
   35 #include <sys/systm.h>
   36 #include <sys/kernel.h>
   37 #include <sys/bus.h>
   38 #include <sys/module.h>
   39 #include <sys/lock.h>
   40 #include <sys/mutex.h>
   41 #include <sys/condvar.h>
   42 #include <sys/sysctl.h>
   43 #include <sys/sx.h>
   44 #include <sys/unistd.h>
   45 #include <sys/callout.h>
   46 #include <sys/malloc.h>
   47 #include <sys/priv.h>
   48 #include <sys/conf.h>
   49 #include <sys/fcntl.h>
   50 
   51 #include <dev/usb/usb.h>
   52 #include <dev/usb/usb_ioctl.h>
   53 #include <dev/usb/usbdi.h>
   54 #include <dev/usb/usbdi_util.h>
   55 
   56 #define USB_DEBUG_VAR ugen_debug
   57 
   58 #include <dev/usb/usb_core.h>
   59 #include <dev/usb/usb_dev.h>
   60 #include <dev/usb/usb_mbuf.h>
   61 #include <dev/usb/usb_process.h>
   62 #include <dev/usb/usb_device.h>
   63 #include <dev/usb/usb_debug.h>
   64 #include <dev/usb/usb_request.h>
   65 #include <dev/usb/usb_busdma.h>
   66 #include <dev/usb/usb_util.h>
   67 #include <dev/usb/usb_hub.h>
   68 #include <dev/usb/usb_generic.h>
   69 #include <dev/usb/usb_transfer.h>
   70 
   71 #include <dev/usb/usb_controller.h>
   72 #include <dev/usb/usb_bus.h>
   73 #endif                  /* USB_GLOBAL_INCLUDE_FILE */
   74 
   75 #if USB_HAVE_UGEN
   76 
   77 /* defines */
   78 
   79 #define UGEN_BULK_FS_BUFFER_SIZE        (64*32) /* bytes */
   80 #define UGEN_BULK_HS_BUFFER_SIZE        (1024*32)       /* bytes */
   81 #define UGEN_HW_FRAMES  50              /* number of milliseconds per transfer */
   82 
   83 /* function prototypes */
   84 
   85 static usb_callback_t ugen_read_clear_stall_callback;
   86 static usb_callback_t ugen_write_clear_stall_callback;
   87 static usb_callback_t ugen_ctrl_read_callback;
   88 static usb_callback_t ugen_ctrl_write_callback;
   89 static usb_callback_t ugen_isoc_read_callback;
   90 static usb_callback_t ugen_isoc_write_callback;
   91 static usb_callback_t ugen_ctrl_fs_callback;
   92 
   93 static usb_fifo_open_t ugen_open;
   94 static usb_fifo_close_t ugen_close;
   95 static usb_fifo_ioctl_t ugen_ioctl;
   96 static usb_fifo_ioctl_t ugen_ioctl_post;
   97 static usb_fifo_cmd_t ugen_start_read;
   98 static usb_fifo_cmd_t ugen_start_write;
   99 static usb_fifo_cmd_t ugen_stop_io;
  100 
  101 static int      ugen_transfer_setup(struct usb_fifo *,
  102                      const struct usb_config *, uint8_t);
  103 static int      ugen_open_pipe_write(struct usb_fifo *);
  104 static int      ugen_open_pipe_read(struct usb_fifo *);
  105 static int      ugen_set_config(struct usb_fifo *, uint8_t);
  106 static int      ugen_set_interface(struct usb_fifo *, uint8_t, uint8_t);
  107 static int      ugen_get_cdesc(struct usb_fifo *, struct usb_gen_descriptor *);
  108 static int      ugen_get_sdesc(struct usb_fifo *, struct usb_gen_descriptor *);
  109 static int      ugen_get_iface_driver(struct usb_fifo *f, struct usb_gen_descriptor *ugd);
  110 static int      usb_gen_fill_deviceinfo(struct usb_fifo *,
  111                     struct usb_device_info *);
  112 static int      ugen_re_enumerate(struct usb_fifo *);
  113 static int      ugen_iface_ioctl(struct usb_fifo *, u_long, void *, int);
  114 static uint8_t  ugen_fs_get_complete(struct usb_fifo *, uint8_t *);
  115 static int      ugen_fs_uninit(struct usb_fifo *f);
  116 
  117 /* structures */
  118 
  119 struct usb_fifo_methods usb_ugen_methods = {
  120         .f_open = &ugen_open,
  121         .f_close = &ugen_close,
  122         .f_ioctl = &ugen_ioctl,
  123         .f_ioctl_post = &ugen_ioctl_post,
  124         .f_start_read = &ugen_start_read,
  125         .f_stop_read = &ugen_stop_io,
  126         .f_start_write = &ugen_start_write,
  127         .f_stop_write = &ugen_stop_io,
  128 };
  129 
  130 #ifdef USB_DEBUG
  131 static int ugen_debug = 0;
  132 
  133 static SYSCTL_NODE(_hw_usb, OID_AUTO, ugen, CTLFLAG_RW, 0, "USB generic");
  134 SYSCTL_INT(_hw_usb_ugen, OID_AUTO, debug, CTLFLAG_RW | CTLFLAG_TUN, &ugen_debug,
  135     0, "Debug level");
  136 TUNABLE_INT("hw.usb.ugen.debug", &ugen_debug);
  137 #endif
  138 
  139 
  140 /* prototypes */
  141 
  142 static int
  143 ugen_transfer_setup(struct usb_fifo *f,
  144     const struct usb_config *setup, uint8_t n_setup)
  145 {
  146         struct usb_endpoint *ep = usb_fifo_softc(f);
  147         struct usb_device *udev = f->udev;
  148         uint8_t iface_index = ep->iface_index;
  149         int error;
  150 
  151         mtx_unlock(f->priv_mtx);
  152 
  153         /*
  154          * "usbd_transfer_setup()" can sleep so one needs to make a wrapper,
  155          * exiting the mutex and checking things
  156          */
  157         error = usbd_transfer_setup(udev, &iface_index, f->xfer,
  158             setup, n_setup, f, f->priv_mtx);
  159         if (error == 0) {
  160 
  161                 if (f->xfer[0]->nframes == 1) {
  162                         error = usb_fifo_alloc_buffer(f,
  163                             f->xfer[0]->max_data_length, 2);
  164                 } else {
  165                         error = usb_fifo_alloc_buffer(f,
  166                             f->xfer[0]->max_frame_size,
  167                             2 * f->xfer[0]->nframes);
  168                 }
  169                 if (error) {
  170                         usbd_transfer_unsetup(f->xfer, n_setup);
  171                 }
  172         }
  173         mtx_lock(f->priv_mtx);
  174 
  175         return (error);
  176 }
  177 
  178 static int
  179 ugen_open(struct usb_fifo *f, int fflags)
  180 {
  181         struct usb_endpoint *ep = usb_fifo_softc(f);
  182         struct usb_endpoint_descriptor *ed = ep->edesc;
  183         uint8_t type;
  184 
  185         DPRINTFN(6, "flag=0x%x\n", fflags);
  186 
  187         mtx_lock(f->priv_mtx);
  188         switch (usbd_get_speed(f->udev)) {
  189         case USB_SPEED_LOW:
  190         case USB_SPEED_FULL:
  191                 f->nframes = UGEN_HW_FRAMES;
  192                 f->bufsize = UGEN_BULK_FS_BUFFER_SIZE;
  193                 break;
  194         default:
  195                 f->nframes = UGEN_HW_FRAMES * 8;
  196                 f->bufsize = UGEN_BULK_HS_BUFFER_SIZE;
  197                 break;
  198         }
  199 
  200         type = ed->bmAttributes & UE_XFERTYPE;
  201         if (type == UE_INTERRUPT) {
  202                 f->bufsize = 0;         /* use "wMaxPacketSize" */
  203         }
  204         f->timeout = USB_NO_TIMEOUT;
  205         f->flag_short = 0;
  206         f->fifo_zlp = 0;
  207         mtx_unlock(f->priv_mtx);
  208 
  209         return (0);
  210 }
  211 
  212 static void
  213 ugen_close(struct usb_fifo *f, int fflags)
  214 {
  215         DPRINTFN(6, "flag=0x%x\n", fflags);
  216 
  217         /* cleanup */
  218 
  219         mtx_lock(f->priv_mtx);
  220         usbd_transfer_stop(f->xfer[0]);
  221         usbd_transfer_stop(f->xfer[1]);
  222         mtx_unlock(f->priv_mtx);
  223 
  224         usbd_transfer_unsetup(f->xfer, 2);
  225         usb_fifo_free_buffer(f);
  226 
  227         if (ugen_fs_uninit(f)) {
  228                 /* ignore any errors - we are closing */
  229                 DPRINTFN(6, "no FIFOs\n");
  230         }
  231 }
  232 
  233 static int
  234 ugen_open_pipe_write(struct usb_fifo *f)
  235 {
  236         struct usb_config usb_config[2];
  237         struct usb_endpoint *ep = usb_fifo_softc(f);
  238         struct usb_endpoint_descriptor *ed = ep->edesc;
  239 
  240         mtx_assert(f->priv_mtx, MA_OWNED);
  241 
  242         if (f->xfer[0] || f->xfer[1]) {
  243                 /* transfers are already opened */
  244                 return (0);
  245         }
  246         memset(usb_config, 0, sizeof(usb_config));
  247 
  248         usb_config[1].type = UE_CONTROL;
  249         usb_config[1].endpoint = 0;
  250         usb_config[1].direction = UE_DIR_ANY;
  251         usb_config[1].timeout = 1000;   /* 1 second */
  252         usb_config[1].interval = 50;/* 50 milliseconds */
  253         usb_config[1].bufsize = sizeof(struct usb_device_request);
  254         usb_config[1].callback = &ugen_write_clear_stall_callback;
  255         usb_config[1].usb_mode = USB_MODE_HOST;
  256 
  257         usb_config[0].type = ed->bmAttributes & UE_XFERTYPE;
  258         usb_config[0].endpoint = ed->bEndpointAddress & UE_ADDR;
  259         usb_config[0].stream_id = 0;    /* XXX support more stream ID's */
  260         usb_config[0].direction = UE_DIR_TX;
  261         usb_config[0].interval = USB_DEFAULT_INTERVAL;
  262         usb_config[0].flags.proxy_buffer = 1;
  263         usb_config[0].usb_mode = USB_MODE_DUAL; /* both modes */
  264 
  265         switch (ed->bmAttributes & UE_XFERTYPE) {
  266         case UE_INTERRUPT:
  267         case UE_BULK:
  268                 if (f->flag_short) {
  269                         usb_config[0].flags.force_short_xfer = 1;
  270                 }
  271                 usb_config[0].callback = &ugen_ctrl_write_callback;
  272                 usb_config[0].timeout = f->timeout;
  273                 usb_config[0].frames = 1;
  274                 usb_config[0].bufsize = f->bufsize;
  275                 if (ugen_transfer_setup(f, usb_config, 2)) {
  276                         return (EIO);
  277                 }
  278                 /* first transfer does not clear stall */
  279                 f->flag_stall = 0;
  280                 break;
  281 
  282         case UE_ISOCHRONOUS:
  283                 usb_config[0].flags.short_xfer_ok = 1;
  284                 usb_config[0].bufsize = 0;      /* use default */
  285                 usb_config[0].frames = f->nframes;
  286                 usb_config[0].callback = &ugen_isoc_write_callback;
  287                 usb_config[0].timeout = 0;
  288 
  289                 /* clone configuration */
  290                 usb_config[1] = usb_config[0];
  291 
  292                 if (ugen_transfer_setup(f, usb_config, 2)) {
  293                         return (EIO);
  294                 }
  295                 break;
  296         default:
  297                 return (EINVAL);
  298         }
  299         return (0);
  300 }
  301 
  302 static int
  303 ugen_open_pipe_read(struct usb_fifo *f)
  304 {
  305         struct usb_config usb_config[2];
  306         struct usb_endpoint *ep = usb_fifo_softc(f);
  307         struct usb_endpoint_descriptor *ed = ep->edesc;
  308 
  309         mtx_assert(f->priv_mtx, MA_OWNED);
  310 
  311         if (f->xfer[0] || f->xfer[1]) {
  312                 /* transfers are already opened */
  313                 return (0);
  314         }
  315         memset(usb_config, 0, sizeof(usb_config));
  316 
  317         usb_config[1].type = UE_CONTROL;
  318         usb_config[1].endpoint = 0;
  319         usb_config[1].direction = UE_DIR_ANY;
  320         usb_config[1].timeout = 1000;   /* 1 second */
  321         usb_config[1].interval = 50;/* 50 milliseconds */
  322         usb_config[1].bufsize = sizeof(struct usb_device_request);
  323         usb_config[1].callback = &ugen_read_clear_stall_callback;
  324         usb_config[1].usb_mode = USB_MODE_HOST;
  325 
  326         usb_config[0].type = ed->bmAttributes & UE_XFERTYPE;
  327         usb_config[0].endpoint = ed->bEndpointAddress & UE_ADDR;
  328         usb_config[0].stream_id = 0;    /* XXX support more stream ID's */
  329         usb_config[0].direction = UE_DIR_RX;
  330         usb_config[0].interval = USB_DEFAULT_INTERVAL;
  331         usb_config[0].flags.proxy_buffer = 1;
  332         usb_config[0].usb_mode = USB_MODE_DUAL; /* both modes */
  333 
  334         switch (ed->bmAttributes & UE_XFERTYPE) {
  335         case UE_INTERRUPT:
  336         case UE_BULK:
  337                 if (f->flag_short) {
  338                         usb_config[0].flags.short_xfer_ok = 1;
  339                 }
  340                 usb_config[0].timeout = f->timeout;
  341                 usb_config[0].frames = 1;
  342                 usb_config[0].callback = &ugen_ctrl_read_callback;
  343                 usb_config[0].bufsize = f->bufsize;
  344 
  345                 if (ugen_transfer_setup(f, usb_config, 2)) {
  346                         return (EIO);
  347                 }
  348                 /* first transfer does not clear stall */
  349                 f->flag_stall = 0;
  350                 break;
  351 
  352         case UE_ISOCHRONOUS:
  353                 usb_config[0].flags.short_xfer_ok = 1;
  354                 usb_config[0].bufsize = 0;      /* use default */
  355                 usb_config[0].frames = f->nframes;
  356                 usb_config[0].callback = &ugen_isoc_read_callback;
  357                 usb_config[0].timeout = 0;
  358 
  359                 /* clone configuration */
  360                 usb_config[1] = usb_config[0];
  361 
  362                 if (ugen_transfer_setup(f, usb_config, 2)) {
  363                         return (EIO);
  364                 }
  365                 break;
  366 
  367         default:
  368                 return (EINVAL);
  369         }
  370         return (0);
  371 }
  372 
  373 static void
  374 ugen_start_read(struct usb_fifo *f)
  375 {
  376         /* check that pipes are open */
  377         if (ugen_open_pipe_read(f)) {
  378                 /* signal error */
  379                 usb_fifo_put_data_error(f);
  380         }
  381         /* start transfers */
  382         usbd_transfer_start(f->xfer[0]);
  383         usbd_transfer_start(f->xfer[1]);
  384 }
  385 
  386 static void
  387 ugen_start_write(struct usb_fifo *f)
  388 {
  389         /* check that pipes are open */
  390         if (ugen_open_pipe_write(f)) {
  391                 /* signal error */
  392                 usb_fifo_get_data_error(f);
  393         }
  394         /* start transfers */
  395         usbd_transfer_start(f->xfer[0]);
  396         usbd_transfer_start(f->xfer[1]);
  397 }
  398 
  399 static void
  400 ugen_stop_io(struct usb_fifo *f)
  401 {
  402         /* stop transfers */
  403         usbd_transfer_stop(f->xfer[0]);
  404         usbd_transfer_stop(f->xfer[1]);
  405 }
  406 
  407 static void
  408 ugen_ctrl_read_callback(struct usb_xfer *xfer, usb_error_t error)
  409 {
  410         struct usb_fifo *f = usbd_xfer_softc(xfer);
  411         struct usb_mbuf *m;
  412 
  413         DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes);
  414 
  415         switch (USB_GET_STATE(xfer)) {
  416         case USB_ST_TRANSFERRED:
  417                 if (xfer->actlen == 0) {
  418                         if (f->fifo_zlp != 4) {
  419                                 f->fifo_zlp++;
  420                         } else {
  421                                 /*
  422                                  * Throttle a little bit we have multiple ZLPs
  423                                  * in a row!
  424                                  */
  425                                 xfer->interval = 64;    /* ms */
  426                         }
  427                 } else {
  428                         /* clear throttle */
  429                         xfer->interval = 0;
  430                         f->fifo_zlp = 0;
  431                 }
  432                 usb_fifo_put_data(f, xfer->frbuffers, 0,
  433                     xfer->actlen, 1);
  434 
  435         case USB_ST_SETUP:
  436                 if (f->flag_stall) {
  437                         usbd_transfer_start(f->xfer[1]);
  438                         break;
  439                 }
  440                 USB_IF_POLL(&f->free_q, m);
  441                 if (m) {
  442                         usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
  443                         usbd_transfer_submit(xfer);
  444                 }
  445                 break;
  446 
  447         default:                        /* Error */
  448                 if (xfer->error != USB_ERR_CANCELLED) {
  449                         /* send a zero length packet to userland */
  450                         usb_fifo_put_data(f, xfer->frbuffers, 0, 0, 1);
  451                         f->flag_stall = 1;
  452                         f->fifo_zlp = 0;
  453                         usbd_transfer_start(f->xfer[1]);
  454                 }
  455                 break;
  456         }
  457 }
  458 
  459 static void
  460 ugen_ctrl_write_callback(struct usb_xfer *xfer, usb_error_t error)
  461 {
  462         struct usb_fifo *f = usbd_xfer_softc(xfer);
  463         usb_frlength_t actlen;
  464 
  465         DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes);
  466 
  467         switch (USB_GET_STATE(xfer)) {
  468         case USB_ST_SETUP:
  469         case USB_ST_TRANSFERRED:
  470                 /*
  471                  * If writing is in stall, just jump to clear stall
  472                  * callback and solve the situation.
  473                  */
  474                 if (f->flag_stall) {
  475                         usbd_transfer_start(f->xfer[1]);
  476                         break;
  477                 }
  478                 /*
  479                  * Write data, setup and perform hardware transfer.
  480                  */
  481                 if (usb_fifo_get_data(f, xfer->frbuffers, 0,
  482                     xfer->max_data_length, &actlen, 0)) {
  483                         usbd_xfer_set_frame_len(xfer, 0, actlen);
  484                         usbd_transfer_submit(xfer);
  485                 }
  486                 break;
  487 
  488         default:                        /* Error */
  489                 if (xfer->error != USB_ERR_CANCELLED) {
  490                         f->flag_stall = 1;
  491                         usbd_transfer_start(f->xfer[1]);
  492                 }
  493                 break;
  494         }
  495 }
  496 
  497 static void
  498 ugen_read_clear_stall_callback(struct usb_xfer *xfer, usb_error_t error)
  499 {
  500         struct usb_fifo *f = usbd_xfer_softc(xfer);
  501         struct usb_xfer *xfer_other = f->xfer[0];
  502 
  503         if (f->flag_stall == 0) {
  504                 /* nothing to do */
  505                 return;
  506         }
  507         if (usbd_clear_stall_callback(xfer, xfer_other)) {
  508                 DPRINTFN(5, "f=%p: stall cleared\n", f);
  509                 f->flag_stall = 0;
  510                 usbd_transfer_start(xfer_other);
  511         }
  512 }
  513 
  514 static void
  515 ugen_write_clear_stall_callback(struct usb_xfer *xfer, usb_error_t error)
  516 {
  517         struct usb_fifo *f = usbd_xfer_softc(xfer);
  518         struct usb_xfer *xfer_other = f->xfer[0];
  519 
  520         if (f->flag_stall == 0) {
  521                 /* nothing to do */
  522                 return;
  523         }
  524         if (usbd_clear_stall_callback(xfer, xfer_other)) {
  525                 DPRINTFN(5, "f=%p: stall cleared\n", f);
  526                 f->flag_stall = 0;
  527                 usbd_transfer_start(xfer_other);
  528         }
  529 }
  530 
  531 static void
  532 ugen_isoc_read_callback(struct usb_xfer *xfer, usb_error_t error)
  533 {
  534         struct usb_fifo *f = usbd_xfer_softc(xfer);
  535         usb_frlength_t offset;
  536         usb_frcount_t n;
  537 
  538         DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes);
  539 
  540         switch (USB_GET_STATE(xfer)) {
  541         case USB_ST_TRANSFERRED:
  542 
  543                 DPRINTFN(6, "actlen=%d\n", xfer->actlen);
  544 
  545                 offset = 0;
  546 
  547                 for (n = 0; n != xfer->aframes; n++) {
  548                         usb_fifo_put_data(f, xfer->frbuffers, offset,
  549                             xfer->frlengths[n], 1);
  550                         offset += xfer->max_frame_size;
  551                 }
  552 
  553         case USB_ST_SETUP:
  554 tr_setup:
  555                 for (n = 0; n != xfer->nframes; n++) {
  556                         /* setup size for next transfer */
  557                         usbd_xfer_set_frame_len(xfer, n, xfer->max_frame_size);
  558                 }
  559                 usbd_transfer_submit(xfer);
  560                 break;
  561 
  562         default:                        /* Error */
  563                 if (xfer->error == USB_ERR_CANCELLED) {
  564                         break;
  565                 }
  566                 goto tr_setup;
  567         }
  568 }
  569 
  570 static void
  571 ugen_isoc_write_callback(struct usb_xfer *xfer, usb_error_t error)
  572 {
  573         struct usb_fifo *f = usbd_xfer_softc(xfer);
  574         usb_frlength_t actlen;
  575         usb_frlength_t offset;
  576         usb_frcount_t n;
  577 
  578         DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes);
  579 
  580         switch (USB_GET_STATE(xfer)) {
  581         case USB_ST_TRANSFERRED:
  582         case USB_ST_SETUP:
  583 tr_setup:
  584                 offset = 0;
  585                 for (n = 0; n != xfer->nframes; n++) {
  586                         if (usb_fifo_get_data(f, xfer->frbuffers, offset,
  587                             xfer->max_frame_size, &actlen, 1)) {
  588                                 usbd_xfer_set_frame_len(xfer, n, actlen);
  589                                 offset += actlen;
  590                         } else {
  591                                 break;
  592                         }
  593                 }
  594 
  595                 for (; n != xfer->nframes; n++) {
  596                         /* fill in zero frames */
  597                         usbd_xfer_set_frame_len(xfer, n, 0);
  598                 }
  599                 usbd_transfer_submit(xfer);
  600                 break;
  601 
  602         default:                        /* Error */
  603                 if (xfer->error == USB_ERR_CANCELLED) {
  604                         break;
  605                 }
  606                 goto tr_setup;
  607         }
  608 }
  609 
  610 static int
  611 ugen_set_config(struct usb_fifo *f, uint8_t index)
  612 {
  613         DPRINTFN(2, "index %u\n", index);
  614 
  615         if (f->udev->flags.usb_mode != USB_MODE_HOST) {
  616                 /* not possible in device side mode */
  617                 return (ENOTTY);
  618         }
  619 
  620         /* make sure all FIFO's are gone */
  621         /* else there can be a deadlock */
  622         if (ugen_fs_uninit(f)) {
  623                 /* ignore any errors */
  624                 DPRINTFN(6, "no FIFOs\n");
  625         }
  626 
  627         if (usbd_start_set_config(f->udev, index) != 0)
  628                 return (EIO);
  629 
  630         return (0);
  631 }
  632 
  633 static int
  634 ugen_set_interface(struct usb_fifo *f,
  635     uint8_t iface_index, uint8_t alt_index)
  636 {
  637         DPRINTFN(2, "%u, %u\n", iface_index, alt_index);
  638 
  639         if (f->udev->flags.usb_mode != USB_MODE_HOST) {
  640                 /* not possible in device side mode */
  641                 return (ENOTTY);
  642         }
  643         /* make sure all FIFO's are gone */
  644         /* else there can be a deadlock */
  645         if (ugen_fs_uninit(f)) {
  646                 /* ignore any errors */
  647                 DPRINTFN(6, "no FIFOs\n");
  648         }
  649         /* change setting - will free generic FIFOs, if any */
  650         if (usbd_set_alt_interface_index(f->udev, iface_index, alt_index)) {
  651                 return (EIO);
  652         }
  653         /* probe and attach */
  654         if (usb_probe_and_attach(f->udev, iface_index)) {
  655                 return (EIO);
  656         }
  657         return (0);
  658 }
  659 
  660 /*------------------------------------------------------------------------*
  661  *      ugen_get_cdesc
  662  *
  663  * This function will retrieve the complete configuration descriptor
  664  * at the given index.
  665  *------------------------------------------------------------------------*/
  666 static int
  667 ugen_get_cdesc(struct usb_fifo *f, struct usb_gen_descriptor *ugd)
  668 {
  669         struct usb_config_descriptor *cdesc;
  670         struct usb_device *udev = f->udev;
  671         int error;
  672         uint16_t len;
  673         uint8_t free_data;
  674 
  675         DPRINTFN(6, "\n");
  676 
  677         if (ugd->ugd_data == NULL) {
  678                 /* userland pointer should not be zero */
  679                 return (EINVAL);
  680         }
  681         if ((ugd->ugd_config_index == USB_UNCONFIG_INDEX) ||
  682             (ugd->ugd_config_index == udev->curr_config_index)) {
  683                 cdesc = usbd_get_config_descriptor(udev);
  684                 if (cdesc == NULL)
  685                         return (ENXIO);
  686                 free_data = 0;
  687 
  688         } else {
  689 #if (USB_HAVE_FIXED_CONFIG == 0)
  690                 if (usbd_req_get_config_desc_full(udev,
  691                     NULL, &cdesc, ugd->ugd_config_index)) {
  692                         return (ENXIO);
  693                 }
  694                 free_data = 1;
  695 #else
  696                 /* configuration descriptor data is shared */
  697                 return (EINVAL);
  698 #endif
  699         }
  700 
  701         len = UGETW(cdesc->wTotalLength);
  702         if (len > ugd->ugd_maxlen) {
  703                 len = ugd->ugd_maxlen;
  704         }
  705         DPRINTFN(6, "len=%u\n", len);
  706 
  707         ugd->ugd_actlen = len;
  708         ugd->ugd_offset = 0;
  709 
  710         error = copyout(cdesc, ugd->ugd_data, len);
  711 
  712         if (free_data)
  713                 usbd_free_config_desc(udev, cdesc);
  714 
  715         return (error);
  716 }
  717 
  718 /*
  719  * This function is called having the enumeration SX locked which
  720  * protects the scratch area used.
  721  */
  722 static int
  723 ugen_get_sdesc(struct usb_fifo *f, struct usb_gen_descriptor *ugd)
  724 {
  725         void *ptr;
  726         uint16_t size;
  727         int error;
  728 
  729         ptr = f->udev->scratch.data;
  730         size = sizeof(f->udev->scratch.data);
  731 
  732         if (usbd_req_get_string_desc(f->udev, NULL, ptr,
  733             size, ugd->ugd_lang_id, ugd->ugd_string_index)) {
  734                 error = EINVAL;
  735         } else {
  736 
  737                 if (size > ((uint8_t *)ptr)[0]) {
  738                         size = ((uint8_t *)ptr)[0];
  739                 }
  740                 if (size > ugd->ugd_maxlen) {
  741                         size = ugd->ugd_maxlen;
  742                 }
  743                 ugd->ugd_actlen = size;
  744                 ugd->ugd_offset = 0;
  745 
  746                 error = copyout(ptr, ugd->ugd_data, size);
  747         }
  748         return (error);
  749 }
  750 
  751 /*------------------------------------------------------------------------*
  752  *      ugen_get_iface_driver
  753  *
  754  * This function generates an USB interface description for userland.
  755  *
  756  * Returns:
  757  *    0: Success
  758  * Else: Failure
  759  *------------------------------------------------------------------------*/
  760 static int
  761 ugen_get_iface_driver(struct usb_fifo *f, struct usb_gen_descriptor *ugd)
  762 {
  763         struct usb_device *udev = f->udev;
  764         struct usb_interface *iface;
  765         const char *ptr;
  766         const char *desc;
  767         unsigned int len;
  768         unsigned int maxlen;
  769         char buf[128];
  770         int error;
  771 
  772         DPRINTFN(6, "\n");
  773 
  774         if ((ugd->ugd_data == NULL) || (ugd->ugd_maxlen == 0)) {
  775                 /* userland pointer should not be zero */
  776                 return (EINVAL);
  777         }
  778 
  779         iface = usbd_get_iface(udev, ugd->ugd_iface_index);
  780         if ((iface == NULL) || (iface->idesc == NULL)) {
  781                 /* invalid interface index */
  782                 return (EINVAL);
  783         }
  784 
  785         /* read out device nameunit string, if any */
  786         if ((iface->subdev != NULL) &&
  787             device_is_attached(iface->subdev) &&
  788             (ptr = device_get_nameunit(iface->subdev)) &&
  789             (desc = device_get_desc(iface->subdev))) {
  790 
  791                 /* print description */
  792                 snprintf(buf, sizeof(buf), "%s: <%s>", ptr, desc);
  793 
  794                 /* range checks */
  795                 maxlen = ugd->ugd_maxlen - 1;
  796                 len = strlen(buf);
  797                 if (len > maxlen)
  798                         len = maxlen;
  799 
  800                 /* update actual length, including terminating zero */
  801                 ugd->ugd_actlen = len + 1;
  802 
  803                 /* copy out interface description */
  804                 error = copyout(buf, ugd->ugd_data, ugd->ugd_actlen);
  805         } else {
  806                 /* zero length string is default */
  807                 error = copyout("", ugd->ugd_data, 1);
  808         }
  809         return (error);
  810 }
  811 
  812 /*------------------------------------------------------------------------*
  813  *      usb_gen_fill_deviceinfo
  814  *
  815  * This function dumps information about an USB device to the
  816  * structure pointed to by the "di" argument.
  817  *
  818  * Returns:
  819  *    0: Success
  820  * Else: Failure
  821  *------------------------------------------------------------------------*/
  822 static int
  823 usb_gen_fill_deviceinfo(struct usb_fifo *f, struct usb_device_info *di)
  824 {
  825         struct usb_device *udev;
  826         struct usb_device *hub;
  827 
  828         udev = f->udev;
  829 
  830         bzero(di, sizeof(di[0]));
  831 
  832         di->udi_bus = device_get_unit(udev->bus->bdev);
  833         di->udi_addr = udev->address;
  834         di->udi_index = udev->device_index;
  835         strlcpy(di->udi_serial, usb_get_serial(udev), sizeof(di->udi_serial));
  836         strlcpy(di->udi_vendor, usb_get_manufacturer(udev), sizeof(di->udi_vendor));
  837         strlcpy(di->udi_product, usb_get_product(udev), sizeof(di->udi_product));
  838         usb_printbcd(di->udi_release, sizeof(di->udi_release),
  839             UGETW(udev->ddesc.bcdDevice));
  840         di->udi_vendorNo = UGETW(udev->ddesc.idVendor);
  841         di->udi_productNo = UGETW(udev->ddesc.idProduct);
  842         di->udi_releaseNo = UGETW(udev->ddesc.bcdDevice);
  843         di->udi_class = udev->ddesc.bDeviceClass;
  844         di->udi_subclass = udev->ddesc.bDeviceSubClass;
  845         di->udi_protocol = udev->ddesc.bDeviceProtocol;
  846         di->udi_config_no = udev->curr_config_no;
  847         di->udi_config_index = udev->curr_config_index;
  848         di->udi_power = udev->flags.self_powered ? 0 : udev->power;
  849         di->udi_speed = udev->speed;
  850         di->udi_mode = udev->flags.usb_mode;
  851         di->udi_power_mode = udev->power_mode;
  852         di->udi_suspended = udev->flags.peer_suspended;
  853 
  854         hub = udev->parent_hub;
  855         if (hub) {
  856                 di->udi_hubaddr = hub->address;
  857                 di->udi_hubindex = hub->device_index;
  858                 di->udi_hubport = udev->port_no;
  859         }
  860         return (0);
  861 }
  862 
  863 /*------------------------------------------------------------------------*
  864  *      ugen_check_request
  865  *
  866  * Return values:
  867  * 0: Access allowed
  868  * Else: No access
  869  *------------------------------------------------------------------------*/
  870 static int
  871 ugen_check_request(struct usb_device *udev, struct usb_device_request *req)
  872 {
  873         struct usb_endpoint *ep;
  874         int error;
  875 
  876         /*
  877          * Avoid requests that would damage the bus integrity:
  878          */
  879         if (((req->bmRequestType == UT_WRITE_DEVICE) &&
  880             (req->bRequest == UR_SET_ADDRESS)) ||
  881             ((req->bmRequestType == UT_WRITE_DEVICE) &&
  882             (req->bRequest == UR_SET_CONFIG)) ||
  883             ((req->bmRequestType == UT_WRITE_INTERFACE) &&
  884             (req->bRequest == UR_SET_INTERFACE))) {
  885                 /*
  886                  * These requests can be useful for testing USB drivers.
  887                  */
  888                 error = priv_check(curthread, PRIV_DRIVER);
  889                 if (error) {
  890                         return (error);
  891                 }
  892         }
  893         /*
  894          * Special case - handle clearing of stall
  895          */
  896         if (req->bmRequestType == UT_WRITE_ENDPOINT) {
  897 
  898                 ep = usbd_get_ep_by_addr(udev, req->wIndex[0]);
  899                 if (ep == NULL) {
  900                         return (EINVAL);
  901                 }
  902                 if ((req->bRequest == UR_CLEAR_FEATURE) &&
  903                     (UGETW(req->wValue) == UF_ENDPOINT_HALT)) {
  904                         usbd_clear_data_toggle(udev, ep);
  905                 }
  906         }
  907         /* TODO: add more checks to verify the interface index */
  908 
  909         return (0);
  910 }
  911 
  912 int
  913 ugen_do_request(struct usb_fifo *f, struct usb_ctl_request *ur)
  914 {
  915         int error;
  916         uint16_t len;
  917         uint16_t actlen;
  918 
  919         if (ugen_check_request(f->udev, &ur->ucr_request)) {
  920                 return (EPERM);
  921         }
  922         len = UGETW(ur->ucr_request.wLength);
  923 
  924         /* check if "ucr_data" is valid */
  925         if (len != 0) {
  926                 if (ur->ucr_data == NULL) {
  927                         return (EFAULT);
  928                 }
  929         }
  930         /* do the USB request */
  931         error = usbd_do_request_flags
  932             (f->udev, NULL, &ur->ucr_request, ur->ucr_data,
  933             (ur->ucr_flags & USB_SHORT_XFER_OK) |
  934             USB_USER_DATA_PTR, &actlen,
  935             USB_DEFAULT_TIMEOUT);
  936 
  937         ur->ucr_actlen = actlen;
  938 
  939         if (error) {
  940                 error = EIO;
  941         }
  942         return (error);
  943 }
  944 
  945 /*------------------------------------------------------------------------
  946  *      ugen_re_enumerate
  947  *------------------------------------------------------------------------*/
  948 static int
  949 ugen_re_enumerate(struct usb_fifo *f)
  950 {
  951         struct usb_device *udev = f->udev;
  952         int error;
  953 
  954         /*
  955          * This request can be useful for testing USB drivers:
  956          */
  957         error = priv_check(curthread, PRIV_DRIVER);
  958         if (error) {
  959                 return (error);
  960         }
  961         if (udev->flags.usb_mode != USB_MODE_HOST) {
  962                 /* not possible in device side mode */
  963                 DPRINTFN(6, "device mode\n");
  964                 return (ENOTTY);
  965         }
  966         /* make sure all FIFO's are gone */
  967         /* else there can be a deadlock */
  968         if (ugen_fs_uninit(f)) {
  969                 /* ignore any errors */
  970                 DPRINTFN(6, "no FIFOs\n");
  971         }
  972         /* start re-enumeration of device */
  973         usbd_start_re_enumerate(udev);
  974         return (0);
  975 }
  976 
  977 int
  978 ugen_fs_uninit(struct usb_fifo *f)
  979 {
  980         if (f->fs_xfer == NULL) {
  981                 return (EINVAL);
  982         }
  983         usbd_transfer_unsetup(f->fs_xfer, f->fs_ep_max);
  984         free(f->fs_xfer, M_USB);
  985         f->fs_xfer = NULL;
  986         f->fs_ep_max = 0;
  987         f->fs_ep_ptr = NULL;
  988         f->flag_iscomplete = 0;
  989         usb_fifo_free_buffer(f);
  990         return (0);
  991 }
  992 
  993 static uint8_t
  994 ugen_fs_get_complete(struct usb_fifo *f, uint8_t *pindex)
  995 {
  996         struct usb_mbuf *m;
  997 
  998         USB_IF_DEQUEUE(&f->used_q, m);
  999 
 1000         if (m) {
 1001                 *pindex = *((uint8_t *)(m->cur_data_ptr));
 1002 
 1003                 USB_IF_ENQUEUE(&f->free_q, m);
 1004 
 1005                 return (0);             /* success */
 1006         } else {
 1007 
 1008                 *pindex = 0;            /* fix compiler warning */
 1009 
 1010                 f->flag_iscomplete = 0;
 1011         }
 1012         return (1);                     /* failure */
 1013 }
 1014 
 1015 static void
 1016 ugen_fs_set_complete(struct usb_fifo *f, uint8_t index)
 1017 {
 1018         struct usb_mbuf *m;
 1019 
 1020         USB_IF_DEQUEUE(&f->free_q, m);
 1021 
 1022         if (m == NULL) {
 1023                 /* can happen during close */
 1024                 DPRINTF("out of buffers\n");
 1025                 return;
 1026         }
 1027         USB_MBUF_RESET(m);
 1028 
 1029         *((uint8_t *)(m->cur_data_ptr)) = index;
 1030 
 1031         USB_IF_ENQUEUE(&f->used_q, m);
 1032 
 1033         f->flag_iscomplete = 1;
 1034 
 1035         usb_fifo_wakeup(f);
 1036 }
 1037 
 1038 static int
 1039 ugen_fs_copy_in(struct usb_fifo *f, uint8_t ep_index)
 1040 {
 1041         struct usb_device_request *req;
 1042         struct usb_xfer *xfer;
 1043         struct usb_fs_endpoint fs_ep;
 1044         void *uaddr;                    /* userland pointer */
 1045         void *kaddr;
 1046         usb_frlength_t offset;
 1047         usb_frlength_t rem;
 1048         usb_frcount_t n;
 1049         uint32_t length;
 1050         int error;
 1051         uint8_t isread;
 1052 
 1053         if (ep_index >= f->fs_ep_max) {
 1054                 return (EINVAL);
 1055         }
 1056         xfer = f->fs_xfer[ep_index];
 1057         if (xfer == NULL) {
 1058                 return (EINVAL);
 1059         }
 1060         mtx_lock(f->priv_mtx);
 1061         if (usbd_transfer_pending(xfer)) {
 1062                 mtx_unlock(f->priv_mtx);
 1063                 return (EBUSY);         /* should not happen */
 1064         }
 1065         mtx_unlock(f->priv_mtx);
 1066 
 1067         error = copyin(f->fs_ep_ptr +
 1068             ep_index, &fs_ep, sizeof(fs_ep));
 1069         if (error) {
 1070                 return (error);
 1071         }
 1072         /* security checks */
 1073 
 1074         if (fs_ep.nFrames > xfer->max_frame_count) {
 1075                 xfer->error = USB_ERR_INVAL;
 1076                 goto complete;
 1077         }
 1078         if (fs_ep.nFrames == 0) {
 1079                 xfer->error = USB_ERR_INVAL;
 1080                 goto complete;
 1081         }
 1082         error = copyin(fs_ep.ppBuffer,
 1083             &uaddr, sizeof(uaddr));
 1084         if (error) {
 1085                 return (error);
 1086         }
 1087         /* reset first frame */
 1088         usbd_xfer_set_frame_offset(xfer, 0, 0);
 1089 
 1090         if (xfer->flags_int.control_xfr) {
 1091 
 1092                 req = xfer->frbuffers[0].buffer;
 1093 
 1094                 error = copyin(fs_ep.pLength,
 1095                     &length, sizeof(length));
 1096                 if (error) {
 1097                         return (error);
 1098                 }
 1099                 if (length != sizeof(*req)) {
 1100                         xfer->error = USB_ERR_INVAL;
 1101                         goto complete;
 1102                 }
 1103                 if (length != 0) {
 1104                         error = copyin(uaddr, req, length);
 1105                         if (error) {
 1106                                 return (error);
 1107                         }
 1108                 }
 1109                 if (ugen_check_request(f->udev, req)) {
 1110                         xfer->error = USB_ERR_INVAL;
 1111                         goto complete;
 1112                 }
 1113                 usbd_xfer_set_frame_len(xfer, 0, length);
 1114 
 1115                 /* Host mode only ! */
 1116                 if ((req->bmRequestType &
 1117                     (UT_READ | UT_WRITE)) == UT_READ) {
 1118                         isread = 1;
 1119                 } else {
 1120                         isread = 0;
 1121                 }
 1122                 n = 1;
 1123                 offset = sizeof(*req);
 1124 
 1125         } else {
 1126                 /* Device and Host mode */
 1127                 if (USB_GET_DATA_ISREAD(xfer)) {
 1128                         isread = 1;
 1129                 } else {
 1130                         isread = 0;
 1131                 }
 1132                 n = 0;
 1133                 offset = 0;
 1134         }
 1135 
 1136         rem = usbd_xfer_max_len(xfer);
 1137         xfer->nframes = fs_ep.nFrames;
 1138         xfer->timeout = fs_ep.timeout;
 1139         if (xfer->timeout > 65535) {
 1140                 xfer->timeout = 65535;
 1141         }
 1142         if (fs_ep.flags & USB_FS_FLAG_SINGLE_SHORT_OK)
 1143                 xfer->flags.short_xfer_ok = 1;
 1144         else
 1145                 xfer->flags.short_xfer_ok = 0;
 1146 
 1147         if (fs_ep.flags & USB_FS_FLAG_MULTI_SHORT_OK)
 1148                 xfer->flags.short_frames_ok = 1;
 1149         else
 1150                 xfer->flags.short_frames_ok = 0;
 1151 
 1152         if (fs_ep.flags & USB_FS_FLAG_FORCE_SHORT)
 1153                 xfer->flags.force_short_xfer = 1;
 1154         else
 1155                 xfer->flags.force_short_xfer = 0;
 1156 
 1157         if (fs_ep.flags & USB_FS_FLAG_CLEAR_STALL)
 1158                 usbd_xfer_set_stall(xfer);
 1159         else
 1160                 xfer->flags.stall_pipe = 0;
 1161 
 1162         for (; n != xfer->nframes; n++) {
 1163 
 1164                 error = copyin(fs_ep.pLength + n,
 1165                     &length, sizeof(length));
 1166                 if (error) {
 1167                         break;
 1168                 }
 1169                 usbd_xfer_set_frame_len(xfer, n, length);
 1170 
 1171                 if (length > rem) {
 1172                         xfer->error = USB_ERR_INVAL;
 1173                         goto complete;
 1174                 }
 1175                 rem -= length;
 1176 
 1177                 if (!isread) {
 1178 
 1179                         /* we need to know the source buffer */
 1180                         error = copyin(fs_ep.ppBuffer + n,
 1181                             &uaddr, sizeof(uaddr));
 1182                         if (error) {
 1183                                 break;
 1184                         }
 1185                         if (xfer->flags_int.isochronous_xfr) {
 1186                                 /* get kernel buffer address */
 1187                                 kaddr = xfer->frbuffers[0].buffer;
 1188                                 kaddr = USB_ADD_BYTES(kaddr, offset);
 1189                         } else {
 1190                                 /* set current frame offset */
 1191                                 usbd_xfer_set_frame_offset(xfer, offset, n);
 1192 
 1193                                 /* get kernel buffer address */
 1194                                 kaddr = xfer->frbuffers[n].buffer;
 1195                         }
 1196 
 1197                         /* move data */
 1198                         error = copyin(uaddr, kaddr, length);
 1199                         if (error) {
 1200                                 break;
 1201                         }
 1202                 }
 1203                 offset += length;
 1204         }
 1205         return (error);
 1206 
 1207 complete:
 1208         mtx_lock(f->priv_mtx);
 1209         ugen_fs_set_complete(f, ep_index);
 1210         mtx_unlock(f->priv_mtx);
 1211         return (0);
 1212 }
 1213 
 1214 static int
 1215 ugen_fs_copy_out(struct usb_fifo *f, uint8_t ep_index)
 1216 {
 1217         struct usb_device_request *req;
 1218         struct usb_xfer *xfer;
 1219         struct usb_fs_endpoint fs_ep;
 1220         struct usb_fs_endpoint *fs_ep_uptr;     /* userland ptr */
 1221         void *uaddr;                    /* userland ptr */
 1222         void *kaddr;
 1223         usb_frlength_t offset;
 1224         usb_frlength_t rem;
 1225         usb_frcount_t n;
 1226         uint32_t length;
 1227         uint32_t temp;
 1228         int error;
 1229         uint8_t isread;
 1230 
 1231         if (ep_index >= f->fs_ep_max)
 1232                 return (EINVAL);
 1233 
 1234         xfer = f->fs_xfer[ep_index];
 1235         if (xfer == NULL)
 1236                 return (EINVAL);
 1237 
 1238         mtx_lock(f->priv_mtx);
 1239         if (usbd_transfer_pending(xfer)) {
 1240                 mtx_unlock(f->priv_mtx);
 1241                 return (EBUSY);         /* should not happen */
 1242         }
 1243         mtx_unlock(f->priv_mtx);
 1244 
 1245         fs_ep_uptr = f->fs_ep_ptr + ep_index;
 1246         error = copyin(fs_ep_uptr, &fs_ep, sizeof(fs_ep));
 1247         if (error) {
 1248                 return (error);
 1249         }
 1250         fs_ep.status = xfer->error;
 1251         fs_ep.aFrames = xfer->aframes;
 1252         fs_ep.isoc_time_complete = xfer->isoc_time_complete;
 1253         if (xfer->error) {
 1254                 goto complete;
 1255         }
 1256         if (xfer->flags_int.control_xfr) {
 1257                 req = xfer->frbuffers[0].buffer;
 1258 
 1259                 /* Host mode only ! */
 1260                 if ((req->bmRequestType & (UT_READ | UT_WRITE)) == UT_READ) {
 1261                         isread = 1;
 1262                 } else {
 1263                         isread = 0;
 1264                 }
 1265                 if (xfer->nframes == 0)
 1266                         n = 0;          /* should never happen */
 1267                 else
 1268                         n = 1;
 1269         } else {
 1270                 /* Device and Host mode */
 1271                 if (USB_GET_DATA_ISREAD(xfer)) {
 1272                         isread = 1;
 1273                 } else {
 1274                         isread = 0;
 1275                 }
 1276                 n = 0;
 1277         }
 1278 
 1279         /* Update lengths and copy out data */
 1280 
 1281         rem = usbd_xfer_max_len(xfer);
 1282         offset = 0;
 1283 
 1284         for (; n != xfer->nframes; n++) {
 1285 
 1286                 /* get initial length into "temp" */
 1287                 error = copyin(fs_ep.pLength + n,
 1288                     &temp, sizeof(temp));
 1289                 if (error) {
 1290                         return (error);
 1291                 }
 1292                 if (temp > rem) {
 1293                         /* the userland length has been corrupted */
 1294                         DPRINTF("corrupt userland length "
 1295                             "%u > %u\n", temp, rem);
 1296                         fs_ep.status = USB_ERR_INVAL;
 1297                         goto complete;
 1298                 }
 1299                 rem -= temp;
 1300 
 1301                 /* get actual transfer length */
 1302                 length = xfer->frlengths[n];
 1303                 if (length > temp) {
 1304                         /* data overflow */
 1305                         fs_ep.status = USB_ERR_INVAL;
 1306                         DPRINTF("data overflow %u > %u\n",
 1307                             length, temp);
 1308                         goto complete;
 1309                 }
 1310                 if (isread) {
 1311 
 1312                         /* we need to know the destination buffer */
 1313                         error = copyin(fs_ep.ppBuffer + n,
 1314                             &uaddr, sizeof(uaddr));
 1315                         if (error) {
 1316                                 return (error);
 1317                         }
 1318                         if (xfer->flags_int.isochronous_xfr) {
 1319                                 /* only one frame buffer */
 1320                                 kaddr = USB_ADD_BYTES(
 1321                                     xfer->frbuffers[0].buffer, offset);
 1322                         } else {
 1323                                 /* multiple frame buffers */
 1324                                 kaddr = xfer->frbuffers[n].buffer;
 1325                         }
 1326 
 1327                         /* move data */
 1328                         error = copyout(kaddr, uaddr, length);
 1329                         if (error) {
 1330                                 return (error);
 1331                         }
 1332                 }
 1333                 /*
 1334                  * Update offset according to initial length, which is
 1335                  * needed by isochronous transfers!
 1336                  */
 1337                 offset += temp;
 1338 
 1339                 /* update length */
 1340                 error = copyout(&length,
 1341                     fs_ep.pLength + n, sizeof(length));
 1342                 if (error) {
 1343                         return (error);
 1344                 }
 1345         }
 1346 
 1347 complete:
 1348         /* update "aFrames" */
 1349         error = copyout(&fs_ep.aFrames, &fs_ep_uptr->aFrames,
 1350             sizeof(fs_ep.aFrames));
 1351         if (error)
 1352                 goto done;
 1353 
 1354         /* update "isoc_time_complete" */
 1355         error = copyout(&fs_ep.isoc_time_complete,
 1356             &fs_ep_uptr->isoc_time_complete,
 1357             sizeof(fs_ep.isoc_time_complete));
 1358         if (error)
 1359                 goto done;
 1360         /* update "status" */
 1361         error = copyout(&fs_ep.status, &fs_ep_uptr->status,
 1362             sizeof(fs_ep.status));
 1363 done:
 1364         return (error);
 1365 }
 1366 
 1367 static uint8_t
 1368 ugen_fifo_in_use(struct usb_fifo *f, int fflags)
 1369 {
 1370         struct usb_fifo *f_rx;
 1371         struct usb_fifo *f_tx;
 1372 
 1373         f_rx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_RX];
 1374         f_tx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_TX];
 1375 
 1376         if ((fflags & FREAD) && f_rx &&
 1377             (f_rx->xfer[0] || f_rx->xfer[1])) {
 1378                 return (1);             /* RX FIFO in use */
 1379         }
 1380         if ((fflags & FWRITE) && f_tx &&
 1381             (f_tx->xfer[0] || f_tx->xfer[1])) {
 1382                 return (1);             /* TX FIFO in use */
 1383         }
 1384         return (0);                     /* not in use */
 1385 }
 1386 
 1387 static int
 1388 ugen_ioctl(struct usb_fifo *f, u_long cmd, void *addr, int fflags)
 1389 {
 1390         struct usb_config usb_config[1];
 1391         struct usb_device_request req;
 1392         union {
 1393                 struct usb_fs_complete *pcomp;
 1394                 struct usb_fs_start *pstart;
 1395                 struct usb_fs_stop *pstop;
 1396                 struct usb_fs_open *popen;
 1397                 struct usb_fs_open_stream *popen_stream;
 1398                 struct usb_fs_close *pclose;
 1399                 struct usb_fs_clear_stall_sync *pstall;
 1400                 void   *addr;
 1401         }     u;
 1402         struct usb_endpoint *ep;
 1403         struct usb_endpoint_descriptor *ed;
 1404         struct usb_xfer *xfer;
 1405         int error = 0;
 1406         uint8_t iface_index;
 1407         uint8_t isread;
 1408         uint8_t ep_index;
 1409         uint8_t pre_scale;
 1410 
 1411         u.addr = addr;
 1412 
 1413         DPRINTFN(6, "cmd=0x%08lx\n", cmd);
 1414 
 1415         switch (cmd) {
 1416         case USB_FS_COMPLETE:
 1417                 mtx_lock(f->priv_mtx);
 1418                 error = ugen_fs_get_complete(f, &ep_index);
 1419                 mtx_unlock(f->priv_mtx);
 1420 
 1421                 if (error) {
 1422                         error = EBUSY;
 1423                         break;
 1424                 }
 1425                 u.pcomp->ep_index = ep_index;
 1426                 error = ugen_fs_copy_out(f, u.pcomp->ep_index);
 1427                 break;
 1428 
 1429         case USB_FS_START:
 1430                 error = ugen_fs_copy_in(f, u.pstart->ep_index);
 1431                 if (error)
 1432                         break;
 1433                 mtx_lock(f->priv_mtx);
 1434                 xfer = f->fs_xfer[u.pstart->ep_index];
 1435                 usbd_transfer_start(xfer);
 1436                 mtx_unlock(f->priv_mtx);
 1437                 break;
 1438 
 1439         case USB_FS_STOP:
 1440                 if (u.pstop->ep_index >= f->fs_ep_max) {
 1441                         error = EINVAL;
 1442                         break;
 1443                 }
 1444                 mtx_lock(f->priv_mtx);
 1445                 xfer = f->fs_xfer[u.pstart->ep_index];
 1446                 if (usbd_transfer_pending(xfer)) {
 1447                         usbd_transfer_stop(xfer);
 1448                         /*
 1449                          * Check if the USB transfer was stopped
 1450                          * before it was even started. Else a cancel
 1451                          * callback will be pending.
 1452                          */
 1453                         if (!xfer->flags_int.transferring) {
 1454                                 ugen_fs_set_complete(xfer->priv_sc,
 1455                                     USB_P2U(xfer->priv_fifo));
 1456                         }
 1457                 }
 1458                 mtx_unlock(f->priv_mtx);
 1459                 break;
 1460 
 1461         case USB_FS_OPEN:
 1462         case USB_FS_OPEN_STREAM:
 1463                 if (u.popen->ep_index >= f->fs_ep_max) {
 1464                         error = EINVAL;
 1465                         break;
 1466                 }
 1467                 if (f->fs_xfer[u.popen->ep_index] != NULL) {
 1468                         error = EBUSY;
 1469                         break;
 1470                 }
 1471                 if (u.popen->max_bufsize > USB_FS_MAX_BUFSIZE) {
 1472                         u.popen->max_bufsize = USB_FS_MAX_BUFSIZE;
 1473                 }
 1474                 if (u.popen->max_frames & USB_FS_MAX_FRAMES_PRE_SCALE) {
 1475                         pre_scale = 1;
 1476                         u.popen->max_frames &= ~USB_FS_MAX_FRAMES_PRE_SCALE;
 1477                 } else {
 1478                         pre_scale = 0;
 1479                 }
 1480                 if (u.popen->max_frames > USB_FS_MAX_FRAMES) {
 1481                         u.popen->max_frames = USB_FS_MAX_FRAMES;
 1482                         break;
 1483                 }
 1484                 if (u.popen->max_frames == 0) {
 1485                         error = EINVAL;
 1486                         break;
 1487                 }
 1488                 ep = usbd_get_ep_by_addr(f->udev, u.popen->ep_no);
 1489                 if (ep == NULL) {
 1490                         error = EINVAL;
 1491                         break;
 1492                 }
 1493                 ed = ep->edesc;
 1494                 if (ed == NULL) {
 1495                         error = ENXIO;
 1496                         break;
 1497                 }
 1498                 iface_index = ep->iface_index;
 1499 
 1500                 memset(usb_config, 0, sizeof(usb_config));
 1501 
 1502                 usb_config[0].type = ed->bmAttributes & UE_XFERTYPE;
 1503                 usb_config[0].endpoint = ed->bEndpointAddress & UE_ADDR;
 1504                 usb_config[0].direction = ed->bEndpointAddress & (UE_DIR_OUT | UE_DIR_IN);
 1505                 usb_config[0].interval = USB_DEFAULT_INTERVAL;
 1506                 usb_config[0].flags.proxy_buffer = 1;
 1507                 if (pre_scale != 0)
 1508                         usb_config[0].flags.pre_scale_frames = 1;
 1509                 usb_config[0].callback = &ugen_ctrl_fs_callback;
 1510                 usb_config[0].timeout = 0;      /* no timeout */
 1511                 usb_config[0].frames = u.popen->max_frames;
 1512                 usb_config[0].bufsize = u.popen->max_bufsize;
 1513                 usb_config[0].usb_mode = USB_MODE_DUAL; /* both modes */
 1514                 if (cmd == USB_FS_OPEN_STREAM)
 1515                         usb_config[0].stream_id = u.popen_stream->stream_id;
 1516 
 1517                 if (usb_config[0].type == UE_CONTROL) {
 1518                         if (f->udev->flags.usb_mode != USB_MODE_HOST) {
 1519                                 error = EINVAL;
 1520                                 break;
 1521                         }
 1522                 } else {
 1523 
 1524                         isread = ((usb_config[0].endpoint &
 1525                             (UE_DIR_IN | UE_DIR_OUT)) == UE_DIR_IN);
 1526 
 1527                         if (f->udev->flags.usb_mode != USB_MODE_HOST) {
 1528                                 isread = !isread;
 1529                         }
 1530                         /* check permissions */
 1531                         if (isread) {
 1532                                 if (!(fflags & FREAD)) {
 1533                                         error = EPERM;
 1534                                         break;
 1535                                 }
 1536                         } else {
 1537                                 if (!(fflags & FWRITE)) {
 1538                                         error = EPERM;
 1539                                         break;
 1540                                 }
 1541                         }
 1542                 }
 1543                 error = usbd_transfer_setup(f->udev, &iface_index,
 1544                     f->fs_xfer + u.popen->ep_index, usb_config, 1,
 1545                     f, f->priv_mtx);
 1546                 if (error == 0) {
 1547                         /* update maximums */
 1548                         u.popen->max_packet_length =
 1549                             f->fs_xfer[u.popen->ep_index]->max_frame_size;
 1550                         u.popen->max_bufsize =
 1551                             f->fs_xfer[u.popen->ep_index]->max_data_length;
 1552                         /* update number of frames */
 1553                         u.popen->max_frames =
 1554                             f->fs_xfer[u.popen->ep_index]->nframes;
 1555                         /* store index of endpoint */
 1556                         f->fs_xfer[u.popen->ep_index]->priv_fifo =
 1557                             ((uint8_t *)0) + u.popen->ep_index;
 1558                 } else {
 1559                         error = ENOMEM;
 1560                 }
 1561                 break;
 1562 
 1563         case USB_FS_CLOSE:
 1564                 if (u.pclose->ep_index >= f->fs_ep_max) {
 1565                         error = EINVAL;
 1566                         break;
 1567                 }
 1568                 if (f->fs_xfer[u.pclose->ep_index] == NULL) {
 1569                         error = EINVAL;
 1570                         break;
 1571                 }
 1572                 usbd_transfer_unsetup(f->fs_xfer + u.pclose->ep_index, 1);
 1573                 break;
 1574 
 1575         case USB_FS_CLEAR_STALL_SYNC:
 1576                 if (u.pstall->ep_index >= f->fs_ep_max) {
 1577                         error = EINVAL;
 1578                         break;
 1579                 }
 1580                 if (f->fs_xfer[u.pstall->ep_index] == NULL) {
 1581                         error = EINVAL;
 1582                         break;
 1583                 }
 1584                 if (f->udev->flags.usb_mode != USB_MODE_HOST) {
 1585                         error = EINVAL;
 1586                         break;
 1587                 }
 1588                 mtx_lock(f->priv_mtx);
 1589                 error = usbd_transfer_pending(f->fs_xfer[u.pstall->ep_index]);
 1590                 mtx_unlock(f->priv_mtx);
 1591 
 1592                 if (error) {
 1593                         return (EBUSY);
 1594                 }
 1595                 ep = f->fs_xfer[u.pstall->ep_index]->endpoint;
 1596 
 1597                 /* setup a clear-stall packet */
 1598                 req.bmRequestType = UT_WRITE_ENDPOINT;
 1599                 req.bRequest = UR_CLEAR_FEATURE;
 1600                 USETW(req.wValue, UF_ENDPOINT_HALT);
 1601                 req.wIndex[0] = ep->edesc->bEndpointAddress;
 1602                 req.wIndex[1] = 0;
 1603                 USETW(req.wLength, 0);
 1604 
 1605                 error = usbd_do_request(f->udev, NULL, &req, NULL);
 1606                 if (error == 0) {
 1607                         usbd_clear_data_toggle(f->udev, ep);
 1608                 } else {
 1609                         error = ENXIO;
 1610                 }
 1611                 break;
 1612 
 1613         default:
 1614                 error = ENOIOCTL;
 1615                 break;
 1616         }
 1617 
 1618         DPRINTFN(6, "error=%d\n", error);
 1619 
 1620         return (error);
 1621 }
 1622 
 1623 static int
 1624 ugen_set_short_xfer(struct usb_fifo *f, void *addr)
 1625 {
 1626         uint8_t t;
 1627 
 1628         if (*(int *)addr)
 1629                 t = 1;
 1630         else
 1631                 t = 0;
 1632 
 1633         if (f->flag_short == t) {
 1634                 /* same value like before - accept */
 1635                 return (0);
 1636         }
 1637         if (f->xfer[0] || f->xfer[1]) {
 1638                 /* cannot change this during transfer */
 1639                 return (EBUSY);
 1640         }
 1641         f->flag_short = t;
 1642         return (0);
 1643 }
 1644 
 1645 static int
 1646 ugen_set_timeout(struct usb_fifo *f, void *addr)
 1647 {
 1648         f->timeout = *(int *)addr;
 1649         if (f->timeout > 65535) {
 1650                 /* limit user input */
 1651                 f->timeout = 65535;
 1652         }
 1653         return (0);
 1654 }
 1655 
 1656 static int
 1657 ugen_get_frame_size(struct usb_fifo *f, void *addr)
 1658 {
 1659         if (f->xfer[0]) {
 1660                 *(int *)addr = f->xfer[0]->max_frame_size;
 1661         } else {
 1662                 return (EINVAL);
 1663         }
 1664         return (0);
 1665 }
 1666 
 1667 static int
 1668 ugen_set_buffer_size(struct usb_fifo *f, void *addr)
 1669 {
 1670         usb_frlength_t t;
 1671 
 1672         if (*(int *)addr < 0)
 1673                 t = 0;          /* use "wMaxPacketSize" */
 1674         else if (*(int *)addr < (256 * 1024))
 1675                 t = *(int *)addr;
 1676         else
 1677                 t = 256 * 1024;
 1678 
 1679         if (f->bufsize == t) {
 1680                 /* same value like before - accept */
 1681                 return (0);
 1682         }
 1683         if (f->xfer[0] || f->xfer[1]) {
 1684                 /* cannot change this during transfer */
 1685                 return (EBUSY);
 1686         }
 1687         f->bufsize = t;
 1688         return (0);
 1689 }
 1690 
 1691 static int
 1692 ugen_get_buffer_size(struct usb_fifo *f, void *addr)
 1693 {
 1694         *(int *)addr = f->bufsize;
 1695         return (0);
 1696 }
 1697 
 1698 static int
 1699 ugen_get_iface_desc(struct usb_fifo *f,
 1700     struct usb_interface_descriptor *idesc)
 1701 {
 1702         struct usb_interface *iface;
 1703 
 1704         iface = usbd_get_iface(f->udev, f->iface_index);
 1705         if (iface && iface->idesc) {
 1706                 *idesc = *(iface->idesc);
 1707         } else {
 1708                 return (EIO);
 1709         }
 1710         return (0);
 1711 }
 1712 
 1713 static int
 1714 ugen_get_endpoint_desc(struct usb_fifo *f,
 1715     struct usb_endpoint_descriptor *ed)
 1716 {
 1717         struct usb_endpoint *ep;
 1718 
 1719         ep = usb_fifo_softc(f);
 1720 
 1721         if (ep && ep->edesc) {
 1722                 *ed = *ep->edesc;
 1723         } else {
 1724                 return (EINVAL);
 1725         }
 1726         return (0);
 1727 }
 1728 
 1729 static int
 1730 ugen_set_power_mode(struct usb_fifo *f, int mode)
 1731 {
 1732         struct usb_device *udev = f->udev;
 1733         int err;
 1734         uint8_t old_mode;
 1735 
 1736         if ((udev == NULL) ||
 1737             (udev->parent_hub == NULL)) {
 1738                 return (EINVAL);
 1739         }
 1740         err = priv_check(curthread, PRIV_DRIVER);
 1741         if (err)
 1742                 return (err);
 1743 
 1744         /* get old power mode */
 1745         old_mode = udev->power_mode;
 1746 
 1747         /* if no change, then just return */
 1748         if (old_mode == mode)
 1749                 return (0);
 1750 
 1751         switch (mode) {
 1752         case USB_POWER_MODE_OFF:
 1753                 if (udev->flags.usb_mode == USB_MODE_HOST &&
 1754                     udev->re_enumerate_wait == USB_RE_ENUM_DONE) {
 1755                         udev->re_enumerate_wait = USB_RE_ENUM_PWR_OFF;
 1756                 }
 1757                 /* set power mode will wake up the explore thread */
 1758                 break;
 1759 
 1760         case USB_POWER_MODE_ON:
 1761         case USB_POWER_MODE_SAVE:
 1762                 break;
 1763 
 1764         case USB_POWER_MODE_RESUME:
 1765 #if USB_HAVE_POWERD
 1766                 /* let USB-powerd handle resume */
 1767                 USB_BUS_LOCK(udev->bus);
 1768                 udev->pwr_save.write_refs++;
 1769                 udev->pwr_save.last_xfer_time = ticks;
 1770                 USB_BUS_UNLOCK(udev->bus);
 1771 
 1772                 /* set new power mode */
 1773                 usbd_set_power_mode(udev, USB_POWER_MODE_SAVE);
 1774 
 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                     udev->re_enumerate_wait == USB_RE_ENUM_DONE) {
 1807                         udev->re_enumerate_wait = USB_RE_ENUM_START;
 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 
 1818 static int
 1819 ugen_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 
 1829 static int
 1830 ugen_get_port_path(struct usb_fifo *f, struct usb_device_port_path *dpp)
 1831 {
 1832         struct usb_device *udev = f->udev;
 1833         struct usb_device *next;
 1834         unsigned int nlevel = 0;
 1835 
 1836         if (udev == NULL)
 1837                 goto error;
 1838 
 1839         dpp->udp_bus = device_get_unit(udev->bus->bdev);
 1840         dpp->udp_index = udev->device_index;
 1841 
 1842         /* count port levels */
 1843         next = udev;
 1844         while (next->parent_hub != NULL) {
 1845                 nlevel++;
 1846                 next = next->parent_hub;
 1847         }
 1848 
 1849         /* check if too many levels */
 1850         if (nlevel > USB_DEVICE_PORT_PATH_MAX)
 1851                 goto error;
 1852 
 1853         /* store total level of ports */
 1854         dpp->udp_port_level = nlevel;
 1855 
 1856         /* store port index array */
 1857         next = udev;
 1858         while (next->parent_hub != NULL) {
 1859                 dpp->udp_port_no[--nlevel] = next->port_no;
 1860                 next = next->parent_hub;
 1861         }
 1862         return (0);     /* success */
 1863 
 1864 error:
 1865         return (EINVAL);        /* failure */
 1866 }
 1867 
 1868 static int
 1869 ugen_get_power_usage(struct usb_fifo *f)
 1870 {
 1871         struct usb_device *udev = f->udev;
 1872 
 1873         if (udev == NULL)
 1874                 return (0);
 1875 
 1876         return (udev->power);
 1877 }
 1878 
 1879 static int
 1880 ugen_do_port_feature(struct usb_fifo *f, uint8_t port_no,
 1881     uint8_t set, uint16_t feature)
 1882 {
 1883         struct usb_device *udev = f->udev;
 1884         struct usb_hub *hub;
 1885         int err;
 1886 
 1887         err = priv_check(curthread, PRIV_DRIVER);
 1888         if (err) {
 1889                 return (err);
 1890         }
 1891         if (port_no == 0) {
 1892                 return (EINVAL);
 1893         }
 1894         if ((udev == NULL) ||
 1895             (udev->hub == NULL)) {
 1896                 return (EINVAL);
 1897         }
 1898         hub = udev->hub;
 1899 
 1900         if (port_no > hub->nports) {
 1901                 return (EINVAL);
 1902         }
 1903         if (set)
 1904                 err = usbd_req_set_port_feature(udev,
 1905                     NULL, port_no, feature);
 1906         else
 1907                 err = usbd_req_clear_port_feature(udev,
 1908                     NULL, port_no, feature);
 1909 
 1910         if (err)
 1911                 return (ENXIO);         /* failure */
 1912 
 1913         return (0);                     /* success */
 1914 }
 1915 
 1916 static int
 1917 ugen_iface_ioctl(struct usb_fifo *f, u_long cmd, void *addr, int fflags)
 1918 {
 1919         struct usb_fifo *f_rx;
 1920         struct usb_fifo *f_tx;
 1921         int error = 0;
 1922 
 1923         f_rx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_RX];
 1924         f_tx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_TX];
 1925 
 1926         switch (cmd) {
 1927         case USB_SET_RX_SHORT_XFER:
 1928                 if (fflags & FREAD) {
 1929                         error = ugen_set_short_xfer(f_rx, addr);
 1930                 } else {
 1931                         error = EINVAL;
 1932                 }
 1933                 break;
 1934 
 1935         case USB_SET_TX_FORCE_SHORT:
 1936                 if (fflags & FWRITE) {
 1937                         error = ugen_set_short_xfer(f_tx, addr);
 1938                 } else {
 1939                         error = EINVAL;
 1940                 }
 1941                 break;
 1942 
 1943         case USB_SET_RX_TIMEOUT:
 1944                 if (fflags & FREAD) {
 1945                         error = ugen_set_timeout(f_rx, addr);
 1946                 } else {
 1947                         error = EINVAL;
 1948                 }
 1949                 break;
 1950 
 1951         case USB_SET_TX_TIMEOUT:
 1952                 if (fflags & FWRITE) {
 1953                         error = ugen_set_timeout(f_tx, addr);
 1954                 } else {
 1955                         error = EINVAL;
 1956                 }
 1957                 break;
 1958 
 1959         case USB_GET_RX_FRAME_SIZE:
 1960                 if (fflags & FREAD) {
 1961                         error = ugen_get_frame_size(f_rx, addr);
 1962                 } else {
 1963                         error = EINVAL;
 1964                 }
 1965                 break;
 1966 
 1967         case USB_GET_TX_FRAME_SIZE:
 1968                 if (fflags & FWRITE) {
 1969                         error = ugen_get_frame_size(f_tx, addr);
 1970                 } else {
 1971                         error = EINVAL;
 1972                 }
 1973                 break;
 1974 
 1975         case USB_SET_RX_BUFFER_SIZE:
 1976                 if (fflags & FREAD) {
 1977                         error = ugen_set_buffer_size(f_rx, addr);
 1978                 } else {
 1979                         error = EINVAL;
 1980                 }
 1981                 break;
 1982 
 1983         case USB_SET_TX_BUFFER_SIZE:
 1984                 if (fflags & FWRITE) {
 1985                         error = ugen_set_buffer_size(f_tx, addr);
 1986                 } else {
 1987                         error = EINVAL;
 1988                 }
 1989                 break;
 1990 
 1991         case USB_GET_RX_BUFFER_SIZE:
 1992                 if (fflags & FREAD) {
 1993                         error = ugen_get_buffer_size(f_rx, addr);
 1994                 } else {
 1995                         error = EINVAL;
 1996                 }
 1997                 break;
 1998 
 1999         case USB_GET_TX_BUFFER_SIZE:
 2000                 if (fflags & FWRITE) {
 2001                         error = ugen_get_buffer_size(f_tx, addr);
 2002                 } else {
 2003                         error = EINVAL;
 2004                 }
 2005                 break;
 2006 
 2007         case USB_GET_RX_INTERFACE_DESC:
 2008                 if (fflags & FREAD) {
 2009                         error = ugen_get_iface_desc(f_rx, addr);
 2010                 } else {
 2011                         error = EINVAL;
 2012                 }
 2013                 break;
 2014 
 2015         case USB_GET_TX_INTERFACE_DESC:
 2016                 if (fflags & FWRITE) {
 2017                         error = ugen_get_iface_desc(f_tx, addr);
 2018                 } else {
 2019                         error = EINVAL;
 2020                 }
 2021                 break;
 2022 
 2023         case USB_GET_RX_ENDPOINT_DESC:
 2024                 if (fflags & FREAD) {
 2025                         error = ugen_get_endpoint_desc(f_rx, addr);
 2026                 } else {
 2027                         error = EINVAL;
 2028                 }
 2029                 break;
 2030 
 2031         case USB_GET_TX_ENDPOINT_DESC:
 2032                 if (fflags & FWRITE) {
 2033                         error = ugen_get_endpoint_desc(f_tx, addr);
 2034                 } else {
 2035                         error = EINVAL;
 2036                 }
 2037                 break;
 2038 
 2039         case USB_SET_RX_STALL_FLAG:
 2040                 if ((fflags & FREAD) && (*(int *)addr)) {
 2041                         f_rx->flag_stall = 1;
 2042                 }
 2043                 break;
 2044 
 2045         case USB_SET_TX_STALL_FLAG:
 2046                 if ((fflags & FWRITE) && (*(int *)addr)) {
 2047                         f_tx->flag_stall = 1;
 2048                 }
 2049                 break;
 2050 
 2051         default:
 2052                 error = ENOIOCTL;
 2053                 break;
 2054         }
 2055         return (error);
 2056 }
 2057 
 2058 static int
 2059 ugen_ioctl_post(struct usb_fifo *f, u_long cmd, void *addr, int fflags)
 2060 {
 2061         union {
 2062                 struct usb_interface_descriptor *idesc;
 2063                 struct usb_alt_interface *ai;
 2064                 struct usb_device_descriptor *ddesc;
 2065                 struct usb_config_descriptor *cdesc;
 2066                 struct usb_device_stats *stat;
 2067                 struct usb_fs_init *pinit;
 2068                 struct usb_fs_uninit *puninit;
 2069                 struct usb_device_port_path *dpp;
 2070                 uint32_t *ptime;
 2071                 void   *addr;
 2072                 int    *pint;
 2073         }     u;
 2074         struct usb_device_descriptor *dtemp;
 2075         struct usb_config_descriptor *ctemp;
 2076         struct usb_interface *iface;
 2077         int error = 0;
 2078         uint8_t n;
 2079 
 2080         u.addr = addr;
 2081 
 2082         DPRINTFN(6, "cmd=0x%08lx\n", cmd);
 2083 
 2084         switch (cmd) {
 2085         case USB_DISCOVER:
 2086                 usb_needs_explore_all();
 2087                 break;
 2088 
 2089         case USB_SETDEBUG:
 2090                 if (!(fflags & FWRITE)) {
 2091                         error = EPERM;
 2092                         break;
 2093                 }
 2094                 usb_debug = *(int *)addr;
 2095                 break;
 2096 
 2097         case USB_GET_CONFIG:
 2098                 *(int *)addr = f->udev->curr_config_index;
 2099                 break;
 2100 
 2101         case USB_SET_CONFIG:
 2102                 if (!(fflags & FWRITE)) {
 2103                         error = EPERM;
 2104                         break;
 2105                 }
 2106                 error = ugen_set_config(f, *(int *)addr);
 2107                 break;
 2108 
 2109         case USB_GET_ALTINTERFACE:
 2110                 iface = usbd_get_iface(f->udev,
 2111                     u.ai->uai_interface_index);
 2112                 if (iface && iface->idesc) {
 2113                         u.ai->uai_alt_index = iface->alt_index;
 2114                 } else {
 2115                         error = EINVAL;
 2116                 }
 2117                 break;
 2118 
 2119         case USB_SET_ALTINTERFACE:
 2120                 if (!(fflags & FWRITE)) {
 2121                         error = EPERM;
 2122                         break;
 2123                 }
 2124                 error = ugen_set_interface(f,
 2125                     u.ai->uai_interface_index, u.ai->uai_alt_index);
 2126                 break;
 2127 
 2128         case USB_GET_DEVICE_DESC:
 2129                 dtemp = usbd_get_device_descriptor(f->udev);
 2130                 if (!dtemp) {
 2131                         error = EIO;
 2132                         break;
 2133                 }
 2134                 *u.ddesc = *dtemp;
 2135                 break;
 2136 
 2137         case USB_GET_CONFIG_DESC:
 2138                 ctemp = usbd_get_config_descriptor(f->udev);
 2139                 if (!ctemp) {
 2140                         error = EIO;
 2141                         break;
 2142                 }
 2143                 *u.cdesc = *ctemp;
 2144                 break;
 2145 
 2146         case USB_GET_FULL_DESC:
 2147                 error = ugen_get_cdesc(f, addr);
 2148                 break;
 2149 
 2150         case USB_GET_STRING_DESC:
 2151                 error = ugen_get_sdesc(f, addr);
 2152                 break;
 2153 
 2154         case USB_GET_IFACE_DRIVER:
 2155                 error = ugen_get_iface_driver(f, addr);
 2156                 break;
 2157 
 2158         case USB_REQUEST:
 2159         case USB_DO_REQUEST:
 2160                 if (!(fflags & FWRITE)) {
 2161                         error = EPERM;
 2162                         break;
 2163                 }
 2164                 error = ugen_do_request(f, addr);
 2165                 break;
 2166 
 2167         case USB_DEVICEINFO:
 2168         case USB_GET_DEVICEINFO:
 2169                 error = usb_gen_fill_deviceinfo(f, addr);
 2170                 break;
 2171 
 2172         case USB_DEVICESTATS:
 2173                 for (n = 0; n != 4; n++) {
 2174 
 2175                         u.stat->uds_requests_fail[n] =
 2176                             f->udev->bus->stats_err.uds_requests[n];
 2177 
 2178                         u.stat->uds_requests_ok[n] =
 2179                             f->udev->bus->stats_ok.uds_requests[n];
 2180                 }
 2181                 break;
 2182 
 2183         case USB_DEVICEENUMERATE:
 2184                 error = ugen_re_enumerate(f);
 2185                 break;
 2186 
 2187         case USB_GET_PLUGTIME:
 2188                 *u.ptime = f->udev->plugtime;
 2189                 break;
 2190 
 2191         case USB_CLAIM_INTERFACE:
 2192         case USB_RELEASE_INTERFACE:
 2193                 /* TODO */
 2194                 break;
 2195 
 2196         case USB_IFACE_DRIVER_ACTIVE:
 2197 
 2198                 n = *u.pint & 0xFF;
 2199 
 2200                 iface = usbd_get_iface(f->udev, n);
 2201 
 2202                 if (iface && iface->subdev)
 2203                         error = 0;
 2204                 else
 2205                         error = ENXIO;
 2206                 break;
 2207 
 2208         case USB_IFACE_DRIVER_DETACH:
 2209 
 2210                 error = priv_check(curthread, PRIV_DRIVER);
 2211 
 2212                 if (error)
 2213                         break;
 2214 
 2215                 n = *u.pint & 0xFF;
 2216 
 2217                 if (n == USB_IFACE_INDEX_ANY) {
 2218                         error = EINVAL;
 2219                         break;
 2220                 }
 2221 
 2222                 /*
 2223                  * Detach the currently attached driver.
 2224                  */
 2225                 usb_detach_device(f->udev, n, 0);
 2226 
 2227                 /*
 2228                  * Set parent to self, this should keep attach away
 2229                  * until the next set configuration event.
 2230                  */
 2231                 usbd_set_parent_iface(f->udev, n, n);
 2232                 break;
 2233 
 2234         case USB_SET_POWER_MODE:
 2235                 error = ugen_set_power_mode(f, *u.pint);
 2236                 break;
 2237 
 2238         case USB_GET_POWER_MODE:
 2239                 *u.pint = ugen_get_power_mode(f);
 2240                 break;
 2241 
 2242         case USB_GET_DEV_PORT_PATH:
 2243                 error = ugen_get_port_path(f, u.dpp);
 2244                 break;
 2245 
 2246         case USB_GET_POWER_USAGE:
 2247                 *u.pint = ugen_get_power_usage(f);
 2248                 break;
 2249 
 2250         case USB_SET_PORT_ENABLE:
 2251                 error = ugen_do_port_feature(f,
 2252                     *u.pint, 1, UHF_PORT_ENABLE);
 2253                 break;
 2254 
 2255         case USB_SET_PORT_DISABLE:
 2256                 error = ugen_do_port_feature(f,
 2257                     *u.pint, 0, UHF_PORT_ENABLE);
 2258                 break;
 2259 
 2260         case USB_FS_INIT:
 2261                 /* verify input parameters */
 2262                 if (u.pinit->pEndpoints == NULL) {
 2263                         error = EINVAL;
 2264                         break;
 2265                 }
 2266                 if (u.pinit->ep_index_max > 127) {
 2267                         error = EINVAL;
 2268                         break;
 2269                 }
 2270                 if (u.pinit->ep_index_max == 0) {
 2271                         error = EINVAL;
 2272                         break;
 2273                 }
 2274                 if (f->fs_xfer != NULL) {
 2275                         error = EBUSY;
 2276                         break;
 2277                 }
 2278                 if (f->dev_ep_index != 0) {
 2279                         error = EINVAL;
 2280                         break;
 2281                 }
 2282                 if (ugen_fifo_in_use(f, fflags)) {
 2283                         error = EBUSY;
 2284                         break;
 2285                 }
 2286                 error = usb_fifo_alloc_buffer(f, 1, u.pinit->ep_index_max);
 2287                 if (error) {
 2288                         break;
 2289                 }
 2290                 f->fs_xfer = malloc(sizeof(f->fs_xfer[0]) *
 2291                     u.pinit->ep_index_max, M_USB, M_WAITOK | M_ZERO);
 2292                 if (f->fs_xfer == NULL) {
 2293                         usb_fifo_free_buffer(f);
 2294                         error = ENOMEM;
 2295                         break;
 2296                 }
 2297                 f->fs_ep_max = u.pinit->ep_index_max;
 2298                 f->fs_ep_ptr = u.pinit->pEndpoints;
 2299                 break;
 2300 
 2301         case USB_FS_UNINIT:
 2302                 if (u.puninit->dummy != 0) {
 2303                         error = EINVAL;
 2304                         break;
 2305                 }
 2306                 error = ugen_fs_uninit(f);
 2307                 break;
 2308 
 2309         default:
 2310                 mtx_lock(f->priv_mtx);
 2311                 error = ugen_iface_ioctl(f, cmd, addr, fflags);
 2312                 mtx_unlock(f->priv_mtx);
 2313                 break;
 2314         }
 2315         DPRINTFN(6, "error=%d\n", error);
 2316         return (error);
 2317 }
 2318 
 2319 static void
 2320 ugen_ctrl_fs_callback(struct usb_xfer *xfer, usb_error_t error)
 2321 {
 2322         ;                               /* workaround for a bug in "indent" */
 2323 
 2324         DPRINTF("st=%u alen=%u aframes=%u\n",
 2325             USB_GET_STATE(xfer), xfer->actlen, xfer->aframes);
 2326 
 2327         switch (USB_GET_STATE(xfer)) {
 2328         case USB_ST_SETUP:
 2329                 usbd_transfer_submit(xfer);
 2330                 break;
 2331         default:
 2332                 ugen_fs_set_complete(xfer->priv_sc, USB_P2U(xfer->priv_fifo));
 2333                 break;
 2334         }
 2335 }
 2336 #endif  /* USB_HAVE_UGEN */
Cache object: eda79fe4316d7056fb21a3c5e5a0bdb3
[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]
This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.
FreeBSD/Linux Kernel Cross Reference sys/dev/usb/usb_generic.c

FreeBSD/Linux Kernel Cross Reference
sys/dev/usb/usb_generic.c
