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