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