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