ARM: tegra: power: implement LP1 suspend/resume for Tegra3
[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, unsigned int flags);
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 u64 tegra_rtc_read_ms(void);
83
84 /*
85  * Callbacks for platform drivers to implement.
86  */
87 extern void (*tegra_deep_sleep)(int);
88
89 unsigned int tegra_idle_lp2_last(unsigned int us, unsigned int flags);
90
91 #if defined(CONFIG_PM_SLEEP) && !defined(CONFIG_ARCH_TEGRA_2x_SOC)
92 void tegra_lp0_suspend_mc(void);
93 void tegra_lp0_resume_mc(void);
94 void tegra_lp0_cpu_mode(bool enter);
95 #else
96 static inline void tegra_lp0_suspend_mc(void) {}
97 static inline void tegra_lp0_resume_mc(void) {}
98 static inline void tegra_lp0_cpu_mode(bool enter) {}
99 #endif
100
101 #ifdef CONFIG_TEGRA_CLUSTER_CONTROL
102 #define INSTRUMENT_CLUSTER_SWITCH 1     /* Should be zero for shipping code */
103 #define DEBUG_CLUSTER_SWITCH 0          /* Should be zero for shipping code */
104 #define PARAMETERIZE_CLUSTER_SWITCH 1   /* Should be zero for shipping code */
105
106 static inline bool is_g_cluster_present(void)
107 {
108         u32 fuse_sku = readl(FUSE_SKU_DIRECT_CONFIG);
109         if (fuse_sku & FUSE_SKU_DISABLE_ALL_CPUS)
110                 return false;
111         return true;
112 }
113 static inline unsigned int is_lp_cluster(void)
114 {
115         unsigned int reg;
116         reg = readl(FLOW_CTRL_CLUSTER_CONTROL);
117         return (reg & 1); /* 0 == G, 1 == LP*/
118 }
119 int tegra_cluster_control(unsigned int us, unsigned int flags);
120 void tegra_cluster_switch_prolog(unsigned int flags);
121 void tegra_cluster_switch_epilog(unsigned int flags);
122 #else
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 static inline bool is_g_cluster_present(void)   { return true; }
128 static inline unsigned int is_lp_cluster(void)  { return 0; }
129 static inline int tegra_cluster_control(unsigned int us, unsigned int flags)
130 {
131         return -EPERM;
132 }
133 static inline void tegra_cluster_switch_prolog(unsigned int flags) {}
134 static inline void tegra_cluster_switch_epilog(unsigned int flags) {}
135 #endif
136
137 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
138 void tegra2_lp0_suspend_init(void);
139 void tegra2_lp2_set_trigger(unsigned long cycles);
140 unsigned long tegra2_lp2_timer_remain(void);
141 #endif
142 #ifdef CONFIG_ARCH_TEGRA_3x_SOC
143 void tegra3_lp2_set_trigger(unsigned long cycles);
144 unsigned long tegra3_lp2_timer_remain(void);
145 #endif
146
147 static inline void tegra_lp0_suspend_init(void)
148 {
149 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
150         tegra2_lp0_suspend_init();
151 #endif
152 }
153
154 static inline void tegra_lp2_set_trigger(unsigned long cycles)
155 {
156 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
157         tegra2_lp2_set_trigger(cycles);
158 #endif
159 #ifdef CONFIG_ARCH_TEGRA_3x_SOC
160         tegra3_lp2_set_trigger(cycles);
161 #endif
162 }
163
164 static inline unsigned long tegra_lp2_timer_remain(void)
165 {
166 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
167         return tegra2_lp2_timer_remain();
168 #endif
169 #ifdef CONFIG_ARCH_TEGRA_3x_SOC
170         return tegra3_lp2_timer_remain();
171 #endif
172 }
173
174 #if DEBUG_CLUSTER_SWITCH && 0 /* !!!FIXME!!! THIS IS BROKEN */
175 extern unsigned int tegra_cluster_debug;
176 #define DEBUG_CLUSTER(x) do { if (tegra_cluster_debug) printk x; } while (0)
177 #else
178 #define DEBUG_CLUSTER(x) do { } while (0)
179 #endif
180 #if PARAMETERIZE_CLUSTER_SWITCH
181 void tegra_cluster_switch_set_parameters(unsigned int us, unsigned int flags);
182 #else
183 static inline void tegra_cluster_switch_set_parameters(
184         unsigned int us, unsigned int flags)
185 { }
186 #endif
187
188 #ifdef CONFIG_SMP
189 extern bool tegra_all_cpus_booted __read_mostly;
190 #else
191 #define tegra_all_cpus_booted (true)
192 #endif
193
194 /* The debug channel uart base physical address */
195 extern unsigned long  debug_uart_port_base;
196
197 extern struct clk *debug_uart_clk;
198 void tegra_console_uart_suspend(void);
199 void tegra_console_uart_resume(void);
200
201 #endif /* _MACH_TEGRA_PM_H_ */