Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 1 | /* |
Roberto Vargas | 9fb8af3 | 2018-02-12 12:36:17 +0000 | [diff] [blame] | 2 | * Copyright (c) 2013-2018, ARM Limited and Contributors. All rights reserved. |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 3 | * |
dp-arm | 82cb2c1 | 2017-05-03 09:38:09 +0100 | [diff] [blame] | 4 | * SPDX-License-Identifier: BSD-3-Clause |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 5 | */ |
| 6 | |
| 7 | #ifndef __BL_COMMON_H__ |
| 8 | #define __BL_COMMON_H__ |
| 9 | |
Soby Mathew | 5dffb46 | 2017-02-13 12:46:28 +0000 | [diff] [blame] | 10 | #include <ep_info.h> |
| 11 | #include <param_header.h> |
Soby Mathew | da5f274 | 2018-02-21 01:16:39 +0000 | [diff] [blame] | 12 | #include <utils_def.h> |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 13 | |
| 14 | #define UP 1 |
| 15 | #define DOWN 0 |
| 16 | |
| 17 | /******************************************************************************* |
Sandrine Bailleux | 8f55dfb | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 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 |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 23 | |
Yatharth Kochar | 7baff11 | 2015-10-09 18:06:13 +0100 | [diff] [blame] | 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 | |
Soby Mathew | da5f274 | 2018-02-21 01:16:39 +0000 | [diff] [blame] | 35 | #define IMAGE_ATTRIB_SKIP_LOADING U(0x02) |
| 36 | #define IMAGE_ATTRIB_PLAT_SETUP U(0x04) |
Yatharth Kochar | 843ddee | 2016-02-01 11:04:46 +0000 | [diff] [blame] | 37 | |
Soby Mathew | da5f274 | 2018-02-21 01:16:39 +0000 | [diff] [blame] | 38 | #define INVALID_IMAGE_ID U(0xFFFFFFFF) |
Yatharth Kochar | 7baff11 | 2015-10-09 18:06:13 +0100 | [diff] [blame] | 39 | |
Yatharth Kochar | bbf8f6f | 2015-10-02 17:56:48 +0100 | [diff] [blame] | 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 | |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 60 | #ifndef __ASSEMBLY__ |
Vikram Kanigiri | 29fb905 | 2014-05-15 18:27:15 +0100 | [diff] [blame] | 61 | #include <cassert.h> |
Sandrine Bailleux | 8f55dfb | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 62 | #include <stddef.h> |
Soby Mathew | 5dffb46 | 2017-02-13 12:46:28 +0000 | [diff] [blame] | 63 | #include <stdint.h> |
Soby Mathew | 4c0d039 | 2016-06-16 14:52:04 +0100 | [diff] [blame] | 64 | #include <types.h> |
Scott Branden | 53d9c9c | 2017-04-10 11:45:52 -0700 | [diff] [blame] | 65 | #include <utils_def.h> /* To retain compatibility */ |
Vikram Kanigiri | a7e98ad | 2015-03-04 10:34:27 +0000 | [diff] [blame] | 66 | |
Joel Hutton | 9f85f9e | 2018-03-21 11:40:57 +0000 | [diff] [blame] | 67 | |
Dan Handley | 90b3a6a | 2015-04-27 11:49:22 +0100 | [diff] [blame] | 68 | /* |
| 69 | * Declarations of linker defined symbols to help determine memory layout of |
| 70 | * BL images |
| 71 | */ |
Sandrine Bailleux | 5d1c104 | 2016-07-08 14:37:40 +0100 | [diff] [blame] | 72 | #if SEPARATE_CODE_AND_RODATA |
Joel Hutton | 9f85f9e | 2018-03-21 11:40:57 +0000 | [diff] [blame] | 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); |
Sandrine Bailleux | 5d1c104 | 2016-07-08 14:37:40 +0100 | [diff] [blame] | 77 | #else |
Joel Hutton | 9f85f9e | 2018-03-21 11:40:57 +0000 | [diff] [blame] | 78 | IMPORT_SYM(unsigned long, __RO_START__, BL_CODE_BASE); |
| 79 | IMPORT_SYM(unsigned long, __RO_END__, BL_CODE_END); |
Sandrine Bailleux | 5d1c104 | 2016-07-08 14:37:40 +0100 | [diff] [blame] | 80 | #endif |
| 81 | |
Masahiro Yamada | 3d8256b | 2016-12-25 23:36:24 +0900 | [diff] [blame] | 82 | #if defined(IMAGE_BL2) |
Joel Hutton | 9f85f9e | 2018-03-21 11:40:57 +0000 | [diff] [blame] | 83 | IMPORT_SYM(unsigned long, __BL2_END__, BL2_END); |
Masahiro Yamada | 3d8256b | 2016-12-25 23:36:24 +0900 | [diff] [blame] | 84 | #elif defined(IMAGE_BL2U) |
Joel Hutton | 9f85f9e | 2018-03-21 11:40:57 +0000 | [diff] [blame] | 85 | IMPORT_SYM(unsigned long, __BL2U_END__, BL2U_END); |
Masahiro Yamada | 3d8256b | 2016-12-25 23:36:24 +0900 | [diff] [blame] | 86 | #elif defined(IMAGE_BL31) |
Joel Hutton | 9f85f9e | 2018-03-21 11:40:57 +0000 | [diff] [blame] | 87 | IMPORT_SYM(unsigned long, __BL31_END__, BL31_END); |
Masahiro Yamada | 3d8256b | 2016-12-25 23:36:24 +0900 | [diff] [blame] | 88 | #elif defined(IMAGE_BL32) |
Joel Hutton | 9f85f9e | 2018-03-21 11:40:57 +0000 | [diff] [blame] | 89 | IMPORT_SYM(unsigned long, __BL32_END__, BL32_END); |
Dan Handley | 90b3a6a | 2015-04-27 11:49:22 +0100 | [diff] [blame] | 90 | #endif /* IMAGE_BLX */ |
| 91 | |
Joel Hutton | 9f85f9e | 2018-03-21 11:40:57 +0000 | [diff] [blame] | 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 | */ |
Dan Handley | 90b3a6a | 2015-04-27 11:49:22 +0100 | [diff] [blame] | 99 | #if USE_COHERENT_MEM |
Joel Hutton | 9f85f9e | 2018-03-21 11:40:57 +0000 | [diff] [blame] | 100 | IMPORT_SYM(unsigned long, __COHERENT_RAM_START__, BL_COHERENT_RAM_BASE); |
| 101 | IMPORT_SYM(unsigned long, __COHERENT_RAM_END__, BL_COHERENT_RAM_END); |
Dan Handley | 90b3a6a | 2015-04-27 11:49:22 +0100 | [diff] [blame] | 102 | #endif |
| 103 | |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 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 | ******************************************************************************/ |
Dan Handley | fb037bf | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 108 | typedef struct meminfo { |
Soby Mathew | 4c0d039 | 2016-06-16 14:52:04 +0100 | [diff] [blame] | 109 | uintptr_t total_base; |
Sandrine Bailleux | 8f55dfb | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 110 | size_t total_size; |
Yatharth Kochar | 7260022 | 2016-09-12 16:08:41 +0100 | [diff] [blame] | 111 | #if !LOAD_IMAGE_V2 |
Soby Mathew | 4c0d039 | 2016-06-16 14:52:04 +0100 | [diff] [blame] | 112 | uintptr_t free_base; |
Sandrine Bailleux | 8f55dfb | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 113 | size_t free_size; |
Yatharth Kochar | 7260022 | 2016-09-12 16:08:41 +0100 | [diff] [blame] | 114 | #endif |
Dan Handley | fb037bf | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 115 | } meminfo_t; |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 116 | |
Vikram Kanigiri | 4112bfa | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 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 */ |
Yatharth Kochar | 7260022 | 2016-09-12 16:08:41 +0100 | [diff] [blame] | 128 | #if LOAD_IMAGE_V2 |
| 129 | uint32_t image_max_size; |
| 130 | #endif |
Vikram Kanigiri | 4112bfa | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 131 | } image_info_t; |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 132 | |
Yatharth Kochar | 7baff11 | 2015-10-09 18:06:13 +0100 | [diff] [blame] | 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; |
Yatharth Kochar | 7baff11 | 2015-10-09 18:06:13 +0100 | [diff] [blame] | 139 | /* |
| 140 | * This member contains Image state information. |
| 141 | * Refer IMAGE_STATE_XXX defined above. |
| 142 | */ |
| 143 | unsigned int state; |
Yatharth Kochar | 843ddee | 2016-02-01 11:04:46 +0000 | [diff] [blame] | 144 | uint32_t copied_size; /* image size copied in blocks */ |
Soby Mathew | b313d75 | 2016-01-12 10:30:59 +0000 | [diff] [blame] | 145 | image_info_t image_info; |
| 146 | entry_point_info_t ep_info; |
Yatharth Kochar | 7baff11 | 2015-10-09 18:06:13 +0100 | [diff] [blame] | 147 | } image_desc_t; |
| 148 | |
Yatharth Kochar | 7260022 | 2016-09-12 16:08:41 +0100 | [diff] [blame] | 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 | |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 182 | /******************************************************************************* |
Achin Gupta | e4d084e | 2014-02-19 17:18:23 +0000 | [diff] [blame] | 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 |
Vikram Kanigiri | 4112bfa | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 185 | * populated only if BL2 detects its presence. A pointer to a structure of this |
Juan Castillo | d178637 | 2015-12-14 09:35:25 +0000 | [diff] [blame] | 186 | * type should be passed in X0 to BL31's cold boot entrypoint. |
Vikram Kanigiri | 4112bfa | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 187 | * |
Juan Castillo | d178637 | 2015-12-14 09:35:25 +0000 | [diff] [blame] | 188 | * Use of this structure and the X0 parameter is not mandatory: the BL31 |
Vikram Kanigiri | 4112bfa | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 189 | * platform code can use other mechanisms to provide the necessary information |
Juan Castillo | d178637 | 2015-12-14 09:35:25 +0000 | [diff] [blame] | 190 | * about BL32 and BL33 to the common and SPD code. |
Vikram Kanigiri | 4112bfa | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 191 | * |
Juan Castillo | d178637 | 2015-12-14 09:35:25 +0000 | [diff] [blame] | 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 |
Vikram Kanigiri | 4112bfa | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 194 | * indicated by the respective image_info pointers being zero. |
Achin Gupta | e4d084e | 2014-02-19 17:18:23 +0000 | [diff] [blame] | 195 | ******************************************************************************/ |
Vikram Kanigiri | 4112bfa | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 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 | |
Yatharth Kochar | 7260022 | 2016-09-12 16:08:41 +0100 | [diff] [blame] | 205 | #endif /* LOAD_IMAGE_V2 */ |
Vikram Kanigiri | 4112bfa | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 206 | |
Achin Gupta | e4d084e | 2014-02-19 17:18:23 +0000 | [diff] [blame] | 207 | /******************************************************************************* |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 208 | * Function & variable prototypes |
| 209 | ******************************************************************************/ |
Daniel Boulby | d3775d4 | 2018-05-04 11:18:26 +0100 | [diff] [blame] | 210 | size_t get_image_size(unsigned int image_id); |
Yatharth Kochar | 7260022 | 2016-09-12 16:08:41 +0100 | [diff] [blame] | 211 | |
Sandrine Bailleux | 99c5eba | 2016-11-08 14:27:10 +0000 | [diff] [blame] | 212 | int is_mem_free(uintptr_t free_base, size_t free_size, |
| 213 | uintptr_t addr, size_t size); |
| 214 | |
Yatharth Kochar | 7260022 | 2016-09-12 16:08:41 +0100 | [diff] [blame] | 215 | #if LOAD_IMAGE_V2 |
| 216 | |
Yatharth Kochar | 7260022 | 2016-09-12 16:08:41 +0100 | [diff] [blame] | 217 | int load_auth_image(unsigned int image_id, image_info_t *image_data); |
| 218 | |
| 219 | #else |
| 220 | |
Sandrine Bailleux | 8f55dfb | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 221 | int load_image(meminfo_t *mem_layout, |
Juan Castillo | 16948ae | 2015-04-13 17:36:19 +0100 | [diff] [blame] | 222 | unsigned int image_id, |
Juan Castillo | 1779ba6 | 2015-05-19 11:54:12 +0100 | [diff] [blame] | 223 | uintptr_t image_base, |
Sandrine Bailleux | 8f55dfb | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 224 | image_info_t *image_data, |
| 225 | entry_point_info_t *entry_point_info); |
Juan Castillo | 1779ba6 | 2015-05-19 11:54:12 +0100 | [diff] [blame] | 226 | int load_auth_image(meminfo_t *mem_layout, |
Yatharth Kochar | 7260022 | 2016-09-12 16:08:41 +0100 | [diff] [blame] | 227 | unsigned int image_id, |
Juan Castillo | 1779ba6 | 2015-05-19 11:54:12 +0100 | [diff] [blame] | 228 | uintptr_t image_base, |
| 229 | image_info_t *image_data, |
| 230 | entry_point_info_t *entry_point_info); |
Soby Mathew | 4c0d039 | 2016-06-16 14:52:04 +0100 | [diff] [blame] | 231 | void reserve_mem(uintptr_t *free_base, size_t *free_size, |
| 232 | uintptr_t addr, size_t size); |
Sandrine Bailleux | 8f55dfb | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 233 | |
Yatharth Kochar | 7260022 | 2016-09-12 16:08:41 +0100 | [diff] [blame] | 234 | #endif /* LOAD_IMAGE_V2 */ |
| 235 | |
Soby Mathew | 209a60c | 2018-03-26 12:43:37 +0100 | [diff] [blame] | 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 | |
Yatharth Kochar | 7260022 | 2016-09-12 16:08:41 +0100 | [diff] [blame] | 244 | extern const char build_message[]; |
| 245 | extern const char version_string[]; |
| 246 | |
Sandrine Bailleux | 68a68c9 | 2015-09-28 17:03:06 +0100 | [diff] [blame] | 247 | void print_entry_point_info(const entry_point_info_t *ep_info); |
Roberto Vargas | 1af540e | 2018-02-12 12:36:17 +0000 | [diff] [blame] | 248 | uintptr_t page_align(uintptr_t value, unsigned dir); |
Sandrine Bailleux | 68a68c9 | 2015-09-28 17:03:06 +0100 | [diff] [blame] | 249 | |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 250 | #endif /*__ASSEMBLY__*/ |
| 251 | |
| 252 | #endif /* __BL_COMMON_H__ */ |