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   Module Name:  PiHob.h
  14
  15   @par Revision Reference:
  16   Version 1.0.
  17
  18 **/
  19
  20 #ifndef __PI_HOB_H__
  21 #define __PI_HOB_H__
  22
  23 //
  24 // HobType of EFI_HOB_GENERIC_HEADER.
  25 //
  26 #define EFI_HOB_TYPE_HANDOFF              0x0001
  27 #define EFI_HOB_TYPE_MEMORY_ALLOCATION    0x0002
  28 #define EFI_HOB_TYPE_RESOURCE_DESCRIPTOR  0x0003
  29 #define EFI_HOB_TYPE_GUID_EXTENSION       0x0004
  30 #define EFI_HOB_TYPE_FV                   0x0005
  31 #define EFI_HOB_TYPE_CPU                  0x0006
  32 #define EFI_HOB_TYPE_MEMORY_POOL          0x0007
  33 #define EFI_HOB_TYPE_FV2                  0x0009
  34 #define EFI_HOB_TYPE_LOAD_PEIM            0x000A
  35 #define EFI_HOB_TYPE_UNUSED               0xFFFE
  36 #define EFI_HOB_TYPE_END_OF_HOB_LIST      0xFFFF
  37
  38 //
  39 // Describes the format and size of the data inside the HOB.
  40 // All HOBs must contain this generic HOB header.
  41 //
  42 typedef struct {
  43   UINT16    HobType;
  44   UINT16    HobLength;
  45   UINT32    Reserved;
  46 } EFI_HOB_GENERIC_HEADER;
  47
  48
  49 //
  50 // Value of version ofinEFI_HOB_HANDOFF_INFO_TABLE.
  51 //
  52 #define EFI_HOB_HANDOFF_TABLE_VERSION 0x0009
  53 //
  54 // Contains general state information used by the HOB producer phase.
  55 // This HOB must be the first one in the HOB list.
  56 //
  57 typedef struct {
  58   EFI_HOB_GENERIC_HEADER  Header;
  59   UINT32                  Version;
  60   EFI_BOOT_MODE           BootMode;
  61   EFI_PHYSICAL_ADDRESS    EfiMemoryTop;
  62   EFI_PHYSICAL_ADDRESS    EfiMemoryBottom;
  63   EFI_PHYSICAL_ADDRESS    EfiFreeMemoryTop;
  64   EFI_PHYSICAL_ADDRESS    EfiFreeMemoryBottom;
  65   EFI_PHYSICAL_ADDRESS    EfiEndOfHobList;
  66 } EFI_HOB_HANDOFF_INFO_TABLE;
  67
  68
  69 typedef struct {
  70   EFI_GUID              Name;
  71   EFI_PHYSICAL_ADDRESS  MemoryBaseAddress;
  72   UINT64                MemoryLength;
  73   EFI_MEMORY_TYPE       MemoryType;
  74
  75   //
  76   // Padding for Itanium processor family
  77   //
  78   UINT8                 Reserved[4];
  79 } EFI_HOB_MEMORY_ALLOCATION_HEADER;
  80
  81 //
  82 // Describes all memory ranges used during the HOB producer
  83 // phase that exist outside the HOB list. This HOB type
  84 // describes how memory is used,
  85 // not the physical attributes of memory.
  86 //
  87 typedef struct {
  88   EFI_HOB_GENERIC_HEADER            Header;
  89   EFI_HOB_MEMORY_ALLOCATION_HEADER  AllocDescriptor;
  90   //
  91   // Additional data pertaining to the ¡°Name¡± Guid memory
  92   // may go here.
  93   //
  94 } EFI_HOB_MEMORY_ALLOCATION;
  95
  96
  97 //
  98 // Describes the memory stack that is produced by the HOB producer
  99 // phase and upon which all postmemory-installed executable
 100 // content in the HOB producer phase is executing.
 101 //
 102 typedef struct {
 103   EFI_HOB_GENERIC_HEADER            Header;
 104   EFI_HOB_MEMORY_ALLOCATION_HEADER  AllocDescriptor;
 105 } EFI_HOB_MEMORY_ALLOCATION_STACK;
 106
 107 //
 108 // Defines the location of the boot-strap
 109 // processor (BSP) BSPStore (¡°Backing Store Pointer Store¡±).
 110 // This HOB is valid for the Itanium processor family only
 111 // register overflow store.
 112 //
 113 typedef struct {
 114   EFI_HOB_GENERIC_HEADER            Header;
 115   EFI_HOB_MEMORY_ALLOCATION_HEADER  AllocDescriptor;
 116 } EFI_HOB_MEMORY_ALLOCATION_BSP_STORE;
 117
 118 //
 119 // Defines the location and entry point of the HOB consumer phase.
 120 //
 121 typedef struct {
 122   EFI_HOB_GENERIC_HEADER            Header;
 123   EFI_HOB_MEMORY_ALLOCATION_HEADER  MemoryAllocationHeader;
 124   EFI_GUID ModuleName;
 125   EFI_PHYSICAL_ADDRESS EntryPoint;
 126 } EFI_HOB_MEMORY_ALLOCATION_MODULE;
 127
 128 typedef UINT32 EFI_RESOURCE_TYPE;
 129
 130 //
 131 // Value of ResourceType in EFI_HOB_RESOURCE_DESCRIPTOR.
 132 //
 133 #define EFI_RESOURCE_SYSTEM_MEMORY          0x00000000
 134 #define EFI_RESOURCE_MEMORY_MAPPED_IO       0x00000001
 135 #define EFI_RESOURCE_IO                     0x00000002
 136 #define EFI_RESOURCE_FIRMWARE_DEVICE        0x00000003
 137 #define EFI_RESOURCE_MEMORY_MAPPED_IO_PORT  0x00000004
 138 #define EFI_RESOURCE_MEMORY_RESERVED        0x00000005
 139 #define EFI_RESOURCE_IO_RESERVED            0x00000006
 140 #define EFI_RESOURCE_MAX_MEMORY_TYPE        0x00000007
 141
 142
 143 typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE;
 144
 145 //
 146 // These types can be ORed together as needed.
 147 //
 148 // The first three enumerations describe settings
 149 //
 150 #define EFI_RESOURCE_ATTRIBUTE_PRESENT              0x00000001
 151 #define EFI_RESOURCE_ATTRIBUTE_INITIALIZED          0x00000002
 152 #define EFI_RESOURCE_ATTRIBUTE_TESTED               0x00000004
 153 //
 154 // The rest of the settings describe capabilities
 155 //
 156 #define EFI_RESOURCE_ATTRIBUTE_SINGLE_BIT_ECC       0x00000008
 157 #define EFI_RESOURCE_ATTRIBUTE_MULTIPLE_BIT_ECC     0x00000010
 158 #define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_1       0x00000020
 159 #define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_2       0x00000040
 160 #define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTED       0x00000080
 161 #define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED      0x00000100
 162 #define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTED  0x00000200
 163 #define EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE          0x00000400
 164 #define EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE    0x00000800
 165 #define EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE  0x00001000
 166 #define EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE 0x00002000
 167 #define EFI_RESOURCE_ATTRIBUTE_16_BIT_IO            0x00004000
 168 #define EFI_RESOURCE_ATTRIBUTE_32_BIT_IO            0x00008000
 169 #define EFI_RESOURCE_ATTRIBUTE_64_BIT_IO            0x00010000
 170 #define EFI_RESOURCE_ATTRIBUTE_UNCACHED_EXPORTED    0x00020000
 171
 172 //
 173 // Describes the resource properties of all fixed,
 174 // nonrelocatable resource ranges found on the processor
 175 // host bus during the HOB producer phase.
 176 //
 177 typedef struct {
 178   EFI_HOB_GENERIC_HEADER      Header;
 179   EFI_GUID                    Owner;
 180   EFI_RESOURCE_TYPE           ResourceType;
 181   EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute;
 182   EFI_PHYSICAL_ADDRESS        PhysicalStart;
 183   UINT64                      ResourceLength;
 184 } EFI_HOB_RESOURCE_DESCRIPTOR;
 185
 186 //
 187 // Allows writers of executable content in the HOB producer phase to
 188 // maintain and manage HOBs with specific GUID.
 189 //
 190 typedef struct {
 191   EFI_HOB_GENERIC_HEADER      Header;
 192   EFI_GUID                    Name;
 193
 194   //
 195   // Guid specific data goes here
 196   //
 197 } EFI_HOB_GUID_TYPE;
 198
 199 //
 200 // Details the location of firmware volumes that contain firmware files.
 201 //
 202 typedef struct {
 203   EFI_HOB_GENERIC_HEADER Header;
 204   EFI_PHYSICAL_ADDRESS BaseAddress;
 205   UINT64 Length;
 206 } EFI_HOB_FIRMWARE_VOLUME;
 207
 208 //
 209 // Details the location of a firmware volume which was extracted
 210 // from a file within another firmware volume.
 211 //
 212 typedef struct {
 213   EFI_HOB_GENERIC_HEADER  Header;
 214   EFI_PHYSICAL_ADDRESS    BaseAddress;
 215   UINT64                  Length;
 216   EFI_GUID                FvName;
 217   EFI_GUID                FileName;
 218 } EFI_HOB_FIRMWARE_VOLUME2;
 219
 220
 221 //
 222 // Describes processor information, such as address space and I/O space capabilities.
 223 //
 224 typedef struct {
 225   EFI_HOB_GENERIC_HEADER  Header;
 226   UINT8                   SizeOfMemorySpace;
 227   UINT8                   SizeOfIoSpace;
 228   UINT8                   Reserved[6];
 229 } EFI_HOB_CPU;
 230
 231
 232 //
 233 // Describes pool memory allocations.
 234 //
 235 typedef struct {
 236   EFI_HOB_GENERIC_HEADER  Header;
 237 } EFI_HOB_MEMORY_POOL;
 238
 239 //
 240 // Union of all the possible HOB Types
 241 //
 242 typedef union {
 243   EFI_HOB_GENERIC_HEADER              *Header;
 244   EFI_HOB_HANDOFF_INFO_TABLE          *HandoffInformationTable;
 245   EFI_HOB_MEMORY_ALLOCATION           *MemoryAllocation;
 246   EFI_HOB_MEMORY_ALLOCATION_BSP_STORE *MemoryAllocationBspStore;
 247   EFI_HOB_MEMORY_ALLOCATION_STACK     *MemoryAllocationStack;
 248   EFI_HOB_MEMORY_ALLOCATION_MODULE    *MemoryAllocationModule;
 249   EFI_HOB_RESOURCE_DESCRIPTOR         *ResourceDescriptor;
 250   EFI_HOB_GUID_TYPE                   *Guid;
 251   EFI_HOB_FIRMWARE_VOLUME             *FirmwareVolume;
 252   EFI_HOB_CPU                         *Cpu;
 253   EFI_HOB_MEMORY_POOL                 *Pool;
 254   UINT8                               *Raw;
 255 } EFI_PEI_HOB_POINTERS;
 256
 257
 258 #endif