regulator: Document "regulator-boot-on" binding more thoroughly
authorDouglas Anderson <dianders@chromium.org>
Tue, 1 Oct 2019 19:45:54 +0000 (12:45 -0700)
committerMark Brown <broonie@kernel.org>
Wed, 2 Oct 2019 11:58:37 +0000 (12:58 +0100)
commit87fd0db6d7df1cf4cc6e9b09e2155d1f324bf836
tree6196c34ac96ca74bf2261e325c44f1de30576e12
parent95bddd8bbf912a9a7980fde2a376fabf1ff7cd4b
regulator: Document "regulator-boot-on" binding more thoroughly

The description of "regulator-boot-on" was a little unclear, at least
to me.  Did this property mean that we should turn the regulator on at
boot?  Or perhaps it was intended only to be used for regulators where
we couldn't read the state at bootup to indicate what state we should
assume?  The answer, it turns out, is both [1].

Let's document this.

[1] https://lore.kernel.org/r/20190923181431.GU2036@sirena.org.uk

Signed-off-by: Douglas Anderson <dianders@chromium.org>
Link: https://lore.kernel.org/r/20191001124531.v2.1.Ice34ad5970a375c3c03cb15c3859b3ee501561bf@changeid
Signed-off-by: Mark Brown <broonie@kernel.org>
Documentation/devicetree/bindings/regulator/regulator.yaml