hwmon: (ina2xx) Fix overflow issues
Guenter Roeck
maintainerPATCH v4 1/1 hwmon: (ina2xx) Fix overflow issues
Sashiko reports the following overflow problems:
In ina2xx_get_value(), the INA2XX_POWER calculation is:
val = regval * data->power_lsb_uW;
The result is returned as a signed 32-bit int. For the INA232 with a common 2mOhm shunt, power_lsb_uW becomes 40,000. When the 16-bit regval exceeds 53,687, the product exceeds INT_MAX. This overflows the 32-bit signed math, wrapping to a negative integer and reporting erroneous negative power readings to userspace.
For INA2XX_POWER, the upper bound is clamped:
val = clamp_val(val, 0, UINT_MAX - data->power_lsb_uW);
clamp_val() implicitly casts the upper bound to a 32-bit signed long on 32-bit platforms. This results in a negative number, meaning any valid power limit is clamped to a negative value and ultimately programmed as 0. Similarly, for INA2XX_SHUNT_VOLTAGE, the initial clamp uses SHRT_MAX * shunt_div instead of division. The subsequent multiplication:
val *= data->config->shunt_div;
overflows LONG_MAX on 32-bit platforms for high inputs, wrapping to a negative value and also programming the hardware limit to 0.
For INA2XX_BUS_VOLTAGE on parts with bus_voltage_shift > 0, the calculation (val * 1000) << shift can exceed LONG_MAX for limits over ~134V, wrapping to negative and setting the limit to 0.
For INA2XX_CURRENT:
On 32-bit systems, long is 32-bit signed. For configurations with small shunts, current_lsb_uA can be very large (e.g., 40,000,000). When multiplied by a large regval, the product can reach 1.3 trillion, massively exceeding LONG_MAX (2.14 billion).
This will silently overflow the 32-bit signed math, wrapping to a negative value.
If a large limit is provided to effectively disable the alert (e.g., INT_MAX / 1000), the intermediate value after DIV_ROUND_CLOSEST can be large (e.g., 200,000,000). When left-shifted by current_shift (e.g., 4 for INA234), it becomes 3.2 billion, exceeding LONG_MAX and wrapping to a negative number.
In sy24655_average_power_read(), the accumulator quotient multiplied by power_lsb_uW can overflow the 32-bit signed math before the assignment.
Have ina2xx_get_value() return a long variable to improve the supported value range on 64-bit systems and to match the type of values returned to the hwmon core.
Clamp the result of 'regval * data->power_lsb_uW' to LONG_MAX to fix the INA2XX_POWER calculation overflow.
Change the initial clamp for INA2XX_SHUNT_VOLTAGE to SHRT_MAX / shunt_div to fix the shunt limit overflow.
For INA2XX_BUS_VOLTAGE, limit the initial clamp to 130V instead of 200V to avoid the overflow.
For INA2XX_CURRENT, improve clamping to avoid the overflow.
To address the INA2XX_CURRENT problem in ina226_alert_to_reg(), take current_shift into acount for the initial clamp to avoid the overflow.
In sy24655_average_power_read, use a temporary 64-bit variable to store the multiplication result and clamp the result against LONG_MAX.
---
v4: Fix another clamping issue when reading INA2XX_CURRENT
v3: Fix additional problems in INA2XX_CURRENT handling
(avoid possible 64-bit divide operation and overflow when using
DIV_ROUND_CLOSEST)
v2: Fixed several additional overflow conditions reported by Sashiko
after v1
drivers/hwmon/ina2xx.c | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-)
drivers/hwmon/ina2xx.c +19 -10
@@ -16,6 +16,7 @@#include <linux/i2c.h> #include <linux/init.h> #include <linux/kernel.h> +#include <linux/limits.h> #include <linux/module.h> #include <linux/property.h> #include <linux/regmap.h>
@@ -266,10 +267,11 @@ static u16 ina226_interval_to_reg(long interval)return FIELD_PREP (INA226_AVG_RD_MASK , avg_bits); } -static int ina2xx_get_value (struct ina2xx_data *data,u8 reg, -unsigned int regval) +static long ina2xx_get_value (struct ina2xx_data *data,u8 reg, +unsigned int regval) { -int val; +s64 val64; +long val;switch (reg) {case INA2XX_SHUNT_VOLTAGE :
@@ -283,12 +285,13 @@ static int ina2xx_get_value(struct ina2xx_data *data, u8 reg, val =DIV_ROUND_CLOSEST (val,1000 );break ;case INA2XX_POWER : - val = regval * data->power_lsb_uW; + val =clamp_val ((u64 )regval * data->power_lsb_uW,0 ,LONG_MAX );break ;case INA2XX_CURRENT :/* signed register, result in mA */ - val = ((s16 )regval >> data->config->current_shift) * + val64 = (s64)((s16 )regval >> data->config->current_shift) * data->current_lsb_uA; + val =clamp_val (val64,LONG_MIN +500 ,LONG_MAX -500 ); val =DIV_ROUND_CLOSEST (val,1000 );break ;case INA2XX_CALIBRATION :
@@ -378,23 +381,27 @@ static int ina2xx_read_init(struct device *dev, int reg, long *val)*/ static u16 ina226_alert_to_reg (struct ina2xx_data *data,int reg,long val) { +long limit; +switch (reg) {case INA2XX_SHUNT_VOLTAGE : - val =clamp_val (val,0 ,SHRT_MAX * data->config->shunt_div); + val =clamp_val (val,0 ,DIV_ROUND_CLOSEST (SHRT_MAX , data->config->shunt_div)); val *= data->config->shunt_div; val <<= data->config->shunt_voltage_shift;return clamp_val (val,0 ,SHRT_MAX );case INA2XX_BUS_VOLTAGE : - val =clamp_val (val,0 ,200000 ); + val =clamp_val (val,0 ,130000 ); val = (val *1000 ) << data->config->bus_voltage_shift; val =DIV_ROUND_CLOSEST (val, data->config->bus_voltage_lsb);return clamp_val (val,0 ,USHRT_MAX );case INA2XX_POWER : - val =clamp_val (val,0 ,UINT_MAX - data->power_lsb_uW); + val =clamp_val (val,0 ,LONG_MAX - data->power_lsb_uW); val =DIV_ROUND_CLOSEST (val, data->power_lsb_uW);return clamp_val (val,0 ,USHRT_MAX );case INA2XX_CURRENT : - val =clamp_val (val,INT_MIN /1000 ,INT_MAX /1000 ); + limit = ((INT_MAX - data->current_lsb_uA) /1000 ) >> + data->config->current_shift; + val =clamp_val (val, -limit, limit);/* signed register, result in mA */ val =DIV_ROUND_CLOSEST (val *1000 , data->current_lsb_uA); val <<= data->config->current_shift;
@@ -537,6 +544,7 @@ static int sy24655_average_power_read(struct ina2xx_data *data, u8 reg, long *vau8 template[6 ];int ret;long accumulator_24, sample_count; +u64 val64;/* 48-bit register read */ ret =i2c_smbus_read_i2c_block_data (data->client, reg,6 , template);
@@ -555,7 +563,8 @@ static int sy24655_average_power_read(struct ina2xx_data *data, u8 reg, long *vareturn 0 ; } - *val =DIV_ROUND_CLOSEST (accumulator_24, sample_count) * data->power_lsb_uW; + val64 = (u64 )DIV_ROUND_CLOSEST (accumulator_24, sample_count) * data->power_lsb_uW; + *val =clamp_val (val64,0 ,LONG_MAX );return 0 ; }
Signature · 1 line
2.45.2
[email protected]
AI reviewThank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider: - [High] The INA2XX_CURRENT limit calculation artificially restricts physically valid high-current alerts…
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [High] The INA2XX_CURRENT limit calculation artificially restricts physically valid high-current alerts due to a mathematically flawed clamp derivation. --
commit bc9d600ea70203e68f587fb999176459b42802ea
Author: Guenter Roeck <[email protected]>
hwmon: (ina2xx) Fix overflow issues
This patch updates the return type of ina2xx_get_value() to long to support a wider range of values on 64-bit systems. It also adds and adjusts clamping limits in ina2xx_get_value() and ina226_alert_to_reg() to prevent integer overflows during intermediate calculations.
Quoted 4 lines
drivers/hwmon/ina2xx.c +0
-0
[ ... ]
Quoted 7 lines
drivers/hwmon/ina2xx.c +2
-0@@ -378,23 +381,27 @@ static int ina2xx_read_init(struct device *dev, int reg, long *val)*/ static u16 ina226_alert_to_reg (struct ina2xx_data *data,int reg,long val) { +long limit; +switch (reg) {
[ ... ]
drivers/hwmon/ina2xx.c static int ina2xx_read_init(struct device *dev, int reg, long *val) · line 404
Quoted 5 lines
drivers/hwmon/ina2xx.c +3
-1case INA2XX_CURRENT : - val =clamp_val (val,INT_MIN /1000 ,INT_MAX /1000 ); + limit = ((INT_MAX - data->current_lsb_uA) /1000 ) >> + data->config->current_shift; + val =clamp_val (val, -limit, limit);
[Severity: High]
Does this calculation miscalculate the maximum safe input limit by not accounting for the subsequent division?
To prevent the final shifted value (val * 1000 / current_lsb_uA) << shift from overflowing, the limit would need to factor in the division by current_lsb_uA. Instead, this formula subtracts the LSB and effectively shifts the INT_MAX / 1000 limit right by current_shift.
For devices like the INA234 (current_shift = 4) configured with a small shunt, the LSB can be very large. As noted in the commit message, current_lsb_uA can reach 40,000,000. In this configuration, the hardware's physical maximum alert limit is (32767 >> 4) * 40A = 81,880A.
By not multiplying the allowable upper bound by the LSB before the shift, does this artificially cap the user input to ((INT_MAX - 40000000) / 1000)
Quoted 1 line
Quoted 1 line
4 = 131,717 mA (131.7A)? This restricts users to less than 0.2% of the
sensor's valid measurement range.
Quoted 4 lines
drivers/hwmon/ina2xx.c +0
-0/* signed register, result in mA */ val =DIV_ROUND_CLOSEST (val *1000 , data->current_lsb_uA); val <<= data->config->current_shift;return clamp_val (val,SHRT_MIN ,SHRT_MAX );
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1