Hao, Why will this cause CDROM devices to fail to be recognized? If they require a capacity read, I can change the MustReadCapacity flag to TRUE. On subsequent media change, the sense key parsing will set Action to ACTION_READ_CAPACITY so that case is covered as well. Is there a reason the MustReadCapacity flag was originally set to FALSE for CDROM devices? With the default action being to read capacity anyway, the existing implementation seems to make the flag mostly useless.
I have implemented the rest of the suggestions. Thanks, Christopher Zurcher -----Original Message----- From: Wu, Hao A Sent: Monday, June 17, 2019 19:12 To: devel@edk2.groups.io; Zurcher, Christopher J <christopher.j.zurc...@intel.com> Cc: Kinney, Michael D <michael.d.kin...@intel.com>; Yao, Jiewen <jiewen....@intel.com>; Wang, Jian J <jian.j.w...@intel.com>; Gao, Liming <liming....@intel.com> Subject: RE: [edk2-devel] [PATCH v4 2/2] MdeModulePkg/ScsiDiskDxe: Support Storage Security Command Protocol > -----Original Message----- > From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of > Zurcher, Christopher J > Sent: Thursday, June 13, 2019 10:05 AM > To: devel@edk2.groups.io > Cc: Kinney, Michael D; Yao, Jiewen; Wang, Jian J; Gao, Liming > Subject: [edk2-devel] [PATCH v4 2/2] MdeModulePkg/ScsiDiskDxe: Support > Storage Security Command Protocol > > This patch implements the EFI_STORAGE_SECURITY_COMMAND_PROTOCOL > in the > ScsiDiskDxe driver. > > Support is currently limited to the RPMB Well-known LUN for UFS devices. Hello, Some general level comments: 1. CDROM device issue This patch will bring an issue to the CDROM devices that CD/DVD will not be recognized properly. I think the cause of the issue is the relocation of the below logic: ScsiDiskDevice->BlkIo.Media->MediaPresent = TRUE; from GetMediaInfo() to ScsiDiskTestUnitReady(). It will lead to the read capacity command being skipped for CDROM devices, which results into the LastBlock for the device equals to 0. We may need to find out a better approach to handle the case for UFS RPMB. 2. Split this patch into three commits Besides adding the Storage Security Command Protocol support in ScsiDisk driver, the patch also: * Updates the ScsiBus driver to recognize the Well known logical unit * Updates the UfsPassThruDxe driver to expose the RPMB WLUN Please help to split the patch into 3 separate commits. 3. Updates for the BlockIO(2) services For functions ScsiDiskReadBlocks(Ex) & ScsiDiskWriteBlocks(Ex), below codes are added for the dummy BlockIO(2) protocol instance on the UFS RPMB Lun: if (BlockSize == 0) { Status = EFI_UNSUPPORTED; goto Done; } I suggest to use status 'EFI_DEVICE_ERROR' for such case, since 'EFI_UNSUPPORTED' is not listed as an expected return status in the UEFI spec. 4. Reinstallation of the EFI_STORAGE_SECURITY_COMMAND_PROTOCOL For the reinstallation of the SSC protocol to handle media change, I saw this is only handled within ScsiDiskReceiveData() & ScsiDiskSendData(). The below functions should be considered as well: ScsiDiskReadBlocks(Ex) ScsiDiskWriteBlocks(Ex) ScsiDiskFlushBlocksEx ScsiDiskEraseBlocks Some inline comments below: > > Cc: Michael D Kinney <michael.d.kin...@intel.com> > Cc: Jiewen Yao <jiewen....@intel.com> > Cc: Jian J Wang <jian.j.w...@intel.com> > Cc: Liming Gao <liming....@intel.com> > Signed-off-by: Christopher J Zurcher <christopher.j.zurc...@intel.com> > --- > MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDiskDxe.inf | 3 +- > MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.h | 171 ++++++- > MdeModulePkg/Bus/Scsi/ScsiBusDxe/ScsiBus.c | 5 +- > MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.c | 522 > +++++++++++++++++++- > MdeModulePkg/Bus/Ufs/UfsPassThruDxe/UfsPassThru.c | 19 +- > 5 files changed, 698 insertions(+), 22 deletions(-) > > diff --git a/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDiskDxe.inf > b/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDiskDxe.inf > index 5500d828e9..40818e669b 100644 > --- a/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDiskDxe.inf > +++ b/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDiskDxe.inf > @@ -3,7 +3,7 @@ > # It detects the SCSI disk media and installs Block I/O and Block I/O2 > Protocol > on > # the device handle. > # > -# 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 > # > ## > @@ -52,6 +52,7 @@ > gEfiBlockIoProtocolGuid ## BY_START > gEfiBlockIo2ProtocolGuid ## BY_START > gEfiEraseBlockProtocolGuid ## BY_START > + gEfiStorageSecurityCommandProtocolGuid ## BY_START > gEfiScsiIoProtocolGuid ## TO_START > gEfiScsiPassThruProtocolGuid ## TO_START > gEfiExtScsiPassThruProtocolGuid ## TO_START > diff --git a/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.h > b/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.h > index 42c0aaaa95..2d8679ec6f 100644 > --- a/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.h > +++ b/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.h > @@ -1,7 +1,7 @@ > /** @file > Header file for SCSI Disk Driver. > > -Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR> > +Copyright (c) 2004 - 2019, Intel Corporation. All rights reserved.<BR> > SPDX-License-Identifier: BSD-2-Clause-Patent > > **/ > @@ -22,6 +22,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent > #include <Protocol/ScsiPassThruExt.h> > #include <Protocol/ScsiPassThru.h> > #include <Protocol/DiskInfo.h> > +#include <Protocol/StorageSecurityCommand.h> > > > #include <Library/DebugLib.h> > @@ -38,6 +39,10 @@ SPDX-License-Identifier: BSD-2-Clause-Patent > > #define IS_DEVICE_FIXED(a) (a)->FixedDevice ? 1 : 0 > > +#define IS_ALIGNED(addr, size) (((UINTN) (addr) & (size - 1)) == 0) > + > +#define UFS_WLUN_RPMB 0xC4 > + > typedef struct { > UINT32 MaxLbaCnt; > UINT32 MaxBlkDespCnt; > @@ -51,6 +56,8 @@ typedef struct { > > EFI_HANDLE Handle; > > + EFI_STORAGE_SECURITY_COMMAND_PROTOCOL StorageSecurity; > + > EFI_BLOCK_IO_PROTOCOL BlkIo; > EFI_BLOCK_IO2_PROTOCOL BlkIo2; > EFI_BLOCK_IO_MEDIA BlkIoMedia; > @@ -95,6 +102,7 @@ typedef struct { > #define SCSI_DISK_DEV_FROM_BLKIO(a) CR (a, SCSI_DISK_DEV, BlkIo, > SCSI_DISK_DEV_SIGNATURE) > #define SCSI_DISK_DEV_FROM_BLKIO2(a) CR (a, SCSI_DISK_DEV, BlkIo2, > SCSI_DISK_DEV_SIGNATURE) > #define SCSI_DISK_DEV_FROM_ERASEBLK(a) CR (a, SCSI_DISK_DEV, > EraseBlock, SCSI_DISK_DEV_SIGNATURE) > +#define SCSI_DISK_DEV_FROM_STORSEC(a) CR (a, SCSI_DISK_DEV, > StorageSecurity, SCSI_DISK_DEV_SIGNATURE) > > #define SCSI_DISK_DEV_FROM_DISKINFO(a) CR (a, SCSI_DISK_DEV, > DiskInfo, SCSI_DISK_DEV_SIGNATURE) > > @@ -638,6 +646,151 @@ ScsiDiskEraseBlocks ( > ); > > > +/** > + 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. > + > + 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 > +ScsiDiskReceiveData ( > + IN EFI_STORAGE_SECURITY_COMMAND_PROTOCOL *This, > + IN UINT32 MediaId OPTIONAL, > + IN UINT64 Timeout, > + IN UINT8 SecurityProtocolId, > + IN UINT16 SecurityProtocolSpecificData, > + IN UINTN PayloadBufferSize, > + OUT VOID *PayloadBuffer, > + OUT UINTN *PayloadTransferSize > + ); > + > +/** > + 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. > + > + 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 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. > + > + @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 > +ScsiDiskSendData ( > + IN EFI_STORAGE_SECURITY_COMMAND_PROTOCOL *This, > + IN UINT32 MediaId OPTIONAL, > + IN UINT64 Timeout, > + IN UINT8 SecurityProtocolId, > + IN UINT16 SecurityProtocolSpecificData, > + IN UINTN PayloadBufferSize, > + OUT VOID *PayloadBuffer > + ); > + > + > /** > Provides inquiry information for the controller type. > > @@ -1428,4 +1581,20 @@ DetermineInstallEraseBlock ( > IN EFI_HANDLE ChildHandle > ); > > +/** > + Determine if EFI Storage Security Command Protocol should be produced. > + > + @param ScsiDiskDevice The pointer of SCSI_DISK_DEV. > + @param ChildHandle Handle of device. > + > + @retval TRUE Should produce EFI Storage Security Command Protocol. > + @retval FALSE Should not produce EFI Storage Security Command > Protocol. > + > +**/ > +BOOLEAN > +DetermineInstallStorageSecurity ( > + IN SCSI_DISK_DEV *ScsiDiskDevice, > + IN EFI_HANDLE ChildHandle > + ); > + > #endif > diff --git a/MdeModulePkg/Bus/Scsi/ScsiBusDxe/ScsiBus.c > b/MdeModulePkg/Bus/Scsi/ScsiBusDxe/ScsiBus.c > index c4069aec0f..1caffd38cd 100644 > --- a/MdeModulePkg/Bus/Scsi/ScsiBusDxe/ScsiBus.c > +++ b/MdeModulePkg/Bus/Scsi/ScsiBusDxe/ScsiBus.c > @@ -2,7 +2,7 @@ > SCSI Bus driver that layers on every SCSI Pass Thru and > Extended SCSI Pass Thru protocol in the system. > > -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 > > **/ > @@ -1368,7 +1368,8 @@ DiscoverScsiDevice ( > goto Done; > } > > - if (0x1e >= InquiryData->Peripheral_Type && InquiryData- > >Peripheral_Type >= 0xa) { > + if ((InquiryData->Peripheral_Type >= EFI_SCSI_TYPE_RESERVED_LOW) && > + (InquiryData->Peripheral_Type <= EFI_SCSI_TYPE_RESERVED_HIGH)) { > ScsiDeviceFound = FALSE; > goto Done; > } > diff --git a/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.c > b/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.c > index fbdf927a11..01d5ad4969 100644 > --- a/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.c > +++ b/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.c > @@ -1,7 +1,7 @@ > /** @file > SCSI disk driver that layers on every SCSI IO protocol in the system. > > -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 > > **/ > @@ -151,7 +151,9 @@ ScsiDiskDriverBindingSupported ( > > Status = ScsiIo->GetDeviceType (ScsiIo, &DeviceType); > if (!EFI_ERROR (Status)) { > - if ((DeviceType == EFI_SCSI_TYPE_DISK) || (DeviceType == > EFI_SCSI_TYPE_CDROM)) { > + if ((DeviceType == EFI_SCSI_TYPE_DISK) || > + (DeviceType == EFI_SCSI_TYPE_CDROM) || > + (DeviceType == EFI_SCSI_TYPE_WLUN)) { > Status = EFI_SUCCESS; > } else { > Status = EFI_UNSUPPORTED; > @@ -238,6 +240,8 @@ ScsiDiskDriverBindingStart ( > ScsiDiskDevice->BlkIo2.ReadBlocksEx = ScsiDiskReadBlocksEx; > ScsiDiskDevice->BlkIo2.WriteBlocksEx = ScsiDiskWriteBlocksEx; > ScsiDiskDevice->BlkIo2.FlushBlocksEx = ScsiDiskFlushBlocksEx; > + ScsiDiskDevice->StorageSecurity.ReceiveData = ScsiDiskReceiveData; > + ScsiDiskDevice->StorageSecurity.SendData = ScsiDiskSendData; > ScsiDiskDevice->EraseBlock.Revision = > EFI_ERASE_BLOCK_PROTOCOL_REVISION; > ScsiDiskDevice->EraseBlock.EraseLengthGranularity = 1; > ScsiDiskDevice->EraseBlock.EraseBlocks = ScsiDiskEraseBlocks; > @@ -258,6 +262,10 @@ ScsiDiskDriverBindingStart ( > ScsiDiskDevice->BlkIo.Media->ReadOnly = TRUE; > MustReadCapacity = FALSE; > break; > + > + case EFI_SCSI_TYPE_WLUN: > + MustReadCapacity = FALSE; > + break; > } > // > // The Sense Data Array's initial size is 6 > @@ -309,8 +317,8 @@ ScsiDiskDriverBindingStart ( > // Determine if Block IO & Block IO2 should be produced on this > controller > // handle > // > - if (DetermineInstallBlockIo(Controller)) { > - InitializeInstallDiskInfo(ScsiDiskDevice, Controller); > + if (DetermineInstallBlockIo (Controller)) { > + InitializeInstallDiskInfo (ScsiDiskDevice, Controller); > Status = gBS->InstallMultipleProtocolInterfaces ( > &Controller, > &gEfiBlockIoProtocolGuid, > @@ -321,16 +329,27 @@ ScsiDiskDriverBindingStart ( > &ScsiDiskDevice->DiskInfo, > NULL > ); > - if (!EFI_ERROR(Status)) { > - if (DetermineInstallEraseBlock(ScsiDiskDevice, Controller)) { > + if (!EFI_ERROR (Status)) { > + if (DetermineInstallEraseBlock (ScsiDiskDevice, Controller)) { > Status = gBS->InstallProtocolInterface ( > &Controller, > &gEfiEraseBlockProtocolGuid, > EFI_NATIVE_INTERFACE, > &ScsiDiskDevice->EraseBlock > ); > - if (EFI_ERROR(Status)) { > - DEBUG ((EFI_D_ERROR, "ScsiDisk: Failed to install the Erase Block > Protocol! Status = %r\n", Status)); > + if (EFI_ERROR (Status)) { > + DEBUG ((DEBUG_ERROR, "ScsiDisk: Failed to install the Erase Block > Protocol! Status = %r\n", Status)); > + } > + } > + if (DetermineInstallStorageSecurity (ScsiDiskDevice, Controller)) { > + Status = gBS->InstallProtocolInterface ( > + &Controller, > + &gEfiStorageSecurityCommandProtocolGuid, > + EFI_NATIVE_INTERFACE, > + &ScsiDiskDevice->StorageSecurity > + ); > + if (EFI_ERROR (Status)) { > + DEBUG ((DEBUG_ERROR, "ScsiDisk: Failed to install the Storage > Security Command Protocol! Status = %r\n", Status)); > } > } > ScsiDiskDevice->ControllerNameTable = NULL; > @@ -606,6 +625,11 @@ ScsiDiskReadBlocks ( > // > BlockSize = Media->BlockSize; > > + if (BlockSize == 0) { > + Status = EFI_UNSUPPORTED; > + goto Done; > + } > + > NumberOfBlocks = BufferSize / BlockSize; > > if (!(Media->MediaPresent)) { > @@ -742,6 +766,11 @@ ScsiDiskWriteBlocks ( > // > BlockSize = Media->BlockSize; > > + if (BlockSize == 0) { > + Status = EFI_UNSUPPORTED; > + goto Done; > + } > + > NumberOfBlocks = BufferSize / BlockSize; > > if (!(Media->MediaPresent)) { > @@ -968,6 +997,11 @@ ScsiDiskReadBlocksEx ( > // > BlockSize = Media->BlockSize; > > + if (BlockSize == 0) { > + Status = EFI_UNSUPPORTED; > + goto Done; > + } > + > NumberOfBlocks = BufferSize / BlockSize; > > if (!(Media->MediaPresent)) { > @@ -1131,6 +1165,11 @@ ScsiDiskWriteBlocksEx ( > // > BlockSize = Media->BlockSize; > > + if (BlockSize == 0) { > + Status = EFI_UNSUPPORTED; > + goto Done; > + } > + > NumberOfBlocks = BufferSize / BlockSize; > > if (!(Media->MediaPresent)) { > @@ -1708,6 +1747,393 @@ Done: > 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. > + > + 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 > +ScsiDiskReceiveData ( > + IN EFI_STORAGE_SECURITY_COMMAND_PROTOCOL *This, > + IN UINT32 MediaId OPTIONAL, > + IN UINT64 Timeout, > + IN UINT8 SecurityProtocolId, > + IN UINT16 SecurityProtocolSpecificData, > + IN UINTN PayloadBufferSize, > + OUT VOID *PayloadBuffer, > + OUT UINTN *PayloadTransferSize > + ) > +{ > + SCSI_DISK_DEV *ScsiDiskDevice; > + EFI_BLOCK_IO_MEDIA *Media; > + EFI_STATUS Status; > + BOOLEAN MediaChange; > + EFI_TPL OldTpl; > + UINT8 SenseDataLength; > + UINT8 HostAdapterStatus; > + UINT8 TargetStatus; > + VOID *AlignedBuffer; > + BOOLEAN AlignedBufferAllocated; > + > + AlignedBuffer = NULL; > + MediaChange = FALSE; > + AlignedBufferAllocated = FALSE; > + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); > + ScsiDiskDevice = SCSI_DISK_DEV_FROM_STORSEC (This); > + Media = ScsiDiskDevice->BlkIo.Media; > + > + SenseDataLength = (UINT8) (ScsiDiskDevice->SenseDataNumber * sizeof > (EFI_SCSI_SENSE_DATA)); > + > + if (!DetermineInstallStorageSecurity (ScsiDiskDevice, ScsiDiskDevice- > >Handle)) { > + Status = EFI_UNSUPPORTED; > + goto Done; > + } I think the above 'if' statement is not needed, and should be placed within the below 'if' statement when handling media change: if (MediaChange) {...} (Similar case to ScsiDiskSendData().) > + > + if (!IS_DEVICE_FIXED (ScsiDiskDevice)) { > + Status = ScsiDiskDetectMedia (ScsiDiskDevice, FALSE, &MediaChange); > + if (EFI_ERROR (Status)) { > + Status = EFI_DEVICE_ERROR; > + goto Done; > + } > + > + if (MediaChange) { > + gBS->ReinstallProtocolInterface ( > + ScsiDiskDevice->Handle, > + &gEfiStorageSecurityCommandProtocolGuid, > + &ScsiDiskDevice->StorageSecurity, > + &ScsiDiskDevice->StorageSecurity > + ); The BlockIO(2) & EraseBlocks (if supported) should be reinstalled as well. (Similar case to ScsiDiskSendData().) > + if (Media->MediaPresent) { > + Status = EFI_MEDIA_CHANGED; > + } else { > + Status = EFI_NO_MEDIA; > + } > + goto Done; > + } > + } > + > + // > + // Validate Media > + // > + if (!(Media->MediaPresent)) { > + Status = EFI_NO_MEDIA; > + goto Done; > + } > + > + if ((MediaId != 0) && (MediaId != Media->MediaId)) { > + Status = EFI_MEDIA_CHANGED; > + goto Done; > + } > + > + if (PayloadBufferSize != 0) { > + if ((PayloadBuffer == NULL) || (PayloadTransferSize == NULL)) { > + Status = EFI_INVALID_PARAMETER; > + goto Done; > + } > + > + if ((ScsiDiskDevice->ScsiIo->IoAlign > 1) && !IS_ALIGNED (PayloadBuffer, > ScsiDiskDevice->ScsiIo->IoAlign)) { > + AlignedBuffer = AllocateAlignedBuffer (ScsiDiskDevice, > PayloadBufferSize); > + if (AlignedBuffer == NULL) { > + Status = EFI_OUT_OF_RESOURCES; > + goto Done; > + } > + ZeroMem (AlignedBuffer, PayloadBufferSize); > + AlignedBufferAllocated = TRUE; > + } else { > + AlignedBuffer = PayloadBuffer; > + } > + } > + > + Status = ScsiSecurityProtocolInCommand ( > + ScsiDiskDevice->ScsiIo, > + Timeout, > + ScsiDiskDevice->SenseData, > + &SenseDataLength, > + &HostAdapterStatus, > + &TargetStatus, > + SecurityProtocolId, > + SecurityProtocolSpecificData, > + (UINT32) PayloadBufferSize, > + AlignedBuffer, > + (UINT32 *) PayloadTransferSize > + ); > + if (EFI_ERROR (Status)) { > + goto Done; > + } > + > + if (AlignedBufferAllocated) { > + CopyMem (PayloadBuffer, AlignedBuffer, PayloadBufferSize); > + } > + > + if (PayloadBufferSize < *PayloadTransferSize) { > + Status = EFI_WARN_BUFFER_TOO_SMALL; > + goto Done; > + } > + > + Status = CheckHostAdapterStatus (HostAdapterStatus); > + if (EFI_ERROR (Status)) { > + goto Done; > + } > + > + Status = CheckTargetStatus (TargetStatus); > + if (EFI_ERROR (Status)) { > + goto Done; > + } > + > +Done: > + if (AlignedBufferAllocated) { IMO, the content in 'AlignedBuffer' should be wiped out, since it might contain sensitive information. SSC protocol user can control the data in 'PayloadBuffer' but not in 'AlignedBuffer'. > + FreeAlignedBuffer (AlignedBuffer, PayloadBufferSize); > + } > + gBS->RestoreTPL (OldTpl); > + 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. > + > + 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 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. > + > + @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 > +ScsiDiskSendData ( > + IN EFI_STORAGE_SECURITY_COMMAND_PROTOCOL *This, > + IN UINT32 MediaId OPTIONAL, > + IN UINT64 Timeout, > + IN UINT8 SecurityProtocolId, > + IN UINT16 SecurityProtocolSpecificData, > + IN UINTN PayloadBufferSize, > + OUT VOID *PayloadBuffer > + ) > +{ > + SCSI_DISK_DEV *ScsiDiskDevice; > + EFI_BLOCK_IO_MEDIA *Media; > + EFI_STATUS Status; > + BOOLEAN MediaChange; > + EFI_TPL OldTpl; > + UINT8 SenseDataLength; > + UINT8 HostAdapterStatus; > + UINT8 TargetStatus; > + VOID *AlignedBuffer; > + BOOLEAN AlignedBufferAllocated; > + > + AlignedBuffer = NULL; > + MediaChange = FALSE; > + AlignedBufferAllocated = FALSE; > + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); > + ScsiDiskDevice = SCSI_DISK_DEV_FROM_STORSEC (This); > + Media = ScsiDiskDevice->BlkIo.Media; > + > + SenseDataLength = (UINT8) (ScsiDiskDevice->SenseDataNumber * sizeof > (EFI_SCSI_SENSE_DATA)); > + > + if (!DetermineInstallStorageSecurity (ScsiDiskDevice, ScsiDiskDevice- > >Handle)) { > + Status = EFI_UNSUPPORTED; > + goto Done; > + } > + > + if (!IS_DEVICE_FIXED (ScsiDiskDevice)) { > + Status = ScsiDiskDetectMedia (ScsiDiskDevice, FALSE, &MediaChange); > + if (EFI_ERROR (Status)) { > + Status = EFI_DEVICE_ERROR; > + goto Done; > + } > + > + if (MediaChange) { > + gBS->ReinstallProtocolInterface ( > + ScsiDiskDevice->Handle, > + &gEfiStorageSecurityCommandProtocolGuid, > + &ScsiDiskDevice->StorageSecurity, > + &ScsiDiskDevice->StorageSecurity > + ); > + if (Media->MediaPresent) { > + Status = EFI_MEDIA_CHANGED; > + } else { > + Status = EFI_NO_MEDIA; > + } > + goto Done; > + } > + } > + > + // > + // Validate Media > + // > + if (!(Media->MediaPresent)) { > + Status = EFI_NO_MEDIA; > + goto Done; > + } > + > + if ((MediaId != 0) && (MediaId != Media->MediaId)) { > + Status = EFI_MEDIA_CHANGED; > + goto Done; > + } > + > + if (Media->ReadOnly) { > + Status = EFI_WRITE_PROTECTED; > + goto Done; > + } > + > + if (PayloadBufferSize != 0) { > + if (PayloadBuffer == NULL) { > + Status = EFI_INVALID_PARAMETER; > + goto Done; > + } > + > + if ((ScsiDiskDevice->ScsiIo->IoAlign > 1) && !IS_ALIGNED (PayloadBuffer, > ScsiDiskDevice->ScsiIo->IoAlign)) { > + AlignedBuffer = AllocateAlignedBuffer (ScsiDiskDevice, > PayloadBufferSize); > + if (AlignedBuffer == NULL) { > + Status = EFI_OUT_OF_RESOURCES; > + goto Done; > + } > + CopyMem (AlignedBuffer, PayloadBuffer, PayloadBufferSize); > + AlignedBufferAllocated = TRUE; > + } else { > + AlignedBuffer = PayloadBuffer; > + } > + } > + > + Status = ScsiSecurityProtocolOutCommand ( > + ScsiDiskDevice->ScsiIo, > + Timeout, > + ScsiDiskDevice->SenseData, > + &SenseDataLength, > + &HostAdapterStatus, > + &TargetStatus, > + SecurityProtocolId, > + SecurityProtocolSpecificData, > + (UINT32) PayloadBufferSize, > + AlignedBuffer > + ); > + if (EFI_ERROR (Status)) { > + goto Done; > + } > + > + Status = CheckHostAdapterStatus (HostAdapterStatus); > + if (EFI_ERROR (Status)) { > + goto Done; > + } > + > + Status = CheckTargetStatus (TargetStatus); > + if (EFI_ERROR (Status)) { > + goto Done; > + } > + > +Done: > + if (AlignedBufferAllocated) { IMO, the content in 'AlignedBuffer' should be wiped out, since it might contain sensitive information. SSC protocol user can control the data in 'PayloadBuffer' but not in 'AlignedBuffer'. > + FreeAlignedBuffer (AlignedBuffer, PayloadBufferSize); > + } > + gBS->RestoreTPL (OldTpl); > + return Status; > +} > + > > /** > Detect Device and read out capacity ,if error occurs, parse the sense key. > @@ -2261,6 +2687,8 @@ ScsiDiskTestUnitReady ( > return EFI_DEVICE_ERROR; > } > > + ScsiDiskDevice->BlkIo.Media->MediaPresent = TRUE; > + > if (SenseDataLength != 0) { > *NumberOfSenseKeys = SenseDataLength / sizeof > (EFI_SCSI_SENSE_DATA); > *SenseDataArray = ScsiDiskDevice->SenseData; > @@ -2315,13 +2743,12 @@ DetectMediaParsingSenseKeys ( > BOOLEAN RetryLater; > > // > - // Default is to read capacity, unless.. > + // Default is no action > // > - *Action = ACTION_READ_CAPACITY; > + *Action = ACTION_NO_ACTION; > > if (NumberOfSenseKeys == 0) { > if (ScsiDiskDevice->BlkIo.Media->MediaPresent == TRUE) { > - *Action = ACTION_NO_ACTION; > } I do not think the behavior is the same after the patch. Can it be: if (NumberOfSenseKeys == 0) { if (!ScsiDiskDevice->BlkIo.Media->MediaPresent) { *Action = ACTION_READ_CAPACITY; } return EFI_SUCCESS; } > return EFI_SUCCESS; > } > @@ -2331,7 +2758,6 @@ DetectMediaParsingSenseKeys ( > // No Sense Key returned from last submitted command > // > if (ScsiDiskDevice->BlkIo.Media->MediaPresent == TRUE) { > - *Action = ACTION_NO_ACTION; > } I do not think the behavior is the same after the patch. Can it be: if (!ScsiDiskHaveSenseKey (SenseData, NumberOfSenseKeys)) { // // No Sense Key returned from last submitted command // if (!ScsiDiskDevice->BlkIo.Media->MediaPresent) { *Action = ACTION_READ_CAPACITY; } return EFI_SUCCESS; } Best Regards, Hao Wu > return EFI_SUCCESS; > } > @@ -2339,13 +2765,13 @@ DetectMediaParsingSenseKeys ( > if (ScsiDiskIsNoMedia (SenseData, NumberOfSenseKeys)) { > ScsiDiskDevice->BlkIo.Media->MediaPresent = FALSE; > ScsiDiskDevice->BlkIo.Media->LastBlock = 0; > - *Action = ACTION_NO_ACTION; > DEBUG ((EFI_D_VERBOSE, "ScsiDisk: ScsiDiskIsNoMedia\n")); > return EFI_SUCCESS; > } > > if (ScsiDiskIsMediaChange (SenseData, NumberOfSenseKeys)) { > ScsiDiskDevice->BlkIo.Media->MediaId++; > + *Action = ACTION_READ_CAPACITY; > DEBUG ((EFI_D_VERBOSE, "ScsiDisk: ScsiDiskIsMediaChange!\n")); > return EFI_SUCCESS; > } > @@ -2374,7 +2800,6 @@ DetectMediaParsingSenseKeys ( > DEBUG ((EFI_D_VERBOSE, "ScsiDisk: ScsiDiskDriveNotReady!\n")); > return EFI_SUCCESS; > } > - *Action = ACTION_NO_ACTION; > return EFI_DEVICE_ERROR; > } > > @@ -2808,8 +3233,6 @@ GetMediaInfo ( > } > } > } > - > - ScsiDiskDevice->BlkIo.Media->MediaPresent = TRUE; > } > > /** > @@ -5358,6 +5781,14 @@ DetermineInstallEraseBlock ( > RetVal = TRUE; > CapacityData16 = NULL; > > + // > + // UNMAP command is not supported by any of the UFS WLUNs. > + // > + if (ScsiDiskDevice->DeviceType == EFI_SCSI_TYPE_WLUN) { > + RetVal = FALSE; > + goto Done; > + } > + > Status = gBS->HandleProtocol ( > ChildHandle, > &gEfiDevicePathProtocolGuid, > @@ -5460,6 +5891,65 @@ Done: > return RetVal; > } > > +/** > + Determine if EFI Storage Security Command Protocol should be produced. > + > + @param ScsiDiskDevice The pointer of SCSI_DISK_DEV. > + @param ChildHandle Handle of device. > + > + @retval TRUE Should produce EFI Storage Security Command Protocol. > + @retval FALSE Should not produce EFI Storage Security Command > Protocol. > + > +**/ > +BOOLEAN > +DetermineInstallStorageSecurity ( > + IN SCSI_DISK_DEV *ScsiDiskDevice, > + IN EFI_HANDLE ChildHandle > + ) > +{ > + EFI_STATUS Status; > + UFS_DEVICE_PATH *UfsDevice; > + BOOLEAN RetVal; > + EFI_DEVICE_PATH_PROTOCOL *DevicePathNode; > + > + UfsDevice = NULL; > + RetVal = TRUE; > + > + Status = gBS->HandleProtocol ( > + ChildHandle, > + &gEfiDevicePathProtocolGuid, > + (VOID **) &DevicePathNode > + ); > + // > + // Device Path protocol must be installed on the device handle. > + // > + ASSERT_EFI_ERROR (Status); > + > + while (!IsDevicePathEndType (DevicePathNode)) { > + // > + // For now, only support Storage Security Command Protocol on UFS > devices. > + // > + if ((DevicePathNode->Type == MESSAGING_DEVICE_PATH) && > + (DevicePathNode->SubType == MSG_UFS_DP)) { > + UfsDevice = (UFS_DEVICE_PATH *) DevicePathNode; > + break; > + } > + > + DevicePathNode = NextDevicePathNode (DevicePathNode); > + } > + if (UfsDevice == NULL) { > + RetVal = FALSE; > + goto Done; > + } > + > + if (UfsDevice->Lun != UFS_WLUN_RPMB) { > + RetVal = FALSE; > + } > + > +Done: > + return RetVal; > +} > + > /** > Provides inquiry information for the controller type. > > diff --git a/MdeModulePkg/Bus/Ufs/UfsPassThruDxe/UfsPassThru.c > b/MdeModulePkg/Bus/Ufs/UfsPassThruDxe/UfsPassThru.c > index 1518b251d8..0bb67f2ddc 100644 > --- a/MdeModulePkg/Bus/Ufs/UfsPassThruDxe/UfsPassThru.c > +++ b/MdeModulePkg/Bus/Ufs/UfsPassThruDxe/UfsPassThru.c > @@ -1,6 +1,6 @@ > /** @file > > - Copyright (c) 2014 - 2018, Intel Corporation. All rights reserved.<BR> > + Copyright (c) 2014 - 2019, Intel Corporation. All rights reserved.<BR> > SPDX-License-Identifier: BSD-2-Clause-Patent > > **/ > @@ -819,7 +819,9 @@ UfsPassThruDriverBindingStart ( > UINTN UfsHcBase; > UINT32 Index; > UFS_UNIT_DESC UnitDescriptor; > + UFS_DEV_DESC DeviceDescriptor; > UINT32 UnitDescriptorSize; > + UINT32 DeviceDescriptorSize; > > Status = EFI_SUCCESS; > UfsHc = NULL; > @@ -894,7 +896,6 @@ UfsPassThruDriverBindingStart ( > > // > // Check if 8 common luns are active and set corresponding bit mask. > - // TODO: Parse device descriptor to decide if exposing RPMB LUN to upper > layer for authentication access. > // > UnitDescriptorSize = sizeof (UFS_UNIT_DESC); > for (Index = 0; Index < 8; Index++) { > @@ -909,6 +910,20 @@ UfsPassThruDriverBindingStart ( > } > } > > + // > + // Check if RPMB WLUN is supported and set corresponding bit mask. > + // > + DeviceDescriptorSize = sizeof (UFS_DEV_DESC); > + Status = UfsRwDeviceDesc (Private, TRUE, UfsDeviceDesc, 0, 0, > &DeviceDescriptor, &DeviceDescriptorSize); > + if (EFI_ERROR (Status)) { > + DEBUG ((DEBUG_ERROR, "Failed to read device descriptor, status = %r\n", > Status)); > + } else { > + if (DeviceDescriptor.SecurityLun == 0x1) { > + DEBUG ((DEBUG_INFO, "UFS WLUN RPMB is supported\n")); > + Private->Luns.BitMask |= BIT11; > + } > + } > + > // > // Start the asynchronous interrupt monitor > // > -- > 2.16.2.windows.1 > > > -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#45856): https://edk2.groups.io/g/devel/message/45856 Mute This Topic: https://groups.io/mt/32048247/21656 Group Owner: devel+ow...@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
