Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 1 | /* |
Antonio Nino Diaz | bf75a37 | 2017-02-23 17:22:58 +0000 | [diff] [blame] | 2 | * Copyright (c) 2015-2017, ARM Limited and Contributors. All rights reserved. |
Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 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 | #ifndef __PLAT_ARM_H__ |
| 31 | #define __PLAT_ARM_H__ |
| 32 | |
Antonio Nino Diaz | 3b211ff | 2017-04-11 14:04:56 +0100 | [diff] [blame] | 33 | #include <arm_xlat_tables.h> |
Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 34 | #include <bakery_lock.h> |
Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 35 | #include <cassert.h> |
| 36 | #include <cpu_data.h> |
| 37 | #include <stdint.h> |
Sandrine Bailleux | ed81f3e | 2016-07-05 09:55:03 +0100 | [diff] [blame] | 38 | #include <utils.h> |
Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 39 | |
Sandrine Bailleux | afc931f | 2016-09-15 10:09:53 +0100 | [diff] [blame] | 40 | /******************************************************************************* |
| 41 | * Forward declarations |
| 42 | ******************************************************************************/ |
| 43 | struct bl31_params; |
| 44 | struct meminfo; |
Yatharth Kochar | a8aa7fe | 2016-09-13 17:07:57 +0100 | [diff] [blame] | 45 | struct image_info; |
Sandrine Bailleux | afc931f | 2016-09-15 10:09:53 +0100 | [diff] [blame] | 46 | |
Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 47 | #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 Mathew | 4c0d039 | 2016-06-16 14:52:04 +0100 | [diff] [blame] | 55 | void 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 Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 61 | #if USE_COHERENT_MEM |
Soby Mathew | 4c0d039 | 2016-06-16 14:52:04 +0100 | [diff] [blame] | 62 | , uintptr_t coh_start, |
| 63 | uintptr_t coh_limit |
Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 64 | #endif |
| 65 | ); |
| 66 | |
Soby Mathew | e40e075 | 2017-02-28 22:58:29 +0000 | [diff] [blame] | 67 | #if defined(IMAGE_BL31) || (defined(AARCH32) && defined(IMAGE_BL32)) |
Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 68 | /* |
| 69 | * Use this macro to instantiate lock before it is used in below |
| 70 | * arm_lock_xxx() macros |
| 71 | */ |
Vikram Kanigiri | e25e6f4 | 2015-09-09 10:52:13 +0100 | [diff] [blame] | 72 | #define ARM_INSTANTIATE_LOCK DEFINE_BAKERY_LOCK(arm_lock); |
Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 73 | |
| 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 Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 83 | /* |
Yatharth Kochar | 6f24934 | 2016-11-14 12:00:41 +0000 | [diff] [blame] | 84 | * Empty macros for all other BL stages other than BL31 and BL32 |
Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 85 | */ |
Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 86 | #define ARM_INSTANTIATE_LOCK |
| 87 | #define arm_lock_init() |
| 88 | #define arm_lock_get() |
| 89 | #define arm_lock_release() |
| 90 | |
Soby Mathew | e40e075 | 2017-02-28 22:58:29 +0000 | [diff] [blame] | 91 | #endif /* defined(IMAGE_BL31) || (defined(AARCH32) && defined(IMAGE_BL32)) */ |
Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 92 | |
Soby Mathew | 2204afd | 2015-04-16 14:49:09 +0100 | [diff] [blame] | 93 | #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 Mathew | 5f3a603 | 2015-05-08 10:18:59 +0100 | [diff] [blame] | 120 | /* 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 Mathew | 2204afd | 2015-04-16 14:49:09 +0100 | [diff] [blame] | 125 | #endif /* __ARM_RECOM_STATE_ID_ENC__ */ |
| 126 | |
Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 127 | |
Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 128 | /* IO storage utility functions */ |
| 129 | void arm_io_setup(void); |
| 130 | |
| 131 | /* Security utility functions */ |
Soby Mathew | 57f7820 | 2016-02-26 14:23:19 +0000 | [diff] [blame] | 132 | void arm_tzc400_setup(void); |
Vikram Kanigiri | 618f0fe | 2016-01-29 12:32:58 +0000 | [diff] [blame] | 133 | struct tzc_dmc500_driver_data; |
| 134 | void arm_tzc_dmc500_setup(struct tzc_dmc500_driver_data *plat_driver_data); |
Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 135 | |
Soby Mathew | c1bb8a0 | 2015-10-12 17:32:29 +0100 | [diff] [blame] | 136 | /* Systimer utility function */ |
| 137 | void arm_configure_sys_timer(void); |
| 138 | |
Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 139 | /* PM utility functions */ |
Soby Mathew | 38dce70 | 2015-07-01 16:16:20 +0100 | [diff] [blame] | 140 | int arm_validate_power_state(unsigned int power_state, |
| 141 | psci_power_state_t *req_state); |
Soby Mathew | f9e858b | 2015-07-15 13:36:24 +0100 | [diff] [blame] | 142 | int arm_validate_ns_entrypoint(uintptr_t entrypoint); |
Soby Mathew | c1bb8a0 | 2015-10-12 17:32:29 +0100 | [diff] [blame] | 143 | void arm_system_pwr_domain_resume(void); |
Sandrine Bailleux | 4c117f6 | 2015-11-26 16:31:34 +0000 | [diff] [blame] | 144 | void arm_program_trusted_mailbox(uintptr_t address); |
Soby Mathew | 38dce70 | 2015-07-01 16:16:20 +0100 | [diff] [blame] | 145 | |
| 146 | /* Topology utility function */ |
| 147 | int arm_check_mpidr(u_register_t mpidr); |
Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 148 | |
| 149 | /* BL1 utility functions */ |
| 150 | void arm_bl1_early_platform_setup(void); |
| 151 | void arm_bl1_platform_setup(void); |
| 152 | void arm_bl1_plat_arch_setup(void); |
| 153 | |
| 154 | /* BL2 utility functions */ |
Sandrine Bailleux | afc931f | 2016-09-15 10:09:53 +0100 | [diff] [blame] | 155 | void arm_bl2_early_platform_setup(struct meminfo *mem_layout); |
Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 156 | void arm_bl2_platform_setup(void); |
| 157 | void arm_bl2_plat_arch_setup(void); |
| 158 | uint32_t arm_get_spsr_for_bl32_entry(void); |
| 159 | uint32_t arm_get_spsr_for_bl33_entry(void); |
Yatharth Kochar | 07570d5 | 2016-11-14 12:01:04 +0000 | [diff] [blame] | 160 | int arm_bl2_handle_post_image_load(unsigned int image_id); |
Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 161 | |
Yatharth Kochar | dcda29f | 2015-10-14 15:28:11 +0100 | [diff] [blame] | 162 | /* BL2U utility functions */ |
| 163 | void arm_bl2u_early_platform_setup(struct meminfo *mem_layout, |
| 164 | void *plat_info); |
| 165 | void arm_bl2u_platform_setup(void); |
| 166 | void arm_bl2u_plat_arch_setup(void); |
| 167 | |
Juan Castillo | d178637 | 2015-12-14 09:35:25 +0000 | [diff] [blame] | 168 | /* BL31 utility functions */ |
Yatharth Kochar | a8aa7fe | 2016-09-13 17:07:57 +0100 | [diff] [blame] | 169 | #if LOAD_IMAGE_V2 |
| 170 | void arm_bl31_early_platform_setup(void *from_bl2, |
| 171 | void *plat_params_from_bl2); |
| 172 | #else |
Sandrine Bailleux | afc931f | 2016-09-15 10:09:53 +0100 | [diff] [blame] | 173 | void arm_bl31_early_platform_setup(struct bl31_params *from_bl2, |
Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 174 | void *plat_params_from_bl2); |
Yatharth Kochar | a8aa7fe | 2016-09-13 17:07:57 +0100 | [diff] [blame] | 175 | #endif /* LOAD_IMAGE_V2 */ |
Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 176 | void arm_bl31_platform_setup(void); |
Soby Mathew | 080225d | 2015-12-09 11:38:43 +0000 | [diff] [blame] | 177 | void arm_bl31_plat_runtime_setup(void); |
Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 178 | void arm_bl31_plat_arch_setup(void); |
| 179 | |
| 180 | /* TSP utility functions */ |
| 181 | void arm_tsp_early_platform_setup(void); |
| 182 | |
Soby Mathew | 181bbd4 | 2016-07-11 14:15:27 +0100 | [diff] [blame] | 183 | /* SP_MIN utility functions */ |
Yatharth Kochar | d991551 | 2016-06-30 14:50:58 +0100 | [diff] [blame] | 184 | void arm_sp_min_early_platform_setup(void *from_bl2, |
| 185 | void *plat_params_from_bl2); |
Soby Mathew | 181bbd4 | 2016-07-11 14:15:27 +0100 | [diff] [blame] | 186 | |
Yatharth Kochar | 436223d | 2015-10-11 14:14:55 +0100 | [diff] [blame] | 187 | /* FIP TOC validity check */ |
| 188 | int arm_io_is_toc_valid(void); |
Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 189 | |
| 190 | /* |
| 191 | * Mandatory functions required in ARM standard platforms |
| 192 | */ |
Soby Mathew | 0108047 | 2016-02-01 14:04:34 +0000 | [diff] [blame] | 193 | unsigned int plat_arm_get_cluster_core_count(u_register_t mpidr); |
Achin Gupta | 27573c5 | 2015-11-03 14:18:34 +0000 | [diff] [blame] | 194 | void plat_arm_gic_driver_init(void); |
Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 195 | void plat_arm_gic_init(void); |
Achin Gupta | 27573c5 | 2015-11-03 14:18:34 +0000 | [diff] [blame] | 196 | void plat_arm_gic_cpuif_enable(void); |
| 197 | void plat_arm_gic_cpuif_disable(void); |
Jeenu Viswambharan | d17b953 | 2016-12-09 11:12:34 +0000 | [diff] [blame] | 198 | void plat_arm_gic_redistif_on(void); |
| 199 | void plat_arm_gic_redistif_off(void); |
Achin Gupta | 27573c5 | 2015-11-03 14:18:34 +0000 | [diff] [blame] | 200 | void plat_arm_gic_pcpu_init(void); |
Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 201 | void plat_arm_security_setup(void); |
| 202 | void plat_arm_pwrc_setup(void); |
Vikram Kanigiri | 6355f23 | 2016-02-15 11:54:14 +0000 | [diff] [blame] | 203 | void plat_arm_interconnect_init(void); |
| 204 | void plat_arm_interconnect_enter_coherency(void); |
| 205 | void plat_arm_interconnect_exit_coherency(void); |
Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 206 | |
Summer Qin | d8d6cf2 | 2017-02-28 16:46:17 +0000 | [diff] [blame] | 207 | #if ARM_PLAT_MT |
| 208 | unsigned int plat_arm_get_cpu_pe_count(u_register_t mpidr); |
| 209 | #endif |
| 210 | |
Yatharth Kochar | a8aa7fe | 2016-09-13 17:07:57 +0100 | [diff] [blame] | 211 | #if LOAD_IMAGE_V2 |
| 212 | /* |
| 213 | * This function is called after loading SCP_BL2 image and it is used to perform |
| 214 | * any platform-specific actions required to handle the SCP firmware. |
| 215 | */ |
| 216 | int plat_arm_bl2_handle_scp_bl2(struct image_info *scp_bl2_image_info); |
| 217 | #endif |
| 218 | |
Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 219 | /* |
| 220 | * Optional functions required in ARM standard platforms |
| 221 | */ |
| 222 | void plat_arm_io_setup(void); |
| 223 | int plat_arm_get_alt_image_source( |
Juan Castillo | 16948ae | 2015-04-13 17:36:19 +0100 | [diff] [blame] | 224 | unsigned int image_id, |
| 225 | uintptr_t *dev_handle, |
| 226 | uintptr_t *image_spec); |
Soby Mathew | 38dce70 | 2015-07-01 16:16:20 +0100 | [diff] [blame] | 227 | unsigned int plat_arm_calc_core_pos(u_register_t mpidr); |
Vikram Kanigiri | 65cb1c4 | 2015-11-12 18:52:34 +0000 | [diff] [blame] | 228 | const mmap_region_t *plat_arm_get_mmap(void); |
Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 229 | |
Soby Mathew | 5486a96 | 2016-10-21 17:51:22 +0100 | [diff] [blame] | 230 | /* Allow platform to override psci_pm_ops during runtime */ |
| 231 | const plat_psci_ops_t *plat_arm_psci_override_pm_ops(plat_psci_ops_t *ops); |
| 232 | |
Dan Handley | b431530 | 2015-03-19 18:58:55 +0000 | [diff] [blame] | 233 | #endif /* __PLAT_ARM_H__ */ |