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