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 <common/ep_info.h> 11 #include <common/param_header.h> 12 #include <lib/utils_def.h> 13 14 #define UP U(1) 15 #define DOWN U(0) 16 17 /******************************************************************************* 18 * Constants to identify the location of a memory region in a given memory 19 * layout. 20 ******************************************************************************/ 21 #define TOP U(0x1) 22 #define BOTTOM U(0x0) 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 U(0) 29 #define IMAGE_STATE_COPIED U(1) 30 #define IMAGE_STATE_COPYING U(2) 31 #define IMAGE_STATE_AUTHENTICATED U(3) 32 #define IMAGE_STATE_EXECUTED U(4) 33 #define IMAGE_STATE_INTERRUPTED U(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 U(0x0) 44 #define IRQ_SP_EL0 U(0x1) 45 #define FIQ_SP_EL0 U(0x2) 46 #define SERROR_SP_EL0 U(0x3) 47 #define SYNC_EXCEPTION_SP_ELX U(0x4) 48 #define IRQ_SP_ELX U(0x5) 49 #define FIQ_SP_ELX U(0x6) 50 #define SERROR_SP_ELX U(0x7) 51 #define SYNC_EXCEPTION_AARCH64 U(0x8) 52 #define IRQ_AARCH64 U(0x9) 53 #define FIQ_AARCH64 U(0xa) 54 #define SERROR_AARCH64 U(0xb) 55 #define SYNC_EXCEPTION_AARCH32 U(0xc) 56 #define IRQ_AARCH32 U(0xd) 57 #define FIQ_AARCH32 U(0xe) 58 #define SERROR_AARCH32 U(0xf) 59 60 #ifndef __ASSEMBLY__ 61 62 #include <stddef.h> 63 #include <stdint.h> 64 65 #include <lib/cassert.h> 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_BL1) 82 IMPORT_SYM(uintptr_t, __BL1_ROM_END__, BL1_ROM_END); 83 84 IMPORT_SYM(uintptr_t, __BL1_RAM_START__, BL1_RAM_BASE); 85 IMPORT_SYM(uintptr_t, __BL1_RAM_END__, BL1_RAM_LIMIT); 86 #elif defined(IMAGE_BL2) 87 IMPORT_SYM(unsigned long, __BL2_END__, BL2_END); 88 #elif defined(IMAGE_BL2U) 89 IMPORT_SYM(unsigned long, __BL2U_END__, BL2U_END); 90 #elif defined(IMAGE_BL31) 91 IMPORT_SYM(unsigned long, __BL31_START__, BL31_START); 92 IMPORT_SYM(unsigned long, __BL31_END__, BL31_END); 93 #elif defined(IMAGE_BL32) 94 IMPORT_SYM(unsigned long, __BL32_END__, BL32_END); 95 #endif /* IMAGE_BLX */ 96 97 /* The following symbols are only exported from the BL2 at EL3 linker script. */ 98 #if BL2_IN_XIP_MEM && defined(IMAGE_BL2) 99 extern uintptr_t __BL2_ROM_END__; 100 #define BL2_ROM_END (uintptr_t)(&__BL2_ROM_END__) 101 102 extern uintptr_t __BL2_RAM_START__; 103 extern uintptr_t __BL2_RAM_END__; 104 #define BL2_RAM_BASE (uintptr_t)(&__BL2_RAM_START__) 105 #define BL2_RAM_LIMIT (uintptr_t)(&__BL2_RAM_END__) 106 #endif /* BL2_IN_XIP_MEM */ 107 108 /* 109 * The next 2 constants identify the extents of the coherent memory region. 110 * These addresses are used by the MMU setup code and therefore they must be 111 * page-aligned. It is the responsibility of the linker script to ensure that 112 * __COHERENT_RAM_START__ and __COHERENT_RAM_END__ linker symbols refer to 113 * page-aligned addresses. 114 */ 115 #if USE_COHERENT_MEM 116 IMPORT_SYM(unsigned long, __COHERENT_RAM_START__, BL_COHERENT_RAM_BASE); 117 IMPORT_SYM(unsigned long, __COHERENT_RAM_END__, BL_COHERENT_RAM_END); 118 #endif 119 120 /******************************************************************************* 121 * Structure used for telling the next BL how much of a particular type of 122 * memory is available for its use and how much is already used. 123 ******************************************************************************/ 124 typedef struct meminfo { 125 uintptr_t total_base; 126 size_t total_size; 127 } meminfo_t; 128 129 /***************************************************************************** 130 * Image info binary provides information from the image loader that 131 * can be used by the firmware to manage available trusted RAM. 132 * More advanced firmware image formats can provide additional 133 * information that enables optimization or greater flexibility in the 134 * common firmware code 135 *****************************************************************************/ 136 typedef struct image_info { 137 param_header_t h; 138 uintptr_t image_base; /* physical address of base of image */ 139 uint32_t image_size; /* bytes read from image file */ 140 uint32_t image_max_size; 141 } image_info_t; 142 143 /***************************************************************************** 144 * The image descriptor struct definition. 145 *****************************************************************************/ 146 typedef struct image_desc { 147 /* Contains unique image id for the image. */ 148 unsigned int image_id; 149 /* 150 * This member contains Image state information. 151 * Refer IMAGE_STATE_XXX defined above. 152 */ 153 unsigned int state; 154 uint32_t copied_size; /* image size copied in blocks */ 155 image_info_t image_info; 156 entry_point_info_t ep_info; 157 } image_desc_t; 158 159 /* BL image node in the BL image loading sequence */ 160 typedef struct bl_load_info_node { 161 unsigned int image_id; 162 image_info_t *image_info; 163 struct bl_load_info_node *next_load_info; 164 } bl_load_info_node_t; 165 166 /* BL image head node in the BL image loading sequence */ 167 typedef struct bl_load_info { 168 param_header_t h; 169 bl_load_info_node_t *head; 170 } bl_load_info_t; 171 172 /* BL image node in the BL image execution sequence */ 173 typedef struct bl_params_node { 174 unsigned int image_id; 175 image_info_t *image_info; 176 entry_point_info_t *ep_info; 177 struct bl_params_node *next_params_info; 178 } bl_params_node_t; 179 180 /* 181 * BL image head node in the BL image execution sequence 182 * It is also used to pass information to next BL image. 183 */ 184 typedef struct bl_params { 185 param_header_t h; 186 bl_params_node_t *head; 187 } bl_params_t; 188 189 /******************************************************************************* 190 * Function & variable prototypes 191 ******************************************************************************/ 192 size_t get_image_size(unsigned int image_id); 193 194 int is_mem_free(uintptr_t free_base, size_t free_size, 195 uintptr_t addr, size_t size); 196 197 int load_auth_image(unsigned int image_id, image_info_t *image_data); 198 199 #if TRUSTED_BOARD_BOOT && defined(DYN_DISABLE_AUTH) 200 /* 201 * API to dynamically disable authentication. Only meant for development 202 * systems. 203 */ 204 void dyn_disable_auth(void); 205 #endif 206 207 extern const char build_message[]; 208 extern const char version_string[]; 209 210 void print_entry_point_info(const entry_point_info_t *ep_info); 211 uintptr_t page_align(uintptr_t value, unsigned dir); 212 213 struct mmap_region; 214 215 void setup_page_tables(const struct mmap_region *bl_regions, 216 const struct mmap_region *plat_regions); 217 218 #endif /*__ASSEMBLY__*/ 219 220 #endif /* BL_COMMON_H */ 221