diff options
| author | Linus Walleij <linus.walleij@linaro.org> | 2012-09-26 14:59:47 +0200 |
|---|---|---|
| committer | Linus Walleij <linus.walleij@linaro.org> | 2012-10-01 08:04:52 +0200 |
| commit | b0e181d0944e858ae0cacf808752e791894c5651 (patch) | |
| tree | 76e8aaf2416551a00dcff39c86c962e409cb83c1 /include | |
| parent | 95f0bc9bf0db600fbefda9d2157b95d5ff55e783 (diff) | |
| download | linux-3.10-b0e181d0944e858ae0cacf808752e791894c5651.tar.gz linux-3.10-b0e181d0944e858ae0cacf808752e791894c5651.tar.bz2 linux-3.10-b0e181d0944e858ae0cacf808752e791894c5651.zip | |
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: Stephen Warren <swarren@nvidia.com>
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
Diffstat (limited to 'include')
| -rw-r--r-- | include/linux/pinctrl/pinctrl-state.h | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/include/linux/pinctrl/pinctrl-state.h b/include/linux/pinctrl/pinctrl-state.h index 634608dc6c8..b5919f8e6d1 100644 --- a/include/linux/pinctrl/pinctrl-state.h +++ b/include/linux/pinctrl/pinctrl-state.h @@ -6,13 +6,18 @@ * @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. + * 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 - * when the pins are idle. Could typically be set from a - * pm_runtime_suspend() operation. + * 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. Could typically be set from a - * common suspend() function. + * 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_IDLE "idle" |