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