include/linux/regulator/driver.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * driver.h -- SoC Regulator driver support.
   4  *
   5  * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC.
   6  *
   7  * Author: Liam Girdwood <lrg@slimlogic.co.uk>
   8  *
   9  * Regulator Driver Interface.
  10  */
  11
  12 #ifndef __LINUX_REGULATOR_DRIVER_H_
  13 #define __LINUX_REGULATOR_DRIVER_H_
  14
  15 #define MAX_COUPLED             2
  16
  17 #include <linux/device.h>
  18 #include <linux/notifier.h>
  19 #include <linux/regulator/consumer.h>
  20 #include <linux/ww_mutex.h>
  21
  22 struct gpio_desc;
  23 struct regmap;
  24 struct regulator_dev;
  25 struct regulator_config;
  26 struct regulator_init_data;
  27 struct regulator_enable_gpio;
  28
  29 enum regulator_status {
  30         REGULATOR_STATUS_OFF,
  31         REGULATOR_STATUS_ON,
  32         REGULATOR_STATUS_ERROR,
  33         /* fast/normal/idle/standby are flavors of "on" */
  34         REGULATOR_STATUS_FAST,
  35         REGULATOR_STATUS_NORMAL,
  36         REGULATOR_STATUS_IDLE,
  37         REGULATOR_STATUS_STANDBY,
  38         /* The regulator is enabled but not regulating */
  39         REGULATOR_STATUS_BYPASS,
  40         /* in case that any other status doesn't apply */
  41         REGULATOR_STATUS_UNDEFINED,
  42 };
  43
  44 /**
  45  * struct regulator_linear_range - specify linear voltage ranges
  46  *
  47  * Specify a range of voltages for regulator_map_linear_range() and
  48  * regulator_list_linear_range().
  49  *
  50  * @min_uV:  Lowest voltage in range
  51  * @min_sel: Lowest selector for range
  52  * @max_sel: Highest selector for range
  53  * @uV_step: Step size
  54  */
  55 struct regulator_linear_range {
  56         unsigned int min_uV;
  57         unsigned int min_sel;
  58         unsigned int max_sel;
  59         unsigned int uV_step;
  60 };
  61
  62 /* Initialize struct regulator_linear_range */
  63 #define REGULATOR_LINEAR_RANGE(_min_uV, _min_sel, _max_sel, _step_uV)   \
  64 {                                                                       \
  65         .min_uV         = _min_uV,                                      \
  66         .min_sel        = _min_sel,                                     \
  67         .max_sel        = _max_sel,                                     \
  68         .uV_step        = _step_uV,                                     \
  69 }
  70
  71 /**
  72  * struct regulator_ops - regulator operations.
  73  *
  74  * @enable: Configure the regulator as enabled.
  75  * @disable: Configure the regulator as disabled.
  76  * @is_enabled: Return 1 if the regulator is enabled, 0 if not.
  77  *              May also return negative errno.
  78  *
  79  * @set_voltage: Set the voltage for the regulator within the range specified.
  80  *               The driver should select the voltage closest to min_uV.
  81  * @set_voltage_sel: Set the voltage for the regulator using the specified
  82  *                   selector.
  83  * @map_voltage: Convert a voltage into a selector
  84  * @get_voltage: Return the currently configured voltage for the regulator;
  85  *                   return -ENOTRECOVERABLE if regulator can't be read at
  86  *                   bootup and hasn't been set yet.
  87  * @get_voltage_sel: Return the currently configured voltage selector for the
  88  *                   regulator; return -ENOTRECOVERABLE if regulator can't
  89  *                   be read at bootup and hasn't been set yet.
  90  * @list_voltage: Return one of the supported voltages, in microvolts; zero
  91  *      if the selector indicates a voltage that is unusable on this system;
  92  *      or negative errno.  Selectors range from zero to one less than
  93  *      regulator_desc.n_voltages.  Voltages may be reported in any order.
  94  *
  95  * @set_current_limit: Configure a limit for a current-limited regulator.
  96  *                     The driver should select the current closest to max_uA.
  97  * @get_current_limit: Get the configured limit for a current-limited regulator.
  98  * @set_input_current_limit: Configure an input limit.
  99  *
 100  * @set_over_current_protection: Support capability of automatically shutting
 101  *                               down when detecting an over current event.
 102  *
 103  * @set_active_discharge: Set active discharge enable/disable of regulators.
 104  *
 105  * @set_mode: Set the configured operating mode for the regulator.
 106  * @get_mode: Get the configured operating mode for the regulator.
 107  * @get_error_flags: Get the current error(s) for the regulator.
 108  * @get_status: Return actual (not as-configured) status of regulator, as a
 109  *      REGULATOR_STATUS value (or negative errno)
 110  * @get_optimum_mode: Get the most efficient operating mode for the regulator
 111  *                    when running with the specified parameters.
 112  * @set_load: Set the load for the regulator.
 113  *
 114  * @set_bypass: Set the regulator in bypass mode.
 115  * @get_bypass: Get the regulator bypass mode state.
 116  *
 117  * @enable_time: Time taken for the regulator voltage output voltage to
 118  *               stabilise after being enabled, in microseconds.
 119  * @set_ramp_delay: Set the ramp delay for the regulator. The driver should
 120  *              select ramp delay equal to or less than(closest) ramp_delay.
 121  * @set_voltage_time: Time taken for the regulator voltage output voltage
 122  *               to stabilise after being set to a new value, in microseconds.
 123  *               The function receives the from and to voltage as input, it
 124  *               should return the worst case.
 125  * @set_voltage_time_sel: Time taken for the regulator voltage output voltage
 126  *               to stabilise after being set to a new value, in microseconds.
 127  *               The function receives the from and to voltage selector as
 128  *               input, it should return the worst case.
 129  * @set_soft_start: Enable soft start for the regulator.
 130  *
 131  * @set_suspend_voltage: Set the voltage for the regulator when the system
 132  *                       is suspended.
 133  * @set_suspend_enable: Mark the regulator as enabled when the system is
 134  *                      suspended.
 135  * @set_suspend_disable: Mark the regulator as disabled when the system is
 136  *                       suspended.
 137  * @set_suspend_mode: Set the operating mode for the regulator when the
 138  *                    system is suspended.
 139  *
 140  * @set_pull_down: Configure the regulator to pull down when the regulator
 141  *                 is disabled.
 142  *
 143  * This struct describes regulator operations which can be implemented by
 144  * regulator chip drivers.
 145  */
 146 struct regulator_ops {
 147
 148         /* enumerate supported voltages */
 149         int (*list_voltage) (struct regulator_dev *, unsigned selector);
 150
 151         /* get/set regulator voltage */
 152         int (*set_voltage) (struct regulator_dev *, int min_uV, int max_uV,
 153                             unsigned *selector);
 154         int (*map_voltage)(struct regulator_dev *, int min_uV, int max_uV);
 155         int (*set_voltage_sel) (struct regulator_dev *, unsigned selector);
 156         int (*get_voltage) (struct regulator_dev *);
 157         int (*get_voltage_sel) (struct regulator_dev *);
 158
 159         /* get/set regulator current  */
 160         int (*set_current_limit) (struct regulator_dev *,
 161                                  int min_uA, int max_uA);
 162         int (*get_current_limit) (struct regulator_dev *);
 163
 164         int (*set_input_current_limit) (struct regulator_dev *, int lim_uA);
 165         int (*set_over_current_protection) (struct regulator_dev *);
 166         int (*set_active_discharge) (struct regulator_dev *, bool enable);
 167
 168         /* enable/disable regulator */
 169         int (*enable) (struct regulator_dev *);
 170         int (*disable) (struct regulator_dev *);
 171         int (*is_enabled) (struct regulator_dev *);
 172
 173         /* get/set regulator operating mode (defined in consumer.h) */
 174         int (*set_mode) (struct regulator_dev *, unsigned int mode);
 175         unsigned int (*get_mode) (struct regulator_dev *);
 176
 177         /* retrieve current error flags on the regulator */
 178         int (*get_error_flags)(struct regulator_dev *, unsigned int *flags);
 179
 180         /* Time taken to enable or set voltage on the regulator */
 181         int (*enable_time) (struct regulator_dev *);
 182         int (*set_ramp_delay) (struct regulator_dev *, int ramp_delay);
 183         int (*set_voltage_time) (struct regulator_dev *, int old_uV,
 184                                  int new_uV);
 185         int (*set_voltage_time_sel) (struct regulator_dev *,
 186                                      unsigned int old_selector,
 187                                      unsigned int new_selector);
 188
 189         int (*set_soft_start) (struct regulator_dev *);
 190
 191         /* report regulator status ... most other accessors report
 192          * control inputs, this reports results of combining inputs
 193          * from Linux (and other sources) with the actual load.
 194          * returns REGULATOR_STATUS_* or negative errno.
 195          */
 196         int (*get_status)(struct regulator_dev *);
 197
 198         /* get most efficient regulator operating mode for load */
 199         unsigned int (*get_optimum_mode) (struct regulator_dev *, int input_uV,
 200                                           int output_uV, int load_uA);
 201         /* set the load on the regulator */
 202         int (*set_load)(struct regulator_dev *, int load_uA);
 203
 204         /* control and report on bypass mode */
 205         int (*set_bypass)(struct regulator_dev *dev, bool enable);
 206         int (*get_bypass)(struct regulator_dev *dev, bool *enable);
 207
 208         /* the operations below are for configuration of regulator state when
 209          * its parent PMIC enters a global STANDBY/HIBERNATE state */
 210
 211         /* set regulator suspend voltage */
 212         int (*set_suspend_voltage) (struct regulator_dev *, int uV);
 213
 214         /* enable/disable regulator in suspend state */
 215         int (*set_suspend_enable) (struct regulator_dev *);
 216         int (*set_suspend_disable) (struct regulator_dev *);
 217
 218         /* set regulator suspend operating mode (defined in consumer.h) */
 219         int (*set_suspend_mode) (struct regulator_dev *, unsigned int mode);
 220
 221         int (*resume)(struct regulator_dev *rdev);
 222
 223         int (*set_pull_down) (struct regulator_dev *);
 224 };
 225
 226 /*
 227  * Regulators can either control voltage or current.
 228  */
 229 enum regulator_type {
 230         REGULATOR_VOLTAGE,
 231         REGULATOR_CURRENT,
 232 };
 233
 234 /**
 235  * struct regulator_desc - Static regulator descriptor
 236  *
 237  * Each regulator registered with the core is described with a
 238  * structure of this type and a struct regulator_config.  This
 239  * structure contains the non-varying parts of the regulator
 240  * description.
 241  *
 242  * @name: Identifying name for the regulator.
 243  * @supply_name: Identifying the regulator supply
 244  * @of_match: Name used to identify regulator in DT.
 245  * @regulators_node: Name of node containing regulator definitions in DT.
 246  * @of_parse_cb: Optional callback called only if of_match is present.
 247  *               Will be called for each regulator parsed from DT, during
 248  *               init_data parsing.
 249  *               The regulator_config passed as argument to the callback will
 250  *               be a copy of config passed to regulator_register, valid only
 251  *               for this particular call. Callback may freely change the
 252  *               config but it cannot store it for later usage.
 253  *               Callback should return 0 on success or negative ERRNO
 254  *               indicating failure.
 255  * @id: Numerical identifier for the regulator.
 256  * @ops: Regulator operations table.
 257  * @irq: Interrupt number for the regulator.
 258  * @type: Indicates if the regulator is a voltage or current regulator.
 259  * @owner: Module providing the regulator, used for refcounting.
 260  *
 261  * @continuous_voltage_range: Indicates if the regulator can set any
 262  *                            voltage within constrains range.
 263  * @n_voltages: Number of selectors available for ops.list_voltage().
 264  * @n_current_limits: Number of selectors available for current limits
 265  *
 266  * @min_uV: Voltage given by the lowest selector (if linear mapping)
 267  * @uV_step: Voltage increase with each selector (if linear mapping)
 268  * @linear_min_sel: Minimal selector for starting linear mapping
 269  * @fixed_uV: Fixed voltage of rails.
 270  * @ramp_delay: Time to settle down after voltage change (unit: uV/us)
 271  * @min_dropout_uV: The minimum dropout voltage this regulator can handle
 272  * @linear_ranges: A constant table of possible voltage ranges.
 273  * @linear_range_selectors: A constant table of voltage range selectors.
 274  *                          If pickable ranges are used each range must
 275  *                          have corresponding selector here.
 276  * @n_linear_ranges: Number of entries in the @linear_ranges (and in
 277  *                   linear_range_selectors if used) table(s).
 278  * @volt_table: Voltage mapping table (if table based mapping)
 279  * @curr_table: Current limit mapping table (if table based mapping)
 280  *
 281  * @vsel_range_reg: Register for range selector when using pickable ranges
 282  *                  and regulator_regmap_X_voltage_X_pickable functions.
 283  * @vsel_range_mask: Mask for register bitfield used for range selector
 284  * @vsel_reg: Register for selector when using regulator_regmap_X_voltage_
 285  * @vsel_mask: Mask for register bitfield used for selector
 286  * @csel_reg: Register for current limit selector using regmap set_current_limit
 287  * @csel_mask: Mask for register bitfield used for current limit selector
 288  * @apply_reg: Register for initiate voltage change on the output when
 289  *                using regulator_set_voltage_sel_regmap
 290  * @apply_bit: Register bitfield used for initiate voltage change on the
 291  *                output when using regulator_set_voltage_sel_regmap
 292  * @enable_reg: Register for control when using regmap enable/disable ops
 293  * @enable_mask: Mask for control when using regmap enable/disable ops
 294  * @enable_val: Enabling value for control when using regmap enable/disable ops
 295  * @disable_val: Disabling value for control when using regmap enable/disable ops
 296  * @enable_is_inverted: A flag to indicate set enable_mask bits to disable
 297  *                      when using regulator_enable_regmap and friends APIs.
 298  * @bypass_reg: Register for control when using regmap set_bypass
 299  * @bypass_mask: Mask for control when using regmap set_bypass
 300  * @bypass_val_on: Enabling value for control when using regmap set_bypass
 301  * @bypass_val_off: Disabling value for control when using regmap set_bypass
 302  * @active_discharge_off: Enabling value for control when using regmap
 303  *                        set_active_discharge
 304  * @active_discharge_on: Disabling value for control when using regmap
 305  *                       set_active_discharge
 306  * @active_discharge_mask: Mask for control when using regmap
 307  *                         set_active_discharge
 308  * @active_discharge_reg: Register for control when using regmap
 309  *                        set_active_discharge
 310  * @soft_start_reg: Register for control when using regmap set_soft_start
 311  * @soft_start_mask: Mask for control when using regmap set_soft_start
 312  * @soft_start_val_on: Enabling value for control when using regmap
 313  *                     set_soft_start
 314  * @pull_down_reg: Register for control when using regmap set_pull_down
 315  * @pull_down_mask: Mask for control when using regmap set_pull_down
 316  * @pull_down_val_on: Enabling value for control when using regmap
 317  *                     set_pull_down
 318  *
 319  * @enable_time: Time taken for initial enable of regulator (in uS).
 320  * @off_on_delay: guard time (in uS), before re-enabling a regulator
 321  *
 322  * @of_map_mode: Maps a hardware mode defined in a DeviceTree to a standard mode
 323  */
 324 struct regulator_desc {
 325         const char *name;
 326         const char *supply_name;
 327         const char *of_match;
 328         const char *regulators_node;
 329         int (*of_parse_cb)(struct device_node *,
 330                             const struct regulator_desc *,
 331                             struct regulator_config *);
 332         int id;
 333         unsigned int continuous_voltage_range:1;
 334         unsigned n_voltages;
 335         unsigned int n_current_limits;
 336         const struct regulator_ops *ops;
 337         int irq;
 338         enum regulator_type type;
 339         struct module *owner;
 340
 341         unsigned int min_uV;
 342         unsigned int uV_step;
 343         unsigned int linear_min_sel;
 344         int fixed_uV;
 345         unsigned int ramp_delay;
 346         int min_dropout_uV;
 347
 348         const struct regulator_linear_range *linear_ranges;
 349         const unsigned int *linear_range_selectors;
 350
 351         int n_linear_ranges;
 352
 353         const unsigned int *volt_table;
 354         const unsigned int *curr_table;
 355
 356         unsigned int vsel_range_reg;
 357         unsigned int vsel_range_mask;
 358         unsigned int vsel_reg;
 359         unsigned int vsel_mask;
 360         unsigned int csel_reg;
 361         unsigned int csel_mask;
 362         unsigned int apply_reg;
 363         unsigned int apply_bit;
 364         unsigned int enable_reg;
 365         unsigned int enable_mask;
 366         unsigned int enable_val;
 367         unsigned int disable_val;
 368         bool enable_is_inverted;
 369         unsigned int bypass_reg;
 370         unsigned int bypass_mask;
 371         unsigned int bypass_val_on;
 372         unsigned int bypass_val_off;
 373         unsigned int active_discharge_on;
 374         unsigned int active_discharge_off;
 375         unsigned int active_discharge_mask;
 376         unsigned int active_discharge_reg;
 377         unsigned int soft_start_reg;
 378         unsigned int soft_start_mask;
 379         unsigned int soft_start_val_on;
 380         unsigned int pull_down_reg;
 381         unsigned int pull_down_mask;
 382         unsigned int pull_down_val_on;
 383
 384         unsigned int enable_time;
 385
 386         unsigned int off_on_delay;
 387
 388         unsigned int (*of_map_mode)(unsigned int mode);
 389 };
 390
 391 /**
 392  * struct regulator_config - Dynamic regulator descriptor
 393  *
 394  * Each regulator registered with the core is described with a
 395  * structure of this type and a struct regulator_desc.  This structure
 396  * contains the runtime variable parts of the regulator description.
 397  *
 398  * @dev: struct device for the regulator
 399  * @init_data: platform provided init data, passed through by driver
 400  * @driver_data: private regulator data
 401  * @of_node: OpenFirmware node to parse for device tree bindings (may be
 402  *           NULL).
 403  * @regmap: regmap to use for core regmap helpers if dev_get_regmap() is
 404  *          insufficient.
 405  * @ena_gpiod: GPIO controlling regulator enable.
 406  */
 407 struct regulator_config {
 408         struct device *dev;
 409         const struct regulator_init_data *init_data;
 410         void *driver_data;
 411         struct device_node *of_node;
 412         struct regmap *regmap;
 413
 414         struct gpio_desc *ena_gpiod;
 415 };
 416
 417 /*
 418  * struct coupling_desc
 419  *
 420  * Describes coupling of regulators. Each regulator should have
 421  * at least a pointer to itself in coupled_rdevs array.
 422  * When a new coupled regulator is resolved, n_resolved is
 423  * incremented.
 424  */
 425 struct coupling_desc {
 426         struct regulator_dev *coupled_rdevs[MAX_COUPLED];
 427         int n_resolved;
 428         int n_coupled;
 429 };
 430
 431 /*
 432  * struct regulator_dev
 433  *
 434  * Voltage / Current regulator class device. One for each
 435  * regulator.
 436  *
 437  * This should *not* be used directly by anything except the regulator
 438  * core and notification injection (which should take the mutex and do
 439  * no other direct access).
 440  */
 441 struct regulator_dev {
 442         const struct regulator_desc *desc;
 443         int exclusive;
 444         u32 use_count;
 445         u32 open_count;
 446         u32 bypass_count;
 447
 448         /* lists we belong to */
 449         struct list_head list; /* list of all regulators */
 450
 451         /* lists we own */
 452         struct list_head consumer_list; /* consumers we supply */
 453
 454         struct coupling_desc coupling_desc;
 455
 456         struct blocking_notifier_head notifier;
 457         struct ww_mutex mutex; /* consumer lock */
 458         struct task_struct *mutex_owner;
 459         int ref_cnt;
 460         struct module *owner;
 461         struct device dev;
 462         struct regulation_constraints *constraints;
 463         struct regulator *supply;       /* for tree */
 464         const char *supply_name;
 465         struct regmap *regmap;
 466
 467         struct delayed_work disable_work;
 468
 469         void *reg_data;         /* regulator_dev data */
 470
 471         struct dentry *debugfs;
 472
 473         struct regulator_enable_gpio *ena_pin;
 474         unsigned int ena_gpio_state:1;
 475
 476         unsigned int is_switch:1;
 477
 478         /* time when this regulator was disabled last time */
 479         unsigned long last_off_jiffy;
 480 };
 481
 482 struct regulator_dev *
 483 regulator_register(const struct regulator_desc *regulator_desc,
 484                    const struct regulator_config *config);
 485 struct regulator_dev *
 486 devm_regulator_register(struct device *dev,
 487                         const struct regulator_desc *regulator_desc,
 488                         const struct regulator_config *config);
 489 void regulator_unregister(struct regulator_dev *rdev);
 490 void devm_regulator_unregister(struct device *dev, struct regulator_dev *rdev);
 491
 492 int regulator_notifier_call_chain(struct regulator_dev *rdev,
 493                                   unsigned long event, void *data);
 494
 495 void *rdev_get_drvdata(struct regulator_dev *rdev);
 496 struct device *rdev_get_dev(struct regulator_dev *rdev);
 497 struct regmap *rdev_get_regmap(struct regulator_dev *rdev);
 498 int rdev_get_id(struct regulator_dev *rdev);
 499
 500 int regulator_mode_to_status(unsigned int);
 501
 502 int regulator_list_voltage_linear(struct regulator_dev *rdev,
 503                                   unsigned int selector);
 504 int regulator_list_voltage_pickable_linear_range(struct regulator_dev *rdev,
 505                                                    unsigned int selector);
 506 int regulator_list_voltage_linear_range(struct regulator_dev *rdev,
 507                                         unsigned int selector);
 508 int regulator_list_voltage_table(struct regulator_dev *rdev,
 509                                   unsigned int selector);
 510 int regulator_map_voltage_linear(struct regulator_dev *rdev,
 511                                   int min_uV, int max_uV);
 512 int regulator_map_voltage_pickable_linear_range(struct regulator_dev *rdev,
 513                                                   int min_uV, int max_uV);
 514 int regulator_map_voltage_linear_range(struct regulator_dev *rdev,
 515                                        int min_uV, int max_uV);
 516 int regulator_map_voltage_iterate(struct regulator_dev *rdev,
 517                                   int min_uV, int max_uV);
 518 int regulator_map_voltage_ascend(struct regulator_dev *rdev,
 519                                   int min_uV, int max_uV);
 520 int regulator_get_voltage_sel_pickable_regmap(struct regulator_dev *rdev);
 521 int regulator_set_voltage_sel_pickable_regmap(struct regulator_dev *rdev,
 522                                                 unsigned int sel);
 523 int regulator_get_voltage_sel_regmap(struct regulator_dev *rdev);
 524 int regulator_set_voltage_sel_regmap(struct regulator_dev *rdev, unsigned sel);
 525 int regulator_is_enabled_regmap(struct regulator_dev *rdev);
 526 int regulator_enable_regmap(struct regulator_dev *rdev);
 527 int regulator_disable_regmap(struct regulator_dev *rdev);
 528 int regulator_set_voltage_time_sel(struct regulator_dev *rdev,
 529                                    unsigned int old_selector,
 530                                    unsigned int new_selector);
 531 int regulator_set_bypass_regmap(struct regulator_dev *rdev, bool enable);
 532 int regulator_get_bypass_regmap(struct regulator_dev *rdev, bool *enable);
 533 int regulator_set_soft_start_regmap(struct regulator_dev *rdev);
 534 int regulator_set_pull_down_regmap(struct regulator_dev *rdev);
 535
 536 int regulator_set_active_discharge_regmap(struct regulator_dev *rdev,
 537                                           bool enable);
 538 int regulator_set_current_limit_regmap(struct regulator_dev *rdev,
 539                                        int min_uA, int max_uA);
 540 int regulator_get_current_limit_regmap(struct regulator_dev *rdev);
 541 void *regulator_get_init_drvdata(struct regulator_init_data *reg_init_data);
 542
 543 void regulator_lock(struct regulator_dev *rdev);
 544 void regulator_unlock(struct regulator_dev *rdev);
 545
 546 /*
 547  * Helper functions intended to be used by regulator drivers prior registering
 548  * their regulators.
 549  */
 550 int regulator_desc_list_voltage_linear_range(const struct regulator_desc *desc,
 551                                              unsigned int selector);
 552 #endif