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