blob: da6a20fa4e39ceb24c417252a43daf8ad167e32f [file] [log] [blame]
Achin Gupta4f6ad662013-10-25 09:08:21 +01001/*
dp-arm66abfbe2017-01-31 13:01:04 +00002 * Copyright (c) 2013-2017, ARM Limited and Contributors. All rights reserved.
Achin Gupta4f6ad662013-10-25 09:08:21 +01003 *
dp-armfa3cf0b2017-05-03 09:38:09 +01004 * SPDX-License-Identifier: BSD-3-Clause
Achin Gupta4f6ad662013-10-25 09:08:21 +01005 */
6
7#ifndef __PSCI_PRIVATE_H__
8#define __PSCI_PRIVATE_H__
9
Achin Guptaa59caa42013-12-05 14:21:04 +000010#include <arch.h>
Achin Gupta4f6ad662013-10-25 09:08:21 +010011#include <bakery_lock.h>
Soby Mathew8595b872015-01-06 15:36:38 +000012#include <bl_common.h>
Soby Mathew981487a2015-07-13 14:10:57 +010013#include <cpu_data.h>
Dan Handley2bd4ef22014-04-09 13:14:54 +010014#include <psci.h>
Soby Mathew981487a2015-07-13 14:10:57 +010015#include <spinlock.h>
Achin Gupta4f6ad662013-10-25 09:08:21 +010016
Jeenu Viswambharan0b56d6f2017-01-06 14:58:11 +000017#if HW_ASSISTED_COHERENCY
Jeenu Viswambharan346bfd82017-01-05 11:01:02 +000018
Jeenu Viswambharan0b56d6f2017-01-06 14:58:11 +000019/*
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()
Jeenu Viswambharan346bfd82017-01-05 11:01:02 +000029
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
Jeenu Viswambharan0b56d6f2017-01-06 14:58:11 +000042#else
Jeenu Viswambharan346bfd82017-01-05 11:01:02 +000043
Jeenu Viswambharan0b56d6f2017-01-06 14:58:11 +000044/*
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()
Jeenu Viswambharan0b56d6f2017-01-06 14:58:11 +000053
Soby Mathew523d6332015-01-08 18:02:19 +000054/*
Jeenu Viswambharan346bfd82017-01-05 11:01:02 +000055 * Use bakery locks for state coordination as not all PSCI participants are
56 * cache coherent.
Soby Mathew523d6332015-01-08 18:02:19 +000057 */
Jeenu Viswambharan346bfd82017-01-05 11:01:02 +000058#define DEFINE_PSCI_LOCK(_name) DEFINE_BAKERY_LOCK(_name)
59#define DECLARE_PSCI_LOCK(_name) DECLARE_BAKERY_LOCK(_name)
60
Soby Mathew981487a2015-07-13 14:10:57 +010061#define psci_lock_get(non_cpu_pd_node) \
Andrew Thoelkee466c9f2015-09-10 11:39:36 +010062 bakery_lock_get(&psci_locks[(non_cpu_pd_node)->lock_index])
Soby Mathew981487a2015-07-13 14:10:57 +010063#define psci_lock_release(non_cpu_pd_node) \
Andrew Thoelkee466c9f2015-09-10 11:39:36 +010064 bakery_lock_release(&psci_locks[(non_cpu_pd_node)->lock_index])
Andrew Thoelke56f44702014-06-20 00:36:14 +010065
Jeenu Viswambharan346bfd82017-01-05 11:01:02 +000066#endif
67
68#define psci_lock_init(non_cpu_pd_node, idx) \
69 ((non_cpu_pd_node)[(idx)].lock_index = (idx))
70
Soby Mathew6cdddaf2015-01-07 11:10:22 +000071/*
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) | \
Soby Mathew96168382014-12-17 14:47:57 +000088 define_psci_cap(PSCI_MIG_INFO_UP_CPU_AARCH64) | \
Jeenu Viswambharan7f03e9d92016-08-03 15:54:50 +010089 define_psci_cap(PSCI_NODE_HW_STATE_AARCH64) | \
Yatharth Kochar241ec6c2016-05-09 18:26:35 +010090 define_psci_cap(PSCI_SYSTEM_SUSPEND_AARCH64) | \
91 define_psci_cap(PSCI_STAT_RESIDENCY_AARCH64) | \
92 define_psci_cap(PSCI_STAT_COUNT_AARCH64))
Soby Mathew6cdddaf2015-01-07 11:10:22 +000093
Soby Mathew981487a2015-07-13 14:10:57 +010094/*
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)
Soby Mathewca370502016-01-26 11:47:53 +0000103#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)
Soby Mathew981487a2015-07-13 14:10:57 +0100106#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)
Soby Mathew6cdddaf2015-01-07 11:10:22 +0000126
Achin Gupta4f6ad662013-10-25 09:08:21 +0100127/*******************************************************************************
Soby Mathew981487a2015-07-13 14:10:57 +0100128 * 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.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100133 ******************************************************************************/
Soby Mathew981487a2015-07-13 14:10:57 +0100134typedef 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
Achin Gupta75f73672013-12-05 16:33:10 +0000156 unsigned char level;
Andrew Thoelkee466c9f2015-09-10 11:39:36 +0100157
158 /* For indexing the psci_lock array*/
Soby Mathew981487a2015-07-13 14:10:57 +0100159 unsigned char lock_index;
Soby Mathew981487a2015-07-13 14:10:57 +0100160} non_cpu_pd_node_t;
161
162typedef struct cpu_pwr_domain_node {
Soby Mathew011ca182015-07-29 17:05:03 +0100163 u_register_t mpidr;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100164
Soby Mathew981487a2015-07-13 14:10:57 +0100165 /*
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;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100170
Soby Mathew981487a2015-07-13 14:10:57 +0100171 /*
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;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100179
180/*******************************************************************************
181 * Data prototypes
182 ******************************************************************************/
Soby Mathew981487a2015-07-13 14:10:57 +0100183extern const plat_psci_ops_t *psci_plat_pm_ops;
184extern non_cpu_pd_node_t psci_non_cpu_pd_nodes[PSCI_NUM_NON_CPU_PWR_DOMAINS];
185extern cpu_pd_node_t psci_cpu_pd_nodes[PLATFORM_CORE_COUNT];
Soby Mathew011ca182015-07-29 17:05:03 +0100186extern unsigned int psci_caps;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100187
Jeenu Viswambharan346bfd82017-01-05 11:01:02 +0000188/* One lock is required per non-CPU power domain node */
189DECLARE_PSCI_LOCK(psci_locks[PSCI_NUM_NON_CPU_PWR_DOMAINS]);
Andrew Thoelkee466c9f2015-09-10 11:39:36 +0100190
Achin Gupta4f6ad662013-10-25 09:08:21 +0100191/*******************************************************************************
Jeenu Viswambharan7f366602014-02-20 17:11:00 +0000192 * SPD's power management hooks registered with PSCI
Achin Gupta607084e2014-02-09 18:24:19 +0000193 ******************************************************************************/
Dan Handleye2712bc2014-04-10 15:37:22 +0100194extern const spd_pm_ops_t *psci_spd_pm;
Achin Gupta607084e2014-02-09 18:24:19 +0000195
196/*******************************************************************************
Achin Gupta4f6ad662013-10-25 09:08:21 +0100197 * Function prototypes
198 ******************************************************************************/
199/* Private exported functions from psci_common.c */
Soby Mathew981487a2015-07-13 14:10:57 +0100200int psci_validate_power_state(unsigned int power_state,
201 psci_power_state_t *state_info);
202void psci_query_sys_suspend_pwrstate(psci_power_state_t *state_info);
Soby Mathew011ca182015-07-29 17:05:03 +0100203int psci_validate_mpidr(u_register_t mpidr);
Soby Mathew981487a2015-07-13 14:10:57 +0100204void psci_init_req_local_pwr_states(void);
Achin Gupta9b2bf252016-06-28 16:46:15 +0100205void psci_get_target_local_pwr_states(unsigned int end_pwrlvl,
206 psci_power_state_t *target_state);
Soby Mathewf1f97a12015-07-15 12:13:26 +0100207int psci_validate_entry_point(entry_point_info_t *ep,
Soby Mathew011ca182015-07-29 17:05:03 +0100208 uintptr_t entrypoint, u_register_t context_id);
Soby Mathew981487a2015-07-13 14:10:57 +0100209void psci_get_parent_pwr_domain_nodes(unsigned int cpu_idx,
Soby Mathew011ca182015-07-29 17:05:03 +0100210 unsigned int end_lvl,
Soby Mathew981487a2015-07-13 14:10:57 +0100211 unsigned int node_index[]);
Soby Mathew011ca182015-07-29 17:05:03 +0100212void psci_do_state_coordination(unsigned int end_pwrlvl,
Soby Mathew981487a2015-07-13 14:10:57 +0100213 psci_power_state_t *state_info);
Soby Mathew011ca182015-07-29 17:05:03 +0100214void psci_acquire_pwr_domain_locks(unsigned int end_pwrlvl,
Soby Mathew981487a2015-07-13 14:10:57 +0100215 unsigned int cpu_idx);
Soby Mathew011ca182015-07-29 17:05:03 +0100216void psci_release_pwr_domain_locks(unsigned int end_pwrlvl,
Soby Mathew981487a2015-07-13 14:10:57 +0100217 unsigned int cpu_idx);
218int psci_validate_suspend_req(const psci_power_state_t *state_info,
219 unsigned int is_power_down_state_req);
220unsigned int psci_find_max_off_lvl(const psci_power_state_t *state_info);
221unsigned int psci_find_target_suspend_lvl(const psci_power_state_t *state_info);
Soby Mathew011ca182015-07-29 17:05:03 +0100222void psci_set_pwr_domains_to_run(unsigned int end_pwrlvl);
Soby Mathew981487a2015-07-13 14:10:57 +0100223void psci_print_power_domain_map(void);
Soby Mathew96168382014-12-17 14:47:57 +0000224unsigned int psci_is_last_on_cpu(void);
Soby Mathew011ca182015-07-29 17:05:03 +0100225int psci_spd_migrate_info(u_register_t *mpidr);
Jeenu Viswambharan346bfd82017-01-05 11:01:02 +0000226void 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 */
233void prepare_cpu_pwr_dwn(unsigned int power_level);
Achin Gupta0959db52013-12-02 17:33:04 +0000234
Soby Mathew981487a2015-07-13 14:10:57 +0100235/* Private exported functions from psci_on.c */
Soby Mathewa0fedc42016-06-16 14:52:04 +0100236int psci_cpu_on_start(u_register_t target_cpu,
Sandrine Bailleux7497bff2016-04-25 09:28:43 +0100237 entry_point_info_t *ep);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100238
Soby Mathew981487a2015-07-13 14:10:57 +0100239void psci_cpu_on_finish(unsigned int cpu_idx,
240 psci_power_state_t *state_info);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100241
Sandrine Bailleuxf4119ec2015-12-17 13:58:58 +0000242/* Private exported functions from psci_off.c */
Soby Mathew011ca182015-07-29 17:05:03 +0100243int psci_do_cpu_off(unsigned int end_pwrlvl);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100244
Sandrine Bailleuxf4119ec2015-12-17 13:58:58 +0000245/* Private exported functions from psci_suspend.c */
Soby Mathew981487a2015-07-13 14:10:57 +0100246void psci_cpu_suspend_start(entry_point_info_t *ep,
Soby Mathew011ca182015-07-29 17:05:03 +0100247 unsigned int end_pwrlvl,
Soby Mathew981487a2015-07-13 14:10:57 +0100248 psci_power_state_t *state_info,
249 unsigned int is_power_down_state_req);
Soby Mathew8595b872015-01-06 15:36:38 +0000250
Soby Mathew981487a2015-07-13 14:10:57 +0100251void psci_cpu_suspend_finish(unsigned int cpu_idx,
252 psci_power_state_t *state_info);
Jeenu Viswambharancaa84932014-02-06 10:36:15 +0000253
Achin Guptae1aa5162014-06-26 09:58:52 +0100254/* Private exported functions from psci_helpers.S */
Soby Mathew011ca182015-07-29 17:05:03 +0100255void psci_do_pwrdown_cache_maintenance(unsigned int pwr_level);
Achin Guptae1aa5162014-06-26 09:58:52 +0100256void psci_do_pwrup_cache_maintenance(void);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100257
Juan Castillo4dc4a472014-08-12 11:17:06 +0100258/* Private exported functions from psci_system_off.c */
259void __dead2 psci_system_off(void);
260void __dead2 psci_system_reset(void);
261
Yatharth Kochar241ec6c2016-05-09 18:26:35 +0100262/* Private exported functions from psci_stat.c */
263void psci_stats_update_pwr_down(unsigned int end_pwrlvl,
264 const psci_power_state_t *state_info);
265void psci_stats_update_pwr_up(unsigned int end_pwrlvl,
dp-arm66abfbe2017-01-31 13:01:04 +0000266 const psci_power_state_t *state_info);
Yatharth Kochar241ec6c2016-05-09 18:26:35 +0100267u_register_t psci_stat_residency(u_register_t target_cpu,
268 unsigned int power_state);
269u_register_t psci_stat_count(u_register_t target_cpu,
270 unsigned int power_state);
271
Achin Gupta4f6ad662013-10-25 09:08:21 +0100272#endif /* __PSCI_PRIVATE_H__ */