Commit d0d71055 authored by Javier Carrasco's avatar Javier Carrasco Committed by Guenter Roeck

ABI: sysfs-class-hwmon: document missing humidity attributes

All these attributes already exist and are used by the hwmon subsystem,
but they still must be documented.

The missing attributes are the following:
- humidityY_alarm
- humidityY_fault
- humidityY_label
- humidityY_max
- humidityY_max_hyst
- humidityY_min
- humidityY_min_hyst

Add the missing humidity attributes to the ABI documentation according
to their current usage and access rights in the hwmon subsystem.
Signed-off-by: default avatarJavier Carrasco <javier.carrasco.cruz@gmail.com>
Link: https://lore.kernel.org/r/20231116-hwmon_abi-v1-2-8bfb7f51145a@gmail.comSigned-off-by: default avatarGuenter Roeck <linux@roeck-us.net>
parent 02d0fdd4
...@@ -887,6 +887,15 @@ Description: ...@@ -887,6 +887,15 @@ Description:
RW RW
What: /sys/class/hwmon/hwmonX/humidityY_alarm
Description:
Humidity limit detection
- 0: OK
- 1: Humidity limit has been reached
RO
What: /sys/class/hwmon/hwmonX/humidityY_enable What: /sys/class/hwmon/hwmonX/humidityY_enable
Description: Description:
Enable or disable the sensors Enable or disable the sensors
...@@ -899,6 +908,15 @@ Description: ...@@ -899,6 +908,15 @@ Description:
RW RW
What: /sys/class/hwmon/hwmonX/humidityY_fault
Description:
Reports a humidity sensor failure.
- 1: Failed
- 0: Ok
RO
What: /sys/class/hwmon/hwmonX/humidityY_input What: /sys/class/hwmon/hwmonX/humidityY_input
Description: Description:
Humidity Humidity
...@@ -907,6 +925,57 @@ Description: ...@@ -907,6 +925,57 @@ Description:
RO RO
What: /sys/class/hwmon/hwmonX/humidityY_label
Description:
Suggested humidity channel label.
Text string
Should only be created if the driver has hints about what
this humidity channel is being used for, and user-space
doesn't. In all other cases, the label is provided by
user-space.
RO
What: /sys/class/hwmon/hwmonX/humidityY_max
Description:
Humidity max value.
Unit: milli-percent (per cent mille, pcm)
RW
What: /sys/class/hwmon/hwmonX/humidityY_max_hyst
Description:
Humidity hysteresis value for max limit.
Unit: milli-percent (per cent mille, pcm)
Must be reported as an absolute humidity, NOT a delta
from the max value.
RW
What: /sys/class/hwmon/hwmonX/humidityY_min
Description:
Humidity min value.
Unit: milli-percent (per cent mille, pcm)
RW
What: /sys/class/hwmon/hwmonX/humidityY_min_hyst
Description:
Humidity hysteresis value for min limit.
Unit: milli-percent (per cent mille, pcm)
Must be reported as an absolute humidity, NOT a delta
from the min value.
RW
What: /sys/class/hwmon/hwmonX/humidityY_rated_min What: /sys/class/hwmon/hwmonX/humidityY_rated_min
Description: Description:
Minimum rated humidity. Minimum rated humidity.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment