Dan Handley | ed6ff95 | 2014-05-14 17:44:19 +0100 | [diff] [blame] | 1 | /* |
Soby Mathew | 294e1cf | 2022-03-22 16:19:39 +0000 | [diff] [blame^] | 2 | * Copyright (c) 2013-2022, ARM Limited and Contributors. All rights reserved. |
Dan Handley | ed6ff95 | 2014-05-14 17:44:19 +0100 | [diff] [blame] | 3 | * |
dp-arm | fa3cf0b | 2017-05-03 09:38:09 +0100 | [diff] [blame] | 4 | * SPDX-License-Identifier: BSD-3-Clause |
Dan Handley | ed6ff95 | 2014-05-14 17:44:19 +0100 | [diff] [blame] | 5 | */ |
| 6 | |
Antonio Nino Diaz | fec756f | 2018-07-18 16:24:16 +0100 | [diff] [blame] | 7 | #ifndef PLATFORM_H |
| 8 | #define PLATFORM_H |
Dan Handley | ed6ff95 | 2014-05-14 17:44:19 +0100 | [diff] [blame] | 9 | |
| 10 | #include <stdint.h> |
Dan Handley | ed6ff95 | 2014-05-14 17:44:19 +0100 | [diff] [blame] | 11 | |
Antonio Nino Diaz | e0f9063 | 2018-12-14 00:18:21 +0000 | [diff] [blame] | 12 | #include <lib/psci/psci.h> |
Achin Gupta | da6ef0e | 2019-10-11 14:54:48 +0100 | [diff] [blame] | 13 | #if defined(SPD_spmd) |
| 14 | #include <services/spm_core_manifest.h> |
| 15 | #endif |
Jimmy Brisson | 26c5b5c | 2020-06-22 14:18:42 -0500 | [diff] [blame] | 16 | #if TRNG_SUPPORT |
| 17 | #include "plat_trng.h" |
| 18 | #endif |
Manish V Badarkhe | a040b64 | 2021-06-20 21:04:49 +0100 | [diff] [blame] | 19 | #include <drivers/fwu/fwu_metadata.h> |
Antonio Nino Diaz | e0f9063 | 2018-12-14 00:18:21 +0000 | [diff] [blame] | 20 | |
Dan Handley | ed6ff95 | 2014-05-14 17:44:19 +0100 | [diff] [blame] | 21 | /******************************************************************************* |
| 22 | * Forward declarations |
| 23 | ******************************************************************************/ |
dp-arm | b3e8580 | 2016-12-12 14:48:13 +0000 | [diff] [blame] | 24 | struct auth_img_desc_s; |
Dan Handley | ed6ff95 | 2014-05-14 17:44:19 +0100 | [diff] [blame] | 25 | struct meminfo; |
| 26 | struct image_info; |
| 27 | struct entry_point_info; |
Yatharth Kochar | a65be2f | 2015-10-09 18:06:13 +0100 | [diff] [blame] | 28 | struct image_desc; |
Yatharth Kochar | 3345a8d | 2016-09-12 16:08:41 +0100 | [diff] [blame] | 29 | struct bl_load_info; |
| 30 | struct bl_params; |
Antonio Nino Diaz | c41f206 | 2017-10-24 10:07:35 +0100 | [diff] [blame] | 31 | struct mmap_region; |
Paul Beesley | 45f4028 | 2019-10-15 10:57:42 +0000 | [diff] [blame] | 32 | struct spm_mm_boot_info; |
Antonio Nino Diaz | b86edcb | 2018-10-30 11:12:42 +0000 | [diff] [blame] | 33 | struct sp_res_desc; |
Sumit Garg | 617e215 | 2019-11-15 15:34:55 +0530 | [diff] [blame] | 34 | enum fw_enc_status_t; |
Dan Handley | ed6ff95 | 2014-05-14 17:44:19 +0100 | [diff] [blame] | 35 | |
| 36 | /******************************************************************************* |
Juan Castillo | 31a68f0 | 2015-04-14 12:49:03 +0100 | [diff] [blame] | 37 | * plat_get_rotpk_info() flags |
| 38 | ******************************************************************************/ |
| 39 | #define ROTPK_IS_HASH (1 << 0) |
Soby Mathew | 2f7ed05 | 2016-05-24 15:05:15 +0100 | [diff] [blame] | 40 | /* Flag used to skip verification of the certificate ROTPK while the platform |
| 41 | ROTPK is not deployed */ |
| 42 | #define ROTPK_NOT_DEPLOYED (1 << 1) |
Juan Castillo | 31a68f0 | 2015-04-14 12:49:03 +0100 | [diff] [blame] | 43 | |
| 44 | /******************************************************************************* |
Sumit Garg | 392e4df | 2019-11-15 10:43:00 +0530 | [diff] [blame] | 45 | * plat_get_enc_key_info() flags |
| 46 | ******************************************************************************/ |
| 47 | /* |
| 48 | * Flag used to notify caller that information provided in key buffer is an |
| 49 | * identifier rather than an actual key. |
| 50 | */ |
| 51 | #define ENC_KEY_IS_IDENTIFIER (1 << 0) |
| 52 | |
| 53 | /******************************************************************************* |
Dan Handley | 7ce42df | 2014-05-15 14:11:36 +0100 | [diff] [blame] | 54 | * Function declarations |
Dan Handley | ed6ff95 | 2014-05-14 17:44:19 +0100 | [diff] [blame] | 55 | ******************************************************************************/ |
Dan Handley | 7ce42df | 2014-05-15 14:11:36 +0100 | [diff] [blame] | 56 | /******************************************************************************* |
| 57 | * Mandatory common functions |
| 58 | ******************************************************************************/ |
Antonio Nino Diaz | 391a76e | 2016-05-18 16:53:31 +0100 | [diff] [blame] | 59 | unsigned int plat_get_syscnt_freq2(void); |
| 60 | |
Juan Castillo | 3a66aca | 2015-04-13 17:36:19 +0100 | [diff] [blame] | 61 | int plat_get_image_source(unsigned int image_id, |
Dan Handley | 7ce42df | 2014-05-15 14:11:36 +0100 | [diff] [blame] | 62 | uintptr_t *dev_handle, |
| 63 | uintptr_t *image_spec); |
Soby Mathew | 21f9361 | 2016-03-23 10:11:10 +0000 | [diff] [blame] | 64 | uintptr_t plat_get_ns_image_entrypoint(void); |
Soby Mathew | 981487a | 2015-07-13 14:10:57 +0100 | [diff] [blame] | 65 | unsigned int plat_my_core_pos(void); |
| 66 | int plat_core_pos_by_mpidr(u_register_t mpidr); |
Ambroise Vincent | d207f56 | 2019-04-10 12:50:27 +0100 | [diff] [blame] | 67 | int plat_get_mbedtls_heap(void **heap_addr, size_t *heap_size); |
Dan Handley | 7ce42df | 2014-05-15 14:11:36 +0100 | [diff] [blame] | 68 | |
Douglas Raillard | 306593d | 2017-02-24 18:14:15 +0000 | [diff] [blame] | 69 | #if STACK_PROTECTOR_ENABLED |
| 70 | /* |
| 71 | * Return a new value to be used for the stack protection's canary. |
| 72 | * |
| 73 | * Ideally, this value is a random number that is impossible to predict by an |
| 74 | * attacker. |
| 75 | */ |
| 76 | u_register_t plat_get_stack_protector_canary(void); |
| 77 | #endif /* STACK_PROTECTOR_ENABLED */ |
| 78 | |
Dan Handley | 7ce42df | 2014-05-15 14:11:36 +0100 | [diff] [blame] | 79 | /******************************************************************************* |
| 80 | * Mandatory interrupt management functions |
| 81 | ******************************************************************************/ |
Dan Handley | 701fea7 | 2014-05-27 16:17:21 +0100 | [diff] [blame] | 82 | uint32_t plat_ic_get_pending_interrupt_id(void); |
| 83 | uint32_t plat_ic_get_pending_interrupt_type(void); |
| 84 | uint32_t plat_ic_acknowledge_interrupt(void); |
| 85 | uint32_t plat_ic_get_interrupt_type(uint32_t id); |
| 86 | void plat_ic_end_of_interrupt(uint32_t id); |
Dan Handley | ed6ff95 | 2014-05-14 17:44:19 +0100 | [diff] [blame] | 87 | uint32_t plat_interrupt_type_to_line(uint32_t type, |
| 88 | uint32_t security_state); |
| 89 | |
Dan Handley | 7ce42df | 2014-05-15 14:11:36 +0100 | [diff] [blame] | 90 | /******************************************************************************* |
Jeenu Viswambharan | b1e957e | 2017-09-22 08:32:09 +0100 | [diff] [blame] | 91 | * Optional interrupt management functions, depending on chosen EL3 components. |
| 92 | ******************************************************************************/ |
| 93 | unsigned int plat_ic_get_running_priority(void); |
Jeenu Viswambharan | 522a465 | 2017-09-22 08:32:09 +0100 | [diff] [blame] | 94 | int plat_ic_is_spi(unsigned int id); |
| 95 | int plat_ic_is_ppi(unsigned int id); |
| 96 | int plat_ic_is_sgi(unsigned int id); |
Jeenu Viswambharan | 24e7029 | 2017-09-22 08:32:09 +0100 | [diff] [blame] | 97 | unsigned int plat_ic_get_interrupt_active(unsigned int id); |
Jeenu Viswambharan | 0fcdfff | 2017-09-22 08:32:09 +0100 | [diff] [blame] | 98 | void plat_ic_disable_interrupt(unsigned int id); |
| 99 | void plat_ic_enable_interrupt(unsigned int id); |
Jeenu Viswambharan | c06f05c | 2017-09-22 08:32:09 +0100 | [diff] [blame] | 100 | int plat_ic_has_interrupt_type(unsigned int type); |
| 101 | void plat_ic_set_interrupt_type(unsigned int id, unsigned int type); |
Jeenu Viswambharan | 447b89d | 2017-09-22 08:32:09 +0100 | [diff] [blame] | 102 | void plat_ic_set_interrupt_priority(unsigned int id, unsigned int priority); |
Jeenu Viswambharan | ab14e9b | 2017-09-22 08:32:09 +0100 | [diff] [blame] | 103 | void plat_ic_raise_el3_sgi(int sgi_num, u_register_t target); |
Jeenu Viswambharan | dce70b3 | 2017-09-22 08:32:09 +0100 | [diff] [blame] | 104 | void plat_ic_set_spi_routing(unsigned int id, unsigned int routing_mode, |
| 105 | u_register_t mpidr); |
Jeenu Viswambharan | eb1c12c | 2017-09-22 08:32:09 +0100 | [diff] [blame] | 106 | void plat_ic_set_interrupt_pending(unsigned int id); |
| 107 | void plat_ic_clear_interrupt_pending(unsigned int id); |
Jeenu Viswambharan | 6250507 | 2017-09-22 08:32:09 +0100 | [diff] [blame] | 108 | unsigned int plat_ic_set_priority_mask(unsigned int mask); |
Jeenu Viswambharan | 055af4b | 2017-10-24 15:13:59 +0100 | [diff] [blame] | 109 | unsigned int plat_ic_get_interrupt_id(unsigned int raw); |
Jeenu Viswambharan | b1e957e | 2017-09-22 08:32:09 +0100 | [diff] [blame] | 110 | |
| 111 | /******************************************************************************* |
Dan Handley | 7ce42df | 2014-05-15 14:11:36 +0100 | [diff] [blame] | 112 | * Optional common functions (may be overridden) |
| 113 | ******************************************************************************/ |
Soby Mathew | a0fedc4 | 2016-06-16 14:52:04 +0100 | [diff] [blame] | 114 | uintptr_t plat_get_my_stack(void); |
Yatharth Kochar | f528faf | 2016-06-28 16:58:26 +0100 | [diff] [blame] | 115 | void plat_report_exception(unsigned int exception_type); |
Sandrine Bailleux | 046cd3f | 2014-08-06 11:27:23 +0100 | [diff] [blame] | 116 | int plat_crash_console_init(void); |
Soby Mathew | 066f713 | 2014-07-14 16:57:23 +0100 | [diff] [blame] | 117 | int plat_crash_console_putc(int c); |
Jimmy Brisson | 39f9eee | 2020-08-05 13:44:05 -0500 | [diff] [blame] | 118 | void plat_crash_console_flush(void); |
Juan Castillo | 26ae583 | 2015-09-25 15:41:14 +0100 | [diff] [blame] | 119 | void plat_error_handler(int err) __dead2; |
Antonio Nino Diaz | 1f21bcf | 2016-02-01 13:57:25 +0000 | [diff] [blame] | 120 | void plat_panic_handler(void) __dead2; |
Soby Mathew | aaf15f5 | 2017-09-04 11:49:29 +0100 | [diff] [blame] | 121 | const char *plat_log_get_prefix(unsigned int log_level); |
Roberto Vargas | bc1ae1f | 2017-09-26 12:53:01 +0100 | [diff] [blame] | 122 | void bl2_plat_preload_setup(void); |
| 123 | int plat_try_next_boot_source(void); |
Dan Handley | 7ce42df | 2014-05-15 14:11:36 +0100 | [diff] [blame] | 124 | |
Manish V Badarkhe | a74d963 | 2021-09-14 23:12:42 +0100 | [diff] [blame] | 125 | #if MEASURED_BOOT |
| 126 | int plat_mboot_measure_image(unsigned int image_id, image_info_t *image_data); |
Manish V Badarkhe | 1ffa009 | 2021-10-20 22:06:40 +0100 | [diff] [blame] | 127 | int plat_mboot_measure_critical_data(unsigned int critical_data_id, |
| 128 | const void *base, |
| 129 | size_t size); |
Manish V Badarkhe | a74d963 | 2021-09-14 23:12:42 +0100 | [diff] [blame] | 130 | #else |
| 131 | static inline int plat_mboot_measure_image(unsigned int image_id __unused, |
| 132 | image_info_t *image_data __unused) |
| 133 | { |
| 134 | return 0; |
| 135 | } |
Manish V Badarkhe | 1ffa009 | 2021-10-20 22:06:40 +0100 | [diff] [blame] | 136 | static inline int plat_mboot_measure_critical_data( |
| 137 | unsigned int critical_data_id __unused, |
| 138 | const void *base __unused, |
| 139 | size_t size __unused) |
| 140 | { |
| 141 | return 0; |
| 142 | } |
Manish V Badarkhe | a74d963 | 2021-09-14 23:12:42 +0100 | [diff] [blame] | 143 | #endif /* MEASURED_BOOT */ |
| 144 | |
Dan Handley | 7ce42df | 2014-05-15 14:11:36 +0100 | [diff] [blame] | 145 | /******************************************************************************* |
| 146 | * Mandatory BL1 functions |
| 147 | ******************************************************************************/ |
Dan Handley | 4fd2f5c | 2014-08-04 11:41:20 +0100 | [diff] [blame] | 148 | void bl1_early_platform_setup(void); |
Dan Handley | 7ce42df | 2014-05-15 14:11:36 +0100 | [diff] [blame] | 149 | void bl1_plat_arch_setup(void); |
| 150 | void bl1_platform_setup(void); |
| 151 | struct meminfo *bl1_plat_sec_mem_layout(void); |
Dan Handley | ed6ff95 | 2014-05-14 17:44:19 +0100 | [diff] [blame] | 152 | |
Jeenu Viswambharan | 04e3a7f | 2017-10-16 08:43:14 +0100 | [diff] [blame] | 153 | /******************************************************************************* |
| 154 | * Optional EL3 component functions in BL31 |
| 155 | ******************************************************************************/ |
| 156 | |
| 157 | /* SDEI platform functions */ |
| 158 | #if SDEI_SUPPORT |
Balint Dobszay | d0dbd5e | 2019-12-18 15:28:00 +0100 | [diff] [blame] | 159 | void plat_sdei_setup(void); |
Jeenu Viswambharan | 04e3a7f | 2017-10-16 08:43:14 +0100 | [diff] [blame] | 160 | int plat_sdei_validate_entry_point(uintptr_t ep, unsigned int client_mode); |
| 161 | void plat_sdei_handle_masked_trigger(uint64_t mpidr, unsigned int intr); |
| 162 | #endif |
| 163 | |
Pali Rohár | c36e97f | 2021-06-21 17:22:27 +0200 | [diff] [blame] | 164 | void plat_default_ea_handler(unsigned int ea_reason, uint64_t syndrome, void *cookie, |
| 165 | void *handle, uint64_t flags); |
Jeenu Viswambharan | 96c7df0 | 2017-11-30 12:54:15 +0000 | [diff] [blame] | 166 | void plat_ea_handler(unsigned int ea_reason, uint64_t syndrome, void *cookie, |
| 167 | void *handle, uint64_t flags); |
| 168 | |
Yatharth Kochar | 71c9a5e | 2015-10-10 19:06:53 +0100 | [diff] [blame] | 169 | /* |
| 170 | * The following function is mandatory when the |
| 171 | * firmware update feature is used. |
| 172 | */ |
| 173 | int bl1_plat_mem_check(uintptr_t mem_base, unsigned int mem_size, |
| 174 | unsigned int flags); |
| 175 | |
Dan Handley | 7ce42df | 2014-05-15 14:11:36 +0100 | [diff] [blame] | 176 | /******************************************************************************* |
| 177 | * Optional BL1 functions (may be overridden) |
| 178 | ******************************************************************************/ |
Yatharth Kochar | a65be2f | 2015-10-09 18:06:13 +0100 | [diff] [blame] | 179 | /* |
| 180 | * The following functions are used for image loading process in BL1. |
| 181 | */ |
| 182 | void bl1_plat_set_ep_info(unsigned int image_id, |
| 183 | struct entry_point_info *ep_info); |
Yatharth Kochar | 71c9a5e | 2015-10-10 19:06:53 +0100 | [diff] [blame] | 184 | /* |
| 185 | * The following functions are mandatory when firmware update |
| 186 | * feature is used and optional otherwise. |
| 187 | */ |
Yatharth Kochar | a65be2f | 2015-10-09 18:06:13 +0100 | [diff] [blame] | 188 | unsigned int bl1_plat_get_next_image_id(void); |
| 189 | struct image_desc *bl1_plat_get_image_desc(unsigned int image_id); |
Dan Handley | 7ce42df | 2014-05-15 14:11:36 +0100 | [diff] [blame] | 190 | |
Yatharth Kochar | 71c9a5e | 2015-10-10 19:06:53 +0100 | [diff] [blame] | 191 | /* |
| 192 | * The following functions are used by firmware update |
| 193 | * feature and may optionally be overridden. |
| 194 | */ |
Dan Handley | 89f8f33 | 2015-12-15 14:28:24 +0000 | [diff] [blame] | 195 | __dead2 void bl1_plat_fwu_done(void *client_cookie, void *reserved); |
Yatharth Kochar | 71c9a5e | 2015-10-10 19:06:53 +0100 | [diff] [blame] | 196 | |
Masahiro Yamada | 43d20b3 | 2018-02-01 16:46:18 +0900 | [diff] [blame] | 197 | /* |
Soby Mathew | 2f38ce3 | 2018-02-08 17:45:12 +0000 | [diff] [blame] | 198 | * This BL1 function can be used by the platforms to update/use image |
| 199 | * information for a given `image_id`. |
Masahiro Yamada | 43d20b3 | 2018-02-01 16:46:18 +0900 | [diff] [blame] | 200 | */ |
Soby Mathew | 2f38ce3 | 2018-02-08 17:45:12 +0000 | [diff] [blame] | 201 | int bl1_plat_handle_pre_image_load(unsigned int image_id); |
| 202 | int bl1_plat_handle_post_image_load(unsigned int image_id); |
Yatharth Kochar | 71c9a5e | 2015-10-10 19:06:53 +0100 | [diff] [blame] | 203 | |
Manish V Badarkhe | a74d963 | 2021-09-14 23:12:42 +0100 | [diff] [blame] | 204 | #if MEASURED_BOOT |
| 205 | void bl1_plat_mboot_init(void); |
| 206 | void bl1_plat_mboot_finish(void); |
| 207 | #else |
| 208 | static inline void bl1_plat_mboot_init(void) |
| 209 | { |
| 210 | } |
| 211 | static inline void bl1_plat_mboot_finish(void) |
| 212 | { |
| 213 | } |
| 214 | #endif /* MEASURED_BOOT */ |
| 215 | |
Dan Handley | 7ce42df | 2014-05-15 14:11:36 +0100 | [diff] [blame] | 216 | /******************************************************************************* |
| 217 | * Mandatory BL2 functions |
| 218 | ******************************************************************************/ |
Soby Mathew | 73308d0 | 2018-01-09 14:36:14 +0000 | [diff] [blame] | 219 | void bl2_early_platform_setup2(u_register_t arg0, u_register_t arg1, u_register_t arg2, u_register_t arg3); |
Dan Handley | 7ce42df | 2014-05-15 14:11:36 +0100 | [diff] [blame] | 220 | void bl2_plat_arch_setup(void); |
| 221 | void bl2_platform_setup(void); |
| 222 | struct meminfo *bl2_plat_sec_mem_layout(void); |
| 223 | |
Yatharth Kochar | 3345a8d | 2016-09-12 16:08:41 +0100 | [diff] [blame] | 224 | /* |
| 225 | * This function can be used by the platforms to update/use image |
| 226 | * information for given `image_id`. |
| 227 | */ |
Masahiro Yamada | 02a0d3d | 2018-02-01 16:45:51 +0900 | [diff] [blame] | 228 | int bl2_plat_handle_pre_image_load(unsigned int image_id); |
Yatharth Kochar | 3345a8d | 2016-09-12 16:08:41 +0100 | [diff] [blame] | 229 | int bl2_plat_handle_post_image_load(unsigned int image_id); |
| 230 | |
Sandrine Bailleux | f841ef0 | 2014-06-24 14:19:36 +0100 | [diff] [blame] | 231 | /******************************************************************************* |
Dan Handley | 7ce42df | 2014-05-15 14:11:36 +0100 | [diff] [blame] | 232 | * Optional BL2 functions (may be overridden) |
| 233 | ******************************************************************************/ |
Alexei Fedorov | c717617 | 2020-07-13 12:11:05 +0100 | [diff] [blame] | 234 | #if MEASURED_BOOT |
Manish V Badarkhe | 5797b80 | 2021-08-06 09:26:20 +0100 | [diff] [blame] | 235 | void bl2_plat_mboot_init(void); |
| 236 | void bl2_plat_mboot_finish(void); |
| 237 | #else |
| 238 | static inline void bl2_plat_mboot_init(void) |
| 239 | { |
| 240 | } |
| 241 | static inline void bl2_plat_mboot_finish(void) |
| 242 | { |
Manish V Badarkhe | 57b669f | 2021-09-20 09:06:02 +0100 | [diff] [blame] | 243 | } |
Manish V Badarkhe | 5797b80 | 2021-08-06 09:26:20 +0100 | [diff] [blame] | 244 | #endif /* MEASURED_BOOT */ |
Roberto Vargas | e0e9946 | 2017-10-30 14:43:43 +0000 | [diff] [blame] | 245 | |
| 246 | /******************************************************************************* |
| 247 | * Mandatory BL2 at EL3 functions: Must be implemented if BL2_AT_EL3 image is |
| 248 | * supported |
| 249 | ******************************************************************************/ |
| 250 | void bl2_el3_early_platform_setup(u_register_t arg0, u_register_t arg1, |
| 251 | u_register_t arg2, u_register_t arg3); |
| 252 | void bl2_el3_plat_arch_setup(void); |
| 253 | |
Roberto Vargas | e0e9946 | 2017-10-30 14:43:43 +0000 | [diff] [blame] | 254 | /******************************************************************************* |
| 255 | * Optional BL2 at EL3 functions (may be overridden) |
| 256 | ******************************************************************************/ |
| 257 | void bl2_el3_plat_prepare_exit(void); |
| 258 | |
Dan Handley | 7ce42df | 2014-05-15 14:11:36 +0100 | [diff] [blame] | 259 | /******************************************************************************* |
Yatharth Kochar | b1c2fe0 | 2015-10-14 15:27:24 +0100 | [diff] [blame] | 260 | * Mandatory BL2U functions. |
| 261 | ******************************************************************************/ |
| 262 | void bl2u_early_platform_setup(struct meminfo *mem_layout, |
| 263 | void *plat_info); |
| 264 | void bl2u_plat_arch_setup(void); |
| 265 | void bl2u_platform_setup(void); |
| 266 | |
| 267 | /******************************************************************************* |
| 268 | * Conditionally mandatory BL2U functions for CSS platforms. |
| 269 | ******************************************************************************/ |
| 270 | /* |
| 271 | * This function is used to perform any platform-specific actions required to |
| 272 | * handle the BL2U_SCP firmware. |
| 273 | */ |
| 274 | int bl2u_plat_handle_scp_bl2u(void); |
| 275 | |
| 276 | /******************************************************************************* |
Juan Castillo | 7d19941 | 2015-12-14 09:35:25 +0000 | [diff] [blame] | 277 | * Mandatory BL31 functions |
Dan Handley | 7ce42df | 2014-05-15 14:11:36 +0100 | [diff] [blame] | 278 | ******************************************************************************/ |
Soby Mathew | 73308d0 | 2018-01-09 14:36:14 +0000 | [diff] [blame] | 279 | void bl31_early_platform_setup2(u_register_t arg0, u_register_t arg1, |
| 280 | u_register_t arg2, u_register_t arg3); |
Dan Handley | 7ce42df | 2014-05-15 14:11:36 +0100 | [diff] [blame] | 281 | void bl31_plat_arch_setup(void); |
| 282 | void bl31_platform_setup(void); |
Soby Mathew | 1ff495b | 2015-12-09 11:28:43 +0000 | [diff] [blame] | 283 | void bl31_plat_runtime_setup(void); |
Dan Handley | 701fea7 | 2014-05-27 16:17:21 +0100 | [diff] [blame] | 284 | struct entry_point_info *bl31_plat_get_next_image_ep_info(uint32_t type); |
Dan Handley | 7ce42df | 2014-05-15 14:11:36 +0100 | [diff] [blame] | 285 | |
| 286 | /******************************************************************************* |
Juan Castillo | 7d19941 | 2015-12-14 09:35:25 +0000 | [diff] [blame] | 287 | * Mandatory PSCI functions (BL31) |
Dan Handley | 7ce42df | 2014-05-15 14:11:36 +0100 | [diff] [blame] | 288 | ******************************************************************************/ |
Soby Mathew | 981487a | 2015-07-13 14:10:57 +0100 | [diff] [blame] | 289 | int plat_setup_psci_ops(uintptr_t sec_entrypoint, |
Roberto Vargas | 777dd43 | 2018-02-12 12:36:17 +0000 | [diff] [blame] | 290 | const struct plat_psci_ops **psci_ops); |
Soby Mathew | 981487a | 2015-07-13 14:10:57 +0100 | [diff] [blame] | 291 | const unsigned char *plat_get_power_domain_tree_desc(void); |
| 292 | |
| 293 | /******************************************************************************* |
Juan Castillo | 7d19941 | 2015-12-14 09:35:25 +0000 | [diff] [blame] | 294 | * Optional PSCI functions (BL31). |
Soby Mathew | 981487a | 2015-07-13 14:10:57 +0100 | [diff] [blame] | 295 | ******************************************************************************/ |
dp-arm | 66abfbe | 2017-01-31 13:01:04 +0000 | [diff] [blame] | 296 | void plat_psci_stat_accounting_start(const psci_power_state_t *state_info); |
| 297 | void plat_psci_stat_accounting_stop(const psci_power_state_t *state_info); |
| 298 | u_register_t plat_psci_stat_get_residency(unsigned int lvl, |
| 299 | const psci_power_state_t *state_info, |
Deepika Bhavnani | 4287c0c | 2019-12-13 10:23:18 -0600 | [diff] [blame] | 300 | unsigned int last_cpu_idx); |
Soby Mathew | 981487a | 2015-07-13 14:10:57 +0100 | [diff] [blame] | 301 | plat_local_state_t plat_get_target_pwr_state(unsigned int lvl, |
| 302 | const plat_local_state_t *states, |
| 303 | unsigned int ncpu); |
Dan Handley | 7ce42df | 2014-05-15 14:11:36 +0100 | [diff] [blame] | 304 | |
| 305 | /******************************************************************************* |
Soby Mathew | 294e1cf | 2022-03-22 16:19:39 +0000 | [diff] [blame^] | 306 | * Mandatory BL31 functions when ENABLE_RME=1 |
| 307 | ******************************************************************************/ |
| 308 | int plat_get_cca_attest_token(uintptr_t buf, size_t *len, |
| 309 | uintptr_t hash, size_t hash_size); |
| 310 | /******************************************************************************* |
Juan Castillo | 7d19941 | 2015-12-14 09:35:25 +0000 | [diff] [blame] | 311 | * Optional BL31 functions (may be overridden) |
Dan Handley | b226a4d | 2014-05-16 14:08:45 +0100 | [diff] [blame] | 312 | ******************************************************************************/ |
Achin Gupta | e998254 | 2014-06-26 08:59:07 +0100 | [diff] [blame] | 313 | void bl31_plat_enable_mmu(uint32_t flags); |
Dan Handley | b226a4d | 2014-05-16 14:08:45 +0100 | [diff] [blame] | 314 | |
| 315 | /******************************************************************************* |
Juan Castillo | 7d19941 | 2015-12-14 09:35:25 +0000 | [diff] [blame] | 316 | * Optional BL32 functions (may be overridden) |
Dan Handley | b226a4d | 2014-05-16 14:08:45 +0100 | [diff] [blame] | 317 | ******************************************************************************/ |
Achin Gupta | e998254 | 2014-06-26 08:59:07 +0100 | [diff] [blame] | 318 | void bl32_plat_enable_mmu(uint32_t flags); |
Dan Handley | b226a4d | 2014-05-16 14:08:45 +0100 | [diff] [blame] | 319 | |
Juan Castillo | 5e29c75 | 2015-01-07 10:39:25 +0000 | [diff] [blame] | 320 | /******************************************************************************* |
Juan Castillo | 31a68f0 | 2015-04-14 12:49:03 +0100 | [diff] [blame] | 321 | * Trusted Board Boot functions |
Juan Castillo | 5e29c75 | 2015-01-07 10:39:25 +0000 | [diff] [blame] | 322 | ******************************************************************************/ |
Juan Castillo | 31a68f0 | 2015-04-14 12:49:03 +0100 | [diff] [blame] | 323 | int plat_get_rotpk_info(void *cookie, void **key_ptr, unsigned int *key_len, |
| 324 | unsigned int *flags); |
Juan Castillo | bfb7fa6 | 2016-01-22 11:05:57 +0000 | [diff] [blame] | 325 | int plat_get_nv_ctr(void *cookie, unsigned int *nv_ctr); |
| 326 | int plat_set_nv_ctr(void *cookie, unsigned int nv_ctr); |
dp-arm | b3e8580 | 2016-12-12 14:48:13 +0000 | [diff] [blame] | 327 | int plat_set_nv_ctr2(void *cookie, const struct auth_img_desc_s *img_desc, |
| 328 | unsigned int nv_ctr); |
Ambroise Vincent | d207f56 | 2019-04-10 12:50:27 +0100 | [diff] [blame] | 329 | int get_mbedtls_heap_helper(void **heap_addr, size_t *heap_size); |
Sumit Garg | 617e215 | 2019-11-15 15:34:55 +0530 | [diff] [blame] | 330 | int plat_get_enc_key_info(enum fw_enc_status_t fw_enc_status, uint8_t *key, |
| 331 | size_t *key_len, unsigned int *flags, |
| 332 | const uint8_t *img_id, size_t img_id_len); |
Juan Castillo | 5e29c75 | 2015-01-07 10:39:25 +0000 | [diff] [blame] | 333 | |
Antonio Nino Diaz | c41f206 | 2017-10-24 10:07:35 +0100 | [diff] [blame] | 334 | /******************************************************************************* |
| 335 | * Secure Partitions functions |
| 336 | ******************************************************************************/ |
| 337 | const struct mmap_region *plat_get_secure_partition_mmap(void *cookie); |
Paul Beesley | 45f4028 | 2019-10-15 10:57:42 +0000 | [diff] [blame] | 338 | const struct spm_mm_boot_info *plat_get_secure_partition_boot_info( |
Antonio Nino Diaz | c41f206 | 2017-10-24 10:07:35 +0100 | [diff] [blame] | 339 | void *cookie); |
Antonio Nino Diaz | b86edcb | 2018-10-30 11:12:42 +0000 | [diff] [blame] | 340 | int plat_spm_sp_rd_load(struct sp_res_desc *rd, const void *ptr, size_t size); |
Antonio Nino Diaz | 840627f | 2018-11-27 08:36:02 +0000 | [diff] [blame] | 341 | int plat_spm_sp_get_next_address(void **sp_base, size_t *sp_size, |
| 342 | void **rd_base, size_t *rd_size); |
Achin Gupta | da6ef0e | 2019-10-11 14:54:48 +0100 | [diff] [blame] | 343 | #if defined(SPD_spmd) |
Olivier Deprez | 2bae35f | 2020-04-16 13:39:06 +0200 | [diff] [blame] | 344 | int plat_spm_core_manifest_load(spmc_manifest_attribute_t *manifest, |
Olivier Deprez | 69ca84a | 2020-02-07 15:44:43 +0100 | [diff] [blame] | 345 | const void *pm_addr); |
Achin Gupta | da6ef0e | 2019-10-11 14:54:48 +0100 | [diff] [blame] | 346 | #endif |
Yatharth Kochar | 3345a8d | 2016-09-12 16:08:41 +0100 | [diff] [blame] | 347 | /******************************************************************************* |
| 348 | * Mandatory BL image load functions(may be overridden). |
| 349 | ******************************************************************************/ |
| 350 | /* |
| 351 | * This function returns pointer to the list of images that the |
| 352 | * platform has populated to load. |
| 353 | */ |
| 354 | struct bl_load_info *plat_get_bl_image_load_info(void); |
| 355 | |
| 356 | /* |
| 357 | * This function returns a pointer to the shared memory that the |
| 358 | * platform has kept aside to pass trusted firmware related |
| 359 | * information that next BL image could need. |
| 360 | */ |
| 361 | struct bl_params *plat_get_next_bl_params(void); |
| 362 | |
| 363 | /* |
| 364 | * This function flushes to main memory all the params that are |
| 365 | * passed to next image. |
| 366 | */ |
| 367 | void plat_flush_next_bl_params(void); |
| 368 | |
Soby Mathew | 70716d6 | 2015-07-13 16:26:11 +0100 | [diff] [blame] | 369 | /* |
| 370 | * The below function enable Trusted Firmware components like SPDs which |
| 371 | * haven't migrated to the new platform API to compile on platforms which |
| 372 | * have the compatibility layer disabled. |
| 373 | */ |
Roberto Vargas | 0571270 | 2018-02-12 12:36:17 +0000 | [diff] [blame] | 374 | unsigned int platform_core_pos_helper(unsigned long mpidr); |
Douglas Raillard | 306593d | 2017-02-24 18:14:15 +0000 | [diff] [blame] | 375 | |
Manish V Badarkhe | f809c6e | 2020-02-22 08:43:00 +0000 | [diff] [blame] | 376 | /* |
| 377 | * Optional function to get SOC version |
| 378 | */ |
| 379 | int32_t plat_get_soc_version(void); |
| 380 | |
| 381 | /* |
| 382 | * Optional function to get SOC revision |
| 383 | */ |
| 384 | int32_t plat_get_soc_revision(void); |
| 385 | |
Manish V Badarkhe | 80f13ee | 2020-07-23 20:23:01 +0100 | [diff] [blame] | 386 | /* |
| 387 | * Optional function to check for SMCCC function availability for platform |
| 388 | */ |
| 389 | int32_t plat_is_smccc_feature_available(u_register_t fid); |
| 390 | |
Manish V Badarkhe | a040b64 | 2021-06-20 21:04:49 +0100 | [diff] [blame] | 391 | /******************************************************************************* |
| 392 | * FWU platform specific functions |
| 393 | ******************************************************************************/ |
| 394 | int plat_fwu_set_metadata_image_source(unsigned int image_id, |
| 395 | uintptr_t *dev_handle, |
| 396 | uintptr_t *image_spec); |
Sughosh Ganu | f40154f | 2021-11-17 17:08:10 +0530 | [diff] [blame] | 397 | void plat_fwu_set_images_source(const struct fwu_metadata *metadata); |
Sughosh Ganu | 4e336a6 | 2021-12-01 15:53:32 +0530 | [diff] [blame] | 398 | uint32_t plat_fwu_get_boot_idx(void); |
Manish V Badarkhe | a040b64 | 2021-06-20 21:04:49 +0100 | [diff] [blame] | 399 | |
Antonio Nino Diaz | fec756f | 2018-07-18 16:24:16 +0100 | [diff] [blame] | 400 | #endif /* PLATFORM_H */ |