blob: 12d5036c8b1cf7ec068ffc366af51a8a215dce29 [file] [log] [blame]
Achin Gupta4f6ad662013-10-25 09:08:21 +01001/*
Yatharth Kocharf11b29a2016-02-01 11:04:46 +00002 * Copyright (c) 2013-2016, 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
31#ifndef __BL_COMMON_H__
32#define __BL_COMMON_H__
33
Vikram Kanigirida567432014-04-15 18:08:08 +010034#define SECURE 0x0
35#define NON_SECURE 0x1
Juan Castillof558cac2014-06-05 09:45:36 +010036#define sec_state_is_valid(s) (((s) == SECURE) || ((s) == NON_SECURE))
Achin Gupta4f6ad662013-10-25 09:08:21 +010037
38#define UP 1
39#define DOWN 0
40
41/*******************************************************************************
Sandrine Bailleux467d0572014-06-24 14:02:34 +010042 * Constants to identify the location of a memory region in a given memory
43 * layout.
44******************************************************************************/
45#define TOP 0x1
46#define BOTTOM !TOP
Achin Gupta4f6ad662013-10-25 09:08:21 +010047
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +010048/*******************************************************************************
49 * Constants that allow assembler code to access members of and the
Vikram Kanigirida567432014-04-15 18:08:08 +010050 * 'entry_point_info' structure at their correct offsets.
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +010051 ******************************************************************************/
Vikram Kanigirida567432014-04-15 18:08:08 +010052#define ENTRY_POINT_INFO_PC_OFFSET 0x08
Soby Mathew748be1d2016-05-05 14:10:46 +010053#ifdef AARCH32
54#define ENTRY_POINT_INFO_ARGS_OFFSET 0x10
55#else
Vikram Kanigirida567432014-04-15 18:08:08 +010056#define ENTRY_POINT_INFO_ARGS_OFFSET 0x18
Soby Mathew748be1d2016-05-05 14:10:46 +010057#endif
Sandrine Bailleuxba6980a2013-12-02 15:41:25 +000058
Yatharth Kochara65be2f2015-10-09 18:06:13 +010059/* The following are used to set/get image attributes. */
Yatharth Kochara65be2f2015-10-09 18:06:13 +010060#define PARAM_EP_SECURITY_MASK (0x1)
Yatharth Kochara65be2f2015-10-09 18:06:13 +010061
Vikram Kanigirida567432014-04-15 18:08:08 +010062#define GET_SECURITY_STATE(x) (x & PARAM_EP_SECURITY_MASK)
63#define SET_SECURITY_STATE(x, security) \
64 ((x) = ((x) & ~PARAM_EP_SECURITY_MASK) | (security))
65
Yatharth Kochara65be2f2015-10-09 18:06:13 +010066
67/*
68 * The following are used for image state attributes.
69 * Image can only be in one of the following state.
70 */
71#define IMAGE_STATE_RESET 0
72#define IMAGE_STATE_COPIED 1
73#define IMAGE_STATE_COPYING 2
74#define IMAGE_STATE_AUTHENTICATED 3
75#define IMAGE_STATE_EXECUTED 4
76#define IMAGE_STATE_INTERRUPTED 5
77
Andrew Thoelke4e126072014-06-04 21:10:52 +010078#define EP_EE_MASK 0x2
79#define EP_EE_LITTLE 0x0
80#define EP_EE_BIG 0x2
81#define EP_GET_EE(x) (x & EP_EE_MASK)
82#define EP_SET_EE(x, ee) ((x) = ((x) & ~EP_EE_MASK) | (ee))
83
84#define EP_ST_MASK 0x4
85#define EP_ST_DISABLE 0x0
86#define EP_ST_ENABLE 0x4
87#define EP_GET_ST(x) (x & EP_ST_MASK)
88#define EP_SET_ST(x, ee) ((x) = ((x) & ~EP_ST_MASK) | (ee))
89
Yatharth Kocharf11b29a2016-02-01 11:04:46 +000090#define EP_EXE_MASK 0x8
91#define NON_EXECUTABLE 0x0
92#define EXECUTABLE 0x8
93#define EP_GET_EXE(x) (x & EP_EXE_MASK)
94#define EP_SET_EXE(x, ee) ((x) = ((x) & ~EP_EXE_MASK) | (ee))
95
Yatharth Kochar3345a8d2016-09-12 16:08:41 +010096#define EP_FIRST_EXE_MASK 0x10
97#define EP_FIRST_EXE 0x10
98#define EP_GET_FIRST_EXE(x) ((x) & EP_FIRST_EXE_MASK)
99#define EP_SET_FIRST_EXE(x, ee) ((x) = ((x) & ~EP_FIRST_EXE_MASK) | (ee))
100
Yatharth Kocharf11b29a2016-02-01 11:04:46 +0000101#define PARAM_EP 0x01
102#define PARAM_IMAGE_BINARY 0x02
103#define PARAM_BL31 0x03
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100104#define PARAM_BL_LOAD_INFO 0x04
105#define PARAM_BL_PARAMS 0x05
Soby Mathew89256b82016-09-13 14:19:08 +0100106#define PARAM_PSCI_LIB_ARGS 0x06
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100107
108#define IMAGE_ATTRIB_SKIP_LOADING 0x02
109#define IMAGE_ATTRIB_PLAT_SETUP 0x04
Dan Handley2bd4ef22014-04-09 13:14:54 +0100110
Yatharth Kocharf11b29a2016-02-01 11:04:46 +0000111#define VERSION_1 0x01
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100112#define VERSION_2 0x02
Vikram Kanigirida567432014-04-15 18:08:08 +0100113
Yatharth Kochara65be2f2015-10-09 18:06:13 +0100114#define INVALID_IMAGE_ID (0xFFFFFFFF)
115
Vikram Kanigirida567432014-04-15 18:08:08 +0100116#define SET_PARAM_HEAD(_p, _type, _ver, _attr) do { \
117 (_p)->h.type = (uint8_t)(_type); \
118 (_p)->h.version = (uint8_t)(_ver); \
119 (_p)->h.size = (uint16_t)sizeof(*_p); \
120 (_p)->h.attr = (uint32_t)(_attr) ; \
121 } while (0)
122
Yatharth Kocharf11b29a2016-02-01 11:04:46 +0000123/* Following is used for populating structure members statically. */
124#define SET_STATIC_PARAM_HEAD(_p, _type, _ver, _p_type, _attr) \
125 ._p.h.type = (uint8_t)(_type), \
126 ._p.h.version = (uint8_t)(_ver), \
127 ._p.h.size = (uint16_t)sizeof(_p_type), \
128 ._p.h.attr = (uint32_t)(_attr)
129
130
Yatharth Kochar6c0566c2015-10-02 17:56:48 +0100131/*******************************************************************************
132 * Constants to indicate type of exception to the common exception handler.
133 ******************************************************************************/
134#define SYNC_EXCEPTION_SP_EL0 0x0
135#define IRQ_SP_EL0 0x1
136#define FIQ_SP_EL0 0x2
137#define SERROR_SP_EL0 0x3
138#define SYNC_EXCEPTION_SP_ELX 0x4
139#define IRQ_SP_ELX 0x5
140#define FIQ_SP_ELX 0x6
141#define SERROR_SP_ELX 0x7
142#define SYNC_EXCEPTION_AARCH64 0x8
143#define IRQ_AARCH64 0x9
144#define FIQ_AARCH64 0xa
145#define SERROR_AARCH64 0xb
146#define SYNC_EXCEPTION_AARCH32 0xc
147#define IRQ_AARCH32 0xd
148#define FIQ_AARCH32 0xe
149#define SERROR_AARCH32 0xf
150
Vikram Kanigirida567432014-04-15 18:08:08 +0100151#ifndef __ASSEMBLY__
Dan Handley2bd4ef22014-04-09 13:14:54 +0100152#include <cdefs.h> /* For __dead2 */
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +0100153#include <cassert.h>
Vikram Kanigirida567432014-04-15 18:08:08 +0100154#include <stdint.h>
Sandrine Bailleux467d0572014-06-24 14:02:34 +0100155#include <stddef.h>
Soby Mathewa0fedc42016-06-16 14:52:04 +0100156#include <types.h>
Sandrine Bailleux7659a262016-07-05 09:55:03 +0100157#include <utils.h> /* To retain compatibility */
Vikram Kanigiri725b1332015-03-04 10:34:27 +0000158
Dan Handleyf05c1b52015-04-27 11:49:22 +0100159/*
160 * Declarations of linker defined symbols to help determine memory layout of
161 * BL images
162 */
Sandrine Bailleuxf91f1442016-07-08 14:37:40 +0100163#if SEPARATE_CODE_AND_RODATA
Soby Mathewa0fedc42016-06-16 14:52:04 +0100164extern uintptr_t __TEXT_START__;
165extern uintptr_t __TEXT_END__;
166extern uintptr_t __RODATA_START__;
167extern uintptr_t __RODATA_END__;
Sandrine Bailleuxf91f1442016-07-08 14:37:40 +0100168#else
Soby Mathewa0fedc42016-06-16 14:52:04 +0100169extern uintptr_t __RO_START__;
170extern uintptr_t __RO_END__;
Sandrine Bailleuxf91f1442016-07-08 14:37:40 +0100171#endif
172
Dan Handleyf05c1b52015-04-27 11:49:22 +0100173#if IMAGE_BL2
Soby Mathewa0fedc42016-06-16 14:52:04 +0100174extern uintptr_t __BL2_END__;
Yatharth Kocharb1c2fe02015-10-14 15:27:24 +0100175#elif IMAGE_BL2U
Soby Mathewa0fedc42016-06-16 14:52:04 +0100176extern uintptr_t __BL2U_END__;
Dan Handleyf05c1b52015-04-27 11:49:22 +0100177#elif IMAGE_BL31
Soby Mathewa0fedc42016-06-16 14:52:04 +0100178extern uintptr_t __BL31_END__;
Dan Handleyf05c1b52015-04-27 11:49:22 +0100179#elif IMAGE_BL32
Soby Mathewa0fedc42016-06-16 14:52:04 +0100180extern uintptr_t __BL32_END__;
Dan Handleyf05c1b52015-04-27 11:49:22 +0100181#endif /* IMAGE_BLX */
182
183#if USE_COHERENT_MEM
Soby Mathewa0fedc42016-06-16 14:52:04 +0100184extern uintptr_t __COHERENT_RAM_START__;
185extern uintptr_t __COHERENT_RAM_END__;
Dan Handleyf05c1b52015-04-27 11:49:22 +0100186#endif
187
188
Achin Gupta4f6ad662013-10-25 09:08:21 +0100189/*******************************************************************************
190 * Structure used for telling the next BL how much of a particular type of
191 * memory is available for its use and how much is already used.
192 ******************************************************************************/
Dan Handleye2712bc2014-04-10 15:37:22 +0100193typedef struct meminfo {
Soby Mathewa0fedc42016-06-16 14:52:04 +0100194 uintptr_t total_base;
Sandrine Bailleux467d0572014-06-24 14:02:34 +0100195 size_t total_size;
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100196#if !LOAD_IMAGE_V2
Soby Mathewa0fedc42016-06-16 14:52:04 +0100197 uintptr_t free_base;
Sandrine Bailleux467d0572014-06-24 14:02:34 +0100198 size_t free_size;
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100199#endif
Dan Handleye2712bc2014-04-10 15:37:22 +0100200} meminfo_t;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100201
Dan Handleye2712bc2014-04-10 15:37:22 +0100202typedef struct aapcs64_params {
Soby Mathewa0fedc42016-06-16 14:52:04 +0100203 u_register_t arg0;
204 u_register_t arg1;
205 u_register_t arg2;
206 u_register_t arg3;
207 u_register_t arg4;
208 u_register_t arg5;
209 u_register_t arg6;
210 u_register_t arg7;
Dan Handleye2712bc2014-04-10 15:37:22 +0100211} aapcs64_params_t;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100212
Soby Mathew748be1d2016-05-05 14:10:46 +0100213typedef struct aapcs32_params {
214 u_register_t arg0;
215 u_register_t arg1;
216 u_register_t arg2;
217 u_register_t arg3;
218} aapcs32_params_t;
219
Vikram Kanigirida567432014-04-15 18:08:08 +0100220/***************************************************************************
221 * This structure provides version information and the size of the
222 * structure, attributes for the structure it represents
223 ***************************************************************************/
224typedef struct param_header {
225 uint8_t type; /* type of the structure */
226 uint8_t version; /* version of this structure */
227 uint16_t size; /* size of this structure in bytes */
228 uint32_t attr; /* attributes: unused bits SBZ */
229} param_header_t;
230
231/*****************************************************************************
232 * This structure represents the superset of information needed while
233 * switching exception levels. The only two mechanisms to do so are
234 * ERET & SMC. Security state is indicated using bit zero of header
235 * attribute
Soby Mathew6d4f2622016-01-12 10:30:59 +0000236 * NOTE: BL1 expects entrypoint followed by spsr at an offset from the start
237 * of this structure defined by the macro `ENTRY_POINT_INFO_PC_OFFSET` while
238 * processing SMC to jump to BL31.
Vikram Kanigirida567432014-04-15 18:08:08 +0100239 *****************************************************************************/
240typedef struct entry_point_info {
241 param_header_t h;
242 uintptr_t pc;
243 uint32_t spsr;
Soby Mathew748be1d2016-05-05 14:10:46 +0100244#ifdef AARCH32
245 aapcs32_params_t args;
246#else
Dan Handleye2712bc2014-04-10 15:37:22 +0100247 aapcs64_params_t args;
Soby Mathew748be1d2016-05-05 14:10:46 +0100248#endif
Vikram Kanigirida567432014-04-15 18:08:08 +0100249} entry_point_info_t;
250
251/*****************************************************************************
252 * Image info binary provides information from the image loader that
253 * can be used by the firmware to manage available trusted RAM.
254 * More advanced firmware image formats can provide additional
255 * information that enables optimization or greater flexibility in the
256 * common firmware code
257 *****************************************************************************/
258typedef struct image_info {
259 param_header_t h;
260 uintptr_t image_base; /* physical address of base of image */
261 uint32_t image_size; /* bytes read from image file */
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100262#if LOAD_IMAGE_V2
263 uint32_t image_max_size;
264#endif
Vikram Kanigirida567432014-04-15 18:08:08 +0100265} image_info_t;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100266
Yatharth Kochara65be2f2015-10-09 18:06:13 +0100267/*****************************************************************************
268 * The image descriptor struct definition.
269 *****************************************************************************/
270typedef struct image_desc {
271 /* Contains unique image id for the image. */
272 unsigned int image_id;
Yatharth Kochara65be2f2015-10-09 18:06:13 +0100273 /*
274 * This member contains Image state information.
275 * Refer IMAGE_STATE_XXX defined above.
276 */
277 unsigned int state;
Yatharth Kocharf11b29a2016-02-01 11:04:46 +0000278 uint32_t copied_size; /* image size copied in blocks */
Soby Mathew6d4f2622016-01-12 10:30:59 +0000279 image_info_t image_info;
280 entry_point_info_t ep_info;
Yatharth Kochara65be2f2015-10-09 18:06:13 +0100281} image_desc_t;
282
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100283#if LOAD_IMAGE_V2
284/* BL image node in the BL image loading sequence */
285typedef struct bl_load_info_node {
286 unsigned int image_id;
287 image_info_t *image_info;
288 struct bl_load_info_node *next_load_info;
289} bl_load_info_node_t;
290
291/* BL image head node in the BL image loading sequence */
292typedef struct bl_load_info {
293 param_header_t h;
294 bl_load_info_node_t *head;
295} bl_load_info_t;
296
297/* BL image node in the BL image execution sequence */
298typedef struct bl_params_node {
299 unsigned int image_id;
300 image_info_t *image_info;
301 entry_point_info_t *ep_info;
302 struct bl_params_node *next_params_info;
303} bl_params_node_t;
304
305/*
306 * BL image head node in the BL image execution sequence
307 * It is also used to pass information to next BL image.
308 */
309typedef struct bl_params {
310 param_header_t h;
311 bl_params_node_t *head;
312} bl_params_t;
313
314#else /* LOAD_IMAGE_V2 */
315
Achin Gupta4f6ad662013-10-25 09:08:21 +0100316/*******************************************************************************
Achin Guptae4d084e2014-02-19 17:18:23 +0000317 * This structure represents the superset of information that can be passed to
318 * BL31 e.g. while passing control to it from BL2. The BL32 parameters will be
Vikram Kanigirida567432014-04-15 18:08:08 +0100319 * populated only if BL2 detects its presence. A pointer to a structure of this
Juan Castillo7d199412015-12-14 09:35:25 +0000320 * type should be passed in X0 to BL31's cold boot entrypoint.
Vikram Kanigirida567432014-04-15 18:08:08 +0100321 *
Juan Castillo7d199412015-12-14 09:35:25 +0000322 * Use of this structure and the X0 parameter is not mandatory: the BL31
Vikram Kanigirida567432014-04-15 18:08:08 +0100323 * platform code can use other mechanisms to provide the necessary information
Juan Castillo7d199412015-12-14 09:35:25 +0000324 * about BL32 and BL33 to the common and SPD code.
Vikram Kanigirida567432014-04-15 18:08:08 +0100325 *
Juan Castillo7d199412015-12-14 09:35:25 +0000326 * BL31 image information is mandatory if this structure is used. If either of
327 * the optional BL32 and BL33 image information is not provided, this is
Vikram Kanigirida567432014-04-15 18:08:08 +0100328 * indicated by the respective image_info pointers being zero.
Achin Guptae4d084e2014-02-19 17:18:23 +0000329 ******************************************************************************/
Vikram Kanigirida567432014-04-15 18:08:08 +0100330typedef struct bl31_params {
331 param_header_t h;
332 image_info_t *bl31_image_info;
333 entry_point_info_t *bl32_ep_info;
334 image_info_t *bl32_image_info;
335 entry_point_info_t *bl33_ep_info;
336 image_info_t *bl33_image_info;
337} bl31_params_t;
338
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100339#endif /* LOAD_IMAGE_V2 */
Vikram Kanigirida567432014-04-15 18:08:08 +0100340
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +0100341/*
Vikram Kanigirida567432014-04-15 18:08:08 +0100342 * Compile time assertions related to the 'entry_point_info' structure to
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +0100343 * ensure that the assembler and the compiler view of the offsets of
344 * the structure members is the same.
345 */
Vikram Kanigirida567432014-04-15 18:08:08 +0100346CASSERT(ENTRY_POINT_INFO_PC_OFFSET ==
347 __builtin_offsetof(entry_point_info_t, pc), \
348 assert_BL31_pc_offset_mismatch);
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +0100349
Vikram Kanigirida567432014-04-15 18:08:08 +0100350CASSERT(ENTRY_POINT_INFO_ARGS_OFFSET == \
351 __builtin_offsetof(entry_point_info_t, args), \
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +0100352 assert_BL31_args_offset_mismatch);
353
Soby Mathewa0fedc42016-06-16 14:52:04 +0100354CASSERT(sizeof(uintptr_t) ==
Vikram Kanigirida567432014-04-15 18:08:08 +0100355 __builtin_offsetof(entry_point_info_t, spsr) - \
356 __builtin_offsetof(entry_point_info_t, pc), \
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +0100357 assert_entrypoint_and_spsr_should_be_adjacent);
358
Achin Guptae4d084e2014-02-19 17:18:23 +0000359/*******************************************************************************
Achin Gupta4f6ad662013-10-25 09:08:21 +0100360 * Function & variable prototypes
361 ******************************************************************************/
Soby Mathewa0fedc42016-06-16 14:52:04 +0100362size_t image_size(unsigned int image_id);
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100363
364#if LOAD_IMAGE_V2
365
366int load_image(unsigned int image_id, image_info_t *image_data);
367int load_auth_image(unsigned int image_id, image_info_t *image_data);
368
369#else
370
371uintptr_t page_align(uintptr_t, unsigned);
Sandrine Bailleux467d0572014-06-24 14:02:34 +0100372int load_image(meminfo_t *mem_layout,
Juan Castillo3a66aca2015-04-13 17:36:19 +0100373 unsigned int image_id,
Juan Castilloa08a5e72015-05-19 11:54:12 +0100374 uintptr_t image_base,
Sandrine Bailleux467d0572014-06-24 14:02:34 +0100375 image_info_t *image_data,
376 entry_point_info_t *entry_point_info);
Juan Castilloa08a5e72015-05-19 11:54:12 +0100377int load_auth_image(meminfo_t *mem_layout,
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100378 unsigned int image_id,
Juan Castilloa08a5e72015-05-19 11:54:12 +0100379 uintptr_t image_base,
380 image_info_t *image_data,
381 entry_point_info_t *entry_point_info);
Soby Mathewa0fedc42016-06-16 14:52:04 +0100382void reserve_mem(uintptr_t *free_base, size_t *free_size,
383 uintptr_t addr, size_t size);
Sandrine Bailleux467d0572014-06-24 14:02:34 +0100384
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100385#endif /* LOAD_IMAGE_V2 */
386
387extern const char build_message[];
388extern const char version_string[];
389
Sandrine Bailleuxb2e224c2015-09-28 17:03:06 +0100390void print_entry_point_info(const entry_point_info_t *ep_info);
391
Achin Gupta4f6ad662013-10-25 09:08:21 +0100392#endif /*__ASSEMBLY__*/
393
394#endif /* __BL_COMMON_H__ */