blob: 4ef916f531871ffe2e4a674d110aef1c7f2bcede [file] [log] [blame]
Achin Gupta4f6ad662013-10-25 09:08:21 +01001/*
Roberto Vargas777dd432018-02-12 12:36:17 +00002 * Copyright (c) 2013-2018, ARM Limited and Contributors. All rights reserved.
Achin Gupta4f6ad662013-10-25 09:08:21 +01003 *
dp-armfa3cf0b2017-05-03 09:38:09 +01004 * SPDX-License-Identifier: BSD-3-Clause
Achin Gupta4f6ad662013-10-25 09:08:21 +01005 */
6
7#ifndef __BL_COMMON_H__
8#define __BL_COMMON_H__
9
Soby Mathewb911cc72017-02-13 12:46:28 +000010#include <ep_info.h>
11#include <param_header.h>
Soby Mathewcc364842018-02-21 01:16:39 +000012#include <utils_def.h>
Achin Gupta4f6ad662013-10-25 09:08:21 +010013
14#define UP 1
15#define DOWN 0
16
17/*******************************************************************************
Sandrine Bailleux467d0572014-06-24 14:02:34 +010018 * Constants to identify the location of a memory region in a given memory
19 * layout.
20******************************************************************************/
21#define TOP 0x1
22#define BOTTOM !TOP
Achin Gupta4f6ad662013-10-25 09:08:21 +010023
Yatharth Kochara65be2f2015-10-09 18:06:13 +010024/*
25 * The following are used for image state attributes.
26 * Image can only be in one of the following state.
27 */
28#define IMAGE_STATE_RESET 0
29#define IMAGE_STATE_COPIED 1
30#define IMAGE_STATE_COPYING 2
31#define IMAGE_STATE_AUTHENTICATED 3
32#define IMAGE_STATE_EXECUTED 4
33#define IMAGE_STATE_INTERRUPTED 5
34
Soby Mathewcc364842018-02-21 01:16:39 +000035#define IMAGE_ATTRIB_SKIP_LOADING U(0x02)
36#define IMAGE_ATTRIB_PLAT_SETUP U(0x04)
Dan Handley2bd4ef22014-04-09 13:14:54 +010037
Soby Mathewcc364842018-02-21 01:16:39 +000038#define INVALID_IMAGE_ID U(0xFFFFFFFF)
Yatharth Kochara65be2f2015-10-09 18:06:13 +010039
Yatharth Kochar6c0566c2015-10-02 17:56:48 +010040/*******************************************************************************
41 * Constants to indicate type of exception to the common exception handler.
42 ******************************************************************************/
43#define SYNC_EXCEPTION_SP_EL0 0x0
44#define IRQ_SP_EL0 0x1
45#define FIQ_SP_EL0 0x2
46#define SERROR_SP_EL0 0x3
47#define SYNC_EXCEPTION_SP_ELX 0x4
48#define IRQ_SP_ELX 0x5
49#define FIQ_SP_ELX 0x6
50#define SERROR_SP_ELX 0x7
51#define SYNC_EXCEPTION_AARCH64 0x8
52#define IRQ_AARCH64 0x9
53#define FIQ_AARCH64 0xa
54#define SERROR_AARCH64 0xb
55#define SYNC_EXCEPTION_AARCH32 0xc
56#define IRQ_AARCH32 0xd
57#define FIQ_AARCH32 0xe
58#define SERROR_AARCH32 0xf
59
Vikram Kanigirida567432014-04-15 18:08:08 +010060#ifndef __ASSEMBLY__
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +010061#include <cassert.h>
Sandrine Bailleux467d0572014-06-24 14:02:34 +010062#include <stddef.h>
Soby Mathewb911cc72017-02-13 12:46:28 +000063#include <stdint.h>
Soby Mathewa0fedc42016-06-16 14:52:04 +010064#include <types.h>
Scott Brandenbf404c02017-04-10 11:45:52 -070065#include <utils_def.h> /* To retain compatibility */
Vikram Kanigiri725b1332015-03-04 10:34:27 +000066
Dan Handleyf05c1b52015-04-27 11:49:22 +010067/*
68 * Declarations of linker defined symbols to help determine memory layout of
69 * BL images
70 */
Sandrine Bailleuxf91f1442016-07-08 14:37:40 +010071#if SEPARATE_CODE_AND_RODATA
Soby Mathewa0fedc42016-06-16 14:52:04 +010072extern uintptr_t __TEXT_START__;
73extern uintptr_t __TEXT_END__;
74extern uintptr_t __RODATA_START__;
75extern uintptr_t __RODATA_END__;
Sandrine Bailleuxf91f1442016-07-08 14:37:40 +010076#else
Soby Mathewa0fedc42016-06-16 14:52:04 +010077extern uintptr_t __RO_START__;
78extern uintptr_t __RO_END__;
Sandrine Bailleuxf91f1442016-07-08 14:37:40 +010079#endif
80
Masahiro Yamada441bfdd2016-12-25 23:36:24 +090081#if defined(IMAGE_BL2)
Soby Mathewa0fedc42016-06-16 14:52:04 +010082extern uintptr_t __BL2_END__;
Masahiro Yamada441bfdd2016-12-25 23:36:24 +090083#elif defined(IMAGE_BL2U)
Soby Mathewa0fedc42016-06-16 14:52:04 +010084extern uintptr_t __BL2U_END__;
Masahiro Yamada441bfdd2016-12-25 23:36:24 +090085#elif defined(IMAGE_BL31)
Soby Mathewa0fedc42016-06-16 14:52:04 +010086extern uintptr_t __BL31_END__;
Masahiro Yamada441bfdd2016-12-25 23:36:24 +090087#elif defined(IMAGE_BL32)
Soby Mathewa0fedc42016-06-16 14:52:04 +010088extern uintptr_t __BL32_END__;
Dan Handleyf05c1b52015-04-27 11:49:22 +010089#endif /* IMAGE_BLX */
90
91#if USE_COHERENT_MEM
Soby Mathewa0fedc42016-06-16 14:52:04 +010092extern uintptr_t __COHERENT_RAM_START__;
93extern uintptr_t __COHERENT_RAM_END__;
Dan Handleyf05c1b52015-04-27 11:49:22 +010094#endif
95
Achin Gupta4f6ad662013-10-25 09:08:21 +010096/*******************************************************************************
97 * Structure used for telling the next BL how much of a particular type of
98 * memory is available for its use and how much is already used.
99 ******************************************************************************/
Dan Handleye2712bc2014-04-10 15:37:22 +0100100typedef struct meminfo {
Soby Mathewa0fedc42016-06-16 14:52:04 +0100101 uintptr_t total_base;
Sandrine Bailleux467d0572014-06-24 14:02:34 +0100102 size_t total_size;
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100103#if !LOAD_IMAGE_V2
Soby Mathewa0fedc42016-06-16 14:52:04 +0100104 uintptr_t free_base;
Sandrine Bailleux467d0572014-06-24 14:02:34 +0100105 size_t free_size;
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100106#endif
Dan Handleye2712bc2014-04-10 15:37:22 +0100107} meminfo_t;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100108
Vikram Kanigirida567432014-04-15 18:08:08 +0100109/*****************************************************************************
110 * Image info binary provides information from the image loader that
111 * can be used by the firmware to manage available trusted RAM.
112 * More advanced firmware image formats can provide additional
113 * information that enables optimization or greater flexibility in the
114 * common firmware code
115 *****************************************************************************/
116typedef struct image_info {
117 param_header_t h;
118 uintptr_t image_base; /* physical address of base of image */
119 uint32_t image_size; /* bytes read from image file */
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100120#if LOAD_IMAGE_V2
121 uint32_t image_max_size;
122#endif
Vikram Kanigirida567432014-04-15 18:08:08 +0100123} image_info_t;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100124
Yatharth Kochara65be2f2015-10-09 18:06:13 +0100125/*****************************************************************************
126 * The image descriptor struct definition.
127 *****************************************************************************/
128typedef struct image_desc {
129 /* Contains unique image id for the image. */
130 unsigned int image_id;
Yatharth Kochara65be2f2015-10-09 18:06:13 +0100131 /*
132 * This member contains Image state information.
133 * Refer IMAGE_STATE_XXX defined above.
134 */
135 unsigned int state;
Yatharth Kocharf11b29a2016-02-01 11:04:46 +0000136 uint32_t copied_size; /* image size copied in blocks */
Soby Mathew6d4f2622016-01-12 10:30:59 +0000137 image_info_t image_info;
138 entry_point_info_t ep_info;
Yatharth Kochara65be2f2015-10-09 18:06:13 +0100139} image_desc_t;
140
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100141#if LOAD_IMAGE_V2
142/* BL image node in the BL image loading sequence */
143typedef struct bl_load_info_node {
144 unsigned int image_id;
145 image_info_t *image_info;
146 struct bl_load_info_node *next_load_info;
147} bl_load_info_node_t;
148
149/* BL image head node in the BL image loading sequence */
150typedef struct bl_load_info {
151 param_header_t h;
152 bl_load_info_node_t *head;
153} bl_load_info_t;
154
155/* BL image node in the BL image execution sequence */
156typedef struct bl_params_node {
157 unsigned int image_id;
158 image_info_t *image_info;
159 entry_point_info_t *ep_info;
160 struct bl_params_node *next_params_info;
161} bl_params_node_t;
162
163/*
164 * BL image head node in the BL image execution sequence
165 * It is also used to pass information to next BL image.
166 */
167typedef struct bl_params {
168 param_header_t h;
169 bl_params_node_t *head;
170} bl_params_t;
171
172#else /* LOAD_IMAGE_V2 */
173
Achin Gupta4f6ad662013-10-25 09:08:21 +0100174/*******************************************************************************
Achin Guptae4d084e2014-02-19 17:18:23 +0000175 * This structure represents the superset of information that can be passed to
176 * BL31 e.g. while passing control to it from BL2. The BL32 parameters will be
Vikram Kanigirida567432014-04-15 18:08:08 +0100177 * populated only if BL2 detects its presence. A pointer to a structure of this
Juan Castillo7d199412015-12-14 09:35:25 +0000178 * type should be passed in X0 to BL31's cold boot entrypoint.
Vikram Kanigirida567432014-04-15 18:08:08 +0100179 *
Juan Castillo7d199412015-12-14 09:35:25 +0000180 * Use of this structure and the X0 parameter is not mandatory: the BL31
Vikram Kanigirida567432014-04-15 18:08:08 +0100181 * platform code can use other mechanisms to provide the necessary information
Juan Castillo7d199412015-12-14 09:35:25 +0000182 * about BL32 and BL33 to the common and SPD code.
Vikram Kanigirida567432014-04-15 18:08:08 +0100183 *
Juan Castillo7d199412015-12-14 09:35:25 +0000184 * BL31 image information is mandatory if this structure is used. If either of
185 * the optional BL32 and BL33 image information is not provided, this is
Vikram Kanigirida567432014-04-15 18:08:08 +0100186 * indicated by the respective image_info pointers being zero.
Achin Guptae4d084e2014-02-19 17:18:23 +0000187 ******************************************************************************/
Vikram Kanigirida567432014-04-15 18:08:08 +0100188typedef struct bl31_params {
189 param_header_t h;
190 image_info_t *bl31_image_info;
191 entry_point_info_t *bl32_ep_info;
192 image_info_t *bl32_image_info;
193 entry_point_info_t *bl33_ep_info;
194 image_info_t *bl33_image_info;
195} bl31_params_t;
196
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100197#endif /* LOAD_IMAGE_V2 */
Vikram Kanigirida567432014-04-15 18:08:08 +0100198
Achin Guptae4d084e2014-02-19 17:18:23 +0000199/*******************************************************************************
Achin Gupta4f6ad662013-10-25 09:08:21 +0100200 * Function & variable prototypes
201 ******************************************************************************/
Soby Mathewa0fedc42016-06-16 14:52:04 +0100202size_t image_size(unsigned int image_id);
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100203
Sandrine Bailleuxb0e529b2016-11-08 14:27:10 +0000204int is_mem_free(uintptr_t free_base, size_t free_size,
205 uintptr_t addr, size_t size);
206
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100207#if LOAD_IMAGE_V2
208
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100209int load_auth_image(unsigned int image_id, image_info_t *image_data);
210
211#else
212
Sandrine Bailleux467d0572014-06-24 14:02:34 +0100213int load_image(meminfo_t *mem_layout,
Juan Castillo3a66aca2015-04-13 17:36:19 +0100214 unsigned int image_id,
Juan Castilloa08a5e72015-05-19 11:54:12 +0100215 uintptr_t image_base,
Sandrine Bailleux467d0572014-06-24 14:02:34 +0100216 image_info_t *image_data,
217 entry_point_info_t *entry_point_info);
Juan Castilloa08a5e72015-05-19 11:54:12 +0100218int load_auth_image(meminfo_t *mem_layout,
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100219 unsigned int image_id,
Juan Castilloa08a5e72015-05-19 11:54:12 +0100220 uintptr_t image_base,
221 image_info_t *image_data,
222 entry_point_info_t *entry_point_info);
Soby Mathewa0fedc42016-06-16 14:52:04 +0100223void reserve_mem(uintptr_t *free_base, size_t *free_size,
224 uintptr_t addr, size_t size);
Sandrine Bailleux467d0572014-06-24 14:02:34 +0100225
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100226#endif /* LOAD_IMAGE_V2 */
227
228extern const char build_message[];
229extern const char version_string[];
230
Sandrine Bailleuxb2e224c2015-09-28 17:03:06 +0100231void print_entry_point_info(const entry_point_info_t *ep_info);
Roberto Vargas2ca18d92018-02-12 12:36:17 +0000232uintptr_t page_align(uintptr_t value, unsigned dir);
Sandrine Bailleuxb2e224c2015-09-28 17:03:06 +0100233
Achin Gupta4f6ad662013-10-25 09:08:21 +0100234#endif /*__ASSEMBLY__*/
235
236#endif /* __BL_COMMON_H__ */