On 09/22/2018 09:11 PM, Nicolin Chen wrote:
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@xxxxxxxxx>
---
Changelog
v3->v4:
* Removed the attempt of putting labels in the node names
* Added a new optional label property in the child node
* Updated examples accordingly
v2->v3:
* Added a simple subject in the line 1
* Fixed the shunt resistor value in the example
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 | 42 +++++++++++++++++++
1 file changed, 42 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..7d90bfe34adb
--- /dev/null
+++ b/Documentation/devicetree/bindings/hwmon/ina3221.txt
@@ -0,0 +1,42 @@
+Texas Instruments INA3221 Device Tree Bindings
+
+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
+ Required properties:
+ - input-id: Must be 1, 2 or 3
+
+ Optional properties:
+ - input-label: Name of the input source
+ - shunt-resistor: Shunt resistor value in micro-Ohm
+ - status: Should be "disabled" if no input source
+
+ Example:
+
+ input1 {
+ input-id = <0x1>;
We'll have to find a better name for this. Feel free to look up examples in the
existing devicetree descriptions. The one that seems to be used most of the time
to indicate a channel index or id is "reg". It should also start with 0 - there
is no real reason for it to start with 1; it only makes the code more complex.
+ status = "disabled";
+ };
+ input2 {
+ input-id = <0x2>;
+ shunt-resistor = <5000>;
I would suggest shunt-resistor-micro-ohms as per
Documentation/devicetree/bindings/property-units.txt.
+ };
+ input3 {
+ input-id = <0x3>;
+ input-label = "VDD_5V";
+ shunt-resistor = <5000>;
+ };
