arm: tegra: add Trusted Foundations hooks and driver
[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-2012 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         unsigned int cpu_resume_boost;  /* CPU frequency resume boost in kHz */
68 };
69
70 /* Tegra io dpd entry - for each supported driver */
71 struct tegra_io_dpd {
72         const char *name;       /* driver name */
73         u8 io_dpd_reg_index;    /* io dpd register index */
74         u8 io_dpd_bit;          /* bit position for driver in dpd register */
75 };
76
77 unsigned long tegra_cpu_power_good_time(void);
78 unsigned long tegra_cpu_power_off_time(void);
79 unsigned long tegra_cpu_lp2_min_residency(void);
80 void tegra_clear_cpu_in_lp2(int cpu);
81 bool tegra_set_cpu_in_lp2(int cpu);
82
83 int tegra_suspend_dram(enum tegra_suspend_mode mode, unsigned int flags);
84
85 #define FLOW_CTRL_CLUSTER_CONTROL \
86         (IO_ADDRESS(TEGRA_FLOW_CTRL_BASE) + 0x2c)
87
88 #define FUSE_SKU_DIRECT_CONFIG \
89         (IO_ADDRESS(TEGRA_FUSE_BASE) + 0x1F4)
90 #define FUSE_SKU_DISABLE_ALL_CPUS       (1<<5)
91 #define FUSE_SKU_NUM_DISABLED_CPUS(x)   (((x) >> 3) & 3)
92
93 void __init tegra_init_suspend(struct tegra_suspend_platform_data *plat);
94
95 u64 tegra_rtc_read_ms(void);
96
97 /*
98  * Callbacks for platform drivers to implement.
99  */
100 extern void (*tegra_deep_sleep)(int);
101
102 unsigned int tegra_idle_lp2_last(unsigned int us, unsigned int flags);
103
104 #if defined(CONFIG_PM_SLEEP) && !defined(CONFIG_ARCH_TEGRA_2x_SOC)
105 void tegra_lp0_suspend_mc(void);
106 void tegra_lp0_resume_mc(void);
107 void tegra_lp0_cpu_mode(bool enter);
108 #else
109 static inline void tegra_lp0_suspend_mc(void) {}
110 static inline void tegra_lp0_resume_mc(void) {}
111 static inline void tegra_lp0_cpu_mode(bool enter) {}
112 #endif
113
114 #ifdef CONFIG_TEGRA_CLUSTER_CONTROL
115 #define INSTRUMENT_CLUSTER_SWITCH 0     /* Should be zero for shipping code */
116 #define DEBUG_CLUSTER_SWITCH 0          /* Should be zero for shipping code */
117 #define PARAMETERIZE_CLUSTER_SWITCH 1   /* Should be zero for shipping code */
118
119 static inline bool is_g_cluster_present(void)
120 {
121         u32 fuse_sku = readl(FUSE_SKU_DIRECT_CONFIG);
122         if (fuse_sku & FUSE_SKU_DISABLE_ALL_CPUS)
123                 return false;
124         return true;
125 }
126 static inline unsigned int is_lp_cluster(void)
127 {
128         unsigned int reg;
129         reg = readl(FLOW_CTRL_CLUSTER_CONTROL);
130         return (reg & 1); /* 0 == G, 1 == LP*/
131 }
132 int tegra_cluster_control(unsigned int us, unsigned int flags);
133 void tegra_cluster_switch_prolog(unsigned int flags);
134 void tegra_cluster_switch_epilog(unsigned int flags);
135 #else
136 #define INSTRUMENT_CLUSTER_SWITCH 0     /* Must be zero for ARCH_TEGRA_2x_SOC */
137 #define DEBUG_CLUSTER_SWITCH 0          /* Must be zero for ARCH_TEGRA_2x_SOC */
138 #define PARAMETERIZE_CLUSTER_SWITCH 0   /* Must be zero for ARCH_TEGRA_2x_SOC */
139
140 static inline bool is_g_cluster_present(void)   { return true; }
141 static inline unsigned int is_lp_cluster(void)  { return 0; }
142 static inline int tegra_cluster_control(unsigned int us, unsigned int flags)
143 {
144         return -EPERM;
145 }
146 static inline void tegra_cluster_switch_prolog(unsigned int flags) {}
147 static inline void tegra_cluster_switch_epilog(unsigned int flags) {}
148 #endif
149
150 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
151 void tegra2_lp0_suspend_init(void);
152 void tegra2_lp2_set_trigger(unsigned long cycles);
153 unsigned long tegra2_lp2_timer_remain(void);
154 #endif
155 #ifdef CONFIG_ARCH_TEGRA_3x_SOC
156 void tegra3_lp2_set_trigger(unsigned long cycles);
157 unsigned long tegra3_lp2_timer_remain(void);
158 int tegra3_is_lp2_timer_ready(unsigned int cpu);
159 void tegra3_lp2_timer_cancel_secondary(void);
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 static inline void tegra_lp2_set_trigger(unsigned long cycles)
170 {
171 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
172         tegra2_lp2_set_trigger(cycles);
173 #endif
174 #ifdef CONFIG_ARCH_TEGRA_3x_SOC
175         tegra3_lp2_set_trigger(cycles);
176 #endif
177 }
178
179 static inline unsigned long tegra_lp2_timer_remain(void)
180 {
181 #ifdef CONFIG_ARCH_TEGRA_2x_SOC
182         return tegra2_lp2_timer_remain();
183 #endif
184 #ifdef CONFIG_ARCH_TEGRA_3x_SOC
185         return tegra3_lp2_timer_remain();
186 #endif
187 }
188
189 static inline int tegra_is_lp2_timer_ready(unsigned int cpu)
190 {
191 #if defined(CONFIG_TEGRA_LP2_ARM_TWD) || defined(CONFIG_ARCH_TEGRA_2x_SOC)
192         return 1;
193 #else
194         return tegra3_is_lp2_timer_ready(cpu);
195 #endif
196 }
197
198 static inline void tegra_lp2_timer_cancel_secondary(void)
199 {
200 #ifndef CONFIG_ARCH_TEGRA_2x_SOC
201         tegra3_lp2_timer_cancel_secondary();
202 #endif
203 }
204
205 #if DEBUG_CLUSTER_SWITCH && 0 /* !!!FIXME!!! THIS IS BROKEN */
206 extern unsigned int tegra_cluster_debug;
207 #define DEBUG_CLUSTER(x) do { if (tegra_cluster_debug) printk x; } while (0)
208 #else
209 #define DEBUG_CLUSTER(x) do { } while (0)
210 #endif
211 #if PARAMETERIZE_CLUSTER_SWITCH
212 void tegra_cluster_switch_set_parameters(unsigned int us, unsigned int flags);
213 #else
214 static inline void tegra_cluster_switch_set_parameters(
215         unsigned int us, unsigned int flags)
216 { }
217 #endif
218
219 #ifdef CONFIG_SMP
220 extern bool tegra_all_cpus_booted __read_mostly;
221 #else
222 #define tegra_all_cpus_booted (true)
223 #endif
224
225 #ifdef CONFIG_TRUSTED_FOUNDATIONS
226 void tegra_generic_smc(u32 type, u32 subtype, u32 arg);
227 #endif
228
229 /* The debug channel uart base physical address */
230 extern unsigned long  debug_uart_port_base;
231
232 extern struct clk *debug_uart_clk;
233 void tegra_console_uart_suspend(void);
234 void tegra_console_uart_resume(void);
235
236 #endif /* _MACH_TEGRA_PM_H_ */