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