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         {0, 0}
 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
 925         ksnprintf(sc->sc_name, sizeof(sc->sc_name), "%s",
 926             device_get_nameunit(dev));
 927
 928         device_set_usb_desc(dev);
 929
 930         DPRINTFN(2, "depth=%d selfpowered=%d, parent=%p, "
 931             "parent->selfpowered=%d\n",
 932             udev->depth,
 933             udev->flags.self_powered,
 934             parent_hub,
 935             parent_hub ?
 936             parent_hub->flags.self_powered : 0);
 937
 938         if (uhub_is_too_deep(udev)) {
 939                 DPRINTFN(0, "HUB at depth %d, "
 940                     "exceeds maximum. HUB ignored\n", (int)udev->depth);
 941                 goto error;
 942         }
 943
 944         if (!udev->flags.self_powered && parent_hub &&
 945             !parent_hub->flags.self_powered) {
 946                 DPRINTFN(0, "Bus powered HUB connected to "
 947                     "bus powered HUB. HUB ignored\n");
 948                 goto error;
 949         }
 950         /* get HUB descriptor */
 951
 952         DPRINTFN(2, "Getting HUB descriptor\n");
 953
 954         switch (udev->speed) {
 955         case USB_SPEED_LOW:
 956         case USB_SPEED_FULL:
 957         case USB_SPEED_HIGH:
 958                 /* assuming that there is one port */
 959                 err = usbd_req_get_hub_descriptor(udev, NULL, &hubdesc20, 1);
 960                 if (err) {
 961                         DPRINTFN(0, "getting USB 2.0 HUB descriptor failed,"
 962                             "error=%s\n", usbd_errstr(err));
 963                         goto error;
 964                 }
 965                 /* get number of ports */
 966                 nports = hubdesc20.bNbrPorts;
 967
 968                 /* get power delay */
 969                 pwrdly = ((hubdesc20.bPwrOn2PwrGood * UHD_PWRON_FACTOR) +
 970                     USB_EXTRA_POWER_UP_TIME);
 971
 972                 /* get complete HUB descriptor */
 973                 if (nports >= 8) {
 974                         /* check number of ports */
 975                         if (nports > 127) {
 976                                 DPRINTFN(0, "Invalid number of USB 2.0 ports,"
 977                                     "error=%s\n", usbd_errstr(err));
 978                                 goto error;
 979                         }
 980                         /* get complete HUB descriptor */
 981                         err = usbd_req_get_hub_descriptor(udev, NULL, &hubdesc20, nports);
 982
 983                         if (err) {
 984                                 DPRINTFN(0, "Getting USB 2.0 HUB descriptor failed,"
 985                                     "error=%s\n", usbd_errstr(err));
 986                                 goto error;
 987                         }
 988                         if (hubdesc20.bNbrPorts != nports) {
 989                                 DPRINTFN(0, "Number of ports changed\n");
 990                                 goto error;
 991                         }
 992                 }
 993                 break;
 994         case USB_SPEED_SUPER:
 995                 if (udev->parent_hub != NULL) {
 996                         err = usbd_req_set_hub_depth(udev, NULL,
 997                             udev->depth - 1);
 998                         if (err) {
 999                                 DPRINTFN(0, "Setting USB 3.0 HUB depth failed,"
1000                                     "error=%s\n", usbd_errstr(err));
1001                                 goto error;
1002                         }
1003                 }
1004                 err = usbd_req_get_ss_hub_descriptor(udev, NULL, &hubdesc30, 1);
1005                 if (err) {
1006                         DPRINTFN(0, "Getting USB 3.0 HUB descriptor failed,"
1007                             "error=%s\n", usbd_errstr(err));
1008                         goto error;
1009                 }
1010                 /* get number of ports */
1011                 nports = hubdesc30.bNbrPorts;
1012
1013                 /* get power delay */
1014                 pwrdly = ((hubdesc30.bPwrOn2PwrGood * UHD_PWRON_FACTOR) +
1015                     USB_EXTRA_POWER_UP_TIME);
1016
1017                 /* get complete HUB descriptor */
1018                 if (nports >= 8) {
1019                         /* check number of ports */
1020                         if (nports > ((udev->parent_hub != NULL) ? 15 : 127)) {
1021                                 DPRINTFN(0, "Invalid number of USB 3.0 ports,"
1022                                     "error=%s\n", usbd_errstr(err));
1023                                 goto error;
1024                         }
1025                         /* get complete HUB descriptor */
1026                         err = usbd_req_get_ss_hub_descriptor(udev, NULL, &hubdesc30, nports);
1027
1028                         if (err) {
1029                                 DPRINTFN(0, "Getting USB 2.0 HUB descriptor failed,"
1030                                     "error=%s\n", usbd_errstr(err));
1031                                 goto error;
1032                         }
1033                         if (hubdesc30.bNbrPorts != nports) {
1034                                 DPRINTFN(0, "Number of ports changed\n");
1035                                 goto error;
1036                         }
1037                 }
1038                 break;
1039         default:
1040                 DPRINTF("Assuming HUB has only one port\n");
1041                 /* default number of ports */
1042                 nports = 1;
1043                 /* default power delay */
1044                 pwrdly = ((10 * UHD_PWRON_FACTOR) + USB_EXTRA_POWER_UP_TIME);
1045                 break;
1046         }
1047         if (nports == 0) {
1048                 DPRINTFN(0, "portless HUB\n");
1049                 goto error;
1050         }
1051         hub = kmalloc(sizeof(hub[0]) + (sizeof(hub->ports[0]) * nports),
1052             M_USBDEV, M_WAITOK | M_ZERO);
1053
1054         if (hub == NULL) {
1055                 goto error;
1056         }
1057         udev->hub = hub;
1058
1059 #if USB_HAVE_TT_SUPPORT
1060         /* init FULL-speed ISOCHRONOUS schedule */
1061         usbd_fs_isoc_schedule_init_all(hub->fs_isoc_schedule);
1062 #endif
1063         /* initialize HUB structure */
1064         hub->hubsoftc = sc;
1065         hub->explore = &uhub_explore;
1066         hub->nports = nports;
1067         hub->hubudev = udev;
1068
1069         /* if self powered hub, give ports maximum current */
1070         if (udev->flags.self_powered) {
1071                 hub->portpower = USB_MAX_POWER;
1072         } else {
1073                 hub->portpower = USB_MIN_POWER;
1074         }
1075
1076         /* set up interrupt pipe */
1077         iface_index = 0;
1078         if (udev->parent_hub == NULL) {
1079                 /* root HUB is special */
1080                 err = 0;
1081         } else {
1082                 /* normal HUB */
1083                 err = usbd_transfer_setup(udev, &iface_index, sc->sc_xfer,
1084                     uhub_config, UHUB_N_TRANSFER, sc, &sc->sc_lock);
1085         }
1086         if (err) {
1087                 DPRINTFN(0, "cannot setup interrupt transfer, "
1088                     "errstr=%s\n", usbd_errstr(err));
1089                 goto error;
1090         }
1091         /* wait with power off for a while */
1092         usb_pause_mtx(NULL, USB_MS_TO_TICKS(USB_POWER_DOWN_TIME));
1093
1094         /*
1095          * To have the best chance of success we do things in the exact same
1096          * order as Windoze98.  This should not be necessary, but some
1097          * devices do not follow the USB specs to the letter.
1098          *
1099          * These are the events on the bus when a hub is attached:
1100          *  Get device and config descriptors (see attach code)
1101          *  Get hub descriptor (see above)
1102          *  For all ports
1103          *     turn on power
1104          *     wait for power to become stable
1105          * (all below happens in explore code)
1106          *  For all ports
1107          *     clear C_PORT_CONNECTION
1108          *  For all ports
1109          *     get port status
1110          *     if device connected
1111          *        wait 100 ms
1112          *        turn on reset
1113          *        wait
1114          *        clear C_PORT_RESET
1115          *        get port status
1116          *        proceed with device attachment
1117          */
1118
1119         /* XXX should check for none, individual, or ganged power? */
1120
1121         removable = 0;
1122
1123         for (x = 0; x != nports; x++) {
1124                 /* set up data structures */
1125                 struct usb_port *up = hub->ports + x;
1126
1127                 up->device_index = 0;
1128                 up->restartcnt = 0;
1129                 portno = x + 1;
1130
1131                 /* check if port is removable */
1132                 switch (udev->speed) {
1133                 case USB_SPEED_LOW:
1134                 case USB_SPEED_FULL:
1135                 case USB_SPEED_HIGH:
1136                         if (!UHD_NOT_REMOV(&hubdesc20, portno))
1137                                 removable++;
1138                         break;
1139                 case USB_SPEED_SUPER:
1140                         if (!UHD_NOT_REMOV(&hubdesc30, portno))
1141                                 removable++;
1142                         break;
1143                 default:
1144                         DPRINTF("Assuming removable port\n");
1145                         removable++;
1146                         break;
1147                 }
1148                 if (!err) {
1149                         /* turn the power on */
1150                         err = usbd_req_set_port_feature(udev, NULL,
1151                             portno, UHF_PORT_POWER);
1152                 }
1153                 if (err) {
1154                         DPRINTFN(0, "port %d power on failed, %s\n",
1155                             portno, usbd_errstr(err));
1156                 }
1157                 DPRINTF("turn on port %d power\n",
1158                     portno);
1159
1160                 /* wait for stable power */
1161                 usb_pause_mtx(NULL, USB_MS_TO_TICKS(pwrdly));
1162         }
1163
1164         device_printf(dev, "%d port%s with %d "
1165             "removable, %s powered\n", nports, (nports != 1) ? "s" : "",
1166             removable, udev->flags.self_powered ? "self" : "bus");
1167
1168         /* Start the interrupt endpoint, if any */
1169
1170         if (sc->sc_xfer[0] != NULL) {
1171                 lockmgr(&sc->sc_lock, LK_EXCLUSIVE);
1172                 usbd_transfer_start(sc->sc_xfer[0]);
1173                 lockmgr(&sc->sc_lock, LK_RELEASE);
1174         }
1175
1176         /* Enable automatic power save on all USB HUBs */
1177
1178         usbd_set_power_mode(udev, USB_POWER_MODE_SAVE);
1179
1180         return (0);
1181
1182 error:
1183         usbd_transfer_unsetup(sc->sc_xfer, UHUB_N_TRANSFER);
1184
1185         if (udev->hub) {
1186                 kfree(udev->hub, M_USBDEV);
1187                 udev->hub = NULL;
1188         }
1189
1190         lockuninit(&sc->sc_lock);
1191
1192         return (ENXIO);
1193 }
1194
1195 /*
1196  * Called from process context when the hub is gone.
1197  * Detach all devices on active ports.
1198  */
1199 static int
1200 uhub_detach(device_t dev)
1201 {
1202         struct uhub_softc *sc = device_get_softc(dev);
1203         struct usb_hub *hub = sc->sc_udev->hub;
1204         struct usb_device *child;
1205         uint8_t x;
1206
1207         if (hub == NULL)                /* must be partially working */
1208                 return (0);
1209
1210         /* Make sure interrupt transfer is gone. */
1211         usbd_transfer_unsetup(sc->sc_xfer, UHUB_N_TRANSFER);
1212
1213         /* Detach all ports */
1214         for (x = 0; x != hub->nports; x++) {
1215
1216                 child = usb_bus_port_get_device(sc->sc_udev->bus, hub->ports + x);
1217
1218                 if (child == NULL) {
1219                         continue;
1220                 }
1221
1222                 /*
1223                  * Free USB device and all subdevices, if any.
1224                  */
1225                 usb_free_device(child, 0);
1226         }
1227
1228         kfree(hub, M_USBDEV);
1229         sc->sc_udev->hub = NULL;
1230
1231         lockuninit(&sc->sc_lock);
1232
1233         return (0);
1234 }
1235
1236 static int
1237 uhub_suspend(device_t dev)
1238 {
1239         DPRINTF("\n");
1240         /* Sub-devices are not suspended here! */
1241         return (0);
1242 }
1243
1244 static int
1245 uhub_resume(device_t dev)
1246 {
1247         DPRINTF("\n");
1248         /* Sub-devices are not resumed here! */
1249         return (0);
1250 }
1251
1252 static void
1253 uhub_driver_added(device_t dev, driver_t *driver)
1254 {
1255         usb_needs_explore_all();
1256 }
1257
1258 struct hub_result {
1259         struct usb_device *udev;
1260         uint8_t portno;
1261         uint8_t iface_index;
1262 };
1263
1264 static void
1265 uhub_find_iface_index(struct usb_hub *hub, device_t child,
1266     struct hub_result *res)
1267 {
1268         struct usb_interface *iface;
1269         struct usb_device *udev;
1270         uint8_t nports;
1271         uint8_t x;
1272         uint8_t i;
1273
1274         nports = hub->nports;
1275         for (x = 0; x != nports; x++) {
1276                 udev = usb_bus_port_get_device(hub->hubudev->bus,
1277                     hub->ports + x);
1278                 if (!udev) {
1279                         continue;
1280                 }
1281                 for (i = 0; i != USB_IFACE_MAX; i++) {
1282                         iface = usbd_get_iface(udev, i);
1283                         if (iface &&
1284                             (iface->subdev == child)) {
1285                                 res->iface_index = i;
1286                                 res->udev = udev;
1287                                 res->portno = x + 1;
1288                                 return;
1289                         }
1290                 }
1291         }
1292         res->iface_index = 0;
1293         res->udev = NULL;
1294         res->portno = 0;
1295 }
1296
1297 static int
1298 uhub_child_location_string(device_t parent, device_t child,
1299     char *buf, size_t buflen)
1300 {
1301         struct uhub_softc *sc;
1302         struct usb_hub *hub;
1303         struct hub_result res;
1304
1305         if (!device_is_attached(parent)) {
1306                 if (buflen)
1307                         buf[0] = 0;
1308                 return (0);
1309         }
1310
1311         sc = device_get_softc(parent);
1312         hub = sc->sc_udev->hub;
1313
1314         /* XXX
1315      * mtx_lock(&Giant);
1316      */
1317         uhub_find_iface_index(hub, child, &res);
1318         if (!res.udev) {
1319                 DPRINTF("device not on hub\n");
1320                 if (buflen) {
1321                         buf[0] = '\0';
1322                 }
1323                 goto done;
1324         }
1325         ksnprintf(buf, buflen, "bus=%u hubaddr=%u port=%u devaddr=%u interface=%u",
1326             (res.udev->parent_hub != NULL) ? res.udev->parent_hub->device_index : 0,
1327             res.portno, device_get_unit(res.udev->bus->bdev),
1328             res.udev->device_index, res.iface_index);
1329 done:
1330         /* XXX
1331      * mtx_unlock(&Giant);
1332      */
1333
1334         return (0);
1335 }
1336
1337 static int
1338 uhub_child_pnpinfo_string(device_t parent, device_t child,
1339     char *buf, size_t buflen)
1340 {
1341         struct uhub_softc *sc;
1342         struct usb_hub *hub;
1343         struct usb_interface *iface;
1344         struct hub_result res;
1345
1346         if (!device_is_attached(parent)) {
1347                 if (buflen)
1348                         buf[0] = 0;
1349                 return (0);
1350         }
1351
1352         sc = device_get_softc(parent);
1353         hub = sc->sc_udev->hub;
1354
1355     /* XXX
1356         mtx_lock(&Giant);
1357     */
1358         uhub_find_iface_index(hub, child, &res);
1359         if (!res.udev) {
1360                 DPRINTF("device not on hub\n");
1361                 if (buflen) {
1362                         buf[0] = '\0';
1363                 }
1364                 goto done;
1365         }
1366         iface = usbd_get_iface(res.udev, res.iface_index);
1367         if (iface && iface->idesc) {
1368                 ksnprintf(buf, buflen, "vendor=0x%04x product=0x%04x "
1369                     "devclass=0x%02x devsubclass=0x%02x "
1370                     "sernum=\"%s\" "
1371                     "release=0x%04x "
1372                     "mode=%s "
1373                     "intclass=0x%02x intsubclass=0x%02x "
1374                     "intprotocol=0x%02x " "%s%s",
1375                     UGETW(res.udev->ddesc.idVendor),
1376                     UGETW(res.udev->ddesc.idProduct),
1377                     res.udev->ddesc.bDeviceClass,
1378                     res.udev->ddesc.bDeviceSubClass,
1379                     usb_get_serial(res.udev),
1380                     UGETW(res.udev->ddesc.bcdDevice),
1381                     (res.udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device",
1382                     iface->idesc->bInterfaceClass,
1383                     iface->idesc->bInterfaceSubClass,
1384                     iface->idesc->bInterfaceProtocol,
1385                     iface->pnpinfo ? " " : "",
1386                     iface->pnpinfo ? iface->pnpinfo : "");
1387         } else {
1388                 if (buflen) {
1389                         buf[0] = '\0';
1390                 }
1391                 goto done;
1392         }
1393 done:
1394     /* XXX
1395         mtx_unlock(&Giant);
1396     */
1397         return (0);
1398 }
1399
1400 /*
1401  * The USB Transaction Translator:
1402  * ===============================
1403  *
1404  * When doing LOW- and FULL-speed USB transfers accross a HIGH-speed
1405  * USB HUB, bandwidth must be allocated for ISOCHRONOUS and INTERRUPT
1406  * USB transfers. To utilize bandwidth dynamically the "scatter and
1407  * gather" principle must be applied. This means that bandwidth must
1408  * be divided into equal parts of bandwidth. With regard to USB all
1409  * data is transferred in smaller packets with length
1410  * "wMaxPacketSize". The problem however is that "wMaxPacketSize" is
1411  * not a constant!
1412  *
1413  * The bandwidth scheduler which I have implemented will simply pack
1414  * the USB transfers back to back until there is no more space in the
1415  * schedule. Out of the 8 microframes which the USB 2.0 standard
1416  * provides, only 6 are available for non-HIGH-speed devices. I have
1417  * reserved the first 4 microframes for ISOCHRONOUS transfers. The
1418  * last 2 microframes I have reserved for INTERRUPT transfers. Without
1419  * this division, it is very difficult to allocate and free bandwidth
1420  * dynamically.
1421  *
1422  * NOTE about the Transaction Translator in USB HUBs:
1423  *
1424  * USB HUBs have a very simple Transaction Translator, that will
1425  * simply pipeline all the SPLIT transactions. That means that the
1426  * transactions will be executed in the order they are queued!
1427  *
1428  */
1429
1430 /*------------------------------------------------------------------------*
1431  *      usb_intr_find_best_slot
1432  *
1433  * Return value:
1434  *   The best Transaction Translation slot for an interrupt endpoint.
1435  *------------------------------------------------------------------------*/
1436 static uint8_t
1437 usb_intr_find_best_slot(usb_size_t *ptr, uint8_t start,
1438     uint8_t end, uint8_t mask)
1439 {
1440         usb_size_t min = 0 - 1;
1441         usb_size_t sum;
1442         uint8_t x;
1443         uint8_t y;
1444         uint8_t z;
1445
1446         y = 0;
1447
1448         /* find the last slot with lesser used bandwidth */
1449
1450         for (x = start; x < end; x++) {
1451
1452                 sum = 0;
1453
1454                 /* compute sum of bandwidth */
1455                 for (z = x; z < end; z++) {
1456                         if (mask & (1U << (z - x)))
1457                                 sum += ptr[z];
1458                 }
1459
1460                 /* check if the current multi-slot is more optimal */
1461                 if (min >= sum) {
1462                         min = sum;
1463                         y = x;
1464                 }
1465
1466                 /* check if the mask is about to be shifted out */
1467                 if (mask & (1U << (end - 1 - x)))
1468                         break;
1469         }
1470         return (y);
1471 }
1472
1473 /*------------------------------------------------------------------------*
1474  *      usb_hs_bandwidth_adjust
1475  *
1476  * This function will update the bandwith usage for the microframe
1477  * having index "slot" by "len" bytes. "len" can be negative.  If the
1478  * "slot" argument is greater or equal to "USB_HS_MICRO_FRAMES_MAX"
1479  * the "slot" argument will be replaced by the slot having least used
1480  * bandwidth. The "mask" argument is used for multi-slot allocations.
1481  *
1482  * Returns:
1483  *    The slot in which the bandwidth update was done: 0..7
1484  *------------------------------------------------------------------------*/
1485 static uint8_t
1486 usb_hs_bandwidth_adjust(struct usb_device *udev, int16_t len,
1487     uint8_t slot, uint8_t mask)
1488 {
1489         struct usb_bus *bus = udev->bus;
1490         struct usb_hub *hub;
1491         enum usb_dev_speed speed;
1492         uint8_t x;
1493
1494         USB_BUS_LOCK_ASSERT(bus);
1495         speed = usbd_get_speed(udev);
1496
1497         switch (speed) {
1498         case USB_SPEED_LOW:
1499         case USB_SPEED_FULL:
1500                 if (speed == USB_SPEED_LOW) {
1501                         len *= 8;
1502                 }
1503                 /*
1504                  * The Host Controller Driver should have
1505                  * performed checks so that the lookup
1506                  * below does not result in a NULL pointer
1507                  * access.
1508                  */
1509
1510                 hub = udev->parent_hs_hub->hub;
1511                 if (slot >= USB_HS_MICRO_FRAMES_MAX) {
1512                         slot = usb_intr_find_best_slot(hub->uframe_usage,
1513                             USB_FS_ISOC_UFRAME_MAX, 6, mask);
1514                 }
1515                 for (x = slot; x < 8; x++) {
1516                         if (mask & (1U << (x - slot))) {
1517                                 hub->uframe_usage[x] += len;
1518                                 bus->uframe_usage[x] += len;
1519                         }
1520                 }
1521                 break;
1522         default:
1523                 if (slot >= USB_HS_MICRO_FRAMES_MAX) {
1524                         slot = usb_intr_find_best_slot(bus->uframe_usage, 0,
1525                             USB_HS_MICRO_FRAMES_MAX, mask);
1526                 }
1527                 for (x = slot; x < 8; x++) {
1528                         if (mask & (1U << (x - slot))) {
1529                                 bus->uframe_usage[x] += len;
1530                         }
1531                 }
1532                 break;
1533         }
1534         return (slot);
1535 }
1536
1537 /*------------------------------------------------------------------------*
1538  *      usb_hs_bandwidth_alloc
1539  *
1540  * This function is a wrapper function for "usb_hs_bandwidth_adjust()".
1541  *------------------------------------------------------------------------*/
1542 void
1543 usb_hs_bandwidth_alloc(struct usb_xfer *xfer)
1544 {
1545         struct usb_device *udev;
1546         uint8_t slot;
1547         uint8_t mask;
1548         uint8_t speed;
1549
1550         udev = xfer->xroot->udev;
1551
1552         if (udev->flags.usb_mode != USB_MODE_HOST)
1553                 return;         /* not supported */
1554
1555         xfer->endpoint->refcount_bw++;
1556         if (xfer->endpoint->refcount_bw != 1)
1557                 return;         /* already allocated */
1558
1559         speed = usbd_get_speed(udev);
1560
1561         switch (xfer->endpoint->edesc->bmAttributes & UE_XFERTYPE) {
1562         case UE_INTERRUPT:
1563                 /* allocate a microframe slot */
1564
1565                 mask = 0x01;
1566                 slot = usb_hs_bandwidth_adjust(udev,
1567                     xfer->max_frame_size, USB_HS_MICRO_FRAMES_MAX, mask);
1568
1569                 xfer->endpoint->usb_uframe = slot;
1570                 xfer->endpoint->usb_smask = mask << slot;
1571
1572                 if ((speed != USB_SPEED_FULL) &&
1573                     (speed != USB_SPEED_LOW)) {
1574                         xfer->endpoint->usb_cmask = 0x00 ;
1575                 } else {
1576                         xfer->endpoint->usb_cmask = (-(0x04 << slot)) & 0xFE;
1577                 }
1578                 break;
1579
1580         case UE_ISOCHRONOUS:
1581                 switch (usbd_xfer_get_fps_shift(xfer)) {
1582                 case 0:
1583                         mask = 0xFF;
1584                         break;
1585                 case 1:
1586                         mask = 0x55;
1587                         break;
1588                 case 2:
1589                         mask = 0x11;
1590                         break;
1591                 default:
1592                         mask = 0x01;
1593                         break;
1594                 }
1595
1596                 /* allocate a microframe multi-slot */
1597
1598                 slot = usb_hs_bandwidth_adjust(udev,
1599                     xfer->max_frame_size, USB_HS_MICRO_FRAMES_MAX, mask);
1600
1601                 xfer->endpoint->usb_uframe = slot;
1602                 xfer->endpoint->usb_cmask = 0;
1603                 xfer->endpoint->usb_smask = mask << slot;
1604                 break;
1605
1606         default:
1607                 xfer->endpoint->usb_uframe = 0;
1608                 xfer->endpoint->usb_cmask = 0;
1609                 xfer->endpoint->usb_smask = 0;
1610                 break;
1611         }
1612
1613         DPRINTFN(11, "slot=%d, mask=0x%02x\n",
1614             xfer->endpoint->usb_uframe,
1615             xfer->endpoint->usb_smask >> xfer->endpoint->usb_uframe);
1616 }
1617
1618 /*------------------------------------------------------------------------*
1619  *      usb_hs_bandwidth_free
1620  *
1621  * This function is a wrapper function for "usb_hs_bandwidth_adjust()".
1622  *------------------------------------------------------------------------*/
1623 void
1624 usb_hs_bandwidth_free(struct usb_xfer *xfer)
1625 {
1626         struct usb_device *udev;
1627         uint8_t slot;
1628         uint8_t mask;
1629
1630         udev = xfer->xroot->udev;
1631
1632         if (udev->flags.usb_mode != USB_MODE_HOST)
1633                 return;         /* not supported */
1634
1635         xfer->endpoint->refcount_bw--;
1636         if (xfer->endpoint->refcount_bw != 0)
1637                 return;         /* still allocated */
1638
1639         switch (xfer->endpoint->edesc->bmAttributes & UE_XFERTYPE) {
1640         case UE_INTERRUPT:
1641         case UE_ISOCHRONOUS:
1642
1643                 slot = xfer->endpoint->usb_uframe;
1644                 mask = xfer->endpoint->usb_smask;
1645
1646                 /* free microframe slot(s): */
1647                 usb_hs_bandwidth_adjust(udev,
1648                     -xfer->max_frame_size, slot, mask >> slot);
1649
1650                 DPRINTFN(11, "slot=%d, mask=0x%02x\n",
1651                     slot, mask >> slot);
1652
1653                 xfer->endpoint->usb_uframe = 0;
1654                 xfer->endpoint->usb_cmask = 0;
1655                 xfer->endpoint->usb_smask = 0;
1656                 break;
1657
1658         default:
1659                 break;
1660         }
1661 }
1662
1663 /*------------------------------------------------------------------------*
1664  *      usbd_fs_isoc_schedule_init_sub
1665  *
1666  * This function initialises an USB FULL speed isochronous schedule
1667  * entry.
1668  *------------------------------------------------------------------------*/
1669 #if USB_HAVE_TT_SUPPORT
1670 static void
1671 usbd_fs_isoc_schedule_init_sub(struct usb_fs_isoc_schedule *fss)
1672 {
1673         fss->total_bytes = (USB_FS_ISOC_UFRAME_MAX *
1674             USB_FS_BYTES_PER_HS_UFRAME);
1675         fss->frame_bytes = (USB_FS_BYTES_PER_HS_UFRAME);
1676         fss->frame_slot = 0;
1677 }
1678 #endif
1679
1680 /*------------------------------------------------------------------------*
1681  *      usbd_fs_isoc_schedule_init_all
1682  *
1683  * This function will reset the complete USB FULL speed isochronous
1684  * bandwidth schedule.
1685  *------------------------------------------------------------------------*/
1686 #if USB_HAVE_TT_SUPPORT
1687 void
1688 usbd_fs_isoc_schedule_init_all(struct usb_fs_isoc_schedule *fss)
1689 {
1690         struct usb_fs_isoc_schedule *fss_end = fss + USB_ISOC_TIME_MAX;
1691
1692         while (fss != fss_end) {
1693                 usbd_fs_isoc_schedule_init_sub(fss);
1694                 fss++;
1695         }
1696 }
1697 #endif
1698
1699 /*------------------------------------------------------------------------*
1700  *      usb_isoc_time_expand
1701  *
1702  * This function will expand the time counter from 7-bit to 16-bit.
1703  *
1704  * Returns:
1705  *   16-bit isochronous time counter.
1706  *------------------------------------------------------------------------*/
1707 uint16_t
1708 usb_isoc_time_expand(struct usb_bus *bus, uint16_t isoc_time_curr)
1709 {
1710         uint16_t rem;
1711
1712         USB_BUS_LOCK_ASSERT(bus);
1713
1714         rem = bus->isoc_time_last & (USB_ISOC_TIME_MAX - 1);
1715
1716         isoc_time_curr &= (USB_ISOC_TIME_MAX - 1);
1717
1718         if (isoc_time_curr < rem) {
1719                 /* the time counter wrapped around */
1720                 bus->isoc_time_last += USB_ISOC_TIME_MAX;
1721         }
1722         /* update the remainder */
1723
1724         bus->isoc_time_last &= ~(USB_ISOC_TIME_MAX - 1);
1725         bus->isoc_time_last |= isoc_time_curr;
1726
1727         return (bus->isoc_time_last);
1728 }
1729
1730 /*------------------------------------------------------------------------*
1731  *      usbd_fs_isoc_schedule_isoc_time_expand
1732  *
1733  * This function does multiple things. First of all it will expand the
1734  * passed isochronous time, which is the return value. Then it will
1735  * store where the current FULL speed isochronous schedule is
1736  * positioned in time and where the end is. See "pp_start" and
1737  * "pp_end" arguments.
1738  *
1739  * Returns:
1740  *   Expanded version of "isoc_time".
1741  *
1742  * NOTE: This function depends on being called regularly with
1743  * intervals less than "USB_ISOC_TIME_MAX".
1744  *------------------------------------------------------------------------*/
1745 #if USB_HAVE_TT_SUPPORT
1746 uint16_t
1747 usbd_fs_isoc_schedule_isoc_time_expand(struct usb_device *udev,
1748     struct usb_fs_isoc_schedule **pp_start,
1749     struct usb_fs_isoc_schedule **pp_end,
1750     uint16_t isoc_time)
1751 {
1752         struct usb_fs_isoc_schedule *fss_end;
1753         struct usb_fs_isoc_schedule *fss_a;
1754         struct usb_fs_isoc_schedule *fss_b;
1755         struct usb_hub *hs_hub;
1756
1757         isoc_time = usb_isoc_time_expand(udev->bus, isoc_time);
1758
1759         hs_hub = udev->parent_hs_hub->hub;
1760
1761         if (hs_hub != NULL) {
1762
1763                 fss_a = hs_hub->fs_isoc_schedule +
1764                     (hs_hub->isoc_last_time % USB_ISOC_TIME_MAX);
1765
1766                 hs_hub->isoc_last_time = isoc_time;
1767
1768                 fss_b = hs_hub->fs_isoc_schedule +
1769                     (isoc_time % USB_ISOC_TIME_MAX);
1770
1771                 fss_end = hs_hub->fs_isoc_schedule + USB_ISOC_TIME_MAX;
1772
1773                 *pp_start = hs_hub->fs_isoc_schedule;
1774                 *pp_end = fss_end;
1775
1776                 while (fss_a != fss_b) {
1777                         if (fss_a == fss_end) {
1778                                 fss_a = hs_hub->fs_isoc_schedule;
1779                                 continue;
1780                         }
1781                         usbd_fs_isoc_schedule_init_sub(fss_a);
1782                         fss_a++;
1783                 }
1784
1785         } else {
1786
1787                 *pp_start = NULL;
1788                 *pp_end = NULL;
1789         }
1790         return (isoc_time);
1791 }
1792 #endif
1793
1794 /*------------------------------------------------------------------------*
1795  *      usbd_fs_isoc_schedule_alloc
1796  *
1797  * This function will allocate bandwidth for an isochronous FULL speed
1798  * transaction in the FULL speed schedule. The microframe slot where
1799  * the transaction should be started is stored in the byte pointed to
1800  * by "pstart". The "len" argument specifies the length of the
1801  * transaction in bytes.
1802  *
1803  * Returns:
1804  *    0: Success
1805  * Else: Error
1806  *------------------------------------------------------------------------*/
1807 #if USB_HAVE_TT_SUPPORT
1808 uint8_t
1809 usbd_fs_isoc_schedule_alloc(struct usb_fs_isoc_schedule *fss,
1810     uint8_t *pstart, uint16_t len)
1811 {
1812         uint8_t slot = fss->frame_slot;
1813
1814         /* Compute overhead and bit-stuffing */
1815
1816         len += 8;
1817
1818         len *= 7;
1819         len /= 6;
1820
1821         if (len > fss->total_bytes) {
1822                 *pstart = 0;            /* set some dummy value */
1823                 return (1);             /* error */
1824         }
1825         if (len > 0) {
1826
1827                 fss->total_bytes -= len;
1828
1829                 while (len >= fss->frame_bytes) {
1830                         len -= fss->frame_bytes;
1831                         fss->frame_bytes = USB_FS_BYTES_PER_HS_UFRAME;
1832                         fss->frame_slot++;
1833                 }
1834
1835                 fss->frame_bytes -= len;
1836         }
1837         *pstart = slot;
1838         return (0);                     /* success */
1839 }
1840 #endif
1841
1842 /*------------------------------------------------------------------------*
1843  *      usb_bus_port_get_device
1844  *
1845  * This function is NULL safe.
1846  *------------------------------------------------------------------------*/
1847 struct usb_device *
1848 usb_bus_port_get_device(struct usb_bus *bus, struct usb_port *up)
1849 {
1850         if ((bus == NULL) || (up == NULL)) {
1851                 /* be NULL safe */
1852                 return (NULL);
1853         }
1854         if (up->device_index == 0) {
1855                 /* nothing to do */
1856                 return (NULL);
1857         }
1858         return (bus->devices[up->device_index]);
1859 }
1860
1861 /*------------------------------------------------------------------------*
1862  *      usb_bus_port_set_device
1863  *
1864  * This function is NULL safe.
1865  *------------------------------------------------------------------------*/
1866 void
1867 usb_bus_port_set_device(struct usb_bus *bus, struct usb_port *up,
1868     struct usb_device *udev, uint8_t device_index)
1869 {
1870         if (bus == NULL) {
1871                 /* be NULL safe */
1872                 return;
1873         }
1874         /*
1875          * There is only one case where we don't
1876          * have an USB port, and that is the Root Hub!
1877          */
1878         if (up) {
1879                 if (udev) {
1880                         up->device_index = device_index;
1881                 } else {
1882                         device_index = up->device_index;
1883                         up->device_index = 0;
1884                 }
1885         }
1886         /*
1887          * Make relationships to our new device
1888          */
1889         if (device_index != 0) {
1890 #if USB_HAVE_UGEN
1891                 lockmgr(&usb_ref_lock, LK_EXCLUSIVE);
1892 #endif
1893                 bus->devices[device_index] = udev;
1894 #if USB_HAVE_UGEN
1895                 lockmgr(&usb_ref_lock, LK_RELEASE);
1896 #endif
1897         }
1898         /*
1899          * Debug print
1900          */
1901         DPRINTFN(2, "bus %p devices[%u] = %p\n", bus, device_index, udev);
1902 }
1903
1904 /*------------------------------------------------------------------------*
1905  *      usb_needs_explore
1906  *
1907  * This functions is called when the USB event thread needs to run.
1908  *------------------------------------------------------------------------*/
1909 void
1910 usb_needs_explore(struct usb_bus *bus, uint8_t do_probe)
1911 {
1912         uint8_t do_unlock;
1913
1914         DPRINTF("\n");
1915
1916         if (bus == NULL) {
1917                 DPRINTF("No bus pointer!\n");
1918                 return;
1919         }
1920         if ((bus->devices == NULL) ||
1921             (bus->devices[USB_ROOT_HUB_ADDR] == NULL)) {
1922                 DPRINTF("No root HUB\n");
1923                 return;
1924         }
1925         if (lockstatus(&bus->bus_lock, curthread) != 0) {
1926                 do_unlock = 0;
1927         } else {
1928                 USB_BUS_LOCK(bus);
1929                 do_unlock = 1;
1930         }
1931         if (do_probe) {
1932                 bus->do_probe = 1;
1933         }
1934         if (usb_proc_msignal(&bus->explore_proc,
1935             &bus->explore_msg[0], &bus->explore_msg[1])) {
1936                 /* ignore */
1937         }
1938         if (do_unlock) {
1939                 USB_BUS_UNLOCK(bus);
1940         }
1941 }
1942
1943 /*------------------------------------------------------------------------*
1944  *      usb_needs_explore_all
1945  *
1946  * This function is called whenever a new driver is loaded and will
1947  * cause that all USB busses are re-explored.
1948  *------------------------------------------------------------------------*/
1949 void
1950 usb_needs_explore_all(void)
1951 {
1952         struct usb_bus *bus;
1953         devclass_t dc;
1954         device_t dev;
1955         int max;
1956
1957         DPRINTFN(3, "\n");
1958
1959         dc = usb_devclass_ptr;
1960         if (dc == NULL) {
1961                 DPRINTFN(0, "no devclass\n");
1962                 return;
1963         }
1964         /*
1965          * Explore all USB busses in parallell.
1966          */
1967         max = devclass_get_maxunit(dc);
1968         while (max >= 0) {
1969                 dev = devclass_get_device(dc, max);
1970                 if (dev) {
1971                         bus = device_get_softc(dev);
1972                         if (bus) {
1973                                 usb_needs_explore(bus, 1);
1974                         }
1975                 }
1976                 max--;
1977         }
1978 }
1979
1980 /*------------------------------------------------------------------------*
1981  *      usb_bus_power_update
1982  *
1983  * This function will ensure that all USB devices on the given bus are
1984  * properly suspended or resumed according to the device transfer
1985  * state.
1986  *------------------------------------------------------------------------*/
1987 #if USB_HAVE_POWERD
1988 void
1989 usb_bus_power_update(struct usb_bus *bus)
1990 {
1991         usb_needs_explore(bus, 0 /* no probe */ );
1992 }
1993 #endif
1994
1995 /*------------------------------------------------------------------------*
1996  *      usbd_transfer_power_ref
1997  *
1998  * This function will modify the power save reference counts and
1999  * wakeup the USB device associated with the given USB transfer, if
2000  * needed.
2001  *------------------------------------------------------------------------*/
2002 #if USB_HAVE_POWERD
2003 void
2004 usbd_transfer_power_ref(struct usb_xfer *xfer, int val)
2005 {
2006         static const usb_power_mask_t power_mask[4] = {
2007                 [UE_CONTROL] = USB_HW_POWER_CONTROL,
2008                 [UE_BULK] = USB_HW_POWER_BULK,
2009                 [UE_INTERRUPT] = USB_HW_POWER_INTERRUPT,
2010                 [UE_ISOCHRONOUS] = USB_HW_POWER_ISOC,
2011         };
2012         struct usb_device *udev;
2013         uint8_t needs_explore;
2014         uint8_t needs_hw_power;
2015         uint8_t xfer_type;
2016
2017         udev = xfer->xroot->udev;
2018
2019         if (udev->device_index == USB_ROOT_HUB_ADDR) {
2020                 /* no power save for root HUB */
2021                 return;
2022         }
2023         USB_BUS_LOCK(udev->bus);
2024
2025         xfer_type = xfer->endpoint->edesc->bmAttributes & UE_XFERTYPE;
2026
2027         udev->pwr_save.last_xfer_time = ticks;
2028         udev->pwr_save.type_refs[xfer_type] += val;
2029
2030         if (xfer->flags_int.control_xfr) {
2031                 udev->pwr_save.read_refs += val;
2032                 if (xfer->flags_int.usb_mode == USB_MODE_HOST) {
2033                         /*
2034                          * It is not allowed to suspend during a
2035                          * control transfer:
2036                          */
2037                         udev->pwr_save.write_refs += val;
2038                 }
2039         } else if (USB_GET_DATA_ISREAD(xfer)) {
2040                 udev->pwr_save.read_refs += val;
2041         } else {
2042                 udev->pwr_save.write_refs += val;
2043         }
2044
2045         if (val > 0) {
2046                 if (udev->flags.self_suspended)
2047                         needs_explore = usb_peer_should_wakeup(udev);
2048                 else
2049                         needs_explore = 0;
2050
2051                 if (!(udev->bus->hw_power_state & power_mask[xfer_type])) {
2052                         DPRINTF("Adding type %u to power state\n", xfer_type);
2053                         udev->bus->hw_power_state |= power_mask[xfer_type];
2054                         needs_hw_power = 1;
2055                 } else {
2056                         needs_hw_power = 0;
2057                 }
2058         } else {
2059                 needs_explore = 0;
2060                 needs_hw_power = 0;
2061         }
2062
2063         USB_BUS_UNLOCK(udev->bus);
2064
2065         if (needs_explore) {
2066                 DPRINTF("update\n");
2067                 usb_bus_power_update(udev->bus);
2068         } else if (needs_hw_power) {
2069                 DPRINTF("needs power\n");
2070                 if (udev->bus->methods->set_hw_power != NULL) {
2071                         (udev->bus->methods->set_hw_power) (udev->bus);
2072                 }
2073         }
2074 }
2075 #endif
2076
2077 /*------------------------------------------------------------------------*
2078  *      usb_peer_should_wakeup
2079  *
2080  * This function returns non-zero if the current device should wake up.
2081  *------------------------------------------------------------------------*/
2082 static uint8_t
2083 usb_peer_should_wakeup(struct usb_device *udev)
2084 {
2085         return ((udev->power_mode == USB_POWER_MODE_ON) ||
2086             (udev->driver_added_refcount != udev->bus->driver_added_refcount) ||
2087             (udev->re_enumerate_wait != 0) ||
2088             (udev->pwr_save.type_refs[UE_ISOCHRONOUS] != 0) ||
2089             (udev->pwr_save.write_refs != 0) ||
2090             ((udev->pwr_save.read_refs != 0) &&
2091             (udev->flags.usb_mode == USB_MODE_HOST) &&
2092             (usb_peer_can_wakeup(udev) == 0)));
2093 }
2094
2095 /*------------------------------------------------------------------------*
2096  *      usb_bus_powerd
2097  *
2098  * This function implements the USB power daemon and is called
2099  * regularly from the USB explore thread.
2100  *------------------------------------------------------------------------*/
2101 #if USB_HAVE_POWERD
2102 void
2103 usb_bus_powerd(struct usb_bus *bus)
2104 {
2105         struct usb_device *udev;
2106         usb_ticks_t temp;
2107         usb_ticks_t limit;
2108         usb_ticks_t mintime;
2109         usb_size_t type_refs[5];
2110         uint8_t x;
2111
2112         limit = usb_power_timeout;
2113         if (limit == 0)
2114                 limit = hz;
2115         else if (limit > 255)
2116                 limit = 255 * hz;
2117         else
2118                 limit = limit * hz;
2119
2120         DPRINTF("bus=%p\n", bus);
2121
2122         USB_BUS_LOCK(bus);
2123
2124         /*
2125          * The root HUB device is never suspended
2126          * and we simply skip it.
2127          */
2128         for (x = USB_ROOT_HUB_ADDR + 1;
2129             x != bus->devices_max; x++) {
2130
2131                 udev = bus->devices[x];
2132                 if (udev == NULL)
2133                         continue;
2134
2135                 temp = ticks - udev->pwr_save.last_xfer_time;
2136
2137                 if (usb_peer_should_wakeup(udev)) {
2138                         /* check if we are suspended */
2139                         if (udev->flags.self_suspended != 0) {
2140                                 USB_BUS_UNLOCK(bus);
2141                                 usb_dev_resume_peer(udev);
2142                                 USB_BUS_LOCK(bus);
2143                         }
2144                 } else if ((temp >= limit) &&
2145                     (udev->flags.usb_mode == USB_MODE_HOST) &&
2146                     (udev->flags.self_suspended == 0)) {
2147                         /* try to do suspend */
2148
2149                         USB_BUS_UNLOCK(bus);
2150                         usb_dev_suspend_peer(udev);
2151                         USB_BUS_LOCK(bus);
2152                 }
2153         }
2154
2155         /* reset counters */
2156
2157         mintime = 0 - 1;
2158         type_refs[0] = 0;
2159         type_refs[1] = 0;
2160         type_refs[2] = 0;
2161         type_refs[3] = 0;
2162         type_refs[4] = 0;
2163
2164         /* Re-loop all the devices to get the actual state */
2165
2166         for (x = USB_ROOT_HUB_ADDR + 1;
2167             x != bus->devices_max; x++) {
2168
2169                 udev = bus->devices[x];
2170                 if (udev == NULL)
2171                         continue;
2172
2173                 /* we found a non-Root-Hub USB device */
2174                 type_refs[4] += 1;
2175
2176                 /* "last_xfer_time" can be updated by a resume */
2177                 temp = ticks - udev->pwr_save.last_xfer_time;
2178
2179                 /*
2180                  * Compute minimum time since last transfer for the complete
2181                  * bus:
2182                  */
2183                 if (temp < mintime)
2184                         mintime = temp;
2185
2186                 if (udev->flags.self_suspended == 0) {
2187                         type_refs[0] += udev->pwr_save.type_refs[0];
2188                         type_refs[1] += udev->pwr_save.type_refs[1];
2189                         type_refs[2] += udev->pwr_save.type_refs[2];
2190                         type_refs[3] += udev->pwr_save.type_refs[3];
2191                 }
2192         }
2193
2194         if (mintime >= (1 * hz)) {
2195                 /* recompute power masks */
2196                 DPRINTF("Recomputing power masks\n");
2197                 bus->hw_power_state = 0;
2198                 if (type_refs[UE_CONTROL] != 0)
2199                         bus->hw_power_state |= USB_HW_POWER_CONTROL;
2200                 if (type_refs[UE_BULK] != 0)
2201                         bus->hw_power_state |= USB_HW_POWER_BULK;
2202                 if (type_refs[UE_INTERRUPT] != 0)
2203                         bus->hw_power_state |= USB_HW_POWER_INTERRUPT;
2204                 if (type_refs[UE_ISOCHRONOUS] != 0)
2205                         bus->hw_power_state |= USB_HW_POWER_ISOC;
2206                 if (type_refs[4] != 0)
2207                         bus->hw_power_state |= USB_HW_POWER_NON_ROOT_HUB;
2208         }
2209         USB_BUS_UNLOCK(bus);
2210
2211         if (bus->methods->set_hw_power != NULL) {
2212                 /* always update hardware power! */
2213                 (bus->methods->set_hw_power) (bus);
2214         }
2215         return;
2216 }
2217 #endif
2218
2219 /*------------------------------------------------------------------------*
2220  *      usb_dev_resume_peer
2221  *
2222  * This function will resume an USB peer and do the required USB
2223  * signalling to get an USB device out of the suspended state.
2224  *------------------------------------------------------------------------*/
2225 static void
2226 usb_dev_resume_peer(struct usb_device *udev)
2227 {
2228         struct usb_bus *bus;
2229         int err;
2230
2231         /* be NULL safe */
2232         if (udev == NULL)
2233                 return;
2234
2235         /* check if already resumed */
2236         if (udev->flags.self_suspended == 0)
2237                 return;
2238
2239         /* we need a parent HUB to do resume */
2240         if (udev->parent_hub == NULL)
2241                 return;
2242
2243         DPRINTF("udev=%p\n", udev);
2244
2245         if ((udev->flags.usb_mode == USB_MODE_DEVICE) &&
2246             (udev->flags.remote_wakeup == 0)) {
2247                 /*
2248                  * If the host did not set the remote wakeup feature, we can
2249                  * not wake it up either!
2250                  */
2251                 DPRINTF("remote wakeup is not set!\n");
2252                 return;
2253         }
2254         /* get bus pointer */
2255         bus = udev->bus;
2256
2257         /* resume parent hub first */
2258         usb_dev_resume_peer(udev->parent_hub);
2259
2260         /* reduce chance of instant resume failure by waiting a little bit */
2261         usb_pause_mtx(NULL, USB_MS_TO_TICKS(20));
2262
2263         if (usb_device_20_compatible(udev)) {
2264                 /* resume current port (Valid in Host and Device Mode) */
2265                 err = usbd_req_clear_port_feature(udev->parent_hub,
2266                     NULL, udev->port_no, UHF_PORT_SUSPEND);
2267                 if (err) {
2268                         DPRINTFN(0, "Resuming port failed\n");
2269                         return;
2270                 }
2271         } else {
2272                 /* resume current port (Valid in Host and Device Mode) */
2273                 err = usbd_req_set_port_link_state(udev->parent_hub,
2274                     NULL, udev->port_no, UPS_PORT_LS_U0);
2275                 if (err) {
2276                         DPRINTFN(0, "Resuming port failed\n");
2277                         return;
2278                 }
2279         }
2280
2281         /* resume settle time */
2282         usb_pause_mtx(NULL, USB_MS_TO_TICKS(USB_PORT_RESUME_DELAY));
2283
2284         if (bus->methods->device_resume != NULL) {
2285                 /* resume USB device on the USB controller */
2286                 (bus->methods->device_resume) (udev);
2287         }
2288         USB_BUS_LOCK(bus);
2289         /* set that this device is now resumed */
2290         udev->flags.self_suspended = 0;
2291 #if USB_HAVE_POWERD
2292         /* make sure that we don't go into suspend right away */
2293         udev->pwr_save.last_xfer_time = ticks;
2294
2295         /* make sure the needed power masks are on */
2296         if (udev->pwr_save.type_refs[UE_CONTROL] != 0)
2297                 bus->hw_power_state |= USB_HW_POWER_CONTROL;
2298         if (udev->pwr_save.type_refs[UE_BULK] != 0)
2299                 bus->hw_power_state |= USB_HW_POWER_BULK;
2300         if (udev->pwr_save.type_refs[UE_INTERRUPT] != 0)
2301                 bus->hw_power_state |= USB_HW_POWER_INTERRUPT;
2302         if (udev->pwr_save.type_refs[UE_ISOCHRONOUS] != 0)
2303                 bus->hw_power_state |= USB_HW_POWER_ISOC;
2304 #endif
2305         USB_BUS_UNLOCK(bus);
2306
2307         if (bus->methods->set_hw_power != NULL) {
2308                 /* always update hardware power! */
2309                 (bus->methods->set_hw_power) (bus);
2310         }
2311
2312         usbd_sr_lock(udev);
2313
2314         /* notify all sub-devices about resume */
2315         err = usb_suspend_resume(udev, 0);
2316
2317         usbd_sr_unlock(udev);
2318
2319         /* check if peer has wakeup capability */
2320         if (usb_peer_can_wakeup(udev)) {
2321                 /* clear remote wakeup */
2322                 err = usbd_req_clear_device_feature(udev,
2323                     NULL, UF_DEVICE_REMOTE_WAKEUP);
2324                 if (err) {
2325                         DPRINTFN(0, "Clearing device "
2326                             "remote wakeup failed: %s\n",
2327                             usbd_errstr(err));
2328                 }
2329         }
2330 }
2331
2332 /*------------------------------------------------------------------------*
2333  *      usb_dev_suspend_peer
2334  *
2335  * This function will suspend an USB peer and do the required USB
2336  * signalling to get an USB device into the suspended state.
2337  *------------------------------------------------------------------------*/
2338 static void
2339 usb_dev_suspend_peer(struct usb_device *udev)
2340 {
2341         struct usb_device *child;
2342         int err;
2343         uint8_t x;
2344         uint8_t nports;
2345
2346 repeat:
2347         /* be NULL safe */
2348         if (udev == NULL)
2349                 return;
2350
2351         /* check if already suspended */
2352         if (udev->flags.self_suspended)
2353                 return;
2354
2355         /* we need a parent HUB to do suspend */
2356         if (udev->parent_hub == NULL)
2357                 return;
2358
2359         DPRINTF("udev=%p\n", udev);
2360
2361         /* check if the current device is a HUB */
2362         if (udev->hub != NULL) {
2363                 nports = udev->hub->nports;
2364
2365                 /* check if all devices on the HUB are suspended */
2366                 for (x = 0; x != nports; x++) {
2367                         child = usb_bus_port_get_device(udev->bus,
2368                             udev->hub->ports + x);
2369
2370                         if (child == NULL)
2371                                 continue;
2372
2373                         if (child->flags.self_suspended)
2374                                 continue;
2375
2376                         DPRINTFN(1, "Port %u is busy on the HUB!\n", x + 1);
2377                         return;
2378                 }
2379         }
2380
2381         if (usb_peer_can_wakeup(udev)) {
2382                 /*
2383                  * This request needs to be done before we set
2384                  * "udev->flags.self_suspended":
2385                  */
2386
2387                 /* allow device to do remote wakeup */
2388                 err = usbd_req_set_device_feature(udev,
2389                     NULL, UF_DEVICE_REMOTE_WAKEUP);
2390                 if (err) {
2391                         DPRINTFN(0, "Setting device "
2392                             "remote wakeup failed\n");
2393                 }
2394         }
2395
2396         USB_BUS_LOCK(udev->bus);
2397         /*
2398          * Checking for suspend condition and setting suspended bit
2399          * must be atomic!
2400          */
2401         err = usb_peer_should_wakeup(udev);
2402         if (err == 0) {
2403                 /*
2404                  * Set that this device is suspended. This variable
2405                  * must be set before calling USB controller suspend
2406                  * callbacks.
2407                  */
2408                 udev->flags.self_suspended = 1;
2409         }
2410         USB_BUS_UNLOCK(udev->bus);
2411
2412         if (err != 0) {
2413                 if (usb_peer_can_wakeup(udev)) {
2414                         /* allow device to do remote wakeup */
2415                         err = usbd_req_clear_device_feature(udev,
2416                             NULL, UF_DEVICE_REMOTE_WAKEUP);
2417                         if (err) {
2418                                 DPRINTFN(0, "Setting device "
2419                                     "remote wakeup failed\n");
2420                         }
2421                 }
2422
2423                 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
2424                         /* resume parent HUB first */
2425                         usb_dev_resume_peer(udev->parent_hub);
2426
2427                         /* reduce chance of instant resume failure by waiting a little bit */
2428                         usb_pause_mtx(NULL, USB_MS_TO_TICKS(20));
2429
2430                         /* resume current port (Valid in Host and Device Mode) */
2431                         err = usbd_req_clear_port_feature(udev->parent_hub,
2432                             NULL, udev->port_no, UHF_PORT_SUSPEND);
2433
2434                         /* resume settle time */
2435                         usb_pause_mtx(NULL, USB_MS_TO_TICKS(USB_PORT_RESUME_DELAY));
2436                 }
2437                 DPRINTF("Suspend was cancelled!\n");
2438                 return;
2439         }
2440
2441         usbd_sr_lock(udev);
2442
2443         /* notify all sub-devices about suspend */
2444         err = usb_suspend_resume(udev, 1);
2445
2446         usbd_sr_unlock(udev);
2447
2448         if (udev->bus->methods->device_suspend != NULL) {
2449                 usb_timeout_t temp;
2450
2451                 /* suspend device on the USB controller */
2452                 (udev->bus->methods->device_suspend) (udev);
2453
2454                 /* do DMA delay */
2455                 temp = usbd_get_dma_delay(udev);
2456                 if (temp != 0)
2457                         usb_pause_mtx(NULL, USB_MS_TO_TICKS(temp));
2458
2459         }
2460
2461         if (usb_device_20_compatible(udev)) {
2462                 /* suspend current port */
2463                 err = usbd_req_set_port_feature(udev->parent_hub,
2464                     NULL, udev->port_no, UHF_PORT_SUSPEND);
2465                 if (err) {
2466                         DPRINTFN(0, "Suspending port failed\n");
2467                         return;
2468                 }
2469         } else {
2470                 /* suspend current port */
2471                 err = usbd_req_set_port_link_state(udev->parent_hub,
2472                     NULL, udev->port_no, UPS_PORT_LS_U3);
2473                 if (err) {
2474                         DPRINTFN(0, "Suspending port failed\n");
2475                         return;
2476                 }
2477         }
2478
2479         udev = udev->parent_hub;
2480         goto repeat;
2481 }
2482
2483 /*------------------------------------------------------------------------*
2484  *      usbd_set_power_mode
2485  *
2486  * This function will set the power mode, see USB_POWER_MODE_XXX for a
2487  * USB device.
2488  *------------------------------------------------------------------------*/
2489 void
2490 usbd_set_power_mode(struct usb_device *udev, uint8_t power_mode)
2491 {
2492         /* filter input argument */
2493         if ((power_mode != USB_POWER_MODE_ON) &&
2494             (power_mode != USB_POWER_MODE_OFF))
2495                 power_mode = USB_POWER_MODE_SAVE;
2496
2497         power_mode = usbd_filter_power_mode(udev, power_mode);
2498
2499         udev->power_mode = power_mode;  /* update copy of power mode */
2500
2501 #if USB_HAVE_POWERD
2502         usb_bus_power_update(udev->bus);
2503 #endif
2504 }
2505
2506 /*------------------------------------------------------------------------*
2507  *      usbd_filter_power_mode
2508  *
2509  * This function filters the power mode based on hardware requirements.
2510  *------------------------------------------------------------------------*/
2511 uint8_t
2512 usbd_filter_power_mode(struct usb_device *udev, uint8_t power_mode)
2513 {
2514         struct usb_bus_methods *mtod;
2515         int8_t temp;
2516
2517         mtod = udev->bus->methods;
2518         temp = -1;
2519
2520         if (mtod->get_power_mode != NULL)
2521                 (mtod->get_power_mode) (udev, &temp);
2522
2523         /* check if we should not filter */
2524         if (temp < 0)
2525                 return (power_mode);
2526
2527         /* use fixed power mode given by hardware driver */
2528         return (temp);
2529 }
2530
2531 /*------------------------------------------------------------------------*
2532  *      usbd_start_re_enumerate
2533  *
2534  * This function starts re-enumeration of the given USB device. This
2535  * function does not need to be called BUS-locked. This function does
2536  * not wait until the re-enumeration is completed.
2537  *------------------------------------------------------------------------*/
2538 void
2539 usbd_start_re_enumerate(struct usb_device *udev)
2540 {
2541         if (udev->re_enumerate_wait == 0) {
2542                 udev->re_enumerate_wait = 1;
2543                 usb_needs_explore(udev->bus, 0);
2544         }
2545 }