ARM: tegra: Add support for passing arguments to bootloader.
[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 #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
87 #define FUSE_SKU_DIRECT_CONFIG \
88         (IO_ADDRESS(TEGRA_FUSE_BASE) + 0x1F4)
89 #define FUSE_SKU_DISABLE_ALL_CPUS       (1<<5)
90 #define FUSE_SKU_NUM_DISABLED_CPUS(x)   (((x) >> 3) & 3)
91
92 void __init tegra_init_suspend(struct tegra_suspend_platform_data *plat);
93
94 u64 tegra_rtc_read_ms(void);
95
96 /*
97  * Callbacks for platform drivers to implement.
98  */
99 extern void (*tegra_deep_sleep)(int);
100
101 unsigned int tegra_idle_lp2_last(unsigned int us, unsigned int flags);
102
103 #if defined(CONFIG_PM_SLEEP) && !defined(CONFIG_ARCH_TEGRA_2x_SOC)
104 void tegra_lp0_suspend_mc(void);
105 void tegra_lp0_resume_mc(void);
106 void tegra_lp0_cpu_mode(bool enter);
107 #else
108 static inline void tegra_lp0_suspend_mc(void) {}
109 static inline void tegra_lp0_resume_mc(void) {}
110 static inline void tegra_lp0_cpu_mode(bool enter) {}
111 #endif
112
113 #ifdef CONFIG_TEGRA_CLUSTER_CONTROL
114 #define INSTRUMENT_CLUSTER_SWITCH 0     /* Should be zero for shipping code */
115 #define DEBUG_CLUSTER_SWITCH 0          /* Should be zero for shipping code */
116 #define PARAMETERIZE_CLUSTER_SWITCH 1   /* Should be zero for shipping code */
117
118 static inline bool is_g_cluster_present(void)
119 {
120         u32 fuse_sku = readl(FUSE_SKU_DIRECT_CONFIG);
121         if (fuse_sku & FUSE_SKU_DISABLE_ALL_CPUS)
122                 return false;
123         return true;
124 }
125 static inline unsigned int is_lp_cluster(void)
126 {
127         unsigned int reg;
128         reg = readl(FLOW_CTRL_CLUSTER_CONTROL);
129         return (reg & 1); /* 0 == G, 1 == LP*/
130 }
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 #else
135 #define INSTRUMENT_CLUSTER_SWITCH 0     /* Must be zero for ARCH_TEGRA_2x_SOC */
136 #define DEBUG_CLUSTER_SWITCH 0          /* Must be zero for ARCH_TEGRA_2x_SOC */
137 #define PARAMETERIZE_CLUSTER_SWITCH 0   /* Must be zero for ARCH_TEGRA_2x_SOC */
138
139 static inline bool is_g_cluster_present(void)   { return true; }
140 static inline unsigned int is_lp_cluster(void)  { return 0; }
141 static inline int tegra_cluster_control(unsigned int us, unsigned int flags)
142 {
143         return -EPERM;
144 }
145 static inline void tegra_cluster_switch_prolog(unsigned int flags) {}
146 static inline void tegra_cluster_switch_epilog(unsigned int flags) {}
147 #endif
148
149 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
150 void tegra2_lp0_suspend_init(void);
151 void tegra2_lp2_set_trigger(unsigned long cycles);
152 unsigned long tegra2_lp2_timer_remain(void);
153 #endif
154 #ifdef CONFIG_ARCH_TEGRA_3x_SOC
155 void tegra3_lp2_set_trigger(unsigned long cycles);
156 unsigned long tegra3_lp2_timer_remain(void);
157 int tegra3_is_lp2_timer_ready(unsigned int cpu);
158 void tegra3_lp2_timer_cancel_secondary(void);
159 #endif
160
161 static inline void tegra_lp0_suspend_init(void)
162 {
163 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
164         tegra2_lp0_suspend_init();
165 #endif
166 }
167
168 static inline void tegra_lp2_set_trigger(unsigned long cycles)
169 {
170 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
171         tegra2_lp2_set_trigger(cycles);
172 #endif
173 #ifdef CONFIG_ARCH_TEGRA_3x_SOC
174         tegra3_lp2_set_trigger(cycles);
175 #endif
176 }
177
178 static inline unsigned long tegra_lp2_timer_remain(void)
179 {
180 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
181         return tegra2_lp2_timer_remain();
182 #endif
183 #ifdef CONFIG_ARCH_TEGRA_3x_SOC
184         return tegra3_lp2_timer_remain();
185 #endif
186 }
187
188 static inline int tegra_is_lp2_timer_ready(unsigned int cpu)
189 {
190 #if defined(CONFIG_TEGRA_LP2_ARM_TWD) || defined(CONFIG_ARCH_TEGRA_2x_SOC)
191         return 1;
192 #else
193         return tegra3_is_lp2_timer_ready(cpu);
194 #endif
195 }
196
197 static inline void tegra_lp2_timer_cancel_secondary(void)
198 {
199 #ifndef CONFIG_ARCH_TEGRA_2x_SOC
200         tegra3_lp2_timer_cancel_secondary();
201 #endif
202 }
203
204 #if DEBUG_CLUSTER_SWITCH && 0 /* !!!FIXME!!! THIS IS BROKEN */
205 extern unsigned int tegra_cluster_debug;
206 #define DEBUG_CLUSTER(x) do { if (tegra_cluster_debug) printk x; } while (0)
207 #else
208 #define DEBUG_CLUSTER(x) do { } while (0)
209 #endif
210 #if PARAMETERIZE_CLUSTER_SWITCH
211 void tegra_cluster_switch_set_parameters(unsigned int us, unsigned int flags);
212 #else
213 static inline void tegra_cluster_switch_set_parameters(
214         unsigned int us, unsigned int flags)
215 { }
216 #endif
217
218 #ifdef CONFIG_SMP
219 extern bool tegra_all_cpus_booted __read_mostly;
220 #else
221 #define tegra_all_cpus_booted (true)
222 #endif
223
224 /* The debug channel uart base physical address */
225 extern unsigned long  debug_uart_port_base;
226
227 extern struct clk *debug_uart_clk;
228 void tegra_console_uart_suspend(void);
229 void tegra_console_uart_resume(void);
230
231 #endif /* _MACH_TEGRA_PM_H_ */