diff mbox series

[v1,1/2] dt-bindings: hwmon: add INA233 binding documents

Message ID 20230920054739.1561080-2-Delphine_CC_Chiu@wiwynn.com
State Changes Requested
Headers show
Series hwmon: ina233: add ina233 support | expand

Checks

Context Check Description
robh/checkpatch warning total: 0 errors, 5 warnings, 39 lines checked

Commit Message

Delphine_CC_Chiu/WYHQ/Wiwynn Sept. 20, 2023, 5:47 a.m. UTC
Add INA233 binding documents for Yosemite V4 config.

Signed-off-by: Delphine CC Chiu <Delphine_CC_Chiu@wiwynn.com>
---
 .../devicetree/bindings/hwmon/ina233.txt      | 27 +++++++++++++++++++
 MAINTAINERS                                   |  6 +++++
 2 files changed, 33 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/hwmon/ina233.txt

Comments

Krzysztof Kozlowski Sept. 20, 2023, 6:47 a.m. UTC | #1
On 20/09/2023 07:47, Delphine CC Chiu wrote:
> Add INA233 binding documents for Yosemite V4 config.
> 
> Signed-off-by: Delphine CC Chiu <Delphine_CC_Chiu@wiwynn.com>
> ---
>  .../devicetree/bindings/hwmon/ina233.txt      | 27 +++++++++++++++++++

No bindings in the TXT format.

Anyway, this looks like could be merged with existing ina bindings.

Best regards,
Krzysztof
Guenter Roeck Sept. 20, 2023, 4:14 p.m. UTC | #2
On 9/19/23 22:47, Delphine CC Chiu wrote:
> Add INA233 binding documents for Yosemite V4 config.
> 
> Signed-off-by: Delphine CC Chiu <Delphine_CC_Chiu@wiwynn.com>
> ---
>   .../devicetree/bindings/hwmon/ina233.txt      | 27 +++++++++++++++++++
>   MAINTAINERS                                   |  6 +++++
>   2 files changed, 33 insertions(+)
>   create mode 100644 Documentation/devicetree/bindings/hwmon/ina233.txt
> 
> diff --git a/Documentation/devicetree/bindings/hwmon/ina233.txt b/Documentation/devicetree/bindings/hwmon/ina233.txt
> new file mode 100644
> index 000000000000..a1067788ec0c
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/hwmon/ina233.txt
> @@ -0,0 +1,27 @@
> +Bindings for the Maxim MAX31790 Intelligent Fan Controller

Not really.

> +==========================================================
> +
> +Reference:
> +
> +https://pdf1.alldatasheet.com/datasheet-pdf/view/930928/TI1/INA233.html
> +
> +The INA233 device is a current, voltage and power monitor with an I2C-, SMBus-,and PMBus-compatible interface
> +that is compliant with digital bus voltages from 1.8 V to 5.0 V.
> +The device monitors and reports values for current, voltage and power.
> +The integrated power accumulator can be used for energy or average power calculations.
> +Programmable calibration value, conversion times and averaging when combined with an internal multiplier
> +enable direct readouts of current in amperes and power in watts.
> +
> +Required properties:
> +- compatible     	: ti,ina233
> +- reg            	: I2C address
> +- resistor-calibration  : MFR_CALIBRATION which will be set into register 0xd4
> +- current-lsb    	: Current_LSB for calibration

The lack of valid ranges is a concern for me, as well as the lack of units.
MFR_CALIBRATION is register 0xd4, so I don't think that "MFR_CALIBRATION
which will be set into register 0xd4" is a really useful description.

Also, the calibration register value is, per datasheet, supposed to be
calculated from current_lsb and Rshunt. Since current_lsb is calculated
from the maximum expected current, the properties should actually be
the maximum expected current and Rshunt.

> +Example:
> +
> +        ina233@45 {
> +                compatible = "ti,ina233";
> +                reg = <0x45>;
> +                resistor-calibration = /bits/ 16 <0x0a00>;
> +                current-lsb= /bits/ 16 <0x0001>;
> +        };
> diff --git a/MAINTAINERS b/MAINTAINERS
> index bf0f54c24f81..48b9a73d259f 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -10243,6 +10243,12 @@ F:	Documentation/devicetree/bindings/hwmon/ti,ina2xx.yaml
>   F:	Documentation/hwmon/ina209.rst
>   F:	drivers/hwmon/ina209.c
>   
> +INA233 HARDWARE MONITOR DRIVER
> +M:     Delphine CC Chiu <Delphine_CC_Chiu@wiwynn.com>
> +S:     Odd Fixes
> +F:     Documentation/devicetree/bindings/hwmon/ina233.txt
> +F:     drivers/hwmon/ina233.c
> +
>   INA2XX HARDWARE MONITOR DRIVER
>   M:	Guenter Roeck <linux@roeck-us.net>
>   L:	linux-hwmon@vger.kernel.org
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/hwmon/ina233.txt b/Documentation/devicetree/bindings/hwmon/ina233.txt
new file mode 100644
index 000000000000..a1067788ec0c
--- /dev/null
+++ b/Documentation/devicetree/bindings/hwmon/ina233.txt
@@ -0,0 +1,27 @@ 
+Bindings for the Maxim MAX31790 Intelligent Fan Controller
+==========================================================
+
+Reference:
+
+https://pdf1.alldatasheet.com/datasheet-pdf/view/930928/TI1/INA233.html
+
+The INA233 device is a current, voltage and power monitor with an I2C-, SMBus-,and PMBus-compatible interface
+that is compliant with digital bus voltages from 1.8 V to 5.0 V.
+The device monitors and reports values for current, voltage and power.
+The integrated power accumulator can be used for energy or average power calculations.
+Programmable calibration value, conversion times and averaging when combined with an internal multiplier
+enable direct readouts of current in amperes and power in watts.
+
+Required properties:
+- compatible     	: ti,ina233
+- reg            	: I2C address
+- resistor-calibration  : MFR_CALIBRATION which will be set into register 0xd4
+- current-lsb    	: Current_LSB for calibration
+Example:
+
+        ina233@45 {
+                compatible = "ti,ina233";
+                reg = <0x45>;
+                resistor-calibration = /bits/ 16 <0x0a00>;
+                current-lsb= /bits/ 16 <0x0001>;
+        };
diff --git a/MAINTAINERS b/MAINTAINERS
index bf0f54c24f81..48b9a73d259f 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -10243,6 +10243,12 @@  F:	Documentation/devicetree/bindings/hwmon/ti,ina2xx.yaml
 F:	Documentation/hwmon/ina209.rst
 F:	drivers/hwmon/ina209.c
 
+INA233 HARDWARE MONITOR DRIVER
+M:     Delphine CC Chiu <Delphine_CC_Chiu@wiwynn.com>
+S:     Odd Fixes
+F:     Documentation/devicetree/bindings/hwmon/ina233.txt
+F:     drivers/hwmon/ina233.c
+
 INA2XX HARDWARE MONITOR DRIVER
 M:	Guenter Roeck <linux@roeck-us.net>
 L:	linux-hwmon@vger.kernel.org