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 } meminfo_t; 111 112 /***************************************************************************** 113 * Image info binary provides information from the image loader that 114 * can be used by the firmware to manage available trusted RAM. 115 * More advanced firmware image formats can provide additional 116 * information that enables optimization or greater flexibility in the 117 * common firmware code 118 *****************************************************************************/ 119 typedef struct image_info { 120 param_header_t h; 121 uintptr_t image_base; /* physical address of base of image */ 122 uint32_t image_size; /* bytes read from image file */ 123 uint32_t image_max_size; 124 } image_info_t; 125 126 /***************************************************************************** 127 * The image descriptor struct definition. 128 *****************************************************************************/ 129 typedef struct image_desc { 130 /* Contains unique image id for the image. */ 131 unsigned int image_id; 132 /* 133 * This member contains Image state information. 134 * Refer IMAGE_STATE_XXX defined above. 135 */ 136 unsigned int state; 137 uint32_t copied_size; /* image size copied in blocks */ 138 image_info_t image_info; 139 entry_point_info_t ep_info; 140 } image_desc_t; 141 142 /* BL image node in the BL image loading sequence */ 143 typedef struct bl_load_info_node { 144 unsigned int image_id; 145 image_info_t *image_info; 146 struct bl_load_info_node *next_load_info; 147 } bl_load_info_node_t; 148 149 /* BL image head node in the BL image loading sequence */ 150 typedef struct bl_load_info { 151 param_header_t h; 152 bl_load_info_node_t *head; 153 } bl_load_info_t; 154 155 /* BL image node in the BL image execution sequence */ 156 typedef struct bl_params_node { 157 unsigned int image_id; 158 image_info_t *image_info; 159 entry_point_info_t *ep_info; 160 struct bl_params_node *next_params_info; 161 } bl_params_node_t; 162 163 /* 164 * BL image head node in the BL image execution sequence 165 * It is also used to pass information to next BL image. 166 */ 167 typedef struct bl_params { 168 param_header_t h; 169 bl_params_node_t *head; 170 } bl_params_t; 171 172 /******************************************************************************* 173 * Function & variable prototypes 174 ******************************************************************************/ 175 size_t get_image_size(unsigned int image_id); 176 177 int is_mem_free(uintptr_t free_base, size_t free_size, 178 uintptr_t addr, size_t size); 179 180 int load_auth_image(unsigned int image_id, image_info_t *image_data); 181 182 #if TRUSTED_BOARD_BOOT && defined(DYN_DISABLE_AUTH) 183 /* 184 * API to dynamically disable authentication. Only meant for development 185 * systems. 186 */ 187 void dyn_disable_auth(void); 188 #endif 189 190 extern const char build_message[]; 191 extern const char version_string[]; 192 193 void print_entry_point_info(const entry_point_info_t *ep_info); 194 uintptr_t page_align(uintptr_t value, unsigned dir); 195 196 #endif /*__ASSEMBLY__*/ 197 198 #endif /* __BL_COMMON_H__ */ 199