pinctrl: document the "GPIO mode" pitfall
authorLinus Walleij <linus.walleij@linaro.org>
Fri, 15 Mar 2013 11:01:20 +0000 (12:01 +0100)
committerLinus Walleij <linus.walleij@linaro.org>
Mon, 18 Mar 2013 10:03:29 +0000 (11:03 +0100)
commitfdba2d065cb2891b3006424b50fbc6406ce66672
treec39f081800ad2d650deada201a6e89d1f1b419a4
parent9cca1173594dccc67c50f0530dc5743fa395da67
pinctrl: document the "GPIO mode" pitfall

Recently as adoption of the pinctrl framework is reaching
niches where the pins are reconfigured during system sleep
and datasheets often talk about something called "GPIO mode",
some engineers become confused by this, thinking that since
it is named "GPIO (something something)" it must be modeled
in the kernel using <linux/gpio.h>.

To clarify things, let's put in this piece of documentation,
or just start off the discussion here.

Cc: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Cc: Pankaj Dev <pankaj.dev@st.com>
Reviewed-by: Stephen Warren <swarren@nvidia.com>
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
Documentation/pinctrl.txt