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