sys/dev/usb/usb_generic.c

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