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