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 = 0;
 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(0, "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 (0);
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         for (x = 0; x != hub->nports; x++) {
1026                 up = hub->ports + x;
1027                 portno = x + 1;
1028
1029                 err = uhub_read_port_status(sc, portno);
1030                 if (err) {
1031                         /* most likely the HUB is gone */
1032                         break;
1033                 }
1034                 if (sc->sc_st.port_change & UPS_C_OVERCURRENT_INDICATOR) {
1035                         DPRINTF("Overcurrent on port %u.\n", portno);
1036                         err = usbd_req_clear_port_feature(
1037                             udev, NULL, portno, UHF_C_PORT_OVER_CURRENT);
1038                         if (err) {
1039                                 /* most likely the HUB is gone */
1040                                 break;
1041                         }
1042                 }
1043                 if (!(sc->sc_flags & UHUB_FLAG_DID_EXPLORE)) {
1044                         /*
1045                          * Fake a connect status change so that the
1046                          * status gets checked initially!
1047                          */
1048                         sc->sc_st.port_change |=
1049                             UPS_C_CONNECT_STATUS;
1050                 }
1051                 if (sc->sc_st.port_change & UPS_C_PORT_ENABLED) {
1052                         err = usbd_req_clear_port_feature(
1053                             udev, NULL, portno, UHF_C_PORT_ENABLE);
1054                         if (err) {
1055                                 /* most likely the HUB is gone */
1056                                 break;
1057                         }
1058                         if (sc->sc_st.port_change & UPS_C_CONNECT_STATUS) {
1059                                 /*
1060                                  * Ignore the port error if the device
1061                                  * has vanished !
1062                                  */
1063                         } else if (sc->sc_st.port_status & UPS_PORT_ENABLED) {
1064                                 DPRINTFN(0, "illegal enable change, "
1065                                     "port %d\n", portno);
1066                         } else {
1067                                 if (up->restartcnt == USB_RESTART_MAX) {
1068                                         /* XXX could try another speed ? */
1069                                         DPRINTFN(0, "port error, giving up "
1070                                             "port %d\n", portno);
1071                                 } else {
1072                                         sc->sc_st.port_change |=
1073                                             UPS_C_CONNECT_STATUS;
1074                                         up->restartcnt++;
1075                                 }
1076                         }
1077                 }
1078                 if (sc->sc_st.port_change & UPS_C_CONNECT_STATUS) {
1079                         err = uhub_reattach_port(sc, portno);
1080                         if (err) {
1081                                 /* most likely the HUB is gone */
1082                                 break;
1083                         }
1084                 }
1085                 if (sc->sc_st.port_change & (UPS_C_SUSPEND |
1086                     UPS_C_PORT_LINK_STATE)) {
1087                         err = uhub_suspend_resume_port(sc, portno);
1088                         if (err) {
1089                                 /* most likely the HUB is gone */
1090                                 break;
1091                         }
1092                 }
1093                 err = uhub_explore_sub(sc, up);
1094                 if (err) {
1095                         /* no device(s) present */
1096                         continue;
1097                 }
1098                 /* explore succeeded - reset restart counter */
1099                 up->restartcnt = 0;
1100         }
1101
1102         if (do_unlock)
1103                 usbd_enum_unlock(udev);
1104
1105         /* initial status checked */
1106         sc->sc_flags |= UHUB_FLAG_DID_EXPLORE;
1107
1108         /* return success */
1109         return (USB_ERR_NORMAL_COMPLETION);
1110 }
1111
1112 int
1113 uhub_probe(device_t dev)
1114 {
1115         struct usb_attach_arg *uaa = device_get_ivars(dev);
1116
1117         if (uaa->usb_mode != USB_MODE_HOST)
1118                 return (ENXIO);
1119
1120         /*
1121          * The subclass for USB HUBs is currently ignored because it
1122          * is 0 for some and 1 for others.
1123          */
1124         if (uaa->info.bConfigIndex == 0 &&
1125             uaa->info.bDeviceClass == UDCLASS_HUB)
1126                 return (BUS_PROBE_DEFAULT);
1127
1128         return (ENXIO);
1129 }
1130
1131 /* NOTE: The information returned by this function can be wrong. */
1132 usb_error_t
1133 uhub_query_info(struct usb_device *udev, uint8_t *pnports, uint8_t *ptt)
1134 {
1135         struct usb_hub_descriptor hubdesc20;
1136         struct usb_hub_ss_descriptor hubdesc30;
1137         usb_error_t err;
1138         uint8_t nports;
1139         uint8_t tt;
1140
1141         if (udev->ddesc.bDeviceClass != UDCLASS_HUB)
1142                 return (USB_ERR_INVAL);
1143
1144         nports = 0;
1145         tt = 0;
1146
1147         switch (udev->speed) {
1148         case USB_SPEED_LOW:
1149         case USB_SPEED_FULL:
1150         case USB_SPEED_HIGH:
1151                 /* assuming that there is one port */
1152                 err = usbd_req_get_hub_descriptor(udev, NULL, &hubdesc20, 1);
1153                 if (err) {
1154                         DPRINTFN(0, "getting USB 2.0 HUB descriptor failed,"
1155                             "error=%s\n", usbd_errstr(err));
1156                         break;
1157                 }
1158                 nports = hubdesc20.bNbrPorts;
1159                 if (nports > 127)
1160                         nports = 127;
1161
1162                 if (udev->speed == USB_SPEED_HIGH)
1163                         tt = (UGETW(hubdesc20.wHubCharacteristics) >> 5) & 3;
1164                 break;
1165
1166         case USB_SPEED_SUPER:
1167                 err = usbd_req_get_ss_hub_descriptor(udev, NULL, &hubdesc30, 1);
1168                 if (err) {
1169                         DPRINTFN(0, "Getting USB 3.0 HUB descriptor failed,"
1170                             "error=%s\n", usbd_errstr(err));
1171                         break;
1172                 }
1173                 nports = hubdesc30.bNbrPorts;
1174                 if (nports > 16)
1175                         nports = 16;
1176                 break;
1177
1178         default:
1179                 err = USB_ERR_INVAL;
1180                 break;
1181         }
1182
1183         if (pnports != NULL)
1184                 *pnports = nports;
1185
1186         if (ptt != NULL)
1187                 *ptt = tt;
1188
1189         return (err);
1190 }
1191
1192 int
1193 uhub_attach(device_t dev)
1194 {
1195         struct uhub_softc *sc = device_get_softc(dev);
1196         struct usb_attach_arg *uaa = device_get_ivars(dev);
1197         struct usb_device *udev = uaa->device;
1198         struct usb_device *parent_hub = udev->parent_hub;
1199         struct usb_hub *hub;
1200         struct usb_hub_descriptor hubdesc20;
1201         struct usb_hub_ss_descriptor hubdesc30;
1202 #if USB_HAVE_DISABLE_ENUM
1203         struct sysctl_ctx_list *sysctl_ctx;
1204         struct sysctl_oid *sysctl_tree;
1205 #endif
1206         uint16_t pwrdly;
1207         uint16_t nports;
1208         uint8_t x;
1209         uint8_t portno;
1210         uint8_t removable;
1211         uint8_t iface_index;
1212         usb_error_t err;
1213
1214         sc->sc_udev = udev;
1215         sc->sc_dev = dev;
1216
1217         mtx_init(&sc->sc_mtx, "USB HUB mutex", NULL, MTX_DEF);
1218
1219         device_set_usb_desc(dev);
1220
1221         DPRINTFN(2, "depth=%d selfpowered=%d, parent=%p, "
1222             "parent->selfpowered=%d\n",
1223             udev->depth,
1224             udev->flags.self_powered,
1225             parent_hub,
1226             parent_hub ?
1227             parent_hub->flags.self_powered : 0);
1228
1229         if (uhub_is_too_deep(udev)) {
1230                 DPRINTFN(0, "HUB at depth %d, "
1231                     "exceeds maximum. HUB ignored\n", (int)udev->depth);
1232                 goto error;
1233         }
1234
1235         if (!udev->flags.self_powered && parent_hub &&
1236             !parent_hub->flags.self_powered) {
1237                 DPRINTFN(0, "Bus powered HUB connected to "
1238                     "bus powered HUB. HUB ignored\n");
1239                 goto error;
1240         }
1241
1242         if (UHUB_IS_MULTI_TT(sc)) {
1243                 err = usbd_set_alt_interface_index(udev, 0, 1);
1244                 if (err) {
1245                         device_printf(dev, "MTT could not be enabled\n");
1246                         goto error;
1247                 }
1248                 device_printf(dev, "MTT enabled\n");
1249         }
1250
1251         /* get HUB descriptor */
1252
1253         DPRINTFN(2, "Getting HUB descriptor\n");
1254
1255         switch (udev->speed) {
1256         case USB_SPEED_LOW:
1257         case USB_SPEED_FULL:
1258         case USB_SPEED_HIGH:
1259                 /* assuming that there is one port */
1260                 err = usbd_req_get_hub_descriptor(udev, NULL, &hubdesc20, 1);
1261                 if (err) {
1262                         DPRINTFN(0, "getting USB 2.0 HUB descriptor failed,"
1263                             "error=%s\n", usbd_errstr(err));
1264                         goto error;
1265                 }
1266                 /* get number of ports */
1267                 nports = hubdesc20.bNbrPorts;
1268
1269                 /* get power delay */
1270                 pwrdly = ((hubdesc20.bPwrOn2PwrGood * UHD_PWRON_FACTOR) +
1271                     usb_extra_power_up_time);
1272
1273                 /* get complete HUB descriptor */
1274                 if (nports >= 8) {
1275                         /* check number of ports */
1276                         if (nports > 127) {
1277                                 DPRINTFN(0, "Invalid number of USB 2.0 ports,"
1278                                     "error=%s\n", usbd_errstr(err));
1279                                 goto error;
1280                         }
1281                         /* get complete HUB descriptor */
1282                         err = usbd_req_get_hub_descriptor(udev, NULL, &hubdesc20, nports);
1283
1284                         if (err) {
1285                                 DPRINTFN(0, "Getting USB 2.0 HUB descriptor failed,"
1286                                     "error=%s\n", usbd_errstr(err));
1287                                 goto error;
1288                         }
1289                         if (hubdesc20.bNbrPorts != nports) {
1290                                 DPRINTFN(0, "Number of ports changed\n");
1291                                 goto error;
1292                         }
1293                 }
1294                 break;
1295         case USB_SPEED_SUPER:
1296                 if (udev->parent_hub != NULL) {
1297                         err = usbd_req_set_hub_depth(udev, NULL,
1298                             udev->depth - 1);
1299                         if (err) {
1300                                 DPRINTFN(0, "Setting USB 3.0 HUB depth failed,"
1301                                     "error=%s\n", usbd_errstr(err));
1302                                 goto error;
1303                         }
1304                 }
1305                 err = usbd_req_get_ss_hub_descriptor(udev, NULL, &hubdesc30, 1);
1306                 if (err) {
1307                         DPRINTFN(0, "Getting USB 3.0 HUB descriptor failed,"
1308                             "error=%s\n", usbd_errstr(err));
1309                         goto error;
1310                 }
1311                 /* get number of ports */
1312                 nports = hubdesc30.bNbrPorts;
1313
1314                 /* get power delay */
1315                 pwrdly = ((hubdesc30.bPwrOn2PwrGood * UHD_PWRON_FACTOR) +
1316                     usb_extra_power_up_time);
1317
1318                 /* get complete HUB descriptor */
1319                 if (nports >= 8) {
1320                         /* check number of ports */
1321                         if (nports > ((udev->parent_hub != NULL) ? 15 : 127)) {
1322                                 DPRINTFN(0, "Invalid number of USB 3.0 ports,"
1323                                     "error=%s\n", usbd_errstr(err));
1324                                 goto error;
1325                         }
1326                         /* get complete HUB descriptor */
1327                         err = usbd_req_get_ss_hub_descriptor(udev, NULL, &hubdesc30, nports);
1328
1329                         if (err) {
1330                                 DPRINTFN(0, "Getting USB 2.0 HUB descriptor failed,"
1331                                     "error=%s\n", usbd_errstr(err));
1332                                 goto error;
1333                         }
1334                         if (hubdesc30.bNbrPorts != nports) {
1335                                 DPRINTFN(0, "Number of ports changed\n");
1336                                 goto error;
1337                         }
1338                 }
1339                 break;
1340         default:
1341                 DPRINTF("Assuming HUB has only one port\n");
1342                 /* default number of ports */
1343                 nports = 1;
1344                 /* default power delay */
1345                 pwrdly = ((10 * UHD_PWRON_FACTOR) + usb_extra_power_up_time);
1346                 break;
1347         }
1348         if (nports == 0) {
1349                 DPRINTFN(0, "portless HUB\n");
1350                 goto error;
1351         }
1352         if (nports > USB_MAX_PORTS) {
1353                 DPRINTF("Port limit exceeded\n");
1354                 goto error;
1355         }
1356 #if (USB_HAVE_FIXED_PORT == 0)
1357         hub = malloc(sizeof(hub[0]) + (sizeof(hub->ports[0]) * nports),
1358             M_USBDEV, M_WAITOK | M_ZERO);
1359
1360         if (hub == NULL)
1361                 goto error;
1362 #else
1363         hub = &sc->sc_hub;
1364 #endif
1365         udev->hub = hub;
1366
1367         /* initialize HUB structure */
1368         hub->hubsoftc = sc;
1369         hub->explore = &uhub_explore;
1370         hub->nports = nports;
1371         hub->hubudev = udev;
1372 #if USB_HAVE_TT_SUPPORT
1373         hub->tt_msg[0].hdr.pm_callback = &uhub_reset_tt_proc;
1374         hub->tt_msg[0].udev = udev;
1375         hub->tt_msg[1].hdr.pm_callback = &uhub_reset_tt_proc;
1376         hub->tt_msg[1].udev = udev;
1377 #endif
1378         /* if self powered hub, give ports maximum current */
1379         if (udev->flags.self_powered) {
1380                 hub->portpower = USB_MAX_POWER;
1381         } else {
1382                 hub->portpower = USB_MIN_POWER;
1383         }
1384
1385         /* set up interrupt pipe */
1386         iface_index = 0;
1387         if (udev->parent_hub == NULL) {
1388                 /* root HUB is special */
1389                 err = 0;
1390         } else {
1391                 /* normal HUB */
1392                 err = usbd_transfer_setup(udev, &iface_index, sc->sc_xfer,
1393                     uhub_config, UHUB_N_TRANSFER, sc, &sc->sc_mtx);
1394         }
1395         if (err) {
1396                 DPRINTFN(0, "cannot setup interrupt transfer, "
1397                     "errstr=%s\n", usbd_errstr(err));
1398                 goto error;
1399         }
1400         /* wait with power off for a while */
1401         usb_pause_mtx(NULL, USB_MS_TO_TICKS(USB_POWER_DOWN_TIME));
1402
1403 #if USB_HAVE_DISABLE_ENUM
1404         /* Add device sysctls */
1405
1406         sysctl_ctx = device_get_sysctl_ctx(dev);
1407         sysctl_tree = device_get_sysctl_tree(dev);
1408
1409         if (sysctl_ctx != NULL && sysctl_tree != NULL) {
1410                 (void) SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1411                     OID_AUTO, "disable_enumeration", CTLFLAG_RWTUN,
1412                     &sc->sc_disable_enumeration, 0,
1413                     "Set to disable enumeration on this USB HUB.");
1414
1415                 (void) SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1416                     OID_AUTO, "disable_port_power", CTLFLAG_RWTUN,
1417                     &sc->sc_disable_port_power, 0,
1418                     "Set to disable USB port power on this USB HUB.");
1419         }
1420 #endif
1421         /*
1422          * To have the best chance of success we do things in the exact same
1423          * order as Windoze98.  This should not be necessary, but some
1424          * devices do not follow the USB specs to the letter.
1425          *
1426          * These are the events on the bus when a hub is attached:
1427          *  Get device and config descriptors (see attach code)
1428          *  Get hub descriptor (see above)
1429          *  For all ports
1430          *     turn on power
1431          *     wait for power to become stable
1432          * (all below happens in explore code)
1433          *  For all ports
1434          *     clear C_PORT_CONNECTION
1435          *  For all ports
1436          *     get port status
1437          *     if device connected
1438          *        wait 100 ms
1439          *        turn on reset
1440          *        wait
1441          *        clear C_PORT_RESET
1442          *        get port status
1443          *        proceed with device attachment
1444          */
1445
1446         /* XXX should check for none, individual, or ganged power? */
1447
1448         removable = 0;
1449
1450         for (x = 0; x != nports; x++) {
1451                 /* set up data structures */
1452                 struct usb_port *up = hub->ports + x;
1453
1454                 up->device_index = 0;
1455                 up->restartcnt = 0;
1456                 portno = x + 1;
1457
1458                 /* check if port is removable */
1459                 switch (udev->speed) {
1460                 case USB_SPEED_LOW:
1461                 case USB_SPEED_FULL:
1462                 case USB_SPEED_HIGH:
1463                         if (!UHD_NOT_REMOV(&hubdesc20, portno))
1464                                 removable++;
1465                         break;
1466                 case USB_SPEED_SUPER:
1467                         if (!UHD_NOT_REMOV(&hubdesc30, portno))
1468                                 removable++;
1469                         break;
1470                 default:
1471                         DPRINTF("Assuming removable port\n");
1472                         removable++;
1473                         break;
1474                 }
1475                 if (err == 0) {
1476 #if USB_HAVE_DISABLE_ENUM
1477                         /* check if we should disable USB port power or not */
1478                         if (usb_disable_port_power != 0 ||
1479                             sc->sc_disable_port_power != 0) {
1480                                 /* turn the power off */
1481                                 DPRINTFN(2, "Turning port %d power off\n", portno);
1482                                 err = usbd_req_clear_port_feature(udev, NULL,
1483                                     portno, UHF_PORT_POWER);
1484                         } else {
1485 #endif
1486                                 /* turn the power on */
1487                                 DPRINTFN(2, "Turning port %d power on\n", portno);
1488                                 err = usbd_req_set_port_feature(udev, NULL,
1489                                     portno, UHF_PORT_POWER);
1490 #if USB_HAVE_DISABLE_ENUM
1491                         }
1492 #endif
1493                 }
1494                 if (err != 0) {
1495                         DPRINTFN(0, "port %d power on or off failed, %s\n",
1496                             portno, usbd_errstr(err));
1497                 }
1498                 DPRINTF("turn on port %d power\n",
1499                     portno);
1500
1501                 /* wait for stable power */
1502                 usb_pause_mtx(NULL, USB_MS_TO_TICKS(pwrdly));
1503         }
1504
1505         device_printf(dev, "%d port%s with %d "
1506             "removable, %s powered\n", nports, (nports != 1) ? "s" : "",
1507             removable, udev->flags.self_powered ? "self" : "bus");
1508
1509         /* Start the interrupt endpoint, if any */
1510
1511         USB_MTX_LOCK(&sc->sc_mtx);
1512         usbd_transfer_start(sc->sc_xfer[UHUB_INTR_TRANSFER]);
1513         USB_MTX_UNLOCK(&sc->sc_mtx);
1514
1515         /* Enable automatic power save on all USB HUBs */
1516
1517         usbd_set_power_mode(udev, USB_POWER_MODE_SAVE);
1518
1519         return (0);
1520
1521 error:
1522         usbd_transfer_unsetup(sc->sc_xfer, UHUB_N_TRANSFER);
1523
1524 #if (USB_HAVE_FIXED_PORT == 0)
1525         free(udev->hub, M_USBDEV);
1526 #endif
1527         udev->hub = NULL;
1528
1529         mtx_destroy(&sc->sc_mtx);
1530
1531         return (ENXIO);
1532 }
1533
1534 /*
1535  * Called from process context when the hub is gone.
1536  * Detach all devices on active ports.
1537  */
1538 int
1539 uhub_detach(device_t dev)
1540 {
1541         struct uhub_softc *sc = device_get_softc(dev);
1542         struct usb_hub *hub = sc->sc_udev->hub;
1543         struct usb_bus *bus = sc->sc_udev->bus;
1544         struct usb_device *child;
1545         uint8_t x;
1546
1547         if (hub == NULL)                /* must be partially working */
1548                 return (0);
1549
1550         /* Make sure interrupt transfer is gone. */
1551         usbd_transfer_unsetup(sc->sc_xfer, UHUB_N_TRANSFER);
1552
1553         /* Detach all ports */
1554         for (x = 0; x != hub->nports; x++) {
1555                 child = usb_bus_port_get_device(bus, hub->ports + x);
1556
1557                 if (child == NULL) {
1558                         continue;
1559                 }
1560
1561                 /*
1562                  * Free USB device and all subdevices, if any.
1563                  */
1564                 usb_free_device(child, 0);
1565         }
1566
1567 #if USB_HAVE_TT_SUPPORT
1568         /* Make sure our TT messages are not queued anywhere */
1569         USB_BUS_LOCK(bus);
1570         usb_proc_mwait(USB_BUS_TT_PROC(bus),
1571             &hub->tt_msg[0], &hub->tt_msg[1]);
1572         USB_BUS_UNLOCK(bus);
1573 #endif
1574
1575 #if (USB_HAVE_FIXED_PORT == 0)
1576         free(hub, M_USBDEV);
1577 #endif
1578         sc->sc_udev->hub = NULL;
1579
1580         mtx_destroy(&sc->sc_mtx);
1581
1582         return (0);
1583 }
1584
1585 static int
1586 uhub_suspend(device_t dev)
1587 {
1588         DPRINTF("\n");
1589         /* Sub-devices are not suspended here! */
1590         return (0);
1591 }
1592
1593 static int
1594 uhub_resume(device_t dev)
1595 {
1596         DPRINTF("\n");
1597         /* Sub-devices are not resumed here! */
1598         return (0);
1599 }
1600
1601 static void
1602 uhub_driver_added(device_t dev, driver_t *driver)
1603 {
1604         usb_needs_explore_all();
1605 }
1606
1607 void
1608 uhub_find_iface_index(struct usb_hub *hub, device_t child,
1609     struct hub_result *res)
1610 {
1611         struct usb_interface *iface;
1612         struct usb_device *udev;
1613         uint8_t nports;
1614         uint8_t x;
1615         uint8_t i;
1616
1617         nports = hub->nports;
1618         for (x = 0; x != nports; x++) {
1619                 udev = usb_bus_port_get_device(hub->hubudev->bus,
1620                     hub->ports + x);
1621                 if (!udev) {
1622                         continue;
1623                 }
1624                 for (i = 0; i != USB_IFACE_MAX; i++) {
1625                         iface = usbd_get_iface(udev, i);
1626                         if (iface &&
1627                             (iface->subdev == child)) {
1628                                 res->iface_index = i;
1629                                 res->udev = udev;
1630                                 res->portno = x + 1;
1631                                 return;
1632                         }
1633                 }
1634         }
1635         res->iface_index = 0;
1636         res->udev = NULL;
1637         res->portno = 0;
1638 }
1639
1640 int
1641 uhub_child_location_string(device_t parent, device_t child,
1642     char *buf, size_t buflen)
1643 {
1644         struct uhub_softc *sc;
1645         struct usb_hub *hub;
1646         struct hub_result res;
1647
1648         if (!device_is_attached(parent)) {
1649                 if (buflen)
1650                         buf[0] = 0;
1651                 return (0);
1652         }
1653
1654         sc = device_get_softc(parent);
1655         hub = sc->sc_udev->hub;
1656
1657         mtx_lock(&Giant);
1658         uhub_find_iface_index(hub, child, &res);
1659         if (!res.udev) {
1660                 DPRINTF("device not on hub\n");
1661                 if (buflen) {
1662                         buf[0] = '\0';
1663                 }
1664                 goto done;
1665         }
1666         snprintf(buf, buflen, "bus=%u hubaddr=%u port=%u devaddr=%u"
1667             " interface=%u"
1668 #if USB_HAVE_UGEN
1669             " ugen=%s"
1670 #endif
1671             , device_get_unit(res.udev->bus->bdev)
1672             , (res.udev->parent_hub != NULL) ?
1673             res.udev->parent_hub->device_index : 0
1674             , res.portno, res.udev->device_index, res.iface_index
1675 #if USB_HAVE_UGEN
1676             , res.udev->ugen_name
1677 #endif
1678             );
1679 done:
1680         mtx_unlock(&Giant);
1681
1682         return (0);
1683 }
1684
1685 static int
1686 uhub_child_pnpinfo_string(device_t parent, device_t child,
1687     char *buf, size_t buflen)
1688 {
1689         struct uhub_softc *sc;
1690         struct usb_hub *hub;
1691         struct usb_interface *iface;
1692         struct hub_result res;
1693         uint8_t do_unlock;
1694
1695         if (!device_is_attached(parent)) {
1696                 if (buflen)
1697                         buf[0] = 0;
1698                 return (0);
1699         }
1700
1701         sc = device_get_softc(parent);
1702         hub = sc->sc_udev->hub;
1703
1704         mtx_lock(&Giant);
1705         uhub_find_iface_index(hub, child, &res);
1706         if (!res.udev) {
1707                 DPRINTF("device not on hub\n");
1708                 if (buflen) {
1709                         buf[0] = '\0';
1710                 }
1711                 goto done;
1712         }
1713         iface = usbd_get_iface(res.udev, res.iface_index);
1714         if (iface && iface->idesc) {
1715                 /* Make sure device information is not changed during the print. */
1716                 do_unlock = usbd_ctrl_lock(res.udev);
1717
1718                 snprintf(buf, buflen, "vendor=0x%04x product=0x%04x "
1719                     "devclass=0x%02x devsubclass=0x%02x "
1720                     "devproto=0x%02x "
1721                     "sernum=\"%s\" "
1722                     "release=0x%04x "
1723                     "mode=%s "
1724                     "intclass=0x%02x intsubclass=0x%02x "
1725                     "intprotocol=0x%02x" "%s%s",
1726                     UGETW(res.udev->ddesc.idVendor),
1727                     UGETW(res.udev->ddesc.idProduct),
1728                     res.udev->ddesc.bDeviceClass,
1729                     res.udev->ddesc.bDeviceSubClass,
1730                     res.udev->ddesc.bDeviceProtocol,
1731                     usb_get_serial(res.udev),
1732                     UGETW(res.udev->ddesc.bcdDevice),
1733                     (res.udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device",
1734                     iface->idesc->bInterfaceClass,
1735                     iface->idesc->bInterfaceSubClass,
1736                     iface->idesc->bInterfaceProtocol,
1737                     iface->pnpinfo ? " " : "",
1738                     iface->pnpinfo ? iface->pnpinfo : "");
1739
1740                 if (do_unlock)
1741                         usbd_ctrl_unlock(res.udev);
1742         } else {
1743                 if (buflen) {
1744                         buf[0] = '\0';
1745                 }
1746                 goto done;
1747         }
1748 done:
1749         mtx_unlock(&Giant);
1750
1751         return (0);
1752 }
1753
1754 /*
1755  * The USB Transaction Translator:
1756  * ===============================
1757  *
1758  * When doing LOW- and FULL-speed USB transfers across a HIGH-speed
1759  * USB HUB, bandwidth must be allocated for ISOCHRONOUS and INTERRUPT
1760  * USB transfers. To utilize bandwidth dynamically the "scatter and
1761  * gather" principle must be applied. This means that bandwidth must
1762  * be divided into equal parts of bandwidth. With regard to USB all
1763  * data is transferred in smaller packets with length
1764  * "wMaxPacketSize". The problem however is that "wMaxPacketSize" is
1765  * not a constant!
1766  *
1767  * The bandwidth scheduler which I have implemented will simply pack
1768  * the USB transfers back to back until there is no more space in the
1769  * schedule. Out of the 8 microframes which the USB 2.0 standard
1770  * provides, only 6 are available for non-HIGH-speed devices. I have
1771  * reserved the first 4 microframes for ISOCHRONOUS transfers. The
1772  * last 2 microframes I have reserved for INTERRUPT transfers. Without
1773  * this division, it is very difficult to allocate and free bandwidth
1774  * dynamically.
1775  *
1776  * NOTE about the Transaction Translator in USB HUBs:
1777  *
1778  * USB HUBs have a very simple Transaction Translator, that will
1779  * simply pipeline all the SPLIT transactions. That means that the
1780  * transactions will be executed in the order they are queued!
1781  *
1782  */
1783
1784 /*------------------------------------------------------------------------*
1785  *      usb_intr_find_best_slot
1786  *
1787  * Return value:
1788  *   The best Transaction Translation slot for an interrupt endpoint.
1789  *------------------------------------------------------------------------*/
1790 static uint8_t
1791 usb_intr_find_best_slot(usb_size_t *ptr, uint8_t start,
1792     uint8_t end, uint8_t mask)
1793 {
1794         usb_size_t min = (usb_size_t)-1;
1795         usb_size_t sum;
1796         uint8_t x;
1797         uint8_t y;
1798         uint8_t z;
1799
1800         y = 0;
1801
1802         /* find the last slot with lesser used bandwidth */
1803
1804         for (x = start; x < end; x++) {
1805                 sum = 0;
1806
1807                 /* compute sum of bandwidth */
1808                 for (z = x; z < end; z++) {
1809                         if (mask & (1U << (z - x)))
1810                                 sum += ptr[z];
1811                 }
1812
1813                 /* check if the current multi-slot is more optimal */
1814                 if (min >= sum) {
1815                         min = sum;
1816                         y = x;
1817                 }
1818
1819                 /* check if the mask is about to be shifted out */
1820                 if (mask & (1U << (end - 1 - x)))
1821                         break;
1822         }
1823         return (y);
1824 }
1825
1826 /*------------------------------------------------------------------------*
1827  *      usb_hs_bandwidth_adjust
1828  *
1829  * This function will update the bandwidth usage for the microframe
1830  * having index "slot" by "len" bytes. "len" can be negative.  If the
1831  * "slot" argument is greater or equal to "USB_HS_MICRO_FRAMES_MAX"
1832  * the "slot" argument will be replaced by the slot having least used
1833  * bandwidth. The "mask" argument is used for multi-slot allocations.
1834  *
1835  * Returns:
1836  *    The slot in which the bandwidth update was done: 0..7
1837  *------------------------------------------------------------------------*/
1838 static uint8_t
1839 usb_hs_bandwidth_adjust(struct usb_device *udev, int16_t len,
1840     uint8_t slot, uint8_t mask)
1841 {
1842         struct usb_bus *bus = udev->bus;
1843         struct usb_hub *hub;
1844         enum usb_dev_speed speed;
1845         uint8_t x;
1846
1847         USB_BUS_LOCK_ASSERT(bus, MA_OWNED);
1848
1849         speed = usbd_get_speed(udev);
1850
1851         switch (speed) {
1852         case USB_SPEED_LOW:
1853         case USB_SPEED_FULL:
1854                 if (speed == USB_SPEED_LOW) {
1855                         len *= 8;
1856                 }
1857                 /*
1858                  * The Host Controller Driver should have
1859                  * performed checks so that the lookup
1860                  * below does not result in a NULL pointer
1861                  * access.
1862                  */
1863
1864                 hub = udev->parent_hs_hub->hub;
1865                 if (slot >= USB_HS_MICRO_FRAMES_MAX) {
1866                         slot = usb_intr_find_best_slot(hub->uframe_usage,
1867                             USB_FS_ISOC_UFRAME_MAX, 6, mask);
1868                 }
1869                 for (x = slot; x < 8; x++) {
1870                         if (mask & (1U << (x - slot))) {
1871                                 hub->uframe_usage[x] += len;
1872                                 bus->uframe_usage[x] += len;
1873                         }
1874                 }
1875                 break;
1876         default:
1877                 if (slot >= USB_HS_MICRO_FRAMES_MAX) {
1878                         slot = usb_intr_find_best_slot(bus->uframe_usage, 0,
1879                             USB_HS_MICRO_FRAMES_MAX, mask);
1880                 }
1881                 for (x = slot; x < 8; x++) {
1882                         if (mask & (1U << (x - slot))) {
1883                                 bus->uframe_usage[x] += len;
1884                         }
1885                 }
1886                 break;
1887         }
1888         return (slot);
1889 }
1890
1891 /*------------------------------------------------------------------------*
1892  *      usb_hs_bandwidth_alloc
1893  *
1894  * This function is a wrapper function for "usb_hs_bandwidth_adjust()".
1895  *------------------------------------------------------------------------*/
1896 void
1897 usb_hs_bandwidth_alloc(struct usb_xfer *xfer)
1898 {
1899         struct usb_device *udev;
1900         uint8_t slot;
1901         uint8_t mask;
1902         uint8_t speed;
1903
1904         udev = xfer->xroot->udev;
1905
1906         if (udev->flags.usb_mode != USB_MODE_HOST)
1907                 return;         /* not supported */
1908
1909         xfer->endpoint->refcount_bw++;
1910         if (xfer->endpoint->refcount_bw != 1)
1911                 return;         /* already allocated */
1912
1913         speed = usbd_get_speed(udev);
1914
1915         switch (xfer->endpoint->edesc->bmAttributes & UE_XFERTYPE) {
1916         case UE_INTERRUPT:
1917                 /* allocate a microframe slot */
1918
1919                 mask = 0x01;
1920                 slot = usb_hs_bandwidth_adjust(udev,
1921                     xfer->max_frame_size, USB_HS_MICRO_FRAMES_MAX, mask);
1922
1923                 xfer->endpoint->usb_uframe = slot;
1924                 xfer->endpoint->usb_smask = mask << slot;
1925
1926                 if ((speed != USB_SPEED_FULL) &&
1927                     (speed != USB_SPEED_LOW)) {
1928                         xfer->endpoint->usb_cmask = 0x00 ;
1929                 } else {
1930                         xfer->endpoint->usb_cmask = (-(0x04 << slot)) & 0xFE;
1931                 }
1932                 break;
1933
1934         case UE_ISOCHRONOUS:
1935                 switch (usbd_xfer_get_fps_shift(xfer)) {
1936                 case 0:
1937                         mask = 0xFF;
1938                         break;
1939                 case 1:
1940                         mask = 0x55;
1941                         break;
1942                 case 2:
1943                         mask = 0x11;
1944                         break;
1945                 default:
1946                         mask = 0x01;
1947                         break;
1948                 }
1949
1950                 /* allocate a microframe multi-slot */
1951
1952                 slot = usb_hs_bandwidth_adjust(udev,
1953                     xfer->max_frame_size, USB_HS_MICRO_FRAMES_MAX, mask);
1954
1955                 xfer->endpoint->usb_uframe = slot;
1956                 xfer->endpoint->usb_cmask = 0;
1957                 xfer->endpoint->usb_smask = mask << slot;
1958                 break;
1959
1960         default:
1961                 xfer->endpoint->usb_uframe = 0;
1962                 xfer->endpoint->usb_cmask = 0;
1963                 xfer->endpoint->usb_smask = 0;
1964                 break;
1965         }
1966
1967         DPRINTFN(11, "slot=%d, mask=0x%02x\n",
1968             xfer->endpoint->usb_uframe,
1969             xfer->endpoint->usb_smask >> xfer->endpoint->usb_uframe);
1970 }
1971
1972 /*------------------------------------------------------------------------*
1973  *      usb_hs_bandwidth_free
1974  *
1975  * This function is a wrapper function for "usb_hs_bandwidth_adjust()".
1976  *------------------------------------------------------------------------*/
1977 void
1978 usb_hs_bandwidth_free(struct usb_xfer *xfer)
1979 {
1980         struct usb_device *udev;
1981         uint8_t slot;
1982         uint8_t mask;
1983
1984         udev = xfer->xroot->udev;
1985
1986         if (udev->flags.usb_mode != USB_MODE_HOST)
1987                 return;         /* not supported */
1988
1989         xfer->endpoint->refcount_bw--;
1990         if (xfer->endpoint->refcount_bw != 0)
1991                 return;         /* still allocated */
1992
1993         switch (xfer->endpoint->edesc->bmAttributes & UE_XFERTYPE) {
1994         case UE_INTERRUPT:
1995         case UE_ISOCHRONOUS:
1996
1997                 slot = xfer->endpoint->usb_uframe;
1998                 mask = xfer->endpoint->usb_smask;
1999
2000                 /* free microframe slot(s): */
2001                 usb_hs_bandwidth_adjust(udev,
2002                     -xfer->max_frame_size, slot, mask >> slot);
2003
2004                 DPRINTFN(11, "slot=%d, mask=0x%02x\n",
2005                     slot, mask >> slot);
2006
2007                 xfer->endpoint->usb_uframe = 0;
2008                 xfer->endpoint->usb_cmask = 0;
2009                 xfer->endpoint->usb_smask = 0;
2010                 break;
2011
2012         default:
2013                 break;
2014         }
2015 }
2016
2017 /*------------------------------------------------------------------------*
2018  *      usb_isoc_time_expand
2019  *
2020  * This function will expand the time counter from 7-bit to 16-bit.
2021  *
2022  * Returns:
2023  *   16-bit isochronous time counter.
2024  *------------------------------------------------------------------------*/
2025 uint16_t
2026 usb_isoc_time_expand(struct usb_bus *bus, uint16_t isoc_time_curr)
2027 {
2028         uint16_t rem;
2029
2030         USB_BUS_LOCK_ASSERT(bus, MA_OWNED);
2031
2032         rem = bus->isoc_time_last & (USB_ISOC_TIME_MAX - 1);
2033
2034         isoc_time_curr &= (USB_ISOC_TIME_MAX - 1);
2035
2036         if (isoc_time_curr < rem) {
2037                 /* the time counter wrapped around */
2038                 bus->isoc_time_last += USB_ISOC_TIME_MAX;
2039         }
2040         /* update the remainder */
2041
2042         bus->isoc_time_last &= ~(USB_ISOC_TIME_MAX - 1);
2043         bus->isoc_time_last |= isoc_time_curr;
2044
2045         return (bus->isoc_time_last);
2046 }
2047
2048 /*------------------------------------------------------------------------*
2049  *      usbd_fs_isoc_schedule_alloc_slot
2050  *
2051  * This function will allocate bandwidth for an isochronous FULL speed
2052  * transaction in the FULL speed schedule.
2053  *
2054  * Returns:
2055  *    <8: Success
2056  * Else: Error
2057  *------------------------------------------------------------------------*/
2058 #if USB_HAVE_TT_SUPPORT
2059 uint8_t
2060 usbd_fs_isoc_schedule_alloc_slot(struct usb_xfer *isoc_xfer, uint16_t isoc_time)
2061 {
2062         struct usb_xfer *xfer;
2063         struct usb_xfer *pipe_xfer;
2064         struct usb_bus *bus;
2065         usb_frlength_t len;
2066         usb_frlength_t data_len;
2067         uint16_t delta;
2068         uint16_t slot;
2069         uint8_t retval;
2070
2071         data_len = 0;
2072         slot = 0;
2073
2074         bus = isoc_xfer->xroot->bus;
2075
2076         TAILQ_FOREACH(xfer, &bus->intr_q.head, wait_entry) {
2077                 /* skip self, if any */
2078
2079                 if (xfer == isoc_xfer)
2080                         continue;
2081
2082                 /* check if this USB transfer is going through the same TT */
2083
2084                 if (xfer->xroot->udev->parent_hs_hub !=
2085                     isoc_xfer->xroot->udev->parent_hs_hub) {
2086                         continue;
2087                 }
2088                 if ((isoc_xfer->xroot->udev->parent_hs_hub->
2089                     ddesc.bDeviceProtocol == UDPROTO_HSHUBMTT) &&
2090                     (xfer->xroot->udev->hs_port_no !=
2091                     isoc_xfer->xroot->udev->hs_port_no)) {
2092                         continue;
2093                 }
2094                 if (xfer->endpoint->methods != isoc_xfer->endpoint->methods)
2095                         continue;
2096
2097                 /* check if isoc_time is part of this transfer */
2098
2099                 delta = xfer->isoc_time_complete - isoc_time;
2100                 if (delta > 0 && delta <= xfer->nframes) {
2101                         delta = xfer->nframes - delta;
2102
2103                         len = xfer->frlengths[delta];
2104                         len += 8;
2105                         len *= 7;
2106                         len /= 6;
2107
2108                         data_len += len;
2109                 }
2110
2111                 /*
2112                  * Check double buffered transfers. Only stream ID
2113                  * equal to zero is valid here!
2114                  */
2115                 TAILQ_FOREACH(pipe_xfer, &xfer->endpoint->endpoint_q[0].head,
2116                     wait_entry) {
2117                         /* skip self, if any */
2118
2119                         if (pipe_xfer == isoc_xfer)
2120                                 continue;
2121
2122                         /* check if isoc_time is part of this transfer */
2123
2124                         delta = pipe_xfer->isoc_time_complete - isoc_time;
2125                         if (delta > 0 && delta <= pipe_xfer->nframes) {
2126                                 delta = pipe_xfer->nframes - delta;
2127
2128                                 len = pipe_xfer->frlengths[delta];
2129                                 len += 8;
2130                                 len *= 7;
2131                                 len /= 6;
2132
2133                                 data_len += len;
2134                         }
2135                 }
2136         }
2137
2138         while (data_len >= USB_FS_BYTES_PER_HS_UFRAME) {
2139                 data_len -= USB_FS_BYTES_PER_HS_UFRAME;
2140                 slot++;
2141         }
2142
2143         /* check for overflow */
2144
2145         if (slot >= USB_FS_ISOC_UFRAME_MAX)
2146                 return (255);
2147
2148         retval = slot;
2149
2150         delta = isoc_xfer->isoc_time_complete - isoc_time;
2151         if (delta > 0 && delta <= isoc_xfer->nframes) {
2152                 delta = isoc_xfer->nframes - delta;
2153
2154                 len = isoc_xfer->frlengths[delta];
2155                 len += 8;
2156                 len *= 7;
2157                 len /= 6;
2158
2159                 data_len += len;
2160         }
2161
2162         while (data_len >= USB_FS_BYTES_PER_HS_UFRAME) {
2163                 data_len -= USB_FS_BYTES_PER_HS_UFRAME;
2164                 slot++;
2165         }
2166
2167         /* check for overflow */
2168
2169         if (slot >= USB_FS_ISOC_UFRAME_MAX)
2170                 return (255);
2171
2172         return (retval);
2173 }
2174 #endif
2175
2176 /*------------------------------------------------------------------------*
2177  *      usb_bus_port_get_device
2178  *
2179  * This function is NULL safe.
2180  *------------------------------------------------------------------------*/
2181 struct usb_device *
2182 usb_bus_port_get_device(struct usb_bus *bus, struct usb_port *up)
2183 {
2184         if ((bus == NULL) || (up == NULL)) {
2185                 /* be NULL safe */
2186                 return (NULL);
2187         }
2188         if (up->device_index == 0) {
2189                 /* nothing to do */
2190                 return (NULL);
2191         }
2192         return (bus->devices[up->device_index]);
2193 }
2194
2195 /*------------------------------------------------------------------------*
2196  *      usb_bus_port_set_device
2197  *
2198  * This function is NULL safe.
2199  *------------------------------------------------------------------------*/
2200 void
2201 usb_bus_port_set_device(struct usb_bus *bus, struct usb_port *up,
2202     struct usb_device *udev, uint8_t device_index)
2203 {
2204         if (bus == NULL) {
2205                 /* be NULL safe */
2206                 return;
2207         }
2208         /*
2209          * There is only one case where we don't
2210          * have an USB port, and that is the Root Hub!
2211          */
2212         if (up) {
2213                 if (udev) {
2214                         up->device_index = device_index;
2215                 } else {
2216                         device_index = up->device_index;
2217                         up->device_index = 0;
2218                 }
2219         }
2220         /*
2221          * Make relationships to our new device
2222          */
2223         if (device_index != 0) {
2224 #if USB_HAVE_UGEN
2225                 mtx_lock(&usb_ref_lock);
2226 #endif
2227                 bus->devices[device_index] = udev;
2228 #if USB_HAVE_UGEN
2229                 mtx_unlock(&usb_ref_lock);
2230 #endif
2231         }
2232         /*
2233          * Debug print
2234          */
2235         DPRINTFN(2, "bus %p devices[%u] = %p\n", bus, device_index, udev);
2236 }
2237
2238 /*------------------------------------------------------------------------*
2239  *      usb_needs_explore
2240  *
2241  * This functions is called when the USB event thread needs to run.
2242  *------------------------------------------------------------------------*/
2243 void
2244 usb_needs_explore(struct usb_bus *bus, uint8_t do_probe)
2245 {
2246         uint8_t do_unlock;
2247
2248         DPRINTF("\n");
2249
2250         if (cold != 0) {
2251                 DPRINTF("Cold\n");
2252                 return;
2253         }
2254
2255         if (bus == NULL) {
2256                 DPRINTF("No bus pointer!\n");
2257                 return;
2258         }
2259         if ((bus->devices == NULL) ||
2260             (bus->devices[USB_ROOT_HUB_ADDR] == NULL)) {
2261                 DPRINTF("No root HUB\n");
2262                 return;
2263         }
2264         if (mtx_owned(&bus->bus_mtx)) {
2265                 do_unlock = 0;
2266         } else {
2267                 USB_BUS_LOCK(bus);
2268                 do_unlock = 1;
2269         }
2270         if (do_probe) {
2271                 bus->do_probe = 1;
2272         }
2273         if (usb_proc_msignal(USB_BUS_EXPLORE_PROC(bus),
2274             &bus->explore_msg[0], &bus->explore_msg[1])) {
2275                 /* ignore */
2276         }
2277         if (do_unlock) {
2278                 USB_BUS_UNLOCK(bus);
2279         }
2280 }
2281
2282 /*------------------------------------------------------------------------*
2283  *      usb_needs_explore_all
2284  *
2285  * This function is called whenever a new driver is loaded and will
2286  * cause that all USB buses are re-explored.
2287  *------------------------------------------------------------------------*/
2288 void
2289 usb_needs_explore_all(void)
2290 {
2291         struct usb_bus *bus;
2292         devclass_t dc;
2293         device_t dev;
2294         int max;
2295
2296         DPRINTFN(3, "\n");
2297
2298         dc = usb_devclass_ptr;
2299         if (dc == NULL) {
2300                 DPRINTFN(0, "no devclass\n");
2301                 return;
2302         }
2303         /*
2304          * Explore all USB buses in parallel.
2305          */
2306         max = devclass_get_maxunit(dc);
2307         while (max >= 0) {
2308                 dev = devclass_get_device(dc, max);
2309                 if (dev) {
2310                         bus = device_get_softc(dev);
2311                         if (bus) {
2312                                 usb_needs_explore(bus, 1);
2313                         }
2314                 }
2315                 max--;
2316         }
2317 }
2318
2319 /*------------------------------------------------------------------------*
2320  *      usb_needs_explore_init
2321  *
2322  * This function will ensure that the USB controllers are not enumerated
2323  * until the "cold" variable is cleared.
2324  *------------------------------------------------------------------------*/
2325 static void
2326 usb_needs_explore_init(void *arg)
2327 {
2328         /*
2329          * The cold variable should be cleared prior to this function
2330          * being called:
2331          */
2332         if (cold == 0)
2333                 usb_needs_explore_all();
2334         else
2335                 DPRINTFN(-1, "Cold variable is still set!\n");
2336 }
2337 SYSINIT(usb_needs_explore_init, SI_SUB_KICK_SCHEDULER, SI_ORDER_SECOND, usb_needs_explore_init, NULL);
2338
2339 /*------------------------------------------------------------------------*
2340  *      usb_bus_power_update
2341  *
2342  * This function will ensure that all USB devices on the given bus are
2343  * properly suspended or resumed according to the device transfer
2344  * state.
2345  *------------------------------------------------------------------------*/
2346 #if USB_HAVE_POWERD
2347 void
2348 usb_bus_power_update(struct usb_bus *bus)
2349 {
2350         usb_needs_explore(bus, 0 /* no probe */ );
2351 }
2352 #endif
2353
2354 /*------------------------------------------------------------------------*
2355  *      usbd_transfer_power_ref
2356  *
2357  * This function will modify the power save reference counts and
2358  * wakeup the USB device associated with the given USB transfer, if
2359  * needed.
2360  *------------------------------------------------------------------------*/
2361 #if USB_HAVE_POWERD
2362 void
2363 usbd_transfer_power_ref(struct usb_xfer *xfer, int val)
2364 {
2365         static const usb_power_mask_t power_mask[4] = {
2366                 [UE_CONTROL] = USB_HW_POWER_CONTROL,
2367                 [UE_BULK] = USB_HW_POWER_BULK,
2368                 [UE_INTERRUPT] = USB_HW_POWER_INTERRUPT,
2369                 [UE_ISOCHRONOUS] = USB_HW_POWER_ISOC,
2370         };
2371         struct usb_device *udev;
2372         uint8_t needs_explore;
2373         uint8_t needs_hw_power;
2374         uint8_t xfer_type;
2375
2376         udev = xfer->xroot->udev;
2377
2378         if (udev->device_index == USB_ROOT_HUB_ADDR) {
2379                 /* no power save for root HUB */
2380                 return;
2381         }
2382         USB_BUS_LOCK(udev->bus);
2383
2384         xfer_type = xfer->endpoint->edesc->bmAttributes & UE_XFERTYPE;
2385
2386         udev->pwr_save.last_xfer_time = ticks;
2387         udev->pwr_save.type_refs[xfer_type] += val;
2388
2389         if (xfer->flags_int.control_xfr) {
2390                 udev->pwr_save.read_refs += val;
2391                 if (xfer->flags_int.usb_mode == USB_MODE_HOST) {
2392                         /*
2393                          * It is not allowed to suspend during a
2394                          * control transfer:
2395                          */
2396                         udev->pwr_save.write_refs += val;
2397                 }
2398         } else if (USB_GET_DATA_ISREAD(xfer)) {
2399                 udev->pwr_save.read_refs += val;
2400         } else {
2401                 udev->pwr_save.write_refs += val;
2402         }
2403
2404         if (val > 0) {
2405                 if (udev->flags.self_suspended)
2406                         needs_explore = usb_peer_should_wakeup(udev);
2407                 else
2408                         needs_explore = 0;
2409
2410                 if (!(udev->bus->hw_power_state & power_mask[xfer_type])) {
2411                         DPRINTF("Adding type %u to power state\n", xfer_type);
2412                         udev->bus->hw_power_state |= power_mask[xfer_type];
2413                         needs_hw_power = 1;
2414                 } else {
2415                         needs_hw_power = 0;
2416                 }
2417         } else {
2418                 needs_explore = 0;
2419                 needs_hw_power = 0;
2420         }
2421
2422         USB_BUS_UNLOCK(udev->bus);
2423
2424         if (needs_explore) {
2425                 DPRINTF("update\n");
2426                 usb_bus_power_update(udev->bus);
2427         } else if (needs_hw_power) {
2428                 DPRINTF("needs power\n");
2429                 if (udev->bus->methods->set_hw_power != NULL) {
2430                         (udev->bus->methods->set_hw_power) (udev->bus);
2431                 }
2432         }
2433 }
2434 #endif
2435
2436 /*------------------------------------------------------------------------*
2437  *      usb_peer_should_wakeup
2438  *
2439  * This function returns non-zero if the current device should wake up.
2440  *------------------------------------------------------------------------*/
2441 static uint8_t
2442 usb_peer_should_wakeup(struct usb_device *udev)
2443 {
2444         return (((udev->power_mode == USB_POWER_MODE_ON) &&
2445             (udev->flags.usb_mode == USB_MODE_HOST)) ||
2446             (udev->driver_added_refcount != udev->bus->driver_added_refcount) ||
2447             (udev->re_enumerate_wait != USB_RE_ENUM_DONE) ||
2448             (udev->pwr_save.type_refs[UE_ISOCHRONOUS] != 0) ||
2449             (udev->pwr_save.write_refs != 0) ||
2450             ((udev->pwr_save.read_refs != 0) &&
2451             (udev->flags.usb_mode == USB_MODE_HOST) &&
2452             (usb_peer_can_wakeup(udev) == 0)));
2453 }
2454
2455 /*------------------------------------------------------------------------*
2456  *      usb_bus_powerd
2457  *
2458  * This function implements the USB power daemon and is called
2459  * regularly from the USB explore thread.
2460  *------------------------------------------------------------------------*/
2461 #if USB_HAVE_POWERD
2462 void
2463 usb_bus_powerd(struct usb_bus *bus)
2464 {
2465         struct usb_device *udev;
2466         usb_ticks_t temp;
2467         usb_ticks_t limit;
2468         usb_ticks_t mintime;
2469         usb_size_t type_refs[5];
2470         uint8_t x;
2471
2472         limit = usb_power_timeout;
2473         if (limit == 0)
2474                 limit = hz;
2475         else if (limit > 255)
2476                 limit = 255 * hz;
2477         else
2478                 limit = limit * hz;
2479
2480         DPRINTF("bus=%p\n", bus);
2481
2482         USB_BUS_LOCK(bus);
2483
2484         /*
2485          * The root HUB device is never suspended
2486          * and we simply skip it.
2487          */
2488         for (x = USB_ROOT_HUB_ADDR + 1;
2489             x != bus->devices_max; x++) {
2490                 udev = bus->devices[x];
2491                 if (udev == NULL)
2492                         continue;
2493
2494                 temp = ticks - udev->pwr_save.last_xfer_time;
2495
2496                 if (usb_peer_should_wakeup(udev)) {
2497                         /* check if we are suspended */
2498                         if (udev->flags.self_suspended != 0) {
2499                                 USB_BUS_UNLOCK(bus);
2500                                 usb_dev_resume_peer(udev);
2501                                 USB_BUS_LOCK(bus);
2502                         }
2503                 } else if ((temp >= limit) &&
2504                     (udev->flags.usb_mode == USB_MODE_HOST) &&
2505                     (udev->flags.self_suspended == 0)) {
2506                         /* try to do suspend */
2507
2508                         USB_BUS_UNLOCK(bus);
2509                         usb_dev_suspend_peer(udev);
2510                         USB_BUS_LOCK(bus);
2511                 }
2512         }
2513
2514         /* reset counters */
2515
2516         mintime = (usb_ticks_t)-1;
2517         type_refs[0] = 0;
2518         type_refs[1] = 0;
2519         type_refs[2] = 0;
2520         type_refs[3] = 0;
2521         type_refs[4] = 0;
2522
2523         /* Re-loop all the devices to get the actual state */
2524
2525         for (x = USB_ROOT_HUB_ADDR + 1;
2526             x != bus->devices_max; x++) {
2527                 udev = bus->devices[x];
2528                 if (udev == NULL)
2529                         continue;
2530
2531                 /* we found a non-Root-Hub USB device */
2532                 type_refs[4] += 1;
2533
2534                 /* "last_xfer_time" can be updated by a resume */
2535                 temp = ticks - udev->pwr_save.last_xfer_time;
2536
2537                 /*
2538                  * Compute minimum time since last transfer for the complete
2539                  * bus:
2540                  */
2541                 if (temp < mintime)
2542                         mintime = temp;
2543
2544                 if (udev->flags.self_suspended == 0) {
2545                         type_refs[0] += udev->pwr_save.type_refs[0];
2546                         type_refs[1] += udev->pwr_save.type_refs[1];
2547                         type_refs[2] += udev->pwr_save.type_refs[2];
2548                         type_refs[3] += udev->pwr_save.type_refs[3];
2549                 }
2550         }
2551
2552         if (mintime >= (usb_ticks_t)(1 * hz)) {
2553                 /* recompute power masks */
2554                 DPRINTF("Recomputing power masks\n");
2555                 bus->hw_power_state = 0;
2556                 if (type_refs[UE_CONTROL] != 0)
2557                         bus->hw_power_state |= USB_HW_POWER_CONTROL;
2558                 if (type_refs[UE_BULK] != 0)
2559                         bus->hw_power_state |= USB_HW_POWER_BULK;
2560                 if (type_refs[UE_INTERRUPT] != 0)
2561                         bus->hw_power_state |= USB_HW_POWER_INTERRUPT;
2562                 if (type_refs[UE_ISOCHRONOUS] != 0)
2563                         bus->hw_power_state |= USB_HW_POWER_ISOC;
2564                 if (type_refs[4] != 0)
2565                         bus->hw_power_state |= USB_HW_POWER_NON_ROOT_HUB;
2566         }
2567         USB_BUS_UNLOCK(bus);
2568
2569         if (bus->methods->set_hw_power != NULL) {
2570                 /* always update hardware power! */
2571                 (bus->methods->set_hw_power) (bus);
2572         }
2573         return;
2574 }
2575 #endif
2576
2577 static usb_error_t
2578 usbd_device_30_remote_wakeup(struct usb_device *udev, uint8_t bRequest)
2579 {
2580         struct usb_device_request req = {};
2581
2582         req.bmRequestType = UT_WRITE_INTERFACE;
2583         req.bRequest = bRequest;
2584         USETW(req.wValue, USB_INTERFACE_FUNC_SUSPEND);
2585         USETW(req.wIndex, USB_INTERFACE_FUNC_SUSPEND_LP |
2586             USB_INTERFACE_FUNC_SUSPEND_RW);
2587
2588         return (usbd_do_request(udev, NULL, &req, 0));
2589 }
2590
2591 static usb_error_t
2592 usbd_clear_dev_wakeup(struct usb_device *udev)
2593 {
2594         usb_error_t err;
2595
2596         if (usb_device_20_compatible(udev)) {
2597                 err = usbd_req_clear_device_feature(udev,
2598                     NULL, UF_DEVICE_REMOTE_WAKEUP);
2599         } else {
2600                 err = usbd_device_30_remote_wakeup(udev,
2601                     UR_CLEAR_FEATURE);
2602         }
2603         return (err);
2604 }
2605
2606 static usb_error_t
2607 usbd_set_dev_wakeup(struct usb_device *udev)
2608 {
2609         usb_error_t err;
2610
2611         if (usb_device_20_compatible(udev)) {
2612                 err = usbd_req_set_device_feature(udev,
2613                     NULL, UF_DEVICE_REMOTE_WAKEUP);
2614         } else {
2615                 err = usbd_device_30_remote_wakeup(udev,
2616                     UR_SET_FEATURE);
2617         }
2618         return (err);
2619 }
2620
2621 /*------------------------------------------------------------------------*
2622  *      usb_dev_resume_peer
2623  *
2624  * This function will resume an USB peer and do the required USB
2625  * signalling to get an USB device out of the suspended state.
2626  *------------------------------------------------------------------------*/
2627 static void
2628 usb_dev_resume_peer(struct usb_device *udev)
2629 {
2630         struct usb_bus *bus;
2631         int err;
2632
2633         /* be NULL safe */
2634         if (udev == NULL)
2635                 return;
2636
2637         /* check if already resumed */
2638         if (udev->flags.self_suspended == 0)
2639                 return;
2640
2641         /* we need a parent HUB to do resume */
2642         if (udev->parent_hub == NULL)
2643                 return;
2644
2645         DPRINTF("udev=%p\n", udev);
2646
2647         if ((udev->flags.usb_mode == USB_MODE_DEVICE) &&
2648             (udev->flags.remote_wakeup == 0)) {
2649                 /*
2650                  * If the host did not set the remote wakeup feature, we can
2651                  * not wake it up either!
2652                  */
2653                 DPRINTF("remote wakeup is not set!\n");
2654                 return;
2655         }
2656         /* get bus pointer */
2657         bus = udev->bus;
2658
2659         /* resume parent hub first */
2660         usb_dev_resume_peer(udev->parent_hub);
2661
2662         /* reduce chance of instant resume failure by waiting a little bit */
2663         usb_pause_mtx(NULL, USB_MS_TO_TICKS(20));
2664
2665         if (usb_device_20_compatible(udev)) {
2666                 /* resume current port (Valid in Host and Device Mode) */
2667                 err = usbd_req_clear_port_feature(udev->parent_hub,
2668                     NULL, udev->port_no, UHF_PORT_SUSPEND);
2669                 if (err) {
2670                         DPRINTFN(0, "Resuming port failed\n");
2671                         return;
2672                 }
2673         } else {
2674                 /* resume current port (Valid in Host and Device Mode) */
2675                 err = usbd_req_set_port_link_state(udev->parent_hub,
2676                     NULL, udev->port_no, UPS_PORT_LS_U0);
2677                 if (err) {
2678                         DPRINTFN(0, "Resuming port failed\n");
2679                         return;
2680                 }
2681         }
2682
2683         /* resume settle time */
2684         usb_pause_mtx(NULL, USB_MS_TO_TICKS(usb_port_resume_delay));
2685
2686         if (bus->methods->device_resume != NULL) {
2687                 /* resume USB device on the USB controller */
2688                 (bus->methods->device_resume) (udev);
2689         }
2690         USB_BUS_LOCK(bus);
2691         /* set that this device is now resumed */
2692         udev->flags.self_suspended = 0;
2693 #if USB_HAVE_POWERD
2694         /* make sure that we don't go into suspend right away */
2695         udev->pwr_save.last_xfer_time = ticks;
2696
2697         /* make sure the needed power masks are on */
2698         if (udev->pwr_save.type_refs[UE_CONTROL] != 0)
2699                 bus->hw_power_state |= USB_HW_POWER_CONTROL;
2700         if (udev->pwr_save.type_refs[UE_BULK] != 0)
2701                 bus->hw_power_state |= USB_HW_POWER_BULK;
2702         if (udev->pwr_save.type_refs[UE_INTERRUPT] != 0)
2703                 bus->hw_power_state |= USB_HW_POWER_INTERRUPT;
2704         if (udev->pwr_save.type_refs[UE_ISOCHRONOUS] != 0)
2705                 bus->hw_power_state |= USB_HW_POWER_ISOC;
2706 #endif
2707         USB_BUS_UNLOCK(bus);
2708
2709         if (bus->methods->set_hw_power != NULL) {
2710                 /* always update hardware power! */
2711                 (bus->methods->set_hw_power) (bus);
2712         }
2713
2714         usbd_sr_lock(udev);
2715
2716         /* notify all sub-devices about resume */
2717         err = usb_suspend_resume(udev, 0);
2718
2719         usbd_sr_unlock(udev);
2720
2721         /* check if peer has wakeup capability */
2722         if (usb_peer_can_wakeup(udev)) {
2723                 /* clear remote wakeup */
2724                 err = usbd_clear_dev_wakeup(udev);
2725                 if (err) {
2726                         DPRINTFN(0, "Clearing device "
2727                             "remote wakeup failed: %s\n",
2728                             usbd_errstr(err));
2729                 }
2730         }
2731 }
2732
2733 /*------------------------------------------------------------------------*
2734  *      usb_dev_suspend_peer
2735  *
2736  * This function will suspend an USB peer and do the required USB
2737  * signalling to get an USB device into the suspended state.
2738  *------------------------------------------------------------------------*/
2739 static void
2740 usb_dev_suspend_peer(struct usb_device *udev)
2741 {
2742         struct usb_device *child;
2743         int err;
2744         uint8_t x;
2745         uint8_t nports;
2746
2747 repeat:
2748         /* be NULL safe */
2749         if (udev == NULL)
2750                 return;
2751
2752         /* check if already suspended */
2753         if (udev->flags.self_suspended)
2754                 return;
2755
2756         /* we need a parent HUB to do suspend */
2757         if (udev->parent_hub == NULL)
2758                 return;
2759
2760         DPRINTF("udev=%p\n", udev);
2761
2762         /* check if the current device is a HUB */
2763         if (udev->hub != NULL) {
2764                 nports = udev->hub->nports;
2765
2766                 /* check if all devices on the HUB are suspended */
2767                 for (x = 0; x != nports; x++) {
2768                         child = usb_bus_port_get_device(udev->bus,
2769                             udev->hub->ports + x);
2770
2771                         if (child == NULL)
2772                                 continue;
2773
2774                         if (child->flags.self_suspended)
2775                                 continue;
2776
2777                         DPRINTFN(1, "Port %u is busy on the HUB!\n", x + 1);
2778                         return;
2779                 }
2780         }
2781
2782         if (usb_peer_can_wakeup(udev)) {
2783                 /*
2784                  * This request needs to be done before we set
2785                  * "udev->flags.self_suspended":
2786                  */
2787
2788                 /* allow device to do remote wakeup */
2789                 err = usbd_set_dev_wakeup(udev);
2790                 if (err) {
2791                         DPRINTFN(0, "Setting device "
2792                             "remote wakeup failed\n");
2793                 }
2794         }
2795
2796         USB_BUS_LOCK(udev->bus);
2797         /*
2798          * Checking for suspend condition and setting suspended bit
2799          * must be atomic!
2800          */
2801         err = usb_peer_should_wakeup(udev);
2802         if (err == 0) {
2803                 /*
2804                  * Set that this device is suspended. This variable
2805                  * must be set before calling USB controller suspend
2806                  * callbacks.
2807                  */
2808                 udev->flags.self_suspended = 1;
2809         }
2810         USB_BUS_UNLOCK(udev->bus);
2811
2812         if (err != 0) {
2813                 if (usb_peer_can_wakeup(udev)) {
2814                         /* allow device to do remote wakeup */
2815                         err = usbd_clear_dev_wakeup(udev);
2816                         if (err) {
2817                                 DPRINTFN(0, "Setting device "
2818                                     "remote wakeup failed\n");
2819                         }
2820                 }
2821
2822                 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
2823                         /* resume parent HUB first */
2824                         usb_dev_resume_peer(udev->parent_hub);
2825
2826                         /* reduce chance of instant resume failure by waiting a little bit */
2827                         usb_pause_mtx(NULL, USB_MS_TO_TICKS(20));
2828
2829                         /* resume current port (Valid in Host and Device Mode) */
2830                         err = usbd_req_clear_port_feature(udev->parent_hub,
2831                             NULL, udev->port_no, UHF_PORT_SUSPEND);
2832
2833                         /* resume settle time */
2834                         usb_pause_mtx(NULL, USB_MS_TO_TICKS(usb_port_resume_delay));
2835                 }
2836                 DPRINTF("Suspend was cancelled!\n");
2837                 return;
2838         }
2839
2840         usbd_sr_lock(udev);
2841
2842         /* notify all sub-devices about suspend */
2843         err = usb_suspend_resume(udev, 1);
2844
2845         usbd_sr_unlock(udev);
2846
2847         if (udev->bus->methods->device_suspend != NULL) {
2848                 usb_timeout_t temp;
2849
2850                 /* suspend device on the USB controller */
2851                 (udev->bus->methods->device_suspend) (udev);
2852
2853                 /* do DMA delay */
2854                 temp = usbd_get_dma_delay(udev);
2855                 if (temp != 0)
2856                         usb_pause_mtx(NULL, USB_MS_TO_TICKS(temp));
2857         }
2858
2859         if (usb_device_20_compatible(udev)) {
2860                 /* suspend current port */
2861                 err = usbd_req_set_port_feature(udev->parent_hub,
2862                     NULL, udev->port_no, UHF_PORT_SUSPEND);
2863                 if (err) {
2864                         DPRINTFN(0, "Suspending port failed\n");
2865                         return;
2866                 }
2867         } else {
2868                 /* suspend current port */
2869                 err = usbd_req_set_port_link_state(udev->parent_hub,
2870                     NULL, udev->port_no, UPS_PORT_LS_U3);
2871                 if (err) {
2872                         DPRINTFN(0, "Suspending port failed\n");
2873                         return;
2874                 }
2875         }
2876
2877         udev = udev->parent_hub;
2878         goto repeat;
2879 }
2880
2881 /*------------------------------------------------------------------------*
2882  *      usbd_set_power_mode
2883  *
2884  * This function will set the power mode, see USB_POWER_MODE_XXX for a
2885  * USB device.
2886  *------------------------------------------------------------------------*/
2887 void
2888 usbd_set_power_mode(struct usb_device *udev, uint8_t power_mode)
2889 {
2890         /* filter input argument */
2891         if ((power_mode != USB_POWER_MODE_ON) &&
2892             (power_mode != USB_POWER_MODE_OFF))
2893                 power_mode = USB_POWER_MODE_SAVE;
2894
2895         power_mode = usbd_filter_power_mode(udev, power_mode);
2896
2897         udev->power_mode = power_mode;  /* update copy of power mode */
2898
2899 #if USB_HAVE_POWERD
2900         usb_bus_power_update(udev->bus);
2901 #else
2902         usb_needs_explore(udev->bus, 0 /* no probe */ );
2903 #endif
2904 }
2905
2906 /*------------------------------------------------------------------------*
2907  *      usbd_filter_power_mode
2908  *
2909  * This function filters the power mode based on hardware requirements.
2910  *------------------------------------------------------------------------*/
2911 uint8_t
2912 usbd_filter_power_mode(struct usb_device *udev, uint8_t power_mode)
2913 {
2914         const struct usb_bus_methods *mtod;
2915         int8_t temp;
2916
2917         mtod = udev->bus->methods;
2918         temp = -1;
2919
2920         if (mtod->get_power_mode != NULL)
2921                 (mtod->get_power_mode) (udev, &temp);
2922
2923         /* check if we should not filter */
2924         if (temp < 0)
2925                 return (power_mode);
2926
2927         /* use fixed power mode given by hardware driver */
2928         return (temp);
2929 }
2930
2931 /*------------------------------------------------------------------------*
2932  *      usbd_start_re_enumerate
2933  *
2934  * This function starts re-enumeration of the given USB device. This
2935  * function does not need to be called BUS-locked. This function does
2936  * not wait until the re-enumeration is completed.
2937  *------------------------------------------------------------------------*/
2938 void
2939 usbd_start_re_enumerate(struct usb_device *udev)
2940 {
2941         if (udev->re_enumerate_wait == USB_RE_ENUM_DONE) {
2942                 udev->re_enumerate_wait = USB_RE_ENUM_START;
2943                 usb_needs_explore(udev->bus, 0);
2944         }
2945 }
2946
2947 /*-----------------------------------------------------------------------*
2948  *      usbd_start_set_config
2949  *
2950  * This function starts setting a USB configuration. This function
2951  * does not need to be called BUS-locked. This function does not wait
2952  * until the set USB configuratino is completed.
2953  *------------------------------------------------------------------------*/
2954 usb_error_t
2955 usbd_start_set_config(struct usb_device *udev, uint8_t index)
2956 {
2957         if (udev->re_enumerate_wait == USB_RE_ENUM_DONE) {
2958                 if (udev->curr_config_index == index) {
2959                         /* no change needed */
2960                         return (0);
2961                 }
2962                 udev->next_config_index = index;
2963                 udev->re_enumerate_wait = USB_RE_ENUM_SET_CONFIG;
2964                 usb_needs_explore(udev->bus, 0);
2965                 return (0);
2966         } else if (udev->re_enumerate_wait == USB_RE_ENUM_SET_CONFIG) {
2967                 if (udev->next_config_index == index) {
2968                         /* no change needed */
2969                         return (0);
2970                 }
2971         }
2972         return (USB_ERR_PENDING_REQUESTS);
2973 }