blob: 12d7b7b7e1b77e382650f720b279b75fb18aab76 [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 */
Maheedhar Bollapallic7b0a282024-04-25 11:47:27 +0530141 if (psci_check_power_state(power_state) != 0U) {
Soby Mathew67487842015-07-13 14:10:57 +0100142 return PSCI_E_INVALID_PARAMS;
Maheedhar Bollapallic7b0a282024-04-25 11:47:27 +0530143 }
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 */
Maheedhar Bollapallic7b0a282024-04-25 11:47:27 +0530442 for (; lvl <= PLAT_MAX_PWR_LVL; lvl++) {
Soby Mathew67487842015-07-13 14:10:57 +0100443 target_state->pwr_domain_state[lvl] = PSCI_LOCAL_STATE_RUN;
Maheedhar Bollapallic7b0a282024-04-25 11:47:27 +0530444 }
Soby Mathew67487842015-07-13 14:10:57 +0100445}
446
447/******************************************************************************
448 * Helper function to set the target local power state that each power domain
449 * from the current cpu power domain to its ancestor at the 'end_pwrlvl' will
450 * enter. This function will be called after coordination of requested power
451 * states has been done for each power level.
452 *****************************************************************************/
Boyan Karatotev3b802102024-11-06 16:26:15 +0000453void psci_set_target_local_pwr_states(unsigned int cpu_idx, unsigned int end_pwrlvl,
Wing Lid3488612023-05-04 08:31:19 -0700454 const psci_power_state_t *target_state)
Soby Mathew67487842015-07-13 14:10:57 +0100455{
Soby Mathew9d070b92015-07-29 17:05:03 +0100456 unsigned int parent_idx, lvl;
Soby Mathew67487842015-07-13 14:10:57 +0100457 const plat_local_state_t *pd_state = target_state->pwr_domain_state;
458
459 psci_set_cpu_local_state(pd_state[PSCI_CPU_PWR_LVL]);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100460
461 /*
Jeenu Viswambharana10d3632017-01-06 14:58:11 +0000462 * Need to flush as local_state might be accessed with Data Cache
Soby Mathew67487842015-07-13 14:10:57 +0100463 * disabled during power on
Achin Gupta4f6ad662013-10-25 09:08:21 +0100464 */
Jeenu Viswambharana10d3632017-01-06 14:58:11 +0000465 psci_flush_cpu_data(psci_svc_cpu_data.local_state);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100466
Boyan Karatotev3b802102024-11-06 16:26:15 +0000467 parent_idx = psci_cpu_pd_nodes[cpu_idx].parent_node;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100468
Soby Mathew67487842015-07-13 14:10:57 +0100469 /* Copy the local_state from state_info */
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100470 for (lvl = 1U; lvl <= end_pwrlvl; lvl++) {
Jeenu Viswambharana10d3632017-01-06 14:58:11 +0000471 set_non_cpu_pd_node_local_state(parent_idx, pd_state[lvl]);
Soby Mathew67487842015-07-13 14:10:57 +0100472 parent_idx = psci_non_cpu_pd_nodes[parent_idx].parent_node;
473 }
Achin Gupta4f6ad662013-10-25 09:08:21 +0100474}
475
476/*******************************************************************************
Soby Mathew67487842015-07-13 14:10:57 +0100477 * PSCI helper function to get the parent nodes corresponding to a cpu_index.
Achin Gupta0959db52013-12-02 17:33:04 +0000478 ******************************************************************************/
Deepika Bhavnanifc810212019-08-27 00:32:24 +0300479void psci_get_parent_pwr_domain_nodes(unsigned int cpu_idx,
Soby Mathew9d070b92015-07-29 17:05:03 +0100480 unsigned int end_lvl,
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100481 unsigned int *node_index)
Achin Gupta0959db52013-12-02 17:33:04 +0000482{
Soby Mathew67487842015-07-13 14:10:57 +0100483 unsigned int parent_node = psci_cpu_pd_nodes[cpu_idx].parent_node;
Varun Wadekar6311f632017-06-07 09:57:42 -0700484 unsigned int i;
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100485 unsigned int *node = node_index;
Soby Mathew67487842015-07-13 14:10:57 +0100486
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100487 for (i = PSCI_CPU_PWR_LVL + 1U; i <= end_lvl; i++) {
488 *node = parent_node;
489 node++;
Soby Mathew67487842015-07-13 14:10:57 +0100490 parent_node = psci_non_cpu_pd_nodes[parent_node].parent_node;
491 }
492}
493
494/******************************************************************************
495 * This function is invoked post CPU power up and initialization. It sets the
496 * affinity info state, target power state and requested power state for the
497 * current CPU and all its ancestor power domains to RUN.
498 *****************************************************************************/
Boyan Karatotev3b802102024-11-06 16:26:15 +0000499void psci_set_pwr_domains_to_run(unsigned int cpu_idx, unsigned int end_pwrlvl)
Soby Mathew67487842015-07-13 14:10:57 +0100500{
Boyan Karatotev3b802102024-11-06 16:26:15 +0000501 unsigned int parent_idx, lvl;
Soby Mathew67487842015-07-13 14:10:57 +0100502 parent_idx = psci_cpu_pd_nodes[cpu_idx].parent_node;
503
504 /* Reset the local_state to RUN for the non cpu power domains. */
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100505 for (lvl = PSCI_CPU_PWR_LVL + 1U; lvl <= end_pwrlvl; lvl++) {
Jeenu Viswambharana10d3632017-01-06 14:58:11 +0000506 set_non_cpu_pd_node_local_state(parent_idx,
507 PSCI_LOCAL_STATE_RUN);
Soby Mathew67487842015-07-13 14:10:57 +0100508 psci_set_req_local_pwr_state(lvl,
509 cpu_idx,
510 PSCI_LOCAL_STATE_RUN);
511 parent_idx = psci_non_cpu_pd_nodes[parent_idx].parent_node;
512 }
513
514 /* Set the affinity info state to ON */
515 psci_set_aff_info_state(AFF_STATE_ON);
516
517 psci_set_cpu_local_state(PSCI_LOCAL_STATE_RUN);
Jeenu Viswambharana10d3632017-01-06 14:58:11 +0000518 psci_flush_cpu_data(psci_svc_cpu_data);
Soby Mathew67487842015-07-13 14:10:57 +0100519}
520
521/******************************************************************************
Wing Li606b7432022-09-14 13:18:17 -0700522 * This function is used in platform-coordinated mode.
523 *
Soby Mathew67487842015-07-13 14:10:57 +0100524 * This function is passed the local power states requested for each power
525 * domain (state_info) between the current CPU domain and its ancestors until
526 * the target power level (end_pwrlvl). It updates the array of requested power
527 * states with this information.
528 *
529 * Then, for each level (apart from the CPU level) until the 'end_pwrlvl', it
530 * retrieves the states requested by all the cpus of which the power domain at
531 * that level is an ancestor. It passes this information to the platform to
532 * coordinate and return the target power state. If the target state for a level
533 * is RUN then subsequent levels are not considered. At the CPU level, state
534 * coordination is not required. Hence, the requested and the target states are
535 * the same.
536 *
537 * The 'state_info' is updated with the target state for each level between the
538 * CPU and the 'end_pwrlvl' and returned to the caller.
539 *
540 * This function will only be invoked with data cache enabled and while
541 * powering down a core.
542 *****************************************************************************/
Boyan Karatotev3b802102024-11-06 16:26:15 +0000543void psci_do_state_coordination(unsigned int cpu_idx, unsigned int end_pwrlvl,
Soby Mathew9d070b92015-07-29 17:05:03 +0100544 psci_power_state_t *state_info)
Soby Mathew67487842015-07-13 14:10:57 +0100545{
Boyan Karatotev3b802102024-11-06 16:26:15 +0000546 unsigned int lvl, parent_idx;
Deepika Bhavnanifc810212019-08-27 00:32:24 +0300547 unsigned int start_idx;
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100548 unsigned int ncpus;
Soby Mathew67487842015-07-13 14:10:57 +0100549 plat_local_state_t target_state, *req_states;
550
Soby Mathew6d189692016-02-02 14:23:10 +0000551 assert(end_pwrlvl <= PLAT_MAX_PWR_LVL);
Soby Mathew67487842015-07-13 14:10:57 +0100552 parent_idx = psci_cpu_pd_nodes[cpu_idx].parent_node;
553
554 /* For level 0, the requested state will be equivalent
555 to target state */
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100556 for (lvl = PSCI_CPU_PWR_LVL + 1U; lvl <= end_pwrlvl; lvl++) {
Soby Mathew67487842015-07-13 14:10:57 +0100557
558 /* First update the requested power state */
559 psci_set_req_local_pwr_state(lvl, cpu_idx,
560 state_info->pwr_domain_state[lvl]);
561
562 /* Get the requested power states for this power level */
563 start_idx = psci_non_cpu_pd_nodes[parent_idx].cpu_start_idx;
564 req_states = psci_get_req_local_pwr_states(lvl, start_idx);
565
566 /*
567 * Let the platform coordinate amongst the requested states at
568 * this power level and return the target local power state.
569 */
570 ncpus = psci_non_cpu_pd_nodes[parent_idx].ncpus;
571 target_state = plat_get_target_pwr_state(lvl,
572 req_states,
573 ncpus);
574
575 state_info->pwr_domain_state[lvl] = target_state;
576
577 /* Break early if the negotiated target power state is RUN */
Maheedhar Bollapallic7b0a282024-04-25 11:47:27 +0530578 if (is_local_state_run(state_info->pwr_domain_state[lvl]) != 0) {
Soby Mathew67487842015-07-13 14:10:57 +0100579 break;
Maheedhar Bollapallic7b0a282024-04-25 11:47:27 +0530580 }
Soby Mathew67487842015-07-13 14:10:57 +0100581
582 parent_idx = psci_non_cpu_pd_nodes[parent_idx].parent_node;
583 }
584
585 /*
586 * This is for cases when we break out of the above loop early because
587 * the target power state is RUN at a power level < end_pwlvl.
588 * We update the requested power state from state_info and then
589 * set the target state as RUN.
590 */
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100591 for (lvl = lvl + 1U; lvl <= end_pwrlvl; lvl++) {
Soby Mathew67487842015-07-13 14:10:57 +0100592 psci_set_req_local_pwr_state(lvl, cpu_idx,
593 state_info->pwr_domain_state[lvl]);
594 state_info->pwr_domain_state[lvl] = PSCI_LOCAL_STATE_RUN;
595
596 }
Soby Mathew67487842015-07-13 14:10:57 +0100597}
598
Wing Li606b7432022-09-14 13:18:17 -0700599#if PSCI_OS_INIT_MODE
600/******************************************************************************
601 * This function is used in OS-initiated mode.
602 *
603 * This function is passed the local power states requested for each power
604 * domain (state_info) between the current CPU domain and its ancestors until
605 * the target power level (end_pwrlvl), and ensures the requested power states
606 * are valid. It updates the array of requested power states with this
607 * information.
608 *
609 * Then, for each level (apart from the CPU level) until the 'end_pwrlvl', it
610 * retrieves the states requested by all the cpus of which the power domain at
611 * that level is an ancestor. It passes this information to the platform to
612 * coordinate and return the target power state. If the requested state does
613 * not match the target state, the request is denied.
614 *
615 * The 'state_info' is not modified.
616 *
617 * This function will only be invoked with data cache enabled and while
618 * powering down a core.
619 *****************************************************************************/
Boyan Karatotev3b802102024-11-06 16:26:15 +0000620int psci_validate_state_coordination(unsigned int cpu_idx, unsigned int end_pwrlvl,
Wing Li606b7432022-09-14 13:18:17 -0700621 psci_power_state_t *state_info)
622{
623 int rc = PSCI_E_SUCCESS;
Boyan Karatotev3b802102024-11-06 16:26:15 +0000624 unsigned int lvl, parent_idx;
Wing Li606b7432022-09-14 13:18:17 -0700625 unsigned int start_idx;
626 unsigned int ncpus;
627 plat_local_state_t target_state, *req_states;
628 plat_local_state_t prev[PLAT_MAX_PWR_LVL];
629
630 assert(end_pwrlvl <= PLAT_MAX_PWR_LVL);
631 parent_idx = psci_cpu_pd_nodes[cpu_idx].parent_node;
632
633 /*
634 * Save a copy of the previous requested local power states and update
635 * the new requested local power states.
636 */
637 psci_update_req_local_pwr_states(end_pwrlvl, cpu_idx, state_info, prev);
638
639 for (lvl = PSCI_CPU_PWR_LVL + 1U; lvl <= end_pwrlvl; lvl++) {
640 /* Get the requested power states for this power level */
641 start_idx = psci_non_cpu_pd_nodes[parent_idx].cpu_start_idx;
642 req_states = psci_get_req_local_pwr_states(lvl, start_idx);
643
644 /*
645 * Let the platform coordinate amongst the requested states at
646 * this power level and return the target local power state.
647 */
648 ncpus = psci_non_cpu_pd_nodes[parent_idx].ncpus;
649 target_state = plat_get_target_pwr_state(lvl,
650 req_states,
651 ncpus);
652
653 /*
654 * Verify that the requested power state matches the target
655 * local power state.
656 */
657 if (state_info->pwr_domain_state[lvl] != target_state) {
658 if (target_state == PSCI_LOCAL_STATE_RUN) {
659 rc = PSCI_E_DENIED;
660 } else {
661 rc = PSCI_E_INVALID_PARAMS;
662 }
663 goto exit;
664 }
Patrick Delaunay412d92f2023-10-17 20:05:52 +0200665
666 parent_idx = psci_non_cpu_pd_nodes[parent_idx].parent_node;
Wing Li606b7432022-09-14 13:18:17 -0700667 }
668
669 /*
670 * Verify that the current core is the last running core at the
671 * specified power level.
672 */
673 lvl = state_info->last_at_pwrlvl;
Boyan Karatotev3b802102024-11-06 16:26:15 +0000674 if (!psci_is_last_cpu_to_idle_at_pwrlvl(cpu_idx, lvl)) {
Wing Li606b7432022-09-14 13:18:17 -0700675 rc = PSCI_E_DENIED;
676 }
677
678exit:
679 if (rc != PSCI_E_SUCCESS) {
680 /* Restore the previous requested local power states. */
681 psci_restore_req_local_pwr_states(cpu_idx, prev);
682 return rc;
683 }
684
Wing Li606b7432022-09-14 13:18:17 -0700685 return rc;
686}
687#endif
688
Soby Mathew67487842015-07-13 14:10:57 +0100689/******************************************************************************
690 * This function validates a suspend request by making sure that if a standby
691 * state is requested then no power level is turned off and the highest power
692 * level is placed in a standby/retention state.
693 *
694 * It also ensures that the state level X will enter is not shallower than the
695 * state level X + 1 will enter.
696 *
697 * This validation will be enabled only for DEBUG builds as the platform is
698 * expected to perform these validations as well.
699 *****************************************************************************/
700int psci_validate_suspend_req(const psci_power_state_t *state_info,
701 unsigned int is_power_down_state)
702{
703 unsigned int max_off_lvl, target_lvl, max_retn_lvl;
704 plat_local_state_t state;
705 plat_local_state_type_t req_state_type, deepest_state_type;
706 int i;
707
708 /* Find the target suspend power level */
709 target_lvl = psci_find_target_suspend_lvl(state_info);
Soby Mathew9d070b92015-07-29 17:05:03 +0100710 if (target_lvl == PSCI_INVALID_PWR_LVL)
Achin Gupta0959db52013-12-02 17:33:04 +0000711 return PSCI_E_INVALID_PARAMS;
712
Soby Mathew67487842015-07-13 14:10:57 +0100713 /* All power domain levels are in a RUN state to begin with */
714 deepest_state_type = STATE_TYPE_RUN;
Achin Gupta0959db52013-12-02 17:33:04 +0000715
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100716 for (i = (int) target_lvl; i >= (int) PSCI_CPU_PWR_LVL; i--) {
Soby Mathew67487842015-07-13 14:10:57 +0100717 state = state_info->pwr_domain_state[i];
718 req_state_type = find_local_state_type(state);
719
720 /*
721 * While traversing from the highest power level to the lowest,
722 * the state requested for lower levels has to be the same or
723 * deeper i.e. equal to or greater than the state at the higher
724 * levels. If this condition is true, then the requested state
725 * becomes the deepest state encountered so far.
726 */
727 if (req_state_type < deepest_state_type)
728 return PSCI_E_INVALID_PARAMS;
729 deepest_state_type = req_state_type;
730 }
731
732 /* Find the highest off power level */
733 max_off_lvl = psci_find_max_off_lvl(state_info);
734
735 /* The target_lvl is either equal to the max_off_lvl or max_retn_lvl */
Soby Mathew9d070b92015-07-29 17:05:03 +0100736 max_retn_lvl = PSCI_INVALID_PWR_LVL;
Soby Mathew67487842015-07-13 14:10:57 +0100737 if (target_lvl != max_off_lvl)
738 max_retn_lvl = target_lvl;
739
740 /*
741 * If this is not a request for a power down state then max off level
742 * has to be invalid and max retention level has to be a valid power
743 * level.
744 */
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100745 if ((is_power_down_state == 0U) &&
746 ((max_off_lvl != PSCI_INVALID_PWR_LVL) ||
747 (max_retn_lvl == PSCI_INVALID_PWR_LVL)))
Achin Gupta0959db52013-12-02 17:33:04 +0000748 return PSCI_E_INVALID_PARAMS;
749
750 return PSCI_E_SUCCESS;
751}
752
Soby Mathew67487842015-07-13 14:10:57 +0100753/******************************************************************************
754 * This function finds the highest power level which will be powered down
755 * amongst all the power levels specified in the 'state_info' structure
756 *****************************************************************************/
757unsigned int psci_find_max_off_lvl(const psci_power_state_t *state_info)
Achin Gupta84c9f102014-07-28 00:09:01 +0100758{
Soby Mathew67487842015-07-13 14:10:57 +0100759 int i;
Achin Gupta84c9f102014-07-28 00:09:01 +0100760
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100761 for (i = (int) PLAT_MAX_PWR_LVL; i >= (int) PSCI_CPU_PWR_LVL; i--) {
Maheedhar Bollapallic7b0a282024-04-25 11:47:27 +0530762 if (is_local_state_off(state_info->pwr_domain_state[i]) != 0) {
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100763 return (unsigned int) i;
Maheedhar Bollapallic7b0a282024-04-25 11:47:27 +0530764 }
Achin Gupta84c9f102014-07-28 00:09:01 +0100765 }
Soby Mathew67487842015-07-13 14:10:57 +0100766
Soby Mathew9d070b92015-07-29 17:05:03 +0100767 return PSCI_INVALID_PWR_LVL;
Soby Mathew67487842015-07-13 14:10:57 +0100768}
769
770/******************************************************************************
771 * This functions finds the level of the highest power domain which will be
772 * placed in a low power state during a suspend operation.
773 *****************************************************************************/
774unsigned int psci_find_target_suspend_lvl(const psci_power_state_t *state_info)
775{
776 int i;
777
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100778 for (i = (int) PLAT_MAX_PWR_LVL; i >= (int) PSCI_CPU_PWR_LVL; i--) {
779 if (is_local_state_run(state_info->pwr_domain_state[i]) == 0)
780 return (unsigned int) i;
Soby Mathew67487842015-07-13 14:10:57 +0100781 }
782
Soby Mathew9d070b92015-07-29 17:05:03 +0100783 return PSCI_INVALID_PWR_LVL;
Achin Gupta84c9f102014-07-28 00:09:01 +0100784}
785
786/*******************************************************************************
Andrew F. Davis74d27d02019-06-04 10:46:54 -0400787 * This function is passed the highest level in the topology tree that the
788 * operation should be applied to and a list of node indexes. It picks up locks
789 * from the node index list in order of increasing power domain level in the
790 * range specified.
Achin Gupta0959db52013-12-02 17:33:04 +0000791 ******************************************************************************/
Andrew F. Davis74d27d02019-06-04 10:46:54 -0400792void psci_acquire_pwr_domain_locks(unsigned int end_pwrlvl,
793 const unsigned int *parent_nodes)
Achin Gupta0959db52013-12-02 17:33:04 +0000794{
Andrew F. Davis74d27d02019-06-04 10:46:54 -0400795 unsigned int parent_idx;
Soby Mathew9d070b92015-07-29 17:05:03 +0100796 unsigned int level;
Achin Gupta0959db52013-12-02 17:33:04 +0000797
Soby Mathew67487842015-07-13 14:10:57 +0100798 /* No locking required for level 0. Hence start locking from level 1 */
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100799 for (level = PSCI_CPU_PWR_LVL + 1U; level <= end_pwrlvl; level++) {
Andrew F. Davis74d27d02019-06-04 10:46:54 -0400800 parent_idx = parent_nodes[level - 1U];
Soby Mathew67487842015-07-13 14:10:57 +0100801 psci_lock_get(&psci_non_cpu_pd_nodes[parent_idx]);
Achin Gupta0959db52013-12-02 17:33:04 +0000802 }
803}
804
805/*******************************************************************************
Andrew F. Davis74d27d02019-06-04 10:46:54 -0400806 * This function is passed the highest level in the topology tree that the
807 * operation should be applied to and a list of node indexes. It releases the
808 * locks in order of decreasing power domain level in the range specified.
Achin Gupta0959db52013-12-02 17:33:04 +0000809 ******************************************************************************/
Andrew F. Davis74d27d02019-06-04 10:46:54 -0400810void psci_release_pwr_domain_locks(unsigned int end_pwrlvl,
811 const unsigned int *parent_nodes)
Achin Gupta0959db52013-12-02 17:33:04 +0000812{
Andrew F. Davis74d27d02019-06-04 10:46:54 -0400813 unsigned int parent_idx;
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100814 unsigned int level;
Achin Gupta0959db52013-12-02 17:33:04 +0000815
Soby Mathew67487842015-07-13 14:10:57 +0100816 /* Unlock top down. No unlocking required for level 0. */
Zelalem2fe75a22020-02-12 10:37:03 -0600817 for (level = end_pwrlvl; level >= (PSCI_CPU_PWR_LVL + 1U); level--) {
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100818 parent_idx = parent_nodes[level - 1U];
Soby Mathew67487842015-07-13 14:10:57 +0100819 psci_lock_release(&psci_non_cpu_pd_nodes[parent_idx]);
Achin Gupta0959db52013-12-02 17:33:04 +0000820 }
821}
822
823/*******************************************************************************
Andrew Thoelke167a9352014-06-04 21:10:52 +0100824 * This function determines the full entrypoint information for the requested
Soby Mathew78879b92015-01-06 15:36:38 +0000825 * PSCI entrypoint on power on/resume and returns it.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100826 ******************************************************************************/
Julius Werner402b3cf2019-07-09 14:02:43 -0700827#ifdef __aarch64__
Soby Mathew617540d2015-07-15 12:13:26 +0100828static int psci_get_ns_ep_info(entry_point_info_t *ep,
Soby Mathew9d070b92015-07-29 17:05:03 +0100829 uintptr_t entrypoint,
830 u_register_t context_id)
Achin Gupta4f6ad662013-10-25 09:08:21 +0100831{
Soby Mathew4c0d0392016-06-16 14:52:04 +0100832 u_register_t ep_attr, sctlr;
Soby Mathew9d070b92015-07-29 17:05:03 +0100833 unsigned int daif, ee, mode;
Soby Mathew4c0d0392016-06-16 14:52:04 +0100834 u_register_t ns_scr_el3 = read_scr_el3();
835 u_register_t ns_sctlr_el1 = read_sctlr_el1();
Achin Gupta4f6ad662013-10-25 09:08:21 +0100836
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100837 sctlr = ((ns_scr_el3 & SCR_HCE_BIT) != 0U) ?
838 read_sctlr_el2() : ns_sctlr_el1;
Andrew Thoelke167a9352014-06-04 21:10:52 +0100839 ee = 0;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100840
Andrew Thoelke167a9352014-06-04 21:10:52 +0100841 ep_attr = NON_SECURE | EP_ST_DISABLE;
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100842 if ((sctlr & SCTLR_EE_BIT) != 0U) {
Andrew Thoelke167a9352014-06-04 21:10:52 +0100843 ep_attr |= EP_EE_BIG;
844 ee = 1;
845 }
Soby Mathew78879b92015-01-06 15:36:38 +0000846 SET_PARAM_HEAD(ep, PARAM_EP, VERSION_1, ep_attr);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100847
Soby Mathew78879b92015-01-06 15:36:38 +0000848 ep->pc = entrypoint;
Douglas Raillard32f0d3c2017-01-26 15:54:44 +0000849 zeromem(&ep->args, sizeof(ep->args));
Soby Mathew78879b92015-01-06 15:36:38 +0000850 ep->args.arg0 = context_id;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100851
852 /*
853 * Figure out whether the cpu enters the non-secure address space
854 * in aarch32 or aarch64
855 */
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100856 if ((ns_scr_el3 & SCR_RW_BIT) != 0U) {
Achin Gupta4f6ad662013-10-25 09:08:21 +0100857
858 /*
859 * Check whether a Thumb entry point has been provided for an
860 * aarch64 EL
861 */
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100862 if ((entrypoint & 0x1UL) != 0UL)
Soby Mathew617540d2015-07-15 12:13:26 +0100863 return PSCI_E_INVALID_ADDRESS;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100864
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100865 mode = ((ns_scr_el3 & SCR_HCE_BIT) != 0U) ? MODE_EL2 : MODE_EL1;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100866
Jimmy Brissond7b5f402020-08-04 16:18:52 -0500867 ep->spsr = SPSR_64((uint64_t)mode, MODE_SP_ELX,
868 DISABLE_ALL_EXCEPTIONS);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100869 } else {
870
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100871 mode = ((ns_scr_el3 & SCR_HCE_BIT) != 0U) ?
872 MODE32_hyp : MODE32_svc;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100873
874 /*
875 * TODO: Choose async. exception bits if HYP mode is not
876 * implemented according to the values of SCR.{AW, FW} bits
877 */
Vikram Kanigiri23ff9ba2014-05-13 14:42:08 +0100878 daif = DAIF_ABT_BIT | DAIF_IRQ_BIT | DAIF_FIQ_BIT;
879
Jimmy Brissond7b5f402020-08-04 16:18:52 -0500880 ep->spsr = SPSR_MODE32((uint64_t)mode, entrypoint & 0x1, ee,
881 daif);
Achin Gupta4f6ad662013-10-25 09:08:21 +0100882 }
883
Andrew Thoelke167a9352014-06-04 21:10:52 +0100884 return PSCI_E_SUCCESS;
Achin Gupta4f6ad662013-10-25 09:08:21 +0100885}
Julius Werner402b3cf2019-07-09 14:02:43 -0700886#else /* !__aarch64__ */
887static int psci_get_ns_ep_info(entry_point_info_t *ep,
888 uintptr_t entrypoint,
889 u_register_t context_id)
890{
891 u_register_t ep_attr;
892 unsigned int aif, ee, mode;
893 u_register_t scr = read_scr();
894 u_register_t ns_sctlr, sctlr;
895
896 /* Switch to non secure state */
897 write_scr(scr | SCR_NS_BIT);
898 isb();
899 ns_sctlr = read_sctlr();
900
901 sctlr = scr & SCR_HCE_BIT ? read_hsctlr() : ns_sctlr;
902
903 /* Return to original state */
904 write_scr(scr);
905 isb();
906 ee = 0;
907
908 ep_attr = NON_SECURE | EP_ST_DISABLE;
909 if (sctlr & SCTLR_EE_BIT) {
910 ep_attr |= EP_EE_BIG;
911 ee = 1;
912 }
913 SET_PARAM_HEAD(ep, PARAM_EP, VERSION_1, ep_attr);
914
915 ep->pc = entrypoint;
916 zeromem(&ep->args, sizeof(ep->args));
917 ep->args.arg0 = context_id;
918
919 mode = scr & SCR_HCE_BIT ? MODE32_hyp : MODE32_svc;
920
921 /*
922 * TODO: Choose async. exception bits if HYP mode is not
923 * implemented according to the values of SCR.{AW, FW} bits
924 */
925 aif = SPSR_ABT_BIT | SPSR_IRQ_BIT | SPSR_FIQ_BIT;
926
927 ep->spsr = SPSR_MODE32(mode, entrypoint & 0x1, ee, aif);
928
929 return PSCI_E_SUCCESS;
930}
931
932#endif /* __aarch64__ */
Achin Gupta4f6ad662013-10-25 09:08:21 +0100933
934/*******************************************************************************
Soby Mathew617540d2015-07-15 12:13:26 +0100935 * This function validates the entrypoint with the platform layer if the
936 * appropriate pm_ops hook is exported by the platform and returns the
937 * 'entry_point_info'.
938 ******************************************************************************/
939int psci_validate_entry_point(entry_point_info_t *ep,
Soby Mathew9d070b92015-07-29 17:05:03 +0100940 uintptr_t entrypoint,
941 u_register_t context_id)
Soby Mathew617540d2015-07-15 12:13:26 +0100942{
943 int rc;
944
945 /* Validate the entrypoint using platform psci_ops */
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100946 if (psci_plat_pm_ops->validate_ns_entrypoint != NULL) {
Soby Mathew617540d2015-07-15 12:13:26 +0100947 rc = psci_plat_pm_ops->validate_ns_entrypoint(entrypoint);
Maheedhar Bollapallic7b0a282024-04-25 11:47:27 +0530948 if (rc != PSCI_E_SUCCESS) {
Soby Mathew617540d2015-07-15 12:13:26 +0100949 return PSCI_E_INVALID_ADDRESS;
Maheedhar Bollapallic7b0a282024-04-25 11:47:27 +0530950 }
Soby Mathew617540d2015-07-15 12:13:26 +0100951 }
952
953 /*
954 * Verify and derive the re-entry information for
955 * the non-secure world from the non-secure state from
956 * where this call originated.
957 */
958 rc = psci_get_ns_ep_info(ep, entrypoint, context_id);
959 return rc;
960}
961
962/*******************************************************************************
Achin Gupta4f6ad662013-10-25 09:08:21 +0100963 * Generic handler which is called when a cpu is physically powered on. It
Soby Mathew67487842015-07-13 14:10:57 +0100964 * traverses the node information and finds the highest power level powered
965 * off and performs generic, architectural, platform setup and state management
966 * to power on that power level and power levels below it.
967 * e.g. For a cpu that's been powered on, it will call the platform specific
968 * code to enable the gic cpu interface and for a cluster it will enable
969 * coherency at the interconnect level in addition to gic cpu interface.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100970 ******************************************************************************/
Soby Mathewcf0b1492016-04-29 19:01:30 +0100971void psci_warmboot_entrypoint(void)
Achin Gupta4f6ad662013-10-25 09:08:21 +0100972{
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +0100973 unsigned int end_pwrlvl;
Deepika Bhavnanifc810212019-08-27 00:32:24 +0300974 unsigned int cpu_idx = plat_my_core_pos();
Andrew F. Davis74d27d02019-06-04 10:46:54 -0400975 unsigned int parent_nodes[PLAT_MAX_PWR_LVL] = {0};
Soby Mathew67487842015-07-13 14:10:57 +0100976 psci_power_state_t state_info = { {PSCI_LOCAL_STATE_RUN} };
Achin Gupta4f6ad662013-10-25 09:08:21 +0100977
Boyan Karatotev24a70732023-03-08 11:56:49 +0000978 /* Init registers that never change for the lifetime of TF-A */
Boyan Karatotev83ec7e42024-11-06 14:55:35 +0000979 cm_manage_extensions_el3(cpu_idx);
Boyan Karatotev24a70732023-03-08 11:56:49 +0000980
Achin Gupta4f6ad662013-10-25 09:08:21 +0100981 /*
Soby Mathew67487842015-07-13 14:10:57 +0100982 * Verify that we have been explicitly turned ON or resumed from
983 * suspend.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100984 */
Soby Mathew67487842015-07-13 14:10:57 +0100985 if (psci_get_aff_info_state() == AFF_STATE_OFF) {
Andrew Walbran33e8c562020-01-23 16:22:44 +0000986 ERROR("Unexpected affinity info state.\n");
James Morrissey40a6f642014-02-10 14:24:36 +0000987 panic();
Soby Mathew67487842015-07-13 14:10:57 +0100988 }
Achin Gupta4f6ad662013-10-25 09:08:21 +0100989
990 /*
Soby Mathew67487842015-07-13 14:10:57 +0100991 * Get the maximum power domain level to traverse to after this cpu
992 * has been physically powered up.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100993 */
Soby Mathew67487842015-07-13 14:10:57 +0100994 end_pwrlvl = get_power_on_target_pwrlvl();
Achin Gupta0a46e2c2014-07-31 11:19:11 +0100995
Andrew F. Davis74d27d02019-06-04 10:46:54 -0400996 /* Get the parent nodes */
997 psci_get_parent_pwr_domain_nodes(cpu_idx, end_pwrlvl, parent_nodes);
998
Achin Gupta0a46e2c2014-07-31 11:19:11 +0100999 /*
Soby Mathew67487842015-07-13 14:10:57 +01001000 * This function acquires the lock corresponding to each power level so
1001 * that by the time all locks are taken, the system topology is snapshot
1002 * and state management can be done safely.
Achin Gupta0a46e2c2014-07-31 11:19:11 +01001003 */
Andrew F. Davis74d27d02019-06-04 10:46:54 -04001004 psci_acquire_pwr_domain_locks(end_pwrlvl, parent_nodes);
Achin Gupta0a46e2c2014-07-31 11:19:11 +01001005
Boyan Karatotev3b802102024-11-06 16:26:15 +00001006 psci_get_target_local_pwr_states(cpu_idx, end_pwrlvl, &state_info);
Soby Mathewbfc87a82017-10-16 15:19:31 +01001007
Yatharth Kochar170fb932016-05-09 18:26:35 +01001008#if ENABLE_PSCI_STAT
dp-arm04c1db12017-01-31 13:01:04 +00001009 plat_psci_stat_accounting_stop(&state_info);
Yatharth Kochar170fb932016-05-09 18:26:35 +01001010#endif
1011
Achin Gupta4f6ad662013-10-25 09:08:21 +01001012 /*
Soby Mathew67487842015-07-13 14:10:57 +01001013 * This CPU could be resuming from suspend or it could have just been
1014 * turned on. To distinguish between these 2 cases, we examine the
1015 * affinity state of the CPU:
1016 * - If the affinity state is ON_PENDING then it has just been
1017 * turned on.
1018 * - Else it is resuming from suspend.
1019 *
1020 * Depending on the type of warm reset identified, choose the right set
1021 * of power management handler and perform the generic, architecture
1022 * and platform specific handling.
Achin Gupta84c9f102014-07-28 00:09:01 +01001023 */
Maheedhar Bollapallic7b0a282024-04-25 11:47:27 +05301024 if (psci_get_aff_info_state() == AFF_STATE_ON_PENDING) {
Soby Mathew67487842015-07-13 14:10:57 +01001025 psci_cpu_on_finish(cpu_idx, &state_info);
Maheedhar Bollapallic7b0a282024-04-25 11:47:27 +05301026 } else {
Boyan Karatotev2b5e00d2024-12-19 16:07:29 +00001027 unsigned int max_off_lvl = psci_find_max_off_lvl(&state_info);
1028
1029 assert(max_off_lvl != PSCI_INVALID_PWR_LVL);
1030 psci_cpu_suspend_to_powerdown_finish(cpu_idx, max_off_lvl, &state_info);
1031 }
Achin Gupta84c9f102014-07-28 00:09:01 +01001032
1033 /*
Boyan Karatoteve07e7392023-05-17 12:20:09 +01001034 * Generic management: Now we just need to retrieve the
1035 * information that we had stashed away during the cpu_on
1036 * call to set this cpu on its way.
1037 */
1038 cm_prepare_el3_exit_ns();
1039
1040 /*
Soby Mathew67487842015-07-13 14:10:57 +01001041 * Set the requested and target state of this CPU and all the higher
1042 * power domains which are ancestors of this CPU to run.
Achin Gupta0a46e2c2014-07-31 11:19:11 +01001043 */
Boyan Karatotev3b802102024-11-06 16:26:15 +00001044 psci_set_pwr_domains_to_run(cpu_idx, end_pwrlvl);
Achin Gupta0a46e2c2014-07-31 11:19:11 +01001045
Yatharth Kochar170fb932016-05-09 18:26:35 +01001046#if ENABLE_PSCI_STAT
Boyan Karatotev3b802102024-11-06 16:26:15 +00001047 psci_stats_update_pwr_up(cpu_idx, end_pwrlvl, &state_info);
Yatharth Kochar170fb932016-05-09 18:26:35 +01001048#endif
1049
Achin Gupta0a46e2c2014-07-31 11:19:11 +01001050 /*
Soby Mathew67487842015-07-13 14:10:57 +01001051 * This loop releases the lock corresponding to each power level
Achin Gupta0959db52013-12-02 17:33:04 +00001052 * in the reverse order to which they were acquired.
1053 */
Andrew F. Davis74d27d02019-06-04 10:46:54 -04001054 psci_release_pwr_domain_locks(end_pwrlvl, parent_nodes);
Achin Gupta4f6ad662013-10-25 09:08:21 +01001055}
Jeenu Viswambharan7f366602014-02-20 17:11:00 +00001056
1057/*******************************************************************************
1058 * This function initializes the set of hooks that PSCI invokes as part of power
1059 * management operation. The power management hooks are expected to be provided
1060 * by the SPD, after it finishes all its initialization
1061 ******************************************************************************/
Dan Handleyfb037bf2014-04-10 15:37:22 +01001062void psci_register_spd_pm_hook(const spd_pm_ops_t *pm)
Jeenu Viswambharan7f366602014-02-20 17:11:00 +00001063{
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +01001064 assert(pm != NULL);
Jeenu Viswambharan7f366602014-02-20 17:11:00 +00001065 psci_spd_pm = pm;
Soby Mathew90e82582015-01-07 11:10:22 +00001066
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +01001067 if (pm->svc_migrate != NULL)
Soby Mathew90e82582015-01-07 11:10:22 +00001068 psci_caps |= define_psci_cap(PSCI_MIG_AARCH64);
1069
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +01001070 if (pm->svc_migrate_info != NULL)
Soby Mathew90e82582015-01-07 11:10:22 +00001071 psci_caps |= define_psci_cap(PSCI_MIG_INFO_UP_CPU_AARCH64)
1072 | define_psci_cap(PSCI_MIG_INFO_TYPE);
Jeenu Viswambharan7f366602014-02-20 17:11:00 +00001073}
Juan Castillod5f13092014-08-12 11:17:06 +01001074
1075/*******************************************************************************
Soby Mathew8991eed2014-10-23 10:35:34 +01001076 * This function invokes the migrate info hook in the spd_pm_ops. It performs
1077 * the necessary return value validation. If the Secure Payload is UP and
1078 * migrate capable, it returns the mpidr of the CPU on which the Secure payload
1079 * is resident through the mpidr parameter. Else the value of the parameter on
1080 * return is undefined.
1081 ******************************************************************************/
Soby Mathew9d070b92015-07-29 17:05:03 +01001082int psci_spd_migrate_info(u_register_t *mpidr)
Soby Mathew8991eed2014-10-23 10:35:34 +01001083{
1084 int rc;
1085
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +01001086 if ((psci_spd_pm == NULL) || (psci_spd_pm->svc_migrate_info == NULL))
Soby Mathew8991eed2014-10-23 10:35:34 +01001087 return PSCI_E_NOT_SUPPORTED;
1088
1089 rc = psci_spd_pm->svc_migrate_info(mpidr);
1090
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +01001091 assert((rc == PSCI_TOS_UP_MIG_CAP) || (rc == PSCI_TOS_NOT_UP_MIG_CAP) ||
1092 (rc == PSCI_TOS_NOT_PRESENT_MP) || (rc == PSCI_E_NOT_SUPPORTED));
Soby Mathew8991eed2014-10-23 10:35:34 +01001093
1094 return rc;
1095}
1096
1097
1098/*******************************************************************************
Soby Mathew67487842015-07-13 14:10:57 +01001099 * This function prints the state of all power domains present in the
Juan Castillod5f13092014-08-12 11:17:06 +01001100 * system
1101 ******************************************************************************/
Soby Mathew67487842015-07-13 14:10:57 +01001102void psci_print_power_domain_map(void)
Juan Castillod5f13092014-08-12 11:17:06 +01001103{
1104#if LOG_LEVEL >= LOG_LEVEL_INFO
Pankaj Guptaab4df502019-10-15 15:44:45 +05301105 unsigned int idx;
Soby Mathew67487842015-07-13 14:10:57 +01001106 plat_local_state_t state;
1107 plat_local_state_type_t state_type;
1108
Juan Castillod5f13092014-08-12 11:17:06 +01001109 /* This array maps to the PSCI_STATE_X definitions in psci.h */
Soby Mathewda554d72016-05-03 17:11:42 +01001110 static const char * const psci_state_type_str[] = {
Juan Castillod5f13092014-08-12 11:17:06 +01001111 "ON",
Soby Mathew67487842015-07-13 14:10:57 +01001112 "RETENTION",
Juan Castillod5f13092014-08-12 11:17:06 +01001113 "OFF",
Juan Castillod5f13092014-08-12 11:17:06 +01001114 };
1115
Soby Mathew67487842015-07-13 14:10:57 +01001116 INFO("PSCI Power Domain Map:\n");
Pankaj Guptaab4df502019-10-15 15:44:45 +05301117 for (idx = 0; idx < (PSCI_NUM_PWR_DOMAINS - psci_plat_core_count);
Soby Mathew67487842015-07-13 14:10:57 +01001118 idx++) {
1119 state_type = find_local_state_type(
1120 psci_non_cpu_pd_nodes[idx].local_state);
Yann Gautierb9338ee2022-02-14 11:09:23 +01001121 INFO(" Domain Node : Level %u, parent_node %u,"
Soby Mathew67487842015-07-13 14:10:57 +01001122 " State %s (0x%x)\n",
1123 psci_non_cpu_pd_nodes[idx].level,
1124 psci_non_cpu_pd_nodes[idx].parent_node,
1125 psci_state_type_str[state_type],
1126 psci_non_cpu_pd_nodes[idx].local_state);
1127 }
1128
Pankaj Guptaab4df502019-10-15 15:44:45 +05301129 for (idx = 0; idx < psci_plat_core_count; idx++) {
Soby Mathew67487842015-07-13 14:10:57 +01001130 state = psci_get_cpu_local_state_by_idx(idx);
1131 state_type = find_local_state_type(state);
Yann Gautierb9338ee2022-02-14 11:09:23 +01001132 INFO(" CPU Node : MPID 0x%llx, parent_node %u,"
Soby Mathew67487842015-07-13 14:10:57 +01001133 " State %s (0x%x)\n",
Soby Mathew4c0d0392016-06-16 14:52:04 +01001134 (unsigned long long)psci_cpu_pd_nodes[idx].mpidr,
Soby Mathew67487842015-07-13 14:10:57 +01001135 psci_cpu_pd_nodes[idx].parent_node,
1136 psci_state_type_str[state_type],
1137 psci_get_cpu_local_state_by_idx(idx));
Juan Castillod5f13092014-08-12 11:17:06 +01001138 }
1139#endif
1140}
Soby Mathew67487842015-07-13 14:10:57 +01001141
Jeenu Viswambharanb10d4492017-02-16 14:55:15 +00001142/******************************************************************************
1143 * Return whether any secondaries were powered up with CPU_ON call. A CPU that
1144 * have ever been powered up would have set its MPDIR value to something other
1145 * than PSCI_INVALID_MPIDR. Note that MPDIR isn't reset back to
1146 * PSCI_INVALID_MPIDR when a CPU is powered down later, so the return value is
1147 * meaningful only when called on the primary CPU during early boot.
1148 *****************************************************************************/
1149int psci_secondaries_brought_up(void)
1150{
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +01001151 unsigned int idx, n_valid = 0U;
Jeenu Viswambharanb10d4492017-02-16 14:55:15 +00001152
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +01001153 for (idx = 0U; idx < ARRAY_SIZE(psci_cpu_pd_nodes); idx++) {
Jeenu Viswambharanb10d4492017-02-16 14:55:15 +00001154 if (psci_cpu_pd_nodes[idx].mpidr != PSCI_INVALID_MPIDR)
1155 n_valid++;
1156 }
1157
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +01001158 assert(n_valid > 0U);
Jeenu Viswambharanb10d4492017-02-16 14:55:15 +00001159
Antonio Nino Diaz6b7b0f32018-07-17 15:10:08 +01001160 return (n_valid > 1U) ? 1 : 0;
Jeenu Viswambharanb10d4492017-02-16 14:55:15 +00001161}
1162
Jeenu Viswambharanb0408e82017-01-05 11:01:02 +00001163/*******************************************************************************
1164 * Initiate power down sequence, by calling power down operations registered for
1165 * this CPU.
1166 ******************************************************************************/
Boyan Karatotev2b5e00d2024-12-19 16:07:29 +00001167void psci_pwrdown_cpu_start(unsigned int power_level)
Jeenu Viswambharanb0408e82017-01-05 11:01:02 +00001168{
Boyan Karatotev9b1e8002024-10-10 08:11:09 +01001169#if ENABLE_RUNTIME_INSTRUMENTATION
1170
1171 /*
1172 * Flush cache line so that even if CPU power down happens
1173 * the timestamp update is reflected in memory.
1174 */
1175 PMF_CAPTURE_TIMESTAMP(rt_instr_svc,
1176 RT_INSTR_ENTER_CFLUSH,
1177 PMF_CACHE_MAINT);
1178#endif
1179
Jeenu Viswambharanb0408e82017-01-05 11:01:02 +00001180#if HW_ASSISTED_COHERENCY
1181 /*
1182 * With hardware-assisted coherency, the CPU drivers only initiate the
1183 * power down sequence, without performing cache-maintenance operations
Andrew F. Davisc98db6c2018-08-30 12:08:01 -05001184 * in software. Data caches enabled both before and after this call.
Jeenu Viswambharanb0408e82017-01-05 11:01:02 +00001185 */
1186 prepare_cpu_pwr_dwn(power_level);
1187#else
1188 /*
1189 * Without hardware-assisted coherency, the CPU drivers disable data
Andrew F. Davisc98db6c2018-08-30 12:08:01 -05001190 * caches, then perform cache-maintenance operations in software.
Jeenu Viswambharanb0408e82017-01-05 11:01:02 +00001191 *
Andrew F. Davisc98db6c2018-08-30 12:08:01 -05001192 * This also calls prepare_cpu_pwr_dwn() to initiate power down
1193 * sequence, but that function will return with data caches disabled.
1194 * We must ensure that the stack memory is flushed out to memory before
1195 * we start popping from it again.
Jeenu Viswambharanb0408e82017-01-05 11:01:02 +00001196 */
1197 psci_do_pwrdown_cache_maintenance(power_level);
1198#endif
Boyan Karatotev9b1e8002024-10-10 08:11:09 +01001199
1200#if ENABLE_RUNTIME_INSTRUMENTATION
1201 PMF_CAPTURE_TIMESTAMP(rt_instr_svc,
1202 RT_INSTR_EXIT_CFLUSH,
1203 PMF_NO_CACHE_MAINT);
1204#endif
Jeenu Viswambharanb0408e82017-01-05 11:01:02 +00001205}
Sandeep Tripathy22744902020-08-17 20:22:13 +05301206
1207/*******************************************************************************
Boyan Karatotev2b5e00d2024-12-19 16:07:29 +00001208 * Finish a terminal power down sequence, ending with a wfi. In case of wakeup
1209 * will retry the sleep and panic if it persists.
1210 ******************************************************************************/
1211void __dead2 psci_pwrdown_cpu_end_terminal(void)
1212{
Boyan Karatotev45c73282024-09-20 13:37:51 +01001213#if ERRATA_SME_POWER_DOWN
1214 /*
1215 * force SME off to not get power down rejected. Getting here is
1216 * terminal so we don't care if we lose context because of another
1217 * wakeup
1218 */
1219 if (is_feat_sme_supported()) {
1220 write_svcr(0);
1221 isb();
1222 }
1223#endif /* ERRATA_SME_POWER_DOWN */
1224
Boyan Karatotev2b5e00d2024-12-19 16:07:29 +00001225 /*
1226 * Execute a wfi which, in most cases, will allow the power controller
1227 * to physically power down this cpu. Under some circumstances that may
1228 * be denied. Hopefully this is transient, retrying a few times should
1229 * power down.
1230 */
1231 for (int i = 0; i < 32; i++)
1232 psci_power_down_wfi();
1233
1234 /* Wake up wasn't transient. System is probably in a bad state. */
1235 ERROR("Could not power off CPU.\n");
1236 panic();
1237}
1238
1239/*******************************************************************************
1240 * Finish a non-terminal power down sequence, ending with a wfi. In case of
1241 * wakeup will unwind any CPU specific actions and return.
1242 ******************************************************************************/
1243
1244void psci_pwrdown_cpu_end_wakeup(unsigned int power_level)
1245{
1246 /*
1247 * Usually, will be terminal. In some circumstances the powerdown will
1248 * be denied and we'll need to unwind
1249 */
1250 psci_power_down_wfi();
1251
1252 /*
1253 * Waking up does not require hardware-assisted coherency, but that is
1254 * the case for every core that can wake up. Untangling the cache
1255 * coherency code from powerdown is a non-trivial effort which isn't
1256 * needed for our purposes.
1257 */
1258#if !FEAT_PABANDON
1259 ERROR("Systems without FEAT_PABANDON shouldn't wake up.\n");
1260 panic();
1261#else /* FEAT_PABANDON */
1262
1263 /*
1264 * Begin unwinding. Everything can be shared with CPU_ON and co later,
1265 * except the CPU specific bit. Cores that have hardware-assisted
1266 * coherency don't have much to do so just calling the hook again is
1267 * the simplest way to achieve this
1268 */
1269 prepare_cpu_pwr_dwn(power_level);
1270#endif /* FEAT_PABANDON */
1271}
1272
1273/*******************************************************************************
Sandeep Tripathy22744902020-08-17 20:22:13 +05301274 * This function invokes the callback 'stop_func()' with the 'mpidr' of each
1275 * online PE. Caller can pass suitable method to stop a remote core.
1276 *
1277 * 'wait_ms' is the timeout value in milliseconds for the other cores to
1278 * transition to power down state. Passing '0' makes it non-blocking.
1279 *
1280 * The function returns 'PSCI_E_DENIED' if some cores failed to stop within the
1281 * given timeout.
1282 ******************************************************************************/
Boyan Karatotev3b802102024-11-06 16:26:15 +00001283int psci_stop_other_cores(unsigned int this_cpu_idx, unsigned int wait_ms,
Sandeep Tripathy22744902020-08-17 20:22:13 +05301284 void (*stop_func)(u_register_t mpidr))
1285{
Sandeep Tripathy22744902020-08-17 20:22:13 +05301286 /* Invoke stop_func for each core */
Boyan Karatotev3b802102024-11-06 16:26:15 +00001287 for (unsigned int idx = 0U; idx < psci_plat_core_count; idx++) {
Sandeep Tripathy22744902020-08-17 20:22:13 +05301288 /* skip current CPU */
1289 if (idx == this_cpu_idx) {
1290 continue;
1291 }
1292
1293 /* Check if the CPU is ON */
1294 if (psci_get_aff_info_state_by_idx(idx) == AFF_STATE_ON) {
1295 (*stop_func)(psci_cpu_pd_nodes[idx].mpidr);
1296 }
1297 }
1298
1299 /* Need to wait for other cores to shutdown */
1300 if (wait_ms != 0U) {
Maheedhar Bollapallie64cdee2024-04-23 11:49:04 +05301301 for (uint32_t delay_ms = wait_ms; ((delay_ms != 0U) &&
1302 (!psci_is_last_on_cpu(this_cpu_idx))); delay_ms--) {
Sandeep Tripathy22744902020-08-17 20:22:13 +05301303 mdelay(1U);
1304 }
1305
Boyan Karatotev3b802102024-11-06 16:26:15 +00001306 if (!psci_is_last_on_cpu(this_cpu_idx)) {
Sandeep Tripathy22744902020-08-17 20:22:13 +05301307 WARN("Failed to stop all cores!\n");
1308 psci_print_power_domain_map();
1309 return PSCI_E_DENIED;
1310 }
1311 }
1312
1313 return PSCI_E_SUCCESS;
1314}
Lucian Paul-Trifuce14a122022-03-02 21:28:24 +00001315
1316/*******************************************************************************
1317 * This function verifies that all the other cores in the system have been
1318 * turned OFF and the current CPU is the last running CPU in the system.
1319 * Returns true if the current CPU is the last ON CPU or false otherwise.
1320 *
1321 * This API has following differences with psci_is_last_on_cpu
1322 * 1. PSCI states are locked
Lucian Paul-Trifuce14a122022-03-02 21:28:24 +00001323 ******************************************************************************/
Boyan Karatotev3b802102024-11-06 16:26:15 +00001324bool psci_is_last_on_cpu_safe(unsigned int this_core)
Lucian Paul-Trifuce14a122022-03-02 21:28:24 +00001325{
Lucian Paul-Trifuce14a122022-03-02 21:28:24 +00001326 unsigned int parent_nodes[PLAT_MAX_PWR_LVL] = {0};
Lucian Paul-Trifuce14a122022-03-02 21:28:24 +00001327
Jayanth Dodderi Chidanandb41b0822022-08-22 23:46:10 +01001328 psci_get_parent_pwr_domain_nodes(this_core, PLAT_MAX_PWR_LVL, parent_nodes);
Lucian Paul-Trifuce14a122022-03-02 21:28:24 +00001329
Jayanth Dodderi Chidanandb41b0822022-08-22 23:46:10 +01001330 psci_acquire_pwr_domain_locks(PLAT_MAX_PWR_LVL, parent_nodes);
Lucian Paul-Trifuce14a122022-03-02 21:28:24 +00001331
Boyan Karatotev3b802102024-11-06 16:26:15 +00001332 if (!psci_is_last_on_cpu(this_core)) {
Lucian Paul-Trifuce14a122022-03-02 21:28:24 +00001333 psci_release_pwr_domain_locks(PLAT_MAX_PWR_LVL, parent_nodes);
Jayanth Dodderi Chidanandb41b0822022-08-22 23:46:10 +01001334 return false;
Lucian Paul-Trifuce14a122022-03-02 21:28:24 +00001335 }
1336
Jayanth Dodderi Chidanandb41b0822022-08-22 23:46:10 +01001337 psci_release_pwr_domain_locks(PLAT_MAX_PWR_LVL, parent_nodes);
1338
Lucian Paul-Trifuce14a122022-03-02 21:28:24 +00001339 return true;
1340}
Wing Lib88a4412022-09-14 13:18:15 -07001341
1342/*******************************************************************************
1343 * This function verifies that all cores in the system have been turned ON.
1344 * Returns true, if all CPUs are ON or false otherwise.
1345 *
1346 * This API has following differences with psci_are_all_cpus_on
1347 * 1. PSCI states are locked
1348 ******************************************************************************/
Boyan Karatotev3b802102024-11-06 16:26:15 +00001349bool psci_are_all_cpus_on_safe(unsigned int this_core)
Wing Lib88a4412022-09-14 13:18:15 -07001350{
Wing Lib88a4412022-09-14 13:18:15 -07001351 unsigned int parent_nodes[PLAT_MAX_PWR_LVL] = {0};
1352
1353 psci_get_parent_pwr_domain_nodes(this_core, PLAT_MAX_PWR_LVL, parent_nodes);
1354
1355 psci_acquire_pwr_domain_locks(PLAT_MAX_PWR_LVL, parent_nodes);
1356
1357 if (!psci_are_all_cpus_on()) {
1358 psci_release_pwr_domain_locks(PLAT_MAX_PWR_LVL, parent_nodes);
1359 return false;
1360 }
1361
1362 psci_release_pwr_domain_locks(PLAT_MAX_PWR_LVL, parent_nodes);
1363
1364 return true;
1365}