diff options
author | Jonathan Herman <hermanjl@cs.unc.edu> | 2013-01-22 10:38:37 -0500 |
---|---|---|
committer | Jonathan Herman <hermanjl@cs.unc.edu> | 2013-01-22 10:38:37 -0500 |
commit | fcc9d2e5a6c89d22b8b773a64fb4ad21ac318446 (patch) | |
tree | a57612d1888735a2ec7972891b68c1ac5ec8faea /include/linux/usb/ch11.h | |
parent | 8dea78da5cee153b8af9c07a2745f6c55057fe12 (diff) |
Diffstat (limited to 'include/linux/usb/ch11.h')
-rw-r--r-- | include/linux/usb/ch11.h | 246 |
1 files changed, 246 insertions, 0 deletions
diff --git a/include/linux/usb/ch11.h b/include/linux/usb/ch11.h new file mode 100644 index 00000000000..4ebaf082417 --- /dev/null +++ b/include/linux/usb/ch11.h | |||
@@ -0,0 +1,246 @@ | |||
1 | /* | ||
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. | ||
4 | * | ||
5 | * It is used/shared between the USB core, the HCDs and couple of other USB | ||
6 | * drivers. | ||
7 | */ | ||
8 | |||
9 | #ifndef __LINUX_CH11_H | ||
10 | #define __LINUX_CH11_H | ||
11 | |||
12 | #include <linux/types.h> /* __u8 etc */ | ||
13 | |||
14 | /* | ||
15 | * Hub request types | ||
16 | */ | ||
17 | |||
18 | #define USB_RT_HUB (USB_TYPE_CLASS | USB_RECIP_DEVICE) | ||
19 | #define USB_RT_PORT (USB_TYPE_CLASS | USB_RECIP_OTHER) | ||
20 | |||
21 | /* | ||
22 | * Hub class requests | ||
23 | * See USB 2.0 spec Table 11-16 | ||
24 | */ | ||
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 | ||
30 | |||
31 | /* | ||
32 | * Hub class additional requests defined by USB 3.0 spec | ||
33 | * See USB 3.0 spec Table 10-6 | ||
34 | */ | ||
35 | #define HUB_SET_DEPTH 12 | ||
36 | #define HUB_GET_PORT_ERR_COUNT 13 | ||
37 | |||
38 | /* | ||
39 | * Hub Class feature numbers | ||
40 | * See USB 2.0 spec Table 11-17 | ||
41 | */ | ||
42 | #define C_HUB_LOCAL_POWER 0 | ||
43 | #define C_HUB_OVER_CURRENT 1 | ||
44 | |||
45 | /* | ||
46 | * Port feature numbers | ||
47 | * See USB 2.0 spec Table 11-17 | ||
48 | */ | ||
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 | ||
71 | |||
72 | /* | ||
73 | * Port feature selectors added by USB 3.0 spec. | ||
74 | * See USB 3.0 spec Table 10-7 | ||
75 | */ | ||
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 | ||
85 | |||
86 | /* | ||
87 | * Hub Status and Hub Change results | ||
88 | * See USB 2.0 spec Table 11-19 and Table 11-20 | ||
89 | */ | ||
90 | struct usb_port_status { | ||
91 | __le16 wPortStatus; | ||
92 | __le16 wPortChange; | ||
93 | } __attribute__ ((packed)); | ||
94 | |||
95 | /* | ||
96 | * wPortStatus bit field | ||
97 | * See USB 2.0 spec Table 11-21 | ||
98 | */ | ||
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 | |||
113 | /* | ||
114 | * Additions to wPortStatus bit field from USB 3.0 | ||
115 | * See USB 3.0 spec Table 10-10 | ||
116 | */ | ||
117 | #define USB_PORT_STAT_LINK_STATE 0x01e0 | ||
118 | #define USB_SS_PORT_STAT_POWER 0x0200 | ||
119 | #define USB_SS_PORT_STAT_SPEED 0x1c00 | ||
120 | #define USB_PORT_STAT_SPEED_5GBPS 0x0000 | ||
121 | /* Valid only if port is enabled */ | ||
122 | /* Bits that are the same from USB 2.0 */ | ||
123 | #define USB_SS_PORT_STAT_MASK (USB_PORT_STAT_CONNECTION | \ | ||
124 | USB_PORT_STAT_ENABLE | \ | ||
125 | USB_PORT_STAT_OVERCURRENT | \ | ||
126 | USB_PORT_STAT_RESET) | ||
127 | |||
128 | /* | ||
129 | * Definitions for PORT_LINK_STATE values | ||
130 | * (bits 5-8) in wPortStatus | ||
131 | */ | ||
132 | #define USB_SS_PORT_LS_U0 0x0000 | ||
133 | #define USB_SS_PORT_LS_U1 0x0020 | ||
134 | #define USB_SS_PORT_LS_U2 0x0040 | ||
135 | #define USB_SS_PORT_LS_U3 0x0060 | ||
136 | #define USB_SS_PORT_LS_SS_DISABLED 0x0080 | ||
137 | #define USB_SS_PORT_LS_RX_DETECT 0x00a0 | ||
138 | #define USB_SS_PORT_LS_SS_INACTIVE 0x00c0 | ||
139 | #define USB_SS_PORT_LS_POLLING 0x00e0 | ||
140 | #define USB_SS_PORT_LS_RECOVERY 0x0100 | ||
141 | #define USB_SS_PORT_LS_HOT_RESET 0x0120 | ||
142 | #define USB_SS_PORT_LS_COMP_MOD 0x0140 | ||
143 | #define USB_SS_PORT_LS_LOOPBACK 0x0160 | ||
144 | |||
145 | /* | ||
146 | * wPortChange bit field | ||
147 | * See USB 2.0 spec Table 11-22 and USB 2.0 LPM ECN Table-4.10 | ||
148 | * Bits 0 to 5 shown, bits 6 to 15 are reserved | ||
149 | */ | ||
150 | #define USB_PORT_STAT_C_CONNECTION 0x0001 | ||
151 | #define USB_PORT_STAT_C_ENABLE 0x0002 | ||
152 | #define USB_PORT_STAT_C_SUSPEND 0x0004 | ||
153 | #define USB_PORT_STAT_C_OVERCURRENT 0x0008 | ||
154 | #define USB_PORT_STAT_C_RESET 0x0010 | ||
155 | #define USB_PORT_STAT_C_L1 0x0020 | ||
156 | /* | ||
157 | * USB 3.0 wPortChange bit fields | ||
158 | * See USB 3.0 spec Table 10-11 | ||
159 | */ | ||
160 | #define USB_PORT_STAT_C_BH_RESET 0x0020 | ||
161 | #define USB_PORT_STAT_C_LINK_STATE 0x0040 | ||
162 | #define USB_PORT_STAT_C_CONFIG_ERROR 0x0080 | ||
163 | |||
164 | /* | ||
165 | * wHubCharacteristics (masks) | ||
166 | * See USB 2.0 spec Table 11-13, offset 3 | ||
167 | */ | ||
168 | #define HUB_CHAR_LPSM 0x0003 /* D1 .. D0 */ | ||
169 | #define HUB_CHAR_COMPOUND 0x0004 /* D2 */ | ||
170 | #define HUB_CHAR_OCPM 0x0018 /* D4 .. D3 */ | ||
171 | #define HUB_CHAR_TTTT 0x0060 /* D6 .. D5 */ | ||
172 | #define HUB_CHAR_PORTIND 0x0080 /* D7 */ | ||
173 | |||
174 | struct usb_hub_status { | ||
175 | __le16 wHubStatus; | ||
176 | __le16 wHubChange; | ||
177 | } __attribute__ ((packed)); | ||
178 | |||
179 | /* | ||
180 | * Hub Status & Hub Change bit masks | ||
181 | * See USB 2.0 spec Table 11-19 and Table 11-20 | ||
182 | * Bits 0 and 1 for wHubStatus and wHubChange | ||
183 | * Bits 2 to 15 are reserved for both | ||
184 | */ | ||
185 | #define HUB_STATUS_LOCAL_POWER 0x0001 | ||
186 | #define HUB_STATUS_OVERCURRENT 0x0002 | ||
187 | #define HUB_CHANGE_LOCAL_POWER 0x0001 | ||
188 | #define HUB_CHANGE_OVERCURRENT 0x0002 | ||
189 | |||
190 | |||
191 | /* | ||
192 | * Hub descriptor | ||
193 | * See USB 2.0 spec Table 11-13 | ||
194 | */ | ||
195 | |||
196 | #define USB_DT_HUB (USB_TYPE_CLASS | 0x09) | ||
197 | #define USB_DT_SS_HUB (USB_TYPE_CLASS | 0x0a) | ||
198 | #define USB_DT_HUB_NONVAR_SIZE 7 | ||
199 | #define USB_DT_SS_HUB_SIZE 12 | ||
200 | |||
201 | struct usb_hub_descriptor { | ||
202 | __u8 bDescLength; | ||
203 | __u8 bDescriptorType; | ||
204 | __u8 bNbrPorts; | ||
205 | __le16 wHubCharacteristics; | ||
206 | __u8 bPwrOn2PwrGood; | ||
207 | __u8 bHubContrCurrent; | ||
208 | |||
209 | /* 2.0 and 3.0 hubs differ here */ | ||
210 | union { | ||
211 | struct { | ||
212 | /* add 1 bit for hub status change; round to bytes */ | ||
213 | __u8 DeviceRemovable[(USB_MAXCHILDREN + 1 + 7) / 8]; | ||
214 | __u8 PortPwrCtrlMask[(USB_MAXCHILDREN + 1 + 7) / 8]; | ||
215 | } __attribute__ ((packed)) hs; | ||
216 | |||
217 | struct { | ||
218 | __u8 bHubHdrDecLat; | ||
219 | __u16 wHubDelay; | ||
220 | __u16 DeviceRemovable; | ||
221 | } __attribute__ ((packed)) ss; | ||
222 | } u; | ||
223 | } __attribute__ ((packed)); | ||
224 | |||
225 | /* port indicator status selectors, tables 11-7 and 11-25 */ | ||
226 | #define HUB_LED_AUTO 0 | ||
227 | #define HUB_LED_AMBER 1 | ||
228 | #define HUB_LED_GREEN 2 | ||
229 | #define HUB_LED_OFF 3 | ||
230 | |||
231 | enum hub_led_mode { | ||
232 | INDICATOR_AUTO = 0, | ||
233 | INDICATOR_CYCLE, | ||
234 | /* software blinks for attention: software, hardware, reserved */ | ||
235 | INDICATOR_GREEN_BLINK, INDICATOR_GREEN_BLINK_OFF, | ||
236 | INDICATOR_AMBER_BLINK, INDICATOR_AMBER_BLINK_OFF, | ||
237 | INDICATOR_ALT_BLINK, INDICATOR_ALT_BLINK_OFF | ||
238 | } __attribute__ ((packed)); | ||
239 | |||
240 | /* Transaction Translator Think Times, in bits */ | ||
241 | #define HUB_TTTT_8_BITS 0x00 | ||
242 | #define HUB_TTTT_16_BITS 0x20 | ||
243 | #define HUB_TTTT_24_BITS 0x40 | ||
244 | #define HUB_TTTT_32_BITS 0x60 | ||
245 | |||
246 | #endif /* __LINUX_CH11_H */ | ||