MdePkg/ProcessorBind: add defines for page allocation granularity

[mirror_edk2.git] / MdePkg / Include / Protocol / S3SaveState.h

diff --git a/MdePkg/Include/Protocol/S3SaveState.h b/MdePkg/Include/Protocol/S3SaveState.h
index c56d083c89d010c407ce51e34d75bbb0f66e80ba..5a72dd860d65c48de015a03deaaa939750606c15 100644 (file)
--- a/MdePkg/Include/Protocol/S3SaveState.h
+++ b/MdePkg/Include/Protocol/S3SaveState.h
@@ -5,8 +5,8 @@
   to be replayed during an S3 resume.\r
   This protocol is not required for all platforms.\r
   \r
-  Copyright (c) 2009, Intel Corporation                                                         \r
-  All rights reserved. This program and the accompanying materials                          \r
+  Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>\r
+  This program and the accompanying materials                          \r
   are licensed and made available under the terms and conditions of the BSD License         \r
   which accompanies this distribution.  The full text of the license may be found at        \r
   http://opensource.org/licenses/bsd-license.php                                            \r
@@ -51,8 +51,8 @@ typedef struct _EFI_S3_SAVE_STATE_PROTOCOL  EFI_S3_SAVE_STATE_PROTOCOL;
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_S3_SAVE_STATE_WRITE)(\r
-   IN CONST struct _EFI_S3_SAVE_STATE_PROTOCOL  *This,\r
-   IN       UINT16                              OpCode,\r
+   IN CONST EFI_S3_SAVE_STATE_PROTOCOL  *This,\r
+   IN       UINT16                      OpCode,\r
    ...\r
 );\r
 \r
@@ -95,10 +95,10 @@ EFI_STATUS
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_S3_SAVE_STATE_INSERT)(\r
-   IN       struct _EFI_S3_SAVE_STATE_PROTOCOL  *This,\r
-   IN       BOOLEAN                             BeforeOrAfter,\r
-   IN OUT   EFI_S3_BOOT_SCRIPT_POSITION         *Position       OPTIONAL,\r
-   IN       UINT16                              OpCode,\r
+   IN CONST EFI_S3_SAVE_STATE_PROTOCOL  *This,\r
+   IN       BOOLEAN                     BeforeOrAfter,\r
+   IN OUT   EFI_S3_BOOT_SCRIPT_POSITION *Position       OPTIONAL,\r
+   IN       UINT16                      OpCode,\r
    ...\r
 );\r
 \r
@@ -125,18 +125,18 @@ EFI_STATUS
   \r
   @retval    EFI_SUCCESS              The label already exists or was inserted.\r
   @retval    EFI_NOT_FOUND            The label did not already exist and CreateifNotFound was FALSE.\r
-  @retval    EFI_INVALID_PARAMETER    The Opcode is an invalid opcode value.\r
+  @retval    EFI_INVALID_PARAMETER    The Label is NULL or points to an empty string.\r
   @retval    EFI_INVALID_PARAMETER    The Position is not a valid position in the boot script table.\r
   @retval    EFI_OUT_OF_RESOURCES     There is insufficient memory to store the boot script.\r
 **/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_S3_SAVE_STATE_LABEL)(\r
-   IN     struct _EFI_S3_SAVE_STATE_PROTOCOL    *This,\r
-   IN     BOOLEAN                               BeforeOrAfter,\r
-   IN     BOOLEAN                               CreateIfNotFound,\r
-   IN OUT EFI_S3_BOOT_SCRIPT_POSITION           *Position OPTIONAL,\r
-   IN     CONST CHAR8                           *Label\r
+   IN CONST  EFI_S3_SAVE_STATE_PROTOCOL      *This,\r
+   IN        BOOLEAN                         BeforeOrAfter,\r
+   IN        BOOLEAN                         CreateIfNotFound,\r
+   IN OUT    EFI_S3_BOOT_SCRIPT_POSITION     *Position OPTIONAL,\r
+   IN CONST  CHAR8                           *Label\r
 );\r
 \r
 /**\r
@@ -151,16 +151,17 @@ EFI_STATUS
   @param[in]    Position2           The positions in the boot script table to compare.\r
   @param[out]   RelativePosition    On return, points to the result of the comparison.\r
   \r
-  @retval   EFI_SUCCESS             The label already exists or was inserted.\r
+  @retval   EFI_SUCCESS             The operation succeeded.\r
   @retval   EFI_INVALID_PARAMETER   The Position1 or Position2 is not a valid position in the boot script table.\r
+  @retval   EFI_INVALID_PARAMETER   The RelativePosition is NULL.\r
 **/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_S3_SAVE_STATE_COMPARE)(\r
-   IN   struct _EFI_S3_SAVE_STATE_PROTOCOL  *This,\r
-   IN   EFI_S3_BOOT_SCRIPT_POSITION         Position1,\r
-   IN   EFI_S3_BOOT_SCRIPT_POSITION         Position2,\r
-   OUT  UINTN                               *RelativePosition\r
+   IN CONST EFI_S3_SAVE_STATE_PROTOCOL          *This,\r
+   IN       EFI_S3_BOOT_SCRIPT_POSITION         Position1,\r
+   IN       EFI_S3_BOOT_SCRIPT_POSITION         Position2,\r
+   OUT      UINTN                               *RelativePosition\r
 );\r
 \r
 struct _EFI_S3_SAVE_STATE_PROTOCOL {\r