Re: [PATCH v4 2/2] dell-smm-hwmon: Add documentation

[Pali RohÃr]

Hi! It is great that kernel would have up-to-date documentation.

On Monday 18 November 2019 18:11:48 Giovanni Mascellani wrote:
> Part of the documentation is taken from the README of the userspace
> utils (https://github.com/vitorafsr/i8kutils). The license is GPL-2+
> and the author Massimo Dal Zotto is already credited as author of
> the module. Therefore there should be no copyright problem.
> 
> I also added a paragraph with specific information on the experimental
> support for automatic BIOS fan control.
> 
> Signed-off-by: Giovanni Mascellani <gio@xxxxxxxxxx>
> ---
>  Documentation/hwmon/dell-smm-hwmon.rst | 112 +++++++++++++++++++++++++
>  Documentation/hwmon/index.rst          |   1 +
>  2 files changed, 113 insertions(+)
>  create mode 100644 Documentation/hwmon/dell-smm-hwmon.rst
> 
> diff --git a/Documentation/hwmon/dell-smm-hwmon.rst b/Documentation/hwmon/dell-smm-hwmon.rst
> new file mode 100644
> index 000000000000..f80d30d8a02a
> --- /dev/null
> +++ b/Documentation/hwmon/dell-smm-hwmon.rst
> @@ -0,0 +1,112 @@
> +Kernel driver dell-smm-hwmon
> +============================
> +
> +Description
> +-----------
> +
> +On many Dell laptops the System Management Mode (SMM) BIOS can be
> +queried for the status of fans and temperature sensors. The userspace
> +suite `i8kutils`__ can be used to read the sensors and automatically
> +adjust fan speed.
> +
> + __ https://github.com/vitorafsr/i8kutils
> +
> +``/proc`` interface
> +-------------------

/proc/i8k is legacy interface and ioctl is already obsoleted/deprecated.
New applications should not use this interface. It is replaced by acpi,
input layer and hwmon interface. /proc/i8k is needed for old Dell
laptops (like Dell Inspiron 8000) which do not support acpi or does not
provide input events. Please express this in documentation, so people
would not try to use this old interface in new applications. Also this
legacy interface is available only when kernel is compile with
CONFIG_I8K option. 

> +The information provided by the kernel driver can be accessed by
> +simply reading the ``/proc/i8k`` file. For example::
> +
> +    $ cat /proc/i8k
> +    1.0 A17 2J59L02 52 2 1 8040 6420 1 2
> +
> +The fields read from ``/proc/i8k`` are::
> +
> +    1.0 A17 2J59L02 52 2 1 8040 6420 1 2
> +    |   |   |       |  | | |    |    | |
> +    |   |   |       |  | | |    |    | +------- 10. buttons status
> +    |   |   |       |  | | |    |    +--------- 9.  AC status
> +    |   |   |       |  | | |    +-------------- 8.  right fan rpm
> +    |   |   |       |  | | +------------------- 7.  left fan rpm

It is not right or left fan, but rather fan0 and fan1 (right = 0). On
some laptops is really fan with index 0 on right side, but on some not.

> +    |   |   |       |  | +--------------------- 6.  right fan status
> +    |   |   |       |  +----------------------- 5.  left fan status

Ditto.

> +    |   |   |       +-------------------------- 4.  CPU temperature (Celsius)

This is not CPU temperature, but rather temperature sensor with index 0.
Probably in most cases it CPU temperature. See i8k_hwmon_temp_label_show
for mapping index to sensor name.

> +    |   |   +---------------------------------- 3.  Dell service tag (later known as 'serial number')
> +    |   +-------------------------------------- 2.  BIOS version
> +    +------------------------------------------ 1.  /proc/i8k format version
> +
> +A negative value, for example -22, indicates that the BIOS doesn't
> +return the corresponding information. This is normal on some
> +models/BIOSes.
> +
> +For performance reasons the ``/proc/i8k`` doesn't report by default
> +the AC status since this SMM call takes a long time to execute and is
> +not really needed.  If you want to see the ac status in ``/proc/i8k``
> +you must explictitly enable this option by passing the
> +``power_status=1`` parameter to insmod. If AC status is not
> +available -1 is printed instead.
> +
> +The driver provides also an ioctl interface which can be used to
> +obtain the same information and to control the fan status. The ioctl
> +interface can be accessed from C programs or from shell using the
> +i8kctl utility. See the source file of ``i8kutils`` for more
> +information on how to use the ioctl interface.
> +
> +``sysfs`` interface
> +-------------------

Please move sysfs hwmon section before legacy /proc/i8k. So users first
read information about new interface and then (who is interested) can
read details about legacy interface. Personally I would move proc
interface even after module parameters, to be at the bottom of document.

> +
> +Temperature sensors and fans can also be queried and set via the
> +standard ``hwmon`` interface on ``sysfs``.

Maybe add comment that this interface is available in /sys/class/hwmon/
path. And that there is "sensors" command line tool as alternative to
calling legacy "cat /proc/i8k".

> +
> +Disabling automatic BIOS fan control
> +------------------------------------
> +
> +On some laptops, the BIOS automatically sets fan speed every few
> +seconds. Therefore the fan speed set via ``/proc/i8k`` or via the
> +``sysfs`` interface is quickly overwritten.
> +
> +There is experimental support for disabling automatic BIOS fan
> +control, at least on laptops where the corresponding SMM command is
> +known, by writing the value ``1`` in the attribute ``pwm1_enable``
> +(writing ``2`` enables automatic BIOS control again). Even if you have
> +more than one fan, all of them are set to either enabled or disabled
> +automatic fan control at the same time and, notwithstanding the name,
> +``pwm1_enable`` sets automatic control for all fans.
> +
> +If ``pwm1_enable`` is not available, then it means that SMM codes for
> +enabling and disabling automatic BIOS fan control are not known for
> +your laptop. You can experiment with the code in `this repository`__
> +to probe the BIOS on your machine and discover the appropriate codes.
> +
> + __ https://github.com/clopez/dellfan/
> +

Ideally add some comments what could users do when they find correct SMM
commands for enabling/disabling BIOS mode. How and where to add these
SMM commands and where to send patch (to ML linux-hwmon@xxxxxxxxxxxxxxx)

> +Module parameters
> +-----------------
> +
> +* force:bool
> +                   Force loading without checking for supported
> +                   models. (default: 0)
> +
> +* ignore_dmi:bool
> +                   Continue probing hardware even if DMI data does not
> +                   match. (default: 0)
> +
> +* restricted:bool
> +                   Allow fan control only to processes with the
> +                   ``CAP_SYS_ADMIN`` capability set or processes run
> +                   as root. In this case normal users will be able to
> +                   read temperature and fan status but not to control
> +                   the fan.  If your notebook is shared with other
> +                   users and you don't trust them you may want to use
> +                   this option. (default: 1)

Add a note that option is only for /proc/i8k and so it is available only
when kernel is compiled with CONFIG_I8K.

> +
> +* power_status:bool
> +                   Report AC status in ``/proc/i8k``. (default: 0)

Again, this is available only when kernel is compiled with CONFIG_I8K.

> +
> +* fan_mult:uint
> +                   Factor to multiply fan speed with. (default:
> +                   autodetect)
> +
> +* fan_max:uint
> +                   Maximum configurable fan speed. (default:
> +                   autodetect)
> diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst
> index 230ad59b462b..092435ad6bb8 100644
> --- a/Documentation/hwmon/index.rst
> +++ b/Documentation/hwmon/index.rst
> @@ -44,6 +44,7 @@ Hardware Monitoring Kernel Drivers
>     coretemp
>     da9052
>     da9055
> +   dell-smm-hwmon
>     dme1737
>     ds1621
>     ds620

-- 
Pali RohÃr
pali.rohar@xxxxxxxxx

Attachment: signature.asc
Description: PGP signature