blob: 33b75f1884ada5da2ccc81965a9c65db38f6a971 [file] [log] [blame]
Achin Gupta4f6ad662013-10-25 09:08:21 +01001/*
Dan Handleye83b0ca2014-01-14 18:17:09 +00002 * Copyright (c) 2013-2014, 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
Sandrine Bailleuxba6980a2013-12-02 15:41:25 +000048/******************************************************************************
49 * Opcode passed in x0 to tell next EL that we want to run an image.
50 * Corresponds to the function ID of the only SMC that the BL1 exception
51 * handlers service. That's why the chosen value is the first function ID of
52 * the ARM SMC64 range.
53 *****************************************************************************/
54#define RUN_IMAGE 0xC0000000
55
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +010056/*******************************************************************************
57 * Constants that allow assembler code to access members of and the
Vikram Kanigirida567432014-04-15 18:08:08 +010058 * 'entry_point_info' structure at their correct offsets.
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +010059 ******************************************************************************/
Vikram Kanigirida567432014-04-15 18:08:08 +010060#define ENTRY_POINT_INFO_PC_OFFSET 0x08
61#define ENTRY_POINT_INFO_ARGS_OFFSET 0x18
Sandrine Bailleuxba6980a2013-12-02 15:41:25 +000062
Andrew Thoelke4e126072014-06-04 21:10:52 +010063#define PARAM_EP_SECURITY_MASK 0x1
Vikram Kanigirida567432014-04-15 18:08:08 +010064#define GET_SECURITY_STATE(x) (x & PARAM_EP_SECURITY_MASK)
65#define SET_SECURITY_STATE(x, security) \
66 ((x) = ((x) & ~PARAM_EP_SECURITY_MASK) | (security))
67
Andrew Thoelke4e126072014-06-04 21:10:52 +010068#define EP_EE_MASK 0x2
69#define EP_EE_LITTLE 0x0
70#define EP_EE_BIG 0x2
71#define EP_GET_EE(x) (x & EP_EE_MASK)
72#define EP_SET_EE(x, ee) ((x) = ((x) & ~EP_EE_MASK) | (ee))
73
74#define EP_ST_MASK 0x4
75#define EP_ST_DISABLE 0x0
76#define EP_ST_ENABLE 0x4
77#define EP_GET_ST(x) (x & EP_ST_MASK)
78#define EP_SET_ST(x, ee) ((x) = ((x) & ~EP_ST_MASK) | (ee))
79
Vikram Kanigirida567432014-04-15 18:08:08 +010080#define PARAM_EP 0x01
81#define PARAM_IMAGE_BINARY 0x02
82#define PARAM_BL31 0x03
Dan Handley2bd4ef22014-04-09 13:14:54 +010083
Vikram Kanigirida567432014-04-15 18:08:08 +010084#define VERSION_1 0x01
85
86#define SET_PARAM_HEAD(_p, _type, _ver, _attr) do { \
87 (_p)->h.type = (uint8_t)(_type); \
88 (_p)->h.version = (uint8_t)(_ver); \
89 (_p)->h.size = (uint16_t)sizeof(*_p); \
90 (_p)->h.attr = (uint32_t)(_attr) ; \
91 } while (0)
92
Yatharth Kochar36433d12014-11-20 18:09:41 +000093/*******************************************************************************
94 * Constant that indicates if this is the first version of the reset handler
95 * contained in an image. This will be the case when the image is BL1 or when
96 * its BL3-1 and RESET_TO_BL31 is true. This constant enables a subsequent
97 * version of the reset handler to perform actions that override the ones
98 * performed in the first version of the code. This will be required when the
99 * first version exists in an un-modifiable image e.g. a BootROM image.
100 ******************************************************************************/
101#if IMAGE_BL1 || (IMAGE_BL31 && RESET_TO_BL31)
102#define FIRST_RESET_HANDLER_CALL
103#endif
104
Vikram Kanigirida567432014-04-15 18:08:08 +0100105#ifndef __ASSEMBLY__
Dan Handley2bd4ef22014-04-09 13:14:54 +0100106#include <cdefs.h> /* For __dead2 */
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +0100107#include <cassert.h>
Vikram Kanigirida567432014-04-15 18:08:08 +0100108#include <stdint.h>
Sandrine Bailleux467d0572014-06-24 14:02:34 +0100109#include <stddef.h>
Achin Guptae4d084e2014-02-19 17:18:23 +0000110
Vikram Kanigiri725b1332015-03-04 10:34:27 +0000111#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
112
Dan Handleyf05c1b52015-04-27 11:49:22 +0100113/*
114 * Declarations of linker defined symbols to help determine memory layout of
115 * BL images
116 */
117extern unsigned long __RO_START__;
118extern unsigned long __RO_END__;
119#if IMAGE_BL2
120extern unsigned long __BL2_END__;
121#elif IMAGE_BL31
122extern unsigned long __BL31_END__;
123#elif IMAGE_BL32
124extern unsigned long __BL32_END__;
125#endif /* IMAGE_BLX */
126
127#if USE_COHERENT_MEM
128extern unsigned long __COHERENT_RAM_START__;
129extern unsigned long __COHERENT_RAM_END__;
130#endif
131
132
Achin Gupta4f6ad662013-10-25 09:08:21 +0100133/*******************************************************************************
134 * Structure used for telling the next BL how much of a particular type of
135 * memory is available for its use and how much is already used.
136 ******************************************************************************/
Dan Handleye2712bc2014-04-10 15:37:22 +0100137typedef struct meminfo {
Sandrine Bailleux467d0572014-06-24 14:02:34 +0100138 uint64_t total_base;
139 size_t total_size;
140 uint64_t free_base;
141 size_t free_size;
Dan Handleye2712bc2014-04-10 15:37:22 +0100142} meminfo_t;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100143
Dan Handleye2712bc2014-04-10 15:37:22 +0100144typedef struct aapcs64_params {
Achin Gupta4f6ad662013-10-25 09:08:21 +0100145 unsigned long arg0;
146 unsigned long arg1;
147 unsigned long arg2;
148 unsigned long arg3;
149 unsigned long arg4;
150 unsigned long arg5;
151 unsigned long arg6;
152 unsigned long arg7;
Dan Handleye2712bc2014-04-10 15:37:22 +0100153} aapcs64_params_t;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100154
Vikram Kanigirida567432014-04-15 18:08:08 +0100155/***************************************************************************
156 * This structure provides version information and the size of the
157 * structure, attributes for the structure it represents
158 ***************************************************************************/
159typedef struct param_header {
160 uint8_t type; /* type of the structure */
161 uint8_t version; /* version of this structure */
162 uint16_t size; /* size of this structure in bytes */
163 uint32_t attr; /* attributes: unused bits SBZ */
164} param_header_t;
165
166/*****************************************************************************
167 * This structure represents the superset of information needed while
168 * switching exception levels. The only two mechanisms to do so are
169 * ERET & SMC. Security state is indicated using bit zero of header
170 * attribute
171 * NOTE: BL1 expects entrypoint followed by spsr while processing
172 * SMC to jump to BL31 from the start of entry_point_info
173 *****************************************************************************/
174typedef struct entry_point_info {
175 param_header_t h;
176 uintptr_t pc;
177 uint32_t spsr;
Dan Handleye2712bc2014-04-10 15:37:22 +0100178 aapcs64_params_t args;
Vikram Kanigirida567432014-04-15 18:08:08 +0100179} entry_point_info_t;
180
181/*****************************************************************************
182 * Image info binary provides information from the image loader that
183 * can be used by the firmware to manage available trusted RAM.
184 * More advanced firmware image formats can provide additional
185 * information that enables optimization or greater flexibility in the
186 * common firmware code
187 *****************************************************************************/
188typedef struct image_info {
189 param_header_t h;
190 uintptr_t image_base; /* physical address of base of image */
191 uint32_t image_size; /* bytes read from image file */
192} image_info_t;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100193
194/*******************************************************************************
Achin Guptae4d084e2014-02-19 17:18:23 +0000195 * This structure represents the superset of information that can be passed to
196 * BL31 e.g. while passing control to it from BL2. The BL32 parameters will be
Vikram Kanigirida567432014-04-15 18:08:08 +0100197 * populated only if BL2 detects its presence. A pointer to a structure of this
198 * type should be passed in X3 to BL31's cold boot entrypoint
199 *
200 * Use of this structure and the X3 parameter is not mandatory: the BL3-1
201 * platform code can use other mechanisms to provide the necessary information
202 * about BL3-2 and BL3-3 to the common and SPD code.
203 *
204 * BL3-1 image information is mandatory if this structure is used. If either of
205 * the optional BL3-2 and BL3-3 image information is not provided, this is
206 * indicated by the respective image_info pointers being zero.
Achin Guptae4d084e2014-02-19 17:18:23 +0000207 ******************************************************************************/
Vikram Kanigirida567432014-04-15 18:08:08 +0100208typedef struct bl31_params {
209 param_header_t h;
210 image_info_t *bl31_image_info;
211 entry_point_info_t *bl32_ep_info;
212 image_info_t *bl32_image_info;
213 entry_point_info_t *bl33_ep_info;
214 image_info_t *bl33_image_info;
215} bl31_params_t;
216
217
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +0100218/*
Vikram Kanigirida567432014-04-15 18:08:08 +0100219 * Compile time assertions related to the 'entry_point_info' structure to
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +0100220 * ensure that the assembler and the compiler view of the offsets of
221 * the structure members is the same.
222 */
Vikram Kanigirida567432014-04-15 18:08:08 +0100223CASSERT(ENTRY_POINT_INFO_PC_OFFSET ==
224 __builtin_offsetof(entry_point_info_t, pc), \
225 assert_BL31_pc_offset_mismatch);
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +0100226
Vikram Kanigirida567432014-04-15 18:08:08 +0100227CASSERT(ENTRY_POINT_INFO_ARGS_OFFSET == \
228 __builtin_offsetof(entry_point_info_t, args), \
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +0100229 assert_BL31_args_offset_mismatch);
230
Vikram Kanigirida567432014-04-15 18:08:08 +0100231CASSERT(sizeof(unsigned long) ==
232 __builtin_offsetof(entry_point_info_t, spsr) - \
233 __builtin_offsetof(entry_point_info_t, pc), \
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +0100234 assert_entrypoint_and_spsr_should_be_adjacent);
235
Achin Guptae4d084e2014-02-19 17:18:23 +0000236/*******************************************************************************
Achin Gupta4f6ad662013-10-25 09:08:21 +0100237 * Function & variable prototypes
238 ******************************************************************************/
Dan Handleya17fefa2014-05-14 12:38:32 +0100239unsigned long page_align(unsigned long, unsigned);
240void change_security_state(unsigned int);
Dan Handleya17fefa2014-05-14 12:38:32 +0100241unsigned long image_size(const char *);
Sandrine Bailleux467d0572014-06-24 14:02:34 +0100242int load_image(meminfo_t *mem_layout,
243 const char *image_name,
244 uint64_t image_base,
245 image_info_t *image_data,
246 entry_point_info_t *entry_point_info);
Jon Medhurstecf0a712014-02-17 12:18:24 +0000247extern const char build_message[];
Juan Castillo04be3a52014-06-30 11:41:46 +0100248extern const char version_string[];
Achin Gupta4f6ad662013-10-25 09:08:21 +0100249
Sandrine Bailleux467d0572014-06-24 14:02:34 +0100250void reserve_mem(uint64_t *free_base, size_t *free_size,
251 uint64_t addr, size_t size);
252
Achin Gupta4f6ad662013-10-25 09:08:21 +0100253#endif /*__ASSEMBLY__*/
254
255#endif /* __BL_COMMON_H__ */