blob: 2c1a180c8390fccc1e4a13d7d42482838a1751cb [file] [log] [blame]
Dan Handleyed6ff952014-05-14 17:44:19 +01001/*
Achin Guptada6ef0e2019-10-11 14:54:48 +01002 * Copyright (c) 2013-2020, 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
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000016
Dan Handleyed6ff952014-05-14 17:44:19 +010017/*******************************************************************************
18 * Forward declarations
19 ******************************************************************************/
dp-armb3e85802016-12-12 14:48:13 +000020struct auth_img_desc_s;
Dan Handleyed6ff952014-05-14 17:44:19 +010021struct meminfo;
22struct image_info;
23struct entry_point_info;
Yatharth Kochara65be2f2015-10-09 18:06:13 +010024struct image_desc;
Yatharth Kochar3345a8d2016-09-12 16:08:41 +010025struct bl_load_info;
26struct bl_params;
Antonio Nino Diazc41f2062017-10-24 10:07:35 +010027struct mmap_region;
Paul Beesley45f40282019-10-15 10:57:42 +000028struct spm_mm_boot_info;
Antonio Nino Diazb86edcb2018-10-30 11:12:42 +000029struct sp_res_desc;
Sumit Garg617e2152019-11-15 15:34:55 +053030enum fw_enc_status_t;
Dan Handleyed6ff952014-05-14 17:44:19 +010031
32/*******************************************************************************
Juan Castillo31a68f02015-04-14 12:49:03 +010033 * plat_get_rotpk_info() flags
34 ******************************************************************************/
35#define ROTPK_IS_HASH (1 << 0)
Soby Mathew2f7ed052016-05-24 15:05:15 +010036/* Flag used to skip verification of the certificate ROTPK while the platform
37 ROTPK is not deployed */
38#define ROTPK_NOT_DEPLOYED (1 << 1)
Juan Castillo31a68f02015-04-14 12:49:03 +010039
40/*******************************************************************************
Sumit Garg392e4df2019-11-15 10:43:00 +053041 * plat_get_enc_key_info() flags
42 ******************************************************************************/
43/*
44 * Flag used to notify caller that information provided in key buffer is an
45 * identifier rather than an actual key.
46 */
47#define ENC_KEY_IS_IDENTIFIER (1 << 0)
48
49/*******************************************************************************
Dan Handley7ce42df2014-05-15 14:11:36 +010050 * Function declarations
Dan Handleyed6ff952014-05-14 17:44:19 +010051 ******************************************************************************/
Dan Handley7ce42df2014-05-15 14:11:36 +010052/*******************************************************************************
53 * Mandatory common functions
54 ******************************************************************************/
Antonio Nino Diaz391a76e2016-05-18 16:53:31 +010055unsigned int plat_get_syscnt_freq2(void);
56
Juan Castillo3a66aca2015-04-13 17:36:19 +010057int plat_get_image_source(unsigned int image_id,
Dan Handley7ce42df2014-05-15 14:11:36 +010058 uintptr_t *dev_handle,
59 uintptr_t *image_spec);
Soby Mathew21f93612016-03-23 10:11:10 +000060uintptr_t plat_get_ns_image_entrypoint(void);
Soby Mathew981487a2015-07-13 14:10:57 +010061unsigned int plat_my_core_pos(void);
62int plat_core_pos_by_mpidr(u_register_t mpidr);
Ambroise Vincentd207f562019-04-10 12:50:27 +010063int plat_get_mbedtls_heap(void **heap_addr, size_t *heap_size);
Dan Handley7ce42df2014-05-15 14:11:36 +010064
Douglas Raillard306593d2017-02-24 18:14:15 +000065#if STACK_PROTECTOR_ENABLED
66/*
67 * Return a new value to be used for the stack protection's canary.
68 *
69 * Ideally, this value is a random number that is impossible to predict by an
70 * attacker.
71 */
72u_register_t plat_get_stack_protector_canary(void);
73#endif /* STACK_PROTECTOR_ENABLED */
74
Dan Handley7ce42df2014-05-15 14:11:36 +010075/*******************************************************************************
76 * Mandatory interrupt management functions
77 ******************************************************************************/
Dan Handley701fea72014-05-27 16:17:21 +010078uint32_t plat_ic_get_pending_interrupt_id(void);
79uint32_t plat_ic_get_pending_interrupt_type(void);
80uint32_t plat_ic_acknowledge_interrupt(void);
81uint32_t plat_ic_get_interrupt_type(uint32_t id);
82void plat_ic_end_of_interrupt(uint32_t id);
Dan Handleyed6ff952014-05-14 17:44:19 +010083uint32_t plat_interrupt_type_to_line(uint32_t type,
84 uint32_t security_state);
85
Dan Handley7ce42df2014-05-15 14:11:36 +010086/*******************************************************************************
Jeenu Viswambharanb1e957e2017-09-22 08:32:09 +010087 * Optional interrupt management functions, depending on chosen EL3 components.
88 ******************************************************************************/
89unsigned int plat_ic_get_running_priority(void);
Jeenu Viswambharan522a4652017-09-22 08:32:09 +010090int plat_ic_is_spi(unsigned int id);
91int plat_ic_is_ppi(unsigned int id);
92int plat_ic_is_sgi(unsigned int id);
Jeenu Viswambharan24e70292017-09-22 08:32:09 +010093unsigned int plat_ic_get_interrupt_active(unsigned int id);
Jeenu Viswambharan0fcdfff2017-09-22 08:32:09 +010094void plat_ic_disable_interrupt(unsigned int id);
95void plat_ic_enable_interrupt(unsigned int id);
Jeenu Viswambharanc06f05c2017-09-22 08:32:09 +010096int plat_ic_has_interrupt_type(unsigned int type);
97void plat_ic_set_interrupt_type(unsigned int id, unsigned int type);
Jeenu Viswambharan447b89d2017-09-22 08:32:09 +010098void plat_ic_set_interrupt_priority(unsigned int id, unsigned int priority);
Jeenu Viswambharanab14e9b2017-09-22 08:32:09 +010099void plat_ic_raise_el3_sgi(int sgi_num, u_register_t target);
Jeenu Viswambharandce70b32017-09-22 08:32:09 +0100100void plat_ic_set_spi_routing(unsigned int id, unsigned int routing_mode,
101 u_register_t mpidr);
Jeenu Viswambharaneb1c12c2017-09-22 08:32:09 +0100102void plat_ic_set_interrupt_pending(unsigned int id);
103void plat_ic_clear_interrupt_pending(unsigned int id);
Jeenu Viswambharan62505072017-09-22 08:32:09 +0100104unsigned int plat_ic_set_priority_mask(unsigned int mask);
Jeenu Viswambharan055af4b2017-10-24 15:13:59 +0100105unsigned int plat_ic_get_interrupt_id(unsigned int raw);
Jeenu Viswambharanb1e957e2017-09-22 08:32:09 +0100106
107/*******************************************************************************
Dan Handley7ce42df2014-05-15 14:11:36 +0100108 * Optional common functions (may be overridden)
109 ******************************************************************************/
Soby Mathewa0fedc42016-06-16 14:52:04 +0100110uintptr_t plat_get_my_stack(void);
Yatharth Kocharf528faf2016-06-28 16:58:26 +0100111void plat_report_exception(unsigned int exception_type);
Sandrine Bailleux046cd3f2014-08-06 11:27:23 +0100112int plat_crash_console_init(void);
Soby Mathew066f7132014-07-14 16:57:23 +0100113int plat_crash_console_putc(int c);
Antonio Nino Diazd3ec5432017-02-17 17:11:27 +0000114int plat_crash_console_flush(void);
Juan Castillo26ae5832015-09-25 15:41:14 +0100115void plat_error_handler(int err) __dead2;
Antonio Nino Diaz1f21bcf2016-02-01 13:57:25 +0000116void plat_panic_handler(void) __dead2;
Soby Mathewaaf15f52017-09-04 11:49:29 +0100117const char *plat_log_get_prefix(unsigned int log_level);
Roberto Vargasbc1ae1f2017-09-26 12:53:01 +0100118void bl2_plat_preload_setup(void);
119int plat_try_next_boot_source(void);
Dan Handley7ce42df2014-05-15 14:11:36 +0100120
121/*******************************************************************************
122 * Mandatory BL1 functions
123 ******************************************************************************/
Dan Handley4fd2f5c2014-08-04 11:41:20 +0100124void bl1_early_platform_setup(void);
Dan Handley7ce42df2014-05-15 14:11:36 +0100125void bl1_plat_arch_setup(void);
126void bl1_platform_setup(void);
127struct meminfo *bl1_plat_sec_mem_layout(void);
Dan Handleyed6ff952014-05-14 17:44:19 +0100128
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100129/*******************************************************************************
130 * Optional EL3 component functions in BL31
131 ******************************************************************************/
132
133/* SDEI platform functions */
134#if SDEI_SUPPORT
Balint Dobszayd0dbd5e2019-12-18 15:28:00 +0100135void plat_sdei_setup(void);
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100136int plat_sdei_validate_entry_point(uintptr_t ep, unsigned int client_mode);
137void plat_sdei_handle_masked_trigger(uint64_t mpidr, unsigned int intr);
138#endif
139
Jeenu Viswambharan96c7df02017-11-30 12:54:15 +0000140void plat_ea_handler(unsigned int ea_reason, uint64_t syndrome, void *cookie,
141 void *handle, uint64_t flags);
142
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100143/*
144 * The following function is mandatory when the
145 * firmware update feature is used.
146 */
147int bl1_plat_mem_check(uintptr_t mem_base, unsigned int mem_size,
148 unsigned int flags);
149
Dan Handley7ce42df2014-05-15 14:11:36 +0100150/*******************************************************************************
151 * Optional BL1 functions (may be overridden)
152 ******************************************************************************/
Yatharth Kochara65be2f2015-10-09 18:06:13 +0100153/*
154 * The following functions are used for image loading process in BL1.
155 */
156void bl1_plat_set_ep_info(unsigned int image_id,
157 struct entry_point_info *ep_info);
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100158/*
159 * The following functions are mandatory when firmware update
160 * feature is used and optional otherwise.
161 */
Yatharth Kochara65be2f2015-10-09 18:06:13 +0100162unsigned int bl1_plat_get_next_image_id(void);
163struct image_desc *bl1_plat_get_image_desc(unsigned int image_id);
Dan Handley7ce42df2014-05-15 14:11:36 +0100164
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100165/*
166 * The following functions are used by firmware update
167 * feature and may optionally be overridden.
168 */
Dan Handley89f8f332015-12-15 14:28:24 +0000169__dead2 void bl1_plat_fwu_done(void *client_cookie, void *reserved);
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100170
Masahiro Yamada43d20b32018-02-01 16:46:18 +0900171/*
Soby Mathew2f38ce32018-02-08 17:45:12 +0000172 * This BL1 function can be used by the platforms to update/use image
173 * information for a given `image_id`.
Masahiro Yamada43d20b32018-02-01 16:46:18 +0900174 */
Soby Mathew2f38ce32018-02-08 17:45:12 +0000175int bl1_plat_handle_pre_image_load(unsigned int image_id);
176int bl1_plat_handle_post_image_load(unsigned int image_id);
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100177
Alexei Fedorovc7176172020-07-13 12:11:05 +0100178#if MEASURED_BOOT
179/*
180 * Calculates and writes BL2 hash data to the platform's defined location.
181 * For ARM platforms the data are written to TB_FW_CONFIG DTB.
182 */
183void bl1_plat_set_bl2_hash(const image_desc_t *image_desc);
184#endif
185
Dan Handley7ce42df2014-05-15 14:11:36 +0100186/*******************************************************************************
187 * Mandatory BL2 functions
188 ******************************************************************************/
Soby Mathew73308d02018-01-09 14:36:14 +0000189void 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 +0100190void bl2_plat_arch_setup(void);
191void bl2_platform_setup(void);
192struct meminfo *bl2_plat_sec_mem_layout(void);
193
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100194/*
195 * This function can be used by the platforms to update/use image
196 * information for given `image_id`.
197 */
Masahiro Yamada02a0d3d2018-02-01 16:45:51 +0900198int bl2_plat_handle_pre_image_load(unsigned int image_id);
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100199int bl2_plat_handle_post_image_load(unsigned int image_id);
200
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100201/*******************************************************************************
Dan Handley7ce42df2014-05-15 14:11:36 +0100202 * Optional BL2 functions (may be overridden)
203 ******************************************************************************/
Alexei Fedorovc7176172020-07-13 12:11:05 +0100204#if MEASURED_BOOT
205/* Read TCG_DIGEST_SIZE bytes of BL2 hash data */
206void bl2_plat_get_hash(void *data);
207#endif
Roberto Vargase0e99462017-10-30 14:43:43 +0000208
209/*******************************************************************************
210 * Mandatory BL2 at EL3 functions: Must be implemented if BL2_AT_EL3 image is
211 * supported
212 ******************************************************************************/
213void bl2_el3_early_platform_setup(u_register_t arg0, u_register_t arg1,
214 u_register_t arg2, u_register_t arg3);
215void bl2_el3_plat_arch_setup(void);
216
Roberto Vargase0e99462017-10-30 14:43:43 +0000217/*******************************************************************************
218 * Optional BL2 at EL3 functions (may be overridden)
219 ******************************************************************************/
220void bl2_el3_plat_prepare_exit(void);
221
Dan Handley7ce42df2014-05-15 14:11:36 +0100222/*******************************************************************************
Yatharth Kocharb1c2fe02015-10-14 15:27:24 +0100223 * Mandatory BL2U functions.
224 ******************************************************************************/
225void bl2u_early_platform_setup(struct meminfo *mem_layout,
226 void *plat_info);
227void bl2u_plat_arch_setup(void);
228void bl2u_platform_setup(void);
229
230/*******************************************************************************
231 * Conditionally mandatory BL2U functions for CSS platforms.
232 ******************************************************************************/
233/*
234 * This function is used to perform any platform-specific actions required to
235 * handle the BL2U_SCP firmware.
236 */
237int bl2u_plat_handle_scp_bl2u(void);
238
239/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000240 * Mandatory BL31 functions
Dan Handley7ce42df2014-05-15 14:11:36 +0100241 ******************************************************************************/
Soby Mathew73308d02018-01-09 14:36:14 +0000242void bl31_early_platform_setup2(u_register_t arg0, u_register_t arg1,
243 u_register_t arg2, u_register_t arg3);
Dan Handley7ce42df2014-05-15 14:11:36 +0100244void bl31_plat_arch_setup(void);
245void bl31_platform_setup(void);
Soby Mathew1ff495b2015-12-09 11:28:43 +0000246void bl31_plat_runtime_setup(void);
Dan Handley701fea72014-05-27 16:17:21 +0100247struct entry_point_info *bl31_plat_get_next_image_ep_info(uint32_t type);
Dan Handley7ce42df2014-05-15 14:11:36 +0100248
249/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000250 * Mandatory PSCI functions (BL31)
Dan Handley7ce42df2014-05-15 14:11:36 +0100251 ******************************************************************************/
Soby Mathew981487a2015-07-13 14:10:57 +0100252int plat_setup_psci_ops(uintptr_t sec_entrypoint,
Roberto Vargas777dd432018-02-12 12:36:17 +0000253 const struct plat_psci_ops **psci_ops);
Soby Mathew981487a2015-07-13 14:10:57 +0100254const unsigned char *plat_get_power_domain_tree_desc(void);
255
256/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000257 * Optional PSCI functions (BL31).
Soby Mathew981487a2015-07-13 14:10:57 +0100258 ******************************************************************************/
dp-arm66abfbe2017-01-31 13:01:04 +0000259void plat_psci_stat_accounting_start(const psci_power_state_t *state_info);
260void plat_psci_stat_accounting_stop(const psci_power_state_t *state_info);
261u_register_t plat_psci_stat_get_residency(unsigned int lvl,
262 const psci_power_state_t *state_info,
Deepika Bhavnani4287c0c2019-12-13 10:23:18 -0600263 unsigned int last_cpu_idx);
Soby Mathew981487a2015-07-13 14:10:57 +0100264plat_local_state_t plat_get_target_pwr_state(unsigned int lvl,
265 const plat_local_state_t *states,
266 unsigned int ncpu);
Dan Handley7ce42df2014-05-15 14:11:36 +0100267
268/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000269 * Optional BL31 functions (may be overridden)
Dan Handleyb226a4d2014-05-16 14:08:45 +0100270 ******************************************************************************/
Achin Guptae9982542014-06-26 08:59:07 +0100271void bl31_plat_enable_mmu(uint32_t flags);
Dan Handleyb226a4d2014-05-16 14:08:45 +0100272
273/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000274 * Optional BL32 functions (may be overridden)
Dan Handleyb226a4d2014-05-16 14:08:45 +0100275 ******************************************************************************/
Achin Guptae9982542014-06-26 08:59:07 +0100276void bl32_plat_enable_mmu(uint32_t flags);
Dan Handleyb226a4d2014-05-16 14:08:45 +0100277
Juan Castillo5e29c752015-01-07 10:39:25 +0000278/*******************************************************************************
Juan Castillo31a68f02015-04-14 12:49:03 +0100279 * Trusted Board Boot functions
Juan Castillo5e29c752015-01-07 10:39:25 +0000280 ******************************************************************************/
Juan Castillo31a68f02015-04-14 12:49:03 +0100281int plat_get_rotpk_info(void *cookie, void **key_ptr, unsigned int *key_len,
282 unsigned int *flags);
Juan Castillobfb7fa62016-01-22 11:05:57 +0000283int plat_get_nv_ctr(void *cookie, unsigned int *nv_ctr);
284int plat_set_nv_ctr(void *cookie, unsigned int nv_ctr);
dp-armb3e85802016-12-12 14:48:13 +0000285int plat_set_nv_ctr2(void *cookie, const struct auth_img_desc_s *img_desc,
286 unsigned int nv_ctr);
Ambroise Vincentd207f562019-04-10 12:50:27 +0100287int get_mbedtls_heap_helper(void **heap_addr, size_t *heap_size);
Sumit Garg617e2152019-11-15 15:34:55 +0530288int plat_get_enc_key_info(enum fw_enc_status_t fw_enc_status, uint8_t *key,
289 size_t *key_len, unsigned int *flags,
290 const uint8_t *img_id, size_t img_id_len);
Juan Castillo5e29c752015-01-07 10:39:25 +0000291
Antonio Nino Diazc41f2062017-10-24 10:07:35 +0100292/*******************************************************************************
293 * Secure Partitions functions
294 ******************************************************************************/
295const struct mmap_region *plat_get_secure_partition_mmap(void *cookie);
Paul Beesley45f40282019-10-15 10:57:42 +0000296const struct spm_mm_boot_info *plat_get_secure_partition_boot_info(
Antonio Nino Diazc41f2062017-10-24 10:07:35 +0100297 void *cookie);
Antonio Nino Diazb86edcb2018-10-30 11:12:42 +0000298int plat_spm_sp_rd_load(struct sp_res_desc *rd, const void *ptr, size_t size);
Antonio Nino Diaz840627f2018-11-27 08:36:02 +0000299int plat_spm_sp_get_next_address(void **sp_base, size_t *sp_size,
300 void **rd_base, size_t *rd_size);
Achin Guptada6ef0e2019-10-11 14:54:48 +0100301#if defined(SPD_spmd)
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200302int plat_spm_core_manifest_load(spmc_manifest_attribute_t *manifest,
Olivier Deprez69ca84a2020-02-07 15:44:43 +0100303 const void *pm_addr);
Achin Guptada6ef0e2019-10-11 14:54:48 +0100304#endif
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100305/*******************************************************************************
306 * Mandatory BL image load functions(may be overridden).
307 ******************************************************************************/
308/*
309 * This function returns pointer to the list of images that the
310 * platform has populated to load.
311 */
312struct bl_load_info *plat_get_bl_image_load_info(void);
313
314/*
315 * This function returns a pointer to the shared memory that the
316 * platform has kept aside to pass trusted firmware related
317 * information that next BL image could need.
318 */
319struct bl_params *plat_get_next_bl_params(void);
320
321/*
322 * This function flushes to main memory all the params that are
323 * passed to next image.
324 */
325void plat_flush_next_bl_params(void);
326
Soby Mathew70716d62015-07-13 16:26:11 +0100327/*
328 * The below function enable Trusted Firmware components like SPDs which
329 * haven't migrated to the new platform API to compile on platforms which
330 * have the compatibility layer disabled.
331 */
Roberto Vargas05712702018-02-12 12:36:17 +0000332unsigned int platform_core_pos_helper(unsigned long mpidr);
Douglas Raillard306593d2017-02-24 18:14:15 +0000333
Manish V Badarkhef809c6e2020-02-22 08:43:00 +0000334/*
335 * Optional function to get SOC version
336 */
337int32_t plat_get_soc_version(void);
338
339/*
340 * Optional function to get SOC revision
341 */
342int32_t plat_get_soc_revision(void);
343
Manish V Badarkhe80f13ee2020-07-23 20:23:01 +0100344/*
345 * Optional function to check for SMCCC function availability for platform
346 */
347int32_t plat_is_smccc_feature_available(u_register_t fid);
348
Antonio Nino Diazfec756f2018-07-18 16:24:16 +0100349#endif /* PLATFORM_H */