bffefa3be6e542205af84d358d0dfd52f8093c79
[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-2012, 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 combined_req;         /* if core & CPU power requests are combined */
62         enum tegra_suspend_mode suspend_mode;
63         unsigned long cpu_lp2_min_residency; /* Min LP2 state residency in us */
64         void (*board_suspend)(int lp_state, enum suspend_stage stg);
65         /* lp_state = 0 for LP0 state, 1 for LP1 state, 2 for LP2 state */
66         void (*board_resume)(int lp_state, enum resume_stage stg);
67         unsigned int cpu_resume_boost;  /* CPU frequency resume boost in kHz */
68 #ifdef CONFIG_TEGRA_LP1_950
69         bool lp1_lowvolt_support;
70         unsigned int i2c_base_addr;
71         unsigned int pmuslave_addr;
72         unsigned int core_reg_addr;
73         unsigned int lp1_core_volt_low;
74         unsigned int lp1_core_volt_high;
75 #endif
76 #ifdef CONFIG_ARCH_TEGRA_HAS_SYMMETRIC_CPU_PWR_GATE
77         unsigned long min_residency_noncpu;
78         unsigned long min_residency_crail;
79 #endif
80 };
81
82 /* clears io dpd settings before kernel code */
83 void tegra_bl_io_dpd_cleanup(void);
84
85 unsigned long tegra_cpu_power_good_time(void);
86 unsigned long tegra_cpu_power_off_time(void);
87 unsigned long tegra_cpu_lp2_min_residency(void);
88 #ifdef CONFIG_ARCH_TEGRA_HAS_SYMMETRIC_CPU_PWR_GATE
89 unsigned long tegra_min_residency_noncpu(void);
90 unsigned long tegra_min_residency_crail(void);
91 #endif
92 void tegra_clear_cpu_in_pd(int cpu);
93 bool tegra_set_cpu_in_pd(int cpu);
94
95 int tegra_suspend_dram(enum tegra_suspend_mode mode, unsigned int flags);
96
97 #ifdef CONFIG_ARCH_TEGRA_14x_SOC
98 #define FLOW_CTRL_CLUSTER_CONTROL \
99         (IO_ADDRESS(TEGRA_FLOW_CTRL_BASE) + 0x2c)
100 #endif
101
102 #define FLOW_CTRL_CPU_PWR_CSR \
103         (IO_ADDRESS(TEGRA_FLOW_CTRL_BASE) + 0x38)
104 #define FLOW_CTRL_CPU_PWR_CSR_RAIL_ENABLE       1
105
106 #define FLOW_CTRL_MPID \
107         (IO_ADDRESS(TEGRA_FLOW_CTRL_BASE) + 0x3c)
108
109 #define FLOW_CTRL_RAM_REPAIR \
110         (IO_ADDRESS(TEGRA_FLOW_CTRL_BASE) + 0x40)
111 #define FLOW_CTRL_RAM_REPAIR_BYPASS_EN  (1<<2)
112
113 #define FUSE_SKU_DIRECT_CONFIG \
114         (IO_ADDRESS(TEGRA_FUSE_BASE) + 0x1F4)
115 #define FUSE_SKU_DISABLE_ALL_CPUS       (1<<5)
116 #define FUSE_SKU_NUM_DISABLED_CPUS(x)   (((x) >> 3) & 3)
117
118 void __init tegra_init_suspend(struct tegra_suspend_platform_data *plat);
119
120 u64 tegra_rtc_read_ms(void);
121
122 /*
123  * Callbacks for platform drivers to implement.
124  */
125 extern void (*tegra_deep_sleep)(int);
126
127 unsigned int tegra_idle_power_down_last(unsigned int us, unsigned int flags);
128
129 #if defined(CONFIG_PM_SLEEP) && !defined(CONFIG_ARCH_TEGRA_2x_SOC)
130 void tegra_lp0_suspend_mc(void);
131 void tegra_lp0_resume_mc(void);
132 void tegra_lp0_cpu_mode(bool enter);
133 #else
134 static inline void tegra_lp0_suspend_mc(void) {}
135 static inline void tegra_lp0_resume_mc(void) {}
136 static inline void tegra_lp0_cpu_mode(bool enter) {}
137 #endif
138
139 #ifdef CONFIG_TEGRA_CLUSTER_CONTROL
140 #define INSTRUMENT_CLUSTER_SWITCH 0     /* Should be zero for shipping code */
141 #define DEBUG_CLUSTER_SWITCH 0          /* Should be zero for shipping code */
142 #define PARAMETERIZE_CLUSTER_SWITCH 1   /* Should be zero for shipping code */
143
144 static inline bool is_g_cluster_present(void)
145 {
146         u32 fuse_sku = readl(FUSE_SKU_DIRECT_CONFIG);
147         if (fuse_sku & FUSE_SKU_DISABLE_ALL_CPUS)
148                 return false;
149         return true;
150 }
151 static inline unsigned int is_lp_cluster(void)
152 {
153         unsigned int reg;
154 #ifdef CONFIG_ARCH_TEGRA_14x_SOC
155         reg = readl(FLOW_CTRL_CLUSTER_CONTROL);
156         return reg & 1; /* 0 == G, 1 == LP*/
157 #else
158         asm("mrc        p15, 0, %0, c0, c0, 5\n"
159             "ubfx       %0, %0, #8, #4"
160             : "=r" (reg)
161             :
162             : "cc");
163         return reg ; /* 0 == G, 1 == LP*/
164 #endif
165 }
166 int tegra_cluster_control(unsigned int us, unsigned int flags);
167 void tegra_cluster_switch_prolog(unsigned int flags);
168 void tegra_cluster_switch_epilog(unsigned int flags);
169 int tegra_switch_to_g_cluster(void);
170 int tegra_switch_to_lp_cluster(void);
171 int tegra_cluster_switch(struct clk *cpu_clk, struct clk *new_cluster_clk);
172 #else
173 #define INSTRUMENT_CLUSTER_SWITCH 0     /* Must be zero for ARCH_TEGRA_2x_SOC */
174 #define DEBUG_CLUSTER_SWITCH 0          /* Must be zero for ARCH_TEGRA_2x_SOC */
175 #define PARAMETERIZE_CLUSTER_SWITCH 0   /* Must be zero for ARCH_TEGRA_2x_SOC */
176
177 static inline bool is_g_cluster_present(void)   { return true; }
178 static inline unsigned int is_lp_cluster(void)  { return 0; }
179 static inline int tegra_cluster_control(unsigned int us, unsigned int flags)
180 {
181         return -EPERM;
182 }
183 static inline void tegra_cluster_switch_prolog(unsigned int flags) {}
184 static inline void tegra_cluster_switch_epilog(unsigned int flags) {}
185 static inline int tegra_switch_to_g_cluster(void)
186 {
187         return -EPERM;
188 }
189 static inline int tegra_switch_to_lp_cluster(void)
190 {
191         return -EPERM;
192 }
193 static inline int tegra_cluster_switch(struct clk *cpu_clk,
194                                        struct clk *new_cluster_clk)
195 {
196         return -EPERM;
197 }
198 #endif
199
200 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
201 void tegra2_lp0_suspend_init(void);
202 void tegra2_lp2_set_trigger(unsigned long cycles);
203 unsigned long tegra2_lp2_timer_remain(void);
204 #else
205 void tegra3_lp2_set_trigger(unsigned long cycles);
206 unsigned long tegra3_lp2_timer_remain(void);
207 int tegra3_is_cpu_wake_timer_ready(unsigned int cpu);
208 void tegra3_lp2_timer_cancel_secondary(void);
209 #endif
210
211 static inline void tegra_lp0_suspend_init(void)
212 {
213 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
214         tegra2_lp0_suspend_init();
215 #endif
216 }
217
218 static inline void tegra_pd_set_trigger(unsigned long cycles)
219 {
220 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
221         tegra2_lp2_set_trigger(cycles);
222 #else
223         tegra3_lp2_set_trigger(cycles);
224 #endif
225 }
226
227 static inline unsigned long tegra_pd_timer_remain(void)
228 {
229 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
230         return tegra2_lp2_timer_remain();
231 #else
232         return tegra3_lp2_timer_remain();
233 #endif
234 }
235
236 static inline int tegra_is_cpu_wake_timer_ready(unsigned int cpu)
237 {
238 #if defined(CONFIG_TEGRA_LP2_CPU_TIMER) || defined(CONFIG_ARCH_TEGRA_2x_SOC)
239         return 1;
240 #else
241         return tegra3_is_cpu_wake_timer_ready(cpu);
242 #endif
243 }
244
245 static inline void tegra_pd_timer_cancel_secondary(void)
246 {
247 #ifndef CONFIG_ARCH_TEGRA_2x_SOC
248         tegra3_lp2_timer_cancel_secondary();
249 #endif
250 }
251
252 #if DEBUG_CLUSTER_SWITCH && 0 /* !!!FIXME!!! THIS IS BROKEN */
253 extern unsigned int tegra_cluster_debug;
254 #define DEBUG_CLUSTER(x) do { if (tegra_cluster_debug) printk x; } while (0)
255 #else
256 #define DEBUG_CLUSTER(x) do { } while (0)
257 #endif
258 #if PARAMETERIZE_CLUSTER_SWITCH
259 void tegra_cluster_switch_set_parameters(unsigned int us, unsigned int flags);
260 #else
261 static inline void tegra_cluster_switch_set_parameters(
262         unsigned int us, unsigned int flags)
263 { }
264 #endif
265
266 #ifdef CONFIG_SMP
267 extern bool tegra_all_cpus_booted __read_mostly;
268 #else
269 #define tegra_all_cpus_booted (true)
270 #endif
271
272 #if !defined(CONFIG_ARCH_TEGRA_2x_SOC) && !defined(CONFIG_ARCH_TEGRA_3x_SOC) \
273         && defined(CONFIG_SMP)
274 void tegra_smp_clear_power_mask(void);
275 #else
276 static inline void tegra_smp_clear_power_mask(void){}
277 #endif
278
279 #ifdef CONFIG_TRUSTED_FOUNDATIONS
280 void tegra_generic_smc(u32 type, u32 subtype, u32 arg);
281 #endif
282
283 /* The debug channel uart base physical address */
284 extern unsigned long  debug_uart_port_base;
285
286 extern struct clk *debug_uart_clk;
287 void tegra_console_uart_suspend(void);
288 void tegra_console_uart_resume(void);
289
290
291 #endif /* _MACH_TEGRA_PM_H_ */