1. Clean up MdePkg internal header files

[mirror_edk2.git] / MdePkg / Include / Uefi / UefiMultiPhase.h

diff --git a/MdePkg/Include/Uefi/UefiMultiPhase.h b/MdePkg/Include/Uefi/UefiMultiPhase.h
index 87f2fcc7aac7e79cd6e7758dd578dcacd76f9ee8..f82a8ae792bdc02a2bcd41150b2507d1af21ecde 100644 (file)
--- a/MdePkg/Include/Uefi/UefiMultiPhase.h
+++ b/MdePkg/Include/Uefi/UefiMultiPhase.h
@@ -1,7 +1,7 @@
 /** @file\r
   This includes some definitions introduced in UEFI that will be used in both PEI and DXE phases.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2009, 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
@@ -15,38 +15,104 @@
 #ifndef __UEFI_MULTIPHASE_H__\r
 #define __UEFI_MULTIPHASE_H__\r
 \r
-#include <ProcessorBind.h>\r
-\r
 ///\r
 /// Enumeration of memory types introduced in UEFI.\r
 /// \r
 typedef enum {\r
+  ///\r
+  /// Not used.\r
+  ///\r
   EfiReservedMemoryType,\r
+  ///\r
+  /// The code portions of a loaded application. \r
+  /// (Note that UEFI OS loaders are UEFI applications.)\r
+  ///\r
   EfiLoaderCode,\r
+  ///\r
+  /// The data portions of a loaded application and the default data allocation\r
+  /// type used by an application to allocate pool memory.\r
+  ///\r
   EfiLoaderData,\r
+  ///\r
+  /// The code portions of a loaded Boot Services Driver\r
+  ///\r
   EfiBootServicesCode,\r
+  ///\r
+  /// The data portions of a loaded Boot Serves Driver, and the default data\r
+  /// allocation type used by a Boot Services Driver to allocate pool memory.\r
+  ///\r
   EfiBootServicesData,\r
+  ///\r
+  /// The code portions of a loaded Runtime Services Driver.\r
+  ///\r
   EfiRuntimeServicesCode,\r
+  ///\r
+  /// The data portions of a loaded Runtime Services Driver and the default\r
+  /// data allocation type used by a Runtime Services Driver to allocate pool memory.\r
+  ///\r
   EfiRuntimeServicesData,\r
+  ///\r
+  /// Free (unallocated) memory.\r
+  ///\r
   EfiConventionalMemory,\r
+  ///\r
+  /// Memory in which errors have been detected.\r
+  ///\r
   EfiUnusableMemory,\r
+  ///\r
+  /// Memory that holds the ACPI tables.\r
+  ///\r
   EfiACPIReclaimMemory,\r
+  ///\r
+  /// Address space reserved for use by the firmware.\r
+  ///\r
   EfiACPIMemoryNVS,\r
+  ///\r
+  /// Used by system firmware to request that a memory-mapped IO region\r
+  /// be mapped by the OS to a virtual address so it can be accessed by EFI runtime services.\r
+  ///\r
   EfiMemoryMappedIO,\r
+  ///\r
+  /// System memory-mapped IO region that is used to translate memory\r
+  /// cycles to IO cycles by the processor.\r
+  ///\r
   EfiMemoryMappedIOPortSpace,\r
+  ///\r
+  /// Address space reserved by the firmware for code that is part of the processor.\r
+  ///\r
   EfiPalCode,\r
   EfiMaxMemoryType\r
 } EFI_MEMORY_TYPE;\r
 \r
-\r
 ///\r
 /// Data structure that precedes all of the standard EFI table types.\r
 /// \r
 typedef struct {\r
+  ///\r
+  /// A 64-bit signature that identifies the type of table that follows.\r
+  /// Unique signatures have been generated for the EFI System Table,\r
+  /// the EFI Boot Services Table, and the EFI Runtime Services Table.\r
+  ///\r
   UINT64  Signature;\r
+  ///\r
+  /// The revision of the EFI Specification to which this table\r
+  /// conforms. The upper 16 bits of this field contain the major\r
+  /// revision value, and the lower 16 bits contain the minor revision\r
+  /// value. The minor revision values are limited to the range of 00..99.\r
+  ///\r
   UINT32  Revision;\r
+  ///\r
+  /// The size, in bytes, of the entire table including the EFI_TABLE_HEADER.\r
+  ///\r
   UINT32  HeaderSize;\r
+  ///\r
+  /// The 32-bit CRC for the entire table. This value is computed by\r
+  /// setting this field to 0, and computing the 32-bit CRC for HeaderSize bytes.\r
+  ///\r
   UINT32  CRC32;\r
+  ///\r
+  /// Reserved field that must be set to 0.\r
+  ///\r
   UINT32  Reserved;\r
 } EFI_TABLE_HEADER;\r
 \r
@@ -104,9 +170,9 @@ typedef struct _WIN_CERTIFICATE {
 #define EFI_CERT_TYPE_RSA2048_SHA256_GUID \\r
   {0xa7717414, 0xc616, 0x4977, {0x94, 0x20, 0x84, 0x47, 0x12, 0xa7, 0x35, 0xbf } }\r
 \r
-//\r
-// WIN_CERTIFICATE_UEFI_GUID.CertData\r
-// \r
+///\r
+/// WIN_CERTIFICATE_UEFI_GUID.CertData\r
+/// \r
 typedef struct _EFI_CERT_BLOCK_RSA_2048_SHA256 {\r
   UINT32  HashType;\r
   UINT8   PublicKey[256];\r