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