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