MdePkg/Include/Pi/PiHob.h

   1 /** @file
   2   HOB related definitions in PI.
   3
   4   Copyright (c) 2006 - 2007, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13   @par Revision Reference:
  14   Version 1.0.
  15
  16 **/
  17
  18 #ifndef __PI_HOB_H__
  19 #define __PI_HOB_H__
  20
  21 #include <ProcessorBind.h>
  22 #include <Pi/PiBootMode.h>
  23 #include <Uefi/UefiBaseType.h>
  24 #include <Uefi/UefiMultiPhase.h>
  25
  26 //
  27 // HobType of EFI_HOB_GENERIC_HEADER.
  28 //
  29 #define EFI_HOB_TYPE_HANDOFF              0x0001
  30 #define EFI_HOB_TYPE_MEMORY_ALLOCATION    0x0002
  31 #define EFI_HOB_TYPE_RESOURCE_DESCRIPTOR  0x0003
  32 #define EFI_HOB_TYPE_GUID_EXTENSION       0x0004
  33 #define EFI_HOB_TYPE_FV                   0x0005
  34 #define EFI_HOB_TYPE_CPU                  0x0006
  35 #define EFI_HOB_TYPE_MEMORY_POOL          0x0007
  36 #define EFI_HOB_TYPE_FV2                  0x0009
  37 #define EFI_HOB_TYPE_LOAD_PEIM            0x000A
  38 #define EFI_HOB_TYPE_UNUSED               0xFFFE
  39 #define EFI_HOB_TYPE_END_OF_HOB_LIST      0xFFFF
  40
  41 ///
  42 /// Describes the format and size of the data inside the HOB.
  43 /// All HOBs must contain this generic HOB header.
  44 ///
  45 typedef struct {
  46   UINT16    HobType;
  47   UINT16    HobLength;
  48   UINT32    Reserved;
  49 } EFI_HOB_GENERIC_HEADER;
  50
  51
  52 ///
  53 /// Value of version ofinEFI_HOB_HANDOFF_INFO_TABLE.
  54 ///
  55 #define EFI_HOB_HANDOFF_TABLE_VERSION 0x0009
  56
  57 ///
  58 /// Contains general state information used by the HOB producer phase.
  59 /// This HOB must be the first one in the HOB list.
  60 ///
  61 typedef struct {
  62   EFI_HOB_GENERIC_HEADER  Header;
  63   UINT32                  Version;
  64   EFI_BOOT_MODE           BootMode;
  65   EFI_PHYSICAL_ADDRESS    EfiMemoryTop;
  66   EFI_PHYSICAL_ADDRESS    EfiMemoryBottom;
  67   EFI_PHYSICAL_ADDRESS    EfiFreeMemoryTop;
  68   EFI_PHYSICAL_ADDRESS    EfiFreeMemoryBottom;
  69   EFI_PHYSICAL_ADDRESS    EfiEndOfHobList;
  70 } EFI_HOB_HANDOFF_INFO_TABLE;
  71
  72 /// EFI_HOB_MEMORY_ALLOCATION_HEADER describes the
  73 /// various attributes of the logical memory allocation. The type field will be used for
  74 /// subsequent inclusion in the UEFI memory map.
  75 typedef struct {
  76   ///
  77   /// A GUID that defines the memory allocation region¡¯s type and purpose, as well as
  78   /// other fields within the memory allocation HOB. This GUID is used to define the
  79   /// additional data within the HOB that may be present for the memory allocation HOB.
  80   /// Type EFI_GUID is defined in InstallProtocolInterface() in the UEFI 2.0
  81   /// specification.
  82   ///
  83   EFI_GUID              Name;
  84
  85   /// The base address of memory allocated by this HOB. Type
  86   /// EFI_PHYSICAL_ADDRESS is defined in AllocatePages() in the UEFI 2.0
  87   /// specification.
  88   EFI_PHYSICAL_ADDRESS  MemoryBaseAddress;
  89
  90   /// The length in bytes of memory allocated by this HOB.
  91   UINT64                MemoryLength;
  92
  93   ///
  94   /// Defines the type of memory allocated by this HOB. The memory type definition
  95   /// follows the EFI_MEMORY_TYPE definition. Type EFI_MEMORY_TYPE is defined
  96   /// in AllocatePages() in the UEFI 2.0 specification.
  97   ///
  98   EFI_MEMORY_TYPE       MemoryType;
  99
 100   ///
 101   /// Padding for Itanium processor family
 102   ///
 103   UINT8                 Reserved[4];
 104 } EFI_HOB_MEMORY_ALLOCATION_HEADER;
 105
 106 ///
 107 /// Describes all memory ranges used during the HOB producer
 108 /// phase that exist outside the HOB list. This HOB type
 109 /// describes how memory is used,
 110 /// not the physical attributes of memory.
 111 ///
 112 typedef struct {
 113   EFI_HOB_GENERIC_HEADER            Header;
 114   EFI_HOB_MEMORY_ALLOCATION_HEADER  AllocDescriptor;
 115   //
 116   // Additional data pertaining to the "Name" Guid memory
 117   // may go here.
 118   //
 119 } EFI_HOB_MEMORY_ALLOCATION;
 120
 121
 122 ///
 123 /// Describes the memory stack that is produced by the HOB producer
 124 /// phase and upon which all postmemory-installed executable
 125 /// content in the HOB producer phase is executing.
 126 ///
 127 typedef struct {
 128   EFI_HOB_GENERIC_HEADER            Header;
 129   EFI_HOB_MEMORY_ALLOCATION_HEADER  AllocDescriptor;
 130 } EFI_HOB_MEMORY_ALLOCATION_STACK;
 131
 132 ///
 133 /// Defines the location of the boot-strap
 134 /// processor (BSP) BSPStore ("Backing Store Pointer Store").
 135 /// This HOB is valid for the Itanium processor family only
 136 /// register overflow store.
 137 ///
 138 typedef struct {
 139   EFI_HOB_GENERIC_HEADER            Header;
 140   EFI_HOB_MEMORY_ALLOCATION_HEADER  AllocDescriptor;
 141 } EFI_HOB_MEMORY_ALLOCATION_BSP_STORE;
 142
 143 ///
 144 /// Defines the location and entry point of the HOB consumer phase.
 145 ///
 146 typedef struct {
 147   EFI_HOB_GENERIC_HEADER            Header;
 148   EFI_HOB_MEMORY_ALLOCATION_HEADER  MemoryAllocationHeader;
 149   EFI_GUID ModuleName;
 150   EFI_PHYSICAL_ADDRESS EntryPoint;
 151 } EFI_HOB_MEMORY_ALLOCATION_MODULE;
 152
 153 ///
 154 /// type of Recount type
 155 ///
 156 typedef UINT32 EFI_RESOURCE_TYPE;
 157
 158 //
 159 // Value of ResourceType in EFI_HOB_RESOURCE_DESCRIPTOR.
 160 //
 161 #define EFI_RESOURCE_SYSTEM_MEMORY          0x00000000
 162 #define EFI_RESOURCE_MEMORY_MAPPED_IO       0x00000001
 163 #define EFI_RESOURCE_IO                     0x00000002
 164 #define EFI_RESOURCE_FIRMWARE_DEVICE        0x00000003
 165 #define EFI_RESOURCE_MEMORY_MAPPED_IO_PORT  0x00000004
 166 #define EFI_RESOURCE_MEMORY_RESERVED        0x00000005
 167 #define EFI_RESOURCE_IO_RESERVED            0x00000006
 168 #define EFI_RESOURCE_MAX_MEMORY_TYPE        0x00000007
 169
 170 ///
 171 /// type of recount attribute type
 172 ///
 173 typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE;
 174
 175 //
 176 // These types can be ORed together as needed.
 177 //
 178 // The first three enumerations describe settings
 179 //
 180 #define EFI_RESOURCE_ATTRIBUTE_PRESENT              0x00000001
 181 #define EFI_RESOURCE_ATTRIBUTE_INITIALIZED          0x00000002
 182 #define EFI_RESOURCE_ATTRIBUTE_TESTED               0x00000004
 183 //
 184 // The rest of the settings describe capabilities
 185 //
 186 #define EFI_RESOURCE_ATTRIBUTE_SINGLE_BIT_ECC       0x00000008
 187 #define EFI_RESOURCE_ATTRIBUTE_MULTIPLE_BIT_ECC     0x00000010
 188 #define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_1       0x00000020
 189 #define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_2       0x00000040
 190 #define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTED       0x00000080
 191 #define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED      0x00000100
 192 #define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTED  0x00000200
 193 #define EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE          0x00000400
 194 #define EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE    0x00000800
 195 #define EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE  0x00001000
 196 #define EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE 0x00002000
 197 #define EFI_RESOURCE_ATTRIBUTE_16_BIT_IO            0x00004000
 198 #define EFI_RESOURCE_ATTRIBUTE_32_BIT_IO            0x00008000
 199 #define EFI_RESOURCE_ATTRIBUTE_64_BIT_IO            0x00010000
 200 #define EFI_RESOURCE_ATTRIBUTE_UNCACHED_EXPORTED    0x00020000
 201
 202 ///
 203 /// Describes the resource properties of all fixed,
 204 /// nonrelocatable resource ranges found on the processor
 205 /// host bus during the HOB producer phase.
 206 ///
 207 typedef struct {
 208   EFI_HOB_GENERIC_HEADER      Header;
 209   EFI_GUID                    Owner;
 210   EFI_RESOURCE_TYPE           ResourceType;
 211   EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute;
 212   EFI_PHYSICAL_ADDRESS        PhysicalStart;
 213   UINT64                      ResourceLength;
 214 } EFI_HOB_RESOURCE_DESCRIPTOR;
 215
 216 ///
 217 /// Allows writers of executable content in the HOB producer phase to
 218 /// maintain and manage HOBs with specific GUID.
 219 ///
 220 typedef struct {
 221   EFI_HOB_GENERIC_HEADER      Header;
 222   EFI_GUID                    Name;
 223
 224   ///
 225   /// Guid specific data goes here
 226   ///
 227 } EFI_HOB_GUID_TYPE;
 228
 229 ///
 230 /// Details the location of firmware volumes that contain firmware files.
 231 ///
 232 typedef struct {
 233   EFI_HOB_GENERIC_HEADER Header;
 234   EFI_PHYSICAL_ADDRESS BaseAddress;
 235   UINT64 Length;
 236 } EFI_HOB_FIRMWARE_VOLUME;
 237
 238 ///
 239 /// Details the location of a firmware volume which was extracted
 240 /// from a file within another firmware volume.
 241 ///
 242 typedef struct {
 243   EFI_HOB_GENERIC_HEADER  Header;
 244   EFI_PHYSICAL_ADDRESS    BaseAddress;
 245   UINT64                  Length;
 246   EFI_GUID                FvName;
 247   EFI_GUID                FileName;
 248 } EFI_HOB_FIRMWARE_VOLUME2;
 249
 250
 251 ///
 252 /// Describes processor information, such as address space and I/O space capabilities.
 253 ///
 254 typedef struct {
 255   EFI_HOB_GENERIC_HEADER  Header;
 256   UINT8                   SizeOfMemorySpace;
 257   UINT8                   SizeOfIoSpace;
 258   UINT8                   Reserved[6];
 259 } EFI_HOB_CPU;
 260
 261
 262 ///
 263 /// Describes pool memory allocations.
 264 ///
 265 typedef struct {
 266   EFI_HOB_GENERIC_HEADER  Header;
 267 } EFI_HOB_MEMORY_POOL;
 268
 269 ///
 270 /// Union of all the possible HOB Types
 271 ///
 272 typedef union {
 273   EFI_HOB_GENERIC_HEADER              *Header;
 274   EFI_HOB_HANDOFF_INFO_TABLE          *HandoffInformationTable;
 275   EFI_HOB_MEMORY_ALLOCATION           *MemoryAllocation;
 276   EFI_HOB_MEMORY_ALLOCATION_BSP_STORE *MemoryAllocationBspStore;
 277   EFI_HOB_MEMORY_ALLOCATION_STACK     *MemoryAllocationStack;
 278   EFI_HOB_MEMORY_ALLOCATION_MODULE    *MemoryAllocationModule;
 279   EFI_HOB_RESOURCE_DESCRIPTOR         *ResourceDescriptor;
 280   EFI_HOB_GUID_TYPE                   *Guid;
 281   EFI_HOB_FIRMWARE_VOLUME             *FirmwareVolume;
 282   EFI_HOB_FIRMWARE_VOLUME2            *FirmwareVolume2;
 283   EFI_HOB_CPU                         *Cpu;
 284   EFI_HOB_MEMORY_POOL                 *Pool;
 285   UINT8                               *Raw;
 286 } EFI_PEI_HOB_POINTERS;
 287
 288
 289 #endif