ARM: tegra3: Cluster Switch and LP0 require PM_SLEEP
[linux-2.6.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
27 enum tegra_suspend_mode {
28         TEGRA_SUSPEND_NONE = 0,
29         TEGRA_SUSPEND_LP2,      /* CPU voltage off */
30         TEGRA_SUSPEND_LP1,      /* CPU voltage off, DRAM self-refresh */
31         TEGRA_SUSPEND_LP0,      /* CPU + core voltage off, DRAM self-refresh */
32         TEGRA_MAX_SUSPEND_MODE,
33 };
34
35 struct tegra_suspend_platform_data {
36         unsigned long cpu_timer;   /* CPU power good time in us,  LP2/LP1 */
37         unsigned long cpu_off_timer;    /* CPU power off time us, LP2/LP1 */
38         unsigned long core_timer;  /* core power good time in ticks,  LP0 */
39         unsigned long core_off_timer;   /* core power off time ticks, LP0 */
40         bool corereq_high;         /* Core power request active-high */
41         bool sysclkreq_high;       /* System clock request is active-high */
42         enum tegra_suspend_mode suspend_mode;
43         unsigned long cpu_lp2_min_residency; /* Min LP2 state residency in us */
44 };
45
46 unsigned long tegra_cpu_power_good_time(void);
47 unsigned long tegra_cpu_power_off_time(void);
48 unsigned long tegra_cpu_lp2_min_residency(void);
49 void tegra_clear_cpu_in_lp2(int cpu);
50 bool tegra_set_cpu_in_lp2(int cpu);
51
52 int tegra_suspend_dram(enum tegra_suspend_mode mode);
53
54 #define TEGRA_POWER_SDRAM_SELFREFRESH   0x400   /* SDRAM is in self-refresh */
55
56 #define TEGRA_POWER_CLUSTER_G           0x1000  /* G CPU */
57 #define TEGRA_POWER_CLUSTER_LP          0x2000  /* LP CPU */
58 #define TEGRA_POWER_CLUSTER_MASK        0x3000
59 #define TEGRA_POWER_CLUSTER_IMMEDIATE   0x4000  /* Immediate wake */
60 #define TEGRA_POWER_CLUSTER_FORCE       0x8000  /* Force switch */
61
62 #define FLOW_CTRL_HALT_CPU(cpu) (IO_ADDRESS(TEGRA_FLOW_CTRL_BASE) + \
63         ((cpu) == 0 ? 0x0 : 0x14 + ((cpu) - 1) * 0x8))
64 #define FLOW_CTRL_CPU_CSR(cpu)  (IO_ADDRESS(TEGRA_FLOW_CTRL_BASE) + \
65         ((cpu) == 0 ? 0x8 : 0x18 + ((cpu) - 1) * 0x8))
66
67 #define FLOW_CTRL_CLUSTER_CONTROL \
68         (IO_ADDRESS(TEGRA_FLOW_CTRL_BASE) + 0x2c)
69 #define FLOW_CTRL_CPU_CSR_IMMEDIATE_WAKE        (1<<3)
70 #define FLOW_CTRL_CPU_CSR_SWITCH_CLUSTER        (1<<2)
71
72 #define FUSE_SKU_DIRECT_CONFIG \
73         (IO_ADDRESS(TEGRA_FUSE_BASE) + 0x1F4)
74 #define FUSE_SKU_DISABLE_ALL_CPUS       (1<<5)
75 #define FUSE_SKU_NUM_DISABLED_CPUS(x)   (((x) >> 3) & 3)
76
77 void __init tegra_init_suspend(struct tegra_suspend_platform_data *plat);
78
79 unsigned int tegra_count_slow_cpus(unsigned long speed_limit);
80 unsigned int tegra_get_slowest_cpu_n(void);
81 unsigned long tegra_cpu_lowest_speed(void);
82 unsigned long tegra_cpu_highest_speed(void);
83 int tegra_cpu_cap_highest_speed(unsigned int *speed_cap);
84
85 #if defined(CONFIG_TEGRA_AUTO_HOTPLUG) && !defined(CONFIG_ARCH_TEGRA_2x_SOC)
86 int tegra_auto_hotplug_init(struct mutex *cpu_lock);
87 void tegra_auto_hotplug_exit(void);
88 void tegra_auto_hotplug_governor(unsigned int cpu_freq);
89 #else
90 static inline int tegra_auto_hotplug_init(struct mutex *cpu_lock)
91 { return 0; }
92 static inline void tegra_auto_hotplug_exit(void)
93 { }
94 static inline void tegra_auto_hotplug_governor(unsigned int cpu_freq)
95 { }
96 #endif
97
98 u64 tegra_rtc_read_ms(void);
99
100 /*
101  * Callbacks for platform drivers to implement.
102  */
103 extern void (*tegra_deep_sleep)(int);
104
105 unsigned int tegra_idle_lp2_last(unsigned int us, unsigned int flags);
106
107 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
108
109 #define INSTRUMENT_CLUSTER_SWITCH 0     /* Must be zero for ARCH_TEGRA_2x_SOC */
110 #define DEBUG_CLUSTER_SWITCH 0          /* Must be zero for ARCH_TEGRA_2x_SOC */
111 #define PARAMETERIZE_CLUSTER_SWITCH 0   /* Must be zero for ARCH_TEGRA_2x_SOC */
112 static inline int tegra_cluster_control(unsigned int us, unsigned int flags)
113 { return -EPERM; }
114 #define tegra_cluster_switch_prolog(flags) do {} while(0)
115 #define tegra_cluster_switch_epilog(flags) do {} while(0)
116 static inline bool is_g_cluster_present(void)
117 { return true; }
118 static inline unsigned int is_lp_cluster(void)
119 { return 0; }
120 #define tegra_lp0_suspend_mc() do {} while(0)
121 #define tegra_lp0_resume_mc() do {} while(0)
122 void tegra2_lp0_suspend_init(void);
123
124 #else
125
126 #define INSTRUMENT_CLUSTER_SWITCH 1     /* Should be zero for shipping code */
127 #define DEBUG_CLUSTER_SWITCH 1          /* Should be zero for shipping code */
128 #define PARAMETERIZE_CLUSTER_SWITCH 1   /* Should be zero for shipping code */
129
130 #ifdef CONFIG_PM_SLEEP
131 int tegra_cluster_control(unsigned int us, unsigned int flags);
132 void tegra_cluster_switch_prolog(unsigned int flags);
133 void tegra_cluster_switch_epilog(unsigned int flags);
134 void tegra_lp0_suspend_mc(void);
135 void tegra_lp0_resume_mc(void);
136 #else
137 static inline int tegra_cluster_control(unsigned int us, unsigned int flags)
138 {
139         return -EPERM;
140 }
141 static inline void tegra_cluster_switch_prolog(unsigned int flags) {}
142 static inline void tegra_cluster_switch_epilog(unsigned int flags) {}
143 static inline void tegra_lp0_suspend_mc(void) {}
144 static inline void tegra_lp0_resume_mc(void) {}
145 #endif
146
147 static inline bool is_g_cluster_present(void)
148 {
149         u32 fuse_sku = readl(FUSE_SKU_DIRECT_CONFIG);
150         if (fuse_sku & FUSE_SKU_DISABLE_ALL_CPUS)
151                 return false;
152         return true;
153 }
154 static inline unsigned int is_lp_cluster(void)
155 {
156         unsigned int reg;
157         reg = readl(FLOW_CTRL_CLUSTER_CONTROL);
158         return (reg & 1); /* 0 == G, 1 == LP*/
159 }
160 #endif
161
162 static inline void tegra_lp0_suspend_init(void)
163 {
164 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
165         tegra2_lp0_suspend_init();
166 #endif
167 }
168
169 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
170 void tegra2_lp2_set_trigger(unsigned long cycles);
171 unsigned long tegra2_lp2_timer_remain(void);
172 #endif
173
174 static inline void tegra_lp2_set_trigger(unsigned long cycles)
175 {
176 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
177         tegra2_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 }
187
188 #if DEBUG_CLUSTER_SWITCH
189 extern unsigned int tegra_cluster_debug;
190 #define DEBUG_CLUSTER(x) do { if (tegra_cluster_debug) printk x; } while (0)
191 #else
192 #define DEBUG_CLUSTER(x) do { } while (0)
193 #endif
194 #if PARAMETERIZE_CLUSTER_SWITCH
195 void tegra_cluster_switch_set_parameters(unsigned int us, unsigned int flags);
196 #else
197 static inline void tegra_cluster_switch_set_parameters(
198         unsigned int us, unsigned int flags)
199 { }
200 #endif
201
202 static inline void flowctrl_writel(unsigned long val, void __iomem *addr)
203 {
204         writel(val, addr);
205 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
206         wmb();
207 #endif
208         (void)__raw_readl(addr);
209 }
210
211 #endif /* _MACH_TEGRA_PM_H_ */