arm: tegra: Console suspend for all boards
[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-2011 NVIDIA Corporation
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 <mach/iomap.h>
31
32 enum tegra_suspend_mode {
33         TEGRA_SUSPEND_NONE = 0,
34         TEGRA_SUSPEND_LP2,      /* CPU voltage off */
35         TEGRA_SUSPEND_LP1,      /* CPU voltage off, DRAM self-refresh */
36         TEGRA_SUSPEND_LP0,      /* CPU + core voltage off, DRAM self-refresh */
37         TEGRA_MAX_SUSPEND_MODE,
38 };
39
40 enum suspend_stage {
41         TEGRA_SUSPEND_BEFORE_PERIPHERAL,
42         TEGRA_SUSPEND_BEFORE_CPU,
43 };
44
45 enum resume_stage {
46         TEGRA_RESUME_AFTER_PERIPHERAL,
47         TEGRA_RESUME_AFTER_CPU,
48 };
49
50 struct tegra_suspend_platform_data {
51         unsigned long cpu_timer;   /* CPU power good time in us,  LP2/LP1 */
52         unsigned long cpu_off_timer;    /* CPU power off time us, LP2/LP1 */
53         unsigned long core_timer;  /* core power good time in ticks,  LP0 */
54         unsigned long core_off_timer;   /* core power off time ticks, LP0 */
55         bool corereq_high;         /* Core power request active-high */
56         bool sysclkreq_high;       /* System clock request is active-high */
57         enum tegra_suspend_mode suspend_mode;
58         unsigned long cpu_lp2_min_residency; /* Min LP2 state residency in us */
59         void (*board_suspend)(int lp_state, enum suspend_stage stg);
60         /* lp_state = 0 for LP0 state, 1 for LP1 state, 2 for LP2 state */
61         void (*board_resume)(int lp_state, enum resume_stage stg);
62 };
63
64 unsigned long tegra_cpu_power_good_time(void);
65 unsigned long tegra_cpu_power_off_time(void);
66 unsigned long tegra_cpu_lp2_min_residency(void);
67 void tegra_clear_cpu_in_lp2(int cpu);
68 bool tegra_set_cpu_in_lp2(int cpu);
69
70 int tegra_suspend_dram(enum tegra_suspend_mode mode);
71
72 #define FLOW_CTRL_CLUSTER_CONTROL \
73         (IO_ADDRESS(TEGRA_FLOW_CTRL_BASE) + 0x2c)
74
75 #define FUSE_SKU_DIRECT_CONFIG \
76         (IO_ADDRESS(TEGRA_FUSE_BASE) + 0x1F4)
77 #define FUSE_SKU_DISABLE_ALL_CPUS       (1<<5)
78 #define FUSE_SKU_NUM_DISABLED_CPUS(x)   (((x) >> 3) & 3)
79
80 void __init tegra_init_suspend(struct tegra_suspend_platform_data *plat);
81
82 unsigned int tegra_count_slow_cpus(unsigned long speed_limit);
83 unsigned int tegra_get_slowest_cpu_n(void);
84 unsigned long tegra_cpu_lowest_speed(void);
85 unsigned long tegra_cpu_highest_speed(void);
86 int tegra_cpu_cap_highest_speed(unsigned int *speed_cap);
87
88 #if defined(CONFIG_TEGRA_AUTO_HOTPLUG) && !defined(CONFIG_ARCH_TEGRA_2x_SOC)
89 int tegra_auto_hotplug_init(struct mutex *cpu_lock);
90 void tegra_auto_hotplug_exit(void);
91 void tegra_auto_hotplug_governor(unsigned int cpu_freq, bool suspend);
92 #else
93 static inline int tegra_auto_hotplug_init(struct mutex *cpu_lock)
94 { return 0; }
95 static inline void tegra_auto_hotplug_exit(void)
96 { }
97 static inline void tegra_auto_hotplug_governor(unsigned int cpu_freq,
98                                                 bool suspend)
99 { }
100 #endif
101
102 u64 tegra_rtc_read_ms(void);
103
104 /*
105  * Callbacks for platform drivers to implement.
106  */
107 extern void (*tegra_deep_sleep)(int);
108
109 unsigned int tegra_idle_lp2_last(unsigned int us, unsigned int flags);
110
111 #if defined(CONFIG_PM_SLEEP) && !defined(CONFIG_ARCH_TEGRA_2x_SOC)
112 #define INSTRUMENT_CLUSTER_SWITCH 1     /* Should be zero for shipping code */
113 #define DEBUG_CLUSTER_SWITCH 0          /* Should be zero for shipping code */
114 #define PARAMETERIZE_CLUSTER_SWITCH 1   /* Should be zero for shipping code */
115 int tegra_cluster_control(unsigned int us, unsigned int flags);
116 void tegra_cluster_switch_prolog(unsigned int flags);
117 void tegra_cluster_switch_epilog(unsigned int flags);
118 void tegra_lp0_suspend_mc(void);
119 void tegra_lp0_resume_mc(void);
120 void tegra_lp0_cpu_mode(bool enter);
121 #else
122 static inline int tegra_cluster_control(unsigned int us, unsigned int flags)
123 #define INSTRUMENT_CLUSTER_SWITCH 0     /* Must be zero for ARCH_TEGRA_2x_SOC */
124 #define DEBUG_CLUSTER_SWITCH 0          /* Must be zero for ARCH_TEGRA_2x_SOC */
125 #define PARAMETERIZE_CLUSTER_SWITCH 0   /* Must be zero for ARCH_TEGRA_2x_SOC */
126 {
127         return -EPERM;
128 }
129 static inline void tegra_cluster_switch_prolog(unsigned int flags) {}
130 static inline void tegra_cluster_switch_epilog(unsigned int flags) {}
131 static inline void tegra_lp0_suspend_mc(void) {}
132 static inline void tegra_lp0_resume_mc(void) {}
133 static inline void tegra_lp0_cpu_mode(bool enter) {}
134 #endif
135
136 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
137 static inline bool is_g_cluster_present(void)   { return true; }
138 static inline unsigned int is_lp_cluster(void)  { return 0; }
139 void tegra2_lp0_suspend_init(void);
140 #else
141 static inline bool is_g_cluster_present(void)
142 {
143         u32 fuse_sku = readl(FUSE_SKU_DIRECT_CONFIG);
144         if (fuse_sku & FUSE_SKU_DISABLE_ALL_CPUS)
145                 return false;
146         return true;
147 }
148 static inline unsigned int is_lp_cluster(void)
149 {
150         unsigned int reg;
151         reg = readl(FLOW_CTRL_CLUSTER_CONTROL);
152         return (reg & 1); /* 0 == G, 1 == LP*/
153 }
154 #endif
155
156 static inline void tegra_lp0_suspend_init(void)
157 {
158 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
159         tegra2_lp0_suspend_init();
160 #endif
161 }
162
163 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
164 void tegra2_lp2_set_trigger(unsigned long cycles);
165 unsigned long tegra2_lp2_timer_remain(void);
166 #endif
167 #ifdef CONFIG_ARCH_TEGRA_3x_SOC
168 void tegra3_lp2_set_trigger(unsigned long cycles);
169 unsigned long tegra3_lp2_timer_remain(void);
170 #endif
171
172 static inline void tegra_lp2_set_trigger(unsigned long cycles)
173 {
174 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
175         tegra2_lp2_set_trigger(cycles);
176 #endif
177 #ifdef CONFIG_ARCH_TEGRA_3x_SOC
178         tegra3_lp2_set_trigger(cycles);
179 #endif
180 }
181
182 static inline unsigned long tegra_lp2_timer_remain(void)
183 {
184 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
185         return tegra2_lp2_timer_remain();
186 #endif
187 #ifdef CONFIG_ARCH_TEGRA_3x_SOC
188         return tegra3_lp2_timer_remain();
189 #endif
190 }
191
192 #if DEBUG_CLUSTER_SWITCH && 0 /* !!!FIXME!!! THIS IS BROKEN */
193 extern unsigned int tegra_cluster_debug;
194 #define DEBUG_CLUSTER(x) do { if (tegra_cluster_debug) printk x; } while (0)
195 #else
196 #define DEBUG_CLUSTER(x) do { } while (0)
197 #endif
198 #if PARAMETERIZE_CLUSTER_SWITCH
199 void tegra_cluster_switch_set_parameters(unsigned int us, unsigned int flags);
200 #else
201 static inline void tegra_cluster_switch_set_parameters(
202         unsigned int us, unsigned int flags)
203 { }
204 #endif
205
206 #ifdef CONFIG_SMP
207 extern bool tegra_all_cpus_booted __read_mostly;
208 #else
209 #define tegra_all_cpus_booted (true)
210 #endif
211
212 /* The debug channel uart base physical address */
213 extern unsigned long  debug_uart_port_base;
214
215 extern struct clk *debug_uart_clk;
216 void tegra_console_uart_suspend(void);
217 void tegra_console_uart_resume(void);
218
219 #endif /* _MACH_TEGRA_PM_H_ */