linux/regulator/driver.h

1 /* SPDX-License-Identifier: GPL-2.0-only */
3  * driver.h -- SoC Regulator driver support.
57  * struct regulator_ops - regulator operations.
64  * @set_voltage: Set the voltage for the regulator within the range specified.
70  *                   return -ENOTRECOVERABLE if regulator can't be read at
73  *                   regulator; return -ENOTRECOVERABLE if regulator can't
75  * @list_voltage: Return one of the supported voltages, in microvolts; zero
77  *	or negative errno.  Selectors range from zero to one less than
80  * @set_current_limit: Configure a limit for a current-limited regulator.
82  * @get_current_limit: Get the configured limit for a current-limited regulator.
89  *	- REGULATOR_SEVERITY_PROT should automatically shut down the regulator(s).
91  *	- REGULATOR_SEVERITY_ERR should indicate that over-current situation is
95  *	- REGULATOR_SEVERITY_WARN should indicate situation where hardware is
116  * @get_status: Return actual (not as-configured) status of regulator, as a
125  * @enable_time: Time taken for the regulator voltage output voltage to
129  * @set_voltage_time: Time taken for the regulator voltage output voltage
133  * @set_voltage_time_sel: Time taken for the regulator voltage output voltage
250  * struct regulator_desc - Static regulator descriptor
254  * structure contains the non-varying parts of the regulator
279  *                            voltage within constrains range.
290  * @linear_range_selectors_bitfield: A constant table of voltage range
292  *                                   pickable ranges are used each range
299  * @vsel_range_reg: Register for range selector when using pickable ranges
301  * @vsel_range_mask: Mask for register bitfield used for range selector
313  * @apply_reg: Register for initiate voltage change on the output when
316  *                output when using regulator_set_voltage_sel_regmap
344  * @ramp_reg:		Register for controlling the regulator ramp-rate.
345  * @ramp_mask:		Bitmask for the ramp-rate control register.
346  * @ramp_delay_table:	Table for mapping the regulator ramp-rate values. Values
352  * @off_on_delay: guard time (in uS), before re-enabling a regulator
436  * struct regulator_config - Dynamic regulator descriptor
462  * struct regulator_err_state - regulator error/notification status
477  * struct regulator_irq_data - regulator error/notification status data
501  * struct regulator_irq_desc - notification sender for IRQ based events.
505  *		best to shut-down regulator(s) or reboot the SOC if error
511  * @reread_ms:	The time which is waited before attempting to re-read status
512  *		at the worker if IC reading fails. Immediate re-read is done
514  * @irq_off_ms:	The time which IRQ is kept disabled before re-evaluating the
538  *		fatal_cnt times the core will call die() callback or power-off
541  *		re-enabling IRQ. If implemented this should clear the error
544  *		assumed to be cleared and IRQ is re-enabled.
548  *		callback or if die() is not populated then attempt to power-off
551  *		and IRQ will be re-enabled. Returning REGULATOR_ERROR_ON
557  *		re-evaluated and re-sent.