kernel/power/energy_model.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Energy Model of devices
   4  *
   5  * Copyright (c) 2018-2020, Arm ltd.
   6  * Written by: Quentin Perret, Arm ltd.
   7  * Improvements provided by: Lukasz Luba, Arm ltd.
   8  */
   9
  10 #define pr_fmt(fmt) "energy_model: " fmt
  11
  12 #include <linux/cpu.h>
  13 #include <linux/cpumask.h>
  14 #include <linux/debugfs.h>
  15 #include <linux/energy_model.h>
  16 #include <linux/sched/topology.h>
  17 #include <linux/slab.h>
  18
  19 /*
  20  * Mutex serializing the registrations of performance domains and letting
  21  * callbacks defined by drivers sleep.
  22  */
  23 static DEFINE_MUTEX(em_pd_mutex);
  24
  25 static bool _is_cpu_device(struct device *dev)
  26 {
  27         return (dev->bus == &cpu_subsys);
  28 }
  29
  30 #ifdef CONFIG_DEBUG_FS
  31 static struct dentry *rootdir;
  32
  33 static void em_debug_create_ps(struct em_perf_state *ps, struct dentry *pd)
  34 {
  35         struct dentry *d;
  36         char name[24];
  37
  38         snprintf(name, sizeof(name), "ps:%lu", ps->frequency);
  39
  40         /* Create per-ps directory */
  41         d = debugfs_create_dir(name, pd);
  42         debugfs_create_ulong("frequency", 0444, d, &ps->frequency);
  43         debugfs_create_ulong("power", 0444, d, &ps->power);
  44         debugfs_create_ulong("cost", 0444, d, &ps->cost);
  45 }
  46
  47 static int em_debug_cpus_show(struct seq_file *s, void *unused)
  48 {
  49         seq_printf(s, "%*pbl\n", cpumask_pr_args(to_cpumask(s->private)));
  50
  51         return 0;
  52 }
  53 DEFINE_SHOW_ATTRIBUTE(em_debug_cpus);
  54
  55 static int em_debug_units_show(struct seq_file *s, void *unused)
  56 {
  57         struct em_perf_domain *pd = s->private;
  58         char *units = pd->milliwatts ? "milliWatts" : "bogoWatts";
  59
  60         seq_printf(s, "%s\n", units);
  61
  62         return 0;
  63 }
  64 DEFINE_SHOW_ATTRIBUTE(em_debug_units);
  65
  66 static void em_debug_create_pd(struct device *dev)
  67 {
  68         struct dentry *d;
  69         int i;
  70
  71         /* Create the directory of the performance domain */
  72         d = debugfs_create_dir(dev_name(dev), rootdir);
  73
  74         if (_is_cpu_device(dev))
  75                 debugfs_create_file("cpus", 0444, d, dev->em_pd->cpus,
  76                                     &em_debug_cpus_fops);
  77
  78         debugfs_create_file("units", 0444, d, dev->em_pd, &em_debug_units_fops);
  79
  80         /* Create a sub-directory for each performance state */
  81         for (i = 0; i < dev->em_pd->nr_perf_states; i++)
  82                 em_debug_create_ps(&dev->em_pd->table[i], d);
  83
  84 }
  85
  86 static void em_debug_remove_pd(struct device *dev)
  87 {
  88         debugfs_lookup_and_remove(dev_name(dev), rootdir);
  89 }
  90
  91 static int __init em_debug_init(void)
  92 {
  93         /* Create /sys/kernel/debug/energy_model directory */
  94         rootdir = debugfs_create_dir("energy_model", NULL);
  95
  96         return 0;
  97 }
  98 fs_initcall(em_debug_init);
  99 #else /* CONFIG_DEBUG_FS */
 100 static void em_debug_create_pd(struct device *dev) {}
 101 static void em_debug_remove_pd(struct device *dev) {}
 102 #endif
 103
 104 static int em_create_perf_table(struct device *dev, struct em_perf_domain *pd,
 105                                 int nr_states, struct em_data_callback *cb)
 106 {
 107         unsigned long power, freq, prev_freq = 0, prev_cost = ULONG_MAX;
 108         struct em_perf_state *table;
 109         int i, ret;
 110         u64 fmax;
 111
 112         table = kcalloc(nr_states, sizeof(*table), GFP_KERNEL);
 113         if (!table)
 114                 return -ENOMEM;
 115
 116         /* Build the list of performance states for this performance domain */
 117         for (i = 0, freq = 0; i < nr_states; i++, freq++) {
 118                 /*
 119                  * active_power() is a driver callback which ceils 'freq' to
 120                  * lowest performance state of 'dev' above 'freq' and updates
 121                  * 'power' and 'freq' accordingly.
 122                  */
 123                 ret = cb->active_power(&power, &freq, dev);
 124                 if (ret) {
 125                         dev_err(dev, "EM: invalid perf. state: %d\n",
 126                                 ret);
 127                         goto free_ps_table;
 128                 }
 129
 130                 /*
 131                  * We expect the driver callback to increase the frequency for
 132                  * higher performance states.
 133                  */
 134                 if (freq <= prev_freq) {
 135                         dev_err(dev, "EM: non-increasing freq: %lu\n",
 136                                 freq);
 137                         goto free_ps_table;
 138                 }
 139
 140                 /*
 141                  * The power returned by active_state() is expected to be
 142                  * positive and to fit into 16 bits.
 143                  */
 144                 if (!power || power > EM_MAX_POWER) {
 145                         dev_err(dev, "EM: invalid power: %lu\n",
 146                                 power);
 147                         goto free_ps_table;
 148                 }
 149
 150                 table[i].power = power;
 151                 table[i].frequency = prev_freq = freq;
 152         }
 153
 154         /* Compute the cost of each performance state. */
 155         fmax = (u64) table[nr_states - 1].frequency;
 156         for (i = nr_states - 1; i >= 0; i--) {
 157                 unsigned long power_res = em_scale_power(table[i].power);
 158
 159                 table[i].cost = div64_u64(fmax * power_res,
 160                                           table[i].frequency);
 161                 if (table[i].cost >= prev_cost) {
 162                         dev_dbg(dev, "EM: OPP:%lu is inefficient\n",
 163                                 table[i].frequency);
 164                 } else {
 165                         prev_cost = table[i].cost;
 166                 }
 167         }
 168
 169         pd->table = table;
 170         pd->nr_perf_states = nr_states;
 171
 172         return 0;
 173
 174 free_ps_table:
 175         kfree(table);
 176         return -EINVAL;
 177 }
 178
 179 static int em_create_pd(struct device *dev, int nr_states,
 180                         struct em_data_callback *cb, cpumask_t *cpus)
 181 {
 182         struct em_perf_domain *pd;
 183         struct device *cpu_dev;
 184         int cpu, ret;
 185
 186         if (_is_cpu_device(dev)) {
 187                 pd = kzalloc(sizeof(*pd) + cpumask_size(), GFP_KERNEL);
 188                 if (!pd)
 189                         return -ENOMEM;
 190
 191                 cpumask_copy(em_span_cpus(pd), cpus);
 192         } else {
 193                 pd = kzalloc(sizeof(*pd), GFP_KERNEL);
 194                 if (!pd)
 195                         return -ENOMEM;
 196         }
 197
 198         ret = em_create_perf_table(dev, pd, nr_states, cb);
 199         if (ret) {
 200                 kfree(pd);
 201                 return ret;
 202         }
 203
 204         if (_is_cpu_device(dev))
 205                 for_each_cpu(cpu, cpus) {
 206                         cpu_dev = get_cpu_device(cpu);
 207                         cpu_dev->em_pd = pd;
 208                 }
 209
 210         dev->em_pd = pd;
 211
 212         return 0;
 213 }
 214
 215 /**
 216  * em_pd_get() - Return the performance domain for a device
 217  * @dev : Device to find the performance domain for
 218  *
 219  * Returns the performance domain to which @dev belongs, or NULL if it doesn't
 220  * exist.
 221  */
 222 struct em_perf_domain *em_pd_get(struct device *dev)
 223 {
 224         if (IS_ERR_OR_NULL(dev))
 225                 return NULL;
 226
 227         return dev->em_pd;
 228 }
 229 EXPORT_SYMBOL_GPL(em_pd_get);
 230
 231 /**
 232  * em_cpu_get() - Return the performance domain for a CPU
 233  * @cpu : CPU to find the performance domain for
 234  *
 235  * Returns the performance domain to which @cpu belongs, or NULL if it doesn't
 236  * exist.
 237  */
 238 struct em_perf_domain *em_cpu_get(int cpu)
 239 {
 240         struct device *cpu_dev;
 241
 242         cpu_dev = get_cpu_device(cpu);
 243         if (!cpu_dev)
 244                 return NULL;
 245
 246         return em_pd_get(cpu_dev);
 247 }
 248 EXPORT_SYMBOL_GPL(em_cpu_get);
 249
 250 /**
 251  * em_dev_register_perf_domain() - Register the Energy Model (EM) for a device
 252  * @dev         : Device for which the EM is to register
 253  * @nr_states   : Number of performance states to register
 254  * @cb          : Callback functions providing the data of the Energy Model
 255  * @cpus        : Pointer to cpumask_t, which in case of a CPU device is
 256  *              obligatory. It can be taken from i.e. 'policy->cpus'. For other
 257  *              type of devices this should be set to NULL.
 258  * @milliwatts  : Flag indicating that the power values are in milliWatts or
 259  *              in some other scale. It must be set properly.
 260  *
 261  * Create Energy Model tables for a performance domain using the callbacks
 262  * defined in cb.
 263  *
 264  * The @milliwatts is important to set with correct value. Some kernel
 265  * sub-systems might rely on this flag and check if all devices in the EM are
 266  * using the same scale.
 267  *
 268  * If multiple clients register the same performance domain, all but the first
 269  * registration will be ignored.
 270  *
 271  * Return 0 on success
 272  */
 273 int em_dev_register_perf_domain(struct device *dev, unsigned int nr_states,
 274                                 struct em_data_callback *cb, cpumask_t *cpus,
 275                                 bool milliwatts)
 276 {
 277         unsigned long cap, prev_cap = 0;
 278         int cpu, ret;
 279
 280         if (!dev || !nr_states || !cb)
 281                 return -EINVAL;
 282
 283         /*
 284          * Use a mutex to serialize the registration of performance domains and
 285          * let the driver-defined callback functions sleep.
 286          */
 287         mutex_lock(&em_pd_mutex);
 288
 289         if (dev->em_pd) {
 290                 ret = -EEXIST;
 291                 goto unlock;
 292         }
 293
 294         if (_is_cpu_device(dev)) {
 295                 if (!cpus) {
 296                         dev_err(dev, "EM: invalid CPU mask\n");
 297                         ret = -EINVAL;
 298                         goto unlock;
 299                 }
 300
 301                 for_each_cpu(cpu, cpus) {
 302                         if (em_cpu_get(cpu)) {
 303                                 dev_err(dev, "EM: exists for CPU%d\n", cpu);
 304                                 ret = -EEXIST;
 305                                 goto unlock;
 306                         }
 307                         /*
 308                          * All CPUs of a domain must have the same
 309                          * micro-architecture since they all share the same
 310                          * table.
 311                          */
 312                         cap = arch_scale_cpu_capacity(cpu);
 313                         if (prev_cap && prev_cap != cap) {
 314                                 dev_err(dev, "EM: CPUs of %*pbl must have the same capacity\n",
 315                                         cpumask_pr_args(cpus));
 316
 317                                 ret = -EINVAL;
 318                                 goto unlock;
 319                         }
 320                         prev_cap = cap;
 321                 }
 322         }
 323
 324         ret = em_create_pd(dev, nr_states, cb, cpus);
 325         if (ret)
 326                 goto unlock;
 327
 328         dev->em_pd->milliwatts = milliwatts;
 329
 330         em_debug_create_pd(dev);
 331         dev_info(dev, "EM: created perf domain\n");
 332
 333 unlock:
 334         mutex_unlock(&em_pd_mutex);
 335         return ret;
 336 }
 337 EXPORT_SYMBOL_GPL(em_dev_register_perf_domain);
 338
 339 /**
 340  * em_dev_unregister_perf_domain() - Unregister Energy Model (EM) for a device
 341  * @dev         : Device for which the EM is registered
 342  *
 343  * Unregister the EM for the specified @dev (but not a CPU device).
 344  */
 345 void em_dev_unregister_perf_domain(struct device *dev)
 346 {
 347         if (IS_ERR_OR_NULL(dev) || !dev->em_pd)
 348                 return;
 349
 350         if (_is_cpu_device(dev))
 351                 return;
 352
 353         /*
 354          * The mutex separates all register/unregister requests and protects
 355          * from potential clean-up/setup issues in the debugfs directories.
 356          * The debugfs directory name is the same as device's name.
 357          */
 358         mutex_lock(&em_pd_mutex);
 359         em_debug_remove_pd(dev);
 360
 361         kfree(dev->em_pd->table);
 362         kfree(dev->em_pd);
 363         dev->em_pd = NULL;
 364         mutex_unlock(&em_pd_mutex);
 365 }
 366 EXPORT_SYMBOL_GPL(em_dev_unregister_perf_domain);