blob: ff7caf1dddf0b928ea3f94d1b8299267badb080a [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 * This function pointer is used to initialise the BL32 image. It's initialized
42 * by SPD calling bl31_register_bl32_init after setting up all things necessary
43 * for SP execution. In cases where both SPD and SP are absent, or when SPD
44 * finds it impossible to execute SP, this pointer is left as NULL
45 ******************************************************************************/
Vikram Kanigirid8c9d262014-05-16 18:48:12 +010046static int32_t (*bl32_init)(void);
Jeenu Viswambharan7f366602014-02-20 17:11:00 +000047
Achin Gupta7aea9082014-02-01 07:51:28 +000048/*******************************************************************************
Achin Gupta35ca3512014-02-19 17:58:33 +000049 * Variable to indicate whether next image to execute after BL31 is BL33
50 * (non-secure & default) or BL32 (secure).
51 ******************************************************************************/
Dan Handleya4cb68e2014-04-23 13:47:06 +010052static uint32_t next_image_type;
Achin Gupta35ca3512014-02-19 17:58:33 +000053
54/*******************************************************************************
Achin Gupta7aea9082014-02-01 07:51:28 +000055 * Simple function to initialise all BL31 helper libraries.
56 ******************************************************************************/
57void bl31_lib_init()
58{
59 cm_init();
60}
Achin Gupta4f6ad662013-10-25 09:08:21 +010061
Achin Gupta4f6ad662013-10-25 09:08:21 +010062/*******************************************************************************
63 * BL31 is responsible for setting up the runtime services for the primary cpu
Achin Gupta35ca3512014-02-19 17:58:33 +000064 * before passing control to the bootloader or an Operating System. This
65 * function calls runtime_svc_init() which initializes all registered runtime
66 * services. The run time services would setup enough context for the core to
67 * swtich to the next exception level. When this function returns, the core will
68 * switch to the programmed exception level via. an ERET.
Achin Gupta4f6ad662013-10-25 09:08:21 +010069 ******************************************************************************/
70void bl31_main(void)
71{
Achin Gupta35ca3512014-02-19 17:58:33 +000072#if DEBUG
73 unsigned long mpidr = read_mpidr();
74#endif
Achin Gupta4f6ad662013-10-25 09:08:21 +010075
76 /* Perform remaining generic architectural setup from EL3 */
77 bl31_arch_setup();
78
79 /* Perform platform setup in BL1 */
80 bl31_platform_setup();
81
Jon Medhurstecf0a712014-02-17 12:18:24 +000082 printf("BL31 %s\n\r", build_message);
83
Achin Gupta7aea9082014-02-01 07:51:28 +000084 /* Initialise helper libraries */
85 bl31_lib_init();
Achin Gupta4f6ad662013-10-25 09:08:21 +010086
87 /* Initialize the runtime services e.g. psci */
Achin Gupta7421b462014-02-01 18:53:26 +000088 runtime_svc_init();
Achin Gupta4f6ad662013-10-25 09:08:21 +010089
90 /* Clean caches before re-entering normal world */
91 dcsw_op_all(DCCSW);
92
Jeenu Viswambharancaa84932014-02-06 10:36:15 +000093 /*
Achin Gupta35ca3512014-02-19 17:58:33 +000094 * Use the more complex exception vectors now that context
95 * management is setup. SP_EL3 should point to a 'cpu_context'
96 * structure which has an exception stack allocated. The PSCI
97 * service should have set the context.
98 */
99 assert(cm_get_context(mpidr, NON_SECURE));
100 cm_set_next_eret_context(NON_SECURE);
Soby Mathew5e5c2072014-04-07 15:28:55 +0100101 cm_init_pcpu_ptr_cache();
Achin Gupta35ca3512014-02-19 17:58:33 +0000102 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 /*
Vikram Kanigirid8c9d262014-05-16 18:48:12 +0100117 * If SPD had registerd an init hook, invoke it.
Jeenu Viswambharan7f366602014-02-20 17:11:00 +0000118 */
Achin Gupta35ca3512014-02-19 17:58:33 +0000119 if (bl32_init)
Vikram Kanigirid8c9d262014-05-16 18:48:12 +0100120 (*bl32_init)();
Achin Gupta35ca3512014-02-19 17:58:33 +0000121
122 /*
123 * We are ready to enter the next EL. Prepare entry into the image
124 * corresponding to the desired security state after the next ERET.
125 */
126 bl31_prepare_next_image_entry();
127}
128
129/*******************************************************************************
130 * Accessor functions to help runtime services decide which image should be
131 * executed after BL31. This is BL33 or the non-secure bootloader image by
132 * default but the Secure payload dispatcher could override this by requesting
133 * an entry into BL32 (Secure payload) first. If it does so then it should use
134 * the same API to program an entry into BL33 once BL32 initialisation is
135 * complete.
136 ******************************************************************************/
137void bl31_set_next_image_type(uint32_t security_state)
138{
139 assert(security_state == NON_SECURE || security_state == SECURE);
140 next_image_type = security_state;
141}
142
143uint32_t bl31_get_next_image_type(void)
144{
145 return next_image_type;
146}
147
148/*******************************************************************************
149 * This function programs EL3 registers and performs other setup to enable entry
150 * into the next image after BL31 at the next ERET.
151 ******************************************************************************/
152void bl31_prepare_next_image_entry()
153{
Vikram Kanigirida567432014-04-15 18:08:08 +0100154 entry_point_info_t *next_image_info;
Achin Gupta35ca3512014-02-19 17:58:33 +0000155 uint32_t scr, image_type;
156
157 /* Determine which image to execute next */
158 image_type = bl31_get_next_image_type();
159
160 /*
Jeenu Viswambharancaa84932014-02-06 10:36:15 +0000161 * Setup minimal architectural state of the next highest EL to
162 * allow execution in it immediately upon entering it.
163 */
Achin Gupta35ca3512014-02-19 17:58:33 +0000164 bl31_next_el_arch_setup(image_type);
Jeenu Viswambharancaa84932014-02-06 10:36:15 +0000165
166 /* Program EL3 registers to enable entry into the next EL */
Achin Gupta35ca3512014-02-19 17:58:33 +0000167 next_image_info = bl31_get_next_image_info(image_type);
168 assert(next_image_info);
169
Jeenu Viswambharancaa84932014-02-06 10:36:15 +0000170 scr = read_scr();
Andrew Thoelke2ecdd8f2014-05-16 15:38:04 +0100171 scr &= ~SCR_NS_BIT;
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
Andrew Thoelke2ecdd8f2014-05-16 15:38:04 +0100175 scr &= ~SCR_RW_BIT;
176 if ((next_image_info->spsr & (1 << MODE_RW_SHIFT)) ==
177 (MODE_RW_64 << MODE_RW_SHIFT))
178 scr |= SCR_RW_BIT;
179
Jeenu Viswambharancaa84932014-02-06 10:36:15 +0000180 /*
181 * Tell the context mgmt. library to ensure that SP_EL3 points to
182 * the right context to exit from EL3 correctly.
183 */
Vikram Kanigirida567432014-04-15 18:08:08 +0100184 cm_set_el3_eret_context(GET_SECURITY_STATE(next_image_info->h.attr),
185 next_image_info->pc,
Jeenu Viswambharancaa84932014-02-06 10:36:15 +0000186 next_image_info->spsr,
187 scr);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100188
Jeenu Viswambharancaa84932014-02-06 10:36:15 +0000189 /* Finally set the next context */
Vikram Kanigirida567432014-04-15 18:08:08 +0100190 cm_set_next_eret_context(GET_SECURITY_STATE(next_image_info->h.attr));
Achin Gupta4f6ad662013-10-25 09:08:21 +0100191}
Jeenu Viswambharan7f366602014-02-20 17:11:00 +0000192
193/*******************************************************************************
194 * This function initializes the pointer to BL32 init function. This is expected
195 * to be called by the SPD after it finishes all its initialization
196 ******************************************************************************/
Vikram Kanigirid8c9d262014-05-16 18:48:12 +0100197void bl31_register_bl32_init(int32_t (*func)(void))
Jeenu Viswambharan7f366602014-02-20 17:11:00 +0000198{
199 bl32_init = func;
200}