xref: /rk3399_ARM-atf/include/plat/arm/css/common/css_pm.h (revision b3ccb0f2bbefa96f72333dbd4b67d88697e3c1e0)
1 /*
2  * Copyright (c) 2015-2017, 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 #ifndef __CSS_PM_H__
32 #define __CSS_PM_H__
33 
34 #include <cdefs.h>
35 #include <psci.h>
36 #include <types.h>
37 
38 /* System power domain at level 2, as currently implemented by CSS platforms */
39 #define CSS_SYSTEM_PWR_DMN_LVL		ARM_PWR_LVL2
40 
41 /* Macros to read the CSS power domain state */
42 #define CSS_CORE_PWR_STATE(state)	(state)->pwr_domain_state[ARM_PWR_LVL0]
43 #define CSS_CLUSTER_PWR_STATE(state)	(state)->pwr_domain_state[ARM_PWR_LVL1]
44 #define CSS_SYSTEM_PWR_STATE(state)	\
45 			((PLAT_MAX_PWR_LVL == CSS_SYSTEM_PWR_DMN_LVL) ?\
46 			(state)->pwr_domain_state[CSS_SYSTEM_PWR_DMN_LVL] : 0)
47 
48 int css_pwr_domain_on(u_register_t mpidr);
49 void css_pwr_domain_on_finish(const psci_power_state_t *target_state);
50 void css_pwr_domain_off(const psci_power_state_t *target_state);
51 void css_pwr_domain_suspend(const psci_power_state_t *target_state);
52 void css_pwr_domain_suspend_finish(
53 				const psci_power_state_t *target_state);
54 void __dead2 css_system_off(void);
55 void __dead2 css_system_reset(void);
56 void css_cpu_standby(plat_local_state_t cpu_state);
57 void css_get_sys_suspend_power_state(psci_power_state_t *req_state);
58 int css_node_hw_state(u_register_t mpidr, unsigned int power_level);
59 
60 #endif /* __CSS_PM_H__ */
61