Re: [PATCH v2 2/2] iio: adc: ad-sigma-delta: Document ABI for sigma delta adc

[Guillaume Ranquet]

On Sat, 30 Nov 2024 20:06, Jonathan Cameron <jic23@xxxxxxxxxx> wrote:
>On Wed, 27 Nov 2024 10:06:14 +0100
>Guillaume Ranquet <granquet@xxxxxxxxxxxx> wrote:
>
>> Add common calibration nodes for sigma delta adc.
>>
>> Signed-off-by: Guillaume Ranquet <granquet@xxxxxxxxxxxx>
>Hi Guillaume.
>
>I think there are some issues with the old docs that should be tidied up whilst
>we are here :(

Hi Jonathan,
No problem, will do :)

>
>Just fix them up in this patch then mention it in the patch description.
>Or if you prefer move and then fix in separate patches.
>
>
>Jonathan
>
>> ---
>>  .../ABI/testing/sysfs-bus-iio-adc-ad-sigma-delta   | 23 +++++++++++++++++++++
>>  Documentation/ABI/testing/sysfs-bus-iio-adc-ad7192 | 24 ----------------------
>>  2 files changed, 23 insertions(+), 24 deletions(-)
>>
>> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-ad-sigma-delta b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad-sigma-delta
>> new file mode 100644
>> index 0000000000000000000000000000000000000000..c2c55a966163736aea8d46fc5089c08dac747b84
>> --- /dev/null
>> +++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad-sigma-delta
>> @@ -0,0 +1,23 @@
>> +What:		/sys/bus/iio/devices/iio:deviceX/in_voltagex_sys_calibration
>in_voltageY_sys_calibration
>
>(as indices are capital letters and X is used earlier).
>
>
>> +KernelVersion:
>Make an estimate of this I'll never remember to fill them in whilst applying.
>
>It should make the next merge window I hope!
>
>> +Contact:	linux-iio@xxxxxxxxxxxxxxx
>> +Description:
>> +		This attribute, if available, initiates the system calibration procedure. This is done on a
>> +		single channel at a time. Write '1' to start the calibration.
>> +
>> +What:		/sys/bus/iio/devices/iio:deviceX/in_voltagex_sys_calibration_mode_available
>> +KernelVersion:
>> +Contact:	linux-iio@xxxxxxxxxxxxxxx
>> +Description:
>> +		This attribute, if available, returns a list with the possible calibration modes.
>> +		There are two available options:
>> +		"zero_scale" - calibrate to zero scale
>> +		"full_scale" - calibrate to full scale
>> +
>> +What:		/sys/bus/iio/devices/iio:deviceX/in_voltagex_sys_calibration_mode
>> +KernelVersion:
>> +Contact:	linux-iio@xxxxxxxxxxxxxxx
>> +Description:
>> +		This attribute, if available, sets up the calibration mode used in the system calibration
>> +		procedure. Reading returns the current calibration mode.
>> +		Writing sets the system calibration mode.
>> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7192 b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7192
>> index f8315202c8f0df2bd4b7216f5cf8d3c2780fcf3f..28be1cabf1124ac7593392e17e4759ddfac829e8 100644
>> --- a/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7192
>> +++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7192
>> @@ -19,33 +19,9 @@ Description:
>>  		the bridge can be disconnected (when it is not being used
>>  		using the bridge_switch_en attribute.
>>
>> -What:		/sys/bus/iio/devices/iio:deviceX/in_voltagex_sys_calibration
>Huh.  That would explain the x above. I assume it is per channel?
>
Yes, calibration is per channel.

>> -KernelVersion:
>> -Contact:	linux-iio@xxxxxxxxxxxxxxx
>> -Description:
>> -		Initiates the system calibration procedure. This is done on a
>> -		single channel at a time. Write '1' to start the calibration.
>> -
>>  What:		/sys/bus/iio/devices/iio:deviceX/in_voltage2-voltage2_shorted_raw
>>  KernelVersion:
>>  Contact:	linux-iio@xxxxxxxxxxxxxxx
>>  Description:
>>  		Measure voltage from AIN2 pin connected to AIN(+)
>>  		and AIN(-) shorted.
>> -
>> -What:		/sys/bus/iio/devices/iio:deviceX/in_voltagex_sys_calibration_mode_available
>> -KernelVersion:
>> -Contact:	linux-iio@xxxxxxxxxxxxxxx
>> -Description:
>> -		Reading returns a list with the possible calibration modes.
>> -		There are two available options:
>> -		"zero_scale" - calibrate to zero scale
>> -		"full_scale" - calibrate to full scale
>> -
>> -What:		/sys/bus/iio/devices/iio:deviceX/in_voltagex_sys_calibration_mode
>> -KernelVersion:
>> -Contact:	linux-iio@xxxxxxxxxxxxxxx
>> -Description:
>> -		Sets up the calibration mode used in the system calibration
>> -		procedure. Reading returns the current calibration mode.
>> -		Writing sets the system calibration mode.
>>