#include "NvmExpress.h"

Functions
EFI_STATUS	EnumerateNvmeDevNamespace (IN NVME_CONTROLLER_PRIVATE_DATA *Private, UINT32 NamespaceId)

EFI_STATUS	DiscoverAllNamespaces (IN NVME_CONTROLLER_PRIVATE_DATA *Private)

EFI_STATUS	UnregisterNvmeNamespace (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE Controller, IN EFI_HANDLE Handle)

VOID EFIAPI	ProcessAsyncTaskList (IN EFI_EVENT Event, IN VOID *Context)

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	NvmExpressUnload (IN EFI_HANDLE ImageHandle)

EFI_STATUS EFIAPI	NvmExpressDriverEntry (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Variables
EFI_DRIVER_BINDING_PROTOCOL	gNvmExpressDriverBinding

EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL	gNvmExpressDriverSupportedEfiVersion

GLOBAL_REMOVE_IF_UNREFERENCED EFI_NVM_EXPRESS_PASS_THRU_MODE	gEfiNvmExpressPassThruMode

Detailed Description

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

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

Definition in file NvmExpress.c.

Function Documentation

◆ DiscoverAllNamespaces()

EFI_STATUS DiscoverAllNamespaces ( IN NVME_CONTROLLER_PRIVATE_DATA * Private )

Discover all Nvm Express device namespaces, and create child handles for them with BlockIo and DiskInfo protocol instances.

Parameters

[in] Private The pointer to the NVME_CONTROLLER_PRIVATE_DATA data structure.

Return values

EFI_SUCCESS All the namespaces in the device are successfully enumerated.

Returns: Others Some error occurs when enumerating the namespaces.

Definition at line 378 of file NvmExpress.c.

◆ EnumerateNvmeDevNamespace()

EFI_STATUS EnumerateNvmeDevNamespace	(	IN NVME_CONTROLLER_PRIVATE_DATA *	Private,
		UINT32	NamespaceId
	)

Check if the specified Nvm Express device namespace is active, and create child handles for them with BlockIo and DiskInfo protocol instances.

Parameters

[in]	Private	The pointer to the NVME_CONTROLLER_PRIVATE_DATA data structure.
[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.

Return values

EFI_SUCCESS All the namespaces in the device are successfully enumerated.

Returns: Others Some error occurs when enumerating the namespaces.

Definition at line 59 of file NvmExpress.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.

◆ NvmExpressDriverEntry()

EFI_STATUS EFIAPI NvmExpressDriverEntry	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

The entry point for Nvm Express driver, used to install Nvm Express driver on the ImageHandle.

Parameters

ImageHandle	The firmware allocated handle for this driver image.
SystemTable	Pointer to the EFI system table.

Return values

EFI_SUCCESS	Driver loaded.
other	Driver not loaded.

Definition at line 1470 of file NvmExpress.c.

◆ NvmExpressUnload()

EFI_STATUS EFIAPI NvmExpressUnload ( IN EFI_HANDLE ImageHandle )

This is the unload handle for the NVM Express driver.

Disconnect the driver specified by ImageHandle from the NVMe device in the handle database. Uninstall all the protocols installed in the driver.

Parameters

[in] ImageHandle The drivers' driver image.

Return values

EFI_SUCCESS	The image is unloaded.
Others	Failed to unload the image.

Definition at line 1351 of file NvmExpress.c.

◆ ProcessAsyncTaskList()

VOID EFIAPI ProcessAsyncTaskList	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Call back function when the timer event is signaled.

Parameters

[in]	Event	The Event this notify function registered to.
[in]	Context	Pointer to the context data registered to the Event.

Definition at line 567 of file NvmExpress.c.

◆ UnregisterNvmeNamespace()

EFI_STATUS UnregisterNvmeNamespace	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN EFI_HANDLE	Handle
	)

Unregisters a Nvm Express device namespace.

This function removes the protocols installed on the controller handle and frees the resources allocated for the namespace.

Parameters

This	The pointer to EFI_DRIVER_BINDING_PROTOCOL instance.
Controller	The controller handle of the namespace.
Handle	The child handle.

Return values

EFI_SUCCESS The namespace is successfully unregistered.

Returns: Others Some error occurs when unregistering the namespace.

Definition at line 427 of file NvmExpress.c.

Variable Documentation

◆ gEfiNvmExpressPassThruMode

GLOBAL_REMOVE_IF_UNREFERENCED EFI_NVM_EXPRESS_PASS_THRU_MODE gEfiNvmExpressPassThruMode

Initial value:

= {
  EFI_NVM_EXPRESS_PASS_THRU_ATTRIBUTES_PHYSICAL   |
  EFI_NVM_EXPRESS_PASS_THRU_ATTRIBUTES_LOGICAL    |
  EFI_NVM_EXPRESS_PASS_THRU_ATTRIBUTES_NONBLOCKIO |
  EFI_NVM_EXPRESS_PASS_THRU_ATTRIBUTES_CMD_SET_NVM,
  sizeof (UINTN),
  0x10100
}

Definition at line 36 of file NvmExpress.c.

◆ gNvmExpressDriverBinding

EFI_DRIVER_BINDING_PROTOCOL gNvmExpressDriverBinding

Initial value:

= {
  NvmExpressDriverBindingSupported,
  NvmExpressDriverBindingStart,
  NvmExpressDriverBindingStop,
  0x10,
  NULL,
  NULL
}

Definition at line 16 of file NvmExpress.c.

◆ gNvmExpressDriverSupportedEfiVersion

EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL gNvmExpressDriverSupportedEfiVersion

Initial value:

= {
  sizeof (EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL), 
  0                                                   
}

Definition at line 28 of file NvmExpress.c.

Functions

Variables

Detailed Description

Function Documentation

◆ DiscoverAllNamespaces()

◆ EnumerateNvmeDevNamespace()

◆ NvmExpressDriverBindingStart()

◆ NvmExpressDriverBindingStop()

◆ NvmExpressDriverBindingSupported()

◆ NvmExpressDriverEntry()

◆ NvmExpressUnload()

◆ ProcessAsyncTaskList()

◆ UnregisterNvmeNamespace()

Variable Documentation

◆ gEfiNvmExpressPassThruMode

◆ gNvmExpressDriverBinding

◆ gNvmExpressDriverSupportedEfiVersion