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 static int
 710 ugen_get_sdesc(struct usb_fifo *f, struct usb_gen_descriptor *ugd)
 711 {
 712         void *ptr;
 713         uint16_t size;
 714         int error;
 715         uint8_t do_unlock;
 716
 717         /* Protect scratch area */
 718         do_unlock = usbd_ctrl_lock(f->udev);
 719
 720         ptr = f->udev->scratch.data;
 721         size = sizeof(f->udev->scratch.data);
 722
 723         if (usbd_req_get_string_desc(f->udev, NULL, ptr,
 724             size, ugd->ugd_lang_id, ugd->ugd_string_index)) {
 725                 error = EINVAL;
 726         } else {
 727
 728                 if (size > ((uint8_t *)ptr)[0]) {
 729                         size = ((uint8_t *)ptr)[0];
 730                 }
 731                 if (size > ugd->ugd_maxlen) {
 732                         size = ugd->ugd_maxlen;
 733                 }
 734                 ugd->ugd_actlen = size;
 735                 ugd->ugd_offset = 0;
 736
 737                 error = copyout(ptr, ugd->ugd_data, size);
 738         }
 739         if (do_unlock)
 740                 usbd_ctrl_unlock(f->udev);
 741
 742         return (error);
 743 }
 744
 745 /*------------------------------------------------------------------------*
 746  *      ugen_get_iface_driver
 747  *
 748  * This function generates an USB interface description for userland.
 749  *
 750  * Returns:
 751  *    0: Success
 752  * Else: Failure
 753  *------------------------------------------------------------------------*/
 754 static int
 755 ugen_get_iface_driver(struct usb_fifo *f, struct usb_gen_descriptor *ugd)
 756 {
 757         struct usb_device *udev = f->udev;
 758         struct usb_interface *iface;
 759         const char *ptr;
 760         const char *desc;
 761         unsigned int len;
 762         unsigned int maxlen;
 763         char buf[128];
 764         int error;
 765
 766         DPRINTFN(6, "\n");
 767
 768         if ((ugd->ugd_data == NULL) || (ugd->ugd_maxlen == 0)) {
 769                 /* userland pointer should not be zero */
 770                 return (EINVAL);
 771         }
 772
 773         iface = usbd_get_iface(udev, ugd->ugd_iface_index);
 774         if ((iface == NULL) || (iface->idesc == NULL)) {
 775                 /* invalid interface index */
 776                 return (EINVAL);
 777         }
 778
 779         /* read out device nameunit string, if any */
 780         if ((iface->subdev != NULL) &&
 781             device_is_attached(iface->subdev) &&
 782             (ptr = device_get_nameunit(iface->subdev)) &&
 783             (desc = device_get_desc(iface->subdev))) {
 784
 785                 /* print description */
 786                 snprintf(buf, sizeof(buf), "%s: <%s>", ptr, desc);
 787
 788                 /* range checks */
 789                 maxlen = ugd->ugd_maxlen - 1;
 790                 len = strlen(buf);
 791                 if (len > maxlen)
 792                         len = maxlen;
 793
 794                 /* update actual length, including terminating zero */
 795                 ugd->ugd_actlen = len + 1;
 796
 797                 /* copy out interface description */
 798                 error = copyout(buf, ugd->ugd_data, ugd->ugd_actlen);
 799         } else {
 800                 /* zero length string is default */
 801                 error = copyout("", ugd->ugd_data, 1);
 802         }
 803         return (error);
 804 }
 805
 806 /*------------------------------------------------------------------------*
 807  *      usb_gen_fill_deviceinfo
 808  *
 809  * This function dumps information about an USB device to the
 810  * structure pointed to by the "di" argument.
 811  *
 812  * Returns:
 813  *    0: Success
 814  * Else: Failure
 815  *------------------------------------------------------------------------*/
 816 static int
 817 usb_gen_fill_deviceinfo(struct usb_fifo *f, struct usb_device_info *di)
 818 {
 819         struct usb_device *udev;
 820         struct usb_device *hub;
 821
 822         udev = f->udev;
 823
 824         bzero(di, sizeof(di[0]));
 825
 826         di->udi_bus = device_get_unit(udev->bus->bdev);
 827         di->udi_addr = udev->address;
 828         di->udi_index = udev->device_index;
 829         strlcpy(di->udi_serial, usb_get_serial(udev), sizeof(di->udi_serial));
 830         strlcpy(di->udi_vendor, usb_get_manufacturer(udev), sizeof(di->udi_vendor));
 831         strlcpy(di->udi_product, usb_get_product(udev), sizeof(di->udi_product));
 832         usb_printbcd(di->udi_release, sizeof(di->udi_release),
 833             UGETW(udev->ddesc.bcdDevice));
 834         di->udi_vendorNo = UGETW(udev->ddesc.idVendor);
 835         di->udi_productNo = UGETW(udev->ddesc.idProduct);
 836         di->udi_releaseNo = UGETW(udev->ddesc.bcdDevice);
 837         di->udi_class = udev->ddesc.bDeviceClass;
 838         di->udi_subclass = udev->ddesc.bDeviceSubClass;
 839         di->udi_protocol = udev->ddesc.bDeviceProtocol;
 840         di->udi_config_no = udev->curr_config_no;
 841         di->udi_config_index = udev->curr_config_index;
 842         di->udi_power = udev->flags.self_powered ? 0 : udev->power;
 843         di->udi_speed = udev->speed;
 844         di->udi_mode = udev->flags.usb_mode;
 845         di->udi_power_mode = udev->power_mode;
 846         di->udi_suspended = udev->flags.peer_suspended;
 847
 848         hub = udev->parent_hub;
 849         if (hub) {
 850                 di->udi_hubaddr = hub->address;
 851                 di->udi_hubindex = hub->device_index;
 852                 di->udi_hubport = udev->port_no;
 853         }
 854         return (0);
 855 }
 856
 857 /*------------------------------------------------------------------------*
 858  *      ugen_check_request
 859  *
 860  * Return values:
 861  * 0: Access allowed
 862  * Else: No access
 863  *------------------------------------------------------------------------*/
 864 static int
 865 ugen_check_request(struct usb_device *udev, struct usb_device_request *req)
 866 {
 867         struct usb_endpoint *ep;
 868         int error;
 869
 870         /*
 871          * Avoid requests that would damage the bus integrity:
 872          */
 873         if (((req->bmRequestType == UT_WRITE_DEVICE) &&
 874             (req->bRequest == UR_SET_ADDRESS)) ||
 875             ((req->bmRequestType == UT_WRITE_DEVICE) &&
 876             (req->bRequest == UR_SET_CONFIG)) ||
 877             ((req->bmRequestType == UT_WRITE_INTERFACE) &&
 878             (req->bRequest == UR_SET_INTERFACE))) {
 879                 /*
 880                  * These requests can be useful for testing USB drivers.
 881                  */
 882                 error = priv_check(curthread, PRIV_DRIVER);
 883                 if (error) {
 884                         return (error);
 885                 }
 886         }
 887         /*
 888          * Special case - handle clearing of stall
 889          */
 890         if (req->bmRequestType == UT_WRITE_ENDPOINT) {
 891
 892                 ep = usbd_get_ep_by_addr(udev, req->wIndex[0]);
 893                 if (ep == NULL) {
 894                         return (EINVAL);
 895                 }
 896                 if ((req->bRequest == UR_CLEAR_FEATURE) &&
 897                     (UGETW(req->wValue) == UF_ENDPOINT_HALT)) {
 898                         usbd_clear_data_toggle(udev, ep);
 899                 }
 900         }
 901         /* TODO: add more checks to verify the interface index */
 902
 903         return (0);
 904 }
 905
 906 int
 907 ugen_do_request(struct usb_fifo *f, struct usb_ctl_request *ur)
 908 {
 909         int error;
 910         uint16_t len;
 911         uint16_t actlen;
 912
 913         if (ugen_check_request(f->udev, &ur->ucr_request)) {
 914                 return (EPERM);
 915         }
 916         len = UGETW(ur->ucr_request.wLength);
 917
 918         /* check if "ucr_data" is valid */
 919         if (len != 0) {
 920                 if (ur->ucr_data == NULL) {
 921                         return (EFAULT);
 922                 }
 923         }
 924         /* do the USB request */
 925         error = usbd_do_request_flags
 926             (f->udev, NULL, &ur->ucr_request, ur->ucr_data,
 927             (ur->ucr_flags & USB_SHORT_XFER_OK) |
 928             USB_USER_DATA_PTR, &actlen,
 929             USB_DEFAULT_TIMEOUT);
 930
 931         ur->ucr_actlen = actlen;
 932
 933         if (error) {
 934                 error = EIO;
 935         }
 936         return (error);
 937 }
 938
 939 /*------------------------------------------------------------------------
 940  *      ugen_re_enumerate
 941  *------------------------------------------------------------------------*/
 942 static int
 943 ugen_re_enumerate(struct usb_fifo *f)
 944 {
 945         struct usb_device *udev = f->udev;
 946         int error;
 947
 948         /*
 949          * This request can be useful for testing USB drivers:
 950          */
 951         error = priv_check(curthread, PRIV_DRIVER);
 952         if (error) {
 953                 return (error);
 954         }
 955         if (udev->flags.usb_mode != USB_MODE_HOST) {
 956                 /* not possible in device side mode */
 957                 DPRINTFN(6, "device mode\n");
 958                 return (ENOTTY);
 959         }
 960         /* make sure all FIFO's are gone */
 961         /* else there can be a deadlock */
 962         if (ugen_fs_uninit(f)) {
 963                 /* ignore any errors */
 964                 DPRINTFN(6, "no FIFOs\n");
 965         }
 966         /* start re-enumeration of device */
 967         usbd_start_re_enumerate(udev);
 968         return (0);
 969 }
 970
 971 int
 972 ugen_fs_uninit(struct usb_fifo *f)
 973 {
 974         if (f->fs_xfer == NULL) {
 975                 return (EINVAL);
 976         }
 977         usbd_transfer_unsetup(f->fs_xfer, f->fs_ep_max);
 978         free(f->fs_xfer, M_USB);
 979         f->fs_xfer = NULL;
 980         f->fs_ep_max = 0;
 981         f->fs_ep_ptr = NULL;
 982         f->flag_iscomplete = 0;
 983         usb_fifo_free_buffer(f);
 984         return (0);
 985 }
 986
 987 static uint8_t
 988 ugen_fs_get_complete(struct usb_fifo *f, uint8_t *pindex)
 989 {
 990         struct usb_mbuf *m;
 991
 992         USB_IF_DEQUEUE(&f->used_q, m);
 993
 994         if (m) {
 995                 *pindex = *((uint8_t *)(m->cur_data_ptr));
 996
 997                 USB_IF_ENQUEUE(&f->free_q, m);
 998
 999                 return (0);             /* success */
1000         } else {
1001
1002                 *pindex = 0;            /* fix compiler warning */
1003
1004                 f->flag_iscomplete = 0;
1005         }
1006         return (1);                     /* failure */
1007 }
1008
1009 static void
1010 ugen_fs_set_complete(struct usb_fifo *f, uint8_t index)
1011 {
1012         struct usb_mbuf *m;
1013
1014         USB_IF_DEQUEUE(&f->free_q, m);
1015
1016         if (m == NULL) {
1017                 /* can happen during close */
1018                 DPRINTF("out of buffers\n");
1019                 return;
1020         }
1021         USB_MBUF_RESET(m);
1022
1023         *((uint8_t *)(m->cur_data_ptr)) = index;
1024
1025         USB_IF_ENQUEUE(&f->used_q, m);
1026
1027         f->flag_iscomplete = 1;
1028
1029         usb_fifo_wakeup(f);
1030 }
1031
1032 static int
1033 ugen_fs_copy_in(struct usb_fifo *f, uint8_t ep_index)
1034 {
1035         struct usb_device_request *req;
1036         struct usb_xfer *xfer;
1037         struct usb_fs_endpoint fs_ep;
1038         void *uaddr;                    /* userland pointer */
1039         void *kaddr;
1040         usb_frlength_t offset;
1041         usb_frlength_t rem;
1042         usb_frcount_t n;
1043         uint32_t length;
1044         int error;
1045         uint8_t isread;
1046
1047         if (ep_index >= f->fs_ep_max) {
1048                 return (EINVAL);
1049         }
1050         xfer = f->fs_xfer[ep_index];
1051         if (xfer == NULL) {
1052                 return (EINVAL);
1053         }
1054         mtx_lock(f->priv_mtx);
1055         if (usbd_transfer_pending(xfer)) {
1056                 mtx_unlock(f->priv_mtx);
1057                 return (EBUSY);         /* should not happen */
1058         }
1059         mtx_unlock(f->priv_mtx);
1060
1061         error = copyin(f->fs_ep_ptr +
1062             ep_index, &fs_ep, sizeof(fs_ep));
1063         if (error) {
1064                 return (error);
1065         }
1066         /* security checks */
1067
1068         if (fs_ep.nFrames > xfer->max_frame_count) {
1069                 xfer->error = USB_ERR_INVAL;
1070                 goto complete;
1071         }
1072         if (fs_ep.nFrames == 0) {
1073                 xfer->error = USB_ERR_INVAL;
1074                 goto complete;
1075         }
1076         error = copyin(fs_ep.ppBuffer,
1077             &uaddr, sizeof(uaddr));
1078         if (error) {
1079                 return (error);
1080         }
1081         /* reset first frame */
1082         usbd_xfer_set_frame_offset(xfer, 0, 0);
1083
1084         if (xfer->flags_int.control_xfr) {
1085
1086                 req = xfer->frbuffers[0].buffer;
1087
1088                 error = copyin(fs_ep.pLength,
1089                     &length, sizeof(length));
1090                 if (error) {
1091                         return (error);
1092                 }
1093                 if (length != sizeof(*req)) {
1094                         xfer->error = USB_ERR_INVAL;
1095                         goto complete;
1096                 }
1097                 if (length != 0) {
1098                         error = copyin(uaddr, req, length);
1099                         if (error) {
1100                                 return (error);
1101                         }
1102                 }
1103                 if (ugen_check_request(f->udev, req)) {
1104                         xfer->error = USB_ERR_INVAL;
1105                         goto complete;
1106                 }
1107                 usbd_xfer_set_frame_len(xfer, 0, length);
1108
1109                 /* Host mode only ! */
1110                 if ((req->bmRequestType &
1111                     (UT_READ | UT_WRITE)) == UT_READ) {
1112                         isread = 1;
1113                 } else {
1114                         isread = 0;
1115                 }
1116                 n = 1;
1117                 offset = sizeof(*req);
1118
1119         } else {
1120                 /* Device and Host mode */
1121                 if (USB_GET_DATA_ISREAD(xfer)) {
1122                         isread = 1;
1123                 } else {
1124                         isread = 0;
1125                 }
1126                 n = 0;
1127                 offset = 0;
1128         }
1129
1130         rem = usbd_xfer_max_len(xfer);
1131         xfer->nframes = fs_ep.nFrames;
1132         xfer->timeout = fs_ep.timeout;
1133         if (xfer->timeout > 65535) {
1134                 xfer->timeout = 65535;
1135         }
1136         if (fs_ep.flags & USB_FS_FLAG_SINGLE_SHORT_OK)
1137                 xfer->flags.short_xfer_ok = 1;
1138         else
1139                 xfer->flags.short_xfer_ok = 0;
1140
1141         if (fs_ep.flags & USB_FS_FLAG_MULTI_SHORT_OK)
1142                 xfer->flags.short_frames_ok = 1;
1143         else
1144                 xfer->flags.short_frames_ok = 0;
1145
1146         if (fs_ep.flags & USB_FS_FLAG_FORCE_SHORT)
1147                 xfer->flags.force_short_xfer = 1;
1148         else
1149                 xfer->flags.force_short_xfer = 0;
1150
1151         if (fs_ep.flags & USB_FS_FLAG_CLEAR_STALL)
1152                 usbd_xfer_set_stall(xfer);
1153         else
1154                 xfer->flags.stall_pipe = 0;
1155
1156         for (; n != xfer->nframes; n++) {
1157
1158                 error = copyin(fs_ep.pLength + n,
1159                     &length, sizeof(length));
1160                 if (error) {
1161                         break;
1162                 }
1163                 usbd_xfer_set_frame_len(xfer, n, length);
1164
1165                 if (length > rem) {
1166                         xfer->error = USB_ERR_INVAL;
1167                         goto complete;
1168                 }
1169                 rem -= length;
1170
1171                 if (!isread) {
1172
1173                         /* we need to know the source buffer */
1174                         error = copyin(fs_ep.ppBuffer + n,
1175                             &uaddr, sizeof(uaddr));
1176                         if (error) {
1177                                 break;
1178                         }
1179                         if (xfer->flags_int.isochronous_xfr) {
1180                                 /* get kernel buffer address */
1181                                 kaddr = xfer->frbuffers[0].buffer;
1182                                 kaddr = USB_ADD_BYTES(kaddr, offset);
1183                         } else {
1184                                 /* set current frame offset */
1185                                 usbd_xfer_set_frame_offset(xfer, offset, n);
1186
1187                                 /* get kernel buffer address */
1188                                 kaddr = xfer->frbuffers[n].buffer;
1189                         }
1190
1191                         /* move data */
1192                         error = copyin(uaddr, kaddr, length);
1193                         if (error) {
1194                                 break;
1195                         }
1196                 }
1197                 offset += length;
1198         }
1199         return (error);
1200
1201 complete:
1202         mtx_lock(f->priv_mtx);
1203         ugen_fs_set_complete(f, ep_index);
1204         mtx_unlock(f->priv_mtx);
1205         return (0);
1206 }
1207
1208 static int
1209 ugen_fs_copy_out_cancelled(struct usb_fs_endpoint *fs_ep_uptr)
1210 {
1211         struct usb_fs_endpoint fs_ep;
1212         int error;
1213
1214         error = copyin(fs_ep_uptr, &fs_ep, sizeof(fs_ep));
1215         if (error)
1216                 return (error);
1217
1218         fs_ep.status = USB_ERR_CANCELLED;
1219         fs_ep.aFrames = 0;
1220         fs_ep.isoc_time_complete = 0;
1221
1222         /* update "aFrames" */
1223         error = copyout(&fs_ep.aFrames, &fs_ep_uptr->aFrames,
1224             sizeof(fs_ep.aFrames));
1225         if (error)
1226                 goto done;
1227
1228         /* update "isoc_time_complete" */
1229         error = copyout(&fs_ep.isoc_time_complete,
1230             &fs_ep_uptr->isoc_time_complete,
1231             sizeof(fs_ep.isoc_time_complete));
1232         if (error)
1233                 goto done;
1234
1235         /* update "status" */
1236         error = copyout(&fs_ep.status, &fs_ep_uptr->status,
1237             sizeof(fs_ep.status));
1238 done:
1239         return (error);
1240 }
1241
1242 static int
1243 ugen_fs_copy_out(struct usb_fifo *f, uint8_t ep_index)
1244 {
1245         struct usb_device_request *req;
1246         struct usb_xfer *xfer;
1247         struct usb_fs_endpoint fs_ep;
1248         struct usb_fs_endpoint *fs_ep_uptr;     /* userland ptr */
1249         void *uaddr;                    /* userland ptr */
1250         void *kaddr;
1251         usb_frlength_t offset;
1252         usb_frlength_t rem;
1253         usb_frcount_t n;
1254         uint32_t length;
1255         uint32_t temp;
1256         int error;
1257         uint8_t isread;
1258
1259         if (ep_index >= f->fs_ep_max)
1260                 return (EINVAL);
1261
1262         xfer = f->fs_xfer[ep_index];
1263         if (xfer == NULL)
1264                 return (EINVAL);
1265
1266         mtx_lock(f->priv_mtx);
1267         if (!xfer->flags_int.transferring &&
1268             !xfer->flags_int.started) {
1269                 mtx_unlock(f->priv_mtx);
1270                 DPRINTF("Returning fake cancel event\n");
1271                 return (ugen_fs_copy_out_cancelled(f->fs_ep_ptr + ep_index));
1272         } else if (usbd_transfer_pending(xfer)) {
1273                 mtx_unlock(f->priv_mtx);
1274                 return (EBUSY);         /* should not happen */
1275         }
1276         mtx_unlock(f->priv_mtx);
1277
1278         fs_ep_uptr = f->fs_ep_ptr + ep_index;
1279         error = copyin(fs_ep_uptr, &fs_ep, sizeof(fs_ep));
1280         if (error) {
1281                 return (error);
1282         }
1283         fs_ep.status = xfer->error;
1284         fs_ep.aFrames = xfer->aframes;
1285         fs_ep.isoc_time_complete = xfer->isoc_time_complete;
1286         if (xfer->error) {
1287                 goto complete;
1288         }
1289         if (xfer->flags_int.control_xfr) {
1290                 req = xfer->frbuffers[0].buffer;
1291
1292                 /* Host mode only ! */
1293                 if ((req->bmRequestType & (UT_READ | UT_WRITE)) == UT_READ) {
1294                         isread = 1;
1295                 } else {
1296                         isread = 0;
1297                 }
1298                 if (xfer->nframes == 0)
1299                         n = 0;          /* should never happen */
1300                 else
1301                         n = 1;
1302         } else {
1303                 /* Device and Host mode */
1304                 if (USB_GET_DATA_ISREAD(xfer)) {
1305                         isread = 1;
1306                 } else {
1307                         isread = 0;
1308                 }
1309                 n = 0;
1310         }
1311
1312         /* Update lengths and copy out data */
1313
1314         rem = usbd_xfer_max_len(xfer);
1315         offset = 0;
1316
1317         for (; n != xfer->nframes; n++) {
1318
1319                 /* get initial length into "temp" */
1320                 error = copyin(fs_ep.pLength + n,
1321                     &temp, sizeof(temp));
1322                 if (error) {
1323                         return (error);
1324                 }
1325                 if (temp > rem) {
1326                         /* the userland length has been corrupted */
1327                         DPRINTF("corrupt userland length "
1328                             "%u > %u\n", temp, rem);
1329                         fs_ep.status = USB_ERR_INVAL;
1330                         goto complete;
1331                 }
1332                 rem -= temp;
1333
1334                 /* get actual transfer length */
1335                 length = xfer->frlengths[n];
1336                 if (length > temp) {
1337                         /* data overflow */
1338                         fs_ep.status = USB_ERR_INVAL;
1339                         DPRINTF("data overflow %u > %u\n",
1340                             length, temp);
1341                         goto complete;
1342                 }
1343                 if (isread) {
1344
1345                         /* we need to know the destination buffer */
1346                         error = copyin(fs_ep.ppBuffer + n,
1347                             &uaddr, sizeof(uaddr));
1348                         if (error) {
1349                                 return (error);
1350                         }
1351                         if (xfer->flags_int.isochronous_xfr) {
1352                                 /* only one frame buffer */
1353                                 kaddr = USB_ADD_BYTES(
1354                                     xfer->frbuffers[0].buffer, offset);
1355                         } else {
1356                                 /* multiple frame buffers */
1357                                 kaddr = xfer->frbuffers[n].buffer;
1358                         }
1359
1360                         /* move data */
1361                         error = copyout(kaddr, uaddr, length);
1362                         if (error) {
1363                                 return (error);
1364                         }
1365                 }
1366                 /*
1367                  * Update offset according to initial length, which is
1368                  * needed by isochronous transfers!
1369                  */
1370                 offset += temp;
1371
1372                 /* update length */
1373                 error = copyout(&length,
1374                     fs_ep.pLength + n, sizeof(length));
1375                 if (error) {
1376                         return (error);
1377                 }
1378         }
1379
1380 complete:
1381         /* update "aFrames" */
1382         error = copyout(&fs_ep.aFrames, &fs_ep_uptr->aFrames,
1383             sizeof(fs_ep.aFrames));
1384         if (error)
1385                 goto done;
1386
1387         /* update "isoc_time_complete" */
1388         error = copyout(&fs_ep.isoc_time_complete,
1389             &fs_ep_uptr->isoc_time_complete,
1390             sizeof(fs_ep.isoc_time_complete));
1391         if (error)
1392                 goto done;
1393
1394         /* update "status" */
1395         error = copyout(&fs_ep.status, &fs_ep_uptr->status,
1396             sizeof(fs_ep.status));
1397 done:
1398         return (error);
1399 }
1400
1401 static uint8_t
1402 ugen_fifo_in_use(struct usb_fifo *f, int fflags)
1403 {
1404         struct usb_fifo *f_rx;
1405         struct usb_fifo *f_tx;
1406
1407         f_rx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_RX];
1408         f_tx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_TX];
1409
1410         if ((fflags & FREAD) && f_rx &&
1411             (f_rx->xfer[0] || f_rx->xfer[1])) {
1412                 return (1);             /* RX FIFO in use */
1413         }
1414         if ((fflags & FWRITE) && f_tx &&
1415             (f_tx->xfer[0] || f_tx->xfer[1])) {
1416                 return (1);             /* TX FIFO in use */
1417         }
1418         return (0);                     /* not in use */
1419 }
1420
1421 static int
1422 ugen_ioctl(struct usb_fifo *f, u_long cmd, void *addr, int fflags)
1423 {
1424         struct usb_config usb_config[1];
1425         struct usb_device_request req;
1426         union {
1427                 struct usb_fs_complete *pcomp;
1428                 struct usb_fs_start *pstart;
1429                 struct usb_fs_stop *pstop;
1430                 struct usb_fs_open *popen;
1431                 struct usb_fs_close *pclose;
1432                 struct usb_fs_clear_stall_sync *pstall;
1433                 void   *addr;
1434         }     u;
1435         struct usb_endpoint *ep;
1436         struct usb_endpoint_descriptor *ed;
1437         struct usb_xfer *xfer;
1438         int error = 0;
1439         uint8_t iface_index;
1440         uint8_t isread;
1441         uint8_t ep_index;
1442         uint8_t pre_scale;
1443
1444         u.addr = addr;
1445
1446         DPRINTFN(6, "cmd=0x%08lx\n", cmd);
1447
1448         switch (cmd) {
1449         case USB_FS_COMPLETE:
1450                 mtx_lock(f->priv_mtx);
1451                 error = ugen_fs_get_complete(f, &ep_index);
1452                 mtx_unlock(f->priv_mtx);
1453
1454                 if (error) {
1455                         error = EBUSY;
1456                         break;
1457                 }
1458                 u.pcomp->ep_index = ep_index;
1459                 error = ugen_fs_copy_out(f, u.pcomp->ep_index);
1460                 break;
1461
1462         case USB_FS_START:
1463                 error = ugen_fs_copy_in(f, u.pstart->ep_index);
1464                 if (error)
1465                         break;
1466                 mtx_lock(f->priv_mtx);
1467                 xfer = f->fs_xfer[u.pstart->ep_index];
1468                 usbd_transfer_start(xfer);
1469                 mtx_unlock(f->priv_mtx);
1470                 break;
1471
1472         case USB_FS_STOP:
1473                 if (u.pstop->ep_index >= f->fs_ep_max) {
1474                         error = EINVAL;
1475                         break;
1476                 }
1477                 mtx_lock(f->priv_mtx);
1478                 xfer = f->fs_xfer[u.pstart->ep_index];
1479                 if (usbd_transfer_pending(xfer)) {
1480                         usbd_transfer_stop(xfer);
1481
1482                         /*
1483                          * Check if the USB transfer was stopped
1484                          * before it was even started and fake a
1485                          * cancel event.
1486                          */
1487                         if (!xfer->flags_int.transferring &&
1488                             !xfer->flags_int.started) {
1489                                 DPRINTF("Issuing fake completion event\n");
1490                                 ugen_fs_set_complete(xfer->priv_sc,
1491                                     USB_P2U(xfer->priv_fifo));
1492                         }
1493                 }
1494                 mtx_unlock(f->priv_mtx);
1495                 break;
1496
1497         case USB_FS_OPEN:
1498                 if (u.popen->ep_index >= f->fs_ep_max) {
1499                         error = EINVAL;
1500                         break;
1501                 }
1502                 if (f->fs_xfer[u.popen->ep_index] != NULL) {
1503                         error = EBUSY;
1504                         break;
1505                 }
1506                 if (u.popen->max_bufsize > USB_FS_MAX_BUFSIZE) {
1507                         u.popen->max_bufsize = USB_FS_MAX_BUFSIZE;
1508                 }
1509                 if (u.popen->max_frames & USB_FS_MAX_FRAMES_PRE_SCALE) {
1510                         pre_scale = 1;
1511                         u.popen->max_frames &= ~USB_FS_MAX_FRAMES_PRE_SCALE;
1512                 } else {
1513                         pre_scale = 0;
1514                 }
1515                 if (u.popen->max_frames > USB_FS_MAX_FRAMES) {
1516                         u.popen->max_frames = USB_FS_MAX_FRAMES;
1517                         break;
1518                 }
1519                 if (u.popen->max_frames == 0) {
1520                         error = EINVAL;
1521                         break;
1522                 }
1523                 ep = usbd_get_ep_by_addr(f->udev, u.popen->ep_no);
1524                 if (ep == NULL) {
1525                         error = EINVAL;
1526                         break;
1527                 }
1528                 ed = ep->edesc;
1529                 if (ed == NULL) {
1530                         error = ENXIO;
1531                         break;
1532                 }
1533                 iface_index = ep->iface_index;
1534
1535                 memset(usb_config, 0, sizeof(usb_config));
1536
1537                 usb_config[0].type = ed->bmAttributes & UE_XFERTYPE;
1538                 usb_config[0].endpoint = ed->bEndpointAddress & UE_ADDR;
1539                 usb_config[0].direction = ed->bEndpointAddress & (UE_DIR_OUT | UE_DIR_IN);
1540                 usb_config[0].interval = USB_DEFAULT_INTERVAL;
1541                 usb_config[0].flags.proxy_buffer = 1;
1542                 if (pre_scale != 0)
1543                         usb_config[0].flags.pre_scale_frames = 1;
1544                 usb_config[0].callback = &ugen_ctrl_fs_callback;
1545                 usb_config[0].timeout = 0;      /* no timeout */
1546                 usb_config[0].frames = u.popen->max_frames;
1547                 usb_config[0].bufsize = u.popen->max_bufsize;
1548                 usb_config[0].usb_mode = USB_MODE_DUAL; /* both modes */
1549
1550                 if (usb_config[0].type == UE_CONTROL) {
1551                         if (f->udev->flags.usb_mode != USB_MODE_HOST) {
1552                                 error = EINVAL;
1553                                 break;
1554                         }
1555                 } else {
1556
1557                         isread = ((usb_config[0].endpoint &
1558                             (UE_DIR_IN | UE_DIR_OUT)) == UE_DIR_IN);
1559
1560                         if (f->udev->flags.usb_mode != USB_MODE_HOST) {
1561                                 isread = !isread;
1562                         }
1563                         /* check permissions */
1564                         if (isread) {
1565                                 if (!(fflags & FREAD)) {
1566                                         error = EPERM;
1567                                         break;
1568                                 }
1569                         } else {
1570                                 if (!(fflags & FWRITE)) {
1571                                         error = EPERM;
1572                                         break;
1573                                 }
1574                         }
1575                 }
1576                 error = usbd_transfer_setup(f->udev, &iface_index,
1577                     f->fs_xfer + u.popen->ep_index, usb_config, 1,
1578                     f, f->priv_mtx);
1579                 if (error == 0) {
1580                         /* update maximums */
1581                         u.popen->max_packet_length =
1582                             f->fs_xfer[u.popen->ep_index]->max_frame_size;
1583                         u.popen->max_bufsize =
1584                             f->fs_xfer[u.popen->ep_index]->max_data_length;
1585                         /* update number of frames */
1586                         u.popen->max_frames =
1587                             f->fs_xfer[u.popen->ep_index]->nframes;
1588                         /* store index of endpoint */
1589                         f->fs_xfer[u.popen->ep_index]->priv_fifo =
1590                             ((uint8_t *)0) + u.popen->ep_index;
1591                 } else {
1592                         error = ENOMEM;
1593                 }
1594                 break;
1595
1596         case USB_FS_CLOSE:
1597                 if (u.pclose->ep_index >= f->fs_ep_max) {
1598                         error = EINVAL;
1599                         break;
1600                 }
1601                 if (f->fs_xfer[u.pclose->ep_index] == NULL) {
1602                         error = EINVAL;
1603                         break;
1604                 }
1605                 usbd_transfer_unsetup(f->fs_xfer + u.pclose->ep_index, 1);
1606                 break;
1607
1608         case USB_FS_CLEAR_STALL_SYNC:
1609                 if (u.pstall->ep_index >= f->fs_ep_max) {
1610                         error = EINVAL;
1611                         break;
1612                 }
1613                 if (f->fs_xfer[u.pstall->ep_index] == NULL) {
1614                         error = EINVAL;
1615                         break;
1616                 }
1617                 if (f->udev->flags.usb_mode != USB_MODE_HOST) {
1618                         error = EINVAL;
1619                         break;
1620                 }
1621                 mtx_lock(f->priv_mtx);
1622                 error = usbd_transfer_pending(f->fs_xfer[u.pstall->ep_index]);
1623                 mtx_unlock(f->priv_mtx);
1624
1625                 if (error) {
1626                         return (EBUSY);
1627                 }
1628                 ep = f->fs_xfer[u.pstall->ep_index]->endpoint;
1629
1630                 /* setup a clear-stall packet */
1631                 req.bmRequestType = UT_WRITE_ENDPOINT;
1632                 req.bRequest = UR_CLEAR_FEATURE;
1633                 USETW(req.wValue, UF_ENDPOINT_HALT);
1634                 req.wIndex[0] = ep->edesc->bEndpointAddress;
1635                 req.wIndex[1] = 0;
1636                 USETW(req.wLength, 0);
1637
1638                 error = usbd_do_request(f->udev, NULL, &req, NULL);
1639                 if (error == 0) {
1640                         usbd_clear_data_toggle(f->udev, ep);
1641                 } else {
1642                         error = ENXIO;
1643                 }
1644                 break;
1645
1646         default:
1647                 error = ENOIOCTL;
1648                 break;
1649         }
1650
1651         DPRINTFN(6, "error=%d\n", error);
1652
1653         return (error);
1654 }
1655
1656 static int
1657 ugen_set_short_xfer(struct usb_fifo *f, void *addr)
1658 {
1659         uint8_t t;
1660
1661         if (*(int *)addr)
1662                 t = 1;
1663         else
1664                 t = 0;
1665
1666         if (f->flag_short == 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->flag_short = t;
1675         return (0);
1676 }
1677
1678 static int
1679 ugen_set_timeout(struct usb_fifo *f, void *addr)
1680 {
1681         f->timeout = *(int *)addr;
1682         if (f->timeout > 65535) {
1683                 /* limit user input */
1684                 f->timeout = 65535;
1685         }
1686         return (0);
1687 }
1688
1689 static int
1690 ugen_get_frame_size(struct usb_fifo *f, void *addr)
1691 {
1692         if (f->xfer[0]) {
1693                 *(int *)addr = f->xfer[0]->max_frame_size;
1694         } else {
1695                 return (EINVAL);
1696         }
1697         return (0);
1698 }
1699
1700 static int
1701 ugen_set_buffer_size(struct usb_fifo *f, void *addr)
1702 {
1703         usb_frlength_t t;
1704
1705         if (*(int *)addr < 0)
1706                 t = 0;          /* use "wMaxPacketSize" */
1707         else if (*(int *)addr < (256 * 1024))
1708                 t = *(int *)addr;
1709         else
1710                 t = 256 * 1024;
1711
1712         if (f->bufsize == t) {
1713                 /* same value like before - accept */
1714                 return (0);
1715         }
1716         if (f->xfer[0] || f->xfer[1]) {
1717                 /* cannot change this during transfer */
1718                 return (EBUSY);
1719         }
1720         f->bufsize = t;
1721         return (0);
1722 }
1723
1724 static int
1725 ugen_get_buffer_size(struct usb_fifo *f, void *addr)
1726 {
1727         *(int *)addr = f->bufsize;
1728         return (0);
1729 }
1730
1731 static int
1732 ugen_get_iface_desc(struct usb_fifo *f,
1733     struct usb_interface_descriptor *idesc)
1734 {
1735         struct usb_interface *iface;
1736
1737         iface = usbd_get_iface(f->udev, f->iface_index);
1738         if (iface && iface->idesc) {
1739                 *idesc = *(iface->idesc);
1740         } else {
1741                 return (EIO);
1742         }
1743         return (0);
1744 }
1745
1746 static int
1747 ugen_get_endpoint_desc(struct usb_fifo *f,
1748     struct usb_endpoint_descriptor *ed)
1749 {
1750         struct usb_endpoint *ep;
1751
1752         ep = usb_fifo_softc(f);
1753
1754         if (ep && ep->edesc) {
1755                 *ed = *ep->edesc;
1756         } else {
1757                 return (EINVAL);
1758         }
1759         return (0);
1760 }
1761
1762 static int
1763 ugen_set_power_mode(struct usb_fifo *f, int mode)
1764 {
1765         struct usb_device *udev = f->udev;
1766         int err;
1767         uint8_t old_mode;
1768
1769         if ((udev == NULL) ||
1770             (udev->parent_hub == NULL)) {
1771                 return (EINVAL);
1772         }
1773         err = priv_check(curthread, PRIV_DRIVER);
1774         if (err)
1775                 return (err);
1776
1777         /* get old power mode */
1778         old_mode = udev->power_mode;
1779
1780         /* if no change, then just return */
1781         if (old_mode == mode)
1782                 return (0);
1783
1784         switch (mode) {
1785         case USB_POWER_MODE_OFF:
1786                 if (udev->flags.usb_mode == USB_MODE_HOST &&
1787                     udev->re_enumerate_wait == USB_RE_ENUM_DONE) {
1788                         udev->re_enumerate_wait = USB_RE_ENUM_PWR_OFF;
1789                 }
1790                 /* set power mode will wake up the explore thread */
1791                 break;
1792
1793         case USB_POWER_MODE_ON:
1794         case USB_POWER_MODE_SAVE:
1795                 break;
1796
1797         case USB_POWER_MODE_RESUME:
1798 #if USB_HAVE_POWERD
1799                 /* let USB-powerd handle resume */
1800                 USB_BUS_LOCK(udev->bus);
1801                 udev->pwr_save.write_refs++;
1802                 udev->pwr_save.last_xfer_time = ticks;
1803                 USB_BUS_UNLOCK(udev->bus);
1804
1805                 /* set new power mode */
1806                 usbd_set_power_mode(udev, USB_POWER_MODE_SAVE);
1807
1808                 /* wait for resume to complete */
1809                 usb_pause_mtx(NULL, hz / 4);
1810
1811                 /* clear write reference */
1812                 USB_BUS_LOCK(udev->bus);
1813                 udev->pwr_save.write_refs--;
1814                 USB_BUS_UNLOCK(udev->bus);
1815 #endif
1816                 mode = USB_POWER_MODE_SAVE;
1817                 break;
1818
1819         case USB_POWER_MODE_SUSPEND:
1820 #if USB_HAVE_POWERD
1821                 /* let USB-powerd handle suspend */
1822                 USB_BUS_LOCK(udev->bus);
1823                 udev->pwr_save.last_xfer_time = ticks - (256 * hz);
1824                 USB_BUS_UNLOCK(udev->bus);
1825 #endif
1826                 mode = USB_POWER_MODE_SAVE;
1827                 break;
1828
1829         default:
1830                 return (EINVAL);
1831         }
1832
1833         if (err)
1834                 return (ENXIO);         /* I/O failure */
1835
1836         /* if we are powered off we need to re-enumerate first */
1837         if (old_mode == USB_POWER_MODE_OFF) {
1838                 if (udev->flags.usb_mode == USB_MODE_HOST &&
1839                     udev->re_enumerate_wait == USB_RE_ENUM_DONE) {
1840                         udev->re_enumerate_wait = USB_RE_ENUM_START;
1841                 }
1842                 /* set power mode will wake up the explore thread */
1843         }
1844
1845         /* set new power mode */
1846         usbd_set_power_mode(udev, mode);
1847
1848         return (0);                     /* success */
1849 }
1850
1851 static int
1852 ugen_get_power_mode(struct usb_fifo *f)
1853 {
1854         struct usb_device *udev = f->udev;
1855
1856         if (udev == NULL)
1857                 return (USB_POWER_MODE_ON);
1858
1859         return (udev->power_mode);
1860 }
1861
1862 static int
1863 ugen_get_port_path(struct usb_fifo *f, struct usb_device_port_path *dpp)
1864 {
1865         struct usb_device *udev = f->udev;
1866         struct usb_device *next;
1867         unsigned int nlevel = 0;
1868
1869         if (udev == NULL)
1870                 goto error;
1871
1872         dpp->udp_bus = device_get_unit(udev->bus->bdev);
1873         dpp->udp_index = udev->device_index;
1874
1875         /* count port levels */
1876         next = udev;
1877         while (next->parent_hub != NULL) {
1878                 nlevel++;
1879                 next = next->parent_hub;
1880         }
1881
1882         /* check if too many levels */
1883         if (nlevel > USB_DEVICE_PORT_PATH_MAX)
1884                 goto error;
1885
1886         /* store total level of ports */
1887         dpp->udp_port_level = nlevel;
1888
1889         /* store port index array */
1890         next = udev;
1891         while (next->parent_hub != NULL) {
1892                 dpp->udp_port_no[--nlevel] = next->port_no;
1893                 next = next->parent_hub;
1894         }
1895         return (0);     /* success */
1896
1897 error:
1898         return (EINVAL);        /* failure */
1899 }
1900
1901 static int
1902 ugen_get_power_usage(struct usb_fifo *f)
1903 {
1904         struct usb_device *udev = f->udev;
1905
1906         if (udev == NULL)
1907                 return (0);
1908
1909         return (udev->power);
1910 }
1911
1912 static int
1913 ugen_do_port_feature(struct usb_fifo *f, uint8_t port_no,
1914     uint8_t set, uint16_t feature)
1915 {
1916         struct usb_device *udev = f->udev;
1917         struct usb_hub *hub;
1918         int err;
1919
1920         err = priv_check(curthread, PRIV_DRIVER);
1921         if (err) {
1922                 return (err);
1923         }
1924         if (port_no == 0) {
1925                 return (EINVAL);
1926         }
1927         if ((udev == NULL) ||
1928             (udev->hub == NULL)) {
1929                 return (EINVAL);
1930         }
1931         hub = udev->hub;
1932
1933         if (port_no > hub->nports) {
1934                 return (EINVAL);
1935         }
1936         if (set)
1937                 err = usbd_req_set_port_feature(udev,
1938                     NULL, port_no, feature);
1939         else
1940                 err = usbd_req_clear_port_feature(udev,
1941                     NULL, port_no, feature);
1942
1943         if (err)
1944                 return (ENXIO);         /* failure */
1945
1946         return (0);                     /* success */
1947 }
1948
1949 static int
1950 ugen_iface_ioctl(struct usb_fifo *f, u_long cmd, void *addr, int fflags)
1951 {
1952         struct usb_fifo *f_rx;
1953         struct usb_fifo *f_tx;
1954         int error = 0;
1955
1956         f_rx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_RX];
1957         f_tx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_TX];
1958
1959         switch (cmd) {
1960         case USB_SET_RX_SHORT_XFER:
1961                 if (fflags & FREAD) {
1962                         error = ugen_set_short_xfer(f_rx, addr);
1963                 } else {
1964                         error = EINVAL;
1965                 }
1966                 break;
1967
1968         case USB_SET_TX_FORCE_SHORT:
1969                 if (fflags & FWRITE) {
1970                         error = ugen_set_short_xfer(f_tx, addr);
1971                 } else {
1972                         error = EINVAL;
1973                 }
1974                 break;
1975
1976         case USB_SET_RX_TIMEOUT:
1977                 if (fflags & FREAD) {
1978                         error = ugen_set_timeout(f_rx, addr);
1979                 } else {
1980                         error = EINVAL;
1981                 }
1982                 break;
1983
1984         case USB_SET_TX_TIMEOUT:
1985                 if (fflags & FWRITE) {
1986                         error = ugen_set_timeout(f_tx, addr);
1987                 } else {
1988                         error = EINVAL;
1989                 }
1990                 break;
1991
1992         case USB_GET_RX_FRAME_SIZE:
1993                 if (fflags & FREAD) {
1994                         error = ugen_get_frame_size(f_rx, addr);
1995                 } else {
1996                         error = EINVAL;
1997                 }
1998                 break;
1999
2000         case USB_GET_TX_FRAME_SIZE:
2001                 if (fflags & FWRITE) {
2002                         error = ugen_get_frame_size(f_tx, addr);
2003                 } else {
2004                         error = EINVAL;
2005                 }
2006                 break;
2007
2008         case USB_SET_RX_BUFFER_SIZE:
2009                 if (fflags & FREAD) {
2010                         error = ugen_set_buffer_size(f_rx, addr);
2011                 } else {
2012                         error = EINVAL;
2013                 }
2014                 break;
2015
2016         case USB_SET_TX_BUFFER_SIZE:
2017                 if (fflags & FWRITE) {
2018                         error = ugen_set_buffer_size(f_tx, addr);
2019                 } else {
2020                         error = EINVAL;
2021                 }
2022                 break;
2023
2024         case USB_GET_RX_BUFFER_SIZE:
2025                 if (fflags & FREAD) {
2026                         error = ugen_get_buffer_size(f_rx, addr);
2027                 } else {
2028                         error = EINVAL;
2029                 }
2030                 break;
2031
2032         case USB_GET_TX_BUFFER_SIZE:
2033                 if (fflags & FWRITE) {
2034                         error = ugen_get_buffer_size(f_tx, addr);
2035                 } else {
2036                         error = EINVAL;
2037                 }
2038                 break;
2039
2040         case USB_GET_RX_INTERFACE_DESC:
2041                 if (fflags & FREAD) {
2042                         error = ugen_get_iface_desc(f_rx, addr);
2043                 } else {
2044                         error = EINVAL;
2045                 }
2046                 break;
2047
2048         case USB_GET_TX_INTERFACE_DESC:
2049                 if (fflags & FWRITE) {
2050                         error = ugen_get_iface_desc(f_tx, addr);
2051                 } else {
2052                         error = EINVAL;
2053                 }
2054                 break;
2055
2056         case USB_GET_RX_ENDPOINT_DESC:
2057                 if (fflags & FREAD) {
2058                         error = ugen_get_endpoint_desc(f_rx, addr);
2059                 } else {
2060                         error = EINVAL;
2061                 }
2062                 break;
2063
2064         case USB_GET_TX_ENDPOINT_DESC:
2065                 if (fflags & FWRITE) {
2066                         error = ugen_get_endpoint_desc(f_tx, addr);
2067                 } else {
2068                         error = EINVAL;
2069                 }
2070                 break;
2071
2072         case USB_SET_RX_STALL_FLAG:
2073                 if ((fflags & FREAD) && (*(int *)addr)) {
2074                         f_rx->flag_stall = 1;
2075                 }
2076                 break;
2077
2078         case USB_SET_TX_STALL_FLAG:
2079                 if ((fflags & FWRITE) && (*(int *)addr)) {
2080                         f_tx->flag_stall = 1;
2081                 }
2082                 break;
2083
2084         default:
2085                 error = ENOIOCTL;
2086                 break;
2087         }
2088         return (error);
2089 }
2090
2091 static int
2092 ugen_ioctl_post(struct usb_fifo *f, u_long cmd, void *addr, int fflags)
2093 {
2094         union {
2095                 struct usb_interface_descriptor *idesc;
2096                 struct usb_alt_interface *ai;
2097                 struct usb_device_descriptor *ddesc;
2098                 struct usb_config_descriptor *cdesc;
2099                 struct usb_device_stats *stat;
2100                 struct usb_fs_init *pinit;
2101                 struct usb_fs_uninit *puninit;
2102                 struct usb_device_port_path *dpp;
2103                 uint32_t *ptime;
2104                 void   *addr;
2105                 int    *pint;
2106         }     u;
2107         struct usb_device_descriptor *dtemp;
2108         struct usb_config_descriptor *ctemp;
2109         struct usb_interface *iface;
2110         int error = 0;
2111         uint8_t n;
2112
2113         u.addr = addr;
2114
2115         DPRINTFN(6, "cmd=0x%08lx\n", cmd);
2116
2117         switch (cmd) {
2118         case USB_DISCOVER:
2119                 usb_needs_explore_all();
2120                 break;
2121
2122         case USB_SETDEBUG:
2123                 if (!(fflags & FWRITE)) {
2124                         error = EPERM;
2125                         break;
2126                 }
2127                 usb_debug = *(int *)addr;
2128                 break;
2129
2130         case USB_GET_CONFIG:
2131                 *(int *)addr = f->udev->curr_config_index;
2132                 break;
2133
2134         case USB_SET_CONFIG:
2135                 if (!(fflags & FWRITE)) {
2136                         error = EPERM;
2137                         break;
2138                 }
2139                 error = ugen_set_config(f, *(int *)addr);
2140                 break;
2141
2142         case USB_GET_ALTINTERFACE:
2143                 iface = usbd_get_iface(f->udev,
2144                     u.ai->uai_interface_index);
2145                 if (iface && iface->idesc) {
2146                         u.ai->uai_alt_index = iface->alt_index;
2147                 } else {
2148                         error = EINVAL;
2149                 }
2150                 break;
2151
2152         case USB_SET_ALTINTERFACE:
2153                 if (!(fflags & FWRITE)) {
2154                         error = EPERM;
2155                         break;
2156                 }
2157                 error = ugen_set_interface(f,
2158                     u.ai->uai_interface_index, u.ai->uai_alt_index);
2159                 break;
2160
2161         case USB_GET_DEVICE_DESC:
2162                 dtemp = usbd_get_device_descriptor(f->udev);
2163                 if (!dtemp) {
2164                         error = EIO;
2165                         break;
2166                 }
2167                 *u.ddesc = *dtemp;
2168                 break;
2169
2170         case USB_GET_CONFIG_DESC:
2171                 ctemp = usbd_get_config_descriptor(f->udev);
2172                 if (!ctemp) {
2173                         error = EIO;
2174                         break;
2175                 }
2176                 *u.cdesc = *ctemp;
2177                 break;
2178
2179         case USB_GET_FULL_DESC:
2180                 error = ugen_get_cdesc(f, addr);
2181                 break;
2182
2183         case USB_GET_STRING_DESC:
2184                 error = ugen_get_sdesc(f, addr);
2185                 break;
2186
2187         case USB_GET_IFACE_DRIVER:
2188                 error = ugen_get_iface_driver(f, addr);
2189                 break;
2190
2191         case USB_REQUEST:
2192         case USB_DO_REQUEST:
2193                 if (!(fflags & FWRITE)) {
2194                         error = EPERM;
2195                         break;
2196                 }
2197                 error = ugen_do_request(f, addr);
2198                 break;
2199
2200         case USB_DEVICEINFO:
2201         case USB_GET_DEVICEINFO:
2202                 error = usb_gen_fill_deviceinfo(f, addr);
2203                 break;
2204
2205         case USB_DEVICESTATS:
2206                 for (n = 0; n != 4; n++) {
2207
2208                         u.stat->uds_requests_fail[n] =
2209                             f->udev->bus->stats_err.uds_requests[n];
2210
2211                         u.stat->uds_requests_ok[n] =
2212                             f->udev->bus->stats_ok.uds_requests[n];
2213                 }
2214                 break;
2215
2216         case USB_DEVICEENUMERATE:
2217                 error = ugen_re_enumerate(f);
2218                 break;
2219
2220         case USB_GET_PLUGTIME:
2221                 *u.ptime = f->udev->plugtime;
2222                 break;
2223
2224         case USB_CLAIM_INTERFACE:
2225         case USB_RELEASE_INTERFACE:
2226                 /* TODO */
2227                 break;
2228
2229         case USB_IFACE_DRIVER_ACTIVE:
2230
2231                 n = *u.pint & 0xFF;
2232
2233                 iface = usbd_get_iface(f->udev, n);
2234
2235                 if (iface && iface->subdev)
2236                         error = 0;
2237                 else
2238                         error = ENXIO;
2239                 break;
2240
2241         case USB_IFACE_DRIVER_DETACH:
2242
2243                 error = priv_check(curthread, PRIV_DRIVER);
2244
2245                 if (error)
2246                         break;
2247
2248                 n = *u.pint & 0xFF;
2249
2250                 if (n == USB_IFACE_INDEX_ANY) {
2251                         error = EINVAL;
2252                         break;
2253                 }
2254
2255                 /*
2256                  * Detach the currently attached driver.
2257                  */
2258                 usb_detach_device(f->udev, n, 0);
2259
2260                 /*
2261                  * Set parent to self, this should keep attach away
2262                  * until the next set configuration event.
2263                  */
2264                 usbd_set_parent_iface(f->udev, n, n);
2265                 break;
2266
2267         case USB_SET_POWER_MODE:
2268                 error = ugen_set_power_mode(f, *u.pint);
2269                 break;
2270
2271         case USB_GET_POWER_MODE:
2272                 *u.pint = ugen_get_power_mode(f);
2273                 break;
2274
2275         case USB_GET_DEV_PORT_PATH:
2276                 error = ugen_get_port_path(f, u.dpp);
2277                 break;
2278
2279         case USB_GET_POWER_USAGE:
2280                 *u.pint = ugen_get_power_usage(f);
2281                 break;
2282
2283         case USB_SET_PORT_ENABLE:
2284                 error = ugen_do_port_feature(f,
2285                     *u.pint, 1, UHF_PORT_ENABLE);
2286                 break;
2287
2288         case USB_SET_PORT_DISABLE:
2289                 error = ugen_do_port_feature(f,
2290                     *u.pint, 0, UHF_PORT_ENABLE);
2291                 break;
2292
2293         case USB_FS_INIT:
2294                 /* verify input parameters */
2295                 if (u.pinit->pEndpoints == NULL) {
2296                         error = EINVAL;
2297                         break;
2298                 }
2299                 if (u.pinit->ep_index_max > 127) {
2300                         error = EINVAL;
2301                         break;
2302                 }
2303                 if (u.pinit->ep_index_max == 0) {
2304                         error = EINVAL;
2305                         break;
2306                 }
2307                 if (f->fs_xfer != NULL) {
2308                         error = EBUSY;
2309                         break;
2310                 }
2311                 if (f->dev_ep_index != 0) {
2312                         error = EINVAL;
2313                         break;
2314                 }
2315                 if (ugen_fifo_in_use(f, fflags)) {
2316                         error = EBUSY;
2317                         break;
2318                 }
2319                 error = usb_fifo_alloc_buffer(f, 1, u.pinit->ep_index_max);
2320                 if (error) {
2321                         break;
2322                 }
2323                 f->fs_xfer = malloc(sizeof(f->fs_xfer[0]) *
2324                     u.pinit->ep_index_max, M_USB, M_WAITOK | M_ZERO);
2325                 if (f->fs_xfer == NULL) {
2326                         usb_fifo_free_buffer(f);
2327                         error = ENOMEM;
2328                         break;
2329                 }
2330                 f->fs_ep_max = u.pinit->ep_index_max;
2331                 f->fs_ep_ptr = u.pinit->pEndpoints;
2332                 break;
2333
2334         case USB_FS_UNINIT:
2335                 if (u.puninit->dummy != 0) {
2336                         error = EINVAL;
2337                         break;
2338                 }
2339                 error = ugen_fs_uninit(f);
2340                 break;
2341
2342         default:
2343                 mtx_lock(f->priv_mtx);
2344                 error = ugen_iface_ioctl(f, cmd, addr, fflags);
2345                 mtx_unlock(f->priv_mtx);
2346                 break;
2347         }
2348         DPRINTFN(6, "error=%d\n", error);
2349         return (error);
2350 }
2351
2352 static void
2353 ugen_ctrl_fs_callback(struct usb_xfer *xfer, usb_error_t error)
2354 {
2355         ;                               /* workaround for a bug in "indent" */
2356
2357         DPRINTF("st=%u alen=%u aframes=%u\n",
2358             USB_GET_STATE(xfer), xfer->actlen, xfer->aframes);
2359
2360         switch (USB_GET_STATE(xfer)) {
2361         case USB_ST_SETUP:
2362                 usbd_transfer_submit(xfer);
2363                 break;
2364         default:
2365                 ugen_fs_set_complete(xfer->priv_sc, USB_P2U(xfer->priv_fifo));
2366                 break;
2367         }
2368 }
2369 #endif  /* USB_HAVE_UGEN */