blob: 04f93bd08d58979c742787c9a72d4c2e4e65f651 [file] [log] [blame]
Achin Gupta4f6ad662013-10-25 09:08:21 +01001/*
Harrison Mutaie5249fe2022-12-09 12:14:25 +00002 * Copyright (c) 2013-2023, 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
Antonio Nino Diaz5a42b682018-07-18 11:57:21 +01007#ifndef PSCI_PRIVATE_H
8#define PSCI_PRIVATE_H
Achin Gupta4f6ad662013-10-25 09:08:21 +01009
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000010#include <stdbool.h>
11
Achin Guptaa59caa42013-12-05 14:21:04 +000012#include <arch.h>
Antonio Nino Diazdd0e85c2018-07-17 09:51:33 +010013#include <arch_helpers.h>
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000014#include <common/bl_common.h>
15#include <lib/bakery_lock.h>
16#include <lib/el3_runtime/cpu_data.h>
17#include <lib/psci/psci.h>
18#include <lib/spinlock.h>
Achin Gupta4f6ad662013-10-25 09:08:21 +010019
Soby Mathew6cdddaf2015-01-07 11:10:22 +000020/*
21 * The PSCI capability which are provided by the generic code but does not
22 * depend on the platform or spd capabilities.
23 */
24#define PSCI_GENERIC_CAP \
25 (define_psci_cap(PSCI_VERSION) | \
26 define_psci_cap(PSCI_AFFINITY_INFO_AARCH64) | \
27 define_psci_cap(PSCI_FEATURES))
28
29/*
30 * The PSCI capabilities mask for 64 bit functions.
31 */
32#define PSCI_CAP_64BIT_MASK \
33 (define_psci_cap(PSCI_CPU_SUSPEND_AARCH64) | \
34 define_psci_cap(PSCI_CPU_ON_AARCH64) | \
35 define_psci_cap(PSCI_AFFINITY_INFO_AARCH64) | \
36 define_psci_cap(PSCI_MIG_AARCH64) | \
Soby Mathew96168382014-12-17 14:47:57 +000037 define_psci_cap(PSCI_MIG_INFO_UP_CPU_AARCH64) | \
Jeenu Viswambharan7f03e9d92016-08-03 15:54:50 +010038 define_psci_cap(PSCI_NODE_HW_STATE_AARCH64) | \
Yatharth Kochar241ec6c2016-05-09 18:26:35 +010039 define_psci_cap(PSCI_SYSTEM_SUSPEND_AARCH64) | \
40 define_psci_cap(PSCI_STAT_RESIDENCY_AARCH64) | \
Roberto Vargasb820ad02017-07-26 09:23:09 +010041 define_psci_cap(PSCI_STAT_COUNT_AARCH64) | \
Roberto Vargas653fb8f2017-10-12 10:57:40 +010042 define_psci_cap(PSCI_SYSTEM_RESET2_AARCH64) | \
43 define_psci_cap(PSCI_MEM_CHK_RANGE_AARCH64))
Soby Mathew6cdddaf2015-01-07 11:10:22 +000044
Graeme Gregory1b4938b2020-12-02 16:24:32 +000045/* Internally PSCI uses a uint16_t for various cpu indexes so
46 * define a limit to number of CPUs that can be initialised.
47 */
48#define PSCI_MAX_CPUS_INDEX 0xFFFFU
49
Lucian Paul-Trifu5e685352022-03-02 21:28:24 +000050/* Invalid parent */
51#define PSCI_PARENT_NODE_INVALID 0xFFFFFFFFU
52
Soby Mathew981487a2015-07-13 14:10:57 +010053/*
Antonio Nino Diaz5a42b682018-07-18 11:57:21 +010054 * Helper functions to get/set the fields of PSCI per-cpu data.
Soby Mathew981487a2015-07-13 14:10:57 +010055 */
Antonio Nino Diaz5a42b682018-07-18 11:57:21 +010056static inline void psci_set_aff_info_state(aff_info_state_t aff_state)
57{
58 set_cpu_data(psci_svc_cpu_data.aff_info_state, aff_state);
59}
Soby Mathew981487a2015-07-13 14:10:57 +010060
Antonio Nino Diaz5a42b682018-07-18 11:57:21 +010061static inline aff_info_state_t psci_get_aff_info_state(void)
62{
63 return get_cpu_data(psci_svc_cpu_data.aff_info_state);
64}
65
Deepika Bhavnani79ffab52019-08-27 00:32:24 +030066static inline aff_info_state_t psci_get_aff_info_state_by_idx(unsigned int idx)
Antonio Nino Diaz5a42b682018-07-18 11:57:21 +010067{
Deepika Bhavnani79ffab52019-08-27 00:32:24 +030068 return get_cpu_data_by_index(idx,
Antonio Nino Diaz5a42b682018-07-18 11:57:21 +010069 psci_svc_cpu_data.aff_info_state);
70}
71
Deepika Bhavnani79ffab52019-08-27 00:32:24 +030072static inline void psci_set_aff_info_state_by_idx(unsigned int idx,
Antonio Nino Diaz5a42b682018-07-18 11:57:21 +010073 aff_info_state_t aff_state)
74{
Deepika Bhavnani79ffab52019-08-27 00:32:24 +030075 set_cpu_data_by_index(idx,
Antonio Nino Diaz5a42b682018-07-18 11:57:21 +010076 psci_svc_cpu_data.aff_info_state, aff_state);
77}
78
79static inline unsigned int psci_get_suspend_pwrlvl(void)
80{
81 return get_cpu_data(psci_svc_cpu_data.target_pwrlvl);
82}
Soby Mathew981487a2015-07-13 14:10:57 +010083
Antonio Nino Diaz5a42b682018-07-18 11:57:21 +010084static inline void psci_set_suspend_pwrlvl(unsigned int target_lvl)
85{
86 set_cpu_data(psci_svc_cpu_data.target_pwrlvl, target_lvl);
87}
88
89static inline void psci_set_cpu_local_state(plat_local_state_t state)
90{
91 set_cpu_data(psci_svc_cpu_data.local_state, state);
92}
93
94static inline plat_local_state_t psci_get_cpu_local_state(void)
95{
96 return get_cpu_data(psci_svc_cpu_data.local_state);
97}
98
Deepika Bhavnani79ffab52019-08-27 00:32:24 +030099static inline plat_local_state_t psci_get_cpu_local_state_by_idx(
100 unsigned int idx)
Antonio Nino Diaz5a42b682018-07-18 11:57:21 +0100101{
Deepika Bhavnani79ffab52019-08-27 00:32:24 +0300102 return get_cpu_data_by_index(idx,
Antonio Nino Diaz5a42b682018-07-18 11:57:21 +0100103 psci_svc_cpu_data.local_state);
104}
105
106/* Helper function to identify a CPU standby request in PSCI Suspend call */
Antonio Nino Diazde11a5b2018-08-01 16:42:10 +0100107static inline bool is_cpu_standby_req(unsigned int is_power_down_state,
108 unsigned int retn_lvl)
Antonio Nino Diaz5a42b682018-07-18 11:57:21 +0100109{
Antonio Nino Diazde11a5b2018-08-01 16:42:10 +0100110 return (is_power_down_state == 0U) && (retn_lvl == 0U);
Antonio Nino Diaz5a42b682018-07-18 11:57:21 +0100111}
Soby Mathew6cdddaf2015-01-07 11:10:22 +0000112
Achin Gupta4f6ad662013-10-25 09:08:21 +0100113/*******************************************************************************
Soby Mathew981487a2015-07-13 14:10:57 +0100114 * The following two data structures implement the power domain tree. The tree
115 * is used to track the state of all the nodes i.e. power domain instances
116 * described by the platform. The tree consists of nodes that describe CPU power
117 * domains i.e. leaf nodes and all other power domains which are parents of a
118 * CPU power domain i.e. non-leaf nodes.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100119 ******************************************************************************/
Soby Mathew981487a2015-07-13 14:10:57 +0100120typedef struct non_cpu_pwr_domain_node {
121 /*
122 * Index of the first CPU power domain node level 0 which has this node
123 * as its parent.
124 */
Deepika Bhavnani79ffab52019-08-27 00:32:24 +0300125 unsigned int cpu_start_idx;
Soby Mathew981487a2015-07-13 14:10:57 +0100126
127 /*
128 * Number of CPU power domains which are siblings of the domain indexed
129 * by 'cpu_start_idx' i.e. all the domains in the range 'cpu_start_idx
130 * -> cpu_start_idx + ncpus' have this node as their parent.
131 */
132 unsigned int ncpus;
133
134 /*
135 * Index of the parent power domain node.
136 * TODO: Figure out whether to whether using pointer is more efficient.
137 */
138 unsigned int parent_node;
139
140 plat_local_state_t local_state;
141
Achin Gupta75f73672013-12-05 16:33:10 +0000142 unsigned char level;
Andrew Thoelkee466c9f2015-09-10 11:39:36 +0100143
144 /* For indexing the psci_lock array*/
Graeme Gregory1b4938b2020-12-02 16:24:32 +0000145 uint16_t lock_index;
Soby Mathew981487a2015-07-13 14:10:57 +0100146} non_cpu_pd_node_t;
147
148typedef struct cpu_pwr_domain_node {
Soby Mathew011ca182015-07-29 17:05:03 +0100149 u_register_t mpidr;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100150
Soby Mathew981487a2015-07-13 14:10:57 +0100151 /*
152 * Index of the parent power domain node.
153 * TODO: Figure out whether to whether using pointer is more efficient.
154 */
155 unsigned int parent_node;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100156
Soby Mathew981487a2015-07-13 14:10:57 +0100157 /*
158 * A CPU power domain does not require state coordination like its
159 * parent power domains. Hence this node does not include a bakery
160 * lock. A spinlock is required by the CPU_ON handler to prevent a race
161 * when multiple CPUs try to turn ON the same target CPU.
162 */
163 spinlock_t cpu_lock;
164} cpu_pd_node_t;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100165
Wing Li71f69df2022-09-14 13:18:15 -0700166#if PSCI_OS_INIT_MODE
167/*******************************************************************************
168 * The supported power state coordination modes that can be used in CPU_SUSPEND.
169 ******************************************************************************/
170typedef enum suspend_mode {
171 PLAT_COORD = 0,
172 OS_INIT = 1
173} suspend_mode_t;
174#endif
175
Achin Gupta4f6ad662013-10-25 09:08:21 +0100176/*******************************************************************************
Antonio Nino Diazdd0e85c2018-07-17 09:51:33 +0100177 * The following are helpers and declarations of locks.
178 ******************************************************************************/
179#if HW_ASSISTED_COHERENCY
180/*
181 * On systems where participant CPUs are cache-coherent, we can use spinlocks
182 * instead of bakery locks.
183 */
184#define DEFINE_PSCI_LOCK(_name) spinlock_t _name
185#define DECLARE_PSCI_LOCK(_name) extern DEFINE_PSCI_LOCK(_name)
186
187/* One lock is required per non-CPU power domain node */
188DECLARE_PSCI_LOCK(psci_locks[PSCI_NUM_NON_CPU_PWR_DOMAINS]);
189
190/*
191 * On systems with hardware-assisted coherency, make PSCI cache operations NOP,
192 * as PSCI participants are cache-coherent, and there's no need for explicit
193 * cache maintenance operations or barriers to coordinate their state.
194 */
195static inline void psci_flush_dcache_range(uintptr_t __unused addr,
196 size_t __unused size)
197{
198 /* Empty */
199}
200
201#define psci_flush_cpu_data(member)
202#define psci_inv_cpu_data(member)
203
204static inline void psci_dsbish(void)
205{
206 /* Empty */
207}
208
209static inline void psci_lock_get(non_cpu_pd_node_t *non_cpu_pd_node)
210{
211 spin_lock(&psci_locks[non_cpu_pd_node->lock_index]);
212}
213
214static inline void psci_lock_release(non_cpu_pd_node_t *non_cpu_pd_node)
215{
216 spin_unlock(&psci_locks[non_cpu_pd_node->lock_index]);
217}
218
219#else /* if HW_ASSISTED_COHERENCY == 0 */
220/*
221 * Use bakery locks for state coordination as not all PSCI participants are
222 * cache coherent.
223 */
224#define DEFINE_PSCI_LOCK(_name) DEFINE_BAKERY_LOCK(_name)
225#define DECLARE_PSCI_LOCK(_name) DECLARE_BAKERY_LOCK(_name)
226
227/* One lock is required per non-CPU power domain node */
228DECLARE_PSCI_LOCK(psci_locks[PSCI_NUM_NON_CPU_PWR_DOMAINS]);
229
230/*
231 * If not all PSCI participants are cache-coherent, perform cache maintenance
232 * and issue barriers wherever required to coordinate state.
233 */
234static inline void psci_flush_dcache_range(uintptr_t addr, size_t size)
235{
236 flush_dcache_range(addr, size);
237}
238
239#define psci_flush_cpu_data(member) flush_cpu_data(member)
240#define psci_inv_cpu_data(member) inv_cpu_data(member)
241
242static inline void psci_dsbish(void)
243{
244 dsbish();
245}
246
247static inline void psci_lock_get(non_cpu_pd_node_t *non_cpu_pd_node)
248{
249 bakery_lock_get(&psci_locks[non_cpu_pd_node->lock_index]);
250}
251
252static inline void psci_lock_release(non_cpu_pd_node_t *non_cpu_pd_node)
253{
254 bakery_lock_release(&psci_locks[non_cpu_pd_node->lock_index]);
255}
256
257#endif /* HW_ASSISTED_COHERENCY */
258
259static inline void psci_lock_init(non_cpu_pd_node_t *non_cpu_pd_node,
Graeme Gregory1b4938b2020-12-02 16:24:32 +0000260 uint16_t idx)
Antonio Nino Diazdd0e85c2018-07-17 09:51:33 +0100261{
262 non_cpu_pd_node[idx].lock_index = idx;
263}
264
265/*******************************************************************************
Achin Gupta4f6ad662013-10-25 09:08:21 +0100266 * Data prototypes
267 ******************************************************************************/
Soby Mathew981487a2015-07-13 14:10:57 +0100268extern const plat_psci_ops_t *psci_plat_pm_ops;
269extern non_cpu_pd_node_t psci_non_cpu_pd_nodes[PSCI_NUM_NON_CPU_PWR_DOMAINS];
270extern cpu_pd_node_t psci_cpu_pd_nodes[PLATFORM_CORE_COUNT];
Soby Mathew011ca182015-07-29 17:05:03 +0100271extern unsigned int psci_caps;
Pankaj Gupta02c35682019-10-15 15:44:45 +0530272extern unsigned int psci_plat_core_count;
Wing Li71f69df2022-09-14 13:18:15 -0700273#if PSCI_OS_INIT_MODE
274extern suspend_mode_t psci_suspend_mode;
275#endif
Achin Gupta4f6ad662013-10-25 09:08:21 +0100276
277/*******************************************************************************
Jeenu Viswambharan7f366602014-02-20 17:11:00 +0000278 * SPD's power management hooks registered with PSCI
Achin Gupta607084e2014-02-09 18:24:19 +0000279 ******************************************************************************/
Dan Handleye2712bc2014-04-10 15:37:22 +0100280extern const spd_pm_ops_t *psci_spd_pm;
Achin Gupta607084e2014-02-09 18:24:19 +0000281
282/*******************************************************************************
Achin Gupta4f6ad662013-10-25 09:08:21 +0100283 * Function prototypes
284 ******************************************************************************/
285/* Private exported functions from psci_common.c */
Soby Mathew981487a2015-07-13 14:10:57 +0100286int psci_validate_power_state(unsigned int power_state,
287 psci_power_state_t *state_info);
288void psci_query_sys_suspend_pwrstate(psci_power_state_t *state_info);
Soby Mathew011ca182015-07-29 17:05:03 +0100289int psci_validate_mpidr(u_register_t mpidr);
Soby Mathew981487a2015-07-13 14:10:57 +0100290void psci_init_req_local_pwr_states(void);
Wing Li2c556f32022-09-14 13:18:17 -0700291#if PSCI_OS_INIT_MODE
292void psci_update_req_local_pwr_states(unsigned int end_pwrlvl,
293 unsigned int cpu_idx,
294 psci_power_state_t *state_info,
295 plat_local_state_t *prev);
296void psci_restore_req_local_pwr_states(unsigned int cpu_idx,
297 plat_local_state_t *prev);
298#endif
Achin Gupta9b2bf252016-06-28 16:46:15 +0100299void psci_get_target_local_pwr_states(unsigned int end_pwrlvl,
300 psci_power_state_t *target_state);
Wing Lic0dc6392023-05-04 08:31:19 -0700301void psci_set_target_local_pwr_states(unsigned int end_pwrlvl,
302 const psci_power_state_t *target_state);
Soby Mathewf1f97a12015-07-15 12:13:26 +0100303int psci_validate_entry_point(entry_point_info_t *ep,
Soby Mathew011ca182015-07-29 17:05:03 +0100304 uintptr_t entrypoint, u_register_t context_id);
Deepika Bhavnani79ffab52019-08-27 00:32:24 +0300305void psci_get_parent_pwr_domain_nodes(unsigned int cpu_idx,
Soby Mathew011ca182015-07-29 17:05:03 +0100306 unsigned int end_lvl,
Antonio Nino Diaz78a95a62018-07-17 15:10:08 +0100307 unsigned int *node_index);
Soby Mathew011ca182015-07-29 17:05:03 +0100308void psci_do_state_coordination(unsigned int end_pwrlvl,
Soby Mathew981487a2015-07-13 14:10:57 +0100309 psci_power_state_t *state_info);
Wing Li2c556f32022-09-14 13:18:17 -0700310#if PSCI_OS_INIT_MODE
311int psci_validate_state_coordination(unsigned int end_pwrlvl,
312 psci_power_state_t *state_info);
313#endif
Andrew F. Davis74e89782019-06-04 10:46:54 -0400314void psci_acquire_pwr_domain_locks(unsigned int end_pwrlvl,
315 const unsigned int *parent_nodes);
316void psci_release_pwr_domain_locks(unsigned int end_pwrlvl,
317 const unsigned int *parent_nodes);
Soby Mathew981487a2015-07-13 14:10:57 +0100318int psci_validate_suspend_req(const psci_power_state_t *state_info,
Roberto Vargas777dd432018-02-12 12:36:17 +0000319 unsigned int is_power_down_state);
Soby Mathew981487a2015-07-13 14:10:57 +0100320unsigned int psci_find_max_off_lvl(const psci_power_state_t *state_info);
321unsigned int psci_find_target_suspend_lvl(const psci_power_state_t *state_info);
Soby Mathew011ca182015-07-29 17:05:03 +0100322void psci_set_pwr_domains_to_run(unsigned int end_pwrlvl);
Soby Mathew981487a2015-07-13 14:10:57 +0100323void psci_print_power_domain_map(void);
Jayanth Dodderi Chidanand70763502022-08-22 23:46:10 +0100324bool psci_is_last_on_cpu(void);
Soby Mathew011ca182015-07-29 17:05:03 +0100325int psci_spd_migrate_info(u_register_t *mpidr);
Jeenu Viswambharan346bfd82017-01-05 11:01:02 +0000326
327/*
328 * CPU power down is directly called only when HW_ASSISTED_COHERENCY is
329 * available. Otherwise, this needs post-call stack maintenance, which is
330 * handled in assembly.
331 */
332void prepare_cpu_pwr_dwn(unsigned int power_level);
Achin Gupta0959db52013-12-02 17:33:04 +0000333
Harrison Mutaie5249fe2022-12-09 12:14:25 +0000334/* This function applies various CPU errata during power down. */
335void apply_cpu_pwr_dwn_errata(void);
336
Soby Mathew981487a2015-07-13 14:10:57 +0100337/* Private exported functions from psci_on.c */
Soby Mathewa0fedc42016-06-16 14:52:04 +0100338int psci_cpu_on_start(u_register_t target_cpu,
Antonio Nino Diaz56a0e8e2018-07-16 23:19:25 +0100339 const entry_point_info_t *ep);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100340
Deepika Bhavnani4287c0c2019-12-13 10:23:18 -0600341void psci_cpu_on_finish(unsigned int cpu_idx, const psci_power_state_t *state_info);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100342
Sandrine Bailleuxf4119ec2015-12-17 13:58:58 +0000343/* Private exported functions from psci_off.c */
Soby Mathew011ca182015-07-29 17:05:03 +0100344int psci_do_cpu_off(unsigned int end_pwrlvl);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100345
Sandrine Bailleuxf4119ec2015-12-17 13:58:58 +0000346/* Private exported functions from psci_suspend.c */
Wing Li2c556f32022-09-14 13:18:17 -0700347int psci_cpu_suspend_start(const entry_point_info_t *ep,
348 unsigned int end_pwrlvl,
349 psci_power_state_t *state_info,
350 unsigned int is_power_down_state);
Soby Mathew8595b872015-01-06 15:36:38 +0000351
Deepika Bhavnani4287c0c2019-12-13 10:23:18 -0600352void psci_cpu_suspend_finish(unsigned int cpu_idx, const psci_power_state_t *state_info);
Jeenu Viswambharancaa84932014-02-06 10:36:15 +0000353
Achin Guptae1aa5162014-06-26 09:58:52 +0100354/* Private exported functions from psci_helpers.S */
Soby Mathew011ca182015-07-29 17:05:03 +0100355void psci_do_pwrdown_cache_maintenance(unsigned int pwr_level);
Achin Guptae1aa5162014-06-26 09:58:52 +0100356void psci_do_pwrup_cache_maintenance(void);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100357
Juan Castillo4dc4a472014-08-12 11:17:06 +0100358/* Private exported functions from psci_system_off.c */
359void __dead2 psci_system_off(void);
360void __dead2 psci_system_reset(void);
Antonio Nino Diaz56a0e8e2018-07-16 23:19:25 +0100361u_register_t psci_system_reset2(uint32_t reset_type, u_register_t cookie);
Juan Castillo4dc4a472014-08-12 11:17:06 +0100362
Yatharth Kochar241ec6c2016-05-09 18:26:35 +0100363/* Private exported functions from psci_stat.c */
364void psci_stats_update_pwr_down(unsigned int end_pwrlvl,
365 const psci_power_state_t *state_info);
366void psci_stats_update_pwr_up(unsigned int end_pwrlvl,
dp-arm66abfbe2017-01-31 13:01:04 +0000367 const psci_power_state_t *state_info);
Yatharth Kochar241ec6c2016-05-09 18:26:35 +0100368u_register_t psci_stat_residency(u_register_t target_cpu,
369 unsigned int power_state);
370u_register_t psci_stat_count(u_register_t target_cpu,
371 unsigned int power_state);
372
Roberto Vargas0a4c2612017-08-03 08:16:16 +0100373/* Private exported functions from psci_mem_protect.c */
Antonio Nino Diazf5c60012018-07-16 23:36:10 +0100374u_register_t psci_mem_protect(unsigned int enable);
375u_register_t psci_mem_chk_range(uintptr_t base, u_register_t length);
Roberto Vargas0a4c2612017-08-03 08:16:16 +0100376
Antonio Nino Diaz5a42b682018-07-18 11:57:21 +0100377#endif /* PSCI_PRIVATE_H */