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