Skip to contentSkip to conversation

iio: bmp280: fix compensation of humidity

PATCH In review Andreas Klinger 2 participants 2 messages May 4, 2020 – May 10, 2020 IIO

lore
Share & tools
lore
#0 lore raw

PATCH v3 1/1 iio: bmp280: fix compensation of humidity

Limit the output of humidity compensation to the range between 0 and 100 percent.

Depending on the calibration parameters of the individual sensor it happens, that a humidity above 100 percent or below 0 percent is calculated, which don't make sense in terms of relative humidity.

Add a clamp to the compensation formula as described in the datasheet of the sensor in chapter 4.2.3.

Although this clamp is documented, it was never in the driver of the kernel.

It depends on the circumstances (calibration parameters, temperature, humidity) if one can see a value above 100 percent without the clamp. The writer of this patch was working with this type of sensor without noting this error. So it seems to be a rare event when this bug occures.

---

Change to v2:
Thanks to the review of Jonathan a more descriptive commit message is added.

Change to v1:
Thanks to Tomasz for suggesting the easier to use function clamp_val() which is now used.

 drivers/iio/pressure/bmp280-core.c | 2 ++
 1 file changed, 2 insertions(+)
drivers/iio/pressure/bmp280-core.c +2 -0
index 29c209cc1108..297ee2205bf6 100644
@@ -271,6 +271,8 @@ static u32 bmp280_compensate_humidity(struct bmp280_data *data,
 		+ (s32)2097152) * calib->H2 + 8192) >> 14);
 	var -= ((((var >> 15) * (var >> 15)) >> 7) * (s32)calib->H1) >> 4;
 
+	var = clamp_val(var, 0, 419430400);
+
 	return var >> 12;
 };
 
Signature · 1 line
2.20.1
maintainer
#1 lore raw
Quoted 13 lines · On Mon, 4 May 2020 20:10:34 +0200 Andreas Klinger <[email protected]> wrote:

Limit the output of humidity compensation to the range between 0 and 100 percent.

Depending on the calibration parameters of the individual sensor it happens, that a humidity above 100 percent or below 0 percent is calculated, which don't make sense in terms of relative humidity.

Add a clamp to the compensation formula as described in the datasheet of the sensor in chapter 4.2.3.

Although this clamp is documented, it was never in the driver of the kernel.

Quoted 6 lines

It depends on the circumstances (calibration parameters, temperature, humidity) if one can see a value above 100 percent without the clamp. The writer of this patch was working with this type of sensor without noting this error. So it seems to be a rare event when this bug occures.

On basis of description I'm going to take this the slow way (next merge window). If you want it backported to stable I don't mind but I haven't marked it as such so you'll have to request it explicitly after the patch is in Linus' tree. It's reasonably likely the scripts will pick this one up anyway though...

Thanks,

Jonathan

Quoted 26 lines

---

Change to v2:
Thanks to the review of Jonathan a more descriptive commit message is added.

Change to v1:
Thanks to Tomasz for suggesting the easier to use function clamp_val() which is now used.

 drivers/iio/pressure/bmp280-core.c | 2 ++
 1 file changed, 2 insertions(+)
drivers/iio/pressure/bmp280-core.c +2 -0
index 29c209cc1108..297ee2205bf6 100644
@@ -271,6 +271,8 @@ static u32 bmp280_compensate_humidity(struct bmp280_data *data,
 		+ (s32)2097152) * calib->H2 + 8192) >> 14);
 	var -= ((((var >> 15) * (var >> 15)) >> 7) * (s32)calib->H1) >> 4;
 
+	var = clamp_val(var, 0, 419430400);
+
 	return var >> 12;
 };