linux/regulator/machine.h

1 /* SPDX-License-Identifier: GPL-2.0-only */
3  * machine.h -- SoC Regulator support, machine/board driver API.
16 #include <linux/suspend.h>
28  * MODE:     Regulator operating mode can be changed by software on this
31  * DRMS:     Dynamic Regulator Mode Switching is enabled for this regulator.
32  * BYPASS:   Regulator can be put into bypass mode
43  * operations in suspend 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
67  * struct regulator_state - regulator state during low power system states
73  * @uV: Default operating voltage during suspend, it can be adjusted
75  * @min_uV: Minimum suspend voltage may be set.
76  * @max_uV: Maximum suspend voltage may be set.
77  * @mode: Operating mode during suspend.
78  * @enabled: operations during suspend.
79  *	     - DO_NOTHING_IN_SUSPEND
80  *	     - DISABLE_IN_SUSPEND
81  *	     - ENABLE_IN_SUSPEND
88 	unsigned int mode;  member
93 #define REGULATOR_NOTIF_LIMIT_DISABLE -1
94 #define REGULATOR_NOTIF_LIMIT_ENABLE -2
102  * struct regulation_constraints - regulator operating constraints.
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.
151  *                 mode.
152  * @initial_state: Suspend state to set by default.
153  * @initial_mode: Mode to set at startup.
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 */
202 	/* regulator input voltage - only if supply is another regulator */
205 	/* regulator suspend states for global PMIC STANDBY/HIBERNATE */
213 	suspend_state_t initial_state; /* suspend state to set at init */
215 	/* mode to set on startup */
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.