mirror of
https://git.proxmox.com/git/mirror_edk2
synced 2025-11-03 14:05:03 +00:00
d987459f8e
Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Star Zeng <star.zeng@intel.com> Reviewed-by: Feng Tian <feng.tian@intel.com> git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15611 6f19259b-4bc3-4df7-8a09-765794883524
95 lines
3.2 KiB
C
95 lines
3.2 KiB
C
/** @file
|
|
Define APIs to retrieve USB Host Controller Info such as controller type and
|
|
I/O Port Base Address.
|
|
|
|
Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
|
|
|
|
This program and the accompanying materials
|
|
are licensed and made available under the terms and conditions
|
|
of the BSD License which accompanies this distribution. The
|
|
full text of the license may be found at
|
|
http://opensource.org/licenses/bsd-license.php
|
|
|
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|
|
|
**/
|
|
|
|
#ifndef _PEI_USB_CONTROLLER_PPI_H_
|
|
#define _PEI_USB_CONTROLLER_PPI_H_
|
|
|
|
///
|
|
/// Global ID for the PEI_USB_CONTROLLER_PPI.
|
|
///
|
|
#define PEI_USB_CONTROLLER_PPI_GUID \
|
|
{ \
|
|
0x3bc1f6de, 0x693e, 0x4547,{ 0xa3, 0x0, 0x21, 0x82, 0x3c, 0xa4, 0x20, 0xb2} \
|
|
}
|
|
|
|
///
|
|
/// Forward declaration for the PEI_USB_CONTROLLER_PPI.
|
|
///
|
|
typedef struct _PEI_USB_CONTROLLER_PPI PEI_USB_CONTROLLER_PPI;
|
|
|
|
///
|
|
/// This bit is used in the ControllerType return parameter of GetUsbController()
|
|
/// to identify the USB Host Controller type as UHCI
|
|
///
|
|
#define PEI_UHCI_CONTROLLER 0x01
|
|
|
|
///
|
|
/// This bit is used in the ControllerType return parameter of GetUsbController()
|
|
/// to identify the USB Host Controller type as OHCI
|
|
///
|
|
#define PEI_OHCI_CONTROLLER 0x02
|
|
|
|
///
|
|
/// This bit is used in the ControllerType return parameter of GetUsbController()
|
|
/// to identify the USB Host Controller type as EHCI
|
|
///
|
|
#define PEI_EHCI_CONTROLLER 0x03
|
|
|
|
///
|
|
/// This bit is used in the ControllerType return parameter of GetUsbController()
|
|
/// to identify the USB Host Controller type as XHCI
|
|
///
|
|
#define PEI_XHCI_CONTROLLER 0x04
|
|
|
|
/**
|
|
Retrieve USB Host Controller Info such as controller type and I/O Base Address.
|
|
|
|
@param[in] PeiServices The pointer to the PEI Services Table.
|
|
@param[in] This The pointer to this instance of the PEI_USB_CONTROLLER_PPI.
|
|
@param[in] ControllerId The ID of the USB controller.
|
|
@param[out] ControllerType On output, returns the type of the USB controller.
|
|
@param[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.
|
|
|
|
@retval EFI_SUCCESS USB controller attributes were returned successfully.
|
|
@retval EFI_INVALID_PARAMETER ControllerId is greater than the maximum number
|
|
of USB controller supported by this platform.
|
|
|
|
**/
|
|
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
|
|
);
|
|
|
|
///
|
|
/// This PPI contains a single service to retrieve the USB Host Controller type
|
|
/// and the base address of the I/O ports used to access the USB Host Controller.
|
|
///
|
|
struct _PEI_USB_CONTROLLER_PPI {
|
|
PEI_GET_USB_CONTROLLER GetUsbController;
|
|
};
|
|
|
|
extern EFI_GUID gPeiUsbControllerPpiGuid;
|
|
|
|
#endif
|