]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Pi/PiHob.h
MdePkg: Apply uncrustify changes
[mirror_edk2.git] / MdePkg / Include / Pi / PiHob.h
index 62c07742a688e249db8e22271105f76f1eeff971..e9f0ab4309d1a4e44a42828b61201c582e239bb2 100644 (file)
@@ -48,11 +48,10 @@ typedef struct {
   UINT32    Reserved;\r
 } EFI_HOB_GENERIC_HEADER;\r
 \r
-\r
 ///\r
 /// Value of version  in EFI_HOB_HANDOFF_INFO_TABLE.\r
 ///\r
-#define EFI_HOB_HANDOFF_TABLE_VERSION 0x0009\r
+#define EFI_HOB_HANDOFF_TABLE_VERSION  0x0009\r
 \r
 ///\r
 /// Contains general state information used by the HOB producer phase.\r
@@ -62,39 +61,39 @@ typedef struct {
   ///\r
   /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_HANDOFF.\r
   ///\r
-  EFI_HOB_GENERIC_HEADER  Header;\r
+  EFI_HOB_GENERIC_HEADER    Header;\r
   ///\r
   /// The version number pertaining to the PHIT HOB definition.\r
   /// This value is four 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
+  UINT32                    Version;\r
   ///\r
   /// The system boot mode as determined during the HOB producer phase.\r
   ///\r
-  EFI_BOOT_MODE           BootMode;\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
+  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
+  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
+  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
+  EFI_PHYSICAL_ADDRESS      EfiFreeMemoryBottom;\r
   ///\r
   /// The end of the HOB list.\r
   ///\r
-  EFI_PHYSICAL_ADDRESS    EfiEndOfHobList;\r
+  EFI_PHYSICAL_ADDRESS      EfiEndOfHobList;\r
 } EFI_HOB_HANDOFF_INFO_TABLE;\r
 \r
 ///\r
@@ -110,31 +109,31 @@ typedef struct {
   /// Type EFI_GUID is defined in InstallProtocolInterface() in the UEFI 2.0\r
   /// specification.\r
   ///\r
-  EFI_GUID              Name;\r
+  EFI_GUID                Name;\r
 \r
   ///\r
   /// The base address of memory allocated by this HOB. Type\r
   /// EFI_PHYSICAL_ADDRESS is defined in AllocatePages() in the UEFI 2.0\r
   /// specification.\r
   ///\r
-  EFI_PHYSICAL_ADDRESS  MemoryBaseAddress;\r
+  EFI_PHYSICAL_ADDRESS    MemoryBaseAddress;\r
 \r
   ///\r
   /// The length in bytes of memory allocated by this HOB.\r
   ///\r
-  UINT64                MemoryLength;\r
+  UINT64                  MemoryLength;\r
 \r
   ///\r
   /// Defines the type of memory allocated by this HOB. The memory type definition\r
   /// follows the EFI_MEMORY_TYPE definition. Type EFI_MEMORY_TYPE is defined\r
   /// in AllocatePages() in the UEFI 2.0 specification.\r
   ///\r
-  EFI_MEMORY_TYPE       MemoryType;\r
+  EFI_MEMORY_TYPE         MemoryType;\r
 \r
   ///\r
   /// Padding for Itanium processor family\r
   ///\r
-  UINT8                 Reserved[4];\r
+  UINT8                   Reserved[4];\r
 } EFI_HOB_MEMORY_ALLOCATION_HEADER;\r
 \r
 ///\r
@@ -146,19 +145,18 @@ typedef struct {
   ///\r
   /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.\r
   ///\r
-  EFI_HOB_GENERIC_HEADER            Header;\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_HEADER    AllocDescriptor;\r
   //\r
   // Additional data pertaining to the "Name" Guid memory\r
   // may go here.\r
   //\r
 } EFI_HOB_MEMORY_ALLOCATION;\r
 \r
-\r
 ///\r
 /// Describes the memory stack that is produced by the HOB producer\r
 /// phase and upon which all post-memory-installed executable\r
@@ -168,12 +166,12 @@ typedef struct {
   ///\r
   /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.\r
   ///\r
-  EFI_HOB_GENERIC_HEADER            Header;\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_HEADER    AllocDescriptor;\r
 } EFI_HOB_MEMORY_ALLOCATION_STACK;\r
 \r
 ///\r
@@ -186,12 +184,12 @@ typedef struct {
   ///\r
   /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.\r
   ///\r
-  EFI_HOB_GENERIC_HEADER            Header;\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_HEADER    AllocDescriptor;\r
 } EFI_HOB_MEMORY_ALLOCATION_BSP_STORE;\r
 \r
 ///\r
@@ -201,22 +199,22 @@ typedef struct {
   ///\r
   /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.\r
   ///\r
-  EFI_HOB_GENERIC_HEADER            Header;\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
+  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
+  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_PHYSICAL_ADDRESS                EntryPoint;\r
 } EFI_HOB_MEMORY_ALLOCATION_MODULE;\r
 \r
 ///\r
@@ -246,10 +244,10 @@ typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE;
 //\r
 // The following attributes are used to describe settings\r
 //\r
-#define EFI_RESOURCE_ATTRIBUTE_PRESENT                  0x00000001\r
-#define EFI_RESOURCE_ATTRIBUTE_INITIALIZED              0x00000002\r
-#define EFI_RESOURCE_ATTRIBUTE_TESTED                   0x00000004\r
-#define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTED           0x00000080\r
+#define EFI_RESOURCE_ATTRIBUTE_PRESENT         0x00000001\r
+#define EFI_RESOURCE_ATTRIBUTE_INITIALIZED     0x00000002\r
+#define EFI_RESOURCE_ATTRIBUTE_TESTED          0x00000004\r
+#define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTED  0x00000080\r
 //\r
 // This is typically used as memory cacheability attribute today.\r
 // NOTE: Since PI spec 1.4, please use EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTED\r
@@ -257,9 +255,9 @@ typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE;
 // means Memory cacheability attribute: The memory supports being programmed with\r
 // a writeprotected cacheable attribute.\r
 //\r
-#define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED          0x00000100\r
-#define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTED      0x00000200\r
-#define EFI_RESOURCE_ATTRIBUTE_PERSISTENT               0x00800000\r
+#define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED      0x00000100\r
+#define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTED  0x00000200\r
+#define EFI_RESOURCE_ATTRIBUTE_PERSISTENT           0x00800000\r
 //\r
 // The rest of the attributes are used to describe capabilities\r
 //\r
@@ -283,12 +281,12 @@ typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE;
 // writes, and EFI_RESOURCE_ATTRIBUTE_WRITE_PROTEC TABLE means Memory cacheability attribute:\r
 // The memory supports being programmed with a writeprotected cacheable attribute.\r
 //\r
-#define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTABLE        0x00200000\r
-#define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTABLE    0x00400000\r
-#define EFI_RESOURCE_ATTRIBUTE_PERSISTABLE              0x01000000\r
+#define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTABLE      0x00200000\r
+#define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTABLE  0x00400000\r
+#define EFI_RESOURCE_ATTRIBUTE_PERSISTABLE            0x01000000\r
 \r
-#define EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTED      0x00040000\r
-#define EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTABLE    0x00080000\r
+#define EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTED    0x00040000\r
+#define EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTABLE  0x00080000\r
 \r
 //\r
 // Physical memory relative reliability attribute. This\r
@@ -296,7 +294,7 @@ typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE;
 // memory in the system. If all memory has the same\r
 // reliability, then this bit is not used.\r
 //\r
-#define EFI_RESOURCE_ATTRIBUTE_MORE_RELIABLE            0x02000000\r
+#define EFI_RESOURCE_ATTRIBUTE_MORE_RELIABLE  0x02000000\r
 \r
 ///\r
 /// Describes the resource properties of all fixed,\r
@@ -307,28 +305,28 @@ typedef struct {
   ///\r
   /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_RESOURCE_DESCRIPTOR.\r
   ///\r
-  EFI_HOB_GENERIC_HEADER      Header;\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
+  EFI_GUID                       Owner;\r
   ///\r
   /// The resource type enumeration as defined by EFI_RESOURCE_TYPE.\r
   ///\r
-  EFI_RESOURCE_TYPE           ResourceType;\r
+  EFI_RESOURCE_TYPE              ResourceType;\r
   ///\r
   /// Resource attributes as defined by EFI_RESOURCE_ATTRIBUTE_TYPE.\r
   ///\r
-  EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute;\r
+  EFI_RESOURCE_ATTRIBUTE_TYPE    ResourceAttribute;\r
   ///\r
   /// The physical start address of the resource region.\r
   ///\r
-  EFI_PHYSICAL_ADDRESS        PhysicalStart;\r
+  EFI_PHYSICAL_ADDRESS           PhysicalStart;\r
   ///\r
   /// The number of bytes of the resource region.\r
   ///\r
-  UINT64                      ResourceLength;\r
+  UINT64                         ResourceLength;\r
 } EFI_HOB_RESOURCE_DESCRIPTOR;\r
 \r
 ///\r
@@ -339,11 +337,11 @@ typedef struct {
   ///\r
   /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_GUID_EXTENSION.\r
   ///\r
-  EFI_HOB_GENERIC_HEADER      Header;\r
+  EFI_HOB_GENERIC_HEADER    Header;\r
   ///\r
   /// A GUID that defines the contents of this HOB.\r
   ///\r
-  EFI_GUID                    Name;\r
+  EFI_GUID                  Name;\r
   //\r
   // Guid specific data goes here\r
   //\r
@@ -356,15 +354,15 @@ typedef struct {
   ///\r
   /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV.\r
   ///\r
-  EFI_HOB_GENERIC_HEADER Header;\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
+  EFI_PHYSICAL_ADDRESS      BaseAddress;\r
   ///\r
   /// The length in bytes of the firmware volume.\r
   ///\r
-  UINT64                 Length;\r
+  UINT64                    Length;\r
 } EFI_HOB_FIRMWARE_VOLUME;\r
 \r
 ///\r
@@ -375,23 +373,23 @@ typedef struct {
   ///\r
   /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV2.\r
   ///\r
-  EFI_HOB_GENERIC_HEADER  Header;\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
+  EFI_PHYSICAL_ADDRESS      BaseAddress;\r
   ///\r
   /// The length in bytes of the firmware volume.\r
   ///\r
-  UINT64                  Length;\r
+  UINT64                    Length;\r
   ///\r
   /// The name of the firmware volume.\r
   ///\r
-  EFI_GUID                FvName;\r
+  EFI_GUID                  FvName;\r
   ///\r
   /// The name of the firmware file that contained this firmware volume.\r
   ///\r
-  EFI_GUID                FileName;\r
+  EFI_GUID                  FileName;\r
 } EFI_HOB_FIRMWARE_VOLUME2;\r
 \r
 ///\r
@@ -402,34 +400,34 @@ typedef struct {
   ///\r
   /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV3.\r
   ///\r
-  EFI_HOB_GENERIC_HEADER  Header;\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
+  EFI_PHYSICAL_ADDRESS      BaseAddress;\r
   ///\r
   /// The length in bytes of the firmware volume.\r
   ///\r
-  UINT64                  Length;\r
+  UINT64                    Length;\r
   ///\r
   /// The authentication status.\r
   ///\r
-  UINT32                  AuthenticationStatus;\r
+  UINT32                    AuthenticationStatus;\r
   ///\r
   /// TRUE if the FV was extracted as a file within another firmware volume.\r
   /// FALSE otherwise.\r
   ///\r
-  BOOLEAN                 ExtractedFv;\r
+  BOOLEAN                   ExtractedFv;\r
   ///\r
   /// The name of the firmware volume.\r
   /// Valid only if IsExtractedFv is TRUE.\r
   ///\r
-  EFI_GUID                FvName;\r
+  EFI_GUID                  FvName;\r
   ///\r
   /// The name of the firmware file that contained this firmware volume.\r
   /// Valid only if IsExtractedFv is TRUE.\r
   ///\r
-  EFI_GUID                FileName;\r
+  EFI_GUID                  FileName;\r
 } EFI_HOB_FIRMWARE_VOLUME3;\r
 \r
 ///\r
@@ -439,22 +437,21 @@ typedef struct {
   ///\r
   /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_CPU.\r
   ///\r
-  EFI_HOB_GENERIC_HEADER  Header;\r
+  EFI_HOB_GENERIC_HEADER    Header;\r
   ///\r
   /// Identifies the maximum physical memory addressability of the processor.\r
   ///\r
-  UINT8                   SizeOfMemorySpace;\r
+  UINT8                     SizeOfMemorySpace;\r
   ///\r
   /// Identifies the maximum physical I/O addressability of the processor.\r
   ///\r
-  UINT8                   SizeOfIoSpace;\r
+  UINT8                     SizeOfIoSpace;\r
   ///\r
   /// This field will always be set to zero.\r
   ///\r
-  UINT8                   Reserved[6];\r
+  UINT8                     Reserved[6];\r
 } EFI_HOB_CPU;\r
 \r
-\r
 ///\r
 /// Describes pool memory allocations.\r
 ///\r
@@ -462,7 +459,7 @@ typedef struct {
   ///\r
   /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_POOL.\r
   ///\r
-  EFI_HOB_GENERIC_HEADER  Header;\r
+  EFI_HOB_GENERIC_HEADER    Header;\r
 } EFI_HOB_MEMORY_POOL;\r
 \r
 ///\r
@@ -476,37 +473,36 @@ typedef struct {
   ///\r
   /// The HOB generic header where Header.HobType = EFI_HOB_TYPE_UEFI_CAPSULE.\r
   ///\r
-  EFI_HOB_GENERIC_HEADER Header;\r
+  EFI_HOB_GENERIC_HEADER    Header;\r
 \r
   ///\r
   /// The physical memory-mapped base address of an UEFI capsule. This value is set to\r
   /// point to the base of the contiguous memory of the UEFI capsule.\r
   /// The length of the contiguous memory in bytes.\r
   ///\r
-  EFI_PHYSICAL_ADDRESS   BaseAddress;\r
-  UINT64                 Length;\r
+  EFI_PHYSICAL_ADDRESS      BaseAddress;\r
+  UINT64                    Length;\r
 } EFI_HOB_UEFI_CAPSULE;\r
 \r
 ///\r
 /// Union of all the possible HOB Types.\r
 ///\r
 typedef union {\r
-  EFI_HOB_GENERIC_HEADER              *Header;\r
-  EFI_HOB_HANDOFF_INFO_TABLE          *HandoffInformationTable;\r
-  EFI_HOB_MEMORY_ALLOCATION           *MemoryAllocation;\r
-  EFI_HOB_MEMORY_ALLOCATION_BSP_STORE *MemoryAllocationBspStore;\r
-  EFI_HOB_MEMORY_ALLOCATION_STACK     *MemoryAllocationStack;\r
-  EFI_HOB_MEMORY_ALLOCATION_MODULE    *MemoryAllocationModule;\r
-  EFI_HOB_RESOURCE_DESCRIPTOR         *ResourceDescriptor;\r
-  EFI_HOB_GUID_TYPE                   *Guid;\r
-  EFI_HOB_FIRMWARE_VOLUME             *FirmwareVolume;\r
-  EFI_HOB_FIRMWARE_VOLUME2            *FirmwareVolume2;\r
-  EFI_HOB_FIRMWARE_VOLUME3            *FirmwareVolume3;\r
-  EFI_HOB_CPU                         *Cpu;\r
-  EFI_HOB_MEMORY_POOL                 *Pool;\r
-  EFI_HOB_UEFI_CAPSULE                *Capsule;\r
-  UINT8                               *Raw;\r
+  EFI_HOB_GENERIC_HEADER                 *Header;\r
+  EFI_HOB_HANDOFF_INFO_TABLE             *HandoffInformationTable;\r
+  EFI_HOB_MEMORY_ALLOCATION              *MemoryAllocation;\r
+  EFI_HOB_MEMORY_ALLOCATION_BSP_STORE    *MemoryAllocationBspStore;\r
+  EFI_HOB_MEMORY_ALLOCATION_STACK        *MemoryAllocationStack;\r
+  EFI_HOB_MEMORY_ALLOCATION_MODULE       *MemoryAllocationModule;\r
+  EFI_HOB_RESOURCE_DESCRIPTOR            *ResourceDescriptor;\r
+  EFI_HOB_GUID_TYPE                      *Guid;\r
+  EFI_HOB_FIRMWARE_VOLUME                *FirmwareVolume;\r
+  EFI_HOB_FIRMWARE_VOLUME2               *FirmwareVolume2;\r
+  EFI_HOB_FIRMWARE_VOLUME3               *FirmwareVolume3;\r
+  EFI_HOB_CPU                            *Cpu;\r
+  EFI_HOB_MEMORY_POOL                    *Pool;\r
+  EFI_HOB_UEFI_CAPSULE                   *Capsule;\r
+  UINT8                                  *Raw;\r
 } EFI_PEI_HOB_POINTERS;\r
 \r
-\r
 #endif\r