ABI: sysfs-class-hwmon: document emergency/max/min temperature alarms

These attributes are widely used in the hwmon subsystem, but they still
must be documented.

Add tempY_emergency_alarm, tempY_max_alarm and tempY_min_alarm to the
ABI documentation according to their current usage and access rights in
the hwmon subsystem.

Signed-off-by: Javier Carrasco <javier.carrasco.cruz@gmail.com>
Link: https://lore.kernel.org/r/20231116-hwmon_abi-v1-4-8bfb7f51145a@gmail.com
Signed-off-by: Guenter Roeck <linux@roeck-us.net>

diff --git a/Documentation/ABI/testing/sysfs-class-hwmon b/Documentation/ABI/testing/sysfs-class-hwmon
index 3d5e6142ef0cb14146492b7af425ec6c8f7afbad..3dac923c9b0ef08b6ce32a4551d7e8d221c01a0a 100644 (file)
--- a/Documentation/ABI/testing/sysfs-class-hwmon
+++ b/Documentation/ABI/testing/sysfs-class-hwmon
@@ -381,6 +381,15 @@ Description:
 
                RW
 
+What:          /sys/class/hwmon/hwmonX/tempY_max_alarm
+Description:
+               Maximum temperature alarm flag.
+
+               - 0: OK
+               - 1: temperature has reached tempY_max
+
+               RO
+
 What:          /sys/class/hwmon/hwmonX/tempY_min
 Description:
                Temperature min value.
@@ -389,6 +398,15 @@ Description:
 
                RW
 
+What:          /sys/class/hwmon/hwmonX/tempY_min_alarm
+Description:
+               Minimum temperature alarm flag.
+
+               - 0: OK
+               - 1: temperature has reached tempY_min
+
+               RO
+
 What:          /sys/class/hwmon/hwmonX/tempY_max_hyst
 Description:
                Temperature hysteresis value for max limit.
@@ -457,6 +475,15 @@ Description:
 
                RW
 
+What:          /sys/class/hwmon/hwmonX/tempY_emergency_alarm
+Description:
+               Emergency high temperature alarm flag.
+
+               - 0: OK
+               - 1: temperature has reached tempY_emergency
+
+               RO
+
 What:          /sys/class/hwmon/hwmonX/tempY_emergency_hyst
 Description:
                Temperature hysteresis value for emergency limit.