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