linux/regulator/machine.h

1 /* SPDX-License-Identifier: GPL-2.0-only */
3  * machine.h -- SoC Regulator support, machine/board driver API.
9  * Regulator Machine/Board Interface.
15 #include <linux/regulator/consumer.h>
18 struct regulator;
21  * Regulator operation constraint flags. These flags are used to enable
22  * certain regulator operations and can be OR'ed together.
24  * VOLTAGE:  Regulator output voltage can be changed by software on this
26  * CURRENT:  Regulator output current can be changed by software on this
28  * MODE:     Regulator operating mode can be changed by software on this
30  * STATUS:   Regulator can be enabled and disabled.
31  * DRMS:     Dynamic Regulator Mode Switching is enabled for this regulator.
32  * BYPASS:   Regulator can be put into bypass mode
44  * DO_NOTHING_IN_SUSPEND - the default value
45  * DISABLE_IN_SUSPEND	- turn off regulator in suspend states
46  * ENABLE_IN_SUSPEND	- keep regulator on in suspend states
53  * Default time window (in milliseconds) following a critical under-voltage
59 /* Regulator active discharge flags */
67  * struct regulator_state - regulator state during low power system states
79  *	     - DO_NOTHING_IN_SUSPEND
80  *	     - DISABLE_IN_SUSPEND
81  *	     - ENABLE_IN_SUSPEND
93 #define REGULATOR_NOTIF_LIMIT_DISABLE -1
94 #define REGULATOR_NOTIF_LIMIT_ENABLE -2
102  * struct regulation_constraints - regulator operating constraints.
104  * This struct describes regulator and board/machine specific constraints.
123  * @max_spread: Max possible spread between coupled regulators
124  * @max_uV_step: Max possible step change in voltage
128  * @always_on: Set if the regulator should never be disabled.
129  * @boot_on: Set if the regulator is enabled when the system is initially
130  *           started.  If the regulator is not enabled by the hardware or
136  * @pull_down: Enable pull down when regulator is disabled.
137  * @system_critical: Set if the regulator is critical to system stability or
146  * @input_uV: Input voltage for regulator when supplied by another regulator.
148  * @state_disk: State for regulator when system is suspended in disk mode.
149  * @state_mem: State for regulator when system is suspended in mem mode.
150  * @state_standby: State for regulator when system is suspended in standby
156  *		   change is non-linear (unit: microseconds).
158  *		      change is non-linear (unit: microseconds).
160  *			 voltage change is non-linear (unit: microseconds).
164  * @enable_time: Turn-on time of the rails (unit: microseconds)
166  *                              following a critical under-voltage (UV) event
177 	/* voltage output range (inclusive) - for voltage control */
183 	/* current output range (inclusive) - for current control */
190 	/* used for coupled regulators */
196 	/* valid regulator operating modes for this machine */
199 	/* valid operations for regulator on this machine */
202 	/* regulator input voltage - only if supply is another regulator */
205 	/* regulator suspend states for global PMIC STANDBY/HIBERNATE */
228 	unsigned always_on:1;	/* regulator never off when system is on */
229 	unsigned boot_on:1;	/* bootloader/firmware enabled regulator */
230 	unsigned apply_uV:1;	/* apply uV constraint if min == max */
233 	unsigned pull_down:1;	/* pull down resistor when regulator off */
243  * struct regulator_consumer_supply - supply -> device mapping
253 	const char *supply;	/* consumer supply - e.g. "vcc" */
264  * struct regulator_init_data - regulator platform initialisation data.
268  * @supply_regulator: Parent regulator.  Specified using the regulator name
272  * @constraints: Constraints.  These must be specified for the regulator to
277  * @regulator_init: Callback invoked when the regulator has been registered.
288 	/* optional regulator machine specific init */