Code Scrub for Protocol and Ppi Definition

[mirror_edk2.git] / MdePkg / Include / Ppi / TemporaryRamSupport.h

diff --git a/MdePkg/Include/Ppi/TemporaryRamSupport.h b/MdePkg/Include/Ppi/TemporaryRamSupport.h
index 7ae6b91ed58114d5f3d3e3679e22df1a71faa9d8..26afa7f62b21f9d718fd57d47f22d49e29b6a404 100644 (file)
--- a/MdePkg/Include/Ppi/TemporaryRamSupport.h
+++ b/MdePkg/Include/Ppi/TemporaryRamSupport.h
@@ -1,7 +1,8 @@
-/* @file\r
+/** @file\r
   This file declares Temporary RAM Support PPI.\r
+  This Ppi provides the service that migrates temporary RAM into permanent memory.\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, 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
@@ -10,8 +11,6 @@
   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:  TemporaryRamSupport.h\r
-\r
   @par Revision Reference:\r
   This PPI is defined in PI.\r
   Version 1.00.\r
@@ -50,14 +49,22 @@
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI * TEMPORARY_RAM_MIGRATION) (\r
+(EFIAPI * TEMPORARY_RAM_MIGRATION)(\r
   IN CONST EFI_PEI_SERVICES   **PeiServices,\r
   IN EFI_PHYSICAL_ADDRESS     TemporaryMemoryBase,\r
   IN EFI_PHYSICAL_ADDRESS     PermanentMemoryBase,\r
   IN UINTN                    CopySize\r
 );\r
 \r
+/**\r
+  @par Ppi Description:\r
+  This service abstracts the ability to migrate contents of the platform early memory store.\r
+\r
+  @param ResetSystem\r
+  Perform the migration of contents of Temporary RAM to Permanent RAM.\r
+  Terminate the Temporary RAM if it cannot coexist with the Permanent RAM.\r
 \r
+**/\r
 typedef struct {\r
   TEMPORARY_RAM_MIGRATION   TemporaryRamMigration;\r
 } TEMPORARY_RAM_SUPPORT_PPI;\r