summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorQingyu Shang <qingyu.shang@intel.com>2024-02-25 19:05:38 -0800
committermergify[bot] <37929162+mergify[bot]@users.noreply.github.com>2024-03-13 02:48:38 +0000
commit6f67ed45e03b554337daba2599a24b3352ad3438 (patch)
treeb8975bd8a4c27c3c433b0f07f1086f35f4831f7e
parenta8b80149e1e18b4dd2c5b8db36f4aae0c66f17ca (diff)
downloadedk2-6f67ed45e03b554337daba2599a24b3352ad3438.tar.gz
edk2-6f67ed45e03b554337daba2599a24b3352ad3438.tar.bz2
edk2-6f67ed45e03b554337daba2599a24b3352ad3438.zip
MdeModulePkg: Update ReceiveData and SendData function description
AtaBusDxe, NvmExpressDxe, ScsiDiskDxe and EmmcDxe is used to back the EFI_STORAGE_SECURITY_COMMAND_PROTOCOL, update the parameter 'MediaId' description for the protocol function ReceiveData and SendData as described in UEFI Spec 2.10 section 13.14. Cc: Liming Gao <gaoliming@byosoft.com.cn> Cc: Michael D Kinney <michael.d.kinney@intel.com> Signed-off-by: Qingyu Shang <qingyu.shang@intel.com> Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>
-rw-r--r--MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.c8
-rw-r--r--MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.h8
-rw-r--r--MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.c8
-rw-r--r--MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressBlockIo.h8
-rw-r--r--MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.c8
-rw-r--r--MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.h8
-rw-r--r--MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.c12
-rw-r--r--MdeModulePkg/Bus/Sd/EmmcDxe/EmmcBlockIo.h12
8 files changed, 54 insertions, 18 deletions
diff --git a/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.c b/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.c
index a729c087ff..67c6389bb8 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 6bc345f7e7..8906947e28 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 b6ed7f7031..e0a85c1cb3 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 8cad15efd3..5547e057e7 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 670f70caf4..e79110c14e 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 5a25b55c49..49a0040369 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 39b7c7ce6e..61fa740be5 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 2568f0359d..8c7e5d2675 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