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