blob: 8915ba069e8fd0c395c26463263e61962b177b79 [file] [log] [blame]
Achin Gupta4f6ad662013-10-25 09:08:21 +01001/*
Soby Mathewb911cc72017-02-13 12:46:28 +00002 * Copyright (c) 2013-2017, 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>
Achin Gupta4f6ad662013-10-25 09:08:21 +010012
13#define UP 1
14#define DOWN 0
15
16/*******************************************************************************
Sandrine Bailleux467d0572014-06-24 14:02:34 +010017 * Constants to identify the location of a memory region in a given memory
18 * layout.
19******************************************************************************/
20#define TOP 0x1
21#define BOTTOM !TOP
Achin Gupta4f6ad662013-10-25 09:08:21 +010022
Yatharth Kochara65be2f2015-10-09 18:06:13 +010023/*
24 * The following are used for image state attributes.
25 * Image can only be in one of the following state.
26 */
27#define IMAGE_STATE_RESET 0
28#define IMAGE_STATE_COPIED 1
29#define IMAGE_STATE_COPYING 2
30#define IMAGE_STATE_AUTHENTICATED 3
31#define IMAGE_STATE_EXECUTED 4
32#define IMAGE_STATE_INTERRUPTED 5
33
Yatharth Kochar3345a8d2016-09-12 16:08:41 +010034#define IMAGE_ATTRIB_SKIP_LOADING 0x02
35#define IMAGE_ATTRIB_PLAT_SETUP 0x04
Dan Handley2bd4ef22014-04-09 13:14:54 +010036
Yatharth Kochara65be2f2015-10-09 18:06:13 +010037#define INVALID_IMAGE_ID (0xFFFFFFFF)
38
Yatharth Kochar6c0566c2015-10-02 17:56:48 +010039/*******************************************************************************
40 * Constants to indicate type of exception to the common exception handler.
41 ******************************************************************************/
42#define SYNC_EXCEPTION_SP_EL0 0x0
43#define IRQ_SP_EL0 0x1
44#define FIQ_SP_EL0 0x2
45#define SERROR_SP_EL0 0x3
46#define SYNC_EXCEPTION_SP_ELX 0x4
47#define IRQ_SP_ELX 0x5
48#define FIQ_SP_ELX 0x6
49#define SERROR_SP_ELX 0x7
50#define SYNC_EXCEPTION_AARCH64 0x8
51#define IRQ_AARCH64 0x9
52#define FIQ_AARCH64 0xa
53#define SERROR_AARCH64 0xb
54#define SYNC_EXCEPTION_AARCH32 0xc
55#define IRQ_AARCH32 0xd
56#define FIQ_AARCH32 0xe
57#define SERROR_AARCH32 0xf
58
Vikram Kanigirida567432014-04-15 18:08:08 +010059#ifndef __ASSEMBLY__
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +010060#include <cassert.h>
Sandrine Bailleux467d0572014-06-24 14:02:34 +010061#include <stddef.h>
Soby Mathewb911cc72017-02-13 12:46:28 +000062#include <stdint.h>
Soby Mathewa0fedc42016-06-16 14:52:04 +010063#include <types.h>
Scott Brandenbf404c02017-04-10 11:45:52 -070064#include <utils_def.h> /* To retain compatibility */
Vikram Kanigiri725b1332015-03-04 10:34:27 +000065
Dan Handleyf05c1b52015-04-27 11:49:22 +010066/*
67 * Declarations of linker defined symbols to help determine memory layout of
68 * BL images
69 */
Sandrine Bailleuxf91f1442016-07-08 14:37:40 +010070#if SEPARATE_CODE_AND_RODATA
Soby Mathewa0fedc42016-06-16 14:52:04 +010071extern uintptr_t __TEXT_START__;
72extern uintptr_t __TEXT_END__;
73extern uintptr_t __RODATA_START__;
74extern uintptr_t __RODATA_END__;
Sandrine Bailleuxf91f1442016-07-08 14:37:40 +010075#else
Soby Mathewa0fedc42016-06-16 14:52:04 +010076extern uintptr_t __RO_START__;
77extern uintptr_t __RO_END__;
Sandrine Bailleuxf91f1442016-07-08 14:37:40 +010078#endif
79
Masahiro Yamada441bfdd2016-12-25 23:36:24 +090080#if defined(IMAGE_BL2)
Soby Mathewa0fedc42016-06-16 14:52:04 +010081extern uintptr_t __BL2_END__;
Masahiro Yamada441bfdd2016-12-25 23:36:24 +090082#elif defined(IMAGE_BL2U)
Soby Mathewa0fedc42016-06-16 14:52:04 +010083extern uintptr_t __BL2U_END__;
Masahiro Yamada441bfdd2016-12-25 23:36:24 +090084#elif defined(IMAGE_BL31)
Soby Mathewa0fedc42016-06-16 14:52:04 +010085extern uintptr_t __BL31_END__;
Masahiro Yamada441bfdd2016-12-25 23:36:24 +090086#elif defined(IMAGE_BL32)
Soby Mathewa0fedc42016-06-16 14:52:04 +010087extern uintptr_t __BL32_END__;
Dan Handleyf05c1b52015-04-27 11:49:22 +010088#endif /* IMAGE_BLX */
89
90#if USE_COHERENT_MEM
Soby Mathewa0fedc42016-06-16 14:52:04 +010091extern uintptr_t __COHERENT_RAM_START__;
92extern uintptr_t __COHERENT_RAM_END__;
Dan Handleyf05c1b52015-04-27 11:49:22 +010093#endif
94
Achin Gupta4f6ad662013-10-25 09:08:21 +010095/*******************************************************************************
96 * Structure used for telling the next BL how much of a particular type of
97 * memory is available for its use and how much is already used.
98 ******************************************************************************/
Dan Handleye2712bc2014-04-10 15:37:22 +010099typedef struct meminfo {
Soby Mathewa0fedc42016-06-16 14:52:04 +0100100 uintptr_t total_base;
Sandrine Bailleux467d0572014-06-24 14:02:34 +0100101 size_t total_size;
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100102#if !LOAD_IMAGE_V2
Soby Mathewa0fedc42016-06-16 14:52:04 +0100103 uintptr_t free_base;
Sandrine Bailleux467d0572014-06-24 14:02:34 +0100104 size_t free_size;
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100105#endif
Dan Handleye2712bc2014-04-10 15:37:22 +0100106} meminfo_t;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100107
Vikram Kanigirida567432014-04-15 18:08:08 +0100108/*****************************************************************************
109 * Image info binary provides information from the image loader that
110 * can be used by the firmware to manage available trusted RAM.
111 * More advanced firmware image formats can provide additional
112 * information that enables optimization or greater flexibility in the
113 * common firmware code
114 *****************************************************************************/
115typedef struct image_info {
116 param_header_t h;
117 uintptr_t image_base; /* physical address of base of image */
118 uint32_t image_size; /* bytes read from image file */
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100119#if LOAD_IMAGE_V2
120 uint32_t image_max_size;
121#endif
Vikram Kanigirida567432014-04-15 18:08:08 +0100122} image_info_t;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100123
Yatharth Kochara65be2f2015-10-09 18:06:13 +0100124/*****************************************************************************
125 * The image descriptor struct definition.
126 *****************************************************************************/
127typedef struct image_desc {
128 /* Contains unique image id for the image. */
129 unsigned int image_id;
Yatharth Kochara65be2f2015-10-09 18:06:13 +0100130 /*
131 * This member contains Image state information.
132 * Refer IMAGE_STATE_XXX defined above.
133 */
134 unsigned int state;
Yatharth Kocharf11b29a2016-02-01 11:04:46 +0000135 uint32_t copied_size; /* image size copied in blocks */
Soby Mathew6d4f2622016-01-12 10:30:59 +0000136 image_info_t image_info;
137 entry_point_info_t ep_info;
Yatharth Kochara65be2f2015-10-09 18:06:13 +0100138} image_desc_t;
139
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100140#if LOAD_IMAGE_V2
141/* BL image node in the BL image loading sequence */
142typedef struct bl_load_info_node {
143 unsigned int image_id;
144 image_info_t *image_info;
145 struct bl_load_info_node *next_load_info;
146} bl_load_info_node_t;
147
148/* BL image head node in the BL image loading sequence */
149typedef struct bl_load_info {
150 param_header_t h;
151 bl_load_info_node_t *head;
152} bl_load_info_t;
153
154/* BL image node in the BL image execution sequence */
155typedef struct bl_params_node {
156 unsigned int image_id;
157 image_info_t *image_info;
158 entry_point_info_t *ep_info;
159 struct bl_params_node *next_params_info;
160} bl_params_node_t;
161
162/*
163 * BL image head node in the BL image execution sequence
164 * It is also used to pass information to next BL image.
165 */
166typedef struct bl_params {
167 param_header_t h;
168 bl_params_node_t *head;
169} bl_params_t;
170
171#else /* LOAD_IMAGE_V2 */
172
Achin Gupta4f6ad662013-10-25 09:08:21 +0100173/*******************************************************************************
Achin Guptae4d084e2014-02-19 17:18:23 +0000174 * This structure represents the superset of information that can be passed to
175 * BL31 e.g. while passing control to it from BL2. The BL32 parameters will be
Vikram Kanigirida567432014-04-15 18:08:08 +0100176 * populated only if BL2 detects its presence. A pointer to a structure of this
Juan Castillo7d199412015-12-14 09:35:25 +0000177 * type should be passed in X0 to BL31's cold boot entrypoint.
Vikram Kanigirida567432014-04-15 18:08:08 +0100178 *
Juan Castillo7d199412015-12-14 09:35:25 +0000179 * Use of this structure and the X0 parameter is not mandatory: the BL31
Vikram Kanigirida567432014-04-15 18:08:08 +0100180 * platform code can use other mechanisms to provide the necessary information
Juan Castillo7d199412015-12-14 09:35:25 +0000181 * about BL32 and BL33 to the common and SPD code.
Vikram Kanigirida567432014-04-15 18:08:08 +0100182 *
Juan Castillo7d199412015-12-14 09:35:25 +0000183 * BL31 image information is mandatory if this structure is used. If either of
184 * the optional BL32 and BL33 image information is not provided, this is
Vikram Kanigirida567432014-04-15 18:08:08 +0100185 * indicated by the respective image_info pointers being zero.
Achin Guptae4d084e2014-02-19 17:18:23 +0000186 ******************************************************************************/
Vikram Kanigirida567432014-04-15 18:08:08 +0100187typedef struct bl31_params {
188 param_header_t h;
189 image_info_t *bl31_image_info;
190 entry_point_info_t *bl32_ep_info;
191 image_info_t *bl32_image_info;
192 entry_point_info_t *bl33_ep_info;
193 image_info_t *bl33_image_info;
194} bl31_params_t;
195
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100196#endif /* LOAD_IMAGE_V2 */
Vikram Kanigirida567432014-04-15 18:08:08 +0100197
Achin Guptae4d084e2014-02-19 17:18:23 +0000198/*******************************************************************************
Achin Gupta4f6ad662013-10-25 09:08:21 +0100199 * Function & variable prototypes
200 ******************************************************************************/
Soby Mathewa0fedc42016-06-16 14:52:04 +0100201size_t image_size(unsigned int image_id);
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100202
Sandrine Bailleuxb0e529b2016-11-08 14:27:10 +0000203int is_mem_free(uintptr_t free_base, size_t free_size,
204 uintptr_t addr, size_t size);
205
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100206#if LOAD_IMAGE_V2
207
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100208int load_auth_image(unsigned int image_id, image_info_t *image_data);
209
210#else
211
212uintptr_t page_align(uintptr_t, unsigned);
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);
232
Achin Gupta4f6ad662013-10-25 09:08:21 +0100233#endif /*__ASSEMBLY__*/
234
235#endif /* __BL_COMMON_H__ */