Add comments for enumeration, structure data members those are referred by UefiServic...

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

diff --git a/MdePkg/Include/Uefi/UefiGpt.h b/MdePkg/Include/Uefi/UefiGpt.h
index 5ae762db079fe2277ac1742b2d6c661ccff67cec..da5f187c522b76806af02721733498904501a5f3 100644 (file)
--- a/MdePkg/Include/Uefi/UefiGpt.h
+++ b/MdePkg/Include/Uefi/UefiGpt.h
@@ -32,15 +32,53 @@
 /// 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
+  ///\r
   EFI_TABLE_HEADER  Header;\r
+  ///\r
+  /// The LBA that contains this data structure.\r
+  ///\r
   EFI_LBA           MyLBA;\r
+  ///\r
+  /// LBA address of the alternate GUID Partition Table Header.\r
+  ///\r
   EFI_LBA           AlternateLBA;\r
+  ///\r
+  /// The first usable logical block that may be used\r
+  /// by a partition described by a GUID Partition Entry.\r
+  ///\r
   EFI_LBA           FirstUsableLBA;\r
+  ///\r
+  /// The last usable logical block that may be used\r
+  /// by a partition described by a GUID Partition Entry.\r
+  ///\r
   EFI_LBA           LastUsableLBA;\r
+  ///\r
+  /// GUID that can be used to uniquely identify the disk.\r
+  ///\r
   EFI_GUID          DiskGUID;\r
+  ///\r
+  /// The starting LBA of the GUID Partition Entry array.\r
+  ///\r
   EFI_LBA           PartitionEntryLBA;\r
+  ///\r
+  /// The number of Partition Entries in the GUID Partition Entry array.\r
+  ///\r
   UINT32            NumberOfPartitionEntries;\r
+  ///\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
+  ///\r
   UINT32            SizeOfPartitionEntry;\r
+  ///\r
+  /// The CRC32 of the GUID Partition Entry array.\r
+  /// Starts at PartitionEntryLBA and is\r
+  /// computed over a byte length of\r
+  /// NumberOfPartitionEntries * SizeOfPartitionEntry.\r
+  ///\r
   UINT32            PartitionEntryArrayCRC32;\r
 } EFI_PARTITION_TABLE_HEADER;\r
 \r
@@ -48,11 +86,35 @@ typedef struct {
 /// GPT Partition Entry\r
 ///\r
 typedef struct {\r
+  ///\r
+  /// Unique ID that defines the purpose and type of this Partition. A value of\r
+  /// zero defines that this partition entry is not being used.\r
+  ///\r
   EFI_GUID  PartitionTypeGUID;\r
+  ///\r
+  /// GUID that is unique for every partition entry. Every partition ever\r
+  /// created will have a unique GUID.\r
+  /// This GUID must be assigned when the GUID Partition Entry is created.\r
+  ///\r
   EFI_GUID  UniquePartitionGUID;\r
+  ///\r
+  /// Starting LBA of the partition defined by this entry\r
+  ///\r
   EFI_LBA   StartingLBA;\r
+  ///\r
+  /// Ending LBA of the partition defined by this entry.\r
+  ///\r
   EFI_LBA   EndingLBA;\r
+  ///\r
+  /// Attribute bits, all bits reserved by UEFI\r
+  /// Bit 0 Required for the platform to function.\r
+  /// Bits 1-47 Undefined and must be zero.\r
+  /// Bits 48-63 Reserved for GUID specific use.\r
+  ///\r
   UINT64    Attributes;\r
+  ///\r
+  /// Unicode string.\r
+  ///\r
   CHAR16    PartitionName[36];\r
 } EFI_PARTITION_ENTRY;\r
 \r