]>
Commit | Line | Data |
---|---|---|
e237e7ae | 1 | /** @file\r |
2 | \r | |
8616fc4c | 3 | Unified interface for RootHub and Hub.\r |
4 | \r | |
cd5ebaa0 HT |
5 | Copyright (c) 2007 - 2009, Intel Corporation. All rights reserved.<BR> \r |
6 | This program and the accompanying materials\r | |
e237e7ae | 7 | are licensed and made available under the terms and conditions of the BSD License\r |
8 | which accompanies this distribution. The full text of the license may be found at\r | |
9 | http://opensource.org/licenses/bsd-license.php\r | |
10 | \r | |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
13 | \r | |
e237e7ae | 14 | **/\r |
15 | \r | |
16 | #include "UsbBus.h"\r | |
17 | \r | |
aa79b0b3 | 18 | //\r |
19 | // Array that maps the change bit to feature value which is\r | |
20 | // used to clear these change bit. USB HUB API will clear\r | |
21 | // these change bit automatically. For non-root hub, these\r | |
22 | // bits determine whether hub will report the port in changed\r | |
23 | // bit maps.\r | |
24 | //\r | |
25 | #define USB_HUB_MAP_SIZE 5\r | |
26 | \r | |
27 | USB_CHANGE_FEATURE_MAP mHubFeatureMap[USB_HUB_MAP_SIZE] = {\r | |
28 | {USB_PORT_STAT_C_CONNECTION, EfiUsbPortConnectChange},\r | |
29 | {USB_PORT_STAT_C_ENABLE, EfiUsbPortEnableChange},\r | |
30 | {USB_PORT_STAT_C_SUSPEND, EfiUsbPortSuspendChange},\r | |
31 | {USB_PORT_STAT_C_OVERCURRENT, EfiUsbPortOverCurrentChange},\r | |
32 | {USB_PORT_STAT_C_RESET, EfiUsbPortResetChange},\r | |
33 | };\r | |
34 | \r | |
35 | #define USB_ROOT_HUB_MAP_SIZE 5\r | |
36 | \r | |
37 | USB_CHANGE_FEATURE_MAP mRootHubFeatureMap[USB_ROOT_HUB_MAP_SIZE] = {\r | |
38 | {USB_PORT_STAT_C_CONNECTION, EfiUsbPortConnectChange},\r | |
39 | {USB_PORT_STAT_C_ENABLE, EfiUsbPortEnableChange},\r | |
40 | {USB_PORT_STAT_C_SUSPEND, EfiUsbPortSuspendChange},\r | |
41 | {USB_PORT_STAT_C_OVERCURRENT, EfiUsbPortOverCurrentChange},\r | |
42 | {USB_PORT_STAT_C_RESET, EfiUsbPortResetChange},\r | |
43 | };\r | |
44 | \r | |
e237e7ae | 45 | //\r |
46 | // USB hub class specific requests. Although USB hub\r | |
47 | // is related to an interface, these requests are sent\r | |
48 | // to the control endpoint of the device.\r | |
49 | //\r | |
50 | \r | |
51 | \r | |
52 | /**\r | |
8616fc4c | 53 | USB hub control transfer to clear the hub feature.\r |
e237e7ae | 54 | \r |
8616fc4c | 55 | @param HubDev The device of the hub.\r |
56 | @param Feature The feature to clear.\r | |
e237e7ae | 57 | \r |
8616fc4c | 58 | @retval EFI_SUCCESS Feature of the hub is cleared.\r |
59 | @retval Others Failed to clear the feature.\r | |
e237e7ae | 60 | \r |
61 | **/\r | |
e237e7ae | 62 | EFI_STATUS\r |
63 | UsbHubCtrlClearHubFeature (\r | |
64 | IN USB_DEVICE *HubDev,\r | |
65 | IN UINT16 Feature\r | |
66 | )\r | |
67 | {\r | |
68 | EFI_STATUS Status;\r | |
69 | \r | |
70 | Status = UsbCtrlRequest (\r | |
71 | HubDev,\r | |
72 | EfiUsbNoData,\r | |
73 | USB_REQ_TYPE_CLASS,\r | |
74 | USB_HUB_TARGET_HUB,\r | |
75 | USB_HUB_REQ_CLEAR_FEATURE,\r | |
76 | Feature,\r | |
77 | 0,\r | |
78 | NULL,\r | |
79 | 0\r | |
80 | );\r | |
81 | \r | |
82 | return Status;\r | |
83 | }\r | |
84 | \r | |
85 | \r | |
86 | /**\r | |
8616fc4c | 87 | Clear the feature of the device's port.\r |
e237e7ae | 88 | \r |
8616fc4c | 89 | @param HubDev The hub device.\r |
90 | @param Port The port to clear feature.\r | |
91 | @param Feature The feature to clear.\r | |
e237e7ae | 92 | \r |
93 | @retval EFI_SUCCESS The feature of the port is cleared.\r | |
94 | @retval Others Failed to clear the feature.\r | |
95 | \r | |
96 | **/\r | |
e237e7ae | 97 | EFI_STATUS\r |
98 | UsbHubCtrlClearPortFeature (\r | |
99 | IN USB_DEVICE *HubDev,\r | |
100 | IN UINT8 Port,\r | |
101 | IN UINT16 Feature\r | |
102 | )\r | |
103 | {\r | |
104 | EFI_STATUS Status;\r | |
105 | \r | |
106 | //\r | |
107 | // In USB bus, all the port index starts from 0. But HUB\r | |
108 | // indexes its port from 1. So, port number is added one.\r | |
109 | //\r | |
110 | Status = UsbCtrlRequest (\r | |
111 | HubDev,\r | |
112 | EfiUsbNoData,\r | |
113 | USB_REQ_TYPE_CLASS,\r | |
114 | USB_HUB_TARGET_PORT,\r | |
115 | USB_HUB_REQ_CLEAR_FEATURE,\r | |
116 | Feature,\r | |
c52fa98c | 117 | (UINT16) (Port + 1),\r |
e237e7ae | 118 | NULL,\r |
119 | 0\r | |
120 | );\r | |
121 | \r | |
122 | return Status;\r | |
123 | }\r | |
124 | \r | |
125 | \r | |
e237e7ae | 126 | /**\r |
127 | Clear the transaction translate buffer if full/low\r | |
128 | speed control/bulk transfer failed and the transfer\r | |
129 | uses this hub as translator.Remember to clear the TT\r | |
130 | buffer of transaction translator, not that of the\r | |
131 | parent.\r | |
132 | \r | |
8616fc4c | 133 | @param HubDev The hub device.\r |
134 | @param Port The port of the hub.\r | |
135 | @param DevAddr Address of the failed transaction.\r | |
136 | @param EpNum The endpoint number of the failed transaction.\r | |
137 | @param EpType The type of failed transaction.\r | |
e237e7ae | 138 | \r |
8616fc4c | 139 | @retval EFI_SUCCESS The TT buffer is cleared.\r |
140 | @retval Others Failed to clear the TT buffer.\r | |
e237e7ae | 141 | \r |
142 | **/\r | |
143 | EFI_STATUS\r | |
144 | UsbHubCtrlClearTTBuffer (\r | |
145 | IN USB_DEVICE *HubDev,\r | |
146 | IN UINT8 Port,\r | |
147 | IN UINT16 DevAddr,\r | |
148 | IN UINT16 EpNum,\r | |
149 | IN UINT16 EpType\r | |
150 | )\r | |
151 | {\r | |
152 | EFI_STATUS Status;\r | |
153 | UINT16 Value;\r | |
154 | \r | |
155 | //\r | |
156 | // Check USB2.0 spec page 424 for wValue's encoding\r | |
157 | //\r | |
c52fa98c | 158 | Value = (UINT16) ((EpNum & 0x0F) | (DevAddr << 4) |\r |
159 | ((EpType & 0x03) << 11) | ((EpNum & 0x80) << 15));\r | |
e237e7ae | 160 | \r |
161 | Status = UsbCtrlRequest (\r | |
162 | HubDev,\r | |
163 | EfiUsbNoData,\r | |
164 | USB_REQ_TYPE_CLASS,\r | |
165 | USB_HUB_TARGET_PORT,\r | |
166 | USB_HUB_REQ_CLEAR_TT,\r | |
167 | Value,\r | |
c52fa98c | 168 | (UINT16) (Port + 1),\r |
e237e7ae | 169 | NULL,\r |
170 | 0\r | |
171 | );\r | |
172 | \r | |
173 | return Status;\r | |
174 | }\r | |
175 | \r | |
176 | \r | |
177 | /**\r | |
8616fc4c | 178 | Usb hub control transfer to get the hub descriptor.\r |
e237e7ae | 179 | \r |
8616fc4c | 180 | @param HubDev The hub device.\r |
181 | @param Buf The buffer to hold the descriptor.\r | |
182 | @param Len The length to retrieve.\r | |
e237e7ae | 183 | \r |
8616fc4c | 184 | @retval EFI_SUCCESS The hub descriptor is retrieved.\r |
185 | @retval Others Failed to retrieve the hub descriptor.\r | |
e237e7ae | 186 | \r |
187 | **/\r | |
e237e7ae | 188 | EFI_STATUS\r |
189 | UsbHubCtrlGetHubDesc (\r | |
190 | IN USB_DEVICE *HubDev,\r | |
191 | OUT VOID *Buf,\r | |
192 | IN UINTN Len\r | |
193 | )\r | |
194 | {\r | |
195 | EFI_STATUS Status;\r | |
196 | \r | |
197 | Status = UsbCtrlRequest (\r | |
198 | HubDev,\r | |
199 | EfiUsbDataIn,\r | |
200 | USB_REQ_TYPE_CLASS,\r | |
201 | USB_HUB_TARGET_HUB,\r | |
202 | USB_HUB_REQ_GET_DESC,\r | |
203 | (UINT16) (USB_DESC_TYPE_HUB << 8),\r | |
204 | 0,\r | |
205 | Buf,\r | |
206 | Len\r | |
207 | );\r | |
208 | \r | |
209 | return Status;\r | |
210 | }\r | |
211 | \r | |
212 | \r | |
213 | /**\r | |
8616fc4c | 214 | Usb hub control transfer to get the hub status.\r |
e237e7ae | 215 | \r |
8616fc4c | 216 | @param HubDev The hub device.\r |
217 | @param State The variable to return the status.\r | |
e237e7ae | 218 | \r |
8616fc4c | 219 | @retval EFI_SUCCESS The hub status is returned in State.\r |
220 | @retval Others Failed to get the hub status.\r | |
e237e7ae | 221 | \r |
222 | **/\r | |
e237e7ae | 223 | EFI_STATUS\r |
224 | UsbHubCtrlGetHubStatus (\r | |
225 | IN USB_DEVICE *HubDev,\r | |
226 | OUT UINT32 *State\r | |
227 | )\r | |
228 | {\r | |
229 | EFI_STATUS Status;\r | |
230 | \r | |
231 | Status = UsbCtrlRequest (\r | |
232 | HubDev,\r | |
233 | EfiUsbDataIn,\r | |
234 | USB_REQ_TYPE_CLASS,\r | |
235 | USB_HUB_TARGET_HUB,\r | |
236 | USB_HUB_REQ_GET_STATUS,\r | |
237 | 0,\r | |
238 | 0,\r | |
239 | State,\r | |
240 | 4\r | |
241 | );\r | |
242 | \r | |
243 | return Status;\r | |
244 | }\r | |
245 | \r | |
246 | \r | |
247 | /**\r | |
8616fc4c | 248 | Usb hub control transfer to get the port status.\r |
e237e7ae | 249 | \r |
8616fc4c | 250 | @param HubDev The hub device.\r |
251 | @param Port The port of the hub.\r | |
252 | @param State Variable to return the hub port state.\r | |
e237e7ae | 253 | \r |
8616fc4c | 254 | @retval EFI_SUCCESS The port state is returned in State.\r |
d17371e8 | 255 | @retval Others Failed to retrieve the port state.\r |
e237e7ae | 256 | \r |
257 | **/\r | |
e237e7ae | 258 | EFI_STATUS\r |
259 | UsbHubCtrlGetPortStatus (\r | |
260 | IN USB_DEVICE *HubDev,\r | |
261 | IN UINT8 Port,\r | |
262 | OUT VOID *State\r | |
263 | )\r | |
264 | {\r | |
265 | EFI_STATUS Status;\r | |
266 | \r | |
267 | //\r | |
268 | // In USB bus, all the port index starts from 0. But HUB\r | |
269 | // indexes its port from 1. So, port number is added one.\r | |
270 | // No need to convert the hub bit to UEFI definition, they\r | |
271 | // are the same\r | |
272 | //\r | |
273 | Status = UsbCtrlRequest (\r | |
274 | HubDev,\r | |
275 | EfiUsbDataIn,\r | |
276 | USB_REQ_TYPE_CLASS,\r | |
277 | USB_HUB_TARGET_PORT,\r | |
278 | USB_HUB_REQ_GET_STATUS,\r | |
279 | 0,\r | |
c52fa98c | 280 | (UINT16) (Port + 1),\r |
e237e7ae | 281 | State,\r |
282 | 4\r | |
283 | );\r | |
284 | \r | |
285 | return Status;\r | |
286 | }\r | |
287 | \r | |
288 | \r | |
289 | /**\r | |
8616fc4c | 290 | Usb hub control transfer to reset the TT (Transaction Transaltor).\r |
e237e7ae | 291 | \r |
8616fc4c | 292 | @param HubDev The hub device.\r |
293 | @param Port The port of the hub.\r | |
e237e7ae | 294 | \r |
8616fc4c | 295 | @retval EFI_SUCCESS The TT of the hub is reset.\r |
296 | @retval Others Failed to reset the port.\r | |
e237e7ae | 297 | \r |
298 | **/\r | |
e237e7ae | 299 | EFI_STATUS\r |
300 | UsbHubCtrlResetTT (\r | |
301 | IN USB_DEVICE *HubDev,\r | |
302 | IN UINT8 Port\r | |
303 | )\r | |
304 | {\r | |
305 | EFI_STATUS Status;\r | |
306 | \r | |
307 | Status = UsbCtrlRequest (\r | |
308 | HubDev,\r | |
309 | EfiUsbNoData,\r | |
310 | USB_REQ_TYPE_CLASS,\r | |
311 | USB_HUB_TARGET_HUB,\r | |
312 | USB_HUB_REQ_RESET_TT,\r | |
313 | 0,\r | |
c52fa98c | 314 | (UINT16) (Port + 1),\r |
e237e7ae | 315 | NULL,\r |
316 | 0\r | |
317 | );\r | |
318 | \r | |
319 | return Status;\r | |
320 | }\r | |
321 | \r | |
322 | \r | |
323 | /**\r | |
8616fc4c | 324 | Usb hub control transfer to set the hub feature.\r |
e237e7ae | 325 | \r |
8616fc4c | 326 | @param HubDev The hub device.\r |
327 | @param Feature The feature to set.\r | |
e237e7ae | 328 | \r |
8616fc4c | 329 | @retval EFI_SUCESS The feature is set for the hub.\r |
330 | @retval Others Failed to set the feature.\r | |
e237e7ae | 331 | \r |
332 | **/\r | |
e237e7ae | 333 | EFI_STATUS\r |
334 | UsbHubCtrlSetHubFeature (\r | |
335 | IN USB_DEVICE *HubDev,\r | |
336 | IN UINT8 Feature\r | |
337 | )\r | |
338 | {\r | |
339 | EFI_STATUS Status;\r | |
340 | \r | |
341 | Status = UsbCtrlRequest (\r | |
342 | HubDev,\r | |
343 | EfiUsbNoData,\r | |
344 | USB_REQ_TYPE_CLASS,\r | |
345 | USB_HUB_TARGET_HUB,\r | |
346 | USB_HUB_REQ_SET_FEATURE,\r | |
347 | Feature,\r | |
348 | 0,\r | |
349 | NULL,\r | |
350 | 0\r | |
351 | );\r | |
352 | \r | |
353 | return Status;\r | |
354 | }\r | |
355 | \r | |
356 | \r | |
357 | /**\r | |
8616fc4c | 358 | Usb hub control transfer to set the port feature.\r |
e237e7ae | 359 | \r |
8616fc4c | 360 | @param HubDev The Usb hub device.\r |
361 | @param Port The Usb port to set feature for.\r | |
362 | @param Feature The feature to set.\r | |
e237e7ae | 363 | \r |
8616fc4c | 364 | @retval EFI_SUCCESS The feature is set for the port.\r |
365 | @retval Others Failed to set the feature.\r | |
e237e7ae | 366 | \r |
367 | **/\r | |
e237e7ae | 368 | EFI_STATUS\r |
369 | UsbHubCtrlSetPortFeature (\r | |
370 | IN USB_DEVICE *HubDev,\r | |
371 | IN UINT8 Port,\r | |
372 | IN UINT8 Feature\r | |
373 | )\r | |
374 | {\r | |
375 | EFI_STATUS Status;\r | |
376 | \r | |
377 | //\r | |
378 | // In USB bus, all the port index starts from 0. But HUB\r | |
379 | // indexes its port from 1. So, port number is added one.\r | |
380 | //\r | |
381 | Status = UsbCtrlRequest (\r | |
382 | HubDev,\r | |
383 | EfiUsbNoData,\r | |
384 | USB_REQ_TYPE_CLASS,\r | |
385 | USB_HUB_TARGET_PORT,\r | |
386 | USB_HUB_REQ_SET_FEATURE,\r | |
387 | Feature,\r | |
c52fa98c | 388 | (UINT16) (Port + 1),\r |
e237e7ae | 389 | NULL,\r |
390 | 0\r | |
391 | );\r | |
392 | \r | |
393 | return Status;\r | |
394 | }\r | |
395 | \r | |
396 | \r | |
397 | /**\r | |
398 | Read the whole usb hub descriptor. It is necessary\r | |
399 | to do it in two steps because hub descriptor is of\r | |
8616fc4c | 400 | variable length.\r |
e237e7ae | 401 | \r |
8616fc4c | 402 | @param HubDev The hub device.\r |
403 | @param HubDesc The variable to return the descriptor.\r | |
e237e7ae | 404 | \r |
8616fc4c | 405 | @retval EFI_SUCCESS The hub descriptor is read.\r |
406 | @retval Others Failed to read the hub descriptor.\r | |
e237e7ae | 407 | \r |
408 | **/\r | |
e237e7ae | 409 | EFI_STATUS\r |
410 | UsbHubReadDesc (\r | |
411 | IN USB_DEVICE *HubDev,\r | |
412 | OUT EFI_USB_HUB_DESCRIPTOR *HubDesc\r | |
413 | )\r | |
414 | {\r | |
415 | EFI_STATUS Status;\r | |
416 | \r | |
417 | //\r | |
418 | // First get the hub descriptor length\r | |
419 | //\r | |
420 | Status = UsbHubCtrlGetHubDesc (HubDev, HubDesc, 2);\r | |
421 | \r | |
422 | if (EFI_ERROR (Status)) {\r | |
423 | return Status;\r | |
424 | }\r | |
425 | \r | |
426 | //\r | |
427 | // Get the whole hub descriptor\r | |
428 | //\r | |
429 | Status = UsbHubCtrlGetHubDesc (HubDev, HubDesc, HubDesc->Length);\r | |
430 | \r | |
431 | return Status;\r | |
432 | }\r | |
433 | \r | |
434 | \r | |
435 | \r | |
436 | /**\r | |
437 | Ack the hub change bits. If these bits are not ACKed, Hub will\r | |
438 | always return changed bit map from its interrupt endpoint.\r | |
439 | \r | |
8616fc4c | 440 | @param HubDev The hub device.\r |
e237e7ae | 441 | \r |
8616fc4c | 442 | @retval EFI_SUCCESS The hub change status is ACKed.\r |
443 | @retval Others Failed to ACK the hub status.\r | |
e237e7ae | 444 | \r |
445 | **/\r | |
446 | EFI_STATUS\r | |
447 | UsbHubAckHubStatus (\r | |
448 | IN USB_DEVICE *HubDev\r | |
449 | )\r | |
450 | {\r | |
451 | EFI_USB_PORT_STATUS HubState;\r | |
452 | EFI_STATUS Status;\r | |
453 | \r | |
454 | Status = UsbHubCtrlGetHubStatus (HubDev, (UINT32 *) &HubState);\r | |
455 | \r | |
456 | if (EFI_ERROR (Status)) {\r | |
457 | return Status;\r | |
458 | }\r | |
459 | \r | |
460 | if (USB_BIT_IS_SET (HubState.PortChangeStatus, USB_HUB_STAT_C_LOCAL_POWER)) {\r | |
461 | UsbHubCtrlClearHubFeature (HubDev, USB_HUB_C_HUB_LOCAL_POWER);\r | |
462 | }\r | |
463 | \r | |
464 | if (USB_BIT_IS_SET (HubState.PortChangeStatus, USB_HUB_STAT_C_OVER_CURRENT)) {\r | |
465 | UsbHubCtrlClearHubFeature (HubDev, USB_HUB_C_HUB_OVER_CURRENT);\r | |
466 | }\r | |
467 | \r | |
468 | return EFI_SUCCESS;\r | |
469 | }\r | |
470 | \r | |
471 | \r | |
472 | /**\r | |
473 | Test whether the interface is a hub interface.\r | |
474 | \r | |
8616fc4c | 475 | @param UsbIf The interface to test.\r |
e237e7ae | 476 | \r |
8616fc4c | 477 | @retval TRUE The interface is a hub interface.\r |
478 | @retval FALSE The interface isn't a hub interface.\r | |
e237e7ae | 479 | \r |
480 | **/\r | |
481 | BOOLEAN\r | |
482 | UsbIsHubInterface (\r | |
483 | IN USB_INTERFACE *UsbIf\r | |
484 | )\r | |
485 | {\r | |
486 | EFI_USB_INTERFACE_DESCRIPTOR *Setting;\r | |
487 | \r | |
488 | //\r | |
489 | // If the hub is a high-speed hub with multiple TT,\r | |
490 | // the hub will has a default setting of single TT.\r | |
491 | //\r | |
492 | Setting = &UsbIf->IfSetting->Desc;\r | |
493 | \r | |
494 | if ((Setting->InterfaceClass == USB_HUB_CLASS_CODE) &&\r | |
495 | (Setting->InterfaceSubClass == USB_HUB_SUBCLASS_CODE)) {\r | |
496 | \r | |
497 | return TRUE;\r | |
498 | }\r | |
499 | \r | |
500 | return FALSE;\r | |
501 | }\r | |
502 | \r | |
503 | \r | |
504 | /**\r | |
505 | The callback function to the USB hub status change\r | |
506 | interrupt endpoint. It is called periodically by\r | |
507 | the underlying host controller.\r | |
508 | \r | |
8616fc4c | 509 | @param Data The data read.\r |
510 | @param DataLength The length of the data read.\r | |
511 | @param Context The context.\r | |
512 | @param Result The result of the last interrupt transfer.\r | |
e237e7ae | 513 | \r |
8616fc4c | 514 | @retval EFI_SUCCESS The process is OK.\r |
515 | @retval EFI_OUT_OF_RESOURCES Failed to allocate resource.\r | |
e237e7ae | 516 | \r |
517 | **/\r | |
e237e7ae | 518 | EFI_STATUS\r |
6d3ea23f | 519 | EFIAPI\r |
e237e7ae | 520 | UsbOnHubInterrupt (\r |
521 | IN VOID *Data,\r | |
522 | IN UINTN DataLength,\r | |
523 | IN VOID *Context,\r | |
524 | IN UINT32 Result\r | |
525 | )\r | |
526 | {\r | |
527 | USB_INTERFACE *HubIf;\r | |
528 | EFI_USB_IO_PROTOCOL *UsbIo;\r | |
529 | EFI_USB_ENDPOINT_DESCRIPTOR *EpDesc;\r | |
530 | EFI_STATUS Status;\r | |
531 | \r | |
532 | HubIf = (USB_INTERFACE *) Context;\r | |
533 | UsbIo = &(HubIf->UsbIo);\r | |
534 | EpDesc = &(HubIf->HubEp->Desc);\r | |
535 | \r | |
536 | if (Result != EFI_USB_NOERROR) {\r | |
537 | //\r | |
538 | // If endpoint is stalled, clear the stall. Use UsbIo to access\r | |
539 | // the control transfer so internal status are maintained.\r | |
540 | //\r | |
541 | if (USB_BIT_IS_SET (Result, EFI_USB_ERR_STALL)) {\r | |
542 | UsbIoClearFeature (\r | |
543 | UsbIo,\r | |
544 | USB_TARGET_ENDPOINT,\r | |
545 | USB_FEATURE_ENDPOINT_HALT,\r | |
546 | EpDesc->EndpointAddress\r | |
547 | );\r | |
548 | }\r | |
549 | \r | |
550 | //\r | |
551 | // Delete and submit a new async interrupt\r | |
552 | //\r | |
553 | Status = UsbIo->UsbAsyncInterruptTransfer (\r | |
554 | UsbIo,\r | |
555 | EpDesc->EndpointAddress,\r | |
556 | FALSE,\r | |
557 | 0,\r | |
558 | 0,\r | |
559 | NULL,\r | |
560 | NULL\r | |
561 | );\r | |
562 | \r | |
563 | if (EFI_ERROR (Status)) {\r | |
d2577026 | 564 | DEBUG (( EFI_D_ERROR, "UsbOnHubInterrupt: failed to remove async transfer - %r\n", Status));\r |
e237e7ae | 565 | return Status;\r |
566 | }\r | |
567 | \r | |
568 | Status = UsbIo->UsbAsyncInterruptTransfer (\r | |
569 | UsbIo,\r | |
570 | EpDesc->EndpointAddress,\r | |
571 | TRUE,\r | |
572 | USB_HUB_POLL_INTERVAL,\r | |
573 | HubIf->NumOfPort / 8 + 1,\r | |
574 | UsbOnHubInterrupt,\r | |
575 | HubIf\r | |
576 | );\r | |
577 | \r | |
578 | if (EFI_ERROR (Status)) {\r | |
d2577026 | 579 | DEBUG (( EFI_D_ERROR, "UsbOnHubInterrupt: failed to submit new async transfer - %r\n", Status));\r |
e237e7ae | 580 | }\r |
581 | \r | |
582 | return Status;\r | |
583 | }\r | |
584 | \r | |
585 | if ((DataLength == 0) || (Data == NULL)) {\r | |
586 | return EFI_SUCCESS;\r | |
587 | }\r | |
588 | \r | |
589 | //\r | |
590 | // OK, actually something is changed, save the change map\r | |
591 | // then signal the HUB to do enumeration. This is a good\r | |
592 | // practise since UsbOnHubInterrupt is called in the context\r | |
593 | // of host contrller's AsyncInterrupt monitor.\r | |
594 | //\r | |
595 | HubIf->ChangeMap = AllocateZeroPool (DataLength);\r | |
596 | \r | |
597 | if (HubIf->ChangeMap == NULL) {\r | |
598 | return EFI_OUT_OF_RESOURCES;\r | |
599 | }\r | |
600 | \r | |
601 | CopyMem (HubIf->ChangeMap, Data, DataLength);\r | |
602 | gBS->SignalEvent (HubIf->HubNotify);\r | |
603 | \r | |
604 | return EFI_SUCCESS;\r | |
605 | }\r | |
606 | \r | |
e237e7ae | 607 | \r |
608 | \r | |
609 | \r | |
610 | /**\r | |
8616fc4c | 611 | Initialize the device for a non-root hub.\r |
e237e7ae | 612 | \r |
8616fc4c | 613 | @param HubIf The USB hub interface.\r |
e237e7ae | 614 | \r |
8616fc4c | 615 | @retval EFI_SUCCESS The hub is initialized.\r |
616 | @retval EFI_DEVICE_ERROR Failed to initialize the hub.\r | |
e237e7ae | 617 | \r |
618 | **/\r | |
e237e7ae | 619 | EFI_STATUS\r |
620 | UsbHubInit (\r | |
621 | IN USB_INTERFACE *HubIf\r | |
622 | )\r | |
623 | {\r | |
624 | EFI_USB_HUB_DESCRIPTOR HubDesc;\r | |
625 | USB_ENDPOINT_DESC *EpDesc;\r | |
626 | USB_INTERFACE_SETTING *Setting;\r | |
627 | EFI_USB_IO_PROTOCOL *UsbIo;\r | |
628 | USB_DEVICE *HubDev;\r | |
629 | EFI_STATUS Status;\r | |
630 | UINT8 Index;\r | |
d17371e8 | 631 | UINT8 NumEndpoints;\r |
e237e7ae | 632 | \r |
633 | //\r | |
634 | // Locate the interrupt endpoint for port change map\r | |
635 | //\r | |
636 | HubIf->IsHub = FALSE;\r | |
637 | Setting = HubIf->IfSetting;\r | |
638 | HubDev = HubIf->Device;\r | |
639 | EpDesc = NULL;\r | |
d17371e8 | 640 | NumEndpoints = Setting->Desc.NumEndpoints;\r |
e237e7ae | 641 | \r |
d17371e8 | 642 | for (Index = 0; Index < NumEndpoints; Index++) {\r |
e237e7ae | 643 | ASSERT ((Setting->Endpoints != NULL) && (Setting->Endpoints[Index] != NULL));\r |
644 | \r | |
645 | EpDesc = Setting->Endpoints[Index];\r | |
646 | \r | |
647 | if (USB_BIT_IS_SET (EpDesc->Desc.EndpointAddress, USB_ENDPOINT_DIR_IN) &&\r | |
648 | (USB_ENDPOINT_TYPE (&EpDesc->Desc) == USB_ENDPOINT_INTERRUPT)) {\r | |
649 | break;\r | |
650 | }\r | |
651 | }\r | |
652 | \r | |
d17371e8 | 653 | if (Index == NumEndpoints) {\r |
d2577026 | 654 | DEBUG (( EFI_D_ERROR, "UsbHubInit: no interrupt endpoint found for hub %d\n", HubDev->Address));\r |
e237e7ae | 655 | return EFI_DEVICE_ERROR;\r |
656 | }\r | |
657 | \r | |
658 | Status = UsbHubReadDesc (HubDev, &HubDesc);\r | |
659 | \r | |
660 | if (EFI_ERROR (Status)) {\r | |
d2577026 | 661 | DEBUG (( EFI_D_ERROR, "UsbHubInit: failed to read HUB descriptor %r\n", Status));\r |
e237e7ae | 662 | return Status;\r |
663 | }\r | |
664 | \r | |
665 | HubIf->NumOfPort = HubDesc.NumPorts;\r | |
666 | \r | |
d2577026 | 667 | DEBUG (( EFI_D_INFO, "UsbHubInit: hub %d has %d ports\n", HubDev->Address,HubIf->NumOfPort));\r |
e237e7ae | 668 | \r |
669 | //\r | |
670 | // Create an event to enumerate the hub's port. On\r | |
671 | //\r | |
672 | Status = gBS->CreateEvent (\r | |
673 | EVT_NOTIFY_SIGNAL,\r | |
674 | TPL_CALLBACK,\r | |
675 | UsbHubEnumeration,\r | |
676 | HubIf,\r | |
677 | &HubIf->HubNotify\r | |
678 | );\r | |
679 | \r | |
680 | if (EFI_ERROR (Status)) {\r | |
d2577026 | 681 | DEBUG (( EFI_D_ERROR, "UsbHubInit: failed to create signal for hub %d - %r\n",\r |
e237e7ae | 682 | HubDev->Address, Status));\r |
683 | \r | |
684 | return Status;\r | |
685 | }\r | |
686 | \r | |
687 | //\r | |
688 | // Create AsyncInterrupt to query hub port change endpoint\r | |
689 | // periodically. If the hub ports are changed, hub will return\r | |
690 | // changed port map from the interrupt endpoint. The port map\r | |
691 | // must be able to hold (HubIf->NumOfPort + 1) bits (one bit for\r | |
692 | // host change status).\r | |
693 | //\r | |
694 | UsbIo = &HubIf->UsbIo;\r | |
695 | Status = UsbIo->UsbAsyncInterruptTransfer (\r | |
696 | UsbIo,\r | |
697 | EpDesc->Desc.EndpointAddress,\r | |
698 | TRUE,\r | |
699 | USB_HUB_POLL_INTERVAL,\r | |
700 | HubIf->NumOfPort / 8 + 1,\r | |
701 | UsbOnHubInterrupt,\r | |
702 | HubIf\r | |
703 | );\r | |
704 | \r | |
705 | if (EFI_ERROR (Status)) {\r | |
d2577026 | 706 | DEBUG (( EFI_D_ERROR, "UsbHubInit: failed to queue interrupt transfer for hub %d - %r\n",\r |
e237e7ae | 707 | HubDev->Address, Status));\r |
708 | \r | |
709 | gBS->CloseEvent (HubIf->HubNotify);\r | |
710 | HubIf->HubNotify = NULL;\r | |
711 | \r | |
712 | return Status;\r | |
713 | }\r | |
714 | \r | |
715 | //\r | |
716 | // OK, set IsHub to TRUE. Now usb bus can handle this device\r | |
717 | // as a working HUB. If failed eariler, bus driver will not\r | |
718 | // recognize it as a hub. Other parts of the bus should be able\r | |
719 | // to work.\r | |
720 | //\r | |
721 | HubIf->IsHub = TRUE;\r | |
722 | HubIf->HubApi = &mUsbHubApi;\r | |
723 | HubIf->HubEp = EpDesc;\r | |
724 | \r | |
725 | //\r | |
726 | // Feed power to all the hub ports. It should be ok\r | |
727 | // for both gang/individual powered hubs.\r | |
728 | //\r | |
729 | for (Index = 0; Index < HubDesc.NumPorts; Index++) {\r | |
c52fa98c | 730 | UsbHubCtrlSetPortFeature (HubIf->Device, Index, (EFI_USB_PORT_FEATURE) USB_HUB_PORT_POWER);\r |
e237e7ae | 731 | }\r |
732 | \r | |
41e8ff27 | 733 | gBS->Stall (HubDesc.PwrOn2PwrGood * USB_SET_PORT_POWER_STALL);\r |
e237e7ae | 734 | UsbHubAckHubStatus (HubIf->Device);\r |
735 | \r | |
d2577026 | 736 | DEBUG (( EFI_D_INFO, "UsbHubInit: hub %d initialized\n", HubDev->Address));\r |
e237e7ae | 737 | return Status;\r |
738 | }\r | |
739 | \r | |
740 | \r | |
741 | \r | |
742 | /**\r | |
743 | Get the port status. This function is required to\r | |
744 | ACK the port change bits although it will return\r | |
745 | the port changes in PortState. Bus enumeration code\r | |
746 | doesn't need to ACK the port change bits.\r | |
747 | \r | |
8616fc4c | 748 | @param HubIf The hub interface.\r |
749 | @param Port The port of the hub to get state.\r | |
750 | @param PortState Variable to return the port state.\r | |
e237e7ae | 751 | \r |
8616fc4c | 752 | @retval EFI_SUCCESS The port status is successfully returned.\r |
753 | @retval Others Failed to return the status.\r | |
e237e7ae | 754 | \r |
755 | **/\r | |
e237e7ae | 756 | EFI_STATUS\r |
757 | UsbHubGetPortStatus (\r | |
758 | IN USB_INTERFACE *HubIf,\r | |
759 | IN UINT8 Port,\r | |
760 | OUT EFI_USB_PORT_STATUS *PortState\r | |
761 | )\r | |
762 | {\r | |
763 | EFI_STATUS Status;\r | |
764 | \r | |
765 | Status = UsbHubCtrlGetPortStatus (HubIf->Device, Port, PortState);\r | |
766 | \r | |
767 | return Status;\r | |
768 | }\r | |
769 | \r | |
770 | \r | |
771 | \r | |
772 | /**\r | |
773 | Clear the port change status.\r | |
774 | \r | |
8616fc4c | 775 | @param HubIf The hub interface.\r |
776 | @param Port The hub port.\r | |
e237e7ae | 777 | \r |
e237e7ae | 778 | **/\r |
e237e7ae | 779 | VOID\r |
780 | UsbHubClearPortChange (\r | |
781 | IN USB_INTERFACE *HubIf,\r | |
782 | IN UINT8 Port\r | |
783 | )\r | |
784 | {\r | |
785 | EFI_USB_PORT_STATUS PortState;\r | |
786 | USB_CHANGE_FEATURE_MAP *Map;\r | |
787 | UINTN Index;\r | |
788 | EFI_STATUS Status;\r | |
789 | \r | |
790 | Status = UsbHubGetPortStatus (HubIf, Port, &PortState);\r | |
791 | \r | |
792 | if (EFI_ERROR (Status)) {\r | |
793 | return;\r | |
794 | }\r | |
795 | \r | |
796 | //\r | |
797 | // OK, get the usb port status, now ACK the change bits.\r | |
798 | // Don't return error when failed to clear the change bits.\r | |
799 | // It may lead to extra port state report. USB bus should\r | |
800 | // be able to handle this.\r | |
801 | //\r | |
802 | for (Index = 0; Index < USB_HUB_MAP_SIZE; Index++) {\r | |
803 | Map = &mHubFeatureMap[Index];\r | |
804 | \r | |
805 | if (USB_BIT_IS_SET (PortState.PortChangeStatus, Map->ChangedBit)) {\r | |
23c326c2 | 806 | UsbHubCtrlClearPortFeature (HubIf->Device, Port, (UINT16) Map->Feature);\r |
e237e7ae | 807 | }\r |
808 | }\r | |
809 | }\r | |
810 | \r | |
811 | \r | |
812 | \r | |
813 | /**\r | |
8616fc4c | 814 | Function to set the port feature for non-root hub.\r |
e237e7ae | 815 | \r |
8616fc4c | 816 | @param HubIf The hub interface.\r |
817 | @param Port The port of the hub.\r | |
818 | @param Feature The feature of the port to set.\r | |
e237e7ae | 819 | \r |
8616fc4c | 820 | @retval EFI_SUCCESS The hub port feature is set.\r |
821 | @retval Others Failed to set the port feature.\r | |
e237e7ae | 822 | \r |
823 | **/\r | |
e237e7ae | 824 | EFI_STATUS\r |
825 | UsbHubSetPortFeature (\r | |
826 | IN USB_INTERFACE *HubIf,\r | |
827 | IN UINT8 Port,\r | |
828 | IN EFI_USB_PORT_FEATURE Feature\r | |
829 | )\r | |
830 | {\r | |
831 | EFI_STATUS Status;\r | |
832 | \r | |
c52fa98c | 833 | Status = UsbHubCtrlSetPortFeature (HubIf->Device, Port, (UINT8) Feature);\r |
e237e7ae | 834 | \r |
835 | return Status;\r | |
836 | }\r | |
837 | \r | |
838 | \r | |
839 | /**\r | |
8616fc4c | 840 | Interface function to clear the port feature for non-root hub.\r |
e237e7ae | 841 | \r |
8616fc4c | 842 | @param HubIf The hub interface.\r |
843 | @param Port The port of the hub to clear feature for.\r | |
844 | @param Feature The feature to clear.\r | |
e237e7ae | 845 | \r |
8616fc4c | 846 | @retval EFI_SUCCESS The port feature is cleared.\r |
847 | @retval Others Failed to clear the port feature.\r | |
e237e7ae | 848 | \r |
849 | **/\r | |
e237e7ae | 850 | EFI_STATUS\r |
851 | UsbHubClearPortFeature (\r | |
852 | IN USB_INTERFACE *HubIf,\r | |
853 | IN UINT8 Port,\r | |
854 | IN EFI_USB_PORT_FEATURE Feature\r | |
855 | )\r | |
856 | {\r | |
857 | EFI_STATUS Status;\r | |
858 | \r | |
c52fa98c | 859 | Status = UsbHubCtrlClearPortFeature (HubIf->Device, Port, (UINT8) Feature);\r |
e237e7ae | 860 | \r |
861 | return Status;\r | |
862 | }\r | |
863 | \r | |
864 | \r | |
865 | /**\r | |
d17371e8 | 866 | Interface function to reset the port.\r |
e237e7ae | 867 | \r |
8616fc4c | 868 | @param HubIf The hub interface.\r |
869 | @param Port The port to reset.\r | |
e237e7ae | 870 | \r |
8616fc4c | 871 | @retval EFI_SUCCESS The hub port is reset.\r |
872 | @retval EFI_TIMEOUT Failed to reset the port in time.\r | |
873 | @retval Others Failed to reset the port.\r | |
e237e7ae | 874 | \r |
875 | **/\r | |
e237e7ae | 876 | EFI_STATUS\r |
877 | UsbHubResetPort (\r | |
878 | IN USB_INTERFACE *HubIf,\r | |
879 | IN UINT8 Port\r | |
880 | )\r | |
881 | {\r | |
882 | EFI_USB_PORT_STATUS PortState;\r | |
883 | UINTN Index;\r | |
884 | EFI_STATUS Status;\r | |
885 | \r | |
c52fa98c | 886 | Status = UsbHubSetPortFeature (HubIf, Port, (EFI_USB_PORT_FEATURE) USB_HUB_PORT_RESET);\r |
e237e7ae | 887 | \r |
888 | if (EFI_ERROR (Status)) {\r | |
889 | return Status;\r | |
890 | }\r | |
891 | \r | |
892 | //\r | |
893 | // Drive the reset signal for at least 10ms. Check USB 2.0 Spec\r | |
894 | // section 7.1.7.5 for timing requirements.\r | |
895 | //\r | |
41e8ff27 | 896 | gBS->Stall (USB_SET_PORT_RESET_STALL);\r |
e237e7ae | 897 | \r |
898 | //\r | |
899 | // USB hub will clear RESET bit if reset is actually finished.\r | |
900 | //\r | |
901 | ZeroMem (&PortState, sizeof (EFI_USB_PORT_STATUS));\r | |
902 | \r | |
41e8ff27 | 903 | for (Index = 0; Index < USB_WAIT_PORT_STS_CHANGE_LOOP; Index++) {\r |
e237e7ae | 904 | Status = UsbHubGetPortStatus (HubIf, Port, &PortState);\r |
905 | \r | |
906 | if (!EFI_ERROR (Status) &&\r | |
907 | !USB_BIT_IS_SET (PortState.PortStatus, USB_PORT_STAT_RESET)) {\r | |
908 | \r | |
909 | return EFI_SUCCESS;\r | |
910 | }\r | |
911 | \r | |
41e8ff27 | 912 | gBS->Stall (USB_WAIT_PORT_STS_CHANGE_STALL);\r |
e237e7ae | 913 | }\r |
914 | \r | |
915 | return EFI_TIMEOUT;\r | |
916 | }\r | |
917 | \r | |
918 | \r | |
919 | /**\r | |
8616fc4c | 920 | Release the hub's control of the interface.\r |
e237e7ae | 921 | \r |
8616fc4c | 922 | @param HubIf The hub interface.\r |
e237e7ae | 923 | \r |
8616fc4c | 924 | @retval EFI_SUCCESS The interface is release of hub control.\r |
e237e7ae | 925 | \r |
926 | **/\r | |
e237e7ae | 927 | EFI_STATUS\r |
928 | UsbHubRelease (\r | |
929 | IN USB_INTERFACE *HubIf\r | |
930 | )\r | |
931 | {\r | |
932 | EFI_USB_IO_PROTOCOL *UsbIo;\r | |
933 | EFI_STATUS Status;\r | |
934 | \r | |
935 | UsbIo = &HubIf->UsbIo;\r | |
936 | Status = UsbIo->UsbAsyncInterruptTransfer (\r | |
937 | UsbIo,\r | |
938 | HubIf->HubEp->Desc.EndpointAddress,\r | |
939 | FALSE,\r | |
940 | USB_HUB_POLL_INTERVAL,\r | |
941 | 0,\r | |
942 | NULL,\r | |
943 | 0\r | |
944 | );\r | |
945 | \r | |
946 | if (EFI_ERROR (Status)) {\r | |
947 | return Status;\r | |
948 | }\r | |
949 | \r | |
950 | gBS->CloseEvent (HubIf->HubNotify);\r | |
951 | \r | |
952 | HubIf->IsHub = FALSE;\r | |
953 | HubIf->HubApi = NULL;\r | |
954 | HubIf->HubEp = NULL;\r | |
955 | HubIf->HubNotify = NULL;\r | |
956 | \r | |
d2577026 | 957 | DEBUG (( EFI_D_INFO, "UsbHubRelease: hub device %d released\n", HubIf->Device->Address));\r |
e237e7ae | 958 | return EFI_SUCCESS;\r |
959 | }\r | |
960 | \r | |
961 | \r | |
962 | \r | |
963 | /**\r | |
8616fc4c | 964 | Initialize the interface for root hub.\r |
e237e7ae | 965 | \r |
8616fc4c | 966 | @param HubIf The root hub interface.\r |
e237e7ae | 967 | \r |
d17371e8 | 968 | @retval EFI_SUCCESS The interface is initialized for root hub.\r |
8616fc4c | 969 | @retval Others Failed to initialize the hub.\r |
e237e7ae | 970 | \r |
971 | **/\r | |
e237e7ae | 972 | EFI_STATUS\r |
973 | UsbRootHubInit (\r | |
974 | IN USB_INTERFACE *HubIf\r | |
975 | )\r | |
976 | {\r | |
977 | EFI_STATUS Status;\r | |
978 | UINT8 MaxSpeed;\r | |
979 | UINT8 NumOfPort;\r | |
980 | UINT8 Support64;\r | |
981 | \r | |
982 | Status = UsbHcGetCapability (HubIf->Device->Bus, &MaxSpeed, &NumOfPort, &Support64);\r | |
983 | \r | |
984 | if (EFI_ERROR (Status)) {\r | |
985 | return Status;\r | |
986 | }\r | |
987 | \r | |
0e549d5b | 988 | DEBUG (( EFI_D_INFO, "UsbRootHubInit: root hub %p - max speed %d, %d ports\n",\r |
e237e7ae | 989 | HubIf, MaxSpeed, NumOfPort));\r |
990 | \r | |
991 | HubIf->IsHub = TRUE;\r | |
992 | HubIf->HubApi = &mUsbRootHubApi;\r | |
993 | HubIf->HubEp = NULL;\r | |
994 | HubIf->MaxSpeed = MaxSpeed;\r | |
995 | HubIf->NumOfPort = NumOfPort;\r | |
996 | HubIf->HubNotify = NULL;\r | |
997 | \r | |
998 | //\r | |
999 | // Create a timer to poll root hub ports periodically\r | |
1000 | //\r | |
1001 | Status = gBS->CreateEvent (\r | |
1002 | EVT_TIMER | EVT_NOTIFY_SIGNAL,\r | |
1003 | TPL_CALLBACK,\r | |
1004 | UsbRootHubEnumeration,\r | |
1005 | HubIf,\r | |
1006 | &HubIf->HubNotify\r | |
1007 | );\r | |
1008 | \r | |
1009 | if (EFI_ERROR (Status)) {\r | |
1010 | return Status;\r | |
1011 | }\r | |
1012 | \r | |
d2577026 | 1013 | //\r |
1014 | // It should signal the event immediately here, or device detection\r | |
1015 | // by bus enumeration might be delayed by the timer interval.\r | |
1016 | //\r | |
1017 | gBS->SignalEvent (HubIf->HubNotify);\r | |
1018 | \r | |
e237e7ae | 1019 | Status = gBS->SetTimer (\r |
1020 | HubIf->HubNotify,\r | |
1021 | TimerPeriodic,\r | |
1022 | USB_ROOTHUB_POLL_INTERVAL\r | |
1023 | );\r | |
1024 | \r | |
1025 | if (EFI_ERROR (Status)) {\r | |
1026 | gBS->CloseEvent (HubIf->HubNotify);\r | |
1027 | }\r | |
1028 | \r | |
1029 | return Status;\r | |
1030 | }\r | |
1031 | \r | |
1032 | \r | |
e237e7ae | 1033 | /**\r |
1034 | Get the port status. This function is required to\r | |
1035 | ACK the port change bits although it will return\r | |
1036 | the port changes in PortState. Bus enumeration code\r | |
1037 | doesn't need to ACK the port change bits.\r | |
1038 | \r | |
8616fc4c | 1039 | @param HubIf The root hub interface.\r |
1040 | @param Port The root hub port to get the state.\r | |
1041 | @param PortState Variable to return the port state.\r | |
e237e7ae | 1042 | \r |
8616fc4c | 1043 | @retval EFI_SUCCESS The port state is returned.\r |
1044 | @retval Others Failed to retrieve the port state.\r | |
e237e7ae | 1045 | \r |
1046 | **/\r | |
e237e7ae | 1047 | EFI_STATUS\r |
1048 | UsbRootHubGetPortStatus (\r | |
1049 | IN USB_INTERFACE *HubIf,\r | |
1050 | IN UINT8 Port,\r | |
1051 | OUT EFI_USB_PORT_STATUS *PortState\r | |
1052 | )\r | |
1053 | {\r | |
1054 | USB_BUS *Bus;\r | |
1055 | EFI_STATUS Status;\r | |
1056 | \r | |
1057 | Bus = HubIf->Device->Bus;\r | |
1058 | Status = UsbHcGetRootHubPortStatus (Bus, Port, PortState);\r | |
1059 | \r | |
1060 | return Status;\r | |
1061 | }\r | |
1062 | \r | |
1063 | \r | |
1064 | /**\r | |
1065 | Clear the port change status.\r | |
1066 | \r | |
8616fc4c | 1067 | @param HubIf The root hub interface.\r |
1068 | @param Port The root hub port.\r | |
e237e7ae | 1069 | \r |
e237e7ae | 1070 | **/\r |
e237e7ae | 1071 | VOID\r |
1072 | UsbRootHubClearPortChange (\r | |
1073 | IN USB_INTERFACE *HubIf,\r | |
1074 | IN UINT8 Port\r | |
1075 | )\r | |
1076 | {\r | |
1077 | EFI_USB_PORT_STATUS PortState;\r | |
1078 | USB_CHANGE_FEATURE_MAP *Map;\r | |
1079 | UINTN Index;\r | |
1080 | EFI_STATUS Status;\r | |
1081 | \r | |
1082 | Status = UsbRootHubGetPortStatus (HubIf, Port, &PortState);\r | |
1083 | \r | |
1084 | if (EFI_ERROR (Status)) {\r | |
1085 | return;\r | |
1086 | }\r | |
1087 | \r | |
1088 | //\r | |
1089 | // OK, get the usb port status, now ACK the change bits.\r | |
1090 | // Don't return error when failed to clear the change bits.\r | |
1091 | // It may lead to extra port state report. USB bus should\r | |
1092 | // be able to handle this.\r | |
1093 | //\r | |
1094 | for (Index = 0; Index < USB_ROOT_HUB_MAP_SIZE; Index++) {\r | |
1095 | Map = &mRootHubFeatureMap[Index];\r | |
1096 | \r | |
1097 | if (USB_BIT_IS_SET (PortState.PortChangeStatus, Map->ChangedBit)) {\r | |
c52fa98c | 1098 | UsbHcClearRootHubPortFeature (HubIf->Device->Bus, Port, (EFI_USB_PORT_FEATURE) Map->Feature);\r |
e237e7ae | 1099 | }\r |
1100 | }\r | |
1101 | }\r | |
1102 | \r | |
1103 | \r | |
e237e7ae | 1104 | /**\r |
8616fc4c | 1105 | Set the root hub port feature.\r |
e237e7ae | 1106 | \r |
8616fc4c | 1107 | @param HubIf The Usb hub interface.\r |
1108 | @param Port The hub port.\r | |
1109 | @param Feature The feature to set.\r | |
e237e7ae | 1110 | \r |
8616fc4c | 1111 | @retval EFI_SUCCESS The root hub port is set with the feature.\r |
1112 | @retval Others Failed to set the feature.\r | |
e237e7ae | 1113 | \r |
1114 | **/\r | |
e237e7ae | 1115 | EFI_STATUS\r |
1116 | UsbRootHubSetPortFeature (\r | |
1117 | IN USB_INTERFACE *HubIf,\r | |
1118 | IN UINT8 Port,\r | |
1119 | IN EFI_USB_PORT_FEATURE Feature\r | |
1120 | )\r | |
1121 | {\r | |
1122 | EFI_STATUS Status;\r | |
1123 | \r | |
1124 | Status = UsbHcSetRootHubPortFeature (HubIf->Device->Bus, Port, Feature);\r | |
1125 | \r | |
1126 | return Status;\r | |
1127 | }\r | |
1128 | \r | |
1129 | \r | |
1130 | /**\r | |
8616fc4c | 1131 | Clear the root hub port feature.\r |
e237e7ae | 1132 | \r |
8616fc4c | 1133 | @param HubIf The root hub interface.\r |
1134 | @param Port The root hub port.\r | |
1135 | @param Feature The feature to clear.\r | |
e237e7ae | 1136 | \r |
8616fc4c | 1137 | @retval EFI_SUCCESS The root hub port is cleared of the feature.\r |
1138 | @retval Others Failed to clear the feature.\r | |
e237e7ae | 1139 | \r |
1140 | **/\r | |
e237e7ae | 1141 | EFI_STATUS\r |
1142 | UsbRootHubClearPortFeature (\r | |
1143 | IN USB_INTERFACE *HubIf,\r | |
1144 | IN UINT8 Port,\r | |
1145 | IN EFI_USB_PORT_FEATURE Feature\r | |
1146 | )\r | |
1147 | {\r | |
1148 | EFI_STATUS Status;\r | |
1149 | \r | |
1150 | Status = UsbHcClearRootHubPortFeature (HubIf->Device->Bus, Port, Feature);\r | |
1151 | \r | |
1152 | return Status;\r | |
1153 | }\r | |
1154 | \r | |
1155 | \r | |
1156 | /**\r | |
d17371e8 | 1157 | Interface function to reset the root hub port.\r |
e237e7ae | 1158 | \r |
8616fc4c | 1159 | @param RootIf The root hub interface.\r |
1160 | @param Port The port to reset.\r | |
e237e7ae | 1161 | \r |
8616fc4c | 1162 | @retval EFI_SUCCESS The hub port is reset.\r |
1163 | @retval EFI_TIMEOUT Failed to reset the port in time.\r | |
1164 | @retval EFI_NOT_FOUND The low/full speed device connected to high speed.\r | |
1165 | root hub is released to the companion UHCI.\r | |
1166 | @retval Others Failed to reset the port.\r | |
e237e7ae | 1167 | \r |
1168 | **/\r | |
e237e7ae | 1169 | EFI_STATUS\r |
1170 | UsbRootHubResetPort (\r | |
1171 | IN USB_INTERFACE *RootIf,\r | |
1172 | IN UINT8 Port\r | |
1173 | )\r | |
1174 | {\r | |
1175 | USB_BUS *Bus;\r | |
1176 | EFI_STATUS Status;\r | |
1177 | EFI_USB_PORT_STATUS PortState;\r | |
1178 | UINTN Index;\r | |
1179 | \r | |
1180 | //\r | |
1181 | // Notice: although EHCI requires that ENABLED bit be cleared\r | |
1182 | // when reset the port, we don't need to care that here. It\r | |
1183 | // should be handled in the EHCI driver.\r | |
1184 | //\r | |
1185 | Bus = RootIf->Device->Bus;\r | |
1186 | Status = UsbHcSetRootHubPortFeature (Bus, Port, EfiUsbPortReset);\r | |
1187 | \r | |
1188 | if (EFI_ERROR (Status)) {\r | |
d2577026 | 1189 | DEBUG (( EFI_D_ERROR, "UsbRootHubResetPort: failed to start reset on port %d\n", Port));\r |
e237e7ae | 1190 | return Status;\r |
1191 | }\r | |
1192 | \r | |
1193 | //\r | |
1194 | // Drive the reset signal for at least 50ms. Check USB 2.0 Spec\r | |
1195 | // section 7.1.7.5 for timing requirements.\r | |
1196 | //\r | |
41e8ff27 | 1197 | gBS->Stall (USB_SET_ROOT_PORT_RESET_STALL);\r |
e237e7ae | 1198 | \r |
1199 | Status = UsbHcClearRootHubPortFeature (Bus, Port, EfiUsbPortReset);\r | |
1200 | \r | |
1201 | if (EFI_ERROR (Status)) {\r | |
d2577026 | 1202 | DEBUG (( EFI_D_ERROR, "UsbRootHubResetPort: failed to clear reset on port %d\n", Port));\r |
e237e7ae | 1203 | return Status;\r |
1204 | }\r | |
1205 | \r | |
41e8ff27 | 1206 | gBS->Stall (USB_CLR_ROOT_PORT_RESET_STALL);\r |
e237e7ae | 1207 | \r |
1208 | //\r | |
1209 | // USB host controller won't clear the RESET bit until\r | |
1210 | // reset is actually finished.\r | |
1211 | //\r | |
1212 | ZeroMem (&PortState, sizeof (EFI_USB_PORT_STATUS));\r | |
1213 | \r | |
41e8ff27 | 1214 | for (Index = 0; Index < USB_WAIT_PORT_STS_CHANGE_LOOP; Index++) {\r |
e237e7ae | 1215 | Status = UsbHcGetRootHubPortStatus (Bus, Port, &PortState);\r |
1216 | \r | |
1217 | if (EFI_ERROR (Status)) {\r | |
1218 | return Status;\r | |
1219 | }\r | |
1220 | \r | |
1221 | if (!USB_BIT_IS_SET (PortState.PortStatus, USB_PORT_STAT_RESET)) {\r | |
1222 | break;\r | |
1223 | }\r | |
1224 | \r | |
41e8ff27 | 1225 | gBS->Stall (USB_WAIT_PORT_STS_CHANGE_STALL);\r |
e237e7ae | 1226 | }\r |
1227 | \r | |
41e8ff27 | 1228 | if (Index == USB_WAIT_PORT_STS_CHANGE_LOOP) {\r |
1229 | DEBUG ((EFI_D_ERROR, "UsbRootHubResetPort: reset not finished in time on port %d\n", Port));\r | |
e237e7ae | 1230 | return EFI_TIMEOUT;\r |
1231 | }\r | |
1232 | \r | |
1233 | if (!USB_BIT_IS_SET (PortState.PortStatus, USB_PORT_STAT_ENABLE)) {\r | |
1234 | //\r | |
1235 | // OK, the port is reset. If root hub is of high speed and\r | |
1236 | // the device is of low/full speed, release the ownership to\r | |
1237 | // companion UHCI. If root hub is of full speed, it won't\r | |
1238 | // automatically enable the port, we need to enable it manually.\r | |
1239 | //\r | |
1240 | if (RootIf->MaxSpeed == EFI_USB_SPEED_HIGH) {\r | |
d2577026 | 1241 | DEBUG (( EFI_D_ERROR, "UsbRootHubResetPort: release low/full speed device (%d) to UHCI\n", Port));\r |
e237e7ae | 1242 | \r |
1243 | UsbRootHubSetPortFeature (RootIf, Port, EfiUsbPortOwner);\r | |
1244 | return EFI_NOT_FOUND;\r | |
1245 | \r | |
1246 | } else {\r | |
1247 | \r | |
1248 | Status = UsbRootHubSetPortFeature (RootIf, Port, EfiUsbPortEnable);\r | |
1249 | \r | |
1250 | if (EFI_ERROR (Status)) {\r | |
d2577026 | 1251 | DEBUG (( EFI_D_ERROR, "UsbRootHubResetPort: failed to enable port %d for UHCI\n", Port));\r |
e237e7ae | 1252 | return Status;\r |
1253 | }\r | |
1254 | \r | |
41e8ff27 | 1255 | gBS->Stall (USB_SET_ROOT_PORT_ENABLE_STALL);\r |
e237e7ae | 1256 | }\r |
1257 | }\r | |
1258 | \r | |
1259 | return EFI_SUCCESS;\r | |
1260 | }\r | |
1261 | \r | |
1262 | \r | |
1263 | /**\r | |
8616fc4c | 1264 | Release the root hub's control of the interface.\r |
e237e7ae | 1265 | \r |
8616fc4c | 1266 | @param HubIf The root hub interface.\r |
e237e7ae | 1267 | \r |
1268 | @retval EFI_SUCCESS The root hub's control of the interface is\r | |
1269 | released.\r | |
1270 | \r | |
1271 | **/\r | |
e237e7ae | 1272 | EFI_STATUS\r |
1273 | UsbRootHubRelease (\r | |
1274 | IN USB_INTERFACE *HubIf\r | |
1275 | )\r | |
1276 | {\r | |
0e549d5b | 1277 | DEBUG (( EFI_D_INFO, "UsbRootHubRelease: root hub released for hub %p\n", HubIf));\r |
e237e7ae | 1278 | \r |
1279 | gBS->SetTimer (HubIf->HubNotify, TimerCancel, USB_ROOTHUB_POLL_INTERVAL);\r | |
1280 | gBS->CloseEvent (HubIf->HubNotify);\r | |
1281 | \r | |
1282 | return EFI_SUCCESS;\r | |
1283 | }\r | |
1284 | \r | |
1285 | USB_HUB_API mUsbHubApi = {\r | |
1286 | UsbHubInit,\r | |
1287 | UsbHubGetPortStatus,\r | |
1288 | UsbHubClearPortChange,\r | |
1289 | UsbHubSetPortFeature,\r | |
1290 | UsbHubClearPortFeature,\r | |
1291 | UsbHubResetPort,\r | |
1292 | UsbHubRelease\r | |
1293 | };\r | |
1294 | \r | |
1295 | USB_HUB_API mUsbRootHubApi = {\r | |
1296 | UsbRootHubInit,\r | |
1297 | UsbRootHubGetPortStatus,\r | |
1298 | UsbRootHubClearPortChange,\r | |
1299 | UsbRootHubSetPortFeature,\r | |
1300 | UsbRootHubClearPortFeature,\r | |
1301 | UsbRootHubResetPort,\r | |
1302 | UsbRootHubRelease\r | |
1303 | };\r |