xref: /rk3399_ARM-atf/bl2/bl2_main.c (revision 93d81d64d3947aa7712fab602a16b781a12c78bb)
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 <bl_common.h>
35 #include <debug.h>
36 #include <platform.h>
37 #include <platform_def.h>
38 #include <stdio.h>
39 #include "bl2_private.h"
40 
41 /*******************************************************************************
42  * Load the BL3-0 image if there's one.
43  * If a platform does not want to attempt to load BL3-0 image it must leave
44  * BL30_BASE undefined.
45  * Return 0 on success or if there's no BL3-0 image to load, a negative error
46  * code otherwise.
47  ******************************************************************************/
48 static int load_bl30(void)
49 {
50 	int e = 0;
51 #ifdef BL30_BASE
52 	meminfo_t bl30_mem_info;
53 	image_info_t bl30_image_info;
54 
55 	/*
56 	 * It is up to the platform to specify where BL3-0 should be loaded if
57 	 * it exists. It could create space in the secure sram or point to a
58 	 * completely different memory.
59 	 *
60 	 * The entry point information is not relevant in this case as the AP
61 	 * won't execute the BL3-0 image.
62 	 */
63 	bl2_plat_get_bl30_meminfo(&bl30_mem_info);
64 	e = load_image(&bl30_mem_info,
65 		       BL30_IMAGE_NAME,
66 		       BL30_BASE,
67 		       &bl30_image_info,
68 		       NULL);
69 
70 	if (e == 0) {
71 		/* The subsequent handling of BL3-0 is platform specific */
72 		bl2_plat_handle_bl30(&bl30_image_info);
73 	}
74 #endif /* BL30_BASE */
75 
76 	return e;
77 }
78 
79 /*******************************************************************************
80  * Load the BL3-1 image.
81  * The bl2_to_bl31_params and bl31_ep_info params will be updated with the
82  * relevant BL3-1 information.
83  * Return 0 on success, a negative error code otherwise.
84  ******************************************************************************/
85 static int load_bl31(bl31_params_t *bl2_to_bl31_params,
86 		     entry_point_info_t *bl31_ep_info)
87 {
88 	meminfo_t *bl2_tzram_layout;
89 	int e;
90 
91 	assert(bl2_to_bl31_params != NULL);
92 	assert(bl31_ep_info != NULL);
93 
94 	/* Find out how much free trusted ram remains after BL2 load */
95 	bl2_tzram_layout = bl2_plat_sec_mem_layout();
96 
97 	/* Set the X0 parameter to BL3-1 */
98 	bl31_ep_info->args.arg0 = (unsigned long)bl2_to_bl31_params;
99 
100 	/* Load the BL3-1 image */
101 	e = load_image(bl2_tzram_layout,
102 		       BL31_IMAGE_NAME,
103 		       BL31_BASE,
104 		       bl2_to_bl31_params->bl31_image_info,
105 		       bl31_ep_info);
106 
107 	if (e == 0)
108 		bl2_plat_set_bl31_ep_info(bl2_to_bl31_params->bl31_image_info,
109 					  bl31_ep_info);
110 
111 	return e;
112 }
113 
114 /*******************************************************************************
115  * Load the BL3-2 image if there's one.
116  * The bl2_to_bl31_params param will be updated with the relevant BL3-2
117  * information.
118  * If a platform does not want to attempt to load BL3-2 image it must leave
119  * BL32_BASE undefined.
120  * Return 0 on success or if there's no BL3-2 image to load, a negative error
121  * code otherwise.
122  ******************************************************************************/
123 static int load_bl32(bl31_params_t *bl2_to_bl31_params)
124 {
125 	int e = 0;
126 #ifdef BL32_BASE
127 	meminfo_t bl32_mem_info;
128 
129 	assert(bl2_to_bl31_params != NULL);
130 
131 	/*
132 	 * It is up to the platform to specify where BL3-2 should be loaded if
133 	 * it exists. It could create space in the secure sram or point to a
134 	 * completely different memory.
135 	 */
136 	bl2_plat_get_bl32_meminfo(&bl32_mem_info);
137 	e = load_image(&bl32_mem_info,
138 		       BL32_IMAGE_NAME,
139 		       BL32_BASE,
140 		       bl2_to_bl31_params->bl32_image_info,
141 		       bl2_to_bl31_params->bl32_ep_info);
142 
143 	if (e == 0) {
144 		bl2_plat_set_bl32_ep_info(
145 			bl2_to_bl31_params->bl32_image_info,
146 			bl2_to_bl31_params->bl32_ep_info);
147 	}
148 #endif /* BL32_BASE */
149 
150 	return e;
151 }
152 
153 /*******************************************************************************
154  * Load the BL3-3 image.
155  * The bl2_to_bl31_params param will be updated with the relevant BL3-3
156  * information.
157  * Return 0 on success, a negative error code otherwise.
158  ******************************************************************************/
159 static int load_bl33(bl31_params_t *bl2_to_bl31_params)
160 {
161 	meminfo_t bl33_mem_info;
162 	int e;
163 
164 	assert(bl2_to_bl31_params != NULL);
165 
166 	bl2_plat_get_bl33_meminfo(&bl33_mem_info);
167 
168 	/* Load the BL3-3 image in non-secure memory provided by the platform */
169 	e = load_image(&bl33_mem_info,
170 		       BL33_IMAGE_NAME,
171 		       plat_get_ns_image_entrypoint(),
172 		       bl2_to_bl31_params->bl33_image_info,
173 		       bl2_to_bl31_params->bl33_ep_info);
174 
175 	if (e == 0)
176 		bl2_plat_set_bl33_ep_info(bl2_to_bl31_params->bl33_image_info,
177 					  bl2_to_bl31_params->bl33_ep_info);
178 
179 	return e;
180 }
181 
182 /*******************************************************************************
183  * The only thing to do in BL2 is to load further images and pass control to
184  * BL3-1. The memory occupied by BL2 will be reclaimed by BL3-x stages. BL2 runs
185  * entirely in S-EL1.
186  ******************************************************************************/
187 void bl2_main(void)
188 {
189 	bl31_params_t *bl2_to_bl31_params;
190 	entry_point_info_t *bl31_ep_info;
191 	int e;
192 
193 	/* Perform remaining generic architectural setup in S-EL1 */
194 	bl2_arch_setup();
195 
196 	/* Perform platform setup in BL2 */
197 	bl2_platform_setup();
198 
199 	printf("BL2 %s\n\r", build_message);
200 
201 	/*
202 	 * Load the subsequent bootloader images
203 	 */
204 	e = load_bl30();
205 	if (e) {
206 		ERROR("Failed to load BL3-0 (%i)\n", e);
207 		panic();
208 	}
209 
210 	/*
211 	 * Get a pointer to the memory the platform has set aside to pass
212 	 * information to BL3-1.
213 	 */
214 	bl2_to_bl31_params = bl2_plat_get_bl31_params();
215 	bl31_ep_info = bl2_plat_get_bl31_ep_info();
216 
217 	e = load_bl31(bl2_to_bl31_params, bl31_ep_info);
218 	if (e) {
219 		ERROR("Failed to load BL3-1 (%i)\n", e);
220 		panic();
221 	}
222 
223 	e = load_bl32(bl2_to_bl31_params);
224 	if (e)
225 		WARN("Failed to load BL3-2 (%i)\n", e);
226 
227 	e = load_bl33(bl2_to_bl31_params);
228 	if (e) {
229 		ERROR("Failed to load BL3-3 (%i)\n", e);
230 		panic();
231 	}
232 
233 	/* Flush the params to be passed to memory */
234 	bl2_plat_flush_bl31_params();
235 
236 	/*
237 	 * Run BL3-1 via an SMC to BL1. Information on how to pass control to
238 	 * the BL3-2 (if present) and BL3-3 software images will be passed to
239 	 * BL3-1 as an argument.
240 	 */
241 	smc(RUN_IMAGE, (unsigned long)bl31_ep_info, 0, 0, 0, 0, 0, 0);
242 }
243