sys/dev/usb/usb_generic.c

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