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                 DPRINTFN(6, "device mode\n");
 957                 return (ENOTTY);
 958         }
 959         if (udev->parent_hub == NULL) {
 960                 /* the root HUB cannot be re-enumerated */
 961                 DPRINTFN(6, "cannot reset root HUB\n");
 962                 return (EINVAL);
 963         }
 964         /* make sure all FIFO's are gone */
 965         /* else there can be a deadlock */
 966         if (ugen_fs_uninit(f)) {
 967                 /* ignore any errors */
 968                 DPRINTFN(6, "no FIFOs\n");
 969         }
 970         if (udev->re_enumerate_wait == 0) {
 971                 udev->re_enumerate_wait = 1;
 972                 usb_needs_explore(udev->bus, 0);
 973         }
 974         return (0);
 975 }
 976
 977 int
 978 ugen_fs_uninit(struct usb_fifo *f)
 979 {
 980         if (f->fs_xfer == NULL) {
 981                 return (EINVAL);
 982         }
 983         usbd_transfer_unsetup(f->fs_xfer, f->fs_ep_max);
 984         free(f->fs_xfer, M_USB);
 985         f->fs_xfer = NULL;
 986         f->fs_ep_max = 0;
 987         f->fs_ep_ptr = NULL;
 988         f->flag_iscomplete = 0;
 989         usb_fifo_free_buffer(f);
 990         return (0);
 991 }
 992
 993 static uint8_t
 994 ugen_fs_get_complete(struct usb_fifo *f, uint8_t *pindex)
 995 {
 996         struct usb_mbuf *m;
 997
 998         USB_IF_DEQUEUE(&f->used_q, m);
 999
1000         if (m) {
1001                 *pindex = *((uint8_t *)(m->cur_data_ptr));
1002
1003                 USB_IF_ENQUEUE(&f->free_q, m);
1004
1005                 return (0);             /* success */
1006         } else {
1007
1008                 *pindex = 0;            /* fix compiler warning */
1009
1010                 f->flag_iscomplete = 0;
1011         }
1012         return (1);                     /* failure */
1013 }
1014
1015 static void
1016 ugen_fs_set_complete(struct usb_fifo *f, uint8_t index)
1017 {
1018         struct usb_mbuf *m;
1019
1020         USB_IF_DEQUEUE(&f->free_q, m);
1021
1022         if (m == NULL) {
1023                 /* can happen during close */
1024                 DPRINTF("out of buffers\n");
1025                 return;
1026         }
1027         USB_MBUF_RESET(m);
1028
1029         *((uint8_t *)(m->cur_data_ptr)) = index;
1030
1031         USB_IF_ENQUEUE(&f->used_q, m);
1032
1033         f->flag_iscomplete = 1;
1034
1035         usb_fifo_wakeup(f);
1036 }
1037
1038 static int
1039 ugen_fs_copy_in(struct usb_fifo *f, uint8_t ep_index)
1040 {
1041         struct usb_device_request *req;
1042         struct usb_xfer *xfer;
1043         struct usb_fs_endpoint fs_ep;
1044         void *uaddr;                    /* userland pointer */
1045         void *kaddr;
1046         usb_frlength_t offset;
1047         usb_frlength_t rem;
1048         usb_frcount_t n;
1049         uint32_t length;
1050         int error;
1051         uint8_t isread;
1052
1053         if (ep_index >= f->fs_ep_max) {
1054                 return (EINVAL);
1055         }
1056         xfer = f->fs_xfer[ep_index];
1057         if (xfer == NULL) {
1058                 return (EINVAL);
1059         }
1060         mtx_lock(f->priv_mtx);
1061         if (usbd_transfer_pending(xfer)) {
1062                 mtx_unlock(f->priv_mtx);
1063                 return (EBUSY);         /* should not happen */
1064         }
1065         mtx_unlock(f->priv_mtx);
1066
1067         error = copyin(f->fs_ep_ptr +
1068             ep_index, &fs_ep, sizeof(fs_ep));
1069         if (error) {
1070                 return (error);
1071         }
1072         /* security checks */
1073
1074         if (fs_ep.nFrames > xfer->max_frame_count) {
1075                 xfer->error = USB_ERR_INVAL;
1076                 goto complete;
1077         }
1078         if (fs_ep.nFrames == 0) {
1079                 xfer->error = USB_ERR_INVAL;
1080                 goto complete;
1081         }
1082         error = copyin(fs_ep.ppBuffer,
1083             &uaddr, sizeof(uaddr));
1084         if (error) {
1085                 return (error);
1086         }
1087         /* reset first frame */
1088         usbd_xfer_set_frame_offset(xfer, 0, 0);
1089
1090         if (xfer->flags_int.control_xfr) {
1091
1092                 req = xfer->frbuffers[0].buffer;
1093
1094                 error = copyin(fs_ep.pLength,
1095                     &length, sizeof(length));
1096                 if (error) {
1097                         return (error);
1098                 }
1099                 if (length != sizeof(*req)) {
1100                         xfer->error = USB_ERR_INVAL;
1101                         goto complete;
1102                 }
1103                 if (length != 0) {
1104                         error = copyin(uaddr, req, length);
1105                         if (error) {
1106                                 return (error);
1107                         }
1108                 }
1109                 if (ugen_check_request(f->udev, req)) {
1110                         xfer->error = USB_ERR_INVAL;
1111                         goto complete;
1112                 }
1113                 usbd_xfer_set_frame_len(xfer, 0, length);
1114
1115                 /* Host mode only ! */
1116                 if ((req->bmRequestType &
1117                     (UT_READ | UT_WRITE)) == UT_READ) {
1118                         isread = 1;
1119                 } else {
1120                         isread = 0;
1121                 }
1122                 n = 1;
1123                 offset = sizeof(*req);
1124
1125         } else {
1126                 /* Device and Host mode */
1127                 if (USB_GET_DATA_ISREAD(xfer)) {
1128                         isread = 1;
1129                 } else {
1130                         isread = 0;
1131                 }
1132                 n = 0;
1133                 offset = 0;
1134         }
1135
1136         rem = usbd_xfer_max_len(xfer);
1137         xfer->nframes = fs_ep.nFrames;
1138         xfer->timeout = fs_ep.timeout;
1139         if (xfer->timeout > 65535) {
1140                 xfer->timeout = 65535;
1141         }
1142         if (fs_ep.flags & USB_FS_FLAG_SINGLE_SHORT_OK)
1143                 xfer->flags.short_xfer_ok = 1;
1144         else
1145                 xfer->flags.short_xfer_ok = 0;
1146
1147         if (fs_ep.flags & USB_FS_FLAG_MULTI_SHORT_OK)
1148                 xfer->flags.short_frames_ok = 1;
1149         else
1150                 xfer->flags.short_frames_ok = 0;
1151
1152         if (fs_ep.flags & USB_FS_FLAG_FORCE_SHORT)
1153                 xfer->flags.force_short_xfer = 1;
1154         else
1155                 xfer->flags.force_short_xfer = 0;
1156
1157         if (fs_ep.flags & USB_FS_FLAG_CLEAR_STALL)
1158                 usbd_xfer_set_stall(xfer);
1159         else
1160                 xfer->flags.stall_pipe = 0;
1161
1162         for (; n != xfer->nframes; n++) {
1163
1164                 error = copyin(fs_ep.pLength + n,
1165                     &length, sizeof(length));
1166                 if (error) {
1167                         break;
1168                 }
1169                 usbd_xfer_set_frame_len(xfer, n, length);
1170
1171                 if (length > rem) {
1172                         xfer->error = USB_ERR_INVAL;
1173                         goto complete;
1174                 }
1175                 rem -= length;
1176
1177                 if (!isread) {
1178
1179                         /* we need to know the source buffer */
1180                         error = copyin(fs_ep.ppBuffer + n,
1181                             &uaddr, sizeof(uaddr));
1182                         if (error) {
1183                                 break;
1184                         }
1185                         if (xfer->flags_int.isochronous_xfr) {
1186                                 /* get kernel buffer address */
1187                                 kaddr = xfer->frbuffers[0].buffer;
1188                                 kaddr = USB_ADD_BYTES(kaddr, offset);
1189                         } else {
1190                                 /* set current frame offset */
1191                                 usbd_xfer_set_frame_offset(xfer, offset, n);
1192
1193                                 /* get kernel buffer address */
1194                                 kaddr = xfer->frbuffers[n].buffer;
1195                         }
1196
1197                         /* move data */
1198                         error = copyin(uaddr, kaddr, length);
1199                         if (error) {
1200                                 break;
1201                         }
1202                 }
1203                 offset += length;
1204         }
1205         return (error);
1206
1207 complete:
1208         mtx_lock(f->priv_mtx);
1209         ugen_fs_set_complete(f, ep_index);
1210         mtx_unlock(f->priv_mtx);
1211         return (0);
1212 }
1213
1214 static int
1215 ugen_fs_copy_out(struct usb_fifo *f, uint8_t ep_index)
1216 {
1217         struct usb_device_request *req;
1218         struct usb_xfer *xfer;
1219         struct usb_fs_endpoint fs_ep;
1220         struct usb_fs_endpoint *fs_ep_uptr;     /* userland ptr */
1221         void *uaddr;                    /* userland ptr */
1222         void *kaddr;
1223         usb_frlength_t offset;
1224         usb_frlength_t rem;
1225         usb_frcount_t n;
1226         uint32_t length;
1227         uint32_t temp;
1228         int error;
1229         uint8_t isread;
1230
1231         if (ep_index >= f->fs_ep_max)
1232                 return (EINVAL);
1233
1234         xfer = f->fs_xfer[ep_index];
1235         if (xfer == NULL)
1236                 return (EINVAL);
1237
1238         mtx_lock(f->priv_mtx);
1239         if (usbd_transfer_pending(xfer)) {
1240                 mtx_unlock(f->priv_mtx);
1241                 return (EBUSY);         /* should not happen */
1242         }
1243         mtx_unlock(f->priv_mtx);
1244
1245         fs_ep_uptr = f->fs_ep_ptr + ep_index;
1246         error = copyin(fs_ep_uptr, &fs_ep, sizeof(fs_ep));
1247         if (error) {
1248                 return (error);
1249         }
1250         fs_ep.status = xfer->error;
1251         fs_ep.aFrames = xfer->aframes;
1252         fs_ep.isoc_time_complete = xfer->isoc_time_complete;
1253         if (xfer->error) {
1254                 goto complete;
1255         }
1256         if (xfer->flags_int.control_xfr) {
1257                 req = xfer->frbuffers[0].buffer;
1258
1259                 /* Host mode only ! */
1260                 if ((req->bmRequestType & (UT_READ | UT_WRITE)) == UT_READ) {
1261                         isread = 1;
1262                 } else {
1263                         isread = 0;
1264                 }
1265                 if (xfer->nframes == 0)
1266                         n = 0;          /* should never happen */
1267                 else
1268                         n = 1;
1269         } else {
1270                 /* Device and Host mode */
1271                 if (USB_GET_DATA_ISREAD(xfer)) {
1272                         isread = 1;
1273                 } else {
1274                         isread = 0;
1275                 }
1276                 n = 0;
1277         }
1278
1279         /* Update lengths and copy out data */
1280
1281         rem = usbd_xfer_max_len(xfer);
1282         offset = 0;
1283
1284         for (; n != xfer->nframes; n++) {
1285
1286                 /* get initial length into "temp" */
1287                 error = copyin(fs_ep.pLength + n,
1288                     &temp, sizeof(temp));
1289                 if (error) {
1290                         return (error);
1291                 }
1292                 if (temp > rem) {
1293                         /* the userland length has been corrupted */
1294                         DPRINTF("corrupt userland length "
1295                             "%u > %u\n", temp, rem);
1296                         fs_ep.status = USB_ERR_INVAL;
1297                         goto complete;
1298                 }
1299                 rem -= temp;
1300
1301                 /* get actual transfer length */
1302                 length = xfer->frlengths[n];
1303                 if (length > temp) {
1304                         /* data overflow */
1305                         fs_ep.status = USB_ERR_INVAL;
1306                         DPRINTF("data overflow %u > %u\n",
1307                             length, temp);
1308                         goto complete;
1309                 }
1310                 if (isread) {
1311
1312                         /* we need to know the destination buffer */
1313                         error = copyin(fs_ep.ppBuffer + n,
1314                             &uaddr, sizeof(uaddr));
1315                         if (error) {
1316                                 return (error);
1317                         }
1318                         if (xfer->flags_int.isochronous_xfr) {
1319                                 /* only one frame buffer */
1320                                 kaddr = USB_ADD_BYTES(
1321                                     xfer->frbuffers[0].buffer, offset);
1322                         } else {
1323                                 /* multiple frame buffers */
1324                                 kaddr = xfer->frbuffers[n].buffer;
1325                         }
1326
1327                         /* move data */
1328                         error = copyout(kaddr, uaddr, length);
1329                         if (error) {
1330                                 return (error);
1331                         }
1332                 }
1333                 /*
1334                  * Update offset according to initial length, which is
1335                  * needed by isochronous transfers!
1336                  */
1337                 offset += temp;
1338
1339                 /* update length */
1340                 error = copyout(&length,
1341                     fs_ep.pLength + n, sizeof(length));
1342                 if (error) {
1343                         return (error);
1344                 }
1345         }
1346
1347 complete:
1348         /* update "aFrames" */
1349         error = copyout(&fs_ep.aFrames, &fs_ep_uptr->aFrames,
1350             sizeof(fs_ep.aFrames));
1351         if (error)
1352                 goto done;
1353
1354         /* update "isoc_time_complete" */
1355         error = copyout(&fs_ep.isoc_time_complete,
1356             &fs_ep_uptr->isoc_time_complete,
1357             sizeof(fs_ep.isoc_time_complete));
1358         if (error)
1359                 goto done;
1360         /* update "status" */
1361         error = copyout(&fs_ep.status, &fs_ep_uptr->status,
1362             sizeof(fs_ep.status));
1363 done:
1364         return (error);
1365 }
1366
1367 static uint8_t
1368 ugen_fifo_in_use(struct usb_fifo *f, int fflags)
1369 {
1370         struct usb_fifo *f_rx;
1371         struct usb_fifo *f_tx;
1372
1373         f_rx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_RX];
1374         f_tx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_TX];
1375
1376         if ((fflags & FREAD) && f_rx &&
1377             (f_rx->xfer[0] || f_rx->xfer[1])) {
1378                 return (1);             /* RX FIFO in use */
1379         }
1380         if ((fflags & FWRITE) && f_tx &&
1381             (f_tx->xfer[0] || f_tx->xfer[1])) {
1382                 return (1);             /* TX FIFO in use */
1383         }
1384         return (0);                     /* not in use */
1385 }
1386
1387 static int
1388 ugen_ioctl(struct usb_fifo *f, u_long cmd, void *addr, int fflags)
1389 {
1390         struct usb_config usb_config[1];
1391         struct usb_device_request req;
1392         union {
1393                 struct usb_fs_complete *pcomp;
1394                 struct usb_fs_start *pstart;
1395                 struct usb_fs_stop *pstop;
1396                 struct usb_fs_open *popen;
1397                 struct usb_fs_close *pclose;
1398                 struct usb_fs_clear_stall_sync *pstall;
1399                 void   *addr;
1400         }     u;
1401         struct usb_endpoint *ep;
1402         struct usb_endpoint_descriptor *ed;
1403         struct usb_xfer *xfer;
1404         int error = 0;
1405         uint8_t iface_index;
1406         uint8_t isread;
1407         uint8_t ep_index;
1408         uint8_t pre_scale;
1409
1410         u.addr = addr;
1411
1412         DPRINTFN(6, "cmd=0x%08lx\n", cmd);
1413
1414         switch (cmd) {
1415         case USB_FS_COMPLETE:
1416                 mtx_lock(f->priv_mtx);
1417                 error = ugen_fs_get_complete(f, &ep_index);
1418                 mtx_unlock(f->priv_mtx);
1419
1420                 if (error) {
1421                         error = EBUSY;
1422                         break;
1423                 }
1424                 u.pcomp->ep_index = ep_index;
1425                 error = ugen_fs_copy_out(f, u.pcomp->ep_index);
1426                 break;
1427
1428         case USB_FS_START:
1429                 error = ugen_fs_copy_in(f, u.pstart->ep_index);
1430                 if (error)
1431                         break;
1432                 mtx_lock(f->priv_mtx);
1433                 xfer = f->fs_xfer[u.pstart->ep_index];
1434                 usbd_transfer_start(xfer);
1435                 mtx_unlock(f->priv_mtx);
1436                 break;
1437
1438         case USB_FS_STOP:
1439                 if (u.pstop->ep_index >= f->fs_ep_max) {
1440                         error = EINVAL;
1441                         break;
1442                 }
1443                 mtx_lock(f->priv_mtx);
1444                 xfer = f->fs_xfer[u.pstart->ep_index];
1445                 if (usbd_transfer_pending(xfer)) {
1446                         usbd_transfer_stop(xfer);
1447                         /*
1448                          * Check if the USB transfer was stopped
1449                          * before it was even started. Else a cancel
1450                          * callback will be pending.
1451                          */
1452                         if (!xfer->flags_int.transferring) {
1453                                 ugen_fs_set_complete(xfer->priv_sc,
1454                                     USB_P2U(xfer->priv_fifo));
1455                         }
1456                 }
1457                 mtx_unlock(f->priv_mtx);
1458                 break;
1459
1460         case USB_FS_OPEN:
1461                 if (u.popen->ep_index >= f->fs_ep_max) {
1462                         error = EINVAL;
1463                         break;
1464                 }
1465                 if (f->fs_xfer[u.popen->ep_index] != NULL) {
1466                         error = EBUSY;
1467                         break;
1468                 }
1469                 if (u.popen->max_bufsize > USB_FS_MAX_BUFSIZE) {
1470                         u.popen->max_bufsize = USB_FS_MAX_BUFSIZE;
1471                 }
1472                 if (u.popen->max_frames & USB_FS_MAX_FRAMES_PRE_SCALE) {
1473                         pre_scale = 1;
1474                         u.popen->max_frames &= ~USB_FS_MAX_FRAMES_PRE_SCALE;
1475                 } else {
1476                         pre_scale = 0;
1477                 }
1478                 if (u.popen->max_frames > USB_FS_MAX_FRAMES) {
1479                         u.popen->max_frames = USB_FS_MAX_FRAMES;
1480                         break;
1481                 }
1482                 if (u.popen->max_frames == 0) {
1483                         error = EINVAL;
1484                         break;
1485                 }
1486                 ep = usbd_get_ep_by_addr(f->udev, u.popen->ep_no);
1487                 if (ep == NULL) {
1488                         error = EINVAL;
1489                         break;
1490                 }
1491                 ed = ep->edesc;
1492                 if (ed == NULL) {
1493                         error = ENXIO;
1494                         break;
1495                 }
1496                 iface_index = ep->iface_index;
1497
1498                 memset(usb_config, 0, sizeof(usb_config));
1499
1500                 usb_config[0].type = ed->bmAttributes & UE_XFERTYPE;
1501                 usb_config[0].endpoint = ed->bEndpointAddress & UE_ADDR;
1502                 usb_config[0].direction = ed->bEndpointAddress & (UE_DIR_OUT | UE_DIR_IN);
1503                 usb_config[0].interval = USB_DEFAULT_INTERVAL;
1504                 usb_config[0].flags.proxy_buffer = 1;
1505                 if (pre_scale != 0)
1506                         usb_config[0].flags.pre_scale_frames = 1;
1507                 usb_config[0].callback = &ugen_ctrl_fs_callback;
1508                 usb_config[0].timeout = 0;      /* no timeout */
1509                 usb_config[0].frames = u.popen->max_frames;
1510                 usb_config[0].bufsize = u.popen->max_bufsize;
1511                 usb_config[0].usb_mode = USB_MODE_DUAL; /* both modes */
1512
1513                 if (usb_config[0].type == UE_CONTROL) {
1514                         if (f->udev->flags.usb_mode != USB_MODE_HOST) {
1515                                 error = EINVAL;
1516                                 break;
1517                         }
1518                 } else {
1519
1520                         isread = ((usb_config[0].endpoint &
1521                             (UE_DIR_IN | UE_DIR_OUT)) == UE_DIR_IN);
1522
1523                         if (f->udev->flags.usb_mode != USB_MODE_HOST) {
1524                                 isread = !isread;
1525                         }
1526                         /* check permissions */
1527                         if (isread) {
1528                                 if (!(fflags & FREAD)) {
1529                                         error = EPERM;
1530                                         break;
1531                                 }
1532                         } else {
1533                                 if (!(fflags & FWRITE)) {
1534                                         error = EPERM;
1535                                         break;
1536                                 }
1537                         }
1538                 }
1539                 error = usbd_transfer_setup(f->udev, &iface_index,
1540                     f->fs_xfer + u.popen->ep_index, usb_config, 1,
1541                     f, f->priv_mtx);
1542                 if (error == 0) {
1543                         /* update maximums */
1544                         u.popen->max_packet_length =
1545                             f->fs_xfer[u.popen->ep_index]->max_frame_size;
1546                         u.popen->max_bufsize =
1547                             f->fs_xfer[u.popen->ep_index]->max_data_length;
1548                         /* update number of frames */
1549                         u.popen->max_frames =
1550                             f->fs_xfer[u.popen->ep_index]->nframes;
1551                         /* store index of endpoint */
1552                         f->fs_xfer[u.popen->ep_index]->priv_fifo =
1553                             ((uint8_t *)0) + u.popen->ep_index;
1554                 } else {
1555                         error = ENOMEM;
1556                 }
1557                 break;
1558
1559         case USB_FS_CLOSE:
1560                 if (u.pclose->ep_index >= f->fs_ep_max) {
1561                         error = EINVAL;
1562                         break;
1563                 }
1564                 if (f->fs_xfer[u.pclose->ep_index] == NULL) {
1565                         error = EINVAL;
1566                         break;
1567                 }
1568                 usbd_transfer_unsetup(f->fs_xfer + u.pclose->ep_index, 1);
1569                 break;
1570
1571         case USB_FS_CLEAR_STALL_SYNC:
1572                 if (u.pstall->ep_index >= f->fs_ep_max) {
1573                         error = EINVAL;
1574                         break;
1575                 }
1576                 if (f->fs_xfer[u.pstall->ep_index] == NULL) {
1577                         error = EINVAL;
1578                         break;
1579                 }
1580                 if (f->udev->flags.usb_mode != USB_MODE_HOST) {
1581                         error = EINVAL;
1582                         break;
1583                 }
1584                 mtx_lock(f->priv_mtx);
1585                 error = usbd_transfer_pending(f->fs_xfer[u.pstall->ep_index]);
1586                 mtx_unlock(f->priv_mtx);
1587
1588                 if (error) {
1589                         return (EBUSY);
1590                 }
1591                 ep = f->fs_xfer[u.pstall->ep_index]->endpoint;
1592
1593                 /* setup a clear-stall packet */
1594                 req.bmRequestType = UT_WRITE_ENDPOINT;
1595                 req.bRequest = UR_CLEAR_FEATURE;
1596                 USETW(req.wValue, UF_ENDPOINT_HALT);
1597                 req.wIndex[0] = ep->edesc->bEndpointAddress;
1598                 req.wIndex[1] = 0;
1599                 USETW(req.wLength, 0);
1600
1601                 error = usbd_do_request(f->udev, NULL, &req, NULL);
1602                 if (error == 0) {
1603                         usbd_clear_data_toggle(f->udev, ep);
1604                 } else {
1605                         error = ENXIO;
1606                 }
1607                 break;
1608
1609         default:
1610                 error = ENOIOCTL;
1611                 break;
1612         }
1613
1614         DPRINTFN(6, "error=%d\n", error);
1615
1616         return (error);
1617 }
1618
1619 static int
1620 ugen_set_short_xfer(struct usb_fifo *f, void *addr)
1621 {
1622         uint8_t t;
1623
1624         if (*(int *)addr)
1625                 t = 1;
1626         else
1627                 t = 0;
1628
1629         if (f->flag_short == t) {
1630                 /* same value like before - accept */
1631                 return (0);
1632         }
1633         if (f->xfer[0] || f->xfer[1]) {
1634                 /* cannot change this during transfer */
1635                 return (EBUSY);
1636         }
1637         f->flag_short = t;
1638         return (0);
1639 }
1640
1641 static int
1642 ugen_set_timeout(struct usb_fifo *f, void *addr)
1643 {
1644         f->timeout = *(int *)addr;
1645         if (f->timeout > 65535) {
1646                 /* limit user input */
1647                 f->timeout = 65535;
1648         }
1649         return (0);
1650 }
1651
1652 static int
1653 ugen_get_frame_size(struct usb_fifo *f, void *addr)
1654 {
1655         if (f->xfer[0]) {
1656                 *(int *)addr = f->xfer[0]->max_frame_size;
1657         } else {
1658                 return (EINVAL);
1659         }
1660         return (0);
1661 }
1662
1663 static int
1664 ugen_set_buffer_size(struct usb_fifo *f, void *addr)
1665 {
1666         usb_frlength_t t;
1667
1668         if (*(int *)addr < 0)
1669                 t = 0;          /* use "wMaxPacketSize" */
1670         else if (*(int *)addr < (256 * 1024))
1671                 t = *(int *)addr;
1672         else
1673                 t = 256 * 1024;
1674
1675         if (f->bufsize == t) {
1676                 /* same value like before - accept */
1677                 return (0);
1678         }
1679         if (f->xfer[0] || f->xfer[1]) {
1680                 /* cannot change this during transfer */
1681                 return (EBUSY);
1682         }
1683         f->bufsize = t;
1684         return (0);
1685 }
1686
1687 static int
1688 ugen_get_buffer_size(struct usb_fifo *f, void *addr)
1689 {
1690         *(int *)addr = f->bufsize;
1691         return (0);
1692 }
1693
1694 static int
1695 ugen_get_iface_desc(struct usb_fifo *f,
1696     struct usb_interface_descriptor *idesc)
1697 {
1698         struct usb_interface *iface;
1699
1700         iface = usbd_get_iface(f->udev, f->iface_index);
1701         if (iface && iface->idesc) {
1702                 *idesc = *(iface->idesc);
1703         } else {
1704                 return (EIO);
1705         }
1706         return (0);
1707 }
1708
1709 static int
1710 ugen_get_endpoint_desc(struct usb_fifo *f,
1711     struct usb_endpoint_descriptor *ed)
1712 {
1713         struct usb_endpoint *ep;
1714
1715         ep = usb_fifo_softc(f);
1716
1717         if (ep && ep->edesc) {
1718                 *ed = *ep->edesc;
1719         } else {
1720                 return (EINVAL);
1721         }
1722         return (0);
1723 }
1724
1725 static int
1726 ugen_set_power_mode(struct usb_fifo *f, int mode)
1727 {
1728         struct usb_device *udev = f->udev;
1729         int err;
1730         uint8_t old_mode;
1731
1732         if ((udev == NULL) ||
1733             (udev->parent_hub == NULL)) {
1734                 return (EINVAL);
1735         }
1736         err = priv_check(curthread, PRIV_DRIVER);
1737         if (err)
1738                 return (err);
1739
1740         /* get old power mode */
1741         old_mode = udev->power_mode;
1742
1743         /* if no change, then just return */
1744         if (old_mode == mode)
1745                 return (0);
1746
1747         switch (mode) {
1748         case USB_POWER_MODE_OFF:
1749                 /* get the device unconfigured */
1750                 err = ugen_set_config(f, USB_UNCONFIG_INDEX);
1751                 if (err) {
1752                         DPRINTFN(0, "Could not unconfigure "
1753                             "device (ignored)\n");
1754                 }
1755
1756                 /* clear port enable */
1757                 err = usbd_req_clear_port_feature(udev->parent_hub,
1758                     NULL, udev->port_no, UHF_PORT_ENABLE);
1759                 break;
1760
1761         case USB_POWER_MODE_ON:
1762         case USB_POWER_MODE_SAVE:
1763                 break;
1764
1765         case USB_POWER_MODE_RESUME:
1766 #if USB_HAVE_POWERD
1767                 /* let USB-powerd handle resume */
1768                 USB_BUS_LOCK(udev->bus);
1769                 udev->pwr_save.write_refs++;
1770                 udev->pwr_save.last_xfer_time = ticks;
1771                 USB_BUS_UNLOCK(udev->bus);
1772
1773                 /* set new power mode */
1774                 usbd_set_power_mode(udev, USB_POWER_MODE_SAVE);
1775
1776                 /* wait for resume to complete */
1777                 usb_pause_mtx(NULL, hz / 4);
1778
1779                 /* clear write reference */
1780                 USB_BUS_LOCK(udev->bus);
1781                 udev->pwr_save.write_refs--;
1782                 USB_BUS_UNLOCK(udev->bus);
1783 #endif
1784                 mode = USB_POWER_MODE_SAVE;
1785                 break;
1786
1787         case USB_POWER_MODE_SUSPEND:
1788 #if USB_HAVE_POWERD
1789                 /* let USB-powerd handle suspend */
1790                 USB_BUS_LOCK(udev->bus);
1791                 udev->pwr_save.last_xfer_time = ticks - (256 * hz);
1792                 USB_BUS_UNLOCK(udev->bus);
1793 #endif
1794                 mode = USB_POWER_MODE_SAVE;
1795                 break;
1796
1797         default:
1798                 return (EINVAL);
1799         }
1800
1801         if (err)
1802                 return (ENXIO);         /* I/O failure */
1803
1804         /* if we are powered off we need to re-enumerate first */
1805         if (old_mode == USB_POWER_MODE_OFF) {
1806                 if (udev->flags.usb_mode == USB_MODE_HOST) {
1807                         if (udev->re_enumerate_wait == 0)
1808                                 udev->re_enumerate_wait = 1;
1809                 }
1810                 /* set power mode will wake up the explore thread */
1811         }
1812
1813         /* set new power mode */
1814         usbd_set_power_mode(udev, mode);
1815
1816         return (0);                     /* success */
1817 }
1818
1819 static int
1820 ugen_get_power_mode(struct usb_fifo *f)
1821 {
1822         struct usb_device *udev = f->udev;
1823
1824         if (udev == NULL)
1825                 return (USB_POWER_MODE_ON);
1826
1827         return (udev->power_mode);
1828 }
1829
1830 static int
1831 ugen_do_port_feature(struct usb_fifo *f, uint8_t port_no,
1832     uint8_t set, uint16_t feature)
1833 {
1834         struct usb_device *udev = f->udev;
1835         struct usb_hub *hub;
1836         int err;
1837
1838         err = priv_check(curthread, PRIV_DRIVER);
1839         if (err) {
1840                 return (err);
1841         }
1842         if (port_no == 0) {
1843                 return (EINVAL);
1844         }
1845         if ((udev == NULL) ||
1846             (udev->hub == NULL)) {
1847                 return (EINVAL);
1848         }
1849         hub = udev->hub;
1850
1851         if (port_no > hub->nports) {
1852                 return (EINVAL);
1853         }
1854         if (set)
1855                 err = usbd_req_set_port_feature(udev,
1856                     NULL, port_no, feature);
1857         else
1858                 err = usbd_req_clear_port_feature(udev,
1859                     NULL, port_no, feature);
1860
1861         if (err)
1862                 return (ENXIO);         /* failure */
1863
1864         return (0);                     /* success */
1865 }
1866
1867 static int
1868 ugen_iface_ioctl(struct usb_fifo *f, u_long cmd, void *addr, int fflags)
1869 {
1870         struct usb_fifo *f_rx;
1871         struct usb_fifo *f_tx;
1872         int error = 0;
1873
1874         f_rx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_RX];
1875         f_tx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_TX];
1876
1877         switch (cmd) {
1878         case USB_SET_RX_SHORT_XFER:
1879                 if (fflags & FREAD) {
1880                         error = ugen_set_short_xfer(f_rx, addr);
1881                 } else {
1882                         error = EINVAL;
1883                 }
1884                 break;
1885
1886         case USB_SET_TX_FORCE_SHORT:
1887                 if (fflags & FWRITE) {
1888                         error = ugen_set_short_xfer(f_tx, addr);
1889                 } else {
1890                         error = EINVAL;
1891                 }
1892                 break;
1893
1894         case USB_SET_RX_TIMEOUT:
1895                 if (fflags & FREAD) {
1896                         error = ugen_set_timeout(f_rx, addr);
1897                 } else {
1898                         error = EINVAL;
1899                 }
1900                 break;
1901
1902         case USB_SET_TX_TIMEOUT:
1903                 if (fflags & FWRITE) {
1904                         error = ugen_set_timeout(f_tx, addr);
1905                 } else {
1906                         error = EINVAL;
1907                 }
1908                 break;
1909
1910         case USB_GET_RX_FRAME_SIZE:
1911                 if (fflags & FREAD) {
1912                         error = ugen_get_frame_size(f_rx, addr);
1913                 } else {
1914                         error = EINVAL;
1915                 }
1916                 break;
1917
1918         case USB_GET_TX_FRAME_SIZE:
1919                 if (fflags & FWRITE) {
1920                         error = ugen_get_frame_size(f_tx, addr);
1921                 } else {
1922                         error = EINVAL;
1923                 }
1924                 break;
1925
1926         case USB_SET_RX_BUFFER_SIZE:
1927                 if (fflags & FREAD) {
1928                         error = ugen_set_buffer_size(f_rx, addr);
1929                 } else {
1930                         error = EINVAL;
1931                 }
1932                 break;
1933
1934         case USB_SET_TX_BUFFER_SIZE:
1935                 if (fflags & FWRITE) {
1936                         error = ugen_set_buffer_size(f_tx, addr);
1937                 } else {
1938                         error = EINVAL;
1939                 }
1940                 break;
1941
1942         case USB_GET_RX_BUFFER_SIZE:
1943                 if (fflags & FREAD) {
1944                         error = ugen_get_buffer_size(f_rx, addr);
1945                 } else {
1946                         error = EINVAL;
1947                 }
1948                 break;
1949
1950         case USB_GET_TX_BUFFER_SIZE:
1951                 if (fflags & FWRITE) {
1952                         error = ugen_get_buffer_size(f_tx, addr);
1953                 } else {
1954                         error = EINVAL;
1955                 }
1956                 break;
1957
1958         case USB_GET_RX_INTERFACE_DESC:
1959                 if (fflags & FREAD) {
1960                         error = ugen_get_iface_desc(f_rx, addr);
1961                 } else {
1962                         error = EINVAL;
1963                 }
1964                 break;
1965
1966         case USB_GET_TX_INTERFACE_DESC:
1967                 if (fflags & FWRITE) {
1968                         error = ugen_get_iface_desc(f_tx, addr);
1969                 } else {
1970                         error = EINVAL;
1971                 }
1972                 break;
1973
1974         case USB_GET_RX_ENDPOINT_DESC:
1975                 if (fflags & FREAD) {
1976                         error = ugen_get_endpoint_desc(f_rx, addr);
1977                 } else {
1978                         error = EINVAL;
1979                 }
1980                 break;
1981
1982         case USB_GET_TX_ENDPOINT_DESC:
1983                 if (fflags & FWRITE) {
1984                         error = ugen_get_endpoint_desc(f_tx, addr);
1985                 } else {
1986                         error = EINVAL;
1987                 }
1988                 break;
1989
1990         case USB_SET_RX_STALL_FLAG:
1991                 if ((fflags & FREAD) && (*(int *)addr)) {
1992                         f_rx->flag_stall = 1;
1993                 }
1994                 break;
1995
1996         case USB_SET_TX_STALL_FLAG:
1997                 if ((fflags & FWRITE) && (*(int *)addr)) {
1998                         f_tx->flag_stall = 1;
1999                 }
2000                 break;
2001
2002         default:
2003                 error = ENOIOCTL;
2004                 break;
2005         }
2006         return (error);
2007 }
2008
2009 static int
2010 ugen_ioctl_post(struct usb_fifo *f, u_long cmd, void *addr, int fflags)
2011 {
2012         union {
2013                 struct usb_interface_descriptor *idesc;
2014                 struct usb_alt_interface *ai;
2015                 struct usb_device_descriptor *ddesc;
2016                 struct usb_config_descriptor *cdesc;
2017                 struct usb_device_stats *stat;
2018                 struct usb_fs_init *pinit;
2019                 struct usb_fs_uninit *puninit;
2020                 uint32_t *ptime;
2021                 void   *addr;
2022                 int    *pint;
2023         }     u;
2024         struct usb_device_descriptor *dtemp;
2025         struct usb_config_descriptor *ctemp;
2026         struct usb_interface *iface;
2027         int error = 0;
2028         uint8_t n;
2029
2030         u.addr = addr;
2031
2032         DPRINTFN(6, "cmd=0x%08lx\n", cmd);
2033
2034         switch (cmd) {
2035         case USB_DISCOVER:
2036                 usb_needs_explore_all();
2037                 break;
2038
2039         case USB_SETDEBUG:
2040                 if (!(fflags & FWRITE)) {
2041                         error = EPERM;
2042                         break;
2043                 }
2044                 usb_debug = *(int *)addr;
2045                 break;
2046
2047         case USB_GET_CONFIG:
2048                 *(int *)addr = f->udev->curr_config_index;
2049                 break;
2050
2051         case USB_SET_CONFIG:
2052                 if (!(fflags & FWRITE)) {
2053                         error = EPERM;
2054                         break;
2055                 }
2056                 error = ugen_set_config(f, *(int *)addr);
2057                 break;
2058
2059         case USB_GET_ALTINTERFACE:
2060                 iface = usbd_get_iface(f->udev,
2061                     u.ai->uai_interface_index);
2062                 if (iface && iface->idesc) {
2063                         u.ai->uai_alt_index = iface->alt_index;
2064                 } else {
2065                         error = EINVAL;
2066                 }
2067                 break;
2068
2069         case USB_SET_ALTINTERFACE:
2070                 if (!(fflags & FWRITE)) {
2071                         error = EPERM;
2072                         break;
2073                 }
2074                 error = ugen_set_interface(f,
2075                     u.ai->uai_interface_index, u.ai->uai_alt_index);
2076                 break;
2077
2078         case USB_GET_DEVICE_DESC:
2079                 dtemp = usbd_get_device_descriptor(f->udev);
2080                 if (!dtemp) {
2081                         error = EIO;
2082                         break;
2083                 }
2084                 *u.ddesc = *dtemp;
2085                 break;
2086
2087         case USB_GET_CONFIG_DESC:
2088                 ctemp = usbd_get_config_descriptor(f->udev);
2089                 if (!ctemp) {
2090                         error = EIO;
2091                         break;
2092                 }
2093                 *u.cdesc = *ctemp;
2094                 break;
2095
2096         case USB_GET_FULL_DESC:
2097                 error = ugen_get_cdesc(f, addr);
2098                 break;
2099
2100         case USB_GET_STRING_DESC:
2101                 error = ugen_get_sdesc(f, addr);
2102                 break;
2103
2104         case USB_GET_IFACE_DRIVER:
2105                 error = ugen_get_iface_driver(f, addr);
2106                 break;
2107
2108         case USB_REQUEST:
2109         case USB_DO_REQUEST:
2110                 if (!(fflags & FWRITE)) {
2111                         error = EPERM;
2112                         break;
2113                 }
2114                 error = ugen_do_request(f, addr);
2115                 break;
2116
2117         case USB_DEVICEINFO:
2118         case USB_GET_DEVICEINFO:
2119                 error = usb_gen_fill_deviceinfo(f, addr);
2120                 break;
2121
2122         case USB_DEVICESTATS:
2123                 for (n = 0; n != 4; n++) {
2124
2125                         u.stat->uds_requests_fail[n] =
2126                             f->udev->bus->stats_err.uds_requests[n];
2127
2128                         u.stat->uds_requests_ok[n] =
2129                             f->udev->bus->stats_ok.uds_requests[n];
2130                 }
2131                 break;
2132
2133         case USB_DEVICEENUMERATE:
2134                 error = ugen_re_enumerate(f);
2135                 break;
2136
2137         case USB_GET_PLUGTIME:
2138                 *u.ptime = f->udev->plugtime;
2139                 break;
2140
2141         case USB_CLAIM_INTERFACE:
2142         case USB_RELEASE_INTERFACE:
2143                 /* TODO */
2144                 break;
2145
2146         case USB_IFACE_DRIVER_ACTIVE:
2147
2148                 n = *u.pint & 0xFF;
2149
2150                 iface = usbd_get_iface(f->udev, n);
2151
2152                 if (iface && iface->subdev)
2153                         error = 0;
2154                 else
2155                         error = ENXIO;
2156                 break;
2157
2158         case USB_IFACE_DRIVER_DETACH:
2159
2160                 error = priv_check(curthread, PRIV_DRIVER);
2161
2162                 if (error)
2163                         break;
2164
2165                 n = *u.pint & 0xFF;
2166
2167                 if (n == USB_IFACE_INDEX_ANY) {
2168                         error = EINVAL;
2169                         break;
2170                 }
2171
2172                 usb_detach_device(f->udev, n, 0);
2173                 break;
2174
2175         case USB_SET_POWER_MODE:
2176                 error = ugen_set_power_mode(f, *u.pint);
2177                 break;
2178
2179         case USB_GET_POWER_MODE:
2180                 *u.pint = ugen_get_power_mode(f);
2181                 break;
2182
2183         case USB_SET_PORT_ENABLE:
2184                 error = ugen_do_port_feature(f,
2185                     *u.pint, 1, UHF_PORT_ENABLE);
2186                 break;
2187
2188         case USB_SET_PORT_DISABLE:
2189                 error = ugen_do_port_feature(f,
2190                     *u.pint, 0, UHF_PORT_ENABLE);
2191                 break;
2192
2193         case USB_FS_INIT:
2194                 /* verify input parameters */
2195                 if (u.pinit->pEndpoints == NULL) {
2196                         error = EINVAL;
2197                         break;
2198                 }
2199                 if (u.pinit->ep_index_max > 127) {
2200                         error = EINVAL;
2201                         break;
2202                 }
2203                 if (u.pinit->ep_index_max == 0) {
2204                         error = EINVAL;
2205                         break;
2206                 }
2207                 if (f->fs_xfer != NULL) {
2208                         error = EBUSY;
2209                         break;
2210                 }
2211                 if (f->dev_ep_index != 0) {
2212                         error = EINVAL;
2213                         break;
2214                 }
2215                 if (ugen_fifo_in_use(f, fflags)) {
2216                         error = EBUSY;
2217                         break;
2218                 }
2219                 error = usb_fifo_alloc_buffer(f, 1, u.pinit->ep_index_max);
2220                 if (error) {
2221                         break;
2222                 }
2223                 f->fs_xfer = malloc(sizeof(f->fs_xfer[0]) *
2224                     u.pinit->ep_index_max, M_USB, M_WAITOK | M_ZERO);
2225                 if (f->fs_xfer == NULL) {
2226                         usb_fifo_free_buffer(f);
2227                         error = ENOMEM;
2228                         break;
2229                 }
2230                 f->fs_ep_max = u.pinit->ep_index_max;
2231                 f->fs_ep_ptr = u.pinit->pEndpoints;
2232                 break;
2233
2234         case USB_FS_UNINIT:
2235                 if (u.puninit->dummy != 0) {
2236                         error = EINVAL;
2237                         break;
2238                 }
2239                 error = ugen_fs_uninit(f);
2240                 break;
2241
2242         default:
2243                 mtx_lock(f->priv_mtx);
2244                 error = ugen_iface_ioctl(f, cmd, addr, fflags);
2245                 mtx_unlock(f->priv_mtx);
2246                 break;
2247         }
2248         DPRINTFN(6, "error=%d\n", error);
2249         return (error);
2250 }
2251
2252 static void
2253 ugen_ctrl_fs_callback(struct usb_xfer *xfer, usb_error_t error)
2254 {
2255         ;                               /* workaround for a bug in "indent" */
2256
2257         DPRINTF("st=%u alen=%u aframes=%u\n",
2258             USB_GET_STATE(xfer), xfer->actlen, xfer->aframes);
2259
2260         switch (USB_GET_STATE(xfer)) {
2261         case USB_ST_SETUP:
2262                 usbd_transfer_submit(xfer);
2263                 break;
2264         default:
2265                 ugen_fs_set_complete(xfer->priv_sc, USB_P2U(xfer->priv_fifo));
2266                 break;
2267         }
2268 }
2269 #endif  /* USB_HAVE_UGEN */