Add comment for S3BootScriptSaveMemPoll API, since it does not match PI specification.

[mirror_edk2.git] / MdePkg / Include / Library / S3BootScriptLib.h

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