1 /*
2  * Copyright (c) 2018-2021, Arm Limited and Contributors. All rights reserved.
3  * Copyright (c) 2022-2024, Advanced Micro Devices, Inc. All rights reserved.
4  *
5  * SPDX-License-Identifier: BSD-3-Clause
6  */
7 
8 #include <assert.h>
9 
10 #include <common/debug.h>
11 #include <lib/mmio.h>
12 #include <lib/psci/psci.h>
13 #include <plat/arm/common/plat_arm.h>
14 #include <plat/common/platform.h>
15 #include <plat_arm.h>
16 
17 #include "drivers/delay_timer.h"
18 #include <plat_private.h>
19 #include "pm_api_sys.h"
20 #include "pm_client.h"
21 #include <pm_common.h>
22 #include "pm_ipi.h"
23 #include "pm_svc_main.h"
24 
25 static uintptr_t versal_sec_entry;
26 
versal_pwr_domain_on(u_register_t mpidr)27 static int32_t versal_pwr_domain_on(u_register_t mpidr)
28 {
29 	int32_t cpu_id = plat_core_pos_by_mpidr(mpidr);
30 	const struct pm_proc *proc;
31 
32 	VERBOSE("%s: mpidr: 0x%lx\n", __func__, mpidr);
33 
34 	if (cpu_id == -1) {
35 		return PSCI_E_INTERN_FAIL;
36 	}
37 
38 	proc = pm_get_proc((uint32_t)cpu_id);
39 	if (proc == NULL) {
40 		return PSCI_E_INTERN_FAIL;
41 	}
42 
43 	/* Send request to PMC to wake up selected ACPU core */
44 	(void)pm_req_wakeup(proc->node_id, (versal_sec_entry & 0xFFFFFFFFU) | 0x1U,
45 			    versal_sec_entry >> 32, 0, SECURE_FLAG);
46 
47 	/* Clear power down request */
48 	pm_client_wakeup(proc);
49 
50 	return PSCI_E_SUCCESS;
51 }
52 
53 /**
54  * versal_pwr_domain_suspend() - This function sends request to PMC to suspend
55  *                               core.
56  * @target_state: Targated state.
57  *
58  */
versal_pwr_domain_suspend(const psci_power_state_t * target_state)59 static void versal_pwr_domain_suspend(const psci_power_state_t *target_state)
60 {
61 	uint32_t state;
62 	uint32_t cpu_id = plat_my_core_pos();
63 	const struct pm_proc *proc = pm_get_proc(cpu_id);
64 
65 	if (proc == NULL) {
66 		return;
67 	}
68 
69 	for (size_t i = 0U; i <= PLAT_MAX_PWR_LVL; i++) {
70 		VERBOSE("%s: target_state->pwr_domain_state[%lu]=%x\n",
71 			__func__, i, target_state->pwr_domain_state[i]);
72 	}
73 
74 	plat_versal_gic_cpuif_disable();
75 
76 	if (target_state->pwr_domain_state[1] > PLAT_MAX_RET_STATE) {
77 		plat_versal_gic_save();
78 	}
79 
80 	state = target_state->pwr_domain_state[1] > PLAT_MAX_RET_STATE ?
81 		PM_STATE_SUSPEND_TO_RAM : PM_STATE_CPU_IDLE;
82 
83 	/* Send request to PMC to suspend this core */
84 	(void)pm_self_suspend(proc->node_id, MAX_LATENCY, state, versal_sec_entry,
85 			      SECURE_FLAG);
86 
87 	/* APU is to be turned off */
88 	if (target_state->pwr_domain_state[1] > PLAT_MAX_RET_STATE) {
89 		/* disable coherency */
90 		plat_arm_interconnect_exit_coherency();
91 	}
92 }
93 
94 /**
95  * versal_pwr_domain_suspend_finish() - This function performs actions to finish
96  *                                      suspend procedure.
97  * @target_state: Targated state.
98  *
99  */
versal_pwr_domain_suspend_finish(const psci_power_state_t * target_state)100 static void versal_pwr_domain_suspend_finish(
101 					const psci_power_state_t *target_state)
102 {
103 	uint32_t cpu_id = plat_my_core_pos();
104 	const struct pm_proc *proc = pm_get_proc(cpu_id);
105 
106 	if (proc == NULL) {
107 		return;
108 	}
109 
110 	for (size_t i = 0U; i <= PLAT_MAX_PWR_LVL; i++) {
111 		VERBOSE("%s: target_state->pwr_domain_state[%lu]=%x\n",
112 			__func__, i, target_state->pwr_domain_state[i]);
113 	}
114 
115 	/* Clear the APU power control register for this cpu */
116 	pm_client_wakeup(proc);
117 
118 	/* enable coherency */
119 	plat_arm_interconnect_enter_coherency();
120 
121 	/* APU was turned off, so restore GIC context */
122 	if (target_state->pwr_domain_state[1] > PLAT_MAX_RET_STATE) {
123 		plat_versal_gic_resume();
124 	}
125 
126 	plat_versal_gic_cpuif_enable();
127 }
128 
versal_pwr_domain_on_finish(const psci_power_state_t * target_state)129 void versal_pwr_domain_on_finish(const psci_power_state_t *target_state)
130 {
131 	/* Enable the gic cpu interface */
132 	plat_versal_gic_pcpu_init();
133 
134 	/* Program the gic per-cpu distributor or re-distributor interface */
135 	plat_versal_gic_cpuif_enable();
136 }
137 
138 /**
139  * versal_system_off() - This function sends the system off request to firmware.
140  *                       This function does not return.
141  *
142  */
versal_system_off(void)143 static void __dead2 versal_system_off(void)
144 {
145 	/* Send the power down request to the PMC */
146 	(void)pm_system_shutdown(XPM_SHUTDOWN_TYPE_SHUTDOWN,
147 				 pm_get_shutdown_scope(), SECURE_FLAG);
148 
149 	while (1) {
150 		wfi();
151 	}
152 }
153 
154 /**
155  * versal_system_reset() - This function sends the reset request to firmware
156  *                         for the system to reset.  This function does not
157  *			   return.
158  *
159  */
versal_system_reset(void)160 static void __dead2 versal_system_reset(void)
161 {
162 	uint32_t ret, timeout = 10000U;
163 
164 	request_cpu_pwrdwn();
165 
166 	/*
167 	 * Send the system reset request to the firmware if power down request
168 	 * is not received from firmware.
169 	 */
170 	if (!pwrdwn_req_received) {
171 		(void)pm_system_shutdown(XPM_SHUTDOWN_TYPE_RESET,
172 					 pm_get_shutdown_scope(), SECURE_FLAG);
173 
174 		/*
175 		 * Wait for system shutdown request completed and idle callback
176 		 * not received.
177 		 */
178 		do {
179 			ret = ipi_mb_enquire_status(primary_proc->ipi->local_ipi_id,
180 						    primary_proc->ipi->remote_ipi_id);
181 			udelay(100);
182 			timeout--;
183 		} while ((ret != IPI_MB_STATUS_RECV_PENDING) && (timeout > 0U));
184 	}
185 
186 	(void)psci_cpu_off();
187 
188 	while (1) {
189 		wfi();
190 	}
191 }
192 
193 /**
194  * versal_pwr_domain_off() - This function performs actions to turn off core.
195  * @target_state: Targated state.
196  *
197  */
versal_pwr_domain_off(const psci_power_state_t * target_state)198 static void versal_pwr_domain_off(const psci_power_state_t *target_state)
199 {
200 	uint32_t ret, fw_api_version, version[PAYLOAD_ARG_CNT] = {0U};
201 	uint32_t cpu_id = plat_my_core_pos();
202 	const struct pm_proc *proc = pm_get_proc(cpu_id);
203 
204 	if (proc == NULL) {
205 		return;
206 	}
207 
208 	for (size_t i = 0U; i <= PLAT_MAX_PWR_LVL; i++) {
209 		VERBOSE("%s: target_state->pwr_domain_state[%lu]=%x\n",
210 			__func__, i, target_state->pwr_domain_state[i]);
211 	}
212 
213 	/* Prevent interrupts from spuriously waking up this cpu */
214 	plat_versal_gic_cpuif_disable();
215 
216 	/*
217 	 * Send request to PMC to power down the appropriate APU CPU
218 	 * core.
219 	 * According to PSCI specification, CPU_off function does not
220 	 * have resume address and CPU core can only be woken up
221 	 * invoking CPU_on function, during which resume address will
222 	 * be set.
223 	 */
224 	ret = pm_feature_check((uint32_t)PM_SELF_SUSPEND, &version[0], SECURE_FLAG);
225 	if (ret == PM_RET_SUCCESS) {
226 		fw_api_version = version[0] & 0xFFFFU;
227 		if (fw_api_version >= 3U) {
228 			(void)pm_self_suspend(proc->node_id, MAX_LATENCY, PM_STATE_CPU_OFF, 0,
229 					      SECURE_FLAG);
230 		} else {
231 			(void)pm_self_suspend(proc->node_id, MAX_LATENCY, PM_STATE_CPU_IDLE, 0,
232 					      SECURE_FLAG);
233 		}
234 	}
235 }
236 
237 /**
238  * versal_validate_power_state() - This function ensures that the power state
239  *                                 parameter in request is valid.
240  * @power_state: Power state of core.
241  * @req_state: Requested state.
242  *
243  * Return: Returns status, either success or reason.
244  *
245  */
versal_validate_power_state(uint32_t power_state,psci_power_state_t * req_state)246 static int32_t versal_validate_power_state(uint32_t power_state,
247 				       psci_power_state_t *req_state)
248 {
249 	VERBOSE("%s: power_state: 0x%x\n", __func__, power_state);
250 
251 	uint32_t pstate = psci_get_pstate_type(power_state);
252 
253 	assert(req_state);
254 
255 	/* Sanity check the requested state */
256 	if (pstate == PSTATE_TYPE_STANDBY) {
257 		req_state->pwr_domain_state[MPIDR_AFFLVL0] = PLAT_MAX_RET_STATE;
258 	} else {
259 		req_state->pwr_domain_state[MPIDR_AFFLVL0] = PLAT_MAX_OFF_STATE;
260 	}
261 
262 	/* We expect the 'state id' to be zero */
263 	if (psci_get_pstate_id(power_state) != 0U) {
264 		return PSCI_E_INVALID_PARAMS;
265 	}
266 
267 	return PSCI_E_SUCCESS;
268 }
269 
270 /**
271  * versal_get_sys_suspend_power_state() - Get power state for system suspend.
272  * @req_state: Requested state.
273  *
274  */
versal_get_sys_suspend_power_state(psci_power_state_t * req_state)275 static void versal_get_sys_suspend_power_state(psci_power_state_t *req_state)
276 {
277 	req_state->pwr_domain_state[PSCI_CPU_PWR_LVL] = PLAT_MAX_OFF_STATE;
278 	req_state->pwr_domain_state[1] = PLAT_MAX_OFF_STATE;
279 }
280 
281 static const struct plat_psci_ops versal_nopmc_psci_ops = {
282 	.pwr_domain_on			= versal_pwr_domain_on,
283 	.pwr_domain_off			= versal_pwr_domain_off,
284 	.pwr_domain_on_finish		= versal_pwr_domain_on_finish,
285 	.pwr_domain_suspend		= versal_pwr_domain_suspend,
286 	.pwr_domain_suspend_finish	= versal_pwr_domain_suspend_finish,
287 	.system_off			= versal_system_off,
288 	.system_reset			= versal_system_reset,
289 	.validate_power_state		= versal_validate_power_state,
290 	.get_sys_suspend_power_state	= versal_get_sys_suspend_power_state,
291 };
292 
293 /*******************************************************************************
294  * Export the platform specific power ops.
295  ******************************************************************************/
plat_setup_psci_ops(uintptr_t sec_entrypoint,const struct plat_psci_ops ** psci_ops)296 int32_t plat_setup_psci_ops(uintptr_t sec_entrypoint,
297 			const struct plat_psci_ops **psci_ops)
298 {
299 	versal_sec_entry = sec_entrypoint;
300 
301 	*psci_ops = &versal_nopmc_psci_ops;
302 
303 	return 0;
304 }
305