1/* 2 * consumer.h -- SoC Regulator consumer support. 3 * 4 * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC. 5 * 6 * Author: Liam Girdwood <lrg@slimlogic.co.uk> 7 * 8 * This program is free software; you can redistribute it and/or modify 9 * it under the terms of the GNU General Public License version 2 as 10 * published by the Free Software Foundation. 11 * 12 * Regulator Consumer Interface. 13 * 14 * A Power Management Regulator framework for SoC based devices. 15 * Features:- 16 * o Voltage and current level control. 17 * o Operating mode control. 18 * o Regulator status. 19 * o sysfs entries for showing client devices and status 20 * 21 * EXPERIMENTAL FEATURES: 22 * Dynamic Regulator operating Mode Switching (DRMS) - allows regulators 23 * to use most efficient operating mode depending upon voltage and load and 24 * is transparent to client drivers. 25 * 26 * e.g. Devices x,y,z share regulator r. Device x and y draw 20mA each during 27 * IO and 1mA at idle. Device z draws 100mA when under load and 5mA when 28 * idling. Regulator r has > 90% efficiency in NORMAL mode at loads > 100mA 29 * but this drops rapidly to 60% when below 100mA. Regulator r has > 90% 30 * efficiency in IDLE mode at loads < 10mA. Thus regulator r will operate 31 * in normal mode for loads > 10mA and in IDLE mode for load <= 10mA. 32 * 33 */ 34 35#ifndef __LINUX_REGULATOR_CONSUMER_H_ 36#define __LINUX_REGULATOR_CONSUMER_H_ 37 38#include <linux/err.h> 39 40struct device; 41struct notifier_block; 42struct regmap; 43 44/* 45 * Regulator operating modes. 46 * 47 * Regulators can run in a variety of different operating modes depending on 48 * output load. This allows further system power savings by selecting the 49 * best (and most efficient) regulator mode for a desired load. 50 * 51 * Most drivers will only care about NORMAL. The modes below are generic and 52 * will probably not match the naming convention of your regulator data sheet 53 * but should match the use cases in the datasheet. 54 * 55 * In order of power efficiency (least efficient at top). 56 * 57 * Mode Description 58 * FAST Regulator can handle fast changes in it's load. 59 * e.g. useful in CPU voltage & frequency scaling where 60 * load can quickly increase with CPU frequency increases. 61 * 62 * NORMAL Normal regulator power supply mode. Most drivers will 63 * use this mode. 64 * 65 * IDLE Regulator runs in a more efficient mode for light 66 * loads. Can be used for devices that have a low power 67 * requirement during periods of inactivity. This mode 68 * may be more noisy than NORMAL and may not be able 69 * to handle fast load switching. 70 * 71 * STANDBY Regulator runs in the most efficient mode for very 72 * light loads. Can be used by devices when they are 73 * in a sleep/standby state. This mode is likely to be 74 * the most noisy and may not be able to handle fast load 75 * switching. 76 * 77 * NOTE: Most regulators will only support a subset of these modes. Some 78 * will only just support NORMAL. 79 * 80 * These modes can be OR'ed together to make up a mask of valid register modes. 81 */ 82 83#define REGULATOR_MODE_FAST 0x1 84#define REGULATOR_MODE_NORMAL 0x2 85#define REGULATOR_MODE_IDLE 0x4 86#define REGULATOR_MODE_STANDBY 0x8 87 88/* 89 * Regulator notifier events. 90 * 91 * UNDER_VOLTAGE Regulator output is under voltage. 92 * OVER_CURRENT Regulator output current is too high. 93 * REGULATION_OUT Regulator output is out of regulation. 94 * FAIL Regulator output has failed. 95 * OVER_TEMP Regulator over temp. 96 * FORCE_DISABLE Regulator forcibly shut down by software. 97 * VOLTAGE_CHANGE Regulator voltage changed. 98 * Data passed is old voltage cast to (void *). 99 * DISABLE Regulator was disabled. 100 * PRE_VOLTAGE_CHANGE Regulator is about to have voltage changed. 101 * Data passed is "struct pre_voltage_change_data" 102 * ABORT_VOLTAGE_CHANGE Regulator voltage change failed for some reason. 103 * Data passed is old voltage cast to (void *). 104 * PRE_DISABLE Regulator is about to be disabled 105 * ABORT_DISABLE Regulator disable failed for some reason 106 * 107 * NOTE: These events can be OR'ed together when passed into handler. 108 */ 109 110#define REGULATOR_EVENT_UNDER_VOLTAGE 0x01 111#define REGULATOR_EVENT_OVER_CURRENT 0x02 112#define REGULATOR_EVENT_REGULATION_OUT 0x04 113#define REGULATOR_EVENT_FAIL 0x08 114#define REGULATOR_EVENT_OVER_TEMP 0x10 115#define REGULATOR_EVENT_FORCE_DISABLE 0x20 116#define REGULATOR_EVENT_VOLTAGE_CHANGE 0x40 117#define REGULATOR_EVENT_DISABLE 0x80 118#define REGULATOR_EVENT_PRE_VOLTAGE_CHANGE 0x100 119#define REGULATOR_EVENT_ABORT_VOLTAGE_CHANGE 0x200 120#define REGULATOR_EVENT_PRE_DISABLE 0x400 121#define REGULATOR_EVENT_ABORT_DISABLE 0x800 122 123/** 124 * struct pre_voltage_change_data - Data sent with PRE_VOLTAGE_CHANGE event 125 * 126 * @old_uV: Current voltage before change. 127 * @min_uV: Min voltage we'll change to. 128 * @max_uV: Max voltage we'll change to. 129 */ 130struct pre_voltage_change_data { 131 unsigned long old_uV; 132 unsigned long min_uV; 133 unsigned long max_uV; 134}; 135 136struct regulator; 137 138/** 139 * struct regulator_bulk_data - Data used for bulk regulator operations. 140 * 141 * @supply: The name of the supply. Initialised by the user before 142 * using the bulk regulator APIs. 143 * @consumer: The regulator consumer for the supply. This will be managed 144 * by the bulk API. 145 * 146 * The regulator APIs provide a series of regulator_bulk_() API calls as 147 * a convenience to consumers which require multiple supplies. This 148 * structure is used to manage data for these calls. 149 */ 150struct regulator_bulk_data { 151 const char *supply; 152 struct regulator *consumer; 153 154 /* private: Internal use */ 155 int ret; 156}; 157 158#if defined(CONFIG_REGULATOR) 159 160/* regulator get and put */ 161struct regulator *__must_check regulator_get(struct device *dev, 162 const char *id); 163struct regulator *__must_check devm_regulator_get(struct device *dev, 164 const char *id); 165struct regulator *__must_check regulator_get_exclusive(struct device *dev, 166 const char *id); 167struct regulator *__must_check devm_regulator_get_exclusive(struct device *dev, 168 const char *id); 169struct regulator *__must_check regulator_get_optional(struct device *dev, 170 const char *id); 171struct regulator *__must_check devm_regulator_get_optional(struct device *dev, 172 const char *id); 173void regulator_put(struct regulator *regulator); 174void devm_regulator_put(struct regulator *regulator); 175 176int regulator_register_supply_alias(struct device *dev, const char *id, 177 struct device *alias_dev, 178 const char *alias_id); 179void regulator_unregister_supply_alias(struct device *dev, const char *id); 180 181int regulator_bulk_register_supply_alias(struct device *dev, 182 const char *const *id, 183 struct device *alias_dev, 184 const char *const *alias_id, 185 int num_id); 186void regulator_bulk_unregister_supply_alias(struct device *dev, 187 const char * const *id, int num_id); 188 189int devm_regulator_register_supply_alias(struct device *dev, const char *id, 190 struct device *alias_dev, 191 const char *alias_id); 192void devm_regulator_unregister_supply_alias(struct device *dev, 193 const char *id); 194 195int devm_regulator_bulk_register_supply_alias(struct device *dev, 196 const char *const *id, 197 struct device *alias_dev, 198 const char *const *alias_id, 199 int num_id); 200void devm_regulator_bulk_unregister_supply_alias(struct device *dev, 201 const char *const *id, 202 int num_id); 203 204/* regulator output control and status */ 205int __must_check regulator_enable(struct regulator *regulator); 206int regulator_disable(struct regulator *regulator); 207int regulator_force_disable(struct regulator *regulator); 208int regulator_is_enabled(struct regulator *regulator); 209int regulator_disable_deferred(struct regulator *regulator, int ms); 210 211int __must_check regulator_bulk_get(struct device *dev, int num_consumers, 212 struct regulator_bulk_data *consumers); 213int __must_check devm_regulator_bulk_get(struct device *dev, int num_consumers, 214 struct regulator_bulk_data *consumers); 215int __must_check regulator_bulk_enable(int num_consumers, 216 struct regulator_bulk_data *consumers); 217int regulator_bulk_disable(int num_consumers, 218 struct regulator_bulk_data *consumers); 219int regulator_bulk_force_disable(int num_consumers, 220 struct regulator_bulk_data *consumers); 221void regulator_bulk_free(int num_consumers, 222 struct regulator_bulk_data *consumers); 223 224int regulator_can_change_voltage(struct regulator *regulator); 225int regulator_count_voltages(struct regulator *regulator); 226int regulator_list_voltage(struct regulator *regulator, unsigned selector); 227int regulator_is_supported_voltage(struct regulator *regulator, 228 int min_uV, int max_uV); 229unsigned int regulator_get_linear_step(struct regulator *regulator); 230int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV); 231int regulator_set_voltage_time(struct regulator *regulator, 232 int old_uV, int new_uV); 233int regulator_get_voltage(struct regulator *regulator); 234int regulator_sync_voltage(struct regulator *regulator); 235int regulator_set_current_limit(struct regulator *regulator, 236 int min_uA, int max_uA); 237int regulator_get_current_limit(struct regulator *regulator); 238 239int regulator_set_mode(struct regulator *regulator, unsigned int mode); 240unsigned int regulator_get_mode(struct regulator *regulator); 241int regulator_set_load(struct regulator *regulator, int load_uA); 242 243int regulator_allow_bypass(struct regulator *regulator, bool allow); 244 245struct regmap *regulator_get_regmap(struct regulator *regulator); 246int regulator_get_hardware_vsel_register(struct regulator *regulator, 247 unsigned *vsel_reg, 248 unsigned *vsel_mask); 249int regulator_list_hardware_vsel(struct regulator *regulator, 250 unsigned selector); 251 252/* regulator notifier block */ 253int regulator_register_notifier(struct regulator *regulator, 254 struct notifier_block *nb); 255int devm_regulator_register_notifier(struct regulator *regulator, 256 struct notifier_block *nb); 257int regulator_unregister_notifier(struct regulator *regulator, 258 struct notifier_block *nb); 259void devm_regulator_unregister_notifier(struct regulator *regulator, 260 struct notifier_block *nb); 261 262/* driver data - core doesn't touch */ 263void *regulator_get_drvdata(struct regulator *regulator); 264void regulator_set_drvdata(struct regulator *regulator, void *data); 265 266#else 267 268/* 269 * Make sure client drivers will still build on systems with no software 270 * controllable voltage or current regulators. 271 */ 272static inline struct regulator *__must_check regulator_get(struct device *dev, 273 const char *id) 274{ 275 /* Nothing except the stubbed out regulator API should be 276 * looking at the value except to check if it is an error 277 * value. Drivers are free to handle NULL specifically by 278 * skipping all regulator API calls, but they don't have to. 279 * Drivers which don't, should make sure they properly handle 280 * corner cases of the API, such as regulator_get_voltage() 281 * returning 0. 282 */ 283 return NULL; 284} 285 286static inline struct regulator *__must_check 287devm_regulator_get(struct device *dev, const char *id) 288{ 289 return NULL; 290} 291 292static inline struct regulator *__must_check 293regulator_get_exclusive(struct device *dev, const char *id) 294{ 295 return ERR_PTR(-ENODEV); 296} 297 298static inline struct regulator *__must_check 299regulator_get_optional(struct device *dev, const char *id) 300{ 301 return ERR_PTR(-ENODEV); 302} 303 304 305static inline struct regulator *__must_check 306devm_regulator_get_optional(struct device *dev, const char *id) 307{ 308 return ERR_PTR(-ENODEV); 309} 310 311static inline void regulator_put(struct regulator *regulator) 312{ 313} 314 315static inline void devm_regulator_put(struct regulator *regulator) 316{ 317} 318 319static inline int regulator_register_supply_alias(struct device *dev, 320 const char *id, 321 struct device *alias_dev, 322 const char *alias_id) 323{ 324 return 0; 325} 326 327static inline void regulator_unregister_supply_alias(struct device *dev, 328 const char *id) 329{ 330} 331 332static inline int regulator_bulk_register_supply_alias(struct device *dev, 333 const char *const *id, 334 struct device *alias_dev, 335 const char * const *alias_id, 336 int num_id) 337{ 338 return 0; 339} 340 341static inline void regulator_bulk_unregister_supply_alias(struct device *dev, 342 const char * const *id, 343 int num_id) 344{ 345} 346 347static inline int devm_regulator_register_supply_alias(struct device *dev, 348 const char *id, 349 struct device *alias_dev, 350 const char *alias_id) 351{ 352 return 0; 353} 354 355static inline void devm_regulator_unregister_supply_alias(struct device *dev, 356 const char *id) 357{ 358} 359 360static inline int devm_regulator_bulk_register_supply_alias(struct device *dev, 361 const char *const *id, 362 struct device *alias_dev, 363 const char *const *alias_id, 364 int num_id) 365{ 366 return 0; 367} 368 369static inline void devm_regulator_bulk_unregister_supply_alias( 370 struct device *dev, const char *const *id, int num_id) 371{ 372} 373 374static inline int regulator_enable(struct regulator *regulator) 375{ 376 return 0; 377} 378 379static inline int regulator_disable(struct regulator *regulator) 380{ 381 return 0; 382} 383 384static inline int regulator_force_disable(struct regulator *regulator) 385{ 386 return 0; 387} 388 389static inline int regulator_disable_deferred(struct regulator *regulator, 390 int ms) 391{ 392 return 0; 393} 394 395static inline int regulator_is_enabled(struct regulator *regulator) 396{ 397 return 1; 398} 399 400static inline int regulator_bulk_get(struct device *dev, 401 int num_consumers, 402 struct regulator_bulk_data *consumers) 403{ 404 return 0; 405} 406 407static inline int devm_regulator_bulk_get(struct device *dev, int num_consumers, 408 struct regulator_bulk_data *consumers) 409{ 410 return 0; 411} 412 413static inline int regulator_bulk_enable(int num_consumers, 414 struct regulator_bulk_data *consumers) 415{ 416 return 0; 417} 418 419static inline int regulator_bulk_disable(int num_consumers, 420 struct regulator_bulk_data *consumers) 421{ 422 return 0; 423} 424 425static inline int regulator_bulk_force_disable(int num_consumers, 426 struct regulator_bulk_data *consumers) 427{ 428 return 0; 429} 430 431static inline void regulator_bulk_free(int num_consumers, 432 struct regulator_bulk_data *consumers) 433{ 434} 435 436static inline int regulator_can_change_voltage(struct regulator *regulator) 437{ 438 return 0; 439} 440 441static inline int regulator_set_voltage(struct regulator *regulator, 442 int min_uV, int max_uV) 443{ 444 return 0; 445} 446 447static inline int regulator_set_voltage_time(struct regulator *regulator, 448 int old_uV, int new_uV) 449{ 450 return 0; 451} 452 453static inline int regulator_get_voltage(struct regulator *regulator) 454{ 455 return -EINVAL; 456} 457 458static inline int regulator_is_supported_voltage(struct regulator *regulator, 459 int min_uV, int max_uV) 460{ 461 return 0; 462} 463 464static inline int regulator_set_current_limit(struct regulator *regulator, 465 int min_uA, int max_uA) 466{ 467 return 0; 468} 469 470static inline int regulator_get_current_limit(struct regulator *regulator) 471{ 472 return 0; 473} 474 475static inline int regulator_set_mode(struct regulator *regulator, 476 unsigned int mode) 477{ 478 return 0; 479} 480 481static inline unsigned int regulator_get_mode(struct regulator *regulator) 482{ 483 return REGULATOR_MODE_NORMAL; 484} 485 486static inline int regulator_set_load(struct regulator *regulator, int load_uA) 487{ 488 return REGULATOR_MODE_NORMAL; 489} 490 491static inline int regulator_allow_bypass(struct regulator *regulator, 492 bool allow) 493{ 494 return 0; 495} 496 497static inline struct regmap *regulator_get_regmap(struct regulator *regulator) 498{ 499 return ERR_PTR(-EOPNOTSUPP); 500} 501 502static inline int regulator_get_hardware_vsel_register(struct regulator *regulator, 503 unsigned *vsel_reg, 504 unsigned *vsel_mask) 505{ 506 return -EOPNOTSUPP; 507} 508 509static inline int regulator_list_hardware_vsel(struct regulator *regulator, 510 unsigned selector) 511{ 512 return -EOPNOTSUPP; 513} 514 515static inline int regulator_register_notifier(struct regulator *regulator, 516 struct notifier_block *nb) 517{ 518 return 0; 519} 520 521static inline int devm_regulator_register_notifier(struct regulator *regulator, 522 struct notifier_block *nb) 523{ 524 return 0; 525} 526 527static inline int regulator_unregister_notifier(struct regulator *regulator, 528 struct notifier_block *nb) 529{ 530 return 0; 531} 532 533static inline int devm_regulator_unregister_notifier(struct regulator *regulator, 534 struct notifier_block *nb) 535{ 536 return 0; 537} 538 539static inline void *regulator_get_drvdata(struct regulator *regulator) 540{ 541 return NULL; 542} 543 544static inline void regulator_set_drvdata(struct regulator *regulator, 545 void *data) 546{ 547} 548 549static inline int regulator_count_voltages(struct regulator *regulator) 550{ 551 return 0; 552} 553#endif 554 555static inline int regulator_set_voltage_tol(struct regulator *regulator, 556 int new_uV, int tol_uV) 557{ 558 if (regulator_set_voltage(regulator, new_uV, new_uV + tol_uV) == 0) 559 return 0; 560 else 561 return regulator_set_voltage(regulator, 562 new_uV - tol_uV, new_uV + tol_uV); 563} 564 565static inline int regulator_is_supported_voltage_tol(struct regulator *regulator, 566 int target_uV, int tol_uV) 567{ 568 return regulator_is_supported_voltage(regulator, 569 target_uV - tol_uV, 570 target_uV + tol_uV); 571} 572 573#endif 574