diff options
author | jyao1 <jyao1> | 2014-03-01 12:25:31 +0000 |
---|---|---|
committer | jyao1 <jyao1@6f19259b-4bc3-4df7-8a09-765794883524> | 2014-03-01 12:25:31 +0000 |
commit | 57a1b9c4252985ee5d631340fed453e73e0c9146 (patch) | |
tree | 6e80a87269d3e23a5b895c7d8803541d8898ce93 /MdeModulePkg/Library | |
parent | a4ab7df48fbb4d953b7ddc6d27b5bf9a0502fa64 (diff) | |
download | edk2-platforms-57a1b9c4252985ee5d631340fed453e73e0c9146.tar.xz |
Add comment for S3BootScriptSaveMemPoll API, since it does not match PI specification.
Signed-off by: Jiewen Yao <Jiewen.yao@intel.com>
Reviewed by: Star Zeng <Star.Zeng@intel.com>
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
Diffstat (limited to 'MdeModulePkg/Library')
-rw-r--r-- | MdeModulePkg/Library/PiDxeS3BootScriptLib/BootScriptSave.c | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/MdeModulePkg/Library/PiDxeS3BootScriptLib/BootScriptSave.c b/MdeModulePkg/Library/PiDxeS3BootScriptLib/BootScriptSave.c index eab1b4180f..739990679b 100644 --- a/MdeModulePkg/Library/PiDxeS3BootScriptLib/BootScriptSave.c +++ b/MdeModulePkg/Library/PiDxeS3BootScriptLib/BootScriptSave.c @@ -1380,7 +1380,12 @@ S3BootScriptSaveDispatch2 ( /**
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 Width The width of the memory operations.
@param Address The base address of the memory operations.
@param BitMask A pointer to the bit mask to be AND-ed with the data read from the register.
|