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