diff options
| author | Douglas Anderson <dianders@chromium.org> | 2019-10-01 12:45:54 -0700 |
|---|---|---|
| committer | Mark Brown <broonie@kernel.org> | 2019-10-02 12:58:37 +0100 |
| commit | 87fd0db6d7df1cf4cc6e9b09e2155d1f324bf836 (patch) | |
| tree | 6196c34ac96ca74bf2261e325c44f1de30576e12 /Documentation | |
| parent | 95bddd8bbf912a9a7980fde2a376fabf1ff7cd4b (diff) | |
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>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/devicetree/bindings/regulator/regulator.yaml | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/Documentation/devicetree/bindings/regulator/regulator.yaml b/Documentation/devicetree/bindings/regulator/regulator.yaml index 02c3043ce419..92ff2e8ad572 100644 --- a/Documentation/devicetree/bindings/regulator/regulator.yaml +++ b/Documentation/devicetree/bindings/regulator/regulator.yaml @@ -38,7 +38,12 @@ properties: type: boolean regulator-boot-on: - description: bootloader/firmware enabled regulator + description: bootloader/firmware enabled regulator. + It's expected that this regulator was left on by the bootloader. + If the bootloader didn't leave it on then OS should turn it on + at boot but shouldn't prevent it from being turned off later. + This property is intended to only be used for regulators where + software cannot read the state of the regulator. type: boolean regulator-allow-bypass: |