blob: 835d41e87bbdc10818fafddf759a9a917916369f [file] [log] [blame]
Achin Gupta4f6ad662013-10-25 09:08:21 +01001/*
Soby Mathew3700a922015-07-13 11:21:11 +01002 * Copyright (c) 2013-2015, 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>
Soby Mathewafe7e2f2014-06-12 17:23:58 +010037#include <debug.h>
Dan Handley7ce42df2014-05-15 14:11:36 +010038#include <platform.h>
Dan Handley2bd4ef22014-04-09 13:14:54 +010039#include <runtime_svc.h>
Vikram Kanigiri614f3952014-05-28 13:41:51 +010040#include <string.h>
Achin Gupta7aea9082014-02-01 07:51:28 +000041
Jeenu Viswambharan7f366602014-02-20 17:11:00 +000042/*******************************************************************************
43 * This function pointer is used to initialise the BL32 image. It's initialized
44 * by SPD calling bl31_register_bl32_init after setting up all things necessary
45 * for SP execution. In cases where both SPD and SP are absent, or when SPD
46 * finds it impossible to execute SP, this pointer is left as NULL
47 ******************************************************************************/
Vikram Kanigirid8c9d262014-05-16 18:48:12 +010048static int32_t (*bl32_init)(void);
Jeenu Viswambharan7f366602014-02-20 17:11:00 +000049
Achin Gupta7aea9082014-02-01 07:51:28 +000050/*******************************************************************************
Achin Gupta35ca3512014-02-19 17:58:33 +000051 * Variable to indicate whether next image to execute after BL31 is BL33
52 * (non-secure & default) or BL32 (secure).
53 ******************************************************************************/
Vikram Kanigiri4e813412014-07-15 16:49:22 +010054static uint32_t next_image_type = NON_SECURE;
Achin Gupta35ca3512014-02-19 17:58:33 +000055
56/*******************************************************************************
Achin Gupta7aea9082014-02-01 07:51:28 +000057 * Simple function to initialise all BL31 helper libraries.
58 ******************************************************************************/
Juan Castillo2d552402014-06-13 17:05:10 +010059void bl31_lib_init(void)
Achin Gupta7aea9082014-02-01 07:51:28 +000060{
61 cm_init();
62}
Achin Gupta4f6ad662013-10-25 09:08:21 +010063
Achin Gupta4f6ad662013-10-25 09:08:21 +010064/*******************************************************************************
65 * BL31 is responsible for setting up the runtime services for the primary cpu
Achin Gupta35ca3512014-02-19 17:58:33 +000066 * before passing control to the bootloader or an Operating System. This
67 * function calls runtime_svc_init() which initializes all registered runtime
68 * services. The run time services would setup enough context for the core to
69 * swtich to the next exception level. When this function returns, the core will
70 * switch to the programmed exception level via. an ERET.
Achin Gupta4f6ad662013-10-25 09:08:21 +010071 ******************************************************************************/
72void bl31_main(void)
73{
Juan Castillo7d199412015-12-14 09:35:25 +000074 NOTICE("BL31: %s\n", version_string);
75 NOTICE("BL31: %s\n", build_message);
Dan Handley91b624e2014-07-29 17:14:00 +010076
Achin Gupta4f6ad662013-10-25 09:08:21 +010077 /* Perform remaining generic architectural setup from EL3 */
78 bl31_arch_setup();
79
Soby Mathew1ff495b2015-12-09 11:28:43 +000080 /* Perform platform setup in BL31 */
Achin Gupta4f6ad662013-10-25 09:08:21 +010081 bl31_platform_setup();
82
Achin Gupta7aea9082014-02-01 07:51:28 +000083 /* Initialise helper libraries */
84 bl31_lib_init();
Achin Gupta4f6ad662013-10-25 09:08:21 +010085
86 /* Initialize the runtime services e.g. psci */
Juan Castillo7d199412015-12-14 09:35:25 +000087 INFO("BL31: Initializing runtime services\n");
Achin Gupta7421b462014-02-01 18:53:26 +000088 runtime_svc_init();
Achin Gupta4f6ad662013-10-25 09:08:21 +010089
Achin Gupta35ca3512014-02-19 17:58:33 +000090 /*
Jeenu Viswambharan7f366602014-02-20 17:11:00 +000091 * All the cold boot actions on the primary cpu are done. We now need to
92 * decide which is the next image (BL32 or BL33) and how to execute it.
93 * If the SPD runtime service is present, it would want to pass control
94 * to BL32 first in S-EL1. In that case, SPD would have registered a
95 * function to intialize bl32 where it takes responsibility of entering
96 * S-EL1 and returning control back to bl31_main. Once this is done we
97 * can prepare entry into BL33 as normal.
Achin Gupta35ca3512014-02-19 17:58:33 +000098 */
99
Jeenu Viswambharan7f366602014-02-20 17:11:00 +0000100 /*
Vikram Kanigirid8c9d262014-05-16 18:48:12 +0100101 * If SPD had registerd an init hook, invoke it.
Jeenu Viswambharan7f366602014-02-20 17:11:00 +0000102 */
Dan Handley91b624e2014-07-29 17:14:00 +0100103 if (bl32_init) {
Juan Castillo7d199412015-12-14 09:35:25 +0000104 INFO("BL31: Initializing BL32\n");
Vikram Kanigirid8c9d262014-05-16 18:48:12 +0100105 (*bl32_init)();
Dan Handley91b624e2014-07-29 17:14:00 +0100106 }
Achin Gupta35ca3512014-02-19 17:58:33 +0000107 /*
108 * We are ready to enter the next EL. Prepare entry into the image
109 * corresponding to the desired security state after the next ERET.
110 */
111 bl31_prepare_next_image_entry();
Soby Mathew1ff495b2015-12-09 11:28:43 +0000112
113 /*
114 * Perform any platform specific runtime setup prior to cold boot exit
115 * from BL31
116 */
117 bl31_plat_runtime_setup();
Achin Gupta35ca3512014-02-19 17:58:33 +0000118}
119
120/*******************************************************************************
121 * Accessor functions to help runtime services decide which image should be
122 * executed after BL31. This is BL33 or the non-secure bootloader image by
123 * default but the Secure payload dispatcher could override this by requesting
124 * an entry into BL32 (Secure payload) first. If it does so then it should use
125 * the same API to program an entry into BL33 once BL32 initialisation is
126 * complete.
127 ******************************************************************************/
128void bl31_set_next_image_type(uint32_t security_state)
129{
Juan Castillof558cac2014-06-05 09:45:36 +0100130 assert(sec_state_is_valid(security_state));
Achin Gupta35ca3512014-02-19 17:58:33 +0000131 next_image_type = security_state;
132}
133
134uint32_t bl31_get_next_image_type(void)
135{
136 return next_image_type;
137}
138
139/*******************************************************************************
140 * This function programs EL3 registers and performs other setup to enable entry
141 * into the next image after BL31 at the next ERET.
142 ******************************************************************************/
Juan Castillo2d552402014-06-13 17:05:10 +0100143void bl31_prepare_next_image_entry(void)
Achin Gupta35ca3512014-02-19 17:58:33 +0000144{
Vikram Kanigirida567432014-04-15 18:08:08 +0100145 entry_point_info_t *next_image_info;
Andrew Thoelke4e126072014-06-04 21:10:52 +0100146 uint32_t image_type;
Achin Gupta35ca3512014-02-19 17:58:33 +0000147
148 /* Determine which image to execute next */
149 image_type = bl31_get_next_image_type();
150
Jeenu Viswambharancaa84932014-02-06 10:36:15 +0000151 /* Program EL3 registers to enable entry into the next EL */
Dan Handley701fea72014-05-27 16:17:21 +0100152 next_image_info = bl31_plat_get_next_image_ep_info(image_type);
Achin Gupta35ca3512014-02-19 17:58:33 +0000153 assert(next_image_info);
Vikram Kanigiri614f3952014-05-28 13:41:51 +0100154 assert(image_type == GET_SECURITY_STATE(next_image_info->h.attr));
Achin Gupta35ca3512014-02-19 17:58:33 +0000155
Juan Castillo7d199412015-12-14 09:35:25 +0000156 INFO("BL31: Preparing for EL3 exit to %s world\n",
Dan Handley91b624e2014-07-29 17:14:00 +0100157 (image_type == SECURE) ? "secure" : "normal");
Sandrine Bailleuxb2e224c2015-09-28 17:03:06 +0100158 print_entry_point_info(next_image_info);
Soby Mathew3700a922015-07-13 11:21:11 +0100159 cm_init_my_context(next_image_info);
Andrew Thoelke4e126072014-06-04 21:10:52 +0100160 cm_prepare_el3_exit(image_type);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100161}
Jeenu Viswambharan7f366602014-02-20 17:11:00 +0000162
163/*******************************************************************************
164 * This function initializes the pointer to BL32 init function. This is expected
165 * to be called by the SPD after it finishes all its initialization
166 ******************************************************************************/
Vikram Kanigirid8c9d262014-05-16 18:48:12 +0100167void bl31_register_bl32_init(int32_t (*func)(void))
Jeenu Viswambharan7f366602014-02-20 17:11:00 +0000168{
169 bl32_init = func;
170}