sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

MdePkg: Implement SCSI commands for Security Protocol In/Out

Browse Source 
BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=1546

This patch implements the Security Protocol In and Security Protocol Out
commands in UefiScsiLib to prepare support for the Storage Security
Command Protocol.

Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Jian J Wang <jian.j.wang@intel.com>
Signed-off-by: Christopher J Zurcher <christopher.j.zurcher@intel.com>
Reviewed-by: Hao A Wu <hao.a.wu@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
This commit is contained in:
Zurcher, Christopher J
2019-09-27 10:19:57 +08:00
committed by Hao A Wu
parent 1f5e4d9128
commit 9b14509b16
3 changed files with 388 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

229
MdePkg/Library/UefiScsiLib/UefiScsiLib.c
View File

@@ -1,7 +1,7 @@
/** @file
UEFI SCSI Library implementation
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
@@ -23,6 +23,7 @@
//
#define EFI_SCSI_OP_LENGTH_SIX 0x6
#define EFI_SCSI_OP_LENGTH_TEN 0xa
#define EFI_SCSI_OP_LENGTH_TWELVE 0xc
#define EFI_SCSI_OP_LENGTH_SIXTEEN 0x10
//
@@ -1280,6 +1281,232 @@ ScsiWrite16Command (
}
/**
Execute Security Protocol In SCSI command on a specific SCSI target.
Executes the SCSI Security Protocol In command on the SCSI target specified by ScsiIo.
If Timeout is zero, then this function waits indefinitely for the command to complete.
If Timeout is greater than zero, then the command is executed and will timeout after
Timeout 100 ns units.
If ScsiIo is NULL, then ASSERT().
If SenseDataLength is NULL, then ASSERT().
If HostAdapterStatus is NULL, then ASSERT().
If TargetStatus is NULL, then ASSERT().
If TransferLength is NULL, then ASSERT().
If SenseDataLength is non-zero and SenseData is not NULL, SenseData must meet buffer
alignment requirement defined in EFI_SCSI_IO_PROTOCOL. Otherwise EFI_INVALID_PARAMETER
gets returned.
If DataLength is non-zero and DataBuffer is not NULL, DataBuffer must meet buffer
alignment requirement defined in EFI_SCSI_IO_PROTOCOL. Otherwise EFI_INVALID_PARAMETER
gets returned.
@param[in] ScsiIo SCSI IO Protocol to use.
@param[in] Timeout The length of timeout period.
@param[in, out] SenseData A pointer to output sense data.
@param[in, out] SenseDataLength The length of output sense data.
@param[out] HostAdapterStatus The status of Host Adapter.
@param[out] TargetStatus The status of the target.
@param[in] SecurityProtocol The Security Protocol to use.
@param[in] SecurityProtocolSpecific The Security Protocol Specific data.
@param[in] Inc512 If TRUE, 512 increment (INC_512) bit will be set for the
SECURITY PROTOCOL IN command.
@param[in] DataLength The size in bytes of the data buffer.
@param[in, out] DataBuffer A pointer to a data buffer.
@param[out] TransferLength A pointer to a buffer to store the size in
bytes of the data written to the data buffer.
@retval EFI_SUCCESS Command is executed successfully.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the entire DataBuffer could
not be transferred. The actual number of bytes transferred is returned in TransferLength.
@retval EFI_NOT_READY The SCSI Request Packet could not be sent because there are too many
SCSI Command Packets already queued.
@retval EFI_DEVICE_ERROR A device error occurred while attempting to send SCSI Request Packet.
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by
the SCSI initiator(i.e., SCSI Host Controller)
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
@retval EFI_INVALID_PARAMETER The contents of the SCSI Request Packet are invalid.
**/
EFI_STATUS
EFIAPI
ScsiSecurityProtocolInCommand (
IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
IN UINT64 Timeout,
IN OUT VOID *SenseData, OPTIONAL
IN OUT UINT8 *SenseDataLength,
OUT UINT8 *HostAdapterStatus,
OUT UINT8 *TargetStatus,
IN UINT8 SecurityProtocol,
IN UINT16 SecurityProtocolSpecific,
IN BOOLEAN Inc512,
IN UINTN DataLength,
IN OUT VOID *DataBuffer, OPTIONAL
OUT UINTN *TransferLength
)
{
EFI_SCSI_IO_SCSI_REQUEST_PACKET CommandPacket;
EFI_STATUS Status;
UINT8 Cdb[EFI_SCSI_OP_LENGTH_TWELVE];
ASSERT (SenseDataLength != NULL);
ASSERT (HostAdapterStatus != NULL);
ASSERT (TargetStatus != NULL);
ASSERT (ScsiIo != NULL);
ASSERT (TransferLength != NULL);
ASSERT (DataLength <= MAX_UINT32);
ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET));
ZeroMem (Cdb, EFI_SCSI_OP_LENGTH_TWELVE);
CommandPacket.Timeout = Timeout;
CommandPacket.InDataBuffer = DataBuffer;
CommandPacket.SenseData = SenseData;
CommandPacket.InTransferLength = (UINT32) DataLength;
CommandPacket.Cdb = Cdb;
//
// Fill Cdb for Security Protocol In Command
//
Cdb[0] = EFI_SCSI_OP_SECURITY_PROTOCOL_IN;
Cdb[1] = SecurityProtocol;
WriteUnaligned16 ((UINT16 *)&Cdb[2], SwapBytes16 (SecurityProtocolSpecific));
if (Inc512) {
if (DataLength % 512 != 0) {
return EFI_INVALID_PARAMETER;
}
Cdb[4] = BIT7;
WriteUnaligned32 ((UINT32 *)&Cdb[6], SwapBytes32 ((UINT32) DataLength / 512));
} else {
WriteUnaligned32 ((UINT32 *)&Cdb[6], SwapBytes32 ((UINT32) DataLength));
}
CommandPacket.CdbLength = EFI_SCSI_OP_LENGTH_TWELVE;
CommandPacket.DataDirection = EFI_SCSI_DATA_IN;
CommandPacket.SenseDataLength = *SenseDataLength;
Status = ScsiIo->ExecuteScsiCommand (ScsiIo, &CommandPacket, NULL);
*HostAdapterStatus = CommandPacket.HostAdapterStatus;
*TargetStatus = CommandPacket.TargetStatus;
*SenseDataLength = CommandPacket.SenseDataLength;
*TransferLength = (UINTN) CommandPacket.InTransferLength;
return Status;
}
/**
Execute Security Protocol Out SCSI command on a specific SCSI target.
Executes the SCSI Security Protocol Out command on the SCSI target specified by ScsiIo.
If Timeout is zero, then this function waits indefinitely for the command to complete.
If Timeout is greater than zero, then the command is executed and will timeout after
Timeout 100 ns units.
If ScsiIo is NULL, then ASSERT().
If SenseDataLength is NULL, then ASSERT().
If HostAdapterStatus is NULL, then ASSERT().
If TargetStatus is NULL, then ASSERT().
If SenseDataLength is non-zero and SenseData is not NULL, SenseData must meet buffer
alignment requirement defined in EFI_SCSI_IO_PROTOCOL. Otherwise EFI_INVALID_PARAMETER
gets returned.
If DataLength is non-zero and DataBuffer is not NULL, DataBuffer must meet buffer
alignment requirement defined in EFI_SCSI_IO_PROTOCOL. Otherwise EFI_INVALID_PARAMETER
gets returned.
@param[in] ScsiIo SCSI IO Protocol to use.
@param[in] Timeout The length of timeout period.
@param[in, out] SenseData A pointer to output sense data.
@param[in, out] SenseDataLength The length of output sense data.
@param[out] HostAdapterStatus The status of Host Adapter.
@param[out] TargetStatus The status of the target.
@param[in] SecurityProtocol The Security Protocol to use.
@param[in] SecurityProtocolSpecific The Security Protocol Specific data.
@param[in] Inc512 If TRUE, 512 increment (INC_512) bit will be set for the
SECURITY PROTOCOL OUT command.
@param[in] DataLength The size in bytes of the transfer data.
@param[in, out] DataBuffer A pointer to a data buffer.
@retval EFI_SUCCESS Command is executed successfully.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the entire DataBuffer could
not be transferred. The actual number of bytes transferred is returned in DataLength.
@retval EFI_NOT_READY The SCSI Request Packet could not be sent because there are too many
SCSI Command Packets already queued.
@retval EFI_DEVICE_ERROR A device error occurred while attempting to send SCSI Request Packet.
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by
the SCSI initiator(i.e., SCSI Host Controller)
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
@retval EFI_INVALID_PARAMETER The contents of the SCSI Request Packet are invalid.
**/
EFI_STATUS
EFIAPI
ScsiSecurityProtocolOutCommand (
IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
IN UINT64 Timeout,
IN OUT VOID *SenseData, OPTIONAL
IN OUT UINT8 *SenseDataLength,
OUT UINT8 *HostAdapterStatus,
OUT UINT8 *TargetStatus,
IN UINT8 SecurityProtocol,
IN UINT16 SecurityProtocolSpecific,
IN BOOLEAN Inc512,
IN UINTN DataLength,
IN OUT VOID *DataBuffer OPTIONAL
)
{
EFI_SCSI_IO_SCSI_REQUEST_PACKET CommandPacket;
EFI_STATUS Status;
UINT8 Cdb[EFI_SCSI_OP_LENGTH_TWELVE];
ASSERT (SenseDataLength != NULL);
ASSERT (HostAdapterStatus != NULL);
ASSERT (TargetStatus != NULL);
ASSERT (ScsiIo != NULL);
ASSERT (DataLength <= MAX_UINT32);
ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET));
ZeroMem (Cdb, EFI_SCSI_OP_LENGTH_TWELVE);
CommandPacket.Timeout = Timeout;
CommandPacket.OutDataBuffer = DataBuffer;
CommandPacket.SenseData = SenseData;
CommandPacket.OutTransferLength = (UINT32) DataLength;
CommandPacket.Cdb = Cdb;
//
// Fill Cdb for Security Protocol Out Command
//
Cdb[0] = EFI_SCSI_OP_SECURITY_PROTOCOL_OUT;
Cdb[1] = SecurityProtocol;
WriteUnaligned16 ((UINT16 *)&Cdb[2], SwapBytes16 (SecurityProtocolSpecific));
if (Inc512) {
if (DataLength % 512 != 0) {
return EFI_INVALID_PARAMETER;
}
Cdb[4] = BIT7;
WriteUnaligned32 ((UINT32 *)&Cdb[6], SwapBytes32 ((UINT32) DataLength / 512));
} else {
WriteUnaligned32 ((UINT32 *)&Cdb[6], SwapBytes32 ((UINT32) DataLength));
}
CommandPacket.CdbLength = EFI_SCSI_OP_LENGTH_TWELVE;
CommandPacket.DataDirection = EFI_SCSI_DATA_OUT;
CommandPacket.SenseDataLength = *SenseDataLength;
Status = ScsiIo->ExecuteScsiCommand (ScsiIo, &CommandPacket, NULL);
*HostAdapterStatus = CommandPacket.HostAdapterStatus;
*TargetStatus = CommandPacket.TargetStatus;
*SenseDataLength = CommandPacket.SenseDataLength;
return Status;
}
/**
Internal helper notify function in which update the result of the
non-blocking SCSI Read/Write commands and signal caller event.