sys/dev/usb/usb_hub.c

   1 /* $FreeBSD$ */
   2 /*-
   3  * SPDX-License-Identifier: BSD-2-Clause-NetBSD
   4  *
   5  * Copyright (c) 1998 The NetBSD Foundation, Inc. All rights reserved.
   6  * Copyright (c) 1998 Lennart Augustsson. All rights reserved.
   7  * Copyright (c) 2008-2010 Hans Petter Selasky. All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  */
  30
  31 /*
  32  * USB spec: http://www.usb.org/developers/docs/usbspec.zip
  33  */
  34
  35 #ifdef USB_GLOBAL_INCLUDE_FILE
  36 #include USB_GLOBAL_INCLUDE_FILE
  37 #else
  38 #include <sys/stdint.h>
  39 #include <sys/stddef.h>
  40 #include <sys/param.h>
  41 #include <sys/queue.h>
  42 #include <sys/types.h>
  43 #include <sys/systm.h>
  44 #include <sys/kernel.h>
  45 #include <sys/bus.h>
  46 #include <sys/module.h>
  47 #include <sys/lock.h>
  48 #include <sys/mutex.h>
  49 #include <sys/condvar.h>
  50 #include <sys/sysctl.h>
  51 #include <sys/sx.h>
  52 #include <sys/unistd.h>
  53 #include <sys/callout.h>
  54 #include <sys/malloc.h>
  55 #include <sys/priv.h>
  56
  57 #include <dev/usb/usb.h>
  58 #include <dev/usb/usbdi.h>
  59 #include <dev/usb/usbdi_util.h>
  60
  61 #define USB_DEBUG_VAR uhub_debug
  62
  63 #include <dev/usb/usb_core.h>
  64 #include <dev/usb/usb_process.h>
  65 #include <dev/usb/usb_device.h>
  66 #include <dev/usb/usb_request.h>
  67 #include <dev/usb/usb_debug.h>
  68 #include <dev/usb/usb_hub.h>
  69 #include <dev/usb/usb_util.h>
  70 #include <dev/usb/usb_busdma.h>
  71 #include <dev/usb/usb_transfer.h>
  72 #include <dev/usb/usb_dynamic.h>
  73
  74 #include <dev/usb/usb_controller.h>
  75 #include <dev/usb/usb_bus.h>
  76 #endif                  /* USB_GLOBAL_INCLUDE_FILE */
  77
  78 #include <dev/usb/usb_hub_private.h>
  79
  80 #ifdef USB_DEBUG
  81 static int uhub_debug = 0;
  82
  83 static SYSCTL_NODE(_hw_usb, OID_AUTO, uhub, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
  84     "USB HUB");
  85 SYSCTL_INT(_hw_usb_uhub, OID_AUTO, debug, CTLFLAG_RWTUN, &uhub_debug, 0,
  86     "Debug level");
  87 #endif
  88
  89 #if USB_HAVE_POWERD
  90 static int usb_power_timeout = 30;      /* seconds */
  91
  92 SYSCTL_INT(_hw_usb, OID_AUTO, power_timeout, CTLFLAG_RWTUN,
  93     &usb_power_timeout, 0, "USB power timeout");
  94 #endif
  95
  96 #if USB_HAVE_DISABLE_ENUM
  97 static int usb_disable_enumeration = 0;
  98 SYSCTL_INT(_hw_usb, OID_AUTO, disable_enumeration, CTLFLAG_RWTUN,
  99     &usb_disable_enumeration, 0, "Set to disable all USB device enumeration. "
 100         "This can secure against USB devices turning evil, "
 101         "for example a USB memory stick becoming a USB keyboard.");
 102
 103 static int usb_disable_port_power = 0;
 104 SYSCTL_INT(_hw_usb, OID_AUTO, disable_port_power, CTLFLAG_RWTUN,
 105     &usb_disable_port_power, 0, "Set to disable all USB port power.");
 106 #endif
 107
 108 #define UHUB_PROTO(sc) ((sc)->sc_udev->ddesc.bDeviceProtocol)
 109 #define UHUB_IS_HIGH_SPEED(sc) (UHUB_PROTO(sc) != UDPROTO_FSHUB)
 110 #define UHUB_IS_SINGLE_TT(sc) (UHUB_PROTO(sc) == UDPROTO_HSHUBSTT)
 111 #define UHUB_IS_MULTI_TT(sc) (UHUB_PROTO(sc) == UDPROTO_HSHUBMTT)
 112 #define UHUB_IS_SUPER_SPEED(sc) (UHUB_PROTO(sc) == UDPROTO_SSHUB)
 113
 114 /* prototypes for type checking: */
 115
 116 static device_suspend_t uhub_suspend;
 117 static device_resume_t uhub_resume;
 118
 119 static bus_driver_added_t uhub_driver_added;
 120 static bus_child_pnpinfo_str_t uhub_child_pnpinfo_string;
 121
 122 static usb_callback_t uhub_intr_callback;
 123 #if USB_HAVE_TT_SUPPORT
 124 static usb_callback_t uhub_reset_tt_callback;
 125 #endif
 126
 127 static void usb_dev_resume_peer(struct usb_device *udev);
 128 static void usb_dev_suspend_peer(struct usb_device *udev);
 129 static uint8_t usb_peer_should_wakeup(struct usb_device *udev);
 130
 131 static const struct usb_config uhub_config[UHUB_N_TRANSFER] = {
 132         [UHUB_INTR_TRANSFER] = {
 133                 .type = UE_INTERRUPT,
 134                 .endpoint = UE_ADDR_ANY,
 135                 .direction = UE_DIR_ANY,
 136                 .timeout = 0,
 137                 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
 138                 .bufsize = 0,   /* use wMaxPacketSize */
 139                 .callback = &uhub_intr_callback,
 140                 .interval = UHUB_INTR_INTERVAL,
 141         },
 142 #if USB_HAVE_TT_SUPPORT
 143         [UHUB_RESET_TT_TRANSFER] = {
 144                 .type = UE_CONTROL,
 145                 .endpoint = 0x00,       /* Control pipe */
 146                 .direction = UE_DIR_ANY,
 147                 .bufsize = sizeof(struct usb_device_request),
 148                 .callback = &uhub_reset_tt_callback,
 149                 .timeout = 1000,        /* 1 second */
 150                 .usb_mode = USB_MODE_HOST,
 151         },
 152 #endif
 153 };
 154
 155 /*
 156  * driver instance for "hub" connected to "usb"
 157  * and "hub" connected to "hub"
 158  */
 159 static devclass_t uhub_devclass;
 160
 161 static device_method_t uhub_methods[] = {
 162         DEVMETHOD(device_probe, uhub_probe),
 163         DEVMETHOD(device_attach, uhub_attach),
 164         DEVMETHOD(device_detach, uhub_detach),
 165
 166         DEVMETHOD(device_suspend, uhub_suspend),
 167         DEVMETHOD(device_resume, uhub_resume),
 168
 169         DEVMETHOD(bus_child_location_str, uhub_child_location_string),
 170         DEVMETHOD(bus_child_pnpinfo_str, uhub_child_pnpinfo_string),
 171         DEVMETHOD(bus_driver_added, uhub_driver_added),
 172         DEVMETHOD_END
 173 };
 174
 175 driver_t uhub_driver = {
 176         .name = "uhub",
 177         .methods = uhub_methods,
 178         .size = sizeof(struct uhub_softc)
 179 };
 180
 181 DRIVER_MODULE(uhub, usbus, uhub_driver, uhub_devclass, 0, 0);
 182 DRIVER_MODULE(uhub, uhub, uhub_driver, uhub_devclass, NULL, 0);
 183 MODULE_VERSION(uhub, 1);
 184
 185 static void
 186 uhub_intr_callback(struct usb_xfer *xfer, usb_error_t error)
 187 {
 188         struct uhub_softc *sc = usbd_xfer_softc(xfer);
 189
 190         switch (USB_GET_STATE(xfer)) {
 191         case USB_ST_TRANSFERRED:
 192                 DPRINTFN(2, "\n");
 193                 /*
 194                  * This is an indication that some port
 195                  * has changed status. Notify the bus
 196                  * event handler thread that we need
 197                  * to be explored again:
 198                  */
 199                 usb_needs_explore(sc->sc_udev->bus, 0);
 200
 201         case USB_ST_SETUP:
 202                 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
 203                 usbd_transfer_submit(xfer);
 204                 break;
 205
 206         default:                        /* Error */
 207                 if (xfer->error != USB_ERR_CANCELLED) {
 208                         /*
 209                          * Do a clear-stall. The "stall_pipe" flag
 210                          * will get cleared before next callback by
 211                          * the USB stack.
 212                          */
 213                         usbd_xfer_set_stall(xfer);
 214                         usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
 215                         usbd_transfer_submit(xfer);
 216                 }
 217                 break;
 218         }
 219 }
 220
 221 /*------------------------------------------------------------------------*
 222  *      uhub_reset_tt_proc
 223  *
 224  * This function starts the TT reset USB request
 225  *------------------------------------------------------------------------*/
 226 #if USB_HAVE_TT_SUPPORT
 227 static void
 228 uhub_reset_tt_proc(struct usb_proc_msg *_pm)
 229 {
 230         struct usb_udev_msg *pm = (void *)_pm;
 231         struct usb_device *udev = pm->udev;
 232         struct usb_hub *hub;
 233         struct uhub_softc *sc;
 234
 235         hub = udev->hub;
 236         if (hub == NULL)
 237                 return;
 238         sc = hub->hubsoftc;
 239         if (sc == NULL)
 240                 return;
 241
 242         /* Change lock */
 243         USB_BUS_UNLOCK(udev->bus);
 244         USB_MTX_LOCK(&sc->sc_mtx);
 245         /* Start transfer */
 246         usbd_transfer_start(sc->sc_xfer[UHUB_RESET_TT_TRANSFER]);
 247         /* Change lock */
 248         USB_MTX_UNLOCK(&sc->sc_mtx);
 249         USB_BUS_LOCK(udev->bus);
 250 }
 251 #endif
 252
 253 /*------------------------------------------------------------------------*
 254  *      uhub_tt_buffer_reset_async_locked
 255  *
 256  * This function queues a TT reset for the given USB device and endpoint.
 257  *------------------------------------------------------------------------*/
 258 #if USB_HAVE_TT_SUPPORT
 259 void
 260 uhub_tt_buffer_reset_async_locked(struct usb_device *child, struct usb_endpoint *ep)
 261 {
 262         struct usb_device_request req;
 263         struct usb_device *udev;
 264         struct usb_hub *hub;
 265         struct usb_port *up;
 266         uint16_t wValue;
 267         uint8_t port;
 268
 269         if (child == NULL || ep == NULL)
 270                 return;
 271
 272         udev = child->parent_hs_hub;
 273         port = child->hs_port_no;
 274
 275         if (udev == NULL)
 276                 return;
 277
 278         hub = udev->hub;
 279         if ((hub == NULL) ||
 280             (udev->speed != USB_SPEED_HIGH) ||
 281             (child->speed != USB_SPEED_LOW &&
 282              child->speed != USB_SPEED_FULL) ||
 283             (child->flags.usb_mode != USB_MODE_HOST) ||
 284             (port == 0) || (ep->edesc == NULL)) {
 285                 /* not applicable */
 286                 return;
 287         }
 288
 289         USB_BUS_LOCK_ASSERT(udev->bus, MA_OWNED);
 290
 291         up = hub->ports + port - 1;
 292
 293         if (udev->ddesc.bDeviceClass == UDCLASS_HUB &&
 294             udev->ddesc.bDeviceProtocol == UDPROTO_HSHUBSTT)
 295                 port = 1;
 296
 297         /* if we already received a clear buffer request, reset the whole TT */
 298         if (up->req_reset_tt.bRequest != 0) {
 299                 req.bmRequestType = UT_WRITE_CLASS_OTHER;
 300                 req.bRequest = UR_RESET_TT;
 301                 USETW(req.wValue, 0);
 302                 req.wIndex[0] = port;
 303                 req.wIndex[1] = 0;
 304                 USETW(req.wLength, 0);
 305         } else {
 306                 wValue = (ep->edesc->bEndpointAddress & 0xF) |
 307                       ((child->address & 0x7F) << 4) |
 308                       ((ep->edesc->bEndpointAddress & 0x80) << 8) |
 309                       ((ep->edesc->bmAttributes & 3) << 12);
 310
 311                 req.bmRequestType = UT_WRITE_CLASS_OTHER;
 312                 req.bRequest = UR_CLEAR_TT_BUFFER;
 313                 USETW(req.wValue, wValue);
 314                 req.wIndex[0] = port;
 315                 req.wIndex[1] = 0;
 316                 USETW(req.wLength, 0);
 317         }
 318         up->req_reset_tt = req;
 319         /* get reset transfer started */
 320         usb_proc_msignal(USB_BUS_TT_PROC(udev->bus),
 321             &hub->tt_msg[0], &hub->tt_msg[1]);
 322 }
 323 #endif
 324
 325 #if USB_HAVE_TT_SUPPORT
 326 static void
 327 uhub_reset_tt_callback(struct usb_xfer *xfer, usb_error_t error)
 328 {
 329         struct uhub_softc *sc;
 330         struct usb_device *udev;
 331         struct usb_port *up;
 332         uint8_t x;
 333
 334         DPRINTF("TT buffer reset\n");
 335
 336         sc = usbd_xfer_softc(xfer);
 337         udev = sc->sc_udev;
 338
 339         switch (USB_GET_STATE(xfer)) {
 340         case USB_ST_TRANSFERRED:
 341         case USB_ST_SETUP:
 342 tr_setup:
 343                 USB_BUS_LOCK(udev->bus);
 344                 /* find first port which needs a TT reset */
 345                 for (x = 0; x != udev->hub->nports; x++) {
 346                         up = udev->hub->ports + x;
 347
 348                         if (up->req_reset_tt.bRequest == 0)
 349                                 continue;
 350
 351                         /* copy in the transfer */
 352                         usbd_copy_in(xfer->frbuffers, 0, &up->req_reset_tt,
 353                             sizeof(up->req_reset_tt));
 354                         /* reset buffer */
 355                         memset(&up->req_reset_tt, 0, sizeof(up->req_reset_tt));
 356
 357                         /* set length */
 358                         usbd_xfer_set_frame_len(xfer, 0, sizeof(up->req_reset_tt));
 359                         xfer->nframes = 1;
 360                         USB_BUS_UNLOCK(udev->bus);
 361
 362                         usbd_transfer_submit(xfer);
 363                         return;
 364                 }
 365                 USB_BUS_UNLOCK(udev->bus);
 366                 break;
 367
 368         default:
 369                 if (error == USB_ERR_CANCELLED)
 370                         break;
 371
 372                 DPRINTF("TT buffer reset failed (%s)\n", usbd_errstr(error));
 373                 goto tr_setup;
 374         }
 375 }
 376 #endif
 377
 378 /*------------------------------------------------------------------------*
 379  *      uhub_count_active_host_ports
 380  *
 381  * This function counts the number of active ports at the given speed.
 382  *------------------------------------------------------------------------*/
 383 uint8_t
 384 uhub_count_active_host_ports(struct usb_device *udev, enum usb_dev_speed speed)
 385 {
 386         struct uhub_softc *sc;
 387         struct usb_device *child;
 388         struct usb_hub *hub;
 389         struct usb_port *up;
 390         uint8_t retval = 0;
 391         uint8_t x;
 392
 393         if (udev == NULL)
 394                 goto done;
 395         hub = udev->hub;
 396         if (hub == NULL)
 397                 goto done;
 398         sc = hub->hubsoftc;
 399         if (sc == NULL)
 400                 goto done;
 401
 402         for (x = 0; x != hub->nports; x++) {
 403                 up = hub->ports + x;
 404                 child = usb_bus_port_get_device(udev->bus, up);
 405                 if (child != NULL &&
 406                     child->flags.usb_mode == USB_MODE_HOST &&
 407                     child->speed == speed)
 408                         retval++;
 409         }
 410 done:
 411         return (retval);
 412 }
 413
 414 void
 415 uhub_explore_handle_re_enumerate(struct usb_device *child)
 416 {
 417         uint8_t do_unlock;
 418         usb_error_t err;
 419
 420         /* check if device should be re-enumerated */
 421         if (child->flags.usb_mode != USB_MODE_HOST)
 422                 return;
 423
 424         do_unlock = usbd_enum_lock(child);
 425         switch (child->re_enumerate_wait) {
 426         case USB_RE_ENUM_START:
 427                 err = usbd_set_config_index(child,
 428                     USB_UNCONFIG_INDEX);
 429                 if (err != 0) {
 430                         DPRINTF("Unconfigure failed: %s: Ignored.\n",
 431                             usbd_errstr(err));
 432                 }
 433                 if (child->parent_hub == NULL) {
 434                         /* the root HUB cannot be re-enumerated */
 435                         DPRINTFN(6, "cannot reset root HUB\n");
 436                         err = 0;
 437                 } else {
 438                         err = usbd_req_re_enumerate(child, NULL);
 439                 }
 440                 if (err == 0) {
 441                         /* refresh device strings */
 442                         usb_get_langid(child);
 443                         usb_set_device_strings(child);
 444
 445                         /* set default configuration */
 446                         err = usbd_set_config_index(child, 0);
 447                 }
 448                 if (err == 0) {
 449                         err = usb_probe_and_attach(child,
 450                             USB_IFACE_INDEX_ANY);
 451                 }
 452                 child->re_enumerate_wait = USB_RE_ENUM_DONE;
 453                 break;
 454
 455         case USB_RE_ENUM_PWR_OFF:
 456                 /* get the device unconfigured */
 457                 err = usbd_set_config_index(child,
 458                     USB_UNCONFIG_INDEX);
 459                 if (err) {
 460                         DPRINTFN(0, "Could not unconfigure "
 461                             "device (ignored)\n");
 462                 }
 463                 if (child->parent_hub == NULL) {
 464                         /* the root HUB cannot be re-enumerated */
 465                         DPRINTFN(6, "cannot set port feature\n");
 466                         err = 0;
 467                 } else {
 468                         /* clear port enable */
 469                         err = usbd_req_clear_port_feature(child->parent_hub,
 470                             NULL, child->port_no, UHF_PORT_ENABLE);
 471                         if (err) {
 472                                 DPRINTFN(0, "Could not disable port "
 473                                     "(ignored)\n");
 474                         }
 475                 }
 476                 child->re_enumerate_wait = USB_RE_ENUM_DONE;
 477                 break;
 478
 479         case USB_RE_ENUM_SET_CONFIG:
 480                 err = usbd_set_config_index(child,
 481                     child->next_config_index);
 482                 if (err != 0) {
 483                         DPRINTF("Configure failed: %s: Ignored.\n",
 484                             usbd_errstr(err));
 485                 } else {
 486                         err = usb_probe_and_attach(child,
 487                             USB_IFACE_INDEX_ANY);
 488                 }
 489                 child->re_enumerate_wait = USB_RE_ENUM_DONE;
 490                 break;
 491
 492         default:
 493                 child->re_enumerate_wait = USB_RE_ENUM_DONE;
 494                 break;
 495         }
 496         if (do_unlock)
 497                 usbd_enum_unlock(child);
 498 }
 499
 500 /*------------------------------------------------------------------------*
 501  *      uhub_explore_sub - subroutine
 502  *
 503  * Return values:
 504  *    0: Success
 505  * Else: A control transaction failed
 506  *------------------------------------------------------------------------*/
 507 static usb_error_t
 508 uhub_explore_sub(struct uhub_softc *sc, struct usb_port *up)
 509 {
 510         struct usb_bus *bus;
 511         struct usb_device *child;
 512         uint8_t refcount;
 513         usb_error_t err;
 514
 515         bus = sc->sc_udev->bus;
 516         err = USB_ERR_NORMAL_COMPLETION;
 517
 518         /* get driver added refcount from USB bus */
 519         refcount = bus->driver_added_refcount;
 520
 521         /* get device assosiated with the given port */
 522         child = usb_bus_port_get_device(bus, up);
 523         if (child == NULL) {
 524                 /* nothing to do */
 525                 goto done;
 526         }
 527
 528         uhub_explore_handle_re_enumerate(child);
 529
 530         /* check if probe and attach should be done */
 531
 532         if (child->driver_added_refcount != refcount) {
 533                 child->driver_added_refcount = refcount;
 534                 err = usb_probe_and_attach(child,
 535                     USB_IFACE_INDEX_ANY);
 536                 if (err) {
 537                         goto done;
 538                 }
 539         }
 540         /* start control transfer, if device mode */
 541
 542         if (child->flags.usb_mode == USB_MODE_DEVICE)
 543                 usbd_ctrl_transfer_setup(child);
 544
 545         /* if a HUB becomes present, do a recursive HUB explore */
 546
 547         if (child->hub)
 548                 err = (child->hub->explore) (child);
 549
 550 done:
 551         return (err);
 552 }
 553
 554 /*------------------------------------------------------------------------*
 555  *      uhub_read_port_status - factored out code
 556  *------------------------------------------------------------------------*/
 557 static usb_error_t
 558 uhub_read_port_status(struct uhub_softc *sc, uint8_t portno)
 559 {
 560         struct usb_port_status ps;
 561         usb_error_t err;
 562
 563         if (sc->sc_usb_port_errors >= UHUB_USB_PORT_ERRORS_MAX) {
 564                 DPRINTFN(4, "port %d, HUB looks dead, too many errors\n", portno);
 565                 sc->sc_st.port_status = 0;
 566                 sc->sc_st.port_change = 0;
 567                 return (USB_ERR_TIMEOUT);
 568         }
 569
 570         err = usbd_req_get_port_status(
 571             sc->sc_udev, NULL, &ps, portno);
 572
 573         if (err == 0) {
 574                 sc->sc_st.port_status = UGETW(ps.wPortStatus);
 575                 sc->sc_st.port_change = UGETW(ps.wPortChange);
 576                 sc->sc_usb_port_errors = 0;
 577         } else {
 578                 sc->sc_st.port_status = 0;
 579                 sc->sc_st.port_change = 0;
 580                 sc->sc_usb_port_errors++;
 581         }
 582
 583         /* debugging print */
 584
 585         DPRINTFN(4, "port %d, wPortStatus=0x%04x, "
 586             "wPortChange=0x%04x, err=%s\n",
 587             portno, sc->sc_st.port_status,
 588             sc->sc_st.port_change, usbd_errstr(err));
 589         return (err);
 590 }
 591
 592 /*------------------------------------------------------------------------*
 593  *      uhub_reattach_port
 594  *
 595  * Returns:
 596  *    0: Success
 597  * Else: A control transaction failed
 598  *------------------------------------------------------------------------*/
 599 static usb_error_t
 600 uhub_reattach_port(struct uhub_softc *sc, uint8_t portno)
 601 {
 602         struct usb_device *child;
 603         struct usb_device *udev;
 604         enum usb_dev_speed speed;
 605         enum usb_hc_mode mode;
 606         usb_error_t err;
 607         uint16_t power_mask;
 608         uint8_t timeout;
 609
 610         DPRINTF("reattaching port %d\n", portno);
 611
 612         timeout = 0;
 613         udev = sc->sc_udev;
 614         child = usb_bus_port_get_device(udev->bus,
 615             udev->hub->ports + portno - 1);
 616
 617 repeat:
 618
 619         /* first clear the port connection change bit */
 620
 621         err = usbd_req_clear_port_feature(udev, NULL,
 622             portno, UHF_C_PORT_CONNECTION);
 623
 624         if (err)
 625                 goto error;
 626
 627         /* check if there is a child */
 628
 629         if (child != NULL) {
 630                 /*
 631                  * Free USB device and all subdevices, if any.
 632                  */
 633                 usb_free_device(child, 0);
 634                 child = NULL;
 635         }
 636         /* get fresh status */
 637
 638         err = uhub_read_port_status(sc, portno);
 639         if (err)
 640                 goto error;
 641
 642 #if USB_HAVE_DISABLE_ENUM
 643         /* check if we should skip enumeration from this USB HUB */
 644         if (usb_disable_enumeration != 0 ||
 645             sc->sc_disable_enumeration != 0) {
 646                 DPRINTF("Enumeration is disabled!\n");
 647                 goto error;
 648         }
 649 #endif
 650         /* check if nothing is connected to the port */
 651
 652         if (!(sc->sc_st.port_status & UPS_CURRENT_CONNECT_STATUS))
 653                 goto error;
 654
 655         /* check if there is no power on the port and print a warning */
 656
 657         switch (udev->speed) {
 658         case USB_SPEED_HIGH:
 659         case USB_SPEED_FULL:
 660         case USB_SPEED_LOW:
 661                 power_mask = UPS_PORT_POWER;
 662                 break;
 663         case USB_SPEED_SUPER:
 664                 if (udev->parent_hub == NULL)
 665                         power_mask = 0; /* XXX undefined */
 666                 else
 667                         power_mask = UPS_PORT_POWER_SS;
 668                 break;
 669         default:
 670                 power_mask = 0;
 671                 break;
 672         }
 673         if ((sc->sc_st.port_status & power_mask) != power_mask) {
 674                 DPRINTF("WARNING: strange, connected port %d "
 675                     "has no power\n", portno);
 676         }
 677
 678         /* check if the device is in Host Mode */
 679
 680         if (!(sc->sc_st.port_status & UPS_PORT_MODE_DEVICE)) {
 681                 DPRINTF("Port %d is in Host Mode\n", portno);
 682
 683                 if (sc->sc_st.port_status & UPS_SUSPEND) {
 684                         /*
 685                          * NOTE: Should not get here in SuperSpeed
 686                          * mode, because the HUB should report this
 687                          * bit as zero.
 688                          */
 689                         DPRINTF("Port %d was still "
 690                             "suspended, clearing.\n", portno);
 691                         err = usbd_req_clear_port_feature(udev,
 692                             NULL, portno, UHF_PORT_SUSPEND);
 693                 }
 694
 695                 /* USB Host Mode */
 696
 697                 /* wait for maximum device power up time */
 698
 699                 usb_pause_mtx(NULL,
 700                     USB_MS_TO_TICKS(usb_port_powerup_delay));
 701
 702                 /* reset port, which implies enabling it */
 703
 704                 err = usbd_req_reset_port(udev, NULL, portno);
 705
 706                 if (err) {
 707                         DPRINTFN(0, "port %d reset "
 708                             "failed, error=%s\n",
 709                             portno, usbd_errstr(err));
 710                         goto error;
 711                 }
 712                 /* get port status again, it might have changed during reset */
 713
 714                 err = uhub_read_port_status(sc, portno);
 715                 if (err) {
 716                         goto error;
 717                 }
 718                 /* check if something changed during port reset */
 719
 720                 if ((sc->sc_st.port_change & UPS_C_CONNECT_STATUS) ||
 721                     (!(sc->sc_st.port_status & UPS_CURRENT_CONNECT_STATUS))) {
 722                         if (timeout) {
 723                                 DPRINTFN(1, "giving up port %d reset - "
 724                                    "device vanished: change %#x status %#x\n",
 725                                    portno, sc->sc_st.port_change,
 726                                    sc->sc_st.port_status);
 727                                 goto error;
 728                         }
 729                         timeout = 1;
 730                         goto repeat;
 731                 }
 732         } else {
 733                 DPRINTF("Port %d is in Device Mode\n", portno);
 734         }
 735
 736         /*
 737          * Figure out the device speed
 738          */
 739         switch (udev->speed) {
 740         case USB_SPEED_HIGH:
 741                 if (sc->sc_st.port_status & UPS_HIGH_SPEED)
 742                         speed = USB_SPEED_HIGH;
 743                 else if (sc->sc_st.port_status & UPS_LOW_SPEED)
 744                         speed = USB_SPEED_LOW;
 745                 else
 746                         speed = USB_SPEED_FULL;
 747                 break;
 748         case USB_SPEED_FULL:
 749                 if (sc->sc_st.port_status & UPS_LOW_SPEED)
 750                         speed = USB_SPEED_LOW;
 751                 else
 752                         speed = USB_SPEED_FULL;
 753                 break;
 754         case USB_SPEED_LOW:
 755                 speed = USB_SPEED_LOW;
 756                 break;
 757         case USB_SPEED_SUPER:
 758                 if (udev->parent_hub == NULL) {
 759                         /* Root HUB - special case */
 760                         switch (sc->sc_st.port_status & UPS_OTHER_SPEED) {
 761                         case 0:
 762                                 speed = USB_SPEED_FULL;
 763                                 break;
 764                         case UPS_LOW_SPEED:
 765                                 speed = USB_SPEED_LOW;
 766                                 break;
 767                         case UPS_HIGH_SPEED:
 768                                 speed = USB_SPEED_HIGH;
 769                                 break;
 770                         default:
 771                                 speed = USB_SPEED_SUPER;
 772                                 break;
 773                         }
 774                 } else {
 775                         speed = USB_SPEED_SUPER;
 776                 }
 777                 break;
 778         default:
 779                 /* same speed like parent */
 780                 speed = udev->speed;
 781                 break;
 782         }
 783         if (speed == USB_SPEED_SUPER) {
 784                 err = usbd_req_set_hub_u1_timeout(udev, NULL,
 785                     portno, 128 - (2 * udev->depth));
 786                 if (err) {
 787                         DPRINTFN(0, "port %d U1 timeout "
 788                             "failed, error=%s\n",
 789                             portno, usbd_errstr(err));
 790                 }
 791                 err = usbd_req_set_hub_u2_timeout(udev, NULL,
 792                     portno, 128 - (2 * udev->depth));
 793                 if (err) {
 794                         DPRINTFN(0, "port %d U2 timeout "
 795                             "failed, error=%s\n",
 796                             portno, usbd_errstr(err));
 797                 }
 798         }
 799
 800         /*
 801          * Figure out the device mode
 802          *
 803          * NOTE: This part is currently FreeBSD specific.
 804          */
 805         if (udev->parent_hub != NULL) {
 806                 /* inherit mode from the parent HUB */
 807                 mode = udev->parent_hub->flags.usb_mode;
 808         } else if (sc->sc_st.port_status & UPS_PORT_MODE_DEVICE)
 809                 mode = USB_MODE_DEVICE;
 810         else
 811                 mode = USB_MODE_HOST;
 812
 813         /* need to create a new child */
 814         child = usb_alloc_device(sc->sc_dev, udev->bus, udev,
 815             udev->depth + 1, portno - 1, portno, speed, mode);
 816         if (child == NULL) {
 817                 DPRINTFN(0, "could not allocate new device\n");
 818                 goto error;
 819         }
 820         return (0);                     /* success */
 821
 822 error:
 823         if (child != NULL) {
 824                 /*
 825                  * Free USB device and all subdevices, if any.
 826                  */
 827                 usb_free_device(child, 0);
 828                 child = NULL;
 829         }
 830         if (err == 0) {
 831                 if (sc->sc_st.port_status & UPS_PORT_ENABLED) {
 832                         err = usbd_req_clear_port_feature(
 833                             sc->sc_udev, NULL,
 834                             portno, UHF_PORT_ENABLE);
 835                 }
 836         }
 837         if (err) {
 838                 DPRINTFN(0, "device problem (%s), "
 839                     "disabling port %d\n", usbd_errstr(err), portno);
 840         }
 841         return (err);
 842 }
 843
 844 /*------------------------------------------------------------------------*
 845  *      usb_device_20_compatible
 846  *
 847  * Returns:
 848  *    0: HUB does not support suspend and resume
 849  * Else: HUB supports suspend and resume
 850  *------------------------------------------------------------------------*/
 851 static uint8_t
 852 usb_device_20_compatible(struct usb_device *udev)
 853 {
 854         if (udev == NULL)
 855                 return (0);
 856         switch (udev->speed) {
 857         case USB_SPEED_LOW:
 858         case USB_SPEED_FULL:
 859         case USB_SPEED_HIGH:
 860                 return (1);
 861         default:
 862                 return (0);
 863         }
 864 }
 865
 866 /*------------------------------------------------------------------------*
 867  *      uhub_suspend_resume_port
 868  *
 869  * Returns:
 870  *    0: Success
 871  * Else: A control transaction failed
 872  *------------------------------------------------------------------------*/
 873 static usb_error_t
 874 uhub_suspend_resume_port(struct uhub_softc *sc, uint8_t portno)
 875 {
 876         struct usb_device *child;
 877         struct usb_device *udev;
 878         uint8_t is_suspend;
 879         usb_error_t err;
 880
 881         DPRINTF("port %d\n", portno);
 882
 883         udev = sc->sc_udev;
 884         child = usb_bus_port_get_device(udev->bus,
 885             udev->hub->ports + portno - 1);
 886
 887         /* first clear the port suspend change bit */
 888
 889         if (usb_device_20_compatible(udev)) {
 890                 err = usbd_req_clear_port_feature(udev, NULL,
 891                     portno, UHF_C_PORT_SUSPEND);
 892         } else {
 893                 err = usbd_req_clear_port_feature(udev, NULL,
 894                     portno, UHF_C_PORT_LINK_STATE);
 895         }
 896
 897         if (err) {
 898                 DPRINTF("clearing suspend failed.\n");
 899                 goto done;
 900         }
 901         /* get fresh status */
 902
 903         err = uhub_read_port_status(sc, portno);
 904         if (err) {
 905                 DPRINTF("reading port status failed.\n");
 906                 goto done;
 907         }
 908         /* convert current state */
 909
 910         if (usb_device_20_compatible(udev)) {
 911                 if (sc->sc_st.port_status & UPS_SUSPEND) {
 912                         is_suspend = 1;
 913                 } else {
 914                         is_suspend = 0;
 915                 }
 916         } else {
 917                 switch (UPS_PORT_LINK_STATE_GET(sc->sc_st.port_status)) {
 918                 case UPS_PORT_LS_U3:
 919                         is_suspend = 1;
 920                         break;
 921                 case UPS_PORT_LS_SS_INA:
 922                         usbd_req_warm_reset_port(udev, NULL, portno);
 923                         is_suspend = 0;
 924                         break;
 925                 default:
 926                         is_suspend = 0;
 927                         break;
 928                 }
 929         }
 930
 931         DPRINTF("suspended=%u\n", is_suspend);
 932
 933         /* do the suspend or resume */
 934
 935         if (child) {
 936                 /*
 937                  * This code handle two cases: 1) Host Mode - we can only
 938                  * receive resume here 2) Device Mode - we can receive
 939                  * suspend and resume here
 940                  */
 941                 if (is_suspend == 0)
 942                         usb_dev_resume_peer(child);
 943                 else if (child->flags.usb_mode == USB_MODE_DEVICE)
 944                         usb_dev_suspend_peer(child);
 945         }
 946 done:
 947         return (err);
 948 }
 949
 950 /*------------------------------------------------------------------------*
 951  *      uhub_root_interrupt
 952  *
 953  * This function is called when a Root HUB interrupt has
 954  * happened. "ptr" and "len" makes up the Root HUB interrupt
 955  * packet. This function is called having the "bus_mtx" locked.
 956  *------------------------------------------------------------------------*/
 957 void
 958 uhub_root_intr(struct usb_bus *bus, const uint8_t *ptr, uint8_t len)
 959 {
 960         USB_BUS_LOCK_ASSERT(bus, MA_OWNED);
 961
 962         usb_needs_explore(bus, 0);
 963 }
 964
 965 static uint8_t
 966 uhub_is_too_deep(struct usb_device *udev)
 967 {
 968         switch (udev->speed) {
 969         case USB_SPEED_FULL:
 970         case USB_SPEED_LOW:
 971         case USB_SPEED_HIGH:
 972                 if (udev->depth > USB_HUB_MAX_DEPTH)
 973                         return (1);
 974                 break;
 975         case USB_SPEED_SUPER:
 976                 if (udev->depth > USB_SS_HUB_DEPTH_MAX)
 977                         return (1);
 978                 break;
 979         default:
 980                 break;
 981         }
 982         return (0);
 983 }
 984
 985 /*------------------------------------------------------------------------*
 986  *      uhub_explore
 987  *
 988  * Returns:
 989  *     0: Success
 990  *  Else: Failure
 991  *------------------------------------------------------------------------*/
 992 static usb_error_t
 993 uhub_explore(struct usb_device *udev)
 994 {
 995         struct usb_hub *hub;
 996         struct uhub_softc *sc;
 997         struct usb_port *up;
 998         usb_error_t err;
 999         uint8_t portno;
1000         uint8_t x;
1001         uint8_t do_unlock;
1002
1003         hub = udev->hub;
1004         sc = hub->hubsoftc;
1005
1006         DPRINTFN(11, "udev=%p addr=%d\n", udev, udev->address);
1007
1008         /* ignore devices that are too deep */
1009         if (uhub_is_too_deep(udev))
1010                 return (USB_ERR_TOO_DEEP);
1011
1012         /* check if device is suspended */
1013         if (udev->flags.self_suspended) {
1014                 /* need to wait until the child signals resume */
1015                 DPRINTF("Device is suspended!\n");
1016                 return (USB_ERR_NORMAL_COMPLETION);
1017         }
1018
1019         /*
1020          * Make sure we don't race against user-space applications
1021          * like LibUSB:
1022          */
1023         do_unlock = usbd_enum_lock(udev);
1024
1025         /*
1026          * Set default error code to avoid compiler warnings.
1027          * Note that hub->nports cannot be zero.
1028          */
1029         err = USB_ERR_NORMAL_COMPLETION;
1030
1031         for (x = 0; x != hub->nports; x++) {
1032                 up = hub->ports + x;
1033                 portno = x + 1;
1034
1035                 err = uhub_read_port_status(sc, portno);
1036                 if (err) {
1037                         /* most likely the HUB is gone */
1038                         break;
1039                 }
1040                 if (sc->sc_st.port_change & UPS_C_OVERCURRENT_INDICATOR) {
1041                         DPRINTF("Overcurrent on port %u.\n", portno);
1042                         err = usbd_req_clear_port_feature(
1043                             udev, NULL, portno, UHF_C_PORT_OVER_CURRENT);
1044                         if (err) {
1045                                 /* most likely the HUB is gone */
1046                                 break;
1047                         }
1048                 }
1049                 if (!(sc->sc_flags & UHUB_FLAG_DID_EXPLORE)) {
1050                         /*
1051                          * Fake a connect status change so that the
1052                          * status gets checked initially!
1053                          */
1054                         sc->sc_st.port_change |=
1055                             UPS_C_CONNECT_STATUS;
1056                 }
1057                 if (sc->sc_st.port_change & UPS_C_PORT_ENABLED) {
1058                         err = usbd_req_clear_port_feature(
1059                             udev, NULL, portno, UHF_C_PORT_ENABLE);
1060                         if (err) {
1061                                 /* most likely the HUB is gone */
1062                                 break;
1063                         }
1064                         if (sc->sc_st.port_change & UPS_C_CONNECT_STATUS) {
1065                                 /*
1066                                  * Ignore the port error if the device
1067                                  * has vanished !
1068                                  */
1069                         } else if (sc->sc_st.port_status & UPS_PORT_ENABLED) {
1070                                 DPRINTFN(0, "illegal enable change, "
1071                                     "port %d\n", portno);
1072                         } else {
1073                                 if (up->restartcnt == USB_RESTART_MAX) {
1074                                         /* XXX could try another speed ? */
1075                                         DPRINTFN(0, "port error, giving up "
1076                                             "port %d\n", portno);
1077                                 } else {
1078                                         sc->sc_st.port_change |=
1079                                             UPS_C_CONNECT_STATUS;
1080                                         up->restartcnt++;
1081                                 }
1082                         }
1083                 }
1084                 if (sc->sc_st.port_change & UPS_C_CONNECT_STATUS) {
1085                         err = uhub_reattach_port(sc, portno);
1086                         if (err) {
1087                                 /* most likely the HUB is gone */
1088                                 break;
1089                         }
1090                 }
1091                 if (sc->sc_st.port_change & (UPS_C_SUSPEND |
1092                     UPS_C_PORT_LINK_STATE)) {
1093                         err = uhub_suspend_resume_port(sc, portno);
1094                         if (err) {
1095                                 /* most likely the HUB is gone */
1096                                 break;
1097                         }
1098                 }
1099
1100                 if (uhub_explore_sub(sc, up) == USB_ERR_NORMAL_COMPLETION) {
1101                         /* explore succeeded - reset restart counter */
1102                         up->restartcnt = 0;
1103                 }
1104         }
1105
1106         if (do_unlock)
1107                 usbd_enum_unlock(udev);
1108
1109         /* initial status checked */
1110         sc->sc_flags |= UHUB_FLAG_DID_EXPLORE;
1111
1112         return (err);
1113 }
1114
1115 int
1116 uhub_probe(device_t dev)
1117 {
1118         struct usb_attach_arg *uaa = device_get_ivars(dev);
1119
1120         if (uaa->usb_mode != USB_MODE_HOST)
1121                 return (ENXIO);
1122
1123         /*
1124          * The subclass for USB HUBs is currently ignored because it
1125          * is 0 for some and 1 for others.
1126          */
1127         if (uaa->info.bConfigIndex == 0 &&
1128             uaa->info.bDeviceClass == UDCLASS_HUB)
1129                 return (BUS_PROBE_DEFAULT);
1130
1131         return (ENXIO);
1132 }
1133
1134 /* NOTE: The information returned by this function can be wrong. */
1135 usb_error_t
1136 uhub_query_info(struct usb_device *udev, uint8_t *pnports, uint8_t *ptt)
1137 {
1138         struct usb_hub_descriptor hubdesc20;
1139         struct usb_hub_ss_descriptor hubdesc30;
1140         usb_error_t err;
1141         uint8_t nports;
1142         uint8_t tt;
1143
1144         if (udev->ddesc.bDeviceClass != UDCLASS_HUB)
1145                 return (USB_ERR_INVAL);
1146
1147         nports = 0;
1148         tt = 0;
1149
1150         switch (udev->speed) {
1151         case USB_SPEED_LOW:
1152         case USB_SPEED_FULL:
1153         case USB_SPEED_HIGH:
1154                 /* assuming that there is one port */
1155                 err = usbd_req_get_hub_descriptor(udev, NULL, &hubdesc20, 1);
1156                 if (err) {
1157                         DPRINTFN(0, "getting USB 2.0 HUB descriptor failed,"
1158                             "error=%s\n", usbd_errstr(err));
1159                         break;
1160                 }
1161                 nports = hubdesc20.bNbrPorts;
1162                 if (nports > 127)
1163                         nports = 127;
1164
1165                 if (udev->speed == USB_SPEED_HIGH)
1166                         tt = (UGETW(hubdesc20.wHubCharacteristics) >> 5) & 3;
1167                 break;
1168
1169         case USB_SPEED_SUPER:
1170                 err = usbd_req_get_ss_hub_descriptor(udev, NULL, &hubdesc30, 1);
1171                 if (err) {
1172                         DPRINTFN(0, "Getting USB 3.0 HUB descriptor failed,"
1173                             "error=%s\n", usbd_errstr(err));
1174                         break;
1175                 }
1176                 nports = hubdesc30.bNbrPorts;
1177                 if (nports > 16)
1178                         nports = 16;
1179                 break;
1180
1181         default:
1182                 err = USB_ERR_INVAL;
1183                 break;
1184         }
1185
1186         if (pnports != NULL)
1187                 *pnports = nports;
1188
1189         if (ptt != NULL)
1190                 *ptt = tt;
1191
1192         return (err);
1193 }
1194
1195 int
1196 uhub_attach(device_t dev)
1197 {
1198         struct uhub_softc *sc = device_get_softc(dev);
1199         struct usb_attach_arg *uaa = device_get_ivars(dev);
1200         struct usb_device *udev = uaa->device;
1201         struct usb_device *parent_hub = udev->parent_hub;
1202         struct usb_hub *hub;
1203         struct usb_hub_descriptor hubdesc20;
1204         struct usb_hub_ss_descriptor hubdesc30;
1205 #if USB_HAVE_DISABLE_ENUM
1206         struct sysctl_ctx_list *sysctl_ctx;
1207         struct sysctl_oid *sysctl_tree;
1208 #endif
1209         uint16_t pwrdly;
1210         uint16_t nports;
1211         uint8_t x;
1212         uint8_t portno;
1213         uint8_t removable;
1214         uint8_t iface_index;
1215         usb_error_t err;
1216
1217         sc->sc_udev = udev;
1218         sc->sc_dev = dev;
1219
1220         mtx_init(&sc->sc_mtx, "USB HUB mutex", NULL, MTX_DEF);
1221
1222         device_set_usb_desc(dev);
1223
1224         DPRINTFN(2, "depth=%d selfpowered=%d, parent=%p, "
1225             "parent->selfpowered=%d\n",
1226             udev->depth,
1227             udev->flags.self_powered,
1228             parent_hub,
1229             parent_hub ?
1230             parent_hub->flags.self_powered : 0);
1231
1232         if (uhub_is_too_deep(udev)) {
1233                 DPRINTFN(0, "HUB at depth %d, "
1234                     "exceeds maximum. HUB ignored\n", (int)udev->depth);
1235                 goto error;
1236         }
1237
1238         if (!udev->flags.self_powered && parent_hub &&
1239             !parent_hub->flags.self_powered) {
1240                 DPRINTFN(0, "Bus powered HUB connected to "
1241                     "bus powered HUB. HUB ignored\n");
1242                 goto error;
1243         }
1244
1245         if (UHUB_IS_MULTI_TT(sc)) {
1246                 err = usbd_set_alt_interface_index(udev, 0, 1);
1247                 if (err) {
1248                         device_printf(dev, "MTT could not be enabled\n");
1249                         goto error;
1250                 }
1251                 device_printf(dev, "MTT enabled\n");
1252         }
1253
1254         /* get HUB descriptor */
1255
1256         DPRINTFN(2, "Getting HUB descriptor\n");
1257
1258         switch (udev->speed) {
1259         case USB_SPEED_LOW:
1260         case USB_SPEED_FULL:
1261         case USB_SPEED_HIGH:
1262                 /* assuming that there is one port */
1263                 err = usbd_req_get_hub_descriptor(udev, NULL, &hubdesc20, 1);
1264                 if (err) {
1265                         DPRINTFN(0, "getting USB 2.0 HUB descriptor failed,"
1266                             "error=%s\n", usbd_errstr(err));
1267                         goto error;
1268                 }
1269                 /* get number of ports */
1270                 nports = hubdesc20.bNbrPorts;
1271
1272                 /* get power delay */
1273                 pwrdly = ((hubdesc20.bPwrOn2PwrGood * UHD_PWRON_FACTOR) +
1274                     usb_extra_power_up_time);
1275
1276                 /* get complete HUB descriptor */
1277                 if (nports >= 8) {
1278                         /* check number of ports */
1279                         if (nports > 127) {
1280                                 DPRINTFN(0, "Invalid number of USB 2.0 ports,"
1281                                     "error=%s\n", usbd_errstr(err));
1282                                 goto error;
1283                         }
1284                         /* get complete HUB descriptor */
1285                         err = usbd_req_get_hub_descriptor(udev, NULL, &hubdesc20, nports);
1286
1287                         if (err) {
1288                                 DPRINTFN(0, "Getting USB 2.0 HUB descriptor failed,"
1289                                     "error=%s\n", usbd_errstr(err));
1290                                 goto error;
1291                         }
1292                         if (hubdesc20.bNbrPorts != nports) {
1293                                 DPRINTFN(0, "Number of ports changed\n");
1294                                 goto error;
1295                         }
1296                 }
1297                 break;
1298         case USB_SPEED_SUPER:
1299                 if (udev->parent_hub != NULL) {
1300                         err = usbd_req_set_hub_depth(udev, NULL,
1301                             udev->depth - 1);
1302                         if (err) {
1303                                 DPRINTFN(0, "Setting USB 3.0 HUB depth failed,"
1304                                     "error=%s\n", usbd_errstr(err));
1305                                 goto error;
1306                         }
1307                 }
1308                 err = usbd_req_get_ss_hub_descriptor(udev, NULL, &hubdesc30, 1);
1309                 if (err) {
1310                         DPRINTFN(0, "Getting USB 3.0 HUB descriptor failed,"
1311                             "error=%s\n", usbd_errstr(err));
1312                         goto error;
1313                 }
1314                 /* get number of ports */
1315                 nports = hubdesc30.bNbrPorts;
1316
1317                 /* get power delay */
1318                 pwrdly = ((hubdesc30.bPwrOn2PwrGood * UHD_PWRON_FACTOR) +
1319                     usb_extra_power_up_time);
1320
1321                 /* get complete HUB descriptor */
1322                 if (nports >= 8) {
1323                         /* check number of ports */
1324                         if (nports > ((udev->parent_hub != NULL) ? 15 : 127)) {
1325                                 DPRINTFN(0, "Invalid number of USB 3.0 ports,"
1326                                     "error=%s\n", usbd_errstr(err));
1327                                 goto error;
1328                         }
1329                         /* get complete HUB descriptor */
1330                         err = usbd_req_get_ss_hub_descriptor(udev, NULL, &hubdesc30, nports);
1331
1332                         if (err) {
1333                                 DPRINTFN(0, "Getting USB 2.0 HUB descriptor failed,"
1334                                     "error=%s\n", usbd_errstr(err));
1335                                 goto error;
1336                         }
1337                         if (hubdesc30.bNbrPorts != nports) {
1338                                 DPRINTFN(0, "Number of ports changed\n");
1339                                 goto error;
1340                         }
1341                 }
1342                 break;
1343         default:
1344                 DPRINTF("Assuming HUB has only one port\n");
1345                 /* default number of ports */
1346                 nports = 1;
1347                 /* default power delay */
1348                 pwrdly = ((10 * UHD_PWRON_FACTOR) + usb_extra_power_up_time);
1349                 break;
1350         }
1351         if (nports == 0) {
1352                 DPRINTFN(0, "portless HUB\n");
1353                 goto error;
1354         }
1355         if (nports > USB_MAX_PORTS) {
1356                 DPRINTF("Port limit exceeded\n");
1357                 goto error;
1358         }
1359 #if (USB_HAVE_FIXED_PORT == 0)
1360         hub = malloc(sizeof(hub[0]) + (sizeof(hub->ports[0]) * nports),
1361             M_USBDEV, M_WAITOK | M_ZERO);
1362
1363         if (hub == NULL)
1364                 goto error;
1365 #else
1366         hub = &sc->sc_hub;
1367 #endif
1368         udev->hub = hub;
1369
1370         /* initialize HUB structure */
1371         hub->hubsoftc = sc;
1372         hub->explore = &uhub_explore;
1373         hub->nports = nports;
1374         hub->hubudev = udev;
1375 #if USB_HAVE_TT_SUPPORT
1376         hub->tt_msg[0].hdr.pm_callback = &uhub_reset_tt_proc;
1377         hub->tt_msg[0].udev = udev;
1378         hub->tt_msg[1].hdr.pm_callback = &uhub_reset_tt_proc;
1379         hub->tt_msg[1].udev = udev;
1380 #endif
1381         /* if self powered hub, give ports maximum current */
1382         if (udev->flags.self_powered) {
1383                 hub->portpower = USB_MAX_POWER;
1384         } else {
1385                 hub->portpower = USB_MIN_POWER;
1386         }
1387
1388         /* set up interrupt pipe */
1389         iface_index = 0;
1390         if (udev->parent_hub == NULL) {
1391                 /* root HUB is special */
1392                 err = 0;
1393         } else {
1394                 /* normal HUB */
1395                 err = usbd_transfer_setup(udev, &iface_index, sc->sc_xfer,
1396                     uhub_config, UHUB_N_TRANSFER, sc, &sc->sc_mtx);
1397         }
1398         if (err) {
1399                 DPRINTFN(0, "cannot setup interrupt transfer, "
1400                     "errstr=%s\n", usbd_errstr(err));
1401                 goto error;
1402         }
1403         /* wait with power off for a while */
1404         usb_pause_mtx(NULL, USB_MS_TO_TICKS(USB_POWER_DOWN_TIME));
1405
1406 #if USB_HAVE_DISABLE_ENUM
1407         /* Add device sysctls */
1408
1409         sysctl_ctx = device_get_sysctl_ctx(dev);
1410         sysctl_tree = device_get_sysctl_tree(dev);
1411
1412         if (sysctl_ctx != NULL && sysctl_tree != NULL) {
1413                 (void) SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1414                     OID_AUTO, "disable_enumeration", CTLFLAG_RWTUN,
1415                     &sc->sc_disable_enumeration, 0,
1416                     "Set to disable enumeration on this USB HUB.");
1417
1418                 (void) SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1419                     OID_AUTO, "disable_port_power", CTLFLAG_RWTUN,
1420                     &sc->sc_disable_port_power, 0,
1421                     "Set to disable USB port power on this USB HUB.");
1422         }
1423 #endif
1424         /*
1425          * To have the best chance of success we do things in the exact same
1426          * order as Windoze98.  This should not be necessary, but some
1427          * devices do not follow the USB specs to the letter.
1428          *
1429          * These are the events on the bus when a hub is attached:
1430          *  Get device and config descriptors (see attach code)
1431          *  Get hub descriptor (see above)
1432          *  For all ports
1433          *     turn on power
1434          *     wait for power to become stable
1435          * (all below happens in explore code)
1436          *  For all ports
1437          *     clear C_PORT_CONNECTION
1438          *  For all ports
1439          *     get port status
1440          *     if device connected
1441          *        wait 100 ms
1442          *        turn on reset
1443          *        wait
1444          *        clear C_PORT_RESET
1445          *        get port status
1446          *        proceed with device attachment
1447          */
1448
1449         /* XXX should check for none, individual, or ganged power? */
1450
1451         removable = 0;
1452
1453         for (x = 0; x != nports; x++) {
1454                 /* set up data structures */
1455                 struct usb_port *up = hub->ports + x;
1456
1457                 up->device_index = 0;
1458                 up->restartcnt = 0;
1459                 portno = x + 1;
1460
1461                 /* check if port is removable */
1462                 switch (udev->speed) {
1463                 case USB_SPEED_LOW:
1464                 case USB_SPEED_FULL:
1465                 case USB_SPEED_HIGH:
1466                         if (!UHD_NOT_REMOV(&hubdesc20, portno))
1467                                 removable++;
1468                         break;
1469                 case USB_SPEED_SUPER:
1470                         if (!UHD_NOT_REMOV(&hubdesc30, portno))
1471                                 removable++;
1472                         break;
1473                 default:
1474                         DPRINTF("Assuming removable port\n");
1475                         removable++;
1476                         break;
1477                 }
1478                 if (err == 0) {
1479 #if USB_HAVE_DISABLE_ENUM
1480                         /* check if we should disable USB port power or not */
1481                         if (usb_disable_port_power != 0 ||
1482                             sc->sc_disable_port_power != 0) {
1483                                 /* turn the power off */
1484                                 DPRINTFN(2, "Turning port %d power off\n", portno);
1485                                 err = usbd_req_clear_port_feature(udev, NULL,
1486                                     portno, UHF_PORT_POWER);
1487                         } else {
1488 #endif
1489                                 /* turn the power on */
1490                                 DPRINTFN(2, "Turning port %d power on\n", portno);
1491                                 err = usbd_req_set_port_feature(udev, NULL,
1492                                     portno, UHF_PORT_POWER);
1493 #if USB_HAVE_DISABLE_ENUM
1494                         }
1495 #endif
1496                 }
1497                 if (err != 0) {
1498                         DPRINTFN(0, "port %d power on or off failed, %s\n",
1499                             portno, usbd_errstr(err));
1500                 }
1501                 DPRINTF("turn on port %d power\n",
1502                     portno);
1503
1504                 /* wait for stable power */
1505                 usb_pause_mtx(NULL, USB_MS_TO_TICKS(pwrdly));
1506         }
1507
1508         device_printf(dev, "%d port%s with %d "
1509             "removable, %s powered\n", nports, (nports != 1) ? "s" : "",
1510             removable, udev->flags.self_powered ? "self" : "bus");
1511
1512         /* Start the interrupt endpoint, if any */
1513
1514         USB_MTX_LOCK(&sc->sc_mtx);
1515         usbd_transfer_start(sc->sc_xfer[UHUB_INTR_TRANSFER]);
1516         USB_MTX_UNLOCK(&sc->sc_mtx);
1517
1518         /* Enable automatic power save on all USB HUBs */
1519
1520         usbd_set_power_mode(udev, USB_POWER_MODE_SAVE);
1521
1522         return (0);
1523
1524 error:
1525         usbd_transfer_unsetup(sc->sc_xfer, UHUB_N_TRANSFER);
1526
1527 #if (USB_HAVE_FIXED_PORT == 0)
1528         free(udev->hub, M_USBDEV);
1529 #endif
1530         udev->hub = NULL;
1531
1532         mtx_destroy(&sc->sc_mtx);
1533
1534         return (ENXIO);
1535 }
1536
1537 /*
1538  * Called from process context when the hub is gone.
1539  * Detach all devices on active ports.
1540  */
1541 int
1542 uhub_detach(device_t dev)
1543 {
1544         struct uhub_softc *sc = device_get_softc(dev);
1545         struct usb_hub *hub = sc->sc_udev->hub;
1546         struct usb_bus *bus = sc->sc_udev->bus;
1547         struct usb_device *child;
1548         uint8_t x;
1549
1550         if (hub == NULL)                /* must be partially working */
1551                 return (0);
1552
1553         /* Make sure interrupt transfer is gone. */
1554         usbd_transfer_unsetup(sc->sc_xfer, UHUB_N_TRANSFER);
1555
1556         /* Detach all ports */
1557         for (x = 0; x != hub->nports; x++) {
1558                 child = usb_bus_port_get_device(bus, hub->ports + x);
1559
1560                 if (child == NULL) {
1561                         continue;
1562                 }
1563
1564                 /*
1565                  * Free USB device and all subdevices, if any.
1566                  */
1567                 usb_free_device(child, 0);
1568         }
1569
1570 #if USB_HAVE_TT_SUPPORT
1571         /* Make sure our TT messages are not queued anywhere */
1572         USB_BUS_LOCK(bus);
1573         usb_proc_mwait(USB_BUS_TT_PROC(bus),
1574             &hub->tt_msg[0], &hub->tt_msg[1]);
1575         USB_BUS_UNLOCK(bus);
1576 #endif
1577
1578 #if (USB_HAVE_FIXED_PORT == 0)
1579         free(hub, M_USBDEV);
1580 #endif
1581         sc->sc_udev->hub = NULL;
1582
1583         mtx_destroy(&sc->sc_mtx);
1584
1585         return (0);
1586 }
1587
1588 static int
1589 uhub_suspend(device_t dev)
1590 {
1591         DPRINTF("\n");
1592         /* Sub-devices are not suspended here! */
1593         return (0);
1594 }
1595
1596 static int
1597 uhub_resume(device_t dev)
1598 {
1599         DPRINTF("\n");
1600         /* Sub-devices are not resumed here! */
1601         return (0);
1602 }
1603
1604 static void
1605 uhub_driver_added(device_t dev, driver_t *driver)
1606 {
1607         usb_needs_explore_all();
1608 }
1609
1610 void
1611 uhub_find_iface_index(struct usb_hub *hub, device_t child,
1612     struct hub_result *res)
1613 {
1614         struct usb_interface *iface;
1615         struct usb_device *udev;
1616         uint8_t nports;
1617         uint8_t x;
1618         uint8_t i;
1619
1620         nports = hub->nports;
1621         for (x = 0; x != nports; x++) {
1622                 udev = usb_bus_port_get_device(hub->hubudev->bus,
1623                     hub->ports + x);
1624                 if (!udev) {
1625                         continue;
1626                 }
1627                 for (i = 0; i != USB_IFACE_MAX; i++) {
1628                         iface = usbd_get_iface(udev, i);
1629                         if (iface &&
1630                             (iface->subdev == child)) {
1631                                 res->iface_index = i;
1632                                 res->udev = udev;
1633                                 res->portno = x + 1;
1634                                 return;
1635                         }
1636                 }
1637         }
1638         res->iface_index = 0;
1639         res->udev = NULL;
1640         res->portno = 0;
1641 }
1642
1643 int
1644 uhub_child_location_string(device_t parent, device_t child,
1645     char *buf, size_t buflen)
1646 {
1647         struct uhub_softc *sc;
1648         struct usb_hub *hub;
1649         struct hub_result res;
1650
1651         if (!device_is_attached(parent)) {
1652                 if (buflen)
1653                         buf[0] = 0;
1654                 return (0);
1655         }
1656
1657         sc = device_get_softc(parent);
1658         hub = sc->sc_udev->hub;
1659
1660         mtx_lock(&Giant);
1661         uhub_find_iface_index(hub, child, &res);
1662         if (!res.udev) {
1663                 DPRINTF("device not on hub\n");
1664                 if (buflen) {
1665                         buf[0] = '\0';
1666                 }
1667                 goto done;
1668         }
1669         snprintf(buf, buflen, "bus=%u hubaddr=%u port=%u devaddr=%u"
1670             " interface=%u"
1671 #if USB_HAVE_UGEN
1672             " ugen=%s"
1673 #endif
1674             , device_get_unit(res.udev->bus->bdev)
1675             , (res.udev->parent_hub != NULL) ?
1676             res.udev->parent_hub->device_index : 0
1677             , res.portno, res.udev->device_index, res.iface_index
1678 #if USB_HAVE_UGEN
1679             , res.udev->ugen_name
1680 #endif
1681             );
1682 done:
1683         mtx_unlock(&Giant);
1684
1685         return (0);
1686 }
1687
1688 static int
1689 uhub_child_pnpinfo_string(device_t parent, device_t child,
1690     char *buf, size_t buflen)
1691 {
1692         struct uhub_softc *sc;
1693         struct usb_hub *hub;
1694         struct usb_interface *iface;
1695         struct hub_result res;
1696         uint8_t do_unlock;
1697
1698         if (!device_is_attached(parent)) {
1699                 if (buflen)
1700                         buf[0] = 0;
1701                 return (0);
1702         }
1703
1704         sc = device_get_softc(parent);
1705         hub = sc->sc_udev->hub;
1706
1707         mtx_lock(&Giant);
1708         uhub_find_iface_index(hub, child, &res);
1709         if (!res.udev) {
1710                 DPRINTF("device not on hub\n");
1711                 if (buflen) {
1712                         buf[0] = '\0';
1713                 }
1714                 goto done;
1715         }
1716         iface = usbd_get_iface(res.udev, res.iface_index);
1717         if (iface && iface->idesc) {
1718                 /* Make sure device information is not changed during the print. */
1719                 do_unlock = usbd_ctrl_lock(res.udev);
1720
1721                 snprintf(buf, buflen, "vendor=0x%04x product=0x%04x "
1722                     "devclass=0x%02x devsubclass=0x%02x "
1723                     "devproto=0x%02x "
1724                     "sernum=\"%s\" "
1725                     "release=0x%04x "
1726                     "mode=%s "
1727                     "intclass=0x%02x intsubclass=0x%02x "
1728                     "intprotocol=0x%02x" "%s%s",
1729                     UGETW(res.udev->ddesc.idVendor),
1730                     UGETW(res.udev->ddesc.idProduct),
1731                     res.udev->ddesc.bDeviceClass,
1732                     res.udev->ddesc.bDeviceSubClass,
1733                     res.udev->ddesc.bDeviceProtocol,
1734                     usb_get_serial(res.udev),
1735                     UGETW(res.udev->ddesc.bcdDevice),
1736                     (res.udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device",
1737                     iface->idesc->bInterfaceClass,
1738                     iface->idesc->bInterfaceSubClass,
1739                     iface->idesc->bInterfaceProtocol,
1740                     iface->pnpinfo ? " " : "",
1741                     iface->pnpinfo ? iface->pnpinfo : "");
1742
1743                 if (do_unlock)
1744                         usbd_ctrl_unlock(res.udev);
1745         } else {
1746                 if (buflen) {
1747                         buf[0] = '\0';
1748                 }
1749                 goto done;
1750         }
1751 done:
1752         mtx_unlock(&Giant);
1753
1754         return (0);
1755 }
1756
1757 /*
1758  * The USB Transaction Translator:
1759  * ===============================
1760  *
1761  * When doing LOW- and FULL-speed USB transfers across a HIGH-speed
1762  * USB HUB, bandwidth must be allocated for ISOCHRONOUS and INTERRUPT
1763  * USB transfers. To utilize bandwidth dynamically the "scatter and
1764  * gather" principle must be applied. This means that bandwidth must
1765  * be divided into equal parts of bandwidth. With regard to USB all
1766  * data is transferred in smaller packets with length
1767  * "wMaxPacketSize". The problem however is that "wMaxPacketSize" is
1768  * not a constant!
1769  *
1770  * The bandwidth scheduler which I have implemented will simply pack
1771  * the USB transfers back to back until there is no more space in the
1772  * schedule. Out of the 8 microframes which the USB 2.0 standard
1773  * provides, only 6 are available for non-HIGH-speed devices. I have
1774  * reserved the first 4 microframes for ISOCHRONOUS transfers. The
1775  * last 2 microframes I have reserved for INTERRUPT transfers. Without
1776  * this division, it is very difficult to allocate and free bandwidth
1777  * dynamically.
1778  *
1779  * NOTE about the Transaction Translator in USB HUBs:
1780  *
1781  * USB HUBs have a very simple Transaction Translator, that will
1782  * simply pipeline all the SPLIT transactions. That means that the
1783  * transactions will be executed in the order they are queued!
1784  *
1785  */
1786
1787 /*------------------------------------------------------------------------*
1788  *      usb_intr_find_best_slot
1789  *
1790  * Return value:
1791  *   The best Transaction Translation slot for an interrupt endpoint.
1792  *------------------------------------------------------------------------*/
1793 static uint8_t
1794 usb_intr_find_best_slot(usb_size_t *ptr, uint8_t start,
1795     uint8_t end, uint8_t mask)
1796 {
1797         usb_size_t min = (usb_size_t)-1;
1798         usb_size_t sum;
1799         uint8_t x;
1800         uint8_t y;
1801         uint8_t z;
1802
1803         y = 0;
1804
1805         /* find the last slot with lesser used bandwidth */
1806
1807         for (x = start; x < end; x++) {
1808                 sum = 0;
1809
1810                 /* compute sum of bandwidth */
1811                 for (z = x; z < end; z++) {
1812                         if (mask & (1U << (z - x)))
1813                                 sum += ptr[z];
1814                 }
1815
1816                 /* check if the current multi-slot is more optimal */
1817                 if (min >= sum) {
1818                         min = sum;
1819                         y = x;
1820                 }
1821
1822                 /* check if the mask is about to be shifted out */
1823                 if (mask & (1U << (end - 1 - x)))
1824                         break;
1825         }
1826         return (y);
1827 }
1828
1829 /*------------------------------------------------------------------------*
1830  *      usb_hs_bandwidth_adjust
1831  *
1832  * This function will update the bandwidth usage for the microframe
1833  * having index "slot" by "len" bytes. "len" can be negative.  If the
1834  * "slot" argument is greater or equal to "USB_HS_MICRO_FRAMES_MAX"
1835  * the "slot" argument will be replaced by the slot having least used
1836  * bandwidth. The "mask" argument is used for multi-slot allocations.
1837  *
1838  * Returns:
1839  *    The slot in which the bandwidth update was done: 0..7
1840  *------------------------------------------------------------------------*/
1841 static uint8_t
1842 usb_hs_bandwidth_adjust(struct usb_device *udev, int16_t len,
1843     uint8_t slot, uint8_t mask)
1844 {
1845         struct usb_bus *bus = udev->bus;
1846         struct usb_hub *hub;
1847         enum usb_dev_speed speed;
1848         uint8_t x;
1849
1850         USB_BUS_LOCK_ASSERT(bus, MA_OWNED);
1851
1852         speed = usbd_get_speed(udev);
1853
1854         switch (speed) {
1855         case USB_SPEED_LOW:
1856         case USB_SPEED_FULL:
1857                 if (speed == USB_SPEED_LOW) {
1858                         len *= 8;
1859                 }
1860                 /*
1861                  * The Host Controller Driver should have
1862                  * performed checks so that the lookup
1863                  * below does not result in a NULL pointer
1864                  * access.
1865                  */
1866
1867                 hub = udev->parent_hs_hub->hub;
1868                 if (slot >= USB_HS_MICRO_FRAMES_MAX) {
1869                         slot = usb_intr_find_best_slot(hub->uframe_usage,
1870                             USB_FS_ISOC_UFRAME_MAX, 6, mask);
1871                 }
1872                 for (x = slot; x < 8; x++) {
1873                         if (mask & (1U << (x - slot))) {
1874                                 hub->uframe_usage[x] += len;
1875                                 bus->uframe_usage[x] += len;
1876                         }
1877                 }
1878                 break;
1879         default:
1880                 if (slot >= USB_HS_MICRO_FRAMES_MAX) {
1881                         slot = usb_intr_find_best_slot(bus->uframe_usage, 0,
1882                             USB_HS_MICRO_FRAMES_MAX, mask);
1883                 }
1884                 for (x = slot; x < 8; x++) {
1885                         if (mask & (1U << (x - slot))) {
1886                                 bus->uframe_usage[x] += len;
1887                         }
1888                 }
1889                 break;
1890         }
1891         return (slot);
1892 }
1893
1894 /*------------------------------------------------------------------------*
1895  *      usb_hs_bandwidth_alloc
1896  *
1897  * This function is a wrapper function for "usb_hs_bandwidth_adjust()".
1898  *------------------------------------------------------------------------*/
1899 void
1900 usb_hs_bandwidth_alloc(struct usb_xfer *xfer)
1901 {
1902         struct usb_device *udev;
1903         uint8_t slot;
1904         uint8_t mask;
1905         uint8_t speed;
1906
1907         udev = xfer->xroot->udev;
1908
1909         if (udev->flags.usb_mode != USB_MODE_HOST)
1910                 return;         /* not supported */
1911
1912         xfer->endpoint->refcount_bw++;
1913         if (xfer->endpoint->refcount_bw != 1)
1914                 return;         /* already allocated */
1915
1916         speed = usbd_get_speed(udev);
1917
1918         switch (xfer->endpoint->edesc->bmAttributes & UE_XFERTYPE) {
1919         case UE_INTERRUPT:
1920                 /* allocate a microframe slot */
1921
1922                 mask = 0x01;
1923                 slot = usb_hs_bandwidth_adjust(udev,
1924                     xfer->max_frame_size, USB_HS_MICRO_FRAMES_MAX, mask);
1925
1926                 xfer->endpoint->usb_uframe = slot;
1927                 xfer->endpoint->usb_smask = mask << slot;
1928
1929                 if ((speed != USB_SPEED_FULL) &&
1930                     (speed != USB_SPEED_LOW)) {
1931                         xfer->endpoint->usb_cmask = 0x00 ;
1932                 } else {
1933                         xfer->endpoint->usb_cmask = (-(0x04 << slot)) & 0xFE;
1934                 }
1935                 break;
1936
1937         case UE_ISOCHRONOUS:
1938                 switch (usbd_xfer_get_fps_shift(xfer)) {
1939                 case 0:
1940                         mask = 0xFF;
1941                         break;
1942                 case 1:
1943                         mask = 0x55;
1944                         break;
1945                 case 2:
1946                         mask = 0x11;
1947                         break;
1948                 default:
1949                         mask = 0x01;
1950                         break;
1951                 }
1952
1953                 /* allocate a microframe multi-slot */
1954
1955                 slot = usb_hs_bandwidth_adjust(udev,
1956                     xfer->max_frame_size, USB_HS_MICRO_FRAMES_MAX, mask);
1957
1958                 xfer->endpoint->usb_uframe = slot;
1959                 xfer->endpoint->usb_cmask = 0;
1960                 xfer->endpoint->usb_smask = mask << slot;
1961                 break;
1962
1963         default:
1964                 xfer->endpoint->usb_uframe = 0;
1965                 xfer->endpoint->usb_cmask = 0;
1966                 xfer->endpoint->usb_smask = 0;
1967                 break;
1968         }
1969
1970         DPRINTFN(11, "slot=%d, mask=0x%02x\n",
1971             xfer->endpoint->usb_uframe,
1972             xfer->endpoint->usb_smask >> xfer->endpoint->usb_uframe);
1973 }
1974
1975 /*------------------------------------------------------------------------*
1976  *      usb_hs_bandwidth_free
1977  *
1978  * This function is a wrapper function for "usb_hs_bandwidth_adjust()".
1979  *------------------------------------------------------------------------*/
1980 void
1981 usb_hs_bandwidth_free(struct usb_xfer *xfer)
1982 {
1983         struct usb_device *udev;
1984         uint8_t slot;
1985         uint8_t mask;
1986
1987         udev = xfer->xroot->udev;
1988
1989         if (udev->flags.usb_mode != USB_MODE_HOST)
1990                 return;         /* not supported */
1991
1992         xfer->endpoint->refcount_bw--;
1993         if (xfer->endpoint->refcount_bw != 0)
1994                 return;         /* still allocated */
1995
1996         switch (xfer->endpoint->edesc->bmAttributes & UE_XFERTYPE) {
1997         case UE_INTERRUPT:
1998         case UE_ISOCHRONOUS:
1999
2000                 slot = xfer->endpoint->usb_uframe;
2001                 mask = xfer->endpoint->usb_smask;
2002
2003                 /* free microframe slot(s): */
2004                 usb_hs_bandwidth_adjust(udev,
2005                     -xfer->max_frame_size, slot, mask >> slot);
2006
2007                 DPRINTFN(11, "slot=%d, mask=0x%02x\n",
2008                     slot, mask >> slot);
2009
2010                 xfer->endpoint->usb_uframe = 0;
2011                 xfer->endpoint->usb_cmask = 0;
2012                 xfer->endpoint->usb_smask = 0;
2013                 break;
2014
2015         default:
2016                 break;
2017         }
2018 }
2019
2020 /*------------------------------------------------------------------------*
2021  *      usb_isoc_time_expand
2022  *
2023  * This function will expand the time counter from 7-bit to 16-bit.
2024  *
2025  * Returns:
2026  *   16-bit isochronous time counter.
2027  *------------------------------------------------------------------------*/
2028 uint16_t
2029 usb_isoc_time_expand(struct usb_bus *bus, uint16_t isoc_time_curr)
2030 {
2031         uint16_t rem;
2032
2033         USB_BUS_LOCK_ASSERT(bus, MA_OWNED);
2034
2035         rem = bus->isoc_time_last & (USB_ISOC_TIME_MAX - 1);
2036
2037         isoc_time_curr &= (USB_ISOC_TIME_MAX - 1);
2038
2039         if (isoc_time_curr < rem) {
2040                 /* the time counter wrapped around */
2041                 bus->isoc_time_last += USB_ISOC_TIME_MAX;
2042         }
2043         /* update the remainder */
2044
2045         bus->isoc_time_last &= ~(USB_ISOC_TIME_MAX - 1);
2046         bus->isoc_time_last |= isoc_time_curr;
2047
2048         return (bus->isoc_time_last);
2049 }
2050
2051 /*------------------------------------------------------------------------*
2052  *      usbd_fs_isoc_schedule_alloc_slot
2053  *
2054  * This function will allocate bandwidth for an isochronous FULL speed
2055  * transaction in the FULL speed schedule.
2056  *
2057  * Returns:
2058  *    <8: Success
2059  * Else: Error
2060  *------------------------------------------------------------------------*/
2061 #if USB_HAVE_TT_SUPPORT
2062 uint8_t
2063 usbd_fs_isoc_schedule_alloc_slot(struct usb_xfer *isoc_xfer, uint16_t isoc_time)
2064 {
2065         struct usb_xfer *xfer;
2066         struct usb_xfer *pipe_xfer;
2067         struct usb_bus *bus;
2068         usb_frlength_t len;
2069         usb_frlength_t data_len;
2070         uint16_t delta;
2071         uint16_t slot;
2072         uint8_t retval;
2073
2074         data_len = 0;
2075         slot = 0;
2076
2077         bus = isoc_xfer->xroot->bus;
2078
2079         TAILQ_FOREACH(xfer, &bus->intr_q.head, wait_entry) {
2080                 /* skip self, if any */
2081
2082                 if (xfer == isoc_xfer)
2083                         continue;
2084
2085                 /* check if this USB transfer is going through the same TT */
2086
2087                 if (xfer->xroot->udev->parent_hs_hub !=
2088                     isoc_xfer->xroot->udev->parent_hs_hub) {
2089                         continue;
2090                 }
2091                 if ((isoc_xfer->xroot->udev->parent_hs_hub->
2092                     ddesc.bDeviceProtocol == UDPROTO_HSHUBMTT) &&
2093                     (xfer->xroot->udev->hs_port_no !=
2094                     isoc_xfer->xroot->udev->hs_port_no)) {
2095                         continue;
2096                 }
2097                 if (xfer->endpoint->methods != isoc_xfer->endpoint->methods)
2098                         continue;
2099
2100                 /* check if isoc_time is part of this transfer */
2101
2102                 delta = xfer->isoc_time_complete - isoc_time;
2103                 if (delta > 0 && delta <= xfer->nframes) {
2104                         delta = xfer->nframes - delta;
2105
2106                         len = xfer->frlengths[delta];
2107                         len += 8;
2108                         len *= 7;
2109                         len /= 6;
2110
2111                         data_len += len;
2112                 }
2113
2114                 /*
2115                  * Check double buffered transfers. Only stream ID
2116                  * equal to zero is valid here!
2117                  */
2118                 TAILQ_FOREACH(pipe_xfer, &xfer->endpoint->endpoint_q[0].head,
2119                     wait_entry) {
2120                         /* skip self, if any */
2121
2122                         if (pipe_xfer == isoc_xfer)
2123                                 continue;
2124
2125                         /* check if isoc_time is part of this transfer */
2126
2127                         delta = pipe_xfer->isoc_time_complete - isoc_time;
2128                         if (delta > 0 && delta <= pipe_xfer->nframes) {
2129                                 delta = pipe_xfer->nframes - delta;
2130
2131                                 len = pipe_xfer->frlengths[delta];
2132                                 len += 8;
2133                                 len *= 7;
2134                                 len /= 6;
2135
2136                                 data_len += len;
2137                         }
2138                 }
2139         }
2140
2141         while (data_len >= USB_FS_BYTES_PER_HS_UFRAME) {
2142                 data_len -= USB_FS_BYTES_PER_HS_UFRAME;
2143                 slot++;
2144         }
2145
2146         /* check for overflow */
2147
2148         if (slot >= USB_FS_ISOC_UFRAME_MAX)
2149                 return (255);
2150
2151         retval = slot;
2152
2153         delta = isoc_xfer->isoc_time_complete - isoc_time;
2154         if (delta > 0 && delta <= isoc_xfer->nframes) {
2155                 delta = isoc_xfer->nframes - delta;
2156
2157                 len = isoc_xfer->frlengths[delta];
2158                 len += 8;
2159                 len *= 7;
2160                 len /= 6;
2161
2162                 data_len += len;
2163         }
2164
2165         while (data_len >= USB_FS_BYTES_PER_HS_UFRAME) {
2166                 data_len -= USB_FS_BYTES_PER_HS_UFRAME;
2167                 slot++;
2168         }
2169
2170         /* check for overflow */
2171
2172         if (slot >= USB_FS_ISOC_UFRAME_MAX)
2173                 return (255);
2174
2175         return (retval);
2176 }
2177 #endif
2178
2179 /*------------------------------------------------------------------------*
2180  *      usb_bus_port_get_device
2181  *
2182  * This function is NULL safe.
2183  *------------------------------------------------------------------------*/
2184 struct usb_device *
2185 usb_bus_port_get_device(struct usb_bus *bus, struct usb_port *up)
2186 {
2187         if ((bus == NULL) || (up == NULL)) {
2188                 /* be NULL safe */
2189                 return (NULL);
2190         }
2191         if (up->device_index == 0) {
2192                 /* nothing to do */
2193                 return (NULL);
2194         }
2195         return (bus->devices[up->device_index]);
2196 }
2197
2198 /*------------------------------------------------------------------------*
2199  *      usb_bus_port_set_device
2200  *
2201  * This function is NULL safe.
2202  *------------------------------------------------------------------------*/
2203 void
2204 usb_bus_port_set_device(struct usb_bus *bus, struct usb_port *up,
2205     struct usb_device *udev, uint8_t device_index)
2206 {
2207         if (bus == NULL) {
2208                 /* be NULL safe */
2209                 return;
2210         }
2211         /*
2212          * There is only one case where we don't
2213          * have an USB port, and that is the Root Hub!
2214          */
2215         if (up) {
2216                 if (udev) {
2217                         up->device_index = device_index;
2218                 } else {
2219                         device_index = up->device_index;
2220                         up->device_index = 0;
2221                 }
2222         }
2223         /*
2224          * Make relationships to our new device
2225          */
2226         if (device_index != 0) {
2227 #if USB_HAVE_UGEN
2228                 mtx_lock(&usb_ref_lock);
2229 #endif
2230                 bus->devices[device_index] = udev;
2231 #if USB_HAVE_UGEN
2232                 mtx_unlock(&usb_ref_lock);
2233 #endif
2234         }
2235         /*
2236          * Debug print
2237          */
2238         DPRINTFN(2, "bus %p devices[%u] = %p\n", bus, device_index, udev);
2239 }
2240
2241 /*------------------------------------------------------------------------*
2242  *      usb_needs_explore
2243  *
2244  * This functions is called when the USB event thread needs to run.
2245  *------------------------------------------------------------------------*/
2246 void
2247 usb_needs_explore(struct usb_bus *bus, uint8_t do_probe)
2248 {
2249         uint8_t do_unlock;
2250
2251         DPRINTF("\n");
2252
2253         if (cold != 0) {
2254                 DPRINTF("Cold\n");
2255                 return;
2256         }
2257
2258         if (bus == NULL) {
2259                 DPRINTF("No bus pointer!\n");
2260                 return;
2261         }
2262         if ((bus->devices == NULL) ||
2263             (bus->devices[USB_ROOT_HUB_ADDR] == NULL)) {
2264                 DPRINTF("No root HUB\n");
2265                 return;
2266         }
2267         if (mtx_owned(&bus->bus_mtx)) {
2268                 do_unlock = 0;
2269         } else {
2270                 USB_BUS_LOCK(bus);
2271                 do_unlock = 1;
2272         }
2273         if (do_probe) {
2274                 bus->do_probe = 1;
2275         }
2276         if (usb_proc_msignal(USB_BUS_EXPLORE_PROC(bus),
2277             &bus->explore_msg[0], &bus->explore_msg[1])) {
2278                 /* ignore */
2279         }
2280         if (do_unlock) {
2281                 USB_BUS_UNLOCK(bus);
2282         }
2283 }
2284
2285 /*------------------------------------------------------------------------*
2286  *      usb_needs_explore_all
2287  *
2288  * This function is called whenever a new driver is loaded and will
2289  * cause that all USB buses are re-explored.
2290  *------------------------------------------------------------------------*/
2291 void
2292 usb_needs_explore_all(void)
2293 {
2294         struct usb_bus *bus;
2295         devclass_t dc;
2296         device_t dev;
2297         int max;
2298
2299         DPRINTFN(3, "\n");
2300
2301         dc = usb_devclass_ptr;
2302         if (dc == NULL) {
2303                 DPRINTFN(0, "no devclass\n");
2304                 return;
2305         }
2306         /*
2307          * Explore all USB buses in parallel.
2308          */
2309         max = devclass_get_maxunit(dc);
2310         while (max >= 0) {
2311                 dev = devclass_get_device(dc, max);
2312                 if (dev) {
2313                         bus = device_get_softc(dev);
2314                         if (bus) {
2315                                 usb_needs_explore(bus, 1);
2316                         }
2317                 }
2318                 max--;
2319         }
2320 }
2321
2322 /*------------------------------------------------------------------------*
2323  *      usb_needs_explore_init
2324  *
2325  * This function will ensure that the USB controllers are not enumerated
2326  * until the "cold" variable is cleared.
2327  *------------------------------------------------------------------------*/
2328 static void
2329 usb_needs_explore_init(void *arg)
2330 {
2331         /*
2332          * The cold variable should be cleared prior to this function
2333          * being called:
2334          */
2335         if (cold == 0)
2336                 usb_needs_explore_all();
2337         else
2338                 DPRINTFN(-1, "Cold variable is still set!\n");
2339 }
2340 SYSINIT(usb_needs_explore_init, SI_SUB_KICK_SCHEDULER, SI_ORDER_SECOND, usb_needs_explore_init, NULL);
2341
2342 /*------------------------------------------------------------------------*
2343  *      usb_bus_power_update
2344  *
2345  * This function will ensure that all USB devices on the given bus are
2346  * properly suspended or resumed according to the device transfer
2347  * state.
2348  *------------------------------------------------------------------------*/
2349 #if USB_HAVE_POWERD
2350 void
2351 usb_bus_power_update(struct usb_bus *bus)
2352 {
2353         usb_needs_explore(bus, 0 /* no probe */ );
2354 }
2355 #endif
2356
2357 /*------------------------------------------------------------------------*
2358  *      usbd_transfer_power_ref
2359  *
2360  * This function will modify the power save reference counts and
2361  * wakeup the USB device associated with the given USB transfer, if
2362  * needed.
2363  *------------------------------------------------------------------------*/
2364 #if USB_HAVE_POWERD
2365 void
2366 usbd_transfer_power_ref(struct usb_xfer *xfer, int val)
2367 {
2368         static const usb_power_mask_t power_mask[4] = {
2369                 [UE_CONTROL] = USB_HW_POWER_CONTROL,
2370                 [UE_BULK] = USB_HW_POWER_BULK,
2371                 [UE_INTERRUPT] = USB_HW_POWER_INTERRUPT,
2372                 [UE_ISOCHRONOUS] = USB_HW_POWER_ISOC,
2373         };
2374         struct usb_device *udev;
2375         uint8_t needs_explore;
2376         uint8_t needs_hw_power;
2377         uint8_t xfer_type;
2378
2379         udev = xfer->xroot->udev;
2380
2381         if (udev->device_index == USB_ROOT_HUB_ADDR) {
2382                 /* no power save for root HUB */
2383                 return;
2384         }
2385         USB_BUS_LOCK(udev->bus);
2386
2387         xfer_type = xfer->endpoint->edesc->bmAttributes & UE_XFERTYPE;
2388
2389         udev->pwr_save.last_xfer_time = ticks;
2390         udev->pwr_save.type_refs[xfer_type] += val;
2391
2392         if (xfer->flags_int.control_xfr) {
2393                 udev->pwr_save.read_refs += val;
2394                 if (xfer->flags_int.usb_mode == USB_MODE_HOST) {
2395                         /*
2396                          * It is not allowed to suspend during a
2397                          * control transfer:
2398                          */
2399                         udev->pwr_save.write_refs += val;
2400                 }
2401         } else if (USB_GET_DATA_ISREAD(xfer)) {
2402                 udev->pwr_save.read_refs += val;
2403         } else {
2404                 udev->pwr_save.write_refs += val;
2405         }
2406
2407         if (val > 0) {
2408                 if (udev->flags.self_suspended)
2409                         needs_explore = usb_peer_should_wakeup(udev);
2410                 else
2411                         needs_explore = 0;
2412
2413                 if (!(udev->bus->hw_power_state & power_mask[xfer_type])) {
2414                         DPRINTF("Adding type %u to power state\n", xfer_type);
2415                         udev->bus->hw_power_state |= power_mask[xfer_type];
2416                         needs_hw_power = 1;
2417                 } else {
2418                         needs_hw_power = 0;
2419                 }
2420         } else {
2421                 needs_explore = 0;
2422                 needs_hw_power = 0;
2423         }
2424
2425         USB_BUS_UNLOCK(udev->bus);
2426
2427         if (needs_explore) {
2428                 DPRINTF("update\n");
2429                 usb_bus_power_update(udev->bus);
2430         } else if (needs_hw_power) {
2431                 DPRINTF("needs power\n");
2432                 if (udev->bus->methods->set_hw_power != NULL) {
2433                         (udev->bus->methods->set_hw_power) (udev->bus);
2434                 }
2435         }
2436 }
2437 #endif
2438
2439 /*------------------------------------------------------------------------*
2440  *      usb_peer_should_wakeup
2441  *
2442  * This function returns non-zero if the current device should wake up.
2443  *------------------------------------------------------------------------*/
2444 static uint8_t
2445 usb_peer_should_wakeup(struct usb_device *udev)
2446 {
2447         return (((udev->power_mode == USB_POWER_MODE_ON) &&
2448             (udev->flags.usb_mode == USB_MODE_HOST)) ||
2449             (udev->driver_added_refcount != udev->bus->driver_added_refcount) ||
2450             (udev->re_enumerate_wait != USB_RE_ENUM_DONE) ||
2451             (udev->pwr_save.type_refs[UE_ISOCHRONOUS] != 0) ||
2452             (udev->pwr_save.write_refs != 0) ||
2453             ((udev->pwr_save.read_refs != 0) &&
2454             (udev->flags.usb_mode == USB_MODE_HOST) &&
2455             (usb_peer_can_wakeup(udev) == 0)));
2456 }
2457
2458 /*------------------------------------------------------------------------*
2459  *      usb_bus_powerd
2460  *
2461  * This function implements the USB power daemon and is called
2462  * regularly from the USB explore thread.
2463  *------------------------------------------------------------------------*/
2464 #if USB_HAVE_POWERD
2465 void
2466 usb_bus_powerd(struct usb_bus *bus)
2467 {
2468         struct usb_device *udev;
2469         usb_ticks_t temp;
2470         usb_ticks_t limit;
2471         usb_ticks_t mintime;
2472         usb_size_t type_refs[5];
2473         uint8_t x;
2474
2475         limit = usb_power_timeout;
2476         if (limit == 0)
2477                 limit = hz;
2478         else if (limit > 255)
2479                 limit = 255 * hz;
2480         else
2481                 limit = limit * hz;
2482
2483         DPRINTF("bus=%p\n", bus);
2484
2485         USB_BUS_LOCK(bus);
2486
2487         /*
2488          * The root HUB device is never suspended
2489          * and we simply skip it.
2490          */
2491         for (x = USB_ROOT_HUB_ADDR + 1;
2492             x != bus->devices_max; x++) {
2493                 udev = bus->devices[x];
2494                 if (udev == NULL)
2495                         continue;
2496
2497                 temp = ticks - udev->pwr_save.last_xfer_time;
2498
2499                 if (usb_peer_should_wakeup(udev)) {
2500                         /* check if we are suspended */
2501                         if (udev->flags.self_suspended != 0) {
2502                                 USB_BUS_UNLOCK(bus);
2503                                 usb_dev_resume_peer(udev);
2504                                 USB_BUS_LOCK(bus);
2505                         }
2506                 } else if ((temp >= limit) &&
2507                     (udev->flags.usb_mode == USB_MODE_HOST) &&
2508                     (udev->flags.self_suspended == 0)) {
2509                         /* try to do suspend */
2510
2511                         USB_BUS_UNLOCK(bus);
2512                         usb_dev_suspend_peer(udev);
2513                         USB_BUS_LOCK(bus);
2514                 }
2515         }
2516
2517         /* reset counters */
2518
2519         mintime = (usb_ticks_t)-1;
2520         type_refs[0] = 0;
2521         type_refs[1] = 0;
2522         type_refs[2] = 0;
2523         type_refs[3] = 0;
2524         type_refs[4] = 0;
2525
2526         /* Re-loop all the devices to get the actual state */
2527
2528         for (x = USB_ROOT_HUB_ADDR + 1;
2529             x != bus->devices_max; x++) {
2530                 udev = bus->devices[x];
2531                 if (udev == NULL)
2532                         continue;
2533
2534                 /* we found a non-Root-Hub USB device */
2535                 type_refs[4] += 1;
2536
2537                 /* "last_xfer_time" can be updated by a resume */
2538                 temp = ticks - udev->pwr_save.last_xfer_time;
2539
2540                 /*
2541                  * Compute minimum time since last transfer for the complete
2542                  * bus:
2543                  */
2544                 if (temp < mintime)
2545                         mintime = temp;
2546
2547                 if (udev->flags.self_suspended == 0) {
2548                         type_refs[0] += udev->pwr_save.type_refs[0];
2549                         type_refs[1] += udev->pwr_save.type_refs[1];
2550                         type_refs[2] += udev->pwr_save.type_refs[2];
2551                         type_refs[3] += udev->pwr_save.type_refs[3];
2552                 }
2553         }
2554
2555         if (mintime >= (usb_ticks_t)(1 * hz)) {
2556                 /* recompute power masks */
2557                 DPRINTF("Recomputing power masks\n");
2558                 bus->hw_power_state = 0;
2559                 if (type_refs[UE_CONTROL] != 0)
2560                         bus->hw_power_state |= USB_HW_POWER_CONTROL;
2561                 if (type_refs[UE_BULK] != 0)
2562                         bus->hw_power_state |= USB_HW_POWER_BULK;
2563                 if (type_refs[UE_INTERRUPT] != 0)
2564                         bus->hw_power_state |= USB_HW_POWER_INTERRUPT;
2565                 if (type_refs[UE_ISOCHRONOUS] != 0)
2566                         bus->hw_power_state |= USB_HW_POWER_ISOC;
2567                 if (type_refs[4] != 0)
2568                         bus->hw_power_state |= USB_HW_POWER_NON_ROOT_HUB;
2569         }
2570         USB_BUS_UNLOCK(bus);
2571
2572         if (bus->methods->set_hw_power != NULL) {
2573                 /* always update hardware power! */
2574                 (bus->methods->set_hw_power) (bus);
2575         }
2576         return;
2577 }
2578 #endif
2579
2580 static usb_error_t
2581 usbd_device_30_remote_wakeup(struct usb_device *udev, uint8_t bRequest)
2582 {
2583         struct usb_device_request req = {};
2584
2585         req.bmRequestType = UT_WRITE_INTERFACE;
2586         req.bRequest = bRequest;
2587         USETW(req.wValue, USB_INTERFACE_FUNC_SUSPEND);
2588         USETW(req.wIndex, USB_INTERFACE_FUNC_SUSPEND_LP |
2589             USB_INTERFACE_FUNC_SUSPEND_RW);
2590
2591         return (usbd_do_request(udev, NULL, &req, 0));
2592 }
2593
2594 static usb_error_t
2595 usbd_clear_dev_wakeup(struct usb_device *udev)
2596 {
2597         usb_error_t err;
2598
2599         if (usb_device_20_compatible(udev)) {
2600                 err = usbd_req_clear_device_feature(udev,
2601                     NULL, UF_DEVICE_REMOTE_WAKEUP);
2602         } else {
2603                 err = usbd_device_30_remote_wakeup(udev,
2604                     UR_CLEAR_FEATURE);
2605         }
2606         return (err);
2607 }
2608
2609 static usb_error_t
2610 usbd_set_dev_wakeup(struct usb_device *udev)
2611 {
2612         usb_error_t err;
2613
2614         if (usb_device_20_compatible(udev)) {
2615                 err = usbd_req_set_device_feature(udev,
2616                     NULL, UF_DEVICE_REMOTE_WAKEUP);
2617         } else {
2618                 err = usbd_device_30_remote_wakeup(udev,
2619                     UR_SET_FEATURE);
2620         }
2621         return (err);
2622 }
2623
2624 /*------------------------------------------------------------------------*
2625  *      usb_dev_resume_peer
2626  *
2627  * This function will resume an USB peer and do the required USB
2628  * signalling to get an USB device out of the suspended state.
2629  *------------------------------------------------------------------------*/
2630 static void
2631 usb_dev_resume_peer(struct usb_device *udev)
2632 {
2633         struct usb_bus *bus;
2634         int err;
2635
2636         /* be NULL safe */
2637         if (udev == NULL)
2638                 return;
2639
2640         /* check if already resumed */
2641         if (udev->flags.self_suspended == 0)
2642                 return;
2643
2644         /* we need a parent HUB to do resume */
2645         if (udev->parent_hub == NULL)
2646                 return;
2647
2648         DPRINTF("udev=%p\n", udev);
2649
2650         if ((udev->flags.usb_mode == USB_MODE_DEVICE) &&
2651             (udev->flags.remote_wakeup == 0)) {
2652                 /*
2653                  * If the host did not set the remote wakeup feature, we can
2654                  * not wake it up either!
2655                  */
2656                 DPRINTF("remote wakeup is not set!\n");
2657                 return;
2658         }
2659         /* get bus pointer */
2660         bus = udev->bus;
2661
2662         /* resume parent hub first */
2663         usb_dev_resume_peer(udev->parent_hub);
2664
2665         /* reduce chance of instant resume failure by waiting a little bit */
2666         usb_pause_mtx(NULL, USB_MS_TO_TICKS(20));
2667
2668         if (usb_device_20_compatible(udev)) {
2669                 /* resume current port (Valid in Host and Device Mode) */
2670                 err = usbd_req_clear_port_feature(udev->parent_hub,
2671                     NULL, udev->port_no, UHF_PORT_SUSPEND);
2672                 if (err) {
2673                         DPRINTFN(0, "Resuming port failed\n");
2674                         return;
2675                 }
2676         } else {
2677                 /* resume current port (Valid in Host and Device Mode) */
2678                 err = usbd_req_set_port_link_state(udev->parent_hub,
2679                     NULL, udev->port_no, UPS_PORT_LS_U0);
2680                 if (err) {
2681                         DPRINTFN(0, "Resuming port failed\n");
2682                         return;
2683                 }
2684         }
2685
2686         /* resume settle time */
2687         usb_pause_mtx(NULL, USB_MS_TO_TICKS(usb_port_resume_delay));
2688
2689         if (bus->methods->device_resume != NULL) {
2690                 /* resume USB device on the USB controller */
2691                 (bus->methods->device_resume) (udev);
2692         }
2693         USB_BUS_LOCK(bus);
2694         /* set that this device is now resumed */
2695         udev->flags.self_suspended = 0;
2696 #if USB_HAVE_POWERD
2697         /* make sure that we don't go into suspend right away */
2698         udev->pwr_save.last_xfer_time = ticks;
2699
2700         /* make sure the needed power masks are on */
2701         if (udev->pwr_save.type_refs[UE_CONTROL] != 0)
2702                 bus->hw_power_state |= USB_HW_POWER_CONTROL;
2703         if (udev->pwr_save.type_refs[UE_BULK] != 0)
2704                 bus->hw_power_state |= USB_HW_POWER_BULK;
2705         if (udev->pwr_save.type_refs[UE_INTERRUPT] != 0)
2706                 bus->hw_power_state |= USB_HW_POWER_INTERRUPT;
2707         if (udev->pwr_save.type_refs[UE_ISOCHRONOUS] != 0)
2708                 bus->hw_power_state |= USB_HW_POWER_ISOC;
2709 #endif
2710         USB_BUS_UNLOCK(bus);
2711
2712         if (bus->methods->set_hw_power != NULL) {
2713                 /* always update hardware power! */
2714                 (bus->methods->set_hw_power) (bus);
2715         }
2716
2717         usbd_sr_lock(udev);
2718
2719         /* notify all sub-devices about resume */
2720         err = usb_suspend_resume(udev, 0);
2721
2722         usbd_sr_unlock(udev);
2723
2724         /* check if peer has wakeup capability */
2725         if (usb_peer_can_wakeup(udev)) {
2726                 /* clear remote wakeup */
2727                 err = usbd_clear_dev_wakeup(udev);
2728                 if (err) {
2729                         DPRINTFN(0, "Clearing device "
2730                             "remote wakeup failed: %s\n",
2731                             usbd_errstr(err));
2732                 }
2733         }
2734 }
2735
2736 /*------------------------------------------------------------------------*
2737  *      usb_dev_suspend_peer
2738  *
2739  * This function will suspend an USB peer and do the required USB
2740  * signalling to get an USB device into the suspended state.
2741  *------------------------------------------------------------------------*/
2742 static void
2743 usb_dev_suspend_peer(struct usb_device *udev)
2744 {
2745         struct usb_device *child;
2746         int err;
2747         uint8_t x;
2748         uint8_t nports;
2749
2750 repeat:
2751         /* be NULL safe */
2752         if (udev == NULL)
2753                 return;
2754
2755         /* check if already suspended */
2756         if (udev->flags.self_suspended)
2757                 return;
2758
2759         /* we need a parent HUB to do suspend */
2760         if (udev->parent_hub == NULL)
2761                 return;
2762
2763         DPRINTF("udev=%p\n", udev);
2764
2765         /* check if the current device is a HUB */
2766         if (udev->hub != NULL) {
2767                 nports = udev->hub->nports;
2768
2769                 /* check if all devices on the HUB are suspended */
2770                 for (x = 0; x != nports; x++) {
2771                         child = usb_bus_port_get_device(udev->bus,
2772                             udev->hub->ports + x);
2773
2774                         if (child == NULL)
2775                                 continue;
2776
2777                         if (child->flags.self_suspended)
2778                                 continue;
2779
2780                         DPRINTFN(1, "Port %u is busy on the HUB!\n", x + 1);
2781                         return;
2782                 }
2783         }
2784
2785         if (usb_peer_can_wakeup(udev)) {
2786                 /*
2787                  * This request needs to be done before we set
2788                  * "udev->flags.self_suspended":
2789                  */
2790
2791                 /* allow device to do remote wakeup */
2792                 err = usbd_set_dev_wakeup(udev);
2793                 if (err) {
2794                         DPRINTFN(0, "Setting device "
2795                             "remote wakeup failed\n");
2796                 }
2797         }
2798
2799         USB_BUS_LOCK(udev->bus);
2800         /*
2801          * Checking for suspend condition and setting suspended bit
2802          * must be atomic!
2803          */
2804         err = usb_peer_should_wakeup(udev);
2805         if (err == 0) {
2806                 /*
2807                  * Set that this device is suspended. This variable
2808                  * must be set before calling USB controller suspend
2809                  * callbacks.
2810                  */
2811                 udev->flags.self_suspended = 1;
2812         }
2813         USB_BUS_UNLOCK(udev->bus);
2814
2815         if (err != 0) {
2816                 if (usb_peer_can_wakeup(udev)) {
2817                         /* allow device to do remote wakeup */
2818                         err = usbd_clear_dev_wakeup(udev);
2819                         if (err) {
2820                                 DPRINTFN(0, "Setting device "
2821                                     "remote wakeup failed\n");
2822                         }
2823                 }
2824
2825                 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
2826                         /* resume parent HUB first */
2827                         usb_dev_resume_peer(udev->parent_hub);
2828
2829                         /* reduce chance of instant resume failure by waiting a little bit */
2830                         usb_pause_mtx(NULL, USB_MS_TO_TICKS(20));
2831
2832                         /* resume current port (Valid in Host and Device Mode) */
2833                         err = usbd_req_clear_port_feature(udev->parent_hub,
2834                             NULL, udev->port_no, UHF_PORT_SUSPEND);
2835
2836                         /* resume settle time */
2837                         usb_pause_mtx(NULL, USB_MS_TO_TICKS(usb_port_resume_delay));
2838                 }
2839                 DPRINTF("Suspend was cancelled!\n");
2840                 return;
2841         }
2842
2843         usbd_sr_lock(udev);
2844
2845         /* notify all sub-devices about suspend */
2846         err = usb_suspend_resume(udev, 1);
2847
2848         usbd_sr_unlock(udev);
2849
2850         if (udev->bus->methods->device_suspend != NULL) {
2851                 usb_timeout_t temp;
2852
2853                 /* suspend device on the USB controller */
2854                 (udev->bus->methods->device_suspend) (udev);
2855
2856                 /* do DMA delay */
2857                 temp = usbd_get_dma_delay(udev);
2858                 if (temp != 0)
2859                         usb_pause_mtx(NULL, USB_MS_TO_TICKS(temp));
2860         }
2861
2862         if (usb_device_20_compatible(udev)) {
2863                 /* suspend current port */
2864                 err = usbd_req_set_port_feature(udev->parent_hub,
2865                     NULL, udev->port_no, UHF_PORT_SUSPEND);
2866                 if (err) {
2867                         DPRINTFN(0, "Suspending port failed\n");
2868                         return;
2869                 }
2870         } else {
2871                 /* suspend current port */
2872                 err = usbd_req_set_port_link_state(udev->parent_hub,
2873                     NULL, udev->port_no, UPS_PORT_LS_U3);
2874                 if (err) {
2875                         DPRINTFN(0, "Suspending port failed\n");
2876                         return;
2877                 }
2878         }
2879
2880         udev = udev->parent_hub;
2881         goto repeat;
2882 }
2883
2884 /*------------------------------------------------------------------------*
2885  *      usbd_set_power_mode
2886  *
2887  * This function will set the power mode, see USB_POWER_MODE_XXX for a
2888  * USB device.
2889  *------------------------------------------------------------------------*/
2890 void
2891 usbd_set_power_mode(struct usb_device *udev, uint8_t power_mode)
2892 {
2893         /* filter input argument */
2894         if ((power_mode != USB_POWER_MODE_ON) &&
2895             (power_mode != USB_POWER_MODE_OFF))
2896                 power_mode = USB_POWER_MODE_SAVE;
2897
2898         power_mode = usbd_filter_power_mode(udev, power_mode);
2899
2900         udev->power_mode = power_mode;  /* update copy of power mode */
2901
2902 #if USB_HAVE_POWERD
2903         usb_bus_power_update(udev->bus);
2904 #else
2905         usb_needs_explore(udev->bus, 0 /* no probe */ );
2906 #endif
2907 }
2908
2909 /*------------------------------------------------------------------------*
2910  *      usbd_filter_power_mode
2911  *
2912  * This function filters the power mode based on hardware requirements.
2913  *------------------------------------------------------------------------*/
2914 uint8_t
2915 usbd_filter_power_mode(struct usb_device *udev, uint8_t power_mode)
2916 {
2917         const struct usb_bus_methods *mtod;
2918         int8_t temp;
2919
2920         mtod = udev->bus->methods;
2921         temp = -1;
2922
2923         if (mtod->get_power_mode != NULL)
2924                 (mtod->get_power_mode) (udev, &temp);
2925
2926         /* check if we should not filter */
2927         if (temp < 0)
2928                 return (power_mode);
2929
2930         /* use fixed power mode given by hardware driver */
2931         return (temp);
2932 }
2933
2934 /*------------------------------------------------------------------------*
2935  *      usbd_start_re_enumerate
2936  *
2937  * This function starts re-enumeration of the given USB device. This
2938  * function does not need to be called BUS-locked. This function does
2939  * not wait until the re-enumeration is completed.
2940  *------------------------------------------------------------------------*/
2941 void
2942 usbd_start_re_enumerate(struct usb_device *udev)
2943 {
2944         if (udev->re_enumerate_wait == USB_RE_ENUM_DONE) {
2945                 udev->re_enumerate_wait = USB_RE_ENUM_START;
2946                 usb_needs_explore(udev->bus, 0);
2947         }
2948 }
2949
2950 /*-----------------------------------------------------------------------*
2951  *      usbd_start_set_config
2952  *
2953  * This function starts setting a USB configuration. This function
2954  * does not need to be called BUS-locked. This function does not wait
2955  * until the set USB configuratino is completed.
2956  *------------------------------------------------------------------------*/
2957 usb_error_t
2958 usbd_start_set_config(struct usb_device *udev, uint8_t index)
2959 {
2960         if (udev->re_enumerate_wait == USB_RE_ENUM_DONE) {
2961                 if (udev->curr_config_index == index) {
2962                         /* no change needed */
2963                         return (0);
2964                 }
2965                 udev->next_config_index = index;
2966                 udev->re_enumerate_wait = USB_RE_ENUM_SET_CONFIG;
2967                 usb_needs_explore(udev->bus, 0);
2968                 return (0);
2969         } else if (udev->re_enumerate_wait == USB_RE_ENUM_SET_CONFIG) {
2970                 if (udev->next_config_index == index) {
2971                         /* no change needed */
2972                         return (0);
2973                 }
2974         }
2975         return (USB_ERR_PENDING_REQUESTS);
2976 }