| Message ID | 20240912121609.13438-3-ramona.nechita@analog.com (mailing list archive) |
|---|---|
| State | Changes Requested |
| Headers | show |
| Series | add support for ad777x family | expand |
On Thu, Sep 12, 2024 at 3:17 PM Ramona Alexandra Nechita <ramona.nechita@analog.com> wrote: > > The filter mode / filter type property is used for ad4130 > and ad7779 drivers, therefore the ABI doc file for ad4130 > was removed, merging both of them in the sysfs-bus-iio. ... > +What: /sys/bus/iio/devices/iio:deviceX/filter_type_available > +What: /sys/bus/iio/devices/iio:deviceX/in_voltage-voltage_filter_mode_available > +KernelVersion: 6.1 I believe I have already commented on this. The commit message keeps silent about version changes. Why? > +Contact: linux-iio@vger.kernel.org > +Description: > + Reading returns a list with the possible filter modes. Options > + for the attribute: > + * "sinc3" - The digital sinc3 filter. Moderate 1st conversion time. > + Good noise performance. > + * "sinc4" - Sinc 4. Excellent noise performance. Long > + 1st conversion time. > + * "sinc5" - The digital sinc5 filter. Excellent noise performance > + * "sinc4+sinc1" - Sinc4 + averaging by 8. Low 1st conversion > + time. > + * "sinc3+rej60" - Sinc3 + 60Hz rejection. > + * "sinc3+sinc1" - Sinc3 + averaging by 8. Low 1st conversion > + time. > + * "sinc3+pf1" - Sinc3 + device specific Post Filter 1. > + * "sinc3+pf2" - Sinc3 + device specific Post Filter 2. > + * "sinc3+pf3" - Sinc3 + device specific Post Filter 3. > + * "sinc3+pf4" - Sinc3 + device specific Post Filter 4. Also, the original file was more verbose for the complex cases, like "sinc3+pfX", why has this been changed?
Hi Ramona,
kernel test robot noticed the following build warnings:
[auto build test WARNING on jic23-iio/togreg]
[also build test WARNING on robh/for-next linus/master v6.11-rc7 next-20240912]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]
url: https://github.com/intel-lab-lkp/linux/commits/Ramona-Alexandra-Nechita/dt-bindings-iio-adc-add-a7779-doc/20240912-201936
base: https://git.kernel.org/pub/scm/linux/kernel/git/jic23/iio.git togreg
patch link: https://lore.kernel.org/r/20240912121609.13438-3-ramona.nechita%40analog.com
patch subject: [PATCH v5 2/3] Documentation: ABI: added filter mode doc in sysfs-bus-iio
reproduce: (https://download.01.org/0day-ci/archive/20240913/202409131243.olYA3Qdt-lkp@intel.com/reproduce)
If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202409131243.olYA3Qdt-lkp@intel.com/
All warnings (new ones prefixed by >>):
Warning: Documentation/devicetree/bindings/power/wakeup-source.txt references a file that doesn't exist: Documentation/devicetree/bindings/input/qcom,pm8xxx-keypad.txt
Warning: Documentation/devicetree/bindings/regulator/siliconmitus,sm5703-regulator.yaml references a file that doesn't exist: Documentation/devicetree/bindings/mfd/siliconmitus,sm5703.yaml
Warning: Documentation/hwmon/g762.rst references a file that doesn't exist: Documentation/devicetree/bindings/hwmon/g762.txt
>> Warning: MAINTAINERS references a file that doesn't exist: Documentation/ABI/testing/sysfs-bus-iio-adc-ad4130
Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/reserved-memory/qcom
Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/display/exynos/
Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/misc/fsl,qoriq-mc.txt
Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/nvmem/u-boot,env.yaml
Using alabaster theme
>> >> The filter mode / filter type property is used for ad4130 and ad7779 >> drivers, therefore the ABI doc file for ad4130 was removed, merging >> both of them in the sysfs-bus-iio. > >... > >> +What: /sys/bus/iio/devices/iio:deviceX/filter_type_available >> +What: /sys/bus/iio/devices/iio:deviceX/in_voltage-voltage_filter_mode_available >> +KernelVersion: 6.1 > >I believe I have already commented on this. The commit message keeps silent about version changes. Why? I mentioned it in the cover-letter, since the attributes of two devices were merged, and one of them was available in 6.1 ad the other in 6.2, it felt appropriate to leave it as 6.1. I was wondering if this is ok or if it should be kept as 6.2. Should this be mentioned in the commit message as well? > >> +Contact: linux-iio@vger.kernel.org >> +Description: >> + Reading returns a list with the possible filter modes. Options >> + for the attribute: >> + * "sinc3" - The digital sinc3 filter. Moderate 1st conversion time. >> + Good noise performance. >> + * "sinc4" - Sinc 4. Excellent noise performance. Long >> + 1st conversion time. >> + * "sinc5" - The digital sinc5 filter. Excellent noise performance >> + * "sinc4+sinc1" - Sinc4 + averaging by 8. Low 1st conversion >> + time. >> + * "sinc3+rej60" - Sinc3 + 60Hz rejection. >> + * "sinc3+sinc1" - Sinc3 + averaging by 8. Low 1st conversion >> + time. >> + * "sinc3+pf1" - Sinc3 + device specific Post Filter 1. >> + * "sinc3+pf2" - Sinc3 + device specific Post Filter 2. >> + * "sinc3+pf3" - Sinc3 + device specific Post Filter 3. >> + * "sinc3+pf4" - Sinc3 + device specific Post Filter 4. > >Also, the original file was more verbose for the complex cases, like "sinc3+pfX", why has this been changed? Since this is a more generic file I was advised to leave out specific details, should I include them just as they were in the original file? -- Best Regards, Ramona
On Fri, Sep 13, 2024 at 02:06:48PM +0000, Nechita, Ramona wrote: > >> > >> The filter mode / filter type property is used for ad4130 and ad7779 > >> drivers, therefore the ABI doc file for ad4130 was removed, merging > >> both of them in the sysfs-bus-iio. ... > >> +What: /sys/bus/iio/devices/iio:deviceX/filter_type_available > >> +What: /sys/bus/iio/devices/iio:deviceX/in_voltage-voltage_filter_mode_available > >> +KernelVersion: 6.1 > > > >I believe I have already commented on this. The commit message keeps silent about version changes. Why? > > I mentioned it in the cover-letter, since the attributes of two devices were > merged, and one of them was available in 6.1 ad the other in 6.2, it felt > appropriate to leave it as 6.1. > I was wondering if this is ok or if it should be kept as 6.2. Should this be > mentioned in the commit message as well? Please, mention in the commit message. > >> +Contact: linux-iio@vger.kernel.org > >> +Description: > >> + Reading returns a list with the possible filter modes. Options > >> + for the attribute: > >> + * "sinc3" - The digital sinc3 filter. Moderate 1st conversion time. > >> + Good noise performance. > >> + * "sinc4" - Sinc 4. Excellent noise performance. Long > >> + 1st conversion time. > >> + * "sinc5" - The digital sinc5 filter. Excellent noise performance > >> + * "sinc4+sinc1" - Sinc4 + averaging by 8. Low 1st conversion > >> + time. > >> + * "sinc3+rej60" - Sinc3 + 60Hz rejection. > >> + * "sinc3+sinc1" - Sinc3 + averaging by 8. Low 1st conversion > >> + time. > >> + * "sinc3+pf1" - Sinc3 + device specific Post Filter 1. > >> + * "sinc3+pf2" - Sinc3 + device specific Post Filter 2. > >> + * "sinc3+pf3" - Sinc3 + device specific Post Filter 3. > >> + * "sinc3+pf4" - Sinc3 + device specific Post Filter 4. > > > >Also, the original file was more verbose for the complex cases, like > >"sinc3+pfX", why has this been changed? > > Since this is a more generic file I was advised to leave out specific > details, should I include them just as they were in the original file? I would leave the examples for the mentioned chip in the parentheses. But it's up to Jonathan, I have no such device anyway, so personally I'm not affected :-)
On Fri, 13 Sep 2024 20:36:32 +0300 Andy Shevchenko <andy.shevchenko@gmail.com> wrote: > On Fri, Sep 13, 2024 at 02:06:48PM +0000, Nechita, Ramona wrote: > > >> > > >> The filter mode / filter type property is used for ad4130 and ad7779 > > >> drivers, therefore the ABI doc file for ad4130 was removed, merging > > >> both of them in the sysfs-bus-iio. > > ... > > > >> +What: /sys/bus/iio/devices/iio:deviceX/filter_type_available > > >> +What: /sys/bus/iio/devices/iio:deviceX/in_voltage-voltage_filter_mode_available > > >> +KernelVersion: 6.1 > > > > > >I believe I have already commented on this. The commit message keeps silent about version changes. Why? > > > > I mentioned it in the cover-letter, since the attributes of two devices were > > merged, and one of them was available in 6.1 ad the other in 6.2, it felt > > appropriate to leave it as 6.1. > > I was wondering if this is ok or if it should be kept as 6.2. Should this be > > mentioned in the commit message as well? > > Please, mention in the commit message. > > > >> +Contact: linux-iio@vger.kernel.org > > >> +Description: > > >> + Reading returns a list with the possible filter modes. Options > > >> + for the attribute: > > >> + * "sinc3" - The digital sinc3 filter. Moderate 1st conversion time. > > >> + Good noise performance. > > >> + * "sinc4" - Sinc 4. Excellent noise performance. Long > > >> + 1st conversion time. > > >> + * "sinc5" - The digital sinc5 filter. Excellent noise performance > > >> + * "sinc4+sinc1" - Sinc4 + averaging by 8. Low 1st conversion > > >> + time. > > >> + * "sinc3+rej60" - Sinc3 + 60Hz rejection. > > >> + * "sinc3+sinc1" - Sinc3 + averaging by 8. Low 1st conversion > > >> + time. > > >> + * "sinc3+pf1" - Sinc3 + device specific Post Filter 1. > > >> + * "sinc3+pf2" - Sinc3 + device specific Post Filter 2. > > >> + * "sinc3+pf3" - Sinc3 + device specific Post Filter 3. > > >> + * "sinc3+pf4" - Sinc3 + device specific Post Filter 4. > > > > > >Also, the original file was more verbose for the complex cases, like > > >"sinc3+pfX", why has this been changed? > > > > Since this is a more generic file I was advised to leave out specific > > details, should I include them just as they were in the original file? > > I would leave the examples for the mentioned chip in the parentheses. But it's > up to Jonathan, I have no such device anyway, so personally I'm not affected > :-) It gets tricky as we gain more and more devices. Nice to have that data somewhere, but maybe a device specific document is more appropriate than keeping it in here? (i.e. not in the ABI docs, but in general IIO per device documentation similar to the docs added recently for various other ADI parts). Jonathan >
On Fri, 13 Sep 2024 12:16:34 +0800 kernel test robot <lkp@intel.com> wrote: > Hi Ramona, > > kernel test robot noticed the following build warnings: > > [auto build test WARNING on jic23-iio/togreg] > [also build test WARNING on robh/for-next linus/master v6.11-rc7 next-20240912] > [If your patch is applied to the wrong git tree, kindly drop us a note. > And when submitting patch, we suggest to use '--base' as documented in > https://git-scm.com/docs/git-format-patch#_base_tree_information] > > url: https://github.com/intel-lab-lkp/linux/commits/Ramona-Alexandra-Nechita/dt-bindings-iio-adc-add-a7779-doc/20240912-201936 > base: https://git.kernel.org/pub/scm/linux/kernel/git/jic23/iio.git togreg > patch link: https://lore.kernel.org/r/20240912121609.13438-3-ramona.nechita%40analog.com > patch subject: [PATCH v5 2/3] Documentation: ABI: added filter mode doc in sysfs-bus-iio > reproduce: (https://download.01.org/0day-ci/archive/20240913/202409131243.olYA3Qdt-lkp@intel.com/reproduce) > > If you fix the issue in a separate patch/commit (i.e. not just a new version of > the same patch/commit), kindly add following tags > | Reported-by: kernel test robot <lkp@intel.com> > | Closes: https://lore.kernel.org/oe-kbuild-all/202409131243.olYA3Qdt-lkp@intel.com/ > > All warnings (new ones prefixed by >>): > > Warning: Documentation/devicetree/bindings/power/wakeup-source.txt references a file that doesn't exist: Documentation/devicetree/bindings/input/qcom,pm8xxx-keypad.txt > Warning: Documentation/devicetree/bindings/regulator/siliconmitus,sm5703-regulator.yaml references a file that doesn't exist: Documentation/devicetree/bindings/mfd/siliconmitus,sm5703.yaml > Warning: Documentation/hwmon/g762.rst references a file that doesn't exist: Documentation/devicetree/bindings/hwmon/g762.txt > >> Warning: MAINTAINERS references a file that doesn't exist: Documentation/ABI/testing/sysfs-bus-iio-adc-ad4130 Ah. Ramona, make sure to delete this reference as well in this patch. Thanks, Jonathan > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/reserved-memory/qcom > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/display/exynos/ > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/misc/fsl,qoriq-mc.txt > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/nvmem/u-boot,env.yaml > Using alabaster theme >
diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio index 345d58535dc9..aac41e69aa43 100644 --- a/Documentation/ABI/testing/sysfs-bus-iio +++ b/Documentation/ABI/testing/sysfs-bus-iio @@ -2265,6 +2265,28 @@ Description: An example format is 16-bytes, 2-digits-per-byte, HEX-string representing the sensor unique ID number. +What: /sys/bus/iio/devices/iio:deviceX/filter_type_available +What: /sys/bus/iio/devices/iio:deviceX/in_voltage-voltage_filter_mode_available +KernelVersion: 6.1 +Contact: linux-iio@vger.kernel.org +Description: + Reading returns a list with the possible filter modes. Options + for the attribute: + * "sinc3" - The digital sinc3 filter. Moderate 1st conversion time. + Good noise performance. + * "sinc4" - Sinc 4. Excellent noise performance. Long + 1st conversion time. + * "sinc5" - The digital sinc5 filter. Excellent noise performance + * "sinc4+sinc1" - Sinc4 + averaging by 8. Low 1st conversion + time. + * "sinc3+rej60" - Sinc3 + 60Hz rejection. + * "sinc3+sinc1" - Sinc3 + averaging by 8. Low 1st conversion + time. + * "sinc3+pf1" - Sinc3 + device specific Post Filter 1. + * "sinc3+pf2" - Sinc3 + device specific Post Filter 2. + * "sinc3+pf3" - Sinc3 + device specific Post Filter 3. + * "sinc3+pf4" - Sinc3 + device specific Post Filter 4. + What: /sys/.../events/in_proximity_thresh_either_runningperiod KernelVersion: 6.6 Contact: linux-iio@vger.kernel.org diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-ad4130 b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad4130 deleted file mode 100644 index f24ed6687e90..000000000000 --- a/Documentation/ABI/testing/sysfs-bus-iio-adc-ad4130 +++ /dev/null @@ -1,46 +0,0 @@ -What: /sys/bus/iio/devices/iio:deviceX/in_voltage-voltage_filter_mode_available -KernelVersion: 6.2 -Contact: linux-iio@vger.kernel.org -Description: - Reading returns a list with the possible filter modes. - - * "sinc4" - Sinc 4. Excellent noise performance. Long - 1st conversion time. No natural 50/60Hz rejection. - - * "sinc4+sinc1" - Sinc4 + averaging by 8. Low 1st conversion - time. - - * "sinc3" - Sinc3. Moderate 1st conversion time. - Good noise performance. - - * "sinc3+rej60" - Sinc3 + 60Hz rejection. At a sampling - frequency of 50Hz, achieves simultaneous 50Hz and 60Hz - rejection. - - * "sinc3+sinc1" - Sinc3 + averaging by 8. Low 1st conversion - time. Best used with a sampling frequency of at least - 216.19Hz. - - * "sinc3+pf1" - Sinc3 + Post Filter 1. 53dB rejection @ - 50Hz, 58dB rejection @ 60Hz. - - * "sinc3+pf2" - Sinc3 + Post Filter 2. 70dB rejection @ - 50Hz, 70dB rejection @ 60Hz. - - * "sinc3+pf3" - Sinc3 + Post Filter 3. 99dB rejection @ - 50Hz, 103dB rejection @ 60Hz. - - * "sinc3+pf4" - Sinc3 + Post Filter 4. 103dB rejection @ - 50Hz, 109dB rejection @ 60Hz. - -What: /sys/bus/iio/devices/iio:deviceX/in_voltageY-voltageZ_filter_mode -KernelVersion: 6.2 -Contact: linux-iio@vger.kernel.org -Description: - Set the filter mode of the differential channel. When the filter - mode changes, the in_voltageY-voltageZ_sampling_frequency and - in_voltageY-voltageZ_sampling_frequency_available attributes - might also change to accommodate the new filter mode. - If the current sampling frequency is out of range for the new - filter mode, the sampling frequency will be changed to the - closest valid one.
The filter mode / filter type property is used for ad4130 and ad7779 drivers, therefore the ABI doc file for ad4130 was removed, merging both of them in the sysfs-bus-iio. Signed-off-by: Ramona Alexandra Nechita <ramona.nechita@analog.com> --- Documentation/ABI/testing/sysfs-bus-iio | 22 +++++++++ .../ABI/testing/sysfs-bus-iio-adc-ad4130 | 46 ------------------- 2 files changed, 22 insertions(+), 46 deletions(-) delete mode 100644 Documentation/ABI/testing/sysfs-bus-iio-adc-ad4130