1 /* 2 * Copyright (c) 2013-2016, ARM Limited and Contributors. All rights reserved. 3 * 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 34 #define SECURE 0x0 35 #define NON_SECURE 0x1 36 #define sec_state_is_valid(s) (((s) == SECURE) || ((s) == NON_SECURE)) 37 38 #define UP 1 39 #define DOWN 0 40 41 /******************************************************************************* 42 * Constants to identify the location of a memory region in a given memory 43 * layout. 44 ******************************************************************************/ 45 #define TOP 0x1 46 #define BOTTOM !TOP 47 48 /******************************************************************************* 49 * Constants that allow assembler code to access members of and the 50 * 'entry_point_info' structure at their correct offsets. 51 ******************************************************************************/ 52 #define ENTRY_POINT_INFO_PC_OFFSET 0x08 53 #define ENTRY_POINT_INFO_ARGS_OFFSET 0x18 54 55 /* The following are used to set/get image attributes. */ 56 #define PARAM_EP_SECURITY_MASK (0x1) 57 58 #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 62 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 74 #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 86 #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 95 96 #define VERSION_1 0x01 97 98 #define INVALID_IMAGE_ID (0xFFFFFFFF) 99 100 #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 107 /* 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 115 /******************************************************************************* 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 135 #ifndef __ASSEMBLY__ 136 #include <cdefs.h> /* For __dead2 */ 137 #include <cassert.h> 138 #include <stdint.h> 139 #include <stddef.h> 140 #include <utils.h> /* To retain compatibility */ 141 142 /* 143 * Declarations of linker defined symbols to help determine memory layout of 144 * BL images 145 */ 146 #if SEPARATE_CODE_AND_RODATA 147 extern unsigned long __TEXT_START__; 148 extern unsigned long __TEXT_END__; 149 extern unsigned long __RODATA_START__; 150 extern unsigned long __RODATA_END__; 151 #else 152 extern unsigned long __RO_START__; 153 extern unsigned long __RO_END__; 154 #endif 155 156 #if IMAGE_BL2 157 extern unsigned long __BL2_END__; 158 #elif IMAGE_BL2U 159 extern unsigned long __BL2U_END__; 160 #elif IMAGE_BL31 161 extern unsigned long __BL31_END__; 162 #elif IMAGE_BL32 163 extern unsigned long __BL32_END__; 164 #endif /* IMAGE_BLX */ 165 166 #if USE_COHERENT_MEM 167 extern unsigned long __COHERENT_RAM_START__; 168 extern unsigned long __COHERENT_RAM_END__; 169 #endif 170 171 172 /******************************************************************************* 173 * Structure used for telling the next BL how much of a particular type of 174 * memory is available for its use and how much is already used. 175 ******************************************************************************/ 176 typedef struct meminfo { 177 uint64_t total_base; 178 size_t total_size; 179 uint64_t free_base; 180 size_t free_size; 181 } meminfo_t; 182 183 typedef struct aapcs64_params { 184 unsigned long arg0; 185 unsigned long arg1; 186 unsigned long arg2; 187 unsigned long arg3; 188 unsigned long arg4; 189 unsigned long arg5; 190 unsigned long arg6; 191 unsigned long arg7; 192 } aapcs64_params_t; 193 194 /*************************************************************************** 195 * This structure provides version information and the size of the 196 * structure, attributes for the structure it represents 197 ***************************************************************************/ 198 typedef struct param_header { 199 uint8_t type; /* type of the structure */ 200 uint8_t version; /* version of this structure */ 201 uint16_t size; /* size of this structure in bytes */ 202 uint32_t attr; /* attributes: unused bits SBZ */ 203 } param_header_t; 204 205 /***************************************************************************** 206 * This structure represents the superset of information needed while 207 * switching exception levels. The only two mechanisms to do so are 208 * ERET & SMC. Security state is indicated using bit zero of header 209 * attribute 210 * NOTE: BL1 expects entrypoint followed by spsr at an offset from the start 211 * of this structure defined by the macro `ENTRY_POINT_INFO_PC_OFFSET` while 212 * processing SMC to jump to BL31. 213 *****************************************************************************/ 214 typedef struct entry_point_info { 215 param_header_t h; 216 uintptr_t pc; 217 uint32_t spsr; 218 aapcs64_params_t args; 219 } entry_point_info_t; 220 221 /***************************************************************************** 222 * Image info binary provides information from the image loader that 223 * can be used by the firmware to manage available trusted RAM. 224 * More advanced firmware image formats can provide additional 225 * information that enables optimization or greater flexibility in the 226 * common firmware code 227 *****************************************************************************/ 228 typedef struct image_info { 229 param_header_t h; 230 uintptr_t image_base; /* physical address of base of image */ 231 uint32_t image_size; /* bytes read from image file */ 232 } image_info_t; 233 234 /***************************************************************************** 235 * The image descriptor struct definition. 236 *****************************************************************************/ 237 typedef struct image_desc { 238 /* Contains unique image id for the image. */ 239 unsigned int image_id; 240 /* 241 * This member contains Image state information. 242 * Refer IMAGE_STATE_XXX defined above. 243 */ 244 unsigned int state; 245 uint32_t copied_size; /* image size copied in blocks */ 246 image_info_t image_info; 247 entry_point_info_t ep_info; 248 } image_desc_t; 249 250 /******************************************************************************* 251 * This structure represents the superset of information that can be passed to 252 * BL31 e.g. while passing control to it from BL2. The BL32 parameters will be 253 * populated only if BL2 detects its presence. A pointer to a structure of this 254 * type should be passed in X0 to BL31's cold boot entrypoint. 255 * 256 * Use of this structure and the X0 parameter is not mandatory: the BL31 257 * platform code can use other mechanisms to provide the necessary information 258 * about BL32 and BL33 to the common and SPD code. 259 * 260 * BL31 image information is mandatory if this structure is used. If either of 261 * the optional BL32 and BL33 image information is not provided, this is 262 * indicated by the respective image_info pointers being zero. 263 ******************************************************************************/ 264 typedef struct bl31_params { 265 param_header_t h; 266 image_info_t *bl31_image_info; 267 entry_point_info_t *bl32_ep_info; 268 image_info_t *bl32_image_info; 269 entry_point_info_t *bl33_ep_info; 270 image_info_t *bl33_image_info; 271 } bl31_params_t; 272 273 274 /* 275 * Compile time assertions related to the 'entry_point_info' structure to 276 * ensure that the assembler and the compiler view of the offsets of 277 * the structure members is the same. 278 */ 279 CASSERT(ENTRY_POINT_INFO_PC_OFFSET == 280 __builtin_offsetof(entry_point_info_t, pc), \ 281 assert_BL31_pc_offset_mismatch); 282 283 CASSERT(ENTRY_POINT_INFO_ARGS_OFFSET == \ 284 __builtin_offsetof(entry_point_info_t, args), \ 285 assert_BL31_args_offset_mismatch); 286 287 CASSERT(sizeof(unsigned long) == 288 __builtin_offsetof(entry_point_info_t, spsr) - \ 289 __builtin_offsetof(entry_point_info_t, pc), \ 290 assert_entrypoint_and_spsr_should_be_adjacent); 291 292 /******************************************************************************* 293 * Function & variable prototypes 294 ******************************************************************************/ 295 unsigned long page_align(unsigned long, unsigned); 296 unsigned long image_size(unsigned int image_id); 297 int load_image(meminfo_t *mem_layout, 298 unsigned int image_id, 299 uintptr_t image_base, 300 image_info_t *image_data, 301 entry_point_info_t *entry_point_info); 302 int load_auth_image(meminfo_t *mem_layout, 303 unsigned int image_name, 304 uintptr_t image_base, 305 image_info_t *image_data, 306 entry_point_info_t *entry_point_info); 307 extern const char build_message[]; 308 extern const char version_string[]; 309 310 void reserve_mem(uint64_t *free_base, size_t *free_size, 311 uint64_t addr, size_t size); 312 313 void print_entry_point_info(const entry_point_info_t *ep_info); 314 315 #endif /*__ASSEMBLY__*/ 316 317 #endif /* __BL_COMMON_H__ */ 318