blob: 8e038aa7f2d610111180aee3d2b4b47a63bc7690 [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/*******************************************************************************
Dan Handley7ce42df2014-05-15 14:11:36 +010047 * Function declarations
Dan Handleyed6ff952014-05-14 17:44:19 +010048 ******************************************************************************/
Dan Handley7ce42df2014-05-15 14:11:36 +010049/*******************************************************************************
50 * Mandatory common functions
51 ******************************************************************************/
52uint64_t plat_get_syscnt_freq(void);
Dan Handley7ce42df2014-05-15 14:11:36 +010053int plat_get_image_source(const char *image_name,
54 uintptr_t *dev_handle,
55 uintptr_t *image_spec);
Dan Handleyed6ff952014-05-14 17:44:19 +010056unsigned long plat_get_ns_image_entrypoint(void);
Dan Handley7ce42df2014-05-15 14:11:36 +010057
58/*******************************************************************************
59 * Mandatory interrupt management functions
60 ******************************************************************************/
Dan Handley701fea72014-05-27 16:17:21 +010061uint32_t plat_ic_get_pending_interrupt_id(void);
62uint32_t plat_ic_get_pending_interrupt_type(void);
63uint32_t plat_ic_acknowledge_interrupt(void);
64uint32_t plat_ic_get_interrupt_type(uint32_t id);
65void plat_ic_end_of_interrupt(uint32_t id);
Dan Handleyed6ff952014-05-14 17:44:19 +010066uint32_t plat_interrupt_type_to_line(uint32_t type,
67 uint32_t security_state);
68
Dan Handley7ce42df2014-05-15 14:11:36 +010069/*******************************************************************************
70 * Optional common functions (may be overridden)
71 ******************************************************************************/
72unsigned int platform_get_core_pos(unsigned long mpidr);
73unsigned long platform_get_stack(unsigned long mpidr);
74void plat_report_exception(unsigned long);
Soby Mathew066f7132014-07-14 16:57:23 +010075void plat_crash_console_init(unsigned long base_addr);
76int plat_crash_console_putc(int c);
Dan Handley7ce42df2014-05-15 14:11:36 +010077
78/*******************************************************************************
79 * Mandatory BL1 functions
80 ******************************************************************************/
Dan Handley4fd2f5c2014-08-04 11:41:20 +010081void bl1_early_platform_setup(void);
Dan Handley7ce42df2014-05-15 14:11:36 +010082void bl1_plat_arch_setup(void);
83void bl1_platform_setup(void);
84struct meminfo *bl1_plat_sec_mem_layout(void);
Dan Handleyed6ff952014-05-14 17:44:19 +010085
86/*
Dan Handley2159ef42014-05-27 15:39:41 +010087 * This function allows the platform to change the entrypoint information for
88 * BL2, after BL1 has loaded BL2 into memory but before BL2 is executed.
Dan Handleyed6ff952014-05-14 17:44:19 +010089 */
90void bl1_plat_set_bl2_ep_info(struct image_info *image,
91 struct entry_point_info *ep);
92
Dan Handley7ce42df2014-05-15 14:11:36 +010093/*******************************************************************************
94 * Optional BL1 functions (may be overridden)
95 ******************************************************************************/
Sandrine Bailleux467d0572014-06-24 14:02:34 +010096void bl1_init_bl2_mem_layout(const struct meminfo *bl1_mem_layout,
97 struct meminfo *bl2_mem_layout);
Dan Handley7ce42df2014-05-15 14:11:36 +010098
99/*******************************************************************************
100 * Mandatory BL2 functions
101 ******************************************************************************/
Dan Handley4fd2f5c2014-08-04 11:41:20 +0100102void bl2_early_platform_setup(struct meminfo *mem_layout);
Dan Handley7ce42df2014-05-15 14:11:36 +0100103void bl2_plat_arch_setup(void);
104void bl2_platform_setup(void);
105struct meminfo *bl2_plat_sec_mem_layout(void);
106
107/*
108 * This function returns a pointer to the shared memory that the platform has
109 * kept aside to pass trusted firmware related information that BL3-1
110 * could need
111 */
112struct bl31_params *bl2_plat_get_bl31_params(void);
113
114/*
115 * This function returns a pointer to the shared memory that the platform
116 * has kept to point to entry point information of BL31 to BL2
117 */
118struct entry_point_info *bl2_plat_get_bl31_ep_info(void);
119
120/*
121 * This function flushes to main memory all the params that are
122 * passed to BL3-1
123 */
124void bl2_plat_flush_bl31_params(void);
125
Dan Handleyed6ff952014-05-14 17:44:19 +0100126/*
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100127 * The next 2 functions allow the platform to change the entrypoint information
128 * for the mandatory 3rd level BL images, BL3-1 and BL3-3. This is done after
129 * BL2 has loaded those images into memory but before BL3-1 is executed.
Dan Handleyed6ff952014-05-14 17:44:19 +0100130 */
131void bl2_plat_set_bl31_ep_info(struct image_info *image,
132 struct entry_point_info *ep);
133
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100134void bl2_plat_set_bl33_ep_info(struct image_info *image,
Dan Handleyed6ff952014-05-14 17:44:19 +0100135 struct entry_point_info *ep);
136
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100137/* Gets the memory layout for BL3-3 */
138void bl2_plat_get_bl33_meminfo(struct meminfo *mem_info);
139
140/*******************************************************************************
141 * Conditionally mandatory BL2 functions: must be implemented if BL3-0 image
142 * is supported
143 ******************************************************************************/
144/* Gets the memory layout for BL3-0 */
145void bl2_plat_get_bl30_meminfo(struct meminfo *mem_info);
146
147/*
148 * This function is called after loading BL3-0 image and it is used to perform
149 * any platform-specific actions required to handle the SCP firmware.
150 */
151int bl2_plat_handle_bl30(struct image_info *bl30_image_info);
152
153/*******************************************************************************
154 * Conditionally mandatory BL2 functions: must be implemented if BL3-2 image
155 * is supported
156 ******************************************************************************/
157void bl2_plat_set_bl32_ep_info(struct image_info *image,
Dan Handleyed6ff952014-05-14 17:44:19 +0100158 struct entry_point_info *ep);
159
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +0100160/* Gets the memory layout for BL3-2 */
Dan Handleyed6ff952014-05-14 17:44:19 +0100161void bl2_plat_get_bl32_meminfo(struct meminfo *mem_info);
162
Dan Handley7ce42df2014-05-15 14:11:36 +0100163/*******************************************************************************
164 * Optional BL2 functions (may be overridden)
165 ******************************************************************************/
166
167/*******************************************************************************
168 * Mandatory BL3-1 functions
169 ******************************************************************************/
170void bl31_early_platform_setup(struct bl31_params *from_bl2,
171 void *plat_params_from_bl2);
172void bl31_plat_arch_setup(void);
173void bl31_platform_setup(void);
Dan Handley701fea72014-05-27 16:17:21 +0100174struct entry_point_info *bl31_plat_get_next_image_ep_info(uint32_t type);
Dan Handley7ce42df2014-05-15 14:11:36 +0100175
176/*******************************************************************************
177 * Mandatory PSCI functions (BL3-1)
178 ******************************************************************************/
179int platform_setup_pm(const struct plat_pm_ops **);
180int plat_get_max_afflvl(void);
181unsigned int plat_get_aff_count(unsigned int, unsigned long);
182unsigned int plat_get_aff_state(unsigned int, unsigned long);
183
184/*******************************************************************************
Dan Handleyb226a4d2014-05-16 14:08:45 +0100185 * Optional BL3-1 functions (may be overridden)
186 ******************************************************************************/
Achin Guptae9982542014-06-26 08:59:07 +0100187void bl31_plat_enable_mmu(uint32_t flags);
Dan Handleyb226a4d2014-05-16 14:08:45 +0100188
189/*******************************************************************************
Dan Handleyb226a4d2014-05-16 14:08:45 +0100190 * Optional BL3-2 functions (may be overridden)
191 ******************************************************************************/
Achin Guptae9982542014-06-26 08:59:07 +0100192void bl32_plat_enable_mmu(uint32_t flags);
Dan Handleyb226a4d2014-05-16 14:08:45 +0100193
Dan Handleyed6ff952014-05-14 17:44:19 +0100194#endif /* __PLATFORM_H__ */