Commit b0e181d0 authored by Linus Walleij's avatar Linus Walleij

pinctrl: clarify idle vs sleep states

This pure documentation fix tries to align the "idle" and
"sleep" pin states to the idle and suspend states from
runtime PM.

Cc: Patrice Chotard <patrice.chotard@st.com>
Acked-by: default avatarStephen Warren <swarren@nvidia.com>
Signed-off-by: default avatarLinus Walleij <linus.walleij@linaro.org>
parent 95f0bc9b
...@@ -6,13 +6,18 @@ ...@@ -6,13 +6,18 @@
* @PINCTRL_STATE_DEFAULT: the state the pinctrl handle shall be put * @PINCTRL_STATE_DEFAULT: the state the pinctrl handle shall be put
* into as default, usually this means the pins are up and ready to * 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 * be used by the device driver. This state is commonly used by
* hogs to configure muxing and pins at boot. * 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_IDLE: the state the pinctrl handle shall be put into * @PINCTRL_STATE_IDLE: the state the pinctrl handle shall be put into
* when the pins are idle. Could typically be set from a * when the pins are idle. This is a state where the system is relaxed
* pm_runtime_suspend() operation. * 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 * @PINCTRL_STATE_SLEEP: the state the pinctrl handle shall be put into
* when the pins are sleeping. Could typically be set from a * when the pins are sleeping. This is a state where the system is in
* common suspend() function. * its lowest sleep state. Could typically be set from an
* ordinary .suspend() function.
*/ */
#define PINCTRL_STATE_DEFAULT "default" #define PINCTRL_STATE_DEFAULT "default"
#define PINCTRL_STATE_IDLE "idle" #define PINCTRL_STATE_IDLE "idle"
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment