include/linux/regulator/consumer.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * consumer.h -- SoC Regulator consumer support.
   4  *
   5  * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC.
   6  *
   7  * Author: Liam Girdwood <lrg@slimlogic.co.uk>
   8  *
   9  * Regulator Consumer Interface.
  10  *
  11  * A Power Management Regulator framework for SoC based devices.
  12  * Features:-
  13  *   o Voltage and current level control.
  14  *   o Operating mode control.
  15  *   o Regulator status.
  16  *   o sysfs entries for showing client devices and status
  17  *
  18  * EXPERIMENTAL FEATURES:
  19  *   Dynamic Regulator operating Mode Switching (DRMS) - allows regulators
  20  *   to use most efficient operating mode depending upon voltage and load and
  21  *   is transparent to client drivers.
  22  *
  23  *   e.g. Devices x,y,z share regulator r. Device x and y draw 20mA each during
  24  *   IO and 1mA at idle. Device z draws 100mA when under load and 5mA when
  25  *   idling. Regulator r has > 90% efficiency in NORMAL mode at loads > 100mA
  26  *   but this drops rapidly to 60% when below 100mA. Regulator r has > 90%
  27  *   efficiency in IDLE mode at loads < 10mA. Thus regulator r will operate
  28  *   in normal mode for loads > 10mA and in IDLE mode for load <= 10mA.
  29  */
  30
  31 #ifndef __LINUX_REGULATOR_CONSUMER_H_
  32 #define __LINUX_REGULATOR_CONSUMER_H_
  33
  34 #include <linux/err.h>
  35 #include <linux/suspend.h>
  36 #include <regulator/regulator.h>
  37
  38 struct device;
  39 struct notifier_block;
  40 struct regmap;
  41 struct regulator_dev;
  42
  43 /*
  44  * Regulator operating modes.
  45  *
  46  * Regulators can run in a variety of different operating modes depending on
  47  * output load. This allows further system power savings by selecting the
  48  * best (and most efficient) regulator mode for a desired load.
  49  *
  50  * Most drivers will only care about NORMAL. The modes below are generic and
  51  * will probably not match the naming convention of your regulator data sheet
  52  * but should match the use cases in the datasheet.
  53  *
  54  * In order of power efficiency (least efficient at top).
  55  *
  56  *  Mode       Description
  57  *  FAST       Regulator can handle fast changes in it's load.
  58  *             e.g. useful in CPU voltage & frequency scaling where
  59  *             load can quickly increase with CPU frequency increases.
  60  *
  61  *  NORMAL     Normal regulator power supply mode. Most drivers will
  62  *             use this mode.
  63  *
  64  *  IDLE       Regulator runs in a more efficient mode for light
  65  *             loads. Can be used for devices that have a low power
  66  *             requirement during periods of inactivity. This mode
  67  *             may be more noisy than NORMAL and may not be able
  68  *             to handle fast load switching.
  69  *
  70  *  STANDBY    Regulator runs in the most efficient mode for very
  71  *             light loads. Can be used by devices when they are
  72  *             in a sleep/standby state. This mode is likely to be
  73  *             the most noisy and may not be able to handle fast load
  74  *             switching.
  75  *
  76  * NOTE: Most regulators will only support a subset of these modes. Some
  77  * will only just support NORMAL.
  78  *
  79  * These modes can be OR'ed together to make up a mask of valid register modes.
  80  */
  81
  82 #define REGULATOR_MODE_INVALID                  0x0
  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 errors that can be queried using regulator_get_error_flags
  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  *
  97  * NOTE: These errors can be OR'ed together.
  98  */
  99
 100 #define REGULATOR_ERROR_UNDER_VOLTAGE           BIT(1)
 101 #define REGULATOR_ERROR_OVER_CURRENT            BIT(2)
 102 #define REGULATOR_ERROR_REGULATION_OUT          BIT(3)
 103 #define REGULATOR_ERROR_FAIL                    BIT(4)
 104 #define REGULATOR_ERROR_OVER_TEMP               BIT(5)
 105
 106 #define REGULATOR_ERROR_UNDER_VOLTAGE_WARN      BIT(6)
 107 #define REGULATOR_ERROR_OVER_CURRENT_WARN       BIT(7)
 108 #define REGULATOR_ERROR_OVER_VOLTAGE_WARN       BIT(8)
 109 #define REGULATOR_ERROR_OVER_TEMP_WARN          BIT(9)
 110
 111 /**
 112  * struct pre_voltage_change_data - Data sent with PRE_VOLTAGE_CHANGE event
 113  *
 114  * @old_uV: Current voltage before change.
 115  * @min_uV: Min voltage we'll change to.
 116  * @max_uV: Max voltage we'll change to.
 117  */
 118 struct pre_voltage_change_data {
 119         unsigned long old_uV;
 120         unsigned long min_uV;
 121         unsigned long max_uV;
 122 };
 123
 124 struct regulator;
 125
 126 /**
 127  * struct regulator_bulk_data - Data used for bulk regulator operations.
 128  *
 129  * @supply:       The name of the supply.  Initialised by the user before
 130  *                using the bulk regulator APIs.
 131  * @init_load_uA: After getting the regulator, regulator_set_load() will be
 132  *                called with this load.  Initialised by the user before
 133  *                using the bulk regulator APIs.
 134  * @consumer:     The regulator consumer for the supply.  This will be managed
 135  *                by the bulk API.
 136  *
 137  * The regulator APIs provide a series of regulator_bulk_() API calls as
 138  * a convenience to consumers which require multiple supplies.  This
 139  * structure is used to manage data for these calls.
 140  */
 141 struct regulator_bulk_data {
 142         const char *supply;
 143         int init_load_uA;
 144         struct regulator *consumer;
 145
 146         /* private: Internal use */
 147         int ret;
 148 };
 149
 150 #if defined(CONFIG_REGULATOR)
 151
 152 /* regulator get and put */
 153 struct regulator *__must_check regulator_get(struct device *dev,
 154                                              const char *id);
 155 struct regulator *__must_check devm_regulator_get(struct device *dev,
 156                                              const char *id);
 157 struct regulator *__must_check regulator_get_exclusive(struct device *dev,
 158                                                        const char *id);
 159 struct regulator *__must_check devm_regulator_get_exclusive(struct device *dev,
 160                                                         const char *id);
 161 struct regulator *__must_check regulator_get_optional(struct device *dev,
 162                                                       const char *id);
 163 struct regulator *__must_check devm_regulator_get_optional(struct device *dev,
 164                                                            const char *id);
 165 int devm_regulator_get_enable(struct device *dev, const char *id);
 166 int devm_regulator_get_enable_optional(struct device *dev, const char *id);
 167 int devm_regulator_get_enable_read_voltage(struct device *dev, const char *id);
 168 void regulator_put(struct regulator *regulator);
 169 void devm_regulator_put(struct regulator *regulator);
 170
 171 int regulator_register_supply_alias(struct device *dev, const char *id,
 172                                     struct device *alias_dev,
 173                                     const char *alias_id);
 174 void regulator_unregister_supply_alias(struct device *dev, const char *id);
 175
 176 int regulator_bulk_register_supply_alias(struct device *dev,
 177                                          const char *const *id,
 178                                          struct device *alias_dev,
 179                                          const char *const *alias_id,
 180                                          int num_id);
 181 void regulator_bulk_unregister_supply_alias(struct device *dev,
 182                                             const char * const *id, int num_id);
 183
 184 int devm_regulator_register_supply_alias(struct device *dev, const char *id,
 185                                          struct device *alias_dev,
 186                                          const char *alias_id);
 187
 188 int devm_regulator_bulk_register_supply_alias(struct device *dev,
 189                                               const char *const *id,
 190                                               struct device *alias_dev,
 191                                               const char *const *alias_id,
 192                                               int num_id);
 193
 194 /* regulator output control and status */
 195 int __must_check regulator_enable(struct regulator *regulator);
 196 int regulator_disable(struct regulator *regulator);
 197 int regulator_force_disable(struct regulator *regulator);
 198 int regulator_is_enabled(struct regulator *regulator);
 199 int regulator_disable_deferred(struct regulator *regulator, int ms);
 200
 201 int __must_check regulator_bulk_get(struct device *dev, int num_consumers,
 202                                     struct regulator_bulk_data *consumers);
 203 int __must_check of_regulator_bulk_get_all(struct device *dev, struct device_node *np,
 204                                            struct regulator_bulk_data **consumers);
 205 int __must_check devm_regulator_bulk_get(struct device *dev, int num_consumers,
 206                                          struct regulator_bulk_data *consumers);
 207 void devm_regulator_bulk_put(struct regulator_bulk_data *consumers);
 208 int __must_check devm_regulator_bulk_get_exclusive(struct device *dev, int num_consumers,
 209                                                    struct regulator_bulk_data *consumers);
 210 int __must_check devm_regulator_bulk_get_const(
 211         struct device *dev, int num_consumers,
 212         const struct regulator_bulk_data *in_consumers,
 213         struct regulator_bulk_data **out_consumers);
 214 int __must_check regulator_bulk_enable(int num_consumers,
 215                                        struct regulator_bulk_data *consumers);
 216 int devm_regulator_bulk_get_enable(struct device *dev, int num_consumers,
 217                                    const char * const *id);
 218 int regulator_bulk_disable(int num_consumers,
 219                            struct regulator_bulk_data *consumers);
 220 int regulator_bulk_force_disable(int num_consumers,
 221                            struct regulator_bulk_data *consumers);
 222 void regulator_bulk_free(int num_consumers,
 223                          struct regulator_bulk_data *consumers);
 224
 225 int regulator_count_voltages(struct regulator *regulator);
 226 int regulator_list_voltage(struct regulator *regulator, unsigned selector);
 227 int regulator_is_supported_voltage(struct regulator *regulator,
 228                                    int min_uV, int max_uV);
 229 unsigned int regulator_get_linear_step(struct regulator *regulator);
 230 int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV);
 231 int regulator_set_voltage_time(struct regulator *regulator,
 232                                int old_uV, int new_uV);
 233 int regulator_get_voltage(struct regulator *regulator);
 234 int regulator_sync_voltage(struct regulator *regulator);
 235 int regulator_set_current_limit(struct regulator *regulator,
 236                                int min_uA, int max_uA);
 237 int regulator_get_current_limit(struct regulator *regulator);
 238
 239 int regulator_set_mode(struct regulator *regulator, unsigned int mode);
 240 unsigned int regulator_get_mode(struct regulator *regulator);
 241 int regulator_get_error_flags(struct regulator *regulator,
 242                                 unsigned int *flags);
 243 int regulator_set_load(struct regulator *regulator, int load_uA);
 244
 245 int regulator_allow_bypass(struct regulator *regulator, bool allow);
 246
 247 struct regmap *regulator_get_regmap(struct regulator *regulator);
 248 int regulator_get_hardware_vsel_register(struct regulator *regulator,
 249                                          unsigned *vsel_reg,
 250                                          unsigned *vsel_mask);
 251 int regulator_list_hardware_vsel(struct regulator *regulator,
 252                                  unsigned selector);
 253
 254 /* regulator notifier block */
 255 int regulator_register_notifier(struct regulator *regulator,
 256                               struct notifier_block *nb);
 257 int devm_regulator_register_notifier(struct regulator *regulator,
 258                                      struct notifier_block *nb);
 259 int regulator_unregister_notifier(struct regulator *regulator,
 260                                 struct notifier_block *nb);
 261 void devm_regulator_unregister_notifier(struct regulator *regulator,
 262                                         struct notifier_block *nb);
 263
 264 /* regulator suspend */
 265 int regulator_suspend_enable(struct regulator_dev *rdev,
 266                              suspend_state_t state);
 267 int regulator_suspend_disable(struct regulator_dev *rdev,
 268                               suspend_state_t state);
 269 int regulator_set_suspend_voltage(struct regulator *regulator, int min_uV,
 270                                   int max_uV, suspend_state_t state);
 271
 272 /* driver data - core doesn't touch */
 273 void *regulator_get_drvdata(struct regulator *regulator);
 274 void regulator_set_drvdata(struct regulator *regulator, void *data);
 275
 276 /* misc helpers */
 277
 278 void regulator_bulk_set_supply_names(struct regulator_bulk_data *consumers,
 279                                      const char *const *supply_names,
 280                                      unsigned int num_supplies);
 281
 282 bool regulator_is_equal(struct regulator *reg1, struct regulator *reg2);
 283
 284 #else
 285
 286 /*
 287  * Make sure client drivers will still build on systems with no software
 288  * controllable voltage or current regulators.
 289  */
 290 static inline struct regulator *__must_check regulator_get(struct device *dev,
 291         const char *id)
 292 {
 293         /* Nothing except the stubbed out regulator API should be
 294          * looking at the value except to check if it is an error
 295          * value. Drivers are free to handle NULL specifically by
 296          * skipping all regulator API calls, but they don't have to.
 297          * Drivers which don't, should make sure they properly handle
 298          * corner cases of the API, such as regulator_get_voltage()
 299          * returning 0.
 300          */
 301         return NULL;
 302 }
 303
 304 static inline struct regulator *__must_check
 305 devm_regulator_get(struct device *dev, const char *id)
 306 {
 307         return NULL;
 308 }
 309
 310 static inline struct regulator *__must_check
 311 regulator_get_exclusive(struct device *dev, const char *id)
 312 {
 313         return ERR_PTR(-ENODEV);
 314 }
 315
 316 static inline struct regulator *__must_check
 317 devm_regulator_get_exclusive(struct device *dev, const char *id)
 318 {
 319         return ERR_PTR(-ENODEV);
 320 }
 321
 322 static inline int devm_regulator_get_enable(struct device *dev, const char *id)
 323 {
 324         return 0;
 325 }
 326
 327 static inline int devm_regulator_get_enable_optional(struct device *dev,
 328                                                      const char *id)
 329 {
 330         return 0;
 331 }
 332
 333 static inline int devm_regulator_get_enable_read_voltage(struct device *dev,
 334                                                          const char *id)
 335 {
 336         return -ENODEV;
 337 }
 338
 339 static inline struct regulator *__must_check
 340 regulator_get_optional(struct device *dev, const char *id)
 341 {
 342         return ERR_PTR(-ENODEV);
 343 }
 344
 345
 346 static inline struct regulator *__must_check
 347 devm_regulator_get_optional(struct device *dev, const char *id)
 348 {
 349         return ERR_PTR(-ENODEV);
 350 }
 351
 352 static inline void regulator_put(struct regulator *regulator)
 353 {
 354 }
 355
 356 static inline void devm_regulator_put(struct regulator *regulator)
 357 {
 358 }
 359
 360 static inline void devm_regulator_bulk_put(struct regulator_bulk_data *consumers)
 361 {
 362 }
 363
 364 static inline int regulator_register_supply_alias(struct device *dev,
 365                                                   const char *id,
 366                                                   struct device *alias_dev,
 367                                                   const char *alias_id)
 368 {
 369         return 0;
 370 }
 371
 372 static inline void regulator_unregister_supply_alias(struct device *dev,
 373                                                     const char *id)
 374 {
 375 }
 376
 377 static inline int regulator_bulk_register_supply_alias(struct device *dev,
 378                                                 const char *const *id,
 379                                                 struct device *alias_dev,
 380                                                 const char * const *alias_id,
 381                                                 int num_id)
 382 {
 383         return 0;
 384 }
 385
 386 static inline void regulator_bulk_unregister_supply_alias(struct device *dev,
 387                                                 const char * const *id,
 388                                                 int num_id)
 389 {
 390 }
 391
 392 static inline int devm_regulator_register_supply_alias(struct device *dev,
 393                                                        const char *id,
 394                                                        struct device *alias_dev,
 395                                                        const char *alias_id)
 396 {
 397         return 0;
 398 }
 399
 400 static inline int devm_regulator_bulk_register_supply_alias(struct device *dev,
 401                                                 const char *const *id,
 402                                                 struct device *alias_dev,
 403                                                 const char *const *alias_id,
 404                                                 int num_id)
 405 {
 406         return 0;
 407 }
 408
 409 static inline int regulator_enable(struct regulator *regulator)
 410 {
 411         return 0;
 412 }
 413
 414 static inline int regulator_disable(struct regulator *regulator)
 415 {
 416         return 0;
 417 }
 418
 419 static inline int regulator_force_disable(struct regulator *regulator)
 420 {
 421         return 0;
 422 }
 423
 424 static inline int regulator_disable_deferred(struct regulator *regulator,
 425                                              int ms)
 426 {
 427         return 0;
 428 }
 429
 430 static inline int regulator_is_enabled(struct regulator *regulator)
 431 {
 432         return 1;
 433 }
 434
 435 static inline int regulator_bulk_get(struct device *dev,
 436                                      int num_consumers,
 437                                      struct regulator_bulk_data *consumers)
 438 {
 439         return 0;
 440 }
 441
 442 static inline int devm_regulator_bulk_get(struct device *dev, int num_consumers,
 443                                           struct regulator_bulk_data *consumers)
 444 {
 445         return 0;
 446 }
 447
 448 static inline int of_regulator_bulk_get_all(struct device *dev, struct device_node *np,
 449                                             struct regulator_bulk_data **consumers)
 450 {
 451         return 0;
 452 }
 453
 454 static inline int regulator_bulk_enable(int num_consumers,
 455                                         struct regulator_bulk_data *consumers)
 456 {
 457         return 0;
 458 }
 459
 460 static inline int devm_regulator_bulk_get_enable(struct device *dev,
 461                                                  int num_consumers,
 462                                                  const char * const *id)
 463 {
 464         return 0;
 465 }
 466
 467 static inline int regulator_bulk_disable(int num_consumers,
 468                                          struct regulator_bulk_data *consumers)
 469 {
 470         return 0;
 471 }
 472
 473 static inline int regulator_bulk_force_disable(int num_consumers,
 474                                         struct regulator_bulk_data *consumers)
 475 {
 476         return 0;
 477 }
 478
 479 static inline void regulator_bulk_free(int num_consumers,
 480                                        struct regulator_bulk_data *consumers)
 481 {
 482 }
 483
 484 static inline int regulator_set_voltage(struct regulator *regulator,
 485                                         int min_uV, int max_uV)
 486 {
 487         return 0;
 488 }
 489
 490 static inline int regulator_set_voltage_time(struct regulator *regulator,
 491                                              int old_uV, int new_uV)
 492 {
 493         return 0;
 494 }
 495
 496 static inline int regulator_get_voltage(struct regulator *regulator)
 497 {
 498         return -EINVAL;
 499 }
 500
 501 static inline int regulator_sync_voltage(struct regulator *regulator)
 502 {
 503         return -EINVAL;
 504 }
 505
 506 static inline int regulator_is_supported_voltage(struct regulator *regulator,
 507                                    int min_uV, int max_uV)
 508 {
 509         return 0;
 510 }
 511
 512 static inline unsigned int regulator_get_linear_step(struct regulator *regulator)
 513 {
 514         return 0;
 515 }
 516
 517 static inline int regulator_set_current_limit(struct regulator *regulator,
 518                                              int min_uA, int max_uA)
 519 {
 520         return 0;
 521 }
 522
 523 static inline int regulator_get_current_limit(struct regulator *regulator)
 524 {
 525         return 0;
 526 }
 527
 528 static inline int regulator_set_mode(struct regulator *regulator,
 529         unsigned int mode)
 530 {
 531         return 0;
 532 }
 533
 534 static inline unsigned int regulator_get_mode(struct regulator *regulator)
 535 {
 536         return REGULATOR_MODE_NORMAL;
 537 }
 538
 539 static inline int regulator_get_error_flags(struct regulator *regulator,
 540                                             unsigned int *flags)
 541 {
 542         return -EINVAL;
 543 }
 544
 545 static inline int regulator_set_load(struct regulator *regulator, int load_uA)
 546 {
 547         return 0;
 548 }
 549
 550 static inline int regulator_allow_bypass(struct regulator *regulator,
 551                                          bool allow)
 552 {
 553         return 0;
 554 }
 555
 556 static inline struct regmap *regulator_get_regmap(struct regulator *regulator)
 557 {
 558         return ERR_PTR(-EOPNOTSUPP);
 559 }
 560
 561 static inline int regulator_get_hardware_vsel_register(struct regulator *regulator,
 562                                                        unsigned *vsel_reg,
 563                                                        unsigned *vsel_mask)
 564 {
 565         return -EOPNOTSUPP;
 566 }
 567
 568 static inline int regulator_list_hardware_vsel(struct regulator *regulator,
 569                                                unsigned selector)
 570 {
 571         return -EOPNOTSUPP;
 572 }
 573
 574 static inline int regulator_register_notifier(struct regulator *regulator,
 575                               struct notifier_block *nb)
 576 {
 577         return 0;
 578 }
 579
 580 static inline int devm_regulator_register_notifier(struct regulator *regulator,
 581                                                    struct notifier_block *nb)
 582 {
 583         return 0;
 584 }
 585
 586 static inline int regulator_unregister_notifier(struct regulator *regulator,
 587                                 struct notifier_block *nb)
 588 {
 589         return 0;
 590 }
 591
 592 static inline int devm_regulator_unregister_notifier(struct regulator *regulator,
 593                                                      struct notifier_block *nb)
 594 {
 595         return 0;
 596 }
 597
 598 static inline int regulator_suspend_enable(struct regulator_dev *rdev,
 599                                            suspend_state_t state)
 600 {
 601         return -EINVAL;
 602 }
 603
 604 static inline int regulator_suspend_disable(struct regulator_dev *rdev,
 605                                             suspend_state_t state)
 606 {
 607         return -EINVAL;
 608 }
 609
 610 static inline int regulator_set_suspend_voltage(struct regulator *regulator,
 611                                                 int min_uV, int max_uV,
 612                                                 suspend_state_t state)
 613 {
 614         return -EINVAL;
 615 }
 616
 617 static inline void *regulator_get_drvdata(struct regulator *regulator)
 618 {
 619         return NULL;
 620 }
 621
 622 static inline void regulator_set_drvdata(struct regulator *regulator,
 623         void *data)
 624 {
 625 }
 626
 627 static inline int regulator_count_voltages(struct regulator *regulator)
 628 {
 629         return 0;
 630 }
 631
 632 static inline int regulator_list_voltage(struct regulator *regulator, unsigned selector)
 633 {
 634         return -EINVAL;
 635 }
 636
 637 static inline void
 638 regulator_bulk_set_supply_names(struct regulator_bulk_data *consumers,
 639                                 const char *const *supply_names,
 640                                 unsigned int num_supplies)
 641 {
 642 }
 643
 644 static inline bool
 645 regulator_is_equal(struct regulator *reg1, struct regulator *reg2)
 646 {
 647         return false;
 648 }
 649 #endif
 650
 651 static inline int regulator_set_voltage_triplet(struct regulator *regulator,
 652                                                 int min_uV, int target_uV,
 653                                                 int max_uV)
 654 {
 655         if (regulator_set_voltage(regulator, target_uV, max_uV) == 0)
 656                 return 0;
 657
 658         return regulator_set_voltage(regulator, min_uV, max_uV);
 659 }
 660
 661 static inline int regulator_set_voltage_tol(struct regulator *regulator,
 662                                             int new_uV, int tol_uV)
 663 {
 664         if (regulator_set_voltage(regulator, new_uV, new_uV + tol_uV) == 0)
 665                 return 0;
 666         else
 667                 return regulator_set_voltage(regulator,
 668                                              new_uV - tol_uV, new_uV + tol_uV);
 669 }
 670
 671 static inline int regulator_is_supported_voltage_tol(struct regulator *regulator,
 672                                                      int target_uV, int tol_uV)
 673 {
 674         return regulator_is_supported_voltage(regulator,
 675                                               target_uV - tol_uV,
 676                                               target_uV + tol_uV);
 677 }
 678
 679 #endif