MdeModulePkg[all]  0.98
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
AtaAhciController.h File Reference

Data Structures

struct  _EDKII_ATA_AHCI_HOST_CONTROLLER_PPI
 

Macros

#define EDKII_ATA_AHCI_HOST_CONTROLLER_PPI_GUID
 

Typedefs

typedef struct
_EDKII_ATA_AHCI_HOST_CONTROLLER_PPI 
EDKII_ATA_AHCI_HOST_CONTROLLER_PPI
 
typedef IN UINT8 ControllerId
 
typedef IN UINT8 OUT UINTNMmioBar
 
typedef IN UINT8 OUT UINTNDevicePathLength
 
typedef IN UINT8 OUT UINTN OUT
EFI_DEVICE_PATH_PROTOCOL ** 
DevicePath
 

Functions

typedef EFI_STATUS (EFIAPI *EDKII_ATA_AHCI_HC_GET_MMIO_BAR)(IN EDKII_ATA_AHCI_HOST_CONTROLLER_PPI *This
 

Variables

EFI_GUID gEdkiiPeiAtaAhciHostControllerPpiGuid
 

Detailed Description

Copyright (c) 2019, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Macro Definition Documentation

#define EDKII_ATA_AHCI_HOST_CONTROLLER_PPI_GUID
Value:
{ \
0x61dd33ea, 0x421f, 0x4cc0, { 0x89, 0x29, 0xff, 0xee, 0xa9, 0xa1, 0xa2, 0x61 } \
}

Global ID for the EDKII_ATA_AHCI_HOST_CONTROLLER_PPI.

Typedef Documentation

typedef IN UINT8 ControllerId
typedef IN UINT8 OUT UINTN OUT EFI_DEVICE_PATH_PROTOCOL** DevicePath
typedef IN UINT8 OUT UINTN* DevicePathLength
typedef IN UINT8 OUT UINTN* MmioBar

Function Documentation

typedef EFI_STATUS ( EFIAPI *  EDKII_ATA_AHCI_HC_GET_DEVICE_PATH)

Get the MMIO base address of ATA AHCI host controller.

Parameters
[in]ThisThe PPI instance pointer.
[in]ControllerIdThe ID of the ATA AHCI host controller.
[out]MmioBarThe MMIO base address of the controller.
Return values
EFI_SUCCESSThe operation succeeds.
EFI_INVALID_PARAMETERThe parameters are invalid.
EFI_NOT_FOUNDThe specified ATA AHCI host controller not found.

Get the device path of ATA AHCI host controller.

Parameters
[in]ThisThe PPI instance pointer.
[in]ControllerIdThe ID of the ATA AHCI host controller.
[out]DevicePathLengthThe length of the device path in bytes specified by DevicePath.
[out]DevicePathThe device path of ATA AHCI host controller. This field re-uses EFI Device Path Protocol as defined by Section 10.2 EFI Device Path Protocol of UEFI 2.7 Specification.
Return values
EFI_SUCCESSThe operation succeeds.
EFI_INVALID_PARAMETERThe parameters are invalid.
EFI_NOT_FOUNDThe specified ATA AHCI host controller not found.
EFI_OUT_OF_RESOURCESThe operation fails due to lack of resources.

Variable Documentation

EFI_GUID gEdkiiPeiAtaAhciHostControllerPpiGuid