]> git.baikalelectronics.ru Git - kernel.git/commitdiff
iio: ABI: temperature: Unify documentation for thermocouple fault detection.
authorJonathan Cameron <Jonathan.Cameron@huawei.com>
Sun, 26 Jun 2022 16:55:08 +0000 (17:55 +0100)
committerJonathan Cameron <Jonathan.Cameron@huawei.com>
Mon, 18 Jul 2022 17:38:27 +0000 (18:38 +0100)
Kernel documentation for a given ABI element should not be duplicated
in multiple files, so pull them into one higher level documentation file.

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Cc: Navin Sankar Velliangiri <navin@linumiz.com>
Cc: Paresh Chaudhary <paresh.chaudhary@rockwellcollins.com>
Reviewed-by: Mauro Carvalho Chehab <mchehab@kernel.org>
Link: https://lore.kernel.org/r/20220626165511.602202-2-jic23@kernel.org
Documentation/ABI/testing/sysfs-bus-iio-temperature-max31856 [deleted file]
Documentation/ABI/testing/sysfs-bus-iio-temperature-max31865
Documentation/ABI/testing/sysfs-bus-iio-thermocouple [new file with mode: 0644]

diff --git a/Documentation/ABI/testing/sysfs-bus-iio-temperature-max31856 b/Documentation/ABI/testing/sysfs-bus-iio-temperature-max31856
deleted file mode 100644 (file)
index e5ef6d8..0000000
+++ /dev/null
@@ -1,31 +0,0 @@
-What:          /sys/bus/iio/devices/iio:deviceX/fault_oc
-KernelVersion: 5.1
-Contact:       linux-iio@vger.kernel.org
-Description:
-               Open-circuit fault. The detection of open-circuit faults,
-               such as those caused by broken thermocouple wires.
-               Reading returns either '1' or '0'.
-
-               ===  =======================================================
-               '1'  An open circuit such as broken thermocouple wires
-                    has been detected.
-               '0'  No open circuit or broken thermocouple wires are detected
-               ===  =======================================================
-
-What:          /sys/bus/iio/devices/iio:deviceX/fault_ovuv
-KernelVersion: 5.1
-Contact:       linux-iio@vger.kernel.org
-Description:
-               Overvoltage or Undervoltage Input Fault. The internal circuitry
-               is protected from excessive voltages applied to the thermocouple
-               cables by integrated MOSFETs at the T+ and T- inputs, and the
-               BIAS output. These MOSFETs turn off when the input voltage is
-               negative or greater than VDD.
-
-               Reading returns either '1' or '0'.
-
-               ===  =======================================================
-               '1'  The input voltage is negative or greater than VDD.
-               '0'  The input voltage is positive and less than VDD (normal
-                    state).
-               ===  =======================================================
index 4b072da92218de570a425cb1581bc00b7b8a136d..349089e4f2d6285fe34f68b0d0399633eb808cfc 100644 (file)
@@ -1,15 +1,3 @@
-What:          /sys/bus/iio/devices/iio:deviceX/fault_ovuv
-KernelVersion: 5.11
-Contact:       linux-iio@vger.kernel.org
-Description:
-               Overvoltage or Undervoltage Input fault. The internal circuitry
-               is protected from excessive voltages applied to the thermocouple
-               cables at FORCE+, FORCE2, RTDIN+ & RTDIN-. This circuitry turn
-               off when the input voltage is negative or greater than VDD.
-
-               Reading returns '1' if input voltage is negative or greater
-               than VDD, otherwise '0'.
-
 What:          /sys/bus/iio/devices/iio:deviceX/in_filter_notch_center_frequency
 KernelVersion: 5.11
 Contact:       linux-iio@vger.kernel.org
diff --git a/Documentation/ABI/testing/sysfs-bus-iio-thermocouple b/Documentation/ABI/testing/sysfs-bus-iio-thermocouple
new file mode 100644 (file)
index 0000000..01259df
--- /dev/null
@@ -0,0 +1,18 @@
+What:          /sys/bus/iio/devices/iio:deviceX/fault_ovuv
+KernelVersion: 5.1
+Contact:       linux-iio@vger.kernel.org
+Description:
+               Overvoltage or Undervoltage Input Fault. The internal circuitry
+               is protected from excessive voltages applied to the thermocouple
+               cables. The device can also detect if such a condition occurs.
+
+               Reading returns '1' if input voltage is negative or greater
+               than VDD, otherwise '0'.
+
+What:          /sys/bus/iio/devices/iio:deviceX/fault_oc
+KernelVersion: 5.1
+Contact:       linux-iio@vger.kernel.org
+Description:
+               Open-circuit fault. The detection of open-circuit faults,
+               such as those caused by broken thermocouple wires.
+               Reading returns '1' if fault, '0' otherwise.