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