[deliverable/linux.git] / include / linux / pinctrl / pinctrl-state.h

/*
 * Standard pin control state definitions
 */

/**
 * @PINCTRL_STATE_DEFAULT: the state the pinctrl handle shall be put
 *	into as default, usually this means the pins are up and ready to
 *	be used by the device driver. This state is commonly used by
 *	hogs to configure muxing and pins at boot, and also as a state
 *	to go into when returning from sleep and idle in
 *	.pm_runtime_resume() or ordinary .resume() for example.
 * @PINCTRL_STATE_INIT: normally the pinctrl will be set to "default"
 *	before the driver's probe() function is called.  There are some
 *	drivers where that is not appropriate becausing doing so would
 *	glitch the pins.  In those cases you can add an "init" pinctrl
 *	which is the state of the pins before drive probe.  After probe
 *	if the pins are still in "init" state they'll be moved to
 *	"default".
 * @PINCTRL_STATE_IDLE: the state the pinctrl handle shall be put into
 *	when the pins are idle. This is a state where the system is relaxed
 *	but not fully sleeping - some power may be on but clocks gated for
 *	example. Could typically be set from a pm_runtime_suspend() or
 *	pm_runtime_idle() operation.
 * @PINCTRL_STATE_SLEEP: the state the pinctrl handle shall be put into
 *	when the pins are sleeping. This is a state where the system is in
 *	its lowest sleep state. Could typically be set from an
 *	ordinary .suspend() function.
 */
#define PINCTRL_STATE_DEFAULT "default"
#define PINCTRL_STATE_INIT "init"
#define PINCTRL_STATE_IDLE "idle"
#define PINCTRL_STATE_SLEEP "sleep"
Commit	Line	Data
9a01be17 LW	1	/*
	2	* Standard pin control state definitions
	3	*/
	4
65697e6b LW	5	/**
	6	* @PINCTRL_STATE_DEFAULT: the state the pinctrl handle shall be put
	7	* into as default, usually this means the pins are up and ready to
	8	* be used by the device driver. This state is commonly used by
b0e181d0 LW	9	* hogs to configure muxing and pins at boot, and also as a state
	10	* to go into when returning from sleep and idle in
	11	* .pm_runtime_resume() or ordinary .resume() for example.
ef0eebc0 DA	12	* @PINCTRL_STATE_INIT: normally the pinctrl will be set to "default"
	13	* before the driver's probe() function is called. There are some
	14	* drivers where that is not appropriate becausing doing so would
	15	* glitch the pins. In those cases you can add an "init" pinctrl
	16	* which is the state of the pins before drive probe. After probe
	17	* if the pins are still in "init" state they'll be moved to
	18	* "default".
65697e6b	19	* @PINCTRL_STATE_IDLE: the state the pinctrl handle shall be put into
b0e181d0 LW	20	* when the pins are idle. This is a state where the system is relaxed
	21	* but not fully sleeping - some power may be on but clocks gated for
	22	* example. Could typically be set from a pm_runtime_suspend() or
	23	* pm_runtime_idle() operation.
65697e6b	24	* @PINCTRL_STATE_SLEEP: the state the pinctrl handle shall be put into
b0e181d0 LW	25	* when the pins are sleeping. This is a state where the system is in
	26	* its lowest sleep state. Could typically be set from an
	27	* ordinary .suspend() function.
65697e6b	28	*/
9a01be17	29	#define PINCTRL_STATE_DEFAULT "default"
ef0eebc0	30	#define PINCTRL_STATE_INIT "init"
9a01be17	31	#define PINCTRL_STATE_IDLE "idle"
65697e6b	32	#define PINCTRL_STATE_SLEEP "sleep"