diff mbox series

doc: iio: Document intensity scale as poorly defined

Message ID 20231207134200.329174-1-marex@denx.de (mailing list archive)
State Accepted
Headers show
Series doc: iio: Document intensity scale as poorly defined | expand

Commit Message

Marek Vasut Dec. 7, 2023, 1:41 p.m. UTC
Add comment about intensity scale being poorly defined and
having no proper units.

Signed-off-by: Marek Vasut <marex@denx.de>
---
Cc: Jonathan Cameron <jic23@kernel.org>
Cc: Lars-Peter Clausen <lars@metafoo.de>
Cc: linux-iio@vger.kernel.org
---
 Documentation/ABI/testing/sysfs-bus-iio | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Comments

Jonathan Cameron Dec. 10, 2023, 11:58 a.m. UTC | #1
On Thu,  7 Dec 2023 14:41:50 +0100
Marek Vasut <marex@denx.de> wrote:

> Add comment about intensity scale being poorly defined and
> having no proper units.
> 
> Signed-off-by: Marek Vasut <marex@denx.de>
Applied. Thanks for cleaning this up.

Jonathan

> ---
> Cc: Jonathan Cameron <jic23@kernel.org>
> Cc: Lars-Peter Clausen <lars@metafoo.de>
> Cc: linux-iio@vger.kernel.org
> ---
>  Documentation/ABI/testing/sysfs-bus-iio | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
> index 0d3ec5fc45f2f..94b8d8461b7c7 100644
> --- a/Documentation/ABI/testing/sysfs-bus-iio
> +++ b/Documentation/ABI/testing/sysfs-bus-iio
> @@ -618,7 +618,9 @@ KernelVersion:	2.6.35
>  Contact:	linux-iio@vger.kernel.org
>  Description:
>  		If a discrete set of scale values is available, they
> -		are listed in this attribute.
> +		are listed in this attribute. Unlike illumination,
> +		multiplying intensity by intensity_scale does not
> +		yield value with any standardized unit.
>  
>  What:		/sys/bus/iio/devices/iio:deviceX/out_voltageY_hardwaregain
>  What:		/sys/bus/iio/devices/iio:deviceX/in_intensity_hardwaregain
Marek Vasut Dec. 10, 2023, 3:29 p.m. UTC | #2
On 12/10/23 12:58, Jonathan Cameron wrote:
> On Thu,  7 Dec 2023 14:41:50 +0100
> Marek Vasut <marex@denx.de> wrote:
> 
>> Add comment about intensity scale being poorly defined and
>> having no proper units.
>>
>> Signed-off-by: Marek Vasut <marex@denx.de>
> Applied. Thanks for cleaning this up.

Glad I could help. Thanks for your help with it.
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
index 0d3ec5fc45f2f..94b8d8461b7c7 100644
--- a/Documentation/ABI/testing/sysfs-bus-iio
+++ b/Documentation/ABI/testing/sysfs-bus-iio
@@ -618,7 +618,9 @@  KernelVersion:	2.6.35
 Contact:	linux-iio@vger.kernel.org
 Description:
 		If a discrete set of scale values is available, they
-		are listed in this attribute.
+		are listed in this attribute. Unlike illumination,
+		multiplying intensity by intensity_scale does not
+		yield value with any standardized unit.
 
 What:		/sys/bus/iio/devices/iio:deviceX/out_voltageY_hardwaregain
 What:		/sys/bus/iio/devices/iio:deviceX/in_intensity_hardwaregain