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 #include <linux/device.h>
  39
  40 /*
  41  * Regulator operating modes.
  42  *
  43  * Regulators can run in a variety of different operating modes depending on
  44  * output load. This allows further system power savings by selecting the
  45  * best (and most efficient) regulator mode for a desired load.
  46  *
  47  * Most drivers will only care about NORMAL. The modes below are generic and
  48  * will probably not match the naming convention of your regulator data sheet
  49  * but should match the use cases in the datasheet.
  50  *
  51  * In order of power efficiency (least efficient at top).
  52  *
  53  *  Mode       Description
  54  *  FAST       Regulator can handle fast changes in it's load.
  55  *             e.g. useful in CPU voltage & frequency scaling where
  56  *             load can quickly increase with CPU frequency increases.
  57  *
  58  *  NORMAL     Normal regulator power supply mode. Most drivers will
  59  *             use this mode.
  60  *
  61  *  IDLE       Regulator runs in a more efficient mode for light
  62  *             loads. Can be used for devices that have a low power
  63  *             requirement during periods of inactivity. This mode
  64  *             may be more noisy than NORMAL and may not be able
  65  *             to handle fast load switching.
  66  *
  67  *  STANDBY    Regulator runs in the most efficient mode for very
  68  *             light loads. Can be used by devices when they are
  69  *             in a sleep/standby state. This mode is likely to be
  70  *             the most noisy and may not be able to handle fast load
  71  *             switching.
  72  *
  73  * NOTE: Most regulators will only support a subset of these modes. Some
  74  * will only just support NORMAL.
  75  *
  76  * These modes can be OR'ed together to make up a mask of valid register modes.
  77  */
  78
  79 #define REGULATOR_MODE_FAST                     0x1
  80 #define REGULATOR_MODE_NORMAL                   0x2
  81 #define REGULATOR_MODE_IDLE                     0x4
  82 #define REGULATOR_MODE_STANDBY                  0x8
  83
  84 /*
  85  * Regulator notifier events.
  86  *
  87  * UNDER_VOLTAGE  Regulator output is under voltage.
  88  * OVER_CURRENT   Regulator output current is too high.
  89  * REGULATION_OUT Regulator output is out of regulation.
  90  * FAIL           Regulator output has failed.
  91  * OVER_TEMP      Regulator over temp.
  92  * FORCE_DISABLE  Regulator forcibly shut down by software.
  93  * VOLTAGE_CHANGE Regulator voltage changed.
  94  * DISABLE        Regulator was disabled.
  95  *
  96  * NOTE: These events can be OR'ed together when passed into handler.
  97  */
  98
  99 #define REGULATOR_EVENT_UNDER_VOLTAGE           0x01
 100 #define REGULATOR_EVENT_OVER_CURRENT            0x02
 101 #define REGULATOR_EVENT_REGULATION_OUT          0x04
 102 #define REGULATOR_EVENT_FAIL                    0x08
 103 #define REGULATOR_EVENT_OVER_TEMP               0x10
 104 #define REGULATOR_EVENT_FORCE_DISABLE           0x20
 105 #define REGULATOR_EVENT_VOLTAGE_CHANGE          0x40
 106 #define REGULATOR_EVENT_DISABLE                 0x80
 107
 108 struct regulator;
 109
 110 /**
 111  * struct regulator_bulk_data - Data used for bulk regulator operations.
 112  *
 113  * @supply:   The name of the supply.  Initialised by the user before
 114  *            using the bulk regulator APIs.
 115  * @consumer: The regulator consumer for the supply.  This will be managed
 116  *            by the bulk API.
 117  *
 118  * The regulator APIs provide a series of regulator_bulk_() API calls as
 119  * a convenience to consumers which require multiple supplies.  This
 120  * structure is used to manage data for these calls.
 121  */
 122 struct regulator_bulk_data {
 123         const char *supply;
 124         struct regulator *consumer;
 125 };
 126
 127 #if defined(CONFIG_REGULATOR)
 128
 129 /* regulator get and put */
 130 struct regulator *__must_check regulator_get(struct device *dev,
 131                                              const char *id);
 132 struct regulator *__must_check regulator_get_exclusive(struct device *dev,
 133                                                        const char *id);
 134 void regulator_put(struct regulator *regulator);
 135
 136 /* regulator output control and status */
 137 int regulator_enable(struct regulator *regulator);
 138 int regulator_disable(struct regulator *regulator);
 139 int regulator_force_disable(struct regulator *regulator);
 140 int regulator_is_enabled(struct regulator *regulator);
 141
 142 int regulator_bulk_get(struct device *dev, int num_consumers,
 143                        struct regulator_bulk_data *consumers);
 144 int regulator_bulk_enable(int num_consumers,
 145                           struct regulator_bulk_data *consumers);
 146 int regulator_bulk_disable(int num_consumers,
 147                            struct regulator_bulk_data *consumers);
 148 void regulator_bulk_free(int num_consumers,
 149                          struct regulator_bulk_data *consumers);
 150
 151 int regulator_count_voltages(struct regulator *regulator);
 152 int regulator_list_voltage(struct regulator *regulator, unsigned selector);
 153 int regulator_is_supported_voltage(struct regulator *regulator,
 154                                    int min_uV, int max_uV);
 155 int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV);
 156 int regulator_get_voltage(struct regulator *regulator);
 157 int regulator_set_current_limit(struct regulator *regulator,
 158                                int min_uA, int max_uA);
 159 int regulator_get_current_limit(struct regulator *regulator);
 160
 161 int regulator_set_mode(struct regulator *regulator, unsigned int mode);
 162 unsigned int regulator_get_mode(struct regulator *regulator);
 163 int regulator_set_optimum_mode(struct regulator *regulator, int load_uA);
 164
 165 /* regulator notifier block */
 166 int regulator_register_notifier(struct regulator *regulator,
 167                               struct notifier_block *nb);
 168 int regulator_unregister_notifier(struct regulator *regulator,
 169                                 struct notifier_block *nb);
 170
 171 /* driver data - core doesn't touch */
 172 void *regulator_get_drvdata(struct regulator *regulator);
 173 void regulator_set_drvdata(struct regulator *regulator, void *data);
 174
 175 #else
 176
 177 /*
 178  * Make sure client drivers will still build on systems with no software
 179  * controllable voltage or current regulators.
 180  */
 181 static inline struct regulator *__must_check regulator_get(struct device *dev,
 182         const char *id)
 183 {
 184         /* Nothing except the stubbed out regulator API should be
 185          * looking at the value except to check if it is an error
 186          * value. Drivers are free to handle NULL specifically by
 187          * skipping all regulator API calls, but they don't have to.
 188          * Drivers which don't, should make sure they properly handle
 189          * corner cases of the API, such as regulator_get_voltage()
 190          * returning 0.
 191          */
 192         return NULL;
 193 }
 194 static inline void regulator_put(struct regulator *regulator)
 195 {
 196 }
 197
 198 static inline int regulator_enable(struct regulator *regulator)
 199 {
 200         return 0;
 201 }
 202
 203 static inline int regulator_disable(struct regulator *regulator)
 204 {
 205         return 0;
 206 }
 207
 208 static inline int regulator_is_enabled(struct regulator *regulator)
 209 {
 210         return 1;
 211 }
 212
 213 static inline int regulator_bulk_get(struct device *dev,
 214                                      int num_consumers,
 215                                      struct regulator_bulk_data *consumers)
 216 {
 217         return 0;
 218 }
 219
 220 static inline int regulator_bulk_enable(int num_consumers,
 221                                         struct regulator_bulk_data *consumers)
 222 {
 223         return 0;
 224 }
 225
 226 static inline int regulator_bulk_disable(int num_consumers,
 227                                          struct regulator_bulk_data *consumers)
 228 {
 229         return 0;
 230 }
 231
 232 static inline void regulator_bulk_free(int num_consumers,
 233                                        struct regulator_bulk_data *consumers)
 234 {
 235 }
 236
 237 static inline int regulator_set_voltage(struct regulator *regulator,
 238                                         int min_uV, int max_uV)
 239 {
 240         return 0;
 241 }
 242
 243 static inline int regulator_get_voltage(struct regulator *regulator)
 244 {
 245         return 0;
 246 }
 247
 248 static inline int regulator_set_current_limit(struct regulator *regulator,
 249                                              int min_uA, int max_uA)
 250 {
 251         return 0;
 252 }
 253
 254 static inline int regulator_get_current_limit(struct regulator *regulator)
 255 {
 256         return 0;
 257 }
 258
 259 static inline int regulator_set_mode(struct regulator *regulator,
 260         unsigned int mode)
 261 {
 262         return 0;
 263 }
 264
 265 static inline unsigned int regulator_get_mode(struct regulator *regulator)
 266 {
 267         return REGULATOR_MODE_NORMAL;
 268 }
 269
 270 static inline int regulator_set_optimum_mode(struct regulator *regulator,
 271                                         int load_uA)
 272 {
 273         return REGULATOR_MODE_NORMAL;
 274 }
 275
 276 static inline int regulator_register_notifier(struct regulator *regulator,
 277                               struct notifier_block *nb)
 278 {
 279         return 0;
 280 }
 281
 282 static inline int regulator_unregister_notifier(struct regulator *regulator,
 283                                 struct notifier_block *nb)
 284 {
 285         return 0;
 286 }
 287
 288 static inline void *regulator_get_drvdata(struct regulator *regulator)
 289 {
 290         return NULL;
 291 }
 292
 293 static inline void regulator_set_drvdata(struct regulator *regulator,
 294         void *data)
 295 {
 296 }
 297
 298 #endif
 299
 300 #endif