2 * Copyright (C) 2013, Intel Corporation
3 * Copyright (C) 2014, Bin Meng <bmeng.cn@gmail.com>
5 * SPDX-License-Identifier: Intel
9 #include <asm/fsp/fsp_support.h>
15 * If the GUIDs are identical then true is returned.
16 * If there are any bit differences in the two GUIDs, then false is returned.
18 * @guid1: A pointer to a 128 bit GUID.
19 * @guid2: A pointer to a 128 bit GUID.
21 * @retval true: guid1 and guid2 are identical.
22 * @retval false: guid1 and guid2 are not identical.
24 static bool compare_guid(const struct efi_guid
*guid1
,
25 const struct efi_guid
*guid2
)
27 if (memcmp(guid1
, guid2
, sizeof(struct efi_guid
)) == 0)
33 struct fsp_header
*__attribute__((optimize("O0"))) find_fsp_header(void)
36 * This function may be called before the a stack is established,
37 * so special care must be taken. First, it cannot declare any local
38 * variable using stack. Only register variable can be used here.
39 * Secondly, some compiler version will add prolog or epilog code
40 * for the C function. If so the function call may not work before
43 * GCC 4.8.1 has been verified to be working for the following codes.
45 volatile register u8
*fsp
asm("eax");
47 /* Initalize the FSP base */
48 fsp
= (u8
*)CONFIG_FSP_ADDR
;
50 /* Check the FV signature, _FVH */
51 if (((struct fv_header
*)fsp
)->sign
== EFI_FVH_SIGNATURE
) {
52 /* Go to the end of the FV header and align the address */
53 fsp
+= ((struct fv_header
*)fsp
)->ext_hdr_off
;
54 fsp
+= ((struct fv_ext_header
*)fsp
)->ext_hdr_size
;
55 fsp
= (u8
*)(((u32
)fsp
+ 7) & 0xFFFFFFF8);
60 /* Check the FFS GUID */
62 ((struct ffs_file_header
*)fsp
)->name
.data1
== FSP_GUID_DATA1
&&
63 ((struct ffs_file_header
*)fsp
)->name
.data2
== FSP_GUID_DATA2
&&
64 ((struct ffs_file_header
*)fsp
)->name
.data3
== FSP_GUID_DATA3
&&
65 ((struct ffs_file_header
*)fsp
)->name
.data4
[0] == FSP_GUID_DATA4_0
&&
66 ((struct ffs_file_header
*)fsp
)->name
.data4
[1] == FSP_GUID_DATA4_1
&&
67 ((struct ffs_file_header
*)fsp
)->name
.data4
[2] == FSP_GUID_DATA4_2
&&
68 ((struct ffs_file_header
*)fsp
)->name
.data4
[3] == FSP_GUID_DATA4_3
&&
69 ((struct ffs_file_header
*)fsp
)->name
.data4
[4] == FSP_GUID_DATA4_4
&&
70 ((struct ffs_file_header
*)fsp
)->name
.data4
[5] == FSP_GUID_DATA4_5
&&
71 ((struct ffs_file_header
*)fsp
)->name
.data4
[6] == FSP_GUID_DATA4_6
&&
72 ((struct ffs_file_header
*)fsp
)->name
.data4
[7] == FSP_GUID_DATA4_7
) {
73 /* Add the FFS header size to find the raw section header */
74 fsp
+= sizeof(struct ffs_file_header
);
80 ((struct raw_section
*)fsp
)->type
== EFI_SECTION_RAW
) {
81 /* Add the raw section header size to find the FSP header */
82 fsp
+= sizeof(struct raw_section
);
87 return (struct fsp_header
*)fsp
;
90 void fsp_continue(struct shared_data
*shared_data
, u32 status
, void *hob_list
)
100 /* Get the migrated stack in normal memory */
101 stack_base
= (u32
)fsp_get_bootloader_tmp_mem(hob_list
, &stack_len
);
102 assert(stack_base
!= 0);
103 stack_top
= stack_base
+ stack_len
- sizeof(u32
);
106 * Old stack base is stored at the very end of the stack top,
107 * use it to calculate the migrated shared data base
109 shared_data
= (struct shared_data
*)(stack_base
+
110 ((u32
)shared_data
- *(u32
*)stack_top
));
112 /* The boot loader main function entry */
113 fsp_init_done(hob_list
);
116 void fsp_init(u32 stack_top
, u32 boot_mode
, void *nvs_buf
)
118 struct shared_data shared_data
;
120 struct fsp_init_params params
;
121 struct fspinit_rtbuf rt_buf
;
122 struct vpd_region
*fsp_vpd
;
123 struct fsp_header
*fsp_hdr
;
124 struct fsp_init_params
*params_ptr
;
125 struct upd_region
*fsp_upd
;
127 fsp_hdr
= (struct fsp_header
*)find_fsp_header();
128 if (fsp_hdr
== NULL
) {
129 /* No valid FSP info header was found */
130 panic("Invalid FSP header");
133 fsp_upd
= (struct upd_region
*)&shared_data
.fsp_upd
;
134 memset(&rt_buf
, 0, sizeof(struct fspinit_rtbuf
));
136 /* Reserve a gap in stack top */
137 rt_buf
.common
.stack_top
= (u32
*)stack_top
- 32;
138 rt_buf
.common
.boot_mode
= boot_mode
;
139 rt_buf
.common
.upd_data
= (struct upd_region
*)fsp_upd
;
141 /* Get VPD region start */
142 fsp_vpd
= (struct vpd_region
*)(fsp_hdr
->img_base
+
143 fsp_hdr
->cfg_region_off
);
145 /* Verifify the VPD data region is valid */
146 assert((fsp_vpd
->img_rev
== VPD_IMAGE_REV
) &&
147 (fsp_vpd
->sign
== VPD_IMAGE_ID
));
149 /* Copy default data from Flash */
150 memcpy(fsp_upd
, (void *)(fsp_hdr
->img_base
+ fsp_vpd
->upd_offset
),
151 sizeof(struct upd_region
));
153 /* Verifify the UPD data region is valid */
154 assert(fsp_upd
->terminator
== UPD_TERMINATOR
);
156 /* Override any UPD setting if required */
157 update_fsp_upd(fsp_upd
);
159 memset(¶ms
, 0, sizeof(struct fsp_init_params
));
160 params
.nvs_buf
= nvs_buf
;
161 params
.rt_buf
= (struct fspinit_rtbuf
*)&rt_buf
;
162 params
.continuation
= (fsp_continuation_f
)asm_continuation
;
164 init
= (fsp_init_f
)(fsp_hdr
->img_base
+ fsp_hdr
->fsp_init
);
165 params_ptr
= ¶ms
;
167 shared_data
.fsp_hdr
= fsp_hdr
;
168 shared_data
.stack_top
= (u32
*)stack_top
;
170 post_code(POST_PRE_MRC
);
173 * Use ASM code to ensure the register value in EAX & ECX
174 * will be passed into BlContinuationFunc
179 ".global asm_continuation;"
181 "movl %%ebx, %%eax;" /* shared_data */
182 "movl 4(%%esp), %%edx;" /* status */
183 "movl 8(%%esp), %%ecx;" /* hob_list */
185 : : "m"(params_ptr
), "a"(init
), "b"(&shared_data
)
189 * Should never get here.
190 * Control will continue from fsp_continue.
191 * This line below is to prevent the compiler from optimizing
192 * structure intialization.
199 u32
fsp_notify(struct fsp_header
*fsp_hdr
, u32 phase
)
202 struct fsp_notify_params params
;
203 struct fsp_notify_params
*params_ptr
;
207 fsp_hdr
= (struct fsp_header
*)find_fsp_header();
209 if (fsp_hdr
== NULL
) {
210 /* No valid FSP info header */
211 panic("Invalid FSP header");
214 notify
= (fsp_notify_f
)(fsp_hdr
->img_base
+ fsp_hdr
->fsp_notify
);
215 params
.phase
= phase
;
216 params_ptr
= ¶ms
;
219 * Use ASM code to ensure correct parameter is on the stack for
220 * FspNotify as U-Boot is using different ABI from FSP
223 "pushl %1;" /* push notify phase */
224 "call *%%eax;" /* call FspNotify */
225 "addl $4, %%esp;" /* clean up the stack */
226 : "=a"(status
) : "m"(params_ptr
), "a"(notify
), "m"(*params_ptr
)
232 u32
fsp_get_usable_lowmem_top(const void *hob_list
)
234 const struct hob_header
*hdr
;
235 struct hob_res_desc
*res_desc
;
236 phys_addr_t phys_start
;
239 /* Get the HOB list for processing */
242 /* * Collect memory ranges */
243 top
= FSP_LOWMEM_BASE
;
244 while (!end_of_hob(hdr
)) {
245 if (hdr
->type
== HOB_TYPE_RES_DESC
) {
246 res_desc
= (struct hob_res_desc
*)hdr
;
247 if (res_desc
->type
== RES_SYS_MEM
) {
248 phys_start
= res_desc
->phys_start
;
249 /* Need memory above 1MB to be collected here */
250 if (phys_start
>= FSP_LOWMEM_BASE
&&
251 phys_start
< (phys_addr_t
)FSP_HIGHMEM_BASE
)
252 top
+= (u32
)(res_desc
->len
);
255 hdr
= get_next_hob(hdr
);
261 u64
fsp_get_usable_highmem_top(const void *hob_list
)
263 const struct hob_header
*hdr
;
264 struct hob_res_desc
*res_desc
;
265 phys_addr_t phys_start
;
268 /* Get the HOB list for processing */
271 /* Collect memory ranges */
272 top
= FSP_HIGHMEM_BASE
;
273 while (!end_of_hob(hdr
)) {
274 if (hdr
->type
== HOB_TYPE_RES_DESC
) {
275 res_desc
= (struct hob_res_desc
*)hdr
;
276 if (res_desc
->type
== RES_SYS_MEM
) {
277 phys_start
= res_desc
->phys_start
;
278 /* Need memory above 1MB to be collected here */
279 if (phys_start
>= (phys_addr_t
)FSP_HIGHMEM_BASE
)
280 top
+= (u32
)(res_desc
->len
);
283 hdr
= get_next_hob(hdr
);
289 u64
fsp_get_reserved_mem_from_guid(const void *hob_list
, u64
*len
,
290 struct efi_guid
*guid
)
292 const struct hob_header
*hdr
;
293 struct hob_res_desc
*res_desc
;
295 /* Get the HOB list for processing */
298 /* Collect memory ranges */
299 while (!end_of_hob(hdr
)) {
300 if (hdr
->type
== HOB_TYPE_RES_DESC
) {
301 res_desc
= (struct hob_res_desc
*)hdr
;
302 if (res_desc
->type
== RES_MEM_RESERVED
) {
303 if (compare_guid(&res_desc
->owner
, guid
)) {
305 *len
= (u32
)(res_desc
->len
);
307 return (u64
)(res_desc
->phys_start
);
311 hdr
= get_next_hob(hdr
);
317 u32
fsp_get_fsp_reserved_mem(const void *hob_list
, u32
*len
)
319 const struct efi_guid guid
= FSP_HOB_RESOURCE_OWNER_FSP_GUID
;
323 base
= (u32
)fsp_get_reserved_mem_from_guid(hob_list
,
324 &length
, (struct efi_guid
*)&guid
);
325 if ((len
!= 0) && (base
!= 0))
331 u32
fsp_get_tseg_reserved_mem(const void *hob_list
, u32
*len
)
333 const struct efi_guid guid
= FSP_HOB_RESOURCE_OWNER_TSEG_GUID
;
337 base
= (u32
)fsp_get_reserved_mem_from_guid(hob_list
,
338 &length
, (struct efi_guid
*)&guid
);
339 if ((len
!= 0) && (base
!= 0))
345 const struct hob_header
*fsp_get_next_hob(uint type
, const void *hob_list
)
347 const struct hob_header
*hdr
;
351 /* Parse the HOB list until end of list or matching type is found */
352 while (!end_of_hob(hdr
)) {
353 if (hdr
->type
== type
)
356 hdr
= get_next_hob(hdr
);
362 const struct hob_header
*fsp_get_next_guid_hob(const struct efi_guid
*guid
,
363 const void *hob_list
)
365 const struct hob_header
*hdr
;
366 struct hob_guid
*guid_hob
;
369 while ((hdr
= fsp_get_next_hob(HOB_TYPE_GUID_EXT
,
371 guid_hob
= (struct hob_guid
*)hdr
;
372 if (compare_guid(guid
, &(guid_hob
->name
)))
374 hdr
= get_next_hob(hdr
);
380 void *fsp_get_guid_hob_data(const void *hob_list
, u32
*len
,
381 struct efi_guid
*guid
)
383 const struct hob_header
*guid_hob
;
385 guid_hob
= fsp_get_next_guid_hob(guid
, hob_list
);
386 if (guid_hob
== NULL
) {
390 *len
= get_guid_hob_data_size(guid_hob
);
392 return get_guid_hob_data(guid_hob
);
396 void *fsp_get_nvs_data(const void *hob_list
, u32
*len
)
398 const struct efi_guid guid
= FSP_NON_VOLATILE_STORAGE_HOB_GUID
;
400 return fsp_get_guid_hob_data(hob_list
, len
, (struct efi_guid
*)&guid
);
403 void *fsp_get_bootloader_tmp_mem(const void *hob_list
, u32
*len
)
405 const struct efi_guid guid
= FSP_BOOTLOADER_TEMP_MEM_HOB_GUID
;
407 return fsp_get_guid_hob_data(hob_list
, len
, (struct efi_guid
*)&guid
);