Clean up to update the reference of the these macros:

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / AcpiS3Save.h

diff --git a/IntelFrameworkPkg/Include/Protocol/AcpiS3Save.h b/IntelFrameworkPkg/Include/Protocol/AcpiS3Save.h
index 1571e3dcd2c235eb920986311b64303ffd2f2839..182e388e90bba8c1b04bd881fe1958f6c43dab32 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/AcpiS3Save.h
+++ b/IntelFrameworkPkg/Include/Protocol/AcpiS3Save.h
@@ -1,25 +1,23 @@
-/*++\r
-\r
-Copyright (c) 2006, Intel Corporation                                                         \r
-All rights reserved. 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
-                                                                                          \r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
-\r
-Module Name:\r
+/** @file\r
+  This protocol is used to prepare all information that is needed for the S3 resume boot path. This\r
+  protocol is not required for all platforms.\r
+  This protocol is defined in framework S3Resume v0.9, page 21.\r
+  \r
+Copyright (c) 2006, Intel Corporation\r
+All rights reserved. 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
 \r
-  AcpiS3Save.h\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-Abstract:\r
+**/\r
 \r
-  \r
---*/\r
+#ifndef _ACPI_S3_SAVE_PROTOCOL_H_\r
+#define _ACPI_S3_SAVE_PROTOCOL_H_\r
 \r
-#ifndef _ACPI_S3_SAVE_PROTOCOL_H\r
-#define _ACPI_S3_SAVE_PROTOCOL_H\r
+#include <PiDxe.h>\r
 \r
 //\r
 // Forward reference for pure ANSI compatability\r
@@ -39,14 +37,14 @@ typedef struct _EFI_ACPI_S3_SAVE_PROTOCOL EFI_ACPI_S3_SAVE_PROTOCOL;
 //\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_ACPI_S3_SAVE) (\r
+(EFIAPI *EFI_ACPI_S3_SAVE)(\r
   IN EFI_ACPI_S3_SAVE_PROTOCOL      * This,\r
-  IN VOID                           * LegacyMemoryAddress \r
+  IN VOID                           * LegacyMemoryAddress\r
   );\r
 \r
-typedef \r
-EFI_STATUS  \r
-(EFIAPI *EFI_ACPI_GET_LEGACY_MEMORY_SIZE) (\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_ACPI_GET_LEGACY_MEMORY_SIZE)(\r
   IN  EFI_ACPI_S3_SAVE_PROTOCOL     * This,\r
   OUT UINTN                         * Size\r
 );\r