247488378af5d3aa164dd75a7d09135205aa3889
[linux-3.10.git] / arch / arm / mach-tegra / pm.h
1 /*
2  * arch/arm/mach-tegra/include/mach/pm.h
3  *
4  * Copyright (C) 2010 Google, Inc.
5  *
6  * Author:
7  *      Colin Cross <ccross@google.com>
8  *
9  * Copyright (c) 2010-2013, NVIDIA CORPORATION.  All rights reserved.
10  *
11  * This program is free software; you can redistribute it and/or modify it
12  * under the terms and conditions of the GNU General Public License,
13  * version 2, as published by the Free Software Foundation.
14  *
15  * This program is distributed in the hope it will be useful, but WITHOUT
16  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
17  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
18  * more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
22  */
23
24
25 #ifndef _MACH_TEGRA_PM_H_
26 #define _MACH_TEGRA_PM_H_
27
28 #include <linux/mutex.h>
29 #include <linux/init.h>
30 #include <linux/errno.h>
31 #include <linux/clkdev.h>
32
33 #include "iomap.h"
34
35 #define PMC_SCRATCH0            0x50
36 #define PMC_SCRATCH1            0x54
37 #define PMC_SCRATCH4            0x60
38
39 enum tegra_suspend_mode {
40         TEGRA_SUSPEND_NONE = 0,
41         TEGRA_SUSPEND_LP2,      /* CPU voltage off */
42         TEGRA_SUSPEND_LP1,      /* CPU voltage off, DRAM self-refresh */
43         TEGRA_SUSPEND_LP0,      /* CPU + core voltage off, DRAM self-refresh */
44         TEGRA_MAX_SUSPEND_MODE,
45 };
46
47 enum suspend_stage {
48         TEGRA_SUSPEND_BEFORE_PERIPHERAL,
49         TEGRA_SUSPEND_BEFORE_CPU,
50 };
51
52 enum resume_stage {
53         TEGRA_RESUME_AFTER_PERIPHERAL,
54         TEGRA_RESUME_AFTER_CPU,
55 };
56
57 struct tegra_suspend_platform_data {
58         unsigned long cpu_timer;   /* CPU power good time in us,  LP2/LP1 */
59         unsigned long cpu_off_timer;    /* CPU power off time us, LP2/LP1 */
60         unsigned long core_timer;  /* core power good time in ticks,  LP0 */
61         unsigned long core_off_timer;   /* core power off time ticks, LP0 */
62         bool corereq_high;         /* Core power request active-high */
63         bool sysclkreq_high;       /* System clock request is active-high */
64         bool sysclkreq_gpio;       /* if System clock request is set to gpio */
65         bool combined_req;         /* if core & CPU power requests are combined */
66         enum tegra_suspend_mode suspend_mode;
67         unsigned long cpu_lp2_min_residency; /* Min LP2 state residency in us */
68         void (*board_suspend)(int lp_state, enum suspend_stage stg);
69         /* lp_state = 0 for LP0 state, 1 for LP1 state, 2 for LP2 state */
70         void (*board_resume)(int lp_state, enum resume_stage stg);
71         unsigned int cpu_resume_boost;  /* CPU frequency resume boost in kHz */
72 #ifdef CONFIG_TEGRA_LP1_LOW_COREVOLTAGE
73         bool lp1_lowvolt_support;
74         unsigned int i2c_base_addr;
75         unsigned int pmuslave_addr;
76         unsigned int core_reg_addr;
77         unsigned int lp1_core_volt_low_cold;
78         unsigned int lp1_core_volt_low;
79         unsigned int lp1_core_volt_high;
80 #endif
81 #ifdef CONFIG_ARCH_TEGRA_HAS_SYMMETRIC_CPU_PWR_GATE
82         unsigned long min_residency_vmin_fmin;
83         unsigned long min_residency_ncpu_slow;
84         unsigned long min_residency_ncpu_fast;
85         unsigned long min_residency_crail;
86 #endif
87         unsigned long min_residency_mc_clk;
88         bool usb_vbus_internal_wake; /* support for internal vbus wake */
89         bool usb_id_internal_wake; /* support for internal id wake */
90 };
91
92 /* clears io dpd settings before kernel code */
93 void tegra_bl_io_dpd_cleanup(void);
94
95 unsigned long tegra_cpu_power_good_time(void);
96 unsigned long tegra_cpu_power_off_time(void);
97 unsigned long tegra_cpu_lp2_min_residency(void);
98 unsigned long tegra_mc_clk_stop_min_residency(void);
99 #ifdef CONFIG_ARCH_TEGRA_HAS_SYMMETRIC_CPU_PWR_GATE
100 unsigned long tegra_min_residency_vmin_fmin(void);
101 unsigned long tegra_min_residency_ncpu(void);
102 unsigned long tegra_min_residency_crail(void);
103 #endif
104 void tegra_clear_cpu_in_pd(int cpu);
105 bool tegra_set_cpu_in_pd(int cpu);
106
107 void tegra_mc_clk_prepare(void);
108 void tegra_mc_clk_finish(void);
109 int tegra_suspend_dram(enum tegra_suspend_mode mode, unsigned int flags);
110 #ifdef CONFIG_TEGRA_LP1_LOW_COREVOLTAGE
111 int tegra_is_lp1_suspend_mode(void);
112 #endif
113
114 #ifdef CONFIG_ARCH_TEGRA_14x_SOC
115 #define FLOW_CTRL_CLUSTER_CONTROL \
116         (IO_ADDRESS(TEGRA_FLOW_CTRL_BASE) + 0x2c)
117 #endif
118
119 #define FLOW_CTRL_CPU_PWR_CSR \
120         (IO_ADDRESS(TEGRA_FLOW_CTRL_BASE) + 0x38)
121 #define FLOW_CTRL_CPU_PWR_CSR_RAIL_ENABLE       1
122
123 #define FLOW_CTRL_MPID \
124         (IO_ADDRESS(TEGRA_FLOW_CTRL_BASE) + 0x3c)
125
126 #define FLOW_CTRL_RAM_REPAIR \
127         (IO_ADDRESS(TEGRA_FLOW_CTRL_BASE) + 0x40)
128 #define FLOW_CTRL_RAM_REPAIR_BYPASS_EN  (1<<2)
129
130 #define FUSE_SKU_DIRECT_CONFIG \
131         (IO_ADDRESS(TEGRA_FUSE_BASE) + 0x1F4)
132 #define FUSE_SKU_DISABLE_ALL_CPUS       (1<<5)
133 #define FUSE_SKU_NUM_DISABLED_CPUS(x)   (((x) >> 3) & 3)
134
135 void __init tegra_init_suspend(struct tegra_suspend_platform_data *plat);
136
137 u64 tegra_rtc_read_ms(void);
138
139 /*
140  * Callbacks for platform drivers to implement.
141  */
142 extern void (*tegra_deep_sleep)(int);
143
144 unsigned int tegra_idle_power_down_last(unsigned int us, unsigned int flags);
145
146 #if defined(CONFIG_PM_SLEEP) && !defined(CONFIG_ARCH_TEGRA_2x_SOC)
147 void tegra_lp0_suspend_mc(void);
148 void tegra_lp0_resume_mc(void);
149 void tegra_lp0_cpu_mode(bool enter);
150 #else
151 static inline void tegra_lp0_suspend_mc(void) {}
152 static inline void tegra_lp0_resume_mc(void) {}
153 static inline void tegra_lp0_cpu_mode(bool enter) {}
154 #endif
155
156 #ifdef CONFIG_TEGRA_CLUSTER_CONTROL
157 #define INSTRUMENT_CLUSTER_SWITCH 0     /* Should be zero for shipping code */
158 #define DEBUG_CLUSTER_SWITCH 0          /* Should be zero for shipping code */
159 #define PARAMETERIZE_CLUSTER_SWITCH 1   /* Should be zero for shipping code */
160
161 static inline bool is_g_cluster_present(void)
162 {
163         u32 fuse_sku = readl(FUSE_SKU_DIRECT_CONFIG);
164         if (fuse_sku & FUSE_SKU_DISABLE_ALL_CPUS)
165                 return false;
166         return true;
167 }
168 static inline unsigned int is_lp_cluster(void)
169 {
170         unsigned int reg;
171 #ifdef CONFIG_ARCH_TEGRA_14x_SOC
172         reg = readl(FLOW_CTRL_CLUSTER_CONTROL);
173         return reg & 1; /* 0 == G, 1 == LP*/
174 #else
175         asm("mrc        p15, 0, %0, c0, c0, 5\n"
176             "ubfx       %0, %0, #8, #4"
177             : "=r" (reg)
178             :
179             : "cc","memory");
180         return reg ; /* 0 == G, 1 == LP*/
181 #endif
182 }
183 int tegra_cluster_control(unsigned int us, unsigned int flags);
184 void tegra_cluster_switch_prolog(unsigned int flags);
185 void tegra_cluster_switch_epilog(unsigned int flags);
186 int tegra_switch_to_g_cluster(void);
187 int tegra_switch_to_lp_cluster(void);
188 int tegra_cluster_switch(struct clk *cpu_clk, struct clk *new_cluster_clk);
189 #else
190 #define INSTRUMENT_CLUSTER_SWITCH 0     /* Must be zero for ARCH_TEGRA_2x_SOC */
191 #define DEBUG_CLUSTER_SWITCH 0          /* Must be zero for ARCH_TEGRA_2x_SOC */
192 #define PARAMETERIZE_CLUSTER_SWITCH 0   /* Must be zero for ARCH_TEGRA_2x_SOC */
193
194 static inline bool is_g_cluster_present(void)   { return true; }
195 static inline unsigned int is_lp_cluster(void)  { return 0; }
196 static inline int tegra_cluster_control(unsigned int us, unsigned int flags)
197 {
198         return -EPERM;
199 }
200 static inline void tegra_cluster_switch_prolog(unsigned int flags) {}
201 static inline void tegra_cluster_switch_epilog(unsigned int flags) {}
202 static inline int tegra_switch_to_g_cluster(void)
203 {
204         return -EPERM;
205 }
206 static inline int tegra_switch_to_lp_cluster(void)
207 {
208         return -EPERM;
209 }
210 static inline int tegra_cluster_switch(struct clk *cpu_clk,
211                                        struct clk *new_cluster_clk)
212 {
213         return -EPERM;
214 }
215 #endif
216
217 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
218 void tegra2_lp0_suspend_init(void);
219 void tegra2_lp2_set_trigger(unsigned long cycles);
220 unsigned long tegra2_lp2_timer_remain(void);
221 #else
222 void tegra3_lp2_set_trigger(unsigned long cycles);
223 unsigned long tegra3_lp2_timer_remain(void);
224 int tegra3_is_cpu_wake_timer_ready(unsigned int cpu);
225 void tegra3_lp2_timer_cancel_secondary(void);
226 #endif
227
228 static inline void tegra_lp0_suspend_init(void)
229 {
230 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
231         tegra2_lp0_suspend_init();
232 #endif
233 }
234
235 static inline void tegra_pd_set_trigger(unsigned long cycles)
236 {
237 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
238         tegra2_lp2_set_trigger(cycles);
239 #else
240         tegra3_lp2_set_trigger(cycles);
241 #endif
242 }
243
244 static inline unsigned long tegra_pd_timer_remain(void)
245 {
246 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
247         return tegra2_lp2_timer_remain();
248 #else
249         return tegra3_lp2_timer_remain();
250 #endif
251 }
252
253 static inline int tegra_is_cpu_wake_timer_ready(unsigned int cpu)
254 {
255 #if defined(CONFIG_TEGRA_LP2_CPU_TIMER) || defined(CONFIG_ARCH_TEGRA_2x_SOC)
256         return 1;
257 #else
258         return tegra3_is_cpu_wake_timer_ready(cpu);
259 #endif
260 }
261
262 static inline void tegra_pd_timer_cancel_secondary(void)
263 {
264 #ifndef CONFIG_ARCH_TEGRA_2x_SOC
265         tegra3_lp2_timer_cancel_secondary();
266 #endif
267 }
268
269 #if DEBUG_CLUSTER_SWITCH && 0 /* !!!FIXME!!! THIS IS BROKEN */
270 extern unsigned int tegra_cluster_debug;
271 #define DEBUG_CLUSTER(x) do { if (tegra_cluster_debug) printk x; } while (0)
272 #else
273 #define DEBUG_CLUSTER(x) do { } while (0)
274 #endif
275 #if PARAMETERIZE_CLUSTER_SWITCH
276 void tegra_cluster_switch_set_parameters(unsigned int us, unsigned int flags);
277 #else
278 static inline void tegra_cluster_switch_set_parameters(
279         unsigned int us, unsigned int flags)
280 { }
281 #endif
282
283 #ifdef CONFIG_SMP
284 extern bool tegra_all_cpus_booted __read_mostly;
285 #else
286 #define tegra_all_cpus_booted (true)
287 #endif
288
289 #if !defined(CONFIG_ARCH_TEGRA_2x_SOC) && !defined(CONFIG_ARCH_TEGRA_3x_SOC) \
290         && defined(CONFIG_SMP)
291 void tegra_smp_clear_power_mask(void);
292 #else
293 static inline void tegra_smp_clear_power_mask(void){}
294 #endif
295
296 #if defined(CONFIG_ARCH_TEGRA_14x_SOC)
297 void tegra_smp_save_power_mask(void);
298 void tegra_smp_restore_power_mask(void);
299 #endif
300
301 #ifdef CONFIG_TEGRA_USE_SECURE_KERNEL
302 void tegra_generic_smc(u32 type, u32 subtype, u32 arg);
303 #endif
304
305 /* The debug channel uart base physical address */
306 extern unsigned long  debug_uart_port_base;
307
308 extern struct clk *debug_uart_clk;
309 void tegra_console_uart_suspend(void);
310 void tegra_console_uart_resume(void);
311
312
313 #endif /* _MACH_TEGRA_PM_H_ */