Fixes for ARM build in the EdkCompatibilityPkg and a couple of Xcode fixes for MdePkg.

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

diff --git a/MdePkg/Include/Ppi/TemporaryRamSupport.h b/MdePkg/Include/Ppi/TemporaryRamSupport.h
index 9ecf505aec8d31d907c1adeb1598bbc69a8e5988..ecbeca2a0f89c83815d1aecc294534f5aa71cb2c 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,11 +11,8 @@
   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
+  This PPI is introduced in PI Version 1.0.\r
 \r
 **/\r
 \r
@@ -22,46 +20,41 @@
 #define __TEMPORARY_RAM_SUPPORT_H__\r
 \r
 #define TEMPORARY_RAM_SUPPORT_PPI_GUID \\r
-       { 0xdbe23aa9, 0xa345, 0x4b97, {0x85, 0xb6, 0xb2, 0x26, 0xf1, 0x61, 0x73, 0x89} }\r
+  { 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
-  @param PeiServices                                           Pointer to the PEI Services Table.\r
-\r
-  @param TemporaryMemoryBase           Source Address in temporary memory from which the SEC or PEIM will copy the\r
-                                                                                                                               Temporary RAM contents.\r
-\r
-  @param PermanentMemoryBase           Destination Address in permanent memory into which the SEC or PEIM will copy the\r
-                                                                                                                               Temporary RAM contents.\r
+  permanent memory.\r
 \r
-  @param CopySize                                                              Amount of memory to migrate from temporary to permanent memory.\r
+  @param PeiServices            Pointer to the PEI Services Table.\r
+  @param TemporaryMemoryBase    Source Address in temporary memory from which the SEC or PEIM will copy the\r
+                                Temporary RAM contents.\r
+  @param PermanentMemoryBase    Destination Address in permanent memory into which the SEC or PEIM will copy the\r
+                                Temporary RAM contents.\r
+  @param CopySize               Amount of memory to migrate from temporary to permanent memory.\r
 \r
-\r
-\r
-       @retval EFI_SUCCESS                                             The data was successfully returned.\r
-\r
-       @retval EFI_INVALID_PARAMETER PermanentMemoryBase + CopySize >\r
-                                                                                                                               TemporaryMemoryBase when TemporaryMemoryBase >\r
-                                                                                                                               PermanentMemoryBase.\r
+  @retval EFI_SUCCESS           The data was successfully returned.\r
+  @retval EFI_INVALID_PARAMETER PermanentMemoryBase + CopySize > TemporaryMemoryBase when\r
+                                TemporaryMemoryBase > PermanentMemoryBase.\r
 \r
 **/\r
 typedef\r
 EFI_STATUS\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
+(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
+///\r
+/// This service abstracts the ability to migrate contents of the platform early memory store.\r
+///\r
 typedef struct {\r
-       TEMPORARY_RAM_MIGRATION         TemporaryRamMigration;\r
+  TEMPORARY_RAM_MIGRATION   TemporaryRamMigration;\r
 } TEMPORARY_RAM_SUPPORT_PPI;\r
 \r
-extern EFI_GUID gEfiPeiTemporaryRamSupportPpiGuid;\r
+extern EFI_GUID gEfiTemporaryRamSupportPpiGuid;\r
 \r
 #endif\r