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 #ifdef AARCH32 54 #define ENTRY_POINT_INFO_ARGS_OFFSET 0x10 55 #else 56 #define ENTRY_POINT_INFO_ARGS_OFFSET 0x18 57 #endif 58 59 /* The following are used to set/get image attributes. */ 60 #define PARAM_EP_SECURITY_MASK (0x1) 61 62 #define GET_SECURITY_STATE(x) (x & PARAM_EP_SECURITY_MASK) 63 #define SET_SECURITY_STATE(x, security) \ 64 ((x) = ((x) & ~PARAM_EP_SECURITY_MASK) | (security)) 65 66 67 /* 68 * The following are used for image state attributes. 69 * Image can only be in one of the following state. 70 */ 71 #define IMAGE_STATE_RESET 0 72 #define IMAGE_STATE_COPIED 1 73 #define IMAGE_STATE_COPYING 2 74 #define IMAGE_STATE_AUTHENTICATED 3 75 #define IMAGE_STATE_EXECUTED 4 76 #define IMAGE_STATE_INTERRUPTED 5 77 78 #define EP_EE_MASK 0x2 79 #define EP_EE_LITTLE 0x0 80 #define EP_EE_BIG 0x2 81 #define EP_GET_EE(x) (x & EP_EE_MASK) 82 #define EP_SET_EE(x, ee) ((x) = ((x) & ~EP_EE_MASK) | (ee)) 83 84 #define EP_ST_MASK 0x4 85 #define EP_ST_DISABLE 0x0 86 #define EP_ST_ENABLE 0x4 87 #define EP_GET_ST(x) (x & EP_ST_MASK) 88 #define EP_SET_ST(x, ee) ((x) = ((x) & ~EP_ST_MASK) | (ee)) 89 90 #define EP_EXE_MASK 0x8 91 #define NON_EXECUTABLE 0x0 92 #define EXECUTABLE 0x8 93 #define EP_GET_EXE(x) (x & EP_EXE_MASK) 94 #define EP_SET_EXE(x, ee) ((x) = ((x) & ~EP_EXE_MASK) | (ee)) 95 96 #define EP_FIRST_EXE_MASK 0x10 97 #define EP_FIRST_EXE 0x10 98 #define EP_GET_FIRST_EXE(x) ((x) & EP_FIRST_EXE_MASK) 99 #define EP_SET_FIRST_EXE(x, ee) ((x) = ((x) & ~EP_FIRST_EXE_MASK) | (ee)) 100 101 #define PARAM_EP 0x01 102 #define PARAM_IMAGE_BINARY 0x02 103 #define PARAM_BL31 0x03 104 #define PARAM_BL_LOAD_INFO 0x04 105 #define PARAM_BL_PARAMS 0x05 106 107 #define IMAGE_ATTRIB_SKIP_LOADING 0x02 108 #define IMAGE_ATTRIB_PLAT_SETUP 0x04 109 110 #define VERSION_1 0x01 111 #define VERSION_2 0x02 112 113 #define INVALID_IMAGE_ID (0xFFFFFFFF) 114 115 #define SET_PARAM_HEAD(_p, _type, _ver, _attr) do { \ 116 (_p)->h.type = (uint8_t)(_type); \ 117 (_p)->h.version = (uint8_t)(_ver); \ 118 (_p)->h.size = (uint16_t)sizeof(*_p); \ 119 (_p)->h.attr = (uint32_t)(_attr) ; \ 120 } while (0) 121 122 /* Following is used for populating structure members statically. */ 123 #define SET_STATIC_PARAM_HEAD(_p, _type, _ver, _p_type, _attr) \ 124 ._p.h.type = (uint8_t)(_type), \ 125 ._p.h.version = (uint8_t)(_ver), \ 126 ._p.h.size = (uint16_t)sizeof(_p_type), \ 127 ._p.h.attr = (uint32_t)(_attr) 128 129 130 /******************************************************************************* 131 * Constants to indicate type of exception to the common exception handler. 132 ******************************************************************************/ 133 #define SYNC_EXCEPTION_SP_EL0 0x0 134 #define IRQ_SP_EL0 0x1 135 #define FIQ_SP_EL0 0x2 136 #define SERROR_SP_EL0 0x3 137 #define SYNC_EXCEPTION_SP_ELX 0x4 138 #define IRQ_SP_ELX 0x5 139 #define FIQ_SP_ELX 0x6 140 #define SERROR_SP_ELX 0x7 141 #define SYNC_EXCEPTION_AARCH64 0x8 142 #define IRQ_AARCH64 0x9 143 #define FIQ_AARCH64 0xa 144 #define SERROR_AARCH64 0xb 145 #define SYNC_EXCEPTION_AARCH32 0xc 146 #define IRQ_AARCH32 0xd 147 #define FIQ_AARCH32 0xe 148 #define SERROR_AARCH32 0xf 149 150 #ifndef __ASSEMBLY__ 151 #include <cdefs.h> /* For __dead2 */ 152 #include <cassert.h> 153 #include <stdint.h> 154 #include <stddef.h> 155 #include <types.h> 156 #include <utils.h> /* To retain compatibility */ 157 158 /* 159 * Declarations of linker defined symbols to help determine memory layout of 160 * BL images 161 */ 162 #if SEPARATE_CODE_AND_RODATA 163 extern uintptr_t __TEXT_START__; 164 extern uintptr_t __TEXT_END__; 165 extern uintptr_t __RODATA_START__; 166 extern uintptr_t __RODATA_END__; 167 #else 168 extern uintptr_t __RO_START__; 169 extern uintptr_t __RO_END__; 170 #endif 171 172 #if IMAGE_BL2 173 extern uintptr_t __BL2_END__; 174 #elif IMAGE_BL2U 175 extern uintptr_t __BL2U_END__; 176 #elif IMAGE_BL31 177 extern uintptr_t __BL31_END__; 178 #elif IMAGE_BL32 179 extern uintptr_t __BL32_END__; 180 #endif /* IMAGE_BLX */ 181 182 #if USE_COHERENT_MEM 183 extern uintptr_t __COHERENT_RAM_START__; 184 extern uintptr_t __COHERENT_RAM_END__; 185 #endif 186 187 188 /******************************************************************************* 189 * Structure used for telling the next BL how much of a particular type of 190 * memory is available for its use and how much is already used. 191 ******************************************************************************/ 192 typedef struct meminfo { 193 uintptr_t total_base; 194 size_t total_size; 195 #if !LOAD_IMAGE_V2 196 uintptr_t free_base; 197 size_t free_size; 198 #endif 199 } meminfo_t; 200 201 typedef struct aapcs64_params { 202 u_register_t arg0; 203 u_register_t arg1; 204 u_register_t arg2; 205 u_register_t arg3; 206 u_register_t arg4; 207 u_register_t arg5; 208 u_register_t arg6; 209 u_register_t arg7; 210 } aapcs64_params_t; 211 212 typedef struct aapcs32_params { 213 u_register_t arg0; 214 u_register_t arg1; 215 u_register_t arg2; 216 u_register_t arg3; 217 } aapcs32_params_t; 218 219 /*************************************************************************** 220 * This structure provides version information and the size of the 221 * structure, attributes for the structure it represents 222 ***************************************************************************/ 223 typedef struct param_header { 224 uint8_t type; /* type of the structure */ 225 uint8_t version; /* version of this structure */ 226 uint16_t size; /* size of this structure in bytes */ 227 uint32_t attr; /* attributes: unused bits SBZ */ 228 } param_header_t; 229 230 /***************************************************************************** 231 * This structure represents the superset of information needed while 232 * switching exception levels. The only two mechanisms to do so are 233 * ERET & SMC. Security state is indicated using bit zero of header 234 * attribute 235 * NOTE: BL1 expects entrypoint followed by spsr at an offset from the start 236 * of this structure defined by the macro `ENTRY_POINT_INFO_PC_OFFSET` while 237 * processing SMC to jump to BL31. 238 *****************************************************************************/ 239 typedef struct entry_point_info { 240 param_header_t h; 241 uintptr_t pc; 242 uint32_t spsr; 243 #ifdef AARCH32 244 aapcs32_params_t args; 245 #else 246 aapcs64_params_t args; 247 #endif 248 } entry_point_info_t; 249 250 /***************************************************************************** 251 * Image info binary provides information from the image loader that 252 * can be used by the firmware to manage available trusted RAM. 253 * More advanced firmware image formats can provide additional 254 * information that enables optimization or greater flexibility in the 255 * common firmware code 256 *****************************************************************************/ 257 typedef struct image_info { 258 param_header_t h; 259 uintptr_t image_base; /* physical address of base of image */ 260 uint32_t image_size; /* bytes read from image file */ 261 #if LOAD_IMAGE_V2 262 uint32_t image_max_size; 263 #endif 264 } image_info_t; 265 266 /***************************************************************************** 267 * The image descriptor struct definition. 268 *****************************************************************************/ 269 typedef struct image_desc { 270 /* Contains unique image id for the image. */ 271 unsigned int image_id; 272 /* 273 * This member contains Image state information. 274 * Refer IMAGE_STATE_XXX defined above. 275 */ 276 unsigned int state; 277 uint32_t copied_size; /* image size copied in blocks */ 278 image_info_t image_info; 279 entry_point_info_t ep_info; 280 } image_desc_t; 281 282 #if LOAD_IMAGE_V2 283 /* BL image node in the BL image loading sequence */ 284 typedef struct bl_load_info_node { 285 unsigned int image_id; 286 image_info_t *image_info; 287 struct bl_load_info_node *next_load_info; 288 } bl_load_info_node_t; 289 290 /* BL image head node in the BL image loading sequence */ 291 typedef struct bl_load_info { 292 param_header_t h; 293 bl_load_info_node_t *head; 294 } bl_load_info_t; 295 296 /* BL image node in the BL image execution sequence */ 297 typedef struct bl_params_node { 298 unsigned int image_id; 299 image_info_t *image_info; 300 entry_point_info_t *ep_info; 301 struct bl_params_node *next_params_info; 302 } bl_params_node_t; 303 304 /* 305 * BL image head node in the BL image execution sequence 306 * It is also used to pass information to next BL image. 307 */ 308 typedef struct bl_params { 309 param_header_t h; 310 bl_params_node_t *head; 311 } bl_params_t; 312 313 #else /* LOAD_IMAGE_V2 */ 314 315 /******************************************************************************* 316 * This structure represents the superset of information that can be passed to 317 * BL31 e.g. while passing control to it from BL2. The BL32 parameters will be 318 * populated only if BL2 detects its presence. A pointer to a structure of this 319 * type should be passed in X0 to BL31's cold boot entrypoint. 320 * 321 * Use of this structure and the X0 parameter is not mandatory: the BL31 322 * platform code can use other mechanisms to provide the necessary information 323 * about BL32 and BL33 to the common and SPD code. 324 * 325 * BL31 image information is mandatory if this structure is used. If either of 326 * the optional BL32 and BL33 image information is not provided, this is 327 * indicated by the respective image_info pointers being zero. 328 ******************************************************************************/ 329 typedef struct bl31_params { 330 param_header_t h; 331 image_info_t *bl31_image_info; 332 entry_point_info_t *bl32_ep_info; 333 image_info_t *bl32_image_info; 334 entry_point_info_t *bl33_ep_info; 335 image_info_t *bl33_image_info; 336 } bl31_params_t; 337 338 #endif /* LOAD_IMAGE_V2 */ 339 340 /* 341 * Compile time assertions related to the 'entry_point_info' structure to 342 * ensure that the assembler and the compiler view of the offsets of 343 * the structure members is the same. 344 */ 345 CASSERT(ENTRY_POINT_INFO_PC_OFFSET == 346 __builtin_offsetof(entry_point_info_t, pc), \ 347 assert_BL31_pc_offset_mismatch); 348 349 CASSERT(ENTRY_POINT_INFO_ARGS_OFFSET == \ 350 __builtin_offsetof(entry_point_info_t, args), \ 351 assert_BL31_args_offset_mismatch); 352 353 CASSERT(sizeof(uintptr_t) == 354 __builtin_offsetof(entry_point_info_t, spsr) - \ 355 __builtin_offsetof(entry_point_info_t, pc), \ 356 assert_entrypoint_and_spsr_should_be_adjacent); 357 358 /******************************************************************************* 359 * Function & variable prototypes 360 ******************************************************************************/ 361 size_t image_size(unsigned int image_id); 362 363 #if LOAD_IMAGE_V2 364 365 int load_image(unsigned int image_id, image_info_t *image_data); 366 int load_auth_image(unsigned int image_id, image_info_t *image_data); 367 368 #else 369 370 uintptr_t page_align(uintptr_t, unsigned); 371 int load_image(meminfo_t *mem_layout, 372 unsigned int image_id, 373 uintptr_t image_base, 374 image_info_t *image_data, 375 entry_point_info_t *entry_point_info); 376 int load_auth_image(meminfo_t *mem_layout, 377 unsigned int image_id, 378 uintptr_t image_base, 379 image_info_t *image_data, 380 entry_point_info_t *entry_point_info); 381 void reserve_mem(uintptr_t *free_base, size_t *free_size, 382 uintptr_t addr, size_t size); 383 384 #endif /* LOAD_IMAGE_V2 */ 385 386 extern const char build_message[]; 387 extern const char version_string[]; 388 389 void print_entry_point_info(const entry_point_info_t *ep_info); 390 391 #endif /*__ASSEMBLY__*/ 392 393 #endif /* __BL_COMMON_H__ */ 394