From: Marek Vasut <marek.vasut+rene...@gmail.com> Reword the binding document to make it clear how the propeties work and which properties affect which other properties.
Signed-off-by: Marek Vasut <marek.vasut+rene...@gmail.com> Cc: Harald Geyer <har...@ccbib.org> Cc: Kuninori Morimoto <kuninori.morimoto...@renesas.com> Cc: Linus Walleij <linus.wall...@linaro.org> Cc: Mark Brown <broo...@kernel.org> Cc: Rob Herring <r...@kernel.org> Cc: firstname.lastname@example.org To: devicet...@vger.kernel.org --- Note: The recent gpio-regulator rework caused breakage. While the changes in the gpio-regulator code were according to the DT binding document, they stopped working with older DTs. Make the binding document clearer to prevent such breakage in the future. --- .../bindings/regulator/gpio-regulator.txt | 23 +++++++++++++------ 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/Documentation/devicetree/bindings/regulator/gpio-regulator.txt b/Documentation/devicetree/bindings/regulator/gpio-regulator.txt index 1f496159e2bb..acca13c1eaf3 100644 --- a/Documentation/devicetree/bindings/regulator/gpio-regulator.txt +++ b/Documentation/devicetree/bindings/regulator/gpio-regulator.txt @@ -4,16 +4,25 @@ Required properties: - compatible : Must be "regulator-gpio". - regulator-name : Defined in regulator.txt as optional, but required here. -- states : Selection of available voltages and GPIO configs. - if there are no states, then use a fixed regulator +- states : Selection of available voltages/currents provided by + this regulator and matching GPIO configurations to + achieve them. If there are no states in the "states" + array, use a fixed regulator instead. Optional properties: -- enable-gpio : GPIO to use to enable/disable the regulator. -- gpios : GPIO group used to control voltage. -- gpios-states : gpios pin's initial states array. 0: LOW, 1: HIGH. - defualt is LOW if nothing is specified. +- enable-gpio : GPIO used to enable/disable the regulator. + Warning, the GPIO phandle flags are ignored and the + GPIO polarity is controlled solely by the presence + of "enable-active-high" DT property. This is due to + compatibility with old DTs. +- enable-active-high : Polarity of "enable-gpio" GPIO is active HIGH. + Default is active LOW. +- gpios : Array of one or more GPIO pins used to select the + regulator voltage/current listed in "states". +- gpios-states : Initial state of GPIO pins in "gpios" array. + 0: LOW, 1: HIGH. + Default is LOW if nothing else is specified. - startup-delay-us : Startup time in microseconds. -- enable-active-high : Polarity of GPIO is active high (default is low). - regulator-type : Specifies what is being regulated, must be either "voltage" or "current", defaults to voltage. -- 2.19.2