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