blob: f37a80f3e0054137a190afb7c4f447a5ec3aa3a8 [file] [log] [blame]
Dan Handleyed6ff952014-05-14 17:44:19 +01001/*
Soby Mathew981487a2015-07-13 14:10:57 +01002 * Copyright (c) 2013-2015, ARM Limited and Contributors. All rights reserved.
Dan Handleyed6ff952014-05-14 17:44:19 +01003 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
6 *
7 * Redistributions of source code must retain the above copyright notice, this
8 * list of conditions and the following disclaimer.
9 *
10 * Redistributions in binary form must reproduce the above copyright notice,
11 * this list of conditions and the following disclaimer in the documentation
12 * and/or other materials provided with the distribution.
13 *
14 * Neither the name of ARM nor the names of its contributors may be used
15 * to endorse or promote products derived from this software without specific
16 * prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
29 */
30
31#ifndef __PLATFORM_H__
32#define __PLATFORM_H__
33
Soby Mathew981487a2015-07-13 14:10:57 +010034#include <psci.h>
Dan Handleyed6ff952014-05-14 17:44:19 +010035#include <stdint.h>
Soby Mathew981487a2015-07-13 14:10:57 +010036#include <types.h>
Dan Handleyed6ff952014-05-14 17:44:19 +010037
38
39/*******************************************************************************
40 * Forward declarations
41 ******************************************************************************/
Dan Handleyed6ff952014-05-14 17:44:19 +010042struct meminfo;
43struct image_info;
44struct entry_point_info;
Dan Handley7ce42df2014-05-15 14:11:36 +010045struct bl31_params;
Yatharth Kochara65be2f2015-10-09 18:06:13 +010046struct image_desc;
Dan Handleyed6ff952014-05-14 17:44:19 +010047
48/*******************************************************************************
Juan Castillo31a68f02015-04-14 12:49:03 +010049 * plat_get_rotpk_info() flags
50 ******************************************************************************/
51#define ROTPK_IS_HASH (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 ******************************************************************************/
59uint64_t plat_get_syscnt_freq(void);
Juan Castillo3a66aca2015-04-13 17:36:19 +010060int plat_get_image_source(unsigned int image_id,
Dan Handley7ce42df2014-05-15 14:11:36 +010061 uintptr_t *dev_handle,
62 uintptr_t *image_spec);
Dan Handleyed6ff952014-05-14 17:44:19 +010063unsigned long plat_get_ns_image_entrypoint(void);
Soby Mathew981487a2015-07-13 14:10:57 +010064unsigned int plat_my_core_pos(void);
65int plat_core_pos_by_mpidr(u_register_t mpidr);
Dan Handley7ce42df2014-05-15 14:11:36 +010066
67/*******************************************************************************
68 * Mandatory interrupt management functions
69 ******************************************************************************/
Dan Handley701fea72014-05-27 16:17:21 +010070uint32_t plat_ic_get_pending_interrupt_id(void);
71uint32_t plat_ic_get_pending_interrupt_type(void);
72uint32_t plat_ic_acknowledge_interrupt(void);
73uint32_t plat_ic_get_interrupt_type(uint32_t id);
74void plat_ic_end_of_interrupt(uint32_t id);
Dan Handleyed6ff952014-05-14 17:44:19 +010075uint32_t plat_interrupt_type_to_line(uint32_t type,
76 uint32_t security_state);
77
Dan Handley7ce42df2014-05-15 14:11:36 +010078/*******************************************************************************
79 * Optional common functions (may be overridden)
80 ******************************************************************************/
Soby Mathew981487a2015-07-13 14:10:57 +010081unsigned long plat_get_my_stack(void);
Dan Handley7ce42df2014-05-15 14:11:36 +010082void plat_report_exception(unsigned long);
Sandrine Bailleux046cd3f2014-08-06 11:27:23 +010083int plat_crash_console_init(void);
Soby Mathew066f7132014-07-14 16:57:23 +010084int plat_crash_console_putc(int c);
Juan Castillo26ae5832015-09-25 15:41:14 +010085void plat_error_handler(int err) __dead2;
Dan Handley7ce42df2014-05-15 14:11:36 +010086
87/*******************************************************************************
88 * Mandatory BL1 functions
89 ******************************************************************************/
Dan Handley4fd2f5c2014-08-04 11:41:20 +010090void bl1_early_platform_setup(void);
Dan Handley7ce42df2014-05-15 14:11:36 +010091void bl1_plat_arch_setup(void);
92void bl1_platform_setup(void);
93struct meminfo *bl1_plat_sec_mem_layout(void);
Dan Handleyed6ff952014-05-14 17:44:19 +010094
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +010095/*
96 * The following function is mandatory when the
97 * firmware update feature is used.
98 */
99int bl1_plat_mem_check(uintptr_t mem_base, unsigned int mem_size,
100 unsigned int flags);
101
Dan Handley7ce42df2014-05-15 14:11:36 +0100102/*******************************************************************************
103 * Optional BL1 functions (may be overridden)
104 ******************************************************************************/
Sandrine Bailleux467d0572014-06-24 14:02:34 +0100105void bl1_init_bl2_mem_layout(const struct meminfo *bl1_mem_layout,
106 struct meminfo *bl2_mem_layout);
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100107
Yatharth Kochara65be2f2015-10-09 18:06:13 +0100108/*
109 * The following functions are used for image loading process in BL1.
110 */
111void bl1_plat_set_ep_info(unsigned int image_id,
112 struct entry_point_info *ep_info);
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100113/*
114 * The following functions are mandatory when firmware update
115 * feature is used and optional otherwise.
116 */
Yatharth Kochara65be2f2015-10-09 18:06:13 +0100117unsigned int bl1_plat_get_next_image_id(void);
118struct image_desc *bl1_plat_get_image_desc(unsigned int image_id);
Dan Handley7ce42df2014-05-15 14:11:36 +0100119
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100120/*
121 * The following functions are used by firmware update
122 * feature and may optionally be overridden.
123 */
Dan Handley89f8f332015-12-15 14:28:24 +0000124__dead2 void bl1_plat_fwu_done(void *client_cookie, void *reserved);
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100125
126
Dan Handley7ce42df2014-05-15 14:11:36 +0100127/*******************************************************************************
128 * Mandatory BL2 functions
129 ******************************************************************************/
Dan Handley4fd2f5c2014-08-04 11:41:20 +0100130void bl2_early_platform_setup(struct meminfo *mem_layout);
Dan Handley7ce42df2014-05-15 14:11:36 +0100131void bl2_plat_arch_setup(void);
132void bl2_platform_setup(void);
133struct meminfo *bl2_plat_sec_mem_layout(void);
134
135/*
136 * This function returns a pointer to the shared memory that the platform has
Juan Castillo7d199412015-12-14 09:35:25 +0000137 * kept aside to pass trusted firmware related information that BL31
Dan Handley7ce42df2014-05-15 14:11:36 +0100138 * could need
139 */
140struct bl31_params *bl2_plat_get_bl31_params(void);
141
142/*
143 * This function returns a pointer to the shared memory that the platform
144 * has kept to point to entry point information of BL31 to BL2
145 */
146struct entry_point_info *bl2_plat_get_bl31_ep_info(void);
147
148/*
149 * This function flushes to main memory all the params that are
Juan Castillo7d199412015-12-14 09:35:25 +0000150 * passed to BL31
Dan Handley7ce42df2014-05-15 14:11:36 +0100151 */
152void bl2_plat_flush_bl31_params(void);
153
Dan Handleyed6ff952014-05-14 17:44:19 +0100154/*
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100155 * The next 2 functions allow the platform to change the entrypoint information
Juan Castillo7d199412015-12-14 09:35:25 +0000156 * for the mandatory 3rd level BL images, BL31 and BL33. This is done after
157 * BL2 has loaded those images into memory but before BL31 is executed.
Dan Handleyed6ff952014-05-14 17:44:19 +0100158 */
159void bl2_plat_set_bl31_ep_info(struct image_info *image,
160 struct entry_point_info *ep);
161
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100162void bl2_plat_set_bl33_ep_info(struct image_info *image,
Dan Handleyed6ff952014-05-14 17:44:19 +0100163 struct entry_point_info *ep);
164
Juan Castillo7d199412015-12-14 09:35:25 +0000165/* Gets the memory layout for BL33 */
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100166void bl2_plat_get_bl33_meminfo(struct meminfo *mem_info);
167
168/*******************************************************************************
Juan Castilloa72b6472015-12-10 15:49:17 +0000169 * Conditionally mandatory BL2 functions: must be implemented if SCP_BL2 image
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100170 * is supported
171 ******************************************************************************/
Juan Castilloa72b6472015-12-10 15:49:17 +0000172/* Gets the memory layout for SCP_BL2 */
173void bl2_plat_get_scp_bl2_meminfo(struct meminfo *mem_info);
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100174
175/*
Juan Castilloa72b6472015-12-10 15:49:17 +0000176 * This function is called after loading SCP_BL2 image and it is used to perform
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100177 * any platform-specific actions required to handle the SCP firmware.
178 */
Juan Castilloa72b6472015-12-10 15:49:17 +0000179int bl2_plat_handle_scp_bl2(struct image_info *scp_bl2_image_info);
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100180
181/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000182 * Conditionally mandatory BL2 functions: must be implemented if BL32 image
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100183 * is supported
184 ******************************************************************************/
185void bl2_plat_set_bl32_ep_info(struct image_info *image,
Dan Handleyed6ff952014-05-14 17:44:19 +0100186 struct entry_point_info *ep);
187
Juan Castillo7d199412015-12-14 09:35:25 +0000188/* Gets the memory layout for BL32 */
Dan Handleyed6ff952014-05-14 17:44:19 +0100189void bl2_plat_get_bl32_meminfo(struct meminfo *mem_info);
190
Dan Handley7ce42df2014-05-15 14:11:36 +0100191/*******************************************************************************
192 * Optional BL2 functions (may be overridden)
193 ******************************************************************************/
194
195/*******************************************************************************
Yatharth Kocharb1c2fe02015-10-14 15:27:24 +0100196 * Mandatory BL2U functions.
197 ******************************************************************************/
198void bl2u_early_platform_setup(struct meminfo *mem_layout,
199 void *plat_info);
200void bl2u_plat_arch_setup(void);
201void bl2u_platform_setup(void);
202
203/*******************************************************************************
204 * Conditionally mandatory BL2U functions for CSS platforms.
205 ******************************************************************************/
206/*
207 * This function is used to perform any platform-specific actions required to
208 * handle the BL2U_SCP firmware.
209 */
210int bl2u_plat_handle_scp_bl2u(void);
211
212/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000213 * Mandatory BL31 functions
Dan Handley7ce42df2014-05-15 14:11:36 +0100214 ******************************************************************************/
215void bl31_early_platform_setup(struct bl31_params *from_bl2,
216 void *plat_params_from_bl2);
217void bl31_plat_arch_setup(void);
218void bl31_platform_setup(void);
Soby Mathew1ff495b2015-12-09 11:28:43 +0000219void bl31_plat_runtime_setup(void);
Dan Handley701fea72014-05-27 16:17:21 +0100220struct entry_point_info *bl31_plat_get_next_image_ep_info(uint32_t type);
Dan Handley7ce42df2014-05-15 14:11:36 +0100221
222/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000223 * Mandatory PSCI functions (BL31)
Dan Handley7ce42df2014-05-15 14:11:36 +0100224 ******************************************************************************/
Soby Mathew981487a2015-07-13 14:10:57 +0100225int plat_setup_psci_ops(uintptr_t sec_entrypoint,
226 const struct plat_psci_ops **);
227const unsigned char *plat_get_power_domain_tree_desc(void);
228
229/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000230 * Optional PSCI functions (BL31).
Soby Mathew981487a2015-07-13 14:10:57 +0100231 ******************************************************************************/
232plat_local_state_t plat_get_target_pwr_state(unsigned int lvl,
233 const plat_local_state_t *states,
234 unsigned int ncpu);
Dan Handley7ce42df2014-05-15 14:11:36 +0100235
236/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000237 * Optional BL31 functions (may be overridden)
Dan Handleyb226a4d2014-05-16 14:08:45 +0100238 ******************************************************************************/
Achin Guptae9982542014-06-26 08:59:07 +0100239void bl31_plat_enable_mmu(uint32_t flags);
Dan Handleyb226a4d2014-05-16 14:08:45 +0100240
241/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000242 * Optional BL32 functions (may be overridden)
Dan Handleyb226a4d2014-05-16 14:08:45 +0100243 ******************************************************************************/
Achin Guptae9982542014-06-26 08:59:07 +0100244void bl32_plat_enable_mmu(uint32_t flags);
Dan Handleyb226a4d2014-05-16 14:08:45 +0100245
Juan Castillo5e29c752015-01-07 10:39:25 +0000246/*******************************************************************************
Juan Castillo31a68f02015-04-14 12:49:03 +0100247 * Trusted Board Boot functions
Juan Castillo5e29c752015-01-07 10:39:25 +0000248 ******************************************************************************/
Juan Castillo31a68f02015-04-14 12:49:03 +0100249int plat_get_rotpk_info(void *cookie, void **key_ptr, unsigned int *key_len,
250 unsigned int *flags);
Juan Castillo5e29c752015-01-07 10:39:25 +0000251
Soby Mathew981487a2015-07-13 14:10:57 +0100252#if ENABLE_PLAT_COMPAT
253/*
254 * The below declarations are to enable compatibility for the platform ports
255 * using the old platform interface.
256 */
257
258/*******************************************************************************
259 * Optional common functions (may be overridden)
260 ******************************************************************************/
261unsigned int platform_get_core_pos(unsigned long mpidr);
262
263/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000264 * Mandatory PSCI Compatibility functions (BL31)
Soby Mathew981487a2015-07-13 14:10:57 +0100265 ******************************************************************************/
266int platform_setup_pm(const plat_pm_ops_t **);
267
268unsigned int plat_get_aff_count(unsigned int, unsigned long);
269unsigned int plat_get_aff_state(unsigned int, unsigned long);
Soby Mathew70716d62015-07-13 16:26:11 +0100270#else
271/*
272 * The below function enable Trusted Firmware components like SPDs which
273 * haven't migrated to the new platform API to compile on platforms which
274 * have the compatibility layer disabled.
275 */
Soren Brinkmanna581bd52016-01-14 10:02:33 -0800276unsigned int platform_get_core_pos(unsigned long mpidr) __deprecated;
Soby Mathew981487a2015-07-13 14:10:57 +0100277
Soby Mathew70716d62015-07-13 16:26:11 +0100278#endif /* __ENABLE_PLAT_COMPAT__ */
Dan Handleyed6ff952014-05-14 17:44:19 +0100279#endif /* __PLATFORM_H__ */