ArmPlatformPkg: Fix stack switch bug after commit 7945b29

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

diff --git a/MdePkg/Include/Library/S3BootScriptLib.h b/MdePkg/Include/Library/S3BootScriptLib.h
index 2fabaa9f894c666791195722bd0f5fe99f37fafc..0a8cbe355aff6790d322c2b6f04d460cab6678a2 100644 (file)
--- a/MdePkg/Include/Library/S3BootScriptLib.h
+++ b/MdePkg/Include/Library/S3BootScriptLib.h
@@ -5,7 +5,7 @@
   be provided in the Framework version library instance, which means some of these \r
   APIs cannot be used if the underlying firmware is Framework and not PI.\r
 \r
-  Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r
 \r
   This program and the accompanying materials\r
   are licensed and made available under the terms and conditions\r
@@ -281,7 +281,7 @@ S3BootScriptSaveStall (
   );\r
 \r
 /**\r
-  Adds a record for an execution stall on the processor into a specified boot script table.\r
+  Adds a record for dispatching specified arbitrary code into a specified boot script table.\r
 \r
   @param[in] EntryPoint   The entry point of the code to be dispatched.\r
   @param[in] Context      The argument to be passed into the EntryPoint of the code \r
@@ -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
@@ -348,7 +353,6 @@ S3BootScriptSaveMemPoll (
   @param[in] InformationLength   Length of the data in bytes\r
   @param[in] Information        Information to be logged in the boot scrpit\r
  \r
-  @retval RETURN_UNSUPPORTED        In runtime, this method is not supported.\r
   @retval RETURN_OUT_OF_RESOURCES   Not enough memory for the table to perform \r
                                     the operation.\r
   @retval RETURN_SUCCESS            The opcode was added.\r
@@ -461,7 +465,6 @@ S3BootScriptSavePci2Poll (
   @param[in] String   The Null-terminated ASCII string to store into the S3 boot \r
                       script table.\r
 \r
-  @retval RETURN_UNSUPPORTED        In runtime, this method is not supported.\r
   @retval RETURN_OUT_OF_RESOURCES   Not enough memory for the table to perform \r
                                     the operation.\r
   @retval RETURN_SUCCESS            The opcode was added.\r
@@ -494,7 +497,7 @@ S3BootScriptSaveInformationAsciiString (
   for figuring out how to get the script to run on an S3 resume because the boot script \r
   maintained by the lib will be destroyed.\r
  \r
-  @return the base address of the new copy of the boot script tble.   \r
+  @return the base address of the new copy of the boot script table.   \r
 \r
 **/\r
 UINT8*\r