From: Rob Herring <robh@kernel.org>
To: Rick Altherr <raltherr@google.com>
Cc: mark.rutland@arm.com, devicetree@vger.kernel.org,
jdelvare@suse.com, linux@roeck-us.net, joel@jms.id.au,
linux-hwmon@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH 1/2] Documentation: dt-bindings: Document bindings for Aspeed AST2400/AST2500 ADC
Date: Fri, 3 Mar 2017 00:21:31 -0600 [thread overview]
Message-ID: <20170303062131.u5gjyv2odbafkkpg@rob-hp-laptop> (raw)
In-Reply-To: <20170228201404.32125-1-raltherr@google.com>
On Tue, Feb 28, 2017 at 12:14:03PM -0800, Rick Altherr wrote:
> Signed-off-by: Rick Altherr <raltherr@google.com>
> ---
> .../devicetree/bindings/hwmon/aspeed_adc.txt | 48 ++++++++++++++++++++++
ADCs should really be documented in one place regardless of whether
hwmon or IIO is used. Don't need to move it now, but certainly the
bindings need to be compatible.
> 1 file changed, 48 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/hwmon/aspeed_adc.txt
>
> diff --git a/Documentation/devicetree/bindings/hwmon/aspeed_adc.txt b/Documentation/devicetree/bindings/hwmon/aspeed_adc.txt
> new file mode 100644
> index 000000000000..9e481668c4d3
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/hwmon/aspeed_adc.txt
> @@ -0,0 +1,48 @@
> +Aspeed AST2400/2500 ADC
> +
> +This device is a 10-bit converter for 16 voltage channels. All inputs are
> +single ended. Each channel can be individually enabled to allow for use of
> +alternate pin functions.
> +
> +1) adc node
> +
> + Required properties:
> + - compatible : Should be one of
> + "aspeed,ast2400-adc"
> + "aspeed,ast2500-adc"
> + - reg : memory window mapping address and length
> + - #address-cells : must be <1> corresponding to the channel child binding
> + - #size-cells : must be <0> corresponding to the channel child binding
> + - clocks : Input clock used to derive the sample clock. Expected to be the
> + SoC's APB clock.
> + - update-interval-ms : initial time between updates on a channel
This is like sampling rate? I think we have a standard ADC property for
that.
> +
> + The node contains child nodes for each channel that the platform uses.
> +
> + Example adc node:
> + adc@1e6e9000 {
> + #address-cells = <1>;
> + #size-cells = <0>;
> + compatible = "aspeed,ast2400-adc";
> + reg = <0x1e6e9000 0xB0>;
> + clocks = <&clk_apb>;
> + update-interval-ms = <100>;
> +
> + [ child node definitions... ]
> + };
> +
> +2) channel nodes
> +
> + Optional properties:
> + - status: indicates the operational status of the device.
> + Value must be either "disabled" or "okay".
Don't need to document this.
> + - label : string describing the monitored value
You need a reg property for the channel number.
> +
> + Example channel node:
> + channel@1 {
> + status = "okay";
> + label = "3V3 rail";
> +
> + pinctrl-names = "default";
> + pinctrl-0 = <&pinctrl_adc0_default>;
Need to document these.
> + };
> --
> 2.11.0.483.g087da7b7c-goog
>
next prev parent reply other threads:[~2017-03-03 9:12 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-02-28 20:14 [PATCH 1/2] Documentation: dt-bindings: Document bindings for Aspeed AST2400/AST2500 ADC Rick Altherr
2017-02-28 20:14 ` [PATCH 2/2] hwmon: " Rick Altherr
2017-03-01 0:49 ` Joel Stanley
2017-03-01 3:45 ` Guenter Roeck
2017-03-02 3:29 ` Rick Altherr
2017-03-05 16:28 ` Guenter Roeck
2017-03-07 23:24 ` Rick Altherr
2017-03-03 6:21 ` Rob Herring
2017-03-05 16:14 ` Guenter Roeck
2017-03-01 0:50 ` [PATCH 1/2] Documentation: dt-bindings: Document bindings for " Joel Stanley
2017-03-03 6:21 ` Rob Herring [this message]
2017-03-06 22:01 ` Rick Altherr
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=20170303062131.u5gjyv2odbafkkpg@rob-hp-laptop \
--to=robh@kernel.org \
--cc=devicetree@vger.kernel.org \
--cc=jdelvare@suse.com \
--cc=joel@jms.id.au \
--cc=linux-hwmon@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@roeck-us.net \
--cc=mark.rutland@arm.com \
--cc=raltherr@google.com \
/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).