[edk2-devel] [PATCH] MdePkg: Update ReceiveData and SendData function description

Tan, Ming posted 1 patch 3 months, 2 weeks ago
Failed in applying to current master (apply log)
MdePkg/Include/Protocol/StorageSecurityCommand.h | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
[edk2-devel] [PATCH] MdePkg: Update ReceiveData and SendData function description
Posted by Tan, Ming 3 months, 2 weeks ago
From: Qingyu Shang <qingyu.shang@intel.com>

Refer to Uefi spec 2.10 section 13.14, update the parameter 'MediaId'
description for EFI_STORAGE_SECURITY_COMMAND_PROTOCOL function ReceiveData
and SendData.

Signed-off-by: Qingyu Shang <qingyu.shang@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Zhiguang Liu <zhiguang.liu@intel.com>
---
 MdePkg/Include/Protocol/StorageSecurityCommand.h | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/MdePkg/Include/Protocol/StorageSecurityCommand.h b/MdePkg/Include/Protocol/StorageSecurityCommand.h
index 810af59b85..206ae79aff 100644
--- a/MdePkg/Include/Protocol/StorageSecurityCommand.h
+++ b/MdePkg/Include/Protocol/StorageSecurityCommand.h
@@ -59,7 +59,9 @@ typedef struct _EFI_STORAGE_SECURITY_COMMAND_PROTOCOL EFI_STORAGE_SECURITY_COMMA
   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  MediaId                      ID of the medium to receive data from. If there is no
+                                       block IO protocol supported by the physical device, the
+                                       value of MediaId is undefined.
   @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
@@ -138,7 +140,9 @@ EFI_STATUS
   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  MediaId                      ID of the medium to receive data from. If there is no
+                                       block IO protocol supported by the physical device, the
+                                       value of MediaId is undefined.
   @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
-- 
2.39.1.windows.1



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#113588): https://edk2.groups.io/g/devel/message/113588
Mute This Topic: https://groups.io/mt/103658104/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-
Re: [edk2-devel] [PATCH] MdePkg: Update ReceiveData and SendData function description
Posted by Michael D Kinney 3 months ago
Hi Ming,

Please update the function headers for the following drivers that 
provide implementations of the Storage Security Command Protocol.

MdeModulePkg\Bus\Ata\AtaBusDxe\AtaBus.c:
  1485    @param  This                         Indicates a pointer to the calling context.
  1486:   @param  MediaId                      ID of the medium to receive data from.
  1487    @param  Timeout                      The timeout, in 100ns units, to use for the execution

  1602    @param  This                         Indicates a pointer to the calling context.
  1603:   @param  MediaId                      ID of the medium to receive data from.
  1604    @param  Timeout                      The timeout, in 100ns units, to use for the execution

MdeModulePkg\Bus\Ata\AtaBusDxe\AtaBus.h:
   929    @param  This                         Indicates a pointer to the calling context.
   930:   @param  MediaId                      ID of the medium to receive data from.
   931    @param  Timeout                      The timeout, in 100ns units, to use for the execution

  1009    @param  This                         Indicates a pointer to the calling context.
  1010:   @param  MediaId                      ID of the medium to receive data from.
  1011    @param  Timeout                      The timeout, in 100ns units, to use for the execution

MdeModulePkg\Bus\Pci\NvmExpressDxe\NvmExpressBlockIo.c:
  1701    @param  This                         Indicates a pointer to the calling context.
  1702:   @param  MediaId                      ID of the medium to receive data from.
  1703    @param  Timeout                      The timeout, in 100ns units, to use for the execution

  1814    @param  This                         Indicates a pointer to the calling context.
  1815:   @param  MediaId                      ID of the medium to receive data from.
  1816    @param  Timeout                      The timeout, in 100ns units, to use for the execution

MdeModulePkg\Bus\Pci\NvmExpressDxe\NvmExpressBlockIo.h:
  291    @param  This                         Indicates a pointer to the calling context.
  292:   @param  MediaId                      ID of the medium to receive data from.
  293    @param  Timeout                      The timeout, in 100ns units, to use for the execution

  371    @param  This                         Indicates a pointer to the calling context.
  372:   @param  MediaId                      ID of the medium to receive data from.
  373    @param  Timeout                      The timeout, in 100ns units, to use for the execution

MdeModulePkg\Bus\Scsi\ScsiDiskDxe\ScsiDisk.c:
  1899    @param  This                         Indicates a pointer to the calling context.
  1900:   @param  MediaId                      ID of the medium to receive data from.
  1901    @param  Timeout                      The timeout, in 100ns units, to use for the execution

  2121    @param  This                         Indicates a pointer to the calling context.
  2122:   @param  MediaId                      ID of the medium to receive data from.
  2123    @param  Timeout                      The timeout, in 100ns units, to use for the execution

MdeModulePkg\Bus\Scsi\ScsiDiskDxe\ScsiDisk.h:
  679    @param  This                         Indicates a pointer to the calling context.
  680:   @param  MediaId                      ID of the medium to receive data from.
  681    @param  Timeout                      The timeout, in 100ns units, to use for the execution

  753    @param  This                         Indicates a pointer to the calling context.
  754:   @param  MediaId                      ID of the medium to receive data from.
  755    @param  Timeout                      The timeout, in 100ns units, to use for the execution

MdeModulePkg\Bus\Sd\EmmcDxe\EmmcBlockIo.c:
  1269    @param[in]  This                         Indicates a pointer to the calling context.
  1270:   @param[in]  MediaId                      ID of the medium to receive data from.
  1271    @param[in]  Timeout                      The timeout, in 100ns units, to use for the execution

  1456    @param  This                         Indicates a pointer to the calling context.
  1457:   @param  MediaId                      ID of the medium to receive data from.
  1458    @param  Timeout                      The timeout, in 100ns units, to use for the execution

  1557    @param  This                         Indicates a pointer to the calling context.
  1558:   @param  MediaId                      ID of the medium to receive data from.
  1559    @param  Timeout                      The timeout, in 100ns units, to use for the execution

MdeModulePkg\Bus\Sd\EmmcDxe\EmmcBlockIo.h:
  252    @param[in]  This                         Indicates a pointer to the calling context.
  253:   @param[in]  MediaId                      ID of the medium to receive data from.
  254    @param[in]  Timeout                      The timeout, in 100ns units, to use for the execution

  339    @param  This                         Indicates a pointer to the calling context.
  340:   @param  MediaId                      ID of the medium to receive data from.
  341    @param  Timeout                      The timeout, in 100ns units, to use for the execution

  419    @param  This                         Indicates a pointer to the calling context.
  420:   @param  MediaId                      ID of the medium to receive data from.
  421    @param  Timeout                      The timeout, in 100ns units, to use for the execution

SecurityPkg\Tcg\Opal\OpalPassword\OpalPasswordPei.c:
   51    @param  This                         Indicates a pointer to the calling context.
   52:   @param  MediaId                      ID of the medium to receive data from.
   53    @param  Timeout                      The timeout, in 100ns units, to use for the execution

  150    @param  This                         Indicates a pointer to the calling context.
  151:   @param  MediaId                      ID of the medium to receive data from.
  152    @param  Timeout                      The timeout, in 100ns units, to use for the execution

Thanks,

Mike


> -----Original Message-----
> From: Tan, Ming <ming.tan@intel.com>
> Sent: Wednesday, January 10, 2024 11:26 PM
> To: devel@edk2.groups.io
> Cc: Shang, Qingyu <qingyu.shang@intel.com>; Kinney, Michael D
> <michael.d.kinney@intel.com>; Gao, Liming <gaoliming@byosoft.com.cn>;
> Liu, Zhiguang <zhiguang.liu@intel.com>
> Subject: [PATCH] MdePkg: Update ReceiveData and SendData function
> description
> 
> From: Qingyu Shang <qingyu.shang@intel.com>
> 
> Refer to Uefi spec 2.10 section 13.14, update the parameter 'MediaId'
> description for EFI_STORAGE_SECURITY_COMMAND_PROTOCOL function
> ReceiveData
> and SendData.
> 
> Signed-off-by: Qingyu Shang <qingyu.shang@intel.com>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Liming Gao <gaoliming@byosoft.com.cn>
> Cc: Zhiguang Liu <zhiguang.liu@intel.com>
> ---
>  MdePkg/Include/Protocol/StorageSecurityCommand.h | 8 ++++++--
>  1 file changed, 6 insertions(+), 2 deletions(-)
> 
> diff --git a/MdePkg/Include/Protocol/StorageSecurityCommand.h
> b/MdePkg/Include/Protocol/StorageSecurityCommand.h
> index 810af59b85..206ae79aff 100644
> --- a/MdePkg/Include/Protocol/StorageSecurityCommand.h
> +++ b/MdePkg/Include/Protocol/StorageSecurityCommand.h
> @@ -59,7 +59,9 @@ typedef struct _EFI_STORAGE_SECURITY_COMMAND_PROTOCOL
> EFI_STORAGE_SECURITY_COMMA
>    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  MediaId                      ID of the medium to receive data
> from. If there is no
> 
> +                                       block IO protocol supported by
> the physical device, the
> 
> +                                       value of MediaId is undefined.
> 
>    @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
> 
> @@ -138,7 +140,9 @@ EFI_STATUS
>    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  MediaId                      ID of the medium to receive data
> from. If there is no
> 
> +                                       block IO protocol supported by
> the physical device, the
> 
> +                                       value of MediaId is undefined.
> 
>    @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
> 
> --
> 2.39.1.windows.1



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#114239): https://edk2.groups.io/g/devel/message/114239
Mute This Topic: https://groups.io/mt/103658104/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/leave/3901457/1787277/102458076/xyzzy [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-