ABI: sysfs-class-hwmon: add a description for tempY_crit_alarm
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Thu, 30 Sep 2021 09:44:50 +0000 (11:44 +0200)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Tue, 5 Oct 2021 14:25:19 +0000 (16:25 +0200)
Such ABI symbol is currently not described. Document it.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/a14f98e1b23ea14cf14da3c3169955343ec28bbe.1632994837.git.mchehab+huawei@kernel.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Documentation/ABI/testing/sysfs-class-hwmon

index ea5a129ae082c8f6c6bcb8b14dcd122f782cd681..1f20687def44cb2998cfaf28bdfe5bd83712135b 100644 (file)
@@ -410,6 +410,20 @@ Description:
 
                RW
 
+What:          /sys/class/hwmon/hwmonX/tempY_crit_alarm
+Description:
+               Critical high temperature alarm flag.
+
+               - 0: OK
+               - 1: temperature has reached tempY_crit
+
+               RW
+
+               Contrary to regular alarm flags which clear themselves
+               automatically when read, this one sticks until cleared by
+               the user. This is done by writing 0 to the file. Writing
+               other values is unsupported.
+
 What:          /sys/class/hwmon/hwmonX/tempY_crit_hyst
 Description:
                Temperature hysteresis value for critical limit.