2005-04-17 06:20:36 +08:00
|
|
|
/*
|
2010-04-25 05:38:17 +08:00
|
|
|
* This file holds Hub protocol constants and data structures that are
|
|
|
|
|
* defined in chapter 11 (Hub Specification) of the USB 2.0 specification.
|
2005-04-17 06:20:36 +08:00
|
|
|
*
|
2010-04-25 05:38:17 +08:00
|
|
|
* It is used/shared between the USB core, the HCDs and couple of other USB
|
|
|
|
|
* drivers.
|
2005-04-17 06:20:36 +08:00
|
|
|
*/
|
|
|
|
|
|
2010-05-01 00:42:23 +08:00
|
|
|
#ifndef __LINUX_CH11_H
|
|
|
|
|
#define __LINUX_CH11_H
|
2010-04-25 05:38:17 +08:00
|
|
|
|
2010-05-01 00:42:23 +08:00
|
|
|
#include <linux/types.h> /* __u8 etc */
|
2005-04-17 06:20:36 +08:00
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Hub request types
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#define USB_RT_HUB (USB_TYPE_CLASS | USB_RECIP_DEVICE)
|
|
|
|
|
#define USB_RT_PORT (USB_TYPE_CLASS | USB_RECIP_OTHER)
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Hub class requests
|
|
|
|
|
* See USB 2.0 spec Table 11-16
|
|
|
|
|
*/
|
|
|
|
|
#define HUB_CLEAR_TT_BUFFER 8
|
|
|
|
|
#define HUB_RESET_TT 9
|
|
|
|
|
#define HUB_GET_TT_STATE 10
|
|
|
|
|
#define HUB_STOP_TT 11
|
|
|
|
|
|
2010-11-02 00:18:24 +08:00
|
|
|
/*
|
|
|
|
|
* Hub class additional requests defined by USB 3.0 spec
|
|
|
|
|
* See USB 3.0 spec Table 10-6
|
|
|
|
|
*/
|
|
|
|
|
#define HUB_SET_DEPTH 12
|
|
|
|
|
#define HUB_GET_PORT_ERR_COUNT 13
|
|
|
|
|
|
2005-04-17 06:20:36 +08:00
|
|
|
/*
|
|
|
|
|
* Hub Class feature numbers
|
|
|
|
|
* See USB 2.0 spec Table 11-17
|
|
|
|
|
*/
|
|
|
|
|
#define C_HUB_LOCAL_POWER 0
|
|
|
|
|
#define C_HUB_OVER_CURRENT 1
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Port feature numbers
|
|
|
|
|
* See USB 2.0 spec Table 11-17
|
|
|
|
|
*/
|
|
|
|
|
#define USB_PORT_FEAT_CONNECTION 0
|
|
|
|
|
#define USB_PORT_FEAT_ENABLE 1
|
2008-02-11 04:24:00 +08:00
|
|
|
#define USB_PORT_FEAT_SUSPEND 2 /* L2 suspend */
|
2005-04-17 06:20:36 +08:00
|
|
|
#define USB_PORT_FEAT_OVER_CURRENT 3
|
|
|
|
|
#define USB_PORT_FEAT_RESET 4
|
2008-02-11 04:24:00 +08:00
|
|
|
#define USB_PORT_FEAT_L1 5 /* L1 suspend */
|
2005-04-17 06:20:36 +08:00
|
|
|
#define USB_PORT_FEAT_POWER 8
|
2010-03-05 00:32:30 +08:00
|
|
|
#define USB_PORT_FEAT_LOWSPEED 9 /* Should never be used */
|
2005-04-17 06:20:36 +08:00
|
|
|
#define USB_PORT_FEAT_C_CONNECTION 16
|
|
|
|
|
#define USB_PORT_FEAT_C_ENABLE 17
|
|
|
|
|
#define USB_PORT_FEAT_C_SUSPEND 18
|
|
|
|
|
#define USB_PORT_FEAT_C_OVER_CURRENT 19
|
|
|
|
|
#define USB_PORT_FEAT_C_RESET 20
|
|
|
|
|
#define USB_PORT_FEAT_TEST 21
|
|
|
|
|
#define USB_PORT_FEAT_INDICATOR 22
|
2008-02-11 04:24:00 +08:00
|
|
|
#define USB_PORT_FEAT_C_PORT_L1 23
|
2005-04-17 06:20:36 +08:00
|
|
|
|
2010-11-02 00:18:24 +08:00
|
|
|
/*
|
|
|
|
|
* Port feature selectors added by USB 3.0 spec.
|
|
|
|
|
* See USB 3.0 spec Table 10-7
|
|
|
|
|
*/
|
|
|
|
|
#define USB_PORT_FEAT_LINK_STATE 5
|
|
|
|
|
#define USB_PORT_FEAT_U1_TIMEOUT 23
|
|
|
|
|
#define USB_PORT_FEAT_U2_TIMEOUT 24
|
2012-01-06 08:28:54 +08:00
|
|
|
#define USB_PORT_FEAT_C_PORT_LINK_STATE 25
|
|
|
|
|
#define USB_PORT_FEAT_C_PORT_CONFIG_ERROR 26
|
2010-11-02 00:18:24 +08:00
|
|
|
#define USB_PORT_FEAT_REMOTE_WAKE_MASK 27
|
|
|
|
|
#define USB_PORT_FEAT_BH_PORT_RESET 28
|
|
|
|
|
#define USB_PORT_FEAT_C_BH_PORT_RESET 29
|
|
|
|
|
#define USB_PORT_FEAT_FORCE_LINKPM_ACCEPT 30
|
|
|
|
|
|
USB: Add support to enable/disable USB3 link states.
There are various functions within the USB core that will need to
disable USB 3.0 link power states. For example, when a USB device
driver is being bound to an interface, we need to disable USB 3.0 LPM
until we know if the driver will allow hub-initiated LPM transitions.
Another example is when the USB core is switching alternate interface
settings. The USB 3.0 timeout values are dependent on what endpoints
are enabled, so we want to ensure that LPM is disabled until the new alt
setting is fully installed.
Multiple functions need to disable LPM, and those functions can even be
nested. For example, usb_bind_interface() could disable LPM, and then
call into the driver probe function, which may attempt to switch to a
different alt setting. Therefore, we need to keep a count of the number
of functions that require LPM to be disabled at any point in time.
Introduce two new USB core API calls, usb_disable_lpm() and
usb_enable_lpm(). These functions increment and decrement a new
variable in the usb_device, lpm_disable_count. If usb_disable_lpm()
fails, it will call usb_enable_lpm() in order to balance the
lpm_disable_count.
These two new functions must be called with the bandwidth_mutex locked.
If the bandwidth_mutex is not already held by the caller, it should
instead call usb_unlocked_disable_lpm() and usb_enable_lpm(), which take
the bandwidth_mutex before calling usb_disable_lpm() and
usb_enable_lpm(), respectively.
Introduce a new variable (timeout) in the usb3_lpm_params structure to
keep track of the currently enabled U1/U2 timeout values. When
usb_disable_lpm() is called, and the USB device has the U1 or U2
timeouts set to a non-zero value (meaning either device-initiated or
hub-initiated LPM is enabled), attempt to disable LPM, regardless of the
state of the lpm_disable_count. We want to ensure that all callers can
be guaranteed that LPM is disabled if usb_disable_lpm() returns zero.
Otherwise the following scenario could occur:
1. Driver A is being bound to interface 1. usb_probe_interface()
disables LPM. Driver A doesn't care if hub-initiated LPM is enabled, so
even though usb_disable_lpm() fails, the probe of the driver continues,
and the bandwidth mutex is dropped.
2. Meanwhile, Driver B is being bound to interface 2.
usb_probe_interface() grabs the bandwidth mutex and calls
usb_disable_lpm(). That call should attempt to disable LPM, even
though the lpm_disable_count is set to 1 by Driver A.
For usb_enable_lpm(), we attempt to enable LPM only when the
lpm_disable_count is zero. If some step in enabling LPM fails, it will
only have a minimal impact on power consumption, and all USB device
drivers should still work properly. Therefore don't bother to return
any error codes.
Don't enable device-initiated LPM if the device is unconfigured. The
USB device will only accept the U1/U2_ENABLE control transfers in the
configured state. Do enable hub-initiated LPM in that case, since
devices are allowed to accept the LGO_Ux link commands in any state.
Don't enable or disable LPM if the device is marked as not being LPM
capable. This can happen if:
- the USB device doesn't have a SS BOS descriptor,
- the device's parent hub has a zeroed bHeaderDecodeLatency value, or
- the xHCI host doesn't support LPM.
Signed-off-by: Sarah Sharp <sarah.a.sharp@linux.intel.com>
Cc: Andiry Xu <andiry.xu@amd.com>
Cc: Alan Stern <stern@rowland.harvard.edu>
Signed-off-by: Sarah Sharp <sarah.a.sharp@linux.intel.com>
2012-04-25 08:21:50 +08:00
|
|
|
#define USB_PORT_LPM_TIMEOUT(p) (((p) & 0xff) << 8)
|
|
|
|
|
|
USB/xHCI: Enable USB 3.0 hub remote wakeup.
USB 3.0 hubs have a different remote wakeup policy than USB 2.0 hubs.
USB 2.0 hubs, once they have remote wakeup enabled, will always send
remote wakes when anything changes on a port.
However, USB 3.0 hubs have a per-port remote wake up policy that is off
by default. The Set Feature remote wake mask can be changed for any
port, enabling remote wakeup for a connect, disconnect, or overcurrent
event, much like EHCI and xHCI host controller "wake on" port status
bits. The bits are cleared to zero on the initial hub power on, or
after the hub has been reset.
Without this patch, when a USB 3.0 hub gets suspended, it will not send
a remote wakeup on device connect or disconnect. This would show up to
the user as "dead ports" unless they ran lsusb -v (since newer versions
of lsusb use the sysfs files, rather than sending control transfers).
Change the hub driver's suspend method to enable remote wake up for
disconnect, connect, and overcurrent for all ports on the hub. Modify
the xHCI driver's roothub code to handle that request, and set the "wake
on" bits in the port status registers accordingly.
Signed-off-by: Sarah Sharp <sarah.a.sharp@linux.intel.com>
2012-01-07 02:34:31 +08:00
|
|
|
/* USB 3.0 hub remote wake mask bits, see table 10-14 */
|
|
|
|
|
#define USB_PORT_FEAT_REMOTE_WAKE_CONNECT (1 << 8)
|
|
|
|
|
#define USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT (1 << 9)
|
|
|
|
|
#define USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT (1 << 10)
|
|
|
|
|
|
2008-01-31 07:21:33 +08:00
|
|
|
/*
|
2005-04-17 06:20:36 +08:00
|
|
|
* Hub Status and Hub Change results
|
|
|
|
|
* See USB 2.0 spec Table 11-19 and Table 11-20
|
|
|
|
|
*/
|
|
|
|
|
struct usb_port_status {
|
|
|
|
|
__le16 wPortStatus;
|
2008-01-31 07:21:33 +08:00
|
|
|
__le16 wPortChange;
|
2005-04-17 06:20:36 +08:00
|
|
|
} __attribute__ ((packed));
|
|
|
|
|
|
2008-01-31 07:21:33 +08:00
|
|
|
/*
|
2005-04-17 06:20:36 +08:00
|
|
|
* wPortStatus bit field
|
|
|
|
|
* See USB 2.0 spec Table 11-21
|
|
|
|
|
*/
|
|
|
|
|
#define USB_PORT_STAT_CONNECTION 0x0001
|
|
|
|
|
#define USB_PORT_STAT_ENABLE 0x0002
|
|
|
|
|
#define USB_PORT_STAT_SUSPEND 0x0004
|
|
|
|
|
#define USB_PORT_STAT_OVERCURRENT 0x0008
|
|
|
|
|
#define USB_PORT_STAT_RESET 0x0010
|
2008-02-11 04:24:00 +08:00
|
|
|
#define USB_PORT_STAT_L1 0x0020
|
|
|
|
|
/* bits 6 to 7 are reserved */
|
2005-04-17 06:20:36 +08:00
|
|
|
#define USB_PORT_STAT_POWER 0x0100
|
|
|
|
|
#define USB_PORT_STAT_LOW_SPEED 0x0200
|
|
|
|
|
#define USB_PORT_STAT_HIGH_SPEED 0x0400
|
|
|
|
|
#define USB_PORT_STAT_TEST 0x0800
|
|
|
|
|
#define USB_PORT_STAT_INDICATOR 0x1000
|
|
|
|
|
/* bits 13 to 15 are reserved */
|
|
|
|
|
|
2010-11-02 00:18:24 +08:00
|
|
|
/*
|
|
|
|
|
* Additions to wPortStatus bit field from USB 3.0
|
|
|
|
|
* See USB 3.0 spec Table 10-10
|
|
|
|
|
*/
|
|
|
|
|
#define USB_PORT_STAT_LINK_STATE 0x01e0
|
|
|
|
|
#define USB_SS_PORT_STAT_POWER 0x0200
|
2001-09-17 15:00:00 +08:00
|
|
|
#define USB_SS_PORT_STAT_SPEED 0x1c00
|
2010-11-02 00:18:24 +08:00
|
|
|
#define USB_PORT_STAT_SPEED_5GBPS 0x0000
|
|
|
|
|
/* Valid only if port is enabled */
|
2001-09-17 15:00:00 +08:00
|
|
|
/* Bits that are the same from USB 2.0 */
|
|
|
|
|
#define USB_SS_PORT_STAT_MASK (USB_PORT_STAT_CONNECTION | \
|
|
|
|
|
USB_PORT_STAT_ENABLE | \
|
|
|
|
|
USB_PORT_STAT_OVERCURRENT | \
|
|
|
|
|
USB_PORT_STAT_RESET)
|
2010-11-02 00:18:24 +08:00
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Definitions for PORT_LINK_STATE values
|
|
|
|
|
* (bits 5-8) in wPortStatus
|
|
|
|
|
*/
|
|
|
|
|
#define USB_SS_PORT_LS_U0 0x0000
|
|
|
|
|
#define USB_SS_PORT_LS_U1 0x0020
|
|
|
|
|
#define USB_SS_PORT_LS_U2 0x0040
|
|
|
|
|
#define USB_SS_PORT_LS_U3 0x0060
|
|
|
|
|
#define USB_SS_PORT_LS_SS_DISABLED 0x0080
|
|
|
|
|
#define USB_SS_PORT_LS_RX_DETECT 0x00a0
|
|
|
|
|
#define USB_SS_PORT_LS_SS_INACTIVE 0x00c0
|
|
|
|
|
#define USB_SS_PORT_LS_POLLING 0x00e0
|
|
|
|
|
#define USB_SS_PORT_LS_RECOVERY 0x0100
|
|
|
|
|
#define USB_SS_PORT_LS_HOT_RESET 0x0120
|
|
|
|
|
#define USB_SS_PORT_LS_COMP_MOD 0x0140
|
|
|
|
|
#define USB_SS_PORT_LS_LOOPBACK 0x0160
|
|
|
|
|
|
2008-01-31 07:21:33 +08:00
|
|
|
/*
|
2005-04-17 06:20:36 +08:00
|
|
|
* wPortChange bit field
|
2011-02-15 06:06:15 +08:00
|
|
|
* See USB 2.0 spec Table 11-22 and USB 2.0 LPM ECN Table-4.10
|
|
|
|
|
* Bits 0 to 5 shown, bits 6 to 15 are reserved
|
2005-04-17 06:20:36 +08:00
|
|
|
*/
|
|
|
|
|
#define USB_PORT_STAT_C_CONNECTION 0x0001
|
|
|
|
|
#define USB_PORT_STAT_C_ENABLE 0x0002
|
|
|
|
|
#define USB_PORT_STAT_C_SUSPEND 0x0004
|
|
|
|
|
#define USB_PORT_STAT_C_OVERCURRENT 0x0008
|
|
|
|
|
#define USB_PORT_STAT_C_RESET 0x0010
|
2008-02-11 04:24:00 +08:00
|
|
|
#define USB_PORT_STAT_C_L1 0x0020
|
2001-09-17 15:00:00 +08:00
|
|
|
/*
|
|
|
|
|
* USB 3.0 wPortChange bit fields
|
|
|
|
|
* See USB 3.0 spec Table 10-11
|
|
|
|
|
*/
|
|
|
|
|
#define USB_PORT_STAT_C_BH_RESET 0x0020
|
|
|
|
|
#define USB_PORT_STAT_C_LINK_STATE 0x0040
|
|
|
|
|
#define USB_PORT_STAT_C_CONFIG_ERROR 0x0080
|
2005-04-17 06:20:36 +08:00
|
|
|
|
|
|
|
|
/*
|
2008-01-31 07:21:33 +08:00
|
|
|
* wHubCharacteristics (masks)
|
2005-04-17 06:20:36 +08:00
|
|
|
* See USB 2.0 spec Table 11-13, offset 3
|
|
|
|
|
*/
|
2011-11-22 22:03:36 +08:00
|
|
|
#define HUB_CHAR_LPSM 0x0003 /* Logical Power Switching Mode mask */
|
|
|
|
|
#define HUB_CHAR_COMMON_LPSM 0x0000 /* All ports power control at once */
|
|
|
|
|
#define HUB_CHAR_INDV_PORT_LPSM 0x0001 /* per-port power control */
|
|
|
|
|
#define HUB_CHAR_NO_LPSM 0x0002 /* no power switching */
|
|
|
|
|
|
|
|
|
|
#define HUB_CHAR_COMPOUND 0x0004 /* hub is part of a compound device */
|
|
|
|
|
|
|
|
|
|
#define HUB_CHAR_OCPM 0x0018 /* Over-Current Protection Mode mask */
|
|
|
|
|
#define HUB_CHAR_COMMON_OCPM 0x0000 /* All ports Over-Current reporting */
|
|
|
|
|
#define HUB_CHAR_INDV_PORT_OCPM 0x0008 /* per-port Over-current reporting */
|
|
|
|
|
#define HUB_CHAR_NO_OCPM 0x0010 /* No Over-current Protection support */
|
|
|
|
|
|
|
|
|
|
#define HUB_CHAR_TTTT 0x0060 /* TT Think Time mask */
|
|
|
|
|
#define HUB_CHAR_PORTIND 0x0080 /* per-port indicators (LEDs) */
|
2005-04-17 06:20:36 +08:00
|
|
|
|
|
|
|
|
struct usb_hub_status {
|
|
|
|
|
__le16 wHubStatus;
|
|
|
|
|
__le16 wHubChange;
|
|
|
|
|
} __attribute__ ((packed));
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Hub Status & Hub Change bit masks
|
|
|
|
|
* See USB 2.0 spec Table 11-19 and Table 11-20
|
|
|
|
|
* Bits 0 and 1 for wHubStatus and wHubChange
|
|
|
|
|
* Bits 2 to 15 are reserved for both
|
|
|
|
|
*/
|
|
|
|
|
#define HUB_STATUS_LOCAL_POWER 0x0001
|
|
|
|
|
#define HUB_STATUS_OVERCURRENT 0x0002
|
|
|
|
|
#define HUB_CHANGE_LOCAL_POWER 0x0001
|
|
|
|
|
#define HUB_CHANGE_OVERCURRENT 0x0002
|
|
|
|
|
|
|
|
|
|
|
2008-01-31 07:21:33 +08:00
|
|
|
/*
|
|
|
|
|
* Hub descriptor
|
2005-04-17 06:20:36 +08:00
|
|
|
* See USB 2.0 spec Table 11-13
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#define USB_DT_HUB (USB_TYPE_CLASS | 0x09)
|
2001-09-17 15:00:00 +08:00
|
|
|
#define USB_DT_SS_HUB (USB_TYPE_CLASS | 0x0a)
|
2005-04-17 06:20:36 +08:00
|
|
|
#define USB_DT_HUB_NONVAR_SIZE 7
|
2001-09-17 15:00:00 +08:00
|
|
|
#define USB_DT_SS_HUB_SIZE 12
|
2005-04-17 06:20:36 +08:00
|
|
|
|
2011-12-08 14:35:22 +08:00
|
|
|
/*
|
|
|
|
|
* Hub Device descriptor
|
|
|
|
|
* USB Hub class device protocols
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#define USB_HUB_PR_FS 0 /* Full speed hub */
|
|
|
|
|
#define USB_HUB_PR_HS_NO_TT 0 /* Hi-speed hub without TT */
|
|
|
|
|
#define USB_HUB_PR_HS_SINGLE_TT 1 /* Hi-speed hub with single TT */
|
|
|
|
|
#define USB_HUB_PR_HS_MULTI_TT 2 /* Hi-speed hub with multiple TT */
|
|
|
|
|
#define USB_HUB_PR_SS 3 /* Super speed hub */
|
|
|
|
|
|
2005-04-17 06:20:36 +08:00
|
|
|
struct usb_hub_descriptor {
|
|
|
|
|
__u8 bDescLength;
|
|
|
|
|
__u8 bDescriptorType;
|
|
|
|
|
__u8 bNbrPorts;
|
2005-06-21 12:15:16 +08:00
|
|
|
__le16 wHubCharacteristics;
|
2005-04-17 06:20:36 +08:00
|
|
|
__u8 bPwrOn2PwrGood;
|
|
|
|
|
__u8 bHubContrCurrent;
|
|
|
|
|
|
2001-09-17 15:00:00 +08:00
|
|
|
/* 2.0 and 3.0 hubs differ here */
|
|
|
|
|
union {
|
|
|
|
|
struct {
|
|
|
|
|
/* add 1 bit for hub status change; round to bytes */
|
|
|
|
|
__u8 DeviceRemovable[(USB_MAXCHILDREN + 1 + 7) / 8];
|
|
|
|
|
__u8 PortPwrCtrlMask[(USB_MAXCHILDREN + 1 + 7) / 8];
|
|
|
|
|
} __attribute__ ((packed)) hs;
|
|
|
|
|
|
|
|
|
|
struct {
|
|
|
|
|
__u8 bHubHdrDecLat;
|
2012-09-10 21:24:41 +08:00
|
|
|
__le16 wHubDelay;
|
|
|
|
|
__le16 DeviceRemovable;
|
2001-09-17 15:00:00 +08:00
|
|
|
} __attribute__ ((packed)) ss;
|
|
|
|
|
} u;
|
|
|
|
|
} __attribute__ ((packed));
|
2005-04-17 06:20:36 +08:00
|
|
|
|
|
|
|
|
/* port indicator status selectors, tables 11-7 and 11-25 */
|
|
|
|
|
#define HUB_LED_AUTO 0
|
|
|
|
|
#define HUB_LED_AMBER 1
|
|
|
|
|
#define HUB_LED_GREEN 2
|
|
|
|
|
#define HUB_LED_OFF 3
|
|
|
|
|
|
|
|
|
|
enum hub_led_mode {
|
|
|
|
|
INDICATOR_AUTO = 0,
|
|
|
|
|
INDICATOR_CYCLE,
|
|
|
|
|
/* software blinks for attention: software, hardware, reserved */
|
|
|
|
|
INDICATOR_GREEN_BLINK, INDICATOR_GREEN_BLINK_OFF,
|
|
|
|
|
INDICATOR_AMBER_BLINK, INDICATOR_AMBER_BLINK_OFF,
|
|
|
|
|
INDICATOR_ALT_BLINK, INDICATOR_ALT_BLINK_OFF
|
|
|
|
|
} __attribute__ ((packed));
|
|
|
|
|
|
2005-08-14 09:41:04 +08:00
|
|
|
/* Transaction Translator Think Times, in bits */
|
|
|
|
|
#define HUB_TTTT_8_BITS 0x00
|
|
|
|
|
#define HUB_TTTT_16_BITS 0x20
|
|
|
|
|
#define HUB_TTTT_24_BITS 0x40
|
|
|
|
|
#define HUB_TTTT_32_BITS 0x60
|
|
|
|
|
|
2010-05-01 00:42:23 +08:00
|
|
|
#endif /* __LINUX_CH11_H */
|