xref: /rk3399_ARM-atf/bl31/bl31_main.c (revision ed8f06ddda52bc0333f79e9ff798419e67771ae5)
1 /*
2  * Copyright (c) 2013-2023, Arm Limited and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #include <assert.h>
8 #include <string.h>
9 
10 #include <arch.h>
11 #include <arch_features.h>
12 #include <arch_helpers.h>
13 #include <bl31/bl31.h>
14 #include <bl31/ehf.h>
15 #include <common/bl_common.h>
16 #include <common/debug.h>
17 #include <common/feat_detect.h>
18 #include <common/runtime_svc.h>
19 #include <drivers/console.h>
20 #include <lib/bootmarker_capture.h>
21 #include <lib/el3_runtime/context_mgmt.h>
22 #include <lib/pmf/pmf.h>
23 #include <lib/runtime_instr.h>
24 #include <plat/common/platform.h>
25 #include <services/std_svc.h>
26 
27 #if ENABLE_RUNTIME_INSTRUMENTATION
28 	PMF_REGISTER_SERVICE_SMC(rt_instr_svc, PMF_RT_INSTR_SVC_ID,
29 		RT_INSTR_TOTAL_IDS, PMF_STORE_ENABLE)
30 #endif
31 
32 #if ENABLE_RUNTIME_INSTRUMENTATION
33 	PMF_REGISTER_SERVICE(bl_svc, PMF_RT_INSTR_SVC_ID,
34 		BL_TOTAL_IDS, PMF_DUMP_ENABLE)
35 #endif
36 
37 /*******************************************************************************
38  * This function pointer is used to initialise the BL32 image. It's initialized
39  * by SPD calling bl31_register_bl32_init after setting up all things necessary
40  * for SP execution. In cases where both SPD and SP are absent, or when SPD
41  * finds it impossible to execute SP, this pointer is left as NULL
42  ******************************************************************************/
43 static int32_t (*bl32_init)(void);
44 
45 /*****************************************************************************
46  * Function used to initialise RMM if RME is enabled
47  *****************************************************************************/
48 #if ENABLE_RME
49 static int32_t (*rmm_init)(void);
50 #endif
51 
52 /*******************************************************************************
53  * Variable to indicate whether next image to execute after BL31 is BL33
54  * (non-secure & default) or BL32 (secure).
55  ******************************************************************************/
56 static uint32_t next_image_type = NON_SECURE;
57 
58 #ifdef SUPPORT_UNKNOWN_MPID
59 /*
60  * Flag to know whether an unsupported MPID has been detected. To avoid having it
61  * landing on the .bss section, it is initialized to a non-zero value, this way
62  * we avoid potential WAW hazards during system bring up.
63  * */
64 volatile uint32_t unsupported_mpid_flag = 1;
65 #endif
66 
67 /*
68  * Implement the ARM Standard Service function to get arguments for a
69  * particular service.
70  */
71 uintptr_t get_arm_std_svc_args(unsigned int svc_mask)
72 {
73 	/* Setup the arguments for PSCI Library */
74 	DEFINE_STATIC_PSCI_LIB_ARGS_V1(psci_args, bl31_warm_entrypoint);
75 
76 	/* PSCI is the only ARM Standard Service implemented */
77 	assert(svc_mask == PSCI_FID_MASK);
78 
79 	return (uintptr_t)&psci_args;
80 }
81 
82 /*******************************************************************************
83  * Simple function to initialise all BL31 helper libraries.
84  ******************************************************************************/
85 void __init bl31_lib_init(void)
86 {
87 	cm_init();
88 }
89 
90 /*******************************************************************************
91  * Setup function for BL31.
92  ******************************************************************************/
93 void bl31_setup(u_register_t arg0, u_register_t arg1, u_register_t arg2,
94 		u_register_t arg3)
95 {
96 	/* Perform early platform-specific setup */
97 	bl31_early_platform_setup2(arg0, arg1, arg2, arg3);
98 
99 	/* Perform late platform-specific setup */
100 	bl31_plat_arch_setup();
101 
102 #if CTX_INCLUDE_PAUTH_REGS
103 	/*
104 	 * Assert that the ARMv8.3-PAuth registers are present or an access
105 	 * fault will be triggered when they are being saved or restored.
106 	 */
107 	assert(is_armv8_3_pauth_present());
108 #endif /* CTX_INCLUDE_PAUTH_REGS */
109 }
110 
111 /*******************************************************************************
112  * BL31 is responsible for setting up the runtime services for the primary cpu
113  * before passing control to the bootloader or an Operating System. This
114  * function calls runtime_svc_init() which initializes all registered runtime
115  * services. The run time services would setup enough context for the core to
116  * switch to the next exception level. When this function returns, the core will
117  * switch to the programmed exception level via an ERET.
118  ******************************************************************************/
119 void bl31_main(void)
120 {
121 	/* Init registers that never change for the lifetime of TF-A */
122 	cm_manage_extensions_el3();
123 
124 	NOTICE("BL31: %s\n", version_string);
125 	NOTICE("BL31: %s\n", build_message);
126 
127 #if FEATURE_DETECTION
128 	/* Detect if features enabled during compilation are supported by PE. */
129 	detect_arch_features();
130 #endif /* FEATURE_DETECTION */
131 
132 #if ENABLE_RUNTIME_INSTRUMENTATION
133 	PMF_CAPTURE_TIMESTAMP(bl_svc, BL31_ENTRY, PMF_CACHE_MAINT);
134 #endif
135 
136 #ifdef SUPPORT_UNKNOWN_MPID
137 	if (unsupported_mpid_flag == 0) {
138 		NOTICE("Unsupported MPID detected!\n");
139 	}
140 #endif
141 
142 	/* Perform platform setup in BL31 */
143 	bl31_platform_setup();
144 
145 	/* Initialise helper libraries */
146 	bl31_lib_init();
147 
148 #if EL3_EXCEPTION_HANDLING
149 	INFO("BL31: Initialising Exception Handling Framework\n");
150 	ehf_init();
151 #endif
152 
153 	/* Initialize the runtime services e.g. psci. */
154 	INFO("BL31: Initializing runtime services\n");
155 	runtime_svc_init();
156 
157 	/*
158 	 * All the cold boot actions on the primary cpu are done. We now need to
159 	 * decide which is the next image and how to execute it.
160 	 * If the SPD runtime service is present, it would want to pass control
161 	 * to BL32 first in S-EL1. In that case, SPD would have registered a
162 	 * function to initialize bl32 where it takes responsibility of entering
163 	 * S-EL1 and returning control back to bl31_main. Similarly, if RME is
164 	 * enabled and a function is registered to initialize RMM, control is
165 	 * transferred to RMM in R-EL2. After RMM initialization, control is
166 	 * returned back to bl31_main. Once this is done we can prepare entry
167 	 * into BL33 as normal.
168 	 */
169 
170 	/*
171 	 * If SPD had registered an init hook, invoke it.
172 	 */
173 	if (bl32_init != NULL) {
174 		INFO("BL31: Initializing BL32\n");
175 
176 		console_flush();
177 		int32_t rc = (*bl32_init)();
178 
179 		if (rc == 0) {
180 			WARN("BL31: BL32 initialization failed\n");
181 		}
182 	}
183 
184 	/*
185 	 * If RME is enabled and init hook is registered, initialize RMM
186 	 * in R-EL2.
187 	 */
188 #if ENABLE_RME
189 	if (rmm_init != NULL) {
190 		INFO("BL31: Initializing RMM\n");
191 
192 		console_flush();
193 		int32_t rc = (*rmm_init)();
194 
195 		if (rc == 0) {
196 			WARN("BL31: RMM initialization failed\n");
197 		}
198 	}
199 #endif
200 
201 	/*
202 	 * We are ready to enter the next EL. Prepare entry into the image
203 	 * corresponding to the desired security state after the next ERET.
204 	 */
205 	bl31_prepare_next_image_entry();
206 
207 	console_flush();
208 
209 	/*
210 	 * Perform any platform specific runtime setup prior to cold boot exit
211 	 * from BL31
212 	 */
213 	bl31_plat_runtime_setup();
214 
215 #if ENABLE_RUNTIME_INSTRUMENTATION
216 	PMF_CAPTURE_TIMESTAMP(bl_svc, BL31_EXIT, PMF_CACHE_MAINT);
217 	console_flush();
218 #endif
219 }
220 
221 /*******************************************************************************
222  * Accessor functions to help runtime services decide which image should be
223  * executed after BL31. This is BL33 or the non-secure bootloader image by
224  * default but the Secure payload dispatcher could override this by requesting
225  * an entry into BL32 (Secure payload) first. If it does so then it should use
226  * the same API to program an entry into BL33 once BL32 initialisation is
227  * complete.
228  ******************************************************************************/
229 void bl31_set_next_image_type(uint32_t security_state)
230 {
231 	assert(sec_state_is_valid(security_state));
232 	next_image_type = security_state;
233 }
234 
235 uint32_t bl31_get_next_image_type(void)
236 {
237 	return next_image_type;
238 }
239 
240 /*******************************************************************************
241  * This function programs EL3 registers and performs other setup to enable entry
242  * into the next image after BL31 at the next ERET.
243  ******************************************************************************/
244 void __init bl31_prepare_next_image_entry(void)
245 {
246 	entry_point_info_t *next_image_info;
247 	uint32_t image_type;
248 
249 #if CTX_INCLUDE_AARCH32_REGS
250 	/*
251 	 * Ensure that the build flag to save AArch32 system registers in CPU
252 	 * context is not set for AArch64-only platforms.
253 	 */
254 	if (el_implemented(1) == EL_IMPL_A64ONLY) {
255 		ERROR("EL1 supports AArch64-only. Please set build flag "
256 				"CTX_INCLUDE_AARCH32_REGS = 0\n");
257 		panic();
258 	}
259 #endif
260 
261 	/* Determine which image to execute next */
262 	image_type = bl31_get_next_image_type();
263 
264 	/* Program EL3 registers to enable entry into the next EL */
265 	next_image_info = bl31_plat_get_next_image_ep_info(image_type);
266 	assert(next_image_info != NULL);
267 	assert(image_type == GET_SECURITY_STATE(next_image_info->h.attr));
268 
269 	INFO("BL31: Preparing for EL3 exit to %s world\n",
270 		(image_type == SECURE) ? "secure" : "normal");
271 	print_entry_point_info(next_image_info);
272 	cm_init_my_context(next_image_info);
273 
274 	/*
275 	* If we are entering the Non-secure world, use
276 	* 'cm_prepare_el3_exit_ns' to exit.
277 	*/
278 	if (image_type == NON_SECURE) {
279 		cm_prepare_el3_exit_ns();
280 	} else {
281 		cm_prepare_el3_exit(image_type);
282 	}
283 }
284 
285 /*******************************************************************************
286  * This function initializes the pointer to BL32 init function. This is expected
287  * to be called by the SPD after it finishes all its initialization
288  ******************************************************************************/
289 void bl31_register_bl32_init(int32_t (*func)(void))
290 {
291 	bl32_init = func;
292 }
293 
294 #if ENABLE_RME
295 /*******************************************************************************
296  * This function initializes the pointer to RMM init function. This is expected
297  * to be called by the RMMD after it finishes all its initialization
298  ******************************************************************************/
299 void bl31_register_rmm_init(int32_t (*func)(void))
300 {
301 	rmm_init = func;
302 }
303 #endif
304