1 /* 2 * Copyright (c) 2013-2017, ARM Limited and Contributors. All rights reserved. 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 */ 6 7 #ifndef __PSCI_PRIVATE_H__ 8 #define __PSCI_PRIVATE_H__ 9 10 #include <arch.h> 11 #include <bakery_lock.h> 12 #include <bl_common.h> 13 #include <cpu_data.h> 14 #include <psci.h> 15 #include <spinlock.h> 16 17 #if HW_ASSISTED_COHERENCY 18 19 /* 20 * On systems with hardware-assisted coherency, make PSCI cache operations NOP, 21 * as PSCI participants are cache-coherent, and there's no need for explicit 22 * cache maintenance operations or barriers to coordinate their state. 23 */ 24 #define psci_flush_dcache_range(addr, size) 25 #define psci_flush_cpu_data(member) 26 #define psci_inv_cpu_data(member) 27 28 #define psci_dsbish() 29 30 /* 31 * On systems where participant CPUs are cache-coherent, we can use spinlocks 32 * instead of bakery locks. 33 */ 34 #define DEFINE_PSCI_LOCK(_name) spinlock_t _name 35 #define DECLARE_PSCI_LOCK(_name) extern DEFINE_PSCI_LOCK(_name) 36 37 #define psci_lock_get(non_cpu_pd_node) \ 38 spin_lock(&psci_locks[(non_cpu_pd_node)->lock_index]) 39 #define psci_lock_release(non_cpu_pd_node) \ 40 spin_unlock(&psci_locks[(non_cpu_pd_node)->lock_index]) 41 42 #else 43 44 /* 45 * If not all PSCI participants are cache-coherent, perform cache maintenance 46 * and issue barriers wherever required to coordinate state. 47 */ 48 #define psci_flush_dcache_range(addr, size) flush_dcache_range(addr, size) 49 #define psci_flush_cpu_data(member) flush_cpu_data(member) 50 #define psci_inv_cpu_data(member) inv_cpu_data(member) 51 52 #define psci_dsbish() dsbish() 53 54 /* 55 * Use bakery locks for state coordination as not all PSCI participants are 56 * cache coherent. 57 */ 58 #define DEFINE_PSCI_LOCK(_name) DEFINE_BAKERY_LOCK(_name) 59 #define DECLARE_PSCI_LOCK(_name) DECLARE_BAKERY_LOCK(_name) 60 61 #define psci_lock_get(non_cpu_pd_node) \ 62 bakery_lock_get(&psci_locks[(non_cpu_pd_node)->lock_index]) 63 #define psci_lock_release(non_cpu_pd_node) \ 64 bakery_lock_release(&psci_locks[(non_cpu_pd_node)->lock_index]) 65 66 #endif 67 68 #define psci_lock_init(non_cpu_pd_node, idx) \ 69 ((non_cpu_pd_node)[(idx)].lock_index = (idx)) 70 71 /* 72 * The PSCI capability which are provided by the generic code but does not 73 * depend on the platform or spd capabilities. 74 */ 75 #define PSCI_GENERIC_CAP \ 76 (define_psci_cap(PSCI_VERSION) | \ 77 define_psci_cap(PSCI_AFFINITY_INFO_AARCH64) | \ 78 define_psci_cap(PSCI_FEATURES)) 79 80 /* 81 * The PSCI capabilities mask for 64 bit functions. 82 */ 83 #define PSCI_CAP_64BIT_MASK \ 84 (define_psci_cap(PSCI_CPU_SUSPEND_AARCH64) | \ 85 define_psci_cap(PSCI_CPU_ON_AARCH64) | \ 86 define_psci_cap(PSCI_AFFINITY_INFO_AARCH64) | \ 87 define_psci_cap(PSCI_MIG_AARCH64) | \ 88 define_psci_cap(PSCI_MIG_INFO_UP_CPU_AARCH64) | \ 89 define_psci_cap(PSCI_NODE_HW_STATE_AARCH64) | \ 90 define_psci_cap(PSCI_SYSTEM_SUSPEND_AARCH64) | \ 91 define_psci_cap(PSCI_STAT_RESIDENCY_AARCH64) | \ 92 define_psci_cap(PSCI_STAT_COUNT_AARCH64)) 93 94 /* 95 * Helper macros to get/set the fields of PSCI per-cpu data. 96 */ 97 #define psci_set_aff_info_state(aff_state) \ 98 set_cpu_data(psci_svc_cpu_data.aff_info_state, aff_state) 99 #define psci_get_aff_info_state() \ 100 get_cpu_data(psci_svc_cpu_data.aff_info_state) 101 #define psci_get_aff_info_state_by_idx(idx) \ 102 get_cpu_data_by_index(idx, psci_svc_cpu_data.aff_info_state) 103 #define psci_set_aff_info_state_by_idx(idx, aff_state) \ 104 set_cpu_data_by_index(idx, psci_svc_cpu_data.aff_info_state,\ 105 aff_state) 106 #define psci_get_suspend_pwrlvl() \ 107 get_cpu_data(psci_svc_cpu_data.target_pwrlvl) 108 #define psci_set_suspend_pwrlvl(target_lvl) \ 109 set_cpu_data(psci_svc_cpu_data.target_pwrlvl, target_lvl) 110 #define psci_set_cpu_local_state(state) \ 111 set_cpu_data(psci_svc_cpu_data.local_state, state) 112 #define psci_get_cpu_local_state() \ 113 get_cpu_data(psci_svc_cpu_data.local_state) 114 #define psci_get_cpu_local_state_by_idx(idx) \ 115 get_cpu_data_by_index(idx, psci_svc_cpu_data.local_state) 116 117 /* 118 * Helper macros for the CPU level spinlocks 119 */ 120 #define psci_spin_lock_cpu(idx) spin_lock(&psci_cpu_pd_nodes[idx].cpu_lock) 121 #define psci_spin_unlock_cpu(idx) spin_unlock(&psci_cpu_pd_nodes[idx].cpu_lock) 122 123 /* Helper macro to identify a CPU standby request in PSCI Suspend call */ 124 #define is_cpu_standby_req(is_power_down_state, retn_lvl) \ 125 (((!(is_power_down_state)) && ((retn_lvl) == 0)) ? 1 : 0) 126 127 /******************************************************************************* 128 * The following two data structures implement the power domain tree. The tree 129 * is used to track the state of all the nodes i.e. power domain instances 130 * described by the platform. The tree consists of nodes that describe CPU power 131 * domains i.e. leaf nodes and all other power domains which are parents of a 132 * CPU power domain i.e. non-leaf nodes. 133 ******************************************************************************/ 134 typedef struct non_cpu_pwr_domain_node { 135 /* 136 * Index of the first CPU power domain node level 0 which has this node 137 * as its parent. 138 */ 139 unsigned int cpu_start_idx; 140 141 /* 142 * Number of CPU power domains which are siblings of the domain indexed 143 * by 'cpu_start_idx' i.e. all the domains in the range 'cpu_start_idx 144 * -> cpu_start_idx + ncpus' have this node as their parent. 145 */ 146 unsigned int ncpus; 147 148 /* 149 * Index of the parent power domain node. 150 * TODO: Figure out whether to whether using pointer is more efficient. 151 */ 152 unsigned int parent_node; 153 154 plat_local_state_t local_state; 155 156 unsigned char level; 157 158 /* For indexing the psci_lock array*/ 159 unsigned char lock_index; 160 } non_cpu_pd_node_t; 161 162 typedef struct cpu_pwr_domain_node { 163 u_register_t mpidr; 164 165 /* 166 * Index of the parent power domain node. 167 * TODO: Figure out whether to whether using pointer is more efficient. 168 */ 169 unsigned int parent_node; 170 171 /* 172 * A CPU power domain does not require state coordination like its 173 * parent power domains. Hence this node does not include a bakery 174 * lock. A spinlock is required by the CPU_ON handler to prevent a race 175 * when multiple CPUs try to turn ON the same target CPU. 176 */ 177 spinlock_t cpu_lock; 178 } cpu_pd_node_t; 179 180 /******************************************************************************* 181 * Data prototypes 182 ******************************************************************************/ 183 extern const plat_psci_ops_t *psci_plat_pm_ops; 184 extern non_cpu_pd_node_t psci_non_cpu_pd_nodes[PSCI_NUM_NON_CPU_PWR_DOMAINS]; 185 extern cpu_pd_node_t psci_cpu_pd_nodes[PLATFORM_CORE_COUNT]; 186 extern unsigned int psci_caps; 187 188 /* One lock is required per non-CPU power domain node */ 189 DECLARE_PSCI_LOCK(psci_locks[PSCI_NUM_NON_CPU_PWR_DOMAINS]); 190 191 /******************************************************************************* 192 * SPD's power management hooks registered with PSCI 193 ******************************************************************************/ 194 extern const spd_pm_ops_t *psci_spd_pm; 195 196 /******************************************************************************* 197 * Function prototypes 198 ******************************************************************************/ 199 /* Private exported functions from psci_common.c */ 200 int psci_validate_power_state(unsigned int power_state, 201 psci_power_state_t *state_info); 202 void psci_query_sys_suspend_pwrstate(psci_power_state_t *state_info); 203 int psci_validate_mpidr(u_register_t mpidr); 204 void psci_init_req_local_pwr_states(void); 205 void psci_get_target_local_pwr_states(unsigned int end_pwrlvl, 206 psci_power_state_t *target_state); 207 int psci_validate_entry_point(entry_point_info_t *ep, 208 uintptr_t entrypoint, u_register_t context_id); 209 void psci_get_parent_pwr_domain_nodes(unsigned int cpu_idx, 210 unsigned int end_lvl, 211 unsigned int node_index[]); 212 void psci_do_state_coordination(unsigned int end_pwrlvl, 213 psci_power_state_t *state_info); 214 void psci_acquire_pwr_domain_locks(unsigned int end_pwrlvl, 215 unsigned int cpu_idx); 216 void psci_release_pwr_domain_locks(unsigned int end_pwrlvl, 217 unsigned int cpu_idx); 218 int psci_validate_suspend_req(const psci_power_state_t *state_info, 219 unsigned int is_power_down_state_req); 220 unsigned int psci_find_max_off_lvl(const psci_power_state_t *state_info); 221 unsigned int psci_find_target_suspend_lvl(const psci_power_state_t *state_info); 222 void psci_set_pwr_domains_to_run(unsigned int end_pwrlvl); 223 void psci_print_power_domain_map(void); 224 unsigned int psci_is_last_on_cpu(void); 225 int psci_spd_migrate_info(u_register_t *mpidr); 226 void psci_do_pwrdown_sequence(unsigned int power_level); 227 228 /* 229 * CPU power down is directly called only when HW_ASSISTED_COHERENCY is 230 * available. Otherwise, this needs post-call stack maintenance, which is 231 * handled in assembly. 232 */ 233 void prepare_cpu_pwr_dwn(unsigned int power_level); 234 235 /* Private exported functions from psci_on.c */ 236 int psci_cpu_on_start(u_register_t target_cpu, 237 entry_point_info_t *ep); 238 239 void psci_cpu_on_finish(unsigned int cpu_idx, 240 psci_power_state_t *state_info); 241 242 /* Private exported functions from psci_off.c */ 243 int psci_do_cpu_off(unsigned int end_pwrlvl); 244 245 /* Private exported functions from psci_suspend.c */ 246 void psci_cpu_suspend_start(entry_point_info_t *ep, 247 unsigned int end_pwrlvl, 248 psci_power_state_t *state_info, 249 unsigned int is_power_down_state_req); 250 251 void psci_cpu_suspend_finish(unsigned int cpu_idx, 252 psci_power_state_t *state_info); 253 254 /* Private exported functions from psci_helpers.S */ 255 void psci_do_pwrdown_cache_maintenance(unsigned int pwr_level); 256 void psci_do_pwrup_cache_maintenance(void); 257 258 /* Private exported functions from psci_system_off.c */ 259 void __dead2 psci_system_off(void); 260 void __dead2 psci_system_reset(void); 261 262 /* Private exported functions from psci_stat.c */ 263 void psci_stats_update_pwr_down(unsigned int end_pwrlvl, 264 const psci_power_state_t *state_info); 265 void psci_stats_update_pwr_up(unsigned int end_pwrlvl, 266 const psci_power_state_t *state_info); 267 u_register_t psci_stat_residency(u_register_t target_cpu, 268 unsigned int power_state); 269 u_register_t psci_stat_count(u_register_t target_cpu, 270 unsigned int power_state); 271 272 /* Private exported functions from psci_mem_protect.c */ 273 int psci_mem_protect(unsigned int enable); 274 int psci_mem_chk_range(uintptr_t base, u_register_t length); 275 276 #endif /* __PSCI_PRIVATE_H__ */ 277