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