Skip to content

Commit

Permalink
[efiwrapper] add NVME security support
Browse files Browse the repository at this point in the history 
this patch support NVME security send/receive and register storage security
protocol(SSP) for NVME

Change-Id: Iad0b98df5e8554903d8abf7dc5f21cd5d535e091
Tracked-On: https://jira01.devtools.intel.com/browse/OAM-52565
Signed-off-by: JianFeng,Zhou <[email protected]>
Reviewed-on: https://android.intel.com:443/657010
  • Loading branch information
@zhouji3x
zhouji3x authored and buildslave committed Feb 21, 2019
1 parent 68778d8 commit e0ca7e6
Show file tree
Hide file tree
Showing 8 changed files with 649 additions and 20 deletions.
2 changes: 2 additions & 0 deletions drivers/nvme/NvmCtrlLib.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,4 +147,6 @@ EFI_STATUS EFIAPI NvmeInitialize (IN UINTN NvmeHcPciBase);

EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL *NvmeGetPassthru(void);

EFI_STORAGE_SECURITY_COMMAND_PROTOCOL *NvmeGetSecurityInterface(void);

#endif
37 changes: 30 additions & 7 deletions drivers/nvme/NvmExpress.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,25 @@ NvmCtrlPlatformInfo NvmCtrlInfo = { {1,0,0} };

EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL *NvmeGetPassthru(void)
{
return (void *)&mNvmeCtrlPrivate->Passthru;
return (void *)&mNvmeCtrlPrivate->Passthru;
}

EFI_STORAGE_SECURITY_COMMAND_PROTOCOL *NvmeGetSecurityInterface(void)
{
NVME_DEVICE_PRIVATE_DATA *device = mMultiNvmeDrive[0];
EFI_STORAGE_SECURITY_COMMAND_PROTOCOL *security;

if (device == NULL)
return NULL;

security = &device->StorageSecurity;
if (security->SendData == NULL || security->ReceiveData == NULL)
return NULL;

return security;
}


//
// Template for NVM Express Pass Thru Mode data structure.
//
Expand Down Expand Up @@ -151,6 +167,17 @@ EnumerateNvmeDevNamespace (
CopyMem (&Device->NamespaceData, NamespaceData, sizeof (NVME_ADMIN_NAMESPACE_DATA));
mMultiNvmeDrive[NamespaceId - 1] = Device; //NamespaceId is 1 based

//
// Create StorageSecurityProtocol Instance
//
Device->StorageSecurity.ReceiveData = NvmeStorageSecurityReceiveData;
Device->StorageSecurity.SendData = NvmeStorageSecuritySendData;
DEBUG_NVME((EFI_D_INFO, "## SECURITY_SEND_RECEIVE %d ####\n", (Private->ControllerData->Oacs & SECURITY_SEND_RECEIVE_SUPPORTED)));
if ((Private->ControllerData->Oacs & SECURITY_SEND_RECEIVE_SUPPORTED) == 0) {
Device->StorageSecurity.ReceiveData = NULL;
Device->StorageSecurity.SendData = NULL;
}

//
// Dump NvmExpress Identify Namespace Data
//
Expand Down Expand Up @@ -392,16 +419,14 @@ NvmeGetMediaInfo (
EFI_STATUS
EFIAPI
NvmeReadBlocks (
IN UINTN DeviceIndex,
IN UINTN DeviceIndex __attribute__((unused)),
IN EFI_PEI_LBA StartLBA,
IN UINTN BufferSize,
OUT VOID *Buffer
)
{
EFI_STATUS Status;

DeviceIndex = DeviceIndex;

Status = NvmeBlockIoReadBlocks(&mMultiNvmeDrive[0]->BlockIo, 0, StartLBA, BufferSize, Buffer);

return Status;
Expand All @@ -423,16 +448,14 @@ NvmeReadBlocks (
EFI_STATUS
EFIAPI
NvmeWriteBlocks (
IN UINTN DeviceIndex,
IN UINTN DeviceIndex __attribute__((unused)),
IN EFI_LBA StartLBA,
IN UINTN DataSize,
IN VOID *DataAddress
)
{
EFI_STATUS Status;

DeviceIndex = DeviceIndex;

Status = NvmeBlockIoWriteBlocks(&mMultiNvmeDrive[0]->BlockIo, 0, StartLBA, DataSize, DataAddress);

return Status;
Expand Down
2 changes: 2 additions & 0 deletions drivers/nvme/NvmExpress.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
#include <external.h>

#include "NvmInternal.h"
#include "protocol/StorageSecurityCommand.h"

#define nvme_dbg(a, ...) { printf(__VA_ARGS__); }
#define DEBUG_NVME(a) (nvme_dbg a)
Expand Down Expand Up @@ -219,6 +220,7 @@ struct _NVME_DEVICE_PRIVATE_DATA {

NVME_CONTROLLER_PRIVATE_DATA *Controller;

EFI_STORAGE_SECURITY_COMMAND_PROTOCOL StorageSecurity;
};

//
Expand Down
232 changes: 221 additions & 11 deletions drivers/nvme/NvmExpressBlockIo.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -337,15 +337,13 @@ EFI_STATUS
EFIAPI
NvmeBlockIoReset (
IN EFI_BLOCK_IO_PROTOCOL *This,
IN BOOLEAN ExtendedVerification
IN BOOLEAN ExtendedVerification __attribute__((unused))
)
{
NVME_CONTROLLER_PRIVATE_DATA *Private;
NVME_DEVICE_PRIVATE_DATA *Device;
EFI_STATUS Status;

ExtendedVerification = ExtendedVerification;

if (This == NULL) {
return EFI_INVALID_PARAMETER;
}
Expand Down Expand Up @@ -584,7 +582,6 @@ TrustTransferNvmeDevice (
EFI_NVM_EXPRESS_COMMAND Command;
EFI_NVM_EXPRESS_COMPLETION Completion;
EFI_STATUS Status;
UINT16 SpecificData;

ZeroMem (&CommandPacket, sizeof (EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET));
ZeroMem (&Command, sizeof (EFI_NVM_EXPRESS_COMMAND));
Expand All @@ -593,22 +590,17 @@ TrustTransferNvmeDevice (
CommandPacket.NvmeCmd = &Command;
CommandPacket.NvmeCompletion = &Completion;

//
// Change Endianness of SecurityProtocolSpecificData
//
SpecificData = (((SecurityProtocolSpecificData << 8) & 0xFF00) | (SecurityProtocolSpecificData >> 8));

if (IsTrustSend) {
Command.Cdw0.Opcode = NVME_ADMIN_SECURITY_SEND_CMD;
CommandPacket.TransferBuffer = Buffer;
CommandPacket.TransferLength = (UINT32)TransferLength;
CommandPacket.NvmeCmd->Cdw10 = (UINT32)((SecurityProtocolId << 24) | (SpecificData << 8));
CommandPacket.NvmeCmd->Cdw10 = (UINT32)((SecurityProtocolId << 24) | (SecurityProtocolSpecificData << 8));
CommandPacket.NvmeCmd->Cdw11 = (UINT32)TransferLength;
} else {
Command.Cdw0.Opcode = NVME_ADMIN_SECURITY_RECEIVE_CMD;
CommandPacket.TransferBuffer = Buffer;
CommandPacket.TransferLength = (UINT32)TransferLength;
CommandPacket.NvmeCmd->Cdw10 = (UINT32)((SecurityProtocolId << 24) | (SpecificData << 8));
CommandPacket.NvmeCmd->Cdw10 = (UINT32)((SecurityProtocolId << 24) | (SecurityProtocolSpecificData << 8));
CommandPacket.NvmeCmd->Cdw11 = (UINT32)TransferLength;
}

Expand All @@ -635,3 +627,221 @@ TrustTransferNvmeDevice (
return Status;
}

/**
Send a security protocol command to a device that receives data and/or the result
of one or more commands sent by SendData.
The ReceiveData function sends a security protocol command to the given MediaId.
The security protocol command sent is defined by SecurityProtocolId and contains
the security protocol specific data SecurityProtocolSpecificData. The function
returns the data from the security protocol command in PayloadBuffer.
For devices supporting the SCSI command set, the security protocol command is sent
using the SECURITY PROTOCOL IN command defined in SPC-4.
For devices supporting the ATA command set, the security protocol command is sent
using one of the TRUSTED RECEIVE commands defined in ATA8-ACS if PayloadBufferSize
is non-zero.
If the PayloadBufferSize is zero, the security protocol command is sent using the
Trusted Non-Data command defined in ATA8-ACS.
If PayloadBufferSize is too small to store the available data from the security
protocol command, the function shall copy PayloadBufferSize bytes into the
PayloadBuffer and return EFI_WARN_BUFFER_TOO_SMALL.
If PayloadBuffer or PayloadTransferSize is NULL and PayloadBufferSize is non-zero,
the function shall return EFI_INVALID_PARAMETER.
If the given MediaId does not support security protocol commands, the function shall
return EFI_UNSUPPORTED. If there is no media in the device, the function returns
EFI_NO_MEDIA. If the MediaId is not the ID for the current media in the device,
the function returns EFI_MEDIA_CHANGED.
If the security protocol fails to complete within the Timeout period, the function
shall return EFI_TIMEOUT.
If the security protocol command completes without an error, the function shall
return EFI_SUCCESS. If the security protocol command completes with an error, the
function shall return EFI_DEVICE_ERROR.
@param This Indicates a pointer to the calling context.
@param MediaId ID of the medium to receive data from.
@param Timeout The timeout, in 100ns units, to use for the execution
of the security protocol command. A Timeout value of 0
means that this function will wait indefinitely for the
security protocol command to execute. If Timeout is greater
than zero, then this function will return EFI_TIMEOUT
if the time required to execute the receive data command
is greater than Timeout.
@param SecurityProtocolId The value of the "Security Protocol" parameter of
the security protocol command to be sent.
@param SecurityProtocolSpecificData The value of the "Security Protocol Specific" parameter
of the security protocol command to be sent.
@param PayloadBufferSize Size in bytes of the payload data buffer.
@param PayloadBuffer A pointer to a destination buffer to store the security
protocol command specific payload data for the security
protocol command. The caller is responsible for having
either implicit or explicit ownership of the buffer.
@param PayloadTransferSize A pointer to a buffer to store the size in bytes of the
data written to the payload data buffer.
@retval EFI_SUCCESS The security protocol command completed successfully.
@retval EFI_WARN_BUFFER_TOO_SMALL The PayloadBufferSize was too small to store the available
data from the device. The PayloadBuffer contains the truncated data.
@retval EFI_UNSUPPORTED The given MediaId does not support security protocol commands.
@retval EFI_DEVICE_ERROR The security protocol command completed with an error.
@retval EFI_NO_MEDIA There is no media in the device.
@retval EFI_MEDIA_CHANGED The MediaId is not for the current media.
@retval EFI_INVALID_PARAMETER The PayloadBuffer or PayloadTransferSize is NULL and
PayloadBufferSize is non-zero.
@retval EFI_TIMEOUT A timeout occurred while waiting for the security
protocol command to execute.
**/
EFI_STATUS
EFIAPI
NvmeStorageSecurityReceiveData (
IN EFI_STORAGE_SECURITY_COMMAND_PROTOCOL *This,
IN UINT32 MediaId,
IN UINT64 Timeout,
IN UINT8 SecurityProtocolId,
IN UINT16 SecurityProtocolSpecificData,
IN UINTN PayloadBufferSize,
OUT VOID *PayloadBuffer,
OUT UINTN *PayloadTransferSize
)
{
EFI_STATUS Status;
NVME_DEVICE_PRIVATE_DATA *Device;

Status = EFI_SUCCESS;

if ((PayloadBuffer == NULL) || (PayloadTransferSize == NULL) || (PayloadBufferSize == 0))
return EFI_INVALID_PARAMETER;

Device = NVME_DEVICE_PRIVATE_DATA_FROM_STORAGE_SECURITY(This);

if (MediaId != Device->BlockIo.Media->MediaId)
return EFI_MEDIA_CHANGED;

if (!Device->BlockIo.Media->MediaPresent)
return EFI_NO_MEDIA;

Status = TrustTransferNvmeDevice(
Device->Controller,
PayloadBuffer,
SecurityProtocolId,
SecurityProtocolSpecificData,
PayloadBufferSize,
FALSE,
Timeout,
PayloadTransferSize
);

return Status;
}

/**
Send a security protocol command to a device.
The SendData function sends a security protocol command containing the payload
PayloadBuffer to the given MediaId. The security protocol command sent is
defined by SecurityProtocolId and contains the security protocol specific data
SecurityProtocolSpecificData. If the underlying protocol command requires a
specific padding for the command payload, the SendData function shall add padding
bytes to the command payload to satisfy the padding requirements.
For devices supporting the SCSI command set, the security protocol command is sent
using the SECURITY PROTOCOL OUT command defined in SPC-4.
For devices supporting the ATA command set, the security protocol command is sent
using one of the TRUSTED SEND commands defined in ATA8-ACS if PayloadBufferSize
is non-zero. If the PayloadBufferSize is zero, the security protocol command is
sent using the Trusted Non-Data command defined in ATA8-ACS.
If PayloadBuffer is NULL and PayloadBufferSize is non-zero, the function shall
return EFI_INVALID_PARAMETER.
If the given MediaId does not support security protocol commands, the function
shall return EFI_UNSUPPORTED. If there is no media in the device, the function
returns EFI_NO_MEDIA. If the MediaId is not the ID for the current media in the
device, the function returns EFI_MEDIA_CHANGED.
If the security protocol fails to complete within the Timeout period, the function
shall return EFI_TIMEOUT.
If the security protocol command completes without an error, the function shall return
EFI_SUCCESS. If the security protocol command completes with an error, the function
shall return EFI_DEVICE_ERROR.
@param This Indicates a pointer to the calling context.
@param MediaId ID of the medium to receive data from.
@param Timeout The timeout, in 100ns units, to use for the execution
of the security protocol command. A Timeout value of 0
means that this function will wait indefinitely for the
security protocol command to execute. If Timeout is greater
than zero, then this function will return EFI_TIMEOUT
if the time required to execute the send data command
is greater than Timeout.
@param SecurityProtocolId The value of the "Security Protocol" parameter of
the security protocol command to be sent.
@param SecurityProtocolSpecificData The value of the "Security Protocol Specific" parameter
of the security protocol command to be sent.
@param PayloadBufferSize Size in bytes of the payload data buffer.
@param PayloadBuffer A pointer to a destination buffer to store the security
protocol command specific payload data for the security
protocol command.
@retval EFI_SUCCESS The security protocol command completed successfully.
@retval EFI_UNSUPPORTED The given MediaId does not support security protocol commands.
@retval EFI_DEVICE_ERROR The security protocol command completed with an error.
@retval EFI_NO_MEDIA There is no media in the device.
@retval EFI_MEDIA_CHANGED The MediaId is not for the current media.
@retval EFI_INVALID_PARAMETER The PayloadBuffer is NULL and PayloadBufferSize is non-zero.
@retval EFI_TIMEOUT A timeout occurred while waiting for the security
protocol command to execute.
**/
EFI_STATUS
EFIAPI
NvmeStorageSecuritySendData(
IN EFI_STORAGE_SECURITY_COMMAND_PROTOCOL *This,
IN UINT32 MediaId,
IN UINT64 Timeout,
IN UINT8 SecurityProtocolId,
IN UINT16 SecurityProtocolSpecificData,
IN UINTN PayloadBufferSize,
IN VOID *PayloadBuffer
)
{
EFI_STATUS Status;
NVME_DEVICE_PRIVATE_DATA *Device;

Status = EFI_SUCCESS;

if ((PayloadBuffer == NULL) && (PayloadBufferSize != 0))
return EFI_INVALID_PARAMETER;

Device = NVME_DEVICE_PRIVATE_DATA_FROM_STORAGE_SECURITY(This);

if (MediaId != Device->BlockIo.Media->MediaId)
return EFI_MEDIA_CHANGED;

if (!Device->BlockIo.Media->MediaPresent)
return EFI_NO_MEDIA;

Status = TrustTransferNvmeDevice(
Device->Controller,
PayloadBuffer,
SecurityProtocolId,
SecurityProtocolSpecificData,
PayloadBufferSize,
TRUE,
Timeout,
NULL
);

return Status;
}

Loading

0 comments on commit e0ca7e6

Please sign in to comment.