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