xref: /rk3399_ARM-atf/bl2/bl2_main.c (revision ab5a53ef0f2f4f19f59a28738ae00c6bb5975d21)
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 <bl1.h>
36 #include <bl_common.h>
37 #include <debug.h>
38 #include <errno.h>
39 #include <platform.h>
40 #include <platform_def.h>
41 #include <stdint.h>
42 #include "bl2_private.h"
43 
44 /*******************************************************************************
45  * Load the BL3-0 image if there's one.
46  * If a platform does not want to attempt to load BL3-0 image it must leave
47  * BL30_BASE undefined.
48  * Return 0 on success or if there's no BL3-0 image to load, a negative error
49  * code otherwise.
50  ******************************************************************************/
51 static int load_bl30(void)
52 {
53 	int e = 0;
54 #ifdef BL30_BASE
55 	meminfo_t bl30_mem_info;
56 	image_info_t bl30_image_info;
57 
58 	/*
59 	 * It is up to the platform to specify where BL3-0 should be loaded if
60 	 * it exists. It could create space in the secure sram or point to a
61 	 * completely different memory.
62 	 *
63 	 * The entry point information is not relevant in this case as the AP
64 	 * won't execute the BL3-0 image.
65 	 */
66 	INFO("BL2: Loading BL3-0\n");
67 	bl2_plat_get_bl30_meminfo(&bl30_mem_info);
68 	bl30_image_info.h.version = VERSION_1;
69 	e = load_auth_image(&bl30_mem_info,
70 			    BL30_IMAGE_ID,
71 			    BL30_BASE,
72 			    &bl30_image_info,
73 			    NULL);
74 
75 	if (e == 0) {
76 		/* The subsequent handling of BL3-0 is platform specific */
77 		e = bl2_plat_handle_bl30(&bl30_image_info);
78 		if (e) {
79 			ERROR("Failure in platform-specific handling of BL3-0 image.\n");
80 		}
81 	}
82 #endif /* BL30_BASE */
83 
84 	return e;
85 }
86 
87 #ifndef EL3_PAYLOAD_BASE
88 /*******************************************************************************
89  * Load the BL3-1 image.
90  * The bl2_to_bl31_params and bl31_ep_info params will be updated with the
91  * relevant BL3-1 information.
92  * Return 0 on success, a negative error code otherwise.
93  ******************************************************************************/
94 static int load_bl31(bl31_params_t *bl2_to_bl31_params,
95 		     entry_point_info_t *bl31_ep_info)
96 {
97 	meminfo_t *bl2_tzram_layout;
98 	int e;
99 
100 	INFO("BL2: Loading BL3-1\n");
101 	assert(bl2_to_bl31_params != NULL);
102 	assert(bl31_ep_info != NULL);
103 
104 	/* Find out how much free trusted ram remains after BL2 load */
105 	bl2_tzram_layout = bl2_plat_sec_mem_layout();
106 
107 	/* Set the X0 parameter to BL3-1 */
108 	bl31_ep_info->args.arg0 = (unsigned long)bl2_to_bl31_params;
109 
110 	/* Load the BL3-1 image */
111 	e = load_auth_image(bl2_tzram_layout,
112 			    BL31_IMAGE_ID,
113 			    BL31_BASE,
114 			    bl2_to_bl31_params->bl31_image_info,
115 			    bl31_ep_info);
116 
117 	if (e == 0) {
118 		bl2_plat_set_bl31_ep_info(bl2_to_bl31_params->bl31_image_info,
119 					  bl31_ep_info);
120 	}
121 
122 	return e;
123 }
124 
125 /*******************************************************************************
126  * Load the BL3-2 image if there's one.
127  * The bl2_to_bl31_params param will be updated with the relevant BL3-2
128  * information.
129  * If a platform does not want to attempt to load BL3-2 image it must leave
130  * BL32_BASE undefined.
131  * Return 0 on success or if there's no BL3-2 image to load, a negative error
132  * code otherwise.
133  ******************************************************************************/
134 static int load_bl32(bl31_params_t *bl2_to_bl31_params)
135 {
136 	int e = 0;
137 #ifdef BL32_BASE
138 	meminfo_t bl32_mem_info;
139 
140 	INFO("BL2: Loading BL3-2\n");
141 	assert(bl2_to_bl31_params != NULL);
142 
143 	/*
144 	 * It is up to the platform to specify where BL3-2 should be loaded if
145 	 * it exists. It could create space in the secure sram or point to a
146 	 * completely different memory.
147 	 */
148 	bl2_plat_get_bl32_meminfo(&bl32_mem_info);
149 	e = load_auth_image(&bl32_mem_info,
150 			    BL32_IMAGE_ID,
151 			    BL32_BASE,
152 			    bl2_to_bl31_params->bl32_image_info,
153 			    bl2_to_bl31_params->bl32_ep_info);
154 
155 	if (e == 0) {
156 		bl2_plat_set_bl32_ep_info(
157 			bl2_to_bl31_params->bl32_image_info,
158 			bl2_to_bl31_params->bl32_ep_info);
159 	}
160 #endif /* BL32_BASE */
161 
162 	return e;
163 }
164 
165 /*******************************************************************************
166  * Load the BL3-3 image.
167  * The bl2_to_bl31_params param will be updated with the relevant BL3-3
168  * information.
169  * Return 0 on success, a negative error code otherwise.
170  ******************************************************************************/
171 static int load_bl33(bl31_params_t *bl2_to_bl31_params)
172 {
173 	meminfo_t bl33_mem_info;
174 	int e;
175 
176 	INFO("BL2: Loading BL3-3\n");
177 	assert(bl2_to_bl31_params != NULL);
178 
179 	bl2_plat_get_bl33_meminfo(&bl33_mem_info);
180 
181 	/* Load the BL3-3 image in non-secure memory provided by the platform */
182 	e = load_auth_image(&bl33_mem_info,
183 			    BL33_IMAGE_ID,
184 			    plat_get_ns_image_entrypoint(),
185 			    bl2_to_bl31_params->bl33_image_info,
186 			    bl2_to_bl31_params->bl33_ep_info);
187 
188 	if (e == 0) {
189 		bl2_plat_set_bl33_ep_info(bl2_to_bl31_params->bl33_image_info,
190 					  bl2_to_bl31_params->bl33_ep_info);
191 	}
192 
193 	return e;
194 }
195 #endif /* EL3_PAYLOAD_BASE */
196 
197 /*******************************************************************************
198  * The only thing to do in BL2 is to load further images and pass control to
199  * BL3-1. The memory occupied by BL2 will be reclaimed by BL3-x stages. BL2 runs
200  * entirely in S-EL1.
201  ******************************************************************************/
202 void bl2_main(void)
203 {
204 	bl31_params_t *bl2_to_bl31_params;
205 	entry_point_info_t *bl31_ep_info;
206 	int e;
207 
208 	NOTICE("BL2: %s\n", version_string);
209 	NOTICE("BL2: %s\n", build_message);
210 
211 	/* Perform remaining generic architectural setup in S-EL1 */
212 	bl2_arch_setup();
213 
214 #if TRUSTED_BOARD_BOOT
215 	/* Initialize authentication module */
216 	auth_mod_init();
217 #endif /* TRUSTED_BOARD_BOOT */
218 
219 	/*
220 	 * Load the subsequent bootloader images
221 	 */
222 	e = load_bl30();
223 	if (e) {
224 		ERROR("Failed to load BL3-0 (%i)\n", e);
225 		plat_error_handler(e);
226 	}
227 
228 	/* Perform platform setup in BL2 after loading BL3-0 */
229 	bl2_platform_setup();
230 
231 	/*
232 	 * Get a pointer to the memory the platform has set aside to pass
233 	 * information to BL3-1.
234 	 */
235 	bl2_to_bl31_params = bl2_plat_get_bl31_params();
236 	bl31_ep_info = bl2_plat_get_bl31_ep_info();
237 
238 #ifdef EL3_PAYLOAD_BASE
239 	/*
240 	 * In the case of an EL3 payload, we don't need to load any further
241 	 * images. Just update the BL31 entrypoint info structure to make BL1
242 	 * jump to the EL3 payload.
243 	 * The pointer to the memory the platform has set aside to pass
244 	 * information to BL3-1 in the normal boot flow is reused here, even
245 	 * though only a fraction of the information contained in the
246 	 * bl31_params_t structure makes sense in the context of EL3 payloads.
247 	 * This will be refined in the future.
248 	 */
249 	VERBOSE("BL2: Populating the entrypoint info for the EL3 payload\n");
250 	bl31_ep_info->pc = EL3_PAYLOAD_BASE;
251 	bl31_ep_info->args.arg0 = (unsigned long) bl2_to_bl31_params;
252 	bl2_plat_set_bl31_ep_info(NULL, bl31_ep_info);
253 #else
254 	e = load_bl31(bl2_to_bl31_params, bl31_ep_info);
255 	if (e) {
256 		ERROR("Failed to load BL3-1 (%i)\n", e);
257 		plat_error_handler(e);
258 	}
259 
260 	e = load_bl32(bl2_to_bl31_params);
261 	if (e) {
262 		if (e == -EAUTH) {
263 			ERROR("Failed to authenticate BL3-2\n");
264 			plat_error_handler(e);
265 		} else {
266 			WARN("Failed to load BL3-2 (%i)\n", e);
267 		}
268 	}
269 
270 	e = load_bl33(bl2_to_bl31_params);
271 	if (e) {
272 		ERROR("Failed to load BL3-3 (%i)\n", e);
273 		plat_error_handler(e);
274 	}
275 #endif /* EL3_PAYLOAD_BASE */
276 
277 	/* Flush the params to be passed to memory */
278 	bl2_plat_flush_bl31_params();
279 
280 	/*
281 	 * Run BL3-1 via an SMC to BL1. Information on how to pass control to
282 	 * the BL3-2 (if present) and BL3-3 software images will be passed to
283 	 * BL3-1 as an argument.
284 	 */
285 	smc(BL1_SMC_RUN_IMAGE, (unsigned long)bl31_ep_info, 0, 0, 0, 0, 0, 0);
286 }
287