From: Nicolin Chen <nicoleotsuka@gmail.com>
To: jdelvare@suse.com, linux@roeck-us.net, robh+dt@kernel.org,
mark.rutland@arm.com, corbet@lwn.net
Cc: afd@ti.com, linux-hwmon@vger.kernel.org,
devicetree@vger.kernel.org, linux-kernel@vger.kernel.org,
linux-doc@vger.kernel.org
Subject: [PATCH v2 1/2] dt-bindings: hwmon: Add ina3221 documentation
Date: Fri, 21 Sep 2018 13:12:51 -0700 [thread overview]
Message-ID: <20180921201252.12875-2-nicoleotsuka@gmail.com> (raw)
In-Reply-To: <20180921201252.12875-1-nicoleotsuka@gmail.com>
Texas Instruments INA3221 is a triple-channel shunt and bus
voltage monitor. This patch adds a DT binding doc for it.
Signed-off-by: Nicolin Chen <nicoleotsuka@gmail.com>
---
Changelog
v1->v2:
* Dropped channel name properties
* Added child node definitions.
* * Added shunt resistor property in the child node
* * Added status property to indicate connection status
* * Changed to use child node name as the label of input source
.../devicetree/bindings/hwmon/ina3221.txt | 38 +++++++++++++++++++
1 file changed, 38 insertions(+)
create mode 100644 Documentation/devicetree/bindings/hwmon/ina3221.txt
diff --git a/Documentation/devicetree/bindings/hwmon/ina3221.txt b/Documentation/devicetree/bindings/hwmon/ina3221.txt
new file mode 100644
index 000000000000..02a2ffbb7c3f
--- /dev/null
+++ b/Documentation/devicetree/bindings/hwmon/ina3221.txt
@@ -0,0 +1,38 @@
+ina3221 properties
+
+1) ina3221 node
+ Required properties:
+ - compatible: Must be "ti,ina3221"
+ - reg: I2C address
+
+ = The node contains optional child nodes for three channels =
+ = Each child node describes the information of input source =
+
+ Example:
+
+ ina3221@40 {
+ compatible = "ti,ina3221";
+ reg = <0x40>;
+ [ child node definitions... ]
+ };
+
+2) child nodes
+ The names of child nodes should indicate input source names
+
+ Required properties:
+ - input-id: Must be 1, 2 or 3
+
+ Optional properties:
+ - shunt-resistor: Shunt resistor value in micro-Ohm
+ - status: Should be "disabled" if no input source
+
+ Example:
+
+ input1 {
+ input-id = <0x1>;
+ status = "disabled";
+ };
+ VDD_GPU {
+ input-id = <0x2>;
+ shunt-resistor = <5>;
+ };
--
2.17.1
next prev parent reply other threads:[~2018-09-21 20:13 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-09-21 20:12 [PATCH v2 0/2] Add an initial DT binding doc for ina3221 Nicolin Chen
2018-09-21 20:12 ` Nicolin Chen [this message]
2018-09-21 21:51 ` [PATCH v2 1/2] dt-bindings: hwmon: Add ina3221 documentation Nicolin Chen
2018-09-21 20:12 ` [PATCH v2 2/2] hwmon: ina3221: Read channel input source info from DT Nicolin Chen
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=20180921201252.12875-2-nicoleotsuka@gmail.com \
--to=nicoleotsuka@gmail.com \
--cc=afd@ti.com \
--cc=corbet@lwn.net \
--cc=devicetree@vger.kernel.org \
--cc=jdelvare@suse.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-hwmon@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@roeck-us.net \
--cc=mark.rutland@arm.com \
--cc=robh+dt@kernel.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).