iio: chemical: ccs811: Renamed resistance member in ccs811_reading struct
authorRichard Lai <richard@richardman.com>
Wed, 14 Feb 2018 01:08:35 +0000 (01:08 +0000)
committerJonathan Cameron <Jonathan.Cameron@huawei.com>
Sat, 24 Feb 2018 11:04:28 +0000 (11:04 +0000)
commit4c73b809a99fc4df39fb18664288921b052f9649
treeeb51677955b89fd3b207f7f41f30f1e08d8834b4
parent721dfe4133a9a41e4b4a74e5b41089b7dac8f539
iio: chemical: ccs811: Renamed resistance member in ccs811_reading struct

The resistance member in ccs811_reading struct is an unsigned 16-bit
integer variable used to store RAW_DATA register bytes read from CCS811.
It is kind of misleading to name this struct member as resistance.

About the RAW_DATA register bytes, the CCS811 datasheet states that:
-----
Two byte read only register which contains the latest readings from the
sense resistor.

The most significant 6 bits of the Byte 0 contain the value of the current
through the sensor (0μA to 63μA).

The lower 10 bits contain (as computed from the ADC) the readings of the
voltage across the sensor with the selected current (1023 = 1.65V)"
-----

Hence, the RAW_DATA register byte contains information about electric
current and voltage of the CCS811 sensor. Calling this struct member
'resistance' is kind of misleading, although both electric current and
voltage are needed to calculate the electrical resistance of the sensor
using Ohm's law, V = I x R, in which a new channel type of IIO_RESISTANCE
may be added to the driver in the future.

Signed-off-by: Richard Lai <richard@richardman.com>
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
drivers/iio/chemical/ccs811.c