blob: 390721f291875ef8c01fd080eb5f7e548d5f67bf [file] [log] [blame]
Dan Handleyed6ff952014-05-14 17:44:19 +01001/*
Antonio Nino Diaz1f21bcf2016-02-01 13:57:25 +00002 * Copyright (c) 2013-2016, 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)
Soby Mathew2f7ed052016-05-24 15:05:15 +010052/* Flag used to skip verification of the certificate ROTPK while the platform
53 ROTPK is not deployed */
54#define ROTPK_NOT_DEPLOYED (1 << 1)
Juan Castillo31a68f02015-04-14 12:49:03 +010055
56/*******************************************************************************
Dan Handley7ce42df2014-05-15 14:11:36 +010057 * Function declarations
Dan Handleyed6ff952014-05-14 17:44:19 +010058 ******************************************************************************/
Dan Handley7ce42df2014-05-15 14:11:36 +010059/*******************************************************************************
60 * Mandatory common functions
61 ******************************************************************************/
Antonio Nino Diaz391a76e2016-05-18 16:53:31 +010062unsigned long long plat_get_syscnt_freq(void) __deprecated;
63unsigned int plat_get_syscnt_freq2(void);
64
Juan Castillo3a66aca2015-04-13 17:36:19 +010065int plat_get_image_source(unsigned int image_id,
Dan Handley7ce42df2014-05-15 14:11:36 +010066 uintptr_t *dev_handle,
67 uintptr_t *image_spec);
Soby Mathew21f93612016-03-23 10:11:10 +000068uintptr_t plat_get_ns_image_entrypoint(void);
Soby Mathew981487a2015-07-13 14:10:57 +010069unsigned int plat_my_core_pos(void);
70int plat_core_pos_by_mpidr(u_register_t mpidr);
Dan Handley7ce42df2014-05-15 14:11:36 +010071
72/*******************************************************************************
73 * Mandatory interrupt management functions
74 ******************************************************************************/
Dan Handley701fea72014-05-27 16:17:21 +010075uint32_t plat_ic_get_pending_interrupt_id(void);
76uint32_t plat_ic_get_pending_interrupt_type(void);
77uint32_t plat_ic_acknowledge_interrupt(void);
78uint32_t plat_ic_get_interrupt_type(uint32_t id);
79void plat_ic_end_of_interrupt(uint32_t id);
Dan Handleyed6ff952014-05-14 17:44:19 +010080uint32_t plat_interrupt_type_to_line(uint32_t type,
81 uint32_t security_state);
82
Dan Handley7ce42df2014-05-15 14:11:36 +010083/*******************************************************************************
84 * Optional common functions (may be overridden)
85 ******************************************************************************/
Soby Mathew981487a2015-07-13 14:10:57 +010086unsigned long plat_get_my_stack(void);
Dan Handley7ce42df2014-05-15 14:11:36 +010087void plat_report_exception(unsigned long);
Sandrine Bailleux046cd3f2014-08-06 11:27:23 +010088int plat_crash_console_init(void);
Soby Mathew066f7132014-07-14 16:57:23 +010089int plat_crash_console_putc(int c);
Juan Castillo26ae5832015-09-25 15:41:14 +010090void plat_error_handler(int err) __dead2;
Antonio Nino Diaz1f21bcf2016-02-01 13:57:25 +000091void plat_panic_handler(void) __dead2;
Dan Handley7ce42df2014-05-15 14:11:36 +010092
93/*******************************************************************************
94 * Mandatory BL1 functions
95 ******************************************************************************/
Dan Handley4fd2f5c2014-08-04 11:41:20 +010096void bl1_early_platform_setup(void);
Dan Handley7ce42df2014-05-15 14:11:36 +010097void bl1_plat_arch_setup(void);
98void bl1_platform_setup(void);
99struct meminfo *bl1_plat_sec_mem_layout(void);
Dan Handleyed6ff952014-05-14 17:44:19 +0100100
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100101/*
102 * The following function is mandatory when the
103 * firmware update feature is used.
104 */
105int bl1_plat_mem_check(uintptr_t mem_base, unsigned int mem_size,
106 unsigned int flags);
107
Dan Handley7ce42df2014-05-15 14:11:36 +0100108/*******************************************************************************
109 * Optional BL1 functions (may be overridden)
110 ******************************************************************************/
Sandrine Bailleux467d0572014-06-24 14:02:34 +0100111void bl1_init_bl2_mem_layout(const struct meminfo *bl1_mem_layout,
112 struct meminfo *bl2_mem_layout);
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100113
Yatharth Kochara65be2f2015-10-09 18:06:13 +0100114/*
115 * The following functions are used for image loading process in BL1.
116 */
117void bl1_plat_set_ep_info(unsigned int image_id,
118 struct entry_point_info *ep_info);
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100119/*
120 * The following functions are mandatory when firmware update
121 * feature is used and optional otherwise.
122 */
Yatharth Kochara65be2f2015-10-09 18:06:13 +0100123unsigned int bl1_plat_get_next_image_id(void);
124struct image_desc *bl1_plat_get_image_desc(unsigned int image_id);
Dan Handley7ce42df2014-05-15 14:11:36 +0100125
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100126/*
127 * The following functions are used by firmware update
128 * feature and may optionally be overridden.
129 */
Dan Handley89f8f332015-12-15 14:28:24 +0000130__dead2 void bl1_plat_fwu_done(void *client_cookie, void *reserved);
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100131
132
Dan Handley7ce42df2014-05-15 14:11:36 +0100133/*******************************************************************************
134 * Mandatory BL2 functions
135 ******************************************************************************/
Dan Handley4fd2f5c2014-08-04 11:41:20 +0100136void bl2_early_platform_setup(struct meminfo *mem_layout);
Dan Handley7ce42df2014-05-15 14:11:36 +0100137void bl2_plat_arch_setup(void);
138void bl2_platform_setup(void);
139struct meminfo *bl2_plat_sec_mem_layout(void);
140
141/*
142 * This function returns a pointer to the shared memory that the platform has
Juan Castillo7d199412015-12-14 09:35:25 +0000143 * kept aside to pass trusted firmware related information that BL31
Dan Handley7ce42df2014-05-15 14:11:36 +0100144 * could need
145 */
146struct bl31_params *bl2_plat_get_bl31_params(void);
147
148/*
149 * This function returns a pointer to the shared memory that the platform
150 * has kept to point to entry point information of BL31 to BL2
151 */
152struct entry_point_info *bl2_plat_get_bl31_ep_info(void);
153
154/*
155 * This function flushes to main memory all the params that are
Juan Castillo7d199412015-12-14 09:35:25 +0000156 * passed to BL31
Dan Handley7ce42df2014-05-15 14:11:36 +0100157 */
158void bl2_plat_flush_bl31_params(void);
159
Dan Handleyed6ff952014-05-14 17:44:19 +0100160/*
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100161 * The next 2 functions allow the platform to change the entrypoint information
Juan Castillo7d199412015-12-14 09:35:25 +0000162 * for the mandatory 3rd level BL images, BL31 and BL33. This is done after
163 * BL2 has loaded those images into memory but before BL31 is executed.
Dan Handleyed6ff952014-05-14 17:44:19 +0100164 */
165void bl2_plat_set_bl31_ep_info(struct image_info *image,
166 struct entry_point_info *ep);
167
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100168void bl2_plat_set_bl33_ep_info(struct image_info *image,
Dan Handleyed6ff952014-05-14 17:44:19 +0100169 struct entry_point_info *ep);
170
Juan Castillo7d199412015-12-14 09:35:25 +0000171/* Gets the memory layout for BL33 */
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100172void bl2_plat_get_bl33_meminfo(struct meminfo *mem_info);
173
174/*******************************************************************************
Juan Castilloa72b6472015-12-10 15:49:17 +0000175 * Conditionally mandatory BL2 functions: must be implemented if SCP_BL2 image
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100176 * is supported
177 ******************************************************************************/
Juan Castilloa72b6472015-12-10 15:49:17 +0000178/* Gets the memory layout for SCP_BL2 */
179void bl2_plat_get_scp_bl2_meminfo(struct meminfo *mem_info);
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100180
181/*
Juan Castilloa72b6472015-12-10 15:49:17 +0000182 * This function is called after loading SCP_BL2 image and it is used to perform
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100183 * any platform-specific actions required to handle the SCP firmware.
184 */
Juan Castilloa72b6472015-12-10 15:49:17 +0000185int bl2_plat_handle_scp_bl2(struct image_info *scp_bl2_image_info);
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100186
187/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000188 * Conditionally mandatory BL2 functions: must be implemented if BL32 image
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100189 * is supported
190 ******************************************************************************/
191void bl2_plat_set_bl32_ep_info(struct image_info *image,
Dan Handleyed6ff952014-05-14 17:44:19 +0100192 struct entry_point_info *ep);
193
Juan Castillo7d199412015-12-14 09:35:25 +0000194/* Gets the memory layout for BL32 */
Dan Handleyed6ff952014-05-14 17:44:19 +0100195void bl2_plat_get_bl32_meminfo(struct meminfo *mem_info);
196
Dan Handley7ce42df2014-05-15 14:11:36 +0100197/*******************************************************************************
198 * Optional BL2 functions (may be overridden)
199 ******************************************************************************/
200
201/*******************************************************************************
Yatharth Kocharb1c2fe02015-10-14 15:27:24 +0100202 * Mandatory BL2U functions.
203 ******************************************************************************/
204void bl2u_early_platform_setup(struct meminfo *mem_layout,
205 void *plat_info);
206void bl2u_plat_arch_setup(void);
207void bl2u_platform_setup(void);
208
209/*******************************************************************************
210 * Conditionally mandatory BL2U functions for CSS platforms.
211 ******************************************************************************/
212/*
213 * This function is used to perform any platform-specific actions required to
214 * handle the BL2U_SCP firmware.
215 */
216int bl2u_plat_handle_scp_bl2u(void);
217
218/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000219 * Mandatory BL31 functions
Dan Handley7ce42df2014-05-15 14:11:36 +0100220 ******************************************************************************/
221void bl31_early_platform_setup(struct bl31_params *from_bl2,
222 void *plat_params_from_bl2);
223void bl31_plat_arch_setup(void);
224void bl31_platform_setup(void);
Soby Mathew1ff495b2015-12-09 11:28:43 +0000225void bl31_plat_runtime_setup(void);
Dan Handley701fea72014-05-27 16:17:21 +0100226struct entry_point_info *bl31_plat_get_next_image_ep_info(uint32_t type);
Dan Handley7ce42df2014-05-15 14:11:36 +0100227
228/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000229 * Mandatory PSCI functions (BL31)
Dan Handley7ce42df2014-05-15 14:11:36 +0100230 ******************************************************************************/
Soby Mathew981487a2015-07-13 14:10:57 +0100231int plat_setup_psci_ops(uintptr_t sec_entrypoint,
232 const struct plat_psci_ops **);
233const unsigned char *plat_get_power_domain_tree_desc(void);
234
235/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000236 * Optional PSCI functions (BL31).
Soby Mathew981487a2015-07-13 14:10:57 +0100237 ******************************************************************************/
238plat_local_state_t plat_get_target_pwr_state(unsigned int lvl,
239 const plat_local_state_t *states,
240 unsigned int ncpu);
Dan Handley7ce42df2014-05-15 14:11:36 +0100241
242/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000243 * Optional BL31 functions (may be overridden)
Dan Handleyb226a4d2014-05-16 14:08:45 +0100244 ******************************************************************************/
Achin Guptae9982542014-06-26 08:59:07 +0100245void bl31_plat_enable_mmu(uint32_t flags);
Dan Handleyb226a4d2014-05-16 14:08:45 +0100246
247/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000248 * Optional BL32 functions (may be overridden)
Dan Handleyb226a4d2014-05-16 14:08:45 +0100249 ******************************************************************************/
Achin Guptae9982542014-06-26 08:59:07 +0100250void bl32_plat_enable_mmu(uint32_t flags);
Dan Handleyb226a4d2014-05-16 14:08:45 +0100251
Juan Castillo5e29c752015-01-07 10:39:25 +0000252/*******************************************************************************
Juan Castillo31a68f02015-04-14 12:49:03 +0100253 * Trusted Board Boot functions
Juan Castillo5e29c752015-01-07 10:39:25 +0000254 ******************************************************************************/
Juan Castillo31a68f02015-04-14 12:49:03 +0100255int plat_get_rotpk_info(void *cookie, void **key_ptr, unsigned int *key_len,
256 unsigned int *flags);
Juan Castillobfb7fa62016-01-22 11:05:57 +0000257int plat_get_nv_ctr(void *cookie, unsigned int *nv_ctr);
258int plat_set_nv_ctr(void *cookie, unsigned int nv_ctr);
Juan Castillo5e29c752015-01-07 10:39:25 +0000259
Soby Mathew981487a2015-07-13 14:10:57 +0100260#if ENABLE_PLAT_COMPAT
261/*
262 * The below declarations are to enable compatibility for the platform ports
263 * using the old platform interface.
264 */
265
266/*******************************************************************************
267 * Optional common functions (may be overridden)
268 ******************************************************************************/
269unsigned int platform_get_core_pos(unsigned long mpidr);
270
271/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000272 * Mandatory PSCI Compatibility functions (BL31)
Soby Mathew981487a2015-07-13 14:10:57 +0100273 ******************************************************************************/
274int platform_setup_pm(const plat_pm_ops_t **);
275
276unsigned int plat_get_aff_count(unsigned int, unsigned long);
277unsigned int plat_get_aff_state(unsigned int, unsigned long);
Soby Mathew70716d62015-07-13 16:26:11 +0100278#else
279/*
280 * The below function enable Trusted Firmware components like SPDs which
281 * haven't migrated to the new platform API to compile on platforms which
282 * have the compatibility layer disabled.
283 */
Soren Brinkmanna581bd52016-01-14 10:02:33 -0800284unsigned int platform_get_core_pos(unsigned long mpidr) __deprecated;
Soby Mathew981487a2015-07-13 14:10:57 +0100285
Soby Mathew70716d62015-07-13 16:26:11 +0100286#endif /* __ENABLE_PLAT_COMPAT__ */
Dan Handleyed6ff952014-05-14 17:44:19 +0100287#endif /* __PLATFORM_H__ */