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 vpd_region *fsp_vpd;
 107         struct fsp_header *fsp_hdr;
 108         struct fsp_init_params *params_ptr;
 109         struct upd_region *fsp_upd;
 110
 111 #ifdef CONFIG_DEBUG_UART
 112         setup_early_uart();
 113 #endif
 114
 115         fsp_hdr = find_fsp_header();
 116         if (fsp_hdr == NULL) {
 117                 /* No valid FSP info header was found */
 118                 panic("Invalid FSP header");
 119         }
 120
 121         config_data.common.fsp_hdr = fsp_hdr;
 122         config_data.common.stack_top = stack_top;
 123         config_data.common.boot_mode = boot_mode;
 124
 125         fsp_upd = &config_data.fsp_upd;
 126         memset(&rt_buf, 0, sizeof(struct fspinit_rtbuf));
 127
 128         /* Reserve a gap in stack top */
 129         rt_buf.common.stack_top = stack_top - 32;
 130         rt_buf.common.boot_mode = boot_mode;
 131         rt_buf.common.upd_data = fsp_upd;
 132
 133         /* Get VPD region start */
 134         fsp_vpd = (struct vpd_region *)(fsp_hdr->img_base +
 135                         fsp_hdr->cfg_region_off);
 136
 137         /* Verify the VPD data region is valid */
 138         assert(fsp_vpd->sign == VPD_IMAGE_ID);
 139
 140         /* Copy default data from Flash */
 141         memcpy(fsp_upd, (void *)(fsp_hdr->img_base + fsp_vpd->upd_offset),
 142                sizeof(struct upd_region));
 143
 144         /* Verify the UPD data region is valid */
 145         assert(fsp_upd->terminator == UPD_TERMINATOR);
 146
 147         /* Override any configuration if required */
 148         update_fsp_configs(&config_data);
 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
 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                 hdr = get_next_hob(hdr);
 246         }
 247
 248         return top;
 249 }
 250
 251 u64 fsp_get_usable_highmem_top(const void *hob_list)
 252 {
 253         const struct hob_header *hdr;
 254         struct hob_res_desc *res_desc;
 255         phys_addr_t phys_start;
 256         u64 top;
 257
 258         /* Get the HOB list for processing */
 259         hdr = hob_list;
 260
 261         /* Collect memory ranges */
 262         top = FSP_HIGHMEM_BASE;
 263         while (!end_of_hob(hdr)) {
 264                 if (hdr->type == HOB_TYPE_RES_DESC) {
 265                         res_desc = (struct hob_res_desc *)hdr;
 266                         if (res_desc->type == RES_SYS_MEM) {
 267                                 phys_start = res_desc->phys_start;
 268                                 /* Need memory above 4GB to be collected here */
 269                                 if (phys_start >= (phys_addr_t)FSP_HIGHMEM_BASE)
 270                                         top += (u32)(res_desc->len);
 271                         }
 272                 }
 273                 hdr = get_next_hob(hdr);
 274         }
 275
 276         return top;
 277 }
 278
 279 u64 fsp_get_reserved_mem_from_guid(const void *hob_list, u64 *len,
 280                                    struct efi_guid *guid)
 281 {
 282         const struct hob_header *hdr;
 283         struct hob_res_desc *res_desc;
 284
 285         /* Get the HOB list for processing */
 286         hdr = hob_list;
 287
 288         /* Collect memory ranges */
 289         while (!end_of_hob(hdr)) {
 290                 if (hdr->type == HOB_TYPE_RES_DESC) {
 291                         res_desc = (struct hob_res_desc *)hdr;
 292                         if (res_desc->type == RES_MEM_RESERVED) {
 293                                 if (compare_guid(&res_desc->owner, guid)) {
 294                                         if (len)
 295                                                 *len = (u32)(res_desc->len);
 296
 297                                         return (u64)(res_desc->phys_start);
 298                                 }
 299                         }
 300                 }
 301                 hdr = get_next_hob(hdr);
 302         }
 303
 304         return 0;
 305 }
 306
 307 u32 fsp_get_fsp_reserved_mem(const void *hob_list, u32 *len)
 308 {
 309         const struct efi_guid guid = FSP_HOB_RESOURCE_OWNER_FSP_GUID;
 310         u64 length;
 311         u32 base;
 312
 313         base = (u32)fsp_get_reserved_mem_from_guid(hob_list,
 314                         &length, (struct efi_guid *)&guid);
 315         if ((len != 0) && (base != 0))
 316                 *len = (u32)length;
 317
 318         return base;
 319 }
 320
 321 u32 fsp_get_tseg_reserved_mem(const void *hob_list, u32 *len)
 322 {
 323         const struct efi_guid guid = FSP_HOB_RESOURCE_OWNER_TSEG_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 const struct hob_header *fsp_get_next_hob(uint type, const void *hob_list)
 336 {
 337         const struct hob_header *hdr;
 338
 339         hdr = hob_list;
 340
 341         /* Parse the HOB list until end of list or matching type is found */
 342         while (!end_of_hob(hdr)) {
 343                 if (hdr->type == type)
 344                         return hdr;
 345
 346                 hdr = get_next_hob(hdr);
 347         }
 348
 349         return NULL;
 350 }
 351
 352 const struct hob_header *fsp_get_next_guid_hob(const struct efi_guid *guid,
 353                                                const void *hob_list)
 354 {
 355         const struct hob_header *hdr;
 356         struct hob_guid *guid_hob;
 357
 358         hdr = hob_list;
 359         while ((hdr = fsp_get_next_hob(HOB_TYPE_GUID_EXT,
 360                         hdr)) != NULL) {
 361                 guid_hob = (struct hob_guid *)hdr;
 362                 if (compare_guid(guid, &(guid_hob->name)))
 363                         break;
 364                 hdr = get_next_hob(hdr);
 365         }
 366
 367         return hdr;
 368 }
 369
 370 void *fsp_get_guid_hob_data(const void *hob_list, u32 *len,
 371                             struct efi_guid *guid)
 372 {
 373         const struct hob_header *guid_hob;
 374
 375         guid_hob = fsp_get_next_guid_hob(guid, hob_list);
 376         if (guid_hob == NULL) {
 377                 return NULL;
 378         } else {
 379                 if (len)
 380                         *len = get_guid_hob_data_size(guid_hob);
 381
 382                 return get_guid_hob_data(guid_hob);
 383         }
 384 }
 385
 386 void *fsp_get_nvs_data(const void *hob_list, u32 *len)
 387 {
 388         const struct efi_guid guid = FSP_NON_VOLATILE_STORAGE_HOB_GUID;
 389
 390         return fsp_get_guid_hob_data(hob_list, len, (struct efi_guid *)&guid);
 391 }
 392
 393 void *fsp_get_bootloader_tmp_mem(const void *hob_list, u32 *len)
 394 {
 395         const struct efi_guid guid = FSP_BOOTLOADER_TEMP_MEM_HOB_GUID;
 396
 397         return fsp_get_guid_hob_data(hob_list, len, (struct efi_guid *)&guid);
 398 }