| Message ID | 20231221225149.11295-2-ivor@iwanders.net (mailing list archive) |
|---|---|
| State | Changes Requested |
| Headers | show |
| Series | clarify intent of fan min and max attributes | expand |
Hi, On 12/21/23 14:51, Ivor Wanders wrote: > This adds a link to the hwmon sysfs attributes in the hwmon patch > submission bullet points. It also adds an explanation denoting the > intent of the fan min and max attributes. > > Signed-off-by: Ivor Wanders <ivor@iwanders.net> > --- > Documentation/hwmon/submitting-patches.rst | 4 +++- > Documentation/hwmon/sysfs-interface.rst | 12 +++++++++--- > 2 files changed, 12 insertions(+), 4 deletions(-) > > diff --git a/Documentation/hwmon/sysfs-interface.rst b/Documentation/hwmon/sysfs-interface.rst > index f76e9f8cc..72dd5e02d 100644 > --- a/Documentation/hwmon/sysfs-interface.rst > +++ b/Documentation/hwmon/sysfs-interface.rst > @@ -167,13 +167,19 @@ Fans > **** > > `fan[1-*]_min` > - Fan minimum value > + Fan minimum value, this is intended as a way to specify Please change the comma here to either (a) semi-colon (';') or (b) a period ('.') followed by a sentence beginning with a capital letter. Same for the other 2 below also. > + the desired minimum speed to the device if the device > + supports that. It is not intended for communicating > + a constant that denotes the lowest possible fan speed. > > `fan[1-*]_max` > - Fan maximum value > + Fan maximum value, this is intended as a way to specify > + the desired maximum speed to the device if the device > + supports that. It is not intended for communicating > + a constant that denotes the highest possible fan speed. > > `fan[1-*]_input` > - Fan input value. > + Fan input value, this is the fan's current speed. > > `fan[1-*]_div` > Fan divisor. thanks.
diff --git a/Documentation/hwmon/submitting-patches.rst b/Documentation/hwmon/submitting-patches.rst index 6482c4f13..d634c41d7 100644 --- a/Documentation/hwmon/submitting-patches.rst +++ b/Documentation/hwmon/submitting-patches.rst @@ -141,7 +141,9 @@ increase the chances of your change being accepted. * When deciding which sysfs attributes to support, look at the chip's capabilities. While we do not expect your driver to support everything the - chip may offer, it should at least support all limits and alarms. + chip may offer, it should at least support all limits and alarms. Only + add attributes that follow the intent of the attributes, as described in + Documentation/hwmon/sysfs-interface.rst. * Last but not least, please check if a driver for your chip already exists before starting to write a new driver. Especially for temperature sensors, diff --git a/Documentation/hwmon/sysfs-interface.rst b/Documentation/hwmon/sysfs-interface.rst index f76e9f8cc..72dd5e02d 100644 --- a/Documentation/hwmon/sysfs-interface.rst +++ b/Documentation/hwmon/sysfs-interface.rst @@ -167,13 +167,19 @@ Fans **** `fan[1-*]_min` - Fan minimum value + Fan minimum value, this is intended as a way to specify + the desired minimum speed to the device if the device + supports that. It is not intended for communicating + a constant that denotes the lowest possible fan speed. `fan[1-*]_max` - Fan maximum value + Fan maximum value, this is intended as a way to specify + the desired maximum speed to the device if the device + supports that. It is not intended for communicating + a constant that denotes the highest possible fan speed. `fan[1-*]_input` - Fan input value. + Fan input value, this is the fan's current speed. `fan[1-*]_div` Fan divisor.
This adds a link to the hwmon sysfs attributes in the hwmon patch submission bullet points. It also adds an explanation denoting the intent of the fan min and max attributes. Signed-off-by: Ivor Wanders <ivor@iwanders.net> --- Documentation/hwmon/submitting-patches.rst | 4 +++- Documentation/hwmon/sysfs-interface.rst | 12 +++++++++--- 2 files changed, 12 insertions(+), 4 deletions(-)