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 void dev_pm_opp_put_opp_table(struct opp_table *opp_table);
  83
  84 unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp);
  85
  86 unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp);
  87
  88 bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp);
  89
  90 int dev_pm_opp_get_opp_count(struct device *dev);
  91 unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev);
  92 unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev);
  93 unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev);
  94 unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev);
  95
  96 struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
  97                                               unsigned long freq,
  98                                               bool available);
  99
 100 struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
 101                                               unsigned long *freq);
 102
 103 struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
 104                                              unsigned long *freq);
 105 void dev_pm_opp_put(struct dev_pm_opp *opp);
 106
 107 int dev_pm_opp_add(struct device *dev, unsigned long freq,
 108                    unsigned long u_volt);
 109 void dev_pm_opp_remove(struct device *dev, unsigned long freq);
 110
 111 int dev_pm_opp_enable(struct device *dev, unsigned long freq);
 112
 113 int dev_pm_opp_disable(struct device *dev, unsigned long freq);
 114
 115 int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb);
 116 int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb);
 117
 118 struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev, const u32 *versions, unsigned int count);
 119 void dev_pm_opp_put_supported_hw(struct opp_table *opp_table);
 120 struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name);
 121 void dev_pm_opp_put_prop_name(struct opp_table *opp_table);
 122 struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count);
 123 void dev_pm_opp_put_regulators(struct opp_table *opp_table);
 124 struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char * name);
 125 void dev_pm_opp_put_clkname(struct opp_table *opp_table);
 126 struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev, int (*set_opp)(struct dev_pm_set_opp_data *data));
 127 void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table);
 128 int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq);
 129 int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask);
 130 int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
 131 void dev_pm_opp_remove_table(struct device *dev);
 132 void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask);
 133 #else
 134 static inline struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
 135 {
 136         return ERR_PTR(-ENOTSUPP);
 137 }
 138
 139 static inline void dev_pm_opp_put_opp_table(struct opp_table *opp_table) {}
 140
 141 static inline unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
 142 {
 143         return 0;
 144 }
 145
 146 static inline unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
 147 {
 148         return 0;
 149 }
 150
 151 static inline bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
 152 {
 153         return false;
 154 }
 155
 156 static inline int dev_pm_opp_get_opp_count(struct device *dev)
 157 {
 158         return 0;
 159 }
 160
 161 static inline unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
 162 {
 163         return 0;
 164 }
 165
 166 static inline unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
 167 {
 168         return 0;
 169 }
 170
 171 static inline unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
 172 {
 173         return 0;
 174 }
 175
 176 static inline unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev)
 177 {
 178         return 0;
 179 }
 180
 181 static inline struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
 182                                         unsigned long freq, bool available)
 183 {
 184         return ERR_PTR(-ENOTSUPP);
 185 }
 186
 187 static inline struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
 188                                         unsigned long *freq)
 189 {
 190         return ERR_PTR(-ENOTSUPP);
 191 }
 192
 193 static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
 194                                         unsigned long *freq)
 195 {
 196         return ERR_PTR(-ENOTSUPP);
 197 }
 198
 199 static inline void dev_pm_opp_put(struct dev_pm_opp *opp) {}
 200
 201 static inline int dev_pm_opp_add(struct device *dev, unsigned long freq,
 202                                         unsigned long u_volt)
 203 {
 204         return -ENOTSUPP;
 205 }
 206
 207 static inline void dev_pm_opp_remove(struct device *dev, unsigned long freq)
 208 {
 209 }
 210
 211 static inline int dev_pm_opp_enable(struct device *dev, unsigned long freq)
 212 {
 213         return 0;
 214 }
 215
 216 static inline int dev_pm_opp_disable(struct device *dev, unsigned long freq)
 217 {
 218         return 0;
 219 }
 220
 221 static inline int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
 222 {
 223         return -ENOTSUPP;
 224 }
 225
 226 static inline int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb)
 227 {
 228         return -ENOTSUPP;
 229 }
 230
 231 static inline struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev,
 232                                                             const u32 *versions,
 233                                                             unsigned int count)
 234 {
 235         return ERR_PTR(-ENOTSUPP);
 236 }
 237
 238 static inline void dev_pm_opp_put_supported_hw(struct opp_table *opp_table) {}
 239
 240 static inline struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev,
 241                         int (*set_opp)(struct dev_pm_set_opp_data *data))
 242 {
 243         return ERR_PTR(-ENOTSUPP);
 244 }
 245
 246 static inline void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table) {}
 247
 248 static inline struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name)
 249 {
 250         return ERR_PTR(-ENOTSUPP);
 251 }
 252
 253 static inline void dev_pm_opp_put_prop_name(struct opp_table *opp_table) {}
 254
 255 static inline struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count)
 256 {
 257         return ERR_PTR(-ENOTSUPP);
 258 }
 259
 260 static inline void dev_pm_opp_put_regulators(struct opp_table *opp_table) {}
 261
 262 static inline struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char * name)
 263 {
 264         return ERR_PTR(-ENOTSUPP);
 265 }
 266
 267 static inline void dev_pm_opp_put_clkname(struct opp_table *opp_table) {}
 268
 269 static inline int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
 270 {
 271         return -ENOTSUPP;
 272 }
 273
 274 static inline int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask)
 275 {
 276         return -ENOTSUPP;
 277 }
 278
 279 static inline int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
 280 {
 281         return -EINVAL;
 282 }
 283
 284 static inline void dev_pm_opp_remove_table(struct device *dev)
 285 {
 286 }
 287
 288 static inline void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask)
 289 {
 290 }
 291
 292 #endif          /* CONFIG_PM_OPP */
 293
 294 #if defined(CONFIG_PM_OPP) && defined(CONFIG_OF)
 295 int dev_pm_opp_of_add_table(struct device *dev);
 296 int dev_pm_opp_of_add_table_indexed(struct device *dev, int index);
 297 void dev_pm_opp_of_remove_table(struct device *dev);
 298 int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask);
 299 void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask);
 300 int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
 301 struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev);
 302 struct dev_pm_opp *of_dev_pm_opp_find_required_opp(struct device *dev, struct device_node *np);
 303 struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp);
 304 #else
 305 static inline int dev_pm_opp_of_add_table(struct device *dev)
 306 {
 307         return -ENOTSUPP;
 308 }
 309
 310 static inline int dev_pm_opp_of_add_table_indexed(struct device *dev, int index)
 311 {
 312         return -ENOTSUPP;
 313 }
 314
 315 static inline void dev_pm_opp_of_remove_table(struct device *dev)
 316 {
 317 }
 318
 319 static inline int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask)
 320 {
 321         return -ENOTSUPP;
 322 }
 323
 324 static inline void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask)
 325 {
 326 }
 327
 328 static inline int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
 329 {
 330         return -ENOTSUPP;
 331 }
 332
 333 static inline struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev)
 334 {
 335         return NULL;
 336 }
 337
 338 static inline struct dev_pm_opp *of_dev_pm_opp_find_required_opp(struct device *dev, struct device_node *np)
 339 {
 340         return NULL;
 341 }
 342 static inline struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp)
 343 {
 344         return NULL;
 345 }
 346 #endif
 347
 348 #endif          /* __LINUX_OPP_H__ */