From: Ivor Wanders <ivor@iwanders.net>
To: Jean Delvare <jdelvare@suse.com>,
Guenter Roeck <linux@roeck-us.net>,
Jonathan Corbet <corbet@lwn.net>
Cc: Ivor Wanders <ivor@iwanders.net>,
linux-hwmon@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org,
Maximilian Luz <luzmaximilian@gmail.com>
Subject: [PATCH 1/1] hwmon: clarify intent of fan min/max
Date: Thu, 21 Dec 2023 17:51:49 -0500 [thread overview]
Message-ID: <20231221225149.11295-2-ivor@iwanders.net> (raw)
In-Reply-To: <20231221225149.11295-1-ivor@iwanders.net>
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/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.
--
2.17.1
next prev parent reply other threads:[~2023-12-21 22:51 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-21 22:51 [PATCH 0/1] clarify intent of fan min and max attributes Ivor Wanders
2023-12-21 22:51 ` Ivor Wanders [this message]
2023-12-21 23:19 ` [PATCH 1/1] hwmon: clarify intent of fan min/max Randy Dunlap
2023-12-21 23:31 ` [PATCH v2] " Ivor Wanders
2023-12-21 23:38 ` Randy Dunlap
2023-12-21 23:46 ` Ivor Wanders
2023-12-22 16:14 ` Guenter Roeck
2023-12-22 23:20 ` Ivor Wanders
2023-12-22 16:12 ` [PATCH 0/1] clarify intent of fan min and max attributes Guenter Roeck
2023-12-22 23:17 ` Ivor Wanders
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20231221225149.11295-2-ivor@iwanders.net \
--to=ivor@iwanders.net \
--cc=corbet@lwn.net \
--cc=jdelvare@suse.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-hwmon@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@roeck-us.net \
--cc=luzmaximilian@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox