sys/dev/usb/usb_hub.c

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