arm64: Uprev Arm TF and adjust to BL31 parameter changes

This patch uprevs the Arm Trusted Firmware submodule to the new upstream
master (commit 42cdeb930).

Arm Trusted Firmware unified a bunch of stuff related to BL31 handoff
parameters across platforms which involved changing a few names around.
This patch syncs coreboot back up with that. They also made header
changes that now allow us to directly include all the headers we need
(in a safer and cleaner way than before), so we can get rid of some
structure definitions that were duplicated. Since the version of entry
point info parameters we have been using has been deprecated in Trusted
Firmware, this patch switches to the new version 2 parameter format.

NOTE: This may or may not stop Cavium from booting with the current
pinned Trusted Firmware blob. Cavium maintainers are still evaluating
whether to fix that later or drop the platform entirely.

Tested on GOOGLE_KEVIN (rk3399).

Change-Id: I0ed32bce5585ce191736f0ff2e5a94a9d2b2cc28
Signed-off-by: Julius Werner <jwerner@chromium.org>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/34676
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Hung-Te Lin <hungte@chromium.org>

3 files changed, 70 insertions, 140 deletions

diff --git a/src/arch/arm64/bl31.c b/src/arch/arm64/bl31.c
index fb24dff40e..c94b1d101e 100644
--- a/src/arch/arm64/bl31.c
+++ b/src/arch/arm64/bl31.c
@@ -18,32 +18,75 @@
 #include <bl31.h>
 #include <bootmem.h>
 #include <cbfs.h>
+#include <cbmem.h>
 #include <console/console.h>
 #include <program_loading.h>
 
-/*
- * TODO: Many of these structures are currently unused. Better not fill them out
- * to make future changes fail fast, rather than try to come up with content
- * that might turn out to not make sense. Implement later as required.
- *
-static image_info_t bl31_image_info;
-static image_info_t bl32_image_info;
-static image_info_t bl33_image_info;
- */
-static entry_point_info_t bl32_ep_info;
-static entry_point_info_t bl33_ep_info;
-static bl31_params_t bl31_params;
+#include <arm-trusted-firmware/include/export/common/bl_common_exp.h>
+
+static entry_point_info_t bl32_ep_info = {
+	.h = {
+		.type = PARAM_EP,
+		.version = PARAM_VERSION_1,
+		.size = sizeof(bl32_ep_info),
+		.attr = EP_SECURE,
+	},
+};
+static entry_point_info_t bl33_ep_info = {
+	.h = {
+		.type = PARAM_EP,
+		.version = PARAM_VERSION_1,
+		.size = sizeof(bl33_ep_info),
+		.attr = EP_NON_SECURE,
+	},
+};
+
+static bl_params_node_t bl32_params_node = {
+	.image_id = BL32_IMAGE_ID,
+	.ep_info = &bl32_ep_info,
+};
+static bl_params_node_t bl33_params_node = {
+	.image_id = BL33_IMAGE_ID,
+	.ep_info = &bl33_ep_info,
+};
+
+static bl_params_t bl_params = {
+	.h = {
+		.type = PARAM_BL_PARAMS,
+		.version = PARAM_VERSION_2,
+		.size = sizeof(bl_params),
+		.attr = 0,
+	},
+	.head = &bl33_params_node,
+};
+
+static struct bl_aux_param_header *bl_aux_params;
 
-void __weak *soc_get_bl31_plat_params(bl31_params_t *params)
+/* Only works when using the default soc_get_bl31_plat_params() below. */
+void register_bl31_aux_param(struct bl_aux_param_header *param)
 {
-	/* Default weak implementation. */
-	return NULL;
+	param->next = (uintptr_t)bl_aux_params;
+	bl_aux_params = param;
+}
+
+/* Default implementation. All newly added SoCs should use this if possible! */
+__weak void *soc_get_bl31_plat_params(void)
+{
+	static struct bl_aux_param_uint64 cbtable_param = {
+		.h = { .type = BL_AUX_PARAM_COREBOOT_TABLE, },
+	};
+	if (!cbtable_param.value) {
+		cbtable_param.value = (uint64_t)cbmem_find(CBMEM_ID_CBTABLE);
+		if (cbtable_param.value)
+			register_bl31_aux_param(&cbtable_param.h);
+	}
+	return bl_aux_params;
 }
 
 void run_bl31(u64 payload_entry, u64 payload_arg0, u64 payload_spsr)
 {
 	struct prog bl31 = PROG_INIT(PROG_BL31, CONFIG_CBFS_PREFIX"/bl31");
-	void (*bl31_entry)(bl31_params_t *params, void *plat_params) = NULL;
+	void (*bl31_entry)(bl_params_t *params, void *plat_params) = NULL;
 
 	if (prog_locate(&bl31))
 		die("BL31 not found");
@@ -52,8 +95,6 @@ void run_bl31(u64 payload_entry, u64 payload_arg0, u64 payload_spsr)
 		die("BL31 load failed");
 	bl31_entry = prog_entry(&bl31);
 
-	SET_PARAM_HEAD(&bl31_params, PARAM_BL31, VERSION_1, 0);
-
 	if (CONFIG(ARM64_USE_SECURE_OS)) {
 		struct prog bl32 = PROG_INIT(PROG_BL32,
 					     CONFIG_CBFS_PREFIX"/secure_os");
@@ -64,27 +105,21 @@ void run_bl31(u64 payload_entry, u64 payload_arg0, u64 payload_spsr)
 		if (cbfs_prog_stage_load(&bl32))
 			die("BL32 load failed");
 
-		SET_PARAM_HEAD(&bl32_ep_info, PARAM_EP, VERSION_1,
-			       PARAM_EP_SECURE);
 		bl32_ep_info.pc = (uintptr_t)prog_entry(&bl32);
 		bl32_ep_info.spsr = SPSR_EXCEPTION_MASK |
 				get_eret_el(EL1, SPSR_USE_L);
-		bl31_params.bl32_ep_info = &bl32_ep_info;
+		bl33_params_node.next_params_info = &bl32_params_node;
 	}
 
-	bl31_params.bl33_ep_info = &bl33_ep_info;
-
-	SET_PARAM_HEAD(&bl33_ep_info, PARAM_EP, VERSION_1, PARAM_EP_NON_SECURE);
 	bl33_ep_info.pc = payload_entry;
 	bl33_ep_info.spsr = payload_spsr;
 	bl33_ep_info.args.arg0 = payload_arg0;
 
-	/* May update bl31_params if necessary. */
-	void *bl31_plat_params = soc_get_bl31_plat_params(&bl31_params);
+	void *bl31_plat_params = soc_get_bl31_plat_params();
 
 	/* MMU disable will flush cache, so passed params land in memory. */
 	raw_write_daif(SPSR_EXCEPTION_MASK);
 	mmu_disable();
-	bl31_entry(&bl31_params, bl31_plat_params);
+	bl31_entry(&bl_params, bl31_plat_params);
 	die("BL31 returned!");
 }
diff --git a/src/arch/arm64/include/arm_tf_temp.h b/src/arch/arm64/include/arm_tf_temp.h
deleted file mode 100644
index f8ee48df25..0000000000
--- a/src/arch/arm64/include/arm_tf_temp.h
+++ /dev/null
@@ -1,109 +0,0 @@
-/*
- * This file is part of the coreboot project.
- *
- * Copyright (c) 2013-2014, ARM Limited and Contributors. All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * Redistributions of source code must retain the above copyright notice, this
- * list of conditions and the following disclaimer.
- *
- * Redistributions in binary form must reproduce the above copyright notice,
- * this list of conditions and the following disclaimer in the documentation
- * and/or other materials provided with the distribution.
- *
- * Neither the name of ARM nor the names of its contributors may be used
- * to endorse or promote products derived from this software without specific
- * prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
- * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
- * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
- * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
- * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE.
- */
-
-#ifndef __ARM_TF_TEMP_H__
-#define __ARM_TF_TEMP_H__
-
-#include <types.h>
-
-/*
- * Code temporarily copied from arm-trusted-firmware/include/common/bl_common.h,
- * since it tries to pull in a few too many standard C headers and needs to be
- * cleaned up a bit before we can include it directly.
- */
-
-#define PARAM_EP_SECURE		0x0
-#define PARAM_EP_NON_SECURE	0x1
-#define PARAM_EP_SECURITY_MASK	0x1
-
-#define PARAM_EP_EE_MASK	0x2
-#define PARAM_EP_EE_LITTLE	0x0
-#define PARAM_EP_EE_BIG		0x2
-
-#define PARAM_EP_ST_MASK	0x4
-#define PARAM_EP_ST_DISABLE	0x0
-#define PARAM_EP_ST_ENABLE	0x4
-
-#define PARAM_EP		0x01
-#define PARAM_IMAGE_BINARY	0x02
-#define PARAM_BL31		0x03
-
-#define VERSION_1		0x01
-
-#define SET_PARAM_HEAD(_p, _type, _ver, _attr) do { \
-	(_p)->h.type = (uint8_t)(_type); \
-	(_p)->h.version = (uint8_t)(_ver); \
-	(_p)->h.size = (uint16_t)sizeof(*_p); \
-	(_p)->h.attr = (uint32_t)(_attr) ; \
-	} while (0)
-
-typedef struct aapcs64_params {
-	unsigned long arg0;
-	unsigned long arg1;
-	unsigned long arg2;
-	unsigned long arg3;
-	unsigned long arg4;
-	unsigned long arg5;
-	unsigned long arg6;
-	unsigned long arg7;
-} aapcs64_params_t;
-
-typedef struct param_header {
-	uint8_t type;		/* type of the structure */
-	uint8_t version;    /* version of this structure */
-	uint16_t size;      /* size of this structure in bytes */
-	uint32_t attr;      /* attributes: unused bits SBZ */
-} param_header_t;
-
-typedef struct entry_point_info {
-	param_header_t h;
-	uintptr_t pc;
-	uint32_t spsr;
-	aapcs64_params_t args;
-} entry_point_info_t;
-
-typedef struct image_info {
-	param_header_t h;
-	uintptr_t image_base;   /* physical address of base of image */
-	uint32_t image_size;    /* bytes read from image file */
-} image_info_t;
-
-typedef struct bl31_params {
-	param_header_t h;
-	image_info_t *bl31_image_info;
-	entry_point_info_t *bl32_ep_info;
-	image_info_t *bl32_image_info;
-	entry_point_info_t *bl33_ep_info;
-	image_info_t *bl33_image_info;
-} bl31_params_t;
-
-#endif /* __ARM_TF_TEMP_H__ */
diff --git a/src/arch/arm64/include/bl31.h b/src/arch/arm64/include/bl31.h
index 08855f64cf..0f90e774b3 100644
--- a/src/arch/arm64/include/bl31.h
+++ b/src/arch/arm64/include/bl31.h
@@ -16,13 +16,17 @@
 
 #include <types.h>
 
-/* TODO: Pull in directly from ARM TF once its headers have been reorganized. */
-#include <arm_tf_temp.h>
+#include <arm-trusted-firmware/include/export/lib/bl_aux_params/bl_aux_params_exp.h>
 
 /* Load and enter BL31, set it up to exit to payload according to arguments. */
 void run_bl31(u64 payload_entry, u64 payload_arg0, u64 payload_spsr);
 
-/* Return platform-specific bl31_plat_params. May update bl31_params. */
-void *soc_get_bl31_plat_params(bl31_params_t *bl31_params);
+/* Return platform-specific bl31_plat_params. SoCs should avoid overriding this
+   and stick with the default BL aux parameter framework if possible. */
+void *soc_get_bl31_plat_params(void);
+
+/* Add a BL aux parameter to the list to be passed to BL31. Only works for SoCs
+   that use the default soc_get_bl31_plat_params() implementation. */
+void register_bl31_aux_param(struct bl_aux_param_header *param);
 
 #endif /* __BL31_H__ */