MdePkg: Apply uncrustify changes

[mirror_edk2.git] / MdePkg / Include / Guid / SmramMemoryReserve.h

diff --git a/MdePkg/Include/Guid/SmramMemoryReserve.h b/MdePkg/Include/Guid/SmramMemoryReserve.h
index 392e426b1e43049d2281023b1304ed095ad2d887..37d55c6bc0cc78bbd7a19411b6cefa42bb619a80 100644 (file)
--- a/MdePkg/Include/Guid/SmramMemoryReserve.h
+++ b/MdePkg/Include/Guid/SmramMemoryReserve.h
@@ -1,67 +1,44 @@
 /** @file\r
-  GUID for use in reserving SMRAM regions.\r
+  This is a special GUID extension Hob to describe SMRAM memory regions.\r
 \r
-  Copyright (c) 2006, 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
+  This file defines:\r
+  * the GUID used to identify the GUID HOB for reserving SMRAM regions.\r
+  * the data structure of SMRAM descriptor to describe SMRAM candidate regions\r
+  * values of state of SMRAM candidate regions\r
+  * the GUID specific data structure of HOB for reserving SMRAM regions.\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:  SmramMemoryReserve.h\r
+  Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
   @par Revision Reference:\r
-  GUIDs defined in SmmCis spec version 0.9\r
+  GUIDs defined in PI SPEC version 1.5.\r
 \r
 **/\r
 \r
-#ifndef _EFI_SMM_PEI_SMRAM_MEMORY_RESERVE_H_\r
-#define _EFI_SMM_PEI_SMRAM_MEMORY_RESERVE_H_\r
+#ifndef _SMRAM_MEMORY_RESERVE_H_\r
+#define _SMRAM_MEMORY_RESERVE_H_\r
 \r
-#define EFI_SMM_PEI_SMRAM_MEMORY_RESERVE \\r
+#define EFI_SMM_SMRAM_MEMORY_GUID \\r
   { \\r
     0x6dadf1d1, 0xd4cc, 0x4910, {0xbb, 0x6e, 0x82, 0xb1, 0xfd, 0x80, 0xff, 0x3d } \\r
   }\r
 \r
-//\r
-// *******************************************************\r
-//  EFI_SMRAM_DESCRIPTOR\r
-// *******************************************************\r
-//\r
-typedef struct {\r
-  EFI_PHYSICAL_ADDRESS  PhysicalStart;  // Phsyical location in DRAM\r
-  EFI_PHYSICAL_ADDRESS  CpuStart;       // Address CPU uses to access the SMI handler\r
-  // May or may not match PhysicalStart\r
-  //\r
-  UINT64                PhysicalSize;\r
-  UINT64                RegionState;\r
-} EFI_SMRAM_DESCRIPTOR;\r
-\r
-//\r
-// *******************************************************\r
-//  EFI_SMRAM_STATE\r
-// *******************************************************\r
-//\r
-#define EFI_SMRAM_OPEN                0x00000001\r
-#define EFI_SMRAM_CLOSED              0x00000002\r
-#define EFI_SMRAM_LOCKED              0x00000004\r
-#define EFI_CACHEABLE                 0x00000008\r
-#define EFI_ALLOCATED                 0x00000010\r
-#define EFI_NEEDS_TESTING             0x00000020\r
-#define EFI_NEEDS_ECC_INITIALIZATION  0x00000040\r
-\r
-//\r
-// *******************************************************\r
-//  EFI_SMRAM_HOB_DESCRIPTOR_BLOCK\r
-// *******************************************************\r
-//\r
+/**\r
+* The GUID extension hob is to describe SMRAM memory regions supported by the platform.\r
+**/\r
 typedef struct {\r
-  UINTN                 NumberOfSmmReservedRegions;\r
-  EFI_SMRAM_DESCRIPTOR  Descriptor[1];\r
+  ///\r
+  /// Designates the number of possible regions in the system\r
+  /// that can be usable for SMRAM.\r
+  ///\r
+  UINT32                  NumberOfSmmReservedRegions;\r
+  ///\r
+  /// Used throughout this protocol to describe the candidate\r
+  /// regions for SMRAM that are supported by this platform.\r
+  ///\r
+  EFI_SMRAM_DESCRIPTOR    Descriptor[1];\r
 } EFI_SMRAM_HOB_DESCRIPTOR_BLOCK;\r
 \r
-extern EFI_GUID gEfiSmmPeiSmramMemoryReserveGuid;\r
+extern EFI_GUID  gEfiSmmSmramMemoryGuid;\r
 \r
 #endif\r