1 /*
2  * OMAP2xxx/3xxx-common Power/Reset Management (PRM) register definitions
3  *
4  * Copyright (C) 2007-2009, 2011-2012 Texas Instruments, Inc.
5  * Copyright (C) 2008-2010 Nokia Corporation
6  * Paul Walmsley
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 as
10  * published by the Free Software Foundation.
11  *
12  * The PRM hardware modules on the OMAP2/3 are quite similar to each
13  * other.  The PRM on OMAP4 has a new register layout, and is handled
14  * in a separate file.
15  */
16 #ifndef __ARCH_ARM_MACH_OMAP2_PRM2XXX_3XXX_H
17 #define __ARCH_ARM_MACH_OMAP2_PRM2XXX_3XXX_H
18 
19 #include "prcm-common.h"
20 #include "prm.h"
21 
22 /*
23  * Module specific PRM register offsets from PRM_BASE + domain offset
24  *
25  * Use prm_{read,write}_mod_reg() with these registers.
26  *
27  * With a few exceptions, these are the register names beginning with
28  * {PM,RM}_* on both OMAP2/3 SoC families..  (The exceptions are the
29  * IRQSTATUS and IRQENABLE bits.)
30  */
31 
32 /* Register offsets appearing on both OMAP2 and OMAP3 */
33 
34 #define OMAP2_RM_RSTCTRL				0x0050
35 #define OMAP2_RM_RSTTIME				0x0054
36 #define OMAP2_RM_RSTST					0x0058
37 #define OMAP2_PM_PWSTCTRL				0x00e0
38 #define OMAP2_PM_PWSTST					0x00e4
39 
40 #define PM_WKEN						0x00a0
41 #define PM_WKEN1					PM_WKEN
42 #define PM_WKST						0x00b0
43 #define PM_WKST1					PM_WKST
44 #define PM_WKDEP					0x00c8
45 #define PM_EVGENCTRL					0x00d4
46 #define PM_EVGENONTIM					0x00d8
47 #define PM_EVGENOFFTIM					0x00dc
48 
49 
50 #ifndef __ASSEMBLER__
51 
52 #include <linux/io.h>
53 #include "powerdomain.h"
54 
55 /* Power/reset management domain register get/set */
56 static inline u32 omap2_prm_read_mod_reg(s16 module, u16 idx)
57 {
58 	return readl_relaxed(prm_base + module + idx);
59 }
60 
61 static inline void omap2_prm_write_mod_reg(u32 val, s16 module, u16 idx)
62 {
63 	writel_relaxed(val, prm_base + module + idx);
64 }
65 
66 /* Read-modify-write a register in a PRM module. Caller must lock */
67 static inline u32 omap2_prm_rmw_mod_reg_bits(u32 mask, u32 bits, s16 module,
68 					     s16 idx)
69 {
70 	u32 v;
71 
72 	v = omap2_prm_read_mod_reg(module, idx);
73 	v &= ~mask;
74 	v |= bits;
75 	omap2_prm_write_mod_reg(v, module, idx);
76 
77 	return v;
78 }
79 
80 /* Read a PRM register, AND it, and shift the result down to bit 0 */
81 static inline u32 omap2_prm_read_mod_bits_shift(s16 domain, s16 idx, u32 mask)
82 {
83 	u32 v;
84 
85 	v = omap2_prm_read_mod_reg(domain, idx);
86 	v &= mask;
87 	v >>= __ffs(mask);
88 
89 	return v;
90 }
91 
92 static inline u32 omap2_prm_set_mod_reg_bits(u32 bits, s16 module, s16 idx)
93 {
94 	return omap2_prm_rmw_mod_reg_bits(bits, bits, module, idx);
95 }
96 
97 static inline u32 omap2_prm_clear_mod_reg_bits(u32 bits, s16 module, s16 idx)
98 {
99 	return omap2_prm_rmw_mod_reg_bits(bits, 0x0, module, idx);
100 }
101 
102 /* These omap2_ PRM functions apply to both OMAP2 and 3 */
103 extern int omap2_prm_is_hardreset_asserted(s16 prm_mod, u8 shift);
104 extern int omap2_prm_assert_hardreset(s16 prm_mod, u8 shift);
105 extern int omap2_prm_deassert_hardreset(s16 prm_mod, u8 rst_shift, u8 st_shift);
106 
107 extern int omap2_pwrdm_set_next_pwrst(struct powerdomain *pwrdm, u8 pwrst);
108 extern int omap2_pwrdm_read_next_pwrst(struct powerdomain *pwrdm);
109 extern int omap2_pwrdm_read_pwrst(struct powerdomain *pwrdm);
110 extern int omap2_pwrdm_set_mem_onst(struct powerdomain *pwrdm, u8 bank,
111 				    u8 pwrst);
112 extern int omap2_pwrdm_set_mem_retst(struct powerdomain *pwrdm, u8 bank,
113 				     u8 pwrst);
114 extern int omap2_pwrdm_read_mem_pwrst(struct powerdomain *pwrdm, u8 bank);
115 extern int omap2_pwrdm_read_mem_retst(struct powerdomain *pwrdm, u8 bank);
116 extern int omap2_pwrdm_set_logic_retst(struct powerdomain *pwrdm, u8 pwrst);
117 extern int omap2_pwrdm_wait_transition(struct powerdomain *pwrdm);
118 
119 extern int omap2_clkdm_add_wkdep(struct clockdomain *clkdm1,
120 				 struct clockdomain *clkdm2);
121 extern int omap2_clkdm_del_wkdep(struct clockdomain *clkdm1,
122 				 struct clockdomain *clkdm2);
123 extern int omap2_clkdm_read_wkdep(struct clockdomain *clkdm1,
124 				  struct clockdomain *clkdm2);
125 extern int omap2_clkdm_clear_all_wkdeps(struct clockdomain *clkdm);
126 
127 #endif /* __ASSEMBLER */
128 
129 /*
130  * Bits common to specific registers
131  *
132  * The 3430 register and bit names are generally used,
133  * since they tend to make more sense
134  */
135 
136 /* PM_EVGENONTIM_MPU */
137 /* Named PM_EVEGENONTIM_MPU on the 24XX */
138 #define OMAP_ONTIMEVAL_SHIFT				0
139 #define OMAP_ONTIMEVAL_MASK				(0xffffffff << 0)
140 
141 /* PM_EVGENOFFTIM_MPU */
142 /* Named PM_EVEGENOFFTIM_MPU on the 24XX */
143 #define OMAP_OFFTIMEVAL_SHIFT				0
144 #define OMAP_OFFTIMEVAL_MASK				(0xffffffff << 0)
145 
146 /* PRM_CLKSETUP and PRCM_VOLTSETUP */
147 /* Named PRCM_CLKSSETUP on the 24XX */
148 #define OMAP_SETUP_TIME_SHIFT				0
149 #define OMAP_SETUP_TIME_MASK				(0xffff << 0)
150 
151 /* PRM_CLKSRC_CTRL */
152 /* Named PRCM_CLKSRC_CTRL on the 24XX */
153 #define OMAP_SYSCLKDIV_SHIFT				6
154 #define OMAP_SYSCLKDIV_MASK				(0x3 << 6)
155 #define OMAP_SYSCLKDIV_WIDTH				2
156 #define OMAP_AUTOEXTCLKMODE_SHIFT			3
157 #define OMAP_AUTOEXTCLKMODE_MASK			(0x3 << 3)
158 #define OMAP_SYSCLKSEL_SHIFT				0
159 #define OMAP_SYSCLKSEL_MASK				(0x3 << 0)
160 
161 /* PM_EVGENCTRL_MPU */
162 #define OMAP_OFFLOADMODE_SHIFT				3
163 #define OMAP_OFFLOADMODE_MASK				(0x3 << 3)
164 #define OMAP_ONLOADMODE_SHIFT				1
165 #define OMAP_ONLOADMODE_MASK				(0x3 << 1)
166 #define OMAP_ENABLE_MASK				(1 << 0)
167 
168 /* PRM_RSTTIME */
169 /* Named RM_RSTTIME_WKUP on the 24xx */
170 #define OMAP_RSTTIME2_SHIFT				8
171 #define OMAP_RSTTIME2_MASK				(0x1f << 8)
172 #define OMAP_RSTTIME1_SHIFT				0
173 #define OMAP_RSTTIME1_MASK				(0xff << 0)
174 
175 /* PRM_RSTCTRL */
176 /* Named RM_RSTCTRL_WKUP on the 24xx */
177 /* 2420 calls RST_DPLL3 'RST_DPLL' */
178 #define OMAP_RST_DPLL3_MASK				(1 << 2)
179 #define OMAP_RST_GS_MASK				(1 << 1)
180 
181 
182 /*
183  * Bits common to module-shared registers
184  *
185  * Not all registers of a particular type support all of these bits -
186  * check TRM if you are unsure
187  */
188 
189 /*
190  * 24XX: RM_RSTST_MPU and RM_RSTST_DSP - on 24XX, 'COREDOMAINWKUP_RST' is
191  *	 called 'COREWKUP_RST'
192  *
193  * 3430: RM_RSTST_IVA2, RM_RSTST_MPU, RM_RSTST_GFX, RM_RSTST_DSS,
194  *	 RM_RSTST_CAM, RM_RSTST_PER, RM_RSTST_NEON
195  */
196 #define OMAP_COREDOMAINWKUP_RST_MASK			(1 << 3)
197 
198 /*
199  * 24XX: RM_RSTST_MPU, RM_RSTST_GFX, RM_RSTST_DSP
200  *
201  * 2430: RM_RSTST_MDM
202  *
203  * 3430: RM_RSTST_CORE, RM_RSTST_EMU
204  */
205 #define OMAP_DOMAINWKUP_RST_MASK			(1 << 2)
206 
207 /*
208  * 24XX: RM_RSTST_MPU, RM_RSTST_WKUP, RM_RSTST_DSP
209  *	 On 24XX, 'GLOBALWARM_RST' is called 'GLOBALWMPU_RST'.
210  *
211  * 2430: RM_RSTST_MDM
212  *
213  * 3430: RM_RSTST_CORE, RM_RSTST_EMU
214  */
215 #define OMAP_GLOBALWARM_RST_SHIFT			1
216 #define OMAP_GLOBALWARM_RST_MASK			(1 << 1)
217 #define OMAP_GLOBALCOLD_RST_SHIFT			0
218 #define OMAP_GLOBALCOLD_RST_MASK			(1 << 0)
219 
220 /*
221  * 24XX: PM_WKDEP_GFX, PM_WKDEP_MPU, PM_WKDEP_CORE, PM_WKDEP_DSP
222  *	 2420 TRM sometimes uses "EN_WAKEUP" instead of "EN_WKUP"
223  *
224  * 2430: PM_WKDEP_MDM
225  *
226  * 3430: PM_WKDEP_IVA2, PM_WKDEP_GFX, PM_WKDEP_DSS, PM_WKDEP_CAM,
227  *	 PM_WKDEP_PER
228  */
229 #define OMAP_EN_WKUP_SHIFT				4
230 #define OMAP_EN_WKUP_MASK				(1 << 4)
231 
232 /*
233  * 24XX: PM_PWSTCTRL_MPU, PM_PWSTCTRL_CORE, PM_PWSTCTRL_GFX,
234  *	 PM_PWSTCTRL_DSP
235  *
236  * 2430: PM_PWSTCTRL_MDM
237  *
238  * 3430: PM_PWSTCTRL_IVA2, PM_PWSTCTRL_CORE, PM_PWSTCTRL_GFX,
239  *	 PM_PWSTCTRL_DSS, PM_PWSTCTRL_CAM, PM_PWSTCTRL_PER,
240  *	 PM_PWSTCTRL_NEON
241  */
242 #define OMAP_LOGICRETSTATE_MASK				(1 << 2)
243 
244 
245 #endif
246