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