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_config;
  25 struct regulator_init_data;
  26 struct regulator_enable_gpio;
  27
  28 enum regulator_status {
  29         REGULATOR_STATUS_OFF,
  30         REGULATOR_STATUS_ON,
  31         REGULATOR_STATUS_ERROR,
  32         /* fast/normal/idle/standby are flavors of "on" */
  33         REGULATOR_STATUS_FAST,
  34         REGULATOR_STATUS_NORMAL,
  35         REGULATOR_STATUS_IDLE,
  36         REGULATOR_STATUS_STANDBY,
  37         /* The regulator is enabled but not regulating */
  38         REGULATOR_STATUS_BYPASS,
  39         /* in case that any other status doesn't apply */
  40         REGULATOR_STATUS_UNDEFINED,
  41 };
  42
  43 /**
  44  * struct regulator_linear_range - specify linear voltage ranges
  45  *
  46  * Specify a range of voltages for regulator_map_linar_range() and
  47  * regulator_list_linear_range().
  48  *
  49  * @min_uV:  Lowest 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 min_sel;
  57         unsigned int max_sel;
  58         unsigned int uV_step;
  59 };
  60
  61 /* Initialize struct regulator_linear_range */
  62 #define REGULATOR_LINEAR_RANGE(_min_uV, _min_sel, _max_sel, _step_uV)   \
  63 {                                                                       \
  64         .min_uV         = _min_uV,                                      \
  65         .min_sel        = _min_sel,                                     \
  66         .max_sel        = _max_sel,                                     \
  67         .uV_step        = _step_uV,                                     \
  68 }
  69
  70 /**
  71  * struct regulator_ops - regulator operations.
  72  *
  73  * @enable: Configure the regulator as enabled.
  74  * @disable: Configure the regulator as disabled.
  75  * @is_enabled: Return 1 if the regulator is enabled, 0 if not.
  76  *              May also return negative errno.
  77  *
  78  * @set_voltage: Set the voltage for the regulator within the range specified.
  79  *               The driver should select the voltage closest to min_uV.
  80  * @set_voltage_sel: Set the voltage for the regulator using the specified
  81  *                   selector.
  82  * @map_voltage: Convert a voltage into a selector
  83  * @get_voltage: Return the currently configured voltage for the regulator.
  84  * @get_voltage_sel: Return the currently configured voltage selector for the
  85  *                   regulator.
  86  * @list_voltage: Return one of the supported voltages, in microvolts; zero
  87  *      if the selector indicates a voltage that is unusable on this system;
  88  *      or negative errno.  Selectors range from zero to one less than
  89  *      regulator_desc.n_voltages.  Voltages may be reported in any order.
  90  *
  91  * @set_current_limit: Configure a limit for a current-limited regulator.
  92  *                     The driver should select the current closest to max_uA.
  93  * @get_current_limit: Get the configured limit for a current-limited regulator.
  94  * @set_input_current_limit: Configure an input limit.
  95  *
  96  * @set_mode: Set the configured operating mode for the regulator.
  97  * @get_mode: Get the configured operating mode for the regulator.
  98  * @get_status: Return actual (not as-configured) status of regulator, as a
  99  *      REGULATOR_STATUS value (or negative errno)
 100  * @get_optimum_mode: Get the most efficient operating mode for the regulator
 101  *                    when running with the specified parameters.
 102  * @set_load: Set the load for the regulator.
 103  *
 104  * @set_bypass: Set the regulator in bypass mode.
 105  * @get_bypass: Get the regulator bypass mode state.
 106  *
 107  * @enable_time: Time taken for the regulator voltage output voltage to
 108  *               stabilise after being enabled, in microseconds.
 109  * @set_ramp_delay: Set the ramp delay for the regulator. The driver should
 110  *              select ramp delay equal to or less than(closest) ramp_delay.
 111  * @set_voltage_time_sel: Time taken for the regulator voltage output voltage
 112  *               to stabilise after being set to a new value, in microseconds.
 113  *               The function provides the from and to voltage selector, the
 114  *               function should return the worst case.
 115  * @set_soft_start: Enable soft start for the regulator.
 116  *
 117  * @set_suspend_voltage: Set the voltage for the regulator when the system
 118  *                       is suspended.
 119  * @set_suspend_enable: Mark the regulator as enabled when the system is
 120  *                      suspended.
 121  * @set_suspend_disable: Mark the regulator as disabled when the system is
 122  *                       suspended.
 123  * @set_suspend_mode: Set the operating mode for the regulator when the
 124  *                    system is suspended.
 125  *
 126  * @set_pull_down: Configure the regulator to pull down when the regulator
 127  *                 is disabled.
 128  *
 129  * This struct describes regulator operations which can be implemented by
 130  * regulator chip drivers.
 131  */
 132 struct regulator_ops {
 133
 134         /* enumerate supported voltages */
 135         int (*list_voltage) (struct regulator_dev *, unsigned selector);
 136
 137         /* get/set regulator voltage */
 138         int (*set_voltage) (struct regulator_dev *, int min_uV, int max_uV,
 139                             unsigned *selector);
 140         int (*map_voltage)(struct regulator_dev *, int min_uV, int max_uV);
 141         int (*set_voltage_sel) (struct regulator_dev *, unsigned selector);
 142         int (*get_voltage) (struct regulator_dev *);
 143         int (*get_voltage_sel) (struct regulator_dev *);
 144
 145         /* get/set regulator current  */
 146         int (*set_current_limit) (struct regulator_dev *,
 147                                  int min_uA, int max_uA);
 148         int (*get_current_limit) (struct regulator_dev *);
 149
 150         int (*set_input_current_limit) (struct regulator_dev *, int lim_uA);
 151
 152         /* enable/disable regulator */
 153         int (*enable) (struct regulator_dev *);
 154         int (*disable) (struct regulator_dev *);
 155         int (*is_enabled) (struct regulator_dev *);
 156
 157         /* get/set regulator operating mode (defined in consumer.h) */
 158         int (*set_mode) (struct regulator_dev *, unsigned int mode);
 159         unsigned int (*get_mode) (struct regulator_dev *);
 160
 161         /* Time taken to enable or set voltage on the regulator */
 162         int (*enable_time) (struct regulator_dev *);
 163         int (*set_ramp_delay) (struct regulator_dev *, int ramp_delay);
 164         int (*set_voltage_time_sel) (struct regulator_dev *,
 165                                      unsigned int old_selector,
 166                                      unsigned int new_selector);
 167
 168         int (*set_soft_start) (struct regulator_dev *);
 169
 170         /* report regulator status ... most other accessors report
 171          * control inputs, this reports results of combining inputs
 172          * from Linux (and other sources) with the actual load.
 173          * returns REGULATOR_STATUS_* or negative errno.
 174          */
 175         int (*get_status)(struct regulator_dev *);
 176
 177         /* get most efficient regulator operating mode for load */
 178         unsigned int (*get_optimum_mode) (struct regulator_dev *, int input_uV,
 179                                           int output_uV, int load_uA);
 180         /* set the load on the regulator */
 181         int (*set_load)(struct regulator_dev *, int load_uA);
 182
 183         /* control and report on bypass mode */
 184         int (*set_bypass)(struct regulator_dev *dev, bool enable);
 185         int (*get_bypass)(struct regulator_dev *dev, bool *enable);
 186
 187         /* the operations below are for configuration of regulator state when
 188          * its parent PMIC enters a global STANDBY/HIBERNATE state */
 189
 190         /* set regulator suspend voltage */
 191         int (*set_suspend_voltage) (struct regulator_dev *, int uV);
 192
 193         /* enable/disable regulator in suspend state */
 194         int (*set_suspend_enable) (struct regulator_dev *);
 195         int (*set_suspend_disable) (struct regulator_dev *);
 196
 197         /* set regulator suspend operating mode (defined in consumer.h) */
 198         int (*set_suspend_mode) (struct regulator_dev *, unsigned int mode);
 199
 200         int (*set_pull_down) (struct regulator_dev *);
 201 };
 202
 203 /*
 204  * Regulators can either control voltage or current.
 205  */
 206 enum regulator_type {
 207         REGULATOR_VOLTAGE,
 208         REGULATOR_CURRENT,
 209 };
 210
 211 /**
 212  * struct regulator_desc - Static regulator descriptor
 213  *
 214  * Each regulator registered with the core is described with a
 215  * structure of this type and a struct regulator_config.  This
 216  * structure contains the non-varying parts of the regulator
 217  * description.
 218  *
 219  * @name: Identifying name for the regulator.
 220  * @supply_name: Identifying the regulator supply
 221  * @of_match: Name used to identify regulator in DT.
 222  * @regulators_node: Name of node containing regulator definitions in DT.
 223  * @of_parse_cb: Optional callback called only if of_match is present.
 224  *               Will be called for each regulator parsed from DT, during
 225  *               init_data parsing.
 226  *               The regulator_config passed as argument to the callback will
 227  *               be a copy of config passed to regulator_register, valid only
 228  *               for this particular call. Callback may freely change the
 229  *               config but it cannot store it for later usage.
 230  *               Callback should return 0 on success or negative ERRNO
 231  *               indicating failure.
 232  * @id: Numerical identifier for the regulator.
 233  * @ops: Regulator operations table.
 234  * @irq: Interrupt number for the regulator.
 235  * @type: Indicates if the regulator is a voltage or current regulator.
 236  * @owner: Module providing the regulator, used for refcounting.
 237  *
 238  * @continuous_voltage_range: Indicates if the regulator can set any
 239  *                            voltage within constrains range.
 240  * @n_voltages: Number of selectors available for ops.list_voltage().
 241  *
 242  * @min_uV: Voltage given by the lowest selector (if linear mapping)
 243  * @uV_step: Voltage increase with each selector (if linear mapping)
 244  * @linear_min_sel: Minimal selector for starting linear mapping
 245  * @fixed_uV: Fixed voltage of rails.
 246  * @ramp_delay: Time to settle down after voltage change (unit: uV/us)
 247  * @linear_ranges: A constant table of possible voltage ranges.
 248  * @n_linear_ranges: Number of entries in the @linear_ranges table.
 249  * @volt_table: Voltage mapping table (if table based mapping)
 250  *
 251  * @vsel_reg: Register for selector when using regulator_regmap_X_voltage_
 252  * @vsel_mask: Mask for register bitfield used for selector
 253  * @apply_reg: Register for initiate voltage change on the output when
 254  *                using regulator_set_voltage_sel_regmap
 255  * @apply_bit: Register bitfield used for initiate voltage change on the
 256  *                output when using regulator_set_voltage_sel_regmap
 257  * @enable_reg: Register for control when using regmap enable/disable ops
 258  * @enable_mask: Mask for control when using regmap enable/disable ops
 259  * @enable_val: Enabling value for control when using regmap enable/disable ops
 260  * @disable_val: Disabling value for control when using regmap enable/disable ops
 261  * @enable_is_inverted: A flag to indicate set enable_mask bits to disable
 262  *                      when using regulator_enable_regmap and friends APIs.
 263  * @bypass_reg: Register for control when using regmap set_bypass
 264  * @bypass_mask: Mask for control when using regmap set_bypass
 265  * @bypass_val_on: Enabling value for control when using regmap set_bypass
 266  * @bypass_val_off: Disabling value for control when using regmap set_bypass
 267  *
 268  * @enable_time: Time taken for initial enable of regulator (in uS).
 269  * @off_on_delay: guard time (in uS), before re-enabling a regulator
 270  *
 271  * @of_map_mode: Maps a hardware mode defined in a DeviceTree to a standard mode
 272  */
 273 struct regulator_desc {
 274         const char *name;
 275         const char *supply_name;
 276         const char *of_match;
 277         const char *regulators_node;
 278         int (*of_parse_cb)(struct device_node *,
 279                             const struct regulator_desc *,
 280                             struct regulator_config *);
 281         int id;
 282         bool continuous_voltage_range;
 283         unsigned n_voltages;
 284         const struct regulator_ops *ops;
 285         int irq;
 286         enum regulator_type type;
 287         struct module *owner;
 288
 289         unsigned int min_uV;
 290         unsigned int uV_step;
 291         unsigned int linear_min_sel;
 292         int fixed_uV;
 293         unsigned int ramp_delay;
 294
 295         const struct regulator_linear_range *linear_ranges;
 296         int n_linear_ranges;
 297
 298         const unsigned int *volt_table;
 299
 300         unsigned int vsel_reg;
 301         unsigned int vsel_mask;
 302         unsigned int apply_reg;
 303         unsigned int apply_bit;
 304         unsigned int enable_reg;
 305         unsigned int enable_mask;
 306         unsigned int enable_val;
 307         unsigned int disable_val;
 308         bool enable_is_inverted;
 309         unsigned int bypass_reg;
 310         unsigned int bypass_mask;
 311         unsigned int bypass_val_on;
 312         unsigned int bypass_val_off;
 313
 314         unsigned int enable_time;
 315
 316         unsigned int off_on_delay;
 317
 318         unsigned int (*of_map_mode)(unsigned int mode);
 319 };
 320
 321 /**
 322  * struct regulator_config - Dynamic regulator descriptor
 323  *
 324  * Each regulator registered with the core is described with a
 325  * structure of this type and a struct regulator_desc.  This structure
 326  * contains the runtime variable parts of the regulator description.
 327  *
 328  * @dev: struct device for the regulator
 329  * @init_data: platform provided init data, passed through by driver
 330  * @driver_data: private regulator data
 331  * @of_node: OpenFirmware node to parse for device tree bindings (may be
 332  *           NULL).
 333  * @regmap: regmap to use for core regmap helpers if dev_get_regmap() is
 334  *          insufficient.
 335  * @ena_gpio_initialized: GPIO controlling regulator enable was properly
 336  *                        initialized, meaning that >= 0 is a valid gpio
 337  *                        identifier and < 0 is a non existent gpio.
 338  * @ena_gpio: GPIO controlling regulator enable.
 339  * @ena_gpio_invert: Sense for GPIO enable control.
 340  * @ena_gpio_flags: Flags to use when calling gpio_request_one()
 341  */
 342 struct regulator_config {
 343         struct device *dev;
 344         const struct regulator_init_data *init_data;
 345         void *driver_data;
 346         struct device_node *of_node;
 347         struct regmap *regmap;
 348
 349         bool ena_gpio_initialized;
 350         int ena_gpio;
 351         unsigned int ena_gpio_invert:1;
 352         unsigned int ena_gpio_flags;
 353 };
 354
 355 /*
 356  * struct regulator_dev
 357  *
 358  * Voltage / Current regulator class device. One for each
 359  * regulator.
 360  *
 361  * This should *not* be used directly by anything except the regulator
 362  * core and notification injection (which should take the mutex and do
 363  * no other direct access).
 364  */
 365 struct regulator_dev {
 366         const struct regulator_desc *desc;
 367         int exclusive;
 368         u32 use_count;
 369         u32 open_count;
 370         u32 bypass_count;
 371
 372         /* lists we belong to */
 373         struct list_head list; /* list of all regulators */
 374
 375         /* lists we own */
 376         struct list_head consumer_list; /* consumers we supply */
 377
 378         struct blocking_notifier_head notifier;
 379         struct mutex mutex; /* consumer lock */
 380         struct module *owner;
 381         struct device dev;
 382         struct regulation_constraints *constraints;
 383         struct regulator *supply;       /* for tree */
 384         const char *supply_name;
 385         struct regmap *regmap;
 386
 387         struct delayed_work disable_work;
 388         int deferred_disables;
 389
 390         void *reg_data;         /* regulator_dev data */
 391
 392         struct dentry *debugfs;
 393
 394         struct regulator_enable_gpio *ena_pin;
 395         unsigned int ena_gpio_state:1;
 396
 397         /* time when this regulator was disabled last time */
 398         unsigned long last_off_jiffy;
 399 };
 400
 401 struct regulator_dev *
 402 regulator_register(const struct regulator_desc *regulator_desc,
 403                    const struct regulator_config *config);
 404 struct regulator_dev *
 405 devm_regulator_register(struct device *dev,
 406                         const struct regulator_desc *regulator_desc,
 407                         const struct regulator_config *config);
 408 void regulator_unregister(struct regulator_dev *rdev);
 409 void devm_regulator_unregister(struct device *dev, struct regulator_dev *rdev);
 410
 411 int regulator_notifier_call_chain(struct regulator_dev *rdev,
 412                                   unsigned long event, void *data);
 413
 414 void *rdev_get_drvdata(struct regulator_dev *rdev);
 415 struct device *rdev_get_dev(struct regulator_dev *rdev);
 416 int rdev_get_id(struct regulator_dev *rdev);
 417
 418 int regulator_mode_to_status(unsigned int);
 419
 420 int regulator_list_voltage_linear(struct regulator_dev *rdev,
 421                                   unsigned int selector);
 422 int regulator_list_voltage_linear_range(struct regulator_dev *rdev,
 423                                         unsigned int selector);
 424 int regulator_list_voltage_table(struct regulator_dev *rdev,
 425                                   unsigned int selector);
 426 int regulator_map_voltage_linear(struct regulator_dev *rdev,
 427                                   int min_uV, int max_uV);
 428 int regulator_map_voltage_linear_range(struct regulator_dev *rdev,
 429                                        int min_uV, int max_uV);
 430 int regulator_map_voltage_iterate(struct regulator_dev *rdev,
 431                                   int min_uV, int max_uV);
 432 int regulator_map_voltage_ascend(struct regulator_dev *rdev,
 433                                   int min_uV, int max_uV);
 434 int regulator_get_voltage_sel_regmap(struct regulator_dev *rdev);
 435 int regulator_set_voltage_sel_regmap(struct regulator_dev *rdev, unsigned sel);
 436 int regulator_is_enabled_regmap(struct regulator_dev *rdev);
 437 int regulator_enable_regmap(struct regulator_dev *rdev);
 438 int regulator_disable_regmap(struct regulator_dev *rdev);
 439 int regulator_set_voltage_time_sel(struct regulator_dev *rdev,
 440                                    unsigned int old_selector,
 441                                    unsigned int new_selector);
 442 int regulator_set_bypass_regmap(struct regulator_dev *rdev, bool enable);
 443 int regulator_get_bypass_regmap(struct regulator_dev *rdev, bool *enable);
 444
 445 void *regulator_get_init_drvdata(struct regulator_init_data *reg_init_data);
 446
 447 #endif