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 /* 128 * The following function is mandatory when the 129 * firmware update feature is used. 130 */ 131 int bl1_plat_mem_check(uintptr_t mem_base, unsigned int mem_size, 132 unsigned int flags); 133 134 /******************************************************************************* 135 * Optional BL1 functions (may be overridden) 136 ******************************************************************************/ 137 #if !ERROR_DEPRECATED 138 void bl1_init_bl2_mem_layout(const struct meminfo *bl1_mem_layout, 139 struct meminfo *bl2_mem_layout); 140 #endif 141 /* 142 * The following functions are used for image loading process in BL1. 143 */ 144 void bl1_plat_set_ep_info(unsigned int image_id, 145 struct entry_point_info *ep_info); 146 /* 147 * The following functions are mandatory when firmware update 148 * feature is used and optional otherwise. 149 */ 150 unsigned int bl1_plat_get_next_image_id(void); 151 struct image_desc *bl1_plat_get_image_desc(unsigned int image_id); 152 153 /* 154 * The following functions are used by firmware update 155 * feature and may optionally be overridden. 156 */ 157 __dead2 void bl1_plat_fwu_done(void *client_cookie, void *reserved); 158 159 /* 160 * This BL1 function can be used by the platforms to update/use image 161 * information for a given `image_id`. 162 */ 163 int bl1_plat_handle_pre_image_load(unsigned int image_id); 164 int bl1_plat_handle_post_image_load(unsigned int image_id); 165 166 /******************************************************************************* 167 * Mandatory BL2 functions 168 ******************************************************************************/ 169 void bl2_early_platform_setup2(u_register_t arg0, u_register_t arg1, u_register_t arg2, u_register_t arg3); 170 #if !ERROR_DEPRECATED 171 void bl2_early_platform_setup(struct meminfo *mem_layout); 172 #endif 173 void bl2_plat_arch_setup(void); 174 void bl2_platform_setup(void); 175 struct meminfo *bl2_plat_sec_mem_layout(void); 176 177 #if LOAD_IMAGE_V2 178 /* 179 * This function can be used by the platforms to update/use image 180 * information for given `image_id`. 181 */ 182 int bl2_plat_handle_pre_image_load(unsigned int image_id); 183 int bl2_plat_handle_post_image_load(unsigned int image_id); 184 185 #else /* LOAD_IMAGE_V2 */ 186 187 /* 188 * This function returns a pointer to the shared memory that the platform has 189 * kept aside to pass trusted firmware related information that BL31 190 * could need 191 */ 192 struct bl31_params *bl2_plat_get_bl31_params(void); 193 194 /* 195 * This function returns a pointer to the shared memory that the platform 196 * has kept to point to entry point information of BL31 to BL2 197 */ 198 struct entry_point_info *bl2_plat_get_bl31_ep_info(void); 199 200 /* 201 * This function flushes to main memory all the params that are 202 * passed to BL31 203 */ 204 void bl2_plat_flush_bl31_params(void); 205 206 /* 207 * The next 2 functions allow the platform to change the entrypoint information 208 * for the mandatory 3rd level BL images, BL31 and BL33. This is done after 209 * BL2 has loaded those images into memory but before BL31 is executed. 210 */ 211 void bl2_plat_set_bl31_ep_info(struct image_info *image, 212 struct entry_point_info *ep); 213 214 void bl2_plat_set_bl33_ep_info(struct image_info *image, 215 struct entry_point_info *ep); 216 217 /* Gets the memory layout for BL33 */ 218 void bl2_plat_get_bl33_meminfo(struct meminfo *mem_info); 219 220 /******************************************************************************* 221 * Conditionally mandatory BL2 functions: must be implemented if SCP_BL2 image 222 * is supported 223 ******************************************************************************/ 224 /* Gets the memory layout for SCP_BL2 */ 225 void bl2_plat_get_scp_bl2_meminfo(struct meminfo *mem_info); 226 227 /* 228 * This function is called after loading SCP_BL2 image and it is used to perform 229 * any platform-specific actions required to handle the SCP firmware. 230 */ 231 int bl2_plat_handle_scp_bl2(struct image_info *scp_bl2_image_info); 232 233 /******************************************************************************* 234 * Conditionally mandatory BL2 functions: must be implemented if BL32 image 235 * is supported 236 ******************************************************************************/ 237 void bl2_plat_set_bl32_ep_info(struct image_info *image, 238 struct entry_point_info *ep); 239 240 /* Gets the memory layout for BL32 */ 241 void bl2_plat_get_bl32_meminfo(struct meminfo *mem_info); 242 243 #endif /* LOAD_IMAGE_V2 */ 244 245 /******************************************************************************* 246 * Optional BL2 functions (may be overridden) 247 ******************************************************************************/ 248 249 250 /******************************************************************************* 251 * Mandatory BL2 at EL3 functions: Must be implemented if BL2_AT_EL3 image is 252 * supported 253 ******************************************************************************/ 254 void bl2_el3_early_platform_setup(u_register_t arg0, u_register_t arg1, 255 u_register_t arg2, u_register_t arg3); 256 void bl2_el3_plat_arch_setup(void); 257 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 #if !ERROR_DEPRECATED 285 #if LOAD_IMAGE_V2 286 void bl31_early_platform_setup(void *from_bl2, 287 void *plat_params_from_bl2); 288 #else 289 void bl31_early_platform_setup(struct bl31_params *from_bl2, 290 void *plat_params_from_bl2); 291 #endif 292 #endif /* ERROR_DEPRECATED */ 293 void bl31_early_platform_setup2(u_register_t arg0, u_register_t arg1, 294 u_register_t arg2, u_register_t arg3); 295 void bl31_plat_arch_setup(void); 296 void bl31_platform_setup(void); 297 void bl31_plat_runtime_setup(void); 298 struct entry_point_info *bl31_plat_get_next_image_ep_info(uint32_t type); 299 300 /******************************************************************************* 301 * Mandatory PSCI functions (BL31) 302 ******************************************************************************/ 303 int plat_setup_psci_ops(uintptr_t sec_entrypoint, 304 const struct plat_psci_ops **psci_ops); 305 const unsigned char *plat_get_power_domain_tree_desc(void); 306 307 /******************************************************************************* 308 * Optional PSCI functions (BL31). 309 ******************************************************************************/ 310 void plat_psci_stat_accounting_start(const psci_power_state_t *state_info); 311 void plat_psci_stat_accounting_stop(const psci_power_state_t *state_info); 312 u_register_t plat_psci_stat_get_residency(unsigned int lvl, 313 const psci_power_state_t *state_info, 314 int last_cpu_idx); 315 plat_local_state_t plat_get_target_pwr_state(unsigned int lvl, 316 const plat_local_state_t *states, 317 unsigned int ncpu); 318 319 /******************************************************************************* 320 * Optional BL31 functions (may be overridden) 321 ******************************************************************************/ 322 void bl31_plat_enable_mmu(uint32_t flags); 323 324 /******************************************************************************* 325 * Optional BL32 functions (may be overridden) 326 ******************************************************************************/ 327 void bl32_plat_enable_mmu(uint32_t flags); 328 329 /******************************************************************************* 330 * Trusted Board Boot functions 331 ******************************************************************************/ 332 int plat_get_rotpk_info(void *cookie, void **key_ptr, unsigned int *key_len, 333 unsigned int *flags); 334 int plat_get_nv_ctr(void *cookie, unsigned int *nv_ctr); 335 int plat_set_nv_ctr(void *cookie, unsigned int nv_ctr); 336 int plat_set_nv_ctr2(void *cookie, const struct auth_img_desc_s *img_desc, 337 unsigned int nv_ctr); 338 339 /******************************************************************************* 340 * Secure Partitions functions 341 ******************************************************************************/ 342 const struct mmap_region *plat_get_secure_partition_mmap(void *cookie); 343 const struct secure_partition_boot_info *plat_get_secure_partition_boot_info( 344 void *cookie); 345 346 #if LOAD_IMAGE_V2 347 /******************************************************************************* 348 * Mandatory BL image load functions(may be overridden). 349 ******************************************************************************/ 350 /* 351 * This function returns pointer to the list of images that the 352 * platform has populated to load. 353 */ 354 struct bl_load_info *plat_get_bl_image_load_info(void); 355 356 /* 357 * This function returns a pointer to the shared memory that the 358 * platform has kept aside to pass trusted firmware related 359 * information that next BL image could need. 360 */ 361 struct bl_params *plat_get_next_bl_params(void); 362 363 /* 364 * This function flushes to main memory all the params that are 365 * passed to next image. 366 */ 367 void plat_flush_next_bl_params(void); 368 369 #endif /* LOAD_IMAGE_V2 */ 370 371 #if ENABLE_PLAT_COMPAT 372 /* 373 * The below declarations are to enable compatibility for the platform ports 374 * using the old platform interface. 375 */ 376 377 /******************************************************************************* 378 * Optional common functions (may be overridden) 379 ******************************************************************************/ 380 unsigned int platform_get_core_pos(unsigned long mpidr); 381 382 /******************************************************************************* 383 * Mandatory PSCI Compatibility functions (BL31) 384 ******************************************************************************/ 385 int platform_setup_pm(const plat_pm_ops_t **); 386 387 unsigned int plat_get_aff_count(unsigned int, unsigned long); 388 unsigned int plat_get_aff_state(unsigned int, unsigned long); 389 390 #else /* __ENABLE_PLAT_COMPAT__ */ 391 /* 392 * The below function enable Trusted Firmware components like SPDs which 393 * haven't migrated to the new platform API to compile on platforms which 394 * have the compatibility layer disabled. 395 */ 396 unsigned int platform_core_pos_helper(unsigned long mpidr); 397 unsigned int platform_get_core_pos(unsigned long mpidr) __deprecated; 398 399 #endif /* __ENABLE_PLAT_COMPAT__ */ 400 401 #endif /* __PLATFORM_H__ */ 402 403