From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: intel.com, ip: 134.134.136.100, mailfrom: christopher.j.zurcher@intel.com) Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) by groups.io with SMTP; Thu, 29 Aug 2019 17:34:53 -0700 X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by orsmga105.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 29 Aug 2019 17:34:52 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.64,445,1559545200"; d="scan'208";a="188720463" Received: from fmsmsx105.amr.corp.intel.com ([10.18.124.203]) by FMSMGA003.fm.intel.com with ESMTP; 29 Aug 2019 17:34:52 -0700 Received: from fmsmsx606.amr.corp.intel.com (10.18.126.86) by FMSMSX105.amr.corp.intel.com (10.18.124.203) with Microsoft SMTP Server (TLS) id 14.3.439.0; Thu, 29 Aug 2019 17:34:48 -0700 Received: from fmsmsx606.amr.corp.intel.com (10.18.126.86) by fmsmsx606.amr.corp.intel.com (10.18.126.86) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.1713.5; Thu, 29 Aug 2019 17:34:47 -0700 Received: from crsmsx102.amr.corp.intel.com (172.18.63.137) by fmsmsx606.amr.corp.intel.com (10.18.126.86) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256) id 15.1.1713.5 via Frontend Transport; Thu, 29 Aug 2019 17:34:47 -0700 Received: from crsmsx103.amr.corp.intel.com ([169.254.4.51]) by CRSMSX102.amr.corp.intel.com ([169.254.2.72]) with mapi id 14.03.0439.000; Thu, 29 Aug 2019 18:34:45 -0600 From: "Zurcher, Christopher J" To: "Wu, Hao A" , "devel@edk2.groups.io" CC: "Yao, Jiewen" , "Wang, Jian J" , "Gao, Liming" Subject: Re: [edk2-devel] [PATCH v5 1/4] MdePkg: Implement SCSI commands for Security Protocol In/Out Thread-Topic: [edk2-devel] [PATCH v5 1/4] MdePkg: Implement SCSI commands for Security Protocol In/Out Thread-Index: AQHVWTVJRJk+SR3YyUSLfUXnUkNgjKcON75ggASZrEA= Date: Fri, 30 Aug 2019 00:34:45 +0000 Message-ID: <8EE4873E19344F4DA986A2AC15D512AE4A4802AF@CRSMSX103.amr.corp.intel.com> References: <20190822220215.24536-1-christopher.j.zurcher@intel.com> <20190822220215.24536-2-christopher.j.zurcher@intel.com> In-Reply-To: Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiYWUyMDliZjctOTdkZS00NDk1LTk5NDctZTdjZjNlY2UzYTQ5IiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE3LjEwLjE4MDQuNDkiLCJUcnVzdGVkTGFiZWxIYXNoIjoiUUtRZCtuSnNBUnpWU0F6NFlcL3pUQVdKRjZ6V3paTmd5M3dkZldRTnlJbFZJemFjT1Y0YmRuenorcGJYakp4ZEkifQ== x-ctpclassification: CTP_NT dlp-product: dlpe-windows dlp-version: 11.2.0.6 dlp-reaction: no-action x-originating-ip: [172.18.205.10] MIME-Version: 1.0 Return-Path: christopher.j.zurcher@intel.com Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable I've implemented all the suggested changes except changing the arguments fr= om UINT32 to UINTN. No other functions in UefiScsiLib take UINTN arguments,= and since the library is directly packing the CDB, I think it makes sense = to force the caller to provide the correct-size length value. That way ther= e is no ambiguity on what is going to the device. If you agree I will send the updated patchset. Thanks, Christopher Zurcher -----Original Message----- From: Wu, Hao A=20 Sent: Monday, August 26, 2019 20:03 To: devel@edk2.groups.io; Zurcher, Christopher J Cc: Yao, Jiewen ; Wang, Jian J ; Gao, Liming Subject: RE: [edk2-devel] [PATCH v5 1/4] MdePkg: Implement SCSI commands f= or Security Protocol In/Out Hello, Please refer to the below inline comments: > -----Original Message----- > From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of > Zurcher, Christopher J > Sent: Friday, August 23, 2019 6:02 AM > To: devel@edk2.groups.io > Cc: Yao, Jiewen; Wang, Jian J; Gao, Liming > Subject: [edk2-devel] [PATCH v5 1/4] MdePkg: Implement SCSI commands > for Security Protocol In/Out >=20 > This patch implements the Security Protocol In and Security Protocol Out > commands in UefiScsiLib to prepare support for the Storage Security > Command Protocol. >=20 > Cc: Jiewen Yao > Cc: Jian J Wang > Cc: Liming Gao > Signed-off-by: Christopher J Zurcher > --- > MdePkg/Include/IndustryStandard/Scsi.h | 48 +++-- > MdePkg/Include/Library/UefiScsiLib.h | 126 +++++++++++- > MdePkg/Include/Protocol/ScsiIo.h | 9 +- > MdePkg/Library/UefiScsiLib/UefiScsiLib.c | 205 +++++++++++++++++++- > 4 files changed, 366 insertions(+), 22 deletions(-) >=20 > diff --git a/MdePkg/Include/IndustryStandard/Scsi.h > b/MdePkg/Include/IndustryStandard/Scsi.h > index cbe5709fe5..10d7b49ba7 100644 > --- a/MdePkg/Include/IndustryStandard/Scsi.h > +++ b/MdePkg/Include/IndustryStandard/Scsi.h > @@ -1,7 +1,7 @@ > /** @file > Support for SCSI-2 standard >=20 > - Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved. > + Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved. > SPDX-License-Identifier: BSD-2-Clause-Patent >=20 > **/ > @@ -163,6 +163,12 @@ > #define EFI_SCSI_OP_SEND_MESSAGE10 0x2a > #define EFI_SCSI_OP_SEND_MESSAGE12 0xaa >=20 > +// > +// Additional commands for Secure Transactions > +// > +#define EFI_SCSI_OP_SECURITY_PROTOCOL_IN 0xa2 > +#define EFI_SCSI_OP_SECURITY_PROTOCOL_OUT 0xb5 > + > // > // SCSI Data Transfer Direction > // > @@ -172,22 +178,30 @@ > // > // Peripheral Device Type Definitions > // > -#define EFI_SCSI_TYPE_DISK 0x00 ///< Direct-access device (e.= g. > magnetic disk) > -#define EFI_SCSI_TYPE_TAPE 0x01 ///< Sequential-access device= (e.g. > magnetic tape) > -#define EFI_SCSI_TYPE_PRINTER 0x02 ///< Printer device > -#define EFI_SCSI_TYPE_PROCESSOR 0x03 ///< Processor device > -#define EFI_SCSI_TYPE_WORM 0x04 ///< Write-once device (e.g. = some > optical disks) > -#define EFI_SCSI_TYPE_CDROM 0x05 ///< CD-ROM device > -#define EFI_SCSI_TYPE_SCANNER 0x06 ///< Scanner device > -#define EFI_SCSI_TYPE_OPTICAL 0x07 ///< Optical memory device (e= .g. > some optical disks) > -#define EFI_SCSI_TYPE_MEDIUMCHANGER 0x08 ///< Medium changer > device (e.g. jukeboxes) > -#define EFI_SCSI_TYPE_COMMUNICATION 0x09 ///< Communications > device > -#define EFI_SCSI_TYPE_ASCIT8_1 0x0A ///< Defined by ASC IT8 (Grap= hic > arts pre-press devices) > -#define EFI_SCSI_TYPE_ASCIT8_2 0x0B ///< Defined by ASC IT8 (Grap= hic > arts pre-press devices) Could you help to address Liming's comment in the V4 series that to preser= ve the definition for EFI_SCSI_TYPE_ASCIT8_1 & EFI_SCSI_TYPE_ASCIT8_2 for compatibility consideration: https://edk2.groups.io/g/devel/message/42361?p=3D,,,20,0,0,0::Created,,scs= i,20,2,40,32048246 > -// > -// 0Ch - 1Eh are reserved > -// > -#define EFI_SCSI_TYPE_UNKNOWN 0x1F ///< Unknown or no device > type > +#define EFI_SCSI_TYPE_DISK 0x00 ///< Direct-access device (= e.g. > magnetic disk) > +#define EFI_SCSI_TYPE_TAPE 0x01 ///< Sequential-access devi= ce (e.g. > magnetic tape) > +#define EFI_SCSI_TYPE_PRINTER 0x02 ///< Printer device > +#define EFI_SCSI_TYPE_PROCESSOR 0x03 ///< Processor device > +#define EFI_SCSI_TYPE_WORM 0x04 ///< Write-once device (e.g= . > some optical disks) > +#define EFI_SCSI_TYPE_CDROM 0x05 ///< CD/DVD device > +#define EFI_SCSI_TYPE_SCANNER 0x06 ///< Scanner device (obsole= te) > +#define EFI_SCSI_TYPE_OPTICAL 0x07 ///< Optical memory device = (e.g. > some optical disks) > +#define EFI_SCSI_TYPE_MEDIUMCHANGER 0x08 ///< Medium changer > device (e.g. jukeboxes) > +#define EFI_SCSI_TYPE_COMMUNICATION 0x09 ///< Communications > device (obsolete) > +#define EFI_SCSI_TYPE_A 0x0A ///< Obsolete > +#define EFI_SCSI_TYPE_B 0x0B ///< Obsolete > +#define EFI_SCSI_TYPE_RAID 0x0C ///< Storage array controll= er > device (e.g., RAID) > +#define EFI_SCSI_TYPE_SES 0x0D ///< Enclosure services dev= ice > +#define EFI_SCSI_TYPE_RBC 0x0E ///< Simplified direct-acce= ss device > (e.g., magnetic disk) > +#define EFI_SCSI_TYPE_OCRW 0x0F ///< Optical card reader/wr= iter > device > +#define EFI_SCSI_TYPE_BRIDGE 0x10 ///< Bridge Controller Comm= ands > +#define EFI_SCSI_TYPE_OSD 0x11 ///< Object-based Storage D= evice > +#define EFI_SCSI_TYPE_AUTOMATION 0x12 ///< Automation/Drive > Interface > +#define EFI_SCSI_TYPE_SECURITYMANAGER 0x13 ///< Security manager > device > +#define EFI_SCSI_TYPE_RESERVED_LOW 0x14 ///< Reserved (low) > +#define EFI_SCSI_TYPE_RESERVED_HIGH 0x1D ///< Reserved (high) > +#define EFI_SCSI_TYPE_WLUN 0x1E ///< Well known logical uni= t > +#define EFI_SCSI_TYPE_UNKNOWN 0x1F ///< Unknown or no device > type >=20 > // > // Page Codes for INQUIRY command > diff --git a/MdePkg/Include/Library/UefiScsiLib.h > b/MdePkg/Include/Library/UefiScsiLib.h > index 10dd81902b..a0d99e703a 100644 > --- a/MdePkg/Include/Library/UefiScsiLib.h > +++ b/MdePkg/Include/Library/UefiScsiLib.h > @@ -5,7 +5,7 @@ > for hard drive, CD and DVD devices that are the most common SCSI boot > targets used by UEFI platforms. > This library class depends on SCSI I/O Protocol defined in UEFI Speci= fication > and SCSI-2 industry standard. >=20 > -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
> +Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.
> SPDX-License-Identifier: BSD-2-Clause-Patent >=20 > **/ > @@ -813,6 +813,130 @@ ScsiWrite16Command ( > ); >=20 >=20 > +/** > + 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 com= mand to > complete. > + If Timeout is greater than zero, then the command is executed and wil= l > timeout after > + Timeout 100 ns units. The StartLba and SectorSize parameters are use= d to > construct As mentioned in V4 series: There is no 'StartLba' & 'SectorSize' parameters for APIs: ScsiSecurityProtocolInCommand ScsiSecurityProtocolOutCommand Could you help to update the comments to address this? (Please help to update UefiScsiLib.c as well.) > + the CDB for this SCSI command. > + 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 DataLength 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 Speci= fic data. > + @param[in] TransferLength The size in bytes of the data al= location. > + @param[in, out] DataBuffer A pointer to a data buffer. > + @param[in, out] DataLength The length of data buffer. As mentioned in V4 series: Referring to the implementation of the library (changes made in MdePkg/Library/UefiScsiLib/UefiScsiLib.c): 'TransferLength' (input) specifies the length of content in 'DataBuffer'; 'DataLength' (input & output) reflects the actual number of bytes transferred. How about swapping their names and changing the description comments to: (Please help to update UefiScsiLib.c as well.) @param[in] DataLength The size in bytes of the data buffe= r. ... @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 n= umber of bytes > transferred is returned in DataLength. > + @retval EFI_NOT_READY The SCSI Request Packet could no= t be > sent because there are too many > + SCSI Command Packets already que= ued. > + @retval EFI_DEVICE_ERROR A device error occurred while > attempting to send SCSI Request Packet. > + @retval EFI_UNSUPPORTED The command described by the SCS= I > Request Packet is not supported by > + the SCSI initiator(i.e., SCSI H= ost 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 UINT32 TransferLength, > + IN OUT VOID *DataBuffer, OPTIONAL > + IN OUT UINT32 *DataLength > + ); As mentioned in V4 series, could you help to add a new parameter "Inc512" = for both new APIs: ScsiSecurityProtocolInCommand ScsiSecurityProtocolOutCommand Though UFS spec requires the INC_512 field of a CDB to be set to 0, but for other devices, setting this field to 1 may be a valid configuration. Also, I would suggest the below parameter type changes to match with the s= ervices definition of the EFI_STORAGE_SECURITY_COMMAND_PROTOCOL (including the name swap mentioned above): IN UINT32 TransferLength, to IN UINTN DataLength, IN OUT UINT32 *DataLength to OUT UINTN *TransferLength > + > + > +/** > + 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 com= mand to > complete. > + If Timeout is greater than zero, then the command is executed and wil= l > timeout after > + Timeout 100 ns units. The StartLba and SectorSize parameters are use= d to > construct As mentioned in V4 series: There is no 'StartLba' & 'SectorSize' parameters for APIs: ScsiSecurityProtocolInCommand ScsiSecurityProtocolOutCommand Could you help to update the comments to address this? (Please help to update UefiScsiLib.c as well.) > + the CDB for this SCSI command. > + 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 DataLength 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 Speci= fic data. > + @param[in] TransferLength The size in bytes of the transfe= r data. > + @param[in, out] DataBuffer A pointer to a data buffer. As mentioned in V4: Suggest to rename 'TransferLength' to 'DataLength' so that it may be a bit more clear for users to know 'DataLength' reflects the size of 'DataBuffer= '. > + > + @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 n= umber of bytes > transferred is returned in DataLength. > + @retval EFI_NOT_READY The SCSI Request Packet could no= t be > sent because there are too many > + SCSI Command Packets already que= ued. > + @retval EFI_DEVICE_ERROR A device error occurred while > attempting to send SCSI Request Packet. > + @retval EFI_UNSUPPORTED The command described by the SCS= I > Request Packet is not supported by > + the SCSI initiator(i.e., SCSI H= ost 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 UINT32 TransferLength, > + IN OUT VOID *DataBuffer OPTIONAL > + ); As mentioned in V4 series: Suggest the below parameter type changes to match with the services definition of the EFI_STORAGE_SECURITY_COMMAND_PROTOCOL (including the name change mentioned above): IN UINT32 TransferLength to IN UINTN DataLength Best Regards, Hao Wu > + > + > /** > Execute blocking/non-blocking Read(10) SCSI command on a specific SCS= I > target. > diff --git a/MdePkg/Include/Protocol/ScsiIo.h > b/MdePkg/Include/Protocol/ScsiIo.h > index 05e46bda9c..27c31fe7f9 100644 > --- a/MdePkg/Include/Protocol/ScsiIo.h > +++ b/MdePkg/Include/Protocol/ScsiIo.h > @@ -4,7 +4,7 @@ > services environment to access SCSI devices. In particular, functions= for > managing devices on SCSI buses are defined here. >=20 > - Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved. > + Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved. > SPDX-License-Identifier: BSD-2-Clause-Patent >=20 > **/ > @@ -43,8 +43,11 @@ typedef struct _EFI_SCSI_IO_PROTOCOL > EFI_SCSI_IO_PROTOCOL; > #define MFI_SCSI_IO_TYPE_OCRW 0x0F = ///< Optical card > reader/writer device > #define MFI_SCSI_IO_TYPE_BRIDGE 0x10 = ///< Bridge > Controller Commands > #define MFI_SCSI_IO_TYPE_OSD 0x11 = ///< Object-based > Storage Device > -#define EFI_SCSI_IO_TYPE_RESERVED_LOW 0x12 = ///< > Reserved (low) > -#define EFI_SCSI_IO_TYPE_RESERVED_HIGH 0x1E = ///< > Reserved (high) > +#define MFI_SCSI_IO_TYPE_AUTOMATION 0x12 = ///< > Automation/Drive Interface > +#define MFI_SCSI_IO_TYPE_SECURITYMANAGER 0x13 = ///< > Security manager device > +#define EFI_SCSI_IO_TYPE_RESERVED_LOW 0x14 = ///< > Reserved (low) > +#define EFI_SCSI_IO_TYPE_RESERVED_HIGH 0x1D = ///< > Reserved (high) > +#define EFI_SCSI_IO_TYPE_WLUN 0x1E = ///< Well known > logical unit > #define EFI_SCSI_IO_TYPE_UNKNOWN 0x1F = ///< Unknown > no device type >=20 > // > diff --git a/MdePkg/Library/UefiScsiLib/UefiScsiLib.c > b/MdePkg/Library/UefiScsiLib/UefiScsiLib.c > index c7491d1436..7584d717ad 100644 > --- a/MdePkg/Library/UefiScsiLib/UefiScsiLib.c > +++ b/MdePkg/Library/UefiScsiLib/UefiScsiLib.c > @@ -1,7 +1,7 @@ > /** @file > UEFI SCSI Library implementation >=20 > - Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved. > + Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved. > SPDX-License-Identifier: BSD-2-Clause-Patent >=20 > **/ > @@ -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 >=20 > // > @@ -1280,6 +1281,208 @@ ScsiWrite16Command ( > } >=20 >=20 > +/** > + 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 com= mand to > complete. > + If Timeout is greater than zero, then the command is executed and wil= l > timeout after > + Timeout 100 ns units. The StartLba and SectorSize parameters are use= d to > construct As mentioned in V4 series: There is no 'StartLba' & 'SectorSize' parameters for APIs: ScsiSecurityProtocolInCommand ScsiSecurityProtocolOutCommand Could you help to update the comments to address this? (Please help to update UefiScsiLib.c as well.) > + the CDB for this SCSI command. > + 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 DataLength 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 Speci= fic data. > + @param[in] TransferLength The size in bytes of the data al= location. > + @param[in, out] DataBuffer A pointer to a data buffer. > + @param[in, out] DataLength The length of 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 n= umber of bytes > transferred is returned in DataLength. > + @retval EFI_NOT_READY The SCSI Request Packet could no= t be > sent because there are too many > + SCSI Command Packets already que= ued. > + @retval EFI_DEVICE_ERROR A device error occurred while > attempting to send SCSI Request Packet. > + @retval EFI_UNSUPPORTED The command described by the SCS= I > Request Packet is not supported by > + the SCSI initiator(i.e., SCSI H= ost 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 UINT32 TransferLength, > + IN OUT VOID *DataBuffer, OPTIONAL > + IN OUT UINT32 *DataLength > + ) > +{ > + EFI_SCSI_IO_SCSI_REQUEST_PACKET CommandPacket; > + EFI_STATUS Status; > + UINT8 Cdb[EFI_SCSI_OP_LENGTH_TWELVE]; > + > + ASSERT (SenseDataLength !=3D NULL); > + ASSERT (HostAdapterStatus !=3D NULL); > + ASSERT (TargetStatus !=3D NULL); > + ASSERT (DataLength !=3D NULL); > + ASSERT (ScsiIo !=3D NULL); > + > + ZeroMem (&CommandPacket, sizeof > (EFI_SCSI_IO_SCSI_REQUEST_PACKET)); > + ZeroMem (Cdb, EFI_SCSI_OP_LENGTH_TWELVE); > + > + CommandPacket.Timeout =3D Timeout; > + CommandPacket.InDataBuffer =3D DataBuffer; > + CommandPacket.SenseData =3D SenseData; > + CommandPacket.InTransferLength =3D TransferLength; > + CommandPacket.Cdb =3D Cdb; > + // > + // Fill Cdb for Security Protocol In Command > + // > + Cdb[0] =3D EFI_SCSI_OP_SECURITY_PROTOCOL_IN; > + Cdb[1] =3D SecurityProtocol; > + WriteUnaligned16 ((UINT16 *)&Cdb[2], SwapBytes16 > (SecurityProtocolSpecific)); > + WriteUnaligned32 ((UINT32 *)&Cdb[6], SwapBytes32 (TransferLength)); > + > + CommandPacket.CdbLength =3D EFI_SCSI_OP_LENGTH_TWELVE; > + CommandPacket.DataDirection =3D EFI_SCSI_DATA_IN; > + CommandPacket.SenseDataLength =3D *SenseDataLength; > + > + Status =3D ScsiIo->ExecuteScsiCommand (ScsiIo, > &CommandPacket, NULL); > + > + *HostAdapterStatus =3D CommandPacket.HostAdapterStatus; > + *TargetStatus =3D CommandPacket.TargetStatus; > + *SenseDataLength =3D CommandPacket.SenseDataLength; > + *DataLength =3D 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 com= mand to > complete. > + If Timeout is greater than zero, then the command is executed and wil= l > timeout after > + Timeout 100 ns units. The StartLba and SectorSize parameters are use= d to > construct > + the CDB for this SCSI command. > + 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 DataLength 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 Speci= fic data. > + @param[in] TransferLength The size in bytes of the transfe= r 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 n= umber of bytes > transferred is returned in DataLength. > + @retval EFI_NOT_READY The SCSI Request Packet could no= t be > sent because there are too many > + SCSI Command Packets already que= ued. > + @retval EFI_DEVICE_ERROR A device error occurred while > attempting to send SCSI Request Packet. > + @retval EFI_UNSUPPORTED The command described by the SCS= I > Request Packet is not supported by > + the SCSI initiator(i.e., SCSI H= ost 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 UINT32 TransferLength, > + IN OUT VOID *DataBuffer OPTIONAL > + ) > +{ > + EFI_SCSI_IO_SCSI_REQUEST_PACKET CommandPacket; > + EFI_STATUS Status; > + UINT8 Cdb[EFI_SCSI_OP_LENGTH_TWELVE]; > + > + ASSERT (SenseDataLength !=3D NULL); > + ASSERT (HostAdapterStatus !=3D NULL); > + ASSERT (TargetStatus !=3D NULL); > + ASSERT (ScsiIo !=3D NULL); > + > + ZeroMem (&CommandPacket, sizeof > (EFI_SCSI_IO_SCSI_REQUEST_PACKET)); > + ZeroMem (Cdb, EFI_SCSI_OP_LENGTH_TWELVE); > + > + CommandPacket.Timeout =3D Timeout; > + CommandPacket.OutDataBuffer =3D DataBuffer; > + CommandPacket.SenseData =3D SenseData; > + CommandPacket.OutTransferLength =3D TransferLength; > + CommandPacket.Cdb =3D Cdb; > + // > + // Fill Cdb for Security Protocol Out Command > + // > + Cdb[0] =3D EFI_SCSI_OP_SECURITY_PROTOCOL_OUT; > + Cdb[1] =3D SecurityProtocol; > + WriteUnaligned16 ((UINT16 *)&Cdb[2], SwapBytes16 > (SecurityProtocolSpecific)); > + WriteUnaligned32 ((UINT32 *)&Cdb[6], SwapBytes32 (TransferLength)); > + > + CommandPacket.CdbLength =3D EFI_SCSI_OP_LENGTH_TWELVE; > + CommandPacket.DataDirection =3D EFI_SCSI_DATA_OUT; > + CommandPacket.SenseDataLength =3D *SenseDataLength; > + > + Status =3D ScsiIo->ExecuteScsiCommand (ScsiIo, > &CommandPacket, NULL); > + > + *HostAdapterStatus =3D CommandPacket.HostAdapterStatus; > + *TargetStatus =3D CommandPacket.TargetStatus; > + *SenseDataLength =3D 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. > -- > 2.16.2.windows.1 >=20 >=20 >=20