From: Qingyu <qingyu.shang@intel.com>
To: devel@edk2.groups.io
Cc: Qingyu Shang <qingyu.shang@intel.com>,
Tan, Ming <ming.tan@intel.com>, Li, Yi1 <yi1.li@intel.com>
Subject: [edk2-devel] [PATCH v2 1/1] MdePkg: Update ReceiveData and SendData function description
Date: Tue, 30 Jan 2024 12:58:43 +0800 [thread overview]
Message-ID: <592acf92fa66c6fbfc7d9268ec7c8d4cfe6bad87.1706585875.git.qingyu.shang@intel.com> (raw)
In-Reply-To: <CO1PR11MB492950FD56475A2ABACB87C3D2742@CO1PR11MB4929.namprd11.prod.outlook.com>
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]
-=-=-=-=-=-=-=-=-=-=-=-
next prev parent reply other threads:[~2024-01-30 16:31 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
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 ` Qingyu [this message]
2024-01-30 17:43 ` [edk2-devel] [PATCH v2 1/1] " Michael D Kinney
2024-01-30 8:53 ` [edk2-devel] [PATCH v3 " Qingyu
2024-01-30 17:58 ` Michael D Kinney
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-list from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=592acf92fa66c6fbfc7d9268ec7c8d4cfe6bad87.1706585875.git.qingyu.shang@intel.com \
--to=devel@edk2.groups.io \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox