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