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