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