Re: [PATCH v6 3/3] Documentation:ABI:testing:admv1013: add ABI docs

[Jonathan Cameron <jic23@kernel.org>]

On Mon, 6 Dec 2021 17:48:45 +0200
Antoniu Miclaus <antoniu.miclaus@analog.com> wrote:

> Add documentation for the use of the Local Oscillator Feedthrough Offset
> calibration.
> 
> Signed-off-by: Antoniu Miclaus <antoniu.miclaus@analog.com>
> ---
> changes in v6:
>  - update iio channels
>  - remove frequency mode
>  .../testing/sysfs-bus-iio-frequency-admv1013  | 38 +++++++++++++++++++
>  1 file changed, 38 insertions(+)
>  create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-frequency-admv1013
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-frequency-admv1013 b/Documentation/ABI/testing/sysfs-bus-iio-frequency-admv1013
> new file mode 100644
> index 000000000000..3be68dd54ed4
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-bus-iio-frequency-admv1013
> @@ -0,0 +1,38 @@
> +What:		/sys/bus/iio/devices/iio:deviceX/in_altvoltage0-1_i_phase

> +KernelVersion:

Please fill these in. We might need to update them, but better to be out by one cycle
rather than have them blank I think.

> +Contact:	linux-iio@vger.kernel.org
> +Description:
> +		Read/write value for the Local Oscillatior path quadrature I phase shift.

As per patch 1 review.  The open issue here is phase has defined units as radians
but we don't know what the scaling of this is beyond vague hints in the datasheet.
So maybe we need to expand the ABI to allow for calibphase?  Much like calibbias in
general we'd assume that was of unknown scaling...

I'm fully open to other suggestions as I'm not particularly happy with any options
I've thought of for this.

> +
> +What:		/sys/bus/iio/devices/iio:deviceX/in_altvoltage0-1_i_phase
> +KernelVersion:
> +Contact:	linux-iio@vger.kernel.org
> +Description:
> +		Read/write value for the Local Oscillatior path quadrature Q phase shift.
> +
> +What:		/sys/bus/iio/devices/iio:deviceX/in_altvoltage0_i_calibbias
> +KernelVersion:
> +Contact:	linux-iio@vger.kernel.org
> +Description:
> +		Read/write value for the Local Oscillatior Feedthrough Offset Calibration I Positive
> +		side.
> +
> +What:		/sys/bus/iio/devices/iio:deviceX/in_altvoltage0_q_calibbias
> +KernelVersion:
> +Contact:	linux-iio@vger.kernel.org
> +Description:
> +		Read/write value for the Local Oscillatior Feedthrough Offset Calibration Q Positive side.
> +
> +What:		/sys/bus/iio/devices/iio:deviceX/in_altvoltage1_i_calibbias
> +KernelVersion:
> +Contact:	linux-iio@vger.kernel.org
> +Description:
> +		Read/write raw value for the Local Oscillatior Feedthrough Offset Calibration I Negative
> +		side.
> +
> +What:		/sys/bus/iio/devices/iio:deviceX/in_altvoltage1_q_calibbias
> +KernelVersion:
> +Contact:	linux-iio@vger.kernel.org
> +Description:
> +		Read/write raw value for the Local Oscillatior Feedthrough Offset Calibration Q Negative
> +		side.