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(struct shared_data *shared_data, u32 status, void *hob_list) 91 { 92 u32 stack_len; 93 u32 stack_base; 94 u32 stack_top; 95 96 post_code(POST_MRC); 97 98 assert(status == 0); 99 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); 104 105 /* 106 * Old stack base is stored at the very end of the stack top, 107 * use it to calculate the migrated shared data base 108 */ 109 shared_data = (struct shared_data *)(stack_base + 110 ((u32)shared_data - *(u32 *)stack_top)); 111 112 /* The boot loader main function entry */ 113 fsp_init_done(hob_list); 114 } 115 116 void fsp_init(u32 stack_top, u32 boot_mode, void *nvs_buf) 117 { 118 struct shared_data shared_data; 119 fsp_init_f init; 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; 126 127 #ifdef CONFIG_DEBUG_UART 128 setup_early_uart(); 129 #endif 130 131 fsp_hdr = find_fsp_header(); 132 if (fsp_hdr == NULL) { 133 /* No valid FSP info header was found */ 134 panic("Invalid FSP header"); 135 } 136 137 fsp_upd = &shared_data.fsp_upd; 138 memset(&rt_buf, 0, sizeof(struct fspinit_rtbuf)); 139 140 /* Reserve a gap in stack top */ 141 rt_buf.common.stack_top = (u32 *)stack_top - 32; 142 rt_buf.common.boot_mode = boot_mode; 143 rt_buf.common.upd_data = fsp_upd; 144 145 /* Get VPD region start */ 146 fsp_vpd = (struct vpd_region *)(fsp_hdr->img_base + 147 fsp_hdr->cfg_region_off); 148 149 /* Verify the VPD data region is valid */ 150 assert(fsp_vpd->sign == VPD_IMAGE_ID); 151 152 /* Copy default data from Flash */ 153 memcpy(fsp_upd, (void *)(fsp_hdr->img_base + fsp_vpd->upd_offset), 154 sizeof(struct upd_region)); 155 156 /* Verify the UPD data region is valid */ 157 assert(fsp_upd->terminator == UPD_TERMINATOR); 158 159 /* Override any UPD setting if required */ 160 update_fsp_upd(fsp_upd); 161 162 memset(¶ms, 0, sizeof(struct fsp_init_params)); 163 params.nvs_buf = nvs_buf; 164 params.rt_buf = (struct fspinit_rtbuf *)&rt_buf; 165 params.continuation = (fsp_continuation_f)asm_continuation; 166 167 init = (fsp_init_f)(fsp_hdr->img_base + fsp_hdr->fsp_init); 168 params_ptr = ¶ms; 169 170 shared_data.fsp_hdr = fsp_hdr; 171 shared_data.stack_top = (u32 *)stack_top; 172 173 post_code(POST_PRE_MRC); 174 175 /* Load GDT for FSP */ 176 setup_fsp_gdt(); 177 178 /* 179 * Use ASM code to ensure the register value in EAX & ECX 180 * will be passed into BlContinuationFunc 181 */ 182 asm volatile ( 183 "pushl %0;" 184 "call *%%eax;" 185 ".global asm_continuation;" 186 "asm_continuation:;" 187 "movl %%ebx, %%eax;" /* shared_data */ 188 "movl 4(%%esp), %%edx;" /* status */ 189 "movl 8(%%esp), %%ecx;" /* hob_list */ 190 "jmp fsp_continue;" 191 : : "m"(params_ptr), "a"(init), "b"(&shared_data) 192 ); 193 194 /* 195 * Should never get here. 196 * Control will continue from fsp_continue. 197 * This line below is to prevent the compiler from optimizing 198 * structure intialization. 199 * 200 * DO NOT REMOVE! 201 */ 202 init(¶ms); 203 } 204 205 u32 fsp_notify(struct fsp_header *fsp_hdr, u32 phase) 206 { 207 fsp_notify_f notify; 208 struct fsp_notify_params params; 209 struct fsp_notify_params *params_ptr; 210 u32 status; 211 212 if (!fsp_hdr) 213 fsp_hdr = (struct fsp_header *)find_fsp_header(); 214 215 if (fsp_hdr == NULL) { 216 /* No valid FSP info header */ 217 panic("Invalid FSP header"); 218 } 219 220 notify = (fsp_notify_f)(fsp_hdr->img_base + fsp_hdr->fsp_notify); 221 params.phase = phase; 222 params_ptr = ¶ms; 223 224 /* 225 * Use ASM code to ensure correct parameter is on the stack for 226 * FspNotify as U-Boot is using different ABI from FSP 227 */ 228 asm volatile ( 229 "pushl %1;" /* push notify phase */ 230 "call *%%eax;" /* call FspNotify */ 231 "addl $4, %%esp;" /* clean up the stack */ 232 : "=a"(status) : "m"(params_ptr), "a"(notify), "m"(*params_ptr) 233 ); 234 235 return status; 236 } 237 238 u32 fsp_get_usable_lowmem_top(const void *hob_list) 239 { 240 const struct hob_header *hdr; 241 struct hob_res_desc *res_desc; 242 phys_addr_t phys_start; 243 u32 top; 244 245 /* Get the HOB list for processing */ 246 hdr = hob_list; 247 248 /* * Collect memory ranges */ 249 top = FSP_LOWMEM_BASE; 250 while (!end_of_hob(hdr)) { 251 if (hdr->type == HOB_TYPE_RES_DESC) { 252 res_desc = (struct hob_res_desc *)hdr; 253 if (res_desc->type == RES_SYS_MEM) { 254 phys_start = res_desc->phys_start; 255 /* Need memory above 1MB to be collected here */ 256 if (phys_start >= FSP_LOWMEM_BASE && 257 phys_start < (phys_addr_t)FSP_HIGHMEM_BASE) 258 top += (u32)(res_desc->len); 259 } 260 } 261 hdr = get_next_hob(hdr); 262 } 263 264 return top; 265 } 266 267 u64 fsp_get_usable_highmem_top(const void *hob_list) 268 { 269 const struct hob_header *hdr; 270 struct hob_res_desc *res_desc; 271 phys_addr_t phys_start; 272 u64 top; 273 274 /* Get the HOB list for processing */ 275 hdr = hob_list; 276 277 /* Collect memory ranges */ 278 top = FSP_HIGHMEM_BASE; 279 while (!end_of_hob(hdr)) { 280 if (hdr->type == HOB_TYPE_RES_DESC) { 281 res_desc = (struct hob_res_desc *)hdr; 282 if (res_desc->type == RES_SYS_MEM) { 283 phys_start = res_desc->phys_start; 284 /* Need memory above 4GB to be collected here */ 285 if (phys_start >= (phys_addr_t)FSP_HIGHMEM_BASE) 286 top += (u32)(res_desc->len); 287 } 288 } 289 hdr = get_next_hob(hdr); 290 } 291 292 return top; 293 } 294 295 u64 fsp_get_reserved_mem_from_guid(const void *hob_list, u64 *len, 296 struct efi_guid *guid) 297 { 298 const struct hob_header *hdr; 299 struct hob_res_desc *res_desc; 300 301 /* Get the HOB list for processing */ 302 hdr = hob_list; 303 304 /* Collect memory ranges */ 305 while (!end_of_hob(hdr)) { 306 if (hdr->type == HOB_TYPE_RES_DESC) { 307 res_desc = (struct hob_res_desc *)hdr; 308 if (res_desc->type == RES_MEM_RESERVED) { 309 if (compare_guid(&res_desc->owner, guid)) { 310 if (len) 311 *len = (u32)(res_desc->len); 312 313 return (u64)(res_desc->phys_start); 314 } 315 } 316 } 317 hdr = get_next_hob(hdr); 318 } 319 320 return 0; 321 } 322 323 u32 fsp_get_fsp_reserved_mem(const void *hob_list, u32 *len) 324 { 325 const struct efi_guid guid = FSP_HOB_RESOURCE_OWNER_FSP_GUID; 326 u64 length; 327 u32 base; 328 329 base = (u32)fsp_get_reserved_mem_from_guid(hob_list, 330 &length, (struct efi_guid *)&guid); 331 if ((len != 0) && (base != 0)) 332 *len = (u32)length; 333 334 return base; 335 } 336 337 u32 fsp_get_tseg_reserved_mem(const void *hob_list, u32 *len) 338 { 339 const struct efi_guid guid = FSP_HOB_RESOURCE_OWNER_TSEG_GUID; 340 u64 length; 341 u32 base; 342 343 base = (u32)fsp_get_reserved_mem_from_guid(hob_list, 344 &length, (struct efi_guid *)&guid); 345 if ((len != 0) && (base != 0)) 346 *len = (u32)length; 347 348 return base; 349 } 350 351 const struct hob_header *fsp_get_next_hob(uint type, const void *hob_list) 352 { 353 const struct hob_header *hdr; 354 355 hdr = hob_list; 356 357 /* Parse the HOB list until end of list or matching type is found */ 358 while (!end_of_hob(hdr)) { 359 if (hdr->type == type) 360 return hdr; 361 362 hdr = get_next_hob(hdr); 363 } 364 365 return NULL; 366 } 367 368 const struct hob_header *fsp_get_next_guid_hob(const struct efi_guid *guid, 369 const void *hob_list) 370 { 371 const struct hob_header *hdr; 372 struct hob_guid *guid_hob; 373 374 hdr = hob_list; 375 while ((hdr = fsp_get_next_hob(HOB_TYPE_GUID_EXT, 376 hdr)) != NULL) { 377 guid_hob = (struct hob_guid *)hdr; 378 if (compare_guid(guid, &(guid_hob->name))) 379 break; 380 hdr = get_next_hob(hdr); 381 } 382 383 return hdr; 384 } 385 386 void *fsp_get_guid_hob_data(const void *hob_list, u32 *len, 387 struct efi_guid *guid) 388 { 389 const struct hob_header *guid_hob; 390 391 guid_hob = fsp_get_next_guid_hob(guid, hob_list); 392 if (guid_hob == NULL) { 393 return NULL; 394 } else { 395 if (len) 396 *len = get_guid_hob_data_size(guid_hob); 397 398 return get_guid_hob_data(guid_hob); 399 } 400 } 401 402 void *fsp_get_nvs_data(const void *hob_list, u32 *len) 403 { 404 const struct efi_guid guid = FSP_NON_VOLATILE_STORAGE_HOB_GUID; 405 406 return fsp_get_guid_hob_data(hob_list, len, (struct efi_guid *)&guid); 407 } 408 409 void *fsp_get_bootloader_tmp_mem(const void *hob_list, u32 *len) 410 { 411 const struct efi_guid guid = FSP_BOOTLOADER_TEMP_MEM_HOB_GUID; 412 413 return fsp_get_guid_hob_data(hob_list, len, (struct efi_guid *)&guid); 414 } 415