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