2 * Copyright (C) 2013, Intel Corporation
3 * Copyright (C) 2014, Bin Meng <bmeng.cn@gmail.com>
5 * SPDX-License-Identifier: Intel
11 /* Type of HOB Header */
12 #define HOB_TYPE_MEM_ALLOC 0x0002
13 #define HOB_TYPE_RES_DESC 0x0003
14 #define HOB_TYPE_GUID_EXT 0x0004
15 #define HOB_TYPE_UNUSED 0xFFFE
16 #define HOB_TYPE_EOH 0xFFFF
19 * Describes the format and size of the data inside the HOB.
20 * All HOBs must contain this generic HOB header.
23 u16 type; /* HOB type */
24 u16 len; /* HOB length */
25 u32 reserved; /* always zero */
28 /* Enumeration of memory types introduced in UEFI */
30 EFI_RESERVED_MEMORY_TYPE,
32 * The code portions of a loaded application.
33 * (Note that UEFI OS loaders are UEFI applications.)
37 * The data portions of a loaded application and
38 * the default data allocation type used by an application
39 * to allocate pool memory.
42 /* The code portions of a loaded Boot Services Driver */
43 EFI_BOOT_SERVICES_CODE,
45 * The data portions of a loaded Boot Serves Driver and
46 * the default data allocation type used by a Boot Services
47 * Driver to allocate pool memory.
49 EFI_BOOT_SERVICES_DATA,
50 /* The code portions of a loaded Runtime Services Driver */
51 EFI_RUNTIME_SERVICES_CODE,
53 * The data portions of a loaded Runtime Services Driver and
54 * the default data allocation type used by a Runtime Services
55 * Driver to allocate pool memory.
57 EFI_RUNTIME_SERVICES_DATA,
58 /* Free (unallocated) memory */
59 EFI_CONVENTIONAL_MEMORY,
60 /* Memory in which errors have been detected */
62 /* Memory that holds the ACPI tables */
63 EFI_ACPI_RECLAIM_MEMORY,
64 /* Address space reserved for use by the firmware */
67 * Used by system firmware to request that a memory-mapped IO region
68 * be mapped by the OS to a virtual address so it can be accessed by
69 * EFI runtime services.
73 * System memory-mapped IO region that is used to translate
74 * memory cycles to IO cycles by the processor.
78 * Address space reserved by the firmware for code that is
79 * part of the processor.
86 * Describes all memory ranges used during the HOB producer phase that
87 * exist outside the HOB list. This HOB type describes how memory is used,
88 * not the physical attributes of memory.
90 struct hob_mem_alloc_t {
91 struct hob_header_t hdr;
93 * A GUID that defines the memory allocation region's type and purpose,
94 * as well as other fields within the memory allocation HOB. This GUID
95 * is used to define the additional data within the HOB that may be
96 * present for the memory allocation HOB. Type efi_guid_t is defined in
97 * InstallProtocolInterface() in the UEFI 2.0 specification.
99 struct efi_guid_t name;
101 * The base address of memory allocated by this HOB.
102 * Type phys_addr_t is defined in AllocatePages() in the UEFI 2.0
105 phys_addr_t mem_base;
106 /* The length in bytes of memory allocated by this HOB */
109 * Defines the type of memory allocated by this HOB.
110 * The memory type definition follows the EFI_MEMORY_TYPE definition.
111 * Type EFI_MEMORY_TYPE is defined in AllocatePages() in the UEFI 2.0
114 enum efi_mem_type_t mem_type;
119 /* Value of ResourceType in HOB_RES_DESC */
120 #define RES_SYS_MEM 0x00000000
121 #define RES_MMAP_IO 0x00000001
122 #define RES_IO 0x00000002
123 #define RES_FW_DEVICE 0x00000003
124 #define RES_MMAP_IO_PORT 0x00000004
125 #define RES_MEM_RESERVED 0x00000005
126 #define RES_IO_RESERVED 0x00000006
127 #define RES_MAX_MEM_TYPE 0x00000007
130 * These types can be ORed together as needed.
132 * The first three enumerations describe settings
133 * The rest of the settings describe capabilities
135 #define RES_ATTR_PRESENT 0x00000001
136 #define RES_ATTR_INITIALIZED 0x00000002
137 #define RES_ATTR_TESTED 0x00000004
138 #define RES_ATTR_SINGLE_BIT_ECC 0x00000008
139 #define RES_ATTR_MULTIPLE_BIT_ECC 0x00000010
140 #define RES_ATTR_ECC_RESERVED_1 0x00000020
141 #define RES_ATTR_ECC_RESERVED_2 0x00000040
142 #define RES_ATTR_READ_PROTECTED 0x00000080
143 #define RES_ATTR_WRITE_PROTECTED 0x00000100
144 #define RES_ATTR_EXECUTION_PROTECTED 0x00000200
145 #define RES_ATTR_UNCACHEABLE 0x00000400
146 #define RES_ATTR_WRITE_COMBINEABLE 0x00000800
147 #define RES_ATTR_WRITE_THROUGH_CACHEABLE 0x00001000
148 #define RES_ATTR_WRITE_BACK_CACHEABLE 0x00002000
149 #define RES_ATTR_16_BIT_IO 0x00004000
150 #define RES_ATTR_32_BIT_IO 0x00008000
151 #define RES_ATTR_64_BIT_IO 0x00010000
152 #define RES_ATTR_UNCACHED_EXPORTED 0x00020000
155 * Describes the resource properties of all fixed, nonrelocatable resource
156 * ranges found on the processor host bus during the HOB producer phase.
158 struct hob_res_desc_t {
159 struct hob_header_t hdr;
161 * A GUID representing the owner of the resource. This GUID is
162 * used by HOB consumer phase components to correlate device
163 * ownership of a resource.
165 struct efi_guid_t owner;
168 /* The physical start address of the resource region */
169 phys_addr_t phys_start;
170 /* The number of bytes of the resource region */
175 * Allows writers of executable content in the HOB producer phase to
176 * maintain and manage HOBs with specific GUID.
179 struct hob_header_t hdr;
180 /* A GUID that defines the contents of this HOB */
181 struct efi_guid_t name;
182 /* GUID specific data goes here */
185 /* Union of all the possible HOB Types */
186 union hob_pointers_t {
187 struct hob_header_t *hdr;
188 struct hob_mem_alloc_t *mem_alloc;
189 struct hob_res_desc_t *res_desc;
190 struct hob_guid_t *guid;
195 * Returns the type of a HOB.
197 * This macro returns the type field from the HOB header for the
198 * HOB specified by hob.
200 * @hob: A pointer to a HOB.
204 #define GET_HOB_TYPE(hob) \
205 ((*(struct hob_header_t **)&(hob))->type)
208 * Returns the length, in bytes, of a HOB.
210 * This macro returns the len field from the HOB header for the
211 * HOB specified by hob.
213 * @hob: A pointer to a HOB.
215 * @return: HOB length.
217 #define GET_HOB_LENGTH(hob) \
218 ((*(struct hob_header_t **)&(hob))->len)
221 * Returns a pointer to the next HOB in the HOB list.
223 * This macro returns a pointer to HOB that follows the HOB specified by hob
226 * @hob: A pointer to a HOB.
228 * @return: A pointer to the next HOB in the HOB list.
230 #define GET_NEXT_HOB(hob) \
231 (void *)(*(u8 **)&(hob) + GET_HOB_LENGTH(hob))
234 * Determines if a HOB is the last HOB in the HOB list.
236 * This macro determine if the HOB specified by hob is the last HOB in the
237 * HOB list. If hob is last HOB in the HOB list, then TRUE is returned.
238 * Otherwise, FALSE is returned.
240 * @hob: A pointer to a HOB.
242 * @retval TRUE: The HOB specified by hob is the last HOB in the HOB list.
243 * @retval FALSE: The HOB specified by hob is not the last HOB in the HOB list.
245 #define END_OF_HOB(hob) (GET_HOB_TYPE(hob) == (u16)HOB_TYPE_EOH)
248 * Returns a pointer to data buffer from a HOB of type HOB_TYPE_GUID_EXT.
250 * This macro returns a pointer to the data buffer in a HOB specified by hob.
251 * hob is assumed to be a HOB of type HOB_TYPE_GUID_EXT.
253 * @hob: A pointer to a HOB.
255 * @return: A pointer to the data buffer in a HOB.
257 #define GET_GUID_HOB_DATA(hob) \
258 (void *)(*(u8 **)&(hob) + sizeof(struct hob_guid_t))
261 * Returns the size of the data buffer from a HOB of type HOB_TYPE_GUID_EXT.
263 * This macro returns the size, in bytes, of the data buffer in a HOB
264 * specified by hob. hob is assumed to be a HOB of type HOB_TYPE_GUID_EXT.
266 * @hob: A pointer to a HOB.
268 * @return: The size of the data buffer.
270 #define GET_GUID_HOB_DATA_SIZE(hob) \
271 (u16)(GET_HOB_LENGTH(hob) - sizeof(struct hob_guid_t))
273 /* FSP specific GUID HOB definitions */
274 #define FSP_HEADER_GUID \
276 0x912740be, 0x2284, 0x4734, \
277 {0xb9, 0x71, 0x84, 0xb0, 0x27, 0x35, 0x3f, 0x0c} \
280 #define FSP_NON_VOLATILE_STORAGE_HOB_GUID \
282 0x721acf02, 0x4d77, 0x4c2a, \
283 { 0xb3, 0xdc, 0x27, 0xb, 0x7b, 0xa9, 0xe4, 0xb0 } \
286 #define FSP_BOOTLOADER_TEMP_MEM_HOB_GUID \
288 0xbbcff46c, 0xc8d3, 0x4113, \
289 { 0x89, 0x85, 0xb9, 0xd4, 0xf3, 0xb3, 0xf6, 0x4e } \
292 #define FSP_HOB_RESOURCE_OWNER_FSP_GUID \
294 0x69a79759, 0x1373, 0x4367, \
295 { 0xa6, 0xc4, 0xc7, 0xf5, 0x9e, 0xfd, 0x98, 0x6e } \
298 #define FSP_HOB_RESOURCE_OWNER_TSEG_GUID \
300 0xd038747c, 0xd00c, 0x4980, \
301 { 0xb3, 0x19, 0x49, 0x01, 0x99, 0xa4, 0x7d, 0x55 } \
304 #define FSP_HOB_RESOURCE_OWNER_GRAPHICS_GUID \
306 0x9c7c3aa7, 0x5332, 0x4917, \
307 { 0x82, 0xb9, 0x56, 0xa5, 0xf3, 0xe6, 0x2a, 0x07 } \