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