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