xref: /rk3399_ARM-atf/plat/arm/common/arm_bl2_setup.c (revision 2f18aa1fa35305f8feec25867473d30975b242fe)
1 /*
2  * Copyright (c) 2015-2018, ARM Limited and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #include <arch_helpers.h>
8 #include <arm_def.h>
9 #include <assert.h>
10 #include <bl_common.h>
11 #include <debug.h>
12 #include <desc_image_load.h>
13 #include <generic_delay_timer.h>
14 #ifdef SPD_opteed
15 #include <optee_utils.h>
16 #endif
17 #include <plat_arm.h>
18 #include <platform.h>
19 #include <platform_def.h>
20 #include <string.h>
21 #include <utils.h>
22 
23 /* Data structure which holds the extents of the trusted SRAM for BL2 */
24 static meminfo_t bl2_tzram_layout __aligned(CACHE_WRITEBACK_GRANULE);
25 
26 /*
27  * Check that BL2_BASE is atleast a page over ARM_BL_RAM_BASE. The page is for
28  * `meminfo_t` data structure and TB_FW_CONFIG passed from BL1. Not needed
29  * when BL2 is compiled for BL_AT_EL3 as BL2 doesn't need any info from BL1 and
30  * BL2 is loaded at base of usable SRAM.
31  */
32 #if BL2_AT_EL3
33 #define BL1_MEMINFO_OFFSET	0x0
34 #else
35 #define BL1_MEMINFO_OFFSET	PAGE_SIZE
36 #endif
37 
38 CASSERT(BL2_BASE >= (ARM_BL_RAM_BASE + BL1_MEMINFO_OFFSET), assert_bl2_base_overflows);
39 
40 /* Weak definitions may be overridden in specific ARM standard platform */
41 #pragma weak bl2_early_platform_setup2
42 #pragma weak bl2_platform_setup
43 #pragma weak bl2_plat_arch_setup
44 #pragma weak bl2_plat_sec_mem_layout
45 
46 #if LOAD_IMAGE_V2
47 
48 #pragma weak bl2_plat_handle_post_image_load
49 
50 #else /* LOAD_IMAGE_V2 */
51 
52 /*******************************************************************************
53  * This structure represents the superset of information that is passed to
54  * BL31, e.g. while passing control to it from BL2, bl31_params
55  * and other platform specific params
56  ******************************************************************************/
57 typedef struct bl2_to_bl31_params_mem {
58 	bl31_params_t bl31_params;
59 	image_info_t bl31_image_info;
60 	image_info_t bl32_image_info;
61 	image_info_t bl33_image_info;
62 	entry_point_info_t bl33_ep_info;
63 	entry_point_info_t bl32_ep_info;
64 	entry_point_info_t bl31_ep_info;
65 } bl2_to_bl31_params_mem_t;
66 
67 
68 static bl2_to_bl31_params_mem_t bl31_params_mem;
69 
70 
71 /* Weak definitions may be overridden in specific ARM standard platform */
72 #pragma weak bl2_plat_get_bl31_params
73 #pragma weak bl2_plat_get_bl31_ep_info
74 #pragma weak bl2_plat_flush_bl31_params
75 #pragma weak bl2_plat_set_bl31_ep_info
76 #pragma weak bl2_plat_get_scp_bl2_meminfo
77 #pragma weak bl2_plat_get_bl32_meminfo
78 #pragma weak bl2_plat_set_bl32_ep_info
79 #pragma weak bl2_plat_get_bl33_meminfo
80 #pragma weak bl2_plat_set_bl33_ep_info
81 
82 #if ARM_BL31_IN_DRAM
83 meminfo_t *bl2_plat_sec_mem_layout(void)
84 {
85 	static meminfo_t bl2_dram_layout
86 		__aligned(CACHE_WRITEBACK_GRANULE) = {
87 		.total_base = BL31_BASE,
88 		.total_size = (ARM_AP_TZC_DRAM1_BASE +
89 				ARM_AP_TZC_DRAM1_SIZE) - BL31_BASE,
90 		.free_base = BL31_BASE,
91 		.free_size = (ARM_AP_TZC_DRAM1_BASE +
92 				ARM_AP_TZC_DRAM1_SIZE) - BL31_BASE
93 	};
94 
95 	return &bl2_dram_layout;
96 }
97 #else
98 meminfo_t *bl2_plat_sec_mem_layout(void)
99 {
100 	return &bl2_tzram_layout;
101 }
102 #endif /* ARM_BL31_IN_DRAM */
103 
104 /*******************************************************************************
105  * This function assigns a pointer to the memory that the platform has kept
106  * aside to pass platform specific and trusted firmware related information
107  * to BL31. This memory is allocated by allocating memory to
108  * bl2_to_bl31_params_mem_t structure which is a superset of all the
109  * structure whose information is passed to BL31
110  * NOTE: This function should be called only once and should be done
111  * before generating params to BL31
112  ******************************************************************************/
113 bl31_params_t *bl2_plat_get_bl31_params(void)
114 {
115 	bl31_params_t *bl2_to_bl31_params;
116 
117 	/*
118 	 * Initialise the memory for all the arguments that needs to
119 	 * be passed to BL31
120 	 */
121 	zeromem(&bl31_params_mem, sizeof(bl2_to_bl31_params_mem_t));
122 
123 	/* Assign memory for TF related information */
124 	bl2_to_bl31_params = &bl31_params_mem.bl31_params;
125 	SET_PARAM_HEAD(bl2_to_bl31_params, PARAM_BL31, VERSION_1, 0);
126 
127 	/* Fill BL31 related information */
128 	bl2_to_bl31_params->bl31_image_info = &bl31_params_mem.bl31_image_info;
129 	SET_PARAM_HEAD(bl2_to_bl31_params->bl31_image_info, PARAM_IMAGE_BINARY,
130 		VERSION_1, 0);
131 
132 	/* Fill BL32 related information if it exists */
133 #ifdef BL32_BASE
134 	bl2_to_bl31_params->bl32_ep_info = &bl31_params_mem.bl32_ep_info;
135 	SET_PARAM_HEAD(bl2_to_bl31_params->bl32_ep_info, PARAM_EP,
136 		VERSION_1, 0);
137 	bl2_to_bl31_params->bl32_image_info = &bl31_params_mem.bl32_image_info;
138 	SET_PARAM_HEAD(bl2_to_bl31_params->bl32_image_info, PARAM_IMAGE_BINARY,
139 		VERSION_1, 0);
140 #endif /* BL32_BASE */
141 
142 	/* Fill BL33 related information */
143 	bl2_to_bl31_params->bl33_ep_info = &bl31_params_mem.bl33_ep_info;
144 	SET_PARAM_HEAD(bl2_to_bl31_params->bl33_ep_info,
145 		PARAM_EP, VERSION_1, 0);
146 
147 	/* BL33 expects to receive the primary CPU MPID (through x0) */
148 	bl2_to_bl31_params->bl33_ep_info->args.arg0 = 0xffff & read_mpidr();
149 
150 	bl2_to_bl31_params->bl33_image_info = &bl31_params_mem.bl33_image_info;
151 	SET_PARAM_HEAD(bl2_to_bl31_params->bl33_image_info, PARAM_IMAGE_BINARY,
152 		VERSION_1, 0);
153 
154 	return bl2_to_bl31_params;
155 }
156 
157 /* Flush the TF params and the TF plat params */
158 void bl2_plat_flush_bl31_params(void)
159 {
160 	flush_dcache_range((unsigned long)&bl31_params_mem,
161 			sizeof(bl2_to_bl31_params_mem_t));
162 }
163 
164 /*******************************************************************************
165  * This function returns a pointer to the shared memory that the platform
166  * has kept to point to entry point information of BL31 to BL2
167  ******************************************************************************/
168 struct entry_point_info *bl2_plat_get_bl31_ep_info(void)
169 {
170 #if DEBUG
171 	bl31_params_mem.bl31_ep_info.args.arg3 = ARM_BL31_PLAT_PARAM_VAL;
172 #endif
173 
174 	return &bl31_params_mem.bl31_ep_info;
175 }
176 #endif /* LOAD_IMAGE_V2 */
177 
178 /*******************************************************************************
179  * BL1 has passed the extents of the trusted SRAM that should be visible to BL2
180  * in x0. This memory layout is sitting at the base of the free trusted SRAM.
181  * Copy it to a safe location before its reclaimed by later BL2 functionality.
182  ******************************************************************************/
183 void arm_bl2_early_platform_setup(uintptr_t tb_fw_config, meminfo_t *mem_layout)
184 {
185 	/* Initialize the console to provide early debug support */
186 	arm_console_boot_init();
187 
188 	/* Setup the BL2 memory layout */
189 	bl2_tzram_layout = *mem_layout;
190 
191 	/* Initialise the IO layer and register platform IO devices */
192 	plat_arm_io_setup();
193 
194 #if LOAD_IMAGE_V2
195 	if (tb_fw_config != 0U)
196 		arm_bl2_set_tb_cfg_addr((void *)tb_fw_config);
197 #endif
198 }
199 
200 void bl2_early_platform_setup2(u_register_t arg0, u_register_t arg1, u_register_t arg2, u_register_t arg3)
201 {
202 	arm_bl2_early_platform_setup((uintptr_t)arg0, (meminfo_t *)arg1);
203 
204 	generic_delay_timer_init();
205 }
206 
207 /*
208  * Perform ARM standard platform setup.
209  */
210 void arm_bl2_platform_setup(void)
211 {
212 #if LOAD_IMAGE_V2
213 	arm_bl2_dyn_cfg_init();
214 #endif
215 
216 	/* Initialize the secure environment */
217 	plat_arm_security_setup();
218 
219 #if defined(PLAT_ARM_MEM_PROT_ADDR)
220 	arm_nor_psci_do_static_mem_protect();
221 #endif
222 }
223 
224 void bl2_platform_setup(void)
225 {
226 	arm_bl2_platform_setup();
227 }
228 
229 /*******************************************************************************
230  * Perform the very early platform specific architectural setup here. At the
231  * moment this is only initializes the mmu in a quick and dirty way.
232  ******************************************************************************/
233 void arm_bl2_plat_arch_setup(void)
234 {
235 	arm_setup_page_tables(bl2_tzram_layout.total_base,
236 			      bl2_tzram_layout.total_size,
237 			      BL_CODE_BASE,
238 			      BL_CODE_END,
239 			      BL_RO_DATA_BASE,
240 			      BL_RO_DATA_END
241 #if USE_COHERENT_MEM
242 			      , BL_COHERENT_RAM_BASE,
243 			      BL_COHERENT_RAM_END
244 #endif
245 			      );
246 
247 #ifdef AARCH32
248 	enable_mmu_secure(0);
249 #else
250 	enable_mmu_el1(0);
251 #endif
252 }
253 
254 void bl2_plat_arch_setup(void)
255 {
256 	arm_bl2_plat_arch_setup();
257 }
258 
259 #if LOAD_IMAGE_V2
260 int arm_bl2_handle_post_image_load(unsigned int image_id)
261 {
262 	int err = 0;
263 	bl_mem_params_node_t *bl_mem_params = get_bl_mem_params_node(image_id);
264 #ifdef SPD_opteed
265 	bl_mem_params_node_t *pager_mem_params = NULL;
266 	bl_mem_params_node_t *paged_mem_params = NULL;
267 #endif
268 	assert(bl_mem_params);
269 
270 	switch (image_id) {
271 #ifdef AARCH64
272 	case BL32_IMAGE_ID:
273 #ifdef SPD_opteed
274 		pager_mem_params = get_bl_mem_params_node(BL32_EXTRA1_IMAGE_ID);
275 		assert(pager_mem_params);
276 
277 		paged_mem_params = get_bl_mem_params_node(BL32_EXTRA2_IMAGE_ID);
278 		assert(paged_mem_params);
279 
280 		err = parse_optee_header(&bl_mem_params->ep_info,
281 				&pager_mem_params->image_info,
282 				&paged_mem_params->image_info);
283 		if (err != 0) {
284 			WARN("OPTEE header parse error.\n");
285 		}
286 #endif
287 		bl_mem_params->ep_info.spsr = arm_get_spsr_for_bl32_entry();
288 		break;
289 #endif
290 
291 	case BL33_IMAGE_ID:
292 		/* BL33 expects to receive the primary CPU MPID (through r0) */
293 		bl_mem_params->ep_info.args.arg0 = 0xffff & read_mpidr();
294 		bl_mem_params->ep_info.spsr = arm_get_spsr_for_bl33_entry();
295 		break;
296 
297 #ifdef SCP_BL2_BASE
298 	case SCP_BL2_IMAGE_ID:
299 		/* The subsequent handling of SCP_BL2 is platform specific */
300 		err = plat_arm_bl2_handle_scp_bl2(&bl_mem_params->image_info);
301 		if (err) {
302 			WARN("Failure in platform-specific handling of SCP_BL2 image.\n");
303 		}
304 		break;
305 #endif
306 	default:
307 		/* Do nothing in default case */
308 		break;
309 	}
310 
311 	return err;
312 }
313 
314 /*******************************************************************************
315  * This function can be used by the platforms to update/use image
316  * information for given `image_id`.
317  ******************************************************************************/
318 int bl2_plat_handle_post_image_load(unsigned int image_id)
319 {
320 	return arm_bl2_handle_post_image_load(image_id);
321 }
322 
323 #else /* LOAD_IMAGE_V2 */
324 
325 /*******************************************************************************
326  * Populate the extents of memory available for loading SCP_BL2 (if used),
327  * i.e. anywhere in trusted RAM as long as it doesn't overwrite BL2.
328  ******************************************************************************/
329 void bl2_plat_get_scp_bl2_meminfo(meminfo_t *scp_bl2_meminfo)
330 {
331 	*scp_bl2_meminfo = bl2_tzram_layout;
332 }
333 
334 /*******************************************************************************
335  * Before calling this function BL31 is loaded in memory and its entrypoint
336  * is set by load_image. This is a placeholder for the platform to change
337  * the entrypoint of BL31 and set SPSR and security state.
338  * On ARM standard platforms we only set the security state of the entrypoint
339  ******************************************************************************/
340 void bl2_plat_set_bl31_ep_info(image_info_t *bl31_image_info,
341 					entry_point_info_t *bl31_ep_info)
342 {
343 	SET_SECURITY_STATE(bl31_ep_info->h.attr, SECURE);
344 	bl31_ep_info->spsr = SPSR_64(MODE_EL3, MODE_SP_ELX,
345 					DISABLE_ALL_EXCEPTIONS);
346 }
347 
348 
349 /*******************************************************************************
350  * Before calling this function BL32 is loaded in memory and its entrypoint
351  * is set by load_image. This is a placeholder for the platform to change
352  * the entrypoint of BL32 and set SPSR and security state.
353  * On ARM standard platforms we only set the security state of the entrypoint
354  ******************************************************************************/
355 #ifdef BL32_BASE
356 void bl2_plat_set_bl32_ep_info(image_info_t *bl32_image_info,
357 					entry_point_info_t *bl32_ep_info)
358 {
359 	SET_SECURITY_STATE(bl32_ep_info->h.attr, SECURE);
360 	bl32_ep_info->spsr = arm_get_spsr_for_bl32_entry();
361 }
362 
363 /*******************************************************************************
364  * Populate the extents of memory available for loading BL32
365  ******************************************************************************/
366 void bl2_plat_get_bl32_meminfo(meminfo_t *bl32_meminfo)
367 {
368 	/*
369 	 * Populate the extents of memory available for loading BL32.
370 	 */
371 	bl32_meminfo->total_base = BL32_BASE;
372 	bl32_meminfo->free_base = BL32_BASE;
373 	bl32_meminfo->total_size =
374 			(TSP_SEC_MEM_BASE + TSP_SEC_MEM_SIZE) - BL32_BASE;
375 	bl32_meminfo->free_size =
376 			(TSP_SEC_MEM_BASE + TSP_SEC_MEM_SIZE) - BL32_BASE;
377 }
378 #endif /* BL32_BASE */
379 
380 /*******************************************************************************
381  * Before calling this function BL33 is loaded in memory and its entrypoint
382  * is set by load_image. This is a placeholder for the platform to change
383  * the entrypoint of BL33 and set SPSR and security state.
384  * On ARM standard platforms we only set the security state of the entrypoint
385  ******************************************************************************/
386 void bl2_plat_set_bl33_ep_info(image_info_t *image,
387 					entry_point_info_t *bl33_ep_info)
388 {
389 	SET_SECURITY_STATE(bl33_ep_info->h.attr, NON_SECURE);
390 	bl33_ep_info->spsr = arm_get_spsr_for_bl33_entry();
391 }
392 
393 /*******************************************************************************
394  * Populate the extents of memory available for loading BL33
395  ******************************************************************************/
396 void bl2_plat_get_bl33_meminfo(meminfo_t *bl33_meminfo)
397 {
398 	bl33_meminfo->total_base = ARM_NS_DRAM1_BASE;
399 	bl33_meminfo->total_size = ARM_NS_DRAM1_SIZE;
400 	bl33_meminfo->free_base = ARM_NS_DRAM1_BASE;
401 	bl33_meminfo->free_size = ARM_NS_DRAM1_SIZE;
402 }
403 
404 #endif /* LOAD_IMAGE_V2 */
405