1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
|
#ifndef _USBHUB_H
#define _USBHUB_H
/** @file
*
* USB hubs
*
*/
FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
#include <ipxe/usb.h>
#include <ipxe/list.h>
#include <ipxe/process.h>
/** Request recipient is a port */
#define USB_HUB_RECIP_PORT ( 3 << 0 )
/** A basic USB hub descriptor */
struct usb_hub_descriptor_basic {
/** Descriptor header */
struct usb_descriptor_header header;
/** Number of ports */
uint8_t ports;
/** Characteristics */
uint16_t characteristics;
/** Power-on delay (in 2ms intervals */
uint8_t delay;
/** Controller current (in mA) */
uint8_t current;
} __attribute__ (( packed ));
/** A basic USB hub descriptor */
#define USB_HUB_DESCRIPTOR 41
/** An enhanced USB hub descriptor */
struct usb_hub_descriptor_enhanced {
/** Basic USB hub descriptor */
struct usb_hub_descriptor_basic basic;
/** Header decode latency */
uint8_t latency;
/** Maximum delay */
uint16_t delay;
/** Removable device bitmask */
uint16_t removable;
} __attribute__ (( packed ));
/** An enhanced USB hub descriptor */
#define USB_HUB_DESCRIPTOR_ENHANCED 42
/** A USB hub descriptor */
union usb_hub_descriptor {
/** Descriptor header */
struct usb_descriptor_header header;
/** Basic hub descriptor */
struct usb_hub_descriptor_basic basic;
/** Enhanced hub descriptor */
struct usb_hub_descriptor_enhanced enhanced;
} __attribute__ (( packed ));
/** Port status */
struct usb_hub_port_status {
/** Current status */
uint16_t current;
/** Changed status */
uint16_t changed;
} __attribute__ (( packed ));
/** Current connect status feature */
#define USB_HUB_PORT_CONNECTION 0
/** Port enabled/disabled feature */
#define USB_HUB_PORT_ENABLE 1
/** Port reset feature */
#define USB_HUB_PORT_RESET 4
/** Port power feature */
#define USB_HUB_PORT_POWER 8
/** Low-speed device attached */
#define USB_HUB_PORT_LOW_SPEED 9
/** High-speed device attached */
#define USB_HUB_PORT_HIGH_SPEED 10
/** Connect status changed */
#define USB_HUB_C_PORT_CONNECTION 16
/** Port enable/disable changed */
#define USB_HUB_C_PORT_ENABLE 17
/** Suspend changed */
#define USB_HUB_C_PORT_SUSPEND 18
/** Over-current indicator changed */
#define USB_HUB_C_PORT_OVER_CURRENT 19
/** Reset changed */
#define USB_HUB_C_PORT_RESET 20
/** Link state changed */
#define USB_HUB_C_PORT_LINK_STATE 25
/** Configuration error */
#define USB_HUB_C_PORT_CONFIG_ERROR 26
/** Calculate feature from change bit number */
#define USB_HUB_C_FEATURE( bit ) ( 16 + (bit) )
/** USB features */
#define USB_HUB_FEATURES \
( ( 1 << USB_HUB_C_PORT_CONNECTION ) | \
( 1 << USB_HUB_C_PORT_ENABLE ) | \
( 1 << USB_HUB_C_PORT_SUSPEND ) | \
( 1 << USB_HUB_C_PORT_OVER_CURRENT ) | \
( 1 << USB_HUB_C_PORT_RESET ) )
/** USB features for enhanced hubs */
#define USB_HUB_FEATURES_ENHANCED \
( ( 1 << USB_HUB_C_PORT_CONNECTION ) | \
( 1 << USB_HUB_C_PORT_OVER_CURRENT ) | \
( 1 << USB_HUB_C_PORT_RESET ) | \
( 1 << USB_HUB_C_PORT_LINK_STATE ) | \
( 1 << USB_HUB_C_PORT_CONFIG_ERROR ) )
/** Set hub depth */
#define USB_HUB_SET_HUB_DEPTH \
( USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_DEVICE | \
USB_REQUEST_TYPE ( 12 ) )
/** Clear transaction translator buffer */
#define USB_HUB_CLEAR_TT_BUFFER \
( USB_DIR_OUT | USB_TYPE_CLASS | USB_HUB_RECIP_PORT | \
USB_REQUEST_TYPE ( 8 ) )
/**
* Get hub descriptor
*
* @v usb USB device
* @v enhanced Hub is an enhanced hub
* @v data Hub descriptor to fill in
* @ret rc Return status code
*/
static inline __attribute__ (( always_inline )) int
usb_hub_get_descriptor ( struct usb_device *usb, int enhanced,
union usb_hub_descriptor *data ) {
unsigned int desc;
size_t len;
/* Determine descriptor type and length */
desc = ( enhanced ? USB_HUB_DESCRIPTOR_ENHANCED : USB_HUB_DESCRIPTOR );
len = ( enhanced ? sizeof ( data->enhanced ) : sizeof ( data->basic ) );
return usb_get_descriptor ( usb, USB_TYPE_CLASS, desc, 0, 0,
&data->header, len );
}
/**
* Get port status
*
* @v usb USB device
* @v port Port address
* @v status Port status descriptor to fill in
* @ret rc Return status code
*/
static inline __attribute__ (( always_inline )) int
usb_hub_get_port_status ( struct usb_device *usb, unsigned int port,
struct usb_hub_port_status *status ) {
return usb_get_status ( usb, ( USB_TYPE_CLASS | USB_HUB_RECIP_PORT ),
port, status, sizeof ( *status ) );
}
/**
* Clear port feature
*
* @v usb USB device
* @v port Port address
* @v feature Feature to clear
* @v index Index (when clearing a port indicator)
* @ret rc Return status code
*/
static inline __attribute__ (( always_inline )) int
usb_hub_clear_port_feature ( struct usb_device *usb, unsigned int port,
unsigned int feature, unsigned int index ) {
return usb_clear_feature ( usb, ( USB_TYPE_CLASS | USB_HUB_RECIP_PORT ),
feature, ( ( index << 8 ) | port ) );
}
/**
* Set port feature
*
* @v usb USB device
* @v port Port address
* @v feature Feature to clear
* @v index Index (when clearing a port indicator)
* @ret rc Return status code
*/
static inline __attribute__ (( always_inline )) int
usb_hub_set_port_feature ( struct usb_device *usb, unsigned int port,
unsigned int feature, unsigned int index ) {
return usb_set_feature ( usb, ( USB_TYPE_CLASS | USB_HUB_RECIP_PORT ),
feature, ( ( index << 8 ) | port ) );
}
/**
* Set hub depth
*
* @v usb USB device
* @v depth Hub depth
* @ret rc Return status code
*/
static inline __attribute__ (( always_inline )) int
usb_hub_set_hub_depth ( struct usb_device *usb, unsigned int depth ) {
return usb_control ( usb, USB_HUB_SET_HUB_DEPTH, depth, 0, NULL, 0 );
}
/**
* Clear transaction translator buffer
*
* @v usb USB device
* @v device Device address
* @v endpoint Endpoint address
* @v attributes Endpoint attributes
* @v tt_port Transaction translator port (or 1 for single-TT hubs)
* @ret rc Return status code
*/
static inline __attribute__ (( always_inline )) int
usb_hub_clear_tt_buffer ( struct usb_device *usb, unsigned int device,
unsigned int endpoint, unsigned int attributes,
unsigned int tt_port ) {
unsigned int value;
/* Calculate value */
value = ( ( ( endpoint & USB_ENDPOINT_MAX ) << 0 ) | ( device << 4 ) |
( ( attributes & USB_ENDPOINT_ATTR_TYPE_MASK ) << 11 ) |
( ( endpoint & USB_ENDPOINT_IN ) << 8 ) );
return usb_control ( usb, USB_HUB_CLEAR_TT_BUFFER, value,
tt_port, NULL, 0 );
}
/** Transaction translator port value for single-TT hubs */
#define USB_HUB_TT_SINGLE 1
/** A USB hub device */
struct usb_hub_device {
/** Name */
const char *name;
/** USB device */
struct usb_device *usb;
/** USB hub */
struct usb_hub *hub;
/** Features */
unsigned int features;
/** Flags */
unsigned int flags;
/** Interrupt endpoint */
struct usb_endpoint intr;
/** Interrupt endpoint refill process */
struct process refill;
};
/** Hub requires additional settling delay */
#define USB_HUB_SLOW_START 0x0001
/** Additional setting delay for out-of-spec hubs */
#define USB_HUB_SLOW_START_DELAY_MS 500
/** Interrupt ring fill level
*
* This is a policy decision.
*/
#define USB_HUB_INTR_FILL 4
/** Maximum time to wait for port to become enabled
*
* This is a policy decision.
*/
#define USB_HUB_ENABLE_MAX_WAIT_MS 100
#endif /* _USBHUB_H */
|
