xref: /rk3399_ARM-atf/plat/arm/board/fvp/fvp_pm.c (revision 6331a31a66cdcf53421d3dccd3067f072c6da175)
1 /*
2  * Copyright (c) 2013-2016, ARM Limited and Contributors. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * Redistributions of source code must retain the above copyright notice, this
8  * list of conditions and the following disclaimer.
9  *
10  * Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  *
14  * Neither the name of ARM nor the names of its contributors may be used
15  * to endorse or promote products derived from this software without specific
16  * prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 #include <arch_helpers.h>
32 #include <arm_config.h>
33 #include <assert.h>
34 #include <debug.h>
35 #include <errno.h>
36 #include <mmio.h>
37 #include <platform.h>
38 #include <plat_arm.h>
39 #include <psci.h>
40 #include <v2m_def.h>
41 #include "drivers/pwrc/fvp_pwrc.h"
42 #include "fvp_def.h"
43 #include "fvp_private.h"
44 
45 
46 #if ARM_RECOM_STATE_ID_ENC
47 /*
48  *  The table storing the valid idle power states. Ensure that the
49  *  array entries are populated in ascending order of state-id to
50  *  enable us to use binary search during power state validation.
51  *  The table must be terminated by a NULL entry.
52  */
53 const unsigned int arm_pm_idle_states[] = {
54 	/* State-id - 0x01 */
55 	arm_make_pwrstate_lvl1(ARM_LOCAL_STATE_RUN, ARM_LOCAL_STATE_RET,
56 			ARM_PWR_LVL0, PSTATE_TYPE_STANDBY),
57 	/* State-id - 0x02 */
58 	arm_make_pwrstate_lvl1(ARM_LOCAL_STATE_RUN, ARM_LOCAL_STATE_OFF,
59 			ARM_PWR_LVL0, PSTATE_TYPE_POWERDOWN),
60 	/* State-id - 0x22 */
61 	arm_make_pwrstate_lvl1(ARM_LOCAL_STATE_OFF, ARM_LOCAL_STATE_OFF,
62 			ARM_PWR_LVL1, PSTATE_TYPE_POWERDOWN),
63 	0,
64 };
65 #endif
66 
67 /*******************************************************************************
68  * Function which implements the common FVP specific operations to power down a
69  * cpu in response to a CPU_OFF or CPU_SUSPEND request.
70  ******************************************************************************/
71 static void fvp_cpu_pwrdwn_common(void)
72 {
73 	/* Prevent interrupts from spuriously waking up this cpu */
74 	plat_arm_gic_cpuif_disable();
75 
76 	/* Program the power controller to power off this cpu. */
77 	fvp_pwrc_write_ppoffr(read_mpidr_el1());
78 }
79 
80 /*******************************************************************************
81  * Function which implements the common FVP specific operations to power down a
82  * cluster in response to a CPU_OFF or CPU_SUSPEND request.
83  ******************************************************************************/
84 static void fvp_cluster_pwrdwn_common(void)
85 {
86 	uint64_t mpidr = read_mpidr_el1();
87 
88 	/* Disable coherency if this cluster is to be turned off */
89 	fvp_interconnect_disable();
90 
91 	/* Program the power controller to turn the cluster off */
92 	fvp_pwrc_write_pcoffr(mpidr);
93 }
94 
95 static void fvp_power_domain_on_finish_common(const psci_power_state_t *target_state)
96 {
97 	unsigned long mpidr;
98 
99 	assert(target_state->pwr_domain_state[ARM_PWR_LVL0] ==
100 					ARM_LOCAL_STATE_OFF);
101 
102 	/* Get the mpidr for this cpu */
103 	mpidr = read_mpidr_el1();
104 
105 	/* Perform the common cluster specific operations */
106 	if (target_state->pwr_domain_state[ARM_PWR_LVL1] ==
107 					ARM_LOCAL_STATE_OFF) {
108 		/*
109 		 * This CPU might have woken up whilst the cluster was
110 		 * attempting to power down. In this case the FVP power
111 		 * controller will have a pending cluster power off request
112 		 * which needs to be cleared by writing to the PPONR register.
113 		 * This prevents the power controller from interpreting a
114 		 * subsequent entry of this cpu into a simple wfi as a power
115 		 * down request.
116 		 */
117 		fvp_pwrc_write_pponr(mpidr);
118 
119 		/* Enable coherency if this cluster was off */
120 		fvp_interconnect_enable();
121 	}
122 
123 	/*
124 	 * Clear PWKUPR.WEN bit to ensure interrupts do not interfere
125 	 * with a cpu power down unless the bit is set again
126 	 */
127 	fvp_pwrc_clr_wen(mpidr);
128 }
129 
130 
131 /*******************************************************************************
132  * FVP handler called when a CPU is about to enter standby.
133  ******************************************************************************/
134 void fvp_cpu_standby(plat_local_state_t cpu_state)
135 {
136 
137 	assert(cpu_state == ARM_LOCAL_STATE_RET);
138 
139 	/*
140 	 * Enter standby state
141 	 * dsb is good practice before using wfi to enter low power states
142 	 */
143 	dsb();
144 	wfi();
145 }
146 
147 /*******************************************************************************
148  * FVP handler called when a power domain is about to be turned on. The
149  * mpidr determines the CPU to be turned on.
150  ******************************************************************************/
151 int fvp_pwr_domain_on(u_register_t mpidr)
152 {
153 	int rc = PSCI_E_SUCCESS;
154 	unsigned int psysr;
155 
156 	/*
157 	 * Ensure that we do not cancel an inflight power off request for the
158 	 * target cpu. That would leave it in a zombie wfi. Wait for it to power
159 	 * off and then program the power controller to turn that CPU on.
160 	 */
161 	do {
162 		psysr = fvp_pwrc_read_psysr(mpidr);
163 	} while (psysr & PSYSR_AFF_L0);
164 
165 	fvp_pwrc_write_pponr(mpidr);
166 	return rc;
167 }
168 
169 /*******************************************************************************
170  * FVP handler called when a power domain is about to be turned off. The
171  * target_state encodes the power state that each level should transition to.
172  ******************************************************************************/
173 void fvp_pwr_domain_off(const psci_power_state_t *target_state)
174 {
175 	assert(target_state->pwr_domain_state[ARM_PWR_LVL0] ==
176 					ARM_LOCAL_STATE_OFF);
177 
178 	/*
179 	 * If execution reaches this stage then this power domain will be
180 	 * suspended. Perform at least the cpu specific actions followed
181 	 * by the cluster specific operations if applicable.
182 	 */
183 	fvp_cpu_pwrdwn_common();
184 
185 	if (target_state->pwr_domain_state[ARM_PWR_LVL1] ==
186 					ARM_LOCAL_STATE_OFF)
187 		fvp_cluster_pwrdwn_common();
188 
189 }
190 
191 /*******************************************************************************
192  * FVP handler called when a power domain is about to be suspended. The
193  * target_state encodes the power state that each level should transition to.
194  ******************************************************************************/
195 void fvp_pwr_domain_suspend(const psci_power_state_t *target_state)
196 {
197 	unsigned long mpidr;
198 
199 	/*
200 	 * FVP has retention only at cpu level. Just return
201 	 * as nothing is to be done for retention.
202 	 */
203 	if (target_state->pwr_domain_state[ARM_PWR_LVL0] ==
204 					ARM_LOCAL_STATE_RET)
205 		return;
206 
207 	assert(target_state->pwr_domain_state[ARM_PWR_LVL0] ==
208 					ARM_LOCAL_STATE_OFF);
209 
210 	/* Get the mpidr for this cpu */
211 	mpidr = read_mpidr_el1();
212 
213 	/* Program the power controller to enable wakeup interrupts. */
214 	fvp_pwrc_set_wen(mpidr);
215 
216 	/* Perform the common cpu specific operations */
217 	fvp_cpu_pwrdwn_common();
218 
219 	/* Perform the common cluster specific operations */
220 	if (target_state->pwr_domain_state[ARM_PWR_LVL1] ==
221 					ARM_LOCAL_STATE_OFF)
222 		fvp_cluster_pwrdwn_common();
223 }
224 
225 /*******************************************************************************
226  * FVP handler called when a power domain has just been powered on after
227  * being turned off earlier. The target_state encodes the low power state that
228  * each level has woken up from.
229  ******************************************************************************/
230 void fvp_pwr_domain_on_finish(const psci_power_state_t *target_state)
231 {
232 	fvp_power_domain_on_finish_common(target_state);
233 
234 	/* Enable the gic cpu interface */
235 	plat_arm_gic_pcpu_init();
236 
237 	/* Program the gic per-cpu distributor or re-distributor interface */
238 	plat_arm_gic_cpuif_enable();
239 }
240 
241 /*******************************************************************************
242  * FVP handler called when a power domain has just been powered on after
243  * having been suspended earlier. The target_state encodes the low power state
244  * that each level has woken up from.
245  * TODO: At the moment we reuse the on finisher and reinitialize the secure
246  * context. Need to implement a separate suspend finisher.
247  ******************************************************************************/
248 void fvp_pwr_domain_suspend_finish(const psci_power_state_t *target_state)
249 {
250 	/*
251 	 * Nothing to be done on waking up from retention from CPU level.
252 	 */
253 	if (target_state->pwr_domain_state[ARM_PWR_LVL0] ==
254 					ARM_LOCAL_STATE_RET)
255 		return;
256 
257 	fvp_power_domain_on_finish_common(target_state);
258 
259 	/* Enable the gic cpu interface */
260 	plat_arm_gic_cpuif_enable();
261 }
262 
263 /*******************************************************************************
264  * FVP handlers to shutdown/reboot the system
265  ******************************************************************************/
266 static void __dead2 fvp_system_off(void)
267 {
268 	/* Write the System Configuration Control Register */
269 	mmio_write_32(V2M_SYSREGS_BASE + V2M_SYS_CFGCTRL,
270 		V2M_CFGCTRL_START |
271 		V2M_CFGCTRL_RW |
272 		V2M_CFGCTRL_FUNC(V2M_FUNC_SHUTDOWN));
273 	wfi();
274 	ERROR("FVP System Off: operation not handled.\n");
275 	panic();
276 }
277 
278 static void __dead2 fvp_system_reset(void)
279 {
280 	/* Write the System Configuration Control Register */
281 	mmio_write_32(V2M_SYSREGS_BASE + V2M_SYS_CFGCTRL,
282 		V2M_CFGCTRL_START |
283 		V2M_CFGCTRL_RW |
284 		V2M_CFGCTRL_FUNC(V2M_FUNC_REBOOT));
285 	wfi();
286 	ERROR("FVP System Reset: operation not handled.\n");
287 	panic();
288 }
289 
290 /*******************************************************************************
291  * Export the platform handlers via plat_arm_psci_pm_ops. The ARM Standard
292  * platform layer will take care of registering the handlers with PSCI.
293  ******************************************************************************/
294 const plat_psci_ops_t plat_arm_psci_pm_ops = {
295 	.cpu_standby = fvp_cpu_standby,
296 	.pwr_domain_on = fvp_pwr_domain_on,
297 	.pwr_domain_off = fvp_pwr_domain_off,
298 	.pwr_domain_suspend = fvp_pwr_domain_suspend,
299 	.pwr_domain_on_finish = fvp_pwr_domain_on_finish,
300 	.pwr_domain_suspend_finish = fvp_pwr_domain_suspend_finish,
301 	.system_off = fvp_system_off,
302 	.system_reset = fvp_system_reset,
303 	.validate_power_state = arm_validate_power_state,
304 	.validate_ns_entrypoint = arm_validate_ns_entrypoint
305 };
306