hwmon: (ina238) Update documentation and Kconfig entry
authorGuenter Roeck <linux@roeck-us.net>
Fri, 5 Sep 2025 20:20:04 +0000 (13:20 -0700)
committerGuenter Roeck <linux@roeck-us.net>
Sun, 7 Sep 2025 23:34:04 +0000 (16:34 -0700)
Update driver documentation and Kconfig entry to list all chips supported
by the driver.

Reviewed-by: Chris Packham <chris.packham@alliedtelesis.co.nz>
Tested-by: Chris Packham <chris.packham@alliedtelesis.co.nz> # INA780
Signed-off-by: Guenter Roeck <linux@roeck-us.net>
Documentation/hwmon/ina238.rst
drivers/hwmon/Kconfig

index 9b830e3..1ac4e2c 100644 (file)
@@ -5,6 +5,24 @@ Kernel driver ina238
 
 Supported chips:
 
+  * Texas Instruments INA228
+
+    Prefix: 'ina228'
+
+    Addresses: I2C 0x40 - 0x4f
+
+    Datasheet:
+       https://www.ti.com/lit/gpn/ina228
+
+  * Texas Instruments INA237
+
+    Prefix: 'ina237'
+
+    Addresses: I2C 0x40 - 0x4f
+
+    Datasheet:
+       https://www.ti.com/lit/gpn/ina237
+
   * Texas Instruments INA238
 
     Prefix: 'ina238'
@@ -34,6 +52,13 @@ platform code or from device tree data. Please refer to
 Documentation/devicetree/bindings/hwmon/ti,ina2xx.yaml for bindings if
 device tree is used.
 
+INA237 is a functionally equivalent variant of INA238 with slightly
+different accuracy. INA228 is another variant of INA238 with higher ADC
+resolution. This chip also reports the energy.
+
+SQ52206 is a mostly compatible chip from Sylergy. It reports the energy
+as well as the peak power consumption.
+
 Sysfs entries
 -------------
 
@@ -53,19 +78,15 @@ in1_max_alarm               Maximum shunt voltage alarm
 power1_input           Power measurement (uW)
 power1_max             Maximum power threshold (uW)
 power1_max_alarm       Maximum power alarm
+power1_input_highest   Peak Power (uW)
+                               (SQ52206 only)
 
 curr1_input            Current measurement (mA)
 
+energy1_input          Energy measurement (uJ)
+                               (SQ52206 and INA237 only)
+
 temp1_input            Die temperature measurement (mC)
 temp1_max              Maximum die temperature threshold (mC)
 temp1_max_alarm                Maximum die temperature alarm
 ======================= =======================================================
-
-Additional sysfs entries for sq52206
-------------------------------------
-
-======================= =======================================================
-energy1_input          Energy measurement (uJ)
-
-power1_input_highest   Peak Power (uW)
-======================= =======================================================
index c53c041..6bdce99 100644 (file)
@@ -2252,13 +2252,14 @@ config SENSORS_INA2XX
          will be called ina2xx.
 
 config SENSORS_INA238
-       tristate "Texas Instruments INA238"
+       tristate "Texas Instruments INA238 and compatibles"
        depends on I2C
        select REGMAP_I2C
        help
-         If you say yes here you get support for the INA238 power monitor
-         chip. This driver supports voltage, current, power and temperature
-         measurements as well as alarm configuration.
+         If you say yes here you get support for INA228, INA237, INA238, and
+         SQ52206 power monitor chips. This driver supports voltage, current,
+         power, energy, and temperature measurements as well as alarm
+         configuration.
 
          This driver can also be built as a module. If so, the module
          will be called ina238.