2022-11-28 23:07:02

by Hawkins, Nick

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

From: Nick Hawkins <[email protected]>

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.

Signed-off-by: Nick Hawkins <[email protected]>

---

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.
--
2.17.1


2022-11-29 04:35:14

by Guenter Roeck

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

On 11/28/22 15:02, [email protected] wrote:
> From: Nick Hawkins <[email protected]>
>
> 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 <[email protected]>
>
> ---
>
> 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.

2022-11-29 16:27:56

by Hawkins, Nick

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

> 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.

Understood. Just to confirm should I change fanY_fault to fanX_fault
in documentation as well as the patch description? For instance:
/sys/class/hwmon/hwmonX/fanX_fault

It seems that the documentation around it uses fanY_ format.

Thanks,

-Nick Hawkins

2022-11-29 17:08:12

by Guenter Roeck

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

On 11/29/22 08:15, Hawkins, Nick wrote:
>> 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.
>
> Understood. Just to confirm should I change fanY_fault to fanX_fault
> in documentation as well as the patch description? For instance:
> /sys/class/hwmon/hwmonX/fanX_fault
>
> It seems that the documentation around it uses fanY_ format.
>

Now you start splitting hairs ;-). I wanted to point out that
fan[X,Y,Z,A,B,C,...]_fault is a generic attribute, not that I want you
to change fanY to fanX.

Guenter