MdeModulePkg: Apply uncrustify changes

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

diff --git a/MdePkg/Include/Ppi/TemporaryRamSupport.h b/MdePkg/Include/Ppi/TemporaryRamSupport.h
index 76e7c923eef91e2af75c7002ee585d9bcd64cd37..664788d037e563d38b8726788bd8f498588272de 100644 (file)
--- a/MdePkg/Include/Ppi/TemporaryRamSupport.h
+++ b/MdePkg/Include/Ppi/TemporaryRamSupport.h
@@ -2,49 +2,39 @@
   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 - 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
-  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
+  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\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
 #ifndef __TEMPORARY_RAM_SUPPORT_H__\r
 #define __TEMPORARY_RAM_SUPPORT_H__\r
 \r
-#define TEMPORARY_RAM_SUPPORT_PPI_GUID \\r
+///\r
+/// Note: The GUID name EFI_PEI_TEMPORARY_RAM_SUPPORT_PPI_GUID is different from the current\r
+///       PI 1.2 spec.\r
+///\r
+#define EFI_PEI_TEMPORARY_RAM_SUPPORT_PPI_GUID  \\r
   { 0xdbe23aa9, 0xa345, 0x4b97, {0x85, 0xb6, 0xb2, 0x26, 0xf1, 0x61, 0x73, 0x89} }\r
 \r
 \r
 /**\r
-  This service of the TEMPORARY_RAM_SUPPORT_PPI that migrates temporary RAM into\r
+  This service of the EFI_PEI_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
-\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_INVALID_PARAMETER PermanentMemoryBase + CopySize > TemporaryMemoryBase when\r
+                                TemporaryMemoryBase > PermanentMemoryBase.\r
 \r
 **/\r
 typedef\r
@@ -56,18 +46,14 @@ EFI_STATUS
   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
+///\r
+/// This service abstracts the ability to migrate contents of the platform early memory store.\r
+/// Note: The name EFI_PEI_TEMPORARY_RAM_SUPPORT_PPI is different from the current PI 1.2 spec.\r
+///       This PPI was optional.\r
+///\r
 typedef struct {\r
   TEMPORARY_RAM_MIGRATION   TemporaryRamMigration;\r
-} TEMPORARY_RAM_SUPPORT_PPI;\r
+} EFI_PEI_TEMPORARY_RAM_SUPPORT_PPI;\r
 \r
 extern EFI_GUID gEfiTemporaryRamSupportPpiGuid;\r
 \r