ARM: tegra: power: Enable cluster switch instrumentation
[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 #include "pmc.h"
36
37 #define PMC_SCRATCH0            0x50
38 #define PMC_SCRATCH1            0x54
39 #define PMC_SCRATCH4            0x60
40
41 enum suspend_stage {
42         TEGRA_SUSPEND_BEFORE_PERIPHERAL,
43         TEGRA_SUSPEND_BEFORE_CPU,
44 };
45
46 enum resume_stage {
47         TEGRA_RESUME_AFTER_PERIPHERAL,
48         TEGRA_RESUME_AFTER_CPU,
49 };
50
51 struct tegra_suspend_platform_data {
52         unsigned long cpu_timer;   /* CPU power good time in us,  LP2/LP1 */
53         unsigned long cpu_off_timer;    /* CPU power off time us, LP2/LP1 */
54         unsigned long core_timer;  /* core power good time in ticks,  LP0 */
55         unsigned long core_off_timer;   /* core power off time ticks, LP0 */
56         bool corereq_high;         /* Core power request active-high */
57         bool sysclkreq_high;       /* System clock request is active-high */
58         bool sysclkreq_gpio;       /* if System clock request is set to gpio */
59         bool combined_req;         /* if core & CPU power requests are combined */
60         enum tegra_suspend_mode suspend_mode;
61         unsigned long cpu_lp2_min_residency; /* Min LP2 state residency in us */
62         void (*board_suspend)(int lp_state, enum suspend_stage stg);
63         /* lp_state = 0 for LP0 state, 1 for LP1 state, 2 for LP2 state */
64         void (*board_resume)(int lp_state, enum resume_stage stg);
65         unsigned int cpu_resume_boost;  /* CPU frequency resume boost in kHz */
66 #ifdef CONFIG_TEGRA_LP1_LOW_COREVOLTAGE
67         bool lp1_lowvolt_support;
68         unsigned int i2c_base_addr;
69         unsigned int pmuslave_addr;
70         unsigned int core_reg_addr;
71         unsigned int lp1_core_volt_low_cold;
72         unsigned int lp1_core_volt_low;
73         unsigned int lp1_core_volt_high;
74 #endif
75         unsigned int lp1bb_core_volt_min;
76         unsigned long lp1bb_emc_rate_min;
77         unsigned long lp1bb_emc_rate_max;
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         bool crail_up_early;
84 #endif
85         unsigned long min_residency_mc_clk;
86         bool usb_vbus_internal_wake; /* support for internal vbus wake */
87         bool usb_id_internal_wake; /* support for internal id wake */
88
89         void (*suspend_dfll_bypass)(void);
90         void (*resume_dfll_bypass)(void);
91 };
92
93 /* clears io dpd settings before kernel code */
94 void tegra_bl_io_dpd_cleanup(void);
95
96 unsigned long tegra_cpu_power_good_time(void);
97 unsigned long tegra_cpu_power_off_time(void);
98 unsigned long tegra_cpu_lp2_min_residency(void);
99 unsigned long tegra_mc_clk_stop_min_residency(void);
100 #ifdef CONFIG_ARCH_TEGRA_HAS_SYMMETRIC_CPU_PWR_GATE
101 unsigned long tegra_min_residency_vmin_fmin(void);
102 unsigned long tegra_min_residency_ncpu(void);
103 unsigned long tegra_min_residency_crail(void);
104 bool tegra_crail_can_start_early(void);
105 #else
106 static inline bool tegra_crail_can_start_early(void)
107 { return false; }
108 #endif
109 void tegra_limit_cpu_power_timers(unsigned long us_on, unsigned long us_off);
110 void tegra_clear_cpu_in_pd(int cpu);
111 bool tegra_set_cpu_in_pd(int cpu);
112
113 void tegra_mc_clk_prepare(void);
114 void tegra_mc_clk_finish(void);
115 int tegra_suspend_dram(enum tegra_suspend_mode mode, unsigned int flags);
116 #ifdef CONFIG_TEGRA_LP1_LOW_COREVOLTAGE
117 int tegra_is_lp1_suspend_mode(void);
118 #endif
119 void tegra_lp1bb_suspend_emc_rate(unsigned long emc_min, unsigned long emc_max);
120 void tegra_lp1bb_suspend_mv_set(int mv);
121 unsigned long tegra_lp1bb_emc_min_rate_get(void);
122
123 #ifdef CONFIG_ARCH_TEGRA_14x_SOC
124 #define FLOW_CTRL_CLUSTER_CONTROL \
125         (IO_ADDRESS(TEGRA_FLOW_CTRL_BASE) + 0x2c)
126 #endif
127
128 #define FLOW_CTRL_CPU_PWR_CSR \
129         (IO_ADDRESS(TEGRA_FLOW_CTRL_BASE) + 0x38)
130 #define FLOW_CTRL_CPU_PWR_CSR_RAIL_ENABLE       1
131
132 #define FLOW_CTRL_MPID \
133         (IO_ADDRESS(TEGRA_FLOW_CTRL_BASE) + 0x3c)
134
135 #define FLOW_CTRL_RAM_REPAIR \
136         (IO_ADDRESS(TEGRA_FLOW_CTRL_BASE) + 0x40)
137 #define FLOW_CTRL_RAM_REPAIR_BYPASS_EN  (1<<2)
138 #define FLOW_CTRL_RAM_REPAIR_STS        (1<<1)
139 #define FLOW_CTRL_RAM_REPAIR_REQ        (1<<0)
140
141 #define FUSE_SKU_DIRECT_CONFIG \
142         (IO_ADDRESS(TEGRA_FUSE_BASE) + 0x1F4)
143 #define FUSE_SKU_DISABLE_ALL_CPUS       (1<<5)
144 #define FUSE_SKU_NUM_DISABLED_CPUS(x)   (((x) >> 3) & 3)
145
146 void __init tegra_init_suspend(struct tegra_suspend_platform_data *plat);
147
148 u64 tegra_rtc_read_ms(void);
149
150 /*
151  * Callbacks for platform drivers to implement.
152  */
153 extern void (*tegra_deep_sleep)(int);
154
155 unsigned int tegra_idle_power_down_last(unsigned int us, unsigned int flags);
156
157 #if defined(CONFIG_PM_SLEEP) && !defined(CONFIG_ARCH_TEGRA_2x_SOC)
158 void tegra_lp0_suspend_mc(void);
159 void tegra_lp0_resume_mc(void);
160 void tegra_lp0_cpu_mode(bool enter);
161 #else
162 static inline void tegra_lp0_suspend_mc(void) {}
163 static inline void tegra_lp0_resume_mc(void) {}
164 static inline void tegra_lp0_cpu_mode(bool enter) {}
165 #endif
166
167 #ifdef CONFIG_TEGRA_CLUSTER_CONTROL
168 #define INSTRUMENT_CLUSTER_SWITCH 1     /* Should be zero for shipping code */
169 #define DEBUG_CLUSTER_SWITCH 0          /* Should be zero for shipping code */
170 #define PARAMETERIZE_CLUSTER_SWITCH 1   /* Should be zero for shipping code */
171
172 #define CLUSTER_SWITCH_TIME_AVG_SHIFT   4
173 #define CLUSTER_SWITCH_AVG_SAMPLES      (0x1U << CLUSTER_SWITCH_TIME_AVG_SHIFT)
174
175 enum tegra_cluster_switch_time_id {
176         tegra_cluster_switch_time_id_start = 0,
177         tegra_cluster_switch_time_id_prolog,
178         tegra_cluster_switch_time_id_switch,
179         tegra_cluster_switch_time_id_epilog,
180         tegra_cluster_switch_time_id_end,
181         tegra_cluster_switch_time_id_max
182 };
183
184 static inline bool is_g_cluster_present(void)
185 {
186         u32 fuse_sku = readl(FUSE_SKU_DIRECT_CONFIG);
187         if (fuse_sku & FUSE_SKU_DISABLE_ALL_CPUS)
188                 return false;
189         return true;
190 }
191 static inline unsigned int is_lp_cluster(void)
192 {
193         unsigned int reg;
194 #ifdef CONFIG_ARCH_TEGRA_14x_SOC
195         reg = readl(FLOW_CTRL_CLUSTER_CONTROL);
196         return reg & 1; /* 0 == G, 1 == LP*/
197 #else
198         asm("mrc        p15, 0, %0, c0, c0, 5\n"
199             "ubfx       %0, %0, #8, #4"
200             : "=r" (reg)
201             :
202             : "cc","memory");
203         return reg ; /* 0 == G, 1 == LP*/
204 #endif
205 }
206 int tegra_cluster_control(unsigned int us, unsigned int flags);
207 void tegra_cluster_switch_prolog(unsigned int flags);
208 void tegra_cluster_switch_epilog(unsigned int flags);
209 int tegra_switch_to_g_cluster(void);
210 int tegra_switch_to_lp_cluster(void);
211 int tegra_cluster_switch(struct clk *cpu_clk, struct clk *new_cluster_clk);
212 #else
213 #define INSTRUMENT_CLUSTER_SWITCH 0     /* Must be zero for ARCH_TEGRA_2x_SOC */
214 #define DEBUG_CLUSTER_SWITCH 0          /* Must be zero for ARCH_TEGRA_2x_SOC */
215 #define PARAMETERIZE_CLUSTER_SWITCH 0   /* Must be zero for ARCH_TEGRA_2x_SOC */
216
217 static inline bool is_g_cluster_present(void)   { return true; }
218 static inline unsigned int is_lp_cluster(void)  { return 0; }
219 static inline int tegra_cluster_control(unsigned int us, unsigned int flags)
220 {
221         return -EPERM;
222 }
223 static inline void tegra_cluster_switch_prolog(unsigned int flags) {}
224 static inline void tegra_cluster_switch_epilog(unsigned int flags) {}
225 static inline int tegra_switch_to_g_cluster(void)
226 {
227         return -EPERM;
228 }
229 static inline int tegra_switch_to_lp_cluster(void)
230 {
231         return -EPERM;
232 }
233 static inline int tegra_cluster_switch(struct clk *cpu_clk,
234                                        struct clk *new_cluster_clk)
235 {
236         return -EPERM;
237 }
238 #endif
239
240 #if INSTRUMENT_CLUSTER_SWITCH
241 void tegra_cluster_switch_time(unsigned int flags, int id);
242 #else
243 static inline void tegra_cluster_switch_time(unsigned int flags, int id) { }
244 #endif
245
246 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
247 void tegra2_lp0_suspend_init(void);
248 void tegra2_lp2_set_trigger(unsigned long cycles);
249 unsigned long tegra2_lp2_timer_remain(void);
250 #else
251 void tegra3_lp2_set_trigger(unsigned long cycles);
252 unsigned long tegra3_lp2_timer_remain(void);
253 int tegra3_is_cpu_wake_timer_ready(unsigned int cpu);
254 void tegra3_lp2_timer_cancel_secondary(void);
255 #endif
256
257 static inline void tegra_lp0_suspend_init(void)
258 {
259 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
260         tegra2_lp0_suspend_init();
261 #endif
262 }
263
264 static inline void tegra_pd_set_trigger(unsigned long cycles)
265 {
266 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
267         tegra2_lp2_set_trigger(cycles);
268 #else
269         tegra3_lp2_set_trigger(cycles);
270 #endif
271 }
272
273 static inline unsigned long tegra_pd_timer_remain(void)
274 {
275 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
276         return tegra2_lp2_timer_remain();
277 #else
278         return tegra3_lp2_timer_remain();
279 #endif
280 }
281
282 static inline int tegra_is_cpu_wake_timer_ready(unsigned int cpu)
283 {
284 #if defined(CONFIG_TEGRA_LP2_CPU_TIMER) || defined(CONFIG_ARCH_TEGRA_2x_SOC)
285         return 1;
286 #else
287         return tegra3_is_cpu_wake_timer_ready(cpu);
288 #endif
289 }
290
291 static inline void tegra_pd_timer_cancel_secondary(void)
292 {
293 #ifndef CONFIG_ARCH_TEGRA_2x_SOC
294         tegra3_lp2_timer_cancel_secondary();
295 #endif
296 }
297
298 #if DEBUG_CLUSTER_SWITCH && 0 /* !!!FIXME!!! THIS IS BROKEN */
299 extern unsigned int tegra_cluster_debug;
300 #define DEBUG_CLUSTER(x) do { if (tegra_cluster_debug) printk x; } while (0)
301 #else
302 #define DEBUG_CLUSTER(x) do { } while (0)
303 #endif
304 #if PARAMETERIZE_CLUSTER_SWITCH
305 void tegra_cluster_switch_set_parameters(unsigned int us, unsigned int flags);
306 #else
307 static inline void tegra_cluster_switch_set_parameters(
308         unsigned int us, unsigned int flags)
309 { }
310 #endif
311
312 #ifdef CONFIG_SMP
313 extern bool tegra_all_cpus_booted __read_mostly;
314 #else
315 #define tegra_all_cpus_booted (true)
316 #endif
317
318 #if !defined(CONFIG_ARCH_TEGRA_2x_SOC) && !defined(CONFIG_ARCH_TEGRA_3x_SOC) \
319         && defined(CONFIG_SMP)
320 void tegra_smp_clear_power_mask(void);
321 #else
322 static inline void tegra_smp_clear_power_mask(void){}
323 #endif
324
325 #if defined(CONFIG_ARCH_TEGRA_14x_SOC)
326 void tegra_smp_save_power_mask(void);
327 void tegra_smp_restore_power_mask(void);
328 #endif
329
330 #ifdef CONFIG_TEGRA_USE_SECURE_KERNEL
331 void tegra_generic_smc(u32 type, u32 subtype, u32 arg);
332 #endif
333
334 /* The debug channel uart base physical address */
335 extern unsigned long  debug_uart_port_base;
336
337 extern struct clk *debug_uart_clk;
338 void tegra_console_uart_suspend(void);
339 void tegra_console_uart_resume(void);
340
341
342 #endif /* _MACH_TEGRA_PM_H_ */