#include <Uefi.h>
#include <IndustryStandard/Pci.h>
#include <IndustryStandard/Nvme.h>
#include <Protocol/ComponentName.h>
#include <Protocol/ComponentName2.h>
#include <Protocol/DriverBinding.h>
#include <Protocol/LoadedImage.h>
#include <Protocol/DevicePath.h>
#include <Protocol/PciIo.h>
#include <Protocol/NvmExpressPassthru.h>
#include <Protocol/BlockIo.h>
#include <Protocol/BlockIo2.h>
#include <Protocol/DiskInfo.h>
#include <Protocol/DriverSupportedEfiVersion.h>
#include <Protocol/StorageSecurityCommand.h>
#include <Protocol/ResetNotification.h>
#include <Protocol/MediaSanitize.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <Library/PrintLib.h>
#include <Library/UefiLib.h>
#include <Library/DevicePathLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Library/ReportStatusCodeLib.h>
#include <Guid/NVMeEventGroup.h>
#include "NvmExpressBlockIo.h"
#include "NvmExpressDiskInfo.h"
#include "NvmExpressHci.h"
#include "NvmExpressMediaSanitize.h"

Data Structures
struct	_NVME_CONTROLLER_PRIVATE_DATA

struct	_NVME_DEVICE_PRIVATE_DATA

struct	NVME_BLKIO2_REQUEST

struct	NVME_BLKIO2_SUBTASK

struct	NVME_PASS_THRU_ASYNC_REQ

Macros
#define	PCI_CLASS_MASS_STORAGE_NVM 0x08

#define	PCI_IF_NVMHCI 0x02

#define	NVME_ASQ_SIZE 1

#define	NVME_ACQ_SIZE 1

#define	NVME_CSQ_SIZE 1

#define	NVME_CCQ_SIZE 1

#define	NVME_ASYNC_CSQ_SIZE 63

#define	NVME_ASYNC_CCQ_SIZE 255

#define	NVME_MAX_QUEUES 3

#define	NVME_LBA_FORMATNVM_LBAF_MASK 0xF

#define	NVME_CQE_STATUS_FIELD_MASK 0xFFFF0000

#define	NVME_CQE_STATUS_FIELD_OFFSET 16

#define	NVME_CQE_STATUS_FIELD_SCT_MASK 0x0E00

#define	NVME_CQE_STATUS_FIELD_SCT_OFFSET 0x9

#define	NVME_CQE_STATUS_FIELD_SC_MASK 0x1FE

#define	NVME_CQE_STATUS_FIELD_SC_OFFSET 0x01

#define	NVME_CQE_SCT_GENERIC_CMD_STATUS 0x0

#define	NVME_CQE_SCT_CMD_SPECIFIC_STATUS 0x1

#define	NVME_CQE_SCT_MEDIA_DATA_INTEGRITY_ERRORS_STATUS 0x2

#define	NVME_CQE_SCT_PATH_RELATED_STATUS 0x3

#define	NVME_CQE_SC_SUCCESSFUL_COMPLETION 0x00

#define	NVME_CQE_SC_INVALID_CMD_OPCODE 0x01

#define	NVME_CQE_SC_INVALID_FIELD_IN_CMD 0x02

#define	NVME_ALL_NAMESPACES 0xFFFFFFFF

#define	NVME_CONTROLLER_ID 0

#define	NVME_GENERIC_TIMEOUT EFI_TIMER_PERIOD_SECONDS (5)

#define	NVME_HC_ASYNC_TIMER EFI_TIMER_PERIOD_MILLISECONDS (1)

#define	NVME_CONTROLLER_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('N','V','M','E')

#define	NVME_CONTROLLER_PRIVATE_DATA_FROM_PASS_THRU(a)

#define	NVME_DEVICE_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('X','S','S','D')

#define	NVME_DEVICE_PRIVATE_DATA_FROM_BLOCK_IO(a)

#define	NVME_DEVICE_PRIVATE_DATA_FROM_BLOCK_IO2(a)

#define	NVME_DEVICE_PRIVATE_DATA_FROM_DISK_INFO(a)

#define	NVME_DEVICE_PRIVATE_DATA_FROM_STORAGE_SECURITY(a)

#define	NVME_DEVICE_PRIVATE_DATA_FROM_MEDIA_SANITIZE(a)

#define	NVME_BLKIO2_REQUEST_SIGNATURE SIGNATURE_32 ('N', 'B', '2', 'R')

#define	NVME_BLKIO2_REQUEST_FROM_LINK(a) CR (a, NVME_BLKIO2_REQUEST, Link, NVME_BLKIO2_REQUEST_SIGNATURE)

#define	NVME_BLKIO2_SUBTASK_SIGNATURE SIGNATURE_32 ('N', 'B', '2', 'S')

#define	NVME_BLKIO2_SUBTASK_FROM_LINK(a) CR (a, NVME_BLKIO2_SUBTASK, Link, NVME_BLKIO2_SUBTASK_SIGNATURE)

#define	NVME_PASS_THRU_ASYNC_REQ_SIG SIGNATURE_32 ('N', 'P', 'A', 'R')

#define	NVME_PASS_THRU_ASYNC_REQ_FROM_THIS(a)

Typedefs
typedef struct _NVME_CONTROLLER_PRIVATE_DATA	NVME_CONTROLLER_PRIVATE_DATA

typedef struct _NVME_DEVICE_PRIVATE_DATA	NVME_DEVICE_PRIVATE_DATA

Functions
EFI_STATUS EFIAPI	NvmExpressComponentNameGetDriverName (IN EFI_COMPONENT_NAME_PROTOCOL This, IN CHAR8 Language, OUT CHAR16 **DriverName)

EFI_STATUS EFIAPI	NvmExpressComponentNameGetControllerName (IN EFI_COMPONENT_NAME_PROTOCOL This, IN EFI_HANDLE ControllerHandle, IN EFI_HANDLE ChildHandle OPTIONAL, IN CHAR8 Language, OUT CHAR16 **ControllerName)

EFI_STATUS EFIAPI	NvmExpressDriverBindingSupported (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE Controller, IN EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath)

EFI_STATUS EFIAPI	NvmExpressDriverBindingStart (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE Controller, IN EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath)

EFI_STATUS EFIAPI	NvmExpressDriverBindingStop (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE Controller, IN UINTN NumberOfChildren, IN EFI_HANDLE ChildHandleBuffer)

EFI_STATUS EFIAPI	NvmExpressPassThru (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 OPTIONAL)

EFI_STATUS EFIAPI	NvmExpressGetNextNamespace (IN EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL This, IN OUT UINT32 NamespaceId)

EFI_STATUS EFIAPI	NvmExpressGetNamespace (IN EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL This, IN EFI_DEVICE_PATH_PROTOCOL DevicePath, OUT UINT32 *NamespaceId)

EFI_STATUS EFIAPI	NvmExpressBuildDevicePath (IN EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL This, IN UINT32 NamespaceId, IN OUT EFI_DEVICE_PATH_PROTOCOL *DevicePath)

VOID	NvmeDumpStatus (IN NVME_CQ *Cq)

VOID	NvmeRegisterShutdownNotification (VOID)

VOID	NvmeUnregisterShutdownNotification (VOID)

Variables
EFI_DRIVER_BINDING_PROTOCOL	gNvmExpressDriverBinding

EFI_COMPONENT_NAME_PROTOCOL	gNvmExpressComponentName

EFI_COMPONENT_NAME2_PROTOCOL	gNvmExpressComponentName2

EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL	gNvmExpressDriverSupportedEfiVersion

Detailed Description

NvmExpressDxe driver is used to manage non-volatile memory subsystem which follows NVM Express specification.

(C) Copyright 2016 Hewlett Packard Enterprise Development LP
Copyright (c) 2013 - 2019, Intel Corporation. All rights reserved.
Copyright (c) Microsoft Corporation.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file NvmExpress.h.

Macro Definition Documentation

◆ NVME_ACQ_SIZE

#define NVME_ACQ_SIZE 1

Definition at line 65 of file NvmExpress.h.

◆ NVME_ALL_NAMESPACES

#define NVME_ALL_NAMESPACES 0xFFFFFFFF

Definition at line 105 of file NvmExpress.h.

◆ NVME_ASQ_SIZE

#define NVME_ASQ_SIZE 1

Definition at line 64 of file NvmExpress.h.

◆ NVME_ASYNC_CCQ_SIZE

#define NVME_ASYNC_CCQ_SIZE 255

Definition at line 79 of file NvmExpress.h.

◆ NVME_ASYNC_CSQ_SIZE

#define NVME_ASYNC_CSQ_SIZE 63

Definition at line 74 of file NvmExpress.h.

◆ NVME_BLKIO2_REQUEST_FROM_LINK

#define NVME_BLKIO2_REQUEST_FROM_LINK ( a ) CR (a, NVME_BLKIO2_REQUEST, Link, NVME_BLKIO2_REQUEST_SIGNATURE)

Definition at line 300 of file NvmExpress.h.

◆ NVME_BLKIO2_REQUEST_SIGNATURE

#define NVME_BLKIO2_REQUEST_SIGNATURE SIGNATURE_32 ('N', 'B', '2', 'R')

Definition at line 285 of file NvmExpress.h.

◆ NVME_BLKIO2_SUBTASK_FROM_LINK

#define NVME_BLKIO2_SUBTASK_FROM_LINK ( a ) CR (a, NVME_BLKIO2_SUBTASK, Link, NVME_BLKIO2_SUBTASK_SIGNATURE)

Definition at line 319 of file NvmExpress.h.

◆ NVME_BLKIO2_SUBTASK_SIGNATURE

#define NVME_BLKIO2_SUBTASK_SIGNATURE SIGNATURE_32 ('N', 'B', '2', 'S')

Definition at line 303 of file NvmExpress.h.

◆ NVME_CCQ_SIZE

#define NVME_CCQ_SIZE 1

Definition at line 68 of file NvmExpress.h.

◆ NVME_CONTROLLER_ID

#define NVME_CONTROLLER_ID 0

Definition at line 107 of file NvmExpress.h.

◆ NVME_CONTROLLER_PRIVATE_DATA_FROM_PASS_THRU

#define NVME_CONTROLLER_PRIVATE_DATA_FROM_PASS_THRU ( a )

Value:

  CR (a, \
      NVME_CONTROLLER_PRIVATE_DATA, \
      Passthru, \
      NVME_CONTROLLER_PRIVATE_DATA_SIGNATURE \
      )

Definition at line 197 of file NvmExpress.h.

◆ NVME_CONTROLLER_PRIVATE_DATA_SIGNATURE

#define NVME_CONTROLLER_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('N','V','M','E')

Definition at line 122 of file NvmExpress.h.

◆ NVME_CQE_SC_INVALID_CMD_OPCODE

#define NVME_CQE_SC_INVALID_CMD_OPCODE 0x01

Definition at line 102 of file NvmExpress.h.

◆ NVME_CQE_SC_INVALID_FIELD_IN_CMD

#define NVME_CQE_SC_INVALID_FIELD_IN_CMD 0x02

Definition at line 103 of file NvmExpress.h.

◆ NVME_CQE_SC_SUCCESSFUL_COMPLETION

#define NVME_CQE_SC_SUCCESSFUL_COMPLETION 0x00

Definition at line 101 of file NvmExpress.h.

◆ NVME_CQE_SCT_CMD_SPECIFIC_STATUS

#define NVME_CQE_SCT_CMD_SPECIFIC_STATUS 0x1

Definition at line 98 of file NvmExpress.h.

◆ NVME_CQE_SCT_GENERIC_CMD_STATUS

#define NVME_CQE_SCT_GENERIC_CMD_STATUS 0x0

Definition at line 97 of file NvmExpress.h.

◆ NVME_CQE_SCT_MEDIA_DATA_INTEGRITY_ERRORS_STATUS

#define NVME_CQE_SCT_MEDIA_DATA_INTEGRITY_ERRORS_STATUS 0x2

Definition at line 99 of file NvmExpress.h.

◆ NVME_CQE_SCT_PATH_RELATED_STATUS

#define NVME_CQE_SCT_PATH_RELATED_STATUS 0x3

Definition at line 100 of file NvmExpress.h.

◆ NVME_CQE_STATUS_FIELD_MASK

#define NVME_CQE_STATUS_FIELD_MASK 0xFFFF0000

Definition at line 91 of file NvmExpress.h.

◆ NVME_CQE_STATUS_FIELD_OFFSET

#define NVME_CQE_STATUS_FIELD_OFFSET 16

Definition at line 92 of file NvmExpress.h.

◆ NVME_CQE_STATUS_FIELD_SC_MASK

#define NVME_CQE_STATUS_FIELD_SC_MASK 0x1FE

Definition at line 95 of file NvmExpress.h.

◆ NVME_CQE_STATUS_FIELD_SC_OFFSET

#define NVME_CQE_STATUS_FIELD_SC_OFFSET 0x01

Definition at line 96 of file NvmExpress.h.

◆ NVME_CQE_STATUS_FIELD_SCT_MASK

#define NVME_CQE_STATUS_FIELD_SCT_MASK 0x0E00

Definition at line 93 of file NvmExpress.h.

◆ NVME_CQE_STATUS_FIELD_SCT_OFFSET

#define NVME_CQE_STATUS_FIELD_SCT_OFFSET 0x9

Definition at line 94 of file NvmExpress.h.

◆ NVME_CSQ_SIZE

#define NVME_CSQ_SIZE 1

Definition at line 67 of file NvmExpress.h.

◆ NVME_DEVICE_PRIVATE_DATA_FROM_BLOCK_IO

#define NVME_DEVICE_PRIVATE_DATA_FROM_BLOCK_IO ( a )

Value:

  CR (a, \
      NVME_DEVICE_PRIVATE_DATA, \
      BlockIo, \
      NVME_DEVICE_PRIVATE_DATA_SIGNATURE \
      )

Definition at line 247 of file NvmExpress.h.

◆ NVME_DEVICE_PRIVATE_DATA_FROM_BLOCK_IO2

#define NVME_DEVICE_PRIVATE_DATA_FROM_BLOCK_IO2 ( a )

Value:

  CR (a, \
      NVME_DEVICE_PRIVATE_DATA, \
      BlockIo2, \
      NVME_DEVICE_PRIVATE_DATA_SIGNATURE \
      )

Definition at line 254 of file NvmExpress.h.

◆ NVME_DEVICE_PRIVATE_DATA_FROM_DISK_INFO

#define NVME_DEVICE_PRIVATE_DATA_FROM_DISK_INFO ( a )

Value:

  CR (a, \
      NVME_DEVICE_PRIVATE_DATA, \
      DiskInfo, \
      NVME_DEVICE_PRIVATE_DATA_SIGNATURE \
      )

Definition at line 261 of file NvmExpress.h.

◆ NVME_DEVICE_PRIVATE_DATA_FROM_MEDIA_SANITIZE

#define NVME_DEVICE_PRIVATE_DATA_FROM_MEDIA_SANITIZE ( a )

Value:

  CR (a,                                                \
      NVME_DEVICE_PRIVATE_DATA,                         \
      MediaSanitize,                                    \
      NVME_DEVICE_PRIVATE_DATA_SIGNATURE                \
      )

Definition at line 275 of file NvmExpress.h.

◆ NVME_DEVICE_PRIVATE_DATA_FROM_STORAGE_SECURITY

#define NVME_DEVICE_PRIVATE_DATA_FROM_STORAGE_SECURITY ( a )

Value:

  CR (a,                                                 \
      NVME_DEVICE_PRIVATE_DATA,                          \
      StorageSecurity,                                   \
      NVME_DEVICE_PRIVATE_DATA_SIGNATURE                 \
      )

Definition at line 268 of file NvmExpress.h.

◆ NVME_DEVICE_PRIVATE_DATA_SIGNATURE

#define NVME_DEVICE_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('X','S','S','D')

Definition at line 207 of file NvmExpress.h.

◆ NVME_GENERIC_TIMEOUT

#define NVME_GENERIC_TIMEOUT EFI_TIMER_PERIOD_SECONDS (5)

Definition at line 112 of file NvmExpress.h.

◆ NVME_HC_ASYNC_TIMER

#define NVME_HC_ASYNC_TIMER EFI_TIMER_PERIOD_MILLISECONDS (1)

Definition at line 117 of file NvmExpress.h.

◆ NVME_LBA_FORMATNVM_LBAF_MASK

#define NVME_LBA_FORMATNVM_LBAF_MASK 0xF

Definition at line 86 of file NvmExpress.h.

◆ NVME_MAX_QUEUES

#define NVME_MAX_QUEUES 3

Definition at line 81 of file NvmExpress.h.

◆ NVME_PASS_THRU_ASYNC_REQ_FROM_THIS

#define NVME_PASS_THRU_ASYNC_REQ_FROM_THIS ( a )

Value:

  CR (a,                                                 \
      NVME_PASS_THRU_ASYNC_REQ,                          \
      Link,                                              \
      NVME_PASS_THRU_ASYNC_REQ_SIG                       \
      )

Definition at line 341 of file NvmExpress.h.

◆ NVME_PASS_THRU_ASYNC_REQ_SIG

#define NVME_PASS_THRU_ASYNC_REQ_SIG SIGNATURE_32 ('N', 'P', 'A', 'R')

Definition at line 325 of file NvmExpress.h.

◆ PCI_CLASS_MASS_STORAGE_NVM

#define PCI_CLASS_MASS_STORAGE_NVM 0x08

Definition at line 61 of file NvmExpress.h.

◆ PCI_IF_NVMHCI

#define PCI_IF_NVMHCI 0x02

Definition at line 62 of file NvmExpress.h.

Typedef Documentation

◆ NVME_CONTROLLER_PRIVATE_DATA

typedef struct _NVME_CONTROLLER_PRIVATE_DATA NVME_CONTROLLER_PRIVATE_DATA

Definition at line 48 of file NvmExpress.h.

◆ NVME_DEVICE_PRIVATE_DATA

typedef struct _NVME_DEVICE_PRIVATE_DATA NVME_DEVICE_PRIVATE_DATA

Definition at line 49 of file NvmExpress.h.

Function Documentation

◆ NvmeDumpStatus()

VOID NvmeDumpStatus ( IN NVME_CQ * Cq )

Dump the execution status from a given completion queue entry.

Parameters

[in] Cq A pointer to the NVME_CQ item.

Definition at line 20 of file NvmExpressPassthru.c.

◆ NvmeRegisterShutdownNotification()

VOID NvmeRegisterShutdownNotification ( VOID )

Register the shutdown notification through the ResetNotification protocol.

Register the shutdown notification when mNvmeControllerNumber increased from 0 to 1.

Definition at line 1070 of file NvmExpressHci.c.

◆ NvmeUnregisterShutdownNotification()

VOID NvmeUnregisterShutdownNotification ( VOID )

Unregister the shutdown notification through the ResetNotification protocol.

Unregister the shutdown notification when mNvmeControllerNumber decreased from 1 to 0.

Definition at line 1095 of file NvmExpressHci.c.

◆ NvmExpressBuildDevicePath()

EFI_STATUS EFIAPI NvmExpressBuildDevicePath	(	IN EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL *	This,
		IN UINT32	NamespaceId,
		IN OUT EFI_DEVICE_PATH_PROTOCOL **	DevicePath
	)

Used to allocate and build a device path node for an NVM Express namespace on an NVM Express controller.

The EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL.BuildDevicePath() function allocates and builds a single device path node for the NVM Express namespace specified by NamespaceId.

If the NamespaceId is not valid, then EFI_NOT_FOUND is returned.

If DevicePath is NULL, then EFI_INVALID_PARAMETER is returned.

If there are not enough resources to allocate the device path node, then EFI_OUT_OF_RESOURCES is returned.

Otherwise, DevicePath is allocated with the boot service AllocatePool(), the contents of DevicePath are initialized to describe the NVM Express namespace specified by NamespaceId, and EFI_SUCCESS is returned.

Parameters

[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. Caller must set the NamespaceId to zero if the device path node will contain a valid UUID.
[in,out]	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.

Return values

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 NamespaceId is not valid.
EFI_INVALID_PARAMETER	DevicePath is NULL.
EFI_OUT_OF_RESOURCES	There are not enough resources to allocate the DevicePath node.

Definition at line 1139 of file NvmExpressPassthru.c.

◆ NvmExpressComponentNameGetControllerName()

EFI_STATUS EFIAPI NvmExpressComponentNameGetControllerName	(	IN EFI_COMPONENT_NAME_PROTOCOL *	This,
		IN EFI_HANDLE	ControllerHandle,
		IN EFI_HANDLE ChildHandle	OPTIONAL,
		IN CHAR8 *	Language,
		OUT CHAR16 **	ControllerName
	)

Retrieves a Unicode string that is the user readable name of the controller that is being managed by a driver.

This function retrieves the user readable name of the controller specified by ControllerHandle and ChildHandle in the form of a Unicode string. If the driver specified by This has a user readable name in the language specified by Language, then a pointer to the controller name is returned in ControllerName, and EFI_SUCCESS is returned. If the driver specified by This is not currently managing the controller specified by ControllerHandle and ChildHandle, then EFI_UNSUPPORTED is returned. If the driver specified by This does not support the language specified by Language, then EFI_UNSUPPORTED is returned.

Parameters

This[in]	A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or EFI_COMPONENT_NAME_PROTOCOL instance.
ControllerHandle[in]	The handle of a controller that the driver specified by This is managing. This handle specifies the controller whose name is to be returned.
ChildHandle[in]	The handle of the child controller to retrieve the name of. This is an optional parameter that may be NULL. It will be NULL for device drivers. It will also be NULL for a bus drivers that wish to retrieve the name of the bus controller. It will not be NULL for a bus driver that wishes to retrieve the name of a child controller.
Language[in]	A pointer to a Null-terminated ASCII string array indicating the language. This is the language of the driver name that the caller is requesting, and it must match one of the languages specified in SupportedLanguages. The number of languages supported by a driver is up to the driver writer. Language is specified in RFC 4646 or ISO 639-2 language code format.
ControllerName[out]	A pointer to the Unicode string to return. This Unicode string is the name of the controller specified by ControllerHandle and ChildHandle in the language specified by Language from the point of view of the driver specified by This.

Return values

EFI_SUCCESS	The Unicode string for the user readable name in the language specified by Language for the driver specified by This was returned in DriverName.
EFI_INVALID_PARAMETER	ControllerHandle is NULL.
EFI_INVALID_PARAMETER	ChildHandle is not NULL and it is not a valid EFI_HANDLE.
EFI_INVALID_PARAMETER	Language is NULL.
EFI_INVALID_PARAMETER	ControllerName is NULL.
EFI_UNSUPPORTED	The driver specified by This is not currently managing the controller specified by ControllerHandle and ChildHandle.
EFI_UNSUPPORTED	The driver specified by This does not support the language specified by Language.

Definition at line 166 of file ComponentName.c.

◆ NvmExpressComponentNameGetDriverName()

EFI_STATUS EFIAPI NvmExpressComponentNameGetDriverName	(	IN EFI_COMPONENT_NAME_PROTOCOL *	This,
		IN CHAR8 *	Language,
		OUT CHAR16 **	DriverName
	)

Retrieves a Unicode string that is the user readable name of the driver.

This function retrieves the user readable name of a driver in the form of a Unicode string. If the driver specified by This has a user readable name in the language specified by Language, then a pointer to the driver name is returned in DriverName, and EFI_SUCCESS is returned. If the driver specified by This does not support the language specified by Language, then EFI_UNSUPPORTED is returned.

Parameters

This[in]	A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or EFI_COMPONENT_NAME_PROTOCOL instance.
Language[in]	A pointer to a Null-terminated ASCII string array indicating the language. This is the language of the driver name that the caller is requesting, and it must match one of the languages specified in SupportedLanguages. The number of languages supported by a driver is up to the driver writer. Language is specified in RFC 4646 or ISO 639-2 language code format.
DriverName[out]	A pointer to the Unicode string to return. This Unicode string is the name of the driver specified by This in the language specified by Language.

Return values

EFI_SUCCESS	The Unicode string for the Driver specified by This and the language specified by Language was returned in DriverName.
EFI_INVALID_PARAMETER	Language is NULL.
EFI_INVALID_PARAMETER	DriverName is NULL.
EFI_UNSUPPORTED	The driver specified by This does not support the language specified by Language.

Definition at line 81 of file ComponentName.c.

◆ NvmExpressDriverBindingStart()

EFI_STATUS EFIAPI NvmExpressDriverBindingStart	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN EFI_DEVICE_PATH_PROTOCOL *	RemainingDevicePath
	)

Starts a device controller or a bus controller.

The Start() function is designed to be invoked from the EFI boot service ConnectController(). As a result, much of the error checking on the parameters to Start() has been moved into this common boot service. It is legal to call Start() from other locations, but the following calling restrictions must be followed or the system behavior will not be deterministic.

ControllerHandle must be a valid EFI_HANDLE.
If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned EFI_DEVICE_PATH_PROTOCOL.
Prior to calling Start(), the Supported() function for the driver specified by This must have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.

Parameters

[in]	This	A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
[in]	ControllerHandle	The handle of the controller to start. This handle must support a protocol interface that supplies an I/O abstraction to the driver.
[in]	RemainingDevicePath	A pointer to the remaining portion of a device path. This parameter is ignored by device drivers, and is optional for bus drivers. For a bus driver, if this parameter is NULL, then handles for all the children of Controller are created by this driver. If this parameter is not NULL and the first Device Path Node is not the End of Device Path Node, then only the handle for the child device specified by the first Device Path Node of RemainingDevicePath is created by this driver. If the first Device Path Node of RemainingDevicePath is the End of Device Path Node, no child handle is created by this driver.

Return values

EFI_SUCCESS	The device was started.
EFI_DEVICE_ERROR	The device could not be started due to a device error.Currently not implemented.
EFI_OUT_OF_RESOURCES	The request could not be completed due to a lack of resources.
Others	The driver failded to start the device.

Definition at line 946 of file NvmExpress.c.

◆ NvmExpressDriverBindingStop()

EFI_STATUS EFIAPI NvmExpressDriverBindingStop	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN UINTN	NumberOfChildren,
		IN EFI_HANDLE *	ChildHandleBuffer
	)

Stops a device controller or a bus controller.

The Stop() function is designed to be invoked from the EFI boot service DisconnectController(). As a result, much of the error checking on the parameters to Stop() has been moved into this common boot service. It is legal to call Stop() from other locations, but the following calling restrictions must be followed or the system behavior will not be deterministic.

ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this same driver's Start() function.
The first NumberOfChildren handles of ChildHandleBuffer must all be a valid EFI_HANDLE. In addition, all of these handles must have been created in this driver's Start() function, and the Start() function must have called OpenProtocol() on ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.

Parameters

[in]	This	A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
[in]	ControllerHandle	A handle to the device being stopped. The handle must support a bus specific I/O protocol for the driver to use to stop the device.
[in]	NumberOfChildren	The number of child device handles in ChildHandleBuffer.
[in]	ChildHandleBuffer	An array of child handles to be freed. May be NULL if NumberOfChildren is 0.

Return values

EFI_SUCCESS	The device was stopped.
EFI_DEVICE_ERROR	The device could not be stopped due to a device error.

Definition at line 1236 of file NvmExpress.c.

◆ NvmExpressDriverBindingSupported()

EFI_STATUS EFIAPI NvmExpressDriverBindingSupported	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN EFI_DEVICE_PATH_PROTOCOL *	RemainingDevicePath
	)

Tests to see if this driver supports a given controller. If a child device is provided, it further tests to see if this driver supports creating a handle for the specified child device.

This function checks to see if the driver specified by This supports the device specified by ControllerHandle. Drivers will typically use the device path attached to ControllerHandle and/or the services from the bus I/O abstraction attached to ControllerHandle to determine if the driver supports ControllerHandle. This function may be called many times during platform initialization. In order to reduce boot times, the tests performed by this function must be very small, and take as little time as possible to execute. This function must not change the state of any hardware devices, and this function must be aware that the device specified by ControllerHandle may already be managed by the same driver or a different driver. This function must match its calls to AllocatePages() with FreePages(), AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol(). Since ControllerHandle may have been previously started by the same driver, if a protocol is already in the opened state, then it must not be closed with CloseProtocol(). This is required to guarantee the state of ControllerHandle is not modified by this function.

Parameters

[in]	This	A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
[in]	ControllerHandle	The handle of the controller to test. This handle must support a protocol interface that supplies an I/O abstraction to the driver.
[in]	RemainingDevicePath	A pointer to the remaining portion of a device path. This parameter is ignored by device drivers, and is optional for bus drivers. For bus drivers, if this parameter is not NULL, then the bus driver must determine if the bus controller specified by ControllerHandle and the child controller specified by RemainingDevicePath are both supported by this bus driver.

Return values

EFI_SUCCESS	The device specified by ControllerHandle and RemainingDevicePath is supported by the driver specified by This.
EFI_ALREADY_STARTED	The device specified by ControllerHandle and RemainingDevicePath is already being managed by the driver specified by This.
EFI_ACCESS_DENIED	The device specified by ControllerHandle and RemainingDevicePath is already being managed by a different driver or an application that requires exclusive access. Currently not implemented.
EFI_UNSUPPORTED	The device specified by ControllerHandle and RemainingDevicePath is not supported by the driver specified by This.

Definition at line 792 of file NvmExpress.c.

◆ NvmExpressGetNamespace()

EFI_STATUS EFIAPI NvmExpressGetNamespace	(	IN EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL *	This,
		IN EFI_DEVICE_PATH_PROTOCOL *	DevicePath,
		OUT UINT32 *	NamespaceId
	)

Used to translate a device path node to a namespace ID.

The EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL.GetNamespace() function determines the namespace ID associated with the namespace described by DevicePath.

If DevicePath is a device path node type that the NVM Express Pass Thru driver supports, then the NVM Express Pass Thru driver will attempt to translate the contents DevicePath into a namespace ID.

If this translation is successful, then that namespace ID is returned in NamespaceId, and EFI_SUCCESS is returned

Parameters

[in]	This	A pointer to the EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL instance.
[in]	DevicePath	A pointer to the device path node that describes an NVM Express namespace on the NVM Express controller.
[out]	NamespaceId	The NVM Express namespace ID contained in the device path node.

Return values

EFI_SUCCESS	DevicePath was successfully translated to NamespaceId.
EFI_INVALID_PARAMETER	If DevicePath or NamespaceId are NULL, then EFI_INVALID_PARAMETER is returned.
EFI_UNSUPPORTED	If DevicePath is not a device path node type that the NVM Express Pass Thru driver supports, then EFI_UNSUPPORTED is returned.
EFI_NOT_FOUND	If DevicePath is a device path node type that the NVM Express Pass Thru driver supports, but there is not a valid translation from DevicePath to a namespace ID, then EFI_NOT_FOUND is returned.

Definition at line 1064 of file NvmExpressPassthru.c.

◆ NvmExpressGetNextNamespace()

EFI_STATUS EFIAPI NvmExpressGetNextNamespace	(	IN EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL *	This,
		IN OUT UINT32 *	NamespaceId
	)

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

The EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL.GetNextNamespace() function retrieves the next valid namespace ID on 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	A pointer to the EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL instance.
[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.

Definition at line 963 of file NvmExpressPassthru.c.

◆ NvmExpressPassThru()

EFI_STATUS EFIAPI NvmExpressPassThru	(	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	OPTIONAL
	)

Sends an NVM Express Command Packet to an NVM Express controller or namespace. This function supports both blocking I/O and nonblocking I/O. The blocking I/O functionality is required, and the nonblocking I/O functionality is optional.

Parameters

[in]	This	A pointer to the EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL instance.
[in]	NamespaceId	Is a 32 bit Namespace ID to which the Express HCI 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 NVM Express HCI Command Packet to send to the NVMe namespace specified by NamespaceId.
[in]	Event	If nonblocking I/O is not supported then Event is ignored, and blocking I/O is performed. If Event is NULL, then blocking I/O is performed. If Event is not NULL and non blocking I/O is supported, then nonblocking I/O is performed, and Event will be signaled when the NVM Express Command Packet completes.

Return values

EFI_SUCCESS	The NVM Express Command Packet was sent by the host. TransferLength bytes were transferred to, or from DataBuffer.
EFI_BAD_BUFFER_SIZE	The NVM Express Command Packet was not executed. The number of bytes that could be transferred is returned in TransferLength.
EFI_NOT_READY	The 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 NVM Express Command Packet.
EFI_INVALID_PARAMETER	Namespace, or the contents of EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET are invalid. The NVM Express Command Packet was not sent, so no additional status information is available.
EFI_UNSUPPORTED	The command described by the NVM Express Command Packet is not supported by the host adapter. The NVM Express Command Packet was not sent, so no additional status information is available.
EFI_TIMEOUT	A timeout occurred while waiting for the NVM Express Command Packet to execute.

Sends an NVM Express Command Packet to an NVM Express controller or namespace. This function supports both blocking I/O and non-blocking I/O. The blocking I/O functionality is required, and the non-blocking I/O functionality is optional.

Parameters

[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. A value of 0 denotes the NVM Express controller, a value of all 0xFF's (all bytes are 0xFF) in the namespace ID specifies that the command packet should be sent to all valid namespaces.
[in,out]	Packet	A pointer to the NVM Express Command Packet.
[in]	Event	If non-blocking I/O is not supported then Event is ignored, and blocking I/O is performed. If Event is NULL, then blocking I/O is performed. If Event is not NULL and non-blocking I/O is supported, then non-blocking I/O is performed, and Event will be signaled when the NVM Express Command Packet completes.

Return values

EFI_SUCCESS	The NVM Express Command Packet was sent by the host. TransferLength bytes were transferred to, or from DataBuffer.
EFI_BAD_BUFFER_SIZE	The NVM Express Command Packet was not executed. The number of bytes that could be transferred is returned in TransferLength.
EFI_NOT_READY	The 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 NVM Express Command Packet.
EFI_INVALID_PARAMETER	NamespaceId or the contents of EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET are invalid. The NVM Express Command Packet was not sent, so no additional status information is available.
EFI_UNSUPPORTED	The command described by the NVM Express Command Packet is not supported by the NVM Express controller. The NVM Express Command Packet was not sent so no additional status information is available.
EFI_TIMEOUT	A timeout occurred while waiting for the NVM Express Command Packet to execute.

Definition at line 451 of file NvmExpressPassthru.c.

Variable Documentation

◆ gNvmExpressComponentName

EFI_COMPONENT_NAME_PROTOCOL gNvmExpressComponentName

extern

Definition at line 15 of file ComponentName.c.

◆ gNvmExpressComponentName2

EFI_COMPONENT_NAME2_PROTOCOL gNvmExpressComponentName2

extern

Definition at line 24 of file ComponentName.c.

◆ gNvmExpressDriverBinding

EFI_DRIVER_BINDING_PROTOCOL gNvmExpressDriverBinding

extern

Definition at line 16 of file NvmExpress.c.

◆ gNvmExpressDriverSupportedEfiVersion

EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL gNvmExpressDriverSupportedEfiVersion

extern

Definition at line 28 of file NvmExpress.c.

Data Structures

Macros

Typedefs

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ NVME_ACQ_SIZE

◆ NVME_ALL_NAMESPACES

◆ NVME_ASQ_SIZE

◆ NVME_ASYNC_CCQ_SIZE

◆ NVME_ASYNC_CSQ_SIZE

◆ NVME_BLKIO2_REQUEST_FROM_LINK

◆ NVME_BLKIO2_REQUEST_SIGNATURE

◆ NVME_BLKIO2_SUBTASK_FROM_LINK

◆ NVME_BLKIO2_SUBTASK_SIGNATURE

◆ NVME_CCQ_SIZE

◆ NVME_CONTROLLER_ID

◆ NVME_CONTROLLER_PRIVATE_DATA_FROM_PASS_THRU

◆ NVME_CONTROLLER_PRIVATE_DATA_SIGNATURE

◆ NVME_CQE_SC_INVALID_CMD_OPCODE

◆ NVME_CQE_SC_INVALID_FIELD_IN_CMD

◆ NVME_CQE_SC_SUCCESSFUL_COMPLETION

◆ NVME_CQE_SCT_CMD_SPECIFIC_STATUS

◆ NVME_CQE_SCT_GENERIC_CMD_STATUS

◆ NVME_CQE_SCT_MEDIA_DATA_INTEGRITY_ERRORS_STATUS

◆ NVME_CQE_SCT_PATH_RELATED_STATUS

◆ NVME_CQE_STATUS_FIELD_MASK

◆ NVME_CQE_STATUS_FIELD_OFFSET

◆ NVME_CQE_STATUS_FIELD_SC_MASK

◆ NVME_CQE_STATUS_FIELD_SC_OFFSET

◆ NVME_CQE_STATUS_FIELD_SCT_MASK

◆ NVME_CQE_STATUS_FIELD_SCT_OFFSET

◆ NVME_CSQ_SIZE

◆ NVME_DEVICE_PRIVATE_DATA_FROM_BLOCK_IO

◆ NVME_DEVICE_PRIVATE_DATA_FROM_BLOCK_IO2

◆ NVME_DEVICE_PRIVATE_DATA_FROM_DISK_INFO

◆ NVME_DEVICE_PRIVATE_DATA_FROM_MEDIA_SANITIZE

◆ NVME_DEVICE_PRIVATE_DATA_FROM_STORAGE_SECURITY

◆ NVME_DEVICE_PRIVATE_DATA_SIGNATURE

◆ NVME_GENERIC_TIMEOUT

◆ NVME_HC_ASYNC_TIMER

◆ NVME_LBA_FORMATNVM_LBAF_MASK

◆ NVME_MAX_QUEUES

◆ NVME_PASS_THRU_ASYNC_REQ_FROM_THIS

◆ NVME_PASS_THRU_ASYNC_REQ_SIG

◆ PCI_CLASS_MASS_STORAGE_NVM

◆ PCI_IF_NVMHCI

Typedef Documentation

◆ NVME_CONTROLLER_PRIVATE_DATA

◆ NVME_DEVICE_PRIVATE_DATA

Function Documentation

◆ NvmeDumpStatus()

◆ NvmeRegisterShutdownNotification()

◆ NvmeUnregisterShutdownNotification()

◆ NvmExpressBuildDevicePath()

◆ NvmExpressComponentNameGetControllerName()

◆ NvmExpressComponentNameGetDriverName()

◆ NvmExpressDriverBindingStart()

◆ NvmExpressDriverBindingStop()

◆ NvmExpressDriverBindingSupported()

◆ NvmExpressGetNamespace()

◆ NvmExpressGetNextNamespace()

◆ NvmExpressPassThru()

Variable Documentation

◆ gNvmExpressComponentName

◆ gNvmExpressComponentName2

◆ gNvmExpressDriverBinding

◆ gNvmExpressDriverSupportedEfiVersion