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