[PATCH v2 2/6] ABI: sysfs-class-hwmon: add a description for fanY_fault

[Guenter Roeck]

On 11/28/22 15:02, nick.hawkins at hpe.com wrote:
> From: Nick Hawkins <nick.hawkins at hpe.com>
> 
> The fans are capable of reporting a fault to the CPLD controller which
> then reports it to the GXP SoC via PLREGS. This patch enables hwmon to
> be able to report these failures up to the HOST OS.
> 

This change is really completely unrelated to a CPLD or specific SoC.
The commit description is just confusing. It should simply state that
it documents the existing fanX_fault attribute.

Guenter

> Signed-off-by: Nick Hawkins <nick.hawkins at hpe.com>
> 
> ---
> 
> v2:
>   *No change
> ---
>   Documentation/ABI/testing/sysfs-class-hwmon | 9 +++++++++
>   1 file changed, 9 insertions(+)
> 
> diff --git a/Documentation/ABI/testing/sysfs-class-hwmon b/Documentation/ABI/testing/sysfs-class-hwmon
> index 7271781a23b2..638f4c6d4ec7 100644
> --- a/Documentation/ABI/testing/sysfs-class-hwmon
> +++ b/Documentation/ABI/testing/sysfs-class-hwmon
> @@ -276,6 +276,15 @@ Description:
>   
>   		RW
>   
> +What:		/sys/class/hwmon/hwmonX/fanY_fault
> +Description:
> +		Reports if a fan has reported failure.
> +
> +		- 1: Failed
> +		- 0: Ok
> +
> +		RO
> +
>   What:		/sys/class/hwmon/hwmonX/pwmY
>   Description:
>   		Pulse width modulation fan control.