sys/bus/u4b/usb_compat_linux.c

   1 /* $FreeBSD$ */
   2 /*-
   3  * Copyright (c) 2007 Luigi Rizzo - Universita` di Pisa. All rights reserved.
   4  * Copyright (c) 2007 Hans Petter Selasky. All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  */
  27
  28 #include <sys/stdint.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/unistd.h>
  41 #include <sys/callout.h>
  42 #include <sys/malloc.h>
  43 #include <sys/priv.h>
  44
  45 #include <bus/u4b/usb.h>
  46 #include <bus/u4b/usb_ioctl.h>
  47 #include <bus/u4b/usbdi.h>
  48 #include <bus/u4b/usbdi_util.h>
  49
  50 #define USB_DEBUG_VAR usb_debug
  51
  52 #include <bus/u4b/usb_core.h>
  53 #include <bus/u4b/usb_compat_linux.h>
  54 #include <bus/u4b/usb_process.h>
  55 #include <bus/u4b/usb_device.h>
  56 #include <bus/u4b/usb_util.h>
  57 #include <bus/u4b/usb_busdma.h>
  58 #include <bus/u4b/usb_transfer.h>
  59 #include <bus/u4b/usb_hub.h>
  60 #include <bus/u4b/usb_request.h>
  61 #include <bus/u4b/usb_debug.h>
  62
  63 struct usb_linux_softc {
  64         LIST_ENTRY(usb_linux_softc) sc_attached_list;
  65
  66         device_t sc_fbsd_dev;
  67         struct usb_device *sc_fbsd_udev;
  68         struct usb_interface *sc_ui;
  69         struct usb_driver *sc_udrv;
  70 };
  71
  72 /* prototypes */
  73 static device_probe_t usb_linux_probe;
  74 static device_attach_t usb_linux_attach;
  75 static device_detach_t usb_linux_detach;
  76 static device_suspend_t usb_linux_suspend;
  77 static device_resume_t usb_linux_resume;
  78
  79 static usb_callback_t usb_linux_isoc_callback;
  80 static usb_callback_t usb_linux_non_isoc_callback;
  81
  82 static usb_complete_t usb_linux_wait_complete;
  83
  84 static uint16_t usb_max_isoc_frames(struct usb_device *);
  85 static int      usb_start_wait_urb(struct urb *, usb_timeout_t, uint16_t *);
  86 static const struct usb_device_id *usb_linux_lookup_id(
  87                     const struct usb_device_id *, struct usb_attach_arg *);
  88 static struct   usb_driver *usb_linux_get_usb_driver(struct usb_linux_softc *);
  89 static int      usb_linux_create_usb_device(struct usb_device *, device_t);
  90 static void     usb_linux_cleanup_interface(struct usb_device *,
  91                     struct usb_interface *);
  92 static void     usb_linux_complete(struct usb_xfer *);
  93 static int      usb_unlink_urb_sub(struct urb *, uint8_t);
  94
  95 /*------------------------------------------------------------------------*
  96  * FreeBSD USB interface
  97  *------------------------------------------------------------------------*/
  98
  99 static LIST_HEAD(, usb_linux_softc) usb_linux_attached_list;
 100 static LIST_HEAD(, usb_driver) usb_linux_driver_list;
 101
 102 static device_method_t usb_linux_methods[] = {
 103         /* Device interface */
 104         DEVMETHOD(device_probe, usb_linux_probe),
 105         DEVMETHOD(device_attach, usb_linux_attach),
 106         DEVMETHOD(device_detach, usb_linux_detach),
 107         DEVMETHOD(device_suspend, usb_linux_suspend),
 108         DEVMETHOD(device_resume, usb_linux_resume),
 109
 110         {0, 0}
 111 };
 112
 113 static driver_t usb_linux_driver = {
 114         .name = "usb_linux",
 115         .methods = usb_linux_methods,
 116         .size = sizeof(struct usb_linux_softc),
 117 };
 118
 119 static devclass_t usb_linux_devclass;
 120
 121 DRIVER_MODULE(usb_linux, uhub, usb_linux_driver, usb_linux_devclass, NULL, 0);
 122 MODULE_VERSION(usb_linux, 1);
 123
 124 /*------------------------------------------------------------------------*
 125  *      usb_linux_lookup_id
 126  *
 127  * This functions takes an array of "struct usb_device_id" and tries
 128  * to match the entries with the information in "struct usb_attach_arg".
 129  * If it finds a match the matching entry will be returned.
 130  * Else "NULL" will be returned.
 131  *------------------------------------------------------------------------*/
 132 static const struct usb_device_id *
 133 usb_linux_lookup_id(const struct usb_device_id *id, struct usb_attach_arg *uaa)
 134 {
 135         if (id == NULL) {
 136                 goto done;
 137         }
 138         /*
 139          * Keep on matching array entries until we find one with
 140          * "match_flags" equal to zero, which indicates the end of the
 141          * array:
 142          */
 143         for (; id->match_flags; id++) {
 144
 145                 if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
 146                     (id->idVendor != uaa->info.idVendor)) {
 147                         continue;
 148                 }
 149                 if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) &&
 150                     (id->idProduct != uaa->info.idProduct)) {
 151                         continue;
 152                 }
 153                 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) &&
 154                     (id->bcdDevice_lo > uaa->info.bcdDevice)) {
 155                         continue;
 156                 }
 157                 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) &&
 158                     (id->bcdDevice_hi < uaa->info.bcdDevice)) {
 159                         continue;
 160                 }
 161                 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) &&
 162                     (id->bDeviceClass != uaa->info.bDeviceClass)) {
 163                         continue;
 164                 }
 165                 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) &&
 166                     (id->bDeviceSubClass != uaa->info.bDeviceSubClass)) {
 167                         continue;
 168                 }
 169                 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) &&
 170                     (id->bDeviceProtocol != uaa->info.bDeviceProtocol)) {
 171                         continue;
 172                 }
 173                 if ((uaa->info.bDeviceClass == 0xFF) &&
 174                     !(id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
 175                     (id->match_flags & (USB_DEVICE_ID_MATCH_INT_CLASS |
 176                     USB_DEVICE_ID_MATCH_INT_SUBCLASS |
 177                     USB_DEVICE_ID_MATCH_INT_PROTOCOL))) {
 178                         continue;
 179                 }
 180                 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) &&
 181                     (id->bInterfaceClass != uaa->info.bInterfaceClass)) {
 182                         continue;
 183                 }
 184                 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) &&
 185                     (id->bInterfaceSubClass != uaa->info.bInterfaceSubClass)) {
 186                         continue;
 187                 }
 188                 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) &&
 189                     (id->bInterfaceProtocol != uaa->info.bInterfaceProtocol)) {
 190                         continue;
 191                 }
 192                 /* we found a match! */
 193                 return (id);
 194         }
 195
 196 done:
 197         return (NULL);
 198 }
 199
 200 /*------------------------------------------------------------------------*
 201  *      usb_linux_probe
 202  *
 203  * This function is the FreeBSD probe callback. It is called from the
 204  * FreeBSD USB stack through the "device_probe_and_attach()" function.
 205  *------------------------------------------------------------------------*/
 206 static int
 207 usb_linux_probe(device_t dev)
 208 {
 209         struct usb_attach_arg *uaa = device_get_ivars(dev);
 210         struct usb_driver *udrv;
 211         int err = ENXIO;
 212
 213         if (uaa->usb_mode != USB_MODE_HOST) {
 214                 return (ENXIO);
 215         }
 216         mtx_lock(&Giant);
 217         LIST_FOREACH(udrv, &usb_linux_driver_list, linux_driver_list) {
 218                 if (usb_linux_lookup_id(udrv->id_table, uaa)) {
 219                         err = 0;
 220                         break;
 221                 }
 222         }
 223         mtx_unlock(&Giant);
 224
 225         return (err);
 226 }
 227
 228 /*------------------------------------------------------------------------*
 229  *      usb_linux_get_usb_driver
 230  *
 231  * This function returns the pointer to the "struct usb_driver" where
 232  * the Linux USB device driver "struct usb_device_id" match was found.
 233  * We apply a lock before reading out the pointer to avoid races.
 234  *------------------------------------------------------------------------*/
 235 static struct usb_driver *
 236 usb_linux_get_usb_driver(struct usb_linux_softc *sc)
 237 {
 238         struct usb_driver *udrv;
 239
 240         mtx_lock(&Giant);
 241         udrv = sc->sc_udrv;
 242         mtx_unlock(&Giant);
 243         return (udrv);
 244 }
 245
 246 /*------------------------------------------------------------------------*
 247  *      usb_linux_attach
 248  *
 249  * This function is the FreeBSD attach callback. It is called from the
 250  * FreeBSD USB stack through the "device_probe_and_attach()" function.
 251  * This function is called when "usb_linux_probe()" returns zero.
 252  *------------------------------------------------------------------------*/
 253 static int
 254 usb_linux_attach(device_t dev)
 255 {
 256         struct usb_attach_arg *uaa = device_get_ivars(dev);
 257         struct usb_linux_softc *sc = device_get_softc(dev);
 258         struct usb_driver *udrv;
 259         const struct usb_device_id *id = NULL;
 260
 261         mtx_lock(&Giant);
 262         LIST_FOREACH(udrv, &usb_linux_driver_list, linux_driver_list) {
 263                 id = usb_linux_lookup_id(udrv->id_table, uaa);
 264                 if (id)
 265                         break;
 266         }
 267         mtx_unlock(&Giant);
 268
 269         if (id == NULL) {
 270                 return (ENXIO);
 271         }
 272         if (usb_linux_create_usb_device(uaa->device, dev) != 0)
 273                 return (ENOMEM);
 274         device_set_usb_desc(dev);
 275
 276         sc->sc_fbsd_udev = uaa->device;
 277         sc->sc_fbsd_dev = dev;
 278         sc->sc_udrv = udrv;
 279         sc->sc_ui = usb_ifnum_to_if(uaa->device, uaa->info.bIfaceNum);
 280         if (sc->sc_ui == NULL) {
 281                 return (EINVAL);
 282         }
 283         if (udrv->probe) {
 284                 if ((udrv->probe) (sc->sc_ui, id)) {
 285                         return (ENXIO);
 286                 }
 287         }
 288         mtx_lock(&Giant);
 289         LIST_INSERT_HEAD(&usb_linux_attached_list, sc, sc_attached_list);
 290         mtx_unlock(&Giant);
 291
 292         /* success */
 293         return (0);
 294 }
 295
 296 /*------------------------------------------------------------------------*
 297  *      usb_linux_detach
 298  *
 299  * This function is the FreeBSD detach callback. It is called from the
 300  * FreeBSD USB stack through the "device_detach()" function.
 301  *------------------------------------------------------------------------*/
 302 static int
 303 usb_linux_detach(device_t dev)
 304 {
 305         struct usb_linux_softc *sc = device_get_softc(dev);
 306         struct usb_driver *udrv = NULL;
 307
 308         mtx_lock(&Giant);
 309         if (sc->sc_attached_list.le_prev) {
 310                 LIST_REMOVE(sc, sc_attached_list);
 311                 sc->sc_attached_list.le_prev = NULL;
 312                 udrv = sc->sc_udrv;
 313                 sc->sc_udrv = NULL;
 314         }
 315         mtx_unlock(&Giant);
 316
 317         if (udrv && udrv->disconnect) {
 318                 (udrv->disconnect) (sc->sc_ui);
 319         }
 320         /*
 321          * Make sure that we free all FreeBSD USB transfers belonging to
 322          * this Linux "usb_interface", hence they will most likely not be
 323          * needed any more.
 324          */
 325         usb_linux_cleanup_interface(sc->sc_fbsd_udev, sc->sc_ui);
 326         return (0);
 327 }
 328
 329 /*------------------------------------------------------------------------*
 330  *      usb_linux_suspend
 331  *
 332  * This function is the FreeBSD suspend callback. Usually it does nothing.
 333  *------------------------------------------------------------------------*/
 334 static int
 335 usb_linux_suspend(device_t dev)
 336 {
 337         struct usb_linux_softc *sc = device_get_softc(dev);
 338         struct usb_driver *udrv = usb_linux_get_usb_driver(sc);
 339         int err;
 340
 341         if (udrv && udrv->suspend) {
 342                 err = (udrv->suspend) (sc->sc_ui, 0);
 343         }
 344         return (0);
 345 }
 346
 347 /*------------------------------------------------------------------------*
 348  *      usb_linux_resume
 349  *
 350  * This function is the FreeBSD resume callback. Usually it does nothing.
 351  *------------------------------------------------------------------------*/
 352 static int
 353 usb_linux_resume(device_t dev)
 354 {
 355         struct usb_linux_softc *sc = device_get_softc(dev);
 356         struct usb_driver *udrv = usb_linux_get_usb_driver(sc);
 357         int err;
 358
 359         if (udrv && udrv->resume) {
 360                 err = (udrv->resume) (sc->sc_ui);
 361         }
 362         return (0);
 363 }
 364
 365 /*------------------------------------------------------------------------*
 366  * Linux emulation layer
 367  *------------------------------------------------------------------------*/
 368
 369 /*------------------------------------------------------------------------*
 370  *      usb_max_isoc_frames
 371  *
 372  * The following function returns the maximum number of isochronous
 373  * frames that we support per URB. It is not part of the Linux USB API.
 374  *------------------------------------------------------------------------*/
 375 static uint16_t
 376 usb_max_isoc_frames(struct usb_device *dev)
 377 {
 378         ;                               /* indent fix */
 379         switch (usbd_get_speed(dev)) {
 380         case USB_SPEED_LOW:
 381         case USB_SPEED_FULL:
 382                 return (USB_MAX_FULL_SPEED_ISOC_FRAMES);
 383         default:
 384                 return (USB_MAX_HIGH_SPEED_ISOC_FRAMES);
 385         }
 386 }
 387
 388 /*------------------------------------------------------------------------*
 389  *      usb_submit_urb
 390  *
 391  * This function is used to queue an URB after that it has been
 392  * initialized. If it returns non-zero, it means that the URB was not
 393  * queued.
 394  *------------------------------------------------------------------------*/
 395 int
 396 usb_submit_urb(struct urb *urb, uint16_t mem_flags)
 397 {
 398         struct usb_host_endpoint *uhe;
 399         uint8_t do_unlock;
 400         int err;
 401
 402         if (urb == NULL)
 403                 return (-EINVAL);
 404
 405         do_unlock = mtx_owned(&Giant) ? 0 : 1;
 406         if (do_unlock)
 407                 mtx_lock(&Giant);
 408
 409         if (urb->endpoint == NULL) {
 410                 err = -EINVAL;
 411                 goto done;
 412         }
 413
 414         /*
 415          * Check to see if the urb is in the process of being killed
 416          * and stop a urb that is in the process of being killed from
 417          * being re-submitted (e.g. from its completion callback
 418          * function).
 419          */
 420         if (urb->kill_count != 0) {
 421                 err = -EPERM;
 422                 goto done;
 423         }
 424
 425         uhe = urb->endpoint;
 426
 427         /*
 428          * Check that we have got a FreeBSD USB transfer that will dequeue
 429          * the URB structure and do the real transfer. If there are no USB
 430          * transfers, then we return an error.
 431          */
 432         if (uhe->bsd_xfer[0] ||
 433             uhe->bsd_xfer[1]) {
 434                 /* we are ready! */
 435
 436                 TAILQ_INSERT_TAIL(&uhe->bsd_urb_list, urb, bsd_urb_list);
 437
 438                 urb->status = -EINPROGRESS;
 439
 440                 usbd_transfer_start(uhe->bsd_xfer[0]);
 441                 usbd_transfer_start(uhe->bsd_xfer[1]);
 442                 err = 0;
 443         } else {
 444                 /* no pipes have been setup yet! */
 445                 urb->status = -EINVAL;
 446                 err = -EINVAL;
 447         }
 448 done:
 449         if (do_unlock)
 450                 mtx_unlock(&Giant);
 451         return (err);
 452 }
 453
 454 /*------------------------------------------------------------------------*
 455  *      usb_unlink_urb
 456  *
 457  * This function is used to stop an URB after that it is been
 458  * submitted, but before the "complete" callback has been called. On
 459  *------------------------------------------------------------------------*/
 460 int
 461 usb_unlink_urb(struct urb *urb)
 462 {
 463         return (usb_unlink_urb_sub(urb, 0));
 464 }
 465
 466 static void
 467 usb_unlink_bsd(struct usb_xfer *xfer,
 468     struct urb *urb, uint8_t drain)
 469 {
 470         if (xfer == NULL)
 471                 return;
 472         if (!usbd_transfer_pending(xfer))
 473                 return;
 474         if (xfer->priv_fifo == (void *)urb) {
 475                 if (drain) {
 476                         mtx_unlock(&Giant);
 477                         usbd_transfer_drain(xfer);
 478                         mtx_lock(&Giant);
 479                 } else {
 480                         usbd_transfer_stop(xfer);
 481                 }
 482                 usbd_transfer_start(xfer);
 483         }
 484 }
 485
 486 static int
 487 usb_unlink_urb_sub(struct urb *urb, uint8_t drain)
 488 {
 489         struct usb_host_endpoint *uhe;
 490         uint16_t x;
 491         uint8_t do_unlock;
 492         int err;
 493
 494         if (urb == NULL)
 495                 return (-EINVAL);
 496
 497         do_unlock = mtx_owned(&Giant) ? 0 : 1;
 498         if (do_unlock)
 499                 mtx_lock(&Giant);
 500         if (drain)
 501                 urb->kill_count++;
 502
 503         if (urb->endpoint == NULL) {
 504                 err = -EINVAL;
 505                 goto done;
 506         }
 507         uhe = urb->endpoint;
 508
 509         if (urb->bsd_urb_list.tqe_prev) {
 510
 511                 /* not started yet, just remove it from the queue */
 512                 TAILQ_REMOVE(&uhe->bsd_urb_list, urb, bsd_urb_list);
 513                 urb->bsd_urb_list.tqe_prev = NULL;
 514                 urb->status = -ECONNRESET;
 515                 urb->actual_length = 0;
 516
 517                 for (x = 0; x < urb->number_of_packets; x++) {
 518                         urb->iso_frame_desc[x].actual_length = 0;
 519                 }
 520
 521                 if (urb->complete) {
 522                         (urb->complete) (urb);
 523                 }
 524         } else {
 525
 526                 /*
 527                  * If the URB is not on the URB list, then check if one of
 528                  * the FreeBSD USB transfer are processing the current URB.
 529                  * If so, re-start that transfer, which will lead to the
 530                  * termination of that URB:
 531                  */
 532                 usb_unlink_bsd(uhe->bsd_xfer[0], urb, drain);
 533                 usb_unlink_bsd(uhe->bsd_xfer[1], urb, drain);
 534         }
 535         err = 0;
 536 done:
 537         if (drain)
 538                 urb->kill_count--;
 539         if (do_unlock)
 540                 mtx_unlock(&Giant);
 541         return (err);
 542 }
 543
 544 /*------------------------------------------------------------------------*
 545  *      usb_clear_halt
 546  *
 547  * This function must always be used to clear the stall. Stall is when
 548  * an USB endpoint returns a stall message to the USB host controller.
 549  * Until the stall is cleared, no data can be transferred.
 550  *------------------------------------------------------------------------*/
 551 int
 552 usb_clear_halt(struct usb_device *dev, struct usb_host_endpoint *uhe)
 553 {
 554         struct usb_config cfg[1];
 555         struct usb_endpoint *ep;
 556         uint8_t type;
 557         uint8_t addr;
 558
 559         if (uhe == NULL)
 560                 return (-EINVAL);
 561
 562         type = uhe->desc.bmAttributes & UE_XFERTYPE;
 563         addr = uhe->desc.bEndpointAddress;
 564
 565         memset(cfg, 0, sizeof(cfg));
 566
 567         cfg[0].type = type;
 568         cfg[0].endpoint = addr & UE_ADDR;
 569         cfg[0].direction = addr & (UE_DIR_OUT | UE_DIR_IN);
 570
 571         ep = usbd_get_endpoint(dev, uhe->bsd_iface_index, cfg);
 572         if (ep == NULL)
 573                 return (-EINVAL);
 574
 575         usbd_clear_data_toggle(dev, ep);
 576
 577         return (usb_control_msg(dev, &dev->ep0,
 578             UR_CLEAR_FEATURE, UT_WRITE_ENDPOINT,
 579             UF_ENDPOINT_HALT, addr, NULL, 0, 1000));
 580 }
 581
 582 /*------------------------------------------------------------------------*
 583  *      usb_start_wait_urb
 584  *
 585  * This is an internal function that is used to perform synchronous
 586  * Linux USB transfers.
 587  *------------------------------------------------------------------------*/
 588 static int
 589 usb_start_wait_urb(struct urb *urb, usb_timeout_t timeout, uint16_t *p_actlen)
 590 {
 591         int err;
 592         uint8_t do_unlock;
 593
 594         /* you must have a timeout! */
 595         if (timeout == 0) {
 596                 timeout = 1;
 597         }
 598         urb->complete = &usb_linux_wait_complete;
 599         urb->timeout = timeout;
 600         urb->transfer_flags |= URB_WAIT_WAKEUP;
 601         urb->transfer_flags &= ~URB_IS_SLEEPING;
 602
 603         do_unlock = mtx_owned(&Giant) ? 0 : 1;
 604         if (do_unlock)
 605                 mtx_lock(&Giant);
 606         err = usb_submit_urb(urb, 0);
 607         if (err)
 608                 goto done;
 609
 610         /*
 611          * the URB might have completed before we get here, so check that by
 612          * using some flags!
 613          */
 614         while (urb->transfer_flags & URB_WAIT_WAKEUP) {
 615                 urb->transfer_flags |= URB_IS_SLEEPING;
 616                 cv_wait(&urb->cv_wait, &Giant);
 617                 urb->transfer_flags &= ~URB_IS_SLEEPING;
 618         }
 619
 620         err = urb->status;
 621
 622 done:
 623         if (do_unlock)
 624                 mtx_unlock(&Giant);
 625         if (p_actlen != NULL) {
 626                 if (err)
 627                         *p_actlen = 0;
 628                 else
 629                         *p_actlen = urb->actual_length;
 630         }
 631         return (err);
 632 }
 633
 634 /*------------------------------------------------------------------------*
 635  *      usb_control_msg
 636  *
 637  * The following function performs a control transfer sequence one any
 638  * control, bulk or interrupt endpoint, specified by "uhe". A control
 639  * transfer means that you transfer an 8-byte header first followed by
 640  * a data-phase as indicated by the 8-byte header. The "timeout" is
 641  * given in milliseconds.
 642  *
 643  * Return values:
 644  *   0: Success
 645  * < 0: Failure
 646  * > 0: Acutal length
 647  *------------------------------------------------------------------------*/
 648 int
 649 usb_control_msg(struct usb_device *dev, struct usb_host_endpoint *uhe,
 650     uint8_t request, uint8_t requesttype,
 651     uint16_t value, uint16_t index, void *data,
 652     uint16_t size, usb_timeout_t timeout)
 653 {
 654         struct usb_device_request req;
 655         struct urb *urb;
 656         int err;
 657         uint16_t actlen;
 658         uint8_t type;
 659         uint8_t addr;
 660
 661         req.bmRequestType = requesttype;
 662         req.bRequest = request;
 663         USETW(req.wValue, value);
 664         USETW(req.wIndex, index);
 665         USETW(req.wLength, size);
 666
 667         if (uhe == NULL) {
 668                 return (-EINVAL);
 669         }
 670         type = (uhe->desc.bmAttributes & UE_XFERTYPE);
 671         addr = (uhe->desc.bEndpointAddress & UE_ADDR);
 672
 673         if (type != UE_CONTROL) {
 674                 return (-EINVAL);
 675         }
 676         if (addr == 0) {
 677                 /*
 678                  * The FreeBSD USB stack supports standard control
 679                  * transfers on control endpoint zero:
 680                  */
 681                 err = usbd_do_request_flags(dev,
 682                     NULL, &req, data, USB_SHORT_XFER_OK,
 683                     &actlen, timeout);
 684                 if (err) {
 685                         err = -EPIPE;
 686                 } else {
 687                         err = actlen;
 688                 }
 689                 return (err);
 690         }
 691         if (dev->flags.usb_mode != USB_MODE_HOST) {
 692                 /* not supported */
 693                 return (-EINVAL);
 694         }
 695         err = usb_setup_endpoint(dev, uhe, 1 /* dummy */ );
 696
 697         /*
 698          * NOTE: we need to allocate real memory here so that we don't
 699          * transfer data to/from the stack!
 700          *
 701          * 0xFFFF is a FreeBSD specific magic value.
 702          */
 703         urb = usb_alloc_urb(0xFFFF, size);
 704         if (urb == NULL)
 705                 return (-ENOMEM);
 706
 707         urb->dev = dev;
 708         urb->endpoint = uhe;
 709
 710         memcpy(urb->setup_packet, &req, sizeof(req));
 711
 712         if (size && (!(req.bmRequestType & UT_READ))) {
 713                 /* move the data to a real buffer */
 714                 memcpy(USB_ADD_BYTES(urb->setup_packet, sizeof(req)),
 715                     data, size);
 716         }
 717         err = usb_start_wait_urb(urb, timeout, &actlen);
 718
 719         if (req.bmRequestType & UT_READ) {
 720                 if (actlen) {
 721                         bcopy(USB_ADD_BYTES(urb->setup_packet,
 722                             sizeof(req)), data, actlen);
 723                 }
 724         }
 725         usb_free_urb(urb);
 726
 727         if (err == 0) {
 728                 err = actlen;
 729         }
 730         return (err);
 731 }
 732
 733 /*------------------------------------------------------------------------*
 734  *      usb_set_interface
 735  *
 736  * The following function will select which alternate setting of an
 737  * USB interface you plan to use. By default alternate setting with
 738  * index zero is selected. Note that "iface_no" is not the interface
 739  * index, but rather the value of "bInterfaceNumber".
 740  *------------------------------------------------------------------------*/
 741 int
 742 usb_set_interface(struct usb_device *dev, uint8_t iface_no, uint8_t alt_index)
 743 {
 744         struct usb_interface *p_ui = usb_ifnum_to_if(dev, iface_no);
 745         int err;
 746
 747         if (p_ui == NULL)
 748                 return (-EINVAL);
 749         if (alt_index >= p_ui->num_altsetting)
 750                 return (-EINVAL);
 751         usb_linux_cleanup_interface(dev, p_ui);
 752         err = -usbd_set_alt_interface_index(dev,
 753             p_ui->bsd_iface_index, alt_index);
 754         if (err == 0) {
 755                 p_ui->cur_altsetting = p_ui->altsetting + alt_index;
 756         }
 757         return (err);
 758 }
 759
 760 /*------------------------------------------------------------------------*
 761  *      usb_setup_endpoint
 762  *
 763  * The following function is an extension to the Linux USB API that
 764  * allows you to set a maximum buffer size for a given USB endpoint.
 765  * The maximum buffer size is per URB. If you don't call this function
 766  * to set a maximum buffer size, the endpoint will not be functional.
 767  * Note that for isochronous endpoints the maximum buffer size must be
 768  * a non-zero dummy, hence this function will base the maximum buffer
 769  * size on "wMaxPacketSize".
 770  *------------------------------------------------------------------------*/
 771 int
 772 usb_setup_endpoint(struct usb_device *dev,
 773     struct usb_host_endpoint *uhe, usb_size_t bufsize)
 774 {
 775         struct usb_config cfg[2];
 776         uint8_t type = uhe->desc.bmAttributes & UE_XFERTYPE;
 777         uint8_t addr = uhe->desc.bEndpointAddress;
 778
 779         if (uhe->fbsd_buf_size == bufsize) {
 780                 /* optimize */
 781                 return (0);
 782         }
 783         usbd_transfer_unsetup(uhe->bsd_xfer, 2);
 784
 785         uhe->fbsd_buf_size = bufsize;
 786
 787         if (bufsize == 0) {
 788                 return (0);
 789         }
 790         memset(cfg, 0, sizeof(cfg));
 791
 792         if (type == UE_ISOCHRONOUS) {
 793
 794                 /*
 795                  * Isochronous transfers are special in that they don't fit
 796                  * into the BULK/INTR/CONTROL transfer model.
 797                  */
 798
 799                 cfg[0].type = type;
 800                 cfg[0].endpoint = addr & UE_ADDR;
 801                 cfg[0].direction = addr & (UE_DIR_OUT | UE_DIR_IN);
 802                 cfg[0].callback = &usb_linux_isoc_callback;
 803                 cfg[0].bufsize = 0;     /* use wMaxPacketSize */
 804                 cfg[0].frames = usb_max_isoc_frames(dev);
 805                 cfg[0].flags.proxy_buffer = 1;
 806 #if 0
 807                 /*
 808                  * The Linux USB API allows non back-to-back
 809                  * isochronous frames which we do not support. If the
 810                  * isochronous frames are not back-to-back we need to
 811                  * do a copy, and then we need a buffer for
 812                  * that. Enable this at your own risk.
 813                  */
 814                 cfg[0].flags.ext_buffer = 1;
 815 #endif
 816                 cfg[0].flags.short_xfer_ok = 1;
 817
 818                 bcopy(cfg, cfg + 1, sizeof(*cfg));
 819
 820                 /* Allocate and setup two generic FreeBSD USB transfers */
 821
 822                 if (usbd_transfer_setup(dev, &uhe->bsd_iface_index,
 823                     uhe->bsd_xfer, cfg, 2, uhe, &Giant)) {
 824                         return (-EINVAL);
 825                 }
 826         } else {
 827                 if (bufsize > (1 << 22)) {
 828                         /* limit buffer size */
 829                         bufsize = (1 << 22);
 830                 }
 831                 /* Allocate and setup one generic FreeBSD USB transfer */
 832
 833                 cfg[0].type = type;
 834                 cfg[0].endpoint = addr & UE_ADDR;
 835                 cfg[0].direction = addr & (UE_DIR_OUT | UE_DIR_IN);
 836                 cfg[0].callback = &usb_linux_non_isoc_callback;
 837                 cfg[0].bufsize = bufsize;
 838                 cfg[0].flags.ext_buffer = 1;    /* enable zero-copy */
 839                 cfg[0].flags.proxy_buffer = 1;
 840                 cfg[0].flags.short_xfer_ok = 1;
 841
 842                 if (usbd_transfer_setup(dev, &uhe->bsd_iface_index,
 843                     uhe->bsd_xfer, cfg, 1, uhe, &Giant)) {
 844                         return (-EINVAL);
 845                 }
 846         }
 847         return (0);
 848 }
 849
 850 /*------------------------------------------------------------------------*
 851  *      usb_linux_create_usb_device
 852  *
 853  * The following function is used to build up a per USB device
 854  * structure tree, that mimics the Linux one. The root structure
 855  * is returned by this function.
 856  *------------------------------------------------------------------------*/
 857 static int
 858 usb_linux_create_usb_device(struct usb_device *udev, device_t dev)
 859 {
 860         struct usb_config_descriptor *cd = usbd_get_config_descriptor(udev);
 861         struct usb_descriptor *desc;
 862         struct usb_interface_descriptor *id;
 863         struct usb_endpoint_descriptor *ed;
 864         struct usb_interface *p_ui = NULL;
 865         struct usb_host_interface *p_uhi = NULL;
 866         struct usb_host_endpoint *p_uhe = NULL;
 867         usb_size_t size;
 868         uint16_t niface_total;
 869         uint16_t nedesc;
 870         uint16_t iface_no_curr;
 871         uint16_t iface_index;
 872         uint8_t pass;
 873         uint8_t iface_no;
 874
 875         /*
 876          * We do two passes. One pass for computing necessary memory size
 877          * and one pass to initialize all the allocated memory structures.
 878          */
 879         for (pass = 0; pass < 2; pass++) {
 880
 881                 iface_no_curr = 0 - 1;
 882                 niface_total = 0;
 883                 iface_index = 0;
 884                 nedesc = 0;
 885                 desc = NULL;
 886
 887                 /*
 888                  * Iterate over all the USB descriptors. Use the USB config
 889                  * descriptor pointer provided by the FreeBSD USB stack.
 890                  */
 891                 while ((desc = usb_desc_foreach(cd, desc))) {
 892
 893                         /*
 894                          * Build up a tree according to the descriptors we
 895                          * find:
 896                          */
 897                         switch (desc->bDescriptorType) {
 898                         case UDESC_DEVICE:
 899                                 break;
 900
 901                         case UDESC_ENDPOINT:
 902                                 ed = (void *)desc;
 903                                 if ((ed->bLength < sizeof(*ed)) ||
 904                                     (iface_index == 0))
 905                                         break;
 906                                 if (p_uhe) {
 907                                         bcopy(ed, &p_uhe->desc, sizeof(p_uhe->desc));
 908                                         p_uhe->bsd_iface_index = iface_index - 1;
 909                                         TAILQ_INIT(&p_uhe->bsd_urb_list);
 910                                         p_uhe++;
 911                                 }
 912                                 if (p_uhi) {
 913                                         (p_uhi - 1)->desc.bNumEndpoints++;
 914                                 }
 915                                 nedesc++;
 916                                 break;
 917
 918                         case UDESC_INTERFACE:
 919                                 id = (void *)desc;
 920                                 if (id->bLength < sizeof(*id))
 921                                         break;
 922                                 if (p_uhi) {
 923                                         bcopy(id, &p_uhi->desc, sizeof(p_uhi->desc));
 924                                         p_uhi->desc.bNumEndpoints = 0;
 925                                         p_uhi->endpoint = p_uhe;
 926                                         p_uhi->string = "";
 927                                         p_uhi->bsd_iface_index = iface_index;
 928                                         p_uhi++;
 929                                 }
 930                                 iface_no = id->bInterfaceNumber;
 931                                 niface_total++;
 932                                 if (iface_no_curr != iface_no) {
 933                                         if (p_ui) {
 934                                                 p_ui->altsetting = p_uhi - 1;
 935                                                 p_ui->cur_altsetting = p_uhi - 1;
 936                                                 p_ui->num_altsetting = 1;
 937                                                 p_ui->bsd_iface_index = iface_index;
 938                                                 p_ui->linux_udev = udev;
 939                                                 p_ui++;
 940                                         }
 941                                         iface_no_curr = iface_no;
 942                                         iface_index++;
 943                                 } else {
 944                                         if (p_ui) {
 945                                                 (p_ui - 1)->num_altsetting++;
 946                                         }
 947                                 }
 948                                 break;
 949
 950                         default:
 951                                 break;
 952                         }
 953                 }
 954
 955                 if (pass == 0) {
 956
 957                         size = (sizeof(*p_uhe) * nedesc) +
 958                             (sizeof(*p_ui) * iface_index) +
 959                             (sizeof(*p_uhi) * niface_total);
 960
 961                         p_uhe = malloc(size, M_USBDEV, M_WAITOK | M_ZERO);
 962                         p_ui = (void *)(p_uhe + nedesc);
 963                         p_uhi = (void *)(p_ui + iface_index);
 964
 965                         udev->linux_iface_start = p_ui;
 966                         udev->linux_iface_end = p_ui + iface_index;
 967                         udev->linux_endpoint_start = p_uhe;
 968                         udev->linux_endpoint_end = p_uhe + nedesc;
 969                         udev->devnum = device_get_unit(dev);
 970                         bcopy(&udev->ddesc, &udev->descriptor,
 971                             sizeof(udev->descriptor));
 972                         bcopy(udev->ctrl_ep.edesc, &udev->ep0.desc,
 973                             sizeof(udev->ep0.desc));
 974                 }
 975         }
 976         return (0);
 977 }
 978
 979 /*------------------------------------------------------------------------*
 980  *      usb_alloc_urb
 981  *
 982  * This function should always be used when you allocate an URB for
 983  * use with the USB Linux stack. In case of an isochronous transfer
 984  * you must specifiy the maximum number of "iso_packets" which you
 985  * plan to transfer per URB. This function is always blocking, and
 986  * "mem_flags" are not regarded like on Linux.
 987  *------------------------------------------------------------------------*/
 988 struct urb *
 989 usb_alloc_urb(uint16_t iso_packets, uint16_t mem_flags)
 990 {
 991         struct urb *urb;
 992         usb_size_t size;
 993
 994         if (iso_packets == 0xFFFF) {
 995                 /*
 996                  * FreeBSD specific magic value to ask for control transfer
 997                  * memory allocation:
 998                  */
 999                 size = sizeof(*urb) + sizeof(struct usb_device_request) + mem_flags;
1000         } else {
1001                 size = sizeof(*urb) + (iso_packets * sizeof(urb->iso_frame_desc[0]));
1002         }
1003
1004         urb = malloc(size, M_USBDEV, M_WAITOK | M_ZERO);
1005         if (urb) {
1006
1007                 cv_init(&urb->cv_wait, "URBWAIT");
1008                 if (iso_packets == 0xFFFF) {
1009                         urb->setup_packet = (void *)(urb + 1);
1010                         urb->transfer_buffer = (void *)(urb->setup_packet +
1011                             sizeof(struct usb_device_request));
1012                 } else {
1013                         urb->number_of_packets = iso_packets;
1014                 }
1015         }
1016         return (urb);
1017 }
1018
1019 /*------------------------------------------------------------------------*
1020  *      usb_find_host_endpoint
1021  *
1022  * The following function will return the Linux USB host endpoint
1023  * structure that matches the given endpoint type and endpoint
1024  * value. If no match is found, NULL is returned. This function is not
1025  * part of the Linux USB API and is only used internally.
1026  *------------------------------------------------------------------------*/
1027 struct usb_host_endpoint *
1028 usb_find_host_endpoint(struct usb_device *dev, uint8_t type, uint8_t ep)
1029 {
1030         struct usb_host_endpoint *uhe;
1031         struct usb_host_endpoint *uhe_end;
1032         struct usb_host_interface *uhi;
1033         struct usb_interface *ui;
1034         uint8_t ea;
1035         uint8_t at;
1036         uint8_t mask;
1037
1038         if (dev == NULL) {
1039                 return (NULL);
1040         }
1041         if (type == UE_CONTROL) {
1042                 mask = UE_ADDR;
1043         } else {
1044                 mask = (UE_DIR_IN | UE_DIR_OUT | UE_ADDR);
1045         }
1046
1047         ep &= mask;
1048
1049         /*
1050          * Iterate over all the interfaces searching the selected alternate
1051          * setting only, and all belonging endpoints.
1052          */
1053         for (ui = dev->linux_iface_start;
1054             ui != dev->linux_iface_end;
1055             ui++) {
1056                 uhi = ui->cur_altsetting;
1057                 if (uhi) {
1058                         uhe_end = uhi->endpoint + uhi->desc.bNumEndpoints;
1059                         for (uhe = uhi->endpoint;
1060                             uhe != uhe_end;
1061                             uhe++) {
1062                                 ea = uhe->desc.bEndpointAddress;
1063                                 at = uhe->desc.bmAttributes;
1064
1065                                 if (((ea & mask) == ep) &&
1066                                     ((at & UE_XFERTYPE) == type)) {
1067                                         return (uhe);
1068                                 }
1069                         }
1070                 }
1071         }
1072
1073         if ((type == UE_CONTROL) && ((ep & UE_ADDR) == 0)) {
1074                 return (&dev->ep0);
1075         }
1076         return (NULL);
1077 }
1078
1079 /*------------------------------------------------------------------------*
1080  *      usb_altnum_to_altsetting
1081  *
1082  * The following function returns a pointer to an alternate setting by
1083  * index given a "usb_interface" pointer. If the alternate setting by
1084  * index does not exist, NULL is returned. And alternate setting is a
1085  * variant of an interface, but usually with slightly different
1086  * characteristics.
1087  *------------------------------------------------------------------------*/
1088 struct usb_host_interface *
1089 usb_altnum_to_altsetting(const struct usb_interface *intf, uint8_t alt_index)
1090 {
1091         if (alt_index >= intf->num_altsetting) {
1092                 return (NULL);
1093         }
1094         return (intf->altsetting + alt_index);
1095 }
1096
1097 /*------------------------------------------------------------------------*
1098  *      usb_ifnum_to_if
1099  *
1100  * The following function searches up an USB interface by
1101  * "bInterfaceNumber". If no match is found, NULL is returned.
1102  *------------------------------------------------------------------------*/
1103 struct usb_interface *
1104 usb_ifnum_to_if(struct usb_device *dev, uint8_t iface_no)
1105 {
1106         struct usb_interface *p_ui;
1107
1108         for (p_ui = dev->linux_iface_start;
1109             p_ui != dev->linux_iface_end;
1110             p_ui++) {
1111                 if ((p_ui->num_altsetting > 0) &&
1112                     (p_ui->altsetting->desc.bInterfaceNumber == iface_no)) {
1113                         return (p_ui);
1114                 }
1115         }
1116         return (NULL);
1117 }
1118
1119 /*------------------------------------------------------------------------*
1120  *      usb_buffer_alloc
1121  *------------------------------------------------------------------------*/
1122 void   *
1123 usb_buffer_alloc(struct usb_device *dev, usb_size_t size, uint16_t mem_flags, uint8_t *dma_addr)
1124 {
1125         return (malloc(size, M_USBDEV, M_WAITOK | M_ZERO));
1126 }
1127
1128 /*------------------------------------------------------------------------*
1129  *      usbd_get_intfdata
1130  *------------------------------------------------------------------------*/
1131 void   *
1132 usbd_get_intfdata(struct usb_interface *intf)
1133 {
1134         return (intf->bsd_priv_sc);
1135 }
1136
1137 /*------------------------------------------------------------------------*
1138  *      usb_linux_register
1139  *
1140  * The following function is used by the "USB_DRIVER_EXPORT()" macro,
1141  * and is used to register a Linux USB driver, so that its
1142  * "usb_device_id" structures gets searched a probe time. This
1143  * function is not part of the Linux USB API, and is for internal use
1144  * only.
1145  *------------------------------------------------------------------------*/
1146 void
1147 usb_linux_register(void *arg)
1148 {
1149         struct usb_driver *drv = arg;
1150
1151         mtx_lock(&Giant);
1152         LIST_INSERT_HEAD(&usb_linux_driver_list, drv, linux_driver_list);
1153         mtx_unlock(&Giant);
1154
1155         usb_needs_explore_all();
1156 }
1157
1158 /*------------------------------------------------------------------------*
1159  *      usb_linux_deregister
1160  *
1161  * The following function is used by the "USB_DRIVER_EXPORT()" macro,
1162  * and is used to deregister a Linux USB driver. This function will
1163  * ensure that all driver instances belonging to the Linux USB device
1164  * driver in question, gets detached before the driver is
1165  * unloaded. This function is not part of the Linux USB API, and is
1166  * for internal use only.
1167  *------------------------------------------------------------------------*/
1168 void
1169 usb_linux_deregister(void *arg)
1170 {
1171         struct usb_driver *drv = arg;
1172         struct usb_linux_softc *sc;
1173
1174 repeat:
1175         mtx_lock(&Giant);
1176         LIST_FOREACH(sc, &usb_linux_attached_list, sc_attached_list) {
1177                 if (sc->sc_udrv == drv) {
1178                         mtx_unlock(&Giant);
1179                         device_detach(sc->sc_fbsd_dev);
1180                         goto repeat;
1181                 }
1182         }
1183         LIST_REMOVE(drv, linux_driver_list);
1184         mtx_unlock(&Giant);
1185 }
1186
1187 /*------------------------------------------------------------------------*
1188  *      usb_linux_free_device
1189  *
1190  * The following function is only used by the FreeBSD USB stack, to
1191  * cleanup and free memory after that a Linux USB device was attached.
1192  *------------------------------------------------------------------------*/
1193 void
1194 usb_linux_free_device(struct usb_device *dev)
1195 {
1196         struct usb_host_endpoint *uhe;
1197         struct usb_host_endpoint *uhe_end;
1198         int err;
1199
1200         uhe = dev->linux_endpoint_start;
1201         uhe_end = dev->linux_endpoint_end;
1202         while (uhe != uhe_end) {
1203                 err = usb_setup_endpoint(dev, uhe, 0);
1204                 uhe++;
1205         }
1206         err = usb_setup_endpoint(dev, &dev->ep0, 0);
1207         free(dev->linux_endpoint_start, M_USBDEV);
1208 }
1209
1210 /*------------------------------------------------------------------------*
1211  *      usb_buffer_free
1212  *------------------------------------------------------------------------*/
1213 void
1214 usb_buffer_free(struct usb_device *dev, usb_size_t size,
1215     void *addr, uint8_t dma_addr)
1216 {
1217         free(addr, M_USBDEV);
1218 }
1219
1220 /*------------------------------------------------------------------------*
1221  *      usb_free_urb
1222  *------------------------------------------------------------------------*/
1223 void
1224 usb_free_urb(struct urb *urb)
1225 {
1226         if (urb == NULL) {
1227                 return;
1228         }
1229         /* make sure that the current URB is not active */
1230         usb_kill_urb(urb);
1231
1232         /* destroy condition variable */
1233         cv_destroy(&urb->cv_wait);
1234
1235         /* just free it */
1236         free(urb, M_USBDEV);
1237 }
1238
1239 /*------------------------------------------------------------------------*
1240  *      usb_init_urb
1241  *
1242  * The following function can be used to initialize a custom URB. It
1243  * is not recommended to use this function. Use "usb_alloc_urb()"
1244  * instead.
1245  *------------------------------------------------------------------------*/
1246 void
1247 usb_init_urb(struct urb *urb)
1248 {
1249         if (urb == NULL) {
1250                 return;
1251         }
1252         memset(urb, 0, sizeof(*urb));
1253 }
1254
1255 /*------------------------------------------------------------------------*
1256  *      usb_kill_urb
1257  *------------------------------------------------------------------------*/
1258 void
1259 usb_kill_urb(struct urb *urb)
1260 {
1261         usb_unlink_urb_sub(urb, 1);
1262 }
1263
1264 /*------------------------------------------------------------------------*
1265  *      usb_set_intfdata
1266  *
1267  * The following function sets the per Linux USB interface private
1268  * data pointer. It is used by most Linux USB device drivers.
1269  *------------------------------------------------------------------------*/
1270 void
1271 usb_set_intfdata(struct usb_interface *intf, void *data)
1272 {
1273         intf->bsd_priv_sc = data;
1274 }
1275
1276 /*------------------------------------------------------------------------*
1277  *      usb_linux_cleanup_interface
1278  *
1279  * The following function will release all FreeBSD USB transfers
1280  * associated with a Linux USB interface. It is for internal use only.
1281  *------------------------------------------------------------------------*/
1282 static void
1283 usb_linux_cleanup_interface(struct usb_device *dev, struct usb_interface *iface)
1284 {
1285         struct usb_host_interface *uhi;
1286         struct usb_host_interface *uhi_end;
1287         struct usb_host_endpoint *uhe;
1288         struct usb_host_endpoint *uhe_end;
1289         int err;
1290
1291         uhi = iface->altsetting;
1292         uhi_end = iface->altsetting + iface->num_altsetting;
1293         while (uhi != uhi_end) {
1294                 uhe = uhi->endpoint;
1295                 uhe_end = uhi->endpoint + uhi->desc.bNumEndpoints;
1296                 while (uhe != uhe_end) {
1297                         err = usb_setup_endpoint(dev, uhe, 0);
1298                         uhe++;
1299                 }
1300                 uhi++;
1301         }
1302 }
1303
1304 /*------------------------------------------------------------------------*
1305  *      usb_linux_wait_complete
1306  *
1307  * The following function is used by "usb_start_wait_urb()" to wake it
1308  * up, when an USB transfer has finished.
1309  *------------------------------------------------------------------------*/
1310 static void
1311 usb_linux_wait_complete(struct urb *urb)
1312 {
1313         if (urb->transfer_flags & URB_IS_SLEEPING) {
1314                 cv_signal(&urb->cv_wait);
1315         }
1316         urb->transfer_flags &= ~URB_WAIT_WAKEUP;
1317 }
1318
1319 /*------------------------------------------------------------------------*
1320  *      usb_linux_complete
1321  *------------------------------------------------------------------------*/
1322 static void
1323 usb_linux_complete(struct usb_xfer *xfer)
1324 {
1325         struct urb *urb;
1326
1327         urb = usbd_xfer_get_priv(xfer);
1328         usbd_xfer_set_priv(xfer, NULL);
1329         if (urb->complete) {
1330                 (urb->complete) (urb);
1331         }
1332 }
1333
1334 /*------------------------------------------------------------------------*
1335  *      usb_linux_isoc_callback
1336  *
1337  * The following is the FreeBSD isochronous USB callback. Isochronous
1338  * frames are USB packets transferred 1000 or 8000 times per second,
1339  * depending on whether a full- or high- speed USB transfer is
1340  * used.
1341  *------------------------------------------------------------------------*/
1342 static void
1343 usb_linux_isoc_callback(struct usb_xfer *xfer, usb_error_t error)
1344 {
1345         usb_frlength_t max_frame = xfer->max_frame_size;
1346         usb_frlength_t offset;
1347         usb_frcount_t x;
1348         struct urb *urb = usbd_xfer_get_priv(xfer);
1349         struct usb_host_endpoint *uhe = usbd_xfer_softc(xfer);
1350         struct usb_iso_packet_descriptor *uipd;
1351
1352         DPRINTF("\n");
1353
1354         switch (USB_GET_STATE(xfer)) {
1355         case USB_ST_TRANSFERRED:
1356
1357                 if (urb->bsd_isread) {
1358
1359                         /* copy in data with regard to the URB */
1360
1361                         offset = 0;
1362
1363                         for (x = 0; x < urb->number_of_packets; x++) {
1364                                 uipd = urb->iso_frame_desc + x;
1365                                 if (uipd->length > xfer->frlengths[x]) {
1366                                         if (urb->transfer_flags & URB_SHORT_NOT_OK) {
1367                                                 /* XXX should be EREMOTEIO */
1368                                                 uipd->status = -EPIPE;
1369                                         } else {
1370                                                 uipd->status = 0;
1371                                         }
1372                                 } else {
1373                                         uipd->status = 0;
1374                                 }
1375                                 uipd->actual_length = xfer->frlengths[x];
1376                                 if (!xfer->flags.ext_buffer) {
1377                                         usbd_copy_out(xfer->frbuffers, offset,
1378                                             USB_ADD_BYTES(urb->transfer_buffer,
1379                                             uipd->offset), uipd->actual_length);
1380                                 }
1381                                 offset += max_frame;
1382                         }
1383                 } else {
1384                         for (x = 0; x < urb->number_of_packets; x++) {
1385                                 uipd = urb->iso_frame_desc + x;
1386                                 uipd->actual_length = xfer->frlengths[x];
1387                                 uipd->status = 0;
1388                         }
1389                 }
1390
1391                 urb->actual_length = xfer->actlen;
1392
1393                 /* check for short transfer */
1394                 if (xfer->actlen < xfer->sumlen) {
1395                         /* short transfer */
1396                         if (urb->transfer_flags & URB_SHORT_NOT_OK) {
1397                                 /* XXX should be EREMOTEIO */
1398                                 urb->status = -EPIPE;
1399                         } else {
1400                                 urb->status = 0;
1401                         }
1402                 } else {
1403                         /* success */
1404                         urb->status = 0;
1405                 }
1406
1407                 /* call callback */
1408                 usb_linux_complete(xfer);
1409
1410         case USB_ST_SETUP:
1411 tr_setup:
1412
1413                 if (xfer->priv_fifo == NULL) {
1414
1415                         /* get next transfer */
1416                         urb = TAILQ_FIRST(&uhe->bsd_urb_list);
1417                         if (urb == NULL) {
1418                                 /* nothing to do */
1419                                 return;
1420                         }
1421                         TAILQ_REMOVE(&uhe->bsd_urb_list, urb, bsd_urb_list);
1422                         urb->bsd_urb_list.tqe_prev = NULL;
1423
1424                         x = xfer->max_frame_count;
1425                         if (urb->number_of_packets > x) {
1426                                 /* XXX simply truncate the transfer */
1427                                 urb->number_of_packets = x;
1428                         }
1429                 } else {
1430                         DPRINTF("Already got a transfer\n");
1431
1432                         /* already got a transfer (should not happen) */
1433                         urb = usbd_xfer_get_priv(xfer);
1434                 }
1435
1436                 urb->bsd_isread = (uhe->desc.bEndpointAddress & UE_DIR_IN) ? 1 : 0;
1437
1438                 if (xfer->flags.ext_buffer) {
1439                         /* set virtual address to load */
1440                         usbd_xfer_set_frame_data(xfer, 0, urb->transfer_buffer, 0);
1441                 }
1442                 if (!(urb->bsd_isread)) {
1443
1444                         /* copy out data with regard to the URB */
1445
1446                         offset = 0;
1447
1448                         for (x = 0; x < urb->number_of_packets; x++) {
1449                                 uipd = urb->iso_frame_desc + x;
1450                                 usbd_xfer_set_frame_len(xfer, x, uipd->length);
1451                                 if (!xfer->flags.ext_buffer) {
1452                                         usbd_copy_in(xfer->frbuffers, offset,
1453                                             USB_ADD_BYTES(urb->transfer_buffer,
1454                                             uipd->offset), uipd->length);
1455                                 }
1456                                 offset += uipd->length;
1457                         }
1458                 } else {
1459
1460                         /*
1461                          * compute the transfer length into the "offset"
1462                          * variable
1463                          */
1464
1465                         offset = urb->number_of_packets * max_frame;
1466
1467                         /* setup "frlengths" array */
1468
1469                         for (x = 0; x < urb->number_of_packets; x++) {
1470                                 uipd = urb->iso_frame_desc + x;
1471                                 usbd_xfer_set_frame_len(xfer, x, max_frame);
1472                         }
1473                 }
1474                 usbd_xfer_set_priv(xfer, urb);
1475                 xfer->flags.force_short_xfer = 0;
1476                 xfer->timeout = urb->timeout;
1477                 xfer->nframes = urb->number_of_packets;
1478                 usbd_transfer_submit(xfer);
1479                 return;
1480
1481         default:                        /* Error */
1482                 if (xfer->error == USB_ERR_CANCELLED) {
1483                         urb->status = -ECONNRESET;
1484                 } else {
1485                         urb->status = -EPIPE;   /* stalled */
1486                 }
1487
1488                 /* Set zero for "actual_length" */
1489                 urb->actual_length = 0;
1490
1491                 /* Set zero for "actual_length" */
1492                 for (x = 0; x < urb->number_of_packets; x++) {
1493                         urb->iso_frame_desc[x].actual_length = 0;
1494                         urb->iso_frame_desc[x].status = urb->status;
1495                 }
1496
1497                 /* call callback */
1498                 usb_linux_complete(xfer);
1499
1500                 if (xfer->error == USB_ERR_CANCELLED) {
1501                         /* we need to return in this case */
1502                         return;
1503                 }
1504                 goto tr_setup;
1505
1506         }
1507 }
1508
1509 /*------------------------------------------------------------------------*
1510  *      usb_linux_non_isoc_callback
1511  *
1512  * The following is the FreeBSD BULK/INTERRUPT and CONTROL USB
1513  * callback. It dequeues Linux USB stack compatible URB's, transforms
1514  * the URB fields into a FreeBSD USB transfer, and defragments the USB
1515  * transfer as required. When the transfer is complete the "complete"
1516  * callback is called.
1517  *------------------------------------------------------------------------*/
1518 static void
1519 usb_linux_non_isoc_callback(struct usb_xfer *xfer, usb_error_t error)
1520 {
1521         enum {
1522                 REQ_SIZE = sizeof(struct usb_device_request)
1523         };
1524         struct urb *urb = usbd_xfer_get_priv(xfer);
1525         struct usb_host_endpoint *uhe = usbd_xfer_softc(xfer);
1526         uint8_t *ptr;
1527         usb_frlength_t max_bulk = usbd_xfer_max_len(xfer);
1528         uint8_t data_frame = xfer->flags_int.control_xfr ? 1 : 0;
1529
1530         DPRINTF("\n");
1531
1532         switch (USB_GET_STATE(xfer)) {
1533         case USB_ST_TRANSFERRED:
1534
1535                 if (xfer->flags_int.control_xfr) {
1536
1537                         /* don't transfer the setup packet again: */
1538
1539                         usbd_xfer_set_frame_len(xfer, 0, 0);
1540                 }
1541                 if (urb->bsd_isread && (!xfer->flags.ext_buffer)) {
1542                         /* copy in data with regard to the URB */
1543                         usbd_copy_out(xfer->frbuffers + data_frame, 0,
1544                             urb->bsd_data_ptr, xfer->frlengths[data_frame]);
1545                 }
1546                 urb->bsd_length_rem -= xfer->frlengths[data_frame];
1547                 urb->bsd_data_ptr += xfer->frlengths[data_frame];
1548                 urb->actual_length += xfer->frlengths[data_frame];
1549
1550                 /* check for short transfer */
1551                 if (xfer->actlen < xfer->sumlen) {
1552                         urb->bsd_length_rem = 0;
1553
1554                         /* short transfer */
1555                         if (urb->transfer_flags & URB_SHORT_NOT_OK) {
1556                                 urb->status = -EPIPE;
1557                         } else {
1558                                 urb->status = 0;
1559                         }
1560                 } else {
1561                         /* check remainder */
1562                         if (urb->bsd_length_rem > 0) {
1563                                 goto setup_bulk;
1564                         }
1565                         /* success */
1566                         urb->status = 0;
1567                 }
1568
1569                 /* call callback */
1570                 usb_linux_complete(xfer);
1571
1572         case USB_ST_SETUP:
1573 tr_setup:
1574                 /* get next transfer */
1575                 urb = TAILQ_FIRST(&uhe->bsd_urb_list);
1576                 if (urb == NULL) {
1577                         /* nothing to do */
1578                         return;
1579                 }
1580                 TAILQ_REMOVE(&uhe->bsd_urb_list, urb, bsd_urb_list);
1581                 urb->bsd_urb_list.tqe_prev = NULL;
1582
1583                 usbd_xfer_set_priv(xfer, urb);
1584                 xfer->flags.force_short_xfer = 0;
1585                 xfer->timeout = urb->timeout;
1586
1587                 if (xfer->flags_int.control_xfr) {
1588
1589                         /*
1590                          * USB control transfers need special handling.
1591                          * First copy in the header, then copy in data!
1592                          */
1593                         if (!xfer->flags.ext_buffer) {
1594                                 usbd_copy_in(xfer->frbuffers, 0,
1595                                     urb->setup_packet, REQ_SIZE);
1596                                 usbd_xfer_set_frame_len(xfer, 0, REQ_SIZE);
1597                         } else {
1598                                 /* set virtual address to load */
1599                                 usbd_xfer_set_frame_data(xfer, 0,
1600                                     urb->setup_packet, REQ_SIZE);
1601                         }
1602
1603                         ptr = urb->setup_packet;
1604
1605                         /* setup data transfer direction and length */
1606                         urb->bsd_isread = (ptr[0] & UT_READ) ? 1 : 0;
1607                         urb->bsd_length_rem = ptr[6] | (ptr[7] << 8);
1608
1609                 } else {
1610
1611                         /* setup data transfer direction */
1612
1613                         urb->bsd_length_rem = urb->transfer_buffer_length;
1614                         urb->bsd_isread = (uhe->desc.bEndpointAddress &
1615                             UE_DIR_IN) ? 1 : 0;
1616                 }
1617
1618                 urb->bsd_data_ptr = urb->transfer_buffer;
1619                 urb->actual_length = 0;
1620
1621 setup_bulk:
1622                 if (max_bulk > urb->bsd_length_rem) {
1623                         max_bulk = urb->bsd_length_rem;
1624                 }
1625                 /* check if we need to force a short transfer */
1626
1627                 if ((max_bulk == urb->bsd_length_rem) &&
1628                     (urb->transfer_flags & URB_ZERO_PACKET) &&
1629                     (!xfer->flags_int.control_xfr)) {
1630                         xfer->flags.force_short_xfer = 1;
1631                 }
1632                 /* check if we need to copy in data */
1633
1634                 if (xfer->flags.ext_buffer) {
1635                         /* set virtual address to load */
1636                         usbd_xfer_set_frame_data(xfer, data_frame,
1637                             urb->bsd_data_ptr, max_bulk);
1638                 } else if (!urb->bsd_isread) {
1639                         /* copy out data with regard to the URB */
1640                         usbd_copy_in(xfer->frbuffers + data_frame, 0,
1641                             urb->bsd_data_ptr, max_bulk);
1642                         usbd_xfer_set_frame_len(xfer, data_frame, max_bulk);
1643                 }
1644                 if (xfer->flags_int.control_xfr) {
1645                         if (max_bulk > 0) {
1646                                 xfer->nframes = 2;
1647                         } else {
1648                                 xfer->nframes = 1;
1649                         }
1650                 } else {
1651                         xfer->nframes = 1;
1652                 }
1653                 usbd_transfer_submit(xfer);
1654                 return;
1655
1656         default:
1657                 if (xfer->error == USB_ERR_CANCELLED) {
1658                         urb->status = -ECONNRESET;
1659                 } else {
1660                         urb->status = -EPIPE;
1661                 }
1662
1663                 /* Set zero for "actual_length" */
1664                 urb->actual_length = 0;
1665
1666                 /* call callback */
1667                 usb_linux_complete(xfer);
1668
1669                 if (xfer->error == USB_ERR_CANCELLED) {
1670                         /* we need to return in this case */
1671                         return;
1672                 }
1673                 goto tr_setup;
1674         }
1675 }
1676
1677 /*------------------------------------------------------------------------*
1678  *      usb_fill_bulk_urb
1679  *------------------------------------------------------------------------*/
1680 void
1681 usb_fill_bulk_urb(struct urb *urb, struct usb_device *udev,
1682     struct usb_host_endpoint *uhe, void *buf,
1683     int length, usb_complete_t callback, void *arg)
1684 {
1685         urb->dev = udev;
1686         urb->endpoint = uhe;
1687         urb->transfer_buffer = buf;
1688         urb->transfer_buffer_length = length;
1689         urb->complete = callback;
1690         urb->context = arg;
1691 }
1692
1693 /*------------------------------------------------------------------------*
1694  *      usb_bulk_msg
1695  *
1696  * NOTE: This function can also be used for interrupt endpoints!
1697  *
1698  * Return values:
1699  *    0: Success
1700  * Else: Failure
1701  *------------------------------------------------------------------------*/
1702 int
1703 usb_bulk_msg(struct usb_device *udev, struct usb_host_endpoint *uhe,
1704     void *data, int len, uint16_t *pactlen, usb_timeout_t timeout)
1705 {
1706         struct urb *urb;
1707         int err;
1708
1709         if (uhe == NULL)
1710                 return (-EINVAL);
1711         if (len < 0)
1712                 return (-EINVAL);
1713
1714         err = usb_setup_endpoint(udev, uhe, 4096 /* bytes */);
1715         if (err)
1716                 return (err);
1717
1718         urb = usb_alloc_urb(0, 0);
1719         if (urb == NULL)
1720                 return (-ENOMEM);
1721
1722         usb_fill_bulk_urb(urb, udev, uhe, data, len,
1723             usb_linux_wait_complete, NULL);
1724
1725         err = usb_start_wait_urb(urb, timeout, pactlen);
1726
1727         usb_free_urb(urb);
1728
1729         return (err);
1730 }