diff mbox series

[4/5,V2] Documentation: ABI: testing: ad7192: update sysfs docs

Message ID 20200205171511.25912-5-alexandru.tachici@analog.com (mailing list archive)
State New, archived
Headers show
Series iio: adc: ad7192: move out of staging | expand

Commit Message

Alexandru Tachici Feb. 5, 2020, 5:15 p.m. UTC 
Updated mainline documentation on ad7192 userspace sysfs.

Signed-off-by: Alexandru Tachici <alexandru.tachici@analog.com>
---
 .../ABI/testing/sysfs-bus-iio-adc-ad7192      | 17 ++++++++++------
 .../iio/Documentation/sysfs-bus-iio-ad7192    | 20 -------------------
 2 files changed, 11 insertions(+), 26 deletions(-)
 delete mode 100644 drivers/staging/iio/Documentation/sysfs-bus-iio-ad7192

Comments

Jonathan Cameron Feb. 6, 2020, 10:05 a.m. UTC | #1 
On Wed, 5 Feb 2020 19:15:10 +0200
Alexandru Tachici <alexandru.tachici@analog.com> wrote:

> Updated mainline documentation on ad7192 userspace sysfs.
> 
> Signed-off-by: Alexandru Tachici <alexandru.tachici@analog.com>
looks good, but the shorted channel docs need to be added as well
unless I'm missing something.

Thanks,

Jonathan

> ---
>  .../ABI/testing/sysfs-bus-iio-adc-ad7192      | 17 ++++++++++------
>  .../iio/Documentation/sysfs-bus-iio-ad7192    | 20 -------------------
>  2 files changed, 11 insertions(+), 26 deletions(-)
>  delete mode 100644 drivers/staging/iio/Documentation/sysfs-bus-iio-ad7192
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7192 b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7192
> index 7627d3be08f5..9be6b8a69a19 100644
> --- a/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7192
> +++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7192
> @@ -2,17 +2,22 @@ What:		/sys/bus/iio/devices/iio:deviceX/ac_excitation_en
>  KernelVersion:
>  Contact:	linux-iio@vger.kernel.org
>  Description:
> -		Reading gives the state of AC excitation.
> -		Writing '1' enables AC excitation.
> +		This attribute, if available, is used to enable the AC
> +		excitation mode found on some converters. In ac excitation mode,
> +		the polarity of the excitation voltage is reversed on
> +		alternate cycles, to eliminate DC errors.
>  
>  What:		/sys/bus/iio/devices/iio:deviceX/bridge_switch_en
>  KernelVersion:
>  Contact:	linux-iio@vger.kernel.org
>  Description:
> -		This bridge switch is used to disconnect it when there is a
> -		need to minimize the system current consumption.
> -		Reading gives the state of the bridge switch.
> -		Writing '1' enables the bridge switch.
> +		This attribute, if available, is used to close or open the
> +		bridge power down switch found on some converters.
> +		In bridge applications, such as strain gauges and load cells,
> +		the bridge itself consumes the majority of the current in the
> +		system. To minimize the current consumption of the system,
> +		the bridge can be disconnected (when it is not being used
> +		using the bridge_switch_en attribute.
>  
>  What:		/sys/bus/iio/devices/iio:deviceX/in_voltagex_sys_calibration
>  KernelVersion:
> diff --git a/drivers/staging/iio/Documentation/sysfs-bus-iio-ad7192 b/drivers/staging/iio/Documentation/sysfs-bus-iio-ad7192
> deleted file mode 100644
> index 1c35c507cc05..000000000000
> --- a/drivers/staging/iio/Documentation/sysfs-bus-iio-ad7192
> +++ /dev/null
> @@ -1,20 +0,0 @@
> -What:		/sys/.../iio:deviceX/ac_excitation_en
> -KernelVersion:	3.1.0
> -Contact:	linux-iio@vger.kernel.org
> -Description:
> -		This attribute, if available, is used to enable the AC
> -		excitation mode found on some converters. In ac excitation mode,
> -		the polarity of the excitation voltage is reversed on
> -		alternate cycles, to eliminate DC errors.
> -
> -What:		/sys/.../iio:deviceX/bridge_switch_en
> -KernelVersion:	3.1.0
> -Contact:	linux-iio@vger.kernel.org
> -Description:
> -		This attribute, if available, is used to close or open the
> -		bridge power down switch found on some converters.
> -		In bridge applications, such as strain gauges and load cells,
> -		the bridge itself consumes the majority of the current in the
> -		system. To minimize the current consumption of the system,
> -		the bridge can be disconnected (when it is not being used
> -		using the bridge_switch_en attribute.
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7192 b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7192
index 7627d3be08f5..9be6b8a69a19 100644
--- a/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7192
+++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7192
@@ -2,17 +2,22 @@  What:		/sys/bus/iio/devices/iio:deviceX/ac_excitation_en
 KernelVersion:
 Contact:	linux-iio@vger.kernel.org
 Description:
-		Reading gives the state of AC excitation.
-		Writing '1' enables AC excitation.
+		This attribute, if available, is used to enable the AC
+		excitation mode found on some converters. In ac excitation mode,
+		the polarity of the excitation voltage is reversed on
+		alternate cycles, to eliminate DC errors.
 
 What:		/sys/bus/iio/devices/iio:deviceX/bridge_switch_en
 KernelVersion:
 Contact:	linux-iio@vger.kernel.org
 Description:
-		This bridge switch is used to disconnect it when there is a
-		need to minimize the system current consumption.
-		Reading gives the state of the bridge switch.
-		Writing '1' enables the bridge switch.
+		This attribute, if available, is used to close or open the
+		bridge power down switch found on some converters.
+		In bridge applications, such as strain gauges and load cells,
+		the bridge itself consumes the majority of the current in the
+		system. To minimize the current consumption of the system,
+		the bridge can be disconnected (when it is not being used
+		using the bridge_switch_en attribute.
 
 What:		/sys/bus/iio/devices/iio:deviceX/in_voltagex_sys_calibration
 KernelVersion:
diff --git a/drivers/staging/iio/Documentation/sysfs-bus-iio-ad7192 b/drivers/staging/iio/Documentation/sysfs-bus-iio-ad7192
deleted file mode 100644
index 1c35c507cc05..000000000000
--- a/drivers/staging/iio/Documentation/sysfs-bus-iio-ad7192
+++ /dev/null
@@ -1,20 +0,0 @@ 
-What:		/sys/.../iio:deviceX/ac_excitation_en
-KernelVersion:	3.1.0
-Contact:	linux-iio@vger.kernel.org
-Description:
-		This attribute, if available, is used to enable the AC
-		excitation mode found on some converters. In ac excitation mode,
-		the polarity of the excitation voltage is reversed on
-		alternate cycles, to eliminate DC errors.
-
-What:		/sys/.../iio:deviceX/bridge_switch_en
-KernelVersion:	3.1.0
-Contact:	linux-iio@vger.kernel.org
-Description:
-		This attribute, if available, is used to close or open the
-		bridge power down switch found on some converters.
-		In bridge applications, such as strain gauges and load cells,
-		the bridge itself consumes the majority of the current in the
-		system. To minimize the current consumption of the system,
-		the bridge can be disconnected (when it is not being used
-		using the bridge_switch_en attribute.