982d2ede641d69008d680dc2cfd81ab432f10a9a
[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         bool combined_req;         /* if core & CPU power requests are combined */
58         enum tegra_suspend_mode suspend_mode;
59         unsigned long cpu_lp2_min_residency; /* Min LP2 state residency in us */
60         void (*board_suspend)(int lp_state, enum suspend_stage stg);
61         /* lp_state = 0 for LP0 state, 1 for LP1 state, 2 for LP2 state */
62         void (*board_resume)(int lp_state, enum resume_stage stg);
63 };
64
65 /* Tegra io dpd entry - for each supported driver */
66 struct tegra_io_dpd {
67         const char *name;       /* driver name */
68         u8 io_dpd_reg_index;    /* io dpd register index */
69         u8 io_dpd_bit;          /* bit position for driver in dpd register */
70 };
71
72 unsigned long tegra_cpu_power_good_time(void);
73 unsigned long tegra_cpu_power_off_time(void);
74 unsigned long tegra_cpu_lp2_min_residency(void);
75 void tegra_clear_cpu_in_lp2(int cpu);
76 bool tegra_set_cpu_in_lp2(int cpu);
77
78 int tegra_suspend_dram(enum tegra_suspend_mode mode, unsigned int flags);
79
80 #define FLOW_CTRL_CLUSTER_CONTROL \
81         (IO_ADDRESS(TEGRA_FLOW_CTRL_BASE) + 0x2c)
82
83 #define FUSE_SKU_DIRECT_CONFIG \
84         (IO_ADDRESS(TEGRA_FUSE_BASE) + 0x1F4)
85 #define FUSE_SKU_DISABLE_ALL_CPUS       (1<<5)
86 #define FUSE_SKU_NUM_DISABLED_CPUS(x)   (((x) >> 3) & 3)
87
88 void __init tegra_init_suspend(struct tegra_suspend_platform_data *plat);
89
90 u64 tegra_rtc_read_ms(void);
91
92 /*
93  * Callbacks for platform drivers to implement.
94  */
95 extern void (*tegra_deep_sleep)(int);
96
97 unsigned int tegra_idle_lp2_last(unsigned int us, unsigned int flags);
98
99 #if defined(CONFIG_PM_SLEEP) && !defined(CONFIG_ARCH_TEGRA_2x_SOC)
100 void tegra_lp0_suspend_mc(void);
101 void tegra_lp0_resume_mc(void);
102 void tegra_lp0_cpu_mode(bool enter);
103 #else
104 static inline void tegra_lp0_suspend_mc(void) {}
105 static inline void tegra_lp0_resume_mc(void) {}
106 static inline void tegra_lp0_cpu_mode(bool enter) {}
107 #endif
108
109 #ifdef CONFIG_TEGRA_CLUSTER_CONTROL
110 #define INSTRUMENT_CLUSTER_SWITCH 0     /* Should be zero for shipping code */
111 #define DEBUG_CLUSTER_SWITCH 0          /* Should be zero for shipping code */
112 #define PARAMETERIZE_CLUSTER_SWITCH 1   /* Should be zero for shipping code */
113
114 static inline bool is_g_cluster_present(void)
115 {
116         u32 fuse_sku = readl(FUSE_SKU_DIRECT_CONFIG);
117         if (fuse_sku & FUSE_SKU_DISABLE_ALL_CPUS)
118                 return false;
119         return true;
120 }
121 static inline unsigned int is_lp_cluster(void)
122 {
123         unsigned int reg;
124         reg = readl(FLOW_CTRL_CLUSTER_CONTROL);
125         return (reg & 1); /* 0 == G, 1 == LP*/
126 }
127 int tegra_cluster_control(unsigned int us, unsigned int flags);
128 void tegra_cluster_switch_prolog(unsigned int flags);
129 void tegra_cluster_switch_epilog(unsigned int flags);
130 #else
131 #define INSTRUMENT_CLUSTER_SWITCH 0     /* Must be zero for ARCH_TEGRA_2x_SOC */
132 #define DEBUG_CLUSTER_SWITCH 0          /* Must be zero for ARCH_TEGRA_2x_SOC */
133 #define PARAMETERIZE_CLUSTER_SWITCH 0   /* Must be zero for ARCH_TEGRA_2x_SOC */
134
135 static inline bool is_g_cluster_present(void)   { return true; }
136 static inline unsigned int is_lp_cluster(void)  { return 0; }
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 #endif
144
145 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
146 void tegra2_lp0_suspend_init(void);
147 void tegra2_lp2_set_trigger(unsigned long cycles);
148 unsigned long tegra2_lp2_timer_remain(void);
149 #endif
150 #ifdef CONFIG_ARCH_TEGRA_3x_SOC
151 void tegra3_lp2_set_trigger(unsigned long cycles);
152 unsigned long tegra3_lp2_timer_remain(void);
153 int tegra3_is_lp2_timer_ready(unsigned int cpu);
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 static inline void tegra_lp2_set_trigger(unsigned long cycles)
164 {
165 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
166         tegra2_lp2_set_trigger(cycles);
167 #endif
168 #ifdef CONFIG_ARCH_TEGRA_3x_SOC
169         tegra3_lp2_set_trigger(cycles);
170 #endif
171 }
172
173 static inline unsigned long tegra_lp2_timer_remain(void)
174 {
175 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
176         return tegra2_lp2_timer_remain();
177 #endif
178 #ifdef CONFIG_ARCH_TEGRA_3x_SOC
179         return tegra3_lp2_timer_remain();
180 #endif
181 }
182
183 static inline int tegra_is_lp2_timer_ready(unsigned int cpu)
184 {
185 #if defined(CONFIG_TEGRA_LP2_ARM_TWD) || defined(CONFIG_ARCH_TEGRA_2x_SOC)
186         return 1;
187 #else
188         return tegra3_is_lp2_timer_ready(cpu);
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_ */