diff options
author | Javier Carrasco <javier.carrasco.cruz@gmail.com> | 2023-11-17 09:40:35 +0300 |
---|---|---|
committer | Guenter Roeck <linux@roeck-us.net> | 2023-12-11 17:21:00 +0300 |
commit | d0d710554ef0454a97dde2c114f7d5b2a3c2b4de (patch) | |
tree | d63f54384b08510658bec2d03600cecd3eb0a0b9 /Documentation/ABI | |
parent | 02d0fdd4842500c27c0c5e2759de29bc79f1924d (diff) | |
download | linux-d0d710554ef0454a97dde2c114f7d5b2a3c2b4de.tar.xz |
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: Javier Carrasco <javier.carrasco.cruz@gmail.com>
Link: https://lore.kernel.org/r/20231116-hwmon_abi-v1-2-8bfb7f51145a@gmail.com
Signed-off-by: Guenter Roeck <linux@roeck-us.net>
Diffstat (limited to 'Documentation/ABI')
-rw-r--r-- | Documentation/ABI/testing/sysfs-class-hwmon | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/Documentation/ABI/testing/sysfs-class-hwmon b/Documentation/ABI/testing/sysfs-class-hwmon index b998a42add95..dccbcdc2dad8 100644 --- a/Documentation/ABI/testing/sysfs-class-hwmon +++ b/Documentation/ABI/testing/sysfs-class-hwmon @@ -887,6 +887,15 @@ Description: 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 Description: Enable or disable the sensors @@ -899,6 +908,15 @@ Description: 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 Description: Humidity @@ -907,6 +925,57 @@ Description: 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 Description: Minimum rated humidity. |