Commit | Line | Data |
---|---|---|
4471a34f VK |
1 | /* |
2 | * drivers/cpufreq/cpufreq_governor.h | |
3 | * | |
4 | * Header file for CPUFreq governors common code | |
5 | * | |
6 | * Copyright (C) 2001 Russell King | |
7 | * (C) 2003 Venkatesh Pallipadi <venkatesh.pallipadi@intel.com>. | |
8 | * (C) 2003 Jun Nakajima <jun.nakajima@intel.com> | |
9 | * (C) 2009 Alexander Clouter <alex@digriz.org.uk> | |
10 | * (c) 2012 Viresh Kumar <viresh.kumar@linaro.org> | |
11 | * | |
12 | * This program is free software; you can redistribute it and/or modify | |
13 | * it under the terms of the GNU General Public License version 2 as | |
14 | * published by the Free Software Foundation. | |
15 | */ | |
16 | ||
beb0ff39 BP |
17 | #ifndef _CPUFREQ_GOVERNOR_H |
18 | #define _CPUFREQ_GOVERNOR_H | |
4471a34f | 19 | |
2dd3e724 | 20 | #include <linux/atomic.h> |
9be4fd2c | 21 | #include <linux/irq_work.h> |
4471a34f | 22 | #include <linux/cpufreq.h> |
5ff0a268 VK |
23 | #include <linux/kernel_stat.h> |
24 | #include <linux/module.h> | |
4471a34f | 25 | #include <linux/mutex.h> |
4471a34f | 26 | |
4471a34f VK |
27 | /* Ondemand Sampling types */ |
28 | enum {OD_NORMAL_SAMPLE, OD_SUB_SAMPLE}; | |
29 | ||
4471a34f VK |
30 | /* |
31 | * Abbreviations: | |
32 | * dbs: used as a shortform for demand based switching It helps to keep variable | |
33 | * names smaller, simpler | |
34 | * cdbs: common dbs | |
e5dde92c | 35 | * od_*: On-demand governor |
4471a34f VK |
36 | * cs_*: Conservative governor |
37 | */ | |
38 | ||
bc505475 RW |
39 | /* Governor demand based switching data (per-policy or global). */ |
40 | struct dbs_data { | |
0dd3c1d6 | 41 | struct gov_attr_set attr_set; |
bc505475 | 42 | void *tuners; |
ff4b1789 VK |
43 | unsigned int min_sampling_rate; |
44 | unsigned int ignore_nice_load; | |
45 | unsigned int sampling_rate; | |
46 | unsigned int sampling_down_factor; | |
47 | unsigned int up_threshold; | |
8847e038 | 48 | unsigned int io_is_busy; |
c4435630 VK |
49 | }; |
50 | ||
0dd3c1d6 RW |
51 | static inline struct dbs_data *to_dbs_data(struct gov_attr_set *attr_set) |
52 | { | |
53 | return container_of(attr_set, struct dbs_data, attr_set); | |
54 | } | |
55 | ||
c4435630 VK |
56 | #define gov_show_one(_gov, file_name) \ |
57 | static ssize_t show_##file_name \ | |
0dd3c1d6 | 58 | (struct gov_attr_set *attr_set, char *buf) \ |
c4435630 | 59 | { \ |
0dd3c1d6 | 60 | struct dbs_data *dbs_data = to_dbs_data(attr_set); \ |
c4435630 VK |
61 | struct _gov##_dbs_tuners *tuners = dbs_data->tuners; \ |
62 | return sprintf(buf, "%u\n", tuners->file_name); \ | |
63 | } | |
64 | ||
65 | #define gov_show_one_common(file_name) \ | |
66 | static ssize_t show_##file_name \ | |
0dd3c1d6 | 67 | (struct gov_attr_set *attr_set, char *buf) \ |
c4435630 | 68 | { \ |
0dd3c1d6 | 69 | struct dbs_data *dbs_data = to_dbs_data(attr_set); \ |
c4435630 VK |
70 | return sprintf(buf, "%u\n", dbs_data->file_name); \ |
71 | } | |
72 | ||
73 | #define gov_attr_ro(_name) \ | |
74 | static struct governor_attr _name = \ | |
75 | __ATTR(_name, 0444, show_##_name, NULL) | |
76 | ||
77 | #define gov_attr_rw(_name) \ | |
78 | static struct governor_attr _name = \ | |
79 | __ATTR(_name, 0644, show_##_name, store_##_name) | |
80 | ||
44152cb8 | 81 | /* Common to all CPUs of a policy */ |
e40e7b25 | 82 | struct policy_dbs_info { |
44152cb8 VK |
83 | struct cpufreq_policy *policy; |
84 | /* | |
70f43e5e VK |
85 | * Per policy mutex that serializes load evaluation from limit-change |
86 | * and work-handler. | |
44152cb8 VK |
87 | */ |
88 | struct mutex timer_mutex; | |
70f43e5e | 89 | |
9be4fd2c RW |
90 | u64 last_sample_time; |
91 | s64 sample_delay_ns; | |
686cc637 | 92 | atomic_t work_count; |
9be4fd2c | 93 | struct irq_work irq_work; |
70f43e5e | 94 | struct work_struct work; |
bc505475 RW |
95 | /* dbs_data may be shared between multiple policy objects */ |
96 | struct dbs_data *dbs_data; | |
c54df071 | 97 | struct list_head list; |
57dc3bcd RW |
98 | /* Multiplier for increasing sample delay temporarily. */ |
99 | unsigned int rate_mult; | |
e4db2813 RW |
100 | /* Status indicators */ |
101 | bool is_shared; /* This object is used by multiple CPUs */ | |
102 | bool work_in_progress; /* Work is being queued up or in progress */ | |
44152cb8 VK |
103 | }; |
104 | ||
e40e7b25 | 105 | static inline void gov_update_sample_delay(struct policy_dbs_info *policy_dbs, |
9be4fd2c RW |
106 | unsigned int delay_us) |
107 | { | |
e40e7b25 | 108 | policy_dbs->sample_delay_ns = delay_us * NSEC_PER_USEC; |
9be4fd2c RW |
109 | } |
110 | ||
4471a34f | 111 | /* Per cpu structures */ |
875b8508 | 112 | struct cpu_dbs_info { |
1e7586a1 | 113 | u64 prev_cpu_idle; |
b4f4b4b3 | 114 | u64 prev_update_time; |
1e7586a1 | 115 | u64 prev_cpu_nice; |
18b46abd | 116 | /* |
c8ae481b VK |
117 | * Used to keep track of load in the previous interval. However, when |
118 | * explicitly set to zero, it is used as a flag to ensure that we copy | |
119 | * the previous load to the current interval only once, upon the first | |
120 | * wake-up from idle. | |
18b46abd | 121 | */ |
c8ae481b | 122 | unsigned int prev_load; |
9be4fd2c | 123 | struct update_util_data update_util; |
e40e7b25 | 124 | struct policy_dbs_info *policy_dbs; |
4471a34f VK |
125 | }; |
126 | ||
c4afc410 | 127 | /* Common Governor data across policies */ |
7bdad34d | 128 | struct dbs_governor { |
af926185 | 129 | struct cpufreq_governor gov; |
c4435630 | 130 | struct kobj_type kobj_type; |
4471a34f | 131 | |
0b981e70 VK |
132 | /* |
133 | * Common data for platforms that don't set | |
134 | * CPUFREQ_HAVE_GOVERNOR_PER_POLICY | |
135 | */ | |
4d5dcc42 | 136 | struct dbs_data *gdbs_data; |
4471a34f | 137 | |
9be4fd2c | 138 | unsigned int (*gov_dbs_timer)(struct cpufreq_policy *policy); |
7d5a9956 RW |
139 | struct policy_dbs_info *(*alloc)(void); |
140 | void (*free)(struct policy_dbs_info *policy_dbs); | |
8e0484d2 VK |
141 | int (*init)(struct dbs_data *dbs_data, bool notify); |
142 | void (*exit)(struct dbs_data *dbs_data, bool notify); | |
702c9e54 | 143 | void (*start)(struct cpufreq_policy *policy); |
4471a34f VK |
144 | }; |
145 | ||
ea59ee0d RW |
146 | static inline struct dbs_governor *dbs_governor_of(struct cpufreq_policy *policy) |
147 | { | |
148 | return container_of(policy->governor, struct dbs_governor, gov); | |
149 | } | |
150 | ||
8434dadb | 151 | /* Governor specific operations */ |
4471a34f | 152 | struct od_ops { |
4471a34f VK |
153 | unsigned int (*powersave_bias_target)(struct cpufreq_policy *policy, |
154 | unsigned int freq_next, unsigned int relation); | |
4471a34f VK |
155 | }; |
156 | ||
4cccf755 | 157 | unsigned int dbs_update(struct cpufreq_policy *policy); |
906a6e5a | 158 | int cpufreq_governor_dbs(struct cpufreq_policy *policy, unsigned int event); |
fb30809e JS |
159 | void od_register_powersave_bias_handler(unsigned int (*f) |
160 | (struct cpufreq_policy *, unsigned int, unsigned int), | |
161 | unsigned int powersave_bias); | |
162 | void od_unregister_powersave_bias_handler(void); | |
0dd3c1d6 | 163 | ssize_t store_sampling_rate(struct gov_attr_set *attr_set, const char *buf, |
aded387b | 164 | size_t count); |
8c8f77fd | 165 | void gov_update_cpu_data(struct dbs_data *dbs_data); |
beb0ff39 | 166 | #endif /* _CPUFREQ_GOVERNOR_H */ |