1 /* 2 * Copyright (c) 2015-2016, 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 #ifndef __PLAT_ARM_H__ 31 #define __PLAT_ARM_H__ 32 33 #include <bakery_lock.h> 34 #include <cassert.h> 35 #include <cpu_data.h> 36 #include <stdint.h> 37 #include <utils.h> 38 #include <xlat_tables.h> 39 40 /******************************************************************************* 41 * Forward declarations 42 ******************************************************************************/ 43 struct bl31_params; 44 struct meminfo; 45 46 #define ARM_CASSERT_MMAP \ 47 CASSERT((ARRAY_SIZE(plat_arm_mmap) + ARM_BL_REGIONS) \ 48 <= MAX_MMAP_REGIONS, \ 49 assert_max_mmap_regions); 50 51 /* 52 * Utility functions common to ARM standard platforms 53 */ 54 void arm_setup_page_tables(uintptr_t total_base, 55 size_t total_size, 56 uintptr_t code_start, 57 uintptr_t code_limit, 58 uintptr_t rodata_start, 59 uintptr_t rodata_limit 60 #if USE_COHERENT_MEM 61 , uintptr_t coh_start, 62 uintptr_t coh_limit 63 #endif 64 ); 65 66 #if IMAGE_BL31 67 /* 68 * Use this macro to instantiate lock before it is used in below 69 * arm_lock_xxx() macros 70 */ 71 #define ARM_INSTANTIATE_LOCK DEFINE_BAKERY_LOCK(arm_lock); 72 73 /* 74 * These are wrapper macros to the Coherent Memory Bakery Lock API. 75 */ 76 #define arm_lock_init() bakery_lock_init(&arm_lock) 77 #define arm_lock_get() bakery_lock_get(&arm_lock) 78 #define arm_lock_release() bakery_lock_release(&arm_lock) 79 80 #else 81 82 /* 83 * Empty macros for all other BL stages other than BL31 84 */ 85 #define ARM_INSTANTIATE_LOCK 86 #define arm_lock_init() 87 #define arm_lock_get() 88 #define arm_lock_release() 89 90 #endif /* IMAGE_BL31 */ 91 92 #if ARM_RECOM_STATE_ID_ENC 93 /* 94 * Macros used to parse state information from State-ID if it is using the 95 * recommended encoding for State-ID. 96 */ 97 #define ARM_LOCAL_PSTATE_WIDTH 4 98 #define ARM_LOCAL_PSTATE_MASK ((1 << ARM_LOCAL_PSTATE_WIDTH) - 1) 99 100 /* Macros to construct the composite power state */ 101 102 /* Make composite power state parameter till power level 0 */ 103 #if PSCI_EXTENDED_STATE_ID 104 105 #define arm_make_pwrstate_lvl0(lvl0_state, pwr_lvl, type) \ 106 (((lvl0_state) << PSTATE_ID_SHIFT) | ((type) << PSTATE_TYPE_SHIFT)) 107 #else 108 #define arm_make_pwrstate_lvl0(lvl0_state, pwr_lvl, type) \ 109 (((lvl0_state) << PSTATE_ID_SHIFT) | \ 110 ((pwr_lvl) << PSTATE_PWR_LVL_SHIFT) | \ 111 ((type) << PSTATE_TYPE_SHIFT)) 112 #endif /* __PSCI_EXTENDED_STATE_ID__ */ 113 114 /* Make composite power state parameter till power level 1 */ 115 #define arm_make_pwrstate_lvl1(lvl1_state, lvl0_state, pwr_lvl, type) \ 116 (((lvl1_state) << ARM_LOCAL_PSTATE_WIDTH) | \ 117 arm_make_pwrstate_lvl0(lvl0_state, pwr_lvl, type)) 118 119 /* Make composite power state parameter till power level 2 */ 120 #define arm_make_pwrstate_lvl2(lvl2_state, lvl1_state, lvl0_state, pwr_lvl, type) \ 121 (((lvl2_state) << (ARM_LOCAL_PSTATE_WIDTH * 2)) | \ 122 arm_make_pwrstate_lvl1(lvl1_state, lvl0_state, pwr_lvl, type)) 123 124 #endif /* __ARM_RECOM_STATE_ID_ENC__ */ 125 126 127 /* IO storage utility functions */ 128 void arm_io_setup(void); 129 130 /* Security utility functions */ 131 void arm_tzc400_setup(void); 132 struct tzc_dmc500_driver_data; 133 void arm_tzc_dmc500_setup(struct tzc_dmc500_driver_data *plat_driver_data); 134 135 /* Systimer utility function */ 136 void arm_configure_sys_timer(void); 137 138 /* PM utility functions */ 139 int arm_validate_power_state(unsigned int power_state, 140 psci_power_state_t *req_state); 141 int arm_validate_ns_entrypoint(uintptr_t entrypoint); 142 void arm_system_pwr_domain_resume(void); 143 void arm_program_trusted_mailbox(uintptr_t address); 144 145 /* Topology utility function */ 146 int arm_check_mpidr(u_register_t mpidr); 147 148 /* BL1 utility functions */ 149 void arm_bl1_early_platform_setup(void); 150 void arm_bl1_platform_setup(void); 151 void arm_bl1_plat_arch_setup(void); 152 153 /* BL2 utility functions */ 154 void arm_bl2_early_platform_setup(struct meminfo *mem_layout); 155 void arm_bl2_platform_setup(void); 156 void arm_bl2_plat_arch_setup(void); 157 uint32_t arm_get_spsr_for_bl32_entry(void); 158 uint32_t arm_get_spsr_for_bl33_entry(void); 159 160 /* BL2U utility functions */ 161 void arm_bl2u_early_platform_setup(struct meminfo *mem_layout, 162 void *plat_info); 163 void arm_bl2u_platform_setup(void); 164 void arm_bl2u_plat_arch_setup(void); 165 166 /* BL31 utility functions */ 167 void arm_bl31_early_platform_setup(struct bl31_params *from_bl2, 168 void *plat_params_from_bl2); 169 void arm_bl31_platform_setup(void); 170 void arm_bl31_plat_runtime_setup(void); 171 void arm_bl31_plat_arch_setup(void); 172 173 /* TSP utility functions */ 174 void arm_tsp_early_platform_setup(void); 175 176 /* SP_MIN utility functions */ 177 void arm_sp_min_early_platform_setup(void); 178 179 /* FIP TOC validity check */ 180 int arm_io_is_toc_valid(void); 181 182 /* 183 * Mandatory functions required in ARM standard platforms 184 */ 185 unsigned int plat_arm_get_cluster_core_count(u_register_t mpidr); 186 void plat_arm_gic_driver_init(void); 187 void plat_arm_gic_init(void); 188 void plat_arm_gic_cpuif_enable(void); 189 void plat_arm_gic_cpuif_disable(void); 190 void plat_arm_gic_pcpu_init(void); 191 void plat_arm_security_setup(void); 192 void plat_arm_pwrc_setup(void); 193 void plat_arm_interconnect_init(void); 194 void plat_arm_interconnect_enter_coherency(void); 195 void plat_arm_interconnect_exit_coherency(void); 196 197 /* 198 * Optional functions required in ARM standard platforms 199 */ 200 void plat_arm_io_setup(void); 201 int plat_arm_get_alt_image_source( 202 unsigned int image_id, 203 uintptr_t *dev_handle, 204 uintptr_t *image_spec); 205 unsigned int plat_arm_calc_core_pos(u_register_t mpidr); 206 const mmap_region_t *plat_arm_get_mmap(void); 207 208 #endif /* __PLAT_ARM_H__ */ 209