xref: /rk3399_ARM-atf/bl2/bl2_main.c (revision 712038db835d268de89dc8a11cfc1e67f581e51b)
1 /*
2  * Copyright (c) 2013-2014, ARM Limited and Contributors. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * Redistributions of source code must retain the above copyright notice, this
8  * list of conditions and the following disclaimer.
9  *
10  * Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  *
14  * Neither the name of ARM nor the names of its contributors may be used
15  * to endorse or promote products derived from this software without specific
16  * prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 #include <arch.h>
32 #include <arch_helpers.h>
33 #include <assert.h>
34 #include <auth_mod.h>
35 #include <bl_common.h>
36 #include <debug.h>
37 #include <errno.h>
38 #include <platform.h>
39 #include <platform_def.h>
40 #include <stdint.h>
41 #include "bl2_private.h"
42 
43 /*******************************************************************************
44  * Load the BL3-0 image if there's one.
45  * If a platform does not want to attempt to load BL3-0 image it must leave
46  * BL30_BASE undefined.
47  * Return 0 on success or if there's no BL3-0 image to load, a negative error
48  * code otherwise.
49  ******************************************************************************/
50 static int load_bl30(void)
51 {
52 	int e = 0;
53 #ifdef BL30_BASE
54 	meminfo_t bl30_mem_info;
55 	image_info_t bl30_image_info;
56 
57 	/*
58 	 * It is up to the platform to specify where BL3-0 should be loaded if
59 	 * it exists. It could create space in the secure sram or point to a
60 	 * completely different memory.
61 	 *
62 	 * The entry point information is not relevant in this case as the AP
63 	 * won't execute the BL3-0 image.
64 	 */
65 	INFO("BL2: Loading BL3-0\n");
66 	bl2_plat_get_bl30_meminfo(&bl30_mem_info);
67 	bl30_image_info.h.version = VERSION_1;
68 	e = load_auth_image(&bl30_mem_info,
69 			    BL30_IMAGE_ID,
70 			    BL30_BASE,
71 			    &bl30_image_info,
72 			    NULL);
73 
74 	if (e == 0) {
75 		/* The subsequent handling of BL3-0 is platform specific */
76 		e = bl2_plat_handle_bl30(&bl30_image_info);
77 		if (e) {
78 			ERROR("Failure in platform-specific handling of BL3-0 image.\n");
79 		}
80 	}
81 #endif /* BL30_BASE */
82 
83 	return e;
84 }
85 
86 #ifndef EL3_PAYLOAD_BASE
87 /*******************************************************************************
88  * Load the BL3-1 image.
89  * The bl2_to_bl31_params and bl31_ep_info params will be updated with the
90  * relevant BL3-1 information.
91  * Return 0 on success, a negative error code otherwise.
92  ******************************************************************************/
93 static int load_bl31(bl31_params_t *bl2_to_bl31_params,
94 		     entry_point_info_t *bl31_ep_info)
95 {
96 	meminfo_t *bl2_tzram_layout;
97 	int e;
98 
99 	INFO("BL2: Loading BL3-1\n");
100 	assert(bl2_to_bl31_params != NULL);
101 	assert(bl31_ep_info != NULL);
102 
103 	/* Find out how much free trusted ram remains after BL2 load */
104 	bl2_tzram_layout = bl2_plat_sec_mem_layout();
105 
106 	/* Set the X0 parameter to BL3-1 */
107 	bl31_ep_info->args.arg0 = (unsigned long)bl2_to_bl31_params;
108 
109 	/* Load the BL3-1 image */
110 	e = load_auth_image(bl2_tzram_layout,
111 			    BL31_IMAGE_ID,
112 			    BL31_BASE,
113 			    bl2_to_bl31_params->bl31_image_info,
114 			    bl31_ep_info);
115 
116 	if (e == 0) {
117 		bl2_plat_set_bl31_ep_info(bl2_to_bl31_params->bl31_image_info,
118 					  bl31_ep_info);
119 	}
120 
121 	return e;
122 }
123 
124 /*******************************************************************************
125  * Load the BL3-2 image if there's one.
126  * The bl2_to_bl31_params param will be updated with the relevant BL3-2
127  * information.
128  * If a platform does not want to attempt to load BL3-2 image it must leave
129  * BL32_BASE undefined.
130  * Return 0 on success or if there's no BL3-2 image to load, a negative error
131  * code otherwise.
132  ******************************************************************************/
133 static int load_bl32(bl31_params_t *bl2_to_bl31_params)
134 {
135 	int e = 0;
136 #ifdef BL32_BASE
137 	meminfo_t bl32_mem_info;
138 
139 	INFO("BL2: Loading BL3-2\n");
140 	assert(bl2_to_bl31_params != NULL);
141 
142 	/*
143 	 * It is up to the platform to specify where BL3-2 should be loaded if
144 	 * it exists. It could create space in the secure sram or point to a
145 	 * completely different memory.
146 	 */
147 	bl2_plat_get_bl32_meminfo(&bl32_mem_info);
148 	e = load_auth_image(&bl32_mem_info,
149 			    BL32_IMAGE_ID,
150 			    BL32_BASE,
151 			    bl2_to_bl31_params->bl32_image_info,
152 			    bl2_to_bl31_params->bl32_ep_info);
153 
154 	if (e == 0) {
155 		bl2_plat_set_bl32_ep_info(
156 			bl2_to_bl31_params->bl32_image_info,
157 			bl2_to_bl31_params->bl32_ep_info);
158 	}
159 #endif /* BL32_BASE */
160 
161 	return e;
162 }
163 
164 /*******************************************************************************
165  * Load the BL3-3 image.
166  * The bl2_to_bl31_params param will be updated with the relevant BL3-3
167  * information.
168  * Return 0 on success, a negative error code otherwise.
169  ******************************************************************************/
170 static int load_bl33(bl31_params_t *bl2_to_bl31_params)
171 {
172 	meminfo_t bl33_mem_info;
173 	int e;
174 
175 	INFO("BL2: Loading BL3-3\n");
176 	assert(bl2_to_bl31_params != NULL);
177 
178 	bl2_plat_get_bl33_meminfo(&bl33_mem_info);
179 
180 	/* Load the BL3-3 image in non-secure memory provided by the platform */
181 	e = load_auth_image(&bl33_mem_info,
182 			    BL33_IMAGE_ID,
183 			    plat_get_ns_image_entrypoint(),
184 			    bl2_to_bl31_params->bl33_image_info,
185 			    bl2_to_bl31_params->bl33_ep_info);
186 
187 	if (e == 0) {
188 		bl2_plat_set_bl33_ep_info(bl2_to_bl31_params->bl33_image_info,
189 					  bl2_to_bl31_params->bl33_ep_info);
190 	}
191 
192 	return e;
193 }
194 #endif /* EL3_PAYLOAD_BASE */
195 
196 /*******************************************************************************
197  * The only thing to do in BL2 is to load further images and pass control to
198  * BL3-1. The memory occupied by BL2 will be reclaimed by BL3-x stages. BL2 runs
199  * entirely in S-EL1.
200  ******************************************************************************/
201 void bl2_main(void)
202 {
203 	bl31_params_t *bl2_to_bl31_params;
204 	entry_point_info_t *bl31_ep_info;
205 	int e;
206 
207 	NOTICE("BL2: %s\n", version_string);
208 	NOTICE("BL2: %s\n", build_message);
209 
210 	/* Perform remaining generic architectural setup in S-EL1 */
211 	bl2_arch_setup();
212 
213 #if TRUSTED_BOARD_BOOT
214 	/* Initialize authentication module */
215 	auth_mod_init();
216 #endif /* TRUSTED_BOARD_BOOT */
217 
218 	/*
219 	 * Load the subsequent bootloader images
220 	 */
221 	e = load_bl30();
222 	if (e) {
223 		ERROR("Failed to load BL3-0 (%i)\n", e);
224 		plat_error_handler(e);
225 	}
226 
227 	/* Perform platform setup in BL2 after loading BL3-0 */
228 	bl2_platform_setup();
229 
230 	/*
231 	 * Get a pointer to the memory the platform has set aside to pass
232 	 * information to BL3-1.
233 	 */
234 	bl2_to_bl31_params = bl2_plat_get_bl31_params();
235 	bl31_ep_info = bl2_plat_get_bl31_ep_info();
236 
237 #ifdef EL3_PAYLOAD_BASE
238 	/*
239 	 * In the case of an EL3 payload, we don't need to load any further
240 	 * images. Just update the BL31 entrypoint info structure to make BL1
241 	 * jump to the EL3 payload.
242 	 * The pointer to the memory the platform has set aside to pass
243 	 * information to BL3-1 in the normal boot flow is reused here, even
244 	 * though only a fraction of the information contained in the
245 	 * bl31_params_t structure makes sense in the context of EL3 payloads.
246 	 * This will be refined in the future.
247 	 */
248 	VERBOSE("BL2: Populating the entrypoint info for the EL3 payload\n");
249 	bl31_ep_info->pc = EL3_PAYLOAD_BASE;
250 	bl31_ep_info->args.arg0 = (unsigned long) bl2_to_bl31_params;
251 	bl2_plat_set_bl31_ep_info(NULL, bl31_ep_info);
252 #else
253 	e = load_bl31(bl2_to_bl31_params, bl31_ep_info);
254 	if (e) {
255 		ERROR("Failed to load BL3-1 (%i)\n", e);
256 		plat_error_handler(e);
257 	}
258 
259 	e = load_bl32(bl2_to_bl31_params);
260 	if (e) {
261 		if (e == -EAUTH) {
262 			ERROR("Failed to authenticate BL3-2\n");
263 			plat_error_handler(e);
264 		} else {
265 			WARN("Failed to load BL3-2 (%i)\n", e);
266 		}
267 	}
268 
269 	e = load_bl33(bl2_to_bl31_params);
270 	if (e) {
271 		ERROR("Failed to load BL3-3 (%i)\n", e);
272 		plat_error_handler(e);
273 	}
274 #endif /* EL3_PAYLOAD_BASE */
275 
276 	/* Flush the params to be passed to memory */
277 	bl2_plat_flush_bl31_params();
278 
279 	/*
280 	 * Run BL3-1 via an SMC to BL1. Information on how to pass control to
281 	 * the BL3-2 (if present) and BL3-3 software images will be passed to
282 	 * BL3-1 as an argument.
283 	 */
284 	smc(RUN_IMAGE, (unsigned long)bl31_ep_info, 0, 0, 0, 0, 0, 0);
285 }
286