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