blob: 2d5c521db2f376db07dc44080f7520487f77505a [file] [log] [blame]
Dan Handleyed6ff952014-05-14 17:44:19 +01001/*
Jimmy Brisson26c5b5c2020-06-22 14:18:42 -05002 * Copyright (c) 2013-2021, 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
Jimmy Brisson26c5b5c2020-06-22 14:18:42 -050016#if TRNG_SUPPORT
17#include "plat_trng.h"
18#endif
Manish V Badarkhea040b642021-06-20 21:04:49 +010019#include <drivers/fwu/fwu_metadata.h>
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000020
Dan Handleyed6ff952014-05-14 17:44:19 +010021/*******************************************************************************
22 * Forward declarations
23 ******************************************************************************/
dp-armb3e85802016-12-12 14:48:13 +000024struct auth_img_desc_s;
Dan Handleyed6ff952014-05-14 17:44:19 +010025struct meminfo;
26struct image_info;
27struct entry_point_info;
Yatharth Kochara65be2f2015-10-09 18:06:13 +010028struct image_desc;
Yatharth Kochar3345a8d2016-09-12 16:08:41 +010029struct bl_load_info;
30struct bl_params;
Antonio Nino Diazc41f2062017-10-24 10:07:35 +010031struct mmap_region;
Paul Beesley45f40282019-10-15 10:57:42 +000032struct spm_mm_boot_info;
Antonio Nino Diazb86edcb2018-10-30 11:12:42 +000033struct sp_res_desc;
Sumit Garg617e2152019-11-15 15:34:55 +053034enum fw_enc_status_t;
Dan Handleyed6ff952014-05-14 17:44:19 +010035
36/*******************************************************************************
Juan Castillo31a68f02015-04-14 12:49:03 +010037 * plat_get_rotpk_info() flags
38 ******************************************************************************/
39#define ROTPK_IS_HASH (1 << 0)
Soby Mathew2f7ed052016-05-24 15:05:15 +010040/* 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 Castillo31a68f02015-04-14 12:49:03 +010043
44/*******************************************************************************
Sumit Garg392e4df2019-11-15 10:43:00 +053045 * 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 Handley7ce42df2014-05-15 14:11:36 +010054 * Function declarations
Dan Handleyed6ff952014-05-14 17:44:19 +010055 ******************************************************************************/
Dan Handley7ce42df2014-05-15 14:11:36 +010056/*******************************************************************************
57 * Mandatory common functions
58 ******************************************************************************/
Antonio Nino Diaz391a76e2016-05-18 16:53:31 +010059unsigned int plat_get_syscnt_freq2(void);
60
Juan Castillo3a66aca2015-04-13 17:36:19 +010061int plat_get_image_source(unsigned int image_id,
Dan Handley7ce42df2014-05-15 14:11:36 +010062 uintptr_t *dev_handle,
63 uintptr_t *image_spec);
Soby Mathew21f93612016-03-23 10:11:10 +000064uintptr_t plat_get_ns_image_entrypoint(void);
Soby Mathew981487a2015-07-13 14:10:57 +010065unsigned int plat_my_core_pos(void);
66int plat_core_pos_by_mpidr(u_register_t mpidr);
Ambroise Vincentd207f562019-04-10 12:50:27 +010067int plat_get_mbedtls_heap(void **heap_addr, size_t *heap_size);
Dan Handley7ce42df2014-05-15 14:11:36 +010068
Douglas Raillard306593d2017-02-24 18:14:15 +000069#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 */
76u_register_t plat_get_stack_protector_canary(void);
77#endif /* STACK_PROTECTOR_ENABLED */
78
Dan Handley7ce42df2014-05-15 14:11:36 +010079/*******************************************************************************
80 * Mandatory interrupt management functions
81 ******************************************************************************/
Dan Handley701fea72014-05-27 16:17:21 +010082uint32_t plat_ic_get_pending_interrupt_id(void);
83uint32_t plat_ic_get_pending_interrupt_type(void);
84uint32_t plat_ic_acknowledge_interrupt(void);
85uint32_t plat_ic_get_interrupt_type(uint32_t id);
86void plat_ic_end_of_interrupt(uint32_t id);
Dan Handleyed6ff952014-05-14 17:44:19 +010087uint32_t plat_interrupt_type_to_line(uint32_t type,
88 uint32_t security_state);
89
Dan Handley7ce42df2014-05-15 14:11:36 +010090/*******************************************************************************
Jeenu Viswambharanb1e957e2017-09-22 08:32:09 +010091 * Optional interrupt management functions, depending on chosen EL3 components.
92 ******************************************************************************/
93unsigned int plat_ic_get_running_priority(void);
Jeenu Viswambharan522a4652017-09-22 08:32:09 +010094int plat_ic_is_spi(unsigned int id);
95int plat_ic_is_ppi(unsigned int id);
96int plat_ic_is_sgi(unsigned int id);
Jeenu Viswambharan24e70292017-09-22 08:32:09 +010097unsigned int plat_ic_get_interrupt_active(unsigned int id);
Jeenu Viswambharan0fcdfff2017-09-22 08:32:09 +010098void plat_ic_disable_interrupt(unsigned int id);
99void plat_ic_enable_interrupt(unsigned int id);
Jeenu Viswambharanc06f05c2017-09-22 08:32:09 +0100100int plat_ic_has_interrupt_type(unsigned int type);
101void plat_ic_set_interrupt_type(unsigned int id, unsigned int type);
Jeenu Viswambharan447b89d2017-09-22 08:32:09 +0100102void plat_ic_set_interrupt_priority(unsigned int id, unsigned int priority);
Jeenu Viswambharanab14e9b2017-09-22 08:32:09 +0100103void plat_ic_raise_el3_sgi(int sgi_num, u_register_t target);
Jeenu Viswambharandce70b32017-09-22 08:32:09 +0100104void plat_ic_set_spi_routing(unsigned int id, unsigned int routing_mode,
105 u_register_t mpidr);
Jeenu Viswambharaneb1c12c2017-09-22 08:32:09 +0100106void plat_ic_set_interrupt_pending(unsigned int id);
107void plat_ic_clear_interrupt_pending(unsigned int id);
Jeenu Viswambharan62505072017-09-22 08:32:09 +0100108unsigned int plat_ic_set_priority_mask(unsigned int mask);
Jeenu Viswambharan055af4b2017-10-24 15:13:59 +0100109unsigned int plat_ic_get_interrupt_id(unsigned int raw);
Jeenu Viswambharanb1e957e2017-09-22 08:32:09 +0100110
111/*******************************************************************************
Dan Handley7ce42df2014-05-15 14:11:36 +0100112 * Optional common functions (may be overridden)
113 ******************************************************************************/
Soby Mathewa0fedc42016-06-16 14:52:04 +0100114uintptr_t plat_get_my_stack(void);
Yatharth Kocharf528faf2016-06-28 16:58:26 +0100115void plat_report_exception(unsigned int exception_type);
Sandrine Bailleux046cd3f2014-08-06 11:27:23 +0100116int plat_crash_console_init(void);
Soby Mathew066f7132014-07-14 16:57:23 +0100117int plat_crash_console_putc(int c);
Jimmy Brisson39f9eee2020-08-05 13:44:05 -0500118void plat_crash_console_flush(void);
Juan Castillo26ae5832015-09-25 15:41:14 +0100119void plat_error_handler(int err) __dead2;
Antonio Nino Diaz1f21bcf2016-02-01 13:57:25 +0000120void plat_panic_handler(void) __dead2;
Soby Mathewaaf15f52017-09-04 11:49:29 +0100121const char *plat_log_get_prefix(unsigned int log_level);
Roberto Vargasbc1ae1f2017-09-26 12:53:01 +0100122void bl2_plat_preload_setup(void);
123int plat_try_next_boot_source(void);
Dan Handley7ce42df2014-05-15 14:11:36 +0100124
125/*******************************************************************************
126 * Mandatory BL1 functions
127 ******************************************************************************/
Dan Handley4fd2f5c2014-08-04 11:41:20 +0100128void bl1_early_platform_setup(void);
Dan Handley7ce42df2014-05-15 14:11:36 +0100129void bl1_plat_arch_setup(void);
130void bl1_platform_setup(void);
131struct meminfo *bl1_plat_sec_mem_layout(void);
Dan Handleyed6ff952014-05-14 17:44:19 +0100132
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100133/*******************************************************************************
134 * Optional EL3 component functions in BL31
135 ******************************************************************************/
136
137/* SDEI platform functions */
138#if SDEI_SUPPORT
Balint Dobszayd0dbd5e2019-12-18 15:28:00 +0100139void plat_sdei_setup(void);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100140int plat_sdei_validate_entry_point(uintptr_t ep, unsigned int client_mode);
141void plat_sdei_handle_masked_trigger(uint64_t mpidr, unsigned int intr);
142#endif
143
Jeenu Viswambharan96c7df02017-11-30 12:54:15 +0000144void plat_ea_handler(unsigned int ea_reason, uint64_t syndrome, void *cookie,
145 void *handle, uint64_t flags);
146
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100147/*
148 * The following function is mandatory when the
149 * firmware update feature is used.
150 */
151int bl1_plat_mem_check(uintptr_t mem_base, unsigned int mem_size,
152 unsigned int flags);
153
Dan Handley7ce42df2014-05-15 14:11:36 +0100154/*******************************************************************************
155 * Optional BL1 functions (may be overridden)
156 ******************************************************************************/
Yatharth Kochara65be2f2015-10-09 18:06:13 +0100157/*
158 * The following functions are used for image loading process in BL1.
159 */
160void bl1_plat_set_ep_info(unsigned int image_id,
161 struct entry_point_info *ep_info);
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100162/*
163 * The following functions are mandatory when firmware update
164 * feature is used and optional otherwise.
165 */
Yatharth Kochara65be2f2015-10-09 18:06:13 +0100166unsigned int bl1_plat_get_next_image_id(void);
167struct image_desc *bl1_plat_get_image_desc(unsigned int image_id);
Dan Handley7ce42df2014-05-15 14:11:36 +0100168
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100169/*
170 * The following functions are used by firmware update
171 * feature and may optionally be overridden.
172 */
Dan Handley89f8f332015-12-15 14:28:24 +0000173__dead2 void bl1_plat_fwu_done(void *client_cookie, void *reserved);
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100174
Masahiro Yamada43d20b32018-02-01 16:46:18 +0900175/*
Soby Mathew2f38ce32018-02-08 17:45:12 +0000176 * This BL1 function can be used by the platforms to update/use image
177 * information for a given `image_id`.
Masahiro Yamada43d20b32018-02-01 16:46:18 +0900178 */
Soby Mathew2f38ce32018-02-08 17:45:12 +0000179int bl1_plat_handle_pre_image_load(unsigned int image_id);
180int bl1_plat_handle_post_image_load(unsigned int image_id);
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100181
Alexei Fedorovc7176172020-07-13 12:11:05 +0100182#if MEASURED_BOOT
183/*
184 * Calculates and writes BL2 hash data to the platform's defined location.
185 * For ARM platforms the data are written to TB_FW_CONFIG DTB.
186 */
187void bl1_plat_set_bl2_hash(const image_desc_t *image_desc);
188#endif
189
Dan Handley7ce42df2014-05-15 14:11:36 +0100190/*******************************************************************************
191 * Mandatory BL2 functions
192 ******************************************************************************/
Soby Mathew73308d02018-01-09 14:36:14 +0000193void 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 +0100194void bl2_plat_arch_setup(void);
195void bl2_platform_setup(void);
196struct meminfo *bl2_plat_sec_mem_layout(void);
197
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100198/*
199 * This function can be used by the platforms to update/use image
200 * information for given `image_id`.
201 */
Masahiro Yamada02a0d3d2018-02-01 16:45:51 +0900202int bl2_plat_handle_pre_image_load(unsigned int image_id);
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100203int bl2_plat_handle_post_image_load(unsigned int image_id);
204
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100205/*******************************************************************************
Dan Handley7ce42df2014-05-15 14:11:36 +0100206 * Optional BL2 functions (may be overridden)
207 ******************************************************************************/
Alexei Fedorovc7176172020-07-13 12:11:05 +0100208#if MEASURED_BOOT
209/* Read TCG_DIGEST_SIZE bytes of BL2 hash data */
210void bl2_plat_get_hash(void *data);
211#endif
Roberto Vargase0e99462017-10-30 14:43:43 +0000212
213/*******************************************************************************
214 * Mandatory BL2 at EL3 functions: Must be implemented if BL2_AT_EL3 image is
215 * supported
216 ******************************************************************************/
217void bl2_el3_early_platform_setup(u_register_t arg0, u_register_t arg1,
218 u_register_t arg2, u_register_t arg3);
219void bl2_el3_plat_arch_setup(void);
220
Roberto Vargase0e99462017-10-30 14:43:43 +0000221/*******************************************************************************
222 * Optional BL2 at EL3 functions (may be overridden)
223 ******************************************************************************/
224void bl2_el3_plat_prepare_exit(void);
225
Dan Handley7ce42df2014-05-15 14:11:36 +0100226/*******************************************************************************
Yatharth Kocharb1c2fe02015-10-14 15:27:24 +0100227 * Mandatory BL2U functions.
228 ******************************************************************************/
229void bl2u_early_platform_setup(struct meminfo *mem_layout,
230 void *plat_info);
231void bl2u_plat_arch_setup(void);
232void 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 */
241int bl2u_plat_handle_scp_bl2u(void);
242
243/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000244 * Mandatory BL31 functions
Dan Handley7ce42df2014-05-15 14:11:36 +0100245 ******************************************************************************/
Soby Mathew73308d02018-01-09 14:36:14 +0000246void bl31_early_platform_setup2(u_register_t arg0, u_register_t arg1,
247 u_register_t arg2, u_register_t arg3);
Dan Handley7ce42df2014-05-15 14:11:36 +0100248void bl31_plat_arch_setup(void);
249void bl31_platform_setup(void);
Soby Mathew1ff495b2015-12-09 11:28:43 +0000250void bl31_plat_runtime_setup(void);
Dan Handley701fea72014-05-27 16:17:21 +0100251struct entry_point_info *bl31_plat_get_next_image_ep_info(uint32_t type);
Dan Handley7ce42df2014-05-15 14:11:36 +0100252
253/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000254 * Mandatory PSCI functions (BL31)
Dan Handley7ce42df2014-05-15 14:11:36 +0100255 ******************************************************************************/
Soby Mathew981487a2015-07-13 14:10:57 +0100256int plat_setup_psci_ops(uintptr_t sec_entrypoint,
Roberto Vargas777dd432018-02-12 12:36:17 +0000257 const struct plat_psci_ops **psci_ops);
Soby Mathew981487a2015-07-13 14:10:57 +0100258const unsigned char *plat_get_power_domain_tree_desc(void);
259
260/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000261 * Optional PSCI functions (BL31).
Soby Mathew981487a2015-07-13 14:10:57 +0100262 ******************************************************************************/
dp-arm66abfbe2017-01-31 13:01:04 +0000263void plat_psci_stat_accounting_start(const psci_power_state_t *state_info);
264void plat_psci_stat_accounting_stop(const psci_power_state_t *state_info);
265u_register_t plat_psci_stat_get_residency(unsigned int lvl,
266 const psci_power_state_t *state_info,
Deepika Bhavnani4287c0c2019-12-13 10:23:18 -0600267 unsigned int last_cpu_idx);
Soby Mathew981487a2015-07-13 14:10:57 +0100268plat_local_state_t plat_get_target_pwr_state(unsigned int lvl,
269 const plat_local_state_t *states,
270 unsigned int ncpu);
Dan Handley7ce42df2014-05-15 14:11:36 +0100271
272/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000273 * Optional BL31 functions (may be overridden)
Dan Handleyb226a4d2014-05-16 14:08:45 +0100274 ******************************************************************************/
Achin Guptae9982542014-06-26 08:59:07 +0100275void bl31_plat_enable_mmu(uint32_t flags);
Dan Handleyb226a4d2014-05-16 14:08:45 +0100276
277/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000278 * Optional BL32 functions (may be overridden)
Dan Handleyb226a4d2014-05-16 14:08:45 +0100279 ******************************************************************************/
Achin Guptae9982542014-06-26 08:59:07 +0100280void bl32_plat_enable_mmu(uint32_t flags);
Dan Handleyb226a4d2014-05-16 14:08:45 +0100281
Juan Castillo5e29c752015-01-07 10:39:25 +0000282/*******************************************************************************
Juan Castillo31a68f02015-04-14 12:49:03 +0100283 * Trusted Board Boot functions
Juan Castillo5e29c752015-01-07 10:39:25 +0000284 ******************************************************************************/
Juan Castillo31a68f02015-04-14 12:49:03 +0100285int plat_get_rotpk_info(void *cookie, void **key_ptr, unsigned int *key_len,
286 unsigned int *flags);
Juan Castillobfb7fa62016-01-22 11:05:57 +0000287int plat_get_nv_ctr(void *cookie, unsigned int *nv_ctr);
288int plat_set_nv_ctr(void *cookie, unsigned int nv_ctr);
dp-armb3e85802016-12-12 14:48:13 +0000289int plat_set_nv_ctr2(void *cookie, const struct auth_img_desc_s *img_desc,
290 unsigned int nv_ctr);
Ambroise Vincentd207f562019-04-10 12:50:27 +0100291int get_mbedtls_heap_helper(void **heap_addr, size_t *heap_size);
Sumit Garg617e2152019-11-15 15:34:55 +0530292int plat_get_enc_key_info(enum fw_enc_status_t fw_enc_status, uint8_t *key,
293 size_t *key_len, unsigned int *flags,
294 const uint8_t *img_id, size_t img_id_len);
Juan Castillo5e29c752015-01-07 10:39:25 +0000295
Antonio Nino Diazc41f2062017-10-24 10:07:35 +0100296/*******************************************************************************
297 * Secure Partitions functions
298 ******************************************************************************/
299const struct mmap_region *plat_get_secure_partition_mmap(void *cookie);
Paul Beesley45f40282019-10-15 10:57:42 +0000300const struct spm_mm_boot_info *plat_get_secure_partition_boot_info(
Antonio Nino Diazc41f2062017-10-24 10:07:35 +0100301 void *cookie);
Antonio Nino Diazb86edcb2018-10-30 11:12:42 +0000302int plat_spm_sp_rd_load(struct sp_res_desc *rd, const void *ptr, size_t size);
Antonio Nino Diaz840627f2018-11-27 08:36:02 +0000303int plat_spm_sp_get_next_address(void **sp_base, size_t *sp_size,
304 void **rd_base, size_t *rd_size);
Achin Guptada6ef0e2019-10-11 14:54:48 +0100305#if defined(SPD_spmd)
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200306int plat_spm_core_manifest_load(spmc_manifest_attribute_t *manifest,
Olivier Deprez69ca84a2020-02-07 15:44:43 +0100307 const void *pm_addr);
Achin Guptada6ef0e2019-10-11 14:54:48 +0100308#endif
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100309/*******************************************************************************
310 * Mandatory BL image load functions(may be overridden).
311 ******************************************************************************/
312/*
313 * This function returns pointer to the list of images that the
314 * platform has populated to load.
315 */
316struct bl_load_info *plat_get_bl_image_load_info(void);
317
318/*
319 * This function returns a pointer to the shared memory that the
320 * platform has kept aside to pass trusted firmware related
321 * information that next BL image could need.
322 */
323struct bl_params *plat_get_next_bl_params(void);
324
325/*
326 * This function flushes to main memory all the params that are
327 * passed to next image.
328 */
329void plat_flush_next_bl_params(void);
330
Soby Mathew70716d62015-07-13 16:26:11 +0100331/*
332 * The below function enable Trusted Firmware components like SPDs which
333 * haven't migrated to the new platform API to compile on platforms which
334 * have the compatibility layer disabled.
335 */
Roberto Vargas05712702018-02-12 12:36:17 +0000336unsigned int platform_core_pos_helper(unsigned long mpidr);
Douglas Raillard306593d2017-02-24 18:14:15 +0000337
Manish V Badarkhef809c6e2020-02-22 08:43:00 +0000338/*
339 * Optional function to get SOC version
340 */
341int32_t plat_get_soc_version(void);
342
343/*
344 * Optional function to get SOC revision
345 */
346int32_t plat_get_soc_revision(void);
347
Manish V Badarkhe80f13ee2020-07-23 20:23:01 +0100348/*
349 * Optional function to check for SMCCC function availability for platform
350 */
351int32_t plat_is_smccc_feature_available(u_register_t fid);
352
Manish V Badarkhea040b642021-06-20 21:04:49 +0100353/*******************************************************************************
354 * FWU platform specific functions
355 ******************************************************************************/
356int plat_fwu_set_metadata_image_source(unsigned int image_id,
357 uintptr_t *dev_handle,
358 uintptr_t *image_spec);
359void plat_fwu_set_images_source(struct fwu_metadata *metadata);
360
Antonio Nino Diazfec756f2018-07-18 16:24:16 +0100361#endif /* PLATFORM_H */