1 /* 2 * Copyright (c) 2013-2020, ARM Limited and Contributors. All rights reserved. 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 */ 6 7 #ifndef PLATFORM_H 8 #define PLATFORM_H 9 10 #include <stdint.h> 11 12 #include <lib/psci/psci.h> 13 #if defined(SPD_spmd) 14 #include <services/spm_core_manifest.h> 15 #endif 16 17 /******************************************************************************* 18 * Forward declarations 19 ******************************************************************************/ 20 struct auth_img_desc_s; 21 struct meminfo; 22 struct image_info; 23 struct entry_point_info; 24 struct image_desc; 25 struct bl_load_info; 26 struct bl_params; 27 struct mmap_region; 28 struct spm_mm_boot_info; 29 struct sp_res_desc; 30 31 /******************************************************************************* 32 * plat_get_rotpk_info() flags 33 ******************************************************************************/ 34 #define ROTPK_IS_HASH (1 << 0) 35 /* Flag used to skip verification of the certificate ROTPK while the platform 36 ROTPK is not deployed */ 37 #define ROTPK_NOT_DEPLOYED (1 << 1) 38 39 /******************************************************************************* 40 * plat_get_enc_key_info() flags 41 ******************************************************************************/ 42 /* 43 * Flag used to notify caller that information provided in key buffer is an 44 * identifier rather than an actual key. 45 */ 46 #define ENC_KEY_IS_IDENTIFIER (1 << 0) 47 48 /******************************************************************************* 49 * Function declarations 50 ******************************************************************************/ 51 /******************************************************************************* 52 * Mandatory common functions 53 ******************************************************************************/ 54 unsigned int plat_get_syscnt_freq2(void); 55 56 int plat_get_image_source(unsigned int image_id, 57 uintptr_t *dev_handle, 58 uintptr_t *image_spec); 59 uintptr_t plat_get_ns_image_entrypoint(void); 60 unsigned int plat_my_core_pos(void); 61 int plat_core_pos_by_mpidr(u_register_t mpidr); 62 int plat_get_mbedtls_heap(void **heap_addr, size_t *heap_size); 63 64 #if STACK_PROTECTOR_ENABLED 65 /* 66 * Return a new value to be used for the stack protection's canary. 67 * 68 * Ideally, this value is a random number that is impossible to predict by an 69 * attacker. 70 */ 71 u_register_t plat_get_stack_protector_canary(void); 72 #endif /* STACK_PROTECTOR_ENABLED */ 73 74 /******************************************************************************* 75 * Mandatory interrupt management functions 76 ******************************************************************************/ 77 uint32_t plat_ic_get_pending_interrupt_id(void); 78 uint32_t plat_ic_get_pending_interrupt_type(void); 79 uint32_t plat_ic_acknowledge_interrupt(void); 80 uint32_t plat_ic_get_interrupt_type(uint32_t id); 81 void plat_ic_end_of_interrupt(uint32_t id); 82 uint32_t plat_interrupt_type_to_line(uint32_t type, 83 uint32_t security_state); 84 85 /******************************************************************************* 86 * Optional interrupt management functions, depending on chosen EL3 components. 87 ******************************************************************************/ 88 unsigned int plat_ic_get_running_priority(void); 89 int plat_ic_is_spi(unsigned int id); 90 int plat_ic_is_ppi(unsigned int id); 91 int plat_ic_is_sgi(unsigned int id); 92 unsigned int plat_ic_get_interrupt_active(unsigned int id); 93 void plat_ic_disable_interrupt(unsigned int id); 94 void plat_ic_enable_interrupt(unsigned int id); 95 int plat_ic_has_interrupt_type(unsigned int type); 96 void plat_ic_set_interrupt_type(unsigned int id, unsigned int type); 97 void plat_ic_set_interrupt_priority(unsigned int id, unsigned int priority); 98 void plat_ic_raise_el3_sgi(int sgi_num, u_register_t target); 99 void plat_ic_set_spi_routing(unsigned int id, unsigned int routing_mode, 100 u_register_t mpidr); 101 void plat_ic_set_interrupt_pending(unsigned int id); 102 void plat_ic_clear_interrupt_pending(unsigned int id); 103 unsigned int plat_ic_set_priority_mask(unsigned int mask); 104 unsigned int plat_ic_get_interrupt_id(unsigned int raw); 105 106 /******************************************************************************* 107 * Optional common functions (may be overridden) 108 ******************************************************************************/ 109 uintptr_t plat_get_my_stack(void); 110 void plat_report_exception(unsigned int exception_type); 111 int plat_crash_console_init(void); 112 int plat_crash_console_putc(int c); 113 int plat_crash_console_flush(void); 114 void plat_error_handler(int err) __dead2; 115 void plat_panic_handler(void) __dead2; 116 const char *plat_log_get_prefix(unsigned int log_level); 117 void bl2_plat_preload_setup(void); 118 int plat_try_next_boot_source(void); 119 120 /******************************************************************************* 121 * Mandatory BL1 functions 122 ******************************************************************************/ 123 void bl1_early_platform_setup(void); 124 void bl1_plat_arch_setup(void); 125 void bl1_platform_setup(void); 126 struct meminfo *bl1_plat_sec_mem_layout(void); 127 128 /******************************************************************************* 129 * Optional EL3 component functions in BL31 130 ******************************************************************************/ 131 132 /* SDEI platform functions */ 133 #if SDEI_SUPPORT 134 int plat_sdei_validate_entry_point(uintptr_t ep, unsigned int client_mode); 135 void plat_sdei_handle_masked_trigger(uint64_t mpidr, unsigned int intr); 136 #endif 137 138 void plat_ea_handler(unsigned int ea_reason, uint64_t syndrome, void *cookie, 139 void *handle, uint64_t flags); 140 141 /* 142 * The following function is mandatory when the 143 * firmware update feature is used. 144 */ 145 int bl1_plat_mem_check(uintptr_t mem_base, unsigned int mem_size, 146 unsigned int flags); 147 148 /******************************************************************************* 149 * Optional BL1 functions (may be overridden) 150 ******************************************************************************/ 151 /* 152 * The following functions are used for image loading process in BL1. 153 */ 154 void bl1_plat_set_ep_info(unsigned int image_id, 155 struct entry_point_info *ep_info); 156 /* 157 * The following functions are mandatory when firmware update 158 * feature is used and optional otherwise. 159 */ 160 unsigned int bl1_plat_get_next_image_id(void); 161 struct image_desc *bl1_plat_get_image_desc(unsigned int image_id); 162 163 /* 164 * The following functions are used by firmware update 165 * feature and may optionally be overridden. 166 */ 167 __dead2 void bl1_plat_fwu_done(void *client_cookie, void *reserved); 168 169 /* 170 * This BL1 function can be used by the platforms to update/use image 171 * information for a given `image_id`. 172 */ 173 int bl1_plat_handle_pre_image_load(unsigned int image_id); 174 int bl1_plat_handle_post_image_load(unsigned int image_id); 175 176 /******************************************************************************* 177 * Mandatory BL2 functions 178 ******************************************************************************/ 179 void bl2_early_platform_setup2(u_register_t arg0, u_register_t arg1, u_register_t arg2, u_register_t arg3); 180 void bl2_plat_arch_setup(void); 181 void bl2_platform_setup(void); 182 struct meminfo *bl2_plat_sec_mem_layout(void); 183 184 /* 185 * This function can be used by the platforms to update/use image 186 * information for given `image_id`. 187 */ 188 int bl2_plat_handle_pre_image_load(unsigned int image_id); 189 int bl2_plat_handle_post_image_load(unsigned int image_id); 190 191 192 /******************************************************************************* 193 * Optional BL2 functions (may be overridden) 194 ******************************************************************************/ 195 196 197 /******************************************************************************* 198 * Mandatory BL2 at EL3 functions: Must be implemented if BL2_AT_EL3 image is 199 * supported 200 ******************************************************************************/ 201 void bl2_el3_early_platform_setup(u_register_t arg0, u_register_t arg1, 202 u_register_t arg2, u_register_t arg3); 203 void bl2_el3_plat_arch_setup(void); 204 205 206 /******************************************************************************* 207 * Optional BL2 at EL3 functions (may be overridden) 208 ******************************************************************************/ 209 void bl2_el3_plat_prepare_exit(void); 210 211 /******************************************************************************* 212 * Mandatory BL2U functions. 213 ******************************************************************************/ 214 void bl2u_early_platform_setup(struct meminfo *mem_layout, 215 void *plat_info); 216 void bl2u_plat_arch_setup(void); 217 void bl2u_platform_setup(void); 218 219 /******************************************************************************* 220 * Conditionally mandatory BL2U functions for CSS platforms. 221 ******************************************************************************/ 222 /* 223 * This function is used to perform any platform-specific actions required to 224 * handle the BL2U_SCP firmware. 225 */ 226 int bl2u_plat_handle_scp_bl2u(void); 227 228 /******************************************************************************* 229 * Mandatory BL31 functions 230 ******************************************************************************/ 231 void bl31_early_platform_setup2(u_register_t arg0, u_register_t arg1, 232 u_register_t arg2, u_register_t arg3); 233 void bl31_plat_arch_setup(void); 234 void bl31_platform_setup(void); 235 void bl31_plat_runtime_setup(void); 236 struct entry_point_info *bl31_plat_get_next_image_ep_info(uint32_t type); 237 238 /******************************************************************************* 239 * Mandatory PSCI functions (BL31) 240 ******************************************************************************/ 241 int plat_setup_psci_ops(uintptr_t sec_entrypoint, 242 const struct plat_psci_ops **psci_ops); 243 const unsigned char *plat_get_power_domain_tree_desc(void); 244 245 /******************************************************************************* 246 * Optional PSCI functions (BL31). 247 ******************************************************************************/ 248 void plat_psci_stat_accounting_start(const psci_power_state_t *state_info); 249 void plat_psci_stat_accounting_stop(const psci_power_state_t *state_info); 250 u_register_t plat_psci_stat_get_residency(unsigned int lvl, 251 const psci_power_state_t *state_info, 252 unsigned int last_cpu_idx); 253 plat_local_state_t plat_get_target_pwr_state(unsigned int lvl, 254 const plat_local_state_t *states, 255 unsigned int ncpu); 256 257 /******************************************************************************* 258 * Optional BL31 functions (may be overridden) 259 ******************************************************************************/ 260 void bl31_plat_enable_mmu(uint32_t flags); 261 262 /******************************************************************************* 263 * Optional BL32 functions (may be overridden) 264 ******************************************************************************/ 265 void bl32_plat_enable_mmu(uint32_t flags); 266 267 /******************************************************************************* 268 * Trusted Board Boot functions 269 ******************************************************************************/ 270 int plat_get_rotpk_info(void *cookie, void **key_ptr, unsigned int *key_len, 271 unsigned int *flags); 272 int plat_get_nv_ctr(void *cookie, unsigned int *nv_ctr); 273 int plat_set_nv_ctr(void *cookie, unsigned int nv_ctr); 274 int plat_set_nv_ctr2(void *cookie, const struct auth_img_desc_s *img_desc, 275 unsigned int nv_ctr); 276 int get_mbedtls_heap_helper(void **heap_addr, size_t *heap_size); 277 278 /******************************************************************************* 279 * Secure Partitions functions 280 ******************************************************************************/ 281 const struct mmap_region *plat_get_secure_partition_mmap(void *cookie); 282 const struct spm_mm_boot_info *plat_get_secure_partition_boot_info( 283 void *cookie); 284 int plat_spm_sp_rd_load(struct sp_res_desc *rd, const void *ptr, size_t size); 285 int plat_spm_sp_get_next_address(void **sp_base, size_t *sp_size, 286 void **rd_base, size_t *rd_size); 287 #if defined(SPD_spmd) 288 int plat_spm_core_manifest_load(spmc_manifest_sect_attribute_t *manifest, 289 const void *ptr, 290 size_t size); 291 #endif 292 /******************************************************************************* 293 * Mandatory BL image load functions(may be overridden). 294 ******************************************************************************/ 295 /* 296 * This function returns pointer to the list of images that the 297 * platform has populated to load. 298 */ 299 struct bl_load_info *plat_get_bl_image_load_info(void); 300 301 /* 302 * This function returns a pointer to the shared memory that the 303 * platform has kept aside to pass trusted firmware related 304 * information that next BL image could need. 305 */ 306 struct bl_params *plat_get_next_bl_params(void); 307 308 /* 309 * This function flushes to main memory all the params that are 310 * passed to next image. 311 */ 312 void plat_flush_next_bl_params(void); 313 314 /* 315 * The below function enable Trusted Firmware components like SPDs which 316 * haven't migrated to the new platform API to compile on platforms which 317 * have the compatibility layer disabled. 318 */ 319 unsigned int platform_core_pos_helper(unsigned long mpidr); 320 321 #endif /* PLATFORM_H */ 322