public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
* [edk2-devel] [PATCH] MdePkg: Update ReceiveData and SendData function description
@ 2024-01-11  7:26 Tan, Ming
  2024-01-23 23:15 ` Michael D Kinney
  0 siblings, 1 reply; 6+ messages in thread
From: Tan, Ming @ 2024-01-11  7:26 UTC (permalink / raw)
  To: devel; +Cc: Qingyu Shang, Michael D Kinney, Liming Gao, Zhiguang Liu

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/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-



^ permalink raw reply related	[flat|nested] 6+ messages in thread

* Re: [edk2-devel] [PATCH] MdePkg: Update ReceiveData and SendData function description
  2024-01-11  7:26 [edk2-devel] [PATCH] MdePkg: Update ReceiveData and SendData function description Tan, Ming
@ 2024-01-23 23:15 ` Michael D Kinney
  2024-01-30  4:58   ` [edk2-devel] [PATCH v2 1/1] " Qingyu
  2024-01-30  8:53   ` [edk2-devel] [PATCH v3 " Qingyu
  0 siblings, 2 replies; 6+ messages in thread
From: Michael D Kinney @ 2024-01-23 23:15 UTC (permalink / raw)
  To: Tan, Ming, devel@edk2.groups.io
  Cc: Shang, Qingyu, Gao, Liming, Liu, Zhiguang, Kinney, Michael D

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/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/leave/12367111/7686176/1913456212/xyzzy [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-



^ permalink raw reply	[flat|nested] 6+ messages in thread

* [edk2-devel] [PATCH v2 1/1] MdePkg: Update ReceiveData and SendData function description
  2024-01-23 23:15 ` Michael D Kinney
@ 2024-01-30  4:58   ` Qingyu
  2024-01-30 17:43     ` Michael D Kinney
  2024-01-30  8:53   ` [edk2-devel] [PATCH v3 " Qingyu
  1 sibling, 1 reply; 6+ messages in thread
From: Qingyu @ 2024-01-30  4:58 UTC (permalink / raw)
  To: devel; +Cc: Qingyu Shang, Tan, Ming, Li, Yi1

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.

Cc: Tan, Ming <ming.tan@intel.com>
Cc: Li, Yi1 <yi1.li@intel.com>
Signed-off-by: Qingyu Shang <qingyu.shang@intel.com>
---
 MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.c              |  8 ++++++--
 MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.h              |  8 ++++++--
 .../Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.c        |  8 ++++++--
 .../Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.h        |  8 ++++++--
 MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.c         |  8 ++++++--
 MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.h         |  8 ++++++--
 MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.c            | 12 +++++++++---
 MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.h            | 12 +++++++++---
 MdePkg/Include/Protocol/StorageSecurityCommand.h     |  8 ++++++--
 SecurityPkg/Tcg/Opal/OpalPassword/OpalPasswordPei.c  |  8 ++++++--
 10 files changed, 66 insertions(+), 22 deletions(-)

diff --git a/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.c b/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.c
index a729c087ff5a..67c6389bb8b3 100644
--- a/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.c
+++ b/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.c
@@ -1483,7 +1483,9 @@ AtaDiskInfoWhichIde (
   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
@@ -1600,7 +1602,9 @@ AtaStorageSecurityReceiveData (
   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
diff --git a/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.h b/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.h
index 6bc345f7e777..8906947e28b3 100644
--- a/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.h
+++ b/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.h
@@ -927,7 +927,9 @@ AtaDiskInfoWhichIde (
   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
@@ -1007,7 +1009,9 @@ AtaStorageSecurityReceiveData (
   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
diff --git a/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.c b/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.c
index b6ed7f7031b3..e0a85c1cb34e 100644
--- a/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.c
+++ b/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.c
@@ -1699,7 +1699,9 @@ TrustTransferNvmeDevice (
   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
@@ -1812,7 +1814,9 @@ NvmeStorageSecurityReceiveData (
   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
diff --git a/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.h b/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.h
index 8cad15efd33a..5547e057e77a 100644
--- a/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.h
+++ b/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.h
@@ -289,7 +289,9 @@ NvmeBlockIoFlushBlocksEx (
   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
@@ -369,7 +371,9 @@ NvmeStorageSecurityReceiveData (
   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
diff --git a/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.c b/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.c
index 670f70caf41f..e79110c14e11 100644
--- a/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.c
+++ b/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.c
@@ -1897,7 +1897,9 @@ Done:
   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
@@ -2119,7 +2121,9 @@ Done:
   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
diff --git a/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.h b/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.h
index 5a25b55c4952..49a00403695f 100644
--- a/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.h
+++ b/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.h
@@ -677,7 +677,9 @@ ScsiDiskEraseBlocks (
   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
@@ -751,7 +753,9 @@ ScsiDiskReceiveData (
   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
diff --git a/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.c b/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.c
index 39b7c7ce6ef1..61fa740be505 100644
--- a/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.c
+++ b/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.c
@@ -1267,7 +1267,9 @@ EmmcFlushBlocksEx (
   function shall return EFI_DEVICE_ERROR.
 
   @param[in]  This                         Indicates a pointer to the calling context.
-  @param[in]  MediaId                      ID of the medium to receive data from.
+  @param[in]  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[in]  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
@@ -1454,7 +1456,9 @@ EmmcSecurityProtocolInOut (
   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
@@ -1555,7 +1559,9 @@ EmmcSecurityProtocolIn (
   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
diff --git a/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.h b/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.h
index 2568f0359df3..8c7e5d2675ff 100644
--- a/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.h
+++ b/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.h
@@ -250,7 +250,9 @@ EmmcFlushBlocksEx (
   function shall return EFI_DEVICE_ERROR.
 
   @param[in]  This                         Indicates a pointer to the calling context.
-  @param[in]  MediaId                      ID of the medium to receive data from.
+  @param[in]  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[in]  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
@@ -337,7 +339,9 @@ EmmcSecurityProtocolInOut (
   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
@@ -417,7 +421,9 @@ EmmcSecurityProtocolIn (
   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
diff --git a/MdePkg/Include/Protocol/StorageSecurityCommand.h b/MdePkg/Include/Protocol/StorageSecurityCommand.h
index 810af59b85c3..206ae79aff8d 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
diff --git a/SecurityPkg/Tcg/Opal/OpalPassword/OpalPasswordPei.c b/SecurityPkg/Tcg/Opal/OpalPassword/OpalPasswordPei.c
index 0fb6b1bf41d5..1ee55105e435 100644
--- a/SecurityPkg/Tcg/Opal/OpalPassword/OpalPasswordPei.c
+++ b/SecurityPkg/Tcg/Opal/OpalPassword/OpalPasswordPei.c
@@ -49,7 +49,9 @@ EFI_GUID  mOpalDeviceLockBoxGuid = OPAL_DEVICE_LOCKBOX_GUID;
   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
@@ -148,7 +150,9 @@ SecurityReceiveData (
   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 (#114797): https://edk2.groups.io/g/devel/message/114797
Mute This Topic: https://groups.io/mt/104056966/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-



^ permalink raw reply related	[flat|nested] 6+ messages in thread

* [edk2-devel] [PATCH v3 1/1] MdePkg: Update ReceiveData and SendData function description
  2024-01-23 23:15 ` Michael D Kinney
  2024-01-30  4:58   ` [edk2-devel] [PATCH v2 1/1] " Qingyu
@ 2024-01-30  8:53   ` Qingyu
  2024-01-30 17:58     ` Michael D Kinney
  1 sibling, 1 reply; 6+ messages in thread
From: Qingyu @ 2024-01-30  8:53 UTC (permalink / raw)
  To: michael.d.kinney, devel
  Cc: Qingyu Shang, Tan, Ming, Li, Yi1, Liming Gao, Zhiguang Liu

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.

Cc: Tan, Ming <ming.tan@intel.com>
Cc: Li, Yi1 <yi1.li@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>
Signed-off-by: Qingyu Shang <qingyu.shang@intel.com>
---
 MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.c              |  8 ++++++--
 MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.h              |  8 ++++++--
 .../Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.c        |  8 ++++++--
 .../Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.h        |  8 ++++++--
 MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.c         |  8 ++++++--
 MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.h         |  8 ++++++--
 MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.c            | 12 +++++++++---
 MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.h            | 12 +++++++++---
 MdePkg/Include/Protocol/StorageSecurityCommand.h     |  8 ++++++--
 SecurityPkg/Tcg/Opal/OpalPassword/OpalPasswordPei.c  |  8 ++++++--
 10 files changed, 66 insertions(+), 22 deletions(-)

diff --git a/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.c b/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.c
index a729c087ff5a..67c6389bb8b3 100644
--- a/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.c
+++ b/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.c
@@ -1483,7 +1483,9 @@ AtaDiskInfoWhichIde (
   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
@@ -1600,7 +1602,9 @@ AtaStorageSecurityReceiveData (
   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
diff --git a/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.h b/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.h
index 6bc345f7e777..8906947e28b3 100644
--- a/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.h
+++ b/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.h
@@ -927,7 +927,9 @@ AtaDiskInfoWhichIde (
   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
@@ -1007,7 +1009,9 @@ AtaStorageSecurityReceiveData (
   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
diff --git a/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.c b/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.c
index b6ed7f7031b3..e0a85c1cb34e 100644
--- a/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.c
+++ b/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.c
@@ -1699,7 +1699,9 @@ TrustTransferNvmeDevice (
   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
@@ -1812,7 +1814,9 @@ NvmeStorageSecurityReceiveData (
   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
diff --git a/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.h b/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.h
index 8cad15efd33a..5547e057e77a 100644
--- a/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.h
+++ b/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.h
@@ -289,7 +289,9 @@ NvmeBlockIoFlushBlocksEx (
   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
@@ -369,7 +371,9 @@ NvmeStorageSecurityReceiveData (
   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
diff --git a/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.c b/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.c
index 670f70caf41f..e79110c14e11 100644
--- a/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.c
+++ b/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.c
@@ -1897,7 +1897,9 @@ Done:
   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
@@ -2119,7 +2121,9 @@ Done:
   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
diff --git a/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.h b/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.h
index 5a25b55c4952..49a00403695f 100644
--- a/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.h
+++ b/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.h
@@ -677,7 +677,9 @@ ScsiDiskEraseBlocks (
   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
@@ -751,7 +753,9 @@ ScsiDiskReceiveData (
   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
diff --git a/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.c b/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.c
index 39b7c7ce6ef1..61fa740be505 100644
--- a/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.c
+++ b/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.c
@@ -1267,7 +1267,9 @@ EmmcFlushBlocksEx (
   function shall return EFI_DEVICE_ERROR.
 
   @param[in]  This                         Indicates a pointer to the calling context.
-  @param[in]  MediaId                      ID of the medium to receive data from.
+  @param[in]  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[in]  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
@@ -1454,7 +1456,9 @@ EmmcSecurityProtocolInOut (
   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
@@ -1555,7 +1559,9 @@ EmmcSecurityProtocolIn (
   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
diff --git a/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.h b/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.h
index 2568f0359df3..8c7e5d2675ff 100644
--- a/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.h
+++ b/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.h
@@ -250,7 +250,9 @@ EmmcFlushBlocksEx (
   function shall return EFI_DEVICE_ERROR.
 
   @param[in]  This                         Indicates a pointer to the calling context.
-  @param[in]  MediaId                      ID of the medium to receive data from.
+  @param[in]  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[in]  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
@@ -337,7 +339,9 @@ EmmcSecurityProtocolInOut (
   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
@@ -417,7 +421,9 @@ EmmcSecurityProtocolIn (
   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
diff --git a/MdePkg/Include/Protocol/StorageSecurityCommand.h b/MdePkg/Include/Protocol/StorageSecurityCommand.h
index 810af59b85c3..206ae79aff8d 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
diff --git a/SecurityPkg/Tcg/Opal/OpalPassword/OpalPasswordPei.c b/SecurityPkg/Tcg/Opal/OpalPassword/OpalPasswordPei.c
index 0fb6b1bf41d5..1ee55105e435 100644
--- a/SecurityPkg/Tcg/Opal/OpalPassword/OpalPasswordPei.c
+++ b/SecurityPkg/Tcg/Opal/OpalPassword/OpalPasswordPei.c
@@ -49,7 +49,9 @@ EFI_GUID  mOpalDeviceLockBoxGuid = OPAL_DEVICE_LOCKBOX_GUID;
   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
@@ -148,7 +150,9 @@ SecurityReceiveData (
   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 (#114800): https://edk2.groups.io/g/devel/message/114800
Mute This Topic: https://groups.io/mt/104056979/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-



^ permalink raw reply related	[flat|nested] 6+ messages in thread

* Re: [edk2-devel] [PATCH v2 1/1] MdePkg: Update ReceiveData and SendData function description
  2024-01-30  4:58   ` [edk2-devel] [PATCH v2 1/1] " Qingyu
@ 2024-01-30 17:43     ` Michael D Kinney
  0 siblings, 0 replies; 6+ messages in thread
From: Michael D Kinney @ 2024-01-30 17:43 UTC (permalink / raw)
  To: devel@edk2.groups.io, Shang, Qingyu; +Cc: Tan, Ming, Li, Yi1, Kinney, Michael D

Hi Qingyu,

Please split patch so there is one patch per package and 
make sure the commit message for each commit has Cc: lines
for the maintainers of the associated package.

Thanks,

Mike

> -----Original Message-----
> From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Qingyu
> Sent: Monday, January 29, 2024 8:59 PM
> To: devel@edk2.groups.io
> Cc: Shang, Qingyu <qingyu.shang@intel.com>; Tan; Tan, Ming
> <ming.tan@intel.com>; Li; Li, Yi1 <yi1.li@intel.com>
> Subject: [edk2-devel] [PATCH v2 1/1] 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.
> 
> Cc: Tan, Ming <ming.tan@intel.com>
> Cc: Li, Yi1 <yi1.li@intel.com>
> Signed-off-by: Qingyu Shang <qingyu.shang@intel.com>
> ---
>  MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.c              |  8 ++++++--
>  MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.h              |  8 ++++++--
>  .../Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.c        |  8 ++++++--
>  .../Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.h        |  8 ++++++--
>  MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.c         |  8 ++++++--
>  MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.h         |  8 ++++++--
>  MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.c            | 12 +++++++++---
>  MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.h            | 12 +++++++++---
>  MdePkg/Include/Protocol/StorageSecurityCommand.h     |  8 ++++++--
>  SecurityPkg/Tcg/Opal/OpalPassword/OpalPasswordPei.c  |  8 ++++++--
>  10 files changed, 66 insertions(+), 22 deletions(-)
> 
> diff --git a/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.c
> b/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.c
> index a729c087ff5a..67c6389bb8b3 100644
> --- a/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.c
> +++ b/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.c
> @@ -1483,7 +1483,9 @@ AtaDiskInfoWhichIde (
>    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
> @@ -1600,7 +1602,9 @@ AtaStorageSecurityReceiveData (
>    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
> diff --git a/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.h
> b/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.h
> index 6bc345f7e777..8906947e28b3 100644
> --- a/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.h
> +++ b/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.h
> @@ -927,7 +927,9 @@ AtaDiskInfoWhichIde (
>    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
> @@ -1007,7 +1009,9 @@ AtaStorageSecurityReceiveData (
>    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
> diff --git a/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.c
> b/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.c
> index b6ed7f7031b3..e0a85c1cb34e 100644
> --- a/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.c
> +++ b/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.c
> @@ -1699,7 +1699,9 @@ TrustTransferNvmeDevice (
>    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
> @@ -1812,7 +1814,9 @@ NvmeStorageSecurityReceiveData (
>    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
> diff --git a/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.h
> b/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.h
> index 8cad15efd33a..5547e057e77a 100644
> --- a/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.h
> +++ b/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.h
> @@ -289,7 +289,9 @@ NvmeBlockIoFlushBlocksEx (
>    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
> @@ -369,7 +371,9 @@ NvmeStorageSecurityReceiveData (
>    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
> diff --git a/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.c
> b/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.c
> index 670f70caf41f..e79110c14e11 100644
> --- a/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.c
> +++ b/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.c
> @@ -1897,7 +1897,9 @@ Done:
>    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
> @@ -2119,7 +2121,9 @@ Done:
>    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
> diff --git a/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.h
> b/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.h
> index 5a25b55c4952..49a00403695f 100644
> --- a/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.h
> +++ b/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.h
> @@ -677,7 +677,9 @@ ScsiDiskEraseBlocks (
>    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
> @@ -751,7 +753,9 @@ ScsiDiskReceiveData (
>    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
> diff --git a/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.c
> b/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.c
> index 39b7c7ce6ef1..61fa740be505 100644
> --- a/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.c
> +++ b/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.c
> @@ -1267,7 +1267,9 @@ EmmcFlushBlocksEx (
>    function shall return EFI_DEVICE_ERROR.
> 
>    @param[in]  This                         Indicates a pointer to the
> calling context.
> -  @param[in]  MediaId                      ID of the medium to receive
> data from.
> +  @param[in]  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[in]  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
> @@ -1454,7 +1456,9 @@ EmmcSecurityProtocolInOut (
>    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
> @@ -1555,7 +1559,9 @@ EmmcSecurityProtocolIn (
>    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
> diff --git a/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.h
> b/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.h
> index 2568f0359df3..8c7e5d2675ff 100644
> --- a/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.h
> +++ b/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.h
> @@ -250,7 +250,9 @@ EmmcFlushBlocksEx (
>    function shall return EFI_DEVICE_ERROR.
> 
>    @param[in]  This                         Indicates a pointer to the
> calling context.
> -  @param[in]  MediaId                      ID of the medium to receive
> data from.
> +  @param[in]  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[in]  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
> @@ -337,7 +339,9 @@ EmmcSecurityProtocolInOut (
>    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
> @@ -417,7 +421,9 @@ EmmcSecurityProtocolIn (
>    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
> diff --git a/MdePkg/Include/Protocol/StorageSecurityCommand.h
> b/MdePkg/Include/Protocol/StorageSecurityCommand.h
> index 810af59b85c3..206ae79aff8d 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
> diff --git a/SecurityPkg/Tcg/Opal/OpalPassword/OpalPasswordPei.c
> b/SecurityPkg/Tcg/Opal/OpalPassword/OpalPasswordPei.c
> index 0fb6b1bf41d5..1ee55105e435 100644
> --- a/SecurityPkg/Tcg/Opal/OpalPassword/OpalPasswordPei.c
> +++ b/SecurityPkg/Tcg/Opal/OpalPassword/OpalPasswordPei.c
> @@ -49,7 +49,9 @@ EFI_GUID  mOpalDeviceLockBoxGuid =
> OPAL_DEVICE_LOCKBOX_GUID;
>    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
> @@ -148,7 +150,9 @@ SecurityReceiveData (
>    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 (#114807): https://edk2.groups.io/g/devel/message/114807
Mute This Topic: https://groups.io/mt/104056966/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/leave/12367111/7686176/1913456212/xyzzy [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-



^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [edk2-devel] [PATCH v3 1/1] MdePkg: Update ReceiveData and SendData function description
  2024-01-30  8:53   ` [edk2-devel] [PATCH v3 " Qingyu
@ 2024-01-30 17:58     ` Michael D Kinney
  0 siblings, 0 replies; 6+ messages in thread
From: Michael D Kinney @ 2024-01-30 17:58 UTC (permalink / raw)
  To: Shang, Qingyu, devel@edk2.groups.io
  Cc: Tan, Ming, Li, Yi1, Liming Gao, Liu, Zhiguang, Kinney, Michael D

I see V2 was received after V3.

Which one is correct?

Also, same comments I have for V2 to split up based on packages applies to V3.

I also see some issues with the current Cc email addresses.

Please do not use ',' separated names for commit message tag email addresses.

Mike

> -----Original Message-----
> From: Shang, Qingyu <qingyu.shang@intel.com>
> Sent: Tuesday, January 30, 2024 12:53 AM
> To: Kinney, Michael D <michael.d.kinney@intel.com>; devel@edk2.groups.io
> Cc: Shang, Qingyu <qingyu.shang@intel.com>; Tan; Tan, Ming
> <ming.tan@intel.com>; Li; Li, Yi1 <yi1.li@intel.com>; Liming Gao
> <gaoliming@byosoft.com.cn>; Liu, Zhiguang <zhiguang.liu@intel.com>
> Subject: [PATCH v3 1/1] 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.
> 
> Cc: Tan, Ming <ming.tan@intel.com>
> Cc: Li, Yi1 <yi1.li@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>
> Signed-off-by: Qingyu Shang <qingyu.shang@intel.com>
> ---
>  MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.c              |  8 ++++++--
>  MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.h              |  8 ++++++--
>  .../Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.c        |  8 ++++++--
>  .../Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.h        |  8 ++++++--
>  MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.c         |  8 ++++++--
>  MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.h         |  8 ++++++--
>  MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.c            | 12 +++++++++---
>  MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.h            | 12 +++++++++---
>  MdePkg/Include/Protocol/StorageSecurityCommand.h     |  8 ++++++--
>  SecurityPkg/Tcg/Opal/OpalPassword/OpalPasswordPei.c  |  8 ++++++--
>  10 files changed, 66 insertions(+), 22 deletions(-)
> 
> diff --git a/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.c
> b/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.c
> index a729c087ff5a..67c6389bb8b3 100644
> --- a/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.c
> +++ b/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.c
> @@ -1483,7 +1483,9 @@ AtaDiskInfoWhichIde (
>    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
> @@ -1600,7 +1602,9 @@ AtaStorageSecurityReceiveData (
>    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
> diff --git a/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.h
> b/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.h
> index 6bc345f7e777..8906947e28b3 100644
> --- a/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.h
> +++ b/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.h
> @@ -927,7 +927,9 @@ AtaDiskInfoWhichIde (
>    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
> @@ -1007,7 +1009,9 @@ AtaStorageSecurityReceiveData (
>    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
> diff --git a/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.c
> b/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.c
> index b6ed7f7031b3..e0a85c1cb34e 100644
> --- a/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.c
> +++ b/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.c
> @@ -1699,7 +1699,9 @@ TrustTransferNvmeDevice (
>    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
> @@ -1812,7 +1814,9 @@ NvmeStorageSecurityReceiveData (
>    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
> diff --git a/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.h
> b/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.h
> index 8cad15efd33a..5547e057e77a 100644
> --- a/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.h
> +++ b/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.h
> @@ -289,7 +289,9 @@ NvmeBlockIoFlushBlocksEx (
>    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
> @@ -369,7 +371,9 @@ NvmeStorageSecurityReceiveData (
>    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
> diff --git a/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.c
> b/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.c
> index 670f70caf41f..e79110c14e11 100644
> --- a/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.c
> +++ b/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.c
> @@ -1897,7 +1897,9 @@ Done:
>    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
> @@ -2119,7 +2121,9 @@ Done:
>    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
> diff --git a/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.h
> b/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.h
> index 5a25b55c4952..49a00403695f 100644
> --- a/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.h
> +++ b/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.h
> @@ -677,7 +677,9 @@ ScsiDiskEraseBlocks (
>    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
> @@ -751,7 +753,9 @@ ScsiDiskReceiveData (
>    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
> diff --git a/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.c
> b/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.c
> index 39b7c7ce6ef1..61fa740be505 100644
> --- a/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.c
> +++ b/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.c
> @@ -1267,7 +1267,9 @@ EmmcFlushBlocksEx (
>    function shall return EFI_DEVICE_ERROR.
> 
>    @param[in]  This                         Indicates a pointer to the
> calling context.
> -  @param[in]  MediaId                      ID of the medium to receive
> data from.
> +  @param[in]  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[in]  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
> @@ -1454,7 +1456,9 @@ EmmcSecurityProtocolInOut (
>    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
> @@ -1555,7 +1559,9 @@ EmmcSecurityProtocolIn (
>    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
> diff --git a/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.h
> b/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.h
> index 2568f0359df3..8c7e5d2675ff 100644
> --- a/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.h
> +++ b/MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.h
> @@ -250,7 +250,9 @@ EmmcFlushBlocksEx (
>    function shall return EFI_DEVICE_ERROR.
> 
>    @param[in]  This                         Indicates a pointer to the
> calling context.
> -  @param[in]  MediaId                      ID of the medium to receive
> data from.
> +  @param[in]  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[in]  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
> @@ -337,7 +339,9 @@ EmmcSecurityProtocolInOut (
>    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
> @@ -417,7 +421,9 @@ EmmcSecurityProtocolIn (
>    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
> diff --git a/MdePkg/Include/Protocol/StorageSecurityCommand.h
> b/MdePkg/Include/Protocol/StorageSecurityCommand.h
> index 810af59b85c3..206ae79aff8d 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
> diff --git a/SecurityPkg/Tcg/Opal/OpalPassword/OpalPasswordPei.c
> b/SecurityPkg/Tcg/Opal/OpalPassword/OpalPasswordPei.c
> index 0fb6b1bf41d5..1ee55105e435 100644
> --- a/SecurityPkg/Tcg/Opal/OpalPassword/OpalPasswordPei.c
> +++ b/SecurityPkg/Tcg/Opal/OpalPassword/OpalPasswordPei.c
> @@ -49,7 +49,9 @@ EFI_GUID  mOpalDeviceLockBoxGuid =
> OPAL_DEVICE_LOCKBOX_GUID;
>    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
> @@ -148,7 +150,9 @@ SecurityReceiveData (
>    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 (#114811): https://edk2.groups.io/g/devel/message/114811
Mute This Topic: https://groups.io/mt/104056979/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/leave/12367111/7686176/1913456212/xyzzy [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-



^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2024-01-30 17:58 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-01-11  7:26 [edk2-devel] [PATCH] MdePkg: Update ReceiveData and SendData function description Tan, Ming
2024-01-23 23:15 ` Michael D Kinney
2024-01-30  4:58   ` [edk2-devel] [PATCH v2 1/1] " Qingyu
2024-01-30 17:43     ` Michael D Kinney
2024-01-30  8:53   ` [edk2-devel] [PATCH v3 " Qingyu
2024-01-30 17:58     ` Michael D Kinney

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox