1 /* 2 * Copyright (c) 2013-2017, ARM Limited and Contributors. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are met: 6 * 7 * Redistributions of source code must retain the above copyright notice, this 8 * list of conditions and the following disclaimer. 9 * 10 * Redistributions in binary form must reproduce the above copyright notice, 11 * this list of conditions and the following disclaimer in the documentation 12 * and/or other materials provided with the distribution. 13 * 14 * Neither the name of ARM nor the names of its contributors may be used 15 * to endorse or promote products derived from this software without specific 16 * prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28 * POSSIBILITY OF SUCH DAMAGE. 29 */ 30 31 #ifndef __PLATFORM_H__ 32 #define __PLATFORM_H__ 33 34 #include <psci.h> 35 #include <stdint.h> 36 #include <types.h> 37 38 39 /******************************************************************************* 40 * Forward declarations 41 ******************************************************************************/ 42 struct auth_img_desc_s; 43 struct meminfo; 44 struct image_info; 45 struct entry_point_info; 46 struct bl31_params; 47 struct image_desc; 48 struct bl_load_info; 49 struct bl_params; 50 51 /******************************************************************************* 52 * plat_get_rotpk_info() flags 53 ******************************************************************************/ 54 #define ROTPK_IS_HASH (1 << 0) 55 /* Flag used to skip verification of the certificate ROTPK while the platform 56 ROTPK is not deployed */ 57 #define ROTPK_NOT_DEPLOYED (1 << 1) 58 59 /******************************************************************************* 60 * Function declarations 61 ******************************************************************************/ 62 /******************************************************************************* 63 * Mandatory common functions 64 ******************************************************************************/ 65 unsigned long long plat_get_syscnt_freq(void) __deprecated; 66 unsigned int plat_get_syscnt_freq2(void); 67 68 int plat_get_image_source(unsigned int image_id, 69 uintptr_t *dev_handle, 70 uintptr_t *image_spec); 71 uintptr_t plat_get_ns_image_entrypoint(void); 72 unsigned int plat_my_core_pos(void); 73 int plat_core_pos_by_mpidr(u_register_t mpidr); 74 75 #if STACK_PROTECTOR_ENABLED 76 /* 77 * Return a new value to be used for the stack protection's canary. 78 * 79 * Ideally, this value is a random number that is impossible to predict by an 80 * attacker. 81 */ 82 u_register_t plat_get_stack_protector_canary(void); 83 #endif /* STACK_PROTECTOR_ENABLED */ 84 85 /******************************************************************************* 86 * Mandatory interrupt management functions 87 ******************************************************************************/ 88 uint32_t plat_ic_get_pending_interrupt_id(void); 89 uint32_t plat_ic_get_pending_interrupt_type(void); 90 uint32_t plat_ic_acknowledge_interrupt(void); 91 uint32_t plat_ic_get_interrupt_type(uint32_t id); 92 void plat_ic_end_of_interrupt(uint32_t id); 93 uint32_t plat_interrupt_type_to_line(uint32_t type, 94 uint32_t security_state); 95 96 /******************************************************************************* 97 * Optional common functions (may be overridden) 98 ******************************************************************************/ 99 uintptr_t plat_get_my_stack(void); 100 void plat_report_exception(unsigned int exception_type); 101 int plat_crash_console_init(void); 102 int plat_crash_console_putc(int c); 103 int plat_crash_console_flush(void); 104 void plat_error_handler(int err) __dead2; 105 void plat_panic_handler(void) __dead2; 106 107 /******************************************************************************* 108 * Mandatory BL1 functions 109 ******************************************************************************/ 110 void bl1_early_platform_setup(void); 111 void bl1_plat_arch_setup(void); 112 void bl1_platform_setup(void); 113 struct meminfo *bl1_plat_sec_mem_layout(void); 114 115 /* 116 * The following function is mandatory when the 117 * firmware update feature is used. 118 */ 119 int bl1_plat_mem_check(uintptr_t mem_base, unsigned int mem_size, 120 unsigned int flags); 121 122 /******************************************************************************* 123 * Optional BL1 functions (may be overridden) 124 ******************************************************************************/ 125 void bl1_init_bl2_mem_layout(const struct meminfo *bl1_mem_layout, 126 struct meminfo *bl2_mem_layout); 127 128 /* 129 * The following functions are used for image loading process in BL1. 130 */ 131 void bl1_plat_set_ep_info(unsigned int image_id, 132 struct entry_point_info *ep_info); 133 /* 134 * The following functions are mandatory when firmware update 135 * feature is used and optional otherwise. 136 */ 137 unsigned int bl1_plat_get_next_image_id(void); 138 struct image_desc *bl1_plat_get_image_desc(unsigned int image_id); 139 140 /* 141 * The following functions are used by firmware update 142 * feature and may optionally be overridden. 143 */ 144 __dead2 void bl1_plat_fwu_done(void *client_cookie, void *reserved); 145 146 147 /******************************************************************************* 148 * Mandatory BL2 functions 149 ******************************************************************************/ 150 void bl2_early_platform_setup(struct meminfo *mem_layout); 151 void bl2_plat_arch_setup(void); 152 void bl2_platform_setup(void); 153 struct meminfo *bl2_plat_sec_mem_layout(void); 154 155 #if LOAD_IMAGE_V2 156 /* 157 * This function can be used by the platforms to update/use image 158 * information for given `image_id`. 159 */ 160 int bl2_plat_handle_post_image_load(unsigned int image_id); 161 162 #else /* LOAD_IMAGE_V2 */ 163 164 /* 165 * This function returns a pointer to the shared memory that the platform has 166 * kept aside to pass trusted firmware related information that BL31 167 * could need 168 */ 169 struct bl31_params *bl2_plat_get_bl31_params(void); 170 171 /* 172 * This function returns a pointer to the shared memory that the platform 173 * has kept to point to entry point information of BL31 to BL2 174 */ 175 struct entry_point_info *bl2_plat_get_bl31_ep_info(void); 176 177 /* 178 * This function flushes to main memory all the params that are 179 * passed to BL31 180 */ 181 void bl2_plat_flush_bl31_params(void); 182 183 /* 184 * The next 2 functions allow the platform to change the entrypoint information 185 * for the mandatory 3rd level BL images, BL31 and BL33. This is done after 186 * BL2 has loaded those images into memory but before BL31 is executed. 187 */ 188 void bl2_plat_set_bl31_ep_info(struct image_info *image, 189 struct entry_point_info *ep); 190 191 void bl2_plat_set_bl33_ep_info(struct image_info *image, 192 struct entry_point_info *ep); 193 194 /* Gets the memory layout for BL33 */ 195 void bl2_plat_get_bl33_meminfo(struct meminfo *mem_info); 196 197 /******************************************************************************* 198 * Conditionally mandatory BL2 functions: must be implemented if SCP_BL2 image 199 * is supported 200 ******************************************************************************/ 201 /* Gets the memory layout for SCP_BL2 */ 202 void bl2_plat_get_scp_bl2_meminfo(struct meminfo *mem_info); 203 204 /* 205 * This function is called after loading SCP_BL2 image and it is used to perform 206 * any platform-specific actions required to handle the SCP firmware. 207 */ 208 int bl2_plat_handle_scp_bl2(struct image_info *scp_bl2_image_info); 209 210 /******************************************************************************* 211 * Conditionally mandatory BL2 functions: must be implemented if BL32 image 212 * is supported 213 ******************************************************************************/ 214 void bl2_plat_set_bl32_ep_info(struct image_info *image, 215 struct entry_point_info *ep); 216 217 /* Gets the memory layout for BL32 */ 218 void bl2_plat_get_bl32_meminfo(struct meminfo *mem_info); 219 220 #endif /* LOAD_IMAGE_V2 */ 221 222 /******************************************************************************* 223 * Optional BL2 functions (may be overridden) 224 ******************************************************************************/ 225 226 /******************************************************************************* 227 * Mandatory BL2U functions. 228 ******************************************************************************/ 229 void bl2u_early_platform_setup(struct meminfo *mem_layout, 230 void *plat_info); 231 void bl2u_plat_arch_setup(void); 232 void bl2u_platform_setup(void); 233 234 /******************************************************************************* 235 * Conditionally mandatory BL2U functions for CSS platforms. 236 ******************************************************************************/ 237 /* 238 * This function is used to perform any platform-specific actions required to 239 * handle the BL2U_SCP firmware. 240 */ 241 int bl2u_plat_handle_scp_bl2u(void); 242 243 /******************************************************************************* 244 * Mandatory BL31 functions 245 ******************************************************************************/ 246 #if LOAD_IMAGE_V2 247 void bl31_early_platform_setup(void *from_bl2, 248 void *plat_params_from_bl2); 249 #else 250 void bl31_early_platform_setup(struct bl31_params *from_bl2, 251 void *plat_params_from_bl2); 252 #endif 253 void bl31_plat_arch_setup(void); 254 void bl31_platform_setup(void); 255 void bl31_plat_runtime_setup(void); 256 struct entry_point_info *bl31_plat_get_next_image_ep_info(uint32_t type); 257 258 /******************************************************************************* 259 * Mandatory PSCI functions (BL31) 260 ******************************************************************************/ 261 int plat_setup_psci_ops(uintptr_t sec_entrypoint, 262 const struct plat_psci_ops **); 263 const unsigned char *plat_get_power_domain_tree_desc(void); 264 265 /******************************************************************************* 266 * Optional PSCI functions (BL31). 267 ******************************************************************************/ 268 void plat_psci_stat_accounting_start(const psci_power_state_t *state_info); 269 void plat_psci_stat_accounting_stop(const psci_power_state_t *state_info); 270 u_register_t plat_psci_stat_get_residency(unsigned int lvl, 271 const psci_power_state_t *state_info, 272 int last_cpu_index); 273 plat_local_state_t plat_get_target_pwr_state(unsigned int lvl, 274 const plat_local_state_t *states, 275 unsigned int ncpu); 276 277 /******************************************************************************* 278 * Optional BL31 functions (may be overridden) 279 ******************************************************************************/ 280 void bl31_plat_enable_mmu(uint32_t flags); 281 282 /******************************************************************************* 283 * Optional BL32 functions (may be overridden) 284 ******************************************************************************/ 285 void bl32_plat_enable_mmu(uint32_t flags); 286 287 /******************************************************************************* 288 * Trusted Board Boot functions 289 ******************************************************************************/ 290 int plat_get_rotpk_info(void *cookie, void **key_ptr, unsigned int *key_len, 291 unsigned int *flags); 292 int plat_get_nv_ctr(void *cookie, unsigned int *nv_ctr); 293 int plat_set_nv_ctr(void *cookie, unsigned int nv_ctr); 294 int plat_set_nv_ctr2(void *cookie, const struct auth_img_desc_s *img_desc, 295 unsigned int nv_ctr); 296 297 #if LOAD_IMAGE_V2 298 /******************************************************************************* 299 * Mandatory BL image load functions(may be overridden). 300 ******************************************************************************/ 301 /* 302 * This function returns pointer to the list of images that the 303 * platform has populated to load. 304 */ 305 struct bl_load_info *plat_get_bl_image_load_info(void); 306 307 /* 308 * This function returns a pointer to the shared memory that the 309 * platform has kept aside to pass trusted firmware related 310 * information that next BL image could need. 311 */ 312 struct bl_params *plat_get_next_bl_params(void); 313 314 /* 315 * This function flushes to main memory all the params that are 316 * passed to next image. 317 */ 318 void plat_flush_next_bl_params(void); 319 320 #endif /* LOAD_IMAGE_V2 */ 321 322 #if ENABLE_PLAT_COMPAT 323 /* 324 * The below declarations are to enable compatibility for the platform ports 325 * using the old platform interface. 326 */ 327 328 /******************************************************************************* 329 * Optional common functions (may be overridden) 330 ******************************************************************************/ 331 unsigned int platform_get_core_pos(unsigned long mpidr); 332 333 /******************************************************************************* 334 * Mandatory PSCI Compatibility functions (BL31) 335 ******************************************************************************/ 336 int platform_setup_pm(const plat_pm_ops_t **); 337 338 unsigned int plat_get_aff_count(unsigned int, unsigned long); 339 unsigned int plat_get_aff_state(unsigned int, unsigned long); 340 #else /* __ENABLE_PLAT_COMPAT__ */ 341 /* 342 * The below function enable Trusted Firmware components like SPDs which 343 * haven't migrated to the new platform API to compile on platforms which 344 * have the compatibility layer disabled. 345 */ 346 unsigned int platform_get_core_pos(unsigned long mpidr) __deprecated; 347 348 #endif /* __ENABLE_PLAT_COMPAT__ */ 349 350 #endif /* __PLATFORM_H__ */ 351 352