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