From 57a1b9c4252985ee5d631340fed453e73e0c9146 Mon Sep 17 00:00:00 2001 From: jyao1 Date: Sat, 1 Mar 2014 12:25:31 +0000 Subject: Add comment for S3BootScriptSaveMemPoll API, since it does not match PI specification. Signed-off by: Jiewen Yao Reviewed by: Star Zeng Contributed-under: TianoCore Contribution Agreement 1.0 git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15280 6f19259b-4bc3-4df7-8a09-765794883524 --- MdePkg/Include/Library/S3BootScriptLib.h | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'MdePkg/Include') 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 -- cgit v1.2.3