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