NvmExpressHostController.h File Reference

#include <Protocol/DevicePath.h>

Go to the source code of this file.

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 EFI_STATUS(EFIAPI *	EDKII_NVM_EXPRESS_HC_GET_MMIO_BAR) (IN EDKII_NVM_EXPRESS_HOST_CONTROLLER_PPI *This, IN UINT8 ControllerId, OUT UINTN *MmioBar)
typedef EFI_STATUS(EFIAPI *	EDKII_NVM_EXPRESS_HC_GET_DEVICE_PATH) (IN EDKII_NVM_EXPRESS_HOST_CONTROLLER_PPI *This, IN UINT8 ControllerId, OUT UINTN *DevicePathLength, OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath)

Variables
EFI_GUID	gEdkiiPeiNvmExpressHostControllerPpiGuid

Detailed Description

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

Definition in file NvmExpressHostController.h.

Macro Definition Documentation

EDKII_NVME_EXPRESS_HOST_CONTROLLER_PPI_GUID

#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.

Definition at line 16 of file NvmExpressHostController.h.

Typedef Documentation

EDKII_NVM_EXPRESS_HC_GET_DEVICE_PATH

typedef EFI_STATUS(EFIAPI * EDKII_NVM_EXPRESS_HC_GET_DEVICE_PATH) (IN EDKII_NVM_EXPRESS_HOST_CONTROLLER_PPI *This, IN UINT8 ControllerId, OUT UINTN *DevicePathLength, OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath)

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.

Definition at line 67 of file NvmExpressHostController.h.

EDKII_NVM_EXPRESS_HC_GET_MMIO_BAR

typedef EFI_STATUS(EFIAPI * EDKII_NVM_EXPRESS_HC_GET_MMIO_BAR) (IN EDKII_NVM_EXPRESS_HOST_CONTROLLER_PPI *This, IN UINT8 ControllerId, OUT UINTN *MmioBar)

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.

Definition at line 40 of file NvmExpressHostController.h.

EDKII_NVM_EXPRESS_HOST_CONTROLLER_PPI

typedef struct _EDKII_NVM_EXPRESS_HOST_CONTROLLER_PPI EDKII_NVM_EXPRESS_HOST_CONTROLLER_PPI

Definition at line 24 of file NvmExpressHostController.h.