xref: /rk3399_ARM-atf/bl1/bl1_main.c (revision 5698c5b3db083b70645ebd288a6957fe590a1d53)
1 /*
2  * Copyright (c) 2013-2015, 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 <platform.h>
38 #include <platform_def.h>
39 #include "bl1_private.h"
40 
41 /*******************************************************************************
42  * Runs BL2 from the given entry point. It results in dropping the
43  * exception level
44  ******************************************************************************/
45 static void __dead2 bl1_run_bl2(entry_point_info_t *bl2_ep)
46 {
47 	/* Check bl2 security state is expected as secure */
48 	assert(GET_SECURITY_STATE(bl2_ep->h.attr) == SECURE);
49 	/* Check NS Bit is also set as secure */
50 	assert(!(read_scr_el3() & SCR_NS_BIT));
51 
52 	bl1_arch_next_el_setup();
53 
54 	write_spsr_el3(bl2_ep->spsr);
55 	write_elr_el3(bl2_ep->pc);
56 
57 	NOTICE("BL1: Booting BL2\n");
58 	print_entry_point_info(bl2_ep);
59 
60 	eret(bl2_ep->args.arg0,
61 		bl2_ep->args.arg1,
62 		bl2_ep->args.arg2,
63 		bl2_ep->args.arg3,
64 		bl2_ep->args.arg4,
65 		bl2_ep->args.arg5,
66 		bl2_ep->args.arg6,
67 		bl2_ep->args.arg7);
68 }
69 
70 /*******************************************************************************
71  * The next function has a weak definition. Platform specific code can override
72  * it if it wishes to.
73  ******************************************************************************/
74 #pragma weak bl1_init_bl2_mem_layout
75 
76 /*******************************************************************************
77  * Function that takes a memory layout into which BL2 has been loaded and
78  * populates a new memory layout for BL2 that ensures that BL1's data sections
79  * resident in secure RAM are not visible to BL2.
80  ******************************************************************************/
81 void bl1_init_bl2_mem_layout(const meminfo_t *bl1_mem_layout,
82 			     meminfo_t *bl2_mem_layout)
83 {
84 	const size_t bl1_size = BL1_RAM_LIMIT - BL1_RAM_BASE;
85 
86 	assert(bl1_mem_layout != NULL);
87 	assert(bl2_mem_layout != NULL);
88 
89 	/* Check that BL1's memory is lying outside of the free memory */
90 	assert((BL1_RAM_LIMIT <= bl1_mem_layout->free_base) ||
91 	       (BL1_RAM_BASE >= bl1_mem_layout->free_base + bl1_mem_layout->free_size));
92 
93 	/* Remove BL1 RW data from the scope of memory visible to BL2 */
94 	*bl2_mem_layout = *bl1_mem_layout;
95 	reserve_mem(&bl2_mem_layout->total_base,
96 		    &bl2_mem_layout->total_size,
97 		    BL1_RAM_BASE,
98 		    bl1_size);
99 
100 	flush_dcache_range((unsigned long)bl2_mem_layout, sizeof(meminfo_t));
101 }
102 
103 /*******************************************************************************
104  * Function to perform late architectural and platform specific initialization.
105  * It also locates and loads the BL2 raw binary image in the trusted DRAM. Only
106  * called by the primary cpu after a cold boot.
107  * TODO: Add support for alternative image load mechanism e.g using virtio/elf
108  * loader etc.
109   ******************************************************************************/
110 void bl1_main(void)
111 {
112 	/* Announce our arrival */
113 	NOTICE(FIRMWARE_WELCOME_STR);
114 	NOTICE("BL1: %s\n", version_string);
115 	NOTICE("BL1: %s\n", build_message);
116 
117 	INFO("BL1: RAM 0x%lx - 0x%lx\n", BL1_RAM_BASE, BL1_RAM_LIMIT);
118 
119 	image_info_t bl2_image_info = { {0} };
120 	entry_point_info_t bl2_ep = { {0} };
121 	meminfo_t *bl1_tzram_layout;
122 	meminfo_t *bl2_tzram_layout = 0x0;
123 	int err;
124 
125 #if DEBUG
126 	unsigned long val;
127 	/*
128 	 * Ensure that MMU/Caches and coherency are turned on
129 	 */
130 	val = read_sctlr_el3();
131 	assert(val & SCTLR_M_BIT);
132 	assert(val & SCTLR_C_BIT);
133 	assert(val & SCTLR_I_BIT);
134 	/*
135 	 * Check that Cache Writeback Granule (CWG) in CTR_EL0 matches the
136 	 * provided platform value
137 	 */
138 	val = (read_ctr_el0() >> CTR_CWG_SHIFT) & CTR_CWG_MASK;
139 	/*
140 	 * If CWG is zero, then no CWG information is available but we can
141 	 * at least check the platform value is less than the architectural
142 	 * maximum.
143 	 */
144 	if (val != 0)
145 		assert(CACHE_WRITEBACK_GRANULE == SIZE_FROM_LOG2_WORDS(val));
146 	else
147 		assert(CACHE_WRITEBACK_GRANULE <= MAX_CACHE_LINE_SIZE);
148 #endif
149 
150 	/* Perform remaining generic architectural setup from EL3 */
151 	bl1_arch_setup();
152 
153 	/* Perform platform setup in BL1. */
154 	bl1_platform_setup();
155 
156 	SET_PARAM_HEAD(&bl2_image_info, PARAM_IMAGE_BINARY, VERSION_1, 0);
157 	SET_PARAM_HEAD(&bl2_ep, PARAM_EP, VERSION_1, 0);
158 
159 	/* Find out how much free trusted ram remains after BL1 load */
160 	bl1_tzram_layout = bl1_plat_sec_mem_layout();
161 
162 	INFO("BL1: Loading BL2\n");
163 
164 #if TRUSTED_BOARD_BOOT
165 	/* Initialize authentication module */
166 	auth_mod_init();
167 #endif /* TRUSTED_BOARD_BOOT */
168 
169 	/* Load the BL2 image */
170 	err = load_auth_image(bl1_tzram_layout,
171 			 BL2_IMAGE_ID,
172 			 BL2_BASE,
173 			 &bl2_image_info,
174 			 &bl2_ep);
175 
176 	if (err) {
177 		ERROR("Failed to load BL2 firmware.\n");
178 		plat_error_handler(err);
179 	}
180 
181 	/*
182 	 * Create a new layout of memory for BL2 as seen by BL1 i.e.
183 	 * tell it the amount of total and free memory available.
184 	 * This layout is created at the first free address visible
185 	 * to BL2. BL2 will read the memory layout before using its
186 	 * memory for other purposes.
187 	 */
188 	bl2_tzram_layout = (meminfo_t *) bl1_tzram_layout->free_base;
189 	bl1_init_bl2_mem_layout(bl1_tzram_layout, bl2_tzram_layout);
190 
191 	bl1_plat_set_bl2_ep_info(&bl2_image_info, &bl2_ep);
192 	bl2_ep.args.arg1 = (unsigned long)bl2_tzram_layout;
193 	bl1_run_bl2(&bl2_ep);
194 
195 	return;
196 }
197 
198 /*******************************************************************************
199  * Function called just before handing over to BL31 to inform the user about
200  * the boot progress. In debug mode, also print details about the BL31 image's
201  * execution context.
202  ******************************************************************************/
203 void bl1_print_bl31_ep_info(const entry_point_info_t *bl31_ep_info)
204 {
205 	NOTICE("BL1: Booting BL3-1\n");
206 	print_entry_point_info(bl31_ep_info);
207 }
208 
209 #if SPIN_ON_BL1_EXIT
210 void print_debug_loop_message(void)
211 {
212 	NOTICE("BL1: Debug loop, spinning forever\n");
213 	NOTICE("BL1: Please connect the debugger to continue\n");
214 }
215 #endif
216