]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Pi/PiHob.h
Add comments for enumeration, structure data members those are referred by UefiServic...
[mirror_edk2.git] / MdePkg / Include / Pi / PiHob.h
index e1926ce67a43898c2825e81a134934063e23521b..7f4bf8a9274dbe65841a90538de4901b9efa2e72 100644 (file)
 /// All HOBs must contain this generic HOB header.\r
 /// \r
 typedef struct {\r
+  ///\r
+  /// Identifies the HOB data structure type.\r
+  ///\r
   UINT16    HobType;\r
+  ///\r
+  /// The length in bytes of the HOB.\r
+  ///\r
   UINT16    HobLength;\r
+  ///\r
+  /// This field must always be set to zero.\r
+  ///\r
   UINT32    Reserved;\r
 } EFI_HOB_GENERIC_HEADER;\r
 \r
@@ -59,13 +68,41 @@ typedef struct {
 /// This HOB must be the first one in the HOB list.\r
 /// \r
 typedef struct {\r
+  ///\r
+  /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_HANDOFF.\r
+  ///\r
   EFI_HOB_GENERIC_HEADER  Header;\r
+  ///\r
+  /// The version number pertaining to the PHIT HOB definition.\r
+  /// This value is 4 bytes in length to provide an 8-byte aligned entry \r
+  /// when it is combined with the 4-byte BootMode.\r
+  ///\r
   UINT32                  Version;\r
+  ///\r
+  /// The system boot mode as determined during the HOB producer phase.\r
+  ///\r
   EFI_BOOT_MODE           BootMode;\r
+  ///\r
+  /// The highest address location of memory that is allocated for use by the HOB producer\r
+  /// phase. This address must be 4-KB aligned to meet page restrictions of UEFI.\r
+  ///\r
   EFI_PHYSICAL_ADDRESS    EfiMemoryTop;\r
+  ///\r
+  /// The lowest address location of memory that is allocated for use by the HOB producer phase.\r
+  ///\r
   EFI_PHYSICAL_ADDRESS    EfiMemoryBottom;\r
+  ///\r
+  /// The highest address location of free memory that is currently available \r
+  /// for use by the HOB producer phase.\r
+  ///\r
   EFI_PHYSICAL_ADDRESS    EfiFreeMemoryTop;\r
+  ///\r
+  /// The lowest address location of free memory that is available for use by the HOB producer phase.\r
+  ///\r
   EFI_PHYSICAL_ADDRESS    EfiFreeMemoryBottom;\r
+  ///\r
+  /// The end of the HOB list.\r
+  ///\r
   EFI_PHYSICAL_ADDRESS    EfiEndOfHobList;\r
 } EFI_HOB_HANDOFF_INFO_TABLE;\r
 \r
@@ -112,11 +149,17 @@ typedef struct {
 ///\r
 /// Describes all memory ranges used during the HOB producer \r
 /// phase that exist outside the HOB list. This HOB type \r
-/// describes how memory is used, \r
-/// not the physical attributes of memory.\r
-/// \r
+/// describes how memory is used, not the physical attributes of memory.\r
+///\r
 typedef struct {\r
+  ///\r
+  /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.\r
+  ///\r
   EFI_HOB_GENERIC_HEADER            Header;\r
+  ///\r
+  /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the\r
+  /// various attributes of the logical memory allocation.\r
+  ///\r
   EFI_HOB_MEMORY_ALLOCATION_HEADER  AllocDescriptor;\r
   //\r
   // Additional data pertaining to the "Name" Guid memory\r
@@ -131,7 +174,14 @@ typedef struct {
 /// content in the HOB producer phase is executing.\r
 /// \r
 typedef struct {\r
+  ///\r
+  /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.\r
+  ///\r
   EFI_HOB_GENERIC_HEADER            Header;\r
+  ///\r
+  /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the\r
+  /// various attributes of the logical memory allocation.\r
+  ///\r
   EFI_HOB_MEMORY_ALLOCATION_HEADER  AllocDescriptor;\r
 } EFI_HOB_MEMORY_ALLOCATION_STACK;\r
 \r
@@ -142,7 +192,14 @@ typedef struct {
 /// register overflow store.\r
 /// \r
 typedef struct {\r
+  ///\r
+  /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.\r
+  ///\r
   EFI_HOB_GENERIC_HEADER            Header;\r
+  ///\r
+  /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the\r
+  /// various attributes of the logical memory allocation.\r
+  ///\r
   EFI_HOB_MEMORY_ALLOCATION_HEADER  AllocDescriptor;\r
 } EFI_HOB_MEMORY_ALLOCATION_BSP_STORE;\r
 \r
@@ -150,9 +207,24 @@ typedef struct {
 /// Defines the location and entry point of the HOB consumer phase.\r
 ///\r
 typedef struct {\r
+  ///\r
+  /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.\r
+  ///\r
   EFI_HOB_GENERIC_HEADER            Header;\r
+  ///\r
+  /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the\r
+  /// various attributes of the logical memory allocation.\r
+  ///\r
   EFI_HOB_MEMORY_ALLOCATION_HEADER  MemoryAllocationHeader;\r
+  ///\r
+  /// The GUID specifying the values of the firmware file system name \r
+  /// that contains the HOB consumer phase component.\r
+  ///\r
   EFI_GUID                          ModuleName;\r
+  ///\r
+  /// The address of the memory-mapped firmware volume \r
+  /// that contains the HOB consumer phase firmware file.\r
+  ///\r
   EFI_PHYSICAL_ADDRESS              EntryPoint;\r
 } EFI_HOB_MEMORY_ALLOCATION_MODULE;\r
 \r
@@ -211,11 +283,30 @@ typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE;
 /// host bus during the HOB producer phase.\r
 /// \r
 typedef struct {\r
+  ///\r
+  /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_RESOURCE_DESCRIPTOR.\r
+  ///\r
   EFI_HOB_GENERIC_HEADER      Header;\r
+  ///\r
+  /// A GUID representing the owner of the resource. This GUID is used by HOB\r
+  /// consumer phase components to correlate device ownership of a resource.\r
+  ///\r
   EFI_GUID                    Owner;\r
+  ///\r
+  /// Resource type enumeration as defined by EFI_RESOURCE_TYPE.\r
+  ///\r
   EFI_RESOURCE_TYPE           ResourceType;\r
+  ///\r
+  /// Resource attributes as defined by EFI_RESOURCE_ATTRIBUTE_TYPE.\r
+  ///\r
   EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute;\r
+  ///\r
+  /// Physical start address of the resource region. \r
+  ///\r
   EFI_PHYSICAL_ADDRESS        PhysicalStart;\r
+  ///\r
+  /// Number of bytes of the resource region.\r
+  ///\r
   UINT64                      ResourceLength;\r
 } EFI_HOB_RESOURCE_DESCRIPTOR;\r
 \r
@@ -224,20 +315,34 @@ typedef struct {
 /// maintain and manage HOBs with specific GUID.\r
 /// \r
 typedef struct {\r
+  ///\r
+  /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_GUID_EXTENSION.\r
+  ///\r
   EFI_HOB_GENERIC_HEADER      Header;\r
-  EFI_GUID                    Name;\r
-\r
   ///\r
-  /// Guid specific data goes here\r
+  /// A GUID that defines the contents of this HOB.\r
   ///\r
+  EFI_GUID                    Name;\r
+  //\r
+  // Guid specific data goes here\r
+  //\r
 } EFI_HOB_GUID_TYPE;\r
 \r
 ///\r
 /// Details the location of firmware volumes that contain firmware files.\r
 /// \r
 typedef struct {\r
+  ///\r
+  /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV.\r
+  ///\r
   EFI_HOB_GENERIC_HEADER Header;\r
+  ///\r
+  /// The physical memory-mapped base address of the firmware volume.\r
+  ///\r
   EFI_PHYSICAL_ADDRESS   BaseAddress;\r
+  ///\r
+  /// The length in bytes of the firmware volume.\r
+  ///\r
   UINT64                 Length;\r
 } EFI_HOB_FIRMWARE_VOLUME;\r
 \r
@@ -246,10 +351,25 @@ typedef struct {
 /// from a file within another firmware volume.\r
 /// \r
 typedef struct {\r
+  ///\r
+  /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV2.\r
+  ///\r
   EFI_HOB_GENERIC_HEADER  Header;\r
+  ///\r
+  /// The physical memory-mapped base address of the firmware volume.\r
+  ///\r
   EFI_PHYSICAL_ADDRESS    BaseAddress;\r
+  ///\r
+  /// The length in bytes of the firmware volume.\r
+  ///\r
   UINT64                  Length;\r
+  ///\r
+  /// The name of the firmware volume.\r
+  ///\r
   EFI_GUID                FvName;\r
+  ///\r
+  /// The name of the firmware file which contained this firmware volume.\r
+  ///\r
   EFI_GUID                FileName;\r
 } EFI_HOB_FIRMWARE_VOLUME2;\r
 \r
@@ -258,9 +378,21 @@ typedef struct {
 /// Describes processor information, such as address space and I/O space capabilities.\r
 ///\r
 typedef struct {\r
+  ///\r
+  /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_CPU.\r
+  ///\r
   EFI_HOB_GENERIC_HEADER  Header;\r
+  ///\r
+  /// Identifies the maximum physical memory addressability of the processor.\r
+  ///\r
   UINT8                   SizeOfMemorySpace;\r
+  ///\r
+  /// Identifies the maximum physical I/O addressability of the processor.\r
+  ///\r
   UINT8                   SizeOfIoSpace;\r
+  ///\r
+  /// This field will always be set to zero.\r
+  ///\r
   UINT8                   Reserved[6];\r
 } EFI_HOB_CPU;\r
 \r
@@ -269,6 +401,9 @@ typedef struct {
 /// Describes pool memory allocations.\r
 /// \r
 typedef struct {\r
+  ///\r
+  /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_POOL.\r
+  ///\r
   EFI_HOB_GENERIC_HEADER  Header;\r
 } EFI_HOB_MEMORY_POOL;\r
 \r