xref: /rk3399_ARM-atf/plat/arm/common/arm_pm.c (revision 804040d106184a93a9fe188743d1d8a8571dea71)
1 /*
2  * Copyright (c) 2015, 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 <assert.h>
33 #include <errno.h>
34 #include <plat_arm.h>
35 #include <psci.h>
36 
37 #if ARM_RECOM_STATE_ID_ENC
38 extern unsigned int arm_pm_idle_states[];
39 #endif /* __ARM_RECOM_STATE_ID_ENC__ */
40 
41 
42 #if !ARM_RECOM_STATE_ID_ENC
43 /*******************************************************************************
44  * ARM standard platform handler called to check the validity of the power state
45  * parameter.
46  ******************************************************************************/
47 int arm_validate_power_state(unsigned int power_state,
48 			    psci_power_state_t *req_state)
49 {
50 	int pstate = psci_get_pstate_type(power_state);
51 	int pwr_lvl = psci_get_pstate_pwrlvl(power_state);
52 	int i;
53 
54 	assert(req_state);
55 
56 	if (pwr_lvl > PLAT_MAX_PWR_LVL)
57 		return PSCI_E_INVALID_PARAMS;
58 
59 	/* Sanity check the requested state */
60 	if (pstate == PSTATE_TYPE_STANDBY) {
61 		/*
62 		 * It's possible to enter standby only on power level 0
63 		 * Ignore any other power level.
64 		 */
65 		if (pwr_lvl != ARM_PWR_LVL0)
66 			return PSCI_E_INVALID_PARAMS;
67 
68 		req_state->pwr_domain_state[ARM_PWR_LVL0] =
69 					ARM_LOCAL_STATE_RET;
70 	} else {
71 		for (i = ARM_PWR_LVL0; i <= pwr_lvl; i++)
72 			req_state->pwr_domain_state[i] =
73 					ARM_LOCAL_STATE_OFF;
74 	}
75 
76 	/*
77 	 * We expect the 'state id' to be zero.
78 	 */
79 	if (psci_get_pstate_id(power_state))
80 		return PSCI_E_INVALID_PARAMS;
81 
82 	return PSCI_E_SUCCESS;
83 }
84 
85 #else
86 /*******************************************************************************
87  * ARM standard platform handler called to check the validity of the power
88  * state parameter. The power state parameter has to be a composite power
89  * state.
90  ******************************************************************************/
91 int arm_validate_power_state(unsigned int power_state,
92 				psci_power_state_t *req_state)
93 {
94 	unsigned int state_id;
95 	int i;
96 
97 	assert(req_state);
98 
99 	/*
100 	 *  Currently we are using a linear search for finding the matching
101 	 *  entry in the idle power state array. This can be made a binary
102 	 *  search if the number of entries justify the additional complexity.
103 	 */
104 	for (i = 0; !!arm_pm_idle_states[i]; i++) {
105 		if (power_state == arm_pm_idle_states[i])
106 			break;
107 	}
108 
109 	/* Return error if entry not found in the idle state array */
110 	if (!arm_pm_idle_states[i])
111 		return PSCI_E_INVALID_PARAMS;
112 
113 	i = 0;
114 	state_id = psci_get_pstate_id(power_state);
115 
116 	/* Parse the State ID and populate the state info parameter */
117 	while (state_id) {
118 		req_state->pwr_domain_state[i++] = state_id &
119 						ARM_LOCAL_PSTATE_MASK;
120 		state_id >>= ARM_LOCAL_PSTATE_WIDTH;
121 	}
122 
123 	return PSCI_E_SUCCESS;
124 }
125 #endif /* __ARM_RECOM_STATE_ID_ENC__ */
126