Update the copyright notice format

[mirror_edk2.git] / IntelFrameworkPkg / Include / Ppi / S3Resume.h

diff --git a/IntelFrameworkPkg/Include/Ppi/S3Resume.h b/IntelFrameworkPkg/Include/Ppi/S3Resume.h
index cbb38f5722d6f892037f5071c48906dd4e15697b..f78605623557cadd7676bc30f259564c6cfd83fa 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/S3Resume.h
+++ b/IntelFrameworkPkg/Include/Ppi/S3Resume.h
@@ -1,28 +1,40 @@
 /** @file\r
-  This file declares S3 Resume PPI.\r
-\r
-  Copyright (c) 2007, 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:  S3Resume.h\r
+  This file declares S3 Resume PPI which accomplishes the firmware S3 resume boot path\r
+  and transfers control to OS.\r
+  \r
+  This PPI is published by the S3 resume PEIM and can be used on the S3 resume boot path to\r
+  restore the platform to its preboot configuration and transfer control to OS. The information that is\r
+  required for an S3 resume can be saved during the normal boot path using\r
+  EFI_ACPI_S3_SAVE_PROTOCOL. This presaved information can then be restored in the S3\r
+  resume boot path using EFI_PEI_S3_RESUME_PPI. Architecturally, the S3 resume PEIM is the\r
+  last PEIM to be dispatched in the S3 resume boot path.\r
+  Before using this PPI, the caller must ensure the necessary information for the S3 resume, such as\r
+  the following, is available for the S3 resume boot path:\r
+  - EFI_ACPI_S3_RESUME_SCRIPT_TABLE script table. Type\r
+    EFI_ACPI_S3_RESUME_SCRIPT_TABLE is defined in the Intel Platform Innovation\r
+    Framework for EFI Boot Script Specification.\r
+  - OS waking vector.\r
+  - The reserved memory range to be used for the S3 resume.\r
+  Otherwise, the S3 resume boot path may fail.\r
+  \r
+Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+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
   @par Revision Reference:\r
-  This PPI is defined in Framework of EFI S3 Resume Boot Path spec.\r
-  Version 0.9\r
+  This PPI is defined in Framework for EFI S3 Resume Boot Path spec.\r
+  Version 0.9.\r
 \r
 **/\r
 \r
 #ifndef __PEI_S3_RESUME_PPI_H__\r
 #define __PEI_S3_RESUME_PPI_H__\r
 \r
-#include <PiPei.h>\r
-\r
 #define EFI_PEI_S3_RESUME_PPI_GUID \\r
   { \\r
     0x4426CCB2, 0xE684, 0x4a8a, {0xAE, 0x40, 0x20, 0xD4, 0xB0, 0x25, 0xB7, 0x10 } \\r
@@ -34,30 +46,28 @@ typedef struct _EFI_PEI_S3_RESUME_PPI   EFI_PEI_S3_RESUME_PPI;
   Restores the platform to its preboot configuration for an S3 resume and\r
   jumps to the OS waking vector.\r
 \r
-  @param  PeiServices    Pointer to the PEI Services Table\r
+  @param  PeiServices    The pointer to the PEI Services Table\r
 \r
   @retval EFI_ABORTED           Execution of the S3 resume boot script table failed.\r
-  @retval EFI_NOT_FOUND         Some necessary information that is used for\r
-                                the S3 resume boot path could not be located.\r
+  @retval EFI_NOT_FOUND         Could not be locate some necessary information that \r
+                                is used for the S3 resume boot path d.\r
 \r
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_S3_RESUME_PPI_RESTORE_CONFIG) (\r
+(EFIAPI *EFI_PEI_S3_RESUME_PPI_RESTORE_CONFIG)(\r
   IN EFI_PEI_SERVICES   **PeiServices\r
   );\r
 \r
 /**\r
-  @par Ppi Description:\r
   EFI_PEI_S3_RESUME_PPI accomplishes the firmware S3 resume boot\r
   path and transfers control to OS.\r
-\r
-  @param S3RestoreConfig\r
-  Restores the platform to its preboot configuration for an S3 resume and\r
-  jumps to the OS waking vector.\r
-\r
 **/\r
 struct _EFI_PEI_S3_RESUME_PPI {\r
+  ///\r
+  /// Restores the platform to its preboot configuration for an S3 resume and\r
+  /// jumps to the OS waking vector.\r
+  ///\r
   EFI_PEI_S3_RESUME_PPI_RESTORE_CONFIG  S3RestoreConfig;\r
 };\r
 \r