2 * Copyright (C) 2013, Intel Corporation
3 * Copyright (C) 2014, Bin Meng <bmeng.cn@gmail.com>
5 * SPDX-License-Identifier: Intel
8 #ifndef __FSP_SUPPORT_H__
9 #define __FSP_SUPPORT_H__
11 #include "fsp_types.h"
16 #include "fsp_platform.h"
17 #include "fsp_infoheader.h"
18 #include "fsp_bootmode.h"
19 #include <asm/arch/fsp/fsp_vpd.h>
22 struct fsp_header *fsp_hdr;
24 struct upd_region fsp_upd;
27 #define FSP_LOWMEM_BASE 0x100000UL
28 #define FSP_HIGHMEM_BASE 0x100000000ULL
29 #define UPD_TERMINATOR 0x55AA
33 * FSP Continuation assembly helper routine
35 * This routine jumps to the C version of FSP continuation function
37 void asm_continuation(void);
40 * FSP initialization complete
42 * This is the function that indicates FSP initialization is complete and jumps
43 * back to the bootloader with HOB list pointer as the parameter.
45 * @hob_list: HOB list pointer
47 void fsp_init_done(void *hob_list);
50 * FSP Continuation function
52 * @shared_data: Shared data base before stack migration
54 * @hob_list: HOB list pointer
56 * @retval: Never returns
58 void fsp_continue(struct shared_data *shared_data, u32 status,
62 * Find FSP header offset in FSP image
64 * @retval: the offset of FSP header. If signature is invalid, returns 0.
66 struct fsp_header *find_fsp_header(void);
69 * FSP initialization wrapper function.
71 * @stack_top: bootloader stack top address
72 * @boot_mode: boot mode defined in fsp_bootmode.h
73 * @nvs_buf: Non-volatile memory buffer pointer
75 void fsp_init(u32 stack_top, u32 boot_mode, void *nvs_buf);
78 * FSP notification wrapper function
80 * @fsp_hdr: Pointer to FSP information header
81 * @phase: FSP initialization phase defined in enum fsp_phase
83 * @retval: compatible status code with EFI_STATUS defined in PI spec
85 u32 fsp_notify(struct fsp_header *fsp_hdr, u32 phase);
88 * This function retrieves the top of usable low memory.
90 * @hob_list: A HOB list pointer.
92 * @retval: Usable low memory top.
94 u32 fsp_get_usable_lowmem_top(const void *hob_list);
97 * This function retrieves the top of usable high memory.
99 * @hob_list: A HOB list pointer.
101 * @retval: Usable high memory top.
103 u64 fsp_get_usable_highmem_top(const void *hob_list);
106 * This function retrieves a special reserved memory region.
108 * @hob_list: A HOB list pointer.
109 * @len: A pointer to the GUID HOB data buffer length.
110 * If the GUID HOB is located, the length will be updated.
111 * @guid: A pointer to the owner guild.
113 * @retval: Reserved region start address.
114 * 0 if this region does not exist.
116 u64 fsp_get_reserved_mem_from_guid(const void *hob_list,
117 u64 *len, struct efi_guid *guid);
120 * This function retrieves the FSP reserved normal memory.
122 * @hob_list: A HOB list pointer.
123 * @len: A pointer to the FSP reserved memory length buffer.
124 * If the GUID HOB is located, the length will be updated.
125 * @retval: FSP reserved memory base
126 * 0 if this region does not exist.
128 u32 fsp_get_fsp_reserved_mem(const void *hob_list, u32 *len);
131 * This function retrieves the TSEG reserved normal memory.
133 * @hob_list: A HOB list pointer.
134 * @len: A pointer to the TSEG reserved memory length buffer.
135 * If the GUID HOB is located, the length will be updated.
137 * @retval NULL: Failed to find the TSEG reserved memory.
138 * @retval others: TSEG reserved memory base.
140 u32 fsp_get_tseg_reserved_mem(const void *hob_list, u32 *len);
143 * Returns the next instance of a HOB type from the starting HOB.
145 * @type: HOB type to search
146 * @hob_list: A pointer to the HOB list
148 * @retval: A HOB object with matching type; Otherwise NULL.
150 const struct hob_header *fsp_get_next_hob(uint type, const void *hob_list);
153 * Returns the next instance of the matched GUID HOB from the starting HOB.
155 * @guid: GUID to search
156 * @hob_list: A pointer to the HOB list
158 * @retval: A HOB object with matching GUID; Otherwise NULL.
160 const struct hob_header *fsp_get_next_guid_hob(const struct efi_guid *guid,
161 const void *hob_list);
164 * This function retrieves a GUID HOB data buffer and size.
166 * @hob_list: A HOB list pointer.
167 * @len: A pointer to the GUID HOB data buffer length.
168 * If the GUID HOB is located, the length will be updated.
169 * @guid A pointer to HOB GUID.
171 * @retval NULL: Failed to find the GUID HOB.
172 * @retval others: GUID HOB data buffer pointer.
174 void *fsp_get_guid_hob_data(const void *hob_list, u32 *len,
175 struct efi_guid *guid);
178 * This function retrieves FSP Non-volatile Storage HOB buffer and size.
180 * @hob_list: A HOB list pointer.
181 * @len: A pointer to the NVS data buffer length.
182 * If the HOB is located, the length will be updated.
184 * @retval NULL: Failed to find the NVS HOB.
185 * @retval others: FSP NVS data buffer pointer.
187 void *fsp_get_nvs_data(const void *hob_list, u32 *len);
190 * This function retrieves Bootloader temporary stack buffer and size.
192 * @hob_list: A HOB list pointer.
193 * @len: A pointer to the bootloader temporary stack length.
194 * If the HOB is located, the length will be updated.
196 * @retval NULL: Failed to find the bootloader temporary stack HOB.
197 * @retval others: Bootloader temporary stackbuffer pointer.
199 void *fsp_get_bootloader_tmp_mem(const void *hob_list, u32 *len);
202 * This function overrides the default configurations in the UPD data region.
204 * @fsp_upd: A pointer to the upd_region data strcture
208 void update_fsp_upd(struct upd_region *fsp_upd);