]>
Commit | Line | Data |
---|---|---|
d1102dba | 1 | /** @file\r |
78c2ffb5 | 2 | The Ehci controller driver.\r |
913cb9dc | 3 | \r |
d1102dba LG |
4 | EhciDxe driver is responsible for managing the behavior of EHCI controller.\r |
5 | It implements the interfaces of monitoring the status of all ports and transferring\r | |
ba19956a | 6 | Control, Bulk, Interrupt and Isochronous requests to Usb2.0 device.\r |
7 | \r | |
8 | Note that EhciDxe driver is enhanced to guarantee that the EHCI controller get attached\r | |
d1102dba LG |
9 | to the EHCI controller before a UHCI or OHCI driver attaches to the companion UHCI or\r |
10 | OHCI controller. This way avoids the control transfer on a shared port between EHCI\r | |
11 | and companion host controller when UHCI or OHCI gets attached earlier than EHCI and a\r | |
51f65b37 | 12 | USB 2.0 device inserts.\r |
ba19956a | 13 | \r |
c74805f1 | 14 | Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r |
cd5ebaa0 | 15 | This program and the accompanying materials\r |
913cb9dc | 16 | are licensed and made available under the terms and conditions of the BSD License\r |
17 | which accompanies this distribution. The full text of the license may be found at\r | |
18 | http://opensource.org/licenses/bsd-license.php\r | |
19 | \r | |
20 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
21 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
22 | \r | |
913cb9dc | 23 | **/\r |
24 | \r | |
25 | \r | |
26 | #include "Ehci.h"\r | |
27 | \r | |
28 | //\r | |
29 | // Two arrays used to translate the EHCI port state (change)\r | |
30 | // to the UEFI protocol's port state (change).\r | |
31 | //\r | |
32 | USB_PORT_STATE_MAP mUsbPortStateMap[] = {\r | |
33 | {PORTSC_CONN, USB_PORT_STAT_CONNECTION},\r | |
34 | {PORTSC_ENABLED, USB_PORT_STAT_ENABLE},\r | |
35 | {PORTSC_SUSPEND, USB_PORT_STAT_SUSPEND},\r | |
36 | {PORTSC_OVERCUR, USB_PORT_STAT_OVERCURRENT},\r | |
37 | {PORTSC_RESET, USB_PORT_STAT_RESET},\r | |
38 | {PORTSC_POWER, USB_PORT_STAT_POWER},\r | |
39 | {PORTSC_OWNER, USB_PORT_STAT_OWNER}\r | |
40 | };\r | |
41 | \r | |
42 | USB_PORT_STATE_MAP mUsbPortChangeMap[] = {\r | |
43 | {PORTSC_CONN_CHANGE, USB_PORT_STAT_C_CONNECTION},\r | |
44 | {PORTSC_ENABLE_CHANGE, USB_PORT_STAT_C_ENABLE},\r | |
45 | {PORTSC_OVERCUR_CHANGE, USB_PORT_STAT_C_OVERCURRENT}\r | |
46 | };\r | |
47 | \r | |
aa79b0b3 | 48 | EFI_DRIVER_BINDING_PROTOCOL\r |
49 | gEhciDriverBinding = {\r | |
50 | EhcDriverBindingSupported,\r | |
51 | EhcDriverBindingStart,\r | |
52 | EhcDriverBindingStop,\r | |
cd92e3fb | 53 | 0x30,\r |
aa79b0b3 | 54 | NULL,\r |
55 | NULL\r | |
56 | };\r | |
913cb9dc | 57 | \r |
58 | /**\r | |
5f8be012 | 59 | Retrieves the capability of root hub ports.\r |
913cb9dc | 60 | \r |
78c2ffb5 | 61 | @param This This EFI_USB_HC_PROTOCOL instance.\r |
62 | @param MaxSpeed Max speed supported by the controller.\r | |
63 | @param PortNumber Number of the root hub ports.\r | |
64 | @param Is64BitCapable Whether the controller supports 64-bit memory\r | |
65 | addressing.\r | |
913cb9dc | 66 | \r |
78c2ffb5 | 67 | @retval EFI_SUCCESS Host controller capability were retrieved successfully.\r |
68 | @retval EFI_INVALID_PARAMETER Either of the three capability pointer is NULL.\r | |
913cb9dc | 69 | \r |
70 | **/\r | |
913cb9dc | 71 | EFI_STATUS\r |
72 | EFIAPI\r | |
73 | EhcGetCapability (\r | |
74 | IN EFI_USB2_HC_PROTOCOL *This,\r | |
75 | OUT UINT8 *MaxSpeed,\r | |
76 | OUT UINT8 *PortNumber,\r | |
77 | OUT UINT8 *Is64BitCapable\r | |
78 | )\r | |
79 | {\r | |
80 | USB2_HC_DEV *Ehc;\r | |
81 | EFI_TPL OldTpl;\r | |
82 | \r | |
83 | if ((MaxSpeed == NULL) || (PortNumber == NULL) || (Is64BitCapable == NULL)) {\r | |
84 | return EFI_INVALID_PARAMETER;\r | |
85 | }\r | |
86 | \r | |
87 | OldTpl = gBS->RaiseTPL (EHC_TPL);\r | |
88 | Ehc = EHC_FROM_THIS (This);\r | |
89 | \r | |
90 | *MaxSpeed = EFI_USB_SPEED_HIGH;\r | |
91 | *PortNumber = (UINT8) (Ehc->HcStructParams & HCSP_NPORTS);\r | |
167c3fb4 | 92 | *Is64BitCapable = (UINT8) Ehc->Support64BitDma;\r |
913cb9dc | 93 | \r |
1c619535 | 94 | DEBUG ((EFI_D_INFO, "EhcGetCapability: %d ports, 64 bit %d\n", *PortNumber, *Is64BitCapable));\r |
913cb9dc | 95 | \r |
96 | gBS->RestoreTPL (OldTpl);\r | |
97 | return EFI_SUCCESS;\r | |
98 | }\r | |
99 | \r | |
100 | \r | |
101 | /**\r | |
102 | Provides software reset for the USB host controller.\r | |
103 | \r | |
78c2ffb5 | 104 | @param This This EFI_USB2_HC_PROTOCOL instance.\r |
105 | @param Attributes A bit mask of the reset operation to perform.\r | |
913cb9dc | 106 | \r |
78c2ffb5 | 107 | @retval EFI_SUCCESS The reset operation succeeded.\r |
108 | @retval EFI_INVALID_PARAMETER Attributes is not valid.\r | |
109 | @retval EFI_UNSUPPOURTED The type of reset specified by Attributes is\r | |
110 | not currently supported by the host controller.\r | |
111 | @retval EFI_DEVICE_ERROR Host controller isn't halted to reset.\r | |
913cb9dc | 112 | \r |
113 | **/\r | |
913cb9dc | 114 | EFI_STATUS\r |
115 | EFIAPI\r | |
116 | EhcReset (\r | |
117 | IN EFI_USB2_HC_PROTOCOL *This,\r | |
118 | IN UINT16 Attributes\r | |
119 | )\r | |
120 | {\r | |
121 | USB2_HC_DEV *Ehc;\r | |
122 | EFI_TPL OldTpl;\r | |
123 | EFI_STATUS Status;\r | |
124 | \r | |
37623a5c | 125 | Ehc = EHC_FROM_THIS (This);\r |
126 | \r | |
127 | if (Ehc->DevicePath != NULL) {\r | |
128 | //\r | |
129 | // Report Status Code to indicate reset happens\r | |
130 | //\r | |
131 | REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r | |
132 | EFI_PROGRESS_CODE,\r | |
133 | (EFI_IO_BUS_USB | EFI_IOB_PC_RESET),\r | |
134 | Ehc->DevicePath\r | |
135 | );\r | |
136 | }\r | |
137 | \r | |
913cb9dc | 138 | OldTpl = gBS->RaiseTPL (EHC_TPL);\r |
913cb9dc | 139 | \r |
140 | switch (Attributes) {\r | |
141 | case EFI_USB_HC_RESET_GLOBAL:\r | |
142 | //\r | |
143 | // Flow through, same behavior as Host Controller Reset\r | |
144 | //\r | |
145 | case EFI_USB_HC_RESET_HOST_CONTROLLER:\r | |
146 | //\r | |
147 | // Host Controller must be Halt when Reset it\r | |
148 | //\r | |
b48ec0e8 LE |
149 | if (EhcIsDebugPortInUse (Ehc, NULL)) {\r |
150 | Status = EFI_SUCCESS;\r | |
151 | goto ON_EXIT;\r | |
09943f5e | 152 | }\r |
153 | \r | |
913cb9dc | 154 | if (!EhcIsHalt (Ehc)) {\r |
41e8ff27 | 155 | Status = EhcHaltHC (Ehc, EHC_GENERIC_TIMEOUT);\r |
913cb9dc | 156 | \r |
157 | if (EFI_ERROR (Status)) {\r | |
158 | Status = EFI_DEVICE_ERROR;\r | |
159 | goto ON_EXIT;\r | |
160 | }\r | |
161 | }\r | |
68246fa8 | 162 | \r |
913cb9dc | 163 | //\r |
164 | // Clean up the asynchronous transfers, currently only\r | |
165 | // interrupt supports asynchronous operation.\r | |
166 | //\r | |
167 | EhciDelAllAsyncIntTransfers (Ehc);\r | |
168 | EhcAckAllInterrupt (Ehc);\r | |
169 | EhcFreeSched (Ehc);\r | |
170 | \r | |
41e8ff27 | 171 | Status = EhcResetHC (Ehc, EHC_RESET_TIMEOUT);\r |
913cb9dc | 172 | \r |
173 | if (EFI_ERROR (Status)) {\r | |
174 | goto ON_EXIT;\r | |
175 | }\r | |
176 | \r | |
177 | Status = EhcInitHC (Ehc);\r | |
178 | break;\r | |
179 | \r | |
180 | case EFI_USB_HC_RESET_GLOBAL_WITH_DEBUG:\r | |
181 | case EFI_USB_HC_RESET_HOST_WITH_DEBUG:\r | |
182 | Status = EFI_UNSUPPORTED;\r | |
183 | break;\r | |
184 | \r | |
185 | default:\r | |
186 | Status = EFI_INVALID_PARAMETER;\r | |
187 | }\r | |
188 | \r | |
189 | ON_EXIT:\r | |
1c619535 | 190 | DEBUG ((EFI_D_INFO, "EhcReset: exit status %r\n", Status));\r |
913cb9dc | 191 | gBS->RestoreTPL (OldTpl);\r |
192 | return Status;\r | |
193 | }\r | |
194 | \r | |
195 | \r | |
196 | /**\r | |
197 | Retrieve the current state of the USB host controller.\r | |
198 | \r | |
78c2ffb5 | 199 | @param This This EFI_USB2_HC_PROTOCOL instance.\r |
200 | @param State Variable to return the current host controller\r | |
201 | state.\r | |
913cb9dc | 202 | \r |
78c2ffb5 | 203 | @retval EFI_SUCCESS Host controller state was returned in State.\r |
204 | @retval EFI_INVALID_PARAMETER State is NULL.\r | |
205 | @retval EFI_DEVICE_ERROR An error was encountered while attempting to\r | |
206 | retrieve the host controller's current state.\r | |
913cb9dc | 207 | \r |
208 | **/\r | |
913cb9dc | 209 | EFI_STATUS\r |
210 | EFIAPI\r | |
211 | EhcGetState (\r | |
db0f0d3c | 212 | IN EFI_USB2_HC_PROTOCOL *This,\r |
213 | OUT EFI_USB_HC_STATE *State\r | |
913cb9dc | 214 | )\r |
215 | {\r | |
216 | EFI_TPL OldTpl;\r | |
217 | USB2_HC_DEV *Ehc;\r | |
218 | \r | |
219 | if (State == NULL) {\r | |
220 | return EFI_INVALID_PARAMETER;\r | |
221 | }\r | |
222 | \r | |
223 | OldTpl = gBS->RaiseTPL (EHC_TPL);\r | |
224 | Ehc = EHC_FROM_THIS (This);\r | |
225 | \r | |
226 | if (EHC_REG_BIT_IS_SET (Ehc, EHC_USBSTS_OFFSET, USBSTS_HALT)) {\r | |
227 | *State = EfiUsbHcStateHalt;\r | |
228 | } else {\r | |
229 | *State = EfiUsbHcStateOperational;\r | |
230 | }\r | |
231 | \r | |
232 | gBS->RestoreTPL (OldTpl);\r | |
233 | \r | |
1c619535 | 234 | DEBUG ((EFI_D_INFO, "EhcGetState: current state %d\n", *State));\r |
913cb9dc | 235 | return EFI_SUCCESS;\r |
236 | }\r | |
237 | \r | |
238 | \r | |
239 | /**\r | |
240 | Sets the USB host controller to a specific state.\r | |
241 | \r | |
78c2ffb5 | 242 | @param This This EFI_USB2_HC_PROTOCOL instance.\r |
243 | @param State The state of the host controller that will be set.\r | |
913cb9dc | 244 | \r |
78c2ffb5 | 245 | @retval EFI_SUCCESS The USB host controller was successfully placed\r |
246 | in the state specified by State.\r | |
247 | @retval EFI_INVALID_PARAMETER State is invalid.\r | |
248 | @retval EFI_DEVICE_ERROR Failed to set the state due to device error.\r | |
913cb9dc | 249 | \r |
250 | **/\r | |
913cb9dc | 251 | EFI_STATUS\r |
252 | EFIAPI\r | |
253 | EhcSetState (\r | |
254 | IN EFI_USB2_HC_PROTOCOL *This,\r | |
255 | IN EFI_USB_HC_STATE State\r | |
256 | )\r | |
257 | {\r | |
258 | USB2_HC_DEV *Ehc;\r | |
259 | EFI_TPL OldTpl;\r | |
260 | EFI_STATUS Status;\r | |
261 | EFI_USB_HC_STATE CurState;\r | |
262 | \r | |
263 | Status = EhcGetState (This, &CurState);\r | |
264 | \r | |
265 | if (EFI_ERROR (Status)) {\r | |
266 | return EFI_DEVICE_ERROR;\r | |
267 | }\r | |
268 | \r | |
269 | if (CurState == State) {\r | |
270 | return EFI_SUCCESS;\r | |
271 | }\r | |
272 | \r | |
273 | OldTpl = gBS->RaiseTPL (EHC_TPL);\r | |
274 | Ehc = EHC_FROM_THIS (This);\r | |
275 | \r | |
276 | switch (State) {\r | |
277 | case EfiUsbHcStateHalt:\r | |
41e8ff27 | 278 | Status = EhcHaltHC (Ehc, EHC_GENERIC_TIMEOUT);\r |
913cb9dc | 279 | break;\r |
280 | \r | |
281 | case EfiUsbHcStateOperational:\r | |
282 | if (EHC_REG_BIT_IS_SET (Ehc, EHC_USBSTS_OFFSET, USBSTS_SYS_ERROR)) {\r | |
283 | Status = EFI_DEVICE_ERROR;\r | |
284 | break;\r | |
285 | }\r | |
286 | \r | |
41e8ff27 | 287 | //\r |
288 | // Software must not write a one to this field unless the host controller\r | |
68246fa8 | 289 | // is in the Halted state. Doing so will yield undefined results.\r |
41e8ff27 | 290 | // refers to Spec[EHCI1.0-2.3.1]\r |
68246fa8 | 291 | //\r |
41e8ff27 | 292 | if (!EHC_REG_BIT_IS_SET (Ehc, EHC_USBSTS_OFFSET, USBSTS_HALT)) {\r |
293 | Status = EFI_DEVICE_ERROR;\r | |
294 | break;\r | |
295 | }\r | |
296 | \r | |
297 | Status = EhcRunHC (Ehc, EHC_GENERIC_TIMEOUT);\r | |
913cb9dc | 298 | break;\r |
299 | \r | |
300 | case EfiUsbHcStateSuspend:\r | |
301 | Status = EFI_UNSUPPORTED;\r | |
302 | break;\r | |
303 | \r | |
304 | default:\r | |
305 | Status = EFI_INVALID_PARAMETER;\r | |
306 | }\r | |
307 | \r | |
1c619535 | 308 | DEBUG ((EFI_D_INFO, "EhcSetState: exit status %r\n", Status));\r |
913cb9dc | 309 | gBS->RestoreTPL (OldTpl);\r |
310 | return Status;\r | |
311 | }\r | |
312 | \r | |
313 | \r | |
314 | /**\r | |
315 | Retrieves the current status of a USB root hub port.\r | |
316 | \r | |
78c2ffb5 | 317 | @param This This EFI_USB2_HC_PROTOCOL instance.\r |
318 | @param PortNumber The root hub port to retrieve the state from.\r | |
319 | This value is zero-based.\r | |
320 | @param PortStatus Variable to receive the port state.\r | |
913cb9dc | 321 | \r |
78c2ffb5 | 322 | @retval EFI_SUCCESS The status of the USB root hub port specified.\r |
323 | by PortNumber was returned in PortStatus.\r | |
324 | @retval EFI_INVALID_PARAMETER PortNumber is invalid.\r | |
325 | @retval EFI_DEVICE_ERROR Can't read register.\r | |
913cb9dc | 326 | \r |
327 | **/\r | |
913cb9dc | 328 | EFI_STATUS\r |
329 | EFIAPI\r | |
330 | EhcGetRootHubPortStatus (\r | |
db0f0d3c | 331 | IN EFI_USB2_HC_PROTOCOL *This,\r |
332 | IN UINT8 PortNumber,\r | |
333 | OUT EFI_USB_PORT_STATUS *PortStatus\r | |
913cb9dc | 334 | )\r |
335 | {\r | |
336 | USB2_HC_DEV *Ehc;\r | |
337 | EFI_TPL OldTpl;\r | |
338 | UINT32 Offset;\r | |
339 | UINT32 State;\r | |
340 | UINT32 TotalPort;\r | |
341 | UINTN Index;\r | |
342 | UINTN MapSize;\r | |
343 | EFI_STATUS Status;\r | |
344 | \r | |
345 | if (PortStatus == NULL) {\r | |
346 | return EFI_INVALID_PARAMETER;\r | |
347 | }\r | |
348 | \r | |
349 | OldTpl = gBS->RaiseTPL (EHC_TPL);\r | |
350 | \r | |
351 | Ehc = EHC_FROM_THIS (This);\r | |
352 | Status = EFI_SUCCESS;\r | |
353 | \r | |
354 | TotalPort = (Ehc->HcStructParams & HCSP_NPORTS);\r | |
355 | \r | |
356 | if (PortNumber >= TotalPort) {\r | |
357 | Status = EFI_INVALID_PARAMETER;\r | |
358 | goto ON_EXIT;\r | |
359 | }\r | |
360 | \r | |
361 | Offset = (UINT32) (EHC_PORT_STAT_OFFSET + (4 * PortNumber));\r | |
362 | PortStatus->PortStatus = 0;\r | |
363 | PortStatus->PortChangeStatus = 0;\r | |
364 | \r | |
b48ec0e8 LE |
365 | if (EhcIsDebugPortInUse (Ehc, &PortNumber)) {\r |
366 | goto ON_EXIT;\r | |
09943f5e | 367 | }\r |
368 | \r | |
913cb9dc | 369 | State = EhcReadOpReg (Ehc, Offset);\r |
370 | \r | |
371 | //\r | |
372 | // Identify device speed. If in K state, it is low speed.\r | |
373 | // If the port is enabled after reset, the device is of\r | |
374 | // high speed. The USB bus driver should retrieve the actual\r | |
375 | // port speed after reset.\r | |
376 | //\r | |
377 | if (EHC_BIT_IS_SET (State, PORTSC_LINESTATE_K)) {\r | |
378 | PortStatus->PortStatus |= USB_PORT_STAT_LOW_SPEED;\r | |
379 | \r | |
380 | } else if (EHC_BIT_IS_SET (State, PORTSC_ENABLED)) {\r | |
381 | PortStatus->PortStatus |= USB_PORT_STAT_HIGH_SPEED;\r | |
382 | }\r | |
383 | \r | |
384 | //\r | |
385 | // Convert the EHCI port/port change state to UEFI status\r | |
386 | //\r | |
387 | MapSize = sizeof (mUsbPortStateMap) / sizeof (USB_PORT_STATE_MAP);\r | |
388 | \r | |
389 | for (Index = 0; Index < MapSize; Index++) {\r | |
390 | if (EHC_BIT_IS_SET (State, mUsbPortStateMap[Index].HwState)) {\r | |
c52fa98c | 391 | PortStatus->PortStatus = (UINT16) (PortStatus->PortStatus | mUsbPortStateMap[Index].UefiState);\r |
913cb9dc | 392 | }\r |
393 | }\r | |
394 | \r | |
395 | MapSize = sizeof (mUsbPortChangeMap) / sizeof (USB_PORT_STATE_MAP);\r | |
396 | \r | |
397 | for (Index = 0; Index < MapSize; Index++) {\r | |
398 | if (EHC_BIT_IS_SET (State, mUsbPortChangeMap[Index].HwState)) {\r | |
c52fa98c | 399 | PortStatus->PortChangeStatus = (UINT16) (PortStatus->PortChangeStatus | mUsbPortChangeMap[Index].UefiState);\r |
913cb9dc | 400 | }\r |
401 | }\r | |
402 | \r | |
403 | ON_EXIT:\r | |
404 | gBS->RestoreTPL (OldTpl);\r | |
405 | return Status;\r | |
406 | }\r | |
407 | \r | |
408 | \r | |
409 | /**\r | |
410 | Sets a feature for the specified root hub port.\r | |
411 | \r | |
78c2ffb5 | 412 | @param This This EFI_USB2_HC_PROTOCOL instance.\r |
413 | @param PortNumber Root hub port to set.\r | |
414 | @param PortFeature Feature to set.\r | |
913cb9dc | 415 | \r |
78c2ffb5 | 416 | @retval EFI_SUCCESS The feature specified by PortFeature was set.\r |
417 | @retval EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid.\r | |
418 | @retval EFI_DEVICE_ERROR Can't read register.\r | |
913cb9dc | 419 | \r |
420 | **/\r | |
913cb9dc | 421 | EFI_STATUS\r |
422 | EFIAPI\r | |
423 | EhcSetRootHubPortFeature (\r | |
424 | IN EFI_USB2_HC_PROTOCOL *This,\r | |
425 | IN UINT8 PortNumber,\r | |
426 | IN EFI_USB_PORT_FEATURE PortFeature\r | |
427 | )\r | |
428 | {\r | |
429 | USB2_HC_DEV *Ehc;\r | |
430 | EFI_TPL OldTpl;\r | |
431 | UINT32 Offset;\r | |
432 | UINT32 State;\r | |
433 | UINT32 TotalPort;\r | |
434 | EFI_STATUS Status;\r | |
435 | \r | |
436 | OldTpl = gBS->RaiseTPL (EHC_TPL);\r | |
437 | Ehc = EHC_FROM_THIS (This);\r | |
438 | Status = EFI_SUCCESS;\r | |
439 | \r | |
440 | TotalPort = (Ehc->HcStructParams & HCSP_NPORTS);\r | |
441 | \r | |
442 | if (PortNumber >= TotalPort) {\r | |
443 | Status = EFI_INVALID_PARAMETER;\r | |
444 | goto ON_EXIT;\r | |
445 | }\r | |
446 | \r | |
447 | Offset = (UINT32) (EHC_PORT_STAT_OFFSET + (4 * PortNumber));\r | |
448 | State = EhcReadOpReg (Ehc, Offset);\r | |
449 | \r | |
450 | //\r | |
451 | // Mask off the port status change bits, these bits are\r | |
452 | // write clean bit\r | |
453 | //\r | |
454 | State &= ~PORTSC_CHANGE_MASK;\r | |
455 | \r | |
456 | switch (PortFeature) {\r | |
457 | case EfiUsbPortEnable:\r | |
458 | //\r | |
459 | // Sofeware can't set this bit, Port can only be enable by\r | |
460 | // EHCI as a part of the reset and enable\r | |
461 | //\r | |
462 | State |= PORTSC_ENABLED;\r | |
463 | EhcWriteOpReg (Ehc, Offset, State);\r | |
464 | break;\r | |
465 | \r | |
466 | case EfiUsbPortSuspend:\r | |
467 | State |= PORTSC_SUSPEND;\r | |
468 | EhcWriteOpReg (Ehc, Offset, State);\r | |
469 | break;\r | |
470 | \r | |
471 | case EfiUsbPortReset:\r | |
472 | //\r | |
473 | // Make sure Host Controller not halt before reset it\r | |
474 | //\r | |
475 | if (EhcIsHalt (Ehc)) {\r | |
41e8ff27 | 476 | Status = EhcRunHC (Ehc, EHC_GENERIC_TIMEOUT);\r |
913cb9dc | 477 | \r |
478 | if (EFI_ERROR (Status)) {\r | |
1c619535 | 479 | DEBUG ((EFI_D_INFO, "EhcSetRootHubPortFeature :failed to start HC - %r\n", Status));\r |
913cb9dc | 480 | break;\r |
481 | }\r | |
482 | }\r | |
68246fa8 | 483 | \r |
913cb9dc | 484 | //\r |
485 | // Set one to PortReset bit must also set zero to PortEnable bit\r | |
486 | //\r | |
487 | State |= PORTSC_RESET;\r | |
488 | State &= ~PORTSC_ENABLED;\r | |
489 | EhcWriteOpReg (Ehc, Offset, State);\r | |
490 | break;\r | |
491 | \r | |
492 | case EfiUsbPortPower:\r | |
493 | //\r | |
f01219e8 | 494 | // Set port power bit when PPC is 1\r |
913cb9dc | 495 | //\r |
f01219e8 | 496 | if ((Ehc->HcCapParams & HCSP_PPC) == HCSP_PPC) {\r |
497 | State |= PORTSC_POWER;\r | |
498 | EhcWriteOpReg (Ehc, Offset, State);\r | |
499 | }\r | |
913cb9dc | 500 | break;\r |
501 | \r | |
502 | case EfiUsbPortOwner:\r | |
503 | State |= PORTSC_OWNER;\r | |
504 | EhcWriteOpReg (Ehc, Offset, State);\r | |
505 | break;\r | |
506 | \r | |
507 | default:\r | |
508 | Status = EFI_INVALID_PARAMETER;\r | |
509 | }\r | |
510 | \r | |
511 | ON_EXIT:\r | |
1c619535 | 512 | DEBUG ((EFI_D_INFO, "EhcSetRootHubPortFeature: exit status %r\n", Status));\r |
913cb9dc | 513 | \r |
514 | gBS->RestoreTPL (OldTpl);\r | |
515 | return Status;\r | |
516 | }\r | |
517 | \r | |
518 | \r | |
519 | /**\r | |
520 | Clears a feature for the specified root hub port.\r | |
521 | \r | |
78c2ffb5 | 522 | @param This A pointer to the EFI_USB2_HC_PROTOCOL instance.\r |
523 | @param PortNumber Specifies the root hub port whose feature is\r | |
524 | requested to be cleared.\r | |
525 | @param PortFeature Indicates the feature selector associated with the\r | |
526 | feature clear request.\r | |
913cb9dc | 527 | \r |
78c2ffb5 | 528 | @retval EFI_SUCCESS The feature specified by PortFeature was cleared\r |
529 | for the USB root hub port specified by PortNumber.\r | |
530 | @retval EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid.\r | |
531 | @retval EFI_DEVICE_ERROR Can't read register.\r | |
913cb9dc | 532 | \r |
533 | **/\r | |
913cb9dc | 534 | EFI_STATUS\r |
535 | EFIAPI\r | |
536 | EhcClearRootHubPortFeature (\r | |
537 | IN EFI_USB2_HC_PROTOCOL *This,\r | |
538 | IN UINT8 PortNumber,\r | |
539 | IN EFI_USB_PORT_FEATURE PortFeature\r | |
540 | )\r | |
541 | {\r | |
542 | USB2_HC_DEV *Ehc;\r | |
543 | EFI_TPL OldTpl;\r | |
544 | UINT32 Offset;\r | |
545 | UINT32 State;\r | |
546 | UINT32 TotalPort;\r | |
547 | EFI_STATUS Status;\r | |
548 | \r | |
549 | OldTpl = gBS->RaiseTPL (EHC_TPL);\r | |
550 | Ehc = EHC_FROM_THIS (This);\r | |
551 | Status = EFI_SUCCESS;\r | |
552 | \r | |
553 | TotalPort = (Ehc->HcStructParams & HCSP_NPORTS);\r | |
554 | \r | |
555 | if (PortNumber >= TotalPort) {\r | |
556 | Status = EFI_INVALID_PARAMETER;\r | |
557 | goto ON_EXIT;\r | |
558 | }\r | |
559 | \r | |
560 | Offset = EHC_PORT_STAT_OFFSET + (4 * PortNumber);\r | |
561 | State = EhcReadOpReg (Ehc, Offset);\r | |
562 | State &= ~PORTSC_CHANGE_MASK;\r | |
563 | \r | |
564 | switch (PortFeature) {\r | |
565 | case EfiUsbPortEnable:\r | |
566 | //\r | |
567 | // Clear PORT_ENABLE feature means disable port.\r | |
568 | //\r | |
569 | State &= ~PORTSC_ENABLED;\r | |
570 | EhcWriteOpReg (Ehc, Offset, State);\r | |
571 | break;\r | |
572 | \r | |
573 | case EfiUsbPortSuspend:\r | |
574 | //\r | |
575 | // A write of zero to this bit is ignored by the host\r | |
576 | // controller. The host controller will unconditionally\r | |
577 | // set this bit to a zero when:\r | |
578 | // 1. software sets the Forct Port Resume bit to a zero from a one.\r | |
579 | // 2. software sets the Port Reset bit to a one frome a zero.\r | |
580 | //\r | |
581 | State &= ~PORSTSC_RESUME;\r | |
582 | EhcWriteOpReg (Ehc, Offset, State);\r | |
583 | break;\r | |
584 | \r | |
585 | case EfiUsbPortReset:\r | |
586 | //\r | |
587 | // Clear PORT_RESET means clear the reset signal.\r | |
588 | //\r | |
589 | State &= ~PORTSC_RESET;\r | |
590 | EhcWriteOpReg (Ehc, Offset, State);\r | |
591 | break;\r | |
592 | \r | |
593 | case EfiUsbPortOwner:\r | |
594 | //\r | |
595 | // Clear port owner means this port owned by EHC\r | |
596 | //\r | |
597 | State &= ~PORTSC_OWNER;\r | |
598 | EhcWriteOpReg (Ehc, Offset, State);\r | |
599 | break;\r | |
600 | \r | |
601 | case EfiUsbPortConnectChange:\r | |
602 | //\r | |
603 | // Clear connect status change\r | |
604 | //\r | |
605 | State |= PORTSC_CONN_CHANGE;\r | |
606 | EhcWriteOpReg (Ehc, Offset, State);\r | |
607 | break;\r | |
608 | \r | |
609 | case EfiUsbPortEnableChange:\r | |
610 | //\r | |
611 | // Clear enable status change\r | |
612 | //\r | |
613 | State |= PORTSC_ENABLE_CHANGE;\r | |
614 | EhcWriteOpReg (Ehc, Offset, State);\r | |
615 | break;\r | |
616 | \r | |
617 | case EfiUsbPortOverCurrentChange:\r | |
618 | //\r | |
619 | // Clear PortOverCurrent change\r | |
620 | //\r | |
621 | State |= PORTSC_OVERCUR_CHANGE;\r | |
622 | EhcWriteOpReg (Ehc, Offset, State);\r | |
623 | break;\r | |
624 | \r | |
625 | case EfiUsbPortPower:\r | |
f01219e8 | 626 | //\r |
627 | // Clear port power bit when PPC is 1\r | |
628 | //\r | |
629 | if ((Ehc->HcCapParams & HCSP_PPC) == HCSP_PPC) {\r | |
630 | State &= ~PORTSC_POWER;\r | |
631 | EhcWriteOpReg (Ehc, Offset, State);\r | |
632 | }\r | |
633 | break;\r | |
913cb9dc | 634 | case EfiUsbPortSuspendChange:\r |
635 | case EfiUsbPortResetChange:\r | |
636 | //\r | |
637 | // Not supported or not related operation\r | |
638 | //\r | |
639 | break;\r | |
640 | \r | |
641 | default:\r | |
642 | Status = EFI_INVALID_PARAMETER;\r | |
643 | break;\r | |
644 | }\r | |
645 | \r | |
646 | ON_EXIT:\r | |
1c619535 | 647 | DEBUG ((EFI_D_INFO, "EhcClearRootHubPortFeature: exit status %r\n", Status));\r |
913cb9dc | 648 | gBS->RestoreTPL (OldTpl);\r |
649 | return Status;\r | |
650 | }\r | |
651 | \r | |
652 | \r | |
653 | /**\r | |
654 | Submits control transfer to a target USB device.\r | |
655 | \r | |
78c2ffb5 | 656 | @param This This EFI_USB2_HC_PROTOCOL instance.\r |
657 | @param DeviceAddress The target device address.\r | |
658 | @param DeviceSpeed Target device speed.\r | |
659 | @param MaximumPacketLength Maximum packet size the default control transfer\r | |
660 | endpoint is capable of sending or receiving.\r | |
661 | @param Request USB device request to send.\r | |
662 | @param TransferDirection Specifies the data direction for the data stage\r | |
663 | @param Data Data buffer to be transmitted or received from USB\r | |
664 | device.\r | |
665 | @param DataLength The size (in bytes) of the data buffer.\r | |
666 | @param TimeOut Indicates the maximum timeout, in millisecond.\r | |
667 | @param Translator Transaction translator to be used by this device.\r | |
668 | @param TransferResult Return the result of this control transfer.\r | |
669 | \r | |
670 | @retval EFI_SUCCESS Transfer was completed successfully.\r | |
671 | @retval EFI_OUT_OF_RESOURCES The transfer failed due to lack of resources.\r | |
672 | @retval EFI_INVALID_PARAMETER Some parameters are invalid.\r | |
673 | @retval EFI_TIMEOUT Transfer failed due to timeout.\r | |
674 | @retval EFI_DEVICE_ERROR Transfer failed due to host controller or device error.\r | |
913cb9dc | 675 | \r |
676 | **/\r | |
913cb9dc | 677 | EFI_STATUS\r |
678 | EFIAPI\r | |
679 | EhcControlTransfer (\r | |
680 | IN EFI_USB2_HC_PROTOCOL *This,\r | |
681 | IN UINT8 DeviceAddress,\r | |
682 | IN UINT8 DeviceSpeed,\r | |
683 | IN UINTN MaximumPacketLength,\r | |
684 | IN EFI_USB_DEVICE_REQUEST *Request,\r | |
685 | IN EFI_USB_DATA_DIRECTION TransferDirection,\r | |
686 | IN OUT VOID *Data,\r | |
687 | IN OUT UINTN *DataLength,\r | |
688 | IN UINTN TimeOut,\r | |
689 | IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator,\r | |
690 | OUT UINT32 *TransferResult\r | |
691 | )\r | |
692 | {\r | |
693 | USB2_HC_DEV *Ehc;\r | |
694 | URB *Urb;\r | |
695 | EFI_TPL OldTpl;\r | |
696 | UINT8 Endpoint;\r | |
697 | EFI_STATUS Status;\r | |
698 | \r | |
699 | //\r | |
700 | // Validate parameters\r | |
701 | //\r | |
702 | if ((Request == NULL) || (TransferResult == NULL)) {\r | |
703 | return EFI_INVALID_PARAMETER;\r | |
704 | }\r | |
705 | \r | |
706 | if ((TransferDirection != EfiUsbDataIn) &&\r | |
707 | (TransferDirection != EfiUsbDataOut) &&\r | |
708 | (TransferDirection != EfiUsbNoData)) {\r | |
709 | return EFI_INVALID_PARAMETER;\r | |
710 | }\r | |
711 | \r | |
712 | if ((TransferDirection == EfiUsbNoData) &&\r | |
713 | ((Data != NULL) || (*DataLength != 0))) {\r | |
714 | return EFI_INVALID_PARAMETER;\r | |
715 | }\r | |
716 | \r | |
717 | if ((TransferDirection != EfiUsbNoData) &&\r | |
718 | ((Data == NULL) || (*DataLength == 0))) {\r | |
719 | return EFI_INVALID_PARAMETER;\r | |
720 | }\r | |
721 | \r | |
722 | if ((MaximumPacketLength != 8) && (MaximumPacketLength != 16) &&\r | |
723 | (MaximumPacketLength != 32) && (MaximumPacketLength != 64)) {\r | |
724 | return EFI_INVALID_PARAMETER;\r | |
725 | }\r | |
726 | \r | |
727 | if ((DeviceSpeed == EFI_USB_SPEED_LOW) && (MaximumPacketLength != 8)) {\r | |
728 | return EFI_INVALID_PARAMETER;\r | |
729 | }\r | |
730 | \r | |
731 | OldTpl = gBS->RaiseTPL (EHC_TPL);\r | |
732 | Ehc = EHC_FROM_THIS (This);\r | |
733 | \r | |
734 | Status = EFI_DEVICE_ERROR;\r | |
735 | *TransferResult = EFI_USB_ERR_SYSTEM;\r | |
736 | \r | |
737 | if (EhcIsHalt (Ehc) || EhcIsSysError (Ehc)) {\r | |
1c619535 | 738 | DEBUG ((EFI_D_ERROR, "EhcControlTransfer: HC halted at entrance\n"));\r |
913cb9dc | 739 | \r |
740 | EhcAckAllInterrupt (Ehc);\r | |
741 | goto ON_EXIT;\r | |
742 | }\r | |
743 | \r | |
744 | EhcAckAllInterrupt (Ehc);\r | |
745 | \r | |
746 | //\r | |
747 | // Create a new URB, insert it into the asynchronous\r | |
748 | // schedule list, then poll the execution status.\r | |
749 | //\r | |
750 | //\r | |
751 | // Encode the direction in address, although default control\r | |
752 | // endpoint is bidirectional. EhcCreateUrb expects this\r | |
753 | // combination of Ep addr and its direction.\r | |
754 | //\r | |
c52fa98c | 755 | Endpoint = (UINT8) (0 | ((TransferDirection == EfiUsbDataIn) ? 0x80 : 0));\r |
913cb9dc | 756 | Urb = EhcCreateUrb (\r |
757 | Ehc,\r | |
758 | DeviceAddress,\r | |
759 | Endpoint,\r | |
760 | DeviceSpeed,\r | |
761 | 0,\r | |
762 | MaximumPacketLength,\r | |
763 | Translator,\r | |
764 | EHC_CTRL_TRANSFER,\r | |
765 | Request,\r | |
766 | Data,\r | |
767 | *DataLength,\r | |
768 | NULL,\r | |
769 | NULL,\r | |
770 | 1\r | |
771 | );\r | |
772 | \r | |
773 | if (Urb == NULL) {\r | |
1c619535 | 774 | DEBUG ((EFI_D_ERROR, "EhcControlTransfer: failed to create URB"));\r |
913cb9dc | 775 | \r |
776 | Status = EFI_OUT_OF_RESOURCES;\r | |
777 | goto ON_EXIT;\r | |
778 | }\r | |
779 | \r | |
780 | EhcLinkQhToAsync (Ehc, Urb->Qh);\r | |
781 | Status = EhcExecTransfer (Ehc, Urb, TimeOut);\r | |
782 | EhcUnlinkQhFromAsync (Ehc, Urb->Qh);\r | |
783 | \r | |
784 | //\r | |
785 | // Get the status from URB. The result is updated in EhcCheckUrbResult\r | |
786 | // which is called by EhcExecTransfer\r | |
787 | //\r | |
788 | *TransferResult = Urb->Result;\r | |
789 | *DataLength = Urb->Completed;\r | |
790 | \r | |
791 | if (*TransferResult == EFI_USB_NOERROR) {\r | |
792 | Status = EFI_SUCCESS;\r | |
793 | }\r | |
794 | \r | |
795 | EhcAckAllInterrupt (Ehc);\r | |
796 | EhcFreeUrb (Ehc, Urb);\r | |
797 | \r | |
798 | ON_EXIT:\r | |
799 | Ehc->PciIo->Flush (Ehc->PciIo);\r | |
800 | gBS->RestoreTPL (OldTpl);\r | |
801 | \r | |
802 | if (EFI_ERROR (Status)) {\r | |
1c619535 | 803 | DEBUG ((EFI_D_ERROR, "EhcControlTransfer: error - %r, transfer - %x\n", Status, *TransferResult));\r |
913cb9dc | 804 | }\r |
805 | \r | |
806 | return Status;\r | |
807 | }\r | |
808 | \r | |
809 | \r | |
810 | /**\r | |
811 | Submits bulk transfer to a bulk endpoint of a USB device.\r | |
812 | \r | |
78c2ffb5 | 813 | @param This This EFI_USB2_HC_PROTOCOL instance.\r |
814 | @param DeviceAddress Target device address.\r | |
815 | @param EndPointAddress Endpoint number and its direction in bit 7.\r | |
816 | @param DeviceSpeed Device speed, Low speed device doesn't support bulk\r | |
817 | transfer.\r | |
818 | @param MaximumPacketLength Maximum packet size the endpoint is capable of\r | |
819 | sending or receiving.\r | |
820 | @param DataBuffersNumber Number of data buffers prepared for the transfer.\r | |
821 | @param Data Array of pointers to the buffers of data to transmit\r | |
913cb9dc | 822 | from or receive into.\r |
78c2ffb5 | 823 | @param DataLength The lenght of the data buffer.\r |
824 | @param DataToggle On input, the initial data toggle for the transfer;\r | |
825 | On output, it is updated to to next data toggle to\r | |
826 | use of the subsequent bulk transfer.\r | |
827 | @param TimeOut Indicates the maximum time, in millisecond, which\r | |
828 | the transfer is allowed to complete.\r | |
829 | @param Translator A pointr to the transaction translator data.\r | |
830 | @param TransferResult A pointer to the detailed result information of the\r | |
831 | bulk transfer.\r | |
832 | \r | |
833 | @retval EFI_SUCCESS The transfer was completed successfully.\r | |
834 | @retval EFI_OUT_OF_RESOURCES The transfer failed due to lack of resource.\r | |
835 | @retval EFI_INVALID_PARAMETER Some parameters are invalid.\r | |
836 | @retval EFI_TIMEOUT The transfer failed due to timeout.\r | |
837 | @retval EFI_DEVICE_ERROR The transfer failed due to host controller error.\r | |
913cb9dc | 838 | \r |
839 | **/\r | |
913cb9dc | 840 | EFI_STATUS\r |
841 | EFIAPI\r | |
842 | EhcBulkTransfer (\r | |
843 | IN EFI_USB2_HC_PROTOCOL *This,\r | |
844 | IN UINT8 DeviceAddress,\r | |
845 | IN UINT8 EndPointAddress,\r | |
846 | IN UINT8 DeviceSpeed,\r | |
847 | IN UINTN MaximumPacketLength,\r | |
848 | IN UINT8 DataBuffersNumber,\r | |
849 | IN OUT VOID *Data[EFI_USB_MAX_BULK_BUFFER_NUM],\r | |
850 | IN OUT UINTN *DataLength,\r | |
851 | IN OUT UINT8 *DataToggle,\r | |
852 | IN UINTN TimeOut,\r | |
853 | IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator,\r | |
854 | OUT UINT32 *TransferResult\r | |
855 | )\r | |
856 | {\r | |
857 | USB2_HC_DEV *Ehc;\r | |
858 | URB *Urb;\r | |
859 | EFI_TPL OldTpl;\r | |
860 | EFI_STATUS Status;\r | |
861 | \r | |
862 | //\r | |
863 | // Validate the parameters\r | |
864 | //\r | |
865 | if ((DataLength == NULL) || (*DataLength == 0) ||\r | |
866 | (Data == NULL) || (Data[0] == NULL) || (TransferResult == NULL)) {\r | |
867 | return EFI_INVALID_PARAMETER;\r | |
868 | }\r | |
869 | \r | |
870 | if ((*DataToggle != 0) && (*DataToggle != 1)) {\r | |
871 | return EFI_INVALID_PARAMETER;\r | |
872 | }\r | |
873 | \r | |
874 | if ((DeviceSpeed == EFI_USB_SPEED_LOW) ||\r | |
875 | ((DeviceSpeed == EFI_USB_SPEED_FULL) && (MaximumPacketLength > 64)) ||\r | |
876 | ((EFI_USB_SPEED_HIGH == DeviceSpeed) && (MaximumPacketLength > 512))) {\r | |
877 | return EFI_INVALID_PARAMETER;\r | |
878 | }\r | |
879 | \r | |
880 | OldTpl = gBS->RaiseTPL (EHC_TPL);\r | |
881 | Ehc = EHC_FROM_THIS (This);\r | |
882 | \r | |
883 | *TransferResult = EFI_USB_ERR_SYSTEM;\r | |
884 | Status = EFI_DEVICE_ERROR;\r | |
885 | \r | |
886 | if (EhcIsHalt (Ehc) || EhcIsSysError (Ehc)) {\r | |
1c619535 | 887 | DEBUG ((EFI_D_ERROR, "EhcBulkTransfer: HC is halted\n"));\r |
913cb9dc | 888 | \r |
889 | EhcAckAllInterrupt (Ehc);\r | |
890 | goto ON_EXIT;\r | |
891 | }\r | |
892 | \r | |
893 | EhcAckAllInterrupt (Ehc);\r | |
894 | \r | |
895 | //\r | |
896 | // Create a new URB, insert it into the asynchronous\r | |
897 | // schedule list, then poll the execution status.\r | |
898 | //\r | |
899 | Urb = EhcCreateUrb (\r | |
900 | Ehc,\r | |
901 | DeviceAddress,\r | |
902 | EndPointAddress,\r | |
903 | DeviceSpeed,\r | |
904 | *DataToggle,\r | |
905 | MaximumPacketLength,\r | |
906 | Translator,\r | |
907 | EHC_BULK_TRANSFER,\r | |
908 | NULL,\r | |
909 | Data[0],\r | |
910 | *DataLength,\r | |
911 | NULL,\r | |
912 | NULL,\r | |
913 | 1\r | |
914 | );\r | |
915 | \r | |
916 | if (Urb == NULL) {\r | |
1c619535 | 917 | DEBUG ((EFI_D_ERROR, "EhcBulkTransfer: failed to create URB\n"));\r |
913cb9dc | 918 | \r |
919 | Status = EFI_OUT_OF_RESOURCES;\r | |
920 | goto ON_EXIT;\r | |
921 | }\r | |
922 | \r | |
923 | EhcLinkQhToAsync (Ehc, Urb->Qh);\r | |
924 | Status = EhcExecTransfer (Ehc, Urb, TimeOut);\r | |
925 | EhcUnlinkQhFromAsync (Ehc, Urb->Qh);\r | |
926 | \r | |
927 | *TransferResult = Urb->Result;\r | |
928 | *DataLength = Urb->Completed;\r | |
929 | *DataToggle = Urb->DataToggle;\r | |
930 | \r | |
931 | if (*TransferResult == EFI_USB_NOERROR) {\r | |
932 | Status = EFI_SUCCESS;\r | |
933 | }\r | |
934 | \r | |
935 | EhcAckAllInterrupt (Ehc);\r | |
936 | EhcFreeUrb (Ehc, Urb);\r | |
937 | \r | |
938 | ON_EXIT:\r | |
939 | Ehc->PciIo->Flush (Ehc->PciIo);\r | |
940 | gBS->RestoreTPL (OldTpl);\r | |
941 | \r | |
942 | if (EFI_ERROR (Status)) {\r | |
1c619535 | 943 | DEBUG ((EFI_D_ERROR, "EhcBulkTransfer: error - %r, transfer - %x\n", Status, *TransferResult));\r |
913cb9dc | 944 | }\r |
945 | \r | |
946 | return Status;\r | |
947 | }\r | |
948 | \r | |
949 | \r | |
950 | /**\r | |
951 | Submits an asynchronous interrupt transfer to an\r | |
952 | interrupt endpoint of a USB device.\r | |
953 | \r | |
78c2ffb5 | 954 | @param This This EFI_USB2_HC_PROTOCOL instance.\r |
955 | @param DeviceAddress Target device address.\r | |
956 | @param EndPointAddress Endpoint number and its direction encoded in bit 7\r | |
957 | @param DeviceSpeed Indicates device speed.\r | |
958 | @param MaximumPacketLength Maximum packet size the target endpoint is capable\r | |
959 | @param IsNewTransfer If TRUE, to submit an new asynchronous interrupt\r | |
960 | transfer If FALSE, to remove the specified\r | |
961 | asynchronous interrupt.\r | |
962 | @param DataToggle On input, the initial data toggle to use; on output,\r | |
963 | it is updated to indicate the next data toggle.\r | |
964 | @param PollingInterval The he interval, in milliseconds, that the transfer\r | |
965 | is polled.\r | |
966 | @param DataLength The length of data to receive at the rate specified\r | |
967 | by PollingInterval.\r | |
968 | @param Translator Transaction translator to use.\r | |
969 | @param CallBackFunction Function to call at the rate specified by\r | |
970 | PollingInterval.\r | |
971 | @param Context Context to CallBackFunction.\r | |
972 | \r | |
973 | @retval EFI_SUCCESS The request has been successfully submitted or canceled.\r | |
974 | @retval EFI_INVALID_PARAMETER Some parameters are invalid.\r | |
975 | @retval EFI_OUT_OF_RESOURCES The request failed due to a lack of resources.\r | |
976 | @retval EFI_DEVICE_ERROR The transfer failed due to host controller error.\r | |
913cb9dc | 977 | \r |
978 | **/\r | |
913cb9dc | 979 | EFI_STATUS\r |
980 | EFIAPI\r | |
981 | EhcAsyncInterruptTransfer (\r | |
982 | IN EFI_USB2_HC_PROTOCOL * This,\r | |
983 | IN UINT8 DeviceAddress,\r | |
984 | IN UINT8 EndPointAddress,\r | |
985 | IN UINT8 DeviceSpeed,\r | |
986 | IN UINTN MaximumPacketLength,\r | |
987 | IN BOOLEAN IsNewTransfer,\r | |
988 | IN OUT UINT8 *DataToggle,\r | |
989 | IN UINTN PollingInterval,\r | |
990 | IN UINTN DataLength,\r | |
991 | IN EFI_USB2_HC_TRANSACTION_TRANSLATOR * Translator,\r | |
992 | IN EFI_ASYNC_USB_TRANSFER_CALLBACK CallBackFunction,\r | |
993 | IN VOID *Context OPTIONAL\r | |
994 | )\r | |
995 | {\r | |
996 | USB2_HC_DEV *Ehc;\r | |
997 | URB *Urb;\r | |
998 | EFI_TPL OldTpl;\r | |
999 | EFI_STATUS Status;\r | |
913cb9dc | 1000 | \r |
1001 | //\r | |
1002 | // Validate parameters\r | |
1003 | //\r | |
e172ea16 | 1004 | if (!EHCI_IS_DATAIN (EndPointAddress)) {\r |
913cb9dc | 1005 | return EFI_INVALID_PARAMETER;\r |
1006 | }\r | |
1007 | \r | |
1008 | if (IsNewTransfer) {\r | |
1009 | if (DataLength == 0) {\r | |
1010 | return EFI_INVALID_PARAMETER;\r | |
1011 | }\r | |
1012 | \r | |
1013 | if ((*DataToggle != 1) && (*DataToggle != 0)) {\r | |
1014 | return EFI_INVALID_PARAMETER;\r | |
1015 | }\r | |
1016 | \r | |
1017 | if ((PollingInterval > 255) || (PollingInterval < 1)) {\r | |
1018 | return EFI_INVALID_PARAMETER;\r | |
1019 | }\r | |
1020 | }\r | |
1021 | \r | |
1022 | OldTpl = gBS->RaiseTPL (EHC_TPL);\r | |
1023 | Ehc = EHC_FROM_THIS (This);\r | |
1024 | \r | |
1025 | //\r | |
1026 | // Delete Async interrupt transfer request. DataToggle will return\r | |
1027 | // the next data toggle to use.\r | |
1028 | //\r | |
1029 | if (!IsNewTransfer) {\r | |
1030 | Status = EhciDelAsyncIntTransfer (Ehc, DeviceAddress, EndPointAddress, DataToggle);\r | |
1031 | \r | |
1c619535 | 1032 | DEBUG ((EFI_D_INFO, "EhcAsyncInterruptTransfer: remove old transfer - %r\n", Status));\r |
913cb9dc | 1033 | goto ON_EXIT;\r |
1034 | }\r | |
1035 | \r | |
1036 | Status = EFI_SUCCESS;\r | |
1037 | \r | |
1038 | if (EhcIsHalt (Ehc) || EhcIsSysError (Ehc)) {\r | |
1c619535 | 1039 | DEBUG ((EFI_D_ERROR, "EhcAsyncInterruptTransfer: HC is halt\n"));\r |
913cb9dc | 1040 | EhcAckAllInterrupt (Ehc);\r |
1041 | \r | |
1042 | Status = EFI_DEVICE_ERROR;\r | |
1043 | goto ON_EXIT;\r | |
1044 | }\r | |
1045 | \r | |
1046 | EhcAckAllInterrupt (Ehc);\r | |
1047 | \r | |
4f792685 | 1048 | Urb = EhciInsertAsyncIntTransfer (\r |
913cb9dc | 1049 | Ehc,\r |
1050 | DeviceAddress,\r | |
1051 | EndPointAddress,\r | |
1052 | DeviceSpeed,\r | |
1053 | *DataToggle,\r | |
1054 | MaximumPacketLength,\r | |
1055 | Translator,\r | |
913cb9dc | 1056 | DataLength,\r |
1057 | CallBackFunction,\r | |
1058 | Context,\r | |
1059 | PollingInterval\r | |
1060 | );\r | |
1061 | \r | |
1062 | if (Urb == NULL) {\r | |
913cb9dc | 1063 | Status = EFI_OUT_OF_RESOURCES;\r |
1064 | goto ON_EXIT;\r | |
1065 | }\r | |
1066 | \r | |
913cb9dc | 1067 | ON_EXIT:\r |
1068 | Ehc->PciIo->Flush (Ehc->PciIo);\r | |
1069 | gBS->RestoreTPL (OldTpl);\r | |
1070 | \r | |
1071 | return Status;\r | |
1072 | }\r | |
1073 | \r | |
1074 | \r | |
1075 | /**\r | |
1076 | Submits synchronous interrupt transfer to an interrupt endpoint\r | |
1077 | of a USB device.\r | |
1078 | \r | |
78c2ffb5 | 1079 | @param This This EFI_USB2_HC_PROTOCOL instance.\r |
1080 | @param DeviceAddress Target device address.\r | |
1081 | @param EndPointAddress Endpoint number and its direction encoded in bit 7\r | |
1082 | @param DeviceSpeed Indicates device speed.\r | |
1083 | @param MaximumPacketLength Maximum packet size the target endpoint is capable\r | |
1084 | of sending or receiving.\r | |
1085 | @param Data Buffer of data that will be transmitted to USB\r | |
1086 | device or received from USB device.\r | |
1087 | @param DataLength On input, the size, in bytes, of the data buffer; On\r | |
1088 | output, the number of bytes transferred.\r | |
1089 | @param DataToggle On input, the initial data toggle to use; on output,\r | |
1090 | it is updated to indicate the next data toggle.\r | |
1091 | @param TimeOut Maximum time, in second, to complete.\r | |
1092 | @param Translator Transaction translator to use.\r | |
1093 | @param TransferResult Variable to receive the transfer result.\r | |
1094 | \r | |
1095 | @return EFI_SUCCESS The transfer was completed successfully.\r | |
1096 | @return EFI_OUT_OF_RESOURCES The transfer failed due to lack of resource.\r | |
1097 | @return EFI_INVALID_PARAMETER Some parameters are invalid.\r | |
1098 | @return EFI_TIMEOUT The transfer failed due to timeout.\r | |
1099 | @return EFI_DEVICE_ERROR The failed due to host controller or device error\r | |
913cb9dc | 1100 | \r |
1101 | **/\r | |
913cb9dc | 1102 | EFI_STATUS\r |
1103 | EFIAPI\r | |
1104 | EhcSyncInterruptTransfer (\r | |
1105 | IN EFI_USB2_HC_PROTOCOL *This,\r | |
1106 | IN UINT8 DeviceAddress,\r | |
1107 | IN UINT8 EndPointAddress,\r | |
1108 | IN UINT8 DeviceSpeed,\r | |
1109 | IN UINTN MaximumPacketLength,\r | |
1110 | IN OUT VOID *Data,\r | |
1111 | IN OUT UINTN *DataLength,\r | |
1112 | IN OUT UINT8 *DataToggle,\r | |
1113 | IN UINTN TimeOut,\r | |
1114 | IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator,\r | |
1115 | OUT UINT32 *TransferResult\r | |
1116 | )\r | |
1117 | {\r | |
1118 | USB2_HC_DEV *Ehc;\r | |
1119 | EFI_TPL OldTpl;\r | |
1120 | URB *Urb;\r | |
1121 | EFI_STATUS Status;\r | |
1122 | \r | |
1123 | //\r | |
1124 | // Validates parameters\r | |
1125 | //\r | |
1126 | if ((DataLength == NULL) || (*DataLength == 0) ||\r | |
1127 | (Data == NULL) || (TransferResult == NULL)) {\r | |
1128 | return EFI_INVALID_PARAMETER;\r | |
1129 | }\r | |
1130 | \r | |
913cb9dc | 1131 | if ((*DataToggle != 1) && (*DataToggle != 0)) {\r |
1132 | return EFI_INVALID_PARAMETER;\r | |
1133 | }\r | |
1134 | \r | |
1135 | if (((DeviceSpeed == EFI_USB_SPEED_LOW) && (MaximumPacketLength != 8)) ||\r | |
1136 | ((DeviceSpeed == EFI_USB_SPEED_FULL) && (MaximumPacketLength > 64)) ||\r | |
1137 | ((DeviceSpeed == EFI_USB_SPEED_HIGH) && (MaximumPacketLength > 3072))) {\r | |
1138 | return EFI_INVALID_PARAMETER;\r | |
1139 | }\r | |
1140 | \r | |
1141 | OldTpl = gBS->RaiseTPL (EHC_TPL);\r | |
1142 | Ehc = EHC_FROM_THIS (This);\r | |
1143 | \r | |
1144 | *TransferResult = EFI_USB_ERR_SYSTEM;\r | |
1145 | Status = EFI_DEVICE_ERROR;\r | |
1146 | \r | |
1147 | if (EhcIsHalt (Ehc) || EhcIsSysError (Ehc)) {\r | |
1c619535 | 1148 | DEBUG ((EFI_D_ERROR, "EhcSyncInterruptTransfer: HC is halt\n"));\r |
913cb9dc | 1149 | \r |
1150 | EhcAckAllInterrupt (Ehc);\r | |
1151 | goto ON_EXIT;\r | |
1152 | }\r | |
1153 | \r | |
1154 | EhcAckAllInterrupt (Ehc);\r | |
1155 | \r | |
1156 | Urb = EhcCreateUrb (\r | |
1157 | Ehc,\r | |
1158 | DeviceAddress,\r | |
1159 | EndPointAddress,\r | |
1160 | DeviceSpeed,\r | |
1161 | *DataToggle,\r | |
1162 | MaximumPacketLength,\r | |
1163 | Translator,\r | |
1164 | EHC_INT_TRANSFER_SYNC,\r | |
1165 | NULL,\r | |
1166 | Data,\r | |
1167 | *DataLength,\r | |
1168 | NULL,\r | |
1169 | NULL,\r | |
1170 | 1\r | |
1171 | );\r | |
1172 | \r | |
1173 | if (Urb == NULL) {\r | |
1c619535 | 1174 | DEBUG ((EFI_D_ERROR, "EhcSyncInterruptTransfer: failed to create URB\n"));\r |
913cb9dc | 1175 | \r |
1176 | Status = EFI_OUT_OF_RESOURCES;\r | |
1177 | goto ON_EXIT;\r | |
1178 | }\r | |
1179 | \r | |
1180 | EhcLinkQhToPeriod (Ehc, Urb->Qh);\r | |
1181 | Status = EhcExecTransfer (Ehc, Urb, TimeOut);\r | |
1182 | EhcUnlinkQhFromPeriod (Ehc, Urb->Qh);\r | |
1183 | \r | |
1184 | *TransferResult = Urb->Result;\r | |
1185 | *DataLength = Urb->Completed;\r | |
1186 | *DataToggle = Urb->DataToggle;\r | |
1187 | \r | |
1188 | if (*TransferResult == EFI_USB_NOERROR) {\r | |
1189 | Status = EFI_SUCCESS;\r | |
1190 | }\r | |
1191 | \r | |
c74805f1 | 1192 | EhcFreeUrb (Ehc, Urb);\r |
913cb9dc | 1193 | ON_EXIT:\r |
1194 | Ehc->PciIo->Flush (Ehc->PciIo);\r | |
1195 | gBS->RestoreTPL (OldTpl);\r | |
1196 | \r | |
1197 | if (EFI_ERROR (Status)) {\r | |
1c619535 | 1198 | DEBUG ((EFI_D_ERROR, "EhcSyncInterruptTransfer: error - %r, transfer - %x\n", Status, *TransferResult));\r |
913cb9dc | 1199 | }\r |
1200 | \r | |
1201 | return Status;\r | |
1202 | }\r | |
1203 | \r | |
1204 | \r | |
1205 | /**\r | |
1206 | Submits isochronous transfer to a target USB device.\r | |
1207 | \r | |
1208 | @param This This EFI_USB2_HC_PROTOCOL instance.\r | |
78c2ffb5 | 1209 | @param DeviceAddress Target device address.\r |
1210 | @param EndPointAddress End point address with its direction.\r | |
913cb9dc | 1211 | @param DeviceSpeed Device speed, Low speed device doesn't support this\r |
1212 | type.\r | |
1213 | @param MaximumPacketLength Maximum packet size that the endpoint is capable of\r | |
1214 | sending or receiving.\r | |
1215 | @param DataBuffersNumber Number of data buffers prepared for the transfer.\r | |
1216 | @param Data Array of pointers to the buffers of data that will\r | |
1217 | be transmitted to USB device or received from USB\r | |
1218 | device.\r | |
78c2ffb5 | 1219 | @param DataLength The size, in bytes, of the data buffer.\r |
913cb9dc | 1220 | @param Translator Transaction translator to use.\r |
78c2ffb5 | 1221 | @param TransferResult Variable to receive the transfer result.\r |
913cb9dc | 1222 | \r |
78c2ffb5 | 1223 | @return EFI_UNSUPPORTED Isochronous transfer is unsupported.\r |
913cb9dc | 1224 | \r |
1225 | **/\r | |
913cb9dc | 1226 | EFI_STATUS\r |
1227 | EFIAPI\r | |
1228 | EhcIsochronousTransfer (\r | |
1229 | IN EFI_USB2_HC_PROTOCOL *This,\r | |
1230 | IN UINT8 DeviceAddress,\r | |
1231 | IN UINT8 EndPointAddress,\r | |
1232 | IN UINT8 DeviceSpeed,\r | |
1233 | IN UINTN MaximumPacketLength,\r | |
1234 | IN UINT8 DataBuffersNumber,\r | |
1235 | IN OUT VOID *Data[EFI_USB_MAX_ISO_BUFFER_NUM],\r | |
1236 | IN UINTN DataLength,\r | |
1237 | IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator,\r | |
1238 | OUT UINT32 *TransferResult\r | |
1239 | )\r | |
1240 | {\r | |
1241 | return EFI_UNSUPPORTED;\r | |
1242 | }\r | |
1243 | \r | |
1244 | \r | |
1245 | /**\r | |
1246 | Submits Async isochronous transfer to a target USB device.\r | |
1247 | \r | |
1248 | @param This This EFI_USB2_HC_PROTOCOL instance.\r | |
78c2ffb5 | 1249 | @param DeviceAddress Target device address.\r |
1250 | @param EndPointAddress End point address with its direction.\r | |
913cb9dc | 1251 | @param DeviceSpeed Device speed, Low speed device doesn't support this\r |
1252 | type.\r | |
1253 | @param MaximumPacketLength Maximum packet size that the endpoint is capable of\r | |
1254 | sending or receiving.\r | |
1255 | @param DataBuffersNumber Number of data buffers prepared for the transfer.\r | |
1256 | @param Data Array of pointers to the buffers of data that will\r | |
1257 | be transmitted to USB device or received from USB\r | |
1258 | device.\r | |
78c2ffb5 | 1259 | @param DataLength The size, in bytes, of the data buffer.\r |
913cb9dc | 1260 | @param Translator Transaction translator to use.\r |
78c2ffb5 | 1261 | @param IsochronousCallBack Function to be called when the transfer complete.\r |
913cb9dc | 1262 | @param Context Context passed to the call back function as\r |
78c2ffb5 | 1263 | parameter.\r |
913cb9dc | 1264 | \r |
78c2ffb5 | 1265 | @return EFI_UNSUPPORTED Isochronous transfer isn't supported.\r |
913cb9dc | 1266 | \r |
1267 | **/\r | |
913cb9dc | 1268 | EFI_STATUS\r |
1269 | EFIAPI\r | |
1270 | EhcAsyncIsochronousTransfer (\r | |
1271 | IN EFI_USB2_HC_PROTOCOL *This,\r | |
1272 | IN UINT8 DeviceAddress,\r | |
1273 | IN UINT8 EndPointAddress,\r | |
1274 | IN UINT8 DeviceSpeed,\r | |
1275 | IN UINTN MaximumPacketLength,\r | |
1276 | IN UINT8 DataBuffersNumber,\r | |
1277 | IN OUT VOID *Data[EFI_USB_MAX_ISO_BUFFER_NUM],\r | |
1278 | IN UINTN DataLength,\r | |
1279 | IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator,\r | |
1280 | IN EFI_ASYNC_USB_TRANSFER_CALLBACK IsochronousCallBack,\r | |
1281 | IN VOID *Context\r | |
1282 | )\r | |
1283 | {\r | |
1284 | return EFI_UNSUPPORTED;\r | |
1285 | }\r | |
1286 | \r | |
78c2ffb5 | 1287 | /**\r |
1288 | Entry point for EFI drivers.\r | |
1289 | \r | |
1290 | @param ImageHandle EFI_HANDLE.\r | |
1291 | @param SystemTable EFI_SYSTEM_TABLE.\r | |
1292 | \r | |
1293 | @return EFI_SUCCESS Success.\r | |
1294 | EFI_DEVICE_ERROR Fail.\r | |
1295 | \r | |
1296 | **/\r | |
913cb9dc | 1297 | EFI_STATUS\r |
1298 | EFIAPI\r | |
1299 | EhcDriverEntryPoint (\r | |
1300 | IN EFI_HANDLE ImageHandle,\r | |
1301 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
1302 | )\r | |
913cb9dc | 1303 | {\r |
f527bce3 | 1304 | return EfiLibInstallDriverBindingComponentName2 (\r |
913cb9dc | 1305 | ImageHandle,\r |
1306 | SystemTable,\r | |
1307 | &gEhciDriverBinding,\r | |
1308 | ImageHandle,\r | |
1309 | &gEhciComponentName,\r | |
f527bce3 | 1310 | &gEhciComponentName2\r |
913cb9dc | 1311 | );\r |
1312 | }\r | |
1313 | \r | |
1314 | \r | |
1315 | /**\r | |
1316 | Test to see if this driver supports ControllerHandle. Any\r | |
1317 | ControllerHandle that has Usb2HcProtocol installed will\r | |
1318 | be supported.\r | |
1319 | \r | |
1320 | @param This Protocol instance pointer.\r | |
78c2ffb5 | 1321 | @param Controller Handle of device to test.\r |
1322 | @param RemainingDevicePath Not used.\r | |
913cb9dc | 1323 | \r |
78c2ffb5 | 1324 | @return EFI_SUCCESS This driver supports this device.\r |
1325 | @return EFI_UNSUPPORTED This driver does not support this device.\r | |
913cb9dc | 1326 | \r |
1327 | **/\r | |
1328 | EFI_STATUS\r | |
1329 | EFIAPI\r | |
1330 | EhcDriverBindingSupported (\r | |
1331 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
1332 | IN EFI_HANDLE Controller,\r | |
1333 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
1334 | )\r | |
1335 | {\r | |
1336 | EFI_STATUS Status;\r | |
1337 | EFI_PCI_IO_PROTOCOL *PciIo;\r | |
1338 | USB_CLASSC UsbClassCReg;\r | |
1339 | \r | |
1340 | //\r | |
1341 | // Test whether there is PCI IO Protocol attached on the controller handle.\r | |
1342 | //\r | |
1343 | Status = gBS->OpenProtocol (\r | |
1344 | Controller,\r | |
1345 | &gEfiPciIoProtocolGuid,\r | |
c52fa98c | 1346 | (VOID **) &PciIo,\r |
913cb9dc | 1347 | This->DriverBindingHandle,\r |
1348 | Controller,\r | |
1349 | EFI_OPEN_PROTOCOL_BY_DRIVER\r | |
1350 | );\r | |
1351 | \r | |
1352 | if (EFI_ERROR (Status)) {\r | |
1353 | return EFI_UNSUPPORTED;\r | |
1354 | }\r | |
1355 | \r | |
1356 | Status = PciIo->Pci.Read (\r | |
1357 | PciIo,\r | |
1358 | EfiPciIoWidthUint8,\r | |
a261044c | 1359 | PCI_CLASSCODE_OFFSET,\r |
913cb9dc | 1360 | sizeof (USB_CLASSC) / sizeof (UINT8),\r |
1361 | &UsbClassCReg\r | |
1362 | );\r | |
1363 | \r | |
1364 | if (EFI_ERROR (Status)) {\r | |
1365 | Status = EFI_UNSUPPORTED;\r | |
1366 | goto ON_EXIT;\r | |
1367 | }\r | |
1368 | \r | |
1369 | //\r | |
1370 | // Test whether the controller belongs to Ehci type\r | |
1371 | //\r | |
cd92e3fb | 1372 | if ((UsbClassCReg.BaseCode != PCI_CLASS_SERIAL) || (UsbClassCReg.SubClassCode != PCI_CLASS_SERIAL_USB)\r |
51f65b37 | 1373 | || ((UsbClassCReg.ProgInterface != PCI_IF_EHCI) && (UsbClassCReg.ProgInterface != PCI_IF_UHCI) && (UsbClassCReg.ProgInterface != PCI_IF_OHCI))) {\r |
913cb9dc | 1374 | \r |
1375 | Status = EFI_UNSUPPORTED;\r | |
1376 | }\r | |
1377 | \r | |
1378 | ON_EXIT:\r | |
1379 | gBS->CloseProtocol (\r | |
1380 | Controller,\r | |
1381 | &gEfiPciIoProtocolGuid,\r | |
1382 | This->DriverBindingHandle,\r | |
1383 | Controller\r | |
1384 | );\r | |
1385 | \r | |
1386 | return Status;\r | |
1387 | }\r | |
1388 | \r | |
09943f5e | 1389 | /**\r |
1390 | Get the usb debug port related information.\r | |
1391 | \r | |
1392 | @param Ehc The EHCI device.\r | |
1393 | \r | |
1394 | @retval RETURN_SUCCESS Get debug port number, bar and offset successfully.\r | |
1395 | @retval Others The usb host controller does not supported usb debug port capability.\r | |
1396 | \r | |
1397 | **/\r | |
1398 | EFI_STATUS\r | |
1399 | EhcGetUsbDebugPortInfo (\r | |
1400 | IN USB2_HC_DEV *Ehc\r | |
1401 | )\r | |
1402 | {\r | |
1403 | EFI_PCI_IO_PROTOCOL *PciIo;\r | |
1404 | UINT16 PciStatus;\r | |
1405 | UINT8 CapabilityPtr;\r | |
1406 | UINT8 CapabilityId;\r | |
1407 | UINT16 DebugPort;\r | |
1408 | EFI_STATUS Status;\r | |
1409 | \r | |
1410 | ASSERT (Ehc->PciIo != NULL);\r | |
1411 | PciIo = Ehc->PciIo;\r | |
1412 | \r | |
1413 | //\r | |
1414 | // Detect if the EHCI host controller support Capaility Pointer.\r | |
1415 | //\r | |
1416 | Status = PciIo->Pci.Read (\r | |
1417 | PciIo,\r | |
1418 | EfiPciIoWidthUint8,\r | |
1419 | PCI_PRIMARY_STATUS_OFFSET,\r | |
1420 | sizeof (UINT16),\r | |
1421 | &PciStatus\r | |
1422 | );\r | |
1423 | \r | |
1424 | if (EFI_ERROR (Status)) {\r | |
1425 | return Status;\r | |
1426 | }\r | |
1427 | \r | |
1428 | if ((PciStatus & EFI_PCI_STATUS_CAPABILITY) == 0) {\r | |
1429 | //\r | |
1430 | // The Pci Device Doesn't Support Capability Pointer.\r | |
1431 | //\r | |
1432 | return EFI_UNSUPPORTED;\r | |
1433 | }\r | |
1434 | \r | |
1435 | //\r | |
1436 | // Get Pointer To Capability List\r | |
1437 | //\r | |
1438 | Status = PciIo->Pci.Read (\r | |
1439 | PciIo,\r | |
1440 | EfiPciIoWidthUint8,\r | |
1441 | PCI_CAPBILITY_POINTER_OFFSET,\r | |
1442 | 1,\r | |
1443 | &CapabilityPtr\r | |
1444 | );\r | |
1445 | \r | |
1446 | if (EFI_ERROR (Status)) {\r | |
1447 | return Status;\r | |
1448 | }\r | |
1449 | \r | |
1450 | //\r | |
1451 | // Find Capability ID 0xA, Which Is For Debug Port\r | |
1452 | //\r | |
1453 | while (CapabilityPtr != 0) {\r | |
1454 | Status = PciIo->Pci.Read (\r | |
1455 | PciIo,\r | |
1456 | EfiPciIoWidthUint8,\r | |
1457 | CapabilityPtr,\r | |
1458 | 1,\r | |
1459 | &CapabilityId\r | |
1460 | );\r | |
1461 | \r | |
1462 | if (EFI_ERROR (Status)) {\r | |
1463 | return Status;\r | |
1464 | }\r | |
1465 | \r | |
1466 | if (CapabilityId == EHC_DEBUG_PORT_CAP_ID) {\r | |
1467 | break;\r | |
1468 | }\r | |
1469 | \r | |
1470 | Status = PciIo->Pci.Read (\r | |
1471 | PciIo,\r | |
1472 | EfiPciIoWidthUint8,\r | |
1473 | CapabilityPtr + 1,\r | |
1474 | 1,\r | |
1475 | &CapabilityPtr\r | |
1476 | );\r | |
1477 | \r | |
1478 | if (EFI_ERROR (Status)) {\r | |
1479 | return Status;\r | |
1480 | }\r | |
1481 | }\r | |
1482 | \r | |
1483 | //\r | |
1484 | // No Debug Port Capability Found\r | |
1485 | //\r | |
1486 | if (CapabilityPtr == 0) {\r | |
1487 | return EFI_UNSUPPORTED;\r | |
1488 | }\r | |
1489 | \r | |
1490 | //\r | |
1491 | // Get The Base Address Of Debug Port Register In Debug Port Capability Register\r | |
1492 | //\r | |
1493 | Status = PciIo->Pci.Read (\r | |
1494 | Ehc->PciIo,\r | |
1495 | EfiPciIoWidthUint8,\r | |
1496 | CapabilityPtr + 2,\r | |
1497 | sizeof (UINT16),\r | |
1498 | &DebugPort\r | |
1499 | );\r | |
1500 | \r | |
1501 | if (EFI_ERROR (Status)) {\r | |
1502 | return Status;\r | |
1503 | }\r | |
1504 | \r | |
1505 | Ehc->DebugPortOffset = DebugPort & 0x1FFF;\r | |
5e10caa1 | 1506 | Ehc->DebugPortBarNum = (UINT8)((DebugPort >> 13) - 1);\r |
09943f5e | 1507 | Ehc->DebugPortNum = (UINT8)((Ehc->HcStructParams & 0x00F00000) >> 20);\r |
1508 | \r | |
1509 | return EFI_SUCCESS;\r | |
1510 | }\r | |
1511 | \r | |
913cb9dc | 1512 | \r |
1513 | /**\r | |
78c2ffb5 | 1514 | Create and initialize a USB2_HC_DEV.\r |
913cb9dc | 1515 | \r |
78c2ffb5 | 1516 | @param PciIo The PciIo on this device.\r |
44c56530 | 1517 | @param DevicePath The device path of host controller.\r |
78c2ffb5 | 1518 | @param OriginalPciAttributes Original PCI attributes.\r |
913cb9dc | 1519 | \r |
78c2ffb5 | 1520 | @return The allocated and initialized USB2_HC_DEV structure if created,\r |
1521 | otherwise NULL.\r | |
913cb9dc | 1522 | \r |
1523 | **/\r | |
913cb9dc | 1524 | USB2_HC_DEV *\r |
1525 | EhcCreateUsb2Hc (\r | |
37623a5c | 1526 | IN EFI_PCI_IO_PROTOCOL *PciIo,\r |
1527 | IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r | |
1528 | IN UINT64 OriginalPciAttributes\r | |
913cb9dc | 1529 | )\r |
1530 | {\r | |
1531 | USB2_HC_DEV *Ehc;\r | |
1532 | EFI_STATUS Status;\r | |
1533 | \r | |
1534 | Ehc = AllocateZeroPool (sizeof (USB2_HC_DEV));\r | |
1535 | \r | |
1536 | if (Ehc == NULL) {\r | |
1537 | return NULL;\r | |
1538 | }\r | |
1539 | \r | |
1540 | //\r | |
1541 | // Init EFI_USB2_HC_PROTOCOL interface and private data structure\r | |
1542 | //\r | |
1543 | Ehc->Signature = USB2_HC_DEV_SIGNATURE;\r | |
1544 | \r | |
1545 | Ehc->Usb2Hc.GetCapability = EhcGetCapability;\r | |
1546 | Ehc->Usb2Hc.Reset = EhcReset;\r | |
1547 | Ehc->Usb2Hc.GetState = EhcGetState;\r | |
1548 | Ehc->Usb2Hc.SetState = EhcSetState;\r | |
1549 | Ehc->Usb2Hc.ControlTransfer = EhcControlTransfer;\r | |
1550 | Ehc->Usb2Hc.BulkTransfer = EhcBulkTransfer;\r | |
1551 | Ehc->Usb2Hc.AsyncInterruptTransfer = EhcAsyncInterruptTransfer;\r | |
1552 | Ehc->Usb2Hc.SyncInterruptTransfer = EhcSyncInterruptTransfer;\r | |
1553 | Ehc->Usb2Hc.IsochronousTransfer = EhcIsochronousTransfer;\r | |
1554 | Ehc->Usb2Hc.AsyncIsochronousTransfer = EhcAsyncIsochronousTransfer;\r | |
1555 | Ehc->Usb2Hc.GetRootHubPortStatus = EhcGetRootHubPortStatus;\r | |
1556 | Ehc->Usb2Hc.SetRootHubPortFeature = EhcSetRootHubPortFeature;\r | |
1557 | Ehc->Usb2Hc.ClearRootHubPortFeature = EhcClearRootHubPortFeature;\r | |
b4c24e2d | 1558 | Ehc->Usb2Hc.MajorRevision = 0x2;\r |
1559 | Ehc->Usb2Hc.MinorRevision = 0x0;\r | |
913cb9dc | 1560 | \r |
68246fa8 | 1561 | Ehc->PciIo = PciIo;\r |
37623a5c | 1562 | Ehc->DevicePath = DevicePath;\r |
68246fa8 | 1563 | Ehc->OriginalPciAttributes = OriginalPciAttributes;\r |
913cb9dc | 1564 | \r |
1565 | InitializeListHead (&Ehc->AsyncIntTransfers);\r | |
1566 | \r | |
1567 | Ehc->HcStructParams = EhcReadCapRegister (Ehc, EHC_HCSPARAMS_OFFSET);\r | |
1568 | Ehc->HcCapParams = EhcReadCapRegister (Ehc, EHC_HCCPARAMS_OFFSET);\r | |
1569 | Ehc->CapLen = EhcReadCapRegister (Ehc, EHC_CAPLENGTH_OFFSET) & 0x0FF;\r | |
1570 | \r | |
1c619535 | 1571 | DEBUG ((EFI_D_INFO, "EhcCreateUsb2Hc: capability length %d\n", Ehc->CapLen));\r |
913cb9dc | 1572 | \r |
68bb5ce7 | 1573 | //\r |
1574 | // EHCI Controllers with a CapLen of 0 are ignored.\r | |
1575 | //\r | |
1576 | if (Ehc->CapLen == 0) {\r | |
1577 | gBS->FreePool (Ehc);\r | |
1578 | return NULL;\r | |
1579 | }\r | |
d1102dba | 1580 | \r |
09943f5e | 1581 | EhcGetUsbDebugPortInfo (Ehc);\r |
68bb5ce7 | 1582 | \r |
913cb9dc | 1583 | //\r |
1584 | // Create AsyncRequest Polling Timer\r | |
1585 | //\r | |
1586 | Status = gBS->CreateEvent (\r | |
1587 | EVT_TIMER | EVT_NOTIFY_SIGNAL,\r | |
3cf6450e | 1588 | TPL_NOTIFY,\r |
597f4ee2 | 1589 | EhcMonitorAsyncRequests,\r |
913cb9dc | 1590 | Ehc,\r |
1591 | &Ehc->PollTimer\r | |
1592 | );\r | |
1593 | \r | |
1594 | if (EFI_ERROR (Status)) {\r | |
1595 | gBS->FreePool (Ehc);\r | |
1596 | return NULL;\r | |
1597 | }\r | |
1598 | \r | |
1599 | return Ehc;\r | |
1600 | }\r | |
1601 | \r | |
0428a6cb | 1602 | /**\r |
1603 | One notified function to stop the Host Controller when gBS->ExitBootServices() called.\r | |
1604 | \r | |
1605 | @param Event Pointer to this event\r | |
e3644786 | 1606 | @param Context Event handler private data\r |
0428a6cb | 1607 | \r |
1608 | **/\r | |
1609 | VOID\r | |
1610 | EFIAPI\r | |
1611 | EhcExitBootService (\r | |
1612 | EFI_EVENT Event,\r | |
1613 | VOID *Context\r | |
1614 | )\r | |
1615 | \r | |
1616 | {\r | |
1617 | USB2_HC_DEV *Ehc;\r | |
1618 | \r | |
1619 | Ehc = (USB2_HC_DEV *) Context;\r | |
1620 | \r | |
1621 | //\r | |
2dda77a6 | 1622 | // Reset the Host Controller\r |
0428a6cb | 1623 | //\r |
2dda77a6 | 1624 | EhcResetHC (Ehc, EHC_RESET_TIMEOUT);\r |
0428a6cb | 1625 | }\r |
1626 | \r | |
913cb9dc | 1627 | \r |
1628 | /**\r | |
78c2ffb5 | 1629 | Starting the Usb EHCI Driver.\r |
913cb9dc | 1630 | \r |
1631 | @param This Protocol instance pointer.\r | |
78c2ffb5 | 1632 | @param Controller Handle of device to test.\r |
1633 | @param RemainingDevicePath Not used.\r | |
913cb9dc | 1634 | \r |
78c2ffb5 | 1635 | @return EFI_SUCCESS supports this device.\r |
1636 | @return EFI_UNSUPPORTED do not support this device.\r | |
1637 | @return EFI_DEVICE_ERROR cannot be started due to device Error.\r | |
1638 | @return EFI_OUT_OF_RESOURCES cannot allocate resources.\r | |
913cb9dc | 1639 | \r |
1640 | **/\r | |
1641 | EFI_STATUS\r | |
1642 | EFIAPI\r | |
1643 | EhcDriverBindingStart (\r | |
1644 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
1645 | IN EFI_HANDLE Controller,\r | |
1646 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
1647 | )\r | |
1648 | {\r | |
1649 | EFI_STATUS Status;\r | |
1650 | USB2_HC_DEV *Ehc;\r | |
1651 | EFI_PCI_IO_PROTOCOL *PciIo;\r | |
cd92e3fb | 1652 | EFI_PCI_IO_PROTOCOL *Instance;\r |
96f6af14 | 1653 | UINT64 Supports;\r |
68246fa8 | 1654 | UINT64 OriginalPciAttributes;\r |
6a6d955c | 1655 | BOOLEAN PciAttributesSaved;\r |
cd92e3fb | 1656 | USB_CLASSC UsbClassCReg;\r |
1657 | EFI_HANDLE *HandleBuffer;\r | |
1658 | UINTN NumberOfHandles;\r | |
1659 | UINTN Index;\r | |
51f65b37 | 1660 | UINTN CompanionSegmentNumber;\r |
1661 | UINTN CompanionBusNumber;\r | |
1662 | UINTN CompanionDeviceNumber;\r | |
1663 | UINTN CompanionFunctionNumber;\r | |
cd92e3fb | 1664 | UINTN EhciSegmentNumber;\r |
1665 | UINTN EhciBusNumber;\r | |
1666 | UINTN EhciDeviceNumber;\r | |
1667 | UINTN EhciFunctionNumber;\r | |
37623a5c | 1668 | EFI_DEVICE_PATH_PROTOCOL *HcDevicePath;\r |
913cb9dc | 1669 | \r |
1670 | //\r | |
1671 | // Open the PciIo Protocol, then enable the USB host controller\r | |
1672 | //\r | |
1673 | Status = gBS->OpenProtocol (\r | |
1674 | Controller,\r | |
1675 | &gEfiPciIoProtocolGuid,\r | |
c52fa98c | 1676 | (VOID **) &PciIo,\r |
913cb9dc | 1677 | This->DriverBindingHandle,\r |
1678 | Controller,\r | |
1679 | EFI_OPEN_PROTOCOL_BY_DRIVER\r | |
1680 | );\r | |
1681 | \r | |
1682 | if (EFI_ERROR (Status)) {\r | |
cd92e3fb | 1683 | return Status;\r |
913cb9dc | 1684 | }\r |
1685 | \r | |
37623a5c | 1686 | //\r |
1687 | // Open Device Path Protocol for on USB host controller\r | |
1688 | //\r | |
1689 | HcDevicePath = NULL;\r | |
1690 | Status = gBS->OpenProtocol (\r | |
1691 | Controller,\r | |
1692 | &gEfiDevicePathProtocolGuid,\r | |
1693 | (VOID **) &HcDevicePath,\r | |
1694 | This->DriverBindingHandle,\r | |
1695 | Controller,\r | |
1696 | EFI_OPEN_PROTOCOL_GET_PROTOCOL\r | |
1697 | );\r | |
1698 | \r | |
6a6d955c | 1699 | PciAttributesSaved = FALSE;\r |
68246fa8 | 1700 | //\r |
1701 | // Save original PCI attributes\r | |
1702 | //\r | |
1703 | Status = PciIo->Attributes (\r | |
1704 | PciIo,\r | |
1705 | EfiPciIoAttributeOperationGet,\r | |
1706 | 0,\r | |
1707 | &OriginalPciAttributes\r | |
1708 | );\r | |
1709 | \r | |
1710 | if (EFI_ERROR (Status)) {\r | |
6a6d955c | 1711 | goto CLOSE_PCIIO;\r |
68246fa8 | 1712 | }\r |
6a6d955c | 1713 | PciAttributesSaved = TRUE;\r |
68246fa8 | 1714 | \r |
913cb9dc | 1715 | Status = PciIo->Attributes (\r |
1716 | PciIo,\r | |
96f6af14 LG |
1717 | EfiPciIoAttributeOperationSupported,\r |
1718 | 0,\r | |
1719 | &Supports\r | |
913cb9dc | 1720 | );\r |
96f6af14 | 1721 | if (!EFI_ERROR (Status)) {\r |
6e1e5405 | 1722 | Supports &= (UINT64)EFI_PCI_DEVICE_ENABLE;\r |
96f6af14 LG |
1723 | Status = PciIo->Attributes (\r |
1724 | PciIo,\r | |
1725 | EfiPciIoAttributeOperationEnable,\r | |
1726 | Supports,\r | |
1727 | NULL\r | |
1728 | );\r | |
1729 | }\r | |
913cb9dc | 1730 | \r |
1731 | if (EFI_ERROR (Status)) {\r | |
1c619535 | 1732 | DEBUG ((EFI_D_ERROR, "EhcDriverBindingStart: failed to enable controller\n"));\r |
913cb9dc | 1733 | goto CLOSE_PCIIO;\r |
1734 | }\r | |
1735 | \r | |
ba19956a | 1736 | //\r |
1737 | // Get the Pci device class code.\r | |
1738 | //\r | |
cd92e3fb | 1739 | Status = PciIo->Pci.Read (\r |
1740 | PciIo,\r | |
1741 | EfiPciIoWidthUint8,\r | |
a261044c | 1742 | PCI_CLASSCODE_OFFSET,\r |
cd92e3fb | 1743 | sizeof (USB_CLASSC) / sizeof (UINT8),\r |
1744 | &UsbClassCReg\r | |
1745 | );\r | |
1746 | \r | |
1747 | if (EFI_ERROR (Status)) {\r | |
1748 | Status = EFI_UNSUPPORTED;\r | |
1749 | goto CLOSE_PCIIO;\r | |
1750 | }\r | |
ba19956a | 1751 | //\r |
d1102dba | 1752 | // Determine if the device is UHCI or OHCI host controller or not. If yes, then find out the\r |
ba19956a | 1753 | // companion usb ehci host controller and force EHCI driver get attached to it before\r |
51f65b37 | 1754 | // UHCI or OHCI driver attaches to UHCI or OHCI host controller.\r |
ba19956a | 1755 | //\r |
51f65b37 | 1756 | if ((UsbClassCReg.ProgInterface == PCI_IF_UHCI || UsbClassCReg.ProgInterface == PCI_IF_OHCI) &&\r |
d1102dba | 1757 | (UsbClassCReg.BaseCode == PCI_CLASS_SERIAL) &&\r |
cd92e3fb | 1758 | (UsbClassCReg.SubClassCode == PCI_CLASS_SERIAL_USB)) {\r |
1759 | Status = PciIo->GetLocation (\r | |
1760 | PciIo,\r | |
51f65b37 | 1761 | &CompanionSegmentNumber,\r |
1762 | &CompanionBusNumber,\r | |
1763 | &CompanionDeviceNumber,\r | |
1764 | &CompanionFunctionNumber\r | |
cd92e3fb | 1765 | );\r |
1766 | if (EFI_ERROR (Status)) {\r | |
1767 | goto CLOSE_PCIIO;\r | |
1768 | }\r | |
1769 | \r | |
1770 | Status = gBS->LocateHandleBuffer (\r | |
1771 | ByProtocol,\r | |
1772 | &gEfiPciIoProtocolGuid,\r | |
1773 | NULL,\r | |
1774 | &NumberOfHandles,\r | |
1775 | &HandleBuffer\r | |
1776 | );\r | |
1777 | if (EFI_ERROR (Status)) {\r | |
1778 | goto CLOSE_PCIIO;\r | |
1779 | }\r | |
1780 | \r | |
1781 | for (Index = 0; Index < NumberOfHandles; Index++) {\r | |
1782 | //\r | |
1783 | // Get the device path on this handle\r | |
1784 | //\r | |
1785 | Status = gBS->HandleProtocol (\r | |
1786 | HandleBuffer[Index],\r | |
1787 | &gEfiPciIoProtocolGuid,\r | |
1788 | (VOID **)&Instance\r | |
1789 | );\r | |
1790 | ASSERT_EFI_ERROR (Status);\r | |
1791 | \r | |
1792 | Status = Instance->Pci.Read (\r | |
1793 | Instance,\r | |
1794 | EfiPciIoWidthUint8,\r | |
a261044c | 1795 | PCI_CLASSCODE_OFFSET,\r |
cd92e3fb | 1796 | sizeof (USB_CLASSC) / sizeof (UINT8),\r |
1797 | &UsbClassCReg\r | |
1798 | );\r | |
1799 | \r | |
1800 | if (EFI_ERROR (Status)) {\r | |
1801 | Status = EFI_UNSUPPORTED;\r | |
1802 | goto CLOSE_PCIIO;\r | |
1803 | }\r | |
1804 | \r | |
1ccdbf2a | 1805 | if ((UsbClassCReg.ProgInterface == PCI_IF_EHCI) &&\r |
d1102dba | 1806 | (UsbClassCReg.BaseCode == PCI_CLASS_SERIAL) &&\r |
cd92e3fb | 1807 | (UsbClassCReg.SubClassCode == PCI_CLASS_SERIAL_USB)) {\r |
1808 | Status = Instance->GetLocation (\r | |
1809 | Instance,\r | |
1810 | &EhciSegmentNumber,\r | |
1811 | &EhciBusNumber,\r | |
1812 | &EhciDeviceNumber,\r | |
1813 | &EhciFunctionNumber\r | |
1814 | );\r | |
1815 | if (EFI_ERROR (Status)) {\r | |
1816 | goto CLOSE_PCIIO;\r | |
1817 | }\r | |
ba19956a | 1818 | //\r |
1819 | // Currently, the judgment on the companion usb host controller is through the\r | |
1820 | // same bus number, which may vary on different platform.\r | |
1821 | //\r | |
51f65b37 | 1822 | if (EhciBusNumber == CompanionBusNumber) {\r |
cd92e3fb | 1823 | gBS->CloseProtocol (\r |
1824 | Controller,\r | |
1825 | &gEfiPciIoProtocolGuid,\r | |
1826 | This->DriverBindingHandle,\r | |
1827 | Controller\r | |
1828 | );\r | |
1829 | EhcDriverBindingStart(This, HandleBuffer[Index], NULL);\r | |
1830 | }\r | |
1831 | }\r | |
1832 | }\r | |
1833 | Status = EFI_NOT_FOUND;\r | |
1834 | goto CLOSE_PCIIO;\r | |
1835 | }\r | |
1836 | \r | |
913cb9dc | 1837 | //\r |
1838 | // Create then install USB2_HC_PROTOCOL\r | |
1839 | //\r | |
37623a5c | 1840 | Ehc = EhcCreateUsb2Hc (PciIo, HcDevicePath, OriginalPciAttributes);\r |
913cb9dc | 1841 | \r |
1842 | if (Ehc == NULL) {\r | |
1c619535 | 1843 | DEBUG ((EFI_D_ERROR, "EhcDriverBindingStart: failed to create USB2_HC\n"));\r |
913cb9dc | 1844 | \r |
1845 | Status = EFI_OUT_OF_RESOURCES;\r | |
1846 | goto CLOSE_PCIIO;\r | |
1847 | }\r | |
1848 | \r | |
167c3fb4 AB |
1849 | //\r |
1850 | // Enable 64-bit DMA support in the PCI layer if this controller\r | |
1851 | // supports it.\r | |
1852 | //\r | |
1853 | if (EHC_BIT_IS_SET (Ehc->HcCapParams, HCCP_64BIT)) {\r | |
1854 | Status = PciIo->Attributes (\r | |
1855 | PciIo,\r | |
1856 | EfiPciIoAttributeOperationEnable,\r | |
1857 | EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE,\r | |
1858 | NULL\r | |
1859 | );\r | |
1860 | if (!EFI_ERROR (Status)) {\r | |
1861 | Ehc->Support64BitDma = TRUE;\r | |
1862 | } else {\r | |
1863 | DEBUG ((EFI_D_WARN,\r | |
1864 | "%a: failed to enable 64-bit DMA on 64-bit capable controller @ %p (%r)\n",\r | |
1865 | __FUNCTION__, Controller, Status));\r | |
1866 | }\r | |
1867 | }\r | |
1868 | \r | |
913cb9dc | 1869 | Status = gBS->InstallProtocolInterface (\r |
1870 | &Controller,\r | |
1871 | &gEfiUsb2HcProtocolGuid,\r | |
1872 | EFI_NATIVE_INTERFACE,\r | |
1873 | &Ehc->Usb2Hc\r | |
1874 | );\r | |
1875 | \r | |
1876 | if (EFI_ERROR (Status)) {\r | |
1c619535 | 1877 | DEBUG ((EFI_D_ERROR, "EhcDriverBindingStart: failed to install USB2_HC Protocol\n"));\r |
913cb9dc | 1878 | goto FREE_POOL;\r |
1879 | }\r | |
1880 | \r | |
1881 | //\r | |
c39c3e21 | 1882 | // Robustnesss improvement such as for Duet platform\r |
f0a83bb3 | 1883 | // Default is not required.\r |
913cb9dc | 1884 | //\r |
cc582cff | 1885 | if (FeaturePcdGet (PcdTurnOffUsbLegacySupport)) {\r |
dd4047a5 | 1886 | EhcClearLegacySupport (Ehc);\r |
1887 | }\r | |
09943f5e | 1888 | \r |
b48ec0e8 | 1889 | if (!EhcIsDebugPortInUse (Ehc, NULL)) {\r |
c3d5d800 | 1890 | EhcResetHC (Ehc, EHC_RESET_TIMEOUT);\r |
09943f5e | 1891 | }\r |
913cb9dc | 1892 | \r |
1893 | Status = EhcInitHC (Ehc);\r | |
1894 | \r | |
1895 | if (EFI_ERROR (Status)) {\r | |
1c619535 | 1896 | DEBUG ((EFI_D_ERROR, "EhcDriverBindingStart: failed to init host controller\n"));\r |
913cb9dc | 1897 | goto UNINSTALL_USBHC;\r |
1898 | }\r | |
1899 | \r | |
1900 | //\r | |
1901 | // Start the asynchronous interrupt monitor\r | |
1902 | //\r | |
41e8ff27 | 1903 | Status = gBS->SetTimer (Ehc->PollTimer, TimerPeriodic, EHC_ASYNC_POLL_INTERVAL);\r |
913cb9dc | 1904 | \r |
1905 | if (EFI_ERROR (Status)) {\r | |
1c619535 | 1906 | DEBUG ((EFI_D_ERROR, "EhcDriverBindingStart: failed to start async interrupt monitor\n"));\r |
913cb9dc | 1907 | \r |
41e8ff27 | 1908 | EhcHaltHC (Ehc, EHC_GENERIC_TIMEOUT);\r |
913cb9dc | 1909 | goto UNINSTALL_USBHC;\r |
1910 | }\r | |
1911 | \r | |
0428a6cb | 1912 | //\r |
1913 | // Create event to stop the HC when exit boot service.\r | |
1914 | //\r | |
1915 | Status = gBS->CreateEventEx (\r | |
1916 | EVT_NOTIFY_SIGNAL,\r | |
1917 | TPL_NOTIFY,\r | |
1918 | EhcExitBootService,\r | |
1919 | Ehc,\r | |
1920 | &gEfiEventExitBootServicesGuid,\r | |
1921 | &Ehc->ExitBootServiceEvent\r | |
1922 | );\r | |
1923 | if (EFI_ERROR (Status)) {\r | |
1924 | goto UNINSTALL_USBHC;\r | |
1925 | }\r | |
1926 | \r | |
913cb9dc | 1927 | //\r |
1928 | // Install the component name protocol, don't fail the start\r | |
1929 | // because of something for display.\r | |
1930 | //\r | |
f527bce3 | 1931 | AddUnicodeString2 (\r |
913cb9dc | 1932 | "eng",\r |
1933 | gEhciComponentName.SupportedLanguages,\r | |
1934 | &Ehc->ControllerNameTable,\r | |
f527bce3 | 1935 | L"Enhanced Host Controller (USB 2.0)",\r |
1936 | TRUE\r | |
913cb9dc | 1937 | );\r |
f527bce3 | 1938 | AddUnicodeString2 (\r |
1939 | "en",\r | |
1940 | gEhciComponentName2.SupportedLanguages,\r | |
1941 | &Ehc->ControllerNameTable,\r | |
1942 | L"Enhanced Host Controller (USB 2.0)",\r | |
1943 | FALSE\r | |
1944 | );\r | |
1945 | \r | |
913cb9dc | 1946 | \r |
0e549d5b | 1947 | DEBUG ((EFI_D_INFO, "EhcDriverBindingStart: EHCI started for controller @ %p\n", Controller));\r |
913cb9dc | 1948 | return EFI_SUCCESS;\r |
1949 | \r | |
1950 | UNINSTALL_USBHC:\r | |
1951 | gBS->UninstallProtocolInterface (\r | |
1952 | Controller,\r | |
1953 | &gEfiUsb2HcProtocolGuid,\r | |
1954 | &Ehc->Usb2Hc\r | |
1955 | );\r | |
1956 | \r | |
1957 | FREE_POOL:\r | |
1958 | EhcFreeSched (Ehc);\r | |
1959 | gBS->CloseEvent (Ehc->PollTimer);\r | |
1960 | gBS->FreePool (Ehc);\r | |
1961 | \r | |
1962 | CLOSE_PCIIO:\r | |
a92d4e8a | 1963 | if (PciAttributesSaved) {\r |
6a6d955c | 1964 | //\r |
1965 | // Restore original PCI attributes\r | |
1966 | //\r | |
1967 | PciIo->Attributes (\r | |
1968 | PciIo,\r | |
1969 | EfiPciIoAttributeOperationSet,\r | |
1970 | OriginalPciAttributes,\r | |
1971 | NULL\r | |
1972 | );\r | |
1973 | }\r | |
68246fa8 | 1974 | \r |
913cb9dc | 1975 | gBS->CloseProtocol (\r |
1976 | Controller,\r | |
1977 | &gEfiPciIoProtocolGuid,\r | |
1978 | This->DriverBindingHandle,\r | |
1979 | Controller\r | |
1980 | );\r | |
1981 | \r | |
1982 | return Status;\r | |
1983 | }\r | |
1984 | \r | |
1985 | \r | |
1986 | /**\r | |
ed356b9e | 1987 | Stop this driver on ControllerHandle. Support stopping any child handles\r |
913cb9dc | 1988 | created by this driver.\r |
1989 | \r | |
1990 | @param This Protocol instance pointer.\r | |
78c2ffb5 | 1991 | @param Controller Handle of device to stop driver on.\r |
1992 | @param NumberOfChildren Number of Children in the ChildHandleBuffer.\r | |
913cb9dc | 1993 | @param ChildHandleBuffer List of handles for the children we need to stop.\r |
1994 | \r | |
78c2ffb5 | 1995 | @return EFI_SUCCESS Success.\r |
1996 | @return EFI_DEVICE_ERROR Fail.\r | |
913cb9dc | 1997 | \r |
1998 | **/\r | |
1999 | EFI_STATUS\r | |
2000 | EFIAPI\r | |
2001 | EhcDriverBindingStop (\r | |
2002 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
2003 | IN EFI_HANDLE Controller,\r | |
2004 | IN UINTN NumberOfChildren,\r | |
2005 | IN EFI_HANDLE *ChildHandleBuffer\r | |
2006 | )\r | |
2007 | {\r | |
2008 | EFI_STATUS Status;\r | |
2009 | EFI_USB2_HC_PROTOCOL *Usb2Hc;\r | |
2010 | EFI_PCI_IO_PROTOCOL *PciIo;\r | |
2011 | USB2_HC_DEV *Ehc;\r | |
2012 | \r | |
2013 | //\r | |
2014 | // Test whether the Controller handler passed in is a valid\r | |
2015 | // Usb controller handle that should be supported, if not,\r | |
2016 | // return the error status directly\r | |
2017 | //\r | |
2018 | Status = gBS->OpenProtocol (\r | |
2019 | Controller,\r | |
2020 | &gEfiUsb2HcProtocolGuid,\r | |
c52fa98c | 2021 | (VOID **) &Usb2Hc,\r |
913cb9dc | 2022 | This->DriverBindingHandle,\r |
2023 | Controller,\r | |
2024 | EFI_OPEN_PROTOCOL_GET_PROTOCOL\r | |
2025 | );\r | |
2026 | \r | |
2027 | if (EFI_ERROR (Status)) {\r | |
2028 | return Status;\r | |
2029 | }\r | |
2030 | \r | |
2031 | Ehc = EHC_FROM_THIS (Usb2Hc);\r | |
2032 | PciIo = Ehc->PciIo;\r | |
2033 | \r | |
913cb9dc | 2034 | Status = gBS->UninstallProtocolInterface (\r |
2035 | Controller,\r | |
2036 | &gEfiUsb2HcProtocolGuid,\r | |
2037 | Usb2Hc\r | |
2038 | );\r | |
2039 | \r | |
2040 | if (EFI_ERROR (Status)) {\r | |
2041 | return Status;\r | |
2042 | }\r | |
2043 | \r | |
0f58371b FT |
2044 | //\r |
2045 | // Stop AsyncRequest Polling timer then stop the EHCI driver\r | |
2046 | // and uninstall the EHCI protocl.\r | |
2047 | //\r | |
2048 | gBS->SetTimer (Ehc->PollTimer, TimerCancel, EHC_ASYNC_POLL_INTERVAL);\r | |
2049 | EhcHaltHC (Ehc, EHC_GENERIC_TIMEOUT);\r | |
2050 | \r | |
913cb9dc | 2051 | if (Ehc->PollTimer != NULL) {\r |
2052 | gBS->CloseEvent (Ehc->PollTimer);\r | |
2053 | }\r | |
2054 | \r | |
0428a6cb | 2055 | if (Ehc->ExitBootServiceEvent != NULL) {\r |
2056 | gBS->CloseEvent (Ehc->ExitBootServiceEvent);\r | |
2057 | }\r | |
2058 | \r | |
913cb9dc | 2059 | EhcFreeSched (Ehc);\r |
2060 | \r | |
78c2ffb5 | 2061 | if (Ehc->ControllerNameTable != NULL) {\r |
913cb9dc | 2062 | FreeUnicodeStringTable (Ehc->ControllerNameTable);\r |
2063 | }\r | |
2064 | \r | |
efe9186f | 2065 | //\r |
d1102dba | 2066 | // Disable routing of all ports to EHCI controller, so all ports are\r |
51f65b37 | 2067 | // routed back to the UHCI or OHCI controller.\r |
efe9186f | 2068 | //\r |
2069 | EhcClearOpRegBit (Ehc, EHC_CONFIG_FLAG_OFFSET, CONFIGFLAG_ROUTE_EHC);\r | |
2070 | \r | |
913cb9dc | 2071 | //\r |
68246fa8 | 2072 | // Restore original PCI attributes\r |
913cb9dc | 2073 | //\r |
68246fa8 | 2074 | PciIo->Attributes (\r |
2075 | PciIo,\r | |
2076 | EfiPciIoAttributeOperationSet,\r | |
2077 | Ehc->OriginalPciAttributes,\r | |
2078 | NULL\r | |
2079 | );\r | |
913cb9dc | 2080 | \r |
2081 | gBS->CloseProtocol (\r | |
2082 | Controller,\r | |
2083 | &gEfiPciIoProtocolGuid,\r | |
2084 | This->DriverBindingHandle,\r | |
2085 | Controller\r | |
2086 | );\r | |
2087 | \r | |
68246fa8 | 2088 | FreePool (Ehc);\r |
2089 | \r | |
96f6af14 | 2090 | return EFI_SUCCESS;\r |
913cb9dc | 2091 | }\r |
2092 | \r |