Data Structures
struct	_PEI_USB_CONTROLLER_PPI

Macros
#define	PEI_USB_CONTROLLER_PPI_GUID

#define	PEI_UHCI_CONTROLLER 0x01

#define	PEI_OHCI_CONTROLLER 0x02

#define	PEI_EHCI_CONTROLLER 0x03

#define	PEI_XHCI_CONTROLLER 0x04

Typedefs
typedef struct _PEI_USB_CONTROLLER_PPI	PEI_USB_CONTROLLER_PPI

typedef EFI_STATUS(EFIAPI *	PEI_GET_USB_CONTROLLER) (IN EFI_PEI_SERVICES *PeiServices, IN PEI_USB_CONTROLLER_PPI This, IN UINT8 UsbControllerId, OUT UINTN ControllerType, OUT UINTN BaseAddress)

Variables
EFI_GUID	gPeiUsbControllerPpiGuid

Detailed Description

Define APIs to retrieve USB Host Controller Info such as controller type and I/O Port Base Address.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file UsbController.h.

Macro Definition Documentation

◆ PEI_EHCI_CONTROLLER

#define PEI_EHCI_CONTROLLER 0x03

This bit is used in the ControllerType return parameter of GetUsbController() to identify the USB Host Controller type as EHCI

Definition at line 43 of file UsbController.h.

◆ PEI_OHCI_CONTROLLER

#define PEI_OHCI_CONTROLLER 0x02

This bit is used in the ControllerType return parameter of GetUsbController() to identify the USB Host Controller type as OHCI

Definition at line 37 of file UsbController.h.

◆ PEI_UHCI_CONTROLLER

#define PEI_UHCI_CONTROLLER 0x01

This bit is used in the ControllerType return parameter of GetUsbController() to identify the USB Host Controller type as UHCI

Definition at line 31 of file UsbController.h.

◆ PEI_USB_CONTROLLER_PPI_GUID

#define PEI_USB_CONTROLLER_PPI_GUID

Value:

  { \
    0x3bc1f6de, 0x693e, 0x4547,{ 0xa3, 0x0, 0x21, 0x82, 0x3c, 0xa4, 0x20, 0xb2} \
  }

Global ID for the PEI_USB_CONTROLLER_PPI.

Definition at line 17 of file UsbController.h.

◆ PEI_XHCI_CONTROLLER

#define PEI_XHCI_CONTROLLER 0x04

This bit is used in the ControllerType return parameter of GetUsbController() to identify the USB Host Controller type as XHCI

Definition at line 49 of file UsbController.h.

Typedef Documentation

◆ PEI_GET_USB_CONTROLLER

typedef EFI_STATUS(EFIAPI * PEI_GET_USB_CONTROLLER) (IN EFI_PEI_SERVICES **PeiServices, IN PEI_USB_CONTROLLER_PPI *This, IN UINT8 UsbControllerId, OUT UINTN *ControllerType, OUT UINTN *BaseAddress)

Retrieve USB Host Controller Info such as controller type and I/O Base Address.

Parameters

[in]	PeiServices	The pointer to the PEI Services Table.
[in]	This	The pointer to this instance of the PEI_USB_CONTROLLER_PPI.
[in]	ControllerId	The ID of the USB controller.
[out]	ControllerType	On output, returns the type of the USB controller.
[out]	BaseAddress	On output, returns the base address of UHCI's I/O ports if UHCI is enabled or the base address of EHCI's MMIO if EHCI is enabled.

Return values

EFI_SUCCESS	USB controller attributes were returned successfully.
EFI_INVALID_PARAMETER	ControllerId is greater than the maximum number of USB controller supported by this platform.

Definition at line 68 of file UsbController.h.

◆ PEI_USB_CONTROLLER_PPI

typedef struct _PEI_USB_CONTROLLER_PPI PEI_USB_CONTROLLER_PPI

Forward declaration for the PEI_USB_CONTROLLER_PPI.

Definition at line 25 of file UsbController.h.

Data Structures

Macros

Typedefs

Variables