1 /** @file 2 Define APIs to retrieve USB Host Controller Info such as controller type and 3 I/O Port Base Address. 4 5 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR> 6 7 SPDX-License-Identifier: BSD-2-Clause-Patent 8 9 **/ 10 11 #ifndef _PEI_USB_CONTROLLER_PPI_H_ 12 #define _PEI_USB_CONTROLLER_PPI_H_ 13 14 /// 15 /// Global ID for the PEI_USB_CONTROLLER_PPI. 16 /// 17 #define PEI_USB_CONTROLLER_PPI_GUID \ 18 { \ 19 0x3bc1f6de, 0x693e, 0x4547,{ 0xa3, 0x0, 0x21, 0x82, 0x3c, 0xa4, 0x20, 0xb2} \ 20 } 21 22 /// 23 /// Forward declaration for the PEI_USB_CONTROLLER_PPI. 24 /// 25 typedef struct _PEI_USB_CONTROLLER_PPI PEI_USB_CONTROLLER_PPI; 26 27 /// 28 /// This bit is used in the ControllerType return parameter of GetUsbController() 29 /// to identify the USB Host Controller type as UHCI 30 /// 31 #define PEI_UHCI_CONTROLLER 0x01 32 33 /// 34 /// This bit is used in the ControllerType return parameter of GetUsbController() 35 /// to identify the USB Host Controller type as OHCI 36 /// 37 #define PEI_OHCI_CONTROLLER 0x02 38 39 /// 40 /// This bit is used in the ControllerType return parameter of GetUsbController() 41 /// to identify the USB Host Controller type as EHCI 42 /// 43 #define PEI_EHCI_CONTROLLER 0x03 44 45 /// 46 /// This bit is used in the ControllerType return parameter of GetUsbController() 47 /// to identify the USB Host Controller type as XHCI 48 /// 49 #define PEI_XHCI_CONTROLLER 0x04 50 51 /** 52 Retrieve USB Host Controller Info such as controller type and I/O Base Address. 53 54 @param[in] PeiServices The pointer to the PEI Services Table. 55 @param[in] This The pointer to this instance of the PEI_USB_CONTROLLER_PPI. 56 @param[in] ControllerId The ID of the USB controller. 57 @param[out] ControllerType On output, returns the type of the USB controller. 58 @param[out] BaseAddress On output, returns the base address of UHCI's I/O ports 59 if UHCI is enabled or the base address of EHCI's MMIO 60 if EHCI is enabled. 61 62 @retval EFI_SUCCESS USB controller attributes were returned successfully. 63 @retval EFI_INVALID_PARAMETER ControllerId is greater than the maximum number 64 of USB controller supported by this platform. 65 66 **/ 67 typedef 68 EFI_STATUS 69 (EFIAPI *PEI_GET_USB_CONTROLLER)( 70 IN EFI_PEI_SERVICES **PeiServices, 71 IN PEI_USB_CONTROLLER_PPI *This, 72 IN UINT8 UsbControllerId, 73 OUT UINTN *ControllerType, 74 OUT UINTN *BaseAddress 75 ); 76 77 /// 78 /// This PPI contains a single service to retrieve the USB Host Controller type 79 /// and the base address of the I/O ports used to access the USB Host Controller. 80 /// 81 struct _PEI_USB_CONTROLLER_PPI { 82 PEI_GET_USB_CONTROLLER GetUsbController; 83 }; 84 85 extern EFI_GUID gPeiUsbControllerPpiGuid; 86 87 #endif 88