xref: /rk3399_ARM-atf/plat/arm/common/arm_bl1_setup.c (revision 2d3b44e3073e8d6ec49dde45ec353d6f41290917)
1 /*
2  * Copyright (c) 2015-2024, Arm Limited and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #include <assert.h>
8 
9 #include <platform_def.h>
10 
11 #include <arch.h>
12 #include <bl1/bl1.h>
13 #include <common/bl_common.h>
14 #include <common/debug.h>
15 #include <lib/fconf/fconf.h>
16 #include <lib/fconf/fconf_dyn_cfg_getter.h>
17 #if TRANSFER_LIST
18 #include <lib/transfer_list.h>
19 #endif
20 #include <lib/utils.h>
21 #include <lib/xlat_tables/xlat_tables_compat.h>
22 #include <plat/arm/common/plat_arm.h>
23 #include <plat/common/platform.h>
24 
25 /* Weak definitions may be overridden in specific ARM standard platform */
26 #pragma weak bl1_early_platform_setup
27 #pragma weak bl1_plat_arch_setup
28 #pragma weak bl1_plat_sec_mem_layout
29 #pragma weak arm_bl1_early_platform_setup
30 #pragma weak bl1_plat_prepare_exit
31 #pragma weak bl1_plat_get_next_image_id
32 #pragma weak plat_arm_bl1_fwu_needed
33 #pragma weak arm_bl1_plat_arch_setup
34 #pragma weak arm_bl1_platform_setup
35 
36 #define MAP_BL1_TOTAL		MAP_REGION_FLAT(			\
37 					bl1_tzram_layout.total_base,	\
38 					bl1_tzram_layout.total_size,	\
39 					MT_MEMORY | MT_RW | EL3_PAS)
40 /*
41  * If SEPARATE_CODE_AND_RODATA=1 we define a region for each section
42  * otherwise one region is defined containing both
43  */
44 #if SEPARATE_CODE_AND_RODATA
45 #define MAP_BL1_RO		MAP_REGION_FLAT(			\
46 					BL_CODE_BASE,			\
47 					BL1_CODE_END - BL_CODE_BASE,	\
48 					MT_CODE | EL3_PAS),		\
49 				MAP_REGION_FLAT(			\
50 					BL1_RO_DATA_BASE,		\
51 					BL1_RO_DATA_END			\
52 						- BL_RO_DATA_BASE,	\
53 					MT_RO_DATA | EL3_PAS)
54 #else
55 #define MAP_BL1_RO		MAP_REGION_FLAT(			\
56 					BL_CODE_BASE,			\
57 					BL1_CODE_END - BL_CODE_BASE,	\
58 					MT_CODE | EL3_PAS)
59 #endif
60 
61 /* Data structure which holds the extents of the trusted SRAM for BL1*/
62 static meminfo_t bl1_tzram_layout;
63 
64 /* Boolean variable to hold condition whether firmware update needed or not */
65 static bool is_fwu_needed;
66 
67 struct transfer_list_header *secure_tl;
68 
69 struct meminfo *bl1_plat_sec_mem_layout(void)
70 {
71 	return &bl1_tzram_layout;
72 }
73 
74 /*******************************************************************************
75  * BL1 specific platform actions shared between ARM standard platforms.
76  ******************************************************************************/
77 void arm_bl1_early_platform_setup(void)
78 {
79 
80 #if !ARM_DISABLE_TRUSTED_WDOG
81 	/* Enable watchdog */
82 	plat_arm_secure_wdt_start();
83 #endif
84 
85 	/* Initialize the console to provide early debug support */
86 	arm_console_boot_init();
87 
88 	/* Allow BL1 to see the whole Trusted RAM */
89 	bl1_tzram_layout.total_base = ARM_BL_RAM_BASE;
90 	bl1_tzram_layout.total_size = ARM_BL_RAM_SIZE;
91 
92 #if TRANSFER_LIST
93 	secure_tl = transfer_list_init((void *)PLAT_ARM_EL3_FW_HANDOFF_BASE,
94 					 PLAT_ARM_FW_HANDOFF_SIZE);
95 	assert(secure_tl != NULL);
96 #endif
97 }
98 
99 void bl1_early_platform_setup(void)
100 {
101 	arm_bl1_early_platform_setup();
102 
103 	/*
104 	 * Initialize Interconnect for this cluster during cold boot.
105 	 * No need for locks as no other CPU is active.
106 	 */
107 	plat_arm_interconnect_init();
108 	/*
109 	 * Enable Interconnect coherency for the primary CPU's cluster.
110 	 */
111 	plat_arm_interconnect_enter_coherency();
112 }
113 
114 /******************************************************************************
115  * Perform the very early platform specific architecture setup shared between
116  * ARM standard platforms. This only does basic initialization. Later
117  * architectural setup (bl1_arch_setup()) does not do anything platform
118  * specific.
119  *****************************************************************************/
120 void arm_bl1_plat_arch_setup(void)
121 {
122 #if USE_COHERENT_MEM
123 	/* Ensure ARM platforms don't use coherent memory in BL1. */
124 	assert((BL_COHERENT_RAM_END - BL_COHERENT_RAM_BASE) == 0U);
125 #endif
126 
127 	const mmap_region_t bl_regions[] = {
128 		MAP_BL1_TOTAL,
129 		MAP_BL1_RO,
130 #if USE_ROMLIB
131 		ARM_MAP_ROMLIB_CODE,
132 		ARM_MAP_ROMLIB_DATA,
133 #endif
134 		{0}
135 	};
136 
137 	setup_page_tables(bl_regions, plat_arm_get_mmap());
138 #ifdef __aarch64__
139 	enable_mmu_el3(0);
140 #else
141 	enable_mmu_svc_mon(0);
142 #endif /* __aarch64__ */
143 
144 	arm_setup_romlib();
145 }
146 
147 void bl1_plat_arch_setup(void)
148 {
149 	arm_bl1_plat_arch_setup();
150 }
151 
152 /*
153  * Perform the platform specific architecture setup shared between
154  * ARM standard platforms.
155  */
156 void arm_bl1_platform_setup(void)
157 {
158 	const struct dyn_cfg_dtb_info_t *config_info __unused;
159 	uint32_t fw_config_max_size __unused;
160 	image_info_t config_image_info __unused;
161 	struct transfer_list_entry *te __unused;
162 
163 	image_desc_t *desc;
164 
165 	int err __unused = 1;
166 
167 	/* Initialise the IO layer and register platform IO devices */
168 	plat_arm_io_setup();
169 
170 	/* Check if we need FWU before further processing */
171 	is_fwu_needed = plat_arm_bl1_fwu_needed();
172 	if (is_fwu_needed) {
173 		ERROR("Skip platform setup as FWU detected\n");
174 		return;
175 	}
176 
177 #if TRANSFER_LIST
178 #if CRYPTO_SUPPORT
179 	te = transfer_list_add(secure_tl, TL_TAG_MBEDTLS_HEAP_INFO,
180 			       sizeof(struct crypto_heap_info), NULL);
181 	assert(te != NULL);
182 
183 	struct crypto_heap_info *heap_info =
184 		(struct crypto_heap_info *)transfer_list_entry_data(te);
185 	arm_get_mbedtls_heap(&heap_info->addr, &heap_info->size);
186 #endif /* CRYPTO_SUPPORT */
187 
188 	desc = bl1_plat_get_image_desc(BL2_IMAGE_ID);
189 
190 	/*
191 	 * The event log might have been updated prior to this, make sure we have an
192 	 * up to date tl before setting the handoff arguments.
193 	 */
194 	transfer_list_update_checksum(secure_tl);
195 	transfer_list_set_handoff_args(secure_tl, &desc->ep_info);
196 #else
197 	/* Set global DTB info for fixed fw_config information */
198 	fw_config_max_size = ARM_FW_CONFIG_LIMIT - ARM_FW_CONFIG_BASE;
199 	set_config_info(ARM_FW_CONFIG_BASE, ~0UL, fw_config_max_size, FW_CONFIG_ID);
200 
201 	/* Fill the device tree information struct with the info from the config dtb */
202 	err = fconf_load_config(FW_CONFIG_ID);
203 	if (err < 0) {
204 		ERROR("Loading of FW_CONFIG failed %d\n", err);
205 		plat_error_handler(err);
206 	}
207 
208 	/*
209 	 * FW_CONFIG loaded successfully. If FW_CONFIG device tree parsing
210 	 * is successful then load TB_FW_CONFIG device tree.
211 	 */
212 	config_info = FCONF_GET_PROPERTY(dyn_cfg, dtb, FW_CONFIG_ID);
213 	if (config_info != NULL) {
214 		err = fconf_populate_dtb_registry(config_info->config_addr);
215 		if (err < 0) {
216 			ERROR("Parsing of FW_CONFIG failed %d\n", err);
217 			plat_error_handler(err);
218 		}
219 
220 		/* load TB_FW_CONFIG */
221 		err = fconf_load_config(TB_FW_CONFIG_ID);
222 		if (err < 0) {
223 			ERROR("Loading of TB_FW_CONFIG failed %d\n", err);
224 			plat_error_handler(err);
225 		}
226 	} else {
227 		ERROR("Invalid FW_CONFIG address\n");
228 		plat_error_handler(err);
229 	}
230 
231 	desc = bl1_plat_get_image_desc(BL2_IMAGE_ID);
232 
233 	/* The BL2 ep_info arg0 is modified to point to FW_CONFIG */
234 	assert(desc != NULL);
235 	desc->ep_info.args.arg0 = config_info->config_addr;
236 
237 #if CRYPTO_SUPPORT
238 	/* Share the Mbed TLS heap info with other images */
239 	arm_bl1_set_mbedtls_heap();
240 #endif /* CRYPTO_SUPPORT */
241 #endif /* TRANSFER_LIST */
242 
243 	/*
244 	 * Allow access to the System counter timer module and program
245 	 * counter frequency for non secure images during FWU
246 	 */
247 #ifdef ARM_SYS_TIMCTL_BASE
248 	arm_configure_sys_timer();
249 #endif
250 #if (ARM_ARCH_MAJOR > 7) || defined(ARMV7_SUPPORTS_GENERIC_TIMER)
251 	write_cntfrq_el0(plat_get_syscnt_freq2());
252 #endif
253 }
254 
255 void bl1_plat_prepare_exit(entry_point_info_t *ep_info)
256 {
257 #if !ARM_DISABLE_TRUSTED_WDOG
258 	/* Disable watchdog before leaving BL1 */
259 	plat_arm_secure_wdt_stop();
260 #endif
261 
262 #ifdef EL3_PAYLOAD_BASE
263 	/*
264 	 * Program the EL3 payload's entry point address into the CPUs mailbox
265 	 * in order to release secondary CPUs from their holding pen and make
266 	 * them jump there.
267 	 */
268 	plat_arm_program_trusted_mailbox(ep_info->pc);
269 	dsbsy();
270 	sev();
271 #endif
272 }
273 
274 /*
275  * On Arm platforms, the FWU process is triggered when the FIP image has
276  * been tampered with.
277  */
278 bool plat_arm_bl1_fwu_needed(void)
279 {
280 	return !arm_io_is_toc_valid();
281 }
282 
283 /*******************************************************************************
284  * The following function checks if Firmware update is needed,
285  * by checking if TOC in FIP image is valid or not.
286  ******************************************************************************/
287 unsigned int bl1_plat_get_next_image_id(void)
288 {
289 	return  is_fwu_needed ? NS_BL1U_IMAGE_ID : BL2_IMAGE_ID;
290 }
291 
292 // Use the default implementation of this function when Firmware Handoff is
293 // disabled to avoid duplicating its logic.
294 #if TRANSFER_LIST
295 int bl1_plat_handle_post_image_load(unsigned int image_id)
296 {
297 	image_desc_t *image_desc __unused;
298 
299 	assert(image_id == BL2_IMAGE_ID);
300 	struct transfer_list_entry *te;
301 
302 	/* Convey this information to BL2 via its TL. */
303 	te = transfer_list_add(secure_tl, TL_TAG_SRAM_LAYOUT64,
304 			       sizeof(meminfo_t), NULL);
305 	assert(te != NULL);
306 
307 	bl1_plat_calc_bl2_layout(&bl1_tzram_layout,
308 				 (meminfo_t *)transfer_list_entry_data(te));
309 
310 	transfer_list_update_checksum(secure_tl);
311 
312 	/**
313 	 * Before exiting make sure the contents of the TL are flushed in case there's no
314 	 * support for hardware cache coherency.
315 	 */
316 	flush_dcache_range((uintptr_t)secure_tl, secure_tl->size);
317 	return 0;
318 }
319 #endif /* TRANSFER_LIST*/
320