blob: 4c2601eca142b27483f7eb263229b1fb24387818 [file] [log] [blame]
Achin Gupta4f6ad662013-10-25 09:08:21 +01001/*
Boyan Karatotev3b802102024-11-06 16:26:15 +00002 * Copyright (c) 2013-2025, Arm Limited and Contributors. All rights reserved.
Achin Gupta4f6ad662013-10-25 09:08:21 +01003 *
dp-arm82cb2c12017-05-03 09:38:09 +01004 * SPDX-License-Identifier: BSD-3-Clause
Achin Gupta4f6ad662013-10-25 09:08:21 +01005 */
6
Antonio Nino Diaz09d40e02018-12-14 00:18:21 +00007#include <assert.h>
8#include <string.h>
9
Dan Handley97043ac2014-04-09 13:14:54 +010010#include <arch.h>
Jayanth Dodderi Chidanand777f1f62023-07-18 14:48:09 +010011#include <arch_features.h>
Achin Gupta4f6ad662013-10-25 09:08:21 +010012#include <arch_helpers.h>
Antonio Nino Diaz09d40e02018-12-14 00:18:21 +000013#include <common/bl_common.h>
14#include <common/debug.h>
Dan Handley97043ac2014-04-09 13:14:54 +010015#include <context.h>
Sandeep Tripathy22744902020-08-17 20:22:13 +053016#include <drivers/delay_timer.h>
Antonio Nino Diaz09d40e02018-12-14 00:18:21 +000017#include <lib/el3_runtime/context_mgmt.h>
Jayanth Dodderi Chidanand777f1f62023-07-18 14:48:09 +010018#include <lib/extensions/spe.h>
Boyan Karatotev9b1e8002024-10-10 08:11:09 +010019#include <lib/pmf/pmf.h>
20#include <lib/runtime_instr.h>
Antonio Nino Diaz09d40e02018-12-14 00:18:21 +000021#include <lib/utils.h>
22#include <plat/common/platform.h>
23
Dan Handley35e98e52014-04-09 13:13:04 +010024#include "psci_private.h"
Achin Gupta4f6ad662013-10-25 09:08:21 +010025
Achin Gupta607084e2014-02-09 18:24:19 +000026/*
Jeenu Viswambharan7f366602014-02-20 17:11:00 +000027 * SPD power management operations, expected to be supplied by the registered
28 * SPD on successful SP initialization
Achin Gupta607084e2014-02-09 18:24:19 +000029 */
Dan Handleyfb037bf2014-04-10 15:37:22 +010030const spd_pm_ops_t *psci_spd_pm;
Achin Gupta607084e2014-02-09 18:24:19 +000031
Soby Mathew67487842015-07-13 14:10:57 +010032/*
33 * PSCI requested local power state map. This array is used to store the local
34 * power states requested by a CPU for power levels from level 1 to
35 * PLAT_MAX_PWR_LVL. It does not store the requested local power state for power
36 * level 0 (PSCI_CPU_PWR_LVL) as the requested and the target power state for a
37 * CPU are the same.
38 *
39 * During state coordination, the platform is passed an array containing the
40 * local states requested for a particular non cpu power domain by each cpu
41 * within the domain.
42 *
43 * TODO: Dense packing of the requested states will cause cache thrashing
44 * when multiple power domains write to it. If we allocate the requested
45 * states at each power level in a cache-line aligned per-domain memory,
46 * the cache thrashing can be avoided.
47 */
48static plat_local_state_t
49 psci_req_local_pwr_states[PLAT_MAX_PWR_LVL][PLATFORM_CORE_COUNT];
50
Pankaj Guptaab4df502019-10-15 15:44:45 +053051unsigned int psci_plat_core_count;
Soby Mathew67487842015-07-13 14:10:57 +010052
Achin Gupta4f6ad662013-10-25 09:08:21 +010053/*******************************************************************************
Soby Mathew67487842015-07-13 14:10:57 +010054 * Arrays that hold the platform's power domain tree information for state
55 * management of power domains.
56 * Each node in the array 'psci_non_cpu_pd_nodes' corresponds to a power domain
57 * which is an ancestor of a CPU power domain.
58 * Each node in the array 'psci_cpu_pd_nodes' corresponds to a cpu power domain
Achin Gupta4f6ad662013-10-25 09:08:21 +010059 ******************************************************************************/
Soby Mathew67487842015-07-13 14:10:57 +010060non_cpu_pd_node_t psci_non_cpu_pd_nodes[PSCI_NUM_NON_CPU_PWR_DOMAINS]
Soby Mathewab8707e2015-01-08 18:02:44 +000061#if USE_COHERENT_MEM
Chris Kayda043412023-02-14 11:30:04 +000062__section(".tzfw_coherent_mem")
Soby Mathewab8707e2015-01-08 18:02:44 +000063#endif
64;
Achin Gupta4f6ad662013-10-25 09:08:21 +010065
Jeenu Viswambharanb0408e82017-01-05 11:01:02 +000066/* Lock for PSCI state coordination */
67DEFINE_PSCI_LOCK(psci_locks[PSCI_NUM_NON_CPU_PWR_DOMAINS]);
Andrew Thoelkeee7b35c2015-09-10 11:39:36 +010068
Soby Mathew67487842015-07-13 14:10:57 +010069cpu_pd_node_t psci_cpu_pd_nodes[PLATFORM_CORE_COUNT];
70
Achin Gupta4f6ad662013-10-25 09:08:21 +010071/*******************************************************************************
Achin Gupta4f6ad662013-10-25 09:08:21 +010072 * Pointer to functions exported by the platform to complete power mgmt. ops
73 ******************************************************************************/
Soby Mathew67487842015-07-13 14:10:57 +010074const plat_psci_ops_t *psci_plat_pm_ops;
Achin Gupta4f6ad662013-10-25 09:08:21 +010075
Soby Mathew67487842015-07-13 14:10:57 +010076/******************************************************************************
77 * Check that the maximum power level supported by the platform makes sense
78 *****************************************************************************/
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +010079CASSERT((PLAT_MAX_PWR_LVL <= PSCI_MAX_PWR_LVL) &&
80 (PLAT_MAX_PWR_LVL >= PSCI_CPU_PWR_LVL),
81 assert_platform_max_pwrlvl_check);
Soby Mathew8c32bc22015-02-12 14:45:02 +000082
Wing Lib88a4412022-09-14 13:18:15 -070083#if PSCI_OS_INIT_MODE
84/*******************************************************************************
85 * The power state coordination mode used in CPU_SUSPEND.
86 * Defaults to platform-coordinated mode.
87 ******************************************************************************/
88suspend_mode_t psci_suspend_mode = PLAT_COORD;
89#endif
90
Soby Mathew67487842015-07-13 14:10:57 +010091/*
92 * The plat_local_state used by the platform is one of these types: RUN,
93 * RETENTION and OFF. The platform can define further sub-states for each type
94 * apart from RUN. This categorization is done to verify the sanity of the
95 * psci_power_state passed by the platform and to print debug information. The
96 * categorization is done on the basis of the following conditions:
97 *
98 * 1. If (plat_local_state == 0) then the category is STATE_TYPE_RUN.
99 *
100 * 2. If (0 < plat_local_state <= PLAT_MAX_RET_STATE), then the category is
101 * STATE_TYPE_RETN.
102 *
103 * 3. If (plat_local_state > PLAT_MAX_RET_STATE), then the category is
104 * STATE_TYPE_OFF.
105 */
106typedef enum plat_local_state_type {
107 STATE_TYPE_RUN = 0,
108 STATE_TYPE_RETN,
109 STATE_TYPE_OFF
110} plat_local_state_type_t;
111
Antonio Nino Diaz97373c32018-07-18 11:57:21 +0100112/* Function used to categorize plat_local_state. */
113static plat_local_state_type_t find_local_state_type(plat_local_state_t state)
114{
115 if (state != 0U) {
116 if (state > PLAT_MAX_RET_STATE) {
117 return STATE_TYPE_OFF;
118 } else {
119 return STATE_TYPE_RETN;
120 }
121 } else {
122 return STATE_TYPE_RUN;
123 }
124}
Soby Mathew67487842015-07-13 14:10:57 +0100125
126/******************************************************************************
127 * Check that the maximum retention level supported by the platform is less
128 * than the maximum off level.
129 *****************************************************************************/
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100130CASSERT(PLAT_MAX_RET_STATE < PLAT_MAX_OFF_STATE,
Soby Mathew67487842015-07-13 14:10:57 +0100131 assert_platform_max_off_and_retn_state_check);
132
133/******************************************************************************
134 * This function ensures that the power state parameter in a CPU_SUSPEND request
135 * is valid. If so, it returns the requested states for each power level.
136 *****************************************************************************/
137int psci_validate_power_state(unsigned int power_state,
138 psci_power_state_t *state_info)
Achin Gupta0a46e2c2014-07-31 11:19:11 +0100139{
Soby Mathew67487842015-07-13 14:10:57 +0100140 /* Check SBZ bits in power state are zero */
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100141 if (psci_check_power_state(power_state) != 0U)
Soby Mathew67487842015-07-13 14:10:57 +0100142 return PSCI_E_INVALID_PARAMS;
Achin Gupta0a46e2c2014-07-31 11:19:11 +0100143
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100144 assert(psci_plat_pm_ops->validate_power_state != NULL);
Achin Gupta0a46e2c2014-07-31 11:19:11 +0100145
Soby Mathew67487842015-07-13 14:10:57 +0100146 /* Validate the power_state using platform pm_ops */
147 return psci_plat_pm_ops->validate_power_state(power_state, state_info);
148}
Achin Gupta0a46e2c2014-07-31 11:19:11 +0100149
Soby Mathew67487842015-07-13 14:10:57 +0100150/******************************************************************************
151 * This function retrieves the `psci_power_state_t` for system suspend from
152 * the platform.
153 *****************************************************************************/
154void psci_query_sys_suspend_pwrstate(psci_power_state_t *state_info)
155{
156 /*
157 * Assert that the required pm_ops hook is implemented to ensure that
158 * the capability detected during psci_setup() is valid.
159 */
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100160 assert(psci_plat_pm_ops->get_sys_suspend_power_state != NULL);
Soby Mathew67487842015-07-13 14:10:57 +0100161
162 /*
163 * Query the platform for the power_state required for system suspend
164 */
165 psci_plat_pm_ops->get_sys_suspend_power_state(state_info);
Achin Gupta0a46e2c2014-07-31 11:19:11 +0100166}
167
Wing Li606b7432022-09-14 13:18:17 -0700168#if PSCI_OS_INIT_MODE
169/*******************************************************************************
170 * This function verifies that all the other cores at the 'end_pwrlvl' have been
171 * idled and the current CPU is the last running CPU at the 'end_pwrlvl'.
172 * Returns 1 (true) if the current CPU is the last ON CPU or 0 (false)
173 * otherwise.
174 ******************************************************************************/
Boyan Karatotev3b802102024-11-06 16:26:15 +0000175static bool psci_is_last_cpu_to_idle_at_pwrlvl(unsigned int my_idx, unsigned int end_pwrlvl)
Wing Li606b7432022-09-14 13:18:17 -0700176{
Boyan Karatotev3b802102024-11-06 16:26:15 +0000177 unsigned int lvl;
Mark Dykes152ad112024-04-08 13:38:01 -0500178 unsigned int parent_idx = 0;
Wing Li606b7432022-09-14 13:18:17 -0700179 unsigned int cpu_start_idx, ncpus, cpu_idx;
180 plat_local_state_t local_state;
181
182 if (end_pwrlvl == PSCI_CPU_PWR_LVL) {
183 return true;
184 }
185
Charlie Bareham01959a12023-10-17 20:17:58 +0200186 parent_idx = psci_cpu_pd_nodes[my_idx].parent_node;
187 for (lvl = PSCI_CPU_PWR_LVL + U(1); lvl < end_pwrlvl; lvl++) {
188 parent_idx = psci_non_cpu_pd_nodes[parent_idx].parent_node;
Wing Li606b7432022-09-14 13:18:17 -0700189 }
190
191 cpu_start_idx = psci_non_cpu_pd_nodes[parent_idx].cpu_start_idx;
192 ncpus = psci_non_cpu_pd_nodes[parent_idx].ncpus;
193
194 for (cpu_idx = cpu_start_idx; cpu_idx < cpu_start_idx + ncpus;
195 cpu_idx++) {
196 local_state = psci_get_cpu_local_state_by_idx(cpu_idx);
197 if (cpu_idx == my_idx) {
198 assert(is_local_state_run(local_state) != 0);
199 continue;
200 }
201
202 if (is_local_state_run(local_state) != 0) {
203 return false;
204 }
205 }
206
207 return true;
208}
209#endif
210
Achin Gupta0a46e2c2014-07-31 11:19:11 +0100211/*******************************************************************************
Wing Lib88a4412022-09-14 13:18:15 -0700212 * This function verifies that all the other cores in the system have been
Soby Mathewc0aff0e2014-12-17 14:47:57 +0000213 * turned OFF and the current CPU is the last running CPU in the system.
Jayanth Dodderi Chidanandb41b0822022-08-22 23:46:10 +0100214 * Returns true, if the current CPU is the last ON CPU or false otherwise.
Soby Mathewc0aff0e2014-12-17 14:47:57 +0000215 ******************************************************************************/
Boyan Karatotev3b802102024-11-06 16:26:15 +0000216bool psci_is_last_on_cpu(unsigned int my_idx)
Soby Mathewc0aff0e2014-12-17 14:47:57 +0000217{
Boyan Karatotev3b802102024-11-06 16:26:15 +0000218 for (unsigned int cpu_idx = 0; cpu_idx < psci_plat_core_count; cpu_idx++) {
Soby Mathew67487842015-07-13 14:10:57 +0100219 if (cpu_idx == my_idx) {
220 assert(psci_get_aff_info_state() == AFF_STATE_ON);
Soby Mathewc0aff0e2014-12-17 14:47:57 +0000221 continue;
222 }
223
Jayanth Dodderi Chidanandb41b0822022-08-22 23:46:10 +0100224 if (psci_get_aff_info_state_by_idx(cpu_idx) != AFF_STATE_OFF) {
225 VERBOSE("core=%u other than current core=%u %s\n",
226 cpu_idx, my_idx, "running in the system");
227 return false;
228 }
Soby Mathewc0aff0e2014-12-17 14:47:57 +0000229 }
230
Jayanth Dodderi Chidanandb41b0822022-08-22 23:46:10 +0100231 return true;
Soby Mathewc0aff0e2014-12-17 14:47:57 +0000232}
233
234/*******************************************************************************
Wing Lib88a4412022-09-14 13:18:15 -0700235 * This function verifies that all cores in the system have been turned ON.
236 * Returns true, if all CPUs are ON or false otherwise.
237 ******************************************************************************/
238static bool psci_are_all_cpus_on(void)
239{
240 unsigned int cpu_idx;
241
242 for (cpu_idx = 0; cpu_idx < psci_plat_core_count; cpu_idx++) {
243 if (psci_get_aff_info_state_by_idx(cpu_idx) == AFF_STATE_OFF) {
244 return false;
245 }
246 }
247
248 return true;
249}
250
251/*******************************************************************************
Soby Mathew67487842015-07-13 14:10:57 +0100252 * Routine to return the maximum power level to traverse to after a cpu has
Achin Guptaa45e3972013-12-05 15:10:48 +0000253 * been physically powered up. It is expected to be called immediately after
Achin Gupta776b68a2014-07-25 14:52:47 +0100254 * reset from assembler code.
Achin Guptaa45e3972013-12-05 15:10:48 +0000255 ******************************************************************************/
Soby Mathew9d070b92015-07-29 17:05:03 +0100256static unsigned int get_power_on_target_pwrlvl(void)
Achin Guptaa45e3972013-12-05 15:10:48 +0000257{
Soby Mathew9d070b92015-07-29 17:05:03 +0100258 unsigned int pwrlvl;
Achin Guptaa45e3972013-12-05 15:10:48 +0000259
260 /*
Soby Mathew67487842015-07-13 14:10:57 +0100261 * Assume that this cpu was suspended and retrieve its target power
Boyan Karatotev0c836552024-09-30 11:31:55 +0100262 * level. If it wasn't, the cpu is off so this will be PLAT_MAX_PWR_LVL.
Achin Gupta776b68a2014-07-25 14:52:47 +0100263 */
Soby Mathew67487842015-07-13 14:10:57 +0100264 pwrlvl = psci_get_suspend_pwrlvl();
Deepika Bhavnani0c411c72019-08-17 01:10:02 +0300265 assert(pwrlvl < PSCI_INVALID_PWR_LVL);
Soby Mathew67487842015-07-13 14:10:57 +0100266 return pwrlvl;
Achin Guptaa45e3972013-12-05 15:10:48 +0000267}
268
Soby Mathew67487842015-07-13 14:10:57 +0100269/******************************************************************************
270 * Helper function to update the requested local power state array. This array
271 * does not store the requested state for the CPU power level. Hence an
Deepika Bhavnani41af0512019-08-15 00:56:46 +0300272 * assertion is added to prevent us from accessing the CPU power level.
Soby Mathew67487842015-07-13 14:10:57 +0100273 *****************************************************************************/
274static void psci_set_req_local_pwr_state(unsigned int pwrlvl,
275 unsigned int cpu_idx,
276 plat_local_state_t req_pwr_state)
Achin Gupta4f6ad662013-10-25 09:08:21 +0100277{
Soby Mathew67487842015-07-13 14:10:57 +0100278 assert(pwrlvl > PSCI_CPU_PWR_LVL);
Deepika Bhavnani41af0512019-08-15 00:56:46 +0300279 if ((pwrlvl > PSCI_CPU_PWR_LVL) && (pwrlvl <= PLAT_MAX_PWR_LVL) &&
Pankaj Guptaab4df502019-10-15 15:44:45 +0530280 (cpu_idx < psci_plat_core_count)) {
Deepika Bhavnani41af0512019-08-15 00:56:46 +0300281 psci_req_local_pwr_states[pwrlvl - 1U][cpu_idx] = req_pwr_state;
282 }
Soby Mathew67487842015-07-13 14:10:57 +0100283}
Achin Gupta4f6ad662013-10-25 09:08:21 +0100284
Soby Mathew67487842015-07-13 14:10:57 +0100285/******************************************************************************
286 * This function initializes the psci_req_local_pwr_states.
287 *****************************************************************************/
Daniel Boulby87c85132018-09-20 14:12:46 +0100288void __init psci_init_req_local_pwr_states(void)
Soby Mathew67487842015-07-13 14:10:57 +0100289{
290 /* Initialize the requested state of all non CPU power domains as OFF */
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100291 unsigned int pwrlvl;
Pankaj Guptaab4df502019-10-15 15:44:45 +0530292 unsigned int core;
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100293
294 for (pwrlvl = 0U; pwrlvl < PLAT_MAX_PWR_LVL; pwrlvl++) {
Pankaj Guptaab4df502019-10-15 15:44:45 +0530295 for (core = 0; core < psci_plat_core_count; core++) {
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100296 psci_req_local_pwr_states[pwrlvl][core] =
297 PLAT_MAX_OFF_STATE;
298 }
299 }
Soby Mathew67487842015-07-13 14:10:57 +0100300}
301
302/******************************************************************************
303 * Helper function to return a reference to an array containing the local power
304 * states requested by each cpu for a power domain at 'pwrlvl'. The size of the
305 * array will be the number of cpu power domains of which this power domain is
306 * an ancestor. These requested states will be used to determine a suitable
307 * target state for this power domain during psci state coordination. An
308 * assertion is added to prevent us from accessing the CPU power level.
309 *****************************************************************************/
Soby Mathew9d070b92015-07-29 17:05:03 +0100310static plat_local_state_t *psci_get_req_local_pwr_states(unsigned int pwrlvl,
Deepika Bhavnanifc810212019-08-27 00:32:24 +0300311 unsigned int cpu_idx)
Soby Mathew67487842015-07-13 14:10:57 +0100312{
313 assert(pwrlvl > PSCI_CPU_PWR_LVL);
314
Deepika Bhavnani41af0512019-08-15 00:56:46 +0300315 if ((pwrlvl > PSCI_CPU_PWR_LVL) && (pwrlvl <= PLAT_MAX_PWR_LVL) &&
Pankaj Guptaab4df502019-10-15 15:44:45 +0530316 (cpu_idx < psci_plat_core_count)) {
Deepika Bhavnani41af0512019-08-15 00:56:46 +0300317 return &psci_req_local_pwr_states[pwrlvl - 1U][cpu_idx];
318 } else
319 return NULL;
Soby Mathew67487842015-07-13 14:10:57 +0100320}
321
Wing Li606b7432022-09-14 13:18:17 -0700322#if PSCI_OS_INIT_MODE
323/******************************************************************************
324 * Helper function to save a copy of the psci_req_local_pwr_states (prev) for a
325 * CPU (cpu_idx), and update psci_req_local_pwr_states with the new requested
326 * local power states (state_info).
327 *****************************************************************************/
328void psci_update_req_local_pwr_states(unsigned int end_pwrlvl,
329 unsigned int cpu_idx,
330 psci_power_state_t *state_info,
331 plat_local_state_t *prev)
332{
333 unsigned int lvl;
334#ifdef PLAT_MAX_CPU_SUSPEND_PWR_LVL
335 unsigned int max_pwrlvl = PLAT_MAX_CPU_SUSPEND_PWR_LVL;
336#else
337 unsigned int max_pwrlvl = PLAT_MAX_PWR_LVL;
338#endif
339 plat_local_state_t req_state;
340
341 for (lvl = PSCI_CPU_PWR_LVL + 1U; lvl <= max_pwrlvl; lvl++) {
342 /* Save the previous requested local power state */
343 prev[lvl - 1U] = *psci_get_req_local_pwr_states(lvl, cpu_idx);
344
345 /* Update the new requested local power state */
346 if (lvl <= end_pwrlvl) {
347 req_state = state_info->pwr_domain_state[lvl];
348 } else {
349 req_state = state_info->pwr_domain_state[end_pwrlvl];
350 }
351 psci_set_req_local_pwr_state(lvl, cpu_idx, req_state);
352 }
353}
354
355/******************************************************************************
356 * Helper function to restore the previously saved requested local power states
357 * (prev) for a CPU (cpu_idx) to psci_req_local_pwr_states.
358 *****************************************************************************/
359void psci_restore_req_local_pwr_states(unsigned int cpu_idx,
360 plat_local_state_t *prev)
361{
362 unsigned int lvl;
363#ifdef PLAT_MAX_CPU_SUSPEND_PWR_LVL
364 unsigned int max_pwrlvl = PLAT_MAX_CPU_SUSPEND_PWR_LVL;
365#else
366 unsigned int max_pwrlvl = PLAT_MAX_PWR_LVL;
367#endif
368
369 for (lvl = PSCI_CPU_PWR_LVL + 1U; lvl <= max_pwrlvl; lvl++) {
370 /* Restore the previous requested local power state */
371 psci_set_req_local_pwr_state(lvl, cpu_idx, prev[lvl - 1U]);
372 }
373}
374#endif
375
Jeenu Viswambharana10d3632017-01-06 14:58:11 +0000376/*
377 * psci_non_cpu_pd_nodes can be placed either in normal memory or coherent
378 * memory.
379 *
380 * With !USE_COHERENT_MEM, psci_non_cpu_pd_nodes is placed in normal memory,
381 * it's accessed by both cached and non-cached participants. To serve the common
382 * minimum, perform a cache flush before read and after write so that non-cached
383 * participants operate on latest data in main memory.
384 *
385 * When USE_COHERENT_MEM is used, psci_non_cpu_pd_nodes is placed in coherent
386 * memory. With HW_ASSISTED_COHERENCY, all PSCI participants are cache-coherent.
387 * In both cases, no cache operations are required.
388 */
389
390/*
391 * Retrieve local state of non-CPU power domain node from a non-cached CPU,
392 * after any required cache maintenance operation.
393 */
394static plat_local_state_t get_non_cpu_pd_node_local_state(
395 unsigned int parent_idx)
396{
Andrew F. Davisf996a5f2018-08-30 12:13:57 -0500397#if !(USE_COHERENT_MEM || HW_ASSISTED_COHERENCY || WARMBOOT_ENABLE_DCACHE_EARLY)
Jeenu Viswambharana10d3632017-01-06 14:58:11 +0000398 flush_dcache_range(
399 (uintptr_t) &psci_non_cpu_pd_nodes[parent_idx],
400 sizeof(psci_non_cpu_pd_nodes[parent_idx]));
401#endif
402 return psci_non_cpu_pd_nodes[parent_idx].local_state;
403}
404
405/*
406 * Update local state of non-CPU power domain node from a cached CPU; perform
407 * any required cache maintenance operation afterwards.
408 */
409static void set_non_cpu_pd_node_local_state(unsigned int parent_idx,
410 plat_local_state_t state)
411{
412 psci_non_cpu_pd_nodes[parent_idx].local_state = state;
Andrew F. Davisf996a5f2018-08-30 12:13:57 -0500413#if !(USE_COHERENT_MEM || HW_ASSISTED_COHERENCY || WARMBOOT_ENABLE_DCACHE_EARLY)
Jeenu Viswambharana10d3632017-01-06 14:58:11 +0000414 flush_dcache_range(
415 (uintptr_t) &psci_non_cpu_pd_nodes[parent_idx],
416 sizeof(psci_non_cpu_pd_nodes[parent_idx]));
417#endif
418}
419
Soby Mathew67487842015-07-13 14:10:57 +0100420/******************************************************************************
421 * Helper function to return the current local power state of each power domain
422 * from the current cpu power domain to its ancestor at the 'end_pwrlvl'. This
423 * function will be called after a cpu is powered on to find the local state
424 * each power domain has emerged from.
425 *****************************************************************************/
Boyan Karatotev3b802102024-11-06 16:26:15 +0000426void psci_get_target_local_pwr_states(unsigned int cpu_idx, unsigned int end_pwrlvl,
Achin Gupta61eae522016-06-28 16:46:15 +0100427 psci_power_state_t *target_state)
Soby Mathew67487842015-07-13 14:10:57 +0100428{
Soby Mathew9d070b92015-07-29 17:05:03 +0100429 unsigned int parent_idx, lvl;
Soby Mathew67487842015-07-13 14:10:57 +0100430 plat_local_state_t *pd_state = target_state->pwr_domain_state;
431
432 pd_state[PSCI_CPU_PWR_LVL] = psci_get_cpu_local_state();
Boyan Karatotev3b802102024-11-06 16:26:15 +0000433 parent_idx = psci_cpu_pd_nodes[cpu_idx].parent_node;
Soby Mathew67487842015-07-13 14:10:57 +0100434
435 /* Copy the local power state from node to state_info */
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100436 for (lvl = PSCI_CPU_PWR_LVL + 1U; lvl <= end_pwrlvl; lvl++) {
Jeenu Viswambharana10d3632017-01-06 14:58:11 +0000437 pd_state[lvl] = get_non_cpu_pd_node_local_state(parent_idx);
Soby Mathew67487842015-07-13 14:10:57 +0100438 parent_idx = psci_non_cpu_pd_nodes[parent_idx].parent_node;
439 }
440
441 /* Set the the higher levels to RUN */
442 for (; lvl <= PLAT_MAX_PWR_LVL; lvl++)
443 target_state->pwr_domain_state[lvl] = PSCI_LOCAL_STATE_RUN;
444}
445
446/******************************************************************************
447 * Helper function to set the target local power state that each power domain
448 * from the current cpu power domain to its ancestor at the 'end_pwrlvl' will
449 * enter. This function will be called after coordination of requested power
450 * states has been done for each power level.
451 *****************************************************************************/
Boyan Karatotev3b802102024-11-06 16:26:15 +0000452void psci_set_target_local_pwr_states(unsigned int cpu_idx, unsigned int end_pwrlvl,
Wing Lid3488612023-05-04 08:31:19 -0700453 const psci_power_state_t *target_state)
Soby Mathew67487842015-07-13 14:10:57 +0100454{
Soby Mathew9d070b92015-07-29 17:05:03 +0100455 unsigned int parent_idx, lvl;
Soby Mathew67487842015-07-13 14:10:57 +0100456 const plat_local_state_t *pd_state = target_state->pwr_domain_state;
457
458 psci_set_cpu_local_state(pd_state[PSCI_CPU_PWR_LVL]);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100459
460 /*
Jeenu Viswambharana10d3632017-01-06 14:58:11 +0000461 * Need to flush as local_state might be accessed with Data Cache
Soby Mathew67487842015-07-13 14:10:57 +0100462 * disabled during power on
Achin Gupta4f6ad662013-10-25 09:08:21 +0100463 */
Jeenu Viswambharana10d3632017-01-06 14:58:11 +0000464 psci_flush_cpu_data(psci_svc_cpu_data.local_state);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100465
Boyan Karatotev3b802102024-11-06 16:26:15 +0000466 parent_idx = psci_cpu_pd_nodes[cpu_idx].parent_node;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100467
Soby Mathew67487842015-07-13 14:10:57 +0100468 /* Copy the local_state from state_info */
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100469 for (lvl = 1U; lvl <= end_pwrlvl; lvl++) {
Jeenu Viswambharana10d3632017-01-06 14:58:11 +0000470 set_non_cpu_pd_node_local_state(parent_idx, pd_state[lvl]);
Soby Mathew67487842015-07-13 14:10:57 +0100471 parent_idx = psci_non_cpu_pd_nodes[parent_idx].parent_node;
472 }
Achin Gupta4f6ad662013-10-25 09:08:21 +0100473}
474
475/*******************************************************************************
Soby Mathew67487842015-07-13 14:10:57 +0100476 * PSCI helper function to get the parent nodes corresponding to a cpu_index.
Achin Gupta0959db52013-12-02 17:33:04 +0000477 ******************************************************************************/
Deepika Bhavnanifc810212019-08-27 00:32:24 +0300478void psci_get_parent_pwr_domain_nodes(unsigned int cpu_idx,
Soby Mathew9d070b92015-07-29 17:05:03 +0100479 unsigned int end_lvl,
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100480 unsigned int *node_index)
Achin Gupta0959db52013-12-02 17:33:04 +0000481{
Soby Mathew67487842015-07-13 14:10:57 +0100482 unsigned int parent_node = psci_cpu_pd_nodes[cpu_idx].parent_node;
Varun Wadekar6311f632017-06-07 09:57:42 -0700483 unsigned int i;
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100484 unsigned int *node = node_index;
Soby Mathew67487842015-07-13 14:10:57 +0100485
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100486 for (i = PSCI_CPU_PWR_LVL + 1U; i <= end_lvl; i++) {
487 *node = parent_node;
488 node++;
Soby Mathew67487842015-07-13 14:10:57 +0100489 parent_node = psci_non_cpu_pd_nodes[parent_node].parent_node;
490 }
491}
492
493/******************************************************************************
494 * This function is invoked post CPU power up and initialization. It sets the
495 * affinity info state, target power state and requested power state for the
496 * current CPU and all its ancestor power domains to RUN.
497 *****************************************************************************/
Boyan Karatotev3b802102024-11-06 16:26:15 +0000498void psci_set_pwr_domains_to_run(unsigned int cpu_idx, unsigned int end_pwrlvl)
Soby Mathew67487842015-07-13 14:10:57 +0100499{
Boyan Karatotev3b802102024-11-06 16:26:15 +0000500 unsigned int parent_idx, lvl;
Soby Mathew67487842015-07-13 14:10:57 +0100501 parent_idx = psci_cpu_pd_nodes[cpu_idx].parent_node;
502
503 /* Reset the local_state to RUN for the non cpu power domains. */
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100504 for (lvl = PSCI_CPU_PWR_LVL + 1U; lvl <= end_pwrlvl; lvl++) {
Jeenu Viswambharana10d3632017-01-06 14:58:11 +0000505 set_non_cpu_pd_node_local_state(parent_idx,
506 PSCI_LOCAL_STATE_RUN);
Soby Mathew67487842015-07-13 14:10:57 +0100507 psci_set_req_local_pwr_state(lvl,
508 cpu_idx,
509 PSCI_LOCAL_STATE_RUN);
510 parent_idx = psci_non_cpu_pd_nodes[parent_idx].parent_node;
511 }
512
513 /* Set the affinity info state to ON */
514 psci_set_aff_info_state(AFF_STATE_ON);
515
516 psci_set_cpu_local_state(PSCI_LOCAL_STATE_RUN);
Jeenu Viswambharana10d3632017-01-06 14:58:11 +0000517 psci_flush_cpu_data(psci_svc_cpu_data);
Soby Mathew67487842015-07-13 14:10:57 +0100518}
519
520/******************************************************************************
Wing Li606b7432022-09-14 13:18:17 -0700521 * This function is used in platform-coordinated mode.
522 *
Soby Mathew67487842015-07-13 14:10:57 +0100523 * This function is passed the local power states requested for each power
524 * domain (state_info) between the current CPU domain and its ancestors until
525 * the target power level (end_pwrlvl). It updates the array of requested power
526 * states with this information.
527 *
528 * Then, for each level (apart from the CPU level) until the 'end_pwrlvl', it
529 * retrieves the states requested by all the cpus of which the power domain at
530 * that level is an ancestor. It passes this information to the platform to
531 * coordinate and return the target power state. If the target state for a level
532 * is RUN then subsequent levels are not considered. At the CPU level, state
533 * coordination is not required. Hence, the requested and the target states are
534 * the same.
535 *
536 * The 'state_info' is updated with the target state for each level between the
537 * CPU and the 'end_pwrlvl' and returned to the caller.
538 *
539 * This function will only be invoked with data cache enabled and while
540 * powering down a core.
541 *****************************************************************************/
Boyan Karatotev3b802102024-11-06 16:26:15 +0000542void psci_do_state_coordination(unsigned int cpu_idx, unsigned int end_pwrlvl,
Soby Mathew9d070b92015-07-29 17:05:03 +0100543 psci_power_state_t *state_info)
Soby Mathew67487842015-07-13 14:10:57 +0100544{
Boyan Karatotev3b802102024-11-06 16:26:15 +0000545 unsigned int lvl, parent_idx;
Deepika Bhavnanifc810212019-08-27 00:32:24 +0300546 unsigned int start_idx;
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100547 unsigned int ncpus;
Soby Mathew67487842015-07-13 14:10:57 +0100548 plat_local_state_t target_state, *req_states;
549
Soby Mathew6d189692016-02-02 14:23:10 +0000550 assert(end_pwrlvl <= PLAT_MAX_PWR_LVL);
Soby Mathew67487842015-07-13 14:10:57 +0100551 parent_idx = psci_cpu_pd_nodes[cpu_idx].parent_node;
552
553 /* For level 0, the requested state will be equivalent
554 to target state */
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100555 for (lvl = PSCI_CPU_PWR_LVL + 1U; lvl <= end_pwrlvl; lvl++) {
Soby Mathew67487842015-07-13 14:10:57 +0100556
557 /* First update the requested power state */
558 psci_set_req_local_pwr_state(lvl, cpu_idx,
559 state_info->pwr_domain_state[lvl]);
560
561 /* Get the requested power states for this power level */
562 start_idx = psci_non_cpu_pd_nodes[parent_idx].cpu_start_idx;
563 req_states = psci_get_req_local_pwr_states(lvl, start_idx);
564
565 /*
566 * Let the platform coordinate amongst the requested states at
567 * this power level and return the target local power state.
568 */
569 ncpus = psci_non_cpu_pd_nodes[parent_idx].ncpus;
570 target_state = plat_get_target_pwr_state(lvl,
571 req_states,
572 ncpus);
573
574 state_info->pwr_domain_state[lvl] = target_state;
575
576 /* Break early if the negotiated target power state is RUN */
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100577 if (is_local_state_run(state_info->pwr_domain_state[lvl]) != 0)
Soby Mathew67487842015-07-13 14:10:57 +0100578 break;
579
580 parent_idx = psci_non_cpu_pd_nodes[parent_idx].parent_node;
581 }
582
583 /*
584 * This is for cases when we break out of the above loop early because
585 * the target power state is RUN at a power level < end_pwlvl.
586 * We update the requested power state from state_info and then
587 * set the target state as RUN.
588 */
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100589 for (lvl = lvl + 1U; lvl <= end_pwrlvl; lvl++) {
Soby Mathew67487842015-07-13 14:10:57 +0100590 psci_set_req_local_pwr_state(lvl, cpu_idx,
591 state_info->pwr_domain_state[lvl]);
592 state_info->pwr_domain_state[lvl] = PSCI_LOCAL_STATE_RUN;
593
594 }
Soby Mathew67487842015-07-13 14:10:57 +0100595}
596
Wing Li606b7432022-09-14 13:18:17 -0700597#if PSCI_OS_INIT_MODE
598/******************************************************************************
599 * This function is used in OS-initiated mode.
600 *
601 * This function is passed the local power states requested for each power
602 * domain (state_info) between the current CPU domain and its ancestors until
603 * the target power level (end_pwrlvl), and ensures the requested power states
604 * are valid. It updates the array of requested power states with this
605 * information.
606 *
607 * Then, for each level (apart from the CPU level) until the 'end_pwrlvl', it
608 * retrieves the states requested by all the cpus of which the power domain at
609 * that level is an ancestor. It passes this information to the platform to
610 * coordinate and return the target power state. If the requested state does
611 * not match the target state, the request is denied.
612 *
613 * The 'state_info' is not modified.
614 *
615 * This function will only be invoked with data cache enabled and while
616 * powering down a core.
617 *****************************************************************************/
Boyan Karatotev3b802102024-11-06 16:26:15 +0000618int psci_validate_state_coordination(unsigned int cpu_idx, unsigned int end_pwrlvl,
Wing Li606b7432022-09-14 13:18:17 -0700619 psci_power_state_t *state_info)
620{
621 int rc = PSCI_E_SUCCESS;
Boyan Karatotev3b802102024-11-06 16:26:15 +0000622 unsigned int lvl, parent_idx;
Wing Li606b7432022-09-14 13:18:17 -0700623 unsigned int start_idx;
624 unsigned int ncpus;
625 plat_local_state_t target_state, *req_states;
626 plat_local_state_t prev[PLAT_MAX_PWR_LVL];
627
628 assert(end_pwrlvl <= PLAT_MAX_PWR_LVL);
629 parent_idx = psci_cpu_pd_nodes[cpu_idx].parent_node;
630
631 /*
632 * Save a copy of the previous requested local power states and update
633 * the new requested local power states.
634 */
635 psci_update_req_local_pwr_states(end_pwrlvl, cpu_idx, state_info, prev);
636
637 for (lvl = PSCI_CPU_PWR_LVL + 1U; lvl <= end_pwrlvl; lvl++) {
638 /* Get the requested power states for this power level */
639 start_idx = psci_non_cpu_pd_nodes[parent_idx].cpu_start_idx;
640 req_states = psci_get_req_local_pwr_states(lvl, start_idx);
641
642 /*
643 * Let the platform coordinate amongst the requested states at
644 * this power level and return the target local power state.
645 */
646 ncpus = psci_non_cpu_pd_nodes[parent_idx].ncpus;
647 target_state = plat_get_target_pwr_state(lvl,
648 req_states,
649 ncpus);
650
651 /*
652 * Verify that the requested power state matches the target
653 * local power state.
654 */
655 if (state_info->pwr_domain_state[lvl] != target_state) {
656 if (target_state == PSCI_LOCAL_STATE_RUN) {
657 rc = PSCI_E_DENIED;
658 } else {
659 rc = PSCI_E_INVALID_PARAMS;
660 }
661 goto exit;
662 }
Patrick Delaunay412d92f2023-10-17 20:05:52 +0200663
664 parent_idx = psci_non_cpu_pd_nodes[parent_idx].parent_node;
Wing Li606b7432022-09-14 13:18:17 -0700665 }
666
667 /*
668 * Verify that the current core is the last running core at the
669 * specified power level.
670 */
671 lvl = state_info->last_at_pwrlvl;
Boyan Karatotev3b802102024-11-06 16:26:15 +0000672 if (!psci_is_last_cpu_to_idle_at_pwrlvl(cpu_idx, lvl)) {
Wing Li606b7432022-09-14 13:18:17 -0700673 rc = PSCI_E_DENIED;
674 }
675
676exit:
677 if (rc != PSCI_E_SUCCESS) {
678 /* Restore the previous requested local power states. */
679 psci_restore_req_local_pwr_states(cpu_idx, prev);
680 return rc;
681 }
682
Wing Li606b7432022-09-14 13:18:17 -0700683 return rc;
684}
685#endif
686
Soby Mathew67487842015-07-13 14:10:57 +0100687/******************************************************************************
688 * This function validates a suspend request by making sure that if a standby
689 * state is requested then no power level is turned off and the highest power
690 * level is placed in a standby/retention state.
691 *
692 * It also ensures that the state level X will enter is not shallower than the
693 * state level X + 1 will enter.
694 *
695 * This validation will be enabled only for DEBUG builds as the platform is
696 * expected to perform these validations as well.
697 *****************************************************************************/
698int psci_validate_suspend_req(const psci_power_state_t *state_info,
699 unsigned int is_power_down_state)
700{
701 unsigned int max_off_lvl, target_lvl, max_retn_lvl;
702 plat_local_state_t state;
703 plat_local_state_type_t req_state_type, deepest_state_type;
704 int i;
705
706 /* Find the target suspend power level */
707 target_lvl = psci_find_target_suspend_lvl(state_info);
Soby Mathew9d070b92015-07-29 17:05:03 +0100708 if (target_lvl == PSCI_INVALID_PWR_LVL)
Achin Gupta0959db52013-12-02 17:33:04 +0000709 return PSCI_E_INVALID_PARAMS;
710
Soby Mathew67487842015-07-13 14:10:57 +0100711 /* All power domain levels are in a RUN state to begin with */
712 deepest_state_type = STATE_TYPE_RUN;
Achin Gupta0959db52013-12-02 17:33:04 +0000713
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100714 for (i = (int) target_lvl; i >= (int) PSCI_CPU_PWR_LVL; i--) {
Soby Mathew67487842015-07-13 14:10:57 +0100715 state = state_info->pwr_domain_state[i];
716 req_state_type = find_local_state_type(state);
717
718 /*
719 * While traversing from the highest power level to the lowest,
720 * the state requested for lower levels has to be the same or
721 * deeper i.e. equal to or greater than the state at the higher
722 * levels. If this condition is true, then the requested state
723 * becomes the deepest state encountered so far.
724 */
725 if (req_state_type < deepest_state_type)
726 return PSCI_E_INVALID_PARAMS;
727 deepest_state_type = req_state_type;
728 }
729
730 /* Find the highest off power level */
731 max_off_lvl = psci_find_max_off_lvl(state_info);
732
733 /* The target_lvl is either equal to the max_off_lvl or max_retn_lvl */
Soby Mathew9d070b92015-07-29 17:05:03 +0100734 max_retn_lvl = PSCI_INVALID_PWR_LVL;
Soby Mathew67487842015-07-13 14:10:57 +0100735 if (target_lvl != max_off_lvl)
736 max_retn_lvl = target_lvl;
737
738 /*
739 * If this is not a request for a power down state then max off level
740 * has to be invalid and max retention level has to be a valid power
741 * level.
742 */
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100743 if ((is_power_down_state == 0U) &&
744 ((max_off_lvl != PSCI_INVALID_PWR_LVL) ||
745 (max_retn_lvl == PSCI_INVALID_PWR_LVL)))
Achin Gupta0959db52013-12-02 17:33:04 +0000746 return PSCI_E_INVALID_PARAMS;
747
748 return PSCI_E_SUCCESS;
749}
750
Soby Mathew67487842015-07-13 14:10:57 +0100751/******************************************************************************
752 * This function finds the highest power level which will be powered down
753 * amongst all the power levels specified in the 'state_info' structure
754 *****************************************************************************/
755unsigned int psci_find_max_off_lvl(const psci_power_state_t *state_info)
Achin Gupta84c9f102014-07-28 00:09:01 +0100756{
Soby Mathew67487842015-07-13 14:10:57 +0100757 int i;
Achin Gupta84c9f102014-07-28 00:09:01 +0100758
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100759 for (i = (int) PLAT_MAX_PWR_LVL; i >= (int) PSCI_CPU_PWR_LVL; i--) {
760 if (is_local_state_off(state_info->pwr_domain_state[i]) != 0)
761 return (unsigned int) i;
Achin Gupta84c9f102014-07-28 00:09:01 +0100762 }
Soby Mathew67487842015-07-13 14:10:57 +0100763
Soby Mathew9d070b92015-07-29 17:05:03 +0100764 return PSCI_INVALID_PWR_LVL;
Soby Mathew67487842015-07-13 14:10:57 +0100765}
766
767/******************************************************************************
768 * This functions finds the level of the highest power domain which will be
769 * placed in a low power state during a suspend operation.
770 *****************************************************************************/
771unsigned int psci_find_target_suspend_lvl(const psci_power_state_t *state_info)
772{
773 int i;
774
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100775 for (i = (int) PLAT_MAX_PWR_LVL; i >= (int) PSCI_CPU_PWR_LVL; i--) {
776 if (is_local_state_run(state_info->pwr_domain_state[i]) == 0)
777 return (unsigned int) i;
Soby Mathew67487842015-07-13 14:10:57 +0100778 }
779
Soby Mathew9d070b92015-07-29 17:05:03 +0100780 return PSCI_INVALID_PWR_LVL;
Achin Gupta84c9f102014-07-28 00:09:01 +0100781}
782
783/*******************************************************************************
Andrew F. Davis74d27d02019-06-04 10:46:54 -0400784 * This function is passed the highest level in the topology tree that the
785 * operation should be applied to and a list of node indexes. It picks up locks
786 * from the node index list in order of increasing power domain level in the
787 * range specified.
Achin Gupta0959db52013-12-02 17:33:04 +0000788 ******************************************************************************/
Andrew F. Davis74d27d02019-06-04 10:46:54 -0400789void psci_acquire_pwr_domain_locks(unsigned int end_pwrlvl,
790 const unsigned int *parent_nodes)
Achin Gupta0959db52013-12-02 17:33:04 +0000791{
Andrew F. Davis74d27d02019-06-04 10:46:54 -0400792 unsigned int parent_idx;
Soby Mathew9d070b92015-07-29 17:05:03 +0100793 unsigned int level;
Achin Gupta0959db52013-12-02 17:33:04 +0000794
Soby Mathew67487842015-07-13 14:10:57 +0100795 /* No locking required for level 0. Hence start locking from level 1 */
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100796 for (level = PSCI_CPU_PWR_LVL + 1U; level <= end_pwrlvl; level++) {
Andrew F. Davis74d27d02019-06-04 10:46:54 -0400797 parent_idx = parent_nodes[level - 1U];
Soby Mathew67487842015-07-13 14:10:57 +0100798 psci_lock_get(&psci_non_cpu_pd_nodes[parent_idx]);
Achin Gupta0959db52013-12-02 17:33:04 +0000799 }
800}
801
802/*******************************************************************************
Andrew F. Davis74d27d02019-06-04 10:46:54 -0400803 * This function is passed the highest level in the topology tree that the
804 * operation should be applied to and a list of node indexes. It releases the
805 * locks in order of decreasing power domain level in the range specified.
Achin Gupta0959db52013-12-02 17:33:04 +0000806 ******************************************************************************/
Andrew F. Davis74d27d02019-06-04 10:46:54 -0400807void psci_release_pwr_domain_locks(unsigned int end_pwrlvl,
808 const unsigned int *parent_nodes)
Achin Gupta0959db52013-12-02 17:33:04 +0000809{
Andrew F. Davis74d27d02019-06-04 10:46:54 -0400810 unsigned int parent_idx;
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100811 unsigned int level;
Achin Gupta0959db52013-12-02 17:33:04 +0000812
Soby Mathew67487842015-07-13 14:10:57 +0100813 /* Unlock top down. No unlocking required for level 0. */
Zelalem2fe75a22020-02-12 10:37:03 -0600814 for (level = end_pwrlvl; level >= (PSCI_CPU_PWR_LVL + 1U); level--) {
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100815 parent_idx = parent_nodes[level - 1U];
Soby Mathew67487842015-07-13 14:10:57 +0100816 psci_lock_release(&psci_non_cpu_pd_nodes[parent_idx]);
Achin Gupta0959db52013-12-02 17:33:04 +0000817 }
818}
819
820/*******************************************************************************
Andrew Thoelke167a9352014-06-04 21:10:52 +0100821 * This function determines the full entrypoint information for the requested
Soby Mathew78879b92015-01-06 15:36:38 +0000822 * PSCI entrypoint on power on/resume and returns it.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100823 ******************************************************************************/
Julius Werner402b3cf2019-07-09 14:02:43 -0700824#ifdef __aarch64__
Soby Mathew617540d2015-07-15 12:13:26 +0100825static int psci_get_ns_ep_info(entry_point_info_t *ep,
Soby Mathew9d070b92015-07-29 17:05:03 +0100826 uintptr_t entrypoint,
827 u_register_t context_id)
Achin Gupta4f6ad662013-10-25 09:08:21 +0100828{
Soby Mathew4c0d0392016-06-16 14:52:04 +0100829 u_register_t ep_attr, sctlr;
Soby Mathew9d070b92015-07-29 17:05:03 +0100830 unsigned int daif, ee, mode;
Soby Mathew4c0d0392016-06-16 14:52:04 +0100831 u_register_t ns_scr_el3 = read_scr_el3();
832 u_register_t ns_sctlr_el1 = read_sctlr_el1();
Achin Gupta4f6ad662013-10-25 09:08:21 +0100833
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100834 sctlr = ((ns_scr_el3 & SCR_HCE_BIT) != 0U) ?
835 read_sctlr_el2() : ns_sctlr_el1;
Andrew Thoelke167a9352014-06-04 21:10:52 +0100836 ee = 0;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100837
Andrew Thoelke167a9352014-06-04 21:10:52 +0100838 ep_attr = NON_SECURE | EP_ST_DISABLE;
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100839 if ((sctlr & SCTLR_EE_BIT) != 0U) {
Andrew Thoelke167a9352014-06-04 21:10:52 +0100840 ep_attr |= EP_EE_BIG;
841 ee = 1;
842 }
Soby Mathew78879b92015-01-06 15:36:38 +0000843 SET_PARAM_HEAD(ep, PARAM_EP, VERSION_1, ep_attr);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100844
Soby Mathew78879b92015-01-06 15:36:38 +0000845 ep->pc = entrypoint;
Douglas Raillard32f0d3c2017-01-26 15:54:44 +0000846 zeromem(&ep->args, sizeof(ep->args));
Soby Mathew78879b92015-01-06 15:36:38 +0000847 ep->args.arg0 = context_id;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100848
849 /*
850 * Figure out whether the cpu enters the non-secure address space
851 * in aarch32 or aarch64
852 */
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100853 if ((ns_scr_el3 & SCR_RW_BIT) != 0U) {
Achin Gupta4f6ad662013-10-25 09:08:21 +0100854
855 /*
856 * Check whether a Thumb entry point has been provided for an
857 * aarch64 EL
858 */
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100859 if ((entrypoint & 0x1UL) != 0UL)
Soby Mathew617540d2015-07-15 12:13:26 +0100860 return PSCI_E_INVALID_ADDRESS;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100861
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100862 mode = ((ns_scr_el3 & SCR_HCE_BIT) != 0U) ? MODE_EL2 : MODE_EL1;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100863
Jimmy Brissond7b5f402020-08-04 16:18:52 -0500864 ep->spsr = SPSR_64((uint64_t)mode, MODE_SP_ELX,
865 DISABLE_ALL_EXCEPTIONS);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100866 } else {
867
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100868 mode = ((ns_scr_el3 & SCR_HCE_BIT) != 0U) ?
869 MODE32_hyp : MODE32_svc;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100870
871 /*
872 * TODO: Choose async. exception bits if HYP mode is not
873 * implemented according to the values of SCR.{AW, FW} bits
874 */
Vikram Kanigiri23ff9ba2014-05-13 14:42:08 +0100875 daif = DAIF_ABT_BIT | DAIF_IRQ_BIT | DAIF_FIQ_BIT;
876
Jimmy Brissond7b5f402020-08-04 16:18:52 -0500877 ep->spsr = SPSR_MODE32((uint64_t)mode, entrypoint & 0x1, ee,
878 daif);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100879 }
880
Andrew Thoelke167a9352014-06-04 21:10:52 +0100881 return PSCI_E_SUCCESS;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100882}
Julius Werner402b3cf2019-07-09 14:02:43 -0700883#else /* !__aarch64__ */
884static int psci_get_ns_ep_info(entry_point_info_t *ep,
885 uintptr_t entrypoint,
886 u_register_t context_id)
887{
888 u_register_t ep_attr;
889 unsigned int aif, ee, mode;
890 u_register_t scr = read_scr();
891 u_register_t ns_sctlr, sctlr;
892
893 /* Switch to non secure state */
894 write_scr(scr | SCR_NS_BIT);
895 isb();
896 ns_sctlr = read_sctlr();
897
898 sctlr = scr & SCR_HCE_BIT ? read_hsctlr() : ns_sctlr;
899
900 /* Return to original state */
901 write_scr(scr);
902 isb();
903 ee = 0;
904
905 ep_attr = NON_SECURE | EP_ST_DISABLE;
906 if (sctlr & SCTLR_EE_BIT) {
907 ep_attr |= EP_EE_BIG;
908 ee = 1;
909 }
910 SET_PARAM_HEAD(ep, PARAM_EP, VERSION_1, ep_attr);
911
912 ep->pc = entrypoint;
913 zeromem(&ep->args, sizeof(ep->args));
914 ep->args.arg0 = context_id;
915
916 mode = scr & SCR_HCE_BIT ? MODE32_hyp : MODE32_svc;
917
918 /*
919 * TODO: Choose async. exception bits if HYP mode is not
920 * implemented according to the values of SCR.{AW, FW} bits
921 */
922 aif = SPSR_ABT_BIT | SPSR_IRQ_BIT | SPSR_FIQ_BIT;
923
924 ep->spsr = SPSR_MODE32(mode, entrypoint & 0x1, ee, aif);
925
926 return PSCI_E_SUCCESS;
927}
928
929#endif /* __aarch64__ */
Achin Gupta4f6ad662013-10-25 09:08:21 +0100930
931/*******************************************************************************
Soby Mathew617540d2015-07-15 12:13:26 +0100932 * This function validates the entrypoint with the platform layer if the
933 * appropriate pm_ops hook is exported by the platform and returns the
934 * 'entry_point_info'.
935 ******************************************************************************/
936int psci_validate_entry_point(entry_point_info_t *ep,
Soby Mathew9d070b92015-07-29 17:05:03 +0100937 uintptr_t entrypoint,
938 u_register_t context_id)
Soby Mathew617540d2015-07-15 12:13:26 +0100939{
940 int rc;
941
942 /* Validate the entrypoint using platform psci_ops */
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100943 if (psci_plat_pm_ops->validate_ns_entrypoint != NULL) {
Soby Mathew617540d2015-07-15 12:13:26 +0100944 rc = psci_plat_pm_ops->validate_ns_entrypoint(entrypoint);
945 if (rc != PSCI_E_SUCCESS)
946 return PSCI_E_INVALID_ADDRESS;
947 }
948
949 /*
950 * Verify and derive the re-entry information for
951 * the non-secure world from the non-secure state from
952 * where this call originated.
953 */
954 rc = psci_get_ns_ep_info(ep, entrypoint, context_id);
955 return rc;
956}
957
958/*******************************************************************************
Achin Gupta4f6ad662013-10-25 09:08:21 +0100959 * Generic handler which is called when a cpu is physically powered on. It
Soby Mathew67487842015-07-13 14:10:57 +0100960 * traverses the node information and finds the highest power level powered
961 * off and performs generic, architectural, platform setup and state management
962 * to power on that power level and power levels below it.
963 * e.g. For a cpu that's been powered on, it will call the platform specific
964 * code to enable the gic cpu interface and for a cluster it will enable
965 * coherency at the interconnect level in addition to gic cpu interface.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100966 ******************************************************************************/
Soby Mathewcf0b1492016-04-29 19:01:30 +0100967void psci_warmboot_entrypoint(void)
Achin Gupta4f6ad662013-10-25 09:08:21 +0100968{
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100969 unsigned int end_pwrlvl;
Deepika Bhavnanifc810212019-08-27 00:32:24 +0300970 unsigned int cpu_idx = plat_my_core_pos();
Andrew F. Davis74d27d02019-06-04 10:46:54 -0400971 unsigned int parent_nodes[PLAT_MAX_PWR_LVL] = {0};
Soby Mathew67487842015-07-13 14:10:57 +0100972 psci_power_state_t state_info = { {PSCI_LOCAL_STATE_RUN} };
Achin Gupta4f6ad662013-10-25 09:08:21 +0100973
Boyan Karatotev24a70732023-03-08 11:56:49 +0000974 /* Init registers that never change for the lifetime of TF-A */
Boyan Karatotev83ec7e42024-11-06 14:55:35 +0000975 cm_manage_extensions_el3(cpu_idx);
Boyan Karatotev24a70732023-03-08 11:56:49 +0000976
Achin Gupta4f6ad662013-10-25 09:08:21 +0100977 /*
Soby Mathew67487842015-07-13 14:10:57 +0100978 * Verify that we have been explicitly turned ON or resumed from
979 * suspend.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100980 */
Soby Mathew67487842015-07-13 14:10:57 +0100981 if (psci_get_aff_info_state() == AFF_STATE_OFF) {
Andrew Walbran33e8c562020-01-23 16:22:44 +0000982 ERROR("Unexpected affinity info state.\n");
James Morrissey40a6f642014-02-10 14:24:36 +0000983 panic();
Soby Mathew67487842015-07-13 14:10:57 +0100984 }
Achin Gupta4f6ad662013-10-25 09:08:21 +0100985
986 /*
Soby Mathew67487842015-07-13 14:10:57 +0100987 * Get the maximum power domain level to traverse to after this cpu
988 * has been physically powered up.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100989 */
Soby Mathew67487842015-07-13 14:10:57 +0100990 end_pwrlvl = get_power_on_target_pwrlvl();
Achin Gupta0a46e2c2014-07-31 11:19:11 +0100991
Andrew F. Davis74d27d02019-06-04 10:46:54 -0400992 /* Get the parent nodes */
993 psci_get_parent_pwr_domain_nodes(cpu_idx, end_pwrlvl, parent_nodes);
994
Achin Gupta0a46e2c2014-07-31 11:19:11 +0100995 /*
Soby Mathew67487842015-07-13 14:10:57 +0100996 * This function acquires the lock corresponding to each power level so
997 * that by the time all locks are taken, the system topology is snapshot
998 * and state management can be done safely.
Achin Gupta0a46e2c2014-07-31 11:19:11 +0100999 */
Andrew F. Davis74d27d02019-06-04 10:46:54 -04001000 psci_acquire_pwr_domain_locks(end_pwrlvl, parent_nodes);
Achin Gupta0a46e2c2014-07-31 11:19:11 +01001001
Boyan Karatotev3b802102024-11-06 16:26:15 +00001002 psci_get_target_local_pwr_states(cpu_idx, end_pwrlvl, &state_info);
Soby Mathewbfc87a82017-10-16 15:19:31 +01001003
Yatharth Kochar170fb932016-05-09 18:26:35 +01001004#if ENABLE_PSCI_STAT
dp-arm04c1db12017-01-31 13:01:04 +00001005 plat_psci_stat_accounting_stop(&state_info);
Yatharth Kochar170fb932016-05-09 18:26:35 +01001006#endif
1007
Achin Gupta4f6ad662013-10-25 09:08:21 +01001008 /*
Soby Mathew67487842015-07-13 14:10:57 +01001009 * This CPU could be resuming from suspend or it could have just been
1010 * turned on. To distinguish between these 2 cases, we examine the
1011 * affinity state of the CPU:
1012 * - If the affinity state is ON_PENDING then it has just been
1013 * turned on.
1014 * - Else it is resuming from suspend.
1015 *
1016 * Depending on the type of warm reset identified, choose the right set
1017 * of power management handler and perform the generic, architecture
1018 * and platform specific handling.
Achin Gupta84c9f102014-07-28 00:09:01 +01001019 */
Soby Mathew67487842015-07-13 14:10:57 +01001020 if (psci_get_aff_info_state() == AFF_STATE_ON_PENDING)
1021 psci_cpu_on_finish(cpu_idx, &state_info);
Boyan Karatotev2b5e00d2024-12-19 16:07:29 +00001022 else {
1023 unsigned int max_off_lvl = psci_find_max_off_lvl(&state_info);
1024
1025 assert(max_off_lvl != PSCI_INVALID_PWR_LVL);
1026 psci_cpu_suspend_to_powerdown_finish(cpu_idx, max_off_lvl, &state_info);
1027 }
Achin Gupta84c9f102014-07-28 00:09:01 +01001028
1029 /*
Boyan Karatoteve07e7392023-05-17 12:20:09 +01001030 * Generic management: Now we just need to retrieve the
1031 * information that we had stashed away during the cpu_on
1032 * call to set this cpu on its way.
1033 */
1034 cm_prepare_el3_exit_ns();
1035
1036 /*
Soby Mathew67487842015-07-13 14:10:57 +01001037 * Set the requested and target state of this CPU and all the higher
1038 * power domains which are ancestors of this CPU to run.
Achin Gupta0a46e2c2014-07-31 11:19:11 +01001039 */
Boyan Karatotev3b802102024-11-06 16:26:15 +00001040 psci_set_pwr_domains_to_run(cpu_idx, end_pwrlvl);
Achin Gupta0a46e2c2014-07-31 11:19:11 +01001041
Yatharth Kochar170fb932016-05-09 18:26:35 +01001042#if ENABLE_PSCI_STAT
Boyan Karatotev3b802102024-11-06 16:26:15 +00001043 psci_stats_update_pwr_up(cpu_idx, end_pwrlvl, &state_info);
Yatharth Kochar170fb932016-05-09 18:26:35 +01001044#endif
1045
Achin Gupta0a46e2c2014-07-31 11:19:11 +01001046 /*
Soby Mathew67487842015-07-13 14:10:57 +01001047 * This loop releases the lock corresponding to each power level
Achin Gupta0959db52013-12-02 17:33:04 +00001048 * in the reverse order to which they were acquired.
1049 */
Andrew F. Davis74d27d02019-06-04 10:46:54 -04001050 psci_release_pwr_domain_locks(end_pwrlvl, parent_nodes);
Achin Gupta4f6ad662013-10-25 09:08:21 +01001051}
Jeenu Viswambharan7f366602014-02-20 17:11:00 +00001052
1053/*******************************************************************************
1054 * This function initializes the set of hooks that PSCI invokes as part of power
1055 * management operation. The power management hooks are expected to be provided
1056 * by the SPD, after it finishes all its initialization
1057 ******************************************************************************/
Dan Handleyfb037bf2014-04-10 15:37:22 +01001058void psci_register_spd_pm_hook(const spd_pm_ops_t *pm)
Jeenu Viswambharan7f366602014-02-20 17:11:00 +00001059{
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +01001060 assert(pm != NULL);
Jeenu Viswambharan7f366602014-02-20 17:11:00 +00001061 psci_spd_pm = pm;
Soby Mathew90e82582015-01-07 11:10:22 +00001062
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +01001063 if (pm->svc_migrate != NULL)
Soby Mathew90e82582015-01-07 11:10:22 +00001064 psci_caps |= define_psci_cap(PSCI_MIG_AARCH64);
1065
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +01001066 if (pm->svc_migrate_info != NULL)
Soby Mathew90e82582015-01-07 11:10:22 +00001067 psci_caps |= define_psci_cap(PSCI_MIG_INFO_UP_CPU_AARCH64)
1068 | define_psci_cap(PSCI_MIG_INFO_TYPE);
Jeenu Viswambharan7f366602014-02-20 17:11:00 +00001069}
Juan Castillod5f13092014-08-12 11:17:06 +01001070
1071/*******************************************************************************
Soby Mathew8991eed2014-10-23 10:35:34 +01001072 * This function invokes the migrate info hook in the spd_pm_ops. It performs
1073 * the necessary return value validation. If the Secure Payload is UP and
1074 * migrate capable, it returns the mpidr of the CPU on which the Secure payload
1075 * is resident through the mpidr parameter. Else the value of the parameter on
1076 * return is undefined.
1077 ******************************************************************************/
Soby Mathew9d070b92015-07-29 17:05:03 +01001078int psci_spd_migrate_info(u_register_t *mpidr)
Soby Mathew8991eed2014-10-23 10:35:34 +01001079{
1080 int rc;
1081
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +01001082 if ((psci_spd_pm == NULL) || (psci_spd_pm->svc_migrate_info == NULL))
Soby Mathew8991eed2014-10-23 10:35:34 +01001083 return PSCI_E_NOT_SUPPORTED;
1084
1085 rc = psci_spd_pm->svc_migrate_info(mpidr);
1086
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +01001087 assert((rc == PSCI_TOS_UP_MIG_CAP) || (rc == PSCI_TOS_NOT_UP_MIG_CAP) ||
1088 (rc == PSCI_TOS_NOT_PRESENT_MP) || (rc == PSCI_E_NOT_SUPPORTED));
Soby Mathew8991eed2014-10-23 10:35:34 +01001089
1090 return rc;
1091}
1092
1093
1094/*******************************************************************************
Soby Mathew67487842015-07-13 14:10:57 +01001095 * This function prints the state of all power domains present in the
Juan Castillod5f13092014-08-12 11:17:06 +01001096 * system
1097 ******************************************************************************/
Soby Mathew67487842015-07-13 14:10:57 +01001098void psci_print_power_domain_map(void)
Juan Castillod5f13092014-08-12 11:17:06 +01001099{
1100#if LOG_LEVEL >= LOG_LEVEL_INFO
Pankaj Guptaab4df502019-10-15 15:44:45 +05301101 unsigned int idx;
Soby Mathew67487842015-07-13 14:10:57 +01001102 plat_local_state_t state;
1103 plat_local_state_type_t state_type;
1104
Juan Castillod5f13092014-08-12 11:17:06 +01001105 /* This array maps to the PSCI_STATE_X definitions in psci.h */
Soby Mathewda554d72016-05-03 17:11:42 +01001106 static const char * const psci_state_type_str[] = {
Juan Castillod5f13092014-08-12 11:17:06 +01001107 "ON",
Soby Mathew67487842015-07-13 14:10:57 +01001108 "RETENTION",
Juan Castillod5f13092014-08-12 11:17:06 +01001109 "OFF",
Juan Castillod5f13092014-08-12 11:17:06 +01001110 };
1111
Soby Mathew67487842015-07-13 14:10:57 +01001112 INFO("PSCI Power Domain Map:\n");
Pankaj Guptaab4df502019-10-15 15:44:45 +05301113 for (idx = 0; idx < (PSCI_NUM_PWR_DOMAINS - psci_plat_core_count);
Soby Mathew67487842015-07-13 14:10:57 +01001114 idx++) {
1115 state_type = find_local_state_type(
1116 psci_non_cpu_pd_nodes[idx].local_state);
Yann Gautierb9338ee2022-02-14 11:09:23 +01001117 INFO(" Domain Node : Level %u, parent_node %u,"
Soby Mathew67487842015-07-13 14:10:57 +01001118 " State %s (0x%x)\n",
1119 psci_non_cpu_pd_nodes[idx].level,
1120 psci_non_cpu_pd_nodes[idx].parent_node,
1121 psci_state_type_str[state_type],
1122 psci_non_cpu_pd_nodes[idx].local_state);
1123 }
1124
Pankaj Guptaab4df502019-10-15 15:44:45 +05301125 for (idx = 0; idx < psci_plat_core_count; idx++) {
Soby Mathew67487842015-07-13 14:10:57 +01001126 state = psci_get_cpu_local_state_by_idx(idx);
1127 state_type = find_local_state_type(state);
Yann Gautierb9338ee2022-02-14 11:09:23 +01001128 INFO(" CPU Node : MPID 0x%llx, parent_node %u,"
Soby Mathew67487842015-07-13 14:10:57 +01001129 " State %s (0x%x)\n",
Soby Mathew4c0d0392016-06-16 14:52:04 +01001130 (unsigned long long)psci_cpu_pd_nodes[idx].mpidr,
Soby Mathew67487842015-07-13 14:10:57 +01001131 psci_cpu_pd_nodes[idx].parent_node,
1132 psci_state_type_str[state_type],
1133 psci_get_cpu_local_state_by_idx(idx));
Juan Castillod5f13092014-08-12 11:17:06 +01001134 }
1135#endif
1136}
Soby Mathew67487842015-07-13 14:10:57 +01001137
Jeenu Viswambharanb10d4492017-02-16 14:55:15 +00001138/******************************************************************************
1139 * Return whether any secondaries were powered up with CPU_ON call. A CPU that
1140 * have ever been powered up would have set its MPDIR value to something other
1141 * than PSCI_INVALID_MPIDR. Note that MPDIR isn't reset back to
1142 * PSCI_INVALID_MPIDR when a CPU is powered down later, so the return value is
1143 * meaningful only when called on the primary CPU during early boot.
1144 *****************************************************************************/
1145int psci_secondaries_brought_up(void)
1146{
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +01001147 unsigned int idx, n_valid = 0U;
Jeenu Viswambharanb10d4492017-02-16 14:55:15 +00001148
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +01001149 for (idx = 0U; idx < ARRAY_SIZE(psci_cpu_pd_nodes); idx++) {
Jeenu Viswambharanb10d4492017-02-16 14:55:15 +00001150 if (psci_cpu_pd_nodes[idx].mpidr != PSCI_INVALID_MPIDR)
1151 n_valid++;
1152 }
1153
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +01001154 assert(n_valid > 0U);
Jeenu Viswambharanb10d4492017-02-16 14:55:15 +00001155
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +01001156 return (n_valid > 1U) ? 1 : 0;
Jeenu Viswambharanb10d4492017-02-16 14:55:15 +00001157}
1158
Jeenu Viswambharanb0408e82017-01-05 11:01:02 +00001159/*******************************************************************************
1160 * Initiate power down sequence, by calling power down operations registered for
1161 * this CPU.
1162 ******************************************************************************/
Boyan Karatotev2b5e00d2024-12-19 16:07:29 +00001163void psci_pwrdown_cpu_start(unsigned int power_level)
Jeenu Viswambharanb0408e82017-01-05 11:01:02 +00001164{
Boyan Karatotev9b1e8002024-10-10 08:11:09 +01001165#if ENABLE_RUNTIME_INSTRUMENTATION
1166
1167 /*
1168 * Flush cache line so that even if CPU power down happens
1169 * the timestamp update is reflected in memory.
1170 */
1171 PMF_CAPTURE_TIMESTAMP(rt_instr_svc,
1172 RT_INSTR_ENTER_CFLUSH,
1173 PMF_CACHE_MAINT);
1174#endif
1175
Jeenu Viswambharanb0408e82017-01-05 11:01:02 +00001176#if HW_ASSISTED_COHERENCY
1177 /*
1178 * With hardware-assisted coherency, the CPU drivers only initiate the
1179 * power down sequence, without performing cache-maintenance operations
Andrew F. Davisc98db6c2018-08-30 12:08:01 -05001180 * in software. Data caches enabled both before and after this call.
Jeenu Viswambharanb0408e82017-01-05 11:01:02 +00001181 */
1182 prepare_cpu_pwr_dwn(power_level);
1183#else
1184 /*
1185 * Without hardware-assisted coherency, the CPU drivers disable data
Andrew F. Davisc98db6c2018-08-30 12:08:01 -05001186 * caches, then perform cache-maintenance operations in software.
Jeenu Viswambharanb0408e82017-01-05 11:01:02 +00001187 *
Andrew F. Davisc98db6c2018-08-30 12:08:01 -05001188 * This also calls prepare_cpu_pwr_dwn() to initiate power down
1189 * sequence, but that function will return with data caches disabled.
1190 * We must ensure that the stack memory is flushed out to memory before
1191 * we start popping from it again.
Jeenu Viswambharanb0408e82017-01-05 11:01:02 +00001192 */
1193 psci_do_pwrdown_cache_maintenance(power_level);
1194#endif
Boyan Karatotev9b1e8002024-10-10 08:11:09 +01001195
1196#if ENABLE_RUNTIME_INSTRUMENTATION
1197 PMF_CAPTURE_TIMESTAMP(rt_instr_svc,
1198 RT_INSTR_EXIT_CFLUSH,
1199 PMF_NO_CACHE_MAINT);
1200#endif
Jeenu Viswambharanb0408e82017-01-05 11:01:02 +00001201}
Sandeep Tripathy22744902020-08-17 20:22:13 +05301202
1203/*******************************************************************************
Boyan Karatotev2b5e00d2024-12-19 16:07:29 +00001204 * Finish a terminal power down sequence, ending with a wfi. In case of wakeup
1205 * will retry the sleep and panic if it persists.
1206 ******************************************************************************/
1207void __dead2 psci_pwrdown_cpu_end_terminal(void)
1208{
Boyan Karatotev45c73282024-09-20 13:37:51 +01001209#if ERRATA_SME_POWER_DOWN
1210 /*
1211 * force SME off to not get power down rejected. Getting here is
1212 * terminal so we don't care if we lose context because of another
1213 * wakeup
1214 */
1215 if (is_feat_sme_supported()) {
1216 write_svcr(0);
1217 isb();
1218 }
1219#endif /* ERRATA_SME_POWER_DOWN */
1220
Boyan Karatotev2b5e00d2024-12-19 16:07:29 +00001221 /*
1222 * Execute a wfi which, in most cases, will allow the power controller
1223 * to physically power down this cpu. Under some circumstances that may
1224 * be denied. Hopefully this is transient, retrying a few times should
1225 * power down.
1226 */
1227 for (int i = 0; i < 32; i++)
1228 psci_power_down_wfi();
1229
1230 /* Wake up wasn't transient. System is probably in a bad state. */
1231 ERROR("Could not power off CPU.\n");
1232 panic();
1233}
1234
1235/*******************************************************************************
1236 * Finish a non-terminal power down sequence, ending with a wfi. In case of
1237 * wakeup will unwind any CPU specific actions and return.
1238 ******************************************************************************/
1239
1240void psci_pwrdown_cpu_end_wakeup(unsigned int power_level)
1241{
1242 /*
1243 * Usually, will be terminal. In some circumstances the powerdown will
1244 * be denied and we'll need to unwind
1245 */
1246 psci_power_down_wfi();
1247
1248 /*
1249 * Waking up does not require hardware-assisted coherency, but that is
1250 * the case for every core that can wake up. Untangling the cache
1251 * coherency code from powerdown is a non-trivial effort which isn't
1252 * needed for our purposes.
1253 */
1254#if !FEAT_PABANDON
1255 ERROR("Systems without FEAT_PABANDON shouldn't wake up.\n");
1256 panic();
1257#else /* FEAT_PABANDON */
1258
1259 /*
1260 * Begin unwinding. Everything can be shared with CPU_ON and co later,
1261 * except the CPU specific bit. Cores that have hardware-assisted
1262 * coherency don't have much to do so just calling the hook again is
1263 * the simplest way to achieve this
1264 */
1265 prepare_cpu_pwr_dwn(power_level);
1266#endif /* FEAT_PABANDON */
1267}
1268
1269/*******************************************************************************
Sandeep Tripathy22744902020-08-17 20:22:13 +05301270 * This function invokes the callback 'stop_func()' with the 'mpidr' of each
1271 * online PE. Caller can pass suitable method to stop a remote core.
1272 *
1273 * 'wait_ms' is the timeout value in milliseconds for the other cores to
1274 * transition to power down state. Passing '0' makes it non-blocking.
1275 *
1276 * The function returns 'PSCI_E_DENIED' if some cores failed to stop within the
1277 * given timeout.
1278 ******************************************************************************/
Boyan Karatotev3b802102024-11-06 16:26:15 +00001279int psci_stop_other_cores(unsigned int this_cpu_idx, unsigned int wait_ms,
Sandeep Tripathy22744902020-08-17 20:22:13 +05301280 void (*stop_func)(u_register_t mpidr))
1281{
Sandeep Tripathy22744902020-08-17 20:22:13 +05301282 /* Invoke stop_func for each core */
Boyan Karatotev3b802102024-11-06 16:26:15 +00001283 for (unsigned int idx = 0U; idx < psci_plat_core_count; idx++) {
Sandeep Tripathy22744902020-08-17 20:22:13 +05301284 /* skip current CPU */
1285 if (idx == this_cpu_idx) {
1286 continue;
1287 }
1288
1289 /* Check if the CPU is ON */
1290 if (psci_get_aff_info_state_by_idx(idx) == AFF_STATE_ON) {
1291 (*stop_func)(psci_cpu_pd_nodes[idx].mpidr);
1292 }
1293 }
1294
1295 /* Need to wait for other cores to shutdown */
1296 if (wait_ms != 0U) {
Boyan Karatotev3b802102024-11-06 16:26:15 +00001297 while ((wait_ms-- != 0U) && (!psci_is_last_on_cpu(this_cpu_idx))) {
Sandeep Tripathy22744902020-08-17 20:22:13 +05301298 mdelay(1U);
1299 }
1300
Boyan Karatotev3b802102024-11-06 16:26:15 +00001301 if (!psci_is_last_on_cpu(this_cpu_idx)) {
Sandeep Tripathy22744902020-08-17 20:22:13 +05301302 WARN("Failed to stop all cores!\n");
1303 psci_print_power_domain_map();
1304 return PSCI_E_DENIED;
1305 }
1306 }
1307
1308 return PSCI_E_SUCCESS;
1309}
Lucian Paul-Trifuce14a122022-03-02 21:28:24 +00001310
1311/*******************************************************************************
1312 * This function verifies that all the other cores in the system have been
1313 * turned OFF and the current CPU is the last running CPU in the system.
1314 * Returns true if the current CPU is the last ON CPU or false otherwise.
1315 *
1316 * This API has following differences with psci_is_last_on_cpu
1317 * 1. PSCI states are locked
Lucian Paul-Trifuce14a122022-03-02 21:28:24 +00001318 ******************************************************************************/
Boyan Karatotev3b802102024-11-06 16:26:15 +00001319bool psci_is_last_on_cpu_safe(unsigned int this_core)
Lucian Paul-Trifuce14a122022-03-02 21:28:24 +00001320{
Lucian Paul-Trifuce14a122022-03-02 21:28:24 +00001321 unsigned int parent_nodes[PLAT_MAX_PWR_LVL] = {0};
Lucian Paul-Trifuce14a122022-03-02 21:28:24 +00001322
Jayanth Dodderi Chidanandb41b0822022-08-22 23:46:10 +01001323 psci_get_parent_pwr_domain_nodes(this_core, PLAT_MAX_PWR_LVL, parent_nodes);
Lucian Paul-Trifuce14a122022-03-02 21:28:24 +00001324
Jayanth Dodderi Chidanandb41b0822022-08-22 23:46:10 +01001325 psci_acquire_pwr_domain_locks(PLAT_MAX_PWR_LVL, parent_nodes);
Lucian Paul-Trifuce14a122022-03-02 21:28:24 +00001326
Boyan Karatotev3b802102024-11-06 16:26:15 +00001327 if (!psci_is_last_on_cpu(this_core)) {
Lucian Paul-Trifuce14a122022-03-02 21:28:24 +00001328 psci_release_pwr_domain_locks(PLAT_MAX_PWR_LVL, parent_nodes);
Jayanth Dodderi Chidanandb41b0822022-08-22 23:46:10 +01001329 return false;
Lucian Paul-Trifuce14a122022-03-02 21:28:24 +00001330 }
1331
Jayanth Dodderi Chidanandb41b0822022-08-22 23:46:10 +01001332 psci_release_pwr_domain_locks(PLAT_MAX_PWR_LVL, parent_nodes);
1333
Lucian Paul-Trifuce14a122022-03-02 21:28:24 +00001334 return true;
1335}
Wing Lib88a4412022-09-14 13:18:15 -07001336
1337/*******************************************************************************
1338 * This function verifies that all cores in the system have been turned ON.
1339 * Returns true, if all CPUs are ON or false otherwise.
1340 *
1341 * This API has following differences with psci_are_all_cpus_on
1342 * 1. PSCI states are locked
1343 ******************************************************************************/
Boyan Karatotev3b802102024-11-06 16:26:15 +00001344bool psci_are_all_cpus_on_safe(unsigned int this_core)
Wing Lib88a4412022-09-14 13:18:15 -07001345{
Wing Lib88a4412022-09-14 13:18:15 -07001346 unsigned int parent_nodes[PLAT_MAX_PWR_LVL] = {0};
1347
1348 psci_get_parent_pwr_domain_nodes(this_core, PLAT_MAX_PWR_LVL, parent_nodes);
1349
1350 psci_acquire_pwr_domain_locks(PLAT_MAX_PWR_LVL, parent_nodes);
1351
1352 if (!psci_are_all_cpus_on()) {
1353 psci_release_pwr_domain_locks(PLAT_MAX_PWR_LVL, parent_nodes);
1354 return false;
1355 }
1356
1357 psci_release_pwr_domain_locks(PLAT_MAX_PWR_LVL, parent_nodes);
1358
1359 return true;
1360}