NvmExpressPassThru.h File Reference

Data Structures
struct	_EDKII_PEI_NVM_EXPRESS_PASS_THRU_PPI

Macros
#define	EDKII_PEI_NVM_EXPRESS_PASS_THRU_PPI_GUID
#define	EDKII_PEI_NVM_EXPRESS_PASS_THRU_PPI_REVISION   0x00010000

Typedefs
typedef struct _EDKII_PEI_NVM_EXPRESS_PASS_THRU_PPI	EDKII_PEI_NVM_EXPRESS_PASS_THRU_PPI
typedef OUT UINTN *	DevicePathLength
typedef OUT UINTN OUT EFI_DEVICE_PATH_PROTOCOL **	DevicePath
typedef EFI_STATUS(EFIAPI *	EDKII_PEI_NVME_PASS_THRU_GET_NEXT_NAMESPACE )(IN EDKII_PEI_NVM_EXPRESS_PASS_THRU_PPI *This, IN OUT UINT32 *NamespaceId)
typedef IN UINT32	NamespaceId
typedef IN UINT32 IN OUT EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET *	Packet

Functions
typedef	EFI_STATUS (EFIAPI *EDKII_PEI_NVME_PASS_THRU_GET_DEVICE_PATH)(IN EDKII_PEI_NVM_EXPRESS_PASS_THRU_PPI *This

Variables
EFI_GUID	gEdkiiPeiNvmExpressPassThruPpiGuid

Detailed Description

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

Macro Definition Documentation

#define EDKII_PEI_NVM_EXPRESS_PASS_THRU_PPI_GUID

Value:

{ \
    0x6af31b2c, 0x3be, 0x46c1, { 0xb1, 0x2d, 0xea, 0x4a, 0x36, 0xdf, 0xa7, 0x4c } \
  }

Global ID for the EDKII_PEI_NVM_EXPRESS_PASS_THRU_PPI.

#define EDKII_PEI_NVM_EXPRESS_PASS_THRU_PPI_REVISION   0x00010000

Typedef Documentation

typedef OUT UINTN OUT EFI_DEVICE_PATH_PROTOCOL** DevicePath

typedef OUT UINTN* DevicePathLength

typedef struct _EDKII_PEI_NVM_EXPRESS_PASS_THRU_PPI EDKII_PEI_NVM_EXPRESS_PASS_THRU_PPI

typedef EFI_STATUS(EFIAPI * EDKII_PEI_NVME_PASS_THRU_GET_NEXT_NAMESPACE)(IN EDKII_PEI_NVM_EXPRESS_PASS_THRU_PPI *This, IN OUT UINT32 *NamespaceId)

Used to retrieve the next namespace ID for this NVM Express controller.

If on input the value pointed to by NamespaceId is 0xFFFFFFFF, then the first valid namespace ID defined on the NVM Express controller is returned in the location pointed to by NamespaceId and a status of EFI_SUCCESS is returned.

If on input the value pointed to by NamespaceId is an invalid namespace ID other than 0xFFFFFFFF, then EFI_INVALID_PARAMETER is returned.

If on input the value pointed to by NamespaceId is a valid namespace ID, then the next valid namespace ID on the NVM Express controller is returned in the location pointed to by NamespaceId, and EFI_SUCCESS is returned.

If the value pointed to by NamespaceId is the namespace ID of the last namespace on the NVM Express controller, then EFI_NOT_FOUND is returned.

Parameters

[in]	This	The PPI instance pointer.
[in,out]	NamespaceId	On input, a pointer to a legal NamespaceId for an NVM Express namespace present on the NVM Express controller. On output, a pointer to the next NamespaceId of an NVM Express namespace on an NVM Express controller. An input value of 0xFFFFFFFF retrieves the first NamespaceId for an NVM Express namespace present on an NVM Express controller.

Return values

EFI_SUCCESS	The Namespace ID of the next Namespace was returned.
EFI_NOT_FOUND	There are no more namespaces defined on this controller.
EFI_INVALID_PARAMETER	NamespaceId is an invalid value other than 0xFFFFFFFF.

typedef IN UINT32 NamespaceId

typedef IN UINT32 IN OUT EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET* Packet

Function Documentation

typedef EFI_STATUS

(

EFIAPI *

EDKII_PEI_NVME_PASS_THRU_PASSTHRU

)

Gets the device path information of the underlying NVM Express host controller.

Parameters

[in]	This	The PPI instance pointer.
[out]	DevicePathLength	The length of the device path in bytes specified by DevicePath.
[out]	DevicePath	The device path of the underlying 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	DevicePathLength or DevicePath is NULL.
EFI_OUT_OF_RESOURCES	The operation fails due to lack of resources.

Sends an NVM Express Command Packet to an NVM Express controller or namespace. This function only supports blocking execution of the command.

Parameters

[in]	This	The PPI instance pointer.
[in]	NamespaceId	Is a 32 bit Namespace ID to which the Nvm Express command packet will be sent. A Value of 0 denotes the NVM Express controller, a Value of all 0FFh in the namespace ID specifies that the command packet should be sent to all valid namespaces.
[in,out]	Packet	A pointer to the EDKII PEI NVM Express PassThru Command Packet to send to the NVMe namespace specified by NamespaceId.

Return values

EFI_SUCCESS	The EDKII PEI NVM Express Command Packet was sent by the host. TransferLength bytes were transferred to, or from DataBuffer.
EFI_NOT_READY	The EDKII PEI NVM Express Command Packet could not be sent because the controller is not ready. The caller may retry again later.
EFI_DEVICE_ERROR	A device error occurred while attempting to send the EDKII PEI NVM Express Command Packet.
EFI_INVALID_PARAMETER	Namespace, or the contents of EDKII_PEI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET are invalid. The EDKII PEI NVM Express Command Packet was not sent, so no additional status information is available.
EFI_UNSUPPORTED	The command described by the EDKII PEI NVM Express Command Packet is not supported by the host adapter. The EDKII PEI NVM Express Command Packet was not sent, so no additional status information is available.
EFI_TIMEOUT	A timeout occurred while waiting for the EDKII PEI NVM Express Command Packet to execute.

Variable Documentation

EFI_GUID gEdkiiPeiNvmExpressPassThruPpiGuid