include/linux/pm_opp.h

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