xref: /rk3399_ARM-atf/plat/arm/common/arm_pm.c (revision 3a1b7b108aec527597075b48aa929a622fff23da)
1 /*
2  * Copyright (c) 2015-2018, ARM Limited and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #include <arch_helpers.h>
8 #include <arm_def.h>
9 #include <arm_gic.h>
10 #include <assert.h>
11 #include <errno.h>
12 #include <plat_arm.h>
13 #include <platform.h>
14 #include <platform_def.h>
15 #include <psci.h>
16 
17 /* Allow ARM Standard platforms to override this function */
18 #pragma weak plat_arm_psci_override_pm_ops
19 
20 /* Standard ARM platforms are expected to export plat_arm_psci_pm_ops */
21 extern plat_psci_ops_t plat_arm_psci_pm_ops;
22 
23 #if ARM_RECOM_STATE_ID_ENC
24 extern unsigned int arm_pm_idle_states[];
25 #endif /* __ARM_RECOM_STATE_ID_ENC__ */
26 
27 #if !ARM_RECOM_STATE_ID_ENC
28 /*******************************************************************************
29  * ARM standard platform handler called to check the validity of the power state
30  * parameter.
31  ******************************************************************************/
32 int arm_validate_power_state(unsigned int power_state,
33 			    psci_power_state_t *req_state)
34 {
35 	int pstate = psci_get_pstate_type(power_state);
36 	int pwr_lvl = psci_get_pstate_pwrlvl(power_state);
37 	int i;
38 
39 	assert(req_state);
40 
41 	if (pwr_lvl > PLAT_MAX_PWR_LVL)
42 		return PSCI_E_INVALID_PARAMS;
43 
44 	/* Sanity check the requested state */
45 	if (pstate == PSTATE_TYPE_STANDBY) {
46 		/*
47 		 * It's possible to enter standby only on power level 0
48 		 * Ignore any other power level.
49 		 */
50 		if (pwr_lvl != ARM_PWR_LVL0)
51 			return PSCI_E_INVALID_PARAMS;
52 
53 		req_state->pwr_domain_state[ARM_PWR_LVL0] =
54 					ARM_LOCAL_STATE_RET;
55 	} else {
56 		for (i = ARM_PWR_LVL0; i <= pwr_lvl; i++)
57 			req_state->pwr_domain_state[i] =
58 					ARM_LOCAL_STATE_OFF;
59 	}
60 
61 	/*
62 	 * We expect the 'state id' to be zero.
63 	 */
64 	if (psci_get_pstate_id(power_state))
65 		return PSCI_E_INVALID_PARAMS;
66 
67 	return PSCI_E_SUCCESS;
68 }
69 
70 #else
71 /*******************************************************************************
72  * ARM standard platform handler called to check the validity of the power
73  * state parameter. The power state parameter has to be a composite power
74  * state.
75  ******************************************************************************/
76 int arm_validate_power_state(unsigned int power_state,
77 				psci_power_state_t *req_state)
78 {
79 	unsigned int state_id;
80 	int i;
81 
82 	assert(req_state);
83 
84 	/*
85 	 *  Currently we are using a linear search for finding the matching
86 	 *  entry in the idle power state array. This can be made a binary
87 	 *  search if the number of entries justify the additional complexity.
88 	 */
89 	for (i = 0; !!arm_pm_idle_states[i]; i++) {
90 		if (power_state == arm_pm_idle_states[i])
91 			break;
92 	}
93 
94 	/* Return error if entry not found in the idle state array */
95 	if (!arm_pm_idle_states[i])
96 		return PSCI_E_INVALID_PARAMS;
97 
98 	i = 0;
99 	state_id = psci_get_pstate_id(power_state);
100 
101 	/* Parse the State ID and populate the state info parameter */
102 	while (state_id) {
103 		req_state->pwr_domain_state[i++] = state_id &
104 						ARM_LOCAL_PSTATE_MASK;
105 		state_id >>= ARM_LOCAL_PSTATE_WIDTH;
106 	}
107 
108 	return PSCI_E_SUCCESS;
109 }
110 #endif /* __ARM_RECOM_STATE_ID_ENC__ */
111 
112 /*******************************************************************************
113  * ARM standard platform handler called to check the validity of the non secure
114  * entrypoint. Returns 0 if the entrypoint is valid, or -1 otherwise.
115  ******************************************************************************/
116 int arm_validate_ns_entrypoint(uintptr_t entrypoint)
117 {
118 	/*
119 	 * Check if the non secure entrypoint lies within the non
120 	 * secure DRAM.
121 	 */
122 	if ((entrypoint >= ARM_NS_DRAM1_BASE) && (entrypoint <
123 			(ARM_NS_DRAM1_BASE + ARM_NS_DRAM1_SIZE))) {
124 		return 0;
125 	}
126 #ifndef AARCH32
127 	if ((entrypoint >= ARM_DRAM2_BASE) && (entrypoint <
128 			(ARM_DRAM2_BASE + ARM_DRAM2_SIZE))) {
129 		return 0;
130 	}
131 #endif
132 
133 	return -1;
134 }
135 
136 int arm_validate_psci_entrypoint(uintptr_t entrypoint)
137 {
138 	return arm_validate_ns_entrypoint(entrypoint) == 0 ? PSCI_E_SUCCESS :
139 		PSCI_E_INVALID_ADDRESS;
140 }
141 
142 /******************************************************************************
143  * Default definition on ARM standard platforms to override the plat_psci_ops.
144  *****************************************************************************/
145 const plat_psci_ops_t *plat_arm_psci_override_pm_ops(plat_psci_ops_t *ops)
146 {
147 	return ops;
148 }
149 
150 /******************************************************************************
151  * Helper function to save the platform state before a system suspend. Save the
152  * state of the system components which are not in the Always ON power domain.
153  *****************************************************************************/
154 void arm_system_pwr_domain_save(void)
155 {
156 	/* Assert system power domain is available on the platform */
157 	assert(PLAT_MAX_PWR_LVL >= ARM_PWR_LVL2);
158 
159 	plat_arm_gic_save();
160 
161 	/*
162 	 * Unregister console now so that it is not registered for a second
163 	 * time during resume.
164 	 */
165 	arm_console_runtime_end();
166 
167 	/*
168 	 * All the other peripheral which are configured by ARM TF are
169 	 * re-initialized on resume from system suspend. Hence we
170 	 * don't save their state here.
171 	 */
172 }
173 
174 /******************************************************************************
175  * Helper function to resume the platform from system suspend. Reinitialize
176  * the system components which are not in the Always ON power domain.
177  * TODO: Unify the platform setup when waking up from cold boot and system
178  * resume in arm_bl31_platform_setup().
179  *****************************************************************************/
180 void arm_system_pwr_domain_resume(void)
181 {
182 	/* Initialize the console */
183 	arm_console_runtime_init();
184 
185 	/* Assert system power domain is available on the platform */
186 	assert(PLAT_MAX_PWR_LVL >= ARM_PWR_LVL2);
187 
188 	plat_arm_gic_resume();
189 
190 	plat_arm_security_setup();
191 	arm_configure_sys_timer();
192 }
193 
194 /*******************************************************************************
195  * Private function to program the mailbox for a cpu before it is released
196  * from reset. This function assumes that the Trusted mail box base is within
197  * the ARM_SHARED_RAM region
198  ******************************************************************************/
199 void arm_program_trusted_mailbox(uintptr_t address)
200 {
201 	uintptr_t *mailbox = (void *) PLAT_ARM_TRUSTED_MAILBOX_BASE;
202 
203 	*mailbox = address;
204 
205 	/*
206 	 * Ensure that the PLAT_ARM_TRUSTED_MAILBOX_BASE is within
207 	 * ARM_SHARED_RAM region.
208 	 */
209 	assert((PLAT_ARM_TRUSTED_MAILBOX_BASE >= ARM_SHARED_RAM_BASE) &&
210 		((PLAT_ARM_TRUSTED_MAILBOX_BASE + sizeof(*mailbox)) <= \
211 				(ARM_SHARED_RAM_BASE + ARM_SHARED_RAM_SIZE)));
212 }
213 
214 /*******************************************************************************
215  * The ARM Standard platform definition of platform porting API
216  * `plat_setup_psci_ops`.
217  ******************************************************************************/
218 int plat_setup_psci_ops(uintptr_t sec_entrypoint,
219 				const plat_psci_ops_t **psci_ops)
220 {
221 	*psci_ops = plat_arm_psci_override_pm_ops(&plat_arm_psci_pm_ops);
222 
223 	/* Setup mailbox with entry point. */
224 	arm_program_trusted_mailbox(sec_entrypoint);
225 	return 0;
226 }
227