blob: 755320d38637c7d328a6e34996b31f0a6bc873d5 [file] [log] [blame]
Achin Gupta4f6ad662013-10-25 09:08:21 +01001/*
Dan Handleye83b0ca2014-01-14 18:17:09 +00002 * Copyright (c) 2013-2014, ARM Limited and Contributors. All rights reserved.
Achin Gupta4f6ad662013-10-25 09:08:21 +01003 *
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
Dan Handley2bd4ef22014-04-09 13:14:54 +010031#include <arch.h>
Achin Gupta4f6ad662013-10-25 09:08:21 +010032#include <arch_helpers.h>
Dan Handley2bd4ef22014-04-09 13:14:54 +010033#include <assert.h>
Achin Gupta4f6ad662013-10-25 09:08:21 +010034#include <bl_common.h>
35#include <bl31.h>
Achin Gupta7aea9082014-02-01 07:51:28 +000036#include <context_mgmt.h>
Dan Handley2bd4ef22014-04-09 13:14:54 +010037#include <runtime_svc.h>
38#include <stdio.h>
Achin Gupta7aea9082014-02-01 07:51:28 +000039
Jeenu Viswambharan7f366602014-02-20 17:11:00 +000040
41/*******************************************************************************
42 * This function pointer is used to initialise the BL32 image. It's initialized
43 * by SPD calling bl31_register_bl32_init after setting up all things necessary
44 * for SP execution. In cases where both SPD and SP are absent, or when SPD
45 * finds it impossible to execute SP, this pointer is left as NULL
46 ******************************************************************************/
Dan Handleye2712bc2014-04-10 15:37:22 +010047static int32_t (*bl32_init)(meminfo_t *);
Jeenu Viswambharan7f366602014-02-20 17:11:00 +000048
Achin Gupta7aea9082014-02-01 07:51:28 +000049/*******************************************************************************
Achin Gupta35ca3512014-02-19 17:58:33 +000050 * Variable to indicate whether next image to execute after BL31 is BL33
51 * (non-secure & default) or BL32 (secure).
52 ******************************************************************************/
Dan Handleya4cb68e2014-04-23 13:47:06 +010053static uint32_t next_image_type;
Achin Gupta35ca3512014-02-19 17:58:33 +000054
55/*******************************************************************************
Achin Gupta7aea9082014-02-01 07:51:28 +000056 * Simple function to initialise all BL31 helper libraries.
57 ******************************************************************************/
58void bl31_lib_init()
59{
60 cm_init();
61}
Achin Gupta4f6ad662013-10-25 09:08:21 +010062
Achin Gupta4f6ad662013-10-25 09:08:21 +010063/*******************************************************************************
64 * BL31 is responsible for setting up the runtime services for the primary cpu
Achin Gupta35ca3512014-02-19 17:58:33 +000065 * before passing control to the bootloader or an Operating System. This
66 * function calls runtime_svc_init() which initializes all registered runtime
67 * services. The run time services would setup enough context for the core to
68 * swtich to the next exception level. When this function returns, the core will
69 * switch to the programmed exception level via. an ERET.
Achin Gupta4f6ad662013-10-25 09:08:21 +010070 ******************************************************************************/
71void bl31_main(void)
72{
Achin Gupta35ca3512014-02-19 17:58:33 +000073#if DEBUG
74 unsigned long mpidr = read_mpidr();
75#endif
Achin Gupta4f6ad662013-10-25 09:08:21 +010076
77 /* Perform remaining generic architectural setup from EL3 */
78 bl31_arch_setup();
79
80 /* Perform platform setup in BL1 */
81 bl31_platform_setup();
82
Jon Medhurstecf0a712014-02-17 12:18:24 +000083 printf("BL31 %s\n\r", build_message);
84
Achin Gupta7aea9082014-02-01 07:51:28 +000085 /* Initialise helper libraries */
86 bl31_lib_init();
Achin Gupta4f6ad662013-10-25 09:08:21 +010087
88 /* Initialize the runtime services e.g. psci */
Achin Gupta7421b462014-02-01 18:53:26 +000089 runtime_svc_init();
Achin Gupta4f6ad662013-10-25 09:08:21 +010090
91 /* Clean caches before re-entering normal world */
92 dcsw_op_all(DCCSW);
93
Jeenu Viswambharancaa84932014-02-06 10:36:15 +000094 /*
Achin Gupta35ca3512014-02-19 17:58:33 +000095 * Use the more complex exception vectors now that context
96 * management is setup. SP_EL3 should point to a 'cpu_context'
97 * structure which has an exception stack allocated. The PSCI
98 * service should have set the context.
99 */
100 assert(cm_get_context(mpidr, NON_SECURE));
101 cm_set_next_eret_context(NON_SECURE);
102 write_vbar_el3((uint64_t) runtime_exceptions);
Andrew Thoelke42e75a72014-04-28 12:28:39 +0100103 isb();
Dan Handleya4cb68e2014-04-23 13:47:06 +0100104 next_image_type = NON_SECURE;
Achin Gupta35ca3512014-02-19 17:58:33 +0000105
106 /*
Jeenu Viswambharan7f366602014-02-20 17:11:00 +0000107 * All the cold boot actions on the primary cpu are done. We now need to
108 * decide which is the next image (BL32 or BL33) and how to execute it.
109 * If the SPD runtime service is present, it would want to pass control
110 * to BL32 first in S-EL1. In that case, SPD would have registered a
111 * function to intialize bl32 where it takes responsibility of entering
112 * S-EL1 and returning control back to bl31_main. Once this is done we
113 * can prepare entry into BL33 as normal.
Achin Gupta35ca3512014-02-19 17:58:33 +0000114 */
115
Jeenu Viswambharan7f366602014-02-20 17:11:00 +0000116 /*
117 * If SPD had registerd an init hook, invoke it. Pass it the information
118 * about memory extents
119 */
Achin Gupta35ca3512014-02-19 17:58:33 +0000120 if (bl32_init)
Jeenu Viswambharan7f366602014-02-20 17:11:00 +0000121 (*bl32_init)(bl31_plat_get_bl32_mem_layout());
Achin Gupta35ca3512014-02-19 17:58:33 +0000122
123 /*
124 * We are ready to enter the next EL. Prepare entry into the image
125 * corresponding to the desired security state after the next ERET.
126 */
127 bl31_prepare_next_image_entry();
128}
129
130/*******************************************************************************
131 * Accessor functions to help runtime services decide which image should be
132 * executed after BL31. This is BL33 or the non-secure bootloader image by
133 * default but the Secure payload dispatcher could override this by requesting
134 * an entry into BL32 (Secure payload) first. If it does so then it should use
135 * the same API to program an entry into BL33 once BL32 initialisation is
136 * complete.
137 ******************************************************************************/
138void bl31_set_next_image_type(uint32_t security_state)
139{
140 assert(security_state == NON_SECURE || security_state == SECURE);
141 next_image_type = security_state;
142}
143
144uint32_t bl31_get_next_image_type(void)
145{
146 return next_image_type;
147}
148
149/*******************************************************************************
150 * This function programs EL3 registers and performs other setup to enable entry
151 * into the next image after BL31 at the next ERET.
152 ******************************************************************************/
153void bl31_prepare_next_image_entry()
154{
Dan Handleye2712bc2014-04-10 15:37:22 +0100155 el_change_info_t *next_image_info;
Achin Gupta35ca3512014-02-19 17:58:33 +0000156 uint32_t scr, image_type;
157
158 /* Determine which image to execute next */
159 image_type = bl31_get_next_image_type();
160
161 /*
Jeenu Viswambharancaa84932014-02-06 10:36:15 +0000162 * Setup minimal architectural state of the next highest EL to
163 * allow execution in it immediately upon entering it.
164 */
Achin Gupta35ca3512014-02-19 17:58:33 +0000165 bl31_next_el_arch_setup(image_type);
Jeenu Viswambharancaa84932014-02-06 10:36:15 +0000166
167 /* Program EL3 registers to enable entry into the next EL */
Achin Gupta35ca3512014-02-19 17:58:33 +0000168 next_image_info = bl31_get_next_image_info(image_type);
169 assert(next_image_info);
170
Jeenu Viswambharancaa84932014-02-06 10:36:15 +0000171 scr = read_scr();
Achin Gupta35ca3512014-02-19 17:58:33 +0000172 if (image_type == NON_SECURE)
Jeenu Viswambharancaa84932014-02-06 10:36:15 +0000173 scr |= SCR_NS_BIT;
174
175 /*
176 * Tell the context mgmt. library to ensure that SP_EL3 points to
177 * the right context to exit from EL3 correctly.
178 */
179 cm_set_el3_eret_context(next_image_info->security_state,
180 next_image_info->entrypoint,
181 next_image_info->spsr,
182 scr);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100183
Jeenu Viswambharancaa84932014-02-06 10:36:15 +0000184 /* Finally set the next context */
185 cm_set_next_eret_context(next_image_info->security_state);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100186}
Jeenu Viswambharan7f366602014-02-20 17:11:00 +0000187
188/*******************************************************************************
189 * This function initializes the pointer to BL32 init function. This is expected
190 * to be called by the SPD after it finishes all its initialization
191 ******************************************************************************/
Dan Handleye2712bc2014-04-10 15:37:22 +0100192void bl31_register_bl32_init(int32_t (*func)(meminfo_t *))
Jeenu Viswambharan7f366602014-02-20 17:11:00 +0000193{
194 bl32_init = func;
195}