From: Douglas Anderson <dianders@chromium.org>
To: Mark Brown <broonie@kernel.org>, Rob Herring <robh+dt@kernel.org>
Cc: Marco Felsch <m.felsch@pengutronix.de>,
ckeepax@opensource.cirrus.com, zhang.chunyan@linaro.org,
Douglas Anderson <dianders@chromium.org>,
devicetree@vger.kernel.org, Liam Girdwood <lgirdwood@gmail.com>,
linux-kernel@vger.kernel.org, Mark Rutland <mark.rutland@arm.com>
Subject: [PATCH v2] regulator: Document "regulator-boot-on" binding more thoroughly
Date: Tue, 1 Oct 2019 12:45:54 -0700 [thread overview]
Message-ID: <20191001124531.v2.1.Ice34ad5970a375c3c03cb15c3859b3ee501561bf@changeid> (raw)
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>
---
Changes in v2:
- Don't mention Linux. Duh.
Documentation/devicetree/bindings/regulator/regulator.yaml | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
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:
--
2.23.0.444.g18eeb5a265-goog
next reply other threads:[~2019-10-01 19:45 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-10-01 19:45 Douglas Anderson [this message]
2019-10-04 17:52 ` Applied "regulator: Document "regulator-boot-on" binding more thoroughly" to the regulator tree Mark Brown
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20191001124531.v2.1.Ice34ad5970a375c3c03cb15c3859b3ee501561bf@changeid \
--to=dianders@chromium.org \
--cc=broonie@kernel.org \
--cc=ckeepax@opensource.cirrus.com \
--cc=devicetree@vger.kernel.org \
--cc=lgirdwood@gmail.com \
--cc=linux-kernel@vger.kernel.org \
--cc=m.felsch@pengutronix.de \
--cc=mark.rutland@arm.com \
--cc=robh+dt@kernel.org \
--cc=zhang.chunyan@linaro.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).