1. Remove unnecessary CONST.

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

diff --git a/MdePkg/Include/Ppi/TemporaryRamSupport.h b/MdePkg/Include/Ppi/TemporaryRamSupport.h
index b8d2e7fda57abc26007ab50e2a440e2803330e5c..76e7c923eef91e2af75c7002ee585d9bcd64cd37 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
@@ -23,7 +24,7 @@
   { 0xdbe23aa9, 0xa345, 0x4b97, {0x85, 0xb6, 0xb2, 0x26, 0xf1, 0x61, 0x73, 0x89} }\r
 \r
 \r
-/*\r
+/**\r
   This service of the TEMPORARY_RAM_SUPPORT_PPI that migrates temporary RAM into\r
   permanent memory.\r
 \r
@@ -48,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