blob: f13dc316cfd01434f2e8fa398e7da4111291dfaa [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
53#define ENTRY_POINT_INFO_ARGS_OFFSET 0x18
Sandrine Bailleuxba6980a2013-12-02 15:41:25 +000054
Yatharth Kochara65be2f2015-10-09 18:06:13 +010055/* The following are used to set/get image attributes. */
Yatharth Kochara65be2f2015-10-09 18:06:13 +010056#define PARAM_EP_SECURITY_MASK (0x1)
Yatharth Kochara65be2f2015-10-09 18:06:13 +010057
Vikram Kanigirida567432014-04-15 18:08:08 +010058#define GET_SECURITY_STATE(x) (x & PARAM_EP_SECURITY_MASK)
59#define SET_SECURITY_STATE(x, security) \
60 ((x) = ((x) & ~PARAM_EP_SECURITY_MASK) | (security))
61
Yatharth Kochara65be2f2015-10-09 18:06:13 +010062
63/*
64 * The following are used for image state attributes.
65 * Image can only be in one of the following state.
66 */
67#define IMAGE_STATE_RESET 0
68#define IMAGE_STATE_COPIED 1
69#define IMAGE_STATE_COPYING 2
70#define IMAGE_STATE_AUTHENTICATED 3
71#define IMAGE_STATE_EXECUTED 4
72#define IMAGE_STATE_INTERRUPTED 5
73
Andrew Thoelke4e126072014-06-04 21:10:52 +010074#define EP_EE_MASK 0x2
75#define EP_EE_LITTLE 0x0
76#define EP_EE_BIG 0x2
77#define EP_GET_EE(x) (x & EP_EE_MASK)
78#define EP_SET_EE(x, ee) ((x) = ((x) & ~EP_EE_MASK) | (ee))
79
80#define EP_ST_MASK 0x4
81#define EP_ST_DISABLE 0x0
82#define EP_ST_ENABLE 0x4
83#define EP_GET_ST(x) (x & EP_ST_MASK)
84#define EP_SET_ST(x, ee) ((x) = ((x) & ~EP_ST_MASK) | (ee))
85
Yatharth Kocharf11b29a2016-02-01 11:04:46 +000086#define EP_EXE_MASK 0x8
87#define NON_EXECUTABLE 0x0
88#define EXECUTABLE 0x8
89#define EP_GET_EXE(x) (x & EP_EXE_MASK)
90#define EP_SET_EXE(x, ee) ((x) = ((x) & ~EP_EXE_MASK) | (ee))
91
92#define PARAM_EP 0x01
93#define PARAM_IMAGE_BINARY 0x02
94#define PARAM_BL31 0x03
Dan Handley2bd4ef22014-04-09 13:14:54 +010095
Yatharth Kocharf11b29a2016-02-01 11:04:46 +000096#define VERSION_1 0x01
Vikram Kanigirida567432014-04-15 18:08:08 +010097
Yatharth Kochara65be2f2015-10-09 18:06:13 +010098#define INVALID_IMAGE_ID (0xFFFFFFFF)
99
Vikram Kanigirida567432014-04-15 18:08:08 +0100100#define SET_PARAM_HEAD(_p, _type, _ver, _attr) do { \
101 (_p)->h.type = (uint8_t)(_type); \
102 (_p)->h.version = (uint8_t)(_ver); \
103 (_p)->h.size = (uint16_t)sizeof(*_p); \
104 (_p)->h.attr = (uint32_t)(_attr) ; \
105 } while (0)
106
Yatharth Kocharf11b29a2016-02-01 11:04:46 +0000107/* Following is used for populating structure members statically. */
108#define SET_STATIC_PARAM_HEAD(_p, _type, _ver, _p_type, _attr) \
109 ._p.h.type = (uint8_t)(_type), \
110 ._p.h.version = (uint8_t)(_ver), \
111 ._p.h.size = (uint16_t)sizeof(_p_type), \
112 ._p.h.attr = (uint32_t)(_attr)
113
114
Yatharth Kochar6c0566c2015-10-02 17:56:48 +0100115/*******************************************************************************
116 * Constants to indicate type of exception to the common exception handler.
117 ******************************************************************************/
118#define SYNC_EXCEPTION_SP_EL0 0x0
119#define IRQ_SP_EL0 0x1
120#define FIQ_SP_EL0 0x2
121#define SERROR_SP_EL0 0x3
122#define SYNC_EXCEPTION_SP_ELX 0x4
123#define IRQ_SP_ELX 0x5
124#define FIQ_SP_ELX 0x6
125#define SERROR_SP_ELX 0x7
126#define SYNC_EXCEPTION_AARCH64 0x8
127#define IRQ_AARCH64 0x9
128#define FIQ_AARCH64 0xa
129#define SERROR_AARCH64 0xb
130#define SYNC_EXCEPTION_AARCH32 0xc
131#define IRQ_AARCH32 0xd
132#define FIQ_AARCH32 0xe
133#define SERROR_AARCH32 0xf
134
Vikram Kanigirida567432014-04-15 18:08:08 +0100135#ifndef __ASSEMBLY__
Dan Handley2bd4ef22014-04-09 13:14:54 +0100136#include <cdefs.h> /* For __dead2 */
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +0100137#include <cassert.h>
Vikram Kanigirida567432014-04-15 18:08:08 +0100138#include <stdint.h>
Sandrine Bailleux467d0572014-06-24 14:02:34 +0100139#include <stddef.h>
Achin Guptae4d084e2014-02-19 17:18:23 +0000140
Vikram Kanigiri725b1332015-03-04 10:34:27 +0000141#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
142
Dan Handleyf05c1b52015-04-27 11:49:22 +0100143/*
144 * Declarations of linker defined symbols to help determine memory layout of
145 * BL images
146 */
147extern unsigned long __RO_START__;
148extern unsigned long __RO_END__;
149#if IMAGE_BL2
150extern unsigned long __BL2_END__;
Yatharth Kocharb1c2fe02015-10-14 15:27:24 +0100151#elif IMAGE_BL2U
152extern unsigned long __BL2U_END__;
Dan Handleyf05c1b52015-04-27 11:49:22 +0100153#elif IMAGE_BL31
154extern unsigned long __BL31_END__;
155#elif IMAGE_BL32
156extern unsigned long __BL32_END__;
157#endif /* IMAGE_BLX */
158
159#if USE_COHERENT_MEM
160extern unsigned long __COHERENT_RAM_START__;
161extern unsigned long __COHERENT_RAM_END__;
162#endif
163
164
Achin Gupta4f6ad662013-10-25 09:08:21 +0100165/*******************************************************************************
166 * Structure used for telling the next BL how much of a particular type of
167 * memory is available for its use and how much is already used.
168 ******************************************************************************/
Dan Handleye2712bc2014-04-10 15:37:22 +0100169typedef struct meminfo {
Sandrine Bailleux467d0572014-06-24 14:02:34 +0100170 uint64_t total_base;
171 size_t total_size;
172 uint64_t free_base;
173 size_t free_size;
Dan Handleye2712bc2014-04-10 15:37:22 +0100174} meminfo_t;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100175
Dan Handleye2712bc2014-04-10 15:37:22 +0100176typedef struct aapcs64_params {
Achin Gupta4f6ad662013-10-25 09:08:21 +0100177 unsigned long arg0;
178 unsigned long arg1;
179 unsigned long arg2;
180 unsigned long arg3;
181 unsigned long arg4;
182 unsigned long arg5;
183 unsigned long arg6;
184 unsigned long arg7;
Dan Handleye2712bc2014-04-10 15:37:22 +0100185} aapcs64_params_t;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100186
Vikram Kanigirida567432014-04-15 18:08:08 +0100187/***************************************************************************
188 * This structure provides version information and the size of the
189 * structure, attributes for the structure it represents
190 ***************************************************************************/
191typedef struct param_header {
192 uint8_t type; /* type of the structure */
193 uint8_t version; /* version of this structure */
194 uint16_t size; /* size of this structure in bytes */
195 uint32_t attr; /* attributes: unused bits SBZ */
196} param_header_t;
197
198/*****************************************************************************
199 * This structure represents the superset of information needed while
200 * switching exception levels. The only two mechanisms to do so are
201 * ERET & SMC. Security state is indicated using bit zero of header
202 * attribute
Soby Mathew6d4f2622016-01-12 10:30:59 +0000203 * NOTE: BL1 expects entrypoint followed by spsr at an offset from the start
204 * of this structure defined by the macro `ENTRY_POINT_INFO_PC_OFFSET` while
205 * processing SMC to jump to BL31.
Vikram Kanigirida567432014-04-15 18:08:08 +0100206 *****************************************************************************/
207typedef struct entry_point_info {
208 param_header_t h;
209 uintptr_t pc;
210 uint32_t spsr;
Dan Handleye2712bc2014-04-10 15:37:22 +0100211 aapcs64_params_t args;
Vikram Kanigirida567432014-04-15 18:08:08 +0100212} entry_point_info_t;
213
214/*****************************************************************************
215 * Image info binary provides information from the image loader that
216 * can be used by the firmware to manage available trusted RAM.
217 * More advanced firmware image formats can provide additional
218 * information that enables optimization or greater flexibility in the
219 * common firmware code
220 *****************************************************************************/
221typedef struct image_info {
222 param_header_t h;
223 uintptr_t image_base; /* physical address of base of image */
224 uint32_t image_size; /* bytes read from image file */
225} image_info_t;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100226
Yatharth Kochara65be2f2015-10-09 18:06:13 +0100227/*****************************************************************************
228 * The image descriptor struct definition.
229 *****************************************************************************/
230typedef struct image_desc {
231 /* Contains unique image id for the image. */
232 unsigned int image_id;
Yatharth Kochara65be2f2015-10-09 18:06:13 +0100233 /*
234 * This member contains Image state information.
235 * Refer IMAGE_STATE_XXX defined above.
236 */
237 unsigned int state;
Yatharth Kocharf11b29a2016-02-01 11:04:46 +0000238 uint32_t copied_size; /* image size copied in blocks */
Soby Mathew6d4f2622016-01-12 10:30:59 +0000239 image_info_t image_info;
240 entry_point_info_t ep_info;
Yatharth Kochara65be2f2015-10-09 18:06:13 +0100241} image_desc_t;
242
Achin Gupta4f6ad662013-10-25 09:08:21 +0100243/*******************************************************************************
Achin Guptae4d084e2014-02-19 17:18:23 +0000244 * This structure represents the superset of information that can be passed to
245 * BL31 e.g. while passing control to it from BL2. The BL32 parameters will be
Vikram Kanigirida567432014-04-15 18:08:08 +0100246 * populated only if BL2 detects its presence. A pointer to a structure of this
Juan Castillo7d199412015-12-14 09:35:25 +0000247 * type should be passed in X0 to BL31's cold boot entrypoint.
Vikram Kanigirida567432014-04-15 18:08:08 +0100248 *
Juan Castillo7d199412015-12-14 09:35:25 +0000249 * Use of this structure and the X0 parameter is not mandatory: the BL31
Vikram Kanigirida567432014-04-15 18:08:08 +0100250 * platform code can use other mechanisms to provide the necessary information
Juan Castillo7d199412015-12-14 09:35:25 +0000251 * about BL32 and BL33 to the common and SPD code.
Vikram Kanigirida567432014-04-15 18:08:08 +0100252 *
Juan Castillo7d199412015-12-14 09:35:25 +0000253 * BL31 image information is mandatory if this structure is used. If either of
254 * the optional BL32 and BL33 image information is not provided, this is
Vikram Kanigirida567432014-04-15 18:08:08 +0100255 * indicated by the respective image_info pointers being zero.
Achin Guptae4d084e2014-02-19 17:18:23 +0000256 ******************************************************************************/
Vikram Kanigirida567432014-04-15 18:08:08 +0100257typedef struct bl31_params {
258 param_header_t h;
259 image_info_t *bl31_image_info;
260 entry_point_info_t *bl32_ep_info;
261 image_info_t *bl32_image_info;
262 entry_point_info_t *bl33_ep_info;
263 image_info_t *bl33_image_info;
264} bl31_params_t;
265
266
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +0100267/*
Vikram Kanigirida567432014-04-15 18:08:08 +0100268 * Compile time assertions related to the 'entry_point_info' structure to
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +0100269 * ensure that the assembler and the compiler view of the offsets of
270 * the structure members is the same.
271 */
Vikram Kanigirida567432014-04-15 18:08:08 +0100272CASSERT(ENTRY_POINT_INFO_PC_OFFSET ==
273 __builtin_offsetof(entry_point_info_t, pc), \
274 assert_BL31_pc_offset_mismatch);
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +0100275
Vikram Kanigirida567432014-04-15 18:08:08 +0100276CASSERT(ENTRY_POINT_INFO_ARGS_OFFSET == \
277 __builtin_offsetof(entry_point_info_t, args), \
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +0100278 assert_BL31_args_offset_mismatch);
279
Vikram Kanigirida567432014-04-15 18:08:08 +0100280CASSERT(sizeof(unsigned long) ==
281 __builtin_offsetof(entry_point_info_t, spsr) - \
282 __builtin_offsetof(entry_point_info_t, pc), \
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +0100283 assert_entrypoint_and_spsr_should_be_adjacent);
284
Achin Guptae4d084e2014-02-19 17:18:23 +0000285/*******************************************************************************
Achin Gupta4f6ad662013-10-25 09:08:21 +0100286 * Function & variable prototypes
287 ******************************************************************************/
Dan Handleya17fefa2014-05-14 12:38:32 +0100288unsigned long page_align(unsigned long, unsigned);
Juan Castillo3a66aca2015-04-13 17:36:19 +0100289unsigned long image_size(unsigned int image_id);
Sandrine Bailleux467d0572014-06-24 14:02:34 +0100290int load_image(meminfo_t *mem_layout,
Juan Castillo3a66aca2015-04-13 17:36:19 +0100291 unsigned int image_id,
Juan Castilloa08a5e72015-05-19 11:54:12 +0100292 uintptr_t image_base,
Sandrine Bailleux467d0572014-06-24 14:02:34 +0100293 image_info_t *image_data,
294 entry_point_info_t *entry_point_info);
Juan Castilloa08a5e72015-05-19 11:54:12 +0100295int load_auth_image(meminfo_t *mem_layout,
296 unsigned int image_name,
297 uintptr_t image_base,
298 image_info_t *image_data,
299 entry_point_info_t *entry_point_info);
Jon Medhurstecf0a712014-02-17 12:18:24 +0000300extern const char build_message[];
Juan Castillo04be3a52014-06-30 11:41:46 +0100301extern const char version_string[];
Achin Gupta4f6ad662013-10-25 09:08:21 +0100302
Sandrine Bailleux467d0572014-06-24 14:02:34 +0100303void reserve_mem(uint64_t *free_base, size_t *free_size,
304 uint64_t addr, size_t size);
305
Sandrine Bailleuxb2e224c2015-09-28 17:03:06 +0100306void print_entry_point_info(const entry_point_info_t *ep_info);
307
Achin Gupta4f6ad662013-10-25 09:08:21 +0100308#endif /*__ASSEMBLY__*/
309
310#endif /* __BL_COMMON_H__ */