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