include/linux/regulator/driver.h

   1 /*
   2  * driver.h -- SoC Regulator driver 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 Driver Interface.
  13  */
  14
  15 #ifndef __LINUX_REGULATOR_DRIVER_H_
  16 #define __LINUX_REGULATOR_DRIVER_H_
  17
  18 #include <linux/device.h>
  19 #include <linux/notifier.h>
  20 #include <linux/regulator/consumer.h>
  21
  22 struct regmap;
  23 struct regulator_dev;
  24 struct regulator_init_data;
  25 struct regulator_enable_gpio;
  26
  27 enum regulator_status {
  28         REGULATOR_STATUS_OFF,
  29         REGULATOR_STATUS_ON,
  30         REGULATOR_STATUS_ERROR,
  31         /* fast/normal/idle/standby are flavors of "on" */
  32         REGULATOR_STATUS_FAST,
  33         REGULATOR_STATUS_NORMAL,
  34         REGULATOR_STATUS_IDLE,
  35         REGULATOR_STATUS_STANDBY,
  36         /* The regulator is enabled but not regulating */
  37         REGULATOR_STATUS_BYPASS,
  38         /* in case that any other status doesn't apply */
  39         REGULATOR_STATUS_UNDEFINED,
  40 };
  41
  42 /**
  43  * struct regulator_ops - regulator operations.
  44  *
  45  * @enable: Configure the regulator as enabled.
  46  * @disable: Configure the regulator as disabled.
  47  * @is_enabled: Return 1 if the regulator is enabled, 0 if not.
  48  *              May also return negative errno.
  49  *
  50  * @set_voltage: Set the voltage for the regulator within the range specified.
  51  *               The driver should select the voltage closest to min_uV.
  52  * @set_voltage_sel: Set the voltage for the regulator using the specified
  53  *                   selector.
  54  * @map_voltage: Convert a voltage into a selector
  55  * @get_voltage: Return the currently configured voltage for the regulator.
  56  * @get_voltage_sel: Return the currently configured voltage selector for the
  57  *                   regulator.
  58  * @list_voltage: Return one of the supported voltages, in microvolts; zero
  59  *      if the selector indicates a voltage that is unusable on this system;
  60  *      or negative errno.  Selectors range from zero to one less than
  61  *      regulator_desc.n_voltages.  Voltages may be reported in any order.
  62  *
  63  * @set_current_limit: Configure a limit for a current-limited regulator.
  64  *                     The driver should select the current closest to max_uA.
  65  * @get_current_limit: Get the configured limit for a current-limited regulator.
  66  *
  67  * @set_mode: Set the configured operating mode for the regulator.
  68  * @get_mode: Get the configured operating mode for the regulator.
  69  * @get_status: Return actual (not as-configured) status of regulator, as a
  70  *      REGULATOR_STATUS value (or negative errno)
  71  * @get_optimum_mode: Get the most efficient operating mode for the regulator
  72  *                    when running with the specified parameters.
  73  *
  74  * @set_bypass: Set the regulator in bypass mode.
  75  * @get_bypass: Get the regulator bypass mode state.
  76  *
  77  * @enable_time: Time taken for the regulator voltage output voltage to
  78  *               stabilise after being enabled, in microseconds.
  79  * @set_ramp_delay: Set the ramp delay for the regulator. The driver should
  80  *              select ramp delay equal to or less than(closest) ramp_delay.
  81  * @set_voltage_time_sel: Time taken for the regulator voltage output voltage
  82  *               to stabilise after being set to a new value, in microseconds.
  83  *               The function provides the from and to voltage selector, the
  84  *               function should return the worst case.
  85  *
  86  * @set_suspend_voltage: Set the voltage for the regulator when the system
  87  *                       is suspended.
  88  * @set_suspend_enable: Mark the regulator as enabled when the system is
  89  *                      suspended.
  90  * @set_suspend_disable: Mark the regulator as disabled when the system is
  91  *                       suspended.
  92  * @set_suspend_mode: Set the operating mode for the regulator when the
  93  *                    system is suspended.
  94  *
  95  * This struct describes regulator operations which can be implemented by
  96  * regulator chip drivers.
  97  */
  98 struct regulator_ops {
  99
 100         /* enumerate supported voltages */
 101         int (*list_voltage) (struct regulator_dev *, unsigned selector);
 102
 103         /* get/set regulator voltage */
 104         int (*set_voltage) (struct regulator_dev *, int min_uV, int max_uV,
 105                             unsigned *selector);
 106         int (*map_voltage)(struct regulator_dev *, int min_uV, int max_uV);
 107         int (*set_voltage_sel) (struct regulator_dev *, unsigned selector);
 108         int (*get_voltage) (struct regulator_dev *);
 109         int (*get_voltage_sel) (struct regulator_dev *);
 110
 111         /* get/set regulator current  */
 112         int (*set_current_limit) (struct regulator_dev *,
 113                                  int min_uA, int max_uA);
 114         int (*get_current_limit) (struct regulator_dev *);
 115
 116         /* enable/disable regulator */
 117         int (*enable) (struct regulator_dev *);
 118         int (*disable) (struct regulator_dev *);
 119         int (*is_enabled) (struct regulator_dev *);
 120
 121         /* get/set regulator operating mode (defined in consumer.h) */
 122         int (*set_mode) (struct regulator_dev *, unsigned int mode);
 123         unsigned int (*get_mode) (struct regulator_dev *);
 124
 125         /* Time taken to enable or set voltage on the regulator */
 126         int (*enable_time) (struct regulator_dev *);
 127         int (*set_ramp_delay) (struct regulator_dev *, int ramp_delay);
 128         int (*set_voltage_time_sel) (struct regulator_dev *,
 129                                      unsigned int old_selector,
 130                                      unsigned int new_selector);
 131
 132         /* report regulator status ... most other accessors report
 133          * control inputs, this reports results of combining inputs
 134          * from Linux (and other sources) with the actual load.
 135          * returns REGULATOR_STATUS_* or negative errno.
 136          */
 137         int (*get_status)(struct regulator_dev *);
 138
 139         /* get most efficient regulator operating mode for load */
 140         unsigned int (*get_optimum_mode) (struct regulator_dev *, int input_uV,
 141                                           int output_uV, int load_uA);
 142
 143         /* control and report on bypass mode */
 144         int (*set_bypass)(struct regulator_dev *dev, bool enable);
 145         int (*get_bypass)(struct regulator_dev *dev, bool *enable);
 146
 147         /* the operations below are for configuration of regulator state when
 148          * its parent PMIC enters a global STANDBY/HIBERNATE state */
 149
 150         /* set regulator suspend voltage */
 151         int (*set_suspend_voltage) (struct regulator_dev *, int uV);
 152
 153         /* enable/disable regulator in suspend state */
 154         int (*set_suspend_enable) (struct regulator_dev *);
 155         int (*set_suspend_disable) (struct regulator_dev *);
 156
 157         /* set regulator suspend operating mode (defined in consumer.h) */
 158         int (*set_suspend_mode) (struct regulator_dev *, unsigned int mode);
 159 };
 160
 161 /*
 162  * Regulators can either control voltage or current.
 163  */
 164 enum regulator_type {
 165         REGULATOR_VOLTAGE,
 166         REGULATOR_CURRENT,
 167 };
 168
 169 /**
 170  * struct regulator_desc - Static regulator descriptor
 171  *
 172  * Each regulator registered with the core is described with a
 173  * structure of this type and a struct regulator_config.  This
 174  * structure contains the non-varying parts of the regulator
 175  * description.
 176  *
 177  * @name: Identifying name for the regulator.
 178  * @supply_name: Identifying the regulator supply
 179  * @id: Numerical identifier for the regulator.
 180  * @ops: Regulator operations table.
 181  * @irq: Interrupt number for the regulator.
 182  * @type: Indicates if the regulator is a voltage or current regulator.
 183  * @owner: Module providing the regulator, used for refcounting.
 184  *
 185  * @continuous_voltage_range: Indicates if the regulator can set any
 186  *                            voltage within constrains range.
 187  * @n_voltages: Number of selectors available for ops.list_voltage().
 188  *
 189  * @min_uV: Voltage given by the lowest selector (if linear mapping)
 190  * @uV_step: Voltage increase with each selector (if linear mapping)
 191  * @linear_min_sel: Minimal selector for starting linear mapping
 192  * @ramp_delay: Time to settle down after voltage change (unit: uV/us)
 193  * @volt_table: Voltage mapping table (if table based mapping)
 194  *
 195  * @vsel_reg: Register for selector when using regulator_regmap_X_voltage_
 196  * @vsel_mask: Mask for register bitfield used for selector
 197  * @apply_reg: Register for initiate voltage change on the output when
 198  *                using regulator_set_voltage_sel_regmap
 199  * @apply_bit: Register bitfield used for initiate voltage change on the
 200  *                output when using regulator_set_voltage_sel_regmap
 201  * @enable_reg: Register for control when using regmap enable/disable ops
 202  * @enable_mask: Mask for control when using regmap enable/disable ops
 203  * @enable_is_inverted: A flag to indicate set enable_mask bits to disable
 204  *                      when using regulator_enable_regmap and friends APIs.
 205  * @bypass_reg: Register for control when using regmap set_bypass
 206  * @bypass_mask: Mask for control when using regmap set_bypass
 207  *
 208  * @enable_time: Time taken for initial enable of regulator (in uS).
 209  */
 210 struct regulator_desc {
 211         const char *name;
 212         const char *supply_name;
 213         int id;
 214         bool continuous_voltage_range;
 215         unsigned n_voltages;
 216         struct regulator_ops *ops;
 217         int irq;
 218         enum regulator_type type;
 219         struct module *owner;
 220
 221         unsigned int min_uV;
 222         unsigned int uV_step;
 223         unsigned int linear_min_sel;
 224         unsigned int ramp_delay;
 225
 226         const unsigned int *volt_table;
 227
 228         unsigned int vsel_reg;
 229         unsigned int vsel_mask;
 230         unsigned int apply_reg;
 231         unsigned int apply_bit;
 232         unsigned int enable_reg;
 233         unsigned int enable_mask;
 234         bool enable_is_inverted;
 235         unsigned int bypass_reg;
 236         unsigned int bypass_mask;
 237
 238         unsigned int enable_time;
 239 };
 240
 241 /**
 242  * struct regulator_config - Dynamic regulator descriptor
 243  *
 244  * Each regulator registered with the core is described with a
 245  * structure of this type and a struct regulator_desc.  This structure
 246  * contains the runtime variable parts of the regulator description.
 247  *
 248  * @dev: struct device for the regulator
 249  * @init_data: platform provided init data, passed through by driver
 250  * @driver_data: private regulator data
 251  * @of_node: OpenFirmware node to parse for device tree bindings (may be
 252  *           NULL).
 253  * @regmap: regmap to use for core regmap helpers if dev_get_regulator() is
 254  *          insufficient.
 255  * @ena_gpio: GPIO controlling regulator enable.
 256  * @ena_gpio_invert: Sense for GPIO enable control.
 257  * @ena_gpio_flags: Flags to use when calling gpio_request_one()
 258  */
 259 struct regulator_config {
 260         struct device *dev;
 261         const struct regulator_init_data *init_data;
 262         void *driver_data;
 263         struct device_node *of_node;
 264         struct regmap *regmap;
 265
 266         int ena_gpio;
 267         unsigned int ena_gpio_invert:1;
 268         unsigned int ena_gpio_flags;
 269 };
 270
 271 /*
 272  * struct regulator_dev
 273  *
 274  * Voltage / Current regulator class device. One for each
 275  * regulator.
 276  *
 277  * This should *not* be used directly by anything except the regulator
 278  * core and notification injection (which should take the mutex and do
 279  * no other direct access).
 280  */
 281 struct regulator_dev {
 282         const struct regulator_desc *desc;
 283         int exclusive;
 284         u32 use_count;
 285         u32 open_count;
 286         u32 bypass_count;
 287
 288         /* lists we belong to */
 289         struct list_head list; /* list of all regulators */
 290
 291         /* lists we own */
 292         struct list_head consumer_list; /* consumers we supply */
 293
 294         struct blocking_notifier_head notifier;
 295         struct mutex mutex; /* consumer lock */
 296         struct module *owner;
 297         struct device dev;
 298         struct regulation_constraints *constraints;
 299         struct regulator *supply;       /* for tree */
 300         struct regmap *regmap;
 301
 302         struct delayed_work disable_work;
 303         int deferred_disables;
 304
 305         void *reg_data;         /* regulator_dev data */
 306
 307         struct dentry *debugfs;
 308
 309         struct regulator_enable_gpio *ena_pin;
 310         unsigned int ena_gpio_state:1;
 311 };
 312
 313 struct regulator_dev *
 314 regulator_register(const struct regulator_desc *regulator_desc,
 315                    const struct regulator_config *config);
 316 void regulator_unregister(struct regulator_dev *rdev);
 317
 318 int regulator_notifier_call_chain(struct regulator_dev *rdev,
 319                                   unsigned long event, void *data);
 320
 321 void *rdev_get_drvdata(struct regulator_dev *rdev);
 322 struct device *rdev_get_dev(struct regulator_dev *rdev);
 323 int rdev_get_id(struct regulator_dev *rdev);
 324
 325 int regulator_mode_to_status(unsigned int);
 326
 327 int regulator_list_voltage_linear(struct regulator_dev *rdev,
 328                                   unsigned int selector);
 329 int regulator_list_voltage_table(struct regulator_dev *rdev,
 330                                   unsigned int selector);
 331 int regulator_map_voltage_linear(struct regulator_dev *rdev,
 332                                   int min_uV, int max_uV);
 333 int regulator_map_voltage_iterate(struct regulator_dev *rdev,
 334                                   int min_uV, int max_uV);
 335 int regulator_map_voltage_ascend(struct regulator_dev *rdev,
 336                                   int min_uV, int max_uV);
 337 int regulator_get_voltage_sel_regmap(struct regulator_dev *rdev);
 338 int regulator_set_voltage_sel_regmap(struct regulator_dev *rdev, unsigned sel);
 339 int regulator_is_enabled_regmap(struct regulator_dev *rdev);
 340 int regulator_enable_regmap(struct regulator_dev *rdev);
 341 int regulator_disable_regmap(struct regulator_dev *rdev);
 342 int regulator_set_voltage_time_sel(struct regulator_dev *rdev,
 343                                    unsigned int old_selector,
 344                                    unsigned int new_selector);
 345 int regulator_set_bypass_regmap(struct regulator_dev *rdev, bool enable);
 346 int regulator_get_bypass_regmap(struct regulator_dev *rdev, bool *enable);
 347
 348 void *regulator_get_init_drvdata(struct regulator_init_data *reg_init_data);
 349
 350 #endif