2 * This file holds Hub protocol constants and data structures that are
3 * defined in chapter 11 (Hub Specification) of the USB 2.0 specification.
5 * It is used/shared between the USB core, the HCDs and couple of other USB
10 #define __LINUX_CH11_H
12 #include <linux/types.h> /* __u8 etc */
18 #define USB_RT_HUB (USB_TYPE_CLASS | USB_RECIP_DEVICE)
19 #define USB_RT_PORT (USB_TYPE_CLASS | USB_RECIP_OTHER)
23 * See USB 2.0 spec Table 11-16
25 #define HUB_CLEAR_TT_BUFFER 8
26 #define HUB_RESET_TT 9
27 #define HUB_GET_TT_STATE 10
28 #define HUB_STOP_TT 11
29 #define HUB_SET_DEPTH 12
32 * Hub class additional requests defined by USB 3.0 spec
33 * See USB 3.0 spec Table 10-6
35 #define HUB_SET_DEPTH 12
36 #define HUB_GET_PORT_ERR_COUNT 13
39 * Hub Class feature numbers
40 * See USB 2.0 spec Table 11-17
42 #define C_HUB_LOCAL_POWER 0
43 #define C_HUB_OVER_CURRENT 1
46 * Port feature numbers
47 * See USB 2.0 spec Table 11-17
49 #define USB_PORT_FEAT_CONNECTION 0
50 #define USB_PORT_FEAT_ENABLE 1
51 #define USB_PORT_FEAT_SUSPEND 2 /* L2 suspend */
52 #define USB_PORT_FEAT_OVER_CURRENT 3
53 #define USB_PORT_FEAT_RESET 4
54 #define USB_PORT_FEAT_L1 5 /* L1 suspend */
55 #define USB_PORT_FEAT_POWER 8
56 #define USB_PORT_FEAT_LOWSPEED 9 /* Should never be used */
57 #define USB_PORT_FEAT_C_CONNECTION 16
58 #define USB_PORT_FEAT_C_ENABLE 17
59 #define USB_PORT_FEAT_C_SUSPEND 18
60 #define USB_PORT_FEAT_C_OVER_CURRENT 19
61 #define USB_PORT_FEAT_C_RESET 20
62 #define USB_PORT_FEAT_TEST 21
63 #define USB_PORT_FEAT_INDICATOR 22
64 #define USB_PORT_FEAT_C_PORT_L1 23
65 #define USB_PORT_FEAT_C_PORT_LINK_STATE 25
66 #define USB_PORT_FEAT_C_PORT_CONFIG_ERROR 26
67 #define USB_PORT_FEAT_PORT_REMOTE_WAKE_MASK 27
68 #define USB_PORT_FEAT_BH_PORT_RESET 28
69 #define USB_PORT_FEAT_C_BH_PORT_RESET 29
70 #define USB_PORT_FEAT_FORCE_LINKPM_ACCEPT 30
73 * Port feature selectors added by USB 3.0 spec.
74 * See USB 3.0 spec Table 10-7
76 #define USB_PORT_FEAT_LINK_STATE 5
77 #define USB_PORT_FEAT_U1_TIMEOUT 23
78 #define USB_PORT_FEAT_U2_TIMEOUT 24
79 #define USB_PORT_FEAT_C_LINK_STATE 25
80 #define USB_PORT_FEAT_C_CONFIG_ERR 26
81 #define USB_PORT_FEAT_REMOTE_WAKE_MASK 27
82 #define USB_PORT_FEAT_BH_PORT_RESET 28
83 #define USB_PORT_FEAT_C_BH_PORT_RESET 29
84 #define USB_PORT_FEAT_FORCE_LINKPM_ACCEPT 30
87 * Hub Status and Hub Change results
88 * See USB 2.0 spec Table 11-19 and Table 11-20
90 struct usb_port_status {
93 } __attribute__ ((packed));
96 * wPortStatus bit field
97 * See USB 2.0 spec Table 11-21
99 #define USB_PORT_STAT_CONNECTION 0x0001
100 #define USB_PORT_STAT_ENABLE 0x0002
101 #define USB_PORT_STAT_SUSPEND 0x0004
102 #define USB_PORT_STAT_OVERCURRENT 0x0008
103 #define USB_PORT_STAT_RESET 0x0010
104 #define USB_PORT_STAT_L1 0x0020
105 /* bits 6 to 7 are reserved */
106 #define USB_PORT_STAT_POWER 0x0100
107 #define USB_PORT_STAT_LOW_SPEED 0x0200
108 #define USB_PORT_STAT_HIGH_SPEED 0x0400
109 #define USB_PORT_STAT_TEST 0x0800
110 #define USB_PORT_STAT_INDICATOR 0x1000
111 /* bits 13 to 15 are reserved */
112 #define USB_PORT_STAT_SUPER_SPEED 0x8000 /* Linux-internal */
115 * Additions to wPortStatus bit field from USB 3.0
116 * See USB 3.0 spec Table 10-10
118 #define USB_PORT_STAT_LINK_STATE 0x01e0
119 #define USB_SS_PORT_STAT_POWER 0x0200
120 #define USB_SS_PORT_STAT_SPEED 0x1c00
121 #define USB_PORT_STAT_SPEED_5GBPS 0x0000
122 /* Valid only if port is enabled */
123 /* Bits that are the same from USB 2.0 */
124 #define USB_SS_PORT_STAT_MASK (USB_PORT_STAT_CONNECTION | \
125 USB_PORT_STAT_ENABLE | \
126 USB_PORT_STAT_OVERCURRENT | \
130 * Definitions for PORT_LINK_STATE values
131 * (bits 5-8) in wPortStatus
133 #define USB_SS_PORT_LS_U0 0x0000
134 #define USB_SS_PORT_LS_U1 0x0020
135 #define USB_SS_PORT_LS_U2 0x0040
136 #define USB_SS_PORT_LS_U3 0x0060
137 #define USB_SS_PORT_LS_SS_DISABLED 0x0080
138 #define USB_SS_PORT_LS_RX_DETECT 0x00a0
139 #define USB_SS_PORT_LS_SS_INACTIVE 0x00c0
140 #define USB_SS_PORT_LS_POLLING 0x00e0
141 #define USB_SS_PORT_LS_RECOVERY 0x0100
142 #define USB_SS_PORT_LS_HOT_RESET 0x0120
143 #define USB_SS_PORT_LS_COMP_MOD 0x0140
144 #define USB_SS_PORT_LS_LOOPBACK 0x0160
147 * wPortChange bit field
148 * See USB 2.0 spec Table 11-22 and USB 2.0 LPM ECN Table-4.10
149 * Bits 0 to 5 shown, bits 6 to 15 are reserved
151 #define USB_PORT_STAT_C_CONNECTION 0x0001
152 #define USB_PORT_STAT_C_ENABLE 0x0002
153 #define USB_PORT_STAT_C_SUSPEND 0x0004
154 #define USB_PORT_STAT_C_OVERCURRENT 0x0008
155 #define USB_PORT_STAT_C_RESET 0x0010
156 #define USB_PORT_STAT_C_L1 0x0020
158 * USB 3.0 wPortChange bit fields
159 * See USB 3.0 spec Table 10-11
161 #define USB_PORT_STAT_C_BH_RESET 0x0020
162 #define USB_PORT_STAT_C_LINK_STATE 0x0040
163 #define USB_PORT_STAT_C_CONFIG_ERROR 0x0080
166 * wHubCharacteristics (masks)
167 * See USB 2.0 spec Table 11-13, offset 3
169 #define HUB_CHAR_LPSM 0x0003 /* D1 .. D0 */
170 #define HUB_CHAR_COMPOUND 0x0004 /* D2 */
171 #define HUB_CHAR_OCPM 0x0018 /* D4 .. D3 */
172 #define HUB_CHAR_TTTT 0x0060 /* D6 .. D5 */
173 #define HUB_CHAR_PORTIND 0x0080 /* D7 */
175 struct usb_hub_status {
178 } __attribute__ ((packed));
181 * Hub Status & Hub Change bit masks
182 * See USB 2.0 spec Table 11-19 and Table 11-20
183 * Bits 0 and 1 for wHubStatus and wHubChange
184 * Bits 2 to 15 are reserved for both
186 #define HUB_STATUS_LOCAL_POWER 0x0001
187 #define HUB_STATUS_OVERCURRENT 0x0002
188 #define HUB_CHANGE_LOCAL_POWER 0x0001
189 #define HUB_CHANGE_OVERCURRENT 0x0002
194 * See USB 2.0 spec Table 11-13
197 #define USB_DT_HUB (USB_TYPE_CLASS | 0x09)
198 #define USB_DT_SS_HUB (USB_TYPE_CLASS | 0x0a)
199 #define USB_DT_HUB_NONVAR_SIZE 7
200 #define USB_DT_SS_HUB_SIZE 12
202 struct usb_hub_descriptor {
204 __u8 bDescriptorType;
206 __le16 wHubCharacteristics;
208 __u8 bHubContrCurrent;
210 /* 2.0 and 3.0 hubs differ here */
213 /* add 1 bit for hub status change; round to bytes */
214 __u8 DeviceRemovable[(USB_MAXCHILDREN + 1 + 7) / 8];
215 __u8 PortPwrCtrlMask[(USB_MAXCHILDREN + 1 + 7) / 8];
216 } __attribute__ ((packed)) hs;
221 __u16 DeviceRemovable;
222 } __attribute__ ((packed)) ss;
224 } __attribute__ ((packed));
226 /* port indicator status selectors, tables 11-7 and 11-25 */
227 #define HUB_LED_AUTO 0
228 #define HUB_LED_AMBER 1
229 #define HUB_LED_GREEN 2
230 #define HUB_LED_OFF 3
235 /* software blinks for attention: software, hardware, reserved */
236 INDICATOR_GREEN_BLINK, INDICATOR_GREEN_BLINK_OFF,
237 INDICATOR_AMBER_BLINK, INDICATOR_AMBER_BLINK_OFF,
238 INDICATOR_ALT_BLINK, INDICATOR_ALT_BLINK_OFF
239 } __attribute__ ((packed));
241 /* Transaction Translator Think Times, in bits */
242 #define HUB_TTTT_8_BITS 0x00
243 #define HUB_TTTT_16_BITS 0x20
244 #define HUB_TTTT_24_BITS 0x40
245 #define HUB_TTTT_32_BITS 0x60
247 #endif /* __LINUX_CH11_H */