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