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.
70  *                   return -ENOTRECOVERABLE if regulator can't be read at
73  *                   regulator; return -ENOTRECOVERABLE if regulator can't
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
113  * @set_mode: Set the configured operating mode for the regulator.
114  * @get_mode: Get the configured operating mode for the regulator.
116  * @get_status: Return actual (not as-configured) status of regulator, as a
118  * @get_optimum_mode: Get the most efficient operating mode for the regulator
122  * @set_bypass: Set the regulator in bypass mode.
123  * @get_bypass: Get the regulator bypass mode state.
145  * @set_suspend_mode: Set the operating mode for the regulator when the
188 	/* get/set regulator operating mode (defined in consumer.h) */
189 	int (*set_mode) (struct regulator_dev *, unsigned int mode);
213 	/* get most efficient regulator operating mode for load */
219 	/* control and report on bypass mode */
233 	/* set regulator suspend operating mode (defined in consumer.h) */
234 	int (*set_suspend_mode) (struct regulator_dev *, unsigned int mode);
250  * struct regulator_desc - Static regulator descriptor
254  * structure contains the non-varying parts of the regulator
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
301  * @volt_table: Voltage mapping table (if table based mapping)
302  * @curr_table: Current limit mapping table (if table based mapping)
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
357  * @off_on_delay: guard time (in uS), before re-enabling a regulator
362  * @of_map_mode: Maps a hardware mode defined in a DeviceTree to a standard mode
439 	unsigned int (*of_map_mode)(unsigned int mode);
443  * struct regulator_config - Dynamic regulator descriptor
469  * struct regulator_err_state - regulator error/notification status
484  * struct regulator_irq_data - regulator error/notification status data
508  * struct regulator_irq_desc - notification sender for IRQ based events.
512  *		best to shut-down regulator(s) or reboot the SOC if error
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
521  * @irq_off_ms:	The time which IRQ is kept disabled before re-evaluating the
545  *		fatal_cnt times the core will call die() callback or power-off
548  *		re-enabling IRQ. If implemented this should clear the error
551  *		assumed to be cleared and IRQ is re-enabled.
555  *		callback or if die() is not populated then attempt to power-off
558  *		and IRQ will be re-enabled. Returning REGULATOR_ERROR_ON
564  *		re-evaluated and re-sent.