include/linux/regulator/consumer.h

   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 struct device;
  39 struct notifier_block;
  40
  41 /*
  42  * Regulator operating modes.
  43  *
  44  * Regulators can run in a variety of different operating modes depending on
  45  * output load. This allows further system power savings by selecting the
  46  * best (and most efficient) regulator mode for a desired load.
  47  *
  48  * Most drivers will only care about NORMAL. The modes below are generic and
  49  * will probably not match the naming convention of your regulator data sheet
  50  * but should match the use cases in the datasheet.
  51  *
  52  * In order of power efficiency (least efficient at top).
  53  *
  54  *  Mode       Description
  55  *  FAST       Regulator can handle fast changes in it's load.
  56  *             e.g. useful in CPU voltage & frequency scaling where
  57  *             load can quickly increase with CPU frequency increases.
  58  *
  59  *  NORMAL     Normal regulator power supply mode. Most drivers will
  60  *             use this mode.
  61  *
  62  *  IDLE       Regulator runs in a more efficient mode for light
  63  *             loads. Can be used for devices that have a low power
  64  *             requirement during periods of inactivity. This mode
  65  *             may be more noisy than NORMAL and may not be able
  66  *             to handle fast load switching.
  67  *
  68  *  STANDBY    Regulator runs in the most efficient mode for very
  69  *             light loads. Can be used by devices when they are
  70  *             in a sleep/standby state. This mode is likely to be
  71  *             the most noisy and may not be able to handle fast load
  72  *             switching.
  73  *
  74  * NOTE: Most regulators will only support a subset of these modes. Some
  75  * will only just support NORMAL.
  76  *
  77  * These modes can be OR'ed together to make up a mask of valid register modes.
  78  */
  79
  80 #define REGULATOR_MODE_FAST                     0x1
  81 #define REGULATOR_MODE_NORMAL                   0x2
  82 #define REGULATOR_MODE_IDLE                     0x4
  83 #define REGULATOR_MODE_STANDBY                  0x8
  84
  85 /*
  86  * Regulator notifier events.
  87  *
  88  * UNDER_VOLTAGE  Regulator output is under voltage.
  89  * OVER_CURRENT   Regulator output current is too high.
  90  * REGULATION_OUT Regulator output is out of regulation.
  91  * FAIL           Regulator output has failed.
  92  * OVER_TEMP      Regulator over temp.
  93  * FORCE_DISABLE  Regulator forcibly shut down by software.
  94  * VOLTAGE_CHANGE Regulator voltage changed.
  95  * DISABLE        Regulator was disabled.
  96  *
  97  * NOTE: These events can be OR'ed together when passed into handler.
  98  */
  99
 100 #define REGULATOR_EVENT_UNDER_VOLTAGE           0x01
 101 #define REGULATOR_EVENT_OVER_CURRENT            0x02
 102 #define REGULATOR_EVENT_REGULATION_OUT          0x04
 103 #define REGULATOR_EVENT_FAIL                    0x08
 104 #define REGULATOR_EVENT_OVER_TEMP               0x10
 105 #define REGULATOR_EVENT_FORCE_DISABLE           0x20
 106 #define REGULATOR_EVENT_VOLTAGE_CHANGE          0x40
 107 #define REGULATOR_EVENT_DISABLE                 0x80
 108
 109 struct regulator;
 110
 111 /**
 112  * struct regulator_bulk_data - Data used for bulk regulator operations.
 113  *
 114  * @supply:   The name of the supply.  Initialised by the user before
 115  *            using the bulk regulator APIs.
 116  * @consumer: The regulator consumer for the supply.  This will be managed
 117  *            by the bulk API.
 118  *
 119  * The regulator APIs provide a series of regulator_bulk_() API calls as
 120  * a convenience to consumers which require multiple supplies.  This
 121  * structure is used to manage data for these calls.
 122  */
 123 struct regulator_bulk_data {
 124         const char *supply;
 125         struct regulator *consumer;
 126
 127         /* private: Internal use */
 128         int ret;
 129 };
 130
 131 #if defined(CONFIG_REGULATOR)
 132
 133 /* regulator get and put */
 134 struct regulator *__must_check regulator_get(struct device *dev,
 135                                              const char *id);
 136 struct regulator *__must_check devm_regulator_get(struct device *dev,
 137                                              const char *id);
 138 struct regulator *__must_check regulator_get_exclusive(struct device *dev,
 139                                                        const char *id);
 140 struct regulator *__must_check devm_regulator_get_exclusive(struct device *dev,
 141                                                         const char *id);
 142 struct regulator *__must_check regulator_get_optional(struct device *dev,
 143                                                       const char *id);
 144 struct regulator *__must_check devm_regulator_get_optional(struct device *dev,
 145                                                            const char *id);
 146 void regulator_put(struct regulator *regulator);
 147 void devm_regulator_put(struct regulator *regulator);
 148
 149 int regulator_register_supply_alias(struct device *dev, const char *id,
 150                                     struct device *alias_dev,
 151                                     const char *alias_id);
 152 void regulator_unregister_supply_alias(struct device *dev, const char *id);
 153
 154 int regulator_bulk_register_supply_alias(struct device *dev,
 155                                          const char *const *id,
 156                                          struct device *alias_dev,
 157                                          const char *const *alias_id,
 158                                          int num_id);
 159 void regulator_bulk_unregister_supply_alias(struct device *dev,
 160                                             const char * const *id, int num_id);
 161
 162 int devm_regulator_register_supply_alias(struct device *dev, const char *id,
 163                                          struct device *alias_dev,
 164                                          const char *alias_id);
 165 void devm_regulator_unregister_supply_alias(struct device *dev,
 166                                             const char *id);
 167
 168 int devm_regulator_bulk_register_supply_alias(struct device *dev,
 169                                               const char *const *id,
 170                                               struct device *alias_dev,
 171                                               const char *const *alias_id,
 172                                               int num_id);
 173 void devm_regulator_bulk_unregister_supply_alias(struct device *dev,
 174                                                  const char *const *id,
 175                                                  int num_id);
 176
 177 /* regulator output control and status */
 178 int __must_check regulator_enable(struct regulator *regulator);
 179 int regulator_disable(struct regulator *regulator);
 180 int regulator_force_disable(struct regulator *regulator);
 181 int regulator_is_enabled(struct regulator *regulator);
 182 int regulator_disable_deferred(struct regulator *regulator, int ms);
 183
 184 int __must_check regulator_bulk_get(struct device *dev, int num_consumers,
 185                                     struct regulator_bulk_data *consumers);
 186 int __must_check devm_regulator_bulk_get(struct device *dev, int num_consumers,
 187                                          struct regulator_bulk_data *consumers);
 188 int __must_check regulator_bulk_enable(int num_consumers,
 189                                        struct regulator_bulk_data *consumers);
 190 int regulator_bulk_disable(int num_consumers,
 191                            struct regulator_bulk_data *consumers);
 192 int regulator_bulk_force_disable(int num_consumers,
 193                            struct regulator_bulk_data *consumers);
 194 void regulator_bulk_free(int num_consumers,
 195                          struct regulator_bulk_data *consumers);
 196
 197 int regulator_can_change_voltage(struct regulator *regulator);
 198 int regulator_count_voltages(struct regulator *regulator);
 199 int regulator_list_voltage(struct regulator *regulator, unsigned selector);
 200 int regulator_is_supported_voltage(struct regulator *regulator,
 201                                    int min_uV, int max_uV);
 202 unsigned int regulator_get_linear_step(struct regulator *regulator);
 203 int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV);
 204 int regulator_set_voltage_time(struct regulator *regulator,
 205                                int old_uV, int new_uV);
 206 int regulator_get_voltage(struct regulator *regulator);
 207 int regulator_sync_voltage(struct regulator *regulator);
 208 int regulator_set_current_limit(struct regulator *regulator,
 209                                int min_uA, int max_uA);
 210 int regulator_get_current_limit(struct regulator *regulator);
 211
 212 int regulator_set_mode(struct regulator *regulator, unsigned int mode);
 213 unsigned int regulator_get_mode(struct regulator *regulator);
 214 int regulator_set_optimum_mode(struct regulator *regulator, int load_uA);
 215
 216 int regulator_allow_bypass(struct regulator *regulator, bool allow);
 217
 218 /* regulator notifier block */
 219 int regulator_register_notifier(struct regulator *regulator,
 220                               struct notifier_block *nb);
 221 int regulator_unregister_notifier(struct regulator *regulator,
 222                                 struct notifier_block *nb);
 223
 224 /* driver data - core doesn't touch */
 225 void *regulator_get_drvdata(struct regulator *regulator);
 226 void regulator_set_drvdata(struct regulator *regulator, void *data);
 227
 228 #else
 229
 230 /*
 231  * Make sure client drivers will still build on systems with no software
 232  * controllable voltage or current regulators.
 233  */
 234 static inline struct regulator *__must_check regulator_get(struct device *dev,
 235         const char *id)
 236 {
 237         /* Nothing except the stubbed out regulator API should be
 238          * looking at the value except to check if it is an error
 239          * value. Drivers are free to handle NULL specifically by
 240          * skipping all regulator API calls, but they don't have to.
 241          * Drivers which don't, should make sure they properly handle
 242          * corner cases of the API, such as regulator_get_voltage()
 243          * returning 0.
 244          */
 245         return NULL;
 246 }
 247
 248 static inline struct regulator *__must_check
 249 devm_regulator_get(struct device *dev, const char *id)
 250 {
 251         return NULL;
 252 }
 253
 254 static inline struct regulator *__must_check
 255 regulator_get_exclusive(struct device *dev, const char *id)
 256 {
 257         return NULL;
 258 }
 259
 260 static inline struct regulator *__must_check
 261 regulator_get_optional(struct device *dev, const char *id)
 262 {
 263         return ERR_PTR(-ENODEV);
 264 }
 265
 266
 267 static inline struct regulator *__must_check
 268 devm_regulator_get_optional(struct device *dev, const char *id)
 269 {
 270         return ERR_PTR(-ENODEV);
 271 }
 272
 273 static inline void regulator_put(struct regulator *regulator)
 274 {
 275 }
 276
 277 static inline void devm_regulator_put(struct regulator *regulator)
 278 {
 279 }
 280
 281 static inline int regulator_register_supply_alias(struct device *dev,
 282                                                   const char *id,
 283                                                   struct device *alias_dev,
 284                                                   const char *alias_id)
 285 {
 286         return 0;
 287 }
 288
 289 static inline void regulator_unregister_supply_alias(struct device *dev,
 290                                                     const char *id)
 291 {
 292 }
 293
 294 static inline int regulator_bulk_register_supply_alias(struct device *dev,
 295                                                 const char *const *id,
 296                                                 struct device *alias_dev,
 297                                                 const char * const *alias_id,
 298                                                 int num_id)
 299 {
 300         return 0;
 301 }
 302
 303 static inline void regulator_bulk_unregister_supply_alias(struct device *dev,
 304                                                 const char * const *id,
 305                                                 int num_id)
 306 {
 307 }
 308
 309 static inline int devm_regulator_register_supply_alias(struct device *dev,
 310                                                        const char *id,
 311                                                        struct device *alias_dev,
 312                                                        const char *alias_id)
 313 {
 314         return 0;
 315 }
 316
 317 static inline void devm_regulator_unregister_supply_alias(struct device *dev,
 318                                                           const char *id)
 319 {
 320 }
 321
 322 static inline int devm_regulator_bulk_register_supply_alias(struct device *dev,
 323                                                 const char *const *id,
 324                                                 struct device *alias_dev,
 325                                                 const char *const *alias_id,
 326                                                 int num_id)
 327 {
 328         return 0;
 329 }
 330
 331 static inline void devm_regulator_bulk_unregister_supply_alias(
 332         struct device *dev, const char *const *id, int num_id)
 333 {
 334 }
 335
 336 static inline int regulator_enable(struct regulator *regulator)
 337 {
 338         return 0;
 339 }
 340
 341 static inline int regulator_disable(struct regulator *regulator)
 342 {
 343         return 0;
 344 }
 345
 346 static inline int regulator_force_disable(struct regulator *regulator)
 347 {
 348         return 0;
 349 }
 350
 351 static inline int regulator_disable_deferred(struct regulator *regulator,
 352                                              int ms)
 353 {
 354         return 0;
 355 }
 356
 357 static inline int regulator_is_enabled(struct regulator *regulator)
 358 {
 359         return 1;
 360 }
 361
 362 static inline int regulator_bulk_get(struct device *dev,
 363                                      int num_consumers,
 364                                      struct regulator_bulk_data *consumers)
 365 {
 366         return 0;
 367 }
 368
 369 static inline int devm_regulator_bulk_get(struct device *dev, int num_consumers,
 370                                           struct regulator_bulk_data *consumers)
 371 {
 372         return 0;
 373 }
 374
 375 static inline int regulator_bulk_enable(int num_consumers,
 376                                         struct regulator_bulk_data *consumers)
 377 {
 378         return 0;
 379 }
 380
 381 static inline int regulator_bulk_disable(int num_consumers,
 382                                          struct regulator_bulk_data *consumers)
 383 {
 384         return 0;
 385 }
 386
 387 static inline int regulator_bulk_force_disable(int num_consumers,
 388                                         struct regulator_bulk_data *consumers)
 389 {
 390         return 0;
 391 }
 392
 393 static inline void regulator_bulk_free(int num_consumers,
 394                                        struct regulator_bulk_data *consumers)
 395 {
 396 }
 397
 398 static inline int regulator_set_voltage(struct regulator *regulator,
 399                                         int min_uV, int max_uV)
 400 {
 401         return 0;
 402 }
 403
 404 static inline int regulator_set_voltage_time(struct regulator *regulator,
 405                                              int old_uV, int new_uV)
 406 {
 407         return 0;
 408 }
 409
 410 static inline int regulator_get_voltage(struct regulator *regulator)
 411 {
 412         return -EINVAL;
 413 }
 414
 415 static inline int regulator_is_supported_voltage(struct regulator *regulator,
 416                                    int min_uV, int max_uV)
 417 {
 418         return 0;
 419 }
 420
 421 static inline int regulator_set_current_limit(struct regulator *regulator,
 422                                              int min_uA, int max_uA)
 423 {
 424         return 0;
 425 }
 426
 427 static inline int regulator_get_current_limit(struct regulator *regulator)
 428 {
 429         return 0;
 430 }
 431
 432 static inline int regulator_set_mode(struct regulator *regulator,
 433         unsigned int mode)
 434 {
 435         return 0;
 436 }
 437
 438 static inline unsigned int regulator_get_mode(struct regulator *regulator)
 439 {
 440         return REGULATOR_MODE_NORMAL;
 441 }
 442
 443 static inline int regulator_set_optimum_mode(struct regulator *regulator,
 444                                         int load_uA)
 445 {
 446         return REGULATOR_MODE_NORMAL;
 447 }
 448
 449 static inline int regulator_allow_bypass(struct regulator *regulator,
 450                                          bool allow)
 451 {
 452         return 0;
 453 }
 454
 455 static inline int regulator_register_notifier(struct regulator *regulator,
 456                               struct notifier_block *nb)
 457 {
 458         return 0;
 459 }
 460
 461 static inline int regulator_unregister_notifier(struct regulator *regulator,
 462                                 struct notifier_block *nb)
 463 {
 464         return 0;
 465 }
 466
 467 static inline void *regulator_get_drvdata(struct regulator *regulator)
 468 {
 469         return NULL;
 470 }
 471
 472 static inline void regulator_set_drvdata(struct regulator *regulator,
 473         void *data)
 474 {
 475 }
 476
 477 static inline int regulator_count_voltages(struct regulator *regulator)
 478 {
 479         return 0;
 480 }
 481 #endif
 482
 483 static inline int regulator_set_voltage_tol(struct regulator *regulator,
 484                                             int new_uV, int tol_uV)
 485 {
 486         if (regulator_set_voltage(regulator, new_uV, new_uV + tol_uV) == 0)
 487                 return 0;
 488         else
 489                 return regulator_set_voltage(regulator,
 490                                              new_uV - tol_uV, new_uV + tol_uV);
 491 }
 492
 493 static inline int regulator_is_supported_voltage_tol(struct regulator *regulator,
 494                                                      int target_uV, int tol_uV)
 495 {
 496         return regulator_is_supported_voltage(regulator,
 497                                               target_uV - tol_uV,
 498                                               target_uV + tol_uV);
 499 }
 500
 501 #endif