1 /* 2 * Copyright (c) 2013-2017, 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 94 /******************************************************************************* 95 * Optional common functions (may be overridden) 96 ******************************************************************************/ 97 uintptr_t plat_get_my_stack(void); 98 void plat_report_exception(unsigned int exception_type); 99 int plat_crash_console_init(void); 100 int plat_crash_console_putc(int c); 101 int plat_crash_console_flush(void); 102 void plat_error_handler(int err) __dead2; 103 void plat_panic_handler(void) __dead2; 104 const char *plat_log_get_prefix(unsigned int log_level); 105 void bl2_plat_preload_setup(void); 106 int plat_try_next_boot_source(void); 107 108 /******************************************************************************* 109 * Mandatory BL1 functions 110 ******************************************************************************/ 111 void bl1_early_platform_setup(void); 112 void bl1_plat_arch_setup(void); 113 void bl1_platform_setup(void); 114 struct meminfo *bl1_plat_sec_mem_layout(void); 115 116 /* 117 * The following function is mandatory when the 118 * firmware update feature is used. 119 */ 120 int bl1_plat_mem_check(uintptr_t mem_base, unsigned int mem_size, 121 unsigned int flags); 122 123 /******************************************************************************* 124 * Optional BL1 functions (may be overridden) 125 ******************************************************************************/ 126 void bl1_init_bl2_mem_layout(const struct meminfo *bl1_mem_layout, 127 struct meminfo *bl2_mem_layout); 128 129 /* 130 * The following functions are used for image loading process in BL1. 131 */ 132 void bl1_plat_set_ep_info(unsigned int image_id, 133 struct entry_point_info *ep_info); 134 /* 135 * The following functions are mandatory when firmware update 136 * feature is used and optional otherwise. 137 */ 138 unsigned int bl1_plat_get_next_image_id(void); 139 struct image_desc *bl1_plat_get_image_desc(unsigned int image_id); 140 141 /* 142 * The following functions are used by firmware update 143 * feature and may optionally be overridden. 144 */ 145 __dead2 void bl1_plat_fwu_done(void *client_cookie, void *reserved); 146 147 148 /******************************************************************************* 149 * Mandatory BL2 functions 150 ******************************************************************************/ 151 void bl2_early_platform_setup(struct meminfo *mem_layout); 152 void bl2_plat_arch_setup(void); 153 void bl2_platform_setup(void); 154 struct meminfo *bl2_plat_sec_mem_layout(void); 155 156 #if LOAD_IMAGE_V2 157 /* 158 * This function can be used by the platforms to update/use image 159 * information for given `image_id`. 160 */ 161 int bl2_plat_handle_post_image_load(unsigned int image_id); 162 163 #else /* LOAD_IMAGE_V2 */ 164 165 /* 166 * This function returns a pointer to the shared memory that the platform has 167 * kept aside to pass trusted firmware related information that BL31 168 * could need 169 */ 170 struct bl31_params *bl2_plat_get_bl31_params(void); 171 172 /* 173 * This function returns a pointer to the shared memory that the platform 174 * has kept to point to entry point information of BL31 to BL2 175 */ 176 struct entry_point_info *bl2_plat_get_bl31_ep_info(void); 177 178 /* 179 * This function flushes to main memory all the params that are 180 * passed to BL31 181 */ 182 void bl2_plat_flush_bl31_params(void); 183 184 /* 185 * The next 2 functions allow the platform to change the entrypoint information 186 * for the mandatory 3rd level BL images, BL31 and BL33. This is done after 187 * BL2 has loaded those images into memory but before BL31 is executed. 188 */ 189 void bl2_plat_set_bl31_ep_info(struct image_info *image, 190 struct entry_point_info *ep); 191 192 void bl2_plat_set_bl33_ep_info(struct image_info *image, 193 struct entry_point_info *ep); 194 195 /* Gets the memory layout for BL33 */ 196 void bl2_plat_get_bl33_meminfo(struct meminfo *mem_info); 197 198 /******************************************************************************* 199 * Conditionally mandatory BL2 functions: must be implemented if SCP_BL2 image 200 * is supported 201 ******************************************************************************/ 202 /* Gets the memory layout for SCP_BL2 */ 203 void bl2_plat_get_scp_bl2_meminfo(struct meminfo *mem_info); 204 205 /* 206 * This function is called after loading SCP_BL2 image and it is used to perform 207 * any platform-specific actions required to handle the SCP firmware. 208 */ 209 int bl2_plat_handle_scp_bl2(struct image_info *scp_bl2_image_info); 210 211 /******************************************************************************* 212 * Conditionally mandatory BL2 functions: must be implemented if BL32 image 213 * is supported 214 ******************************************************************************/ 215 void bl2_plat_set_bl32_ep_info(struct image_info *image, 216 struct entry_point_info *ep); 217 218 /* Gets the memory layout for BL32 */ 219 void bl2_plat_get_bl32_meminfo(struct meminfo *mem_info); 220 221 #endif /* LOAD_IMAGE_V2 */ 222 223 /******************************************************************************* 224 * Optional BL2 functions (may be overridden) 225 ******************************************************************************/ 226 227 /******************************************************************************* 228 * Mandatory BL2U functions. 229 ******************************************************************************/ 230 void bl2u_early_platform_setup(struct meminfo *mem_layout, 231 void *plat_info); 232 void bl2u_plat_arch_setup(void); 233 void bl2u_platform_setup(void); 234 235 /******************************************************************************* 236 * Conditionally mandatory BL2U functions for CSS platforms. 237 ******************************************************************************/ 238 /* 239 * This function is used to perform any platform-specific actions required to 240 * handle the BL2U_SCP firmware. 241 */ 242 int bl2u_plat_handle_scp_bl2u(void); 243 244 /******************************************************************************* 245 * Mandatory BL31 functions 246 ******************************************************************************/ 247 #if LOAD_IMAGE_V2 248 void bl31_early_platform_setup(void *from_bl2, 249 void *plat_params_from_bl2); 250 #else 251 void bl31_early_platform_setup(struct bl31_params *from_bl2, 252 void *plat_params_from_bl2); 253 #endif 254 void bl31_plat_arch_setup(void); 255 void bl31_platform_setup(void); 256 void bl31_plat_runtime_setup(void); 257 struct entry_point_info *bl31_plat_get_next_image_ep_info(uint32_t type); 258 259 /******************************************************************************* 260 * Mandatory PSCI functions (BL31) 261 ******************************************************************************/ 262 int plat_setup_psci_ops(uintptr_t sec_entrypoint, 263 const struct plat_psci_ops **); 264 const unsigned char *plat_get_power_domain_tree_desc(void); 265 266 /******************************************************************************* 267 * Optional PSCI functions (BL31). 268 ******************************************************************************/ 269 void plat_psci_stat_accounting_start(const psci_power_state_t *state_info); 270 void plat_psci_stat_accounting_stop(const psci_power_state_t *state_info); 271 u_register_t plat_psci_stat_get_residency(unsigned int lvl, 272 const psci_power_state_t *state_info, 273 int last_cpu_index); 274 plat_local_state_t plat_get_target_pwr_state(unsigned int lvl, 275 const plat_local_state_t *states, 276 unsigned int ncpu); 277 278 /******************************************************************************* 279 * Optional BL31 functions (may be overridden) 280 ******************************************************************************/ 281 void bl31_plat_enable_mmu(uint32_t flags); 282 283 /******************************************************************************* 284 * Optional BL32 functions (may be overridden) 285 ******************************************************************************/ 286 void bl32_plat_enable_mmu(uint32_t flags); 287 288 /******************************************************************************* 289 * Trusted Board Boot functions 290 ******************************************************************************/ 291 int plat_get_rotpk_info(void *cookie, void **key_ptr, unsigned int *key_len, 292 unsigned int *flags); 293 int plat_get_nv_ctr(void *cookie, unsigned int *nv_ctr); 294 int plat_set_nv_ctr(void *cookie, unsigned int nv_ctr); 295 int plat_set_nv_ctr2(void *cookie, const struct auth_img_desc_s *img_desc, 296 unsigned int nv_ctr); 297 298 /******************************************************************************* 299 * Secure Partitions functions 300 ******************************************************************************/ 301 const struct mmap_region *plat_get_secure_partition_mmap(void *cookie); 302 const struct secure_partition_boot_info *plat_get_secure_partition_boot_info( 303 void *cookie); 304 305 #if LOAD_IMAGE_V2 306 /******************************************************************************* 307 * Mandatory BL image load functions(may be overridden). 308 ******************************************************************************/ 309 /* 310 * This function returns pointer to the list of images that the 311 * platform has populated to load. 312 */ 313 struct bl_load_info *plat_get_bl_image_load_info(void); 314 315 /* 316 * This function returns a pointer to the shared memory that the 317 * platform has kept aside to pass trusted firmware related 318 * information that next BL image could need. 319 */ 320 struct bl_params *plat_get_next_bl_params(void); 321 322 /* 323 * This function flushes to main memory all the params that are 324 * passed to next image. 325 */ 326 void plat_flush_next_bl_params(void); 327 328 #endif /* LOAD_IMAGE_V2 */ 329 330 #if ENABLE_PLAT_COMPAT 331 /* 332 * The below declarations are to enable compatibility for the platform ports 333 * using the old platform interface. 334 */ 335 336 /******************************************************************************* 337 * Optional common functions (may be overridden) 338 ******************************************************************************/ 339 unsigned int platform_get_core_pos(unsigned long mpidr); 340 341 /******************************************************************************* 342 * Mandatory PSCI Compatibility functions (BL31) 343 ******************************************************************************/ 344 int platform_setup_pm(const plat_pm_ops_t **); 345 346 unsigned int plat_get_aff_count(unsigned int, unsigned long); 347 unsigned int plat_get_aff_state(unsigned int, unsigned long); 348 #else /* __ENABLE_PLAT_COMPAT__ */ 349 /* 350 * The below function enable Trusted Firmware components like SPDs which 351 * haven't migrated to the new platform API to compile on platforms which 352 * have the compatibility layer disabled. 353 */ 354 unsigned int platform_get_core_pos(unsigned long mpidr) __deprecated; 355 356 #endif /* __ENABLE_PLAT_COMPAT__ */ 357 358 #endif /* __PLATFORM_H__ */ 359 360