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(uintptr_t, __TEXT_START__, BL_CODE_BASE); 73 IMPORT_SYM(uintptr_t, __TEXT_END__, BL_CODE_END); 74 IMPORT_SYM(uintptr_t, __RODATA_START__, BL_RO_DATA_BASE); 75 IMPORT_SYM(uintptr_t, __RODATA_END__, BL_RO_DATA_END); 76 #else 77 IMPORT_SYM(uintptr_t, __RO_START__, BL_CODE_BASE); 78 IMPORT_SYM(uintptr_t, __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(uintptr_t, __BL2_END__, BL2_END); 88 #elif defined(IMAGE_BL2U) 89 IMPORT_SYM(uintptr_t, __BL2U_END__, BL2U_END); 90 #elif defined(IMAGE_BL31) 91 IMPORT_SYM(uintptr_t, __BL31_START__, BL31_START); 92 IMPORT_SYM(uintptr_t, __BL31_END__, BL31_END); 93 #elif defined(IMAGE_BL32) 94 IMPORT_SYM(uintptr_t, __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 IMPORT_SYM(uintptr_t, __BL2_ROM_END__, BL2_ROM_END); 100 101 IMPORT_SYM(uintptr_t, __BL2_RAM_START__, BL2_RAM_BASE); 102 IMPORT_SYM(uintptr_t, __BL2_RAM_END__, BL2_RAM_END); 103 #endif /* BL2_IN_XIP_MEM */ 104 105 /* 106 * The next 2 constants identify the extents of the coherent memory region. 107 * These addresses are used by the MMU setup code and therefore they must be 108 * page-aligned. It is the responsibility of the linker script to ensure that 109 * __COHERENT_RAM_START__ and __COHERENT_RAM_END__ linker symbols refer to 110 * page-aligned addresses. 111 */ 112 #if USE_COHERENT_MEM 113 IMPORT_SYM(uintptr_t, __COHERENT_RAM_START__, BL_COHERENT_RAM_BASE); 114 IMPORT_SYM(uintptr_t, __COHERENT_RAM_END__, BL_COHERENT_RAM_END); 115 #endif 116 117 /******************************************************************************* 118 * Structure used for telling the next BL how much of a particular type of 119 * memory is available for its use and how much is already used. 120 ******************************************************************************/ 121 typedef struct meminfo { 122 uintptr_t total_base; 123 size_t total_size; 124 } meminfo_t; 125 126 /***************************************************************************** 127 * Image info binary provides information from the image loader that 128 * can be used by the firmware to manage available trusted RAM. 129 * More advanced firmware image formats can provide additional 130 * information that enables optimization or greater flexibility in the 131 * common firmware code 132 *****************************************************************************/ 133 typedef struct image_info { 134 param_header_t h; 135 uintptr_t image_base; /* physical address of base of image */ 136 uint32_t image_size; /* bytes read from image file */ 137 uint32_t image_max_size; 138 } image_info_t; 139 140 /***************************************************************************** 141 * The image descriptor struct definition. 142 *****************************************************************************/ 143 typedef struct image_desc { 144 /* Contains unique image id for the image. */ 145 unsigned int image_id; 146 /* 147 * This member contains Image state information. 148 * Refer IMAGE_STATE_XXX defined above. 149 */ 150 unsigned int state; 151 uint32_t copied_size; /* image size copied in blocks */ 152 image_info_t image_info; 153 entry_point_info_t ep_info; 154 } image_desc_t; 155 156 /* BL image node in the BL image loading sequence */ 157 typedef struct bl_load_info_node { 158 unsigned int image_id; 159 image_info_t *image_info; 160 struct bl_load_info_node *next_load_info; 161 } bl_load_info_node_t; 162 163 /* BL image head node in the BL image loading sequence */ 164 typedef struct bl_load_info { 165 param_header_t h; 166 bl_load_info_node_t *head; 167 } bl_load_info_t; 168 169 /* BL image node in the BL image execution sequence */ 170 typedef struct bl_params_node { 171 unsigned int image_id; 172 image_info_t *image_info; 173 entry_point_info_t *ep_info; 174 struct bl_params_node *next_params_info; 175 } bl_params_node_t; 176 177 /* 178 * BL image head node in the BL image execution sequence 179 * It is also used to pass information to next BL image. 180 */ 181 typedef struct bl_params { 182 param_header_t h; 183 bl_params_node_t *head; 184 } bl_params_t; 185 186 /******************************************************************************* 187 * Function & variable prototypes 188 ******************************************************************************/ 189 int load_auth_image(unsigned int image_id, image_info_t *image_data); 190 191 #if TRUSTED_BOARD_BOOT && defined(DYN_DISABLE_AUTH) 192 /* 193 * API to dynamically disable authentication. Only meant for development 194 * systems. 195 */ 196 void dyn_disable_auth(void); 197 #endif 198 199 extern const char build_message[]; 200 extern const char version_string[]; 201 202 void print_entry_point_info(const entry_point_info_t *ep_info); 203 uintptr_t page_align(uintptr_t value, unsigned dir); 204 205 struct mmap_region; 206 207 void setup_page_tables(const struct mmap_region *bl_regions, 208 const struct mmap_region *plat_regions); 209 210 #endif /*__ASSEMBLY__*/ 211 212 #endif /* BL_COMMON_H */ 213