Data Structures
struct	_EDKII_NVM_EXPRESS_HOST_CONTROLLER_PPI

Macros
#define	EDKII_NVME_EXPRESS_HOST_CONTROLLER_PPI_GUID

Typedefs
typedef struct _EDKII_NVM_EXPRESS_HOST_CONTROLLER_PPI	EDKII_NVM_EXPRESS_HOST_CONTROLLER_PPI

typedef IN UINT8	ControllerId

typedef IN UINT8 OUT UINTN *	MmioBar

typedef IN UINT8 OUT UINTN *	DevicePathLength

typedef IN UINT8 OUT UINTN OUT EFI_DEVICE_PATH_PROTOCOL **	DevicePath

Functions
typedef	EFI_STATUS (EFIAPI EDKII_NVM_EXPRESS_HC_GET_MMIO_BAR)(IN EDKII_NVM_EXPRESS_HOST_CONTROLLER_PPI This

Variables
EFI_GUID	gEdkiiPeiNvmExpressHostControllerPpiGuid

Detailed Description

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

Macro Definition Documentation

#define EDKII_NVME_EXPRESS_HOST_CONTROLLER_PPI_GUID

Value:

{ \
    0xcae3aa63, 0x676f, 0x4da3, { 0xbd, 0x50, 0x6c, 0xc5, 0xed, 0xde, 0x9a, 0xad } \
  }

Global ID for the EDKII_NVM_EXPRESS_HOST_CONTROLLER_PPI.

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

typedef EFI_STATUS ( EFIAPI * EDKII_NVM_EXPRESS_HC_GET_DEVICE_PATH )

Get the MMIO base address of NVM Express host controller.

Parameters

[in]	This	The PPI instance pointer.
[in]	ControllerId	The ID of the NVM Express host controller.
[out]	MmioBar	The MMIO base address of the controller.

Return values

EFI_SUCCESS	The operation succeeds.
EFI_INVALID_PARAMETER	The parameters are invalid.
EFI_NOT_FOUND	The specified NVM Express host controller not found.

Get the device path of NVM Express host controller.

Parameters

[in]	This	The PPI instance pointer.
[in]	ControllerId	The ID of the NVM Express host controller.
[out]	DevicePathLength	The length of the device path in bytes specified by DevicePath.
[out]	DevicePath	The device path of NVM Express 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_SUCCESS	The operation succeeds.
EFI_INVALID_PARAMETER	The parameters are invalid.
EFI_NOT_FOUND	The specified NVM Express host controller not found.
EFI_OUT_OF_RESOURCES	The operation fails due to lack of resources.

EFI_GUID gEdkiiPeiNvmExpressHostControllerPpiGuid