include/linux/pm_opp.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * Generic OPP Interface
   4  *
   5  * Copyright (C) 2009-2010 Texas Instruments Incorporated.
   6  *      Nishanth Menon
   7  *      Romit Dasgupta
   8  *      Kevin Hilman
   9  */
  10
  11 #ifndef __LINUX_OPP_H__
  12 #define __LINUX_OPP_H__
  13
  14 #include <linux/err.h>
  15 #include <linux/notifier.h>
  16
  17 struct clk;
  18 struct regulator;
  19 struct dev_pm_opp;
  20 struct device;
  21 struct opp_table;
  22
  23 enum dev_pm_opp_event {
  24         OPP_EVENT_ADD, OPP_EVENT_REMOVE, OPP_EVENT_ENABLE, OPP_EVENT_DISABLE,
  25         OPP_EVENT_ADJUST_VOLTAGE,
  26 };
  27
  28 /**
  29  * struct dev_pm_opp_supply - Power supply voltage/current values
  30  * @u_volt:     Target voltage in microvolts corresponding to this OPP
  31  * @u_volt_min: Minimum voltage in microvolts corresponding to this OPP
  32  * @u_volt_max: Maximum voltage in microvolts corresponding to this OPP
  33  * @u_amp:      Maximum current drawn by the device in microamperes
  34  *
  35  * This structure stores the voltage/current values for a single power supply.
  36  */
  37 struct dev_pm_opp_supply {
  38         unsigned long u_volt;
  39         unsigned long u_volt_min;
  40         unsigned long u_volt_max;
  41         unsigned long u_amp;
  42 };
  43
  44 /**
  45  * struct dev_pm_opp_icc_bw - Interconnect bandwidth values
  46  * @avg:        Average bandwidth corresponding to this OPP (in icc units)
  47  * @peak:       Peak bandwidth corresponding to this OPP (in icc units)
  48  *
  49  * This structure stores the bandwidth values for a single interconnect path.
  50  */
  51 struct dev_pm_opp_icc_bw {
  52         u32 avg;
  53         u32 peak;
  54 };
  55
  56 /**
  57  * struct dev_pm_opp_info - OPP freq/voltage/current values
  58  * @rate:       Target clk rate in hz
  59  * @supplies:   Array of voltage/current values for all power supplies
  60  *
  61  * This structure stores the freq/voltage/current values for a single OPP.
  62  */
  63 struct dev_pm_opp_info {
  64         unsigned long rate;
  65         struct dev_pm_opp_supply *supplies;
  66 };
  67
  68 /**
  69  * struct dev_pm_set_opp_data - Set OPP data
  70  * @old_opp:    Old OPP info
  71  * @new_opp:    New OPP info
  72  * @regulators: Array of regulator pointers
  73  * @regulator_count: Number of regulators
  74  * @clk:        Pointer to clk
  75  * @dev:        Pointer to the struct device
  76  *
  77  * This structure contains all information required for setting an OPP.
  78  */
  79 struct dev_pm_set_opp_data {
  80         struct dev_pm_opp_info old_opp;
  81         struct dev_pm_opp_info new_opp;
  82
  83         struct regulator **regulators;
  84         unsigned int regulator_count;
  85         struct clk *clk;
  86         struct device *dev;
  87 };
  88
  89 #if defined(CONFIG_PM_OPP)
  90
  91 struct opp_table *dev_pm_opp_get_opp_table(struct device *dev);
  92 struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev, int index);
  93 void dev_pm_opp_put_opp_table(struct opp_table *opp_table);
  94
  95 unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp);
  96
  97 unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp);
  98
  99 unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp);
 100
 101 bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp);
 102
 103 int dev_pm_opp_get_opp_count(struct device *dev);
 104 unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev);
 105 unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev);
 106 unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev);
 107 unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev);
 108
 109 struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
 110                                               unsigned long freq,
 111                                               bool available);
 112 struct dev_pm_opp *dev_pm_opp_find_level_exact(struct device *dev,
 113                                                unsigned int level);
 114
 115 struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
 116                                               unsigned long *freq);
 117 struct dev_pm_opp *dev_pm_opp_find_freq_ceil_by_volt(struct device *dev,
 118                                                      unsigned long u_volt);
 119
 120 struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
 121                                              unsigned long *freq);
 122 void dev_pm_opp_put(struct dev_pm_opp *opp);
 123
 124 int dev_pm_opp_add(struct device *dev, unsigned long freq,
 125                    unsigned long u_volt);
 126 void dev_pm_opp_remove(struct device *dev, unsigned long freq);
 127 void dev_pm_opp_remove_all_dynamic(struct device *dev);
 128
 129 int dev_pm_opp_adjust_voltage(struct device *dev, unsigned long freq,
 130                               unsigned long u_volt, unsigned long u_volt_min,
 131                               unsigned long u_volt_max);
 132
 133 int dev_pm_opp_enable(struct device *dev, unsigned long freq);
 134
 135 int dev_pm_opp_disable(struct device *dev, unsigned long freq);
 136
 137 int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb);
 138 int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb);
 139
 140 struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev, const u32 *versions, unsigned int count);
 141 void dev_pm_opp_put_supported_hw(struct opp_table *opp_table);
 142 struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name);
 143 void dev_pm_opp_put_prop_name(struct opp_table *opp_table);
 144 struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count);
 145 void dev_pm_opp_put_regulators(struct opp_table *opp_table);
 146 struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char * name);
 147 void dev_pm_opp_put_clkname(struct opp_table *opp_table);
 148 struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev, int (*set_opp)(struct dev_pm_set_opp_data *data));
 149 void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table);
 150 struct opp_table *dev_pm_opp_attach_genpd(struct device *dev, const char **names, struct device ***virt_devs);
 151 void dev_pm_opp_detach_genpd(struct opp_table *opp_table);
 152 int dev_pm_opp_xlate_performance_state(struct opp_table *src_table, struct opp_table *dst_table, unsigned int pstate);
 153 int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq);
 154 int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask);
 155 int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
 156 void dev_pm_opp_remove_table(struct device *dev);
 157 void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask);
 158 #else
 159 static inline struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
 160 {
 161         return ERR_PTR(-ENOTSUPP);
 162 }
 163
 164 static inline struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev, int index)
 165 {
 166         return ERR_PTR(-ENOTSUPP);
 167 }
 168
 169 static inline void dev_pm_opp_put_opp_table(struct opp_table *opp_table) {}
 170
 171 static inline unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
 172 {
 173         return 0;
 174 }
 175
 176 static inline unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
 177 {
 178         return 0;
 179 }
 180
 181 static inline unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp)
 182 {
 183         return 0;
 184 }
 185
 186 static inline bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
 187 {
 188         return false;
 189 }
 190
 191 static inline int dev_pm_opp_get_opp_count(struct device *dev)
 192 {
 193         return 0;
 194 }
 195
 196 static inline unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
 197 {
 198         return 0;
 199 }
 200
 201 static inline unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
 202 {
 203         return 0;
 204 }
 205
 206 static inline unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
 207 {
 208         return 0;
 209 }
 210
 211 static inline unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev)
 212 {
 213         return 0;
 214 }
 215
 216 static inline struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
 217                                         unsigned long freq, bool available)
 218 {
 219         return ERR_PTR(-ENOTSUPP);
 220 }
 221
 222 static inline struct dev_pm_opp *dev_pm_opp_find_level_exact(struct device *dev,
 223                                         unsigned int level)
 224 {
 225         return ERR_PTR(-ENOTSUPP);
 226 }
 227
 228 static inline struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
 229                                         unsigned long *freq)
 230 {
 231         return ERR_PTR(-ENOTSUPP);
 232 }
 233
 234 static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil_by_volt(struct device *dev,
 235                                         unsigned long u_volt)
 236 {
 237         return ERR_PTR(-ENOTSUPP);
 238 }
 239
 240 static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
 241                                         unsigned long *freq)
 242 {
 243         return ERR_PTR(-ENOTSUPP);
 244 }
 245
 246 static inline void dev_pm_opp_put(struct dev_pm_opp *opp) {}
 247
 248 static inline int dev_pm_opp_add(struct device *dev, unsigned long freq,
 249                                         unsigned long u_volt)
 250 {
 251         return -ENOTSUPP;
 252 }
 253
 254 static inline void dev_pm_opp_remove(struct device *dev, unsigned long freq)
 255 {
 256 }
 257
 258 static inline void dev_pm_opp_remove_all_dynamic(struct device *dev)
 259 {
 260 }
 261
 262 static inline int
 263 dev_pm_opp_adjust_voltage(struct device *dev, unsigned long freq,
 264                           unsigned long u_volt, unsigned long u_volt_min,
 265                           unsigned long u_volt_max)
 266 {
 267         return 0;
 268 }
 269
 270 static inline int dev_pm_opp_enable(struct device *dev, unsigned long freq)
 271 {
 272         return 0;
 273 }
 274
 275 static inline int dev_pm_opp_disable(struct device *dev, unsigned long freq)
 276 {
 277         return 0;
 278 }
 279
 280 static inline int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
 281 {
 282         return -ENOTSUPP;
 283 }
 284
 285 static inline int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb)
 286 {
 287         return -ENOTSUPP;
 288 }
 289
 290 static inline struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev,
 291                                                             const u32 *versions,
 292                                                             unsigned int count)
 293 {
 294         return ERR_PTR(-ENOTSUPP);
 295 }
 296
 297 static inline void dev_pm_opp_put_supported_hw(struct opp_table *opp_table) {}
 298
 299 static inline struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev,
 300                         int (*set_opp)(struct dev_pm_set_opp_data *data))
 301 {
 302         return ERR_PTR(-ENOTSUPP);
 303 }
 304
 305 static inline void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table) {}
 306
 307 static inline struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name)
 308 {
 309         return ERR_PTR(-ENOTSUPP);
 310 }
 311
 312 static inline void dev_pm_opp_put_prop_name(struct opp_table *opp_table) {}
 313
 314 static inline struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count)
 315 {
 316         return ERR_PTR(-ENOTSUPP);
 317 }
 318
 319 static inline void dev_pm_opp_put_regulators(struct opp_table *opp_table) {}
 320
 321 static inline struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char * name)
 322 {
 323         return ERR_PTR(-ENOTSUPP);
 324 }
 325
 326 static inline void dev_pm_opp_put_clkname(struct opp_table *opp_table) {}
 327
 328 static inline struct opp_table *dev_pm_opp_attach_genpd(struct device *dev, const char **names, struct device ***virt_devs)
 329 {
 330         return ERR_PTR(-ENOTSUPP);
 331 }
 332
 333 static inline void dev_pm_opp_detach_genpd(struct opp_table *opp_table) {}
 334
 335 static inline int dev_pm_opp_xlate_performance_state(struct opp_table *src_table, struct opp_table *dst_table, unsigned int pstate)
 336 {
 337         return -ENOTSUPP;
 338 }
 339
 340 static inline int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
 341 {
 342         return -ENOTSUPP;
 343 }
 344
 345 static inline int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask)
 346 {
 347         return -ENOTSUPP;
 348 }
 349
 350 static inline int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
 351 {
 352         return -EINVAL;
 353 }
 354
 355 static inline void dev_pm_opp_remove_table(struct device *dev)
 356 {
 357 }
 358
 359 static inline void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask)
 360 {
 361 }
 362
 363 #endif          /* CONFIG_PM_OPP */
 364
 365 #if defined(CONFIG_PM_OPP) && defined(CONFIG_OF)
 366 int dev_pm_opp_of_add_table(struct device *dev);
 367 int dev_pm_opp_of_add_table_indexed(struct device *dev, int index);
 368 void dev_pm_opp_of_remove_table(struct device *dev);
 369 int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask);
 370 void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask);
 371 int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
 372 struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev);
 373 struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp);
 374 int of_get_required_opp_performance_state(struct device_node *np, int index);
 375 int dev_pm_opp_of_find_icc_paths(struct device *dev, struct opp_table *opp_table);
 376 void dev_pm_opp_of_register_em(struct cpumask *cpus);
 377 #else
 378 static inline int dev_pm_opp_of_add_table(struct device *dev)
 379 {
 380         return -ENOTSUPP;
 381 }
 382
 383 static inline int dev_pm_opp_of_add_table_indexed(struct device *dev, int index)
 384 {
 385         return -ENOTSUPP;
 386 }
 387
 388 static inline void dev_pm_opp_of_remove_table(struct device *dev)
 389 {
 390 }
 391
 392 static inline int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask)
 393 {
 394         return -ENOTSUPP;
 395 }
 396
 397 static inline void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask)
 398 {
 399 }
 400
 401 static inline int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
 402 {
 403         return -ENOTSUPP;
 404 }
 405
 406 static inline struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev)
 407 {
 408         return NULL;
 409 }
 410
 411 static inline struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp)
 412 {
 413         return NULL;
 414 }
 415
 416 static inline void dev_pm_opp_of_register_em(struct cpumask *cpus)
 417 {
 418 }
 419
 420 static inline int of_get_required_opp_performance_state(struct device_node *np, int index)
 421 {
 422         return -ENOTSUPP;
 423 }
 424
 425 static inline int dev_pm_opp_of_find_icc_paths(struct device *dev, struct opp_table *opp_table)
 426 {
 427         return -ENOTSUPP;
 428 }
 429 #endif
 430
 431 #endif          /* __LINUX_OPP_H__ */