blob: 29fcffec87a38c89a937ce2c019bce1493c737ae [file] [log] [blame]
Dan Handley9df48042015-03-19 18:58:55 +00001/*
Vikram Kanigiri07035432015-11-12 18:52:34 +00002 * Copyright (c) 2015-2016, ARM Limited and Contributors. All rights reserved.
Dan Handley9df48042015-03-19 18:58:55 +00003 *
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#ifndef __PLAT_ARM_H__
31#define __PLAT_ARM_H__
32
33#include <bakery_lock.h>
Dan Handley9df48042015-03-19 18:58:55 +000034#include <cassert.h>
35#include <cpu_data.h>
36#include <stdint.h>
Sandrine Bailleux7659a262016-07-05 09:55:03 +010037#include <utils.h>
Soby Mathewfe3b5762015-10-27 10:31:35 +000038#include <xlat_tables.h>
Dan Handley9df48042015-03-19 18:58:55 +000039
Sandrine Bailleuxf402a522016-09-15 10:09:53 +010040/*******************************************************************************
41 * Forward declarations
42 ******************************************************************************/
43struct bl31_params;
44struct meminfo;
Yatharth Kocharf9a0f162016-09-13 17:07:57 +010045struct image_info;
Sandrine Bailleuxf402a522016-09-15 10:09:53 +010046
Dan Handley9df48042015-03-19 18:58:55 +000047#define ARM_CASSERT_MMAP \
48 CASSERT((ARRAY_SIZE(plat_arm_mmap) + ARM_BL_REGIONS) \
49 <= MAX_MMAP_REGIONS, \
50 assert_max_mmap_regions);
51
52/*
53 * Utility functions common to ARM standard platforms
54 */
Soby Mathewa0fedc42016-06-16 14:52:04 +010055void arm_setup_page_tables(uintptr_t total_base,
56 size_t total_size,
57 uintptr_t code_start,
58 uintptr_t code_limit,
59 uintptr_t rodata_start,
60 uintptr_t rodata_limit
Dan Handley9df48042015-03-19 18:58:55 +000061#if USE_COHERENT_MEM
Soby Mathewa0fedc42016-06-16 14:52:04 +010062 , uintptr_t coh_start,
63 uintptr_t coh_limit
Dan Handley9df48042015-03-19 18:58:55 +000064#endif
65);
66
67#if IMAGE_BL31
Dan Handley9df48042015-03-19 18:58:55 +000068/*
69 * Use this macro to instantiate lock before it is used in below
70 * arm_lock_xxx() macros
71 */
Vikram Kanigirid79214c2015-09-09 10:52:13 +010072#define ARM_INSTANTIATE_LOCK DEFINE_BAKERY_LOCK(arm_lock);
Dan Handley9df48042015-03-19 18:58:55 +000073
74/*
75 * These are wrapper macros to the Coherent Memory Bakery Lock API.
76 */
77#define arm_lock_init() bakery_lock_init(&arm_lock)
78#define arm_lock_get() bakery_lock_get(&arm_lock)
79#define arm_lock_release() bakery_lock_release(&arm_lock)
80
81#else
82
Dan Handley9df48042015-03-19 18:58:55 +000083/*
Juan Castillo7d199412015-12-14 09:35:25 +000084 * Empty macros for all other BL stages other than BL31
Dan Handley9df48042015-03-19 18:58:55 +000085 */
Dan Handley9df48042015-03-19 18:58:55 +000086#define ARM_INSTANTIATE_LOCK
87#define arm_lock_init()
88#define arm_lock_get()
89#define arm_lock_release()
90
91#endif /* IMAGE_BL31 */
92
Soby Mathew7799cf72015-04-16 14:49:09 +010093#if ARM_RECOM_STATE_ID_ENC
94/*
95 * Macros used to parse state information from State-ID if it is using the
96 * recommended encoding for State-ID.
97 */
98#define ARM_LOCAL_PSTATE_WIDTH 4
99#define ARM_LOCAL_PSTATE_MASK ((1 << ARM_LOCAL_PSTATE_WIDTH) - 1)
100
101/* Macros to construct the composite power state */
102
103/* Make composite power state parameter till power level 0 */
104#if PSCI_EXTENDED_STATE_ID
105
106#define arm_make_pwrstate_lvl0(lvl0_state, pwr_lvl, type) \
107 (((lvl0_state) << PSTATE_ID_SHIFT) | ((type) << PSTATE_TYPE_SHIFT))
108#else
109#define arm_make_pwrstate_lvl0(lvl0_state, pwr_lvl, type) \
110 (((lvl0_state) << PSTATE_ID_SHIFT) | \
111 ((pwr_lvl) << PSTATE_PWR_LVL_SHIFT) | \
112 ((type) << PSTATE_TYPE_SHIFT))
113#endif /* __PSCI_EXTENDED_STATE_ID__ */
114
115/* Make composite power state parameter till power level 1 */
116#define arm_make_pwrstate_lvl1(lvl1_state, lvl0_state, pwr_lvl, type) \
117 (((lvl1_state) << ARM_LOCAL_PSTATE_WIDTH) | \
118 arm_make_pwrstate_lvl0(lvl0_state, pwr_lvl, type))
119
Soby Mathewa869de12015-05-08 10:18:59 +0100120/* Make composite power state parameter till power level 2 */
121#define arm_make_pwrstate_lvl2(lvl2_state, lvl1_state, lvl0_state, pwr_lvl, type) \
122 (((lvl2_state) << (ARM_LOCAL_PSTATE_WIDTH * 2)) | \
123 arm_make_pwrstate_lvl1(lvl1_state, lvl0_state, pwr_lvl, type))
124
Soby Mathew7799cf72015-04-16 14:49:09 +0100125#endif /* __ARM_RECOM_STATE_ID_ENC__ */
126
Dan Handley9df48042015-03-19 18:58:55 +0000127
Dan Handley9df48042015-03-19 18:58:55 +0000128/* IO storage utility functions */
129void arm_io_setup(void);
130
131/* Security utility functions */
Soby Mathew9c708b52016-02-26 14:23:19 +0000132void arm_tzc400_setup(void);
Vikram Kanigiri510d87b2016-01-29 12:32:58 +0000133struct tzc_dmc500_driver_data;
134void arm_tzc_dmc500_setup(struct tzc_dmc500_driver_data *plat_driver_data);
Dan Handley9df48042015-03-19 18:58:55 +0000135
Soby Mathew61e8d0b2015-10-12 17:32:29 +0100136/* Systimer utility function */
137void arm_configure_sys_timer(void);
138
Dan Handley9df48042015-03-19 18:58:55 +0000139/* PM utility functions */
Soby Mathewfec4eb72015-07-01 16:16:20 +0100140int arm_validate_power_state(unsigned int power_state,
141 psci_power_state_t *req_state);
Soby Mathew0d9e8522015-07-15 13:36:24 +0100142int arm_validate_ns_entrypoint(uintptr_t entrypoint);
Soby Mathew61e8d0b2015-10-12 17:32:29 +0100143void arm_system_pwr_domain_resume(void);
Sandrine Bailleux03897bb2015-11-26 16:31:34 +0000144void arm_program_trusted_mailbox(uintptr_t address);
Soby Mathewfec4eb72015-07-01 16:16:20 +0100145
146/* Topology utility function */
147int arm_check_mpidr(u_register_t mpidr);
Dan Handley9df48042015-03-19 18:58:55 +0000148
149/* BL1 utility functions */
150void arm_bl1_early_platform_setup(void);
151void arm_bl1_platform_setup(void);
152void arm_bl1_plat_arch_setup(void);
153
154/* BL2 utility functions */
Sandrine Bailleuxf402a522016-09-15 10:09:53 +0100155void arm_bl2_early_platform_setup(struct meminfo *mem_layout);
Dan Handley9df48042015-03-19 18:58:55 +0000156void arm_bl2_platform_setup(void);
157void arm_bl2_plat_arch_setup(void);
158uint32_t arm_get_spsr_for_bl32_entry(void);
159uint32_t arm_get_spsr_for_bl33_entry(void);
160
Yatharth Kochar3a11eda2015-10-14 15:28:11 +0100161/* BL2U utility functions */
162void arm_bl2u_early_platform_setup(struct meminfo *mem_layout,
163 void *plat_info);
164void arm_bl2u_platform_setup(void);
165void arm_bl2u_plat_arch_setup(void);
166
Juan Castillo7d199412015-12-14 09:35:25 +0000167/* BL31 utility functions */
Yatharth Kocharf9a0f162016-09-13 17:07:57 +0100168#if LOAD_IMAGE_V2
169void arm_bl31_early_platform_setup(void *from_bl2,
170 void *plat_params_from_bl2);
171#else
Sandrine Bailleuxf402a522016-09-15 10:09:53 +0100172void arm_bl31_early_platform_setup(struct bl31_params *from_bl2,
Dan Handley9df48042015-03-19 18:58:55 +0000173 void *plat_params_from_bl2);
Yatharth Kocharf9a0f162016-09-13 17:07:57 +0100174#endif /* LOAD_IMAGE_V2 */
Dan Handley9df48042015-03-19 18:58:55 +0000175void arm_bl31_platform_setup(void);
Soby Mathew2fd66be2015-12-09 11:38:43 +0000176void arm_bl31_plat_runtime_setup(void);
Dan Handley9df48042015-03-19 18:58:55 +0000177void arm_bl31_plat_arch_setup(void);
178
179/* TSP utility functions */
180void arm_tsp_early_platform_setup(void);
181
Soby Mathew7b754182016-07-11 14:15:27 +0100182/* SP_MIN utility functions */
Yatharth Kochar1c16a4c2016-06-30 14:50:58 +0100183void arm_sp_min_early_platform_setup(void *from_bl2,
184 void *plat_params_from_bl2);
Soby Mathew7b754182016-07-11 14:15:27 +0100185
Yatharth Kochar736a3bf2015-10-11 14:14:55 +0100186/* FIP TOC validity check */
187int arm_io_is_toc_valid(void);
Dan Handley9df48042015-03-19 18:58:55 +0000188
189/*
190 * Mandatory functions required in ARM standard platforms
191 */
Soby Mathew47e43f22016-02-01 14:04:34 +0000192unsigned int plat_arm_get_cluster_core_count(u_register_t mpidr);
Achin Gupta1fa7eb62015-11-03 14:18:34 +0000193void plat_arm_gic_driver_init(void);
Dan Handley9df48042015-03-19 18:58:55 +0000194void plat_arm_gic_init(void);
Achin Gupta1fa7eb62015-11-03 14:18:34 +0000195void plat_arm_gic_cpuif_enable(void);
196void plat_arm_gic_cpuif_disable(void);
197void plat_arm_gic_pcpu_init(void);
Dan Handley9df48042015-03-19 18:58:55 +0000198void plat_arm_security_setup(void);
199void plat_arm_pwrc_setup(void);
Vikram Kanigirifbb13012016-02-15 11:54:14 +0000200void plat_arm_interconnect_init(void);
201void plat_arm_interconnect_enter_coherency(void);
202void plat_arm_interconnect_exit_coherency(void);
Dan Handley9df48042015-03-19 18:58:55 +0000203
Yatharth Kocharf9a0f162016-09-13 17:07:57 +0100204#if LOAD_IMAGE_V2
205/*
206 * This function is called after loading SCP_BL2 image and it is used to perform
207 * any platform-specific actions required to handle the SCP firmware.
208 */
209int plat_arm_bl2_handle_scp_bl2(struct image_info *scp_bl2_image_info);
210#endif
211
Dan Handley9df48042015-03-19 18:58:55 +0000212/*
213 * Optional functions required in ARM standard platforms
214 */
215void plat_arm_io_setup(void);
216int plat_arm_get_alt_image_source(
Juan Castillo3a66aca2015-04-13 17:36:19 +0100217 unsigned int image_id,
218 uintptr_t *dev_handle,
219 uintptr_t *image_spec);
Soby Mathewfec4eb72015-07-01 16:16:20 +0100220unsigned int plat_arm_calc_core_pos(u_register_t mpidr);
Vikram Kanigiri07035432015-11-12 18:52:34 +0000221const mmap_region_t *plat_arm_get_mmap(void);
Dan Handley9df48042015-03-19 18:58:55 +0000222
223#endif /* __PLAT_ARM_H__ */