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