Re: [PATCH v8 02/17] iio: ABI: raw, scale and offset for frequency/phase channels

[sashiko-bot@kernel.org]

Thank you for your contribution! Sashiko AI review found 3 potential issue(s) to consider:
- [Low] Missing ABI documentation for 'in_' scale and offset attributes for frequency and phase channels.
- [Low] Incorrect KernelVersion inherited for new ABI entry `out_phaseY_raw`.
- [Low] Documenting ABI attributes for a non-existent IIO channel type (`frequency`).
--

--- Patch [2]: [PATCH v8 02/17] iio: ABI: raw, scale and offset for frequency/phase channels ---
commit 757abc8c6b95afb7c57d216bb7e4723c3c34e298
Author: Rodrigo Alencar <rodrigo.alencar@analog.com>

iio: ABI: raw, scale and offset for frequency/phase channels

Consider scale and offset attributes for frequency and phase channels.
Frequency channels are going to be introduced later alongside a DDS
device driver which is going to leverage those new attributes.

> diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
> index 90047189c3ebe..7ef0db8dad40f 100644
> --- a/Documentation/ABI/testing/sysfs-bus-iio
> +++ b/Documentation/ABI/testing/sysfs-bus-iio
> @@ -441,6 +441,10 @@ What:		/sys/bus/iio/devices/iio:deviceX/in_voltageY_i_offset
>  What:		/sys/bus/iio/devices/iio:deviceX/in_voltageY_q_offset
>  What:		/sys/bus/iio/devices/iio:deviceX/in_currentY_offset
>  What:		/sys/bus/iio/devices/iio:deviceX/in_current_offset
> +What:		/sys/bus/iio/devices/iio:deviceX/out_phaseY_offset
> +What:		/sys/bus/iio/devices/iio:deviceX/out_phase_offset
> +What:		/sys/bus/iio/devices/iio:deviceX/out_frequencyY_offset
> +What:		/sys/bus/iio/devices/iio:deviceX/out_frequency_offset
>  What:		/sys/bus/iio/devices/iio:deviceX/in_tempY_offset
>  What:		/sys/bus/iio/devices/iio:deviceX/in_temp_offset
>  What:		/sys/bus/iio/devices/iio:deviceX/in_pressureY_offset
> @@ -474,6 +478,10 @@ What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_scale
>  What:		/sys/bus/iio/devices/iio:deviceX/in_voltage-voltage_scale
>  What:		/sys/bus/iio/devices/iio:deviceX/out_voltageY_scale
>  What:		/sys/bus/iio/devices/iio:deviceX/out_altvoltageY_scale
> +What:		/sys/bus/iio/devices/iio:deviceX/out_phaseY_scale
> +What:		/sys/bus/iio/devices/iio:deviceX/out_phase_scale
> +What:		/sys/bus/iio/devices/iio:deviceX/out_frequencyY_scale
> +What:		/sys/bus/iio/devices/iio:deviceX/out_frequency_scale

[Severity: Low]
Should the 'in_' variants for these scale and offset attributes be
documented here as well?

The description added later in this patch for in_frequencyY_raw mentions
that scale and offset are applied, but only the 'out_' variants are
being documented here.

>  What:		/sys/bus/iio/devices/iio:deviceX/in_currentY_scale
>  What:		/sys/bus/iio/devices/iio:deviceX/in_currentY_supply_scale

[ ... ]

> @@ -2147,7 +2155,16 @@ Description:
>  		specific attributes. This is useful for userspace to be able to
>  		better identify an individual channel.
>  
> +What:		/sys/bus/iio/devices/iio:deviceX/in_frequencyY_raw
> +What:		/sys/bus/iio/devices/iio:deviceX/out_frequencyY_raw

[Severity: Low]
The commit message notes that frequency channels will be introduced
later. Is it standard practice to document ABI attributes for a channel
type (like IIO_FREQUENCY) before the channel type exists in the IIO
core?

> +KernelVersion:	7.3
> +Contact:	linux-iio@vger.kernel.org
> +Description:
> +		Raw (unscaled) frequency reading from channel Y.
> +		Units after application of scale and offset are Hz.
> +
>  What:		/sys/bus/iio/devices/iio:deviceX/in_phaseY_raw
> +What:		/sys/bus/iio/devices/iio:deviceX/out_phaseY_raw
>  KernelVersion:	4.18

[Severity: Low]
Does grouping out_phaseY_raw here incorrectly imply that it was
introduced in KernelVersion 4.18, rather than the current release?

>  Contact:	linux-iio@vger.kernel.org
>  Description:

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20260714-ad9910-iio-driver-v8-0-36939c3c07d2@analog.com?part=2