2 PEIM to produce gPeiUsb2HostControllerPpiGuid based on gPeiUsbControllerPpiGuid
3 which is used to enable recovery function from USB Drivers.
5 Copyright (c) 2010 - 2012, Intel Corporation. All rights reserved.<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions
9 of the BSD License which accompanies this distribution. The
10 full text of the license may be found at
11 http://opensource.org/licenses/bsd-license.php
13 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
14 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
21 // Two arrays used to translate the EHCI port state (change)
22 // to the UEFI protocol's port state (change).
24 USB_PORT_STATE_MAP mUsbPortStateMap
[] = {
25 {PORTSC_CONN
, USB_PORT_STAT_CONNECTION
},
26 {PORTSC_ENABLED
, USB_PORT_STAT_ENABLE
},
27 {PORTSC_SUSPEND
, USB_PORT_STAT_SUSPEND
},
28 {PORTSC_OVERCUR
, USB_PORT_STAT_OVERCURRENT
},
29 {PORTSC_RESET
, USB_PORT_STAT_RESET
},
30 {PORTSC_POWER
, USB_PORT_STAT_POWER
},
31 {PORTSC_OWNER
, USB_PORT_STAT_OWNER
}
34 USB_PORT_STATE_MAP mUsbPortChangeMap
[] = {
35 {PORTSC_CONN_CHANGE
, USB_PORT_STAT_C_CONNECTION
},
36 {PORTSC_ENABLE_CHANGE
, USB_PORT_STAT_C_ENABLE
},
37 {PORTSC_OVERCUR_CHANGE
, USB_PORT_STAT_C_OVERCURRENT
}
41 Read Ehc Operation register.
43 @param Ehc The EHCI device.
44 @param Offset The operation register offset.
46 @retval the register content read.
51 IN PEI_USB2_HC_DEV
*Ehc
,
57 ASSERT (Ehc
->CapLen
!= 0);
59 Data
= MmioRead32 (Ehc
->UsbHostControllerBaseAddress
+ Ehc
->CapLen
+ Offset
);
65 Write the data to the EHCI operation register.
67 @param Ehc The EHCI device.
68 @param Offset EHCI operation register offset.
69 @param Data The data to write.
74 IN PEI_USB2_HC_DEV
*Ehc
,
80 ASSERT (Ehc
->CapLen
!= 0);
82 MmioWrite32(Ehc
->UsbHostControllerBaseAddress
+ Ehc
->CapLen
+ Offset
, Data
);
87 Set one bit of the operational register while keeping other bits.
89 @param Ehc The EHCI device.
90 @param Offset The offset of the operational register.
91 @param Bit The bit mask of the register to set.
96 IN PEI_USB2_HC_DEV
*Ehc
,
103 Data
= EhcReadOpReg (Ehc
, Offset
);
105 EhcWriteOpReg (Ehc
, Offset
, Data
);
109 Clear one bit of the operational register while keeping other bits.
111 @param Ehc The EHCI device.
112 @param Offset The offset of the operational register.
113 @param Bit The bit mask of the register to clear.
118 IN PEI_USB2_HC_DEV
*Ehc
,
125 Data
= EhcReadOpReg (Ehc
, Offset
);
127 EhcWriteOpReg (Ehc
, Offset
, Data
);
131 Wait the operation register's bit as specified by Bit
132 to become set (or clear).
134 @param Ehc The EHCI device.
135 @param Offset The offset of the operational register.
136 @param Bit The bit mask of the register to wait for.
137 @param WaitToSet Wait the bit to set or clear.
138 @param Timeout The time to wait before abort (in millisecond).
140 @retval EFI_SUCCESS The bit successfully changed by host controller.
141 @retval EFI_TIMEOUT The time out occurred.
146 IN PEI_USB2_HC_DEV
*Ehc
,
149 IN BOOLEAN WaitToSet
,
155 for (Index
= 0; Index
< Timeout
/ EHC_SYNC_POLL_INTERVAL
+ 1; Index
++) {
156 if (EHC_REG_BIT_IS_SET (Ehc
, Offset
, Bit
) == WaitToSet
) {
160 MicroSecondDelay (EHC_SYNC_POLL_INTERVAL
);
167 Read EHCI capability register.
169 @param Ehc The EHCI device.
170 @param Offset Capability register address.
172 @retval the register content read.
177 IN PEI_USB2_HC_DEV
*Ehc
,
183 Data
= MmioRead32(Ehc
->UsbHostControllerBaseAddress
+ Offset
);
189 Set door bell and wait it to be ACKed by host controller.
190 This function is used to synchronize with the hardware.
192 @param Ehc The EHCI device.
193 @param Timeout The time to wait before abort (in millisecond, ms).
195 @retval EFI_TIMEOUT Time out happened while waiting door bell to set.
196 @retval EFI_SUCCESS Synchronized with the hardware.
200 EhcSetAndWaitDoorBell (
201 IN PEI_USB2_HC_DEV
*Ehc
,
208 EhcSetOpRegBit (Ehc
, EHC_USBCMD_OFFSET
, USBCMD_IAAD
);
210 Status
= EhcWaitOpRegBit (Ehc
, EHC_USBSTS_OFFSET
, USBSTS_IAA
, TRUE
, Timeout
);
213 // ACK the IAA bit in USBSTS register. Make sure other
214 // interrupt bits are not ACKed. These bits are WC (Write Clean).
216 Data
= EhcReadOpReg (Ehc
, EHC_USBSTS_OFFSET
);
217 Data
&= ~USBSTS_INTACK_MASK
;
220 EhcWriteOpReg (Ehc
, EHC_USBSTS_OFFSET
, Data
);
226 Clear all the interrutp status bits, these bits
229 @param Ehc The EHCI device.
234 IN PEI_USB2_HC_DEV
*Ehc
237 EhcWriteOpReg (Ehc
, EHC_USBSTS_OFFSET
, USBSTS_INTACK_MASK
);
241 Enable the periodic schedule then wait EHC to
244 @param Ehc The EHCI device.
245 @param Timeout The time to wait before abort (in millisecond, ms).
247 @retval EFI_TIMEOUT Time out happened while enabling periodic schedule.
248 @retval EFI_SUCCESS The periodical schedule is enabled.
252 EhcEnablePeriodSchd (
253 IN PEI_USB2_HC_DEV
*Ehc
,
259 EhcSetOpRegBit (Ehc
, EHC_USBCMD_OFFSET
, USBCMD_ENABLE_PERIOD
);
261 Status
= EhcWaitOpRegBit (Ehc
, EHC_USBSTS_OFFSET
, USBSTS_PERIOD_ENABLED
, TRUE
, Timeout
);
266 Enable asynchrounous schedule.
268 @param Ehc The EHCI device.
269 @param Timeout Time to wait before abort.
271 @retval EFI_SUCCESS The EHCI asynchronous schedule is enabled.
272 @retval Others Failed to enable the asynchronous scheudle.
277 IN PEI_USB2_HC_DEV
*Ehc
,
283 EhcSetOpRegBit (Ehc
, EHC_USBCMD_OFFSET
, USBCMD_ENABLE_ASYNC
);
285 Status
= EhcWaitOpRegBit (Ehc
, EHC_USBSTS_OFFSET
, USBSTS_ASYNC_ENABLED
, TRUE
, Timeout
);
290 Check whether Ehc is halted.
292 @param Ehc The EHCI device.
294 @retval TRUE The controller is halted.
295 @retval FALSE The controller isn't halted.
300 IN PEI_USB2_HC_DEV
*Ehc
303 return EHC_REG_BIT_IS_SET (Ehc
, EHC_USBSTS_OFFSET
, USBSTS_HALT
);
307 Check whether system error occurred.
309 @param Ehc The EHCI device.
311 @retval TRUE System error happened.
312 @retval FALSE No system error.
317 IN PEI_USB2_HC_DEV
*Ehc
320 return EHC_REG_BIT_IS_SET (Ehc
, EHC_USBSTS_OFFSET
, USBSTS_SYS_ERROR
);
324 Reset the host controller.
326 @param Ehc The EHCI device.
327 @param Timeout Time to wait before abort (in millisecond, ms).
329 @retval EFI_TIMEOUT The transfer failed due to time out.
330 @retval Others Failed to reset the host.
335 IN PEI_USB2_HC_DEV
*Ehc
,
342 // Host can only be reset when it is halt. If not so, halt it
344 if (!EHC_REG_BIT_IS_SET (Ehc
, EHC_USBSTS_OFFSET
, USBSTS_HALT
)) {
345 Status
= EhcHaltHC (Ehc
, Timeout
);
347 if (EFI_ERROR (Status
)) {
352 EhcSetOpRegBit (Ehc
, EHC_USBCMD_OFFSET
, USBCMD_RESET
);
353 Status
= EhcWaitOpRegBit (Ehc
, EHC_USBCMD_OFFSET
, USBCMD_RESET
, FALSE
, Timeout
);
358 Halt the host controller.
360 @param Ehc The EHCI device.
361 @param Timeout Time to wait before abort.
363 @retval EFI_TIMEOUT Failed to halt the controller before Timeout.
364 @retval EFI_SUCCESS The EHCI is halt.
369 IN PEI_USB2_HC_DEV
*Ehc
,
375 EhcClearOpRegBit (Ehc
, EHC_USBCMD_OFFSET
, USBCMD_RUN
);
376 Status
= EhcWaitOpRegBit (Ehc
, EHC_USBSTS_OFFSET
, USBSTS_HALT
, TRUE
, Timeout
);
383 @param Ehc The EHCI device.
384 @param Timeout Time to wait before abort.
386 @retval EFI_SUCCESS The EHCI is running.
387 @retval Others Failed to set the EHCI to run.
392 IN PEI_USB2_HC_DEV
*Ehc
,
398 EhcSetOpRegBit (Ehc
, EHC_USBCMD_OFFSET
, USBCMD_RUN
);
399 Status
= EhcWaitOpRegBit (Ehc
, EHC_USBSTS_OFFSET
, USBSTS_HALT
, FALSE
, Timeout
);
404 Power On All EHCI Ports.
406 @param Ehc The EHCI device.
411 IN PEI_USB2_HC_DEV
*Ehc
417 PortNumber
= (UINT8
)(Ehc
->HcStructParams
& HCSP_NPORTS
);
418 for (Index
= 0; Index
< PortNumber
; Index
++) {
419 EhcSetOpRegBit (Ehc
, EHC_PORT_STAT_OFFSET
+ 4 * Index
, PORTSC_POWER
);
424 Initialize the HC hardware.
425 EHCI spec lists the five things to do to initialize the hardware.
426 1. Program CTRLDSSEGMENT.
427 2. Set USBINTR to enable interrupts.
428 3. Set periodic list base.
429 4. Set USBCMD, interrupt threshold, frame list size etc.
430 5. Write 1 to CONFIGFLAG to route all ports to EHCI.
432 @param Ehc The EHCI device.
434 @retval EFI_SUCCESS The EHCI has come out of halt state.
435 @retval EFI_TIMEOUT Time out happened.
440 IN PEI_USB2_HC_DEV
*Ehc
444 EFI_PHYSICAL_ADDRESS TempPtr
;
447 ASSERT (EhcIsHalt (Ehc
));
450 // Allocate the periodic frame and associated memeory
451 // management facilities if not already done.
453 if (Ehc
->PeriodFrame
!= NULL
) {
456 PageNumber
= sizeof(PEI_URB
)/PAGESIZE
+1;
457 Status
= PeiServicesAllocatePages (
462 Ehc
->Urb
= (PEI_URB
*) ((UINTN
) TempPtr
);
463 if (Ehc
->Urb
== NULL
) {
467 EhcPowerOnAllPorts (Ehc
);
468 MicroSecondDelay (EHC_ROOT_PORT_RECOVERY_STALL
);
470 Status
= EhcInitSched (Ehc
);
472 if (EFI_ERROR (Status
)) {
476 // 1. Program the CTRLDSSEGMENT register with the high 32 bit addr
478 EhcWriteOpReg (Ehc
, EHC_CTRLDSSEG_OFFSET
, Ehc
->High32bitAddr
);
481 // 2. Clear USBINTR to disable all the interrupt. UEFI works by polling
483 EhcWriteOpReg (Ehc
, EHC_USBINTR_OFFSET
, 0);
486 // 3. Program periodic frame list, already done in EhcInitSched
487 // 4. Start the Host Controller
489 EhcSetOpRegBit (Ehc
, EHC_USBCMD_OFFSET
, USBCMD_RUN
);
492 // 5. Set all ports routing to EHC
494 EhcSetOpRegBit (Ehc
, EHC_CONFIG_FLAG_OFFSET
, CONFIGFLAG_ROUTE_EHC
);
497 // Wait roothub port power stable
499 MicroSecondDelay (EHC_ROOT_PORT_RECOVERY_STALL
);
501 Status
= EhcEnablePeriodSchd (Ehc
, EHC_GENERIC_TIMEOUT
);
503 if (EFI_ERROR (Status
)) {
507 Status
= EhcEnableAsyncSchd (Ehc
, EHC_GENERIC_TIMEOUT
);
509 if (EFI_ERROR (Status
)) {
517 Submits bulk transfer to a bulk endpoint of a USB device.
519 @param PeiServices The pointer of EFI_PEI_SERVICES.
520 @param This The pointer of PEI_USB2_HOST_CONTROLLER_PPI.
521 @param DeviceAddress Target device address.
522 @param EndPointAddress Endpoint number and its direction in bit 7.
523 @param DeviceSpeed Device speed, Low speed device doesn't support
525 @param MaximumPacketLength Maximum packet size the endpoint is capable of
526 sending or receiving.
527 @param Data Array of pointers to the buffers of data to transmit
528 from or receive into.
529 @param DataLength The lenght of the data buffer.
530 @param DataToggle On input, the initial data toggle for the transfer;
531 On output, it is updated to to next data toggle to use of
532 the subsequent bulk transfer.
533 @param TimeOut Indicates the maximum time, in millisecond, which the
534 transfer is allowed to complete.
535 @param Translator A pointr to the transaction translator data.
536 @param TransferResult A pointer to the detailed result information of the
539 @retval EFI_SUCCESS The transfer was completed successfully.
540 @retval EFI_OUT_OF_RESOURCES The transfer failed due to lack of resource.
541 @retval EFI_INVALID_PARAMETER Parameters are invalid.
542 @retval EFI_TIMEOUT The transfer failed due to timeout.
543 @retval EFI_DEVICE_ERROR The transfer failed due to host controller error.
549 IN EFI_PEI_SERVICES
**PeiServices
,
550 IN PEI_USB2_HOST_CONTROLLER_PPI
*This
,
551 IN UINT8 DeviceAddress
,
552 IN UINT8 EndPointAddress
,
553 IN UINT8 DeviceSpeed
,
554 IN UINTN MaximumPacketLength
,
555 IN OUT VOID
*Data
[EFI_USB_MAX_BULK_BUFFER_NUM
],
556 IN OUT UINTN
*DataLength
,
557 IN OUT UINT8
*DataToggle
,
559 IN EFI_USB2_HC_TRANSACTION_TRANSLATOR
*Translator
,
560 OUT UINT32
*TransferResult
563 PEI_USB2_HC_DEV
*Ehc
;
568 // Validate the parameters
570 if ((DataLength
== NULL
) || (*DataLength
== 0) ||
571 (Data
== NULL
) || (Data
[0] == NULL
) || (TransferResult
== NULL
)) {
572 return EFI_INVALID_PARAMETER
;
575 if ((*DataToggle
!= 0) && (*DataToggle
!= 1)) {
576 return EFI_INVALID_PARAMETER
;
579 if ((DeviceSpeed
== EFI_USB_SPEED_LOW
) ||
580 ((DeviceSpeed
== EFI_USB_SPEED_FULL
) && (MaximumPacketLength
> 64)) ||
581 ((EFI_USB_SPEED_HIGH
== DeviceSpeed
) && (MaximumPacketLength
> 512))) {
582 return EFI_INVALID_PARAMETER
;
585 Ehc
=PEI_RECOVERY_USB_EHC_DEV_FROM_EHCI_THIS(This
);
586 *TransferResult
= EFI_USB_ERR_SYSTEM
;
587 Status
= EFI_DEVICE_ERROR
;
589 if (EhcIsHalt (Ehc
) || EhcIsSysError (Ehc
)) {
590 EhcAckAllInterrupt (Ehc
);
594 EhcAckAllInterrupt (Ehc
);
597 // Create a new URB, insert it into the asynchronous
598 // schedule list, then poll the execution status.
618 Status
= EFI_OUT_OF_RESOURCES
;
622 EhcLinkQhToAsync (Ehc
, Urb
->Qh
);
623 Status
= EhcExecTransfer (Ehc
, Urb
, TimeOut
);
624 EhcUnlinkQhFromAsync (Ehc
, Urb
->Qh
);
626 *TransferResult
= Urb
->Result
;
627 *DataLength
= Urb
->Completed
;
628 *DataToggle
= Urb
->DataToggle
;
630 if (*TransferResult
== EFI_USB_NOERROR
) {
631 Status
= EFI_SUCCESS
;
634 EhcAckAllInterrupt (Ehc
);
635 EhcFreeUrb (Ehc
, Urb
);
642 Retrieves the number of root hub ports.
644 @param[in] PeiServices The pointer to the PEI Services Table.
645 @param[in] This The pointer to this instance of the
646 PEI_USB2_HOST_CONTROLLER_PPI.
647 @param[out] PortNumber The pointer to the number of the root hub ports.
649 @retval EFI_SUCCESS The port number was retrieved successfully.
650 @retval EFI_INVALID_PARAMETER PortNumber is NULL.
655 EhcGetRootHubPortNumber (
656 IN EFI_PEI_SERVICES
**PeiServices
,
657 IN PEI_USB2_HOST_CONTROLLER_PPI
*This
,
658 OUT UINT8
*PortNumber
662 PEI_USB2_HC_DEV
*EhcDev
;
663 EhcDev
= PEI_RECOVERY_USB_EHC_DEV_FROM_EHCI_THIS (This
);
665 if (PortNumber
== NULL
) {
666 return EFI_INVALID_PARAMETER
;
669 *PortNumber
= (UINT8
)(EhcDev
->HcStructParams
& HCSP_NPORTS
);
675 Clears a feature for the specified root hub port.
677 @param PeiServices The pointer of EFI_PEI_SERVICES.
678 @param This The pointer of PEI_USB2_HOST_CONTROLLER_PPI.
679 @param PortNumber Specifies the root hub port whose feature
680 is requested to be cleared.
681 @param PortFeature Indicates the feature selector associated with the
682 feature clear request.
684 @retval EFI_SUCCESS The feature specified by PortFeature was cleared
685 for the USB root hub port specified by PortNumber.
686 @retval EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid.
691 EhcClearRootHubPortFeature (
692 IN EFI_PEI_SERVICES
**PeiServices
,
693 IN PEI_USB2_HOST_CONTROLLER_PPI
*This
,
695 IN EFI_USB_PORT_FEATURE PortFeature
698 PEI_USB2_HC_DEV
*Ehc
;
704 Ehc
= PEI_RECOVERY_USB_EHC_DEV_FROM_EHCI_THIS (This
);
705 Status
= EFI_SUCCESS
;
707 TotalPort
= (Ehc
->HcStructParams
& HCSP_NPORTS
);
709 if (PortNumber
>= TotalPort
) {
710 Status
= EFI_INVALID_PARAMETER
;
714 Offset
= EHC_PORT_STAT_OFFSET
+ (4 * PortNumber
);
715 State
= EhcReadOpReg (Ehc
, Offset
);
716 State
&= ~PORTSC_CHANGE_MASK
;
718 switch (PortFeature
) {
719 case EfiUsbPortEnable
:
721 // Clear PORT_ENABLE feature means disable port.
723 State
&= ~PORTSC_ENABLED
;
724 EhcWriteOpReg (Ehc
, Offset
, State
);
727 case EfiUsbPortSuspend
:
729 // A write of zero to this bit is ignored by the host
730 // controller. The host controller will unconditionally
731 // set this bit to a zero when:
732 // 1. software sets the Forct Port Resume bit to a zero from a one.
733 // 2. software sets the Port Reset bit to a one frome a zero.
735 State
&= ~PORSTSC_RESUME
;
736 EhcWriteOpReg (Ehc
, Offset
, State
);
739 case EfiUsbPortReset
:
741 // Clear PORT_RESET means clear the reset signal.
743 State
&= ~PORTSC_RESET
;
744 EhcWriteOpReg (Ehc
, Offset
, State
);
747 case EfiUsbPortOwner
:
749 // Clear port owner means this port owned by EHC
751 State
&= ~PORTSC_OWNER
;
752 EhcWriteOpReg (Ehc
, Offset
, State
);
755 case EfiUsbPortConnectChange
:
757 // Clear connect status change
759 State
|= PORTSC_CONN_CHANGE
;
760 EhcWriteOpReg (Ehc
, Offset
, State
);
763 case EfiUsbPortEnableChange
:
765 // Clear enable status change
767 State
|= PORTSC_ENABLE_CHANGE
;
768 EhcWriteOpReg (Ehc
, Offset
, State
);
771 case EfiUsbPortOverCurrentChange
:
773 // Clear PortOverCurrent change
775 State
|= PORTSC_OVERCUR_CHANGE
;
776 EhcWriteOpReg (Ehc
, Offset
, State
);
779 case EfiUsbPortPower
:
780 case EfiUsbPortSuspendChange
:
781 case EfiUsbPortResetChange
:
783 // Not supported or not related operation
788 Status
= EFI_INVALID_PARAMETER
;
797 Sets a feature for the specified root hub port.
799 @param PeiServices The pointer of EFI_PEI_SERVICES
800 @param This The pointer of PEI_USB2_HOST_CONTROLLER_PPI
801 @param PortNumber Root hub port to set.
802 @param PortFeature Feature to set.
804 @retval EFI_SUCCESS The feature specified by PortFeature was set.
805 @retval EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid.
806 @retval EFI_TIMEOUT The time out occurred.
811 EhcSetRootHubPortFeature (
812 IN EFI_PEI_SERVICES
**PeiServices
,
813 IN PEI_USB2_HOST_CONTROLLER_PPI
*This
,
815 IN EFI_USB_PORT_FEATURE PortFeature
818 PEI_USB2_HC_DEV
*Ehc
;
824 Ehc
= PEI_RECOVERY_USB_EHC_DEV_FROM_EHCI_THIS (This
);
825 Status
= EFI_SUCCESS
;
827 TotalPort
= (Ehc
->HcStructParams
& HCSP_NPORTS
);
829 if (PortNumber
>= TotalPort
) {
830 Status
= EFI_INVALID_PARAMETER
;
834 Offset
= (UINT32
) (EHC_PORT_STAT_OFFSET
+ (4 * PortNumber
));
835 State
= EhcReadOpReg (Ehc
, Offset
);
838 // Mask off the port status change bits, these bits are
841 State
&= ~PORTSC_CHANGE_MASK
;
843 switch (PortFeature
) {
844 case EfiUsbPortEnable
:
846 // Sofeware can't set this bit, Port can only be enable by
847 // EHCI as a part of the reset and enable
849 State
|= PORTSC_ENABLED
;
850 EhcWriteOpReg (Ehc
, Offset
, State
);
853 case EfiUsbPortSuspend
:
854 State
|= PORTSC_SUSPEND
;
855 EhcWriteOpReg (Ehc
, Offset
, State
);
858 case EfiUsbPortReset
:
860 // Make sure Host Controller not halt before reset it
862 if (EhcIsHalt (Ehc
)) {
863 Status
= EhcRunHC (Ehc
, EHC_GENERIC_TIMEOUT
);
865 if (EFI_ERROR (Status
)) {
871 // Set one to PortReset bit must also set zero to PortEnable bit
873 State
|= PORTSC_RESET
;
874 State
&= ~PORTSC_ENABLED
;
875 EhcWriteOpReg (Ehc
, Offset
, State
);
878 case EfiUsbPortPower
:
880 // Not supported, ignore the operation
882 Status
= EFI_SUCCESS
;
885 case EfiUsbPortOwner
:
886 State
|= PORTSC_OWNER
;
887 EhcWriteOpReg (Ehc
, Offset
, State
);
891 Status
= EFI_INVALID_PARAMETER
;
899 Retrieves the current status of a USB root hub port.
901 @param PeiServices The pointer of EFI_PEI_SERVICES.
902 @param This The pointer of PEI_USB2_HOST_CONTROLLER_PPI.
903 @param PortNumber The root hub port to retrieve the state from.
904 @param PortStatus Variable to receive the port state.
906 @retval EFI_SUCCESS The status of the USB root hub port specified.
907 by PortNumber was returned in PortStatus.
908 @retval EFI_INVALID_PARAMETER PortNumber is invalid.
913 EhcGetRootHubPortStatus (
914 IN EFI_PEI_SERVICES
**PeiServices
,
915 IN PEI_USB2_HOST_CONTROLLER_PPI
*This
,
917 OUT EFI_USB_PORT_STATUS
*PortStatus
920 PEI_USB2_HC_DEV
*Ehc
;
928 if (PortStatus
== NULL
) {
929 return EFI_INVALID_PARAMETER
;
932 Ehc
= PEI_RECOVERY_USB_EHC_DEV_FROM_EHCI_THIS(This
);
933 Status
= EFI_SUCCESS
;
935 TotalPort
= (Ehc
->HcStructParams
& HCSP_NPORTS
);
937 if (PortNumber
>= TotalPort
) {
938 Status
= EFI_INVALID_PARAMETER
;
942 Offset
= (UINT32
) (EHC_PORT_STAT_OFFSET
+ (4 * PortNumber
));
943 PortStatus
->PortStatus
= 0;
944 PortStatus
->PortChangeStatus
= 0;
946 State
= EhcReadOpReg (Ehc
, Offset
);
949 // Identify device speed. If in K state, it is low speed.
950 // If the port is enabled after reset, the device is of
951 // high speed. The USB bus driver should retrieve the actual
952 // port speed after reset.
954 if (EHC_BIT_IS_SET (State
, PORTSC_LINESTATE_K
)) {
955 PortStatus
->PortStatus
|= USB_PORT_STAT_LOW_SPEED
;
957 } else if (EHC_BIT_IS_SET (State
, PORTSC_ENABLED
)) {
958 PortStatus
->PortStatus
|= USB_PORT_STAT_HIGH_SPEED
;
962 // Convert the EHCI port/port change state to UEFI status
964 MapSize
= sizeof (mUsbPortStateMap
) / sizeof (USB_PORT_STATE_MAP
);
966 for (Index
= 0; Index
< MapSize
; Index
++) {
967 if (EHC_BIT_IS_SET (State
, mUsbPortStateMap
[Index
].HwState
)) {
968 PortStatus
->PortStatus
= (UINT16
) (PortStatus
->PortStatus
| mUsbPortStateMap
[Index
].UefiState
);
972 MapSize
= sizeof (mUsbPortChangeMap
) / sizeof (USB_PORT_STATE_MAP
);
974 for (Index
= 0; Index
< MapSize
; Index
++) {
975 if (EHC_BIT_IS_SET (State
, mUsbPortChangeMap
[Index
].HwState
)) {
976 PortStatus
->PortChangeStatus
= (UINT16
) (PortStatus
->PortChangeStatus
| mUsbPortChangeMap
[Index
].UefiState
);
985 Submits control transfer to a target USB device.
987 @param PeiServices The pointer of EFI_PEI_SERVICES.
988 @param This The pointer of PEI_USB2_HOST_CONTROLLER_PPI.
989 @param DeviceAddress The target device address.
990 @param DeviceSpeed Target device speed.
991 @param MaximumPacketLength Maximum packet size the default control transfer
992 endpoint is capable of sending or receiving.
993 @param Request USB device request to send.
994 @param TransferDirection Specifies the data direction for the data stage.
995 @param Data Data buffer to be transmitted or received from USB device.
996 @param DataLength The size (in bytes) of the data buffer.
997 @param TimeOut Indicates the maximum timeout, in millisecond.
998 @param Translator Transaction translator to be used by this device.
999 @param TransferResult Return the result of this control transfer.
1001 @retval EFI_SUCCESS Transfer was completed successfully.
1002 @retval EFI_OUT_OF_RESOURCES The transfer failed due to lack of resources.
1003 @retval EFI_INVALID_PARAMETER Some parameters are invalid.
1004 @retval EFI_TIMEOUT Transfer failed due to timeout.
1005 @retval EFI_DEVICE_ERROR Transfer failed due to host controller or device error.
1010 EhcControlTransfer (
1011 IN EFI_PEI_SERVICES
**PeiServices
,
1012 IN PEI_USB2_HOST_CONTROLLER_PPI
*This
,
1013 IN UINT8 DeviceAddress
,
1014 IN UINT8 DeviceSpeed
,
1015 IN UINTN MaximumPacketLength
,
1016 IN EFI_USB_DEVICE_REQUEST
*Request
,
1017 IN EFI_USB_DATA_DIRECTION TransferDirection
,
1019 IN OUT UINTN
*DataLength
,
1021 IN EFI_USB2_HC_TRANSACTION_TRANSLATOR
*Translator
,
1022 OUT UINT32
*TransferResult
1025 PEI_USB2_HC_DEV
*Ehc
;
1031 // Validate parameters
1033 if ((Request
== NULL
) || (TransferResult
== NULL
)) {
1034 return EFI_INVALID_PARAMETER
;
1037 if ((TransferDirection
!= EfiUsbDataIn
) &&
1038 (TransferDirection
!= EfiUsbDataOut
) &&
1039 (TransferDirection
!= EfiUsbNoData
)) {
1040 return EFI_INVALID_PARAMETER
;
1043 if ((TransferDirection
== EfiUsbNoData
) &&
1044 ((Data
!= NULL
) || (*DataLength
!= 0))) {
1045 return EFI_INVALID_PARAMETER
;
1048 if ((TransferDirection
!= EfiUsbNoData
) &&
1049 ((Data
== NULL
) || (*DataLength
== 0))) {
1050 return EFI_INVALID_PARAMETER
;
1053 if ((MaximumPacketLength
!= 8) && (MaximumPacketLength
!= 16) &&
1054 (MaximumPacketLength
!= 32) && (MaximumPacketLength
!= 64)) {
1055 return EFI_INVALID_PARAMETER
;
1059 if ((DeviceSpeed
== EFI_USB_SPEED_LOW
) ||
1060 ((DeviceSpeed
== EFI_USB_SPEED_FULL
) && (MaximumPacketLength
> 64)) ||
1061 ((EFI_USB_SPEED_HIGH
== DeviceSpeed
) && (MaximumPacketLength
> 512))) {
1062 return EFI_INVALID_PARAMETER
;
1065 Ehc
= PEI_RECOVERY_USB_EHC_DEV_FROM_EHCI_THIS (This
);
1067 Status
= EFI_DEVICE_ERROR
;
1068 *TransferResult
= EFI_USB_ERR_SYSTEM
;
1070 if (EhcIsHalt (Ehc
) || EhcIsSysError (Ehc
)) {
1071 EhcAckAllInterrupt (Ehc
);
1075 EhcAckAllInterrupt (Ehc
);
1078 // Create a new URB, insert it into the asynchronous
1079 // schedule list, then poll the execution status.
1082 // Encode the direction in address, although default control
1083 // endpoint is bidirectional. EhcCreateUrb expects this
1084 // combination of Ep addr and its direction.
1086 Endpoint
= (UINT8
) (0 | ((TransferDirection
== EfiUsbDataIn
) ? 0x80 : 0));
1087 Urb
= EhcCreateUrb (
1093 MaximumPacketLength
,
1105 Status
= EFI_OUT_OF_RESOURCES
;
1109 EhcLinkQhToAsync (Ehc
, Urb
->Qh
);
1110 Status
= EhcExecTransfer (Ehc
, Urb
, TimeOut
);
1111 EhcUnlinkQhFromAsync (Ehc
, Urb
->Qh
);
1114 // Get the status from URB. The result is updated in EhcCheckUrbResult
1115 // which is called by EhcExecTransfer
1117 *TransferResult
= Urb
->Result
;
1118 *DataLength
= Urb
->Completed
;
1120 if (*TransferResult
== EFI_USB_NOERROR
) {
1121 Status
= EFI_SUCCESS
;
1124 EhcAckAllInterrupt (Ehc
);
1125 EhcFreeUrb (Ehc
, Urb
);
1132 @param FileHandle Handle of the file being invoked.
1133 @param PeiServices Describes the list of possible PEI Services.
1135 @retval EFI_SUCCESS PPI successfully installed.
1141 IN EFI_PEI_FILE_HANDLE FileHandle
,
1142 IN CONST EFI_PEI_SERVICES
**PeiServices
1145 PEI_USB_CONTROLLER_PPI
*ChipSetUsbControllerPpi
;
1148 UINTN ControllerType
;
1151 PEI_USB2_HC_DEV
*EhcDev
;
1152 EFI_PHYSICAL_ADDRESS TempPtr
;
1155 // Shadow this PEIM to run from memory
1157 if (!EFI_ERROR (PeiServicesRegisterForShadow (FileHandle
))) {
1161 Status
= PeiServicesLocatePpi (
1162 &gPeiUsbControllerPpiGuid
,
1165 (VOID
**) &ChipSetUsbControllerPpi
1167 if (EFI_ERROR (Status
)) {
1168 return EFI_UNSUPPORTED
;
1173 Status
= ChipSetUsbControllerPpi
->GetUsbController (
1174 (EFI_PEI_SERVICES
**) PeiServices
,
1175 ChipSetUsbControllerPpi
,
1181 // When status is error, meant no controller is found
1183 if (EFI_ERROR (Status
)) {
1188 // This PEIM is for UHC type controller.
1190 if (ControllerType
!= PEI_EHCI_CONTROLLER
) {
1195 MemPages
= sizeof (PEI_USB2_HC_DEV
) / PAGESIZE
+ 1;
1196 Status
= PeiServicesAllocatePages (
1197 EfiBootServicesCode
,
1201 if (EFI_ERROR (Status
)) {
1202 return EFI_OUT_OF_RESOURCES
;
1205 ZeroMem((VOID
*)(UINTN
)TempPtr
, MemPages
*PAGESIZE
);
1206 EhcDev
= (PEI_USB2_HC_DEV
*) ((UINTN
) TempPtr
);
1208 EhcDev
->Signature
= USB2_HC_DEV_SIGNATURE
;
1210 EhcDev
->UsbHostControllerBaseAddress
= (UINT32
) BaseAddress
;
1213 EhcDev
->HcStructParams
= EhcReadCapRegister (EhcDev
, EHC_HCSPARAMS_OFFSET
);
1214 EhcDev
->HcCapParams
= EhcReadCapRegister (EhcDev
, EHC_HCCPARAMS_OFFSET
);
1215 EhcDev
->CapLen
= EhcReadCapRegister (EhcDev
, EHC_CAPLENGTH_OFFSET
) & 0x0FF;
1217 // Initialize Uhc's hardware
1219 Status
= InitializeUsbHC (EhcDev
);
1220 if (EFI_ERROR (Status
)) {
1224 EhcDev
->Usb2HostControllerPpi
.ControlTransfer
= EhcControlTransfer
;
1225 EhcDev
->Usb2HostControllerPpi
.BulkTransfer
= EhcBulkTransfer
;
1226 EhcDev
->Usb2HostControllerPpi
.GetRootHubPortNumber
= EhcGetRootHubPortNumber
;
1227 EhcDev
->Usb2HostControllerPpi
.GetRootHubPortStatus
= EhcGetRootHubPortStatus
;
1228 EhcDev
->Usb2HostControllerPpi
.SetRootHubPortFeature
= EhcSetRootHubPortFeature
;
1229 EhcDev
->Usb2HostControllerPpi
.ClearRootHubPortFeature
= EhcClearRootHubPortFeature
;
1231 EhcDev
->PpiDescriptor
.Flags
= (EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
);
1232 EhcDev
->PpiDescriptor
.Guid
= &gPeiUsb2HostControllerPpiGuid
;
1233 EhcDev
->PpiDescriptor
.Ppi
= &EhcDev
->Usb2HostControllerPpi
;
1235 Status
= PeiServicesInstallPpi (&EhcDev
->PpiDescriptor
);
1236 if (EFI_ERROR (Status
)) {
1248 @param EhcDev EHCI Device.
1250 @retval EFI_SUCCESS EHCI successfully initialized.
1251 @retval EFI_ABORTED EHCI was failed to be initialized.
1256 IN PEI_USB2_HC_DEV
*EhcDev
1262 EhcResetHC (EhcDev
, EHC_RESET_TIMEOUT
);
1264 Status
= EhcInitHC (EhcDev
);
1266 if (EFI_ERROR (Status
)) {