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