NvmExpressHci.h File Reference

Go to the source code of this file.

Macros
#define	NVME_BAR   0
#define	NVME_ASQ_BUF_OFFSET   EFI_PAGE_SIZE

Functions
EFI_STATUS	NvmeControllerInit (IN NVME_CONTROLLER_PRIVATE_DATA *Private)
EFI_STATUS	NvmeIdentifyController (IN NVME_CONTROLLER_PRIVATE_DATA *Private, IN VOID *Buffer)
EFI_STATUS	NvmeIdentifyNamespace (IN NVME_CONTROLLER_PRIVATE_DATA *Private, IN UINT32 NamespaceId, IN VOID *Buffer)

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 - 2015, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file NvmExpressHci.h.

Macro Definition Documentation

NVME_ASQ_BUF_OFFSET

#define NVME_ASQ_BUF_OFFSET   EFI_PAGE_SIZE

Definition at line 19 of file NvmExpressHci.h.

NVME_BAR

#define NVME_BAR   0

Definition at line 14 of file NvmExpressHci.h.

Function Documentation

NvmeControllerInit()

EFI_STATUS NvmeControllerInit

(

IN NVME_CONTROLLER_PRIVATE_DATA *

Private

)

Initialize the Nvm Express controller.

Parameters

[in]

Private

The pointer to the NVME_CONTROLLER_PRIVATE_DATA data structure.

Return values

EFI_SUCCESS	The NVM Express Controller is initialized successfully.
Others	A device error occurred while initializing the controller.

Definition at line 723 of file NvmExpressHci.c.

NvmeIdentifyController()

EFI_STATUS NvmeIdentifyController	(	IN NVME_CONTROLLER_PRIVATE_DATA *	Private,
		IN VOID *	Buffer
	)

Get identify controller data.

Parameters

Private	The pointer to the NVME_CONTROLLER_PRIVATE_DATA data structure.
Buffer	The buffer used to store the identify controller data.

Returns

EFI_SUCCESS Successfully get the identify controller data.

EFI_DEVICE_ERROR Fail to get the identify controller data.

Definition at line 472 of file NvmExpressHci.c.

NvmeIdentifyNamespace()

EFI_STATUS NvmeIdentifyNamespace	(	IN NVME_CONTROLLER_PRIVATE_DATA *	Private,
		IN UINT32	NamespaceId,
		IN VOID *	Buffer
	)

Get specified identify namespace data.

Parameters

Private	The pointer to the NVME_CONTROLLER_PRIVATE_DATA data structure.
NamespaceId	The specified namespace identifier.
Buffer	The buffer used to store the identify namespace data.

Returns

EFI_SUCCESS Successfully get the identify namespace data.

EFI_DEVICE_ERROR Fail to get the identify namespace data.

Helper function to simulate read.

Parameters

[in]	Private	Private Data.
[in]	NamespaceId	Name Space Id.
[in]	Buffer	Transfer Buffer.

Definition at line 527 of file NvmExpressHci.c.