include/plat/common/platform.h

   1 /*
   2  * Copyright (c) 2013-2019, 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 <stdint.h>
  11
  12 #include <lib/psci/psci.h>
  13
  14 /*******************************************************************************
  15  * Forward declarations
  16  ******************************************************************************/
  17 struct auth_img_desc_s;
  18 struct meminfo;
  19 struct image_info;
  20 struct entry_point_info;
  21 struct image_desc;
  22 struct bl_load_info;
  23 struct bl_params;
  24 struct mmap_region;
  25 struct secure_partition_boot_info;
  26 struct sp_res_desc;
  27
  28 /*******************************************************************************
  29  * plat_get_rotpk_info() flags
  30  ******************************************************************************/
  31 #define ROTPK_IS_HASH                   (1 << 0)
  32 /* Flag used to skip verification of the certificate ROTPK while the platform
  33    ROTPK is not deployed */
  34 #define ROTPK_NOT_DEPLOYED              (1 << 1)
  35
  36 /*******************************************************************************
  37  * Function declarations
  38  ******************************************************************************/
  39 /*******************************************************************************
  40  * Mandatory common functions
  41  ******************************************************************************/
  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 int plat_get_mbedtls_heap(void **heap_addr, size_t *heap_size);
  51
  52 #if STACK_PROTECTOR_ENABLED
  53 /*
  54  * Return a new value to be used for the stack protection's canary.
  55  *
  56  * Ideally, this value is a random number that is impossible to predict by an
  57  * attacker.
  58  */
  59 u_register_t plat_get_stack_protector_canary(void);
  60 #endif /* STACK_PROTECTOR_ENABLED */
  61
  62 /*******************************************************************************
  63  * Mandatory interrupt management functions
  64  ******************************************************************************/
  65 uint32_t plat_ic_get_pending_interrupt_id(void);
  66 uint32_t plat_ic_get_pending_interrupt_type(void);
  67 uint32_t plat_ic_acknowledge_interrupt(void);
  68 uint32_t plat_ic_get_interrupt_type(uint32_t id);
  69 void plat_ic_end_of_interrupt(uint32_t id);
  70 uint32_t plat_interrupt_type_to_line(uint32_t type,
  71                                      uint32_t security_state);
  72
  73 /*******************************************************************************
  74  * Optional interrupt management functions, depending on chosen EL3 components.
  75  ******************************************************************************/
  76 unsigned int plat_ic_get_running_priority(void);
  77 int plat_ic_is_spi(unsigned int id);
  78 int plat_ic_is_ppi(unsigned int id);
  79 int plat_ic_is_sgi(unsigned int id);
  80 unsigned int plat_ic_get_interrupt_active(unsigned int id);
  81 void plat_ic_disable_interrupt(unsigned int id);
  82 void plat_ic_enable_interrupt(unsigned int id);
  83 int plat_ic_has_interrupt_type(unsigned int type);
  84 void plat_ic_set_interrupt_type(unsigned int id, unsigned int type);
  85 void plat_ic_set_interrupt_priority(unsigned int id, unsigned int priority);
  86 void plat_ic_raise_el3_sgi(int sgi_num, u_register_t target);
  87 void plat_ic_set_spi_routing(unsigned int id, unsigned int routing_mode,
  88                 u_register_t mpidr);
  89 void plat_ic_set_interrupt_pending(unsigned int id);
  90 void plat_ic_clear_interrupt_pending(unsigned int id);
  91 unsigned int plat_ic_set_priority_mask(unsigned int mask);
  92 unsigned int plat_ic_get_interrupt_id(unsigned int raw);
  93
  94 /*******************************************************************************
  95  * Optional common functions (may be overridden)
  96  ******************************************************************************/
  97 uintptr_t plat_get_my_stack(void);
  98 void plat_report_exception(unsigned int exception_type);
  99 int plat_crash_console_init(void);
 100 int plat_crash_console_putc(int c);
 101 int plat_crash_console_flush(void);
 102 void plat_error_handler(int err) __dead2;
 103 void plat_panic_handler(void) __dead2;
 104 const char *plat_log_get_prefix(unsigned int log_level);
 105 void bl2_plat_preload_setup(void);
 106 int plat_try_next_boot_source(void);
 107 uint64_t *plat_init_apiakey(void);
 108
 109 /*******************************************************************************
 110  * Mandatory BL1 functions
 111  ******************************************************************************/
 112 void bl1_early_platform_setup(void);
 113 void bl1_plat_arch_setup(void);
 114 void bl1_platform_setup(void);
 115 struct meminfo *bl1_plat_sec_mem_layout(void);
 116
 117 /*******************************************************************************
 118  * Optional EL3 component functions in BL31
 119  ******************************************************************************/
 120
 121 /* SDEI platform functions */
 122 #if SDEI_SUPPORT
 123 int plat_sdei_validate_entry_point(uintptr_t ep, unsigned int client_mode);
 124 void plat_sdei_handle_masked_trigger(uint64_t mpidr, unsigned int intr);
 125 #endif
 126
 127 void plat_ea_handler(unsigned int ea_reason, uint64_t syndrome, void *cookie,
 128                 void *handle, uint64_t flags);
 129
 130 /*
 131  * The following function is mandatory when the
 132  * firmware update feature is used.
 133  */
 134 int bl1_plat_mem_check(uintptr_t mem_base, unsigned int mem_size,
 135                 unsigned int flags);
 136
 137 /*******************************************************************************
 138  * Optional BL1 functions (may be overridden)
 139  ******************************************************************************/
 140 /*
 141  * The following functions are used for image loading process in BL1.
 142  */
 143 void bl1_plat_set_ep_info(unsigned int image_id,
 144                 struct entry_point_info *ep_info);
 145 /*
 146  * The following functions are mandatory when firmware update
 147  * feature is used and optional otherwise.
 148  */
 149 unsigned int bl1_plat_get_next_image_id(void);
 150 struct image_desc *bl1_plat_get_image_desc(unsigned int image_id);
 151
 152 /*
 153  * The following functions are used by firmware update
 154  * feature and may optionally be overridden.
 155  */
 156 __dead2 void bl1_plat_fwu_done(void *client_cookie, void *reserved);
 157
 158 /*
 159  * This BL1 function can be used by the platforms to update/use image
 160  * information for a given `image_id`.
 161  */
 162 int bl1_plat_handle_pre_image_load(unsigned int image_id);
 163 int bl1_plat_handle_post_image_load(unsigned int image_id);
 164
 165 /*******************************************************************************
 166  * Mandatory BL2 functions
 167  ******************************************************************************/
 168 void bl2_early_platform_setup2(u_register_t arg0, u_register_t arg1, u_register_t arg2, u_register_t arg3);
 169 void bl2_plat_arch_setup(void);
 170 void bl2_platform_setup(void);
 171 struct meminfo *bl2_plat_sec_mem_layout(void);
 172
 173 /*
 174  * This function can be used by the platforms to update/use image
 175  * information for given `image_id`.
 176  */
 177 int bl2_plat_handle_pre_image_load(unsigned int image_id);
 178 int bl2_plat_handle_post_image_load(unsigned int image_id);
 179
 180
 181 /*******************************************************************************
 182  * Optional BL2 functions (may be overridden)
 183  ******************************************************************************/
 184
 185
 186 /*******************************************************************************
 187  * Mandatory BL2 at EL3 functions: Must be implemented if BL2_AT_EL3 image is
 188  * supported
 189  ******************************************************************************/
 190 void bl2_el3_early_platform_setup(u_register_t arg0, u_register_t arg1,
 191                                   u_register_t arg2, u_register_t arg3);
 192 void bl2_el3_plat_arch_setup(void);
 193
 194
 195 /*******************************************************************************
 196  * Optional BL2 at EL3 functions (may be overridden)
 197  ******************************************************************************/
 198 void bl2_el3_plat_prepare_exit(void);
 199
 200 /*******************************************************************************
 201  * Mandatory BL2U functions.
 202  ******************************************************************************/
 203 void bl2u_early_platform_setup(struct meminfo *mem_layout,
 204                 void *plat_info);
 205 void bl2u_plat_arch_setup(void);
 206 void bl2u_platform_setup(void);
 207
 208 /*******************************************************************************
 209  * Conditionally mandatory BL2U functions for CSS platforms.
 210  ******************************************************************************/
 211 /*
 212  * This function is used to perform any platform-specific actions required to
 213  * handle the BL2U_SCP firmware.
 214  */
 215 int bl2u_plat_handle_scp_bl2u(void);
 216
 217 /*******************************************************************************
 218  * Mandatory BL31 functions
 219  ******************************************************************************/
 220 void bl31_early_platform_setup2(u_register_t arg0, u_register_t arg1,
 221                 u_register_t arg2, u_register_t arg3);
 222 void bl31_plat_arch_setup(void);
 223 void bl31_platform_setup(void);
 224 void bl31_plat_runtime_setup(void);
 225 struct entry_point_info *bl31_plat_get_next_image_ep_info(uint32_t type);
 226
 227 /*******************************************************************************
 228  * Mandatory PSCI functions (BL31)
 229  ******************************************************************************/
 230 int plat_setup_psci_ops(uintptr_t sec_entrypoint,
 231                         const struct plat_psci_ops **psci_ops);
 232 const unsigned char *plat_get_power_domain_tree_desc(void);
 233
 234 /*******************************************************************************
 235  * Optional PSCI functions (BL31).
 236  ******************************************************************************/
 237 void plat_psci_stat_accounting_start(const psci_power_state_t *state_info);
 238 void plat_psci_stat_accounting_stop(const psci_power_state_t *state_info);
 239 u_register_t plat_psci_stat_get_residency(unsigned int lvl,
 240                         const psci_power_state_t *state_info,
 241                         int last_cpu_idx);
 242 plat_local_state_t plat_get_target_pwr_state(unsigned int lvl,
 243                         const plat_local_state_t *states,
 244                         unsigned int ncpu);
 245
 246 /*******************************************************************************
 247  * Optional BL31 functions (may be overridden)
 248  ******************************************************************************/
 249 void bl31_plat_enable_mmu(uint32_t flags);
 250
 251 /*******************************************************************************
 252  * Optional BL32 functions (may be overridden)
 253  ******************************************************************************/
 254 void bl32_plat_enable_mmu(uint32_t flags);
 255
 256 /*******************************************************************************
 257  * Trusted Board Boot functions
 258  ******************************************************************************/
 259 int plat_get_rotpk_info(void *cookie, void **key_ptr, unsigned int *key_len,
 260                         unsigned int *flags);
 261 int plat_get_nv_ctr(void *cookie, unsigned int *nv_ctr);
 262 int plat_set_nv_ctr(void *cookie, unsigned int nv_ctr);
 263 int plat_set_nv_ctr2(void *cookie, const struct auth_img_desc_s *img_desc,
 264                 unsigned int nv_ctr);
 265 int get_mbedtls_heap_helper(void **heap_addr, size_t *heap_size);
 266
 267 /*******************************************************************************
 268  * Secure Partitions functions
 269  ******************************************************************************/
 270 const struct mmap_region *plat_get_secure_partition_mmap(void *cookie);
 271 const struct secure_partition_boot_info *plat_get_secure_partition_boot_info(
 272                 void *cookie);
 273 int plat_spm_sp_rd_load(struct sp_res_desc *rd, const void *ptr, size_t size);
 274 int plat_spm_sp_get_next_address(void **sp_base, size_t *sp_size,
 275                                  void **rd_base, size_t *rd_size);
 276
 277 /*******************************************************************************
 278  * Mandatory BL image load functions(may be overridden).
 279  ******************************************************************************/
 280 /*
 281  * This function returns pointer to the list of images that the
 282  * platform has populated to load.
 283  */
 284 struct bl_load_info *plat_get_bl_image_load_info(void);
 285
 286 /*
 287  * This function returns a pointer to the shared memory that the
 288  * platform has kept aside to pass trusted firmware related
 289  * information that next BL image could need.
 290  */
 291 struct bl_params *plat_get_next_bl_params(void);
 292
 293 /*
 294  * This function flushes to main memory all the params that are
 295  * passed to next image.
 296  */
 297 void plat_flush_next_bl_params(void);
 298
 299 /*
 300  * The below function enable Trusted Firmware components like SPDs which
 301  * haven't migrated to the new platform API to compile on platforms which
 302  * have the compatibility layer disabled.
 303  */
 304 unsigned int platform_core_pos_helper(unsigned long mpidr);
 305
 306 #endif /* PLATFORM_H */