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_raise_ns_sgi(int sgi_num, u_register_t target); 108 void plat_ic_raise_s_el1_sgi(int sgi_num, u_register_t target); 109 void plat_ic_set_spi_routing(unsigned int id, unsigned int routing_mode, 110 u_register_t mpidr); 111 void plat_ic_set_interrupt_pending(unsigned int id); 112 void plat_ic_clear_interrupt_pending(unsigned int id); 113 unsigned int plat_ic_set_priority_mask(unsigned int mask); 114 unsigned int plat_ic_get_interrupt_id(unsigned int raw); 115 116 /******************************************************************************* 117 * Optional common functions (may be overridden) 118 ******************************************************************************/ 119 uintptr_t plat_get_my_stack(void); 120 void plat_report_exception(unsigned int exception_type); 121 int plat_crash_console_init(void); 122 int plat_crash_console_putc(int c); 123 void plat_crash_console_flush(void); 124 void plat_error_handler(int err) __dead2; 125 void plat_panic_handler(void) __dead2; 126 const char *plat_log_get_prefix(unsigned int log_level); 127 void bl2_plat_preload_setup(void); 128 int plat_try_next_boot_source(void); 129 130 #if MEASURED_BOOT 131 int plat_mboot_measure_image(unsigned int image_id, image_info_t *image_data); 132 int plat_mboot_measure_critical_data(unsigned int critical_data_id, 133 const void *base, 134 size_t size); 135 #else 136 static inline int plat_mboot_measure_image(unsigned int image_id __unused, 137 image_info_t *image_data __unused) 138 { 139 return 0; 140 } 141 static inline int plat_mboot_measure_critical_data( 142 unsigned int critical_data_id __unused, 143 const void *base __unused, 144 size_t size __unused) 145 { 146 return 0; 147 } 148 #endif /* MEASURED_BOOT */ 149 150 /******************************************************************************* 151 * Mandatory BL1 functions 152 ******************************************************************************/ 153 void bl1_early_platform_setup(void); 154 void bl1_plat_arch_setup(void); 155 void bl1_platform_setup(void); 156 struct meminfo *bl1_plat_sec_mem_layout(void); 157 158 /******************************************************************************* 159 * Optional EL3 component functions in BL31 160 ******************************************************************************/ 161 162 /* SDEI platform functions */ 163 #if SDEI_SUPPORT 164 void plat_sdei_setup(void); 165 int plat_sdei_validate_entry_point(uintptr_t ep, unsigned int client_mode); 166 void plat_sdei_handle_masked_trigger(uint64_t mpidr, unsigned int intr); 167 #endif 168 169 void plat_default_ea_handler(unsigned int ea_reason, uint64_t syndrome, void *cookie, 170 void *handle, uint64_t flags); 171 void plat_ea_handler(unsigned int ea_reason, uint64_t syndrome, void *cookie, 172 void *handle, uint64_t flags); 173 174 /* 175 * The following function is mandatory when the 176 * firmware update feature is used. 177 */ 178 int bl1_plat_mem_check(uintptr_t mem_base, unsigned int mem_size, 179 unsigned int flags); 180 181 /******************************************************************************* 182 * Optional BL1 functions (may be overridden) 183 ******************************************************************************/ 184 /* 185 * The following functions are used for image loading process in BL1. 186 */ 187 void bl1_plat_set_ep_info(unsigned int image_id, 188 struct entry_point_info *ep_info); 189 /* 190 * The following functions are mandatory when firmware update 191 * feature is used and optional otherwise. 192 */ 193 unsigned int bl1_plat_get_next_image_id(void); 194 struct image_desc *bl1_plat_get_image_desc(unsigned int image_id); 195 196 /* 197 * The following functions are used by firmware update 198 * feature and may optionally be overridden. 199 */ 200 __dead2 void bl1_plat_fwu_done(void *client_cookie, void *reserved); 201 202 /* 203 * This BL1 function can be used by the platforms to update/use image 204 * information for a given `image_id`. 205 */ 206 int bl1_plat_handle_pre_image_load(unsigned int image_id); 207 int bl1_plat_handle_post_image_load(unsigned int image_id); 208 209 #if MEASURED_BOOT 210 void bl1_plat_mboot_init(void); 211 void bl1_plat_mboot_finish(void); 212 #else 213 static inline void bl1_plat_mboot_init(void) 214 { 215 } 216 static inline void bl1_plat_mboot_finish(void) 217 { 218 } 219 #endif /* MEASURED_BOOT */ 220 221 /******************************************************************************* 222 * Mandatory BL2 functions 223 ******************************************************************************/ 224 void bl2_early_platform_setup2(u_register_t arg0, u_register_t arg1, u_register_t arg2, u_register_t arg3); 225 void bl2_plat_arch_setup(void); 226 void bl2_platform_setup(void); 227 struct meminfo *bl2_plat_sec_mem_layout(void); 228 229 /* 230 * This function can be used by the platforms to update/use image 231 * information for given `image_id`. 232 */ 233 int bl2_plat_handle_pre_image_load(unsigned int image_id); 234 int bl2_plat_handle_post_image_load(unsigned int image_id); 235 236 /******************************************************************************* 237 * Optional BL2 functions (may be overridden) 238 ******************************************************************************/ 239 #if MEASURED_BOOT 240 void bl2_plat_mboot_init(void); 241 void bl2_plat_mboot_finish(void); 242 #else 243 static inline void bl2_plat_mboot_init(void) 244 { 245 } 246 static inline void bl2_plat_mboot_finish(void) 247 { 248 } 249 #endif /* MEASURED_BOOT */ 250 251 /******************************************************************************* 252 * Mandatory BL2 at EL3 functions: Must be implemented if BL2_AT_EL3 image is 253 * supported 254 ******************************************************************************/ 255 void bl2_el3_early_platform_setup(u_register_t arg0, u_register_t arg1, 256 u_register_t arg2, u_register_t arg3); 257 void bl2_el3_plat_arch_setup(void); 258 259 /******************************************************************************* 260 * Optional BL2 at EL3 functions (may be overridden) 261 ******************************************************************************/ 262 void bl2_el3_plat_prepare_exit(void); 263 264 /******************************************************************************* 265 * Mandatory BL2U functions. 266 ******************************************************************************/ 267 void bl2u_early_platform_setup(struct meminfo *mem_layout, 268 void *plat_info); 269 void bl2u_plat_arch_setup(void); 270 void bl2u_platform_setup(void); 271 272 /******************************************************************************* 273 * Conditionally mandatory BL2U functions for CSS platforms. 274 ******************************************************************************/ 275 /* 276 * This function is used to perform any platform-specific actions required to 277 * handle the BL2U_SCP firmware. 278 */ 279 int bl2u_plat_handle_scp_bl2u(void); 280 281 /******************************************************************************* 282 * Mandatory BL31 functions 283 ******************************************************************************/ 284 void bl31_early_platform_setup2(u_register_t arg0, u_register_t arg1, 285 u_register_t arg2, u_register_t arg3); 286 void bl31_plat_arch_setup(void); 287 void bl31_platform_setup(void); 288 void bl31_plat_runtime_setup(void); 289 struct entry_point_info *bl31_plat_get_next_image_ep_info(uint32_t type); 290 291 /******************************************************************************* 292 * Mandatory PSCI functions (BL31) 293 ******************************************************************************/ 294 int plat_setup_psci_ops(uintptr_t sec_entrypoint, 295 const struct plat_psci_ops **psci_ops); 296 const unsigned char *plat_get_power_domain_tree_desc(void); 297 298 /******************************************************************************* 299 * Optional PSCI functions (BL31). 300 ******************************************************************************/ 301 void plat_psci_stat_accounting_start(const psci_power_state_t *state_info); 302 void plat_psci_stat_accounting_stop(const psci_power_state_t *state_info); 303 u_register_t plat_psci_stat_get_residency(unsigned int lvl, 304 const psci_power_state_t *state_info, 305 unsigned int last_cpu_idx); 306 plat_local_state_t plat_get_target_pwr_state(unsigned int lvl, 307 const plat_local_state_t *states, 308 unsigned int ncpu); 309 310 /******************************************************************************* 311 * Mandatory BL31 functions when ENABLE_RME=1 312 ******************************************************************************/ 313 #if ENABLE_RME 314 int plat_rmmd_get_cca_attest_token(uintptr_t buf, size_t *len, 315 uintptr_t hash, size_t hash_size); 316 int plat_rmmd_get_cca_realm_attest_key(uintptr_t buf, size_t *len, 317 unsigned int type); 318 size_t plat_rmmd_get_el3_rmm_shared_mem(uintptr_t *shared); 319 int plat_rmmd_load_manifest(rmm_manifest_t *manifest); 320 #endif 321 322 /******************************************************************************* 323 * Optional BL31 functions (may be overridden) 324 ******************************************************************************/ 325 void bl31_plat_enable_mmu(uint32_t flags); 326 327 /******************************************************************************* 328 * Optional BL32 functions (may be overridden) 329 ******************************************************************************/ 330 void bl32_plat_enable_mmu(uint32_t flags); 331 332 /******************************************************************************* 333 * Trusted Board Boot functions 334 ******************************************************************************/ 335 int plat_get_rotpk_info(void *cookie, void **key_ptr, unsigned int *key_len, 336 unsigned int *flags); 337 int plat_get_nv_ctr(void *cookie, unsigned int *nv_ctr); 338 int plat_set_nv_ctr(void *cookie, unsigned int nv_ctr); 339 int plat_set_nv_ctr2(void *cookie, const struct auth_img_desc_s *img_desc, 340 unsigned int nv_ctr); 341 int get_mbedtls_heap_helper(void **heap_addr, size_t *heap_size); 342 int plat_get_enc_key_info(enum fw_enc_status_t fw_enc_status, uint8_t *key, 343 size_t *key_len, unsigned int *flags, 344 const uint8_t *img_id, size_t img_id_len); 345 346 /******************************************************************************* 347 * Secure Partitions functions 348 ******************************************************************************/ 349 const struct mmap_region *plat_get_secure_partition_mmap(void *cookie); 350 const struct spm_mm_boot_info *plat_get_secure_partition_boot_info( 351 void *cookie); 352 int plat_spm_sp_rd_load(struct sp_res_desc *rd, const void *ptr, size_t size); 353 int plat_spm_sp_get_next_address(void **sp_base, size_t *sp_size, 354 void **rd_base, size_t *rd_size); 355 #if defined(SPD_spmd) 356 int plat_spm_core_manifest_load(spmc_manifest_attribute_t *manifest, 357 const void *pm_addr); 358 #endif 359 #if defined(SPMC_AT_EL3) 360 int plat_spmc_shmem_datastore_get(uint8_t **datastore, size_t *size); 361 #endif 362 363 /******************************************************************************* 364 * Mandatory BL image load functions(may be overridden). 365 ******************************************************************************/ 366 /* 367 * This function returns pointer to the list of images that the 368 * platform has populated to load. 369 */ 370 struct bl_load_info *plat_get_bl_image_load_info(void); 371 372 /* 373 * This function returns a pointer to the shared memory that the 374 * platform has kept aside to pass trusted firmware related 375 * information that next BL image could need. 376 */ 377 struct bl_params *plat_get_next_bl_params(void); 378 379 /* 380 * This function flushes to main memory all the params that are 381 * passed to next image. 382 */ 383 void plat_flush_next_bl_params(void); 384 385 /* 386 * The below function enable Trusted Firmware components like SPDs which 387 * haven't migrated to the new platform API to compile on platforms which 388 * have the compatibility layer disabled. 389 */ 390 unsigned int platform_core_pos_helper(unsigned long mpidr); 391 392 /* 393 * Optional function to get SOC version 394 */ 395 int32_t plat_get_soc_version(void); 396 397 /* 398 * Optional function to get SOC revision 399 */ 400 int32_t plat_get_soc_revision(void); 401 402 /* 403 * Optional function to check for SMCCC function availability for platform 404 */ 405 int32_t plat_is_smccc_feature_available(u_register_t fid); 406 407 /******************************************************************************* 408 * FWU platform specific functions 409 ******************************************************************************/ 410 int plat_fwu_set_metadata_image_source(unsigned int image_id, 411 uintptr_t *dev_handle, 412 uintptr_t *image_spec); 413 void plat_fwu_set_images_source(const struct fwu_metadata *metadata); 414 uint32_t plat_fwu_get_boot_idx(void); 415 416 #endif /* PLATFORM_H */ 417