Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

iio: ABI: stm32-timer-trigger: Fuse unusual ABI into main doc.

We can't duplicate the description of sampling_frequency. This device
has some unusual requirements which we solved by giving a
sampling_frequency of 0 special meaning. As such add a note
about this unusual usage to the main documentation.

Whilst I don't particularly like this resolution, it is the best
I could come up with given earlier discussion on this topic.

Link: https://lore.kernel.org/linux-iio/20210315101217.00002c50@Huawei.com/
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Cc: Fabrice Gasnier <fabrice.gasnier@foss.st.com>
Reviewed-by: Mauro Carvalho Chehab <mchehab@kernel.org>
Link: https://lore.kernel.org/r/20220626165511.602202-4-jic23@kernel.org

+3 -8
+3
Documentation/ABI/testing/sysfs-bus-iio
··· 107 107 relevant directories. If it affects all of the above 108 108 then it is to be found in the base device directory. 109 109 110 + The stm32-timer-trigger has the additional characteristic that 111 + a sampling_frequency of 0 is defined to stop sampling. 112 + 110 113 What: /sys/bus/iio/devices/iio:deviceX/sampling_frequency_available 111 114 What: /sys/bus/iio/devices/iio:deviceX/in_intensity_sampling_frequency_available 112 115 What: /sys/bus/iio/devices/iio:deviceX/in_proximity_sampling_frequency_available
-8
Documentation/ABI/testing/sysfs-bus-iio-timer-stm32
··· 90 90 Reading returns the current master modes. 91 91 Writing set the master mode 92 92 93 - What: /sys/bus/iio/devices/triggerX/sampling_frequency 94 - KernelVersion: 4.11 95 - Contact: benjamin.gaignard@st.com 96 - Description: 97 - Reading returns the current sampling frequency. 98 - Writing an value different of 0 set and start sampling. 99 - Writing 0 stop sampling. 100 - 101 93 What: /sys/bus/iio/devices/iio:deviceX/in_count0_preset 102 94 KernelVersion: 4.12 103 95 Contact: benjamin.gaignard@st.com