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 <types.h> 65 #include <utils_def.h> /* To retain compatibility */ 66 67 68 /* 69 * Declarations of linker defined symbols to help determine memory layout of 70 * BL images 71 */ 72 #if SEPARATE_CODE_AND_RODATA 73 IMPORT_SYM(unsigned long, __TEXT_START__, BL_CODE_BASE); 74 IMPORT_SYM(unsigned long, __TEXT_END__, BL_CODE_END); 75 IMPORT_SYM(unsigned long, __RODATA_START__, BL_RO_DATA_BASE); 76 IMPORT_SYM(unsigned long, __RODATA_END__, BL_RO_DATA_END); 77 #else 78 IMPORT_SYM(unsigned long, __RO_START__, BL_CODE_BASE); 79 IMPORT_SYM(unsigned long, __RO_END__, BL_CODE_END); 80 #endif 81 82 #if defined(IMAGE_BL2) 83 IMPORT_SYM(unsigned long, __BL2_END__, BL2_END); 84 #elif defined(IMAGE_BL2U) 85 IMPORT_SYM(unsigned long, __BL2U_END__, BL2U_END); 86 #elif defined(IMAGE_BL31) 87 IMPORT_SYM(unsigned long, __BL31_END__, BL31_END); 88 #elif defined(IMAGE_BL32) 89 IMPORT_SYM(unsigned long, __BL32_END__, BL32_END); 90 #endif /* IMAGE_BLX */ 91 92 /* 93 * The next 2 constants identify the extents of the coherent memory region. 94 * These addresses are used by the MMU setup code and therefore they must be 95 * page-aligned. It is the responsibility of the linker script to ensure that 96 * __COHERENT_RAM_START__ and __COHERENT_RAM_END__ linker symbols refer to 97 * page-aligned addresses. 98 */ 99 #if USE_COHERENT_MEM 100 IMPORT_SYM(unsigned long, __COHERENT_RAM_START__, BL_COHERENT_RAM_BASE); 101 IMPORT_SYM(unsigned long, __COHERENT_RAM_END__, BL_COHERENT_RAM_END); 102 #endif 103 104 /******************************************************************************* 105 * Structure used for telling the next BL how much of a particular type of 106 * memory is available for its use and how much is already used. 107 ******************************************************************************/ 108 typedef struct meminfo { 109 uintptr_t total_base; 110 size_t total_size; 111 #if !LOAD_IMAGE_V2 112 uintptr_t free_base; 113 size_t free_size; 114 #endif 115 } meminfo_t; 116 117 /***************************************************************************** 118 * Image info binary provides information from the image loader that 119 * can be used by the firmware to manage available trusted RAM. 120 * More advanced firmware image formats can provide additional 121 * information that enables optimization or greater flexibility in the 122 * common firmware code 123 *****************************************************************************/ 124 typedef struct image_info { 125 param_header_t h; 126 uintptr_t image_base; /* physical address of base of image */ 127 uint32_t image_size; /* bytes read from image file */ 128 #if LOAD_IMAGE_V2 129 uint32_t image_max_size; 130 #endif 131 } image_info_t; 132 133 /***************************************************************************** 134 * The image descriptor struct definition. 135 *****************************************************************************/ 136 typedef struct image_desc { 137 /* Contains unique image id for the image. */ 138 unsigned int image_id; 139 /* 140 * This member contains Image state information. 141 * Refer IMAGE_STATE_XXX defined above. 142 */ 143 unsigned int state; 144 uint32_t copied_size; /* image size copied in blocks */ 145 image_info_t image_info; 146 entry_point_info_t ep_info; 147 } image_desc_t; 148 149 #if LOAD_IMAGE_V2 150 /* BL image node in the BL image loading sequence */ 151 typedef struct bl_load_info_node { 152 unsigned int image_id; 153 image_info_t *image_info; 154 struct bl_load_info_node *next_load_info; 155 } bl_load_info_node_t; 156 157 /* BL image head node in the BL image loading sequence */ 158 typedef struct bl_load_info { 159 param_header_t h; 160 bl_load_info_node_t *head; 161 } bl_load_info_t; 162 163 /* BL image node in the BL image execution sequence */ 164 typedef struct bl_params_node { 165 unsigned int image_id; 166 image_info_t *image_info; 167 entry_point_info_t *ep_info; 168 struct bl_params_node *next_params_info; 169 } bl_params_node_t; 170 171 /* 172 * BL image head node in the BL image execution sequence 173 * It is also used to pass information to next BL image. 174 */ 175 typedef struct bl_params { 176 param_header_t h; 177 bl_params_node_t *head; 178 } bl_params_t; 179 180 #else /* LOAD_IMAGE_V2 */ 181 182 /******************************************************************************* 183 * This structure represents the superset of information that can be passed to 184 * BL31 e.g. while passing control to it from BL2. The BL32 parameters will be 185 * populated only if BL2 detects its presence. A pointer to a structure of this 186 * type should be passed in X0 to BL31's cold boot entrypoint. 187 * 188 * Use of this structure and the X0 parameter is not mandatory: the BL31 189 * platform code can use other mechanisms to provide the necessary information 190 * about BL32 and BL33 to the common and SPD code. 191 * 192 * BL31 image information is mandatory if this structure is used. If either of 193 * the optional BL32 and BL33 image information is not provided, this is 194 * indicated by the respective image_info pointers being zero. 195 ******************************************************************************/ 196 typedef struct bl31_params { 197 param_header_t h; 198 image_info_t *bl31_image_info; 199 entry_point_info_t *bl32_ep_info; 200 image_info_t *bl32_image_info; 201 entry_point_info_t *bl33_ep_info; 202 image_info_t *bl33_image_info; 203 } bl31_params_t; 204 205 #endif /* LOAD_IMAGE_V2 */ 206 207 /******************************************************************************* 208 * Function & variable prototypes 209 ******************************************************************************/ 210 size_t get_image_size(unsigned int image_id); 211 212 int is_mem_free(uintptr_t free_base, size_t free_size, 213 uintptr_t addr, size_t size); 214 215 #if LOAD_IMAGE_V2 216 217 int load_auth_image(unsigned int image_id, image_info_t *image_data); 218 219 #else 220 221 int load_image(meminfo_t *mem_layout, 222 unsigned int image_id, 223 uintptr_t image_base, 224 image_info_t *image_data, 225 entry_point_info_t *entry_point_info); 226 int load_auth_image(meminfo_t *mem_layout, 227 unsigned int image_id, 228 uintptr_t image_base, 229 image_info_t *image_data, 230 entry_point_info_t *entry_point_info); 231 void reserve_mem(uintptr_t *free_base, size_t *free_size, 232 uintptr_t addr, size_t size); 233 234 #endif /* LOAD_IMAGE_V2 */ 235 236 #if TRUSTED_BOARD_BOOT && defined(DYN_DISABLE_AUTH) 237 /* 238 * API to dynamically disable authentication. Only meant for development 239 * systems. 240 */ 241 void dyn_disable_auth(void); 242 #endif 243 244 extern const char build_message[]; 245 extern const char version_string[]; 246 247 void print_entry_point_info(const entry_point_info_t *ep_info); 248 uintptr_t page_align(uintptr_t value, unsigned dir); 249 250 #endif /*__ASSEMBLY__*/ 251 252 #endif /* __BL_COMMON_H__ */ 253