Commit 6c6a6ee9 authored by Jonathan Cameron's avatar Jonathan Cameron
Browse files

iio: ABI: temperature: Unify documentation for thermocouple fault detection. 



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: default avatarJonathan Cameron <Jonathan.Cameron@huawei.com>
Cc: Navin Sankar Velliangiri <navin@linumiz.com>
Cc: Paresh Chaudhary <paresh.chaudhary@rockwellcollins.com>
Reviewed-by: default avatarMauro Carvalho Chehab <mchehab@kernel.org>
Link: https://lore.kernel.org/r/20220626165511.602202-2-jic23@kernel.org
parent 295cc426

Documentation/ABI/testing/sysfs-bus-iio-temperature-max31865

+0 −12
Original line number Diff line number Diff line 
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

Documentation/ABI/testing/sysfs-bus-iio-temperature-max31856→Documentation/ABI/testing/sysfs-bus-iio-thermocouple

+10 −23
Original line number Diff line number Diff line 
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.

		cables. The device can also detect if such a condition occurs.



		Reading returns either '1' or '0'.

		Reading returns '1' if input voltage is negative or greater

		than VDD, otherwise '0'.



		===  =======================================================

		'1'  The input voltage is negative or greater than VDD.

		'0'  The input voltage is positive and less than VDD (normal

		     state).

		===  =======================================================
 
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.