b41f64e4224ba39bedbac2c12fc7d613ea17fe68
[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 in_band_pm;
84         bool disabled;
85         bool updating;
86         bool resolving_to;
87         bool rate_set;
88
89         struct list_head node;  /* node in dvfs_rail_list */
90         struct list_head dvfs;  /* list head of attached dvfs clocks */
91         struct list_head relationships_to;
92         struct list_head relationships_from;
93         struct regulator *reg;
94         int millivolts;
95         int new_millivolts;
96         int dbg_mv_offs;
97         int boot_millivolts;
98         int disable_millivolts;
99         int suspend_millivolts;
100
101         bool suspended;
102         bool dfll_mode;
103         bool dfll_mode_updating;
104         int therm_floor_idx;
105         int therm_scale_idx;
106         struct tegra_cooling_device *vmin_cdev;
107         struct tegra_cooling_device *vmax_cdev;
108         struct tegra_cooling_device *vts_cdev;
109         struct rail_alignment alignment;
110         struct rail_stats stats;
111 };
112
113 enum dfll_range {
114         DFLL_RANGE_NONE = 0,
115         DFLL_RANGE_ALL_RATES,
116         DFLL_RANGE_HIGH_RATES,
117 };
118
119 struct dvfs_dfll_data {
120         u32             tune0;
121         u32             tune0_high_mv;
122         u32             tune1;
123         unsigned long   droop_rate_min;
124         unsigned long   use_dfll_rate_min;
125         unsigned long   out_rate_min;
126         unsigned long   max_rate_boost;
127         int tune_high_min_millivolts;
128         int tune_high_margin_mv;
129         int min_millivolts;
130         enum dfll_range range;
131         void (*tune_trimmers)(bool trim_high);
132 };
133
134 struct dvfs {
135         /* Used only by tegra2_clock.c */
136         const char *clk_name;
137         int speedo_id;
138         int process_id;
139
140         /* Must be initialized before tegra_dvfs_init */
141         int freqs_mult;
142         unsigned long freqs[MAX_DVFS_FREQS];
143         unsigned long *alt_freqs;
144         const int *millivolts;
145         const int *dfll_millivolts;
146         struct dvfs_rail *dvfs_rail;
147         bool auto_dvfs;
148         bool can_override;
149
150         /* Filled in by tegra_dvfs_init */
151         int max_millivolts;
152         int num_freqs;
153         struct dvfs_dfll_data dfll_data;
154         bool therm_dvfs;
155
156         int cur_millivolts;
157         unsigned long cur_rate;
158         struct list_head node;
159         struct list_head debug_node;
160         struct list_head reg_node;
161 };
162
163 struct cvb_dvfs_parameters {
164         int     c0;
165         int     c1;
166         int     c2;
167 };
168
169 struct cvb_dvfs_table {
170         unsigned long freq;
171         struct cvb_dvfs_parameters cvb_dfll_param;
172         struct cvb_dvfs_parameters cvb_pll_param;
173 };
174
175 struct cvb_dvfs {
176         int speedo_id;
177         int process_id;
178
179         struct dvfs_dfll_data dfll_tune_data;
180         int max_mv;
181         int min_mv;
182         int freqs_mult;
183         int speedo_scale;
184         int voltage_scale;
185         struct cvb_dvfs_table cvb_table[MAX_DVFS_FREQS];
186         int vmin_trips_table[MAX_THERMAL_LIMITS];
187         int therm_floors_table[MAX_THERMAL_LIMITS];
188 };
189
190 #define cpu_cvb_dvfs    cvb_dvfs
191 #define gpu_cvb_dvfs    cvb_dvfs
192 #define core_cvb_dvfs   cvb_dvfs
193
194 extern struct dvfs_rail *tegra_cpu_rail;
195 extern struct dvfs_rail *tegra_gpu_rail;
196 extern struct dvfs_rail *tegra_core_rail;
197
198 struct dvfs_data {
199         struct dvfs_rail *rail;
200         struct dvfs *tables;
201         int *millivolts;
202         unsigned int num_tables;
203         unsigned int num_voltages;
204 };
205
206 #ifdef CONFIG_OF
207 typedef int (*of_tegra_dvfs_init_cb_t)(struct device_node *);
208 int of_tegra_dvfs_init(const struct of_device_id *matches);
209 #else
210 static inline int of_tegra_dvfs_init(const struct of_device_id *matches)
211 { return -ENODATA; }
212 #endif
213
214 void tegra11x_init_dvfs(void);
215 void tegra12x_init_dvfs(void);
216 void tegra14x_init_dvfs(void);
217 void tegra12x_vdd_cpu_align(int step_uv, int offset_uv);
218 int tegra_enable_dvfs_on_clk(struct clk *c, struct dvfs *d);
219 int dvfs_debugfs_init(struct dentry *clk_debugfs_root);
220 int tegra_dvfs_late_init(void);
221 int tegra_dvfs_init_rails(struct dvfs_rail *dvfs_rails[], int n);
222 void tegra_dvfs_add_relationships(struct dvfs_relationship *rels, int n);
223 void tegra_dvfs_rail_enable(struct dvfs_rail *rail);
224 void tegra_dvfs_rail_disable(struct dvfs_rail *rail);
225 int tegra_dvfs_rail_power_up(struct dvfs_rail *rail);
226 int tegra_dvfs_rail_power_down(struct dvfs_rail *rail);
227 bool tegra_dvfs_is_rail_up(struct dvfs_rail *rail);
228 bool tegra_dvfs_rail_updating(struct clk *clk);
229 void tegra_dvfs_rail_off(struct dvfs_rail *rail, ktime_t now);
230 void tegra_dvfs_rail_on(struct dvfs_rail *rail, ktime_t now);
231 void tegra_dvfs_rail_pause(struct dvfs_rail *rail, ktime_t delta, bool on);
232 struct dvfs_rail *tegra_dvfs_get_rail_by_name(const char *reg_id);
233
234 int tegra_dvfs_predict_millivolts(struct clk *c, unsigned long rate);
235 int tegra_dvfs_predict_millivolts_pll(struct clk *c, unsigned long rate);
236 int tegra_dvfs_predict_millivolts_dfll(struct clk *c, unsigned long rate);
237 int tegra_dvfs_core_cap_level_apply(int level);
238 int tegra_dvfs_alt_freqs_set(struct dvfs *d, unsigned long *alt_freqs);
239 int tegra_cpu_dvfs_alter(int edp_thermal_index, const cpumask_t *cpus,
240                          bool before_clk_update, int cpu_event);
241 int tegra_dvfs_dfll_mode_set(struct dvfs *d, unsigned long rate);
242 int tegra_dvfs_dfll_mode_clear(struct dvfs *d, unsigned long rate);
243
244 struct tegra_cooling_device *tegra_dvfs_get_cpu_vmax_cdev(void);
245 struct tegra_cooling_device *tegra_dvfs_get_cpu_vmin_cdev(void);
246 struct tegra_cooling_device *tegra_dvfs_get_core_vmin_cdev(void);
247 struct tegra_cooling_device *tegra_dvfs_get_gpu_vmin_cdev(void);
248 void tegra_dvfs_rail_init_vmin_thermal_profile(
249         int *therm_trips_table, int *therm_floors_table,
250         struct dvfs_rail *rail, struct dvfs_dfll_data *d);
251 void tegra_dvfs_rail_init_vmax_thermal_profile(
252         int *therm_trips_table, int *therm_caps_table,
253         struct dvfs_rail *rail, struct dvfs_dfll_data *d);
254 int tegra_dvfs_rail_dfll_mode_set_cold(struct dvfs_rail *rail);
255
256 #ifdef CONFIG_ARCH_TEGRA_12x_SOC
257 int read_gpu_dvfs_table(int **millivolts, unsigned long **freqs);
258 #else
259 static inline int read_gpu_dvfs_table(int **millivolts, unsigned long **freqs)
260 { return -EINVAL; }
261 #endif
262
263 #ifndef CONFIG_ARCH_TEGRA_2x_SOC
264 int tegra_dvfs_rail_disable_prepare(struct dvfs_rail *rail);
265 int tegra_dvfs_rail_post_enable(struct dvfs_rail *rail);
266 #else
267 static inline int tegra_dvfs_rail_disable_prepare(struct dvfs_rail *rail)
268 { return 0; }
269 static inline int tegra_dvfs_rail_post_enable(struct dvfs_rail *rail)
270 { return 0; }
271 #endif
272
273 static inline bool tegra_dvfs_rail_is_dfll_mode(struct dvfs_rail *rail)
274 {
275         return rail ? rail->dfll_mode : false;
276 }
277 static inline bool tegra_dvfs_is_dfll_range_entry(struct dvfs *d,
278                                                   unsigned long rate)
279 {
280         /* make exception for cluster switch (cur_rate = 0) */
281         return  d->cur_rate && d->dvfs_rail && (!d->dvfs_rail->dfll_mode) &&
282                 (d->dfll_data.range == DFLL_RANGE_HIGH_RATES) &&
283                 (rate >= d->dfll_data.use_dfll_rate_min) &&
284                 (d->cur_rate < d->dfll_data.use_dfll_rate_min);
285 }
286
287 static inline bool tegra_dvfs_is_dfll_scale(struct dvfs *d, unsigned long rate)
288 {
289         return tegra_dvfs_rail_is_dfll_mode(d->dvfs_rail) ||
290                 tegra_dvfs_is_dfll_range_entry(d, rate);
291 }
292
293 static inline bool tegra_dvfs_is_dfll_range(struct dvfs *d, unsigned long rate)
294 {
295         return (d->dfll_data.range == DFLL_RANGE_ALL_RATES) ||
296                 ((d->dfll_data.range == DFLL_RANGE_HIGH_RATES) &&
297                 (rate >= d->dfll_data.use_dfll_rate_min));
298 }
299 static inline int tegra_dvfs_set_dfll_range(struct dvfs *d, int range)
300 {
301         if (!d->dfll_millivolts)
302                 return -ENOSYS;
303
304         if ((range < DFLL_RANGE_NONE) || (range > DFLL_RANGE_HIGH_RATES))
305                 return -EINVAL;
306
307         d->dfll_data.range = range;
308         return 0;
309 }
310 static inline void tegra_dvfs_rail_mode_updating(struct dvfs_rail *rail,
311                                                  bool updating)
312 {
313         if (rail)
314                 rail->dfll_mode_updating = updating;
315 }
316
317 static inline void tegra_dvfs_set_dfll_tune_trimmers(
318         struct dvfs *d, void (*tune_trimmers)(bool trim_high))
319 {
320         d->dfll_data.tune_trimmers = tune_trimmers;
321 }
322
323 static inline int tegra_dvfs_rail_get_nominal_millivolts(struct dvfs_rail *rail)
324 {
325         if (rail)
326                 return rail->nominal_millivolts;
327         return -ENOENT;
328 }
329
330 static inline int tegra_dvfs_rail_get_boot_level(struct dvfs_rail *rail)
331 {
332         if (rail)
333                 return rail->boot_millivolts ? : rail->nominal_millivolts;
334         return -ENOENT;
335 }
336
337 static inline int tegra_dvfs_rail_get_thermal_floor(struct dvfs_rail *rail)
338 {
339         if (rail && rail->therm_mv_floors &&
340             (rail->therm_floor_idx < rail->therm_mv_floors_num))
341                 return rail->therm_mv_floors[rail->therm_floor_idx];
342         return 0;
343 }
344
345 static inline int tegra_dvfs_rail_get_override_floor(struct dvfs_rail *rail)
346 {
347         if (rail)
348                 return rail->min_override_millivolts;
349         return -ENOENT;
350 }
351
352 static inline bool tegra_dvfs_is_dfll_bypass(void)
353 {
354 #ifdef CONFIG_REGULATOR_TEGRA_DFLL_BYPASS
355         return true;
356 #else
357         return false;
358 #endif
359 }
360
361 #endif