1d2912cb1SThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-only */
24471a34fSViresh Kumar /*
34471a34fSViresh Kumar * drivers/cpufreq/cpufreq_governor.h
44471a34fSViresh Kumar *
54471a34fSViresh Kumar * Header file for CPUFreq governors common code
64471a34fSViresh Kumar *
74471a34fSViresh Kumar * Copyright (C) 2001 Russell King
84471a34fSViresh Kumar * (C) 2003 Venkatesh Pallipadi <venkatesh.pallipadi@intel.com>.
94471a34fSViresh Kumar * (C) 2003 Jun Nakajima <jun.nakajima@intel.com>
104471a34fSViresh Kumar * (C) 2009 Alexander Clouter <alex@digriz.org.uk>
114471a34fSViresh Kumar * (c) 2012 Viresh Kumar <viresh.kumar@linaro.org>
124471a34fSViresh Kumar */
134471a34fSViresh Kumar
14beb0ff39SBorislav Petkov #ifndef _CPUFREQ_GOVERNOR_H
15beb0ff39SBorislav Petkov #define _CPUFREQ_GOVERNOR_H
164471a34fSViresh Kumar
172dd3e724SRafael J. Wysocki #include <linux/atomic.h>
189be4fd2cSRafael J. Wysocki #include <linux/irq_work.h>
194471a34fSViresh Kumar #include <linux/cpufreq.h>
2055687da1SIngo Molnar #include <linux/sched/cpufreq.h>
215ff0a268SViresh Kumar #include <linux/kernel_stat.h>
225ff0a268SViresh Kumar #include <linux/module.h>
234471a34fSViresh Kumar #include <linux/mutex.h>
244471a34fSViresh Kumar
254471a34fSViresh Kumar /* Ondemand Sampling types */
264471a34fSViresh Kumar enum {OD_NORMAL_SAMPLE, OD_SUB_SAMPLE};
274471a34fSViresh Kumar
284471a34fSViresh Kumar /*
294471a34fSViresh Kumar * Abbreviations:
304471a34fSViresh Kumar * dbs: used as a shortform for demand based switching It helps to keep variable
314471a34fSViresh Kumar * names smaller, simpler
324471a34fSViresh Kumar * cdbs: common dbs
33e5dde92cSNamhyung Kim * od_*: On-demand governor
344471a34fSViresh Kumar * cs_*: Conservative governor
354471a34fSViresh Kumar */
364471a34fSViresh Kumar
37bc505475SRafael J. Wysocki /* Governor demand based switching data (per-policy or global). */
38bc505475SRafael J. Wysocki struct dbs_data {
390dd3c1d6SRafael J. Wysocki struct gov_attr_set attr_set;
40*a85ee640SKevin Hao struct dbs_governor *gov;
41bc505475SRafael J. Wysocki void *tuners;
42ff4b1789SViresh Kumar unsigned int ignore_nice_load;
43ff4b1789SViresh Kumar unsigned int sampling_rate;
44ff4b1789SViresh Kumar unsigned int sampling_down_factor;
45ff4b1789SViresh Kumar unsigned int up_threshold;
468847e038SRafael J. Wysocki unsigned int io_is_busy;
47bc505475SRafael J. Wysocki };
48bc505475SRafael J. Wysocki
to_dbs_data(struct gov_attr_set * attr_set)490dd3c1d6SRafael J. Wysocki static inline struct dbs_data *to_dbs_data(struct gov_attr_set *attr_set)
500dd3c1d6SRafael J. Wysocki {
510dd3c1d6SRafael J. Wysocki return container_of(attr_set, struct dbs_data, attr_set);
520dd3c1d6SRafael J. Wysocki }
530dd3c1d6SRafael J. Wysocki
54c4435630SViresh Kumar #define gov_show_one(_gov, file_name) \
5585750bcdSLianjie Zhang static ssize_t file_name##_show \
560dd3c1d6SRafael J. Wysocki (struct gov_attr_set *attr_set, char *buf) \
57c4435630SViresh Kumar { \
580dd3c1d6SRafael J. Wysocki struct dbs_data *dbs_data = to_dbs_data(attr_set); \
59c4435630SViresh Kumar struct _gov##_dbs_tuners *tuners = dbs_data->tuners; \
60c4435630SViresh Kumar return sprintf(buf, "%u\n", tuners->file_name); \
61c4435630SViresh Kumar }
62c4435630SViresh Kumar
63c4435630SViresh Kumar #define gov_show_one_common(file_name) \
6485750bcdSLianjie Zhang static ssize_t file_name##_show \
650dd3c1d6SRafael J. Wysocki (struct gov_attr_set *attr_set, char *buf) \
66c4435630SViresh Kumar { \
670dd3c1d6SRafael J. Wysocki struct dbs_data *dbs_data = to_dbs_data(attr_set); \
68c4435630SViresh Kumar return sprintf(buf, "%u\n", dbs_data->file_name); \
69c4435630SViresh Kumar }
70c4435630SViresh Kumar
71c4435630SViresh Kumar #define gov_attr_ro(_name) \
7285750bcdSLianjie Zhang static struct governor_attr _name = __ATTR_RO(_name)
73c4435630SViresh Kumar
74c4435630SViresh Kumar #define gov_attr_rw(_name) \
7585750bcdSLianjie Zhang static struct governor_attr _name = __ATTR_RW(_name)
76c4435630SViresh Kumar
7744152cb8SViresh Kumar /* Common to all CPUs of a policy */
78e40e7b25SRafael J. Wysocki struct policy_dbs_info {
7944152cb8SViresh Kumar struct cpufreq_policy *policy;
8044152cb8SViresh Kumar /*
8170f43e5eSViresh Kumar * Per policy mutex that serializes load evaluation from limit-change
8270f43e5eSViresh Kumar * and work-handler.
8344152cb8SViresh Kumar */
8426f0dbc9SViresh Kumar struct mutex update_mutex;
8570f43e5eSViresh Kumar
869be4fd2cSRafael J. Wysocki u64 last_sample_time;
879be4fd2cSRafael J. Wysocki s64 sample_delay_ns;
88686cc637SRafael J. Wysocki atomic_t work_count;
899be4fd2cSRafael J. Wysocki struct irq_work irq_work;
9070f43e5eSViresh Kumar struct work_struct work;
91bc505475SRafael J. Wysocki /* dbs_data may be shared between multiple policy objects */
92bc505475SRafael J. Wysocki struct dbs_data *dbs_data;
93c54df071SViresh Kumar struct list_head list;
9457dc3bcdSRafael J. Wysocki /* Multiplier for increasing sample delay temporarily. */
9557dc3bcdSRafael J. Wysocki unsigned int rate_mult;
9600bfe058SStratos Karafotis unsigned int idle_periods; /* For conservative */
97e4db2813SRafael J. Wysocki /* Status indicators */
98e4db2813SRafael J. Wysocki bool is_shared; /* This object is used by multiple CPUs */
99e4db2813SRafael J. Wysocki bool work_in_progress; /* Work is being queued up or in progress */
10044152cb8SViresh Kumar };
10144152cb8SViresh Kumar
gov_update_sample_delay(struct policy_dbs_info * policy_dbs,unsigned int delay_us)102e40e7b25SRafael J. Wysocki static inline void gov_update_sample_delay(struct policy_dbs_info *policy_dbs,
1039be4fd2cSRafael J. Wysocki unsigned int delay_us)
1049be4fd2cSRafael J. Wysocki {
105e40e7b25SRafael J. Wysocki policy_dbs->sample_delay_ns = delay_us * NSEC_PER_USEC;
1069be4fd2cSRafael J. Wysocki }
1079be4fd2cSRafael J. Wysocki
1084471a34fSViresh Kumar /* Per cpu structures */
109875b8508SViresh Kumar struct cpu_dbs_info {
1101e7586a1SViresh Kumar u64 prev_cpu_idle;
111b4f4b4b3SRafael J. Wysocki u64 prev_update_time;
1121e7586a1SViresh Kumar u64 prev_cpu_nice;
11318b46abdSSrivatsa S. Bhat /*
114c8ae481bSViresh Kumar * Used to keep track of load in the previous interval. However, when
115c8ae481bSViresh Kumar * explicitly set to zero, it is used as a flag to ensure that we copy
116c8ae481bSViresh Kumar * the previous load to the current interval only once, upon the first
117c8ae481bSViresh Kumar * wake-up from idle.
11818b46abdSSrivatsa S. Bhat */
119c8ae481bSViresh Kumar unsigned int prev_load;
1209be4fd2cSRafael J. Wysocki struct update_util_data update_util;
121e40e7b25SRafael J. Wysocki struct policy_dbs_info *policy_dbs;
1224471a34fSViresh Kumar };
1234471a34fSViresh Kumar
124c4afc410SStratos Karafotis /* Common Governor data across policies */
1257bdad34dSRafael J. Wysocki struct dbs_governor {
126af926185SRafael J. Wysocki struct cpufreq_governor gov;
127c4435630SViresh Kumar struct kobj_type kobj_type;
1284471a34fSViresh Kumar
1290b981e70SViresh Kumar /*
1300b981e70SViresh Kumar * Common data for platforms that don't set
1310b981e70SViresh Kumar * CPUFREQ_HAVE_GOVERNOR_PER_POLICY
1320b981e70SViresh Kumar */
1334d5dcc42SViresh Kumar struct dbs_data *gdbs_data;
1344471a34fSViresh Kumar
13526f0dbc9SViresh Kumar unsigned int (*gov_dbs_update)(struct cpufreq_policy *policy);
1367d5a9956SRafael J. Wysocki struct policy_dbs_info *(*alloc)(void);
1377d5a9956SRafael J. Wysocki void (*free)(struct policy_dbs_info *policy_dbs);
1389a15fb2cSRafael J. Wysocki int (*init)(struct dbs_data *dbs_data);
1399a15fb2cSRafael J. Wysocki void (*exit)(struct dbs_data *dbs_data);
140702c9e54SRafael J. Wysocki void (*start)(struct cpufreq_policy *policy);
1414471a34fSViresh Kumar };
1424471a34fSViresh Kumar
dbs_governor_of(struct cpufreq_policy * policy)143ea59ee0dSRafael J. Wysocki static inline struct dbs_governor *dbs_governor_of(struct cpufreq_policy *policy)
144ea59ee0dSRafael J. Wysocki {
145ea59ee0dSRafael J. Wysocki return container_of(policy->governor, struct dbs_governor, gov);
146ea59ee0dSRafael J. Wysocki }
147ea59ee0dSRafael J. Wysocki
148e788892bSRafael J. Wysocki /* Governor callback routines */
149e788892bSRafael J. Wysocki int cpufreq_dbs_governor_init(struct cpufreq_policy *policy);
150e788892bSRafael J. Wysocki void cpufreq_dbs_governor_exit(struct cpufreq_policy *policy);
151e788892bSRafael J. Wysocki int cpufreq_dbs_governor_start(struct cpufreq_policy *policy);
152e788892bSRafael J. Wysocki void cpufreq_dbs_governor_stop(struct cpufreq_policy *policy);
153e788892bSRafael J. Wysocki void cpufreq_dbs_governor_limits(struct cpufreq_policy *policy);
154e788892bSRafael J. Wysocki
155e788892bSRafael J. Wysocki #define CPUFREQ_DBS_GOVERNOR_INITIALIZER(_name_) \
156e788892bSRafael J. Wysocki { \
157e788892bSRafael J. Wysocki .name = _name_, \
1589a2a9ebcSRafael J. Wysocki .flags = CPUFREQ_GOV_DYNAMIC_SWITCHING, \
159e788892bSRafael J. Wysocki .owner = THIS_MODULE, \
160e788892bSRafael J. Wysocki .init = cpufreq_dbs_governor_init, \
161e788892bSRafael J. Wysocki .exit = cpufreq_dbs_governor_exit, \
162e788892bSRafael J. Wysocki .start = cpufreq_dbs_governor_start, \
163e788892bSRafael J. Wysocki .stop = cpufreq_dbs_governor_stop, \
164e788892bSRafael J. Wysocki .limits = cpufreq_dbs_governor_limits, \
165e788892bSRafael J. Wysocki }
166e788892bSRafael J. Wysocki
1678434dadbSRafael J. Wysocki /* Governor specific operations */
1684471a34fSViresh Kumar struct od_ops {
1694471a34fSViresh Kumar unsigned int (*powersave_bias_target)(struct cpufreq_policy *policy,
1704471a34fSViresh Kumar unsigned int freq_next, unsigned int relation);
1714471a34fSViresh Kumar };
1724471a34fSViresh Kumar
1734cccf755SRafael J. Wysocki unsigned int dbs_update(struct cpufreq_policy *policy);
174fb30809eSJacob Shin void od_register_powersave_bias_handler(unsigned int (*f)
175fb30809eSJacob Shin (struct cpufreq_policy *, unsigned int, unsigned int),
176fb30809eSJacob Shin unsigned int powersave_bias);
177fb30809eSJacob Shin void od_unregister_powersave_bias_handler(void);
17885750bcdSLianjie Zhang ssize_t sampling_rate_store(struct gov_attr_set *attr_set, const char *buf,
179aded387bSViresh Kumar size_t count);
1808c8f77fdSRafael J. Wysocki void gov_update_cpu_data(struct dbs_data *dbs_data);
181beb0ff39SBorislav Petkov #endif /* _CPUFREQ_GOVERNOR_H */
182