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