blob: 096010589a43d16d8d7dcf93955d675d12a1ffea [file] [log] [blame]
Dan Handleyed6ff952014-05-14 17:44:19 +01001/*
dp-arm66abfbe2017-01-31 13:01:04 +00002 * Copyright (c) 2013-2017, 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
7#ifndef __PLATFORM_H__
8#define __PLATFORM_H__
9
Soby Mathew981487a2015-07-13 14:10:57 +010010#include <psci.h>
Dan Handleyed6ff952014-05-14 17:44:19 +010011#include <stdint.h>
Soby Mathew981487a2015-07-13 14:10:57 +010012#include <types.h>
Dan Handleyed6ff952014-05-14 17:44:19 +010013
14
15/*******************************************************************************
16 * Forward declarations
17 ******************************************************************************/
dp-armb3e85802016-12-12 14:48:13 +000018struct auth_img_desc_s;
Dan Handleyed6ff952014-05-14 17:44:19 +010019struct meminfo;
20struct image_info;
21struct entry_point_info;
Dan Handley7ce42df2014-05-15 14:11:36 +010022struct bl31_params;
Yatharth Kochara65be2f2015-10-09 18:06:13 +010023struct image_desc;
Yatharth Kochar3345a8d2016-09-12 16:08:41 +010024struct bl_load_info;
25struct bl_params;
Antonio Nino Diazc41f2062017-10-24 10:07:35 +010026struct mmap_region;
27struct secure_partition_boot_info;
Dan Handleyed6ff952014-05-14 17:44:19 +010028
29/*******************************************************************************
Juan Castillo31a68f02015-04-14 12:49:03 +010030 * plat_get_rotpk_info() flags
31 ******************************************************************************/
32#define ROTPK_IS_HASH (1 << 0)
Soby Mathew2f7ed052016-05-24 15:05:15 +010033/* Flag used to skip verification of the certificate ROTPK while the platform
34 ROTPK is not deployed */
35#define ROTPK_NOT_DEPLOYED (1 << 1)
Juan Castillo31a68f02015-04-14 12:49:03 +010036
37/*******************************************************************************
Dan Handley7ce42df2014-05-15 14:11:36 +010038 * Function declarations
Dan Handleyed6ff952014-05-14 17:44:19 +010039 ******************************************************************************/
Dan Handley7ce42df2014-05-15 14:11:36 +010040/*******************************************************************************
41 * Mandatory common functions
42 ******************************************************************************/
Antonio Nino Diaz391a76e2016-05-18 16:53:31 +010043unsigned long long plat_get_syscnt_freq(void) __deprecated;
44unsigned int plat_get_syscnt_freq2(void);
45
Juan Castillo3a66aca2015-04-13 17:36:19 +010046int plat_get_image_source(unsigned int image_id,
Dan Handley7ce42df2014-05-15 14:11:36 +010047 uintptr_t *dev_handle,
48 uintptr_t *image_spec);
Soby Mathew21f93612016-03-23 10:11:10 +000049uintptr_t plat_get_ns_image_entrypoint(void);
Soby Mathew981487a2015-07-13 14:10:57 +010050unsigned int plat_my_core_pos(void);
51int plat_core_pos_by_mpidr(u_register_t mpidr);
Dan Handley7ce42df2014-05-15 14:11:36 +010052
Douglas Raillard306593d2017-02-24 18:14:15 +000053#if STACK_PROTECTOR_ENABLED
54/*
55 * Return a new value to be used for the stack protection's canary.
56 *
57 * Ideally, this value is a random number that is impossible to predict by an
58 * attacker.
59 */
60u_register_t plat_get_stack_protector_canary(void);
61#endif /* STACK_PROTECTOR_ENABLED */
62
Dan Handley7ce42df2014-05-15 14:11:36 +010063/*******************************************************************************
64 * Mandatory interrupt management functions
65 ******************************************************************************/
Dan Handley701fea72014-05-27 16:17:21 +010066uint32_t plat_ic_get_pending_interrupt_id(void);
67uint32_t plat_ic_get_pending_interrupt_type(void);
68uint32_t plat_ic_acknowledge_interrupt(void);
69uint32_t plat_ic_get_interrupt_type(uint32_t id);
70void plat_ic_end_of_interrupt(uint32_t id);
Dan Handleyed6ff952014-05-14 17:44:19 +010071uint32_t plat_interrupt_type_to_line(uint32_t type,
72 uint32_t security_state);
73
Dan Handley7ce42df2014-05-15 14:11:36 +010074/*******************************************************************************
Jeenu Viswambharanb1e957e2017-09-22 08:32:09 +010075 * Optional interrupt management functions, depending on chosen EL3 components.
76 ******************************************************************************/
77unsigned int plat_ic_get_running_priority(void);
Jeenu Viswambharan522a4652017-09-22 08:32:09 +010078int plat_ic_is_spi(unsigned int id);
79int plat_ic_is_ppi(unsigned int id);
80int plat_ic_is_sgi(unsigned int id);
Jeenu Viswambharan24e70292017-09-22 08:32:09 +010081unsigned int plat_ic_get_interrupt_active(unsigned int id);
Jeenu Viswambharan0fcdfff2017-09-22 08:32:09 +010082void plat_ic_disable_interrupt(unsigned int id);
83void plat_ic_enable_interrupt(unsigned int id);
Jeenu Viswambharanc06f05c2017-09-22 08:32:09 +010084int plat_ic_has_interrupt_type(unsigned int type);
85void plat_ic_set_interrupt_type(unsigned int id, unsigned int type);
Jeenu Viswambharan447b89d2017-09-22 08:32:09 +010086void plat_ic_set_interrupt_priority(unsigned int id, unsigned int priority);
Jeenu Viswambharanab14e9b2017-09-22 08:32:09 +010087void plat_ic_raise_el3_sgi(int sgi_num, u_register_t target);
Jeenu Viswambharandce70b32017-09-22 08:32:09 +010088void plat_ic_set_spi_routing(unsigned int id, unsigned int routing_mode,
89 u_register_t mpidr);
Jeenu Viswambharaneb1c12c2017-09-22 08:32:09 +010090void plat_ic_set_interrupt_pending(unsigned int id);
91void plat_ic_clear_interrupt_pending(unsigned int id);
Jeenu Viswambharan62505072017-09-22 08:32:09 +010092unsigned int plat_ic_set_priority_mask(unsigned int mask);
Jeenu Viswambharan055af4b2017-10-24 15:13:59 +010093unsigned int plat_ic_get_interrupt_id(unsigned int raw);
Jeenu Viswambharanb1e957e2017-09-22 08:32:09 +010094
95/*******************************************************************************
Dan Handley7ce42df2014-05-15 14:11:36 +010096 * Optional common functions (may be overridden)
97 ******************************************************************************/
Soby Mathewa0fedc42016-06-16 14:52:04 +010098uintptr_t plat_get_my_stack(void);
Yatharth Kocharf528faf2016-06-28 16:58:26 +010099void plat_report_exception(unsigned int exception_type);
Sandrine Bailleux046cd3f2014-08-06 11:27:23 +0100100int plat_crash_console_init(void);
Soby Mathew066f7132014-07-14 16:57:23 +0100101int plat_crash_console_putc(int c);
Antonio Nino Diazd3ec5432017-02-17 17:11:27 +0000102int plat_crash_console_flush(void);
Juan Castillo26ae5832015-09-25 15:41:14 +0100103void plat_error_handler(int err) __dead2;
Antonio Nino Diaz1f21bcf2016-02-01 13:57:25 +0000104void plat_panic_handler(void) __dead2;
Soby Mathewaaf15f52017-09-04 11:49:29 +0100105const char *plat_log_get_prefix(unsigned int log_level);
Roberto Vargasbc1ae1f2017-09-26 12:53:01 +0100106void bl2_plat_preload_setup(void);
107int plat_try_next_boot_source(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
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100127/*
128 * The following function is mandatory when the
129 * firmware update feature is used.
130 */
131int bl1_plat_mem_check(uintptr_t mem_base, unsigned int mem_size,
132 unsigned int flags);
133
Dan Handley7ce42df2014-05-15 14:11:36 +0100134/*******************************************************************************
135 * Optional BL1 functions (may be overridden)
136 ******************************************************************************/
Sandrine Bailleux467d0572014-06-24 14:02:34 +0100137void bl1_init_bl2_mem_layout(const struct meminfo *bl1_mem_layout,
138 struct meminfo *bl2_mem_layout);
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100139
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
158
Dan Handley7ce42df2014-05-15 14:11:36 +0100159/*******************************************************************************
160 * Mandatory BL2 functions
161 ******************************************************************************/
Dan Handley4fd2f5c2014-08-04 11:41:20 +0100162void bl2_early_platform_setup(struct meminfo *mem_layout);
Dan Handley7ce42df2014-05-15 14:11:36 +0100163void bl2_plat_arch_setup(void);
164void bl2_platform_setup(void);
165struct meminfo *bl2_plat_sec_mem_layout(void);
166
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100167#if LOAD_IMAGE_V2
168/*
169 * This function can be used by the platforms to update/use image
170 * information for given `image_id`.
171 */
172int bl2_plat_handle_post_image_load(unsigned int image_id);
173
174#else /* LOAD_IMAGE_V2 */
175
Dan Handley7ce42df2014-05-15 14:11:36 +0100176/*
177 * This function returns a pointer to the shared memory that the platform has
Juan Castillo7d199412015-12-14 09:35:25 +0000178 * kept aside to pass trusted firmware related information that BL31
Dan Handley7ce42df2014-05-15 14:11:36 +0100179 * could need
180 */
181struct bl31_params *bl2_plat_get_bl31_params(void);
182
183/*
184 * This function returns a pointer to the shared memory that the platform
185 * has kept to point to entry point information of BL31 to BL2
186 */
187struct entry_point_info *bl2_plat_get_bl31_ep_info(void);
188
189/*
190 * This function flushes to main memory all the params that are
Juan Castillo7d199412015-12-14 09:35:25 +0000191 * passed to BL31
Dan Handley7ce42df2014-05-15 14:11:36 +0100192 */
193void bl2_plat_flush_bl31_params(void);
194
Dan Handleyed6ff952014-05-14 17:44:19 +0100195/*
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100196 * The next 2 functions allow the platform to change the entrypoint information
Juan Castillo7d199412015-12-14 09:35:25 +0000197 * for the mandatory 3rd level BL images, BL31 and BL33. This is done after
198 * BL2 has loaded those images into memory but before BL31 is executed.
Dan Handleyed6ff952014-05-14 17:44:19 +0100199 */
200void bl2_plat_set_bl31_ep_info(struct image_info *image,
201 struct entry_point_info *ep);
202
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100203void bl2_plat_set_bl33_ep_info(struct image_info *image,
Dan Handleyed6ff952014-05-14 17:44:19 +0100204 struct entry_point_info *ep);
205
Juan Castillo7d199412015-12-14 09:35:25 +0000206/* Gets the memory layout for BL33 */
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100207void bl2_plat_get_bl33_meminfo(struct meminfo *mem_info);
208
209/*******************************************************************************
Juan Castilloa72b6472015-12-10 15:49:17 +0000210 * Conditionally mandatory BL2 functions: must be implemented if SCP_BL2 image
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100211 * is supported
212 ******************************************************************************/
Juan Castilloa72b6472015-12-10 15:49:17 +0000213/* Gets the memory layout for SCP_BL2 */
214void bl2_plat_get_scp_bl2_meminfo(struct meminfo *mem_info);
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100215
216/*
Juan Castilloa72b6472015-12-10 15:49:17 +0000217 * This function is called after loading SCP_BL2 image and it is used to perform
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100218 * any platform-specific actions required to handle the SCP firmware.
219 */
Juan Castilloa72b6472015-12-10 15:49:17 +0000220int bl2_plat_handle_scp_bl2(struct image_info *scp_bl2_image_info);
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100221
222/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000223 * Conditionally mandatory BL2 functions: must be implemented if BL32 image
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100224 * is supported
225 ******************************************************************************/
226void bl2_plat_set_bl32_ep_info(struct image_info *image,
Dan Handleyed6ff952014-05-14 17:44:19 +0100227 struct entry_point_info *ep);
228
Juan Castillo7d199412015-12-14 09:35:25 +0000229/* Gets the memory layout for BL32 */
Dan Handleyed6ff952014-05-14 17:44:19 +0100230void bl2_plat_get_bl32_meminfo(struct meminfo *mem_info);
231
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100232#endif /* LOAD_IMAGE_V2 */
233
Dan Handley7ce42df2014-05-15 14:11:36 +0100234/*******************************************************************************
235 * Optional BL2 functions (may be overridden)
236 ******************************************************************************/
237
Roberto Vargase0e99462017-10-30 14:43:43 +0000238
239/*******************************************************************************
240 * Mandatory BL2 at EL3 functions: Must be implemented if BL2_AT_EL3 image is
241 * supported
242 ******************************************************************************/
243void bl2_el3_early_platform_setup(u_register_t arg0, u_register_t arg1,
244 u_register_t arg2, u_register_t arg3);
245void bl2_el3_plat_arch_setup(void);
246
247
248/*******************************************************************************
249 * Optional BL2 at EL3 functions (may be overridden)
250 ******************************************************************************/
251void bl2_el3_plat_prepare_exit(void);
252
Dan Handley7ce42df2014-05-15 14:11:36 +0100253/*******************************************************************************
Yatharth Kocharb1c2fe02015-10-14 15:27:24 +0100254 * Mandatory BL2U functions.
255 ******************************************************************************/
256void bl2u_early_platform_setup(struct meminfo *mem_layout,
257 void *plat_info);
258void bl2u_plat_arch_setup(void);
259void bl2u_platform_setup(void);
260
261/*******************************************************************************
262 * Conditionally mandatory BL2U functions for CSS platforms.
263 ******************************************************************************/
264/*
265 * This function is used to perform any platform-specific actions required to
266 * handle the BL2U_SCP firmware.
267 */
268int bl2u_plat_handle_scp_bl2u(void);
269
270/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000271 * Mandatory BL31 functions
Dan Handley7ce42df2014-05-15 14:11:36 +0100272 ******************************************************************************/
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100273#if LOAD_IMAGE_V2
274void bl31_early_platform_setup(void *from_bl2,
275 void *plat_params_from_bl2);
276#else
Dan Handley7ce42df2014-05-15 14:11:36 +0100277void bl31_early_platform_setup(struct bl31_params *from_bl2,
278 void *plat_params_from_bl2);
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100279#endif
Dan Handley7ce42df2014-05-15 14:11:36 +0100280void bl31_plat_arch_setup(void);
281void bl31_platform_setup(void);
Soby Mathew1ff495b2015-12-09 11:28:43 +0000282void bl31_plat_runtime_setup(void);
Dan Handley701fea72014-05-27 16:17:21 +0100283struct entry_point_info *bl31_plat_get_next_image_ep_info(uint32_t type);
Dan Handley7ce42df2014-05-15 14:11:36 +0100284
285/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000286 * Mandatory PSCI functions (BL31)
Dan Handley7ce42df2014-05-15 14:11:36 +0100287 ******************************************************************************/
Soby Mathew981487a2015-07-13 14:10:57 +0100288int plat_setup_psci_ops(uintptr_t sec_entrypoint,
289 const struct plat_psci_ops **);
290const unsigned char *plat_get_power_domain_tree_desc(void);
291
292/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000293 * Optional PSCI functions (BL31).
Soby Mathew981487a2015-07-13 14:10:57 +0100294 ******************************************************************************/
dp-arm66abfbe2017-01-31 13:01:04 +0000295void plat_psci_stat_accounting_start(const psci_power_state_t *state_info);
296void plat_psci_stat_accounting_stop(const psci_power_state_t *state_info);
297u_register_t plat_psci_stat_get_residency(unsigned int lvl,
298 const psci_power_state_t *state_info,
299 int last_cpu_index);
Soby Mathew981487a2015-07-13 14:10:57 +0100300plat_local_state_t plat_get_target_pwr_state(unsigned int lvl,
301 const plat_local_state_t *states,
302 unsigned int ncpu);
Dan Handley7ce42df2014-05-15 14:11:36 +0100303
304/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000305 * Optional BL31 functions (may be overridden)
Dan Handleyb226a4d2014-05-16 14:08:45 +0100306 ******************************************************************************/
Achin Guptae9982542014-06-26 08:59:07 +0100307void bl31_plat_enable_mmu(uint32_t flags);
Dan Handleyb226a4d2014-05-16 14:08:45 +0100308
309/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000310 * Optional BL32 functions (may be overridden)
Dan Handleyb226a4d2014-05-16 14:08:45 +0100311 ******************************************************************************/
Achin Guptae9982542014-06-26 08:59:07 +0100312void bl32_plat_enable_mmu(uint32_t flags);
Dan Handleyb226a4d2014-05-16 14:08:45 +0100313
Juan Castillo5e29c752015-01-07 10:39:25 +0000314/*******************************************************************************
Juan Castillo31a68f02015-04-14 12:49:03 +0100315 * Trusted Board Boot functions
Juan Castillo5e29c752015-01-07 10:39:25 +0000316 ******************************************************************************/
Juan Castillo31a68f02015-04-14 12:49:03 +0100317int plat_get_rotpk_info(void *cookie, void **key_ptr, unsigned int *key_len,
318 unsigned int *flags);
Juan Castillobfb7fa62016-01-22 11:05:57 +0000319int plat_get_nv_ctr(void *cookie, unsigned int *nv_ctr);
320int plat_set_nv_ctr(void *cookie, unsigned int nv_ctr);
dp-armb3e85802016-12-12 14:48:13 +0000321int plat_set_nv_ctr2(void *cookie, const struct auth_img_desc_s *img_desc,
322 unsigned int nv_ctr);
Juan Castillo5e29c752015-01-07 10:39:25 +0000323
Antonio Nino Diazc41f2062017-10-24 10:07:35 +0100324/*******************************************************************************
325 * Secure Partitions functions
326 ******************************************************************************/
327const struct mmap_region *plat_get_secure_partition_mmap(void *cookie);
328const struct secure_partition_boot_info *plat_get_secure_partition_boot_info(
329 void *cookie);
330
Yatharth Kochar3345a8d2016-09-12 16:08:41 +0100331#if LOAD_IMAGE_V2
332/*******************************************************************************
333 * Mandatory BL image load functions(may be overridden).
334 ******************************************************************************/
335/*
336 * This function returns pointer to the list of images that the
337 * platform has populated to load.
338 */
339struct bl_load_info *plat_get_bl_image_load_info(void);
340
341/*
342 * This function returns a pointer to the shared memory that the
343 * platform has kept aside to pass trusted firmware related
344 * information that next BL image could need.
345 */
346struct bl_params *plat_get_next_bl_params(void);
347
348/*
349 * This function flushes to main memory all the params that are
350 * passed to next image.
351 */
352void plat_flush_next_bl_params(void);
353
354#endif /* LOAD_IMAGE_V2 */
355
Soby Mathew981487a2015-07-13 14:10:57 +0100356#if ENABLE_PLAT_COMPAT
357/*
358 * The below declarations are to enable compatibility for the platform ports
359 * using the old platform interface.
360 */
361
362/*******************************************************************************
363 * Optional common functions (may be overridden)
364 ******************************************************************************/
365unsigned int platform_get_core_pos(unsigned long mpidr);
366
367/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000368 * Mandatory PSCI Compatibility functions (BL31)
Soby Mathew981487a2015-07-13 14:10:57 +0100369 ******************************************************************************/
370int platform_setup_pm(const plat_pm_ops_t **);
371
372unsigned int plat_get_aff_count(unsigned int, unsigned long);
373unsigned int plat_get_aff_state(unsigned int, unsigned long);
Douglas Raillard306593d2017-02-24 18:14:15 +0000374#else /* __ENABLE_PLAT_COMPAT__ */
Soby Mathew70716d62015-07-13 16:26:11 +0100375/*
376 * The below function enable Trusted Firmware components like SPDs which
377 * haven't migrated to the new platform API to compile on platforms which
378 * have the compatibility layer disabled.
379 */
Soren Brinkmanna581bd52016-01-14 10:02:33 -0800380unsigned int platform_get_core_pos(unsigned long mpidr) __deprecated;
Soby Mathew981487a2015-07-13 14:10:57 +0100381
Soby Mathew70716d62015-07-13 16:26:11 +0100382#endif /* __ENABLE_PLAT_COMPAT__ */
Douglas Raillard306593d2017-02-24 18:14:15 +0000383
Dan Handleyed6ff952014-05-14 17:44:19 +0100384#endif /* __PLATFORM_H__ */
Douglas Raillard306593d2017-02-24 18:14:15 +0000385