arch/x86/lib/fsp/fsp_support.c

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