mirror of https://github.com/acidanthera/audk.git
564 lines
18 KiB
C
564 lines
18 KiB
C
/** @file
|
|
NvmExpressDxe driver is used to manage non-volatile memory subsystem which follows
|
|
NVM Express specification.
|
|
|
|
Copyright (c) 2013, Intel Corporation. All rights reserved.<BR>
|
|
This program and the accompanying materials
|
|
are licensed and made available under the terms and conditions of the BSD License
|
|
which accompanies this distribution. The full text of the license may be found at
|
|
http://opensource.org/licenses/bsd-license.php.
|
|
|
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|
|
|
**/
|
|
|
|
#include "NvmExpress.h"
|
|
|
|
/**
|
|
Read some sectors from the device.
|
|
|
|
@param Device The pointer to the NVME_DEVICE_PRIVATE_DATA data structure.
|
|
@param Buffer The buffer used to store the data read from the device.
|
|
@param Lba The start block number.
|
|
@param Blocks Total block number to be read.
|
|
|
|
@retval EFI_SUCCESS Datum are read from the device.
|
|
@retval Others Fail to read all the datum.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
ReadSectors (
|
|
IN NVME_DEVICE_PRIVATE_DATA *Device,
|
|
IN UINT64 Buffer,
|
|
IN UINT64 Lba,
|
|
IN UINT32 Blocks
|
|
)
|
|
{
|
|
NVME_CONTROLLER_PRIVATE_DATA *Controller;
|
|
UINT32 Bytes;
|
|
NVM_EXPRESS_PASS_THRU_COMMAND_PACKET CommandPacket;
|
|
NVM_EXPRESS_COMMAND Command;
|
|
NVM_EXPRESS_RESPONSE Response;
|
|
EFI_STATUS Status;
|
|
UINT32 BlockSize;
|
|
|
|
Controller = Device->Controller;
|
|
BlockSize = Device->Media.BlockSize;
|
|
Bytes = Blocks * BlockSize;
|
|
|
|
ZeroMem (&CommandPacket, sizeof(NVM_EXPRESS_PASS_THRU_COMMAND_PACKET));
|
|
ZeroMem (&Command, sizeof(NVM_EXPRESS_COMMAND));
|
|
ZeroMem (&Response, sizeof(NVM_EXPRESS_RESPONSE));
|
|
|
|
CommandPacket.NvmeCmd = &Command;
|
|
CommandPacket.NvmeResponse = &Response;
|
|
|
|
CommandPacket.NvmeCmd->Cdw0.Opcode = NVME_IO_READ_OPC;
|
|
CommandPacket.NvmeCmd->Cdw0.Cid = Controller->Cid[1]++;
|
|
CommandPacket.NvmeCmd->Nsid = Device->NamespaceId;
|
|
CommandPacket.TransferBuffer = (VOID *)(UINTN)Buffer;
|
|
|
|
CommandPacket.TransferLength = Bytes;
|
|
CommandPacket.CommandTimeout = NVME_GENERIC_TIMEOUT;
|
|
CommandPacket.QueueId = NVME_IO_QUEUE;
|
|
|
|
CommandPacket.NvmeCmd->Cdw10 = (UINT32)Lba;
|
|
CommandPacket.NvmeCmd->Cdw11 = (UINT32)(Lba >> 32);
|
|
CommandPacket.NvmeCmd->Cdw12 = (Blocks - 1) & 0xFFFF;
|
|
|
|
CommandPacket.NvmeCmd->Flags = CDW10_VALID | CDW11_VALID | CDW12_VALID;
|
|
|
|
Status = Controller->Passthru.PassThru (
|
|
&Controller->Passthru,
|
|
Device->NamespaceId,
|
|
0,
|
|
&CommandPacket,
|
|
NULL
|
|
);
|
|
|
|
return Status;
|
|
}
|
|
|
|
/**
|
|
Write some sectors to the device.
|
|
|
|
@param Device The pointer to the NVME_DEVICE_PRIVATE_DATA data structure.
|
|
@param Buffer The buffer to be written into the device.
|
|
@param Lba The start block number.
|
|
@param Blocks Total block number to be written.
|
|
|
|
@retval EFI_SUCCESS Datum are written into the buffer.
|
|
@retval Others Fail to write all the datum.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
WriteSectors (
|
|
IN NVME_DEVICE_PRIVATE_DATA *Device,
|
|
IN UINT64 Buffer,
|
|
IN UINT64 Lba,
|
|
IN UINT32 Blocks
|
|
)
|
|
{
|
|
NVME_CONTROLLER_PRIVATE_DATA *Controller;
|
|
NVM_EXPRESS_PASS_THRU_COMMAND_PACKET CommandPacket;
|
|
NVM_EXPRESS_COMMAND Command;
|
|
NVM_EXPRESS_RESPONSE Response;
|
|
EFI_STATUS Status;
|
|
UINT32 Bytes;
|
|
UINT32 BlockSize;
|
|
|
|
Controller = Device->Controller;
|
|
BlockSize = Device->Media.BlockSize;
|
|
Bytes = Blocks * BlockSize;
|
|
|
|
ZeroMem (&CommandPacket, sizeof(NVM_EXPRESS_PASS_THRU_COMMAND_PACKET));
|
|
ZeroMem (&Command, sizeof(NVM_EXPRESS_COMMAND));
|
|
ZeroMem (&Response, sizeof(NVM_EXPRESS_RESPONSE));
|
|
|
|
CommandPacket.NvmeCmd = &Command;
|
|
CommandPacket.NvmeResponse = &Response;
|
|
|
|
CommandPacket.NvmeCmd->Cdw0.Opcode = NVME_IO_WRITE_OPC;
|
|
CommandPacket.NvmeCmd->Cdw0.Cid = Controller->Cid[1]++;
|
|
CommandPacket.NvmeCmd->Nsid = Device->NamespaceId;
|
|
CommandPacket.TransferBuffer = (VOID *)(UINTN)Buffer;
|
|
|
|
CommandPacket.TransferLength = Bytes;
|
|
CommandPacket.CommandTimeout = NVME_GENERIC_TIMEOUT;
|
|
CommandPacket.QueueId = NVME_IO_QUEUE;
|
|
|
|
CommandPacket.NvmeCmd->Cdw10 = (UINT32)Lba;
|
|
CommandPacket.NvmeCmd->Cdw11 = (UINT32)(Lba >> 32);
|
|
CommandPacket.NvmeCmd->Cdw12 = (Blocks - 1) & 0xFFFF;
|
|
|
|
CommandPacket.MetadataBuffer = NULL;
|
|
CommandPacket.MetadataLength = 0;
|
|
|
|
CommandPacket.NvmeCmd->Flags = CDW10_VALID | CDW11_VALID | CDW12_VALID;
|
|
|
|
Status = Controller->Passthru.PassThru (
|
|
&Controller->Passthru,
|
|
Device->NamespaceId,
|
|
0,
|
|
&CommandPacket,
|
|
NULL
|
|
);
|
|
|
|
return Status;
|
|
}
|
|
|
|
/**
|
|
Read some blocks from the device.
|
|
|
|
@param Device The pointer to the NVME_DEVICE_PRIVATE_DATA data structure.
|
|
@param Buffer The buffer used to store the data read from the device.
|
|
@param Lba The start block number.
|
|
@param Blocks Total block number to be read.
|
|
|
|
@retval EFI_SUCCESS Datum are read from the device.
|
|
@retval Others Fail to read all the datum.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
NvmeRead (
|
|
IN NVME_DEVICE_PRIVATE_DATA *Device,
|
|
OUT VOID *Buffer,
|
|
IN UINT64 Lba,
|
|
IN UINTN Blocks
|
|
)
|
|
{
|
|
EFI_STATUS Status;
|
|
UINT32 BlockSize;
|
|
NVME_CONTROLLER_PRIVATE_DATA *Controller;
|
|
UINT32 MaxTransferBlocks;
|
|
UINTN OrginalBlocks;
|
|
|
|
Status = EFI_SUCCESS;
|
|
Controller = Device->Controller;
|
|
BlockSize = Device->Media.BlockSize;
|
|
OrginalBlocks = Blocks;
|
|
|
|
if (Controller->ControllerData->Mdts != 0) {
|
|
MaxTransferBlocks = (1 << (Controller->ControllerData->Mdts)) * (1 << (Controller->Cap.Mpsmin + 12)) / BlockSize;
|
|
} else {
|
|
MaxTransferBlocks = 1024;
|
|
}
|
|
|
|
while (Blocks > 0) {
|
|
if (Blocks > MaxTransferBlocks) {
|
|
Status = ReadSectors (Device, (UINT64)(UINTN)Buffer, Lba, MaxTransferBlocks);
|
|
|
|
Blocks -= MaxTransferBlocks;
|
|
Buffer = (VOID *)(UINTN)((UINT64)(UINTN)Buffer + MaxTransferBlocks * BlockSize);
|
|
Lba += MaxTransferBlocks;
|
|
} else {
|
|
Status = ReadSectors (Device, (UINT64)(UINTN)Buffer, Lba, (UINT32)Blocks);
|
|
Blocks = 0;
|
|
}
|
|
|
|
if (EFI_ERROR(Status)) {
|
|
break;
|
|
}
|
|
}
|
|
|
|
DEBUG ((EFI_D_INFO, "NvmeRead() Lba = 0x%08x, Original = 0x%08x, Remaining = 0x%08x, BlockSize = 0x%x Status = %r\n", Lba, OrginalBlocks, Blocks, BlockSize, Status));
|
|
|
|
return Status;
|
|
}
|
|
|
|
/**
|
|
Write some blocks to the device.
|
|
|
|
@param Device The pointer to the NVME_DEVICE_PRIVATE_DATA data structure.
|
|
@param Buffer The buffer to be written into the device.
|
|
@param Lba The start block number.
|
|
@param Blocks Total block number to be written.
|
|
|
|
@retval EFI_SUCCESS Datum are written into the buffer.
|
|
@retval Others Fail to write all the datum.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
NvmeWrite (
|
|
IN NVME_DEVICE_PRIVATE_DATA *Device,
|
|
IN VOID *Buffer,
|
|
IN UINT64 Lba,
|
|
IN UINTN Blocks
|
|
)
|
|
{
|
|
EFI_STATUS Status;
|
|
UINT32 BlockSize;
|
|
NVME_CONTROLLER_PRIVATE_DATA *Controller;
|
|
UINT32 MaxTransferBlocks;
|
|
UINTN OrginalBlocks;
|
|
|
|
Status = EFI_SUCCESS;
|
|
Controller = Device->Controller;
|
|
BlockSize = Device->Media.BlockSize;
|
|
OrginalBlocks = Blocks;
|
|
|
|
if (Controller->ControllerData->Mdts != 0) {
|
|
MaxTransferBlocks = (1 << (Controller->ControllerData->Mdts)) * (1 << (Controller->Cap.Mpsmin + 12)) / BlockSize;
|
|
} else {
|
|
MaxTransferBlocks = 1024;
|
|
}
|
|
|
|
while (Blocks > 0) {
|
|
if (Blocks > MaxTransferBlocks) {
|
|
Status = WriteSectors (Device, (UINT64)(UINTN)Buffer, Lba, MaxTransferBlocks);
|
|
|
|
Blocks -= MaxTransferBlocks;
|
|
Buffer = (VOID *)(UINTN)((UINT64)(UINTN)Buffer + MaxTransferBlocks * BlockSize);
|
|
Lba += MaxTransferBlocks;
|
|
} else {
|
|
Status = WriteSectors (Device, (UINT64)(UINTN)Buffer, Lba, (UINT32)Blocks);
|
|
Blocks = 0;
|
|
}
|
|
|
|
if (EFI_ERROR(Status)) {
|
|
break;
|
|
}
|
|
}
|
|
|
|
DEBUG ((EFI_D_INFO, "NvmeWrite() Lba = 0x%08x, Original = 0x%08x, Remaining = 0x%08x, BlockSize = 0x%x Status = %r\n", Lba, OrginalBlocks, Blocks, BlockSize, Status));
|
|
|
|
return Status;
|
|
}
|
|
|
|
/**
|
|
Flushes all modified data to the device.
|
|
|
|
@param Device The pointer to the NVME_DEVICE_PRIVATE_DATA data structure.
|
|
|
|
@retval EFI_SUCCESS Datum are written into the buffer.
|
|
@retval Others Fail to write all the datum.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
NvmeFlush (
|
|
IN NVME_DEVICE_PRIVATE_DATA *Device
|
|
)
|
|
{
|
|
NVME_CONTROLLER_PRIVATE_DATA *Controller;
|
|
NVM_EXPRESS_PASS_THRU_COMMAND_PACKET CommandPacket;
|
|
NVM_EXPRESS_COMMAND Command;
|
|
NVM_EXPRESS_RESPONSE Response;
|
|
EFI_STATUS Status;
|
|
|
|
Controller = Device->Controller;
|
|
|
|
ZeroMem (&CommandPacket, sizeof(NVM_EXPRESS_PASS_THRU_COMMAND_PACKET));
|
|
ZeroMem (&Command, sizeof(NVM_EXPRESS_COMMAND));
|
|
ZeroMem (&Response, sizeof(NVM_EXPRESS_RESPONSE));
|
|
|
|
CommandPacket.NvmeCmd = &Command;
|
|
CommandPacket.NvmeResponse = &Response;
|
|
|
|
CommandPacket.NvmeCmd->Cdw0.Opcode = NVME_IO_FLUSH_OPC;
|
|
CommandPacket.NvmeCmd->Cdw0.Cid = Controller->Cid[1]++;
|
|
CommandPacket.NvmeCmd->Nsid = Device->NamespaceId;
|
|
CommandPacket.CommandTimeout = NVME_GENERIC_TIMEOUT;
|
|
CommandPacket.QueueId = NVME_IO_QUEUE;
|
|
|
|
Status = Controller->Passthru.PassThru (
|
|
&Controller->Passthru,
|
|
Device->NamespaceId,
|
|
0,
|
|
&CommandPacket,
|
|
NULL
|
|
);
|
|
|
|
return Status;
|
|
}
|
|
|
|
|
|
/**
|
|
Reset the Block Device.
|
|
|
|
@param This Indicates a pointer to the calling context.
|
|
@param ExtendedVerification Driver may perform diagnostics on reset.
|
|
|
|
@retval EFI_SUCCESS The device was reset.
|
|
@retval EFI_DEVICE_ERROR The device is not functioning properly and could
|
|
not be reset.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
NvmeBlockIoReset (
|
|
IN EFI_BLOCK_IO_PROTOCOL *This,
|
|
IN BOOLEAN ExtendedVerification
|
|
)
|
|
{
|
|
EFI_TPL OldTpl;
|
|
NVME_CONTROLLER_PRIVATE_DATA *Private;
|
|
NVME_DEVICE_PRIVATE_DATA *Device;
|
|
EFI_STATUS Status;
|
|
|
|
if (This == NULL) {
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
//
|
|
// For Nvm Express subsystem, reset block device means reset controller.
|
|
//
|
|
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
|
|
|
|
Device = NVME_DEVICE_PRIVATE_DATA_FROM_BLOCK_IO (This);
|
|
|
|
Private = Device->Controller;
|
|
|
|
Status = NvmeControllerInit (Private);
|
|
|
|
gBS->RestoreTPL (OldTpl);
|
|
|
|
return Status;
|
|
}
|
|
|
|
/**
|
|
Read BufferSize bytes from Lba into Buffer.
|
|
|
|
@param This Indicates a pointer to the calling context.
|
|
@param MediaId Id of the media, changes every time the media is replaced.
|
|
@param Lba The starting Logical Block Address to read from.
|
|
@param BufferSize Size of Buffer, must be a multiple of device block size.
|
|
@param Buffer A pointer to the destination buffer for the data. The caller is
|
|
responsible for either having implicit or explicit ownership of the buffer.
|
|
|
|
@retval EFI_SUCCESS The data was read correctly from the device.
|
|
@retval EFI_DEVICE_ERROR The device reported an error while performing the read.
|
|
@retval EFI_NO_MEDIA There is no media in the device.
|
|
@retval EFI_MEDIA_CHANGED The MediaId does not matched the current device.
|
|
@retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device.
|
|
@retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid,
|
|
or the buffer is not on proper alignment.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
NvmeBlockIoReadBlocks (
|
|
IN EFI_BLOCK_IO_PROTOCOL *This,
|
|
IN UINT32 MediaId,
|
|
IN EFI_LBA Lba,
|
|
IN UINTN BufferSize,
|
|
OUT VOID *Buffer
|
|
)
|
|
{
|
|
NVME_DEVICE_PRIVATE_DATA *Device;
|
|
EFI_STATUS Status;
|
|
EFI_BLOCK_IO_MEDIA *Media;
|
|
UINTN BlockSize;
|
|
UINTN NumberOfBlocks;
|
|
UINTN IoAlign;
|
|
EFI_TPL OldTpl;
|
|
|
|
//
|
|
// Check parameters.
|
|
//
|
|
if (This == NULL) {
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
Media = This->Media;
|
|
|
|
if (MediaId != Media->MediaId) {
|
|
return EFI_MEDIA_CHANGED;
|
|
}
|
|
|
|
if (Buffer == NULL) {
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
if (BufferSize == 0) {
|
|
return EFI_SUCCESS;
|
|
}
|
|
|
|
BlockSize = Media->BlockSize;
|
|
if ((BufferSize % BlockSize) != 0) {
|
|
return EFI_BAD_BUFFER_SIZE;
|
|
}
|
|
|
|
NumberOfBlocks = BufferSize / BlockSize;
|
|
if ((Lba + NumberOfBlocks - 1) > Media->LastBlock) {
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
IoAlign = Media->IoAlign;
|
|
if (IoAlign > 0 && (((UINTN) Buffer & (IoAlign - 1)) != 0)) {
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
|
|
|
|
Device = NVME_DEVICE_PRIVATE_DATA_FROM_BLOCK_IO (This);
|
|
|
|
Status = NvmeRead (Device, Buffer, Lba, NumberOfBlocks);
|
|
|
|
gBS->RestoreTPL (OldTpl);
|
|
return Status;
|
|
}
|
|
|
|
/**
|
|
Write BufferSize bytes from Lba into Buffer.
|
|
|
|
@param This Indicates a pointer to the calling context.
|
|
@param MediaId The media ID that the write request is for.
|
|
@param Lba The starting logical block address to be written. The caller is
|
|
responsible for writing to only legitimate locations.
|
|
@param BufferSize Size of Buffer, must be a multiple of device block size.
|
|
@param Buffer A pointer to the source buffer for the data.
|
|
|
|
@retval EFI_SUCCESS The data was written correctly to the device.
|
|
@retval EFI_WRITE_PROTECTED The device can not be written to.
|
|
@retval EFI_DEVICE_ERROR The device reported an error while performing the write.
|
|
@retval EFI_NO_MEDIA There is no media in the device.
|
|
@retval EFI_MEDIA_CHNAGED The MediaId does not matched the current device.
|
|
@retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device.
|
|
@retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid,
|
|
or the buffer is not on proper alignment.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
NvmeBlockIoWriteBlocks (
|
|
IN EFI_BLOCK_IO_PROTOCOL *This,
|
|
IN UINT32 MediaId,
|
|
IN EFI_LBA Lba,
|
|
IN UINTN BufferSize,
|
|
IN VOID *Buffer
|
|
)
|
|
{
|
|
NVME_DEVICE_PRIVATE_DATA *Device;
|
|
EFI_STATUS Status;
|
|
EFI_BLOCK_IO_MEDIA *Media;
|
|
UINTN BlockSize;
|
|
UINTN NumberOfBlocks;
|
|
UINTN IoAlign;
|
|
EFI_TPL OldTpl;
|
|
|
|
//
|
|
// Check parameters.
|
|
//
|
|
if (This == NULL) {
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
Media = This->Media;
|
|
|
|
if (MediaId != Media->MediaId) {
|
|
return EFI_MEDIA_CHANGED;
|
|
}
|
|
|
|
if (Buffer == NULL) {
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
if (BufferSize == 0) {
|
|
return EFI_SUCCESS;
|
|
}
|
|
|
|
BlockSize = Media->BlockSize;
|
|
if ((BufferSize % BlockSize) != 0) {
|
|
return EFI_BAD_BUFFER_SIZE;
|
|
}
|
|
|
|
NumberOfBlocks = BufferSize / BlockSize;
|
|
if ((Lba + NumberOfBlocks - 1) > Media->LastBlock) {
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
IoAlign = Media->IoAlign;
|
|
if (IoAlign > 0 && (((UINTN) Buffer & (IoAlign - 1)) != 0)) {
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
|
|
|
|
Device = NVME_DEVICE_PRIVATE_DATA_FROM_BLOCK_IO (This);
|
|
|
|
Status = NvmeWrite (Device, Buffer, Lba, NumberOfBlocks);
|
|
|
|
gBS->RestoreTPL (OldTpl);
|
|
|
|
return Status;
|
|
}
|
|
|
|
/**
|
|
Flush the Block Device.
|
|
|
|
@param This Indicates a pointer to the calling context.
|
|
|
|
@retval EFI_SUCCESS All outstanding data was written to the device.
|
|
@retval EFI_DEVICE_ERROR The device reported an error while writing back the data.
|
|
@retval EFI_NO_MEDIA There is no media in the device.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
NvmeBlockIoFlushBlocks (
|
|
IN EFI_BLOCK_IO_PROTOCOL *This
|
|
)
|
|
{
|
|
NVME_DEVICE_PRIVATE_DATA *Device;
|
|
EFI_STATUS Status;
|
|
EFI_TPL OldTpl;
|
|
|
|
//
|
|
// Check parameters.
|
|
//
|
|
if (This == NULL) {
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
|
|
|
|
Device = NVME_DEVICE_PRIVATE_DATA_FROM_BLOCK_IO (This);
|
|
|
|
Status = NvmeFlush (Device);
|
|
|
|
gBS->RestoreTPL (OldTpl);
|
|
|
|
return Status;
|
|
}
|