blob: 8407bbda820aea9f269d37496061b5ef210c2caf [file] [log] [blame]
Dan Handleyed6ff952014-05-14 17:44:19 +01001/*
Lucian Paul-Trifu5ee4f4e2022-06-22 18:45:30 +01002 * Copyright (c) 2013-2022, Arm Limited and Contributors. All rights reserved.
Dan Handleyed6ff952014-05-14 17:44:19 +01003 *
dp-armfa3cf0b2017-05-03 09:38:09 +01004 * SPDX-License-Identifier: BSD-3-Clause
Dan Handleyed6ff952014-05-14 17:44:19 +01005 */
6
Antonio Nino Diazfec756f2018-07-18 16:24:16 +01007#ifndef PLATFORM_H
8#define PLATFORM_H
Dan Handleyed6ff952014-05-14 17:44:19 +01009
10#include <stdint.h>
Dan Handleyed6ff952014-05-14 17:44:19 +010011
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000012#include <lib/psci/psci.h>
Achin Guptada6ef0e2019-10-11 14:54:48 +010013#if defined(SPD_spmd)
14 #include <services/spm_core_manifest.h>
15#endif
Javier Almansa Sobrino4165e842022-04-25 17:18:15 +010016#if ENABLE_RME
17#include <services/rmm_core_manifest.h>
18#endif
Jayanth Dodderi Chidanand7c7faff2022-10-11 17:16:07 +010019#include <drivers/fwu/fwu_metadata.h>
Jimmy Brisson26c5b5c2020-06-22 14:18:42 -050020#if TRNG_SUPPORT
21#include "plat_trng.h"
Jayanth Dodderi Chidanand7c7faff2022-10-11 17:16:07 +010022#endif /* TRNG_SUPPORT */
Lucian Paul-Trifu5ee4f4e2022-06-22 18:45:30 +010023#if DRTM_SUPPORT
24#include "plat_drtm.h"
25#endif /* DRTM_SUPPORT */
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000026
Dan Handleyed6ff952014-05-14 17:44:19 +010027/*******************************************************************************
28 * Forward declarations
29 ******************************************************************************/
dp-armb3e85802016-12-12 14:48:13 +000030struct auth_img_desc_s;
Dan Handleyed6ff952014-05-14 17:44:19 +010031struct meminfo;
32struct image_info;
33struct entry_point_info;
Yatharth Kochara65be2f2015-10-09 18:06:13 +010034struct image_desc;
Yatharth Kochar3345a8d2016-09-12 16:08:41 +010035struct bl_load_info;
36struct bl_params;
Antonio Nino Diazc41f2062017-10-24 10:07:35 +010037struct mmap_region;
Paul Beesley45f40282019-10-15 10:57:42 +000038struct spm_mm_boot_info;
Antonio Nino Diazb86edcb2018-10-30 11:12:42 +000039struct sp_res_desc;
Sumit Garg617e2152019-11-15 15:34:55 +053040enum fw_enc_status_t;
Dan Handleyed6ff952014-05-14 17:44:19 +010041
42/*******************************************************************************
Juan Castillo31a68f02015-04-14 12:49:03 +010043 * plat_get_rotpk_info() flags
44 ******************************************************************************/
45#define ROTPK_IS_HASH (1 << 0)
Soby Mathew2f7ed052016-05-24 15:05:15 +010046/* Flag used to skip verification of the certificate ROTPK while the platform
47 ROTPK is not deployed */
48#define ROTPK_NOT_DEPLOYED (1 << 1)
Juan Castillo31a68f02015-04-14 12:49:03 +010049
50/*******************************************************************************
Sumit Garg392e4df2019-11-15 10:43:00 +053051 * plat_get_enc_key_info() flags
52 ******************************************************************************/
53/*
54 * Flag used to notify caller that information provided in key buffer is an
55 * identifier rather than an actual key.
56 */
57#define ENC_KEY_IS_IDENTIFIER (1 << 0)
58
59/*******************************************************************************
Dan Handley7ce42df2014-05-15 14:11:36 +010060 * Function declarations
Dan Handleyed6ff952014-05-14 17:44:19 +010061 ******************************************************************************/
Dan Handley7ce42df2014-05-15 14:11:36 +010062/*******************************************************************************
63 * Mandatory common functions
64 ******************************************************************************/
Antonio Nino Diaz391a76e2016-05-18 16:53:31 +010065unsigned int plat_get_syscnt_freq2(void);
66
Juan Castillo3a66aca2015-04-13 17:36:19 +010067int plat_get_image_source(unsigned int image_id,
Dan Handley7ce42df2014-05-15 14:11:36 +010068 uintptr_t *dev_handle,
69 uintptr_t *image_spec);
Soby Mathew21f93612016-03-23 10:11:10 +000070uintptr_t plat_get_ns_image_entrypoint(void);
Soby Mathew981487a2015-07-13 14:10:57 +010071unsigned int plat_my_core_pos(void);
72int plat_core_pos_by_mpidr(u_register_t mpidr);
Ambroise Vincentd207f562019-04-10 12:50:27 +010073int plat_get_mbedtls_heap(void **heap_addr, size_t *heap_size);
Dan Handley7ce42df2014-05-15 14:11:36 +010074
Douglas Raillard306593d2017-02-24 18:14:15 +000075#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 */
82u_register_t plat_get_stack_protector_canary(void);
83#endif /* STACK_PROTECTOR_ENABLED */
84
Dan Handley7ce42df2014-05-15 14:11:36 +010085/*******************************************************************************
86 * Mandatory interrupt management functions
87 ******************************************************************************/
Dan Handley701fea72014-05-27 16:17:21 +010088uint32_t plat_ic_get_pending_interrupt_id(void);
89uint32_t plat_ic_get_pending_interrupt_type(void);
90uint32_t plat_ic_acknowledge_interrupt(void);
91uint32_t plat_ic_get_interrupt_type(uint32_t id);
92void plat_ic_end_of_interrupt(uint32_t id);
Dan Handleyed6ff952014-05-14 17:44:19 +010093uint32_t plat_interrupt_type_to_line(uint32_t type,
94 uint32_t security_state);
95
Dan Handley7ce42df2014-05-15 14:11:36 +010096/*******************************************************************************
Jeenu Viswambharanb1e957e2017-09-22 08:32:09 +010097 * Optional interrupt management functions, depending on chosen EL3 components.
98 ******************************************************************************/
99unsigned int plat_ic_get_running_priority(void);
Jeenu Viswambharan522a4652017-09-22 08:32:09 +0100100int plat_ic_is_spi(unsigned int id);
101int plat_ic_is_ppi(unsigned int id);
102int plat_ic_is_sgi(unsigned int id);
Jeenu Viswambharan24e70292017-09-22 08:32:09 +0100103unsigned int plat_ic_get_interrupt_active(unsigned int id);
Jeenu Viswambharan0fcdfff2017-09-22 08:32:09 +0100104void plat_ic_disable_interrupt(unsigned int id);
105void plat_ic_enable_interrupt(unsigned int id);
Jeenu Viswambharanc06f05c2017-09-22 08:32:09 +0100106int plat_ic_has_interrupt_type(unsigned int type);
107void plat_ic_set_interrupt_type(unsigned int id, unsigned int type);
Jeenu Viswambharan447b89d2017-09-22 08:32:09 +0100108void plat_ic_set_interrupt_priority(unsigned int id, unsigned int priority);
Jeenu Viswambharanab14e9b2017-09-22 08:32:09 +0100109void plat_ic_raise_el3_sgi(int sgi_num, u_register_t target);
Florian Lugoud4e25032021-09-08 12:40:24 +0200110void plat_ic_raise_ns_sgi(int sgi_num, u_register_t target);
111void plat_ic_raise_s_el1_sgi(int sgi_num, u_register_t target);
Jeenu Viswambharandce70b32017-09-22 08:32:09 +0100112void plat_ic_set_spi_routing(unsigned int id, unsigned int routing_mode,
113 u_register_t mpidr);
Jeenu Viswambharaneb1c12c2017-09-22 08:32:09 +0100114void plat_ic_set_interrupt_pending(unsigned int id);
115void plat_ic_clear_interrupt_pending(unsigned int id);
Jeenu Viswambharan62505072017-09-22 08:32:09 +0100116unsigned int plat_ic_set_priority_mask(unsigned int mask);
Jeenu Viswambharan055af4b2017-10-24 15:13:59 +0100117unsigned int plat_ic_get_interrupt_id(unsigned int raw);
Jeenu Viswambharanb1e957e2017-09-22 08:32:09 +0100118
119/*******************************************************************************
Dan Handley7ce42df2014-05-15 14:11:36 +0100120 * Optional common functions (may be overridden)
121 ******************************************************************************/
Soby Mathewa0fedc42016-06-16 14:52:04 +0100122uintptr_t plat_get_my_stack(void);
Yatharth Kocharf528faf2016-06-28 16:58:26 +0100123void plat_report_exception(unsigned int exception_type);
Yann Gautierc1425872019-02-15 16:42:20 +0100124void plat_report_prefetch_abort(unsigned int fault_address);
125void plat_report_data_abort(unsigned int fault_address);
Sandrine Bailleux046cd3f2014-08-06 11:27:23 +0100126int plat_crash_console_init(void);
Soby Mathew066f7132014-07-14 16:57:23 +0100127int plat_crash_console_putc(int c);
Jimmy Brisson39f9eee2020-08-05 13:44:05 -0500128void plat_crash_console_flush(void);
Juan Castillo26ae5832015-09-25 15:41:14 +0100129void plat_error_handler(int err) __dead2;
Antonio Nino Diaz1f21bcf2016-02-01 13:57:25 +0000130void plat_panic_handler(void) __dead2;
Manish V Badarkhefcfe4312022-07-12 21:48:04 +0100131void plat_system_reset(void) __dead2;
Soby Mathewaaf15f52017-09-04 11:49:29 +0100132const char *plat_log_get_prefix(unsigned int log_level);
Roberto Vargasbc1ae1f2017-09-26 12:53:01 +0100133void bl2_plat_preload_setup(void);
134int plat_try_next_boot_source(void);
Dan Handley7ce42df2014-05-15 14:11:36 +0100135
Manish V Badarkhea74d9632021-09-14 23:12:42 +0100136#if MEASURED_BOOT
137int plat_mboot_measure_image(unsigned int image_id, image_info_t *image_data);
Manish V Badarkhe1ffa0092021-10-20 22:06:40 +0100138int plat_mboot_measure_critical_data(unsigned int critical_data_id,
139 const void *base,
140 size_t size);
Manish V Badarkhea74d9632021-09-14 23:12:42 +0100141#else
142static inline int plat_mboot_measure_image(unsigned int image_id __unused,
143 image_info_t *image_data __unused)
144{
145 return 0;
146}
Manish V Badarkhe1ffa0092021-10-20 22:06:40 +0100147static inline int plat_mboot_measure_critical_data(
148 unsigned int critical_data_id __unused,
149 const void *base __unused,
150 size_t size __unused)
151{
152 return 0;
153}
Manish V Badarkhea74d9632021-09-14 23:12:42 +0100154#endif /* MEASURED_BOOT */
155
Dan Handley7ce42df2014-05-15 14:11:36 +0100156/*******************************************************************************
157 * Mandatory BL1 functions
158 ******************************************************************************/
Dan Handley4fd2f5c2014-08-04 11:41:20 +0100159void bl1_early_platform_setup(void);
Dan Handley7ce42df2014-05-15 14:11:36 +0100160void bl1_plat_arch_setup(void);
161void bl1_platform_setup(void);
162struct meminfo *bl1_plat_sec_mem_layout(void);
Dan Handleyed6ff952014-05-14 17:44:19 +0100163
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100164/*******************************************************************************
165 * Optional EL3 component functions in BL31
166 ******************************************************************************/
167
168/* SDEI platform functions */
169#if SDEI_SUPPORT
Balint Dobszayd0dbd5e2019-12-18 15:28:00 +0100170void plat_sdei_setup(void);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100171int plat_sdei_validate_entry_point(uintptr_t ep, unsigned int client_mode);
172void plat_sdei_handle_masked_trigger(uint64_t mpidr, unsigned int intr);
173#endif
174
Pali Rohárc36e97f2021-06-21 17:22:27 +0200175void plat_default_ea_handler(unsigned int ea_reason, uint64_t syndrome, void *cookie,
176 void *handle, uint64_t flags);
Jeenu Viswambharan96c7df02017-11-30 12:54:15 +0000177void plat_ea_handler(unsigned int ea_reason, uint64_t syndrome, void *cookie,
178 void *handle, uint64_t flags);
179
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100180/*
181 * The following function is mandatory when the
182 * firmware update feature is used.
183 */
184int bl1_plat_mem_check(uintptr_t mem_base, unsigned int mem_size,
185 unsigned int flags);
186
Dan Handley7ce42df2014-05-15 14:11:36 +0100187/*******************************************************************************
188 * Optional BL1 functions (may be overridden)
189 ******************************************************************************/
Yatharth Kochara65be2f2015-10-09 18:06:13 +0100190/*
191 * The following functions are used for image loading process in BL1.
192 */
193void bl1_plat_set_ep_info(unsigned int image_id,
194 struct entry_point_info *ep_info);
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100195/*
196 * The following functions are mandatory when firmware update
197 * feature is used and optional otherwise.
198 */
Yatharth Kochara65be2f2015-10-09 18:06:13 +0100199unsigned int bl1_plat_get_next_image_id(void);
200struct image_desc *bl1_plat_get_image_desc(unsigned int image_id);
Dan Handley7ce42df2014-05-15 14:11:36 +0100201
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100202/*
203 * The following functions are used by firmware update
204 * feature and may optionally be overridden.
205 */
Dan Handley89f8f332015-12-15 14:28:24 +0000206__dead2 void bl1_plat_fwu_done(void *client_cookie, void *reserved);
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100207
Masahiro Yamada43d20b32018-02-01 16:46:18 +0900208/*
Soby Mathew2f38ce32018-02-08 17:45:12 +0000209 * This BL1 function can be used by the platforms to update/use image
210 * information for a given `image_id`.
Masahiro Yamada43d20b32018-02-01 16:46:18 +0900211 */
Soby Mathew2f38ce32018-02-08 17:45:12 +0000212int bl1_plat_handle_pre_image_load(unsigned int image_id);
213int bl1_plat_handle_post_image_load(unsigned int image_id);
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100214
Manish V Badarkhea74d9632021-09-14 23:12:42 +0100215#if MEASURED_BOOT
216void bl1_plat_mboot_init(void);
217void bl1_plat_mboot_finish(void);
218#else
219static inline void bl1_plat_mboot_init(void)
220{
221}
222static inline void bl1_plat_mboot_finish(void)
223{
224}
225#endif /* MEASURED_BOOT */
226
Dan Handley7ce42df2014-05-15 14:11:36 +0100227/*******************************************************************************
228 * Mandatory BL2 functions
229 ******************************************************************************/
Soby Mathew73308d02018-01-09 14:36:14 +0000230void bl2_early_platform_setup2(u_register_t arg0, u_register_t arg1, u_register_t arg2, u_register_t arg3);
Dan Handley7ce42df2014-05-15 14:11:36 +0100231void bl2_plat_arch_setup(void);
232void bl2_platform_setup(void);
233struct meminfo *bl2_plat_sec_mem_layout(void);
234
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100235/*
236 * This function can be used by the platforms to update/use image
237 * information for given `image_id`.
238 */
Masahiro Yamada02a0d3d2018-02-01 16:45:51 +0900239int bl2_plat_handle_pre_image_load(unsigned int image_id);
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100240int bl2_plat_handle_post_image_load(unsigned int image_id);
241
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100242/*******************************************************************************
Dan Handley7ce42df2014-05-15 14:11:36 +0100243 * Optional BL2 functions (may be overridden)
244 ******************************************************************************/
Alexei Fedorovc7176172020-07-13 12:11:05 +0100245#if MEASURED_BOOT
Manish V Badarkhe5797b802021-08-06 09:26:20 +0100246void bl2_plat_mboot_init(void);
247void bl2_plat_mboot_finish(void);
248#else
249static inline void bl2_plat_mboot_init(void)
250{
251}
252static inline void bl2_plat_mboot_finish(void)
253{
Manish V Badarkhe57b669f2021-09-20 09:06:02 +0100254}
Manish V Badarkhe5797b802021-08-06 09:26:20 +0100255#endif /* MEASURED_BOOT */
Roberto Vargase0e99462017-10-30 14:43:43 +0000256
257/*******************************************************************************
258 * Mandatory BL2 at EL3 functions: Must be implemented if BL2_AT_EL3 image is
259 * supported
260 ******************************************************************************/
261void bl2_el3_early_platform_setup(u_register_t arg0, u_register_t arg1,
262 u_register_t arg2, u_register_t arg3);
263void bl2_el3_plat_arch_setup(void);
264
Roberto Vargase0e99462017-10-30 14:43:43 +0000265/*******************************************************************************
266 * Optional BL2 at EL3 functions (may be overridden)
267 ******************************************************************************/
268void bl2_el3_plat_prepare_exit(void);
269
Dan Handley7ce42df2014-05-15 14:11:36 +0100270/*******************************************************************************
Yatharth Kocharb1c2fe02015-10-14 15:27:24 +0100271 * Mandatory BL2U functions.
272 ******************************************************************************/
273void bl2u_early_platform_setup(struct meminfo *mem_layout,
274 void *plat_info);
275void bl2u_plat_arch_setup(void);
276void bl2u_platform_setup(void);
277
278/*******************************************************************************
279 * Conditionally mandatory BL2U functions for CSS platforms.
280 ******************************************************************************/
281/*
282 * This function is used to perform any platform-specific actions required to
283 * handle the BL2U_SCP firmware.
284 */
285int bl2u_plat_handle_scp_bl2u(void);
286
287/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000288 * Mandatory BL31 functions
Dan Handley7ce42df2014-05-15 14:11:36 +0100289 ******************************************************************************/
Soby Mathew73308d02018-01-09 14:36:14 +0000290void bl31_early_platform_setup2(u_register_t arg0, u_register_t arg1,
291 u_register_t arg2, u_register_t arg3);
Dan Handley7ce42df2014-05-15 14:11:36 +0100292void bl31_plat_arch_setup(void);
293void bl31_platform_setup(void);
Soby Mathew1ff495b2015-12-09 11:28:43 +0000294void bl31_plat_runtime_setup(void);
Dan Handley701fea72014-05-27 16:17:21 +0100295struct entry_point_info *bl31_plat_get_next_image_ep_info(uint32_t type);
Dan Handley7ce42df2014-05-15 14:11:36 +0100296
297/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000298 * Mandatory PSCI functions (BL31)
Dan Handley7ce42df2014-05-15 14:11:36 +0100299 ******************************************************************************/
Soby Mathew981487a2015-07-13 14:10:57 +0100300int plat_setup_psci_ops(uintptr_t sec_entrypoint,
Roberto Vargas777dd432018-02-12 12:36:17 +0000301 const struct plat_psci_ops **psci_ops);
Soby Mathew981487a2015-07-13 14:10:57 +0100302const unsigned char *plat_get_power_domain_tree_desc(void);
303
304/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000305 * Optional PSCI functions (BL31).
Soby Mathew981487a2015-07-13 14:10:57 +0100306 ******************************************************************************/
dp-arm66abfbe2017-01-31 13:01:04 +0000307void plat_psci_stat_accounting_start(const psci_power_state_t *state_info);
308void plat_psci_stat_accounting_stop(const psci_power_state_t *state_info);
309u_register_t plat_psci_stat_get_residency(unsigned int lvl,
310 const psci_power_state_t *state_info,
Deepika Bhavnani4287c0c2019-12-13 10:23:18 -0600311 unsigned int last_cpu_idx);
Soby Mathew981487a2015-07-13 14:10:57 +0100312plat_local_state_t plat_get_target_pwr_state(unsigned int lvl,
313 const plat_local_state_t *states,
314 unsigned int ncpu);
Dan Handley7ce42df2014-05-15 14:11:36 +0100315
316/*******************************************************************************
Soby Mathew294e1cf2022-03-22 16:19:39 +0000317 * Mandatory BL31 functions when ENABLE_RME=1
318 ******************************************************************************/
Javier Almansa Sobrino4165e842022-04-25 17:18:15 +0100319#if ENABLE_RME
Javier Almansa Sobrino7176a772021-11-24 18:37:37 +0000320int plat_rmmd_get_cca_attest_token(uintptr_t buf, size_t *len,
321 uintptr_t hash, size_t hash_size);
322int plat_rmmd_get_cca_realm_attest_key(uintptr_t buf, size_t *len,
323 unsigned int type);
324size_t plat_rmmd_get_el3_rmm_shared_mem(uintptr_t *shared);
Javier Almansa Sobrino4165e842022-04-25 17:18:15 +0100325int plat_rmmd_load_manifest(rmm_manifest_t *manifest);
326#endif
327
Soby Mathew294e1cf2022-03-22 16:19:39 +0000328/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000329 * Optional BL31 functions (may be overridden)
Dan Handleyb226a4d2014-05-16 14:08:45 +0100330 ******************************************************************************/
Achin Guptae9982542014-06-26 08:59:07 +0100331void bl31_plat_enable_mmu(uint32_t flags);
Dan Handleyb226a4d2014-05-16 14:08:45 +0100332
333/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000334 * Optional BL32 functions (may be overridden)
Dan Handleyb226a4d2014-05-16 14:08:45 +0100335 ******************************************************************************/
Achin Guptae9982542014-06-26 08:59:07 +0100336void bl32_plat_enable_mmu(uint32_t flags);
Dan Handleyb226a4d2014-05-16 14:08:45 +0100337
Juan Castillo5e29c752015-01-07 10:39:25 +0000338/*******************************************************************************
Juan Castillo31a68f02015-04-14 12:49:03 +0100339 * Trusted Board Boot functions
Juan Castillo5e29c752015-01-07 10:39:25 +0000340 ******************************************************************************/
Juan Castillo31a68f02015-04-14 12:49:03 +0100341int plat_get_rotpk_info(void *cookie, void **key_ptr, unsigned int *key_len,
342 unsigned int *flags);
Juan Castillobfb7fa62016-01-22 11:05:57 +0000343int plat_get_nv_ctr(void *cookie, unsigned int *nv_ctr);
344int plat_set_nv_ctr(void *cookie, unsigned int nv_ctr);
dp-armb3e85802016-12-12 14:48:13 +0000345int plat_set_nv_ctr2(void *cookie, const struct auth_img_desc_s *img_desc,
346 unsigned int nv_ctr);
Nicolas Toromanoff7f95ac82020-11-09 12:14:52 +0100347int plat_convert_pk(void *full_pk_ptr, unsigned int full_pk_len,
348 void **hashed_pk_ptr, unsigned int *hash_pk_len);
Ambroise Vincentd207f562019-04-10 12:50:27 +0100349int get_mbedtls_heap_helper(void **heap_addr, size_t *heap_size);
Sumit Garg617e2152019-11-15 15:34:55 +0530350int plat_get_enc_key_info(enum fw_enc_status_t fw_enc_status, uint8_t *key,
351 size_t *key_len, unsigned int *flags,
352 const uint8_t *img_id, size_t img_id_len);
Juan Castillo5e29c752015-01-07 10:39:25 +0000353
Antonio Nino Diazc41f2062017-10-24 10:07:35 +0100354/*******************************************************************************
355 * Secure Partitions functions
356 ******************************************************************************/
357const struct mmap_region *plat_get_secure_partition_mmap(void *cookie);
Paul Beesley45f40282019-10-15 10:57:42 +0000358const struct spm_mm_boot_info *plat_get_secure_partition_boot_info(
Antonio Nino Diazc41f2062017-10-24 10:07:35 +0100359 void *cookie);
Antonio Nino Diazb86edcb2018-10-30 11:12:42 +0000360int plat_spm_sp_rd_load(struct sp_res_desc *rd, const void *ptr, size_t size);
Antonio Nino Diaz840627f2018-11-27 08:36:02 +0000361int plat_spm_sp_get_next_address(void **sp_base, size_t *sp_size,
362 void **rd_base, size_t *rd_size);
Achin Guptada6ef0e2019-10-11 14:54:48 +0100363#if defined(SPD_spmd)
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200364int plat_spm_core_manifest_load(spmc_manifest_attribute_t *manifest,
Olivier Deprez69ca84a2020-02-07 15:44:43 +0100365 const void *pm_addr);
Achin Guptada6ef0e2019-10-11 14:54:48 +0100366#endif
Marc Bonnicic66fc1b2021-12-16 18:31:02 +0000367#if defined(SPMC_AT_EL3)
368int plat_spmc_shmem_datastore_get(uint8_t **datastore, size_t *size);
369#endif
370
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100371/*******************************************************************************
372 * Mandatory BL image load functions(may be overridden).
373 ******************************************************************************/
374/*
375 * This function returns pointer to the list of images that the
376 * platform has populated to load.
377 */
378struct bl_load_info *plat_get_bl_image_load_info(void);
379
380/*
381 * This function returns a pointer to the shared memory that the
382 * platform has kept aside to pass trusted firmware related
383 * information that next BL image could need.
384 */
385struct bl_params *plat_get_next_bl_params(void);
386
387/*
388 * This function flushes to main memory all the params that are
389 * passed to next image.
390 */
391void plat_flush_next_bl_params(void);
392
Soby Mathew70716d62015-07-13 16:26:11 +0100393/*
394 * The below function enable Trusted Firmware components like SPDs which
395 * haven't migrated to the new platform API to compile on platforms which
396 * have the compatibility layer disabled.
397 */
Roberto Vargas05712702018-02-12 12:36:17 +0000398unsigned int platform_core_pos_helper(unsigned long mpidr);
Douglas Raillard306593d2017-02-24 18:14:15 +0000399
Manish V Badarkhef809c6e2020-02-22 08:43:00 +0000400/*
401 * Optional function to get SOC version
402 */
403int32_t plat_get_soc_version(void);
404
405/*
406 * Optional function to get SOC revision
407 */
408int32_t plat_get_soc_revision(void);
409
Manish V Badarkhe80f13ee2020-07-23 20:23:01 +0100410/*
411 * Optional function to check for SMCCC function availability for platform
412 */
413int32_t plat_is_smccc_feature_available(u_register_t fid);
414
Manish V Badarkhea040b642021-06-20 21:04:49 +0100415/*******************************************************************************
416 * FWU platform specific functions
417 ******************************************************************************/
418int plat_fwu_set_metadata_image_source(unsigned int image_id,
419 uintptr_t *dev_handle,
420 uintptr_t *image_spec);
Sughosh Ganuf40154f2021-11-17 17:08:10 +0530421void plat_fwu_set_images_source(const struct fwu_metadata *metadata);
Sughosh Ganu4e336a62021-12-01 15:53:32 +0530422uint32_t plat_fwu_get_boot_idx(void);
Manish V Badarkhea040b642021-06-20 21:04:49 +0100423
Antonio Nino Diazfec756f2018-07-18 16:24:16 +0100424#endif /* PLATFORM_H */