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