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