tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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
This commit is contained in:
jyao1 2014-03-01 12:25:31 +00:00 committed by jyao1
parent a4ab7df48f
commit 57a1b9c425
3 changed files with 18 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
MdeModulePkg/Library/PiDxeS3BootScriptLib/BootScriptSave.c
View File

@ -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.

7
MdePkg/Include/Library/S3BootScriptLib.h
View File

@ -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

7
MdePkg/Library/BaseS3BootScriptLibNull/BootScriptLib.c
View File

@ -278,7 +278,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.