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.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
30 * USB spec: http://www.usb.org/developers/docs/usbspec.zip
33 #ifdef USB_GLOBAL_INCLUDE_FILE
34 #include USB_GLOBAL_INCLUDE_FILE
36 #include <sys/stdint.h>
37 #include <sys/stddef.h>
38 #include <sys/param.h>
39 #include <sys/queue.h>
40 #include <sys/types.h>
41 #include <sys/systm.h>
42 #include <sys/kernel.h>
44 #include <sys/module.h>
46 #include <sys/mutex.h>
47 #include <sys/condvar.h>
48 #include <sys/sysctl.h>
50 #include <sys/unistd.h>
51 #include <sys/callout.h>
52 #include <sys/malloc.h>
55 #include <dev/usb/usb.h>
56 #include <dev/usb/usbdi.h>
57 #include <dev/usb/usbdi_util.h>
59 #define USB_DEBUG_VAR uhub_debug
61 #include <dev/usb/usb_core.h>
62 #include <dev/usb/usb_process.h>
63 #include <dev/usb/usb_device.h>
64 #include <dev/usb/usb_request.h>
65 #include <dev/usb/usb_debug.h>
66 #include <dev/usb/usb_hub.h>
67 #include <dev/usb/usb_util.h>
68 #include <dev/usb/usb_busdma.h>
69 #include <dev/usb/usb_transfer.h>
70 #include <dev/usb/usb_dynamic.h>
72 #include <dev/usb/usb_controller.h>
73 #include <dev/usb/usb_bus.h>
74 #endif /* USB_GLOBAL_INCLUDE_FILE */
76 #define UHUB_INTR_INTERVAL 250 /* ms */
79 #if USB_HAVE_TT_SUPPORT
80 UHUB_RESET_TT_TRANSFER,
86 static int uhub_debug = 0;
88 static SYSCTL_NODE(_hw_usb, OID_AUTO, uhub, CTLFLAG_RW, 0, "USB HUB");
89 SYSCTL_INT(_hw_usb_uhub, OID_AUTO, debug, CTLFLAG_RWTUN, &uhub_debug, 0,
94 static int usb_power_timeout = 30; /* seconds */
96 SYSCTL_INT(_hw_usb, OID_AUTO, power_timeout, CTLFLAG_RWTUN,
97 &usb_power_timeout, 0, "USB power timeout");
100 #if USB_HAVE_DISABLE_ENUM
101 static int usb_disable_enumeration = 0;
102 SYSCTL_INT(_hw_usb, OID_AUTO, disable_enumeration, CTLFLAG_RWTUN,
103 &usb_disable_enumeration, 0, "Set to disable all USB device enumeration.");
105 static int usb_disable_port_power = 0;
106 SYSCTL_INT(_hw_usb, OID_AUTO, disable_port_power, CTLFLAG_RWTUN,
107 &usb_disable_port_power, 0, "Set to disable all USB port power.");
110 struct uhub_current_state {
111 uint16_t port_change;
112 uint16_t port_status;
116 struct uhub_current_state sc_st;/* current state */
117 #if (USB_HAVE_FIXED_PORT != 0)
118 struct usb_hub sc_hub;
120 device_t sc_dev; /* base device */
121 struct mtx sc_mtx; /* our mutex */
122 struct usb_device *sc_udev; /* USB device */
123 struct usb_xfer *sc_xfer[UHUB_N_TRANSFER]; /* interrupt xfer */
124 #if USB_HAVE_DISABLE_ENUM
125 int sc_disable_enumeration;
126 int sc_disable_port_power;
129 #define UHUB_FLAG_DID_EXPLORE 0x01
132 #define UHUB_PROTO(sc) ((sc)->sc_udev->ddesc.bDeviceProtocol)
133 #define UHUB_IS_HIGH_SPEED(sc) (UHUB_PROTO(sc) != UDPROTO_FSHUB)
134 #define UHUB_IS_SINGLE_TT(sc) (UHUB_PROTO(sc) == UDPROTO_HSHUBSTT)
135 #define UHUB_IS_MULTI_TT(sc) (UHUB_PROTO(sc) == UDPROTO_HSHUBMTT)
136 #define UHUB_IS_SUPER_SPEED(sc) (UHUB_PROTO(sc) == UDPROTO_SSHUB)
138 /* prototypes for type checking: */
140 static device_probe_t uhub_probe;
141 static device_attach_t uhub_attach;
142 static device_detach_t uhub_detach;
143 static device_suspend_t uhub_suspend;
144 static device_resume_t uhub_resume;
146 static bus_driver_added_t uhub_driver_added;
147 static bus_child_location_str_t uhub_child_location_string;
148 static bus_child_pnpinfo_str_t uhub_child_pnpinfo_string;
150 static usb_callback_t uhub_intr_callback;
151 #if USB_HAVE_TT_SUPPORT
152 static usb_callback_t uhub_reset_tt_callback;
155 static void usb_dev_resume_peer(struct usb_device *udev);
156 static void usb_dev_suspend_peer(struct usb_device *udev);
157 static uint8_t usb_peer_should_wakeup(struct usb_device *udev);
159 static const struct usb_config uhub_config[UHUB_N_TRANSFER] = {
161 [UHUB_INTR_TRANSFER] = {
162 .type = UE_INTERRUPT,
163 .endpoint = UE_ADDR_ANY,
164 .direction = UE_DIR_ANY,
166 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
167 .bufsize = 0, /* use wMaxPacketSize */
168 .callback = &uhub_intr_callback,
169 .interval = UHUB_INTR_INTERVAL,
171 #if USB_HAVE_TT_SUPPORT
172 [UHUB_RESET_TT_TRANSFER] = {
174 .endpoint = 0x00, /* Control pipe */
175 .direction = UE_DIR_ANY,
176 .bufsize = sizeof(struct usb_device_request),
177 .callback = &uhub_reset_tt_callback,
178 .timeout = 1000, /* 1 second */
179 .usb_mode = USB_MODE_HOST,
185 * driver instance for "hub" connected to "usb"
186 * and "hub" connected to "hub"
188 static devclass_t uhub_devclass;
190 static device_method_t uhub_methods[] = {
191 DEVMETHOD(device_probe, uhub_probe),
192 DEVMETHOD(device_attach, uhub_attach),
193 DEVMETHOD(device_detach, uhub_detach),
195 DEVMETHOD(device_suspend, uhub_suspend),
196 DEVMETHOD(device_resume, uhub_resume),
198 DEVMETHOD(bus_child_location_str, uhub_child_location_string),
199 DEVMETHOD(bus_child_pnpinfo_str, uhub_child_pnpinfo_string),
200 DEVMETHOD(bus_driver_added, uhub_driver_added),
204 static driver_t uhub_driver = {
206 .methods = uhub_methods,
207 .size = sizeof(struct uhub_softc)
210 DRIVER_MODULE(uhub, usbus, uhub_driver, uhub_devclass, 0, 0);
211 DRIVER_MODULE(uhub, uhub, uhub_driver, uhub_devclass, NULL, 0);
212 MODULE_VERSION(uhub, 1);
215 uhub_intr_callback(struct usb_xfer *xfer, usb_error_t error)
217 struct uhub_softc *sc = usbd_xfer_softc(xfer);
219 switch (USB_GET_STATE(xfer)) {
220 case USB_ST_TRANSFERRED:
223 * This is an indication that some port
224 * has changed status. Notify the bus
225 * event handler thread that we need
226 * to be explored again:
228 usb_needs_explore(sc->sc_udev->bus, 0);
231 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
232 usbd_transfer_submit(xfer);
236 if (xfer->error != USB_ERR_CANCELLED) {
238 * Do a clear-stall. The "stall_pipe" flag
239 * will get cleared before next callback by
242 usbd_xfer_set_stall(xfer);
243 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
244 usbd_transfer_submit(xfer);
250 /*------------------------------------------------------------------------*
253 * This function starts the TT reset USB request
254 *------------------------------------------------------------------------*/
255 #if USB_HAVE_TT_SUPPORT
257 uhub_reset_tt_proc(struct usb_proc_msg *_pm)
259 struct usb_udev_msg *pm = (void *)_pm;
260 struct usb_device *udev = pm->udev;
262 struct uhub_softc *sc;
272 USB_BUS_UNLOCK(udev->bus);
273 USB_MTX_LOCK(&sc->sc_mtx);
275 usbd_transfer_start(sc->sc_xfer[UHUB_RESET_TT_TRANSFER]);
277 USB_MTX_UNLOCK(&sc->sc_mtx);
278 USB_BUS_LOCK(udev->bus);
282 /*------------------------------------------------------------------------*
283 * uhub_tt_buffer_reset_async_locked
285 * This function queues a TT reset for the given USB device and endpoint.
286 *------------------------------------------------------------------------*/
287 #if USB_HAVE_TT_SUPPORT
289 uhub_tt_buffer_reset_async_locked(struct usb_device *child, struct usb_endpoint *ep)
291 struct usb_device_request req;
292 struct usb_device *udev;
298 if (child == NULL || ep == NULL)
301 udev = child->parent_hs_hub;
302 port = child->hs_port_no;
309 (udev->speed != USB_SPEED_HIGH) ||
310 (child->speed != USB_SPEED_LOW &&
311 child->speed != USB_SPEED_FULL) ||
312 (child->flags.usb_mode != USB_MODE_HOST) ||
313 (port == 0) || (ep->edesc == NULL)) {
318 USB_BUS_LOCK_ASSERT(udev->bus, MA_OWNED);
320 up = hub->ports + port - 1;
322 if (udev->ddesc.bDeviceClass == UDCLASS_HUB &&
323 udev->ddesc.bDeviceProtocol == UDPROTO_HSHUBSTT)
326 /* if we already received a clear buffer request, reset the whole TT */
327 if (up->req_reset_tt.bRequest != 0) {
328 req.bmRequestType = UT_WRITE_CLASS_OTHER;
329 req.bRequest = UR_RESET_TT;
330 USETW(req.wValue, 0);
331 req.wIndex[0] = port;
333 USETW(req.wLength, 0);
335 wValue = (ep->edesc->bEndpointAddress & 0xF) |
336 ((child->address & 0x7F) << 4) |
337 ((ep->edesc->bEndpointAddress & 0x80) << 8) |
338 ((ep->edesc->bmAttributes & 3) << 12);
340 req.bmRequestType = UT_WRITE_CLASS_OTHER;
341 req.bRequest = UR_CLEAR_TT_BUFFER;
342 USETW(req.wValue, wValue);
343 req.wIndex[0] = port;
345 USETW(req.wLength, 0);
347 up->req_reset_tt = req;
348 /* get reset transfer started */
349 usb_proc_msignal(USB_BUS_TT_PROC(udev->bus),
350 &hub->tt_msg[0], &hub->tt_msg[1]);
354 #if USB_HAVE_TT_SUPPORT
356 uhub_reset_tt_callback(struct usb_xfer *xfer, usb_error_t error)
358 struct uhub_softc *sc;
359 struct usb_device *udev;
363 DPRINTF("TT buffer reset\n");
365 sc = usbd_xfer_softc(xfer);
368 switch (USB_GET_STATE(xfer)) {
369 case USB_ST_TRANSFERRED:
372 USB_BUS_LOCK(udev->bus);
373 /* find first port which needs a TT reset */
374 for (x = 0; x != udev->hub->nports; x++) {
375 up = udev->hub->ports + x;
377 if (up->req_reset_tt.bRequest == 0)
380 /* copy in the transfer */
381 usbd_copy_in(xfer->frbuffers, 0, &up->req_reset_tt,
382 sizeof(up->req_reset_tt));
384 memset(&up->req_reset_tt, 0, sizeof(up->req_reset_tt));
387 usbd_xfer_set_frame_len(xfer, 0, sizeof(up->req_reset_tt));
389 USB_BUS_UNLOCK(udev->bus);
391 usbd_transfer_submit(xfer);
394 USB_BUS_UNLOCK(udev->bus);
398 if (error == USB_ERR_CANCELLED)
401 DPRINTF("TT buffer reset failed (%s)\n", usbd_errstr(error));
407 /*------------------------------------------------------------------------*
408 * uhub_count_active_host_ports
410 * This function counts the number of active ports at the given speed.
411 *------------------------------------------------------------------------*/
413 uhub_count_active_host_ports(struct usb_device *udev, enum usb_dev_speed speed)
415 struct uhub_softc *sc;
416 struct usb_device *child;
431 for (x = 0; x != hub->nports; x++) {
433 child = usb_bus_port_get_device(udev->bus, up);
435 child->flags.usb_mode == USB_MODE_HOST &&
436 child->speed == speed)
444 uhub_explore_handle_re_enumerate(struct usb_device *child)
449 /* check if device should be re-enumerated */
450 if (child->flags.usb_mode != USB_MODE_HOST)
453 do_unlock = usbd_enum_lock(child);
454 switch (child->re_enumerate_wait) {
455 case USB_RE_ENUM_START:
456 err = usbd_set_config_index(child,
459 DPRINTF("Unconfigure failed: %s: Ignored.\n",
462 if (child->parent_hub == NULL) {
463 /* the root HUB cannot be re-enumerated */
464 DPRINTFN(6, "cannot reset root HUB\n");
467 err = usbd_req_re_enumerate(child, NULL);
470 err = usbd_set_config_index(child, 0);
472 err = usb_probe_and_attach(child,
473 USB_IFACE_INDEX_ANY);
475 child->re_enumerate_wait = USB_RE_ENUM_DONE;
478 case USB_RE_ENUM_PWR_OFF:
479 /* get the device unconfigured */
480 err = usbd_set_config_index(child,
483 DPRINTFN(0, "Could not unconfigure "
484 "device (ignored)\n");
486 if (child->parent_hub == NULL) {
487 /* the root HUB cannot be re-enumerated */
488 DPRINTFN(6, "cannot set port feature\n");
491 /* clear port enable */
492 err = usbd_req_clear_port_feature(child->parent_hub,
493 NULL, child->port_no, UHF_PORT_ENABLE);
495 DPRINTFN(0, "Could not disable port "
499 child->re_enumerate_wait = USB_RE_ENUM_DONE;
502 case USB_RE_ENUM_SET_CONFIG:
503 err = usbd_set_config_index(child,
504 child->next_config_index);
506 DPRINTF("Configure failed: %s: Ignored.\n",
509 err = usb_probe_and_attach(child,
510 USB_IFACE_INDEX_ANY);
512 child->re_enumerate_wait = USB_RE_ENUM_DONE;
516 child->re_enumerate_wait = USB_RE_ENUM_DONE;
520 usbd_enum_unlock(child);
523 /*------------------------------------------------------------------------*
524 * uhub_explore_sub - subroutine
528 * Else: A control transaction failed
529 *------------------------------------------------------------------------*/
531 uhub_explore_sub(struct uhub_softc *sc, struct usb_port *up)
534 struct usb_device *child;
538 bus = sc->sc_udev->bus;
541 /* get driver added refcount from USB bus */
542 refcount = bus->driver_added_refcount;
544 /* get device assosiated with the given port */
545 child = usb_bus_port_get_device(bus, up);
551 uhub_explore_handle_re_enumerate(child);
553 /* check if probe and attach should be done */
555 if (child->driver_added_refcount != refcount) {
556 child->driver_added_refcount = refcount;
557 err = usb_probe_and_attach(child,
558 USB_IFACE_INDEX_ANY);
563 /* start control transfer, if device mode */
565 if (child->flags.usb_mode == USB_MODE_DEVICE)
566 usbd_ctrl_transfer_setup(child);
568 /* if a HUB becomes present, do a recursive HUB explore */
571 err = (child->hub->explore) (child);
577 /*------------------------------------------------------------------------*
578 * uhub_read_port_status - factored out code
579 *------------------------------------------------------------------------*/
581 uhub_read_port_status(struct uhub_softc *sc, uint8_t portno)
583 struct usb_port_status ps;
586 err = usbd_req_get_port_status(
587 sc->sc_udev, NULL, &ps, portno);
589 /* update status regardless of error */
591 sc->sc_st.port_status = UGETW(ps.wPortStatus);
592 sc->sc_st.port_change = UGETW(ps.wPortChange);
594 /* debugging print */
596 DPRINTFN(4, "port %d, wPortStatus=0x%04x, "
597 "wPortChange=0x%04x, err=%s\n",
598 portno, sc->sc_st.port_status,
599 sc->sc_st.port_change, usbd_errstr(err));
603 /*------------------------------------------------------------------------*
608 * Else: A control transaction failed
609 *------------------------------------------------------------------------*/
611 uhub_reattach_port(struct uhub_softc *sc, uint8_t portno)
613 struct usb_device *child;
614 struct usb_device *udev;
615 enum usb_dev_speed speed;
616 enum usb_hc_mode mode;
621 DPRINTF("reattaching port %d\n", portno);
625 child = usb_bus_port_get_device(udev->bus,
626 udev->hub->ports + portno - 1);
630 /* first clear the port connection change bit */
632 err = usbd_req_clear_port_feature(udev, NULL,
633 portno, UHF_C_PORT_CONNECTION);
638 /* check if there is a child */
642 * Free USB device and all subdevices, if any.
644 usb_free_device(child, 0);
647 /* get fresh status */
649 err = uhub_read_port_status(sc, portno);
653 #if USB_HAVE_DISABLE_ENUM
654 /* check if we should skip enumeration from this USB HUB */
655 if (usb_disable_enumeration != 0 ||
656 sc->sc_disable_enumeration != 0) {
657 DPRINTF("Enumeration is disabled!\n");
661 /* check if nothing is connected to the port */
663 if (!(sc->sc_st.port_status & UPS_CURRENT_CONNECT_STATUS))
666 /* check if there is no power on the port and print a warning */
668 switch (udev->speed) {
672 power_mask = UPS_PORT_POWER;
674 case USB_SPEED_SUPER:
675 if (udev->parent_hub == NULL)
676 power_mask = UPS_PORT_POWER;
678 power_mask = UPS_PORT_POWER_SS;
684 if (!(sc->sc_st.port_status & power_mask)) {
685 DPRINTF("WARNING: strange, connected port %d "
686 "has no power\n", portno);
689 /* check if the device is in Host Mode */
691 if (!(sc->sc_st.port_status & UPS_PORT_MODE_DEVICE)) {
693 DPRINTF("Port %d is in Host Mode\n", portno);
695 if (sc->sc_st.port_status & UPS_SUSPEND) {
697 * NOTE: Should not get here in SuperSpeed
698 * mode, because the HUB should report this
701 DPRINTF("Port %d was still "
702 "suspended, clearing.\n", portno);
703 err = usbd_req_clear_port_feature(udev,
704 NULL, portno, UHF_PORT_SUSPEND);
709 /* wait for maximum device power up time */
712 USB_MS_TO_TICKS(usb_port_powerup_delay));
714 /* reset port, which implies enabling it */
716 err = usbd_req_reset_port(udev, NULL, portno);
719 DPRINTFN(0, "port %d reset "
720 "failed, error=%s\n",
721 portno, usbd_errstr(err));
724 /* get port status again, it might have changed during reset */
726 err = uhub_read_port_status(sc, portno);
730 /* check if something changed during port reset */
732 if ((sc->sc_st.port_change & UPS_C_CONNECT_STATUS) ||
733 (!(sc->sc_st.port_status & UPS_CURRENT_CONNECT_STATUS))) {
735 DPRINTFN(0, "giving up port reset "
736 "- device vanished\n");
743 DPRINTF("Port %d is in Device Mode\n", portno);
747 * Figure out the device speed
749 switch (udev->speed) {
751 if (sc->sc_st.port_status & UPS_HIGH_SPEED)
752 speed = USB_SPEED_HIGH;
753 else if (sc->sc_st.port_status & UPS_LOW_SPEED)
754 speed = USB_SPEED_LOW;
756 speed = USB_SPEED_FULL;
759 if (sc->sc_st.port_status & UPS_LOW_SPEED)
760 speed = USB_SPEED_LOW;
762 speed = USB_SPEED_FULL;
765 speed = USB_SPEED_LOW;
767 case USB_SPEED_SUPER:
768 if (udev->parent_hub == NULL) {
769 /* Root HUB - special case */
770 switch (sc->sc_st.port_status & UPS_OTHER_SPEED) {
772 speed = USB_SPEED_FULL;
775 speed = USB_SPEED_LOW;
778 speed = USB_SPEED_HIGH;
781 speed = USB_SPEED_SUPER;
785 speed = USB_SPEED_SUPER;
789 /* same speed like parent */
793 if (speed == USB_SPEED_SUPER) {
794 err = usbd_req_set_hub_u1_timeout(udev, NULL,
795 portno, 128 - (2 * udev->depth));
797 DPRINTFN(0, "port %d U1 timeout "
798 "failed, error=%s\n",
799 portno, usbd_errstr(err));
801 err = usbd_req_set_hub_u2_timeout(udev, NULL,
802 portno, 128 - (2 * udev->depth));
804 DPRINTFN(0, "port %d U2 timeout "
805 "failed, error=%s\n",
806 portno, usbd_errstr(err));
811 * Figure out the device mode
813 * NOTE: This part is currently FreeBSD specific.
815 if (udev->parent_hub != NULL) {
816 /* inherit mode from the parent HUB */
817 mode = udev->parent_hub->flags.usb_mode;
818 } else if (sc->sc_st.port_status & UPS_PORT_MODE_DEVICE)
819 mode = USB_MODE_DEVICE;
821 mode = USB_MODE_HOST;
823 /* need to create a new child */
824 child = usb_alloc_device(sc->sc_dev, udev->bus, udev,
825 udev->depth + 1, portno - 1, portno, speed, mode);
827 DPRINTFN(0, "could not allocate new device\n");
830 return (0); /* success */
835 * Free USB device and all subdevices, if any.
837 usb_free_device(child, 0);
841 if (sc->sc_st.port_status & UPS_PORT_ENABLED) {
842 err = usbd_req_clear_port_feature(
844 portno, UHF_PORT_ENABLE);
848 DPRINTFN(0, "device problem (%s), "
849 "disabling port %d\n", usbd_errstr(err), portno);
854 /*------------------------------------------------------------------------*
855 * usb_device_20_compatible
858 * 0: HUB does not support suspend and resume
859 * Else: HUB supports suspend and resume
860 *------------------------------------------------------------------------*/
862 usb_device_20_compatible(struct usb_device *udev)
866 switch (udev->speed) {
876 /*------------------------------------------------------------------------*
877 * uhub_suspend_resume_port
881 * Else: A control transaction failed
882 *------------------------------------------------------------------------*/
884 uhub_suspend_resume_port(struct uhub_softc *sc, uint8_t portno)
886 struct usb_device *child;
887 struct usb_device *udev;
891 DPRINTF("port %d\n", portno);
894 child = usb_bus_port_get_device(udev->bus,
895 udev->hub->ports + portno - 1);
897 /* first clear the port suspend change bit */
899 if (usb_device_20_compatible(udev)) {
900 err = usbd_req_clear_port_feature(udev, NULL,
901 portno, UHF_C_PORT_SUSPEND);
903 err = usbd_req_clear_port_feature(udev, NULL,
904 portno, UHF_C_PORT_LINK_STATE);
908 DPRINTF("clearing suspend failed.\n");
911 /* get fresh status */
913 err = uhub_read_port_status(sc, portno);
915 DPRINTF("reading port status failed.\n");
918 /* convert current state */
920 if (usb_device_20_compatible(udev)) {
921 if (sc->sc_st.port_status & UPS_SUSPEND) {
927 switch (UPS_PORT_LINK_STATE_GET(sc->sc_st.port_status)) {
931 case UPS_PORT_LS_SS_INA:
932 usbd_req_warm_reset_port(udev, NULL, portno);
941 DPRINTF("suspended=%u\n", is_suspend);
943 /* do the suspend or resume */
947 * This code handle two cases: 1) Host Mode - we can only
948 * receive resume here 2) Device Mode - we can receive
949 * suspend and resume here
952 usb_dev_resume_peer(child);
953 else if (child->flags.usb_mode == USB_MODE_DEVICE)
954 usb_dev_suspend_peer(child);
960 /*------------------------------------------------------------------------*
961 * uhub_root_interrupt
963 * This function is called when a Root HUB interrupt has
964 * happened. "ptr" and "len" makes up the Root HUB interrupt
965 * packet. This function is called having the "bus_mtx" locked.
966 *------------------------------------------------------------------------*/
968 uhub_root_intr(struct usb_bus *bus, const uint8_t *ptr, uint8_t len)
970 USB_BUS_LOCK_ASSERT(bus, MA_OWNED);
972 usb_needs_explore(bus, 0);
976 uhub_is_too_deep(struct usb_device *udev)
978 switch (udev->speed) {
982 if (udev->depth > USB_HUB_MAX_DEPTH)
985 case USB_SPEED_SUPER:
986 if (udev->depth > USB_SS_HUB_DEPTH_MAX)
995 /*------------------------------------------------------------------------*
1001 *------------------------------------------------------------------------*/
1003 uhub_explore(struct usb_device *udev)
1005 struct usb_hub *hub;
1006 struct uhub_softc *sc;
1007 struct usb_port *up;
1016 DPRINTFN(11, "udev=%p addr=%d\n", udev, udev->address);
1018 /* ignore devices that are too deep */
1019 if (uhub_is_too_deep(udev))
1020 return (USB_ERR_TOO_DEEP);
1022 /* check if device is suspended */
1023 if (udev->flags.self_suspended) {
1024 /* need to wait until the child signals resume */
1025 DPRINTF("Device is suspended!\n");
1030 * Make sure we don't race against user-space applications
1033 do_unlock = usbd_enum_lock(udev);
1035 for (x = 0; x != hub->nports; x++) {
1036 up = hub->ports + x;
1039 err = uhub_read_port_status(sc, portno);
1041 /* most likely the HUB is gone */
1044 if (sc->sc_st.port_change & UPS_C_OVERCURRENT_INDICATOR) {
1045 DPRINTF("Overcurrent on port %u.\n", portno);
1046 err = usbd_req_clear_port_feature(
1047 udev, NULL, portno, UHF_C_PORT_OVER_CURRENT);
1049 /* most likely the HUB is gone */
1053 if (!(sc->sc_flags & UHUB_FLAG_DID_EXPLORE)) {
1055 * Fake a connect status change so that the
1056 * status gets checked initially!
1058 sc->sc_st.port_change |=
1059 UPS_C_CONNECT_STATUS;
1061 if (sc->sc_st.port_change & UPS_C_PORT_ENABLED) {
1062 err = usbd_req_clear_port_feature(
1063 udev, NULL, portno, UHF_C_PORT_ENABLE);
1065 /* most likely the HUB is gone */
1068 if (sc->sc_st.port_change & UPS_C_CONNECT_STATUS) {
1070 * Ignore the port error if the device
1073 } else if (sc->sc_st.port_status & UPS_PORT_ENABLED) {
1074 DPRINTFN(0, "illegal enable change, "
1075 "port %d\n", portno);
1078 if (up->restartcnt == USB_RESTART_MAX) {
1079 /* XXX could try another speed ? */
1080 DPRINTFN(0, "port error, giving up "
1081 "port %d\n", portno);
1083 sc->sc_st.port_change |=
1084 UPS_C_CONNECT_STATUS;
1089 if (sc->sc_st.port_change & UPS_C_CONNECT_STATUS) {
1090 err = uhub_reattach_port(sc, portno);
1092 /* most likely the HUB is gone */
1096 if (sc->sc_st.port_change & (UPS_C_SUSPEND |
1097 UPS_C_PORT_LINK_STATE)) {
1098 err = uhub_suspend_resume_port(sc, portno);
1100 /* most likely the HUB is gone */
1104 err = uhub_explore_sub(sc, up);
1106 /* no device(s) present */
1109 /* explore succeeded - reset restart counter */
1114 usbd_enum_unlock(udev);
1116 /* initial status checked */
1117 sc->sc_flags |= UHUB_FLAG_DID_EXPLORE;
1119 /* return success */
1120 return (USB_ERR_NORMAL_COMPLETION);
1124 uhub_probe(device_t dev)
1126 struct usb_attach_arg *uaa = device_get_ivars(dev);
1128 if (uaa->usb_mode != USB_MODE_HOST)
1132 * The subclass for USB HUBs is currently ignored because it
1133 * is 0 for some and 1 for others.
1135 if (uaa->info.bConfigIndex == 0 &&
1136 uaa->info.bDeviceClass == UDCLASS_HUB)
1142 /* NOTE: The information returned by this function can be wrong. */
1144 uhub_query_info(struct usb_device *udev, uint8_t *pnports, uint8_t *ptt)
1146 struct usb_hub_descriptor hubdesc20;
1147 struct usb_hub_ss_descriptor hubdesc30;
1152 if (udev->ddesc.bDeviceClass != UDCLASS_HUB)
1153 return (USB_ERR_INVAL);
1158 switch (udev->speed) {
1160 case USB_SPEED_FULL:
1161 case USB_SPEED_HIGH:
1162 /* assuming that there is one port */
1163 err = usbd_req_get_hub_descriptor(udev, NULL, &hubdesc20, 1);
1165 DPRINTFN(0, "getting USB 2.0 HUB descriptor failed,"
1166 "error=%s\n", usbd_errstr(err));
1169 nports = hubdesc20.bNbrPorts;
1173 if (udev->speed == USB_SPEED_HIGH)
1174 tt = (UGETW(hubdesc20.wHubCharacteristics) >> 5) & 3;
1177 case USB_SPEED_SUPER:
1178 err = usbd_req_get_ss_hub_descriptor(udev, NULL, &hubdesc30, 1);
1180 DPRINTFN(0, "Getting USB 3.0 HUB descriptor failed,"
1181 "error=%s\n", usbd_errstr(err));
1184 nports = hubdesc30.bNbrPorts;
1190 err = USB_ERR_INVAL;
1194 if (pnports != NULL)
1204 uhub_attach(device_t dev)
1206 struct uhub_softc *sc = device_get_softc(dev);
1207 struct usb_attach_arg *uaa = device_get_ivars(dev);
1208 struct usb_device *udev = uaa->device;
1209 struct usb_device *parent_hub = udev->parent_hub;
1210 struct usb_hub *hub;
1211 struct usb_hub_descriptor hubdesc20;
1212 struct usb_hub_ss_descriptor hubdesc30;
1213 #if USB_HAVE_DISABLE_ENUM
1214 struct sysctl_ctx_list *sysctl_ctx;
1215 struct sysctl_oid *sysctl_tree;
1222 uint8_t iface_index;
1228 mtx_init(&sc->sc_mtx, "USB HUB mutex", NULL, MTX_DEF);
1230 device_set_usb_desc(dev);
1232 DPRINTFN(2, "depth=%d selfpowered=%d, parent=%p, "
1233 "parent->selfpowered=%d\n",
1235 udev->flags.self_powered,
1238 parent_hub->flags.self_powered : 0);
1240 if (uhub_is_too_deep(udev)) {
1241 DPRINTFN(0, "HUB at depth %d, "
1242 "exceeds maximum. HUB ignored\n", (int)udev->depth);
1246 if (!udev->flags.self_powered && parent_hub &&
1247 !parent_hub->flags.self_powered) {
1248 DPRINTFN(0, "Bus powered HUB connected to "
1249 "bus powered HUB. HUB ignored\n");
1253 if (UHUB_IS_MULTI_TT(sc)) {
1254 err = usbd_set_alt_interface_index(udev, 0, 1);
1256 device_printf(dev, "MTT could not be enabled\n");
1259 device_printf(dev, "MTT enabled\n");
1262 /* get HUB descriptor */
1264 DPRINTFN(2, "Getting HUB descriptor\n");
1266 switch (udev->speed) {
1268 case USB_SPEED_FULL:
1269 case USB_SPEED_HIGH:
1270 /* assuming that there is one port */
1271 err = usbd_req_get_hub_descriptor(udev, NULL, &hubdesc20, 1);
1273 DPRINTFN(0, "getting USB 2.0 HUB descriptor failed,"
1274 "error=%s\n", usbd_errstr(err));
1277 /* get number of ports */
1278 nports = hubdesc20.bNbrPorts;
1280 /* get power delay */
1281 pwrdly = ((hubdesc20.bPwrOn2PwrGood * UHD_PWRON_FACTOR) +
1282 usb_extra_power_up_time);
1284 /* get complete HUB descriptor */
1286 /* check number of ports */
1288 DPRINTFN(0, "Invalid number of USB 2.0 ports,"
1289 "error=%s\n", usbd_errstr(err));
1292 /* get complete HUB descriptor */
1293 err = usbd_req_get_hub_descriptor(udev, NULL, &hubdesc20, nports);
1296 DPRINTFN(0, "Getting USB 2.0 HUB descriptor failed,"
1297 "error=%s\n", usbd_errstr(err));
1300 if (hubdesc20.bNbrPorts != nports) {
1301 DPRINTFN(0, "Number of ports changed\n");
1306 case USB_SPEED_SUPER:
1307 if (udev->parent_hub != NULL) {
1308 err = usbd_req_set_hub_depth(udev, NULL,
1311 DPRINTFN(0, "Setting USB 3.0 HUB depth failed,"
1312 "error=%s\n", usbd_errstr(err));
1316 err = usbd_req_get_ss_hub_descriptor(udev, NULL, &hubdesc30, 1);
1318 DPRINTFN(0, "Getting USB 3.0 HUB descriptor failed,"
1319 "error=%s\n", usbd_errstr(err));
1322 /* get number of ports */
1323 nports = hubdesc30.bNbrPorts;
1325 /* get power delay */
1326 pwrdly = ((hubdesc30.bPwrOn2PwrGood * UHD_PWRON_FACTOR) +
1327 usb_extra_power_up_time);
1329 /* get complete HUB descriptor */
1331 /* check number of ports */
1332 if (nports > ((udev->parent_hub != NULL) ? 15 : 127)) {
1333 DPRINTFN(0, "Invalid number of USB 3.0 ports,"
1334 "error=%s\n", usbd_errstr(err));
1337 /* get complete HUB descriptor */
1338 err = usbd_req_get_ss_hub_descriptor(udev, NULL, &hubdesc30, nports);
1341 DPRINTFN(0, "Getting USB 2.0 HUB descriptor failed,"
1342 "error=%s\n", usbd_errstr(err));
1345 if (hubdesc30.bNbrPorts != nports) {
1346 DPRINTFN(0, "Number of ports changed\n");
1352 DPRINTF("Assuming HUB has only one port\n");
1353 /* default number of ports */
1355 /* default power delay */
1356 pwrdly = ((10 * UHD_PWRON_FACTOR) + usb_extra_power_up_time);
1360 DPRINTFN(0, "portless HUB\n");
1363 if (nports > USB_MAX_PORTS) {
1364 DPRINTF("Port limit exceeded\n");
1367 #if (USB_HAVE_FIXED_PORT == 0)
1368 hub = malloc(sizeof(hub[0]) + (sizeof(hub->ports[0]) * nports),
1369 M_USBDEV, M_WAITOK | M_ZERO);
1378 /* initialize HUB structure */
1380 hub->explore = &uhub_explore;
1381 hub->nports = nports;
1382 hub->hubudev = udev;
1383 #if USB_HAVE_TT_SUPPORT
1384 hub->tt_msg[0].hdr.pm_callback = &uhub_reset_tt_proc;
1385 hub->tt_msg[0].udev = udev;
1386 hub->tt_msg[1].hdr.pm_callback = &uhub_reset_tt_proc;
1387 hub->tt_msg[1].udev = udev;
1389 /* if self powered hub, give ports maximum current */
1390 if (udev->flags.self_powered) {
1391 hub->portpower = USB_MAX_POWER;
1393 hub->portpower = USB_MIN_POWER;
1396 /* set up interrupt pipe */
1398 if (udev->parent_hub == NULL) {
1399 /* root HUB is special */
1403 err = usbd_transfer_setup(udev, &iface_index, sc->sc_xfer,
1404 uhub_config, UHUB_N_TRANSFER, sc, &sc->sc_mtx);
1407 DPRINTFN(0, "cannot setup interrupt transfer, "
1408 "errstr=%s\n", usbd_errstr(err));
1411 /* wait with power off for a while */
1412 usb_pause_mtx(NULL, USB_MS_TO_TICKS(USB_POWER_DOWN_TIME));
1414 #if USB_HAVE_DISABLE_ENUM
1415 /* Add device sysctls */
1417 sysctl_ctx = device_get_sysctl_ctx(dev);
1418 sysctl_tree = device_get_sysctl_tree(dev);
1420 if (sysctl_ctx != NULL && sysctl_tree != NULL) {
1421 (void) SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1422 OID_AUTO, "disable_enumeration", CTLFLAG_RWTUN,
1423 &sc->sc_disable_enumeration, 0,
1424 "Set to disable enumeration on this USB HUB.");
1426 (void) SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1427 OID_AUTO, "disable_port_power", CTLFLAG_RWTUN,
1428 &sc->sc_disable_port_power, 0,
1429 "Set to disable USB port power on this USB HUB.");
1433 * To have the best chance of success we do things in the exact same
1434 * order as Windoze98. This should not be necessary, but some
1435 * devices do not follow the USB specs to the letter.
1437 * These are the events on the bus when a hub is attached:
1438 * Get device and config descriptors (see attach code)
1439 * Get hub descriptor (see above)
1442 * wait for power to become stable
1443 * (all below happens in explore code)
1445 * clear C_PORT_CONNECTION
1448 * if device connected
1452 * clear C_PORT_RESET
1454 * proceed with device attachment
1457 /* XXX should check for none, individual, or ganged power? */
1461 for (x = 0; x != nports; x++) {
1462 /* set up data structures */
1463 struct usb_port *up = hub->ports + x;
1465 up->device_index = 0;
1469 /* check if port is removable */
1470 switch (udev->speed) {
1472 case USB_SPEED_FULL:
1473 case USB_SPEED_HIGH:
1474 if (!UHD_NOT_REMOV(&hubdesc20, portno))
1477 case USB_SPEED_SUPER:
1478 if (!UHD_NOT_REMOV(&hubdesc30, portno))
1482 DPRINTF("Assuming removable port\n");
1487 #if USB_HAVE_DISABLE_ENUM
1488 /* check if we should disable USB port power or not */
1489 if (usb_disable_port_power != 0 ||
1490 sc->sc_disable_port_power != 0) {
1491 /* turn the power off */
1492 DPRINTFN(2, "Turning port %d power off\n", portno);
1493 err = usbd_req_clear_port_feature(udev, NULL,
1494 portno, UHF_PORT_POWER);
1497 /* turn the power on */
1498 DPRINTFN(2, "Turning port %d power on\n", portno);
1499 err = usbd_req_set_port_feature(udev, NULL,
1500 portno, UHF_PORT_POWER);
1501 #if USB_HAVE_DISABLE_ENUM
1506 DPRINTFN(0, "port %d power on or off failed, %s\n",
1507 portno, usbd_errstr(err));
1509 DPRINTF("turn on port %d power\n",
1512 /* wait for stable power */
1513 usb_pause_mtx(NULL, USB_MS_TO_TICKS(pwrdly));
1516 device_printf(dev, "%d port%s with %d "
1517 "removable, %s powered\n", nports, (nports != 1) ? "s" : "",
1518 removable, udev->flags.self_powered ? "self" : "bus");
1520 /* Start the interrupt endpoint, if any */
1522 USB_MTX_LOCK(&sc->sc_mtx);
1523 usbd_transfer_start(sc->sc_xfer[UHUB_INTR_TRANSFER]);
1524 USB_MTX_UNLOCK(&sc->sc_mtx);
1526 /* Enable automatic power save on all USB HUBs */
1528 usbd_set_power_mode(udev, USB_POWER_MODE_SAVE);
1533 usbd_transfer_unsetup(sc->sc_xfer, UHUB_N_TRANSFER);
1535 #if (USB_HAVE_FIXED_PORT == 0)
1536 free(udev->hub, M_USBDEV);
1540 mtx_destroy(&sc->sc_mtx);
1546 * Called from process context when the hub is gone.
1547 * Detach all devices on active ports.
1550 uhub_detach(device_t dev)
1552 struct uhub_softc *sc = device_get_softc(dev);
1553 struct usb_hub *hub = sc->sc_udev->hub;
1554 struct usb_bus *bus = sc->sc_udev->bus;
1555 struct usb_device *child;
1558 if (hub == NULL) /* must be partially working */
1561 /* Make sure interrupt transfer is gone. */
1562 usbd_transfer_unsetup(sc->sc_xfer, UHUB_N_TRANSFER);
1564 /* Detach all ports */
1565 for (x = 0; x != hub->nports; x++) {
1567 child = usb_bus_port_get_device(bus, hub->ports + x);
1569 if (child == NULL) {
1574 * Free USB device and all subdevices, if any.
1576 usb_free_device(child, 0);
1579 #if USB_HAVE_TT_SUPPORT
1580 /* Make sure our TT messages are not queued anywhere */
1582 usb_proc_mwait(USB_BUS_TT_PROC(bus),
1583 &hub->tt_msg[0], &hub->tt_msg[1]);
1584 USB_BUS_UNLOCK(bus);
1587 #if (USB_HAVE_FIXED_PORT == 0)
1588 free(hub, M_USBDEV);
1590 sc->sc_udev->hub = NULL;
1592 mtx_destroy(&sc->sc_mtx);
1598 uhub_suspend(device_t dev)
1601 /* Sub-devices are not suspended here! */
1606 uhub_resume(device_t dev)
1609 /* Sub-devices are not resumed here! */
1614 uhub_driver_added(device_t dev, driver_t *driver)
1616 usb_needs_explore_all();
1620 struct usb_device *udev;
1622 uint8_t iface_index;
1626 uhub_find_iface_index(struct usb_hub *hub, device_t child,
1627 struct hub_result *res)
1629 struct usb_interface *iface;
1630 struct usb_device *udev;
1635 nports = hub->nports;
1636 for (x = 0; x != nports; x++) {
1637 udev = usb_bus_port_get_device(hub->hubudev->bus,
1642 for (i = 0; i != USB_IFACE_MAX; i++) {
1643 iface = usbd_get_iface(udev, i);
1645 (iface->subdev == child)) {
1646 res->iface_index = i;
1648 res->portno = x + 1;
1653 res->iface_index = 0;
1659 uhub_child_location_string(device_t parent, device_t child,
1660 char *buf, size_t buflen)
1662 struct uhub_softc *sc;
1663 struct usb_hub *hub;
1664 struct hub_result res;
1666 if (!device_is_attached(parent)) {
1672 sc = device_get_softc(parent);
1673 hub = sc->sc_udev->hub;
1676 uhub_find_iface_index(hub, child, &res);
1678 DPRINTF("device not on hub\n");
1684 snprintf(buf, buflen, "bus=%u hubaddr=%u port=%u devaddr=%u"
1689 , device_get_unit(res.udev->bus->bdev)
1690 , (res.udev->parent_hub != NULL) ?
1691 res.udev->parent_hub->device_index : 0
1692 , res.portno, res.udev->device_index, res.iface_index
1694 , res.udev->ugen_name
1704 uhub_child_pnpinfo_string(device_t parent, device_t child,
1705 char *buf, size_t buflen)
1707 struct uhub_softc *sc;
1708 struct usb_hub *hub;
1709 struct usb_interface *iface;
1710 struct hub_result res;
1712 if (!device_is_attached(parent)) {
1718 sc = device_get_softc(parent);
1719 hub = sc->sc_udev->hub;
1722 uhub_find_iface_index(hub, child, &res);
1724 DPRINTF("device not on hub\n");
1730 iface = usbd_get_iface(res.udev, res.iface_index);
1731 if (iface && iface->idesc) {
1732 snprintf(buf, buflen, "vendor=0x%04x product=0x%04x "
1733 "devclass=0x%02x devsubclass=0x%02x "
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 : "");
1766 * The USB Transaction Translator:
1767 * ===============================
1769 * When doing LOW- and FULL-speed USB transfers across a HIGH-speed
1770 * USB HUB, bandwidth must be allocated for ISOCHRONOUS and INTERRUPT
1771 * USB transfers. To utilize bandwidth dynamically the "scatter and
1772 * gather" principle must be applied. This means that bandwidth must
1773 * be divided into equal parts of bandwidth. With regard to USB all
1774 * data is transferred in smaller packets with length
1775 * "wMaxPacketSize". The problem however is that "wMaxPacketSize" is
1778 * The bandwidth scheduler which I have implemented will simply pack
1779 * the USB transfers back to back until there is no more space in the
1780 * schedule. Out of the 8 microframes which the USB 2.0 standard
1781 * provides, only 6 are available for non-HIGH-speed devices. I have
1782 * reserved the first 4 microframes for ISOCHRONOUS transfers. The
1783 * last 2 microframes I have reserved for INTERRUPT transfers. Without
1784 * this division, it is very difficult to allocate and free bandwidth
1787 * NOTE about the Transaction Translator in USB HUBs:
1789 * USB HUBs have a very simple Transaction Translator, that will
1790 * simply pipeline all the SPLIT transactions. That means that the
1791 * transactions will be executed in the order they are queued!
1795 /*------------------------------------------------------------------------*
1796 * usb_intr_find_best_slot
1799 * The best Transaction Translation slot for an interrupt endpoint.
1800 *------------------------------------------------------------------------*/
1802 usb_intr_find_best_slot(usb_size_t *ptr, uint8_t start,
1803 uint8_t end, uint8_t mask)
1805 usb_size_t min = (usb_size_t)-1;
1813 /* find the last slot with lesser used bandwidth */
1815 for (x = start; x < end; x++) {
1819 /* compute sum of bandwidth */
1820 for (z = x; z < end; z++) {
1821 if (mask & (1U << (z - x)))
1825 /* check if the current multi-slot is more optimal */
1831 /* check if the mask is about to be shifted out */
1832 if (mask & (1U << (end - 1 - x)))
1838 /*------------------------------------------------------------------------*
1839 * usb_hs_bandwidth_adjust
1841 * This function will update the bandwidth usage for the microframe
1842 * having index "slot" by "len" bytes. "len" can be negative. If the
1843 * "slot" argument is greater or equal to "USB_HS_MICRO_FRAMES_MAX"
1844 * the "slot" argument will be replaced by the slot having least used
1845 * bandwidth. The "mask" argument is used for multi-slot allocations.
1848 * The slot in which the bandwidth update was done: 0..7
1849 *------------------------------------------------------------------------*/
1851 usb_hs_bandwidth_adjust(struct usb_device *udev, int16_t len,
1852 uint8_t slot, uint8_t mask)
1854 struct usb_bus *bus = udev->bus;
1855 struct usb_hub *hub;
1856 enum usb_dev_speed speed;
1859 USB_BUS_LOCK_ASSERT(bus, MA_OWNED);
1861 speed = usbd_get_speed(udev);
1865 case USB_SPEED_FULL:
1866 if (speed == USB_SPEED_LOW) {
1870 * The Host Controller Driver should have
1871 * performed checks so that the lookup
1872 * below does not result in a NULL pointer
1876 hub = udev->parent_hs_hub->hub;
1877 if (slot >= USB_HS_MICRO_FRAMES_MAX) {
1878 slot = usb_intr_find_best_slot(hub->uframe_usage,
1879 USB_FS_ISOC_UFRAME_MAX, 6, mask);
1881 for (x = slot; x < 8; x++) {
1882 if (mask & (1U << (x - slot))) {
1883 hub->uframe_usage[x] += len;
1884 bus->uframe_usage[x] += len;
1889 if (slot >= USB_HS_MICRO_FRAMES_MAX) {
1890 slot = usb_intr_find_best_slot(bus->uframe_usage, 0,
1891 USB_HS_MICRO_FRAMES_MAX, mask);
1893 for (x = slot; x < 8; x++) {
1894 if (mask & (1U << (x - slot))) {
1895 bus->uframe_usage[x] += len;
1903 /*------------------------------------------------------------------------*
1904 * usb_hs_bandwidth_alloc
1906 * This function is a wrapper function for "usb_hs_bandwidth_adjust()".
1907 *------------------------------------------------------------------------*/
1909 usb_hs_bandwidth_alloc(struct usb_xfer *xfer)
1911 struct usb_device *udev;
1916 udev = xfer->xroot->udev;
1918 if (udev->flags.usb_mode != USB_MODE_HOST)
1919 return; /* not supported */
1921 xfer->endpoint->refcount_bw++;
1922 if (xfer->endpoint->refcount_bw != 1)
1923 return; /* already allocated */
1925 speed = usbd_get_speed(udev);
1927 switch (xfer->endpoint->edesc->bmAttributes & UE_XFERTYPE) {
1929 /* allocate a microframe slot */
1932 slot = usb_hs_bandwidth_adjust(udev,
1933 xfer->max_frame_size, USB_HS_MICRO_FRAMES_MAX, mask);
1935 xfer->endpoint->usb_uframe = slot;
1936 xfer->endpoint->usb_smask = mask << slot;
1938 if ((speed != USB_SPEED_FULL) &&
1939 (speed != USB_SPEED_LOW)) {
1940 xfer->endpoint->usb_cmask = 0x00 ;
1942 xfer->endpoint->usb_cmask = (-(0x04 << slot)) & 0xFE;
1946 case UE_ISOCHRONOUS:
1947 switch (usbd_xfer_get_fps_shift(xfer)) {
1962 /* allocate a microframe multi-slot */
1964 slot = usb_hs_bandwidth_adjust(udev,
1965 xfer->max_frame_size, USB_HS_MICRO_FRAMES_MAX, mask);
1967 xfer->endpoint->usb_uframe = slot;
1968 xfer->endpoint->usb_cmask = 0;
1969 xfer->endpoint->usb_smask = mask << slot;
1973 xfer->endpoint->usb_uframe = 0;
1974 xfer->endpoint->usb_cmask = 0;
1975 xfer->endpoint->usb_smask = 0;
1979 DPRINTFN(11, "slot=%d, mask=0x%02x\n",
1980 xfer->endpoint->usb_uframe,
1981 xfer->endpoint->usb_smask >> xfer->endpoint->usb_uframe);
1984 /*------------------------------------------------------------------------*
1985 * usb_hs_bandwidth_free
1987 * This function is a wrapper function for "usb_hs_bandwidth_adjust()".
1988 *------------------------------------------------------------------------*/
1990 usb_hs_bandwidth_free(struct usb_xfer *xfer)
1992 struct usb_device *udev;
1996 udev = xfer->xroot->udev;
1998 if (udev->flags.usb_mode != USB_MODE_HOST)
1999 return; /* not supported */
2001 xfer->endpoint->refcount_bw--;
2002 if (xfer->endpoint->refcount_bw != 0)
2003 return; /* still allocated */
2005 switch (xfer->endpoint->edesc->bmAttributes & UE_XFERTYPE) {
2007 case UE_ISOCHRONOUS:
2009 slot = xfer->endpoint->usb_uframe;
2010 mask = xfer->endpoint->usb_smask;
2012 /* free microframe slot(s): */
2013 usb_hs_bandwidth_adjust(udev,
2014 -xfer->max_frame_size, slot, mask >> slot);
2016 DPRINTFN(11, "slot=%d, mask=0x%02x\n",
2017 slot, mask >> slot);
2019 xfer->endpoint->usb_uframe = 0;
2020 xfer->endpoint->usb_cmask = 0;
2021 xfer->endpoint->usb_smask = 0;
2029 /*------------------------------------------------------------------------*
2030 * usb_isoc_time_expand
2032 * This function will expand the time counter from 7-bit to 16-bit.
2035 * 16-bit isochronous time counter.
2036 *------------------------------------------------------------------------*/
2038 usb_isoc_time_expand(struct usb_bus *bus, uint16_t isoc_time_curr)
2042 USB_BUS_LOCK_ASSERT(bus, MA_OWNED);
2044 rem = bus->isoc_time_last & (USB_ISOC_TIME_MAX - 1);
2046 isoc_time_curr &= (USB_ISOC_TIME_MAX - 1);
2048 if (isoc_time_curr < rem) {
2049 /* the time counter wrapped around */
2050 bus->isoc_time_last += USB_ISOC_TIME_MAX;
2052 /* update the remainder */
2054 bus->isoc_time_last &= ~(USB_ISOC_TIME_MAX - 1);
2055 bus->isoc_time_last |= isoc_time_curr;
2057 return (bus->isoc_time_last);
2060 /*------------------------------------------------------------------------*
2061 * usbd_fs_isoc_schedule_alloc_slot
2063 * This function will allocate bandwidth for an isochronous FULL speed
2064 * transaction in the FULL speed schedule.
2069 *------------------------------------------------------------------------*/
2070 #if USB_HAVE_TT_SUPPORT
2072 usbd_fs_isoc_schedule_alloc_slot(struct usb_xfer *isoc_xfer, uint16_t isoc_time)
2074 struct usb_xfer *xfer;
2075 struct usb_xfer *pipe_xfer;
2076 struct usb_bus *bus;
2078 usb_frlength_t data_len;
2086 bus = isoc_xfer->xroot->bus;
2088 TAILQ_FOREACH(xfer, &bus->intr_q.head, wait_entry) {
2090 /* skip self, if any */
2092 if (xfer == isoc_xfer)
2095 /* check if this USB transfer is going through the same TT */
2097 if (xfer->xroot->udev->parent_hs_hub !=
2098 isoc_xfer->xroot->udev->parent_hs_hub) {
2101 if ((isoc_xfer->xroot->udev->parent_hs_hub->
2102 ddesc.bDeviceProtocol == UDPROTO_HSHUBMTT) &&
2103 (xfer->xroot->udev->hs_port_no !=
2104 isoc_xfer->xroot->udev->hs_port_no)) {
2107 if (xfer->endpoint->methods != isoc_xfer->endpoint->methods)
2110 /* check if isoc_time is part of this transfer */
2112 delta = xfer->isoc_time_complete - isoc_time;
2113 if (delta > 0 && delta <= xfer->nframes) {
2114 delta = xfer->nframes - delta;
2116 len = xfer->frlengths[delta];
2125 * Check double buffered transfers. Only stream ID
2126 * equal to zero is valid here!
2128 TAILQ_FOREACH(pipe_xfer, &xfer->endpoint->endpoint_q[0].head,
2131 /* skip self, if any */
2133 if (pipe_xfer == isoc_xfer)
2136 /* check if isoc_time is part of this transfer */
2138 delta = pipe_xfer->isoc_time_complete - isoc_time;
2139 if (delta > 0 && delta <= pipe_xfer->nframes) {
2140 delta = pipe_xfer->nframes - delta;
2142 len = pipe_xfer->frlengths[delta];
2152 while (data_len >= USB_FS_BYTES_PER_HS_UFRAME) {
2153 data_len -= USB_FS_BYTES_PER_HS_UFRAME;
2157 /* check for overflow */
2159 if (slot >= USB_FS_ISOC_UFRAME_MAX)
2164 delta = isoc_xfer->isoc_time_complete - isoc_time;
2165 if (delta > 0 && delta <= isoc_xfer->nframes) {
2166 delta = isoc_xfer->nframes - delta;
2168 len = isoc_xfer->frlengths[delta];
2176 while (data_len >= USB_FS_BYTES_PER_HS_UFRAME) {
2177 data_len -= USB_FS_BYTES_PER_HS_UFRAME;
2181 /* check for overflow */
2183 if (slot >= USB_FS_ISOC_UFRAME_MAX)
2190 /*------------------------------------------------------------------------*
2191 * usb_bus_port_get_device
2193 * This function is NULL safe.
2194 *------------------------------------------------------------------------*/
2196 usb_bus_port_get_device(struct usb_bus *bus, struct usb_port *up)
2198 if ((bus == NULL) || (up == NULL)) {
2202 if (up->device_index == 0) {
2206 return (bus->devices[up->device_index]);
2209 /*------------------------------------------------------------------------*
2210 * usb_bus_port_set_device
2212 * This function is NULL safe.
2213 *------------------------------------------------------------------------*/
2215 usb_bus_port_set_device(struct usb_bus *bus, struct usb_port *up,
2216 struct usb_device *udev, uint8_t device_index)
2223 * There is only one case where we don't
2224 * have an USB port, and that is the Root Hub!
2228 up->device_index = device_index;
2230 device_index = up->device_index;
2231 up->device_index = 0;
2235 * Make relationships to our new device
2237 if (device_index != 0) {
2239 mtx_lock(&usb_ref_lock);
2241 bus->devices[device_index] = udev;
2243 mtx_unlock(&usb_ref_lock);
2249 DPRINTFN(2, "bus %p devices[%u] = %p\n", bus, device_index, udev);
2252 /*------------------------------------------------------------------------*
2255 * This functions is called when the USB event thread needs to run.
2256 *------------------------------------------------------------------------*/
2258 usb_needs_explore(struct usb_bus *bus, uint8_t do_probe)
2270 DPRINTF("No bus pointer!\n");
2273 if ((bus->devices == NULL) ||
2274 (bus->devices[USB_ROOT_HUB_ADDR] == NULL)) {
2275 DPRINTF("No root HUB\n");
2278 if (mtx_owned(&bus->bus_mtx)) {
2287 if (usb_proc_msignal(USB_BUS_EXPLORE_PROC(bus),
2288 &bus->explore_msg[0], &bus->explore_msg[1])) {
2292 USB_BUS_UNLOCK(bus);
2296 /*------------------------------------------------------------------------*
2297 * usb_needs_explore_all
2299 * This function is called whenever a new driver is loaded and will
2300 * cause that all USB buses are re-explored.
2301 *------------------------------------------------------------------------*/
2303 usb_needs_explore_all(void)
2305 struct usb_bus *bus;
2312 dc = usb_devclass_ptr;
2314 DPRINTFN(0, "no devclass\n");
2318 * Explore all USB buses in parallel.
2320 max = devclass_get_maxunit(dc);
2322 dev = devclass_get_device(dc, max);
2324 bus = device_get_softc(dev);
2326 usb_needs_explore(bus, 1);
2333 /*------------------------------------------------------------------------*
2334 * usb_needs_explore_init
2336 * This function will ensure that the USB controllers are not enumerated
2337 * until the "cold" variable is cleared.
2338 *------------------------------------------------------------------------*/
2340 usb_needs_explore_init(void *arg)
2343 * The cold variable should be cleared prior to this function
2347 usb_needs_explore_all();
2349 DPRINTFN(-1, "Cold variable is still set!\n");
2351 SYSINIT(usb_needs_explore_init, SI_SUB_KICK_SCHEDULER, SI_ORDER_SECOND, usb_needs_explore_init, NULL);
2353 /*------------------------------------------------------------------------*
2354 * usb_bus_power_update
2356 * This function will ensure that all USB devices on the given bus are
2357 * properly suspended or resumed according to the device transfer
2359 *------------------------------------------------------------------------*/
2362 usb_bus_power_update(struct usb_bus *bus)
2364 usb_needs_explore(bus, 0 /* no probe */ );
2368 /*------------------------------------------------------------------------*
2369 * usbd_transfer_power_ref
2371 * This function will modify the power save reference counts and
2372 * wakeup the USB device associated with the given USB transfer, if
2374 *------------------------------------------------------------------------*/
2377 usbd_transfer_power_ref(struct usb_xfer *xfer, int val)
2379 static const usb_power_mask_t power_mask[4] = {
2380 [UE_CONTROL] = USB_HW_POWER_CONTROL,
2381 [UE_BULK] = USB_HW_POWER_BULK,
2382 [UE_INTERRUPT] = USB_HW_POWER_INTERRUPT,
2383 [UE_ISOCHRONOUS] = USB_HW_POWER_ISOC,
2385 struct usb_device *udev;
2386 uint8_t needs_explore;
2387 uint8_t needs_hw_power;
2390 udev = xfer->xroot->udev;
2392 if (udev->device_index == USB_ROOT_HUB_ADDR) {
2393 /* no power save for root HUB */
2396 USB_BUS_LOCK(udev->bus);
2398 xfer_type = xfer->endpoint->edesc->bmAttributes & UE_XFERTYPE;
2400 udev->pwr_save.last_xfer_time = ticks;
2401 udev->pwr_save.type_refs[xfer_type] += val;
2403 if (xfer->flags_int.control_xfr) {
2404 udev->pwr_save.read_refs += val;
2405 if (xfer->flags_int.usb_mode == USB_MODE_HOST) {
2407 * It is not allowed to suspend during a
2410 udev->pwr_save.write_refs += val;
2412 } else if (USB_GET_DATA_ISREAD(xfer)) {
2413 udev->pwr_save.read_refs += val;
2415 udev->pwr_save.write_refs += val;
2419 if (udev->flags.self_suspended)
2420 needs_explore = usb_peer_should_wakeup(udev);
2424 if (!(udev->bus->hw_power_state & power_mask[xfer_type])) {
2425 DPRINTF("Adding type %u to power state\n", xfer_type);
2426 udev->bus->hw_power_state |= power_mask[xfer_type];
2436 USB_BUS_UNLOCK(udev->bus);
2438 if (needs_explore) {
2439 DPRINTF("update\n");
2440 usb_bus_power_update(udev->bus);
2441 } else if (needs_hw_power) {
2442 DPRINTF("needs power\n");
2443 if (udev->bus->methods->set_hw_power != NULL) {
2444 (udev->bus->methods->set_hw_power) (udev->bus);
2450 /*------------------------------------------------------------------------*
2451 * usb_peer_should_wakeup
2453 * This function returns non-zero if the current device should wake up.
2454 *------------------------------------------------------------------------*/
2456 usb_peer_should_wakeup(struct usb_device *udev)
2458 return (((udev->power_mode == USB_POWER_MODE_ON) &&
2459 (udev->flags.usb_mode == USB_MODE_HOST)) ||
2460 (udev->driver_added_refcount != udev->bus->driver_added_refcount) ||
2461 (udev->re_enumerate_wait != USB_RE_ENUM_DONE) ||
2462 (udev->pwr_save.type_refs[UE_ISOCHRONOUS] != 0) ||
2463 (udev->pwr_save.write_refs != 0) ||
2464 ((udev->pwr_save.read_refs != 0) &&
2465 (udev->flags.usb_mode == USB_MODE_HOST) &&
2466 (usb_peer_can_wakeup(udev) == 0)));
2469 /*------------------------------------------------------------------------*
2472 * This function implements the USB power daemon and is called
2473 * regularly from the USB explore thread.
2474 *------------------------------------------------------------------------*/
2477 usb_bus_powerd(struct usb_bus *bus)
2479 struct usb_device *udev;
2482 usb_ticks_t mintime;
2483 usb_size_t type_refs[5];
2486 limit = usb_power_timeout;
2489 else if (limit > 255)
2494 DPRINTF("bus=%p\n", bus);
2499 * The root HUB device is never suspended
2500 * and we simply skip it.
2502 for (x = USB_ROOT_HUB_ADDR + 1;
2503 x != bus->devices_max; x++) {
2505 udev = bus->devices[x];
2509 temp = ticks - udev->pwr_save.last_xfer_time;
2511 if (usb_peer_should_wakeup(udev)) {
2512 /* check if we are suspended */
2513 if (udev->flags.self_suspended != 0) {
2514 USB_BUS_UNLOCK(bus);
2515 usb_dev_resume_peer(udev);
2518 } else if ((temp >= limit) &&
2519 (udev->flags.usb_mode == USB_MODE_HOST) &&
2520 (udev->flags.self_suspended == 0)) {
2521 /* try to do suspend */
2523 USB_BUS_UNLOCK(bus);
2524 usb_dev_suspend_peer(udev);
2529 /* reset counters */
2531 mintime = (usb_ticks_t)-1;
2538 /* Re-loop all the devices to get the actual state */
2540 for (x = USB_ROOT_HUB_ADDR + 1;
2541 x != bus->devices_max; x++) {
2543 udev = bus->devices[x];
2547 /* we found a non-Root-Hub USB device */
2550 /* "last_xfer_time" can be updated by a resume */
2551 temp = ticks - udev->pwr_save.last_xfer_time;
2554 * Compute minimum time since last transfer for the complete
2560 if (udev->flags.self_suspended == 0) {
2561 type_refs[0] += udev->pwr_save.type_refs[0];
2562 type_refs[1] += udev->pwr_save.type_refs[1];
2563 type_refs[2] += udev->pwr_save.type_refs[2];
2564 type_refs[3] += udev->pwr_save.type_refs[3];
2568 if (mintime >= (usb_ticks_t)(1 * hz)) {
2569 /* recompute power masks */
2570 DPRINTF("Recomputing power masks\n");
2571 bus->hw_power_state = 0;
2572 if (type_refs[UE_CONTROL] != 0)
2573 bus->hw_power_state |= USB_HW_POWER_CONTROL;
2574 if (type_refs[UE_BULK] != 0)
2575 bus->hw_power_state |= USB_HW_POWER_BULK;
2576 if (type_refs[UE_INTERRUPT] != 0)
2577 bus->hw_power_state |= USB_HW_POWER_INTERRUPT;
2578 if (type_refs[UE_ISOCHRONOUS] != 0)
2579 bus->hw_power_state |= USB_HW_POWER_ISOC;
2580 if (type_refs[4] != 0)
2581 bus->hw_power_state |= USB_HW_POWER_NON_ROOT_HUB;
2583 USB_BUS_UNLOCK(bus);
2585 if (bus->methods->set_hw_power != NULL) {
2586 /* always update hardware power! */
2587 (bus->methods->set_hw_power) (bus);
2593 /*------------------------------------------------------------------------*
2594 * usb_dev_resume_peer
2596 * This function will resume an USB peer and do the required USB
2597 * signalling to get an USB device out of the suspended state.
2598 *------------------------------------------------------------------------*/
2600 usb_dev_resume_peer(struct usb_device *udev)
2602 struct usb_bus *bus;
2609 /* check if already resumed */
2610 if (udev->flags.self_suspended == 0)
2613 /* we need a parent HUB to do resume */
2614 if (udev->parent_hub == NULL)
2617 DPRINTF("udev=%p\n", udev);
2619 if ((udev->flags.usb_mode == USB_MODE_DEVICE) &&
2620 (udev->flags.remote_wakeup == 0)) {
2622 * If the host did not set the remote wakeup feature, we can
2623 * not wake it up either!
2625 DPRINTF("remote wakeup is not set!\n");
2628 /* get bus pointer */
2631 /* resume parent hub first */
2632 usb_dev_resume_peer(udev->parent_hub);
2634 /* reduce chance of instant resume failure by waiting a little bit */
2635 usb_pause_mtx(NULL, USB_MS_TO_TICKS(20));
2637 if (usb_device_20_compatible(udev)) {
2638 /* resume current port (Valid in Host and Device Mode) */
2639 err = usbd_req_clear_port_feature(udev->parent_hub,
2640 NULL, udev->port_no, UHF_PORT_SUSPEND);
2642 DPRINTFN(0, "Resuming port failed\n");
2646 /* resume current port (Valid in Host and Device Mode) */
2647 err = usbd_req_set_port_link_state(udev->parent_hub,
2648 NULL, udev->port_no, UPS_PORT_LS_U0);
2650 DPRINTFN(0, "Resuming port failed\n");
2655 /* resume settle time */
2656 usb_pause_mtx(NULL, USB_MS_TO_TICKS(usb_port_resume_delay));
2658 if (bus->methods->device_resume != NULL) {
2659 /* resume USB device on the USB controller */
2660 (bus->methods->device_resume) (udev);
2663 /* set that this device is now resumed */
2664 udev->flags.self_suspended = 0;
2666 /* make sure that we don't go into suspend right away */
2667 udev->pwr_save.last_xfer_time = ticks;
2669 /* make sure the needed power masks are on */
2670 if (udev->pwr_save.type_refs[UE_CONTROL] != 0)
2671 bus->hw_power_state |= USB_HW_POWER_CONTROL;
2672 if (udev->pwr_save.type_refs[UE_BULK] != 0)
2673 bus->hw_power_state |= USB_HW_POWER_BULK;
2674 if (udev->pwr_save.type_refs[UE_INTERRUPT] != 0)
2675 bus->hw_power_state |= USB_HW_POWER_INTERRUPT;
2676 if (udev->pwr_save.type_refs[UE_ISOCHRONOUS] != 0)
2677 bus->hw_power_state |= USB_HW_POWER_ISOC;
2679 USB_BUS_UNLOCK(bus);
2681 if (bus->methods->set_hw_power != NULL) {
2682 /* always update hardware power! */
2683 (bus->methods->set_hw_power) (bus);
2688 /* notify all sub-devices about resume */
2689 err = usb_suspend_resume(udev, 0);
2691 usbd_sr_unlock(udev);
2693 /* check if peer has wakeup capability */
2694 if (usb_peer_can_wakeup(udev)) {
2695 /* clear remote wakeup */
2696 err = usbd_req_clear_device_feature(udev,
2697 NULL, UF_DEVICE_REMOTE_WAKEUP);
2699 DPRINTFN(0, "Clearing device "
2700 "remote wakeup failed: %s\n",
2706 /*------------------------------------------------------------------------*
2707 * usb_dev_suspend_peer
2709 * This function will suspend an USB peer and do the required USB
2710 * signalling to get an USB device into the suspended state.
2711 *------------------------------------------------------------------------*/
2713 usb_dev_suspend_peer(struct usb_device *udev)
2715 struct usb_device *child;
2725 /* check if already suspended */
2726 if (udev->flags.self_suspended)
2729 /* we need a parent HUB to do suspend */
2730 if (udev->parent_hub == NULL)
2733 DPRINTF("udev=%p\n", udev);
2735 /* check if the current device is a HUB */
2736 if (udev->hub != NULL) {
2737 nports = udev->hub->nports;
2739 /* check if all devices on the HUB are suspended */
2740 for (x = 0; x != nports; x++) {
2741 child = usb_bus_port_get_device(udev->bus,
2742 udev->hub->ports + x);
2747 if (child->flags.self_suspended)
2750 DPRINTFN(1, "Port %u is busy on the HUB!\n", x + 1);
2755 if (usb_peer_can_wakeup(udev)) {
2757 * This request needs to be done before we set
2758 * "udev->flags.self_suspended":
2761 /* allow device to do remote wakeup */
2762 err = usbd_req_set_device_feature(udev,
2763 NULL, UF_DEVICE_REMOTE_WAKEUP);
2765 DPRINTFN(0, "Setting device "
2766 "remote wakeup failed\n");
2770 USB_BUS_LOCK(udev->bus);
2772 * Checking for suspend condition and setting suspended bit
2775 err = usb_peer_should_wakeup(udev);
2778 * Set that this device is suspended. This variable
2779 * must be set before calling USB controller suspend
2782 udev->flags.self_suspended = 1;
2784 USB_BUS_UNLOCK(udev->bus);
2787 if (usb_peer_can_wakeup(udev)) {
2788 /* allow device to do remote wakeup */
2789 err = usbd_req_clear_device_feature(udev,
2790 NULL, UF_DEVICE_REMOTE_WAKEUP);
2792 DPRINTFN(0, "Setting device "
2793 "remote wakeup failed\n");
2797 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
2798 /* resume parent HUB first */
2799 usb_dev_resume_peer(udev->parent_hub);
2801 /* reduce chance of instant resume failure by waiting a little bit */
2802 usb_pause_mtx(NULL, USB_MS_TO_TICKS(20));
2804 /* resume current port (Valid in Host and Device Mode) */
2805 err = usbd_req_clear_port_feature(udev->parent_hub,
2806 NULL, udev->port_no, UHF_PORT_SUSPEND);
2808 /* resume settle time */
2809 usb_pause_mtx(NULL, USB_MS_TO_TICKS(usb_port_resume_delay));
2811 DPRINTF("Suspend was cancelled!\n");
2817 /* notify all sub-devices about suspend */
2818 err = usb_suspend_resume(udev, 1);
2820 usbd_sr_unlock(udev);
2822 if (udev->bus->methods->device_suspend != NULL) {
2825 /* suspend device on the USB controller */
2826 (udev->bus->methods->device_suspend) (udev);
2829 temp = usbd_get_dma_delay(udev);
2831 usb_pause_mtx(NULL, USB_MS_TO_TICKS(temp));
2835 if (usb_device_20_compatible(udev)) {
2836 /* suspend current port */
2837 err = usbd_req_set_port_feature(udev->parent_hub,
2838 NULL, udev->port_no, UHF_PORT_SUSPEND);
2840 DPRINTFN(0, "Suspending port failed\n");
2844 /* suspend current port */
2845 err = usbd_req_set_port_link_state(udev->parent_hub,
2846 NULL, udev->port_no, UPS_PORT_LS_U3);
2848 DPRINTFN(0, "Suspending port failed\n");
2853 udev = udev->parent_hub;
2857 /*------------------------------------------------------------------------*
2858 * usbd_set_power_mode
2860 * This function will set the power mode, see USB_POWER_MODE_XXX for a
2862 *------------------------------------------------------------------------*/
2864 usbd_set_power_mode(struct usb_device *udev, uint8_t power_mode)
2866 /* filter input argument */
2867 if ((power_mode != USB_POWER_MODE_ON) &&
2868 (power_mode != USB_POWER_MODE_OFF))
2869 power_mode = USB_POWER_MODE_SAVE;
2871 power_mode = usbd_filter_power_mode(udev, power_mode);
2873 udev->power_mode = power_mode; /* update copy of power mode */
2876 usb_bus_power_update(udev->bus);
2878 usb_needs_explore(udev->bus, 0 /* no probe */ );
2882 /*------------------------------------------------------------------------*
2883 * usbd_filter_power_mode
2885 * This function filters the power mode based on hardware requirements.
2886 *------------------------------------------------------------------------*/
2888 usbd_filter_power_mode(struct usb_device *udev, uint8_t power_mode)
2890 const struct usb_bus_methods *mtod;
2893 mtod = udev->bus->methods;
2896 if (mtod->get_power_mode != NULL)
2897 (mtod->get_power_mode) (udev, &temp);
2899 /* check if we should not filter */
2901 return (power_mode);
2903 /* use fixed power mode given by hardware driver */
2907 /*------------------------------------------------------------------------*
2908 * usbd_start_re_enumerate
2910 * This function starts re-enumeration of the given USB device. This
2911 * function does not need to be called BUS-locked. This function does
2912 * not wait until the re-enumeration is completed.
2913 *------------------------------------------------------------------------*/
2915 usbd_start_re_enumerate(struct usb_device *udev)
2917 if (udev->re_enumerate_wait == USB_RE_ENUM_DONE) {
2918 udev->re_enumerate_wait = USB_RE_ENUM_START;
2919 usb_needs_explore(udev->bus, 0);
2923 /*-----------------------------------------------------------------------*
2924 * usbd_start_set_config
2926 * This function starts setting a USB configuration. This function
2927 * does not need to be called BUS-locked. This function does not wait
2928 * until the set USB configuratino is completed.
2929 *------------------------------------------------------------------------*/
2931 usbd_start_set_config(struct usb_device *udev, uint8_t index)
2933 if (udev->re_enumerate_wait == USB_RE_ENUM_DONE) {
2934 if (udev->curr_config_index == index) {
2935 /* no change needed */
2938 udev->next_config_index = index;
2939 udev->re_enumerate_wait = USB_RE_ENUM_SET_CONFIG;
2940 usb_needs_explore(udev->bus, 0);
2942 } else if (udev->re_enumerate_wait == USB_RE_ENUM_SET_CONFIG) {
2943 if (udev->next_config_index == index) {
2944 /* no change needed */
2948 return (USB_ERR_PENDING_REQUESTS);