iio: counter: Add deprecation markings for IIO Counter attributes
authorWilliam Breathitt Gray <vilhelm.gray@gmail.com>
Tue, 2 Apr 2019 06:30:46 +0000 (15:30 +0900)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Thu, 25 Apr 2019 19:33:41 +0000 (21:33 +0200)
The IIO counter subdirectory is now superceded by the Counter subsystem.
This patch adds deprecation warnings to the documentation of the
relevant IIO Counter sysfs attributes.

Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Documentation/ABI/testing/sysfs-bus-iio
Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8

index 864f8ef..6aef7db 100644 (file)
@@ -1656,6 +1656,8 @@ What:             /sys/bus/iio/devices/iio:deviceX/in_countY_raw
 KernelVersion: 4.10
 Contact:       linux-iio@vger.kernel.org
 Description:
+               This interface is deprecated; please use the Counter subsystem.
+
                Raw counter device counts from channel Y. For quadrature
                counters, multiplication by an available [Y]_scale results in
                the counts of a single quadrature signal phase from channel Y.
@@ -1664,6 +1666,8 @@ What:             /sys/bus/iio/devices/iio:deviceX/in_indexY_raw
 KernelVersion: 4.10
 Contact:       linux-iio@vger.kernel.org
 Description:
+               This interface is deprecated; please use the Counter subsystem.
+
                Raw counter device index value from channel Y. This attribute
                provides an absolute positional reference (e.g. a pulse once per
                revolution) which may be used to home positional systems as
@@ -1673,6 +1677,8 @@ What:             /sys/bus/iio/devices/iio:deviceX/in_count_count_direction_available
 KernelVersion: 4.12
 Contact:       linux-iio@vger.kernel.org
 Description:
+               This interface is deprecated; please use the Counter subsystem.
+
                A list of possible counting directions which are:
                - "up"  : counter device is increasing.
                - "down": counter device is decreasing.
@@ -1681,6 +1687,8 @@ What:             /sys/bus/iio/devices/iio:deviceX/in_countY_count_direction
 KernelVersion: 4.12
 Contact:       linux-iio@vger.kernel.org
 Description:
+               This interface is deprecated; please use the Counter subsystem.
+
                Raw counter device counters direction for channel Y.
 
 What:          /sys/bus/iio/devices/iio:deviceX/in_phaseY_raw
index 7fac2c2..bac3d0d 100644 (file)
@@ -6,6 +6,8 @@ What:           /sys/bus/iio/devices/iio:deviceX/in_index_synchronous_mode_available
 KernelVersion: 4.10
 Contact:       linux-iio@vger.kernel.org
 Description:
+               This interface is deprecated; please use the Counter subsystem.
+
                Discrete set of available values for the respective counter
                configuration are listed in this file.
 
@@ -13,6 +15,8 @@ What:         /sys/bus/iio/devices/iio:deviceX/in_countY_count_mode
 KernelVersion: 4.10
 Contact:       linux-iio@vger.kernel.org
 Description:
+               This interface is deprecated; please use the Counter subsystem.
+
                Count mode for channel Y. Four count modes are available:
                normal, range limit, non-recycle, and modulo-n. The preset value
                for channel Y is used by the count mode where required.
@@ -47,6 +51,8 @@ What:         /sys/bus/iio/devices/iio:deviceX/in_countY_noise_error
 KernelVersion: 4.10
 Contact:       linux-iio@vger.kernel.org
 Description:
+               This interface is deprecated; please use the Counter subsystem.
+
                Read-only attribute that indicates whether excessive noise is
                present at the channel Y count inputs in quadrature clock mode;
                irrelevant in non-quadrature clock mode.
@@ -55,6 +61,8 @@ What:         /sys/bus/iio/devices/iio:deviceX/in_countY_preset
 KernelVersion: 4.10
 Contact:       linux-iio@vger.kernel.org
 Description:
+               This interface is deprecated; please use the Counter subsystem.
+
                If the counter device supports preset registers, the preset
                count for channel Y is provided by this attribute.
 
@@ -62,6 +70,8 @@ What:         /sys/bus/iio/devices/iio:deviceX/in_countY_quadrature_mode
 KernelVersion: 4.10
 Contact:       linux-iio@vger.kernel.org
 Description:
+               This interface is deprecated; please use the Counter subsystem.
+
                Configure channel Y counter for non-quadrature or quadrature
                clock mode. Selecting non-quadrature clock mode will disable
                synchronous load mode. In quadrature clock mode, the channel Y
@@ -83,6 +93,8 @@ What:         /sys/bus/iio/devices/iio:deviceX/in_countY_set_to_preset_on_index
 KernelVersion: 4.10
 Contact:       linux-iio@vger.kernel.org
 Description:
+               This interface is deprecated; please use the Counter subsystem.
+
                Whether to set channel Y counter with channel Y preset value
                when channel Y index input is active, or continuously count.
                Valid attribute values are boolean.
@@ -91,6 +103,8 @@ What:                /sys/bus/iio/devices/iio:deviceX/in_indexY_index_polarity
 KernelVersion: 4.10
 Contact:       linux-iio@vger.kernel.org
 Description:
+               This interface is deprecated; please use the Counter subsystem.
+
                Active level of channel Y index input; irrelevant in
                non-synchronous load mode.
 
@@ -98,6 +112,8 @@ What:                /sys/bus/iio/devices/iio:deviceX/in_indexY_synchronous_mode
 KernelVersion: 4.10
 Contact:       linux-iio@vger.kernel.org
 Description:
+               This interface is deprecated; please use the Counter subsystem.
+
                Configure channel Y counter for non-synchronous or synchronous
                load mode. Synchronous load mode cannot be selected in
                non-quadrature clock mode.