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