ARM: tegra: power: Add LP1 cold low voltage parameter
[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
106 #ifdef CONFIG_ARCH_TEGRA_14x_SOC
107 #define FLOW_CTRL_CLUSTER_CONTROL \
108         (IO_ADDRESS(TEGRA_FLOW_CTRL_BASE) + 0x2c)
109 #endif
110
111 #define FLOW_CTRL_CPU_PWR_CSR \
112         (IO_ADDRESS(TEGRA_FLOW_CTRL_BASE) + 0x38)
113 #define FLOW_CTRL_CPU_PWR_CSR_RAIL_ENABLE       1
114
115 #define FLOW_CTRL_MPID \
116         (IO_ADDRESS(TEGRA_FLOW_CTRL_BASE) + 0x3c)
117
118 #define FLOW_CTRL_RAM_REPAIR \
119         (IO_ADDRESS(TEGRA_FLOW_CTRL_BASE) + 0x40)
120 #define FLOW_CTRL_RAM_REPAIR_BYPASS_EN  (1<<2)
121
122 #define FUSE_SKU_DIRECT_CONFIG \
123         (IO_ADDRESS(TEGRA_FUSE_BASE) + 0x1F4)
124 #define FUSE_SKU_DISABLE_ALL_CPUS       (1<<5)
125 #define FUSE_SKU_NUM_DISABLED_CPUS(x)   (((x) >> 3) & 3)
126
127 void __init tegra_init_suspend(struct tegra_suspend_platform_data *plat);
128
129 u64 tegra_rtc_read_ms(void);
130
131 /*
132  * Callbacks for platform drivers to implement.
133  */
134 extern void (*tegra_deep_sleep)(int);
135
136 unsigned int tegra_idle_power_down_last(unsigned int us, unsigned int flags);
137
138 #if defined(CONFIG_PM_SLEEP) && !defined(CONFIG_ARCH_TEGRA_2x_SOC)
139 void tegra_lp0_suspend_mc(void);
140 void tegra_lp0_resume_mc(void);
141 void tegra_lp0_cpu_mode(bool enter);
142 #else
143 static inline void tegra_lp0_suspend_mc(void) {}
144 static inline void tegra_lp0_resume_mc(void) {}
145 static inline void tegra_lp0_cpu_mode(bool enter) {}
146 #endif
147
148 #ifdef CONFIG_TEGRA_CLUSTER_CONTROL
149 #define INSTRUMENT_CLUSTER_SWITCH 0     /* Should be zero for shipping code */
150 #define DEBUG_CLUSTER_SWITCH 0          /* Should be zero for shipping code */
151 #define PARAMETERIZE_CLUSTER_SWITCH 1   /* Should be zero for shipping code */
152
153 static inline bool is_g_cluster_present(void)
154 {
155         u32 fuse_sku = readl(FUSE_SKU_DIRECT_CONFIG);
156         if (fuse_sku & FUSE_SKU_DISABLE_ALL_CPUS)
157                 return false;
158         return true;
159 }
160 static inline unsigned int is_lp_cluster(void)
161 {
162         unsigned int reg;
163 #ifdef CONFIG_ARCH_TEGRA_14x_SOC
164         reg = readl(FLOW_CTRL_CLUSTER_CONTROL);
165         return reg & 1; /* 0 == G, 1 == LP*/
166 #else
167         asm("mrc        p15, 0, %0, c0, c0, 5\n"
168             "ubfx       %0, %0, #8, #4"
169             : "=r" (reg)
170             :
171             : "cc","memory");
172         return reg ; /* 0 == G, 1 == LP*/
173 #endif
174 }
175 int tegra_cluster_control(unsigned int us, unsigned int flags);
176 void tegra_cluster_switch_prolog(unsigned int flags);
177 void tegra_cluster_switch_epilog(unsigned int flags);
178 int tegra_switch_to_g_cluster(void);
179 int tegra_switch_to_lp_cluster(void);
180 int tegra_cluster_switch(struct clk *cpu_clk, struct clk *new_cluster_clk);
181 #else
182 #define INSTRUMENT_CLUSTER_SWITCH 0     /* Must be zero for ARCH_TEGRA_2x_SOC */
183 #define DEBUG_CLUSTER_SWITCH 0          /* Must be zero for ARCH_TEGRA_2x_SOC */
184 #define PARAMETERIZE_CLUSTER_SWITCH 0   /* Must be zero for ARCH_TEGRA_2x_SOC */
185
186 static inline bool is_g_cluster_present(void)   { return true; }
187 static inline unsigned int is_lp_cluster(void)  { return 0; }
188 static inline int tegra_cluster_control(unsigned int us, unsigned int flags)
189 {
190         return -EPERM;
191 }
192 static inline void tegra_cluster_switch_prolog(unsigned int flags) {}
193 static inline void tegra_cluster_switch_epilog(unsigned int flags) {}
194 static inline int tegra_switch_to_g_cluster(void)
195 {
196         return -EPERM;
197 }
198 static inline int tegra_switch_to_lp_cluster(void)
199 {
200         return -EPERM;
201 }
202 static inline int tegra_cluster_switch(struct clk *cpu_clk,
203                                        struct clk *new_cluster_clk)
204 {
205         return -EPERM;
206 }
207 #endif
208
209 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
210 void tegra2_lp0_suspend_init(void);
211 void tegra2_lp2_set_trigger(unsigned long cycles);
212 unsigned long tegra2_lp2_timer_remain(void);
213 #else
214 void tegra3_lp2_set_trigger(unsigned long cycles);
215 unsigned long tegra3_lp2_timer_remain(void);
216 int tegra3_is_cpu_wake_timer_ready(unsigned int cpu);
217 void tegra3_lp2_timer_cancel_secondary(void);
218 #endif
219
220 static inline void tegra_lp0_suspend_init(void)
221 {
222 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
223         tegra2_lp0_suspend_init();
224 #endif
225 }
226
227 static inline void tegra_pd_set_trigger(unsigned long cycles)
228 {
229 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
230         tegra2_lp2_set_trigger(cycles);
231 #else
232         tegra3_lp2_set_trigger(cycles);
233 #endif
234 }
235
236 static inline unsigned long tegra_pd_timer_remain(void)
237 {
238 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
239         return tegra2_lp2_timer_remain();
240 #else
241         return tegra3_lp2_timer_remain();
242 #endif
243 }
244
245 static inline int tegra_is_cpu_wake_timer_ready(unsigned int cpu)
246 {
247 #if defined(CONFIG_TEGRA_LP2_CPU_TIMER) || defined(CONFIG_ARCH_TEGRA_2x_SOC)
248         return 1;
249 #else
250         return tegra3_is_cpu_wake_timer_ready(cpu);
251 #endif
252 }
253
254 static inline void tegra_pd_timer_cancel_secondary(void)
255 {
256 #ifndef CONFIG_ARCH_TEGRA_2x_SOC
257         tegra3_lp2_timer_cancel_secondary();
258 #endif
259 }
260
261 #if DEBUG_CLUSTER_SWITCH && 0 /* !!!FIXME!!! THIS IS BROKEN */
262 extern unsigned int tegra_cluster_debug;
263 #define DEBUG_CLUSTER(x) do { if (tegra_cluster_debug) printk x; } while (0)
264 #else
265 #define DEBUG_CLUSTER(x) do { } while (0)
266 #endif
267 #if PARAMETERIZE_CLUSTER_SWITCH
268 void tegra_cluster_switch_set_parameters(unsigned int us, unsigned int flags);
269 #else
270 static inline void tegra_cluster_switch_set_parameters(
271         unsigned int us, unsigned int flags)
272 { }
273 #endif
274
275 #ifdef CONFIG_SMP
276 extern bool tegra_all_cpus_booted __read_mostly;
277 #else
278 #define tegra_all_cpus_booted (true)
279 #endif
280
281 #if !defined(CONFIG_ARCH_TEGRA_2x_SOC) && !defined(CONFIG_ARCH_TEGRA_3x_SOC) \
282         && defined(CONFIG_SMP)
283 void tegra_smp_clear_power_mask(void);
284 #else
285 static inline void tegra_smp_clear_power_mask(void){}
286 #endif
287
288 #if defined(CONFIG_ARCH_TEGRA_14x_SOC)
289 void tegra_smp_save_power_mask(void);
290 void tegra_smp_restore_power_mask(void);
291 #endif
292
293 #ifdef CONFIG_TEGRA_USE_SECURE_KERNEL
294 void tegra_generic_smc(u32 type, u32 subtype, u32 arg);
295 #endif
296
297 /* The debug channel uart base physical address */
298 extern unsigned long  debug_uart_port_base;
299
300 extern struct clk *debug_uart_clk;
301 void tegra_console_uart_suspend(void);
302 void tegra_console_uart_resume(void);
303
304
305 #endif /* _MACH_TEGRA_PM_H_ */