1 /* 2 * Copyright (C) 2013, Intel Corporation 3 * Copyright (C) 2014, Bin Meng <bmeng.cn@gmail.com> 4 * 5 * SPDX-License-Identifier: Intel 6 */ 7 8 #include <common.h> 9 #include <asm/fsp/fsp_support.h> 10 #include <asm/post.h> 11 12 /** 13 * Compares two GUIDs 14 * 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. 17 * 18 * @guid1: A pointer to a 128 bit GUID. 19 * @guid2: A pointer to a 128 bit GUID. 20 * 21 * @retval true: guid1 and guid2 are identical. 22 * @retval false: guid1 and guid2 are not identical. 23 */ 24 static bool compare_guid(const struct efi_guid *guid1, 25 const struct efi_guid *guid2) 26 { 27 if (memcmp(guid1, guid2, sizeof(struct efi_guid)) == 0) 28 return true; 29 else 30 return false; 31 } 32 33 struct fsp_header *__attribute__((optimize("O0"))) find_fsp_header(void) 34 { 35 /* 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 41 * stack is ready. 42 * 43 * GCC 4.8.1 has been verified to be working for the following codes. 44 */ 45 volatile register u8 *fsp asm("eax"); 46 47 /* Initalize the FSP base */ 48 fsp = (u8 *)CONFIG_FSP_ADDR; 49 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); 56 } else { 57 fsp = 0; 58 } 59 60 /* Check the FFS GUID */ 61 if (fsp && 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); 75 } else { 76 fsp = 0; 77 } 78 79 if (fsp && 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); 83 } else { 84 fsp = 0; 85 } 86 87 return (struct fsp_header *)fsp; 88 } 89 90 void fsp_continue(u32 status, void *hob_list) 91 { 92 post_code(POST_MRC); 93 94 assert(status == 0); 95 96 /* The boot loader main function entry */ 97 fsp_init_done(hob_list); 98 } 99 100 void fsp_init(u32 stack_top, u32 boot_mode, void *nvs_buf) 101 { 102 struct fsp_config_data config_data; 103 fsp_init_f init; 104 struct fsp_init_params params; 105 struct fspinit_rtbuf rt_buf; 106 struct fsp_header *fsp_hdr; 107 struct fsp_init_params *params_ptr; 108 #ifdef CONFIG_FSP_USE_UPD 109 struct vpd_region *fsp_vpd; 110 struct upd_region *fsp_upd; 111 #endif 112 113 fsp_hdr = find_fsp_header(); 114 if (fsp_hdr == NULL) { 115 /* No valid FSP info header was found */ 116 panic("Invalid FSP header"); 117 } 118 119 config_data.common.fsp_hdr = fsp_hdr; 120 config_data.common.stack_top = stack_top; 121 config_data.common.boot_mode = boot_mode; 122 123 #ifdef CONFIG_FSP_USE_UPD 124 /* Get VPD region start */ 125 fsp_vpd = (struct vpd_region *)(fsp_hdr->img_base + 126 fsp_hdr->cfg_region_off); 127 128 /* Verify the VPD data region is valid */ 129 assert(fsp_vpd->sign == VPD_IMAGE_ID); 130 131 fsp_upd = &config_data.fsp_upd; 132 133 /* Copy default data from Flash */ 134 memcpy(fsp_upd, (void *)(fsp_hdr->img_base + fsp_vpd->upd_offset), 135 sizeof(struct upd_region)); 136 137 /* Verify the UPD data region is valid */ 138 assert(fsp_upd->terminator == UPD_TERMINATOR); 139 #endif 140 141 memset(&rt_buf, 0, sizeof(struct fspinit_rtbuf)); 142 143 /* Override any configuration if required */ 144 update_fsp_configs(&config_data, &rt_buf); 145 146 memset(¶ms, 0, sizeof(struct fsp_init_params)); 147 params.nvs_buf = nvs_buf; 148 params.rt_buf = (struct fspinit_rtbuf *)&rt_buf; 149 params.continuation = (fsp_continuation_f)asm_continuation; 150 151 init = (fsp_init_f)(fsp_hdr->img_base + fsp_hdr->fsp_init); 152 params_ptr = ¶ms; 153 154 post_code(POST_PRE_MRC); 155 156 /* Load GDT for FSP */ 157 setup_fsp_gdt(); 158 159 /* 160 * Use ASM code to ensure the register value in EAX & EDX 161 * will be passed into fsp_continue 162 */ 163 asm volatile ( 164 "pushl %0;" 165 "call *%%eax;" 166 ".global asm_continuation;" 167 "asm_continuation:;" 168 "movl 4(%%esp), %%eax;" /* status */ 169 "movl 8(%%esp), %%edx;" /* hob_list */ 170 "jmp fsp_continue;" 171 : : "m"(params_ptr), "a"(init) 172 ); 173 174 /* 175 * Should never get here. 176 * Control will continue from fsp_continue. 177 * This line below is to prevent the compiler from optimizing 178 * structure intialization. 179 * 180 * DO NOT REMOVE! 181 */ 182 init(¶ms); 183 } 184 185 u32 fsp_notify(struct fsp_header *fsp_hdr, u32 phase) 186 { 187 fsp_notify_f notify; 188 struct fsp_notify_params params; 189 struct fsp_notify_params *params_ptr; 190 u32 status; 191 192 if (!fsp_hdr) 193 fsp_hdr = (struct fsp_header *)find_fsp_header(); 194 195 if (fsp_hdr == NULL) { 196 /* No valid FSP info header */ 197 panic("Invalid FSP header"); 198 } 199 200 notify = (fsp_notify_f)(fsp_hdr->img_base + fsp_hdr->fsp_notify); 201 params.phase = phase; 202 params_ptr = ¶ms; 203 204 /* 205 * Use ASM code to ensure correct parameter is on the stack for 206 * FspNotify as U-Boot is using different ABI from FSP 207 */ 208 asm volatile ( 209 "pushl %1;" /* push notify phase */ 210 "call *%%eax;" /* call FspNotify */ 211 "addl $4, %%esp;" /* clean up the stack */ 212 : "=a"(status) : "m"(params_ptr), "a"(notify), "m"(*params_ptr) 213 ); 214 215 return status; 216 } 217 218 u32 fsp_get_usable_lowmem_top(const void *hob_list) 219 { 220 const struct hob_header *hdr; 221 struct hob_res_desc *res_desc; 222 phys_addr_t phys_start; 223 u32 top; 224 #ifdef CONFIG_FSP_BROKEN_HOB 225 struct hob_mem_alloc *res_mem; 226 phys_addr_t mem_base = 0; 227 #endif 228 229 /* Get the HOB list for processing */ 230 hdr = hob_list; 231 232 /* * Collect memory ranges */ 233 top = FSP_LOWMEM_BASE; 234 while (!end_of_hob(hdr)) { 235 if (hdr->type == HOB_TYPE_RES_DESC) { 236 res_desc = (struct hob_res_desc *)hdr; 237 if (res_desc->type == RES_SYS_MEM) { 238 phys_start = res_desc->phys_start; 239 /* Need memory above 1MB to be collected here */ 240 if (phys_start >= FSP_LOWMEM_BASE && 241 phys_start < (phys_addr_t)FSP_HIGHMEM_BASE) 242 top += (u32)(res_desc->len); 243 } 244 } 245 246 #ifdef CONFIG_FSP_BROKEN_HOB 247 /* 248 * Find out the lowest memory base address allocated by FSP 249 * for the boot service data 250 */ 251 if (hdr->type == HOB_TYPE_MEM_ALLOC) { 252 res_mem = (struct hob_mem_alloc *)hdr; 253 if (!mem_base) 254 mem_base = res_mem->mem_base; 255 if (res_mem->mem_base < mem_base) 256 mem_base = res_mem->mem_base; 257 } 258 #endif 259 260 hdr = get_next_hob(hdr); 261 } 262 263 #ifdef CONFIG_FSP_BROKEN_HOB 264 /* 265 * Check whether the memory top address is below the FSP HOB list. 266 * If not, use the lowest memory base address allocated by FSP as 267 * the memory top address. This is to prevent U-Boot relocation 268 * overwrites the important boot service data which is used by FSP, 269 * otherwise the subsequent call to fsp_notify() will fail. 270 */ 271 if (top > (u32)hob_list) { 272 debug("Adjust memory top address due to a buggy FSP\n"); 273 top = (u32)mem_base; 274 } 275 #endif 276 277 return top; 278 } 279 280 u64 fsp_get_usable_highmem_top(const void *hob_list) 281 { 282 const struct hob_header *hdr; 283 struct hob_res_desc *res_desc; 284 phys_addr_t phys_start; 285 u64 top; 286 287 /* Get the HOB list for processing */ 288 hdr = hob_list; 289 290 /* Collect memory ranges */ 291 top = FSP_HIGHMEM_BASE; 292 while (!end_of_hob(hdr)) { 293 if (hdr->type == HOB_TYPE_RES_DESC) { 294 res_desc = (struct hob_res_desc *)hdr; 295 if (res_desc->type == RES_SYS_MEM) { 296 phys_start = res_desc->phys_start; 297 /* Need memory above 4GB to be collected here */ 298 if (phys_start >= (phys_addr_t)FSP_HIGHMEM_BASE) 299 top += (u32)(res_desc->len); 300 } 301 } 302 hdr = get_next_hob(hdr); 303 } 304 305 return top; 306 } 307 308 u64 fsp_get_reserved_mem_from_guid(const void *hob_list, u64 *len, 309 struct efi_guid *guid) 310 { 311 const struct hob_header *hdr; 312 struct hob_res_desc *res_desc; 313 314 /* Get the HOB list for processing */ 315 hdr = hob_list; 316 317 /* Collect memory ranges */ 318 while (!end_of_hob(hdr)) { 319 if (hdr->type == HOB_TYPE_RES_DESC) { 320 res_desc = (struct hob_res_desc *)hdr; 321 if (res_desc->type == RES_MEM_RESERVED) { 322 if (compare_guid(&res_desc->owner, guid)) { 323 if (len) 324 *len = (u32)(res_desc->len); 325 326 return (u64)(res_desc->phys_start); 327 } 328 } 329 } 330 hdr = get_next_hob(hdr); 331 } 332 333 return 0; 334 } 335 336 u32 fsp_get_fsp_reserved_mem(const void *hob_list, u32 *len) 337 { 338 const struct efi_guid guid = FSP_HOB_RESOURCE_OWNER_FSP_GUID; 339 u64 length; 340 u32 base; 341 342 base = (u32)fsp_get_reserved_mem_from_guid(hob_list, 343 &length, (struct efi_guid *)&guid); 344 if ((len != 0) && (base != 0)) 345 *len = (u32)length; 346 347 return base; 348 } 349 350 u32 fsp_get_tseg_reserved_mem(const void *hob_list, u32 *len) 351 { 352 const struct efi_guid guid = FSP_HOB_RESOURCE_OWNER_TSEG_GUID; 353 u64 length; 354 u32 base; 355 356 base = (u32)fsp_get_reserved_mem_from_guid(hob_list, 357 &length, (struct efi_guid *)&guid); 358 if ((len != 0) && (base != 0)) 359 *len = (u32)length; 360 361 return base; 362 } 363 364 const struct hob_header *fsp_get_next_hob(uint type, const void *hob_list) 365 { 366 const struct hob_header *hdr; 367 368 hdr = hob_list; 369 370 /* Parse the HOB list until end of list or matching type is found */ 371 while (!end_of_hob(hdr)) { 372 if (hdr->type == type) 373 return hdr; 374 375 hdr = get_next_hob(hdr); 376 } 377 378 return NULL; 379 } 380 381 const struct hob_header *fsp_get_next_guid_hob(const struct efi_guid *guid, 382 const void *hob_list) 383 { 384 const struct hob_header *hdr; 385 struct hob_guid *guid_hob; 386 387 hdr = hob_list; 388 while ((hdr = fsp_get_next_hob(HOB_TYPE_GUID_EXT, 389 hdr)) != NULL) { 390 guid_hob = (struct hob_guid *)hdr; 391 if (compare_guid(guid, &(guid_hob->name))) 392 break; 393 hdr = get_next_hob(hdr); 394 } 395 396 return hdr; 397 } 398 399 void *fsp_get_guid_hob_data(const void *hob_list, u32 *len, 400 struct efi_guid *guid) 401 { 402 const struct hob_header *guid_hob; 403 404 guid_hob = fsp_get_next_guid_hob(guid, hob_list); 405 if (guid_hob == NULL) { 406 return NULL; 407 } else { 408 if (len) 409 *len = get_guid_hob_data_size(guid_hob); 410 411 return get_guid_hob_data(guid_hob); 412 } 413 } 414 415 void *fsp_get_nvs_data(const void *hob_list, u32 *len) 416 { 417 const struct efi_guid guid = FSP_NON_VOLATILE_STORAGE_HOB_GUID; 418 419 return fsp_get_guid_hob_data(hob_list, len, (struct efi_guid *)&guid); 420 } 421 422 void *fsp_get_bootloader_tmp_mem(const void *hob_list, u32 *len) 423 { 424 const struct efi_guid guid = FSP_BOOTLOADER_TEMP_MEM_HOB_GUID; 425 426 return fsp_get_guid_hob_data(hob_list, len, (struct efi_guid *)&guid); 427 } 428 429 void *fsp_get_graphics_info(const void *hob_list, u32 *len) 430 { 431 const struct efi_guid guid = FSP_GRAPHICS_INFO_HOB_GUID; 432 433 return fsp_get_guid_hob_data(hob_list, len, (struct efi_guid *)&guid); 434 } 435