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