[PATCH 1/4] Documentation: admin-guide: Update i8k driver name

[PATCH 1/4] Documentation: admin-guide: Update i8k driver name

[Armin Wolf]

The driver should be called dell_smm_hwmon, i8k is only
an alias now.

Signed-off-by: Armin Wolf <W_Armin@gmx.de>
---
 .../admin-guide/kernel-parameters.txt         | 29 ++++++++++++-------
 1 file changed, 18 insertions(+), 11 deletions(-)

diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
index 2fba82431efb..cb1331f85444 100644
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -935,6 +935,24 @@
 			dump out devices still on the deferred probe list after
 			retrying.

+	dell_smm_hwmon.ignore_dmi=
+			[HW] Continue probing hardware even if DMI data
+                        indicates that the driver is running on unsupported
+                        hardware.
+
+        dell_smm_hwmon.force=
+			[HW] Activate driver even if SMM BIOS signature does
+			not match list of supported models and enable otherwise
+			blacklisted features.
+
+        dell_smm_hwmon.power_status=
+                        [HW] Report power status in /proc/i8k
+                        (disabled by default).
+
+        dell_smm_hwmon.restricted=
+			[HW] Allow controlling fans only if SYS_ADMIN
+                        capability is set.
+
 	dfltcc=		[HW,S390]
 			Format: { on | off | def_only | inf_only | always }
 			on:       s390 zlib hardware support for compression on
@@ -1694,17 +1712,6 @@

 	i810=		[HW,DRM]

-	i8k.ignore_dmi	[HW] Continue probing hardware even if DMI data
-			indicates that the driver is running on unsupported
-			hardware.
-	i8k.force	[HW] Activate i8k driver even if SMM BIOS signature
-			does not match list of supported models.
-	i8k.power_status
-			[HW] Report power status in /proc/i8k
-			(disabled by default)
-	i8k.restricted	[HW] Allow controlling fans only if SYS_ADMIN
-			capability is set.
-
 	i915.invert_brightness=
 			[DRM] Invert the sense of the variable that is used to
 			set the brightness of the panel backlight. Normally a
--
2.30.2

[PATCH 2/4] Documentation: admin-guide: Add Documentation for undocumented dell_smm_hwmon parameters

[Armin Wolf]

Add documentation for fan_mult and fan_max.

Signed-off-by: Armin Wolf <W_Armin@gmx.de>
---
 Documentation/admin-guide/kernel-parameters.txt | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
index cb1331f85444..8dd07ca80934 100644
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -953,6 +953,12 @@
 			[HW] Allow controlling fans only if SYS_ADMIN
                         capability is set.

+	dell_smm_hwmon.fan_mult=
+			[HW] Factor to multiply fan speed with.
+
+	dell_smm_hwmon.fan_max=
+			[HW] Maximum configurable fan speed.
+
 	dfltcc=		[HW,S390]
 			Format: { on | off | def_only | inf_only | always }
 			on:       s390 zlib hardware support for compression on
--
2.30.2

[PATCH 3/4] docs: hwmon: dell-smm-hwmon.rst: Replace ascii table with flat-table

[Armin Wolf]

flat-table is recommended over ascii art tables.

Signed-off-by: Armin Wolf <W_Armin@gmx.de>
---
 Documentation/hwmon/dell-smm-hwmon.rst | 60 +++++++++++++++++++-------
 1 file changed, 44 insertions(+), 16 deletions(-)

diff --git a/Documentation/hwmon/dell-smm-hwmon.rst b/Documentation/hwmon/dell-smm-hwmon.rst
index beec88491171..f1e185e8a3f7 100644
--- a/Documentation/hwmon/dell-smm-hwmon.rst
+++ b/Documentation/hwmon/dell-smm-hwmon.rst
@@ -29,22 +29,50 @@ Temperature sensors and fans can be queried and set via the standard
 ``X`` such that ``/sys/class/hwmon/hwmonX/name`` has content
 ``dell_smm``). A number of other attributes can be read or written:

-=============================== ======= =======================================
-Name				Perm	Description
-=============================== ======= =======================================
-fan[1-3]_input                  RO      Fan speed in RPM.
-fan[1-3]_label                  RO      Fan label.
-fan[1-3]_min                    RO      Minimal Fan speed in RPM
-fan[1-3]_max                    RO      Maximal Fan speed in RPM
-fan[1-3]_target                 RO      Expected Fan speed in RPM
-pwm[1-3]                        RW      Control the fan PWM duty-cycle.
-pwm1_enable                     WO      Enable or disable automatic BIOS fan
-                                        control (not supported on all laptops,
-                                        see below for details).
-temp[1-10]_input                RO      Temperature reading in milli-degrees
-                                        Celsius.
-temp[1-10]_label                RO      Temperature sensor label.
-=============================== ======= =======================================
+.. flat-table::
+   :header-rows: 1
+   :widths: 4 1 5
+
+   * - Name
+     - Perm
+     - Description
+
+   * - fan[1-3]_input
+     - RO
+     - Fan speed in RPM
+
+   * - fan[1-3]_label
+     - RO
+     - Fan label
+
+   * - fan[1-3]_min
+     - RO
+     - Minimal Fan speed in RPM
+
+   * - fan[1-3]_max
+     - RO
+     - Maximal Fan speed in RPM
+
+   * - fan[1-3]_target
+     - RO
+     - Expected Fan speed in RPM
+
+   * - pwm[1-3]
+     - RW
+     - Control the fan PWM duty-cycle
+
+   * - pwm1_enable
+     - WO
+     - Enable or disable automatic BIOS fan control (not supported
+       on all laptops, see below for details)
+
+   * - temp[1-10]_input
+     - RO
+     - Temperature reading in milli-degrees Celsius
+
+   * - temp[1-10]_label
+     - RO
+     - Temperature sensor label

 Disabling automatic BIOS fan control
 ------------------------------------
--
2.30.2

Re: [PATCH 3/4] docs: hwmon: dell-smm-hwmon.rst: Replace ascii table with flat-table

[Guenter Roeck]

On 12/28/21 7:37 AM, Armin Wolf wrote:
> flat-table is recommended over ascii art tables.
> 

I really don't want to encourage people sending me such patches,
so please don't do that unless there is a technical reason
to make those changes.

Guenter

> Signed-off-by: Armin Wolf <W_Armin@gmx.de>
> ---
>   Documentation/hwmon/dell-smm-hwmon.rst | 60 +++++++++++++++++++-------
>   1 file changed, 44 insertions(+), 16 deletions(-)
> 
> diff --git a/Documentation/hwmon/dell-smm-hwmon.rst b/Documentation/hwmon/dell-smm-hwmon.rst
> index beec88491171..f1e185e8a3f7 100644
> --- a/Documentation/hwmon/dell-smm-hwmon.rst
> +++ b/Documentation/hwmon/dell-smm-hwmon.rst
> @@ -29,22 +29,50 @@ Temperature sensors and fans can be queried and set via the standard
>   ``X`` such that ``/sys/class/hwmon/hwmonX/name`` has content
>   ``dell_smm``). A number of other attributes can be read or written:
> 
> -=============================== ======= =======================================
> -Name				Perm	Description
> -=============================== ======= =======================================
> -fan[1-3]_input                  RO      Fan speed in RPM.
> -fan[1-3]_label                  RO      Fan label.
> -fan[1-3]_min                    RO      Minimal Fan speed in RPM
> -fan[1-3]_max                    RO      Maximal Fan speed in RPM
> -fan[1-3]_target                 RO      Expected Fan speed in RPM
> -pwm[1-3]                        RW      Control the fan PWM duty-cycle.
> -pwm1_enable                     WO      Enable or disable automatic BIOS fan
> -                                        control (not supported on all laptops,
> -                                        see below for details).
> -temp[1-10]_input                RO      Temperature reading in milli-degrees
> -                                        Celsius.
> -temp[1-10]_label                RO      Temperature sensor label.
> -=============================== ======= =======================================
> +.. flat-table::
> +   :header-rows: 1
> +   :widths: 4 1 5
> +
> +   * - Name
> +     - Perm
> +     - Description
> +
> +   * - fan[1-3]_input
> +     - RO
> +     - Fan speed in RPM
> +
> +   * - fan[1-3]_label
> +     - RO
> +     - Fan label
> +
> +   * - fan[1-3]_min
> +     - RO
> +     - Minimal Fan speed in RPM
> +
> +   * - fan[1-3]_max
> +     - RO
> +     - Maximal Fan speed in RPM
> +
> +   * - fan[1-3]_target
> +     - RO
> +     - Expected Fan speed in RPM
> +
> +   * - pwm[1-3]
> +     - RW
> +     - Control the fan PWM duty-cycle
> +
> +   * - pwm1_enable
> +     - WO
> +     - Enable or disable automatic BIOS fan control (not supported
> +       on all laptops, see below for details)
> +
> +   * - temp[1-10]_input
> +     - RO
> +     - Temperature reading in milli-degrees Celsius
> +
> +   * - temp[1-10]_label
> +     - RO
> +     - Temperature sensor label
> 
>   Disabling automatic BIOS fan control
>   ------------------------------------
> --
> 2.30.2
> 

Re: [PATCH 3/4] docs: hwmon: dell-smm-hwmon.rst: Replace ascii table with flat-table

[Jonathan Corbet]

Armin Wolf <W_Armin@gmx.de> writes:

> flat-table is recommended over ascii art tables.
>
> Signed-off-by: Armin Wolf <W_Armin@gmx.de>
> ---
>  Documentation/hwmon/dell-smm-hwmon.rst | 60 +++++++++++++++++++-------
>  1 file changed, 44 insertions(+), 16 deletions(-)

FWIW, I totally disagree with that recommendation and should really just
take it out.  This patch makes it clear why: the new table is almost
entirely unreadable in the plain-text form.

Thanks,

jon

[PATCH 4/4] Documentation: ABI: Add ABI file for legacy /proc/i8k interface

[Armin Wolf]

Add ABI file for informing remaining users of the
deprecation of the legacy /proc/i8k interface.

Signed-off-by: Armin Wolf <W_Armin@gmx.de>
---
 Documentation/ABI/obsolete/procfs-i8k | 10 ++++++++++
 MAINTAINERS                           |  1 +
 2 files changed, 11 insertions(+)
 create mode 100644 Documentation/ABI/obsolete/procfs-i8k

diff --git a/Documentation/ABI/obsolete/procfs-i8k b/Documentation/ABI/obsolete/procfs-i8k
new file mode 100644
index 000000000000..32df4d5bdd15
--- /dev/null
+++ b/Documentation/ABI/obsolete/procfs-i8k
@@ -0,0 +1,10 @@
+What:		/proc/i8k
+Date:		November 2001
+KernelVersion:	2.4.14
+Contact:	Pali Rohár <pali@kernel.org>
+Description:	Legacy interface for getting/setting sensor information like
+		fan speed, temperature, serial number, hotkey status etc
+		on Dell Laptops.
+		Since the driver is now using the standard hwmon sysfs interface,
+		the procfs interface is deprecated.
+Users:		https://github.com/vitorafsr/i8kutils
diff --git a/MAINTAINERS b/MAINTAINERS
index e7e40563498f..468ee16ee778 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -5365,6 +5365,7 @@ F:	drivers/platform/x86/dell/dell-rbtn.*
 DELL LAPTOP SMM DRIVER
 M:	Pali Rohár <pali@kernel.org>
 S:	Maintained
+F:	Documentation/ABI/obsolete/procfs-i8k
 F:	drivers/hwmon/dell-smm-hwmon.c
 F:	include/uapi/linux/i8k.h

--
2.30.2