diff mbox series

[3/3] iio: Add relative hysteresis in ABI documentation

Message ID 20210201074358.18435-4-xiang.ye@intel.com
State New
Headers show
Series Add relative hysteresis support for hid sensors | expand

Commit Message

Ye Xiang Feb. 1, 2021, 7:43 a.m. UTC
Add relative hysteresis in ABI documentation.

Signed-off-by: Ye Xiang <xiang.ye@intel.com>
---
 Documentation/ABI/testing/sysfs-bus-iio | 8 ++++++++
 1 file changed, 8 insertions(+)

Comments

Jonathan Cameron Feb. 6, 2021, 4:46 p.m. UTC | #1
On Mon,  1 Feb 2021 15:43:58 +0800
Ye Xiang <xiang.ye@intel.com> wrote:

> Add relative hysteresis in ABI documentation.

> 

> Signed-off-by: Ye Xiang <xiang.ye@intel.com>

> ---

>  Documentation/ABI/testing/sysfs-bus-iio | 8 ++++++++

>  1 file changed, 8 insertions(+)

> 

> diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio

> index d957f5da5c04..1c51db7eb8ef 100644

> --- a/Documentation/ABI/testing/sysfs-bus-iio

> +++ b/Documentation/ABI/testing/sysfs-bus-iio

> @@ -1823,3 +1823,11 @@ Description:

>  		hinge, keyboard, screen. It means the three channels

>  		each correspond respectively to hinge angle, keyboard angle,

>  		and screen angle.

> +

> +What:		/sys/bus/iio/devices/iio:deviceX/in_Y_hysteresis_relative


I'm rather undecided on whether a generic catch all for sensor types here makes
sense. Given we aren't currently applying it to too many devices, I think
I'd prefer we documented this for the particular entries we are adding as
that is the approach that we've taken for the majority of the rest of the
main ABI doc.   Note that tidying this doc up has been something I've wanted
to look at doing for a while, so it's possible I'll revisit this decision
at that time.

Otherwise, this looks good.

Thanks,

Jonathan


> +KernelVersion:	5.12

> +Contact:	linux-iio@vger.kernel.org

> +Description:

> +		Specify the percent relative to the current sensor channel

> +		Y absolute value that a data field should change before an event

> +		is generated. Units are a percentage of the prior reading.
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
index d957f5da5c04..1c51db7eb8ef 100644
--- a/Documentation/ABI/testing/sysfs-bus-iio
+++ b/Documentation/ABI/testing/sysfs-bus-iio
@@ -1823,3 +1823,11 @@  Description:
 		hinge, keyboard, screen. It means the three channels
 		each correspond respectively to hinge angle, keyboard angle,
 		and screen angle.
+
+What:		/sys/bus/iio/devices/iio:deviceX/in_Y_hysteresis_relative
+KernelVersion:	5.12
+Contact:	linux-iio@vger.kernel.org
+Description:
+		Specify the percent relative to the current sensor channel
+		Y absolute value that a data field should change before an event
+		is generated. Units are a percentage of the prior reading.