diff options
Diffstat (limited to 'Include/Protocol/NvmExpressPassThru.h')
| -rw-r--r-- | Include/Protocol/NvmExpressPassThru.h | 307 |
1 files changed, 307 insertions, 0 deletions
diff --git a/Include/Protocol/NvmExpressPassThru.h b/Include/Protocol/NvmExpressPassThru.h new file mode 100644 index 0000000..2e9e7ac --- /dev/null +++ b/Include/Protocol/NvmExpressPassThru.h @@ -0,0 +1,307 @@ +//********************************************************************** +//********************************************************************** +//** ** +//** (C)Copyright 1985-2015, American Megatrends, Inc. ** +//** ** +//** All Rights Reserved. ** +//** ** +//** 5555 Oakbrook Parkway, Suite 200, Norcross, GA 30093 ** +//** ** +//** Phone: (770)-246-8600 ** +//** ** +//********************************************************************** +//********************************************************************** +//********************************************************************** +// $Header: /Alaska/SOURCE/Modules/NVMe/Nvme Protocol/NvmExpressPassThru.h 1 5/14/15 2:40a Karthikar $ +// +// $Revision: 1 $ +// +// $Date: 5/14/15 2:40a $ +//********************************************************************** +//********************************************************************** +//<AMI_FHDR_START> +// +// Name: NvmExpressPassThru.h +// +// Description: Protocol Header file for the NvmExpressPassThru Protocol +// +//<AMI_FHDR_END> +//********************************************************************** + +#ifndef __EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL_H__ +#define __EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL_H__ + +typedef struct _EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL; + +#define EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL_GUID \ + {0x52c78312, 0x8edc, 0x4233, { 0x98, 0xf2, 0x1a, 0x1a, 0xa5, 0xe3, 0x88, 0xa5 } } + +#define EFI_NVM_EXPRESS_PASS_THRU_ATTRIBUTES_PHYSICAL 0x0001 + +#define EFI_NVM_EXPRESS_PASS_THRU_ATTRIBUTES_LOGICAL 0x0002 + +#define EFI_NVM_EXPRESS_PASS_THRU_ATTRIBUTES_NONBLOCKINGIO 0x0004 + +#define EFI_NVM_EXPRESS_PASS_THRU_ATTRIBUTES_CMD_SET_NVME 0x0008 + +// FusedOperation +#define NORMAL_CMD 0x00 +#define FUSED_FIRST_CMD 0x01 +#define FUSED_SECOND_CMD 0x02 + +// Flags +#define CDW2_VALID 0x01 +#define CDW3_VALID 0x02 +#define CDW10_VALID 0x04 +#define CDW11_VALID 0x08 +#define CDW12_VALID 0x10 +#define CDW13_VALID 0x20 +#define CDW14_VALID 0x40 +#define CDW15_VALID 0x80 + +typedef struct { + UINT32 Attributes; + UINT32 IoAlign; + UINT32 NvmeVersion; +} EFI_NVM_EXPRESS_PASS_THRU_MODE; + +typedef struct { + UINT8 OpCode; + UINT8 FusedOperation; + UINT16 Unused; +} NVME_CDW0; + +typedef struct { + NVME_CDW0 Cdw0; + UINT8 Flags; + UINT32 Nsid; + UINT32 Cdw2; + UINT32 Cdw3; + UINT32 Cdw10; + UINT32 Cdw11; + UINT32 Cdw12; + UINT32 Cdw13; + UINT32 Cdw14; + UINT32 Cdw15; +} EFI_NVM_EXPRESS_COMMAND; + +// This structure maps to the NVM Express specification Completion Queue Entry + +typedef struct { + UINT32 DW0; + UINT32 DW1; + UINT32 DW2; + UINT32 DW3; +} EFI_NVM_EXPRESS_COMPLETION; + +typedef struct _EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET { + // The timeout, in 100 ns units, to use for the execution of this + // NVM Express Command Packet. A Timeout value of 0 means that this + // function will wait indefinitely for the command to execute. + // If Timeout is greater than zero, then this function will return + // EFI_TIMEOUT if the time required to execute the NVM Express + // command is greater than Timeout + UINT64 CommandTimeout; + // + // A pointer to the data buffer to transfer between the host, and the + // NVM Express controller for read, write, and bi-directional commands + // + VOID *TransferBuffer; + // + // On input, the size in bytes of TransferBuffer. On output, the number + // of bytes transferred to the NVM Express controller, or namespace + // + UINT32 TransferLength; + // + // A pointer to the optional metadata buffer to transfer between the host, + // and the NVM Express controller.If this field is not NULL, then it must + // be aligned on the boundary specified by the IoAlign field in the + // EFI_NVM_EXPRESS_PASS_THRU_MODE structure. + // + VOID *MetaDataBuffer; + // + // On Input, the size in bytes of MetadataBuffer. On output, the number + // of bytes transferred to/from the NVM Express controller, or namespace + // + UINT32 MetadataLength; + // + // The type of the queue that the NVMe command should be posted to. + // A value of 0 indicates it should be posted to the Admin Submission Queue. + // A value of 1 indicates it should be posted to an I/O Submission Queue + // + UINT16 QueueType; + // + // A pointer to an NVM Express Command Packet. + // + EFI_NVM_EXPRESS_COMMAND *NvmeCmd; + // + // The raw NVM Express completion queue + // + EFI_NVM_EXPRESS_COMPLETION *NvmeCompletion; +} EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET; +//********************************************************************** +//<AMI_PHDR_START> +// +// +// Description: Sends an NVM Express Command Packet to an NVM Express controller or namespace. +// +// Input: +// IN This A pointer to the EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL instance +// IN NamespaceId A 32 bit namespace ID as defined in the NVMe specification +// to which the NVM Express Command Packet will be sent. +// IN Packet A pointer to the NVM Express Command Packet to send to +// the NVMe namespace specified by NamespaceId. +// IN Event Event to be signalled when the NVM Express Command Packet completes +// and non-blocking I/O is supported +// Output: +// EFI_SUCCESS The NVM Express Command Packet was sent by the host successfully +// EFI_BAD_BUFFER_SIZE The number of bytes that could be transferred is not valid +// EFI_NOT_READY The NVM Express Command Packet could not be sent as the controller +// is not ready +// EFI_DEVICE_ERROR Device error +// EFI_UNSUPPORTED The command described by the NVM Express Command Packet is not +// supported by the host adapter +// EFI_TIMEOUT A timeout occurred while waiting for the NVM Express Command Packet +// to execute +// Modified: +// +// Referrals: +// +// Notes: +//<AMI_PHDR_END> +//********************************************************************** + +typedef +EFI_STATUS +(EFIAPI *EFI_NVM_EXPRESS_PASS_THRU_PASSTHRU) ( + IN EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL *This, + IN UINT32 NamespaceId, + IN OUT EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET *Packet, + IN EFI_EVENT Event + ); + +//********************************************************************** +//<AMI_PHDR_START> +// +// Description:Used to retrieve the next namespace ID for this NVM Express controller. +// +// Input: +// IN This A pointer to the EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL instance +// IN NamespaceId On input, a pointer to a valid namespace ID on this NVM Express controller +// or a pointer to the value 0xFFFFFFFF. A pointer to the value 0xFFFFFFFF retrieves +// the first valid namespace ID on this NVM Express controller. +// Output: +// 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 The Namespace ID was not valid +// +// Modified: +// +// Referrals: +// +// Notes: +// +//<AMI_PHDR_END> +//********************************************************************** + +typedef +EFI_STATUS +(EFIAPI *EFI_NVM_EXPRESS_PASS_THRU_GET_NEXT_NAMESPACE) ( + IN EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL *This, + IN OUT UINT32 *NamespaceId + ); +//********************************************************************** +//<AMI_PHDR_START> +// +// Description:Used to allocate and build a device path node for an NVM Express namespace +// on an NVM Express controller +// +// Input: +// IN This A pointer to the EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL instance +// IN NamespaceId The NVM Express namespace ID for which a device path node is +// to be allocated and built +// IN DevicePath A pointer to a single device path node that describes the +// NVM Express namespace specified by NamespaceId. +// This function is responsible for allocating the buffer DevicePath +// with the boot service AllocatePool(). It is the caller's responsibility +// to free DevicePath when the caller is finished with DevicePath. +// +// Output: +// EFI_SUCCESS The device path node that describes the NVM Express +// namespace specified by NamespaceId was allocated and +// returned in DevicePath +// EFI_NOT_FOUND The NamespaceIdis not valid +// EFI_INVALID_PARAMETER DevicePath is NULL +// EFI_OUT_OF_RESOURCES There are not enough resources to allocate the +// DevicePath node. +// Modified: +// +// Referrals: +// +// Notes: +// +//<AMI_PHDR_END> +//********************************************************************** +typedef +EFI_STATUS +(EFIAPI *EFI_NVM_EXPRESS_PASS_THRU_BUILD_DEVICE_PATH) ( + IN EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL *This, + IN UINT32 NamespaceId, + IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath + ); + +//********************************************************************** +//<AMI_PHDR_START> +// +// Description: Used to translate a device path node to a namespace ID +// +// Input: +// IN This A pointer to the EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL instance +// IN NamespaceId The NVM Express namespace ID contained in the device path node +// IN DevicePath A pointer to the device path node that describes an NVM +// Express namespace on the NVM Express controller. +// Output: +// EFI_SUCCESS Namespace ID is returned in NamespaceID +// +// Modified: +// +// Referrals: +// +// Notes: +// +//<AMI_PHDR_END> +//********************************************************************** + +typedef +EFI_STATUS +(EFIAPI *EFI_NVM_EXPRESS_PASS_THRU_GET_NAMESPACE) ( + IN EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL *This, + IN EFI_DEVICE_PATH_PROTOCOL *DevicePath, + OUT UINT32 *NamespaceId + ); + +struct _EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL { + EFI_NVM_EXPRESS_PASS_THRU_MODE *Mode; + EFI_NVM_EXPRESS_PASS_THRU_PASSTHRU PassThru; + EFI_NVM_EXPRESS_PASS_THRU_GET_NEXT_NAMESPACE GetNextNamespace; + EFI_NVM_EXPRESS_PASS_THRU_BUILD_DEVICE_PATH BuildDevicePath; + EFI_NVM_EXPRESS_PASS_THRU_GET_NAMESPACE GetNameSpace; +}; + +extern EFI_GUID gEfiNvmExpressPassThruProtocolGuid; + +#endif + +//********************************************************************** +//********************************************************************** +//** ** +//** (C)Copyright 1985-2015, American Megatrends, Inc. ** +//** ** +//** All Rights Reserved. ** +//** ** +//** 5555 Oakbrook Parkway, Suite 200, Norcross, GA 30093 ** +//** ** +//** Phone: (770)-246-8600 ** +//** ** +//********************************************************************** +//**********************************************************************
\ No newline at end of file |