summaryrefslogtreecommitdiff
path: root/MdePkg/Include/Library/S3BootScriptLib.h
diff options
context:
space:
mode:
Diffstat (limited to 'MdePkg/Include/Library/S3BootScriptLib.h')
-rw-r--r--MdePkg/Include/Library/S3BootScriptLib.h7
1 files changed, 6 insertions, 1 deletions
diff --git a/MdePkg/Include/Library/S3BootScriptLib.h b/MdePkg/Include/Library/S3BootScriptLib.h
index 1afb07c248..0a8cbe355a 100644
--- a/MdePkg/Include/Library/S3BootScriptLib.h
+++ b/MdePkg/Include/Library/S3BootScriptLib.h
@@ -316,7 +316,12 @@ S3BootScriptSaveDispatch (
/**
Adds a record for memory reads of the memory location and continues when the exit
criteria is satisfied, or after a defined duration.
-
+
+ Please aware, below interface is different with PI specification, Vol 5:
+ EFI_S3_SAVE_STATE_PROTOCOL.Write() for EFI_BOOT_SCRIPT_MEM_POLL_OPCODE.
+ "Duration" below is microseconds, while "Delay" in PI specification means
+ the number of 100ns units to poll.
+
@param[in] Width The width of the memory operations.
@param[in] Address The base address of the memory operations.
@param[in] BitMask A pointer to the bit mask to be AND-ed with the data read