1 /* 2 * Copyright (c) 2013-2018, 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 <psci.h> 11 #include <stdint.h> 12 13 /******************************************************************************* 14 * Forward declarations 15 ******************************************************************************/ 16 struct auth_img_desc_s; 17 struct meminfo; 18 struct image_info; 19 struct entry_point_info; 20 struct bl31_params; 21 struct image_desc; 22 struct bl_load_info; 23 struct bl_params; 24 struct mmap_region; 25 struct secure_partition_boot_info; 26 27 /******************************************************************************* 28 * plat_get_rotpk_info() flags 29 ******************************************************************************/ 30 #define ROTPK_IS_HASH (1 << 0) 31 /* Flag used to skip verification of the certificate ROTPK while the platform 32 ROTPK is not deployed */ 33 #define ROTPK_NOT_DEPLOYED (1 << 1) 34 35 /******************************************************************************* 36 * Function declarations 37 ******************************************************************************/ 38 /******************************************************************************* 39 * Mandatory common functions 40 ******************************************************************************/ 41 unsigned long long plat_get_syscnt_freq(void) __deprecated; 42 unsigned int plat_get_syscnt_freq2(void); 43 44 int plat_get_image_source(unsigned int image_id, 45 uintptr_t *dev_handle, 46 uintptr_t *image_spec); 47 uintptr_t plat_get_ns_image_entrypoint(void); 48 unsigned int plat_my_core_pos(void); 49 int plat_core_pos_by_mpidr(u_register_t mpidr); 50 51 #if STACK_PROTECTOR_ENABLED 52 /* 53 * Return a new value to be used for the stack protection's canary. 54 * 55 * Ideally, this value is a random number that is impossible to predict by an 56 * attacker. 57 */ 58 u_register_t plat_get_stack_protector_canary(void); 59 #endif /* STACK_PROTECTOR_ENABLED */ 60 61 /******************************************************************************* 62 * Mandatory interrupt management functions 63 ******************************************************************************/ 64 uint32_t plat_ic_get_pending_interrupt_id(void); 65 uint32_t plat_ic_get_pending_interrupt_type(void); 66 uint32_t plat_ic_acknowledge_interrupt(void); 67 uint32_t plat_ic_get_interrupt_type(uint32_t id); 68 void plat_ic_end_of_interrupt(uint32_t id); 69 uint32_t plat_interrupt_type_to_line(uint32_t type, 70 uint32_t security_state); 71 72 /******************************************************************************* 73 * Optional interrupt management functions, depending on chosen EL3 components. 74 ******************************************************************************/ 75 unsigned int plat_ic_get_running_priority(void); 76 int plat_ic_is_spi(unsigned int id); 77 int plat_ic_is_ppi(unsigned int id); 78 int plat_ic_is_sgi(unsigned int id); 79 unsigned int plat_ic_get_interrupt_active(unsigned int id); 80 void plat_ic_disable_interrupt(unsigned int id); 81 void plat_ic_enable_interrupt(unsigned int id); 82 int plat_ic_has_interrupt_type(unsigned int type); 83 void plat_ic_set_interrupt_type(unsigned int id, unsigned int type); 84 void plat_ic_set_interrupt_priority(unsigned int id, unsigned int priority); 85 void plat_ic_raise_el3_sgi(int sgi_num, u_register_t target); 86 void plat_ic_set_spi_routing(unsigned int id, unsigned int routing_mode, 87 u_register_t mpidr); 88 void plat_ic_set_interrupt_pending(unsigned int id); 89 void plat_ic_clear_interrupt_pending(unsigned int id); 90 unsigned int plat_ic_set_priority_mask(unsigned int mask); 91 unsigned int plat_ic_get_interrupt_id(unsigned int raw); 92 93 /******************************************************************************* 94 * Optional common functions (may be overridden) 95 ******************************************************************************/ 96 uintptr_t plat_get_my_stack(void); 97 void plat_report_exception(unsigned int exception_type); 98 int plat_crash_console_init(void); 99 int plat_crash_console_putc(int c); 100 int plat_crash_console_flush(void); 101 void plat_error_handler(int err) __dead2; 102 void plat_panic_handler(void) __dead2; 103 const char *plat_log_get_prefix(unsigned int log_level); 104 void bl2_plat_preload_setup(void); 105 int plat_try_next_boot_source(void); 106 107 /******************************************************************************* 108 * Mandatory BL1 functions 109 ******************************************************************************/ 110 void bl1_early_platform_setup(void); 111 void bl1_plat_arch_setup(void); 112 void bl1_platform_setup(void); 113 struct meminfo *bl1_plat_sec_mem_layout(void); 114 115 /******************************************************************************* 116 * Optional EL3 component functions in BL31 117 ******************************************************************************/ 118 119 /* SDEI platform functions */ 120 #if SDEI_SUPPORT 121 int plat_sdei_validate_entry_point(uintptr_t ep, unsigned int client_mode); 122 void plat_sdei_handle_masked_trigger(uint64_t mpidr, unsigned int intr); 123 #endif 124 125 void plat_ea_handler(unsigned int ea_reason, uint64_t syndrome, void *cookie, 126 void *handle, uint64_t flags); 127 128 /* 129 * The following function is mandatory when the 130 * firmware update feature is used. 131 */ 132 int bl1_plat_mem_check(uintptr_t mem_base, unsigned int mem_size, 133 unsigned int flags); 134 135 /******************************************************************************* 136 * Optional BL1 functions (may be overridden) 137 ******************************************************************************/ 138 #if !ERROR_DEPRECATED 139 void bl1_init_bl2_mem_layout(const struct meminfo *bl1_mem_layout, 140 struct meminfo *bl2_mem_layout); 141 #endif 142 /* 143 * The following functions are used for image loading process in BL1. 144 */ 145 void bl1_plat_set_ep_info(unsigned int image_id, 146 struct entry_point_info *ep_info); 147 /* 148 * The following functions are mandatory when firmware update 149 * feature is used and optional otherwise. 150 */ 151 unsigned int bl1_plat_get_next_image_id(void); 152 struct image_desc *bl1_plat_get_image_desc(unsigned int image_id); 153 154 /* 155 * The following functions are used by firmware update 156 * feature and may optionally be overridden. 157 */ 158 __dead2 void bl1_plat_fwu_done(void *client_cookie, void *reserved); 159 160 /* 161 * This BL1 function can be used by the platforms to update/use image 162 * information for a given `image_id`. 163 */ 164 int bl1_plat_handle_pre_image_load(unsigned int image_id); 165 int bl1_plat_handle_post_image_load(unsigned int image_id); 166 167 /******************************************************************************* 168 * Mandatory BL2 functions 169 ******************************************************************************/ 170 void bl2_early_platform_setup2(u_register_t arg0, u_register_t arg1, u_register_t arg2, u_register_t arg3); 171 #if !ERROR_DEPRECATED 172 void bl2_early_platform_setup(struct meminfo *mem_layout); 173 #endif 174 void bl2_plat_arch_setup(void); 175 void bl2_platform_setup(void); 176 struct meminfo *bl2_plat_sec_mem_layout(void); 177 178 #if LOAD_IMAGE_V2 179 /* 180 * This function can be used by the platforms to update/use image 181 * information for given `image_id`. 182 */ 183 int bl2_plat_handle_pre_image_load(unsigned int image_id); 184 int bl2_plat_handle_post_image_load(unsigned int image_id); 185 186 #else /* LOAD_IMAGE_V2 */ 187 188 /* 189 * This function returns a pointer to the shared memory that the platform has 190 * kept aside to pass trusted firmware related information that BL31 191 * could need 192 */ 193 struct bl31_params *bl2_plat_get_bl31_params(void); 194 195 /* 196 * This function returns a pointer to the shared memory that the platform 197 * has kept to point to entry point information of BL31 to BL2 198 */ 199 struct entry_point_info *bl2_plat_get_bl31_ep_info(void); 200 201 /* 202 * This function flushes to main memory all the params that are 203 * passed to BL31 204 */ 205 void bl2_plat_flush_bl31_params(void); 206 207 /* 208 * The next 2 functions allow the platform to change the entrypoint information 209 * for the mandatory 3rd level BL images, BL31 and BL33. This is done after 210 * BL2 has loaded those images into memory but before BL31 is executed. 211 */ 212 void bl2_plat_set_bl31_ep_info(struct image_info *image, 213 struct entry_point_info *ep); 214 215 void bl2_plat_set_bl33_ep_info(struct image_info *image, 216 struct entry_point_info *ep); 217 218 /* Gets the memory layout for BL33 */ 219 void bl2_plat_get_bl33_meminfo(struct meminfo *mem_info); 220 221 /******************************************************************************* 222 * Conditionally mandatory BL2 functions: must be implemented if SCP_BL2 image 223 * is supported 224 ******************************************************************************/ 225 /* Gets the memory layout for SCP_BL2 */ 226 void bl2_plat_get_scp_bl2_meminfo(struct meminfo *mem_info); 227 228 /* 229 * This function is called after loading SCP_BL2 image and it is used to perform 230 * any platform-specific actions required to handle the SCP firmware. 231 */ 232 int bl2_plat_handle_scp_bl2(struct image_info *scp_bl2_image_info); 233 234 /******************************************************************************* 235 * Conditionally mandatory BL2 functions: must be implemented if BL32 image 236 * is supported 237 ******************************************************************************/ 238 void bl2_plat_set_bl32_ep_info(struct image_info *image, 239 struct entry_point_info *ep); 240 241 /* Gets the memory layout for BL32 */ 242 void bl2_plat_get_bl32_meminfo(struct meminfo *mem_info); 243 244 #endif /* LOAD_IMAGE_V2 */ 245 246 /******************************************************************************* 247 * Optional BL2 functions (may be overridden) 248 ******************************************************************************/ 249 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 /******************************************************************************* 261 * Optional BL2 at EL3 functions (may be overridden) 262 ******************************************************************************/ 263 void bl2_el3_plat_prepare_exit(void); 264 265 /******************************************************************************* 266 * Mandatory BL2U functions. 267 ******************************************************************************/ 268 void bl2u_early_platform_setup(struct meminfo *mem_layout, 269 void *plat_info); 270 void bl2u_plat_arch_setup(void); 271 void bl2u_platform_setup(void); 272 273 /******************************************************************************* 274 * Conditionally mandatory BL2U functions for CSS platforms. 275 ******************************************************************************/ 276 /* 277 * This function is used to perform any platform-specific actions required to 278 * handle the BL2U_SCP firmware. 279 */ 280 int bl2u_plat_handle_scp_bl2u(void); 281 282 /******************************************************************************* 283 * Mandatory BL31 functions 284 ******************************************************************************/ 285 #if !ERROR_DEPRECATED 286 #if LOAD_IMAGE_V2 287 void bl31_early_platform_setup(void *from_bl2, 288 void *plat_params_from_bl2); 289 #else 290 void bl31_early_platform_setup(struct bl31_params *from_bl2, 291 void *plat_params_from_bl2); 292 #endif 293 #endif /* ERROR_DEPRECATED */ 294 void bl31_early_platform_setup2(u_register_t arg0, u_register_t arg1, 295 u_register_t arg2, u_register_t arg3); 296 void bl31_plat_arch_setup(void); 297 void bl31_platform_setup(void); 298 void bl31_plat_runtime_setup(void); 299 struct entry_point_info *bl31_plat_get_next_image_ep_info(uint32_t type); 300 301 /******************************************************************************* 302 * Mandatory PSCI functions (BL31) 303 ******************************************************************************/ 304 int plat_setup_psci_ops(uintptr_t sec_entrypoint, 305 const struct plat_psci_ops **psci_ops); 306 const unsigned char *plat_get_power_domain_tree_desc(void); 307 308 /******************************************************************************* 309 * Optional PSCI functions (BL31). 310 ******************************************************************************/ 311 void plat_psci_stat_accounting_start(const psci_power_state_t *state_info); 312 void plat_psci_stat_accounting_stop(const psci_power_state_t *state_info); 313 u_register_t plat_psci_stat_get_residency(unsigned int lvl, 314 const psci_power_state_t *state_info, 315 int last_cpu_idx); 316 plat_local_state_t plat_get_target_pwr_state(unsigned int lvl, 317 const plat_local_state_t *states, 318 unsigned int ncpu); 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 340 /******************************************************************************* 341 * Secure Partitions functions 342 ******************************************************************************/ 343 const struct mmap_region *plat_get_secure_partition_mmap(void *cookie); 344 const struct secure_partition_boot_info *plat_get_secure_partition_boot_info( 345 void *cookie); 346 347 #if LOAD_IMAGE_V2 348 /******************************************************************************* 349 * Mandatory BL image load functions(may be overridden). 350 ******************************************************************************/ 351 /* 352 * This function returns pointer to the list of images that the 353 * platform has populated to load. 354 */ 355 struct bl_load_info *plat_get_bl_image_load_info(void); 356 357 /* 358 * This function returns a pointer to the shared memory that the 359 * platform has kept aside to pass trusted firmware related 360 * information that next BL image could need. 361 */ 362 struct bl_params *plat_get_next_bl_params(void); 363 364 /* 365 * This function flushes to main memory all the params that are 366 * passed to next image. 367 */ 368 void plat_flush_next_bl_params(void); 369 370 #endif /* LOAD_IMAGE_V2 */ 371 372 #if ENABLE_PLAT_COMPAT 373 /* 374 * The below declarations are to enable compatibility for the platform ports 375 * using the old platform interface. 376 */ 377 378 /******************************************************************************* 379 * Optional common functions (may be overridden) 380 ******************************************************************************/ 381 unsigned int platform_get_core_pos(unsigned long mpidr); 382 383 /******************************************************************************* 384 * Mandatory PSCI Compatibility functions (BL31) 385 ******************************************************************************/ 386 int platform_setup_pm(const plat_pm_ops_t **); 387 388 unsigned int plat_get_aff_count(unsigned int, unsigned long); 389 unsigned int plat_get_aff_state(unsigned int, unsigned long); 390 391 #else /* __ENABLE_PLAT_COMPAT__ */ 392 /* 393 * The below function enable Trusted Firmware components like SPDs which 394 * haven't migrated to the new platform API to compile on platforms which 395 * have the compatibility layer disabled. 396 */ 397 unsigned int platform_core_pos_helper(unsigned long mpidr); 398 unsigned int platform_get_core_pos(unsigned long mpidr) __deprecated; 399 400 #endif /* __ENABLE_PLAT_COMPAT__ */ 401 402 #endif /* PLATFORM_H */ 403