1 /* 2 * Copyright (c) 2013-2018, ARM Limited and Contributors. All rights reserved. 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 */ 6 7 #ifndef __BL_COMMON_H__ 8 #define __BL_COMMON_H__ 9 10 #include <ep_info.h> 11 #include <param_header.h> 12 #include <utils_def.h> 13 14 #define UP 1 15 #define DOWN 0 16 17 /******************************************************************************* 18 * Constants to identify the location of a memory region in a given memory 19 * layout. 20 ******************************************************************************/ 21 #define TOP 0x1 22 #define BOTTOM !TOP 23 24 /* 25 * The following are used for image state attributes. 26 * Image can only be in one of the following state. 27 */ 28 #define IMAGE_STATE_RESET 0 29 #define IMAGE_STATE_COPIED 1 30 #define IMAGE_STATE_COPYING 2 31 #define IMAGE_STATE_AUTHENTICATED 3 32 #define IMAGE_STATE_EXECUTED 4 33 #define IMAGE_STATE_INTERRUPTED 5 34 35 #define IMAGE_ATTRIB_SKIP_LOADING U(0x02) 36 #define IMAGE_ATTRIB_PLAT_SETUP U(0x04) 37 38 #define INVALID_IMAGE_ID U(0xFFFFFFFF) 39 40 /******************************************************************************* 41 * Constants to indicate type of exception to the common exception handler. 42 ******************************************************************************/ 43 #define SYNC_EXCEPTION_SP_EL0 0x0 44 #define IRQ_SP_EL0 0x1 45 #define FIQ_SP_EL0 0x2 46 #define SERROR_SP_EL0 0x3 47 #define SYNC_EXCEPTION_SP_ELX 0x4 48 #define IRQ_SP_ELX 0x5 49 #define FIQ_SP_ELX 0x6 50 #define SERROR_SP_ELX 0x7 51 #define SYNC_EXCEPTION_AARCH64 0x8 52 #define IRQ_AARCH64 0x9 53 #define FIQ_AARCH64 0xa 54 #define SERROR_AARCH64 0xb 55 #define SYNC_EXCEPTION_AARCH32 0xc 56 #define IRQ_AARCH32 0xd 57 #define FIQ_AARCH32 0xe 58 #define SERROR_AARCH32 0xf 59 60 #ifndef __ASSEMBLY__ 61 #include <cassert.h> 62 #include <stddef.h> 63 #include <stdint.h> 64 #include <utils_def.h> /* To retain compatibility */ 65 66 67 /* 68 * Declarations of linker defined symbols to help determine memory layout of 69 * BL images 70 */ 71 #if SEPARATE_CODE_AND_RODATA 72 IMPORT_SYM(unsigned long, __TEXT_START__, BL_CODE_BASE); 73 IMPORT_SYM(unsigned long, __TEXT_END__, BL_CODE_END); 74 IMPORT_SYM(unsigned long, __RODATA_START__, BL_RO_DATA_BASE); 75 IMPORT_SYM(unsigned long, __RODATA_END__, BL_RO_DATA_END); 76 #else 77 IMPORT_SYM(unsigned long, __RO_START__, BL_CODE_BASE); 78 IMPORT_SYM(unsigned long, __RO_END__, BL_CODE_END); 79 #endif 80 81 #if defined(IMAGE_BL2) 82 IMPORT_SYM(unsigned long, __BL2_END__, BL2_END); 83 #elif defined(IMAGE_BL2U) 84 IMPORT_SYM(unsigned long, __BL2U_END__, BL2U_END); 85 #elif defined(IMAGE_BL31) 86 IMPORT_SYM(unsigned long, __BL31_END__, BL31_END); 87 #elif defined(IMAGE_BL32) 88 IMPORT_SYM(unsigned long, __BL32_END__, BL32_END); 89 #endif /* IMAGE_BLX */ 90 91 /* 92 * The next 2 constants identify the extents of the coherent memory region. 93 * These addresses are used by the MMU setup code and therefore they must be 94 * page-aligned. It is the responsibility of the linker script to ensure that 95 * __COHERENT_RAM_START__ and __COHERENT_RAM_END__ linker symbols refer to 96 * page-aligned addresses. 97 */ 98 #if USE_COHERENT_MEM 99 IMPORT_SYM(unsigned long, __COHERENT_RAM_START__, BL_COHERENT_RAM_BASE); 100 IMPORT_SYM(unsigned long, __COHERENT_RAM_END__, BL_COHERENT_RAM_END); 101 #endif 102 103 /******************************************************************************* 104 * Structure used for telling the next BL how much of a particular type of 105 * memory is available for its use and how much is already used. 106 ******************************************************************************/ 107 typedef struct meminfo { 108 uintptr_t total_base; 109 size_t total_size; 110 #if !LOAD_IMAGE_V2 111 uintptr_t free_base; 112 size_t free_size; 113 #endif 114 } meminfo_t; 115 116 /***************************************************************************** 117 * Image info binary provides information from the image loader that 118 * can be used by the firmware to manage available trusted RAM. 119 * More advanced firmware image formats can provide additional 120 * information that enables optimization or greater flexibility in the 121 * common firmware code 122 *****************************************************************************/ 123 typedef struct image_info { 124 param_header_t h; 125 uintptr_t image_base; /* physical address of base of image */ 126 uint32_t image_size; /* bytes read from image file */ 127 #if LOAD_IMAGE_V2 128 uint32_t image_max_size; 129 #endif 130 } image_info_t; 131 132 /***************************************************************************** 133 * The image descriptor struct definition. 134 *****************************************************************************/ 135 typedef struct image_desc { 136 /* Contains unique image id for the image. */ 137 unsigned int image_id; 138 /* 139 * This member contains Image state information. 140 * Refer IMAGE_STATE_XXX defined above. 141 */ 142 unsigned int state; 143 uint32_t copied_size; /* image size copied in blocks */ 144 image_info_t image_info; 145 entry_point_info_t ep_info; 146 } image_desc_t; 147 148 #if LOAD_IMAGE_V2 149 /* BL image node in the BL image loading sequence */ 150 typedef struct bl_load_info_node { 151 unsigned int image_id; 152 image_info_t *image_info; 153 struct bl_load_info_node *next_load_info; 154 } bl_load_info_node_t; 155 156 /* BL image head node in the BL image loading sequence */ 157 typedef struct bl_load_info { 158 param_header_t h; 159 bl_load_info_node_t *head; 160 } bl_load_info_t; 161 162 /* BL image node in the BL image execution sequence */ 163 typedef struct bl_params_node { 164 unsigned int image_id; 165 image_info_t *image_info; 166 entry_point_info_t *ep_info; 167 struct bl_params_node *next_params_info; 168 } bl_params_node_t; 169 170 /* 171 * BL image head node in the BL image execution sequence 172 * It is also used to pass information to next BL image. 173 */ 174 typedef struct bl_params { 175 param_header_t h; 176 bl_params_node_t *head; 177 } bl_params_t; 178 179 #else /* LOAD_IMAGE_V2 */ 180 181 /******************************************************************************* 182 * This structure represents the superset of information that can be passed to 183 * BL31 e.g. while passing control to it from BL2. The BL32 parameters will be 184 * populated only if BL2 detects its presence. A pointer to a structure of this 185 * type should be passed in X0 to BL31's cold boot entrypoint. 186 * 187 * Use of this structure and the X0 parameter is not mandatory: the BL31 188 * platform code can use other mechanisms to provide the necessary information 189 * about BL32 and BL33 to the common and SPD code. 190 * 191 * BL31 image information is mandatory if this structure is used. If either of 192 * the optional BL32 and BL33 image information is not provided, this is 193 * indicated by the respective image_info pointers being zero. 194 ******************************************************************************/ 195 typedef struct bl31_params { 196 param_header_t h; 197 image_info_t *bl31_image_info; 198 entry_point_info_t *bl32_ep_info; 199 image_info_t *bl32_image_info; 200 entry_point_info_t *bl33_ep_info; 201 image_info_t *bl33_image_info; 202 } bl31_params_t; 203 204 #endif /* LOAD_IMAGE_V2 */ 205 206 /******************************************************************************* 207 * Function & variable prototypes 208 ******************************************************************************/ 209 size_t get_image_size(unsigned int image_id); 210 211 int is_mem_free(uintptr_t free_base, size_t free_size, 212 uintptr_t addr, size_t size); 213 214 #if LOAD_IMAGE_V2 215 216 int load_auth_image(unsigned int image_id, image_info_t *image_data); 217 218 #else 219 220 int load_image(meminfo_t *mem_layout, 221 unsigned int image_id, 222 uintptr_t image_base, 223 image_info_t *image_data, 224 entry_point_info_t *entry_point_info); 225 int load_auth_image(meminfo_t *mem_layout, 226 unsigned int image_id, 227 uintptr_t image_base, 228 image_info_t *image_data, 229 entry_point_info_t *entry_point_info); 230 void reserve_mem(uintptr_t *free_base, size_t *free_size, 231 uintptr_t addr, size_t size); 232 233 #endif /* LOAD_IMAGE_V2 */ 234 235 #if TRUSTED_BOARD_BOOT && defined(DYN_DISABLE_AUTH) 236 /* 237 * API to dynamically disable authentication. Only meant for development 238 * systems. 239 */ 240 void dyn_disable_auth(void); 241 #endif 242 243 extern const char build_message[]; 244 extern const char version_string[]; 245 246 void print_entry_point_info(const entry_point_info_t *ep_info); 247 uintptr_t page_align(uintptr_t value, unsigned dir); 248 249 #endif /*__ASSEMBLY__*/ 250 251 #endif /* __BL_COMMON_H__ */ 252