blob: 3f9ab1b66261e01f546a84f6bbd415ac1f7b52cd [file] [log] [blame]
Dan Handleyed6ff952014-05-14 17:44:19 +01001/*
Antonio Nino Diaz25cda672019-02-19 11:53:51 +00002 * Copyright (c) 2013-2019, 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>
13
Dan Handleyed6ff952014-05-14 17:44:19 +010014/*******************************************************************************
15 * Forward declarations
16 ******************************************************************************/
dp-armb3e85802016-12-12 14:48:13 +000017struct auth_img_desc_s;
Dan Handleyed6ff952014-05-14 17:44:19 +010018struct meminfo;
19struct image_info;
20struct entry_point_info;
Yatharth Kochara65be2f2015-10-09 18:06:13 +010021struct image_desc;
Yatharth Kochar3345a8d2016-09-12 16:08:41 +010022struct bl_load_info;
23struct bl_params;
Antonio Nino Diazc41f2062017-10-24 10:07:35 +010024struct mmap_region;
25struct secure_partition_boot_info;
Antonio Nino Diazb86edcb2018-10-30 11:12:42 +000026struct sp_res_desc;
Dan Handleyed6ff952014-05-14 17:44:19 +010027
28/*******************************************************************************
Juan Castillo31a68f02015-04-14 12:49:03 +010029 * plat_get_rotpk_info() flags
30 ******************************************************************************/
31#define ROTPK_IS_HASH (1 << 0)
Soby Mathew2f7ed052016-05-24 15:05:15 +010032/* Flag used to skip verification of the certificate ROTPK while the platform
33 ROTPK is not deployed */
34#define ROTPK_NOT_DEPLOYED (1 << 1)
Juan Castillo31a68f02015-04-14 12:49:03 +010035
36/*******************************************************************************
Dan Handley7ce42df2014-05-15 14:11:36 +010037 * Function declarations
Dan Handleyed6ff952014-05-14 17:44:19 +010038 ******************************************************************************/
Dan Handley7ce42df2014-05-15 14:11:36 +010039/*******************************************************************************
40 * Mandatory common functions
41 ******************************************************************************/
Antonio Nino Diaz391a76e2016-05-18 16:53:31 +010042unsigned int plat_get_syscnt_freq2(void);
43
Juan Castillo3a66aca2015-04-13 17:36:19 +010044int plat_get_image_source(unsigned int image_id,
Dan Handley7ce42df2014-05-15 14:11:36 +010045 uintptr_t *dev_handle,
46 uintptr_t *image_spec);
Soby Mathew21f93612016-03-23 10:11:10 +000047uintptr_t plat_get_ns_image_entrypoint(void);
Soby Mathew981487a2015-07-13 14:10:57 +010048unsigned int plat_my_core_pos(void);
49int plat_core_pos_by_mpidr(u_register_t mpidr);
Ambroise Vincentd207f562019-04-10 12:50:27 +010050int plat_get_mbedtls_heap(void **heap_addr, size_t *heap_size);
Dan Handley7ce42df2014-05-15 14:11:36 +010051
Douglas Raillard306593d2017-02-24 18:14:15 +000052#if STACK_PROTECTOR_ENABLED
53/*
54 * Return a new value to be used for the stack protection's canary.
55 *
56 * Ideally, this value is a random number that is impossible to predict by an
57 * attacker.
58 */
59u_register_t plat_get_stack_protector_canary(void);
60#endif /* STACK_PROTECTOR_ENABLED */
61
Dan Handley7ce42df2014-05-15 14:11:36 +010062/*******************************************************************************
63 * Mandatory interrupt management functions
64 ******************************************************************************/
Dan Handley701fea72014-05-27 16:17:21 +010065uint32_t plat_ic_get_pending_interrupt_id(void);
66uint32_t plat_ic_get_pending_interrupt_type(void);
67uint32_t plat_ic_acknowledge_interrupt(void);
68uint32_t plat_ic_get_interrupt_type(uint32_t id);
69void plat_ic_end_of_interrupt(uint32_t id);
Dan Handleyed6ff952014-05-14 17:44:19 +010070uint32_t plat_interrupt_type_to_line(uint32_t type,
71 uint32_t security_state);
72
Dan Handley7ce42df2014-05-15 14:11:36 +010073/*******************************************************************************
Jeenu Viswambharanb1e957e2017-09-22 08:32:09 +010074 * Optional interrupt management functions, depending on chosen EL3 components.
75 ******************************************************************************/
76unsigned int plat_ic_get_running_priority(void);
Jeenu Viswambharan522a4652017-09-22 08:32:09 +010077int plat_ic_is_spi(unsigned int id);
78int plat_ic_is_ppi(unsigned int id);
79int plat_ic_is_sgi(unsigned int id);
Jeenu Viswambharan24e70292017-09-22 08:32:09 +010080unsigned int plat_ic_get_interrupt_active(unsigned int id);
Jeenu Viswambharan0fcdfff2017-09-22 08:32:09 +010081void plat_ic_disable_interrupt(unsigned int id);
82void plat_ic_enable_interrupt(unsigned int id);
Jeenu Viswambharanc06f05c2017-09-22 08:32:09 +010083int plat_ic_has_interrupt_type(unsigned int type);
84void plat_ic_set_interrupt_type(unsigned int id, unsigned int type);
Jeenu Viswambharan447b89d2017-09-22 08:32:09 +010085void plat_ic_set_interrupt_priority(unsigned int id, unsigned int priority);
Jeenu Viswambharanab14e9b2017-09-22 08:32:09 +010086void plat_ic_raise_el3_sgi(int sgi_num, u_register_t target);
Jeenu Viswambharandce70b32017-09-22 08:32:09 +010087void plat_ic_set_spi_routing(unsigned int id, unsigned int routing_mode,
88 u_register_t mpidr);
Jeenu Viswambharaneb1c12c2017-09-22 08:32:09 +010089void plat_ic_set_interrupt_pending(unsigned int id);
90void plat_ic_clear_interrupt_pending(unsigned int id);
Jeenu Viswambharan62505072017-09-22 08:32:09 +010091unsigned int plat_ic_set_priority_mask(unsigned int mask);
Jeenu Viswambharan055af4b2017-10-24 15:13:59 +010092unsigned int plat_ic_get_interrupt_id(unsigned int raw);
Jeenu Viswambharanb1e957e2017-09-22 08:32:09 +010093
94/*******************************************************************************
Dan Handley7ce42df2014-05-15 14:11:36 +010095 * Optional common functions (may be overridden)
96 ******************************************************************************/
Soby Mathewa0fedc42016-06-16 14:52:04 +010097uintptr_t plat_get_my_stack(void);
Yatharth Kocharf528faf2016-06-28 16:58:26 +010098void plat_report_exception(unsigned int exception_type);
Sandrine Bailleux046cd3f2014-08-06 11:27:23 +010099int plat_crash_console_init(void);
Soby Mathew066f7132014-07-14 16:57:23 +0100100int plat_crash_console_putc(int c);
Antonio Nino Diazd3ec5432017-02-17 17:11:27 +0000101int plat_crash_console_flush(void);
Juan Castillo26ae5832015-09-25 15:41:14 +0100102void plat_error_handler(int err) __dead2;
Antonio Nino Diaz1f21bcf2016-02-01 13:57:25 +0000103void plat_panic_handler(void) __dead2;
Soby Mathewaaf15f52017-09-04 11:49:29 +0100104const char *plat_log_get_prefix(unsigned int log_level);
Roberto Vargasbc1ae1f2017-09-26 12:53:01 +0100105void bl2_plat_preload_setup(void);
106int plat_try_next_boot_source(void);
Antonio Nino Diaz25cda672019-02-19 11:53:51 +0000107uint64_t *plat_init_apiakey(void);
Dan Handley7ce42df2014-05-15 14:11:36 +0100108
109/*******************************************************************************
110 * Mandatory BL1 functions
111 ******************************************************************************/
Dan Handley4fd2f5c2014-08-04 11:41:20 +0100112void bl1_early_platform_setup(void);
Dan Handley7ce42df2014-05-15 14:11:36 +0100113void bl1_plat_arch_setup(void);
114void bl1_platform_setup(void);
115struct meminfo *bl1_plat_sec_mem_layout(void);
Dan Handleyed6ff952014-05-14 17:44:19 +0100116
Jeenu Viswambharan04e3a7f2017-10-16 08:43:14 +0100117/*******************************************************************************
118 * Optional EL3 component functions in BL31
119 ******************************************************************************/
120
121/* SDEI platform functions */
122#if SDEI_SUPPORT
123int plat_sdei_validate_entry_point(uintptr_t ep, unsigned int client_mode);
124void plat_sdei_handle_masked_trigger(uint64_t mpidr, unsigned int intr);
125#endif
126
Jeenu Viswambharan96c7df02017-11-30 12:54:15 +0000127void plat_ea_handler(unsigned int ea_reason, uint64_t syndrome, void *cookie,
128 void *handle, uint64_t flags);
129
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100130/*
131 * The following function is mandatory when the
132 * firmware update feature is used.
133 */
134int bl1_plat_mem_check(uintptr_t mem_base, unsigned int mem_size,
135 unsigned int flags);
136
Dan Handley7ce42df2014-05-15 14:11:36 +0100137/*******************************************************************************
138 * Optional BL1 functions (may be overridden)
139 ******************************************************************************/
Yatharth Kochara65be2f2015-10-09 18:06:13 +0100140/*
141 * The following functions are used for image loading process in BL1.
142 */
143void bl1_plat_set_ep_info(unsigned int image_id,
144 struct entry_point_info *ep_info);
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100145/*
146 * The following functions are mandatory when firmware update
147 * feature is used and optional otherwise.
148 */
Yatharth Kochara65be2f2015-10-09 18:06:13 +0100149unsigned int bl1_plat_get_next_image_id(void);
150struct image_desc *bl1_plat_get_image_desc(unsigned int image_id);
Dan Handley7ce42df2014-05-15 14:11:36 +0100151
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100152/*
153 * The following functions are used by firmware update
154 * feature and may optionally be overridden.
155 */
Dan Handley89f8f332015-12-15 14:28:24 +0000156__dead2 void bl1_plat_fwu_done(void *client_cookie, void *reserved);
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100157
Masahiro Yamada43d20b32018-02-01 16:46:18 +0900158/*
Soby Mathew2f38ce32018-02-08 17:45:12 +0000159 * This BL1 function can be used by the platforms to update/use image
160 * information for a given `image_id`.
Masahiro Yamada43d20b32018-02-01 16:46:18 +0900161 */
Soby Mathew2f38ce32018-02-08 17:45:12 +0000162int bl1_plat_handle_pre_image_load(unsigned int image_id);
163int bl1_plat_handle_post_image_load(unsigned int image_id);
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100164
Dan Handley7ce42df2014-05-15 14:11:36 +0100165/*******************************************************************************
166 * Mandatory BL2 functions
167 ******************************************************************************/
Soby Mathew73308d02018-01-09 14:36:14 +0000168void 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 +0100169void bl2_plat_arch_setup(void);
170void bl2_platform_setup(void);
171struct meminfo *bl2_plat_sec_mem_layout(void);
172
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100173/*
174 * This function can be used by the platforms to update/use image
175 * information for given `image_id`.
176 */
Masahiro Yamada02a0d3d2018-02-01 16:45:51 +0900177int bl2_plat_handle_pre_image_load(unsigned int image_id);
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100178int bl2_plat_handle_post_image_load(unsigned int image_id);
179
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100180
181/*******************************************************************************
Dan Handley7ce42df2014-05-15 14:11:36 +0100182 * Optional BL2 functions (may be overridden)
183 ******************************************************************************/
184
Roberto Vargase0e99462017-10-30 14:43:43 +0000185
186/*******************************************************************************
187 * Mandatory BL2 at EL3 functions: Must be implemented if BL2_AT_EL3 image is
188 * supported
189 ******************************************************************************/
190void bl2_el3_early_platform_setup(u_register_t arg0, u_register_t arg1,
191 u_register_t arg2, u_register_t arg3);
192void bl2_el3_plat_arch_setup(void);
193
194
195/*******************************************************************************
196 * Optional BL2 at EL3 functions (may be overridden)
197 ******************************************************************************/
198void bl2_el3_plat_prepare_exit(void);
199
Dan Handley7ce42df2014-05-15 14:11:36 +0100200/*******************************************************************************
Yatharth Kocharb1c2fe02015-10-14 15:27:24 +0100201 * Mandatory BL2U functions.
202 ******************************************************************************/
203void bl2u_early_platform_setup(struct meminfo *mem_layout,
204 void *plat_info);
205void bl2u_plat_arch_setup(void);
206void bl2u_platform_setup(void);
207
208/*******************************************************************************
209 * Conditionally mandatory BL2U functions for CSS platforms.
210 ******************************************************************************/
211/*
212 * This function is used to perform any platform-specific actions required to
213 * handle the BL2U_SCP firmware.
214 */
215int bl2u_plat_handle_scp_bl2u(void);
216
217/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000218 * Mandatory BL31 functions
Dan Handley7ce42df2014-05-15 14:11:36 +0100219 ******************************************************************************/
Soby Mathew73308d02018-01-09 14:36:14 +0000220void bl31_early_platform_setup2(u_register_t arg0, u_register_t arg1,
221 u_register_t arg2, u_register_t arg3);
Dan Handley7ce42df2014-05-15 14:11:36 +0100222void bl31_plat_arch_setup(void);
223void bl31_platform_setup(void);
Soby Mathew1ff495b2015-12-09 11:28:43 +0000224void bl31_plat_runtime_setup(void);
Dan Handley701fea72014-05-27 16:17:21 +0100225struct entry_point_info *bl31_plat_get_next_image_ep_info(uint32_t type);
Dan Handley7ce42df2014-05-15 14:11:36 +0100226
227/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000228 * Mandatory PSCI functions (BL31)
Dan Handley7ce42df2014-05-15 14:11:36 +0100229 ******************************************************************************/
Soby Mathew981487a2015-07-13 14:10:57 +0100230int plat_setup_psci_ops(uintptr_t sec_entrypoint,
Roberto Vargas777dd432018-02-12 12:36:17 +0000231 const struct plat_psci_ops **psci_ops);
Soby Mathew981487a2015-07-13 14:10:57 +0100232const unsigned char *plat_get_power_domain_tree_desc(void);
233
234/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000235 * Optional PSCI functions (BL31).
Soby Mathew981487a2015-07-13 14:10:57 +0100236 ******************************************************************************/
dp-arm66abfbe2017-01-31 13:01:04 +0000237void plat_psci_stat_accounting_start(const psci_power_state_t *state_info);
238void plat_psci_stat_accounting_stop(const psci_power_state_t *state_info);
239u_register_t plat_psci_stat_get_residency(unsigned int lvl,
240 const psci_power_state_t *state_info,
Roberto Vargas777dd432018-02-12 12:36:17 +0000241 int last_cpu_idx);
Soby Mathew981487a2015-07-13 14:10:57 +0100242plat_local_state_t plat_get_target_pwr_state(unsigned int lvl,
243 const plat_local_state_t *states,
244 unsigned int ncpu);
Dan Handley7ce42df2014-05-15 14:11:36 +0100245
246/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000247 * Optional BL31 functions (may be overridden)
Dan Handleyb226a4d2014-05-16 14:08:45 +0100248 ******************************************************************************/
Achin Guptae9982542014-06-26 08:59:07 +0100249void bl31_plat_enable_mmu(uint32_t flags);
Dan Handleyb226a4d2014-05-16 14:08:45 +0100250
251/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000252 * Optional BL32 functions (may be overridden)
Dan Handleyb226a4d2014-05-16 14:08:45 +0100253 ******************************************************************************/
Achin Guptae9982542014-06-26 08:59:07 +0100254void bl32_plat_enable_mmu(uint32_t flags);
Dan Handleyb226a4d2014-05-16 14:08:45 +0100255
Juan Castillo5e29c752015-01-07 10:39:25 +0000256/*******************************************************************************
Juan Castillo31a68f02015-04-14 12:49:03 +0100257 * Trusted Board Boot functions
Juan Castillo5e29c752015-01-07 10:39:25 +0000258 ******************************************************************************/
Juan Castillo31a68f02015-04-14 12:49:03 +0100259int plat_get_rotpk_info(void *cookie, void **key_ptr, unsigned int *key_len,
260 unsigned int *flags);
Juan Castillobfb7fa62016-01-22 11:05:57 +0000261int plat_get_nv_ctr(void *cookie, unsigned int *nv_ctr);
262int plat_set_nv_ctr(void *cookie, unsigned int nv_ctr);
dp-armb3e85802016-12-12 14:48:13 +0000263int plat_set_nv_ctr2(void *cookie, const struct auth_img_desc_s *img_desc,
264 unsigned int nv_ctr);
Ambroise Vincentd207f562019-04-10 12:50:27 +0100265int get_mbedtls_heap_helper(void **heap_addr, size_t *heap_size);
Juan Castillo5e29c752015-01-07 10:39:25 +0000266
Antonio Nino Diazc41f2062017-10-24 10:07:35 +0100267/*******************************************************************************
268 * Secure Partitions functions
269 ******************************************************************************/
270const struct mmap_region *plat_get_secure_partition_mmap(void *cookie);
271const struct secure_partition_boot_info *plat_get_secure_partition_boot_info(
272 void *cookie);
Antonio Nino Diazb86edcb2018-10-30 11:12:42 +0000273int plat_spm_sp_rd_load(struct sp_res_desc *rd, const void *ptr, size_t size);
Antonio Nino Diaz840627f2018-11-27 08:36:02 +0000274int plat_spm_sp_get_next_address(void **sp_base, size_t *sp_size,
275 void **rd_base, size_t *rd_size);
Antonio Nino Diazc41f2062017-10-24 10:07:35 +0100276
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100277/*******************************************************************************
278 * Mandatory BL image load functions(may be overridden).
279 ******************************************************************************/
280/*
281 * This function returns pointer to the list of images that the
282 * platform has populated to load.
283 */
284struct bl_load_info *plat_get_bl_image_load_info(void);
285
286/*
287 * This function returns a pointer to the shared memory that the
288 * platform has kept aside to pass trusted firmware related
289 * information that next BL image could need.
290 */
291struct bl_params *plat_get_next_bl_params(void);
292
293/*
294 * This function flushes to main memory all the params that are
295 * passed to next image.
296 */
297void plat_flush_next_bl_params(void);
298
Soby Mathew70716d62015-07-13 16:26:11 +0100299/*
300 * The below function enable Trusted Firmware components like SPDs which
301 * haven't migrated to the new platform API to compile on platforms which
302 * have the compatibility layer disabled.
303 */
Roberto Vargas05712702018-02-12 12:36:17 +0000304unsigned int platform_core_pos_helper(unsigned long mpidr);
Douglas Raillard306593d2017-02-24 18:14:15 +0000305
Antonio Nino Diazfec756f2018-07-18 16:24:16 +0100306#endif /* PLATFORM_H */