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