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 void regulator_put(struct regulator *regulator);
 141 void devm_regulator_put(struct regulator *regulator);
 142
 143 /* regulator output control and status */
 144 int regulator_enable(struct regulator *regulator);
 145 int regulator_disable(struct regulator *regulator);
 146 int regulator_force_disable(struct regulator *regulator);
 147 int regulator_is_enabled(struct regulator *regulator);
 148 int regulator_disable_deferred(struct regulator *regulator, int ms);
 149
 150 int regulator_bulk_get(struct device *dev, int num_consumers,
 151                        struct regulator_bulk_data *consumers);
 152 int devm_regulator_bulk_get(struct device *dev, int num_consumers,
 153                             struct regulator_bulk_data *consumers);
 154 int regulator_bulk_enable(int num_consumers,
 155                           struct regulator_bulk_data *consumers);
 156 int regulator_bulk_disable(int num_consumers,
 157                            struct regulator_bulk_data *consumers);
 158 int regulator_bulk_force_disable(int num_consumers,
 159                            struct regulator_bulk_data *consumers);
 160 void regulator_bulk_free(int num_consumers,
 161                          struct regulator_bulk_data *consumers);
 162
 163 int regulator_can_change_voltage(struct regulator *regulator);
 164 int regulator_count_voltages(struct regulator *regulator);
 165 int regulator_list_voltage(struct regulator *regulator, unsigned selector);
 166 int regulator_is_supported_voltage(struct regulator *regulator,
 167                                    int min_uV, int max_uV);
 168 int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV);
 169 int regulator_set_voltage_time(struct regulator *regulator,
 170                                int old_uV, int new_uV);
 171 int regulator_get_voltage(struct regulator *regulator);
 172 int regulator_sync_voltage(struct regulator *regulator);
 173 int regulator_set_current_limit(struct regulator *regulator,
 174                                int min_uA, int max_uA);
 175 int regulator_get_current_limit(struct regulator *regulator);
 176
 177 int regulator_set_mode(struct regulator *regulator, unsigned int mode);
 178 unsigned int regulator_get_mode(struct regulator *regulator);
 179 int regulator_set_optimum_mode(struct regulator *regulator, int load_uA);
 180
 181 int regulator_allow_bypass(struct regulator *regulator, bool allow);
 182
 183 /* regulator notifier block */
 184 int regulator_register_notifier(struct regulator *regulator,
 185                               struct notifier_block *nb);
 186 int regulator_unregister_notifier(struct regulator *regulator,
 187                                 struct notifier_block *nb);
 188
 189 /* driver data - core doesn't touch */
 190 void *regulator_get_drvdata(struct regulator *regulator);
 191 void regulator_set_drvdata(struct regulator *regulator, void *data);
 192
 193 #else
 194
 195 /*
 196  * Make sure client drivers will still build on systems with no software
 197  * controllable voltage or current regulators.
 198  */
 199 static inline struct regulator *__must_check regulator_get(struct device *dev,
 200         const char *id)
 201 {
 202         /* Nothing except the stubbed out regulator API should be
 203          * looking at the value except to check if it is an error
 204          * value. Drivers are free to handle NULL specifically by
 205          * skipping all regulator API calls, but they don't have to.
 206          * Drivers which don't, should make sure they properly handle
 207          * corner cases of the API, such as regulator_get_voltage()
 208          * returning 0.
 209          */
 210         return NULL;
 211 }
 212
 213 static inline struct regulator *__must_check
 214 devm_regulator_get(struct device *dev, const char *id)
 215 {
 216         return NULL;
 217 }
 218
 219 static inline void regulator_put(struct regulator *regulator)
 220 {
 221 }
 222
 223 static inline void devm_regulator_put(struct regulator *regulator)
 224 {
 225 }
 226
 227 static inline int regulator_enable(struct regulator *regulator)
 228 {
 229         return 0;
 230 }
 231
 232 static inline int regulator_disable(struct regulator *regulator)
 233 {
 234         return 0;
 235 }
 236
 237 static inline int regulator_force_disable(struct regulator *regulator)
 238 {
 239         return 0;
 240 }
 241
 242 static inline int regulator_disable_deferred(struct regulator *regulator,
 243                                              int ms)
 244 {
 245         return 0;
 246 }
 247
 248 static inline int regulator_is_enabled(struct regulator *regulator)
 249 {
 250         return 1;
 251 }
 252
 253 static inline int regulator_bulk_get(struct device *dev,
 254                                      int num_consumers,
 255                                      struct regulator_bulk_data *consumers)
 256 {
 257         return 0;
 258 }
 259
 260 static inline int devm_regulator_bulk_get(struct device *dev, int num_consumers,
 261                                           struct regulator_bulk_data *consumers)
 262 {
 263         return 0;
 264 }
 265
 266 static inline int regulator_bulk_enable(int num_consumers,
 267                                         struct regulator_bulk_data *consumers)
 268 {
 269         return 0;
 270 }
 271
 272 static inline int regulator_bulk_disable(int num_consumers,
 273                                          struct regulator_bulk_data *consumers)
 274 {
 275         return 0;
 276 }
 277
 278 static inline int regulator_bulk_force_disable(int num_consumers,
 279                                         struct regulator_bulk_data *consumers)
 280 {
 281         return 0;
 282 }
 283
 284 static inline void regulator_bulk_free(int num_consumers,
 285                                        struct regulator_bulk_data *consumers)
 286 {
 287 }
 288
 289 static inline int regulator_set_voltage(struct regulator *regulator,
 290                                         int min_uV, int max_uV)
 291 {
 292         return 0;
 293 }
 294
 295 static inline int regulator_get_voltage(struct regulator *regulator)
 296 {
 297         return -EINVAL;
 298 }
 299
 300 static inline int regulator_is_supported_voltage(struct regulator *regulator,
 301                                    int min_uV, int max_uV)
 302 {
 303         return 0;
 304 }
 305
 306 static inline int regulator_set_current_limit(struct regulator *regulator,
 307                                              int min_uA, int max_uA)
 308 {
 309         return 0;
 310 }
 311
 312 static inline int regulator_get_current_limit(struct regulator *regulator)
 313 {
 314         return 0;
 315 }
 316
 317 static inline int regulator_set_mode(struct regulator *regulator,
 318         unsigned int mode)
 319 {
 320         return 0;
 321 }
 322
 323 static inline unsigned int regulator_get_mode(struct regulator *regulator)
 324 {
 325         return REGULATOR_MODE_NORMAL;
 326 }
 327
 328 static inline int regulator_set_optimum_mode(struct regulator *regulator,
 329                                         int load_uA)
 330 {
 331         return REGULATOR_MODE_NORMAL;
 332 }
 333
 334 static inline int regulator_allow_bypass(struct regulator *regulator,
 335                                          bool allow)
 336 {
 337         return 0;
 338 }
 339
 340 static inline int regulator_register_notifier(struct regulator *regulator,
 341                               struct notifier_block *nb)
 342 {
 343         return 0;
 344 }
 345
 346 static inline int regulator_unregister_notifier(struct regulator *regulator,
 347                                 struct notifier_block *nb)
 348 {
 349         return 0;
 350 }
 351
 352 static inline void *regulator_get_drvdata(struct regulator *regulator)
 353 {
 354         return NULL;
 355 }
 356
 357 static inline void regulator_set_drvdata(struct regulator *regulator,
 358         void *data)
 359 {
 360 }
 361
 362 static inline int regulator_count_voltages(struct regulator *regulator)
 363 {
 364         return 0;
 365 }
 366 #endif
 367
 368 static inline int regulator_set_voltage_tol(struct regulator *regulator,
 369                                             int new_uV, int tol_uV)
 370 {
 371         return regulator_set_voltage(regulator,
 372                                      new_uV - tol_uV, new_uV + tol_uV);
 373 }
 374
 375 static inline int regulator_is_supported_voltage_tol(struct regulator *regulator,
 376                                                      int target_uV, int tol_uV)
 377 {
 378         return regulator_is_supported_voltage(regulator,
 379                                               target_uV - tol_uV,
 380                                               target_uV + tol_uV);
 381 }
 382
 383 #endif