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