blob: 469d46b678cd9f7470b71df5615962798159bd17 [file] [log] [blame]
Dan Handleyed6ff952014-05-14 17:44:19 +01001/*
2 * Copyright (c) 2013-2014, ARM Limited and Contributors. All rights reserved.
3 *
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
34#include <stdint.h>
35
36
37/*******************************************************************************
38 * Forward declarations
39 ******************************************************************************/
40struct plat_pm_ops;
41struct meminfo;
42struct image_info;
43struct entry_point_info;
Dan Handley7ce42df2014-05-15 14:11:36 +010044struct bl31_params;
Dan Handleyed6ff952014-05-14 17:44:19 +010045
46/*******************************************************************************
Juan Castillo31a68f02015-04-14 12:49:03 +010047 * plat_get_rotpk_info() flags
48 ******************************************************************************/
49#define ROTPK_IS_HASH (1 << 0)
50
51/*******************************************************************************
Dan Handley7ce42df2014-05-15 14:11:36 +010052 * Function declarations
Dan Handleyed6ff952014-05-14 17:44:19 +010053 ******************************************************************************/
Dan Handley7ce42df2014-05-15 14:11:36 +010054/*******************************************************************************
55 * Mandatory common functions
56 ******************************************************************************/
57uint64_t plat_get_syscnt_freq(void);
Juan Castillo3a66aca2015-04-13 17:36:19 +010058int plat_get_image_source(unsigned int image_id,
Dan Handley7ce42df2014-05-15 14:11:36 +010059 uintptr_t *dev_handle,
60 uintptr_t *image_spec);
Dan Handleyed6ff952014-05-14 17:44:19 +010061unsigned long plat_get_ns_image_entrypoint(void);
Dan Handley7ce42df2014-05-15 14:11:36 +010062
63/*******************************************************************************
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/*******************************************************************************
75 * Optional common functions (may be overridden)
76 ******************************************************************************/
77unsigned int platform_get_core_pos(unsigned long mpidr);
78unsigned long platform_get_stack(unsigned long mpidr);
79void plat_report_exception(unsigned long);
Sandrine Bailleux046cd3f2014-08-06 11:27:23 +010080int plat_crash_console_init(void);
Soby Mathew066f7132014-07-14 16:57:23 +010081int plat_crash_console_putc(int c);
Dan Handley7ce42df2014-05-15 14:11:36 +010082
83/*******************************************************************************
84 * Mandatory BL1 functions
85 ******************************************************************************/
Dan Handley4fd2f5c2014-08-04 11:41:20 +010086void bl1_early_platform_setup(void);
Dan Handley7ce42df2014-05-15 14:11:36 +010087void bl1_plat_arch_setup(void);
88void bl1_platform_setup(void);
89struct meminfo *bl1_plat_sec_mem_layout(void);
Dan Handleyed6ff952014-05-14 17:44:19 +010090
91/*
Dan Handley2159ef42014-05-27 15:39:41 +010092 * This function allows the platform to change the entrypoint information for
93 * BL2, after BL1 has loaded BL2 into memory but before BL2 is executed.
Dan Handleyed6ff952014-05-14 17:44:19 +010094 */
95void bl1_plat_set_bl2_ep_info(struct image_info *image,
96 struct entry_point_info *ep);
97
Dan Handley7ce42df2014-05-15 14:11:36 +010098/*******************************************************************************
99 * Optional BL1 functions (may be overridden)
100 ******************************************************************************/
Sandrine Bailleux467d0572014-06-24 14:02:34 +0100101void bl1_init_bl2_mem_layout(const struct meminfo *bl1_mem_layout,
102 struct meminfo *bl2_mem_layout);
Dan Handley7ce42df2014-05-15 14:11:36 +0100103
104/*******************************************************************************
105 * Mandatory BL2 functions
106 ******************************************************************************/
Dan Handley4fd2f5c2014-08-04 11:41:20 +0100107void bl2_early_platform_setup(struct meminfo *mem_layout);
Dan Handley7ce42df2014-05-15 14:11:36 +0100108void bl2_plat_arch_setup(void);
109void bl2_platform_setup(void);
110struct meminfo *bl2_plat_sec_mem_layout(void);
111
112/*
113 * This function returns a pointer to the shared memory that the platform has
114 * kept aside to pass trusted firmware related information that BL3-1
115 * could need
116 */
117struct bl31_params *bl2_plat_get_bl31_params(void);
118
119/*
120 * This function returns a pointer to the shared memory that the platform
121 * has kept to point to entry point information of BL31 to BL2
122 */
123struct entry_point_info *bl2_plat_get_bl31_ep_info(void);
124
125/*
126 * This function flushes to main memory all the params that are
127 * passed to BL3-1
128 */
129void bl2_plat_flush_bl31_params(void);
130
Dan Handleyed6ff952014-05-14 17:44:19 +0100131/*
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100132 * The next 2 functions allow the platform to change the entrypoint information
133 * for the mandatory 3rd level BL images, BL3-1 and BL3-3. This is done after
134 * BL2 has loaded those images into memory but before BL3-1 is executed.
Dan Handleyed6ff952014-05-14 17:44:19 +0100135 */
136void bl2_plat_set_bl31_ep_info(struct image_info *image,
137 struct entry_point_info *ep);
138
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100139void bl2_plat_set_bl33_ep_info(struct image_info *image,
Dan Handleyed6ff952014-05-14 17:44:19 +0100140 struct entry_point_info *ep);
141
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100142/* Gets the memory layout for BL3-3 */
143void bl2_plat_get_bl33_meminfo(struct meminfo *mem_info);
144
145/*******************************************************************************
146 * Conditionally mandatory BL2 functions: must be implemented if BL3-0 image
147 * is supported
148 ******************************************************************************/
149/* Gets the memory layout for BL3-0 */
150void bl2_plat_get_bl30_meminfo(struct meminfo *mem_info);
151
152/*
153 * This function is called after loading BL3-0 image and it is used to perform
154 * any platform-specific actions required to handle the SCP firmware.
155 */
156int bl2_plat_handle_bl30(struct image_info *bl30_image_info);
157
158/*******************************************************************************
159 * Conditionally mandatory BL2 functions: must be implemented if BL3-2 image
160 * is supported
161 ******************************************************************************/
162void bl2_plat_set_bl32_ep_info(struct image_info *image,
Dan Handleyed6ff952014-05-14 17:44:19 +0100163 struct entry_point_info *ep);
164
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100165/* Gets the memory layout for BL3-2 */
Dan Handleyed6ff952014-05-14 17:44:19 +0100166void bl2_plat_get_bl32_meminfo(struct meminfo *mem_info);
167
Dan Handley7ce42df2014-05-15 14:11:36 +0100168/*******************************************************************************
169 * Optional BL2 functions (may be overridden)
170 ******************************************************************************/
171
172/*******************************************************************************
173 * Mandatory BL3-1 functions
174 ******************************************************************************/
175void bl31_early_platform_setup(struct bl31_params *from_bl2,
176 void *plat_params_from_bl2);
177void bl31_plat_arch_setup(void);
178void bl31_platform_setup(void);
Dan Handley701fea72014-05-27 16:17:21 +0100179struct entry_point_info *bl31_plat_get_next_image_ep_info(uint32_t type);
Dan Handley7ce42df2014-05-15 14:11:36 +0100180
181/*******************************************************************************
182 * Mandatory PSCI functions (BL3-1)
183 ******************************************************************************/
184int platform_setup_pm(const struct plat_pm_ops **);
Dan Handley7ce42df2014-05-15 14:11:36 +0100185unsigned int plat_get_aff_count(unsigned int, unsigned long);
186unsigned int plat_get_aff_state(unsigned int, unsigned long);
187
188/*******************************************************************************
Dan Handleyb226a4d2014-05-16 14:08:45 +0100189 * Optional BL3-1 functions (may be overridden)
190 ******************************************************************************/
Achin Guptae9982542014-06-26 08:59:07 +0100191void bl31_plat_enable_mmu(uint32_t flags);
Dan Handleyb226a4d2014-05-16 14:08:45 +0100192
193/*******************************************************************************
Dan Handleyb226a4d2014-05-16 14:08:45 +0100194 * Optional BL3-2 functions (may be overridden)
195 ******************************************************************************/
Achin Guptae9982542014-06-26 08:59:07 +0100196void bl32_plat_enable_mmu(uint32_t flags);
Dan Handleyb226a4d2014-05-16 14:08:45 +0100197
Juan Castillo5e29c752015-01-07 10:39:25 +0000198/*******************************************************************************
Juan Castillo31a68f02015-04-14 12:49:03 +0100199 * Trusted Board Boot functions
Juan Castillo5e29c752015-01-07 10:39:25 +0000200 ******************************************************************************/
Juan Castillo31a68f02015-04-14 12:49:03 +0100201int plat_get_rotpk_info(void *cookie, void **key_ptr, unsigned int *key_len,
202 unsigned int *flags);
Juan Castillo5e29c752015-01-07 10:39:25 +0000203
Dan Handleyed6ff952014-05-14 17:44:19 +0100204#endif /* __PLATFORM_H__ */