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