1 /*
2  * Copyright (c) 2018-2023, ARM Limited and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #ifndef IMX8M_GPC_H
8 #define IMX8M_GPC_H
9 
10 #include <gpc_reg.h>
11 
12 /* helper macro */
13 #define A53_LPM_MASK	U(0xF)
14 #define A53_LPM_WAIT	U(0x5)
15 #define A53_LPM_STOP	U(0xA)
16 #define LPM_MODE(local_state)		((local_state) == PLAT_WAIT_RET_STATE ? A53_LPM_WAIT : A53_LPM_STOP)
17 
18 #define DSM_MODE_MASK	BIT(31)
19 #define CORE_WKUP_FROM_GIC		(IRQ_SRC_C0 | IRQ_SRC_C1 | IRQ_SRC_C2 | IRQ_SRC_C3)
20 #define A53_CORE_WUP_SRC(core_id)	(1 << ((core_id) < 2 ? 28 + (core_id) : 22 + (core_id) - 2))
21 #define COREx_PGC_PCR(core_id)		(0x800 + (core_id) * 0x40)
22 #define COREx_WFI_PDN(core_id)		(1 << ((core_id) < 2 ? (core_id) * 2 : ((core_id) - 2) * 2 + 16))
23 #define COREx_IRQ_WUP(core_id)		((core_id) < 2 ? (1 << ((core_id) * 2 + 8)) : (1 << ((core_id) * 2 + 20)))
24 #define COREx_LPM_PUP(core_id)		((core_id) < 2 ? (1 << ((core_id) * 2 + 9)) : (1 << ((core_id) * 2 + 21)))
25 #define SLTx_CFG(n)			((SLT0_CFG + ((n) * 4)))
26 #define SLT_COREx_PUP(core_id)		(0x2 << ((core_id) * 2))
27 #define SLT_COREx_PUP_ACK(core_id)	((core_id) < 2 ? (1 << ((core_id) + 16)) : (1 << ((core_id) + 27)))
28 
29 #define IMR_MASK_ALL	0xffffffff
30 
31 #define IMX_PD_DOMAIN(name, on)				\
32 	{						\
33 		.pwr_req = name##_PWR_REQ,		\
34 		.pgc_offset = name##_PGC,		\
35 		.need_sync = false,			\
36 		.always_on = (on),			\
37 	}
38 
39 #define IMX_MIX_DOMAIN(name, on)			\
40 	{						\
41 		.pwr_req = name##_PWR_REQ,		\
42 		.pgc_offset = name##_PGC,		\
43 		.adb400_sync = name##_ADB400_SYNC,	\
44 		.adb400_ack = name##_ADB400_ACK,	\
45 		.need_sync = true,			\
46 		.always_on = (on),			\
47 	}
48 
49 struct imx_pwr_domain {
50 	uint32_t pwr_req;
51 	uint32_t adb400_sync;
52 	uint32_t adb400_ack;
53 	uint32_t pgc_offset;
54 	bool need_sync;
55 	bool always_on;
56 };
57 
58 struct pll_override {
59 	uint32_t reg;
60 	uint32_t override_mask;
61 };
62 
63 DECLARE_BAKERY_LOCK(gpc_lock);
64 
65 /* function declare */
66 void imx_gpc_init(void);
67 void imx_set_cpu_secure_entry(unsigned int core_index, uintptr_t sec_entrypoint);
68 void imx_set_cpu_pwr_off(unsigned int core_index);
69 void imx_set_cpu_pwr_on(unsigned int core_index);
70 void imx_set_cpu_lpm(unsigned int core_index, bool pdn);
71 void imx_set_cluster_standby(bool retention);
72 void imx_set_cluster_powerdown(unsigned int last_core, uint8_t power_state);
73 void imx_noc_slot_config(bool pdn);
74 void imx_set_sys_wakeup(unsigned int last_core, bool pdn);
75 void imx_set_sys_lpm(unsigned last_core, bool retention);
76 void imx_set_rbc_count(void);
77 void imx_clear_rbc_count(void);
78 void imx_anamix_override(bool enter);
79 void imx_gpc_pm_domain_enable(uint32_t domain_id, bool on);
80 
81 #if defined(PLAT_imx8mq)
82 void imx_gpc_set_a53_core_awake(uint32_t core_id);
83 void imx_gpc_core_wake(uint32_t cpumask);
84 #endif
85 
86 #endif /*IMX8M_GPC_H */
87