[PATCH v2 0/3] Documenation: Update documentation regarding dell_smm_hwmon

[PATCH v2 0/3] Documenation: Update documentation regarding dell_smm_hwmon

[Armin Wolf]

Update documentation regarding dell_smm_hwmon in preparation for
future changes.

---
Changes in v2:
- omit unneccessary patch

Armin Wolf (3):
  Documentation: admin-guide: Update i8k driver name
  Documentation: admin-guide: Add Documentation for undocumented
    dell_smm_hwmon parameters
  Documentation: ABI: Add ABI file for legacy /proc/i8k interface

 Documentation/ABI/obsolete/procfs-i8k         | 10 ++++++
 .../admin-guide/kernel-parameters.txt         | 35 +++++++++++++------
 MAINTAINERS                                   |  1 +
 3 files changed, 35 insertions(+), 11 deletions(-)
 create mode 100644 Documentation/ABI/obsolete/procfs-i8k

--
2.30.2

[PATCH v2 1/3] 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 v2 2/3] 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 v2 3/3] 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