b7ddb59eff13594d89868bf108a8355ca58094c2
[linux-3.10.git] / arch / arm / mach-tegra / dvfs.h
1 /*
2  *
3  * Copyright (C) 2010 Google, Inc.
4  *
5  * Author:
6  *      Colin Cross <ccross@google.com>
7  *
8  * Copyright (c) 2010-2013 NVIDIA CORPORATION. All rights reserved.
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 #ifndef _TEGRA_DVFS_H_
22 #define _TEGRA_DVFS_H_
23
24 #include <linux/of.h>
25 #include <mach/thermal.h>
26
27 #define MAX_DVFS_FREQS  40
28 #define MAX_DVFS_TABLES 80
29 #define DVFS_RAIL_STATS_TOP_BIN 100
30 #define MAX_THERMAL_LIMITS      8
31
32 struct clk;
33 struct dvfs_rail;
34
35 /*
36  * dvfs_relationship between to rails, "from" and "to"
37  * when the rail changes, it will call dvfs_rail_update on the rails
38  * in the relationship_to list.
39  * when determining the voltage to set a rail to, it will consider each
40  * rail in the relationship_from list.
41  */
42 struct dvfs_relationship {
43         struct dvfs_rail *to;
44         struct dvfs_rail *from;
45         int (*solve)(struct dvfs_rail *, struct dvfs_rail *);
46
47         struct list_head to_node; /* node in relationship_to list */
48         struct list_head from_node; /* node in relationship_from list */
49         bool solved_at_nominal;
50 };
51
52 struct rail_stats {
53         ktime_t time_at_mv[DVFS_RAIL_STATS_TOP_BIN + 1];
54         ktime_t last_update;
55         int last_index;
56         bool off;
57         int bin_uV;
58 };
59
60 struct rail_alignment {
61         int offset_uv;
62         int step_uv;
63 };
64
65 struct dvfs_rail {
66         const char *reg_id;
67         int min_millivolts;
68         int max_millivolts;
69         int reg_max_millivolts;
70         int nominal_millivolts;
71         int fixed_millivolts;
72         int override_millivolts;
73         int min_override_millivolts;
74
75         const int *therm_mv_floors;
76         int therm_mv_floors_num;
77         const int *therm_mv_caps;
78         int therm_mv_caps_num;
79
80         int step;
81         int step_up;
82         bool jmp_to_zero;
83         bool disabled;
84         bool updating;
85         bool resolving_to;
86
87         struct list_head node;  /* node in dvfs_rail_list */
88         struct list_head dvfs;  /* list head of attached dvfs clocks */
89         struct list_head relationships_to;
90         struct list_head relationships_from;
91         struct regulator *reg;
92         int millivolts;
93         int new_millivolts;
94         int offs_millivolts;
95         int boot_millivolts;
96         int disable_millivolts;
97         int suspend_millivolts;
98
99         bool suspended;
100         bool dfll_mode;
101         bool dfll_mode_updating;
102         int therm_floor_idx;
103         struct tegra_cooling_device *vmin_cdev;
104         struct tegra_cooling_device *vmax_cdev;
105         struct rail_alignment alignment;
106         struct rail_stats stats;
107 };
108
109 enum dfll_range {
110         DFLL_RANGE_NONE = 0,
111         DFLL_RANGE_ALL_RATES,
112         DFLL_RANGE_HIGH_RATES,
113 };
114
115 struct dvfs_dfll_data {
116         u32             tune0;
117         u32             tune0_high_mv;
118         u32             tune1;
119         unsigned long   droop_rate_min;
120         unsigned long   use_dfll_rate_min;
121         unsigned long   out_rate_min;
122         unsigned long   max_rate_boost;
123         int tune_high_min_millivolts;
124         int tune_high_margin_mv;
125         int min_millivolts;
126         enum dfll_range range;
127         void (*tune_trimmers)(bool trim_high);
128 };
129
130 struct dvfs {
131         /* Used only by tegra2_clock.c */
132         const char *clk_name;
133         int speedo_id;
134         int process_id;
135
136         /* Must be initialized before tegra_dvfs_init */
137         int freqs_mult;
138         unsigned long freqs[MAX_DVFS_FREQS];
139         unsigned long *alt_freqs;
140         const int *millivolts;
141         const int *dfll_millivolts;
142         struct dvfs_rail *dvfs_rail;
143         bool auto_dvfs;
144
145         /* Filled in by tegra_dvfs_init */
146         int max_millivolts;
147         int num_freqs;
148         struct dvfs_dfll_data dfll_data;
149
150         int cur_millivolts;
151         unsigned long cur_rate;
152         struct list_head node;
153         struct list_head debug_node;
154         struct list_head reg_node;
155 };
156
157 struct cvb_dvfs_parameters {
158         int     c0;
159         int     c1;
160         int     c2;
161 };
162
163 struct cvb_dvfs_table {
164         unsigned long freq;
165         struct cvb_dvfs_parameters cvb_dfll_param;
166         struct cvb_dvfs_parameters cvb_pll_param;
167 };
168
169 struct cvb_dvfs {
170         int speedo_id;
171         int process_id;
172
173         struct dvfs_dfll_data dfll_tune_data;
174         int max_mv;
175         int min_mv;
176         int freqs_mult;
177         int speedo_scale;
178         int voltage_scale;
179         struct cvb_dvfs_table cvb_table[MAX_DVFS_FREQS];
180         int therm_trips_table[MAX_THERMAL_LIMITS];
181         int therm_floors_table[MAX_THERMAL_LIMITS];
182 };
183
184 #define cpu_cvb_dvfs    cvb_dvfs
185 #define gpu_cvb_dvfs    cvb_dvfs
186 #define core_cvb_dvfs   cvb_dvfs
187
188 extern struct dvfs_rail *tegra_cpu_rail;
189 extern struct dvfs_rail *tegra_core_rail;
190
191 struct dvfs_data {
192         struct dvfs_rail *rail;
193         struct dvfs *tables;
194         int *millivolts;
195         unsigned int num_tables;
196         unsigned int num_voltages;
197 };
198
199 #ifdef CONFIG_OF
200 typedef int (*of_tegra_dvfs_init_cb_t)(struct device_node *);
201 int of_tegra_dvfs_init(const struct of_device_id *matches);
202 #else
203 static inline int of_tegra_dvfs_init(const struct of_device_id *matches)
204 { return -ENODATA; }
205 #endif
206
207 void tegra11x_init_dvfs(void);
208 void tegra12x_init_dvfs(void);
209 void tegra14x_init_dvfs(void);
210 void tegra12x_vdd_cpu_align(int step_uv, int offset_uv);
211 int tegra_enable_dvfs_on_clk(struct clk *c, struct dvfs *d);
212 int dvfs_debugfs_init(struct dentry *clk_debugfs_root);
213 int tegra_dvfs_late_init(void);
214 int tegra_dvfs_init_rails(struct dvfs_rail *dvfs_rails[], int n);
215 void tegra_dvfs_add_relationships(struct dvfs_relationship *rels, int n);
216 void tegra_dvfs_rail_enable(struct dvfs_rail *rail);
217 void tegra_dvfs_rail_disable(struct dvfs_rail *rail);
218 bool tegra_dvfs_rail_updating(struct clk *clk);
219 void tegra_dvfs_rail_off(struct dvfs_rail *rail, ktime_t now);
220 void tegra_dvfs_rail_on(struct dvfs_rail *rail, ktime_t now);
221 void tegra_dvfs_rail_pause(struct dvfs_rail *rail, ktime_t delta, bool on);
222 struct dvfs_rail *tegra_dvfs_get_rail_by_name(const char *reg_id);
223 int tegra_dvfs_predict_millivolts(struct clk *c, unsigned long rate);
224 int tegra_dvfs_predict_millivolts_pll(struct clk *c, unsigned long rate);
225 int tegra_dvfs_predict_millivolts_dfll(struct clk *c, unsigned long rate);
226 int tegra_dvfs_core_cap_level_apply(int level);
227 int tegra_dvfs_alt_freqs_set(struct dvfs *d, unsigned long *alt_freqs);
228 int tegra_cpu_dvfs_alter(int edp_thermal_index, const cpumask_t *cpus,
229                          bool before_clk_update, int cpu_event);
230 int tegra_dvfs_dfll_mode_set(struct dvfs *d, unsigned long rate);
231 int tegra_dvfs_dfll_mode_clear(struct dvfs *d, unsigned long rate);
232 struct tegra_cooling_device *tegra_dvfs_get_cpu_vmax_cdev(void);
233 struct tegra_cooling_device *tegra_dvfs_get_cpu_vmin_cdev(void);
234 struct tegra_cooling_device *tegra_dvfs_get_core_vmin_cdev(void);
235 int tegra_dvfs_rail_dfll_mode_set_cold(struct dvfs_rail *rail);
236
237 #ifdef CONFIG_ARCH_TEGRA_12x_SOC
238 int read_gpu_dvfs_table(int **millivolts, unsigned long **freqs);
239 #else
240 static inline int read_gpu_dvfs_table(int **millivolts, unsigned long **freqs)
241 { return -EINVAL; }
242 #endif
243
244 #ifndef CONFIG_ARCH_TEGRA_2x_SOC
245 int tegra_dvfs_rail_disable_prepare(struct dvfs_rail *rail);
246 int tegra_dvfs_rail_post_enable(struct dvfs_rail *rail);
247 #else
248 static inline int tegra_dvfs_rail_disable_prepare(struct dvfs_rail *rail)
249 { return 0; }
250 static inline int tegra_dvfs_rail_post_enable(struct dvfs_rail *rail)
251 { return 0; }
252 #endif
253
254 static inline bool tegra_dvfs_rail_is_dfll_mode(struct dvfs_rail *rail)
255 {
256         return rail ? rail->dfll_mode : false;
257 }
258 static inline bool tegra_dvfs_is_dfll_range_entry(struct dvfs *d,
259                                                   unsigned long rate)
260 {
261         /* make exception for cluster switch (cur_rate = 0) */
262         return  d->cur_rate && d->dvfs_rail && (!d->dvfs_rail->dfll_mode) &&
263                 (d->dfll_data.range == DFLL_RANGE_HIGH_RATES) &&
264                 (rate >= d->dfll_data.use_dfll_rate_min) &&
265                 (d->cur_rate < d->dfll_data.use_dfll_rate_min);
266 }
267
268 static inline bool tegra_dvfs_is_dfll_scale(struct dvfs *d, unsigned long rate)
269 {
270         return tegra_dvfs_rail_is_dfll_mode(d->dvfs_rail) ||
271                 tegra_dvfs_is_dfll_range_entry(d, rate);
272 }
273
274 static inline bool tegra_dvfs_is_dfll_range(struct dvfs *d, unsigned long rate)
275 {
276         return (d->dfll_data.range == DFLL_RANGE_ALL_RATES) ||
277                 ((d->dfll_data.range == DFLL_RANGE_HIGH_RATES) &&
278                 (rate >= d->dfll_data.use_dfll_rate_min));
279 }
280 static inline int tegra_dvfs_set_dfll_range(struct dvfs *d, int range)
281 {
282         if (!d->dfll_millivolts)
283                 return -ENOSYS;
284
285         if ((range < DFLL_RANGE_NONE) || (range > DFLL_RANGE_HIGH_RATES))
286                 return -EINVAL;
287
288         d->dfll_data.range = range;
289         return 0;
290 }
291 static inline void tegra_dvfs_rail_mode_updating(struct dvfs_rail *rail,
292                                                  bool updating)
293 {
294         if (rail)
295                 rail->dfll_mode_updating = updating;
296 }
297
298 static inline void tegra_dvfs_set_dfll_tune_trimmers(
299         struct dvfs *d, void (*tune_trimmers)(bool trim_high))
300 {
301         d->dfll_data.tune_trimmers = tune_trimmers;
302 }
303
304 static inline int tegra_dvfs_rail_get_nominal_millivolts(struct dvfs_rail *rail)
305 {
306         if (rail)
307                 return rail->nominal_millivolts;
308         return -ENOENT;
309 }
310
311 static inline int tegra_dvfs_rail_get_boot_level(struct dvfs_rail *rail)
312 {
313         if (rail)
314                 return rail->boot_millivolts ? : rail->nominal_millivolts;
315         return -ENOENT;
316 }
317
318 static inline int tegra_dvfs_rail_get_thermal_floor(struct dvfs_rail *rail)
319 {
320         if (rail && rail->therm_mv_floors &&
321             (rail->therm_floor_idx < rail->therm_mv_floors_num))
322                 return rail->therm_mv_floors[rail->therm_floor_idx];
323         return 0;
324 }
325
326 static inline int tegra_dvfs_rail_get_override_floor(struct dvfs_rail *rail)
327 {
328         if (rail)
329                 return rail->min_override_millivolts;
330         return -ENOENT;
331 }
332
333 static inline bool tegra_dvfs_is_dfll_bypass(void)
334 {
335 #ifdef CONFIG_REGULATOR_TEGRA_DFLL_BYPASS
336         return true;
337 #else
338         return false;
339 #endif
340 }
341
342 #endif