blob: 2f3bade1ad19c2c937c846f16abba2ee3e045802 [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
36#define PARAM_EP_SECURITY_MASK 0x1
Achin Gupta4f6ad662013-10-25 09:08:21 +010037
38#define UP 1
39#define DOWN 0
40
41/*******************************************************************************
42 * Constants for loading images. When BLx wants to load BLy, it looks at a
43 * meminfo structure to find the extents of free memory. Then depending upon
44 * how it has been configured, it can either load BLy at the top or bottom of
45 * the free memory. These constants indicate the choice.
46 * TODO: Make this configurable while building the trusted firmware.
47 ******************************************************************************/
48#define TOP_LOAD 0x1
49#define BOT_LOAD !TOP_LOAD
50#define LOAD_MASK (1 << 0)
51
Sandrine Bailleuxba6980a2013-12-02 15:41:25 +000052/******************************************************************************
53 * Opcode passed in x0 to tell next EL that we want to run an image.
54 * Corresponds to the function ID of the only SMC that the BL1 exception
55 * handlers service. That's why the chosen value is the first function ID of
56 * the ARM SMC64 range.
57 *****************************************************************************/
58#define RUN_IMAGE 0xC0000000
59
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +010060/*******************************************************************************
61 * Constants that allow assembler code to access members of and the
Vikram Kanigirida567432014-04-15 18:08:08 +010062 * 'entry_point_info' structure at their correct offsets.
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +010063 ******************************************************************************/
Vikram Kanigirida567432014-04-15 18:08:08 +010064#define ENTRY_POINT_INFO_PC_OFFSET 0x08
65#define ENTRY_POINT_INFO_ARGS_OFFSET 0x18
Sandrine Bailleuxba6980a2013-12-02 15:41:25 +000066
Vikram Kanigirida567432014-04-15 18:08:08 +010067#define GET_SECURITY_STATE(x) (x & PARAM_EP_SECURITY_MASK)
68#define SET_SECURITY_STATE(x, security) \
69 ((x) = ((x) & ~PARAM_EP_SECURITY_MASK) | (security))
70
71#define PARAM_EP 0x01
72#define PARAM_IMAGE_BINARY 0x02
73#define PARAM_BL31 0x03
Dan Handley2bd4ef22014-04-09 13:14:54 +010074
Vikram Kanigirida567432014-04-15 18:08:08 +010075#define VERSION_1 0x01
76
77#define SET_PARAM_HEAD(_p, _type, _ver, _attr) do { \
78 (_p)->h.type = (uint8_t)(_type); \
79 (_p)->h.version = (uint8_t)(_ver); \
80 (_p)->h.size = (uint16_t)sizeof(*_p); \
81 (_p)->h.attr = (uint32_t)(_attr) ; \
82 } while (0)
83
84#ifndef __ASSEMBLY__
Dan Handley2bd4ef22014-04-09 13:14:54 +010085#include <cdefs.h> /* For __dead2 */
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +010086#include <cassert.h>
Vikram Kanigirida567432014-04-15 18:08:08 +010087#include <stdint.h>
Achin Guptae4d084e2014-02-19 17:18:23 +000088
Achin Gupta4f6ad662013-10-25 09:08:21 +010089/*******************************************************************************
90 * Structure used for telling the next BL how much of a particular type of
91 * memory is available for its use and how much is already used.
92 ******************************************************************************/
Dan Handleye2712bc2014-04-10 15:37:22 +010093typedef struct meminfo {
Achin Gupta4f6ad662013-10-25 09:08:21 +010094 unsigned long total_base;
95 long total_size;
96 unsigned long free_base;
97 long free_size;
98 unsigned long attr;
99 unsigned long next;
Dan Handleye2712bc2014-04-10 15:37:22 +0100100} meminfo_t;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100101
Dan Handleye2712bc2014-04-10 15:37:22 +0100102typedef struct aapcs64_params {
Achin Gupta4f6ad662013-10-25 09:08:21 +0100103 unsigned long arg0;
104 unsigned long arg1;
105 unsigned long arg2;
106 unsigned long arg3;
107 unsigned long arg4;
108 unsigned long arg5;
109 unsigned long arg6;
110 unsigned long arg7;
Dan Handleye2712bc2014-04-10 15:37:22 +0100111} aapcs64_params_t;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100112
Vikram Kanigirida567432014-04-15 18:08:08 +0100113/***************************************************************************
114 * This structure provides version information and the size of the
115 * structure, attributes for the structure it represents
116 ***************************************************************************/
117typedef struct param_header {
118 uint8_t type; /* type of the structure */
119 uint8_t version; /* version of this structure */
120 uint16_t size; /* size of this structure in bytes */
121 uint32_t attr; /* attributes: unused bits SBZ */
122} param_header_t;
123
124/*****************************************************************************
125 * This structure represents the superset of information needed while
126 * switching exception levels. The only two mechanisms to do so are
127 * ERET & SMC. Security state is indicated using bit zero of header
128 * attribute
129 * NOTE: BL1 expects entrypoint followed by spsr while processing
130 * SMC to jump to BL31 from the start of entry_point_info
131 *****************************************************************************/
132typedef struct entry_point_info {
133 param_header_t h;
134 uintptr_t pc;
135 uint32_t spsr;
Dan Handleye2712bc2014-04-10 15:37:22 +0100136 aapcs64_params_t args;
Vikram Kanigirida567432014-04-15 18:08:08 +0100137} entry_point_info_t;
138
139/*****************************************************************************
140 * Image info binary provides information from the image loader that
141 * can be used by the firmware to manage available trusted RAM.
142 * More advanced firmware image formats can provide additional
143 * information that enables optimization or greater flexibility in the
144 * common firmware code
145 *****************************************************************************/
146typedef struct image_info {
147 param_header_t h;
148 uintptr_t image_base; /* physical address of base of image */
149 uint32_t image_size; /* bytes read from image file */
150} image_info_t;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100151
152/*******************************************************************************
Achin Guptae4d084e2014-02-19 17:18:23 +0000153 * This structure represents the superset of information that can be passed to
154 * BL31 e.g. while passing control to it from BL2. The BL32 parameters will be
Vikram Kanigirida567432014-04-15 18:08:08 +0100155 * populated only if BL2 detects its presence. A pointer to a structure of this
156 * type should be passed in X3 to BL31's cold boot entrypoint
157 *
158 * Use of this structure and the X3 parameter is not mandatory: the BL3-1
159 * platform code can use other mechanisms to provide the necessary information
160 * about BL3-2 and BL3-3 to the common and SPD code.
161 *
162 * BL3-1 image information is mandatory if this structure is used. If either of
163 * the optional BL3-2 and BL3-3 image information is not provided, this is
164 * indicated by the respective image_info pointers being zero.
Achin Guptae4d084e2014-02-19 17:18:23 +0000165 ******************************************************************************/
Vikram Kanigirida567432014-04-15 18:08:08 +0100166typedef struct bl31_params {
167 param_header_t h;
168 image_info_t *bl31_image_info;
169 entry_point_info_t *bl32_ep_info;
170 image_info_t *bl32_image_info;
171 entry_point_info_t *bl33_ep_info;
172 image_info_t *bl33_image_info;
173} bl31_params_t;
174
175
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +0100176/*
Vikram Kanigirida567432014-04-15 18:08:08 +0100177 * Compile time assertions related to the 'entry_point_info' structure to
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +0100178 * ensure that the assembler and the compiler view of the offsets of
179 * the structure members is the same.
180 */
Vikram Kanigirida567432014-04-15 18:08:08 +0100181CASSERT(ENTRY_POINT_INFO_PC_OFFSET ==
182 __builtin_offsetof(entry_point_info_t, pc), \
183 assert_BL31_pc_offset_mismatch);
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +0100184
Vikram Kanigirida567432014-04-15 18:08:08 +0100185CASSERT(ENTRY_POINT_INFO_ARGS_OFFSET == \
186 __builtin_offsetof(entry_point_info_t, args), \
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +0100187 assert_BL31_args_offset_mismatch);
188
Vikram Kanigirida567432014-04-15 18:08:08 +0100189CASSERT(sizeof(unsigned long) ==
190 __builtin_offsetof(entry_point_info_t, spsr) - \
191 __builtin_offsetof(entry_point_info_t, pc), \
Vikram Kanigiria3a5e4a2014-05-15 18:27:15 +0100192 assert_entrypoint_and_spsr_should_be_adjacent);
193
Achin Guptae4d084e2014-02-19 17:18:23 +0000194/*******************************************************************************
Achin Gupta4f6ad662013-10-25 09:08:21 +0100195 * Function & variable prototypes
196 ******************************************************************************/
Dan Handleya17fefa2014-05-14 12:38:32 +0100197unsigned long page_align(unsigned long, unsigned);
198void change_security_state(unsigned int);
Dan Handleya17fefa2014-05-14 12:38:32 +0100199unsigned long image_size(const char *);
200int load_image(meminfo_t *,
201 const char *,
202 unsigned int,
203 unsigned long,
204 image_info_t *,
205 entry_point_info_t *);
Jon Medhurstecf0a712014-02-17 12:18:24 +0000206extern const char build_message[];
Achin Gupta4f6ad662013-10-25 09:08:21 +0100207
208#endif /*__ASSEMBLY__*/
209
210#endif /* __BL_COMMON_H__ */