MdePkg/ProcessorBind: add defines for page allocation granularity

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

diff --git a/MdePkg/Include/Uefi/UefiGpt.h b/MdePkg/Include/Uefi/UefiGpt.h
index bac0c2668d9f1988434fc32dfeb13a998d03f972..f2d0fa0b09f69c85fd5f81edc0b2f6bc70600379 100644 (file)
--- a/MdePkg/Include/Uefi/UefiGpt.h
+++ b/MdePkg/Include/Uefi/UefiGpt.h
@@ -1,14 +1,14 @@
 /** @file\r
   EFI Guid Partition Table Format Definition.\r
 \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
-  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 - 2011, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+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
 \r
 **/\r
 \r
@@ -21,19 +21,19 @@
 ///\r
 #define PRIMARY_PART_HEADER_LBA 1\r
 ///\r
-/// EFI Partition Table Signature: "EFI PART"\r
+/// EFI Partition Table Signature: "EFI PART".\r
 /// \r
 #define EFI_PTAB_HEADER_ID      SIGNATURE_64 ('E','F','I',' ','P','A','R','T')\r
 \r
 #pragma pack(1)\r
 \r
 ///\r
-/// GPT Partition Table Header\r
+/// GPT Partition Table Header.\r
 ///\r
 typedef struct {\r
   ///\r
   /// The table header for the GPT partition Table.\r
-  /// This header contains EFI_PTAB_HEADER_ID\r
+  /// This header contains EFI_PTAB_HEADER_ID.\r
   ///\r
   EFI_TABLE_HEADER  Header;\r
   ///\r
@@ -69,7 +69,8 @@ typedef struct {
   ///\r
   /// The size, in bytes, of each the GUID Partition\r
   /// Entry structures in the GUID Partition Entry\r
-  /// array. Must be a multiple of 8.\r
+  /// array. This field shall be set to a value of 128 x 2^n where n is\r
+  /// an integer greater than or equal to zero (e.g., 128, 256, 512, etc.).\r
   ///\r
   UINT32            SizeOfPartitionEntry;\r
   ///\r
@@ -82,7 +83,7 @@ typedef struct {
 } EFI_PARTITION_TABLE_HEADER;\r
 \r
 ///\r
-/// GPT Partition Entry\r
+/// GPT Partition Entry.\r
 ///\r
 typedef struct {\r
   ///\r
@@ -110,22 +111,26 @@ typedef struct {
   ///             partition indicates that deletion or modification of the contents can result in loss of platform\r
   ///             features or failure for the platform to boot or operate. The system cannot function normally if\r
   ///             this partition is removed, and it should be considered part of the hardware of the system.\r
-  ///             Actions such as running diagnostics, system recovery, or even OS install or boot could\r
+  ///             Actions such as running diagnostics, system recovery, or even OS install or boot, could\r
   ///             potentially stop working if this partition is removed. Unless OS software or firmware\r
   ///             recognizes this partition, it should never be removed or modified as the UEFI firmware or\r
   ///             platform hardware may become non-functional.\r
-  /// Bit 1:      If this bit is set firmware must not produce an EFI_BLOCK_IO_PROTOCOL device for\r
-  ///             this partition. By not producing EFI_BLOCK_IO_PROTOCOL partition, file system\r
+  /// Bit 1:      If this bit is set, then firmware must not produce an EFI_BLOCK_IO_PROTOCOL device for\r
+  ///             this partition. By not producing an EFI_BLOCK_IO_PROTOCOL partition, file system\r
   ///             mappings will not be created for this partition in UEFI.\r
-  /// Bits 2-47:  Undefined and must be zero. Reserved for expansion by future versions of the UEFI\r
+  /// Bit 2:      This bit is set aside to let systems with traditional PC-AT BIOS firmware implementations\r
+  ///             inform certain limited, special-purpose software running on these systems that a GPT \r
+  ///             partition may be bootable. The UEFI boot manager must ignore this bit when selecting\r
+  ///             a UEFI-compliant application, e.g., an OS loader.\r
+  /// Bits 3-47:  Undefined and must be zero. Reserved for expansion by future versions of the UEFI\r
   ///             specification.\r
   /// Bits 48-63: Reserved for GUID specific use. The use of these bits will vary depending on the\r
   ///             PartitionTypeGUID. Only the owner of the PartitionTypeGUID is allowed\r
-  ///             to modify these bits. They must be preserved if Bits 0¨C47 are modified..\r
+  ///             to modify these bits. They must be preserved if Bits 0-47 are modified..\r
   ///\r
   UINT64    Attributes;\r
   ///\r
-  /// Unicode string.\r
+  /// Null-terminated name of the partition.\r
   ///\r
   CHAR16    PartitionName[36];\r
 } EFI_PARTITION_ENTRY;\r