Viresh Kumar | 4471a34 | 2012-10-26 00:47:42 +0200 | [diff] [blame] | 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 | |
Borislav Petkov | beb0ff3 | 2013-04-02 12:26:15 +0000 | [diff] [blame] | 17 | #ifndef _CPUFREQ_GOVERNOR_H |
| 18 | #define _CPUFREQ_GOVERNOR_H |
Viresh Kumar | 4471a34 | 2012-10-26 00:47:42 +0200 | [diff] [blame] | 19 | |
Rafael J. Wysocki | 2dd3e72 | 2015-12-08 21:44:05 +0100 | [diff] [blame] | 20 | #include <linux/atomic.h> |
Rafael J. Wysocki | 9be4fd2 | 2016-02-10 16:53:50 +0100 | [diff] [blame] | 21 | #include <linux/irq_work.h> |
Viresh Kumar | 4471a34 | 2012-10-26 00:47:42 +0200 | [diff] [blame] | 22 | #include <linux/cpufreq.h> |
Viresh Kumar | 5ff0a26 | 2013-08-06 22:53:03 +0530 | [diff] [blame] | 23 | #include <linux/kernel_stat.h> |
| 24 | #include <linux/module.h> |
Viresh Kumar | 4471a34 | 2012-10-26 00:47:42 +0200 | [diff] [blame] | 25 | #include <linux/mutex.h> |
Viresh Kumar | 4471a34 | 2012-10-26 00:47:42 +0200 | [diff] [blame] | 26 | |
| 27 | /* |
| 28 | * The polling frequency depends on the capability of the processor. Default |
| 29 | * polling frequency is 1000 times the transition latency of the processor. The |
Stratos Karafotis | c4afc41 | 2013-08-26 21:42:21 +0300 | [diff] [blame] | 30 | * governor will work on any processor with transition latency <= 10ms, using |
Viresh Kumar | 4471a34 | 2012-10-26 00:47:42 +0200 | [diff] [blame] | 31 | * appropriate sampling rate. |
| 32 | * |
Stratos Karafotis | c4afc41 | 2013-08-26 21:42:21 +0300 | [diff] [blame] | 33 | * For CPUs with transition latency > 10ms (mostly drivers with CPUFREQ_ETERNAL) |
| 34 | * this governor will not work. All times here are in us (micro seconds). |
Viresh Kumar | 4471a34 | 2012-10-26 00:47:42 +0200 | [diff] [blame] | 35 | */ |
| 36 | #define MIN_SAMPLING_RATE_RATIO (2) |
| 37 | #define LATENCY_MULTIPLIER (1000) |
Viresh Kumar | 98104ee | 2013-02-26 15:07:24 +0530 | [diff] [blame] | 38 | #define MIN_LATENCY_MULTIPLIER (20) |
Viresh Kumar | 4471a34 | 2012-10-26 00:47:42 +0200 | [diff] [blame] | 39 | #define TRANSITION_LATENCY_LIMIT (10 * 1000 * 1000) |
| 40 | |
| 41 | /* Ondemand Sampling types */ |
| 42 | enum {OD_NORMAL_SAMPLE, OD_SUB_SAMPLE}; |
| 43 | |
Rafael J. Wysocki | 0dd3c1d | 2016-03-22 02:47:51 +0100 | [diff] [blame^] | 44 | struct gov_attr_set { |
| 45 | struct kobject kobj; |
| 46 | struct list_head policy_list; |
| 47 | struct mutex update_lock; |
| 48 | int usage_count; |
| 49 | }; |
| 50 | |
Viresh Kumar | 4471a34 | 2012-10-26 00:47:42 +0200 | [diff] [blame] | 51 | /* |
| 52 | * Abbreviations: |
| 53 | * dbs: used as a shortform for demand based switching It helps to keep variable |
| 54 | * names smaller, simpler |
| 55 | * cdbs: common dbs |
Namhyung Kim | e5dde92 | 2013-02-28 05:38:00 +0000 | [diff] [blame] | 56 | * od_*: On-demand governor |
Viresh Kumar | 4471a34 | 2012-10-26 00:47:42 +0200 | [diff] [blame] | 57 | * cs_*: Conservative governor |
| 58 | */ |
| 59 | |
Rafael J. Wysocki | bc50547 | 2016-02-07 16:24:26 +0100 | [diff] [blame] | 60 | /* Governor demand based switching data (per-policy or global). */ |
| 61 | struct dbs_data { |
Rafael J. Wysocki | 0dd3c1d | 2016-03-22 02:47:51 +0100 | [diff] [blame^] | 62 | struct gov_attr_set attr_set; |
Rafael J. Wysocki | bc50547 | 2016-02-07 16:24:26 +0100 | [diff] [blame] | 63 | void *tuners; |
Viresh Kumar | ff4b178 | 2016-02-09 09:01:32 +0530 | [diff] [blame] | 64 | unsigned int min_sampling_rate; |
| 65 | unsigned int ignore_nice_load; |
| 66 | unsigned int sampling_rate; |
| 67 | unsigned int sampling_down_factor; |
| 68 | unsigned int up_threshold; |
Rafael J. Wysocki | 8847e03 | 2016-02-18 02:20:13 +0100 | [diff] [blame] | 69 | unsigned int io_is_busy; |
Rafael J. Wysocki | bc50547 | 2016-02-07 16:24:26 +0100 | [diff] [blame] | 70 | }; |
| 71 | |
Rafael J. Wysocki | 0dd3c1d | 2016-03-22 02:47:51 +0100 | [diff] [blame^] | 72 | static inline struct dbs_data *to_dbs_data(struct gov_attr_set *attr_set) |
| 73 | { |
| 74 | return container_of(attr_set, struct dbs_data, attr_set); |
| 75 | } |
| 76 | |
Viresh Kumar | c443563 | 2016-02-09 09:01:33 +0530 | [diff] [blame] | 77 | /* Governor's specific attributes */ |
Viresh Kumar | c443563 | 2016-02-09 09:01:33 +0530 | [diff] [blame] | 78 | struct governor_attr { |
| 79 | struct attribute attr; |
Rafael J. Wysocki | 0dd3c1d | 2016-03-22 02:47:51 +0100 | [diff] [blame^] | 80 | ssize_t (*show)(struct gov_attr_set *attr_set, char *buf); |
| 81 | ssize_t (*store)(struct gov_attr_set *attr_set, const char *buf, |
Viresh Kumar | c443563 | 2016-02-09 09:01:33 +0530 | [diff] [blame] | 82 | size_t count); |
| 83 | }; |
| 84 | |
| 85 | #define gov_show_one(_gov, file_name) \ |
| 86 | static ssize_t show_##file_name \ |
Rafael J. Wysocki | 0dd3c1d | 2016-03-22 02:47:51 +0100 | [diff] [blame^] | 87 | (struct gov_attr_set *attr_set, char *buf) \ |
Viresh Kumar | c443563 | 2016-02-09 09:01:33 +0530 | [diff] [blame] | 88 | { \ |
Rafael J. Wysocki | 0dd3c1d | 2016-03-22 02:47:51 +0100 | [diff] [blame^] | 89 | struct dbs_data *dbs_data = to_dbs_data(attr_set); \ |
Viresh Kumar | c443563 | 2016-02-09 09:01:33 +0530 | [diff] [blame] | 90 | struct _gov##_dbs_tuners *tuners = dbs_data->tuners; \ |
| 91 | return sprintf(buf, "%u\n", tuners->file_name); \ |
| 92 | } |
| 93 | |
| 94 | #define gov_show_one_common(file_name) \ |
| 95 | static ssize_t show_##file_name \ |
Rafael J. Wysocki | 0dd3c1d | 2016-03-22 02:47:51 +0100 | [diff] [blame^] | 96 | (struct gov_attr_set *attr_set, char *buf) \ |
Viresh Kumar | c443563 | 2016-02-09 09:01:33 +0530 | [diff] [blame] | 97 | { \ |
Rafael J. Wysocki | 0dd3c1d | 2016-03-22 02:47:51 +0100 | [diff] [blame^] | 98 | struct dbs_data *dbs_data = to_dbs_data(attr_set); \ |
Viresh Kumar | c443563 | 2016-02-09 09:01:33 +0530 | [diff] [blame] | 99 | return sprintf(buf, "%u\n", dbs_data->file_name); \ |
| 100 | } |
| 101 | |
| 102 | #define gov_attr_ro(_name) \ |
| 103 | static struct governor_attr _name = \ |
| 104 | __ATTR(_name, 0444, show_##_name, NULL) |
| 105 | |
| 106 | #define gov_attr_rw(_name) \ |
| 107 | static struct governor_attr _name = \ |
| 108 | __ATTR(_name, 0644, show_##_name, store_##_name) |
| 109 | |
Viresh Kumar | 44152cb | 2015-07-18 11:30:59 +0530 | [diff] [blame] | 110 | /* Common to all CPUs of a policy */ |
Rafael J. Wysocki | e40e7b2 | 2016-02-10 17:07:44 +0100 | [diff] [blame] | 111 | struct policy_dbs_info { |
Viresh Kumar | 44152cb | 2015-07-18 11:30:59 +0530 | [diff] [blame] | 112 | struct cpufreq_policy *policy; |
| 113 | /* |
Viresh Kumar | 70f43e5 | 2015-12-09 07:34:42 +0530 | [diff] [blame] | 114 | * Per policy mutex that serializes load evaluation from limit-change |
| 115 | * and work-handler. |
Viresh Kumar | 44152cb | 2015-07-18 11:30:59 +0530 | [diff] [blame] | 116 | */ |
| 117 | struct mutex timer_mutex; |
Viresh Kumar | 70f43e5 | 2015-12-09 07:34:42 +0530 | [diff] [blame] | 118 | |
Rafael J. Wysocki | 9be4fd2 | 2016-02-10 16:53:50 +0100 | [diff] [blame] | 119 | u64 last_sample_time; |
| 120 | s64 sample_delay_ns; |
Rafael J. Wysocki | 686cc63 | 2016-02-08 23:41:10 +0100 | [diff] [blame] | 121 | atomic_t work_count; |
Rafael J. Wysocki | 9be4fd2 | 2016-02-10 16:53:50 +0100 | [diff] [blame] | 122 | struct irq_work irq_work; |
Viresh Kumar | 70f43e5 | 2015-12-09 07:34:42 +0530 | [diff] [blame] | 123 | struct work_struct work; |
Rafael J. Wysocki | bc50547 | 2016-02-07 16:24:26 +0100 | [diff] [blame] | 124 | /* dbs_data may be shared between multiple policy objects */ |
| 125 | struct dbs_data *dbs_data; |
Viresh Kumar | c54df07 | 2016-02-10 11:00:25 +0530 | [diff] [blame] | 126 | struct list_head list; |
Rafael J. Wysocki | 57dc3bc | 2016-02-15 02:20:51 +0100 | [diff] [blame] | 127 | /* Multiplier for increasing sample delay temporarily. */ |
| 128 | unsigned int rate_mult; |
Rafael J. Wysocki | e4db281 | 2016-02-15 02:13:42 +0100 | [diff] [blame] | 129 | /* Status indicators */ |
| 130 | bool is_shared; /* This object is used by multiple CPUs */ |
| 131 | bool work_in_progress; /* Work is being queued up or in progress */ |
Viresh Kumar | 44152cb | 2015-07-18 11:30:59 +0530 | [diff] [blame] | 132 | }; |
| 133 | |
Rafael J. Wysocki | e40e7b2 | 2016-02-10 17:07:44 +0100 | [diff] [blame] | 134 | static inline void gov_update_sample_delay(struct policy_dbs_info *policy_dbs, |
Rafael J. Wysocki | 9be4fd2 | 2016-02-10 16:53:50 +0100 | [diff] [blame] | 135 | unsigned int delay_us) |
| 136 | { |
Rafael J. Wysocki | e40e7b2 | 2016-02-10 17:07:44 +0100 | [diff] [blame] | 137 | policy_dbs->sample_delay_ns = delay_us * NSEC_PER_USEC; |
Rafael J. Wysocki | 9be4fd2 | 2016-02-10 16:53:50 +0100 | [diff] [blame] | 138 | } |
| 139 | |
Viresh Kumar | 4471a34 | 2012-10-26 00:47:42 +0200 | [diff] [blame] | 140 | /* Per cpu structures */ |
Viresh Kumar | 875b850 | 2015-06-19 17:18:03 +0530 | [diff] [blame] | 141 | struct cpu_dbs_info { |
Viresh Kumar | 1e7586a | 2012-10-26 00:51:21 +0200 | [diff] [blame] | 142 | u64 prev_cpu_idle; |
| 143 | u64 prev_cpu_wall; |
| 144 | u64 prev_cpu_nice; |
Srivatsa S. Bhat | 18b46ab | 2014-06-08 02:11:43 +0530 | [diff] [blame] | 145 | /* |
Viresh Kumar | c8ae481 | 2014-06-09 14:21:24 +0530 | [diff] [blame] | 146 | * Used to keep track of load in the previous interval. However, when |
| 147 | * explicitly set to zero, it is used as a flag to ensure that we copy |
| 148 | * the previous load to the current interval only once, upon the first |
| 149 | * wake-up from idle. |
Srivatsa S. Bhat | 18b46ab | 2014-06-08 02:11:43 +0530 | [diff] [blame] | 150 | */ |
Viresh Kumar | c8ae481 | 2014-06-09 14:21:24 +0530 | [diff] [blame] | 151 | unsigned int prev_load; |
Rafael J. Wysocki | 9be4fd2 | 2016-02-10 16:53:50 +0100 | [diff] [blame] | 152 | struct update_util_data update_util; |
Rafael J. Wysocki | e40e7b2 | 2016-02-10 17:07:44 +0100 | [diff] [blame] | 153 | struct policy_dbs_info *policy_dbs; |
Viresh Kumar | 4471a34 | 2012-10-26 00:47:42 +0200 | [diff] [blame] | 154 | }; |
| 155 | |
Stratos Karafotis | c4afc41 | 2013-08-26 21:42:21 +0300 | [diff] [blame] | 156 | /* Common Governor data across policies */ |
Rafael J. Wysocki | 7bdad34 | 2016-02-07 16:05:07 +0100 | [diff] [blame] | 157 | struct dbs_governor { |
Rafael J. Wysocki | af92618 | 2016-02-05 03:16:08 +0100 | [diff] [blame] | 158 | struct cpufreq_governor gov; |
Viresh Kumar | c443563 | 2016-02-09 09:01:33 +0530 | [diff] [blame] | 159 | struct kobj_type kobj_type; |
Viresh Kumar | 4471a34 | 2012-10-26 00:47:42 +0200 | [diff] [blame] | 160 | |
Viresh Kumar | 0b981e7 | 2013-10-02 14:13:18 +0530 | [diff] [blame] | 161 | /* |
| 162 | * Common data for platforms that don't set |
| 163 | * CPUFREQ_HAVE_GOVERNOR_PER_POLICY |
| 164 | */ |
Viresh Kumar | 4d5dcc4 | 2013-03-27 15:58:58 +0000 | [diff] [blame] | 165 | struct dbs_data *gdbs_data; |
Viresh Kumar | 4471a34 | 2012-10-26 00:47:42 +0200 | [diff] [blame] | 166 | |
Rafael J. Wysocki | 9be4fd2 | 2016-02-10 16:53:50 +0100 | [diff] [blame] | 167 | unsigned int (*gov_dbs_timer)(struct cpufreq_policy *policy); |
Rafael J. Wysocki | 7d5a995 | 2016-02-18 18:40:14 +0100 | [diff] [blame] | 168 | struct policy_dbs_info *(*alloc)(void); |
| 169 | void (*free)(struct policy_dbs_info *policy_dbs); |
Viresh Kumar | 8e0484d | 2015-06-03 15:57:11 +0530 | [diff] [blame] | 170 | int (*init)(struct dbs_data *dbs_data, bool notify); |
| 171 | void (*exit)(struct dbs_data *dbs_data, bool notify); |
Rafael J. Wysocki | 702c9e5 | 2016-02-18 02:21:21 +0100 | [diff] [blame] | 172 | void (*start)(struct cpufreq_policy *policy); |
Viresh Kumar | 4471a34 | 2012-10-26 00:47:42 +0200 | [diff] [blame] | 173 | }; |
| 174 | |
Rafael J. Wysocki | ea59ee0d | 2016-02-07 16:09:51 +0100 | [diff] [blame] | 175 | static inline struct dbs_governor *dbs_governor_of(struct cpufreq_policy *policy) |
| 176 | { |
| 177 | return container_of(policy->governor, struct dbs_governor, gov); |
| 178 | } |
| 179 | |
Rafael J. Wysocki | 8434dad | 2016-02-18 02:22:42 +0100 | [diff] [blame] | 180 | /* Governor specific operations */ |
Viresh Kumar | 4471a34 | 2012-10-26 00:47:42 +0200 | [diff] [blame] | 181 | struct od_ops { |
Viresh Kumar | 4471a34 | 2012-10-26 00:47:42 +0200 | [diff] [blame] | 182 | unsigned int (*powersave_bias_target)(struct cpufreq_policy *policy, |
| 183 | unsigned int freq_next, unsigned int relation); |
Viresh Kumar | 4471a34 | 2012-10-26 00:47:42 +0200 | [diff] [blame] | 184 | }; |
| 185 | |
Rafael J. Wysocki | 4cccf75 | 2016-02-15 02:19:31 +0100 | [diff] [blame] | 186 | unsigned int dbs_update(struct cpufreq_policy *policy); |
Rafael J. Wysocki | 906a6e5 | 2016-02-07 16:07:51 +0100 | [diff] [blame] | 187 | int cpufreq_governor_dbs(struct cpufreq_policy *policy, unsigned int event); |
Jacob Shin | fb30809 | 2013-04-02 09:56:56 -0500 | [diff] [blame] | 188 | void od_register_powersave_bias_handler(unsigned int (*f) |
| 189 | (struct cpufreq_policy *, unsigned int, unsigned int), |
| 190 | unsigned int powersave_bias); |
| 191 | void od_unregister_powersave_bias_handler(void); |
Rafael J. Wysocki | 0dd3c1d | 2016-03-22 02:47:51 +0100 | [diff] [blame^] | 192 | ssize_t store_sampling_rate(struct gov_attr_set *attr_set, const char *buf, |
Viresh Kumar | aded387 | 2016-02-11 17:31:15 +0530 | [diff] [blame] | 193 | size_t count); |
Rafael J. Wysocki | 8c8f77f | 2016-02-21 00:51:27 +0100 | [diff] [blame] | 194 | void gov_update_cpu_data(struct dbs_data *dbs_data); |
Borislav Petkov | beb0ff3 | 2013-04-02 12:26:15 +0000 | [diff] [blame] | 195 | #endif /* _CPUFREQ_GOVERNOR_H */ |