aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt
diff options
context:
space:
mode:
authorStephen Warren <swarren@nvidia.com>2013-08-05 17:55:59 -0400
committerLinus Walleij <linus.walleij@linaro.org>2013-08-07 16:30:24 -0400
commitbcd0c8c2d4daf13a41880a82a685de41e6e193cc (patch)
tree2fe09cb95be9446ac4c50af527d2cb1008c33b68 /Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt
parent99fce0295e9c0b953844af92f3e9fa3a3b07c7e4 (diff)
pinctrl: clean up pinconfig-generic documentation
Reword the section of pinctrl-bindings.txt that describes generic properties that pinctrl bindings may use. The aim is to make the text clearer, and more explicitly call out the responsibility of individual bindings that use the generic properties to define which of the properties are used, and how. Signed-off-by: Stephen Warren <swarren@nvidia.com> Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
Diffstat (limited to 'Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt')
-rw-r--r--Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt25
1 files changed, 10 insertions, 15 deletions
diff --git a/Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt b/Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt
index aeb3c995cc04..31b0cb9de4f2 100644
--- a/Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt
+++ b/Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt
@@ -127,20 +127,16 @@ whether there is any interaction between the child and intermediate parent
127nodes, is again defined entirely by the binding for the individual pin 127nodes, is again defined entirely by the binding for the individual pin
128controller device. 128controller device.
129 129
130== Using generic pinconfig options == 130== Generic pin configuration node content ==
131 131
132Generic pinconfig parameters can be used by defining a separate node containing 132Many data items that are represented in a pin configuration node are common
133the applicable parameters (and optional values), like: 133and generic. Pin control bindings should use the properties defined below
134where they are applicable; not all of these properties are relevant or useful
135for all hardware or binding structures. Each individual binding document
136should state which of these generic properties, if any, are used, and the
137structure of the DT nodes that contain these properties.
134 138
135pcfg_pull_up: pcfg_pull_up { 139Supported generic properties are:
136 bias-pull-up;
137 drive-strength = <20>;
138};
139
140This node should then be referenced in the appropriate pinctrl node as a phandle
141and parsed in the driver using the pinconf_generic_parse_dt_config function.
142
143Supported configuration parameters are:
144 140
145bias-disable - disable any pin bias 141bias-disable - disable any pin bias
146bias-high-impedance - high impedance mode ("third-state", "floating") 142bias-high-impedance - high impedance mode ("third-state", "floating")
@@ -160,7 +156,8 @@ low-power-disable - disable low power mode
160output-low - set the pin to output mode with low level 156output-low - set the pin to output mode with low level
161output-high - set the pin to output mode with high level 157output-high - set the pin to output mode with high level
162 158
163Arguments for parameters: 159Some of the generic properties take arguments. For those that do, the
160arguments are described below.
164 161
165- bias-pull-up, -down and -pin-default take as optional argument on hardware 162- bias-pull-up, -down and -pin-default take as optional argument on hardware
166 supporting it the pull strength in Ohm. bias-disable will disable the pull. 163 supporting it the pull strength in Ohm. bias-disable will disable the pull.
@@ -170,7 +167,5 @@ Arguments for parameters:
170- input-debounce takes the debounce time in usec as argument 167- input-debounce takes the debounce time in usec as argument
171 or 0 to disable debouncing 168 or 0 to disable debouncing
172 169
173All parameters not listed here, do not take an argument.
174
175More in-depth documentation on these parameters can be found in 170More in-depth documentation on these parameters can be found in
176<include/linux/pinctrl/pinconfig-generic.h> 171<include/linux/pinctrl/pinconfig-generic.h>