| Message ID | f78c3dee381b23c17787f1e2bc9c5667741d407b.1736201898.git.Jonathan.Santos@analog.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | iio: adc: ad7768-1: Add features, improvements, and fixes | expand |
On 1/7/25 9:24 AM, Jonathan Santos wrote: > Add ABI documentation specific to the ad7768-1 device, detailing > the decimation_rate attribute for better clarity and usability. > > Signed-off-by: Jonathan Santos <Jonathan.Santos@analog.com> > --- > .../ABI/testing/sysfs-bus-iio-adc-ad7768-1 | 13 +++++++++++++ > 1 file changed, 13 insertions(+) > create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-adc-ad7768-1 > > diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7768-1 b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7768-1 > new file mode 100644 > index 000000000000..065247f07cfb > --- /dev/null > +++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7768-1 > @@ -0,0 +1,13 @@ > +What: /sys/bus/iio/devices/iio:deviceX/decimation_rate_available > +KernelVersion: > +Contact: linux-iio@vger.kernel.org > +Description: > + Reading returns a range of possible decimation rate values. > + > +What: /sys/bus/iio/devices/iio:deviceX/decimation_rate > +KernelVersion: > +Contact: linux-iio@vger.kernel.org > +Description: > + Sets up the decimation rate for the digital filter. This can > + directly impact in the final sampling frequency. Reading returns > + the decimation rate. Writing sets the decimation rate. If this only affects the filter, I would suggest to add `filter_` to the beginning of the attribute names. Also, an explanation of how to interpret the numbers would be helpful. It looks like a unitless number that acts a sort of a multiplier or divider, but that part isn't so clear to me. Or... Since the decimation rate affects the -3dB point of the filters we could use the standard IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY instead of introducing a new attribute.
diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7768-1 b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7768-1 new file mode 100644 index 000000000000..065247f07cfb --- /dev/null +++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7768-1 @@ -0,0 +1,13 @@ +What: /sys/bus/iio/devices/iio:deviceX/decimation_rate_available +KernelVersion: +Contact: linux-iio@vger.kernel.org +Description: + Reading returns a range of possible decimation rate values. + +What: /sys/bus/iio/devices/iio:deviceX/decimation_rate +KernelVersion: +Contact: linux-iio@vger.kernel.org +Description: + Sets up the decimation rate for the digital filter. This can + directly impact in the final sampling frequency. Reading returns + the decimation rate. Writing sets the decimation rate.
Add ABI documentation specific to the ad7768-1 device, detailing the decimation_rate attribute for better clarity and usability. Signed-off-by: Jonathan Santos <Jonathan.Santos@analog.com> --- .../ABI/testing/sysfs-bus-iio-adc-ad7768-1 | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-adc-ad7768-1