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 <[email protected]>
   8  *
   9  * Regulator Driver Interface.
  10  */
  11
  12 #ifndef __LINUX_REGULATOR_DRIVER_H_
  13 #define __LINUX_REGULATOR_DRIVER_H_
  14
  15 #include <linux/device.h>
  16 #include <linux/linear_range.h>
  17 #include <linux/notifier.h>
  18 #include <linux/regulator/consumer.h>
  19 #include <linux/ww_mutex.h>
  20
  21 struct gpio_desc;
  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 enum regulator_detection_severity {
  44         /* Hardware shut down voltage outputs if condition is detected */
  45         REGULATOR_SEVERITY_PROT,
  46         /* Hardware is probably damaged/inoperable */
  47         REGULATOR_SEVERITY_ERR,
  48         /* Hardware is still recoverable but recovery action must be taken */
  49         REGULATOR_SEVERITY_WARN,
  50 };
  51
  52 /* Initialize struct linear_range for regulators */
  53 #define REGULATOR_LINEAR_RANGE(_min_uV, _min_sel, _max_sel, _step_uV)   \
  54         LINEAR_RANGE(_min_uV, _min_sel, _max_sel, _step_uV)
  55
  56 /**
  57  * struct regulator_ops - regulator operations.
  58  *
  59  * @enable: Configure the regulator as enabled.
  60  * @disable: Configure the regulator as disabled.
  61  * @is_enabled: Return 1 if the regulator is enabled, 0 if not.
  62  *              May also return negative errno.
  63  *
  64  * @set_voltage: Set the voltage for the regulator within the range specified.
  65  *               The driver should select the voltage closest to min_uV.
  66  * @set_voltage_sel: Set the voltage for the regulator using the specified
  67  *                   selector.
  68  * @map_voltage: Convert a voltage into a selector
  69  * @get_voltage: Return the currently configured voltage for the regulator;
  70  *                   return -ENOTRECOVERABLE if regulator can't be read at
  71  *                   bootup and hasn't been set yet.
  72  * @get_voltage_sel: Return the currently configured voltage selector for the
  73  *                   regulator; return -ENOTRECOVERABLE if regulator can't
  74  *                   be read at bootup and hasn't been set yet.
  75  * @list_voltage: Return one of the supported voltages, in microvolts; zero
  76  *      if the selector indicates a voltage that is unusable on this system;
  77  *      or negative errno.  Selectors range from zero to one less than
  78  *      regulator_desc.n_voltages.  Voltages may be reported in any order.
  79  *
  80  * @set_current_limit: Configure a limit for a current-limited regulator.
  81  *                     The driver should select the current closest to max_uA.
  82  * @get_current_limit: Get the configured limit for a current-limited regulator.
  83  * @set_input_current_limit: Configure an input limit.
  84  *
  85  * @set_over_current_protection: Support enabling of and setting limits for over
  86  *      current situation detection. Detection can be configured for three
  87  *      levels of severity.
  88  *
  89  *      - REGULATOR_SEVERITY_PROT should automatically shut down the regulator(s).
  90  *
  91  *      - REGULATOR_SEVERITY_ERR should indicate that over-current situation is
  92  *                caused by an unrecoverable error but HW does not perform
  93  *                automatic shut down.
  94  *
  95  *      - REGULATOR_SEVERITY_WARN should indicate situation where hardware is
  96  *                still believed to not be damaged but that a board sepcific
  97  *                recovery action is needed. If lim_uA is 0 the limit should not
  98  *                be changed but the detection should just be enabled/disabled as
  99  *                is requested.
 100  *
 101  * @set_over_voltage_protection: Support enabling of and setting limits for over
 102  *      voltage situation detection. Detection can be configured for same
 103  *      severities as over current protection. Units of uV.
 104  * @set_under_voltage_protection: Support enabling of and setting limits for
 105  *      under voltage situation detection. Detection can be configured for same
 106  *      severities as over current protection. Units of uV.
 107  * @set_thermal_protection: Support enabling of and setting limits for over
 108  *      temperature situation detection.Detection can be configured for same
 109  *      severities as over current protection. Units of degree Kelvin.
 110  *
 111  * @set_active_discharge: Set active discharge enable/disable of regulators.
 112  *
 113  * @set_mode: Set the configured operating mode for the regulator.
 114  * @get_mode: Get the configured operating mode for the regulator.
 115  * @get_error_flags: Get the current error(s) for the regulator.
 116  * @get_status: Return actual (not as-configured) status of regulator, as a
 117  *      REGULATOR_STATUS value (or negative errno)
 118  * @get_optimum_mode: Get the most efficient operating mode for the regulator
 119  *                    when running with the specified parameters.
 120  * @set_load: Set the load for the regulator.
 121  *
 122  * @set_bypass: Set the regulator in bypass mode.
 123  * @get_bypass: Get the regulator bypass mode state.
 124  *
 125  * @enable_time: Time taken for the regulator voltage output voltage to
 126  *               stabilise after being enabled, in microseconds.
 127  * @set_ramp_delay: Set the ramp delay for the regulator. The driver should
 128  *              select ramp delay equal to or less than(closest) ramp_delay.
 129  * @set_voltage_time: Time taken for the regulator voltage output voltage
 130  *               to stabilise after being set to a new value, in microseconds.
 131  *               The function receives the from and to voltage as input, it
 132  *               should return the worst case.
 133  * @set_voltage_time_sel: Time taken for the regulator voltage output voltage
 134  *               to stabilise after being set to a new value, in microseconds.
 135  *               The function receives the from and to voltage selector as
 136  *               input, it should return the worst case.
 137  * @set_soft_start: Enable soft start for the regulator.
 138  *
 139  * @set_suspend_voltage: Set the voltage for the regulator when the system
 140  *                       is suspended.
 141  * @set_suspend_enable: Mark the regulator as enabled when the system is
 142  *                      suspended.
 143  * @set_suspend_disable: Mark the regulator as disabled when the system is
 144  *                       suspended.
 145  * @set_suspend_mode: Set the operating mode for the regulator when the
 146  *                    system is suspended.
 147  * @resume: Resume operation of suspended regulator.
 148  * @set_pull_down: Configure the regulator to pull down when the regulator
 149  *                 is disabled.
 150  *
 151  * This struct describes regulator operations which can be implemented by
 152  * regulator chip drivers.
 153  */
 154 struct regulator_ops {
 155
 156         /* enumerate supported voltages */
 157         int (*list_voltage) (struct regulator_dev *, unsigned selector);
 158
 159         /* get/set regulator voltage */
 160         int (*set_voltage) (struct regulator_dev *, int min_uV, int max_uV,
 161                             unsigned *selector);
 162         int (*map_voltage)(struct regulator_dev *, int min_uV, int max_uV);
 163         int (*set_voltage_sel) (struct regulator_dev *, unsigned selector);
 164         int (*get_voltage) (struct regulator_dev *);
 165         int (*get_voltage_sel) (struct regulator_dev *);
 166
 167         /* get/set regulator current  */
 168         int (*set_current_limit) (struct regulator_dev *,
 169                                  int min_uA, int max_uA);
 170         int (*get_current_limit) (struct regulator_dev *);
 171
 172         int (*set_input_current_limit) (struct regulator_dev *, int lim_uA);
 173         int (*set_over_current_protection)(struct regulator_dev *, int lim_uA,
 174                                            int severity, bool enable);
 175         int (*set_over_voltage_protection)(struct regulator_dev *, int lim_uV,
 176                                            int severity, bool enable);
 177         int (*set_under_voltage_protection)(struct regulator_dev *, int lim_uV,
 178                                             int severity, bool enable);
 179         int (*set_thermal_protection)(struct regulator_dev *, int lim,
 180                                       int severity, bool enable);
 181         int (*set_active_discharge)(struct regulator_dev *, bool enable);
 182
 183         /* enable/disable regulator */
 184         int (*enable) (struct regulator_dev *);
 185         int (*disable) (struct regulator_dev *);
 186         int (*is_enabled) (struct regulator_dev *);
 187
 188         /* get/set regulator operating mode (defined in consumer.h) */
 189         int (*set_mode) (struct regulator_dev *, unsigned int mode);
 190         unsigned int (*get_mode) (struct regulator_dev *);
 191
 192         /* retrieve current error flags on the regulator */
 193         int (*get_error_flags)(struct regulator_dev *, unsigned int *flags);
 194
 195         /* Time taken to enable or set voltage on the regulator */
 196         int (*enable_time) (struct regulator_dev *);
 197         int (*set_ramp_delay) (struct regulator_dev *, int ramp_delay);
 198         int (*set_voltage_time) (struct regulator_dev *, int old_uV,
 199                                  int new_uV);
 200         int (*set_voltage_time_sel) (struct regulator_dev *,
 201                                      unsigned int old_selector,
 202                                      unsigned int new_selector);
 203
 204         int (*set_soft_start) (struct regulator_dev *);
 205
 206         /* report regulator status ... most other accessors report
 207          * control inputs, this reports results of combining inputs
 208          * from Linux (and other sources) with the actual load.
 209          * returns REGULATOR_STATUS_* or negative errno.
 210          */
 211         int (*get_status)(struct regulator_dev *);
 212
 213         /* get most efficient regulator operating mode for load */
 214         unsigned int (*get_optimum_mode) (struct regulator_dev *, int input_uV,
 215                                           int output_uV, int load_uA);
 216         /* set the load on the regulator */
 217         int (*set_load)(struct regulator_dev *, int load_uA);
 218
 219         /* control and report on bypass mode */
 220         int (*set_bypass)(struct regulator_dev *dev, bool enable);
 221         int (*get_bypass)(struct regulator_dev *dev, bool *enable);
 222
 223         /* the operations below are for configuration of regulator state when
 224          * its parent PMIC enters a global STANDBY/HIBERNATE state */
 225
 226         /* set regulator suspend voltage */
 227         int (*set_suspend_voltage) (struct regulator_dev *, int uV);
 228
 229         /* enable/disable regulator in suspend state */
 230         int (*set_suspend_enable) (struct regulator_dev *);
 231         int (*set_suspend_disable) (struct regulator_dev *);
 232
 233         /* set regulator suspend operating mode (defined in consumer.h) */
 234         int (*set_suspend_mode) (struct regulator_dev *, unsigned int mode);
 235
 236         int (*resume)(struct regulator_dev *rdev);
 237
 238         int (*set_pull_down) (struct regulator_dev *);
 239 };
 240
 241 /*
 242  * Regulators can either control voltage or current.
 243  */
 244 enum regulator_type {
 245         REGULATOR_VOLTAGE,
 246         REGULATOR_CURRENT,
 247 };
 248
 249 /**
 250  * struct regulator_desc - Static regulator descriptor
 251  *
 252  * Each regulator registered with the core is described with a
 253  * structure of this type and a struct regulator_config.  This
 254  * structure contains the non-varying parts of the regulator
 255  * description.
 256  *
 257  * @name: Identifying name for the regulator.
 258  * @supply_name: Identifying the regulator supply
 259  * @of_match: Name used to identify regulator in DT.
 260  * @of_match_full_name: A flag to indicate that the of_match string, if
 261  *                      present, should be matched against the node full_name.
 262  * @regulators_node: Name of node containing regulator definitions in DT.
 263  * @of_parse_cb: Optional callback called only if of_match is present.
 264  *               Will be called for each regulator parsed from DT, during
 265  *               init_data parsing.
 266  *               The regulator_config passed as argument to the callback will
 267  *               be a copy of config passed to regulator_register, valid only
 268  *               for this particular call. Callback may freely change the
 269  *               config but it cannot store it for later usage.
 270  *               Callback should return 0 on success or negative ERRNO
 271  *               indicating failure.
 272  * @init_cb: Optional callback called after the parsing of init_data.
 273  *           Allows the regulator to perform runtime init if necessary,
 274  *           such as synching the regulator and the parsed constraints.
 275  *           Callback should return 0 on success or negative ERRNO
 276  *           indicating failure.
 277  * @id: Numerical identifier for the regulator.
 278  * @ops: Regulator operations table.
 279  * @irq: Interrupt number for the regulator.
 280  * @type: Indicates if the regulator is a voltage or current regulator.
 281  * @owner: Module providing the regulator, used for refcounting.
 282  *
 283  * @continuous_voltage_range: Indicates if the regulator can set any
 284  *                            voltage within constrains range.
 285  * @n_voltages: Number of selectors available for ops.list_voltage().
 286  * @n_current_limits: Number of selectors available for current limits
 287  *
 288  * @min_uV: Voltage given by the lowest selector (if linear mapping)
 289  * @uV_step: Voltage increase with each selector (if linear mapping)
 290  * @linear_min_sel: Minimal selector for starting linear mapping
 291  * @fixed_uV: Fixed voltage of rails.
 292  * @ramp_delay: Time to settle down after voltage change (unit: uV/us)
 293  * @min_dropout_uV: The minimum dropout voltage this regulator can handle
 294  * @linear_ranges: A constant table of possible voltage ranges.
 295  * @linear_range_selectors_bitfield: A constant table of voltage range
 296  *                                   selectors as bitfield values. If
 297  *                                   pickable ranges are used each range
 298  *                                   must have corresponding selector here.
 299  * @n_linear_ranges: Number of entries in the @linear_ranges (and in
 300  *                   linear_range_selectors_bitfield if used) table(s).
 301  * @volt_table: Voltage mapping table (if table based mapping)
 302  * @curr_table: Current limit mapping table (if table based mapping)
 303  *
 304  * @vsel_range_reg: Register for range selector when using pickable ranges
 305  *                  and ``regulator_map_*_voltage_*_pickable`` functions.
 306  * @vsel_range_mask: Mask for register bitfield used for range selector
 307  * @range_applied_by_vsel: A flag to indicate that changes to vsel_range_reg
 308  *                         are only effective after vsel_reg is written
 309  * @vsel_reg: Register for selector when using ``regulator_map_*_voltage_*``
 310  * @vsel_mask: Mask for register bitfield used for selector
 311  * @vsel_step: Specify the resolution of selector stepping when setting
 312  *             voltage. If 0, then no stepping is done (requested selector is
 313  *             set directly), if >0 then the regulator API will ramp the
 314  *             voltage up/down gradually each time increasing/decreasing the
 315  *             selector by the specified step value.
 316  * @csel_reg: Register for current limit selector using regmap set_current_limit
 317  * @csel_mask: Mask for register bitfield used for current limit selector
 318  * @apply_reg: Register for initiate voltage change on the output when
 319  *                using regulator_set_voltage_sel_regmap
 320  * @apply_bit: Register bitfield used for initiate voltage change on the
 321  *                output when using regulator_set_voltage_sel_regmap
 322  * @enable_reg: Register for control when using regmap enable/disable ops
 323  * @enable_mask: Mask for control when using regmap enable/disable ops
 324  * @enable_val: Enabling value for control when using regmap enable/disable ops
 325  * @disable_val: Disabling value for control when using regmap enable/disable ops
 326  * @enable_is_inverted: A flag to indicate set enable_mask bits to disable
 327  *                      when using regulator_enable_regmap and friends APIs.
 328  * @bypass_reg: Register for control when using regmap set_bypass
 329  * @bypass_mask: Mask for control when using regmap set_bypass
 330  * @bypass_val_on: Enabling value for control when using regmap set_bypass
 331  * @bypass_val_off: Disabling value for control when using regmap set_bypass
 332  * @active_discharge_off: Enabling value for control when using regmap
 333  *                        set_active_discharge
 334  * @active_discharge_on: Disabling value for control when using regmap
 335  *                       set_active_discharge
 336  * @active_discharge_mask: Mask for control when using regmap
 337  *                         set_active_discharge
 338  * @active_discharge_reg: Register for control when using regmap
 339  *                        set_active_discharge
 340  * @soft_start_reg: Register for control when using regmap set_soft_start
 341  * @soft_start_mask: Mask for control when using regmap set_soft_start
 342  * @soft_start_val_on: Enabling value for control when using regmap
 343  *                     set_soft_start
 344  * @pull_down_reg: Register for control when using regmap set_pull_down
 345  * @pull_down_mask: Mask for control when using regmap set_pull_down
 346  * @pull_down_val_on: Enabling value for control when using regmap
 347  *                     set_pull_down
 348  *
 349  * @ramp_reg:           Register for controlling the regulator ramp-rate.
 350  * @ramp_mask:          Bitmask for the ramp-rate control register.
 351  * @ramp_delay_table:   Table for mapping the regulator ramp-rate values. Values
 352  *                      should be given in units of V/S (uV/uS). See the
 353  *                      regulator_set_ramp_delay_regmap().
 354  * @n_ramp_values:      number of elements at @ramp_delay_table.
 355  *
 356  * @enable_time: Time taken for initial enable of regulator (in uS).
 357  * @off_on_delay: guard time (in uS), before re-enabling a regulator
 358  *
 359  * @poll_enabled_time: The polling interval (in uS) to use while checking that
 360  *                     the regulator was actually enabled. Max upto enable_time.
 361  *
 362  * @of_map_mode: Maps a hardware mode defined in a DeviceTree to a standard mode
 363  */
 364 struct regulator_desc {
 365         const char *name;
 366         const char *supply_name;
 367         const char *of_match;
 368         bool of_match_full_name;
 369         const char *regulators_node;
 370         int (*of_parse_cb)(struct device_node *,
 371                             const struct regulator_desc *,
 372                             struct regulator_config *);
 373         int (*init_cb)(struct regulator_dev *,
 374                        struct regulator_config *);
 375         int id;
 376         unsigned int continuous_voltage_range:1;
 377         unsigned n_voltages;
 378         unsigned int n_current_limits;
 379         const struct regulator_ops *ops;
 380         int irq;
 381         enum regulator_type type;
 382         struct module *owner;
 383
 384         unsigned int min_uV;
 385         unsigned int uV_step;
 386         unsigned int linear_min_sel;
 387         int fixed_uV;
 388         unsigned int ramp_delay;
 389         int min_dropout_uV;
 390
 391         const struct linear_range *linear_ranges;
 392         const unsigned int *linear_range_selectors_bitfield;
 393
 394         int n_linear_ranges;
 395
 396         const unsigned int *volt_table;
 397         const unsigned int *curr_table;
 398
 399         unsigned int vsel_range_reg;
 400         unsigned int vsel_range_mask;
 401         bool range_applied_by_vsel;
 402         unsigned int vsel_reg;
 403         unsigned int vsel_mask;
 404         unsigned int vsel_step;
 405         unsigned int csel_reg;
 406         unsigned int csel_mask;
 407         unsigned int apply_reg;
 408         unsigned int apply_bit;
 409         unsigned int enable_reg;
 410         unsigned int enable_mask;
 411         unsigned int enable_val;
 412         unsigned int disable_val;
 413         bool enable_is_inverted;
 414         unsigned int bypass_reg;
 415         unsigned int bypass_mask;
 416         unsigned int bypass_val_on;
 417         unsigned int bypass_val_off;
 418         unsigned int active_discharge_on;
 419         unsigned int active_discharge_off;
 420         unsigned int active_discharge_mask;
 421         unsigned int active_discharge_reg;
 422         unsigned int soft_start_reg;
 423         unsigned int soft_start_mask;
 424         unsigned int soft_start_val_on;
 425         unsigned int pull_down_reg;
 426         unsigned int pull_down_mask;
 427         unsigned int pull_down_val_on;
 428         unsigned int ramp_reg;
 429         unsigned int ramp_mask;
 430         const unsigned int *ramp_delay_table;
 431         unsigned int n_ramp_values;
 432
 433         unsigned int enable_time;
 434
 435         unsigned int off_on_delay;
 436
 437         unsigned int poll_enabled_time;
 438
 439         unsigned int (*of_map_mode)(unsigned int mode);
 440 };
 441
 442 /**
 443  * struct regulator_config - Dynamic regulator descriptor
 444  *
 445  * Each regulator registered with the core is described with a
 446  * structure of this type and a struct regulator_desc.  This structure
 447  * contains the runtime variable parts of the regulator description.
 448  *
 449  * @dev: struct device for the regulator
 450  * @init_data: platform provided init data, passed through by driver
 451  * @driver_data: private regulator data
 452  * @of_node: OpenFirmware node to parse for device tree bindings (may be
 453  *           NULL).
 454  * @regmap: regmap to use for core regmap helpers if dev_get_regmap() is
 455  *          insufficient.
 456  * @ena_gpiod: GPIO controlling regulator enable.
 457  */
 458 struct regulator_config {
 459         struct device *dev;
 460         const struct regulator_init_data *init_data;
 461         void *driver_data;
 462         struct device_node *of_node;
 463         struct regmap *regmap;
 464
 465         struct gpio_desc *ena_gpiod;
 466 };
 467
 468 /**
 469  * struct regulator_err_state - regulator error/notification status
 470  *
 471  * @rdev:               Regulator which status the struct indicates.
 472  * @notifs:             Events which have occurred on the regulator.
 473  * @errors:             Errors which are active on the regulator.
 474  * @possible_errs:      Errors which can be signaled (by given IRQ).
 475  */
 476 struct regulator_err_state {
 477         struct regulator_dev *rdev;
 478         unsigned long notifs;
 479         unsigned long errors;
 480         int possible_errs;
 481 };
 482
 483 /**
 484  * struct regulator_irq_data - regulator error/notification status data
 485  *
 486  * @states:     Status structs for each of the associated regulators.
 487  * @num_states: Amount of associated regulators.
 488  * @data:       Driver data pointer given at regulator_irq_desc.
 489  * @opaque:     Value storage for IC driver. Core does not update this. ICs
 490  *              may want to store status register value here at map_event and
 491  *              compare contents at 'renable' callback to see if new problems
 492  *              have been added to status. If that is the case it may be
 493  *              desirable to return REGULATOR_ERROR_CLEARED and not
 494  *              REGULATOR_ERROR_ON to allow IRQ fire again and to generate
 495  *              notifications also for the new issues.
 496  *
 497  * This structure is passed to 'map_event' and 'renable' callbacks for
 498  * reporting regulator status to core.
 499  */
 500 struct regulator_irq_data {
 501         struct regulator_err_state *states;
 502         int num_states;
 503         void *data;
 504         long opaque;
 505 };
 506
 507 /**
 508  * struct regulator_irq_desc - notification sender for IRQ based events.
 509  *
 510  * @name:       The visible name for the IRQ
 511  * @fatal_cnt:  If this IRQ is used to signal HW damaging condition it may be
 512  *              best to shut-down regulator(s) or reboot the SOC if error
 513  *              handling is repeatedly failing. If fatal_cnt is given the IRQ
 514  *              handling is aborted if it fails for fatal_cnt times and die()
 515  *              callback (if populated) is called. If die() is not populated
 516  *              poweroff for the system is attempted in order to prevent any
 517  *              further damage.
 518  * @reread_ms:  The time which is waited before attempting to re-read status
 519  *              at the worker if IC reading fails. Immediate re-read is done
 520  *              if time is not specified.
 521  * @irq_off_ms: The time which IRQ is kept disabled before re-evaluating the
 522  *              status for devices which keep IRQ disabled for duration of the
 523  *              error. If this is not given the IRQ is left enabled and renable
 524  *              is not called.
 525  * @skip_off:   If set to true the IRQ handler will attempt to check if any of
 526  *              the associated regulators are enabled prior to taking other
 527  *              actions. If no regulators are enabled and this is set to true
 528  *              a spurious IRQ is assumed and IRQ_NONE is returned.
 529  * @high_prio:  Boolean to indicate that high priority WQ should be used.
 530  * @data:       Driver private data pointer which will be passed as such to
 531  *              the renable, map_event and die callbacks in regulator_irq_data.
 532  * @die:        Protection callback. If IC status reading or recovery actions
 533  *              fail fatal_cnt times this callback is called or system is
 534  *              powered off. This callback should implement a final protection
 535  *              attempt like disabling the regulator. If protection succeeded
 536  *              die() may return 0. If anything else is returned the core
 537  *              assumes final protection failed and attempts to perform a
 538  *              poweroff as a last resort.
 539  * @map_event:  Driver callback to map IRQ status into regulator devices with
 540  *              events / errors. NOTE: callback MUST initialize both the
 541  *              errors and notifs for all rdevs which it signals having
 542  *              active events as core does not clean the map data.
 543  *              REGULATOR_FAILED_RETRY can be returned to indicate that the
 544  *              status reading from IC failed. If this is repeated for
 545  *              fatal_cnt times the core will call die() callback or power-off
 546  *              the system as a last resort to protect the HW.
 547  * @renable:    Optional callback to check status (if HW supports that) before
 548  *              re-enabling IRQ. If implemented this should clear the error
 549  *              flags so that errors fetched by regulator_get_error_flags()
 550  *              are updated. If callback is not implemented then errors are
 551  *              assumed to be cleared and IRQ is re-enabled.
 552  *              REGULATOR_FAILED_RETRY can be returned to
 553  *              indicate that the status reading from IC failed. If this is
 554  *              repeated for 'fatal_cnt' times the core will call die()
 555  *              callback or if die() is not populated then attempt to power-off
 556  *              the system as a last resort to protect the HW.
 557  *              Returning zero indicates that the problem in HW has been solved
 558  *              and IRQ will be re-enabled. Returning REGULATOR_ERROR_ON
 559  *              indicates the error condition is still active and keeps IRQ
 560  *              disabled. Please note that returning REGULATOR_ERROR_ON does
 561  *              not retrigger evaluating what events are active or resending
 562  *              notifications. If this is needed you probably want to return
 563  *              zero and allow IRQ to retrigger causing events to be
 564  *              re-evaluated and re-sent.
 565  *
 566  * This structure is used for registering regulator IRQ notification helper.
 567  */
 568 struct regulator_irq_desc {
 569         const char *name;
 570         int fatal_cnt;
 571         int reread_ms;
 572         int irq_off_ms;
 573         bool skip_off;
 574         bool high_prio;
 575         void *data;
 576
 577         int (*die)(struct regulator_irq_data *rid);
 578         int (*map_event)(int irq, struct regulator_irq_data *rid,
 579                           unsigned long *dev_mask);
 580         int (*renable)(struct regulator_irq_data *rid);
 581 };
 582
 583 /*
 584  * Return values for regulator IRQ helpers.
 585  */
 586 enum {
 587         REGULATOR_ERROR_CLEARED,
 588         REGULATOR_FAILED_RETRY,
 589         REGULATOR_ERROR_ON,
 590 };
 591
 592 /*
 593  * struct coupling_desc
 594  *
 595  * Describes coupling of regulators. Each regulator should have
 596  * at least a pointer to itself in coupled_rdevs array.
 597  * When a new coupled regulator is resolved, n_resolved is
 598  * incremented.
 599  */
 600 struct coupling_desc {
 601         struct regulator_dev **coupled_rdevs;
 602         struct regulator_coupler *coupler;
 603         int n_resolved;
 604         int n_coupled;
 605 };
 606
 607 /*
 608  * struct regulator_dev
 609  *
 610  * Voltage / Current regulator class device. One for each
 611  * regulator.
 612  *
 613  * This should *not* be used directly by anything except the regulator
 614  * core and notification injection (which should take the mutex and do
 615  * no other direct access).
 616  */
 617 struct regulator_dev {
 618         const struct regulator_desc *desc;
 619         int exclusive;
 620         u32 use_count;
 621         u32 open_count;
 622         u32 bypass_count;
 623
 624         /* lists we belong to */
 625         struct list_head list; /* list of all regulators */
 626
 627         /* lists we own */
 628         struct list_head consumer_list; /* consumers we supply */
 629
 630         struct coupling_desc coupling_desc;
 631
 632         struct blocking_notifier_head notifier;
 633         struct ww_mutex mutex; /* consumer lock */
 634         struct task_struct *mutex_owner;
 635         int ref_cnt;
 636         struct module *owner;
 637         struct device dev;
 638         struct regulation_constraints *constraints;
 639         struct regulator *supply;       /* for tree */
 640         const char *supply_name;
 641         struct regmap *regmap;
 642
 643         struct delayed_work disable_work;
 644
 645         void *reg_data;         /* regulator_dev data */
 646
 647         struct dentry *debugfs;
 648
 649         struct regulator_enable_gpio *ena_pin;
 650         unsigned int ena_gpio_state:1;
 651
 652         unsigned int is_switch:1;
 653
 654         /* time when this regulator was disabled last time */
 655         ktime_t last_off;
 656         int cached_err;
 657         bool use_cached_err;
 658         spinlock_t err_lock;
 659 };
 660
 661 /*
 662  * Convert error flags to corresponding notifications.
 663  *
 664  * Can be used by drivers which use the notification helpers to
 665  * find out correct notification flags based on the error flags. Drivers
 666  * can avoid storing both supported notification and error flags which
 667  * may save few bytes.
 668  */
 669 static inline int regulator_err2notif(int err)
 670 {
 671         switch (err) {
 672         case REGULATOR_ERROR_UNDER_VOLTAGE:
 673                 return REGULATOR_EVENT_UNDER_VOLTAGE;
 674         case REGULATOR_ERROR_OVER_CURRENT:
 675                 return REGULATOR_EVENT_OVER_CURRENT;
 676         case REGULATOR_ERROR_REGULATION_OUT:
 677                 return REGULATOR_EVENT_REGULATION_OUT;
 678         case REGULATOR_ERROR_FAIL:
 679                 return REGULATOR_EVENT_FAIL;
 680         case REGULATOR_ERROR_OVER_TEMP:
 681                 return REGULATOR_EVENT_OVER_TEMP;
 682         case REGULATOR_ERROR_UNDER_VOLTAGE_WARN:
 683                 return REGULATOR_EVENT_UNDER_VOLTAGE_WARN;
 684         case REGULATOR_ERROR_OVER_CURRENT_WARN:
 685                 return REGULATOR_EVENT_OVER_CURRENT_WARN;
 686         case REGULATOR_ERROR_OVER_VOLTAGE_WARN:
 687                 return REGULATOR_EVENT_OVER_VOLTAGE_WARN;
 688         case REGULATOR_ERROR_OVER_TEMP_WARN:
 689                 return REGULATOR_EVENT_OVER_TEMP_WARN;
 690         }
 691         return 0;
 692 }
 693
 694
 695 struct regulator_dev *
 696 regulator_register(struct device *dev,
 697                    const struct regulator_desc *regulator_desc,
 698                    const struct regulator_config *config);
 699 struct regulator_dev *
 700 devm_regulator_register(struct device *dev,
 701                         const struct regulator_desc *regulator_desc,
 702                         const struct regulator_config *config);
 703 void regulator_unregister(struct regulator_dev *rdev);
 704
 705 int regulator_notifier_call_chain(struct regulator_dev *rdev,
 706                                   unsigned long event, void *data);
 707 void *devm_regulator_irq_helper(struct device *dev,
 708                                 const struct regulator_irq_desc *d, int irq,
 709                                 int irq_flags, int common_errs,
 710                                 int *per_rdev_errs, struct regulator_dev **rdev,
 711                                 int rdev_amount);
 712 void *regulator_irq_helper(struct device *dev,
 713                            const struct regulator_irq_desc *d, int irq,
 714                            int irq_flags, int common_errs, int *per_rdev_errs,
 715                            struct regulator_dev **rdev, int rdev_amount);
 716 void regulator_irq_helper_cancel(void **handle);
 717 int regulator_irq_map_event_simple(int irq, struct regulator_irq_data *rid,
 718                                    unsigned long *dev_mask);
 719
 720 void *rdev_get_drvdata(struct regulator_dev *rdev);
 721 struct device *rdev_get_dev(struct regulator_dev *rdev);
 722 struct regmap *rdev_get_regmap(struct regulator_dev *rdev);
 723 int rdev_get_id(struct regulator_dev *rdev);
 724
 725 int regulator_mode_to_status(unsigned int);
 726
 727 int regulator_list_voltage_linear(struct regulator_dev *rdev,
 728                                   unsigned int selector);
 729 int regulator_list_voltage_pickable_linear_range(struct regulator_dev *rdev,
 730                                                    unsigned int selector);
 731 int regulator_list_voltage_linear_range(struct regulator_dev *rdev,
 732                                         unsigned int selector);
 733 int regulator_list_voltage_table(struct regulator_dev *rdev,
 734                                   unsigned int selector);
 735 int regulator_map_voltage_linear(struct regulator_dev *rdev,
 736                                   int min_uV, int max_uV);
 737 int regulator_map_voltage_pickable_linear_range(struct regulator_dev *rdev,
 738                                                   int min_uV, int max_uV);
 739 int regulator_map_voltage_linear_range(struct regulator_dev *rdev,
 740                                        int min_uV, int max_uV);
 741 int regulator_map_voltage_iterate(struct regulator_dev *rdev,
 742                                   int min_uV, int max_uV);
 743 int regulator_map_voltage_ascend(struct regulator_dev *rdev,
 744                                   int min_uV, int max_uV);
 745 int regulator_get_voltage_sel_pickable_regmap(struct regulator_dev *rdev);
 746 int regulator_set_voltage_sel_pickable_regmap(struct regulator_dev *rdev,
 747                                                 unsigned int sel);
 748 int regulator_get_voltage_sel_regmap(struct regulator_dev *rdev);
 749 int regulator_set_voltage_sel_regmap(struct regulator_dev *rdev, unsigned sel);
 750 int regulator_is_enabled_regmap(struct regulator_dev *rdev);
 751 int regulator_enable_regmap(struct regulator_dev *rdev);
 752 int regulator_disable_regmap(struct regulator_dev *rdev);
 753 int regulator_set_voltage_time_sel(struct regulator_dev *rdev,
 754                                    unsigned int old_selector,
 755                                    unsigned int new_selector);
 756 int regulator_set_bypass_regmap(struct regulator_dev *rdev, bool enable);
 757 int regulator_get_bypass_regmap(struct regulator_dev *rdev, bool *enable);
 758 int regulator_set_soft_start_regmap(struct regulator_dev *rdev);
 759 int regulator_set_pull_down_regmap(struct regulator_dev *rdev);
 760
 761 int regulator_set_active_discharge_regmap(struct regulator_dev *rdev,
 762                                           bool enable);
 763 int regulator_set_current_limit_regmap(struct regulator_dev *rdev,
 764                                        int min_uA, int max_uA);
 765 int regulator_get_current_limit_regmap(struct regulator_dev *rdev);
 766 void *regulator_get_init_drvdata(struct regulator_init_data *reg_init_data);
 767 int regulator_find_closest_bigger(unsigned int target, const unsigned int *table,
 768                                   unsigned int num_sel, unsigned int *sel);
 769 int regulator_set_ramp_delay_regmap(struct regulator_dev *rdev, int ramp_delay);
 770 int regulator_sync_voltage_rdev(struct regulator_dev *rdev);
 771
 772 /*
 773  * Helper functions intended to be used by regulator drivers prior registering
 774  * their regulators.
 775  */
 776 int regulator_desc_list_voltage_linear_range(const struct regulator_desc *desc,
 777                                              unsigned int selector);
 778
 779 int regulator_desc_list_voltage_linear(const struct regulator_desc *desc,
 780                                        unsigned int selector);
 781
 782 #ifdef CONFIG_REGULATOR
 783 const char *rdev_get_name(struct regulator_dev *rdev);
 784 #else
 785 static inline const char *rdev_get_name(struct regulator_dev *rdev)
 786 {
 787         return NULL;
 788 }
 789 #endif
 790
 791 #endif