drivers/intel: Update FSP 1.1 Driver

Update the FSP driver files from 1.0 to 1.1.

Updates will occur manually to these files only for FSP 1.1 support.  An
fsp_x_y should be added in the future to support newer versions of the
FSP specification.

Please note that due to the interface with EDK2, these files make
references to data structures and fields that use CamelCase.

BRANCH=none
BUG=None
TEST=Build for Braswell or Skylake boards using FSP 1.1.

Change-Id: I2914c047d786a3060075356783ac9758bc41f633
Signed-off-by: Lee Leahy <leroy.p.leahy@intel.com>
Reviewed-on: http://review.coreboot.org/10049
Tested-by: build bot (Jenkins)
Reviewed-by: Patrick Georgi <pgeorgi@google.com>

1 files changed, 48 insertions, 62 deletions

diff --git a/src/drivers/intel/fsp1_1/fsp_util.h b/src/drivers/intel/fsp1_1/fsp_util.h
index 054de1c5a1..38fa86211b 100644
--- a/src/drivers/intel/fsp1_1/fsp_util.h
+++ b/src/drivers/intel/fsp1_1/fsp_util.h
@@ -2,6 +2,7 @@
  * This file is part of the coreboot project.
  *
  * Copyright (C) 2013-2014 Sage Electronic Engineering, LLC.
+ * Copyright (C) 2015 Intel Corp.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -20,35 +21,52 @@
 #ifndef FSP_UTIL_H
 #define FSP_UTIL_H
 
+#include <types.h>
+#include <arch/cpu.h>
+#include <fsp_gop.h>
+
+/*
+ * The following are functions with prototypes defined in the EDK2 headers. The
+ * EDK2 headers are included with chipset_fsp_util.h.  Define the following
+ * names to reduce the use of CamelCase in the other source files.
+ */
+#define GetHobList	get_hob_list
+#define GetNextHob	get_next_hob
+#define GetFirstHob	get_first_hob
+#define GetNextGuidHob	get_next_guid_hob
+#define GetFirstGuidHob	get_first_guid_hob
+
+/* Include the EDK2 headers */
 #include <chipset_fsp_util.h>
-#include "fsp_values.h"
 
 #if IS_ENABLED(CONFIG_ENABLE_MRC_CACHE)
 int save_mrc_data(void *hob_start);
 void * find_and_set_fastboot_cache(void);
 #endif
 
-volatile u8 * find_fsp (void);
+/* find_fsp() should only be called from assembly code. */
+FSP_INFO_HEADER *find_fsp(void);
+/* Set FSP's runtime information. */
+void fsp_set_runtime(FSP_INFO_HEADER *fih, void *hob_list);
+/* Use a new FSP_INFO_HEADER at runtime. */
+void fsp_update_fih(FSP_INFO_HEADER *fih);
+/* fsp_get_fih() is only valid after calling fsp_set_runtime(). */
+FSP_INFO_HEADER *fsp_get_fih(void);
+/* fsp_get_hob_list() is only valid after calling fsp_set_runtime(). */
+void *fsp_get_hob_list(void);
 void fsp_early_init(FSP_INFO_HEADER *fsp_info);
-void FspNotify(u32 Phase);
-void FspNotifyReturnPoint(EFI_STATUS Status, VOID *HobListPtr);
-void romstage_fsp_rt_buffer_callback(FSP_INIT_RT_BUFFER *FspRtBuffer);
-void print_fsp_info(void);
-void chipset_fsp_early_init(FSP_INIT_PARAMS *FspInitParams,
-	FSP_INFO_HEADER *fsp_ptr);
-void ChipsetFspReturnPoint(EFI_STATUS Status, VOID *HobListPtr);
-void * find_saved_temp_mem(void *hob_list_ptr);
-void * find_fsp_reserved_mem(void *hob_list_ptr);
-
-/* functions in hob.c */
-void print_hob_mem_attributes(void *Hobptr);
-void print_hob_type_structure(u16 Hobtype, void *Hoblistptr);
-void print_hob_resource_attributes(void *Hobptr);
-void print_guid_type_attributes(void *Hobptr);
-const char * get_hob_type_string(void *Hobptr);
-void * find_hob_by_guid(void *Hoblistptr, EFI_GUID *guid1);
-uint8_t guids_are_equal(EFI_GUID *guid1, EFI_GUID *guid2);
-void printguid(EFI_GUID *guid);
+void fsp_notify(u32 phase);
+void print_hob_type_structure(u16 hob_type, void *hob_list_ptr);
+void print_fsp_info(FSP_INFO_HEADER *fsp_header);
+void *get_next_type_guid_hob(UINT16 type, const EFI_GUID *guid,
+	const void *hob_start);
+void *get_next_resource_hob(const EFI_GUID *guid, const void *hob_start);
+void *get_first_resource_hob(const EFI_GUID *guid);
+/*
+ * Relocate FSP entire binary into ram. Returns NULL on error. Otherwise the
+ * FSP_INFO_HEADER pointer to the relocated FSP.
+ */
+FSP_INFO_HEADER *fsp_relocate(void *fsp_src, size_t size);
 
 /* Additional HOB types not included in the FSP:
  * #define EFI_HOB_TYPE_HANDOFF 0x0001
@@ -73,63 +91,31 @@ struct mrc_data_container {
 	u32	mrc_signature;	// "MRCD"
 	u32	mrc_data_size;	// Actual total size of this structure
 	u32	mrc_checksum;	// IP style checksum
-	u32	reserved;		// For header alignment
+	u32	reserved;	// For header alignment
 	u8	mrc_data[0];	// Variable size, platform/run time dependent.
 } __attribute__ ((packed));
 
 struct mrc_data_container *find_current_mrc_cache(void);
-
-#if !defined(__PRE_RAM__)
 void update_mrc_cache(void *unused);
-#endif
 
-#endif
+#endif	/* CONFIG_ENABLE_MRC_CACHE */
 
 /* The offset in bytes from the start of the info structure */
-#define FSP_IMAGE_SIG_LOC				0
-#define FSP_IMAGE_ID_LOC				16
-#define FSP_IMAGE_BASE_LOC				28
+#define FSP_IMAGE_SIG_LOC			0
+#define FSP_IMAGE_ID_LOC			16
+#define FSP_IMAGE_BASE_LOC			28
 
-#define FSP_SIG						0x48505346	/* 'FSPH' */
+#define FSP_SIG					0x48505346	/* 'FSPH' */
 
 #define ERROR_NO_FV_SIG				1
-#define ERROR_NO_FFS_GUID				2
+#define ERROR_NO_FFS_GUID			2
 #define ERROR_NO_INFO_HEADER			3
 #define ERROR_IMAGEBASE_MISMATCH		4
-#define ERROR_INFO_HEAD_SIG_MISMATCH	5
+#define ERROR_INFO_HEAD_SIG_MISMATCH		5
 #define ERROR_FSP_SIG_MISMATCH			6
 
-#ifndef __PRE_RAM__
+#if ENV_RAMSTAGE
 extern void *FspHobListPtr;
 #endif
 
-#define UPD_DEFAULT_CHECK(member) \
-	if (config->member != UPD_DEFAULT) { \
-		UpdData->member = config->member - 1; \
-	} \
-	printk(FSP_INFO_LEVEL, #member ":\t\t0x%02x %s\n", UpdData->member, \
-		config->member ? "(set)" : "(default)");
-
-#define UPD_SPD_CHECK(member) \
-	if (config->member == UPD_SPD_ADDR_DISABLED) { \
-		UpdData->member = 0x00; \
-	} else if (config->member != UPD_SPD_ADDR_DEFAULT) { \
-		UpdData->member = config->member; \
-	} \
-	printk(FSP_INFO_LEVEL, #member ":\t\t0x%02x %s\n", UpdData->member, \
-		config->member ? "(set)" : "(default)");
-
-#define UPD_DEVICE_CHECK(devicename, member, statement) \
-	case devicename: \
-		UpdData->member = dev->enabled; \
-		printk(FSP_INFO_LEVEL, statement "%s\n", \
-			UpdData->member?"Enabled":"Disabled"); \
-	break;
-
-
-#ifndef FSP_BOOTLOADER_TEMPORARY_MEMORY_HOB_GUID
-#define FSP_BOOTLOADER_TEMPORARY_MEMORY_HOB_GUID \
-	{ 0xbbcff46c, 0xc8d3, 0x4113, { 0x89, 0x85, 0xb9, 0xd4, 0xf3, 0xb3, 0xf6, 0x4e } };
-#endif
-
 #endif	/* FSP_UTIL_H */