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