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