Update documentation regarding dell_smm_hwmon in preparation for
future changes.
---
Changes in v3:
- indent everything with tabs in first patch
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
Add documentation for fan_mult and fan_max.
Signed-off-by: Armin Wolf <[email protected]>
---
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 52de7cd06858..5baf4df501e0 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
Add ABI file for informing remaining users of the
deprecation of the legacy /proc/i8k interface.
Signed-off-by: Armin Wolf <[email protected]>
---
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 <[email protected]>
+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 <[email protected]>
S: Maintained
+F: Documentation/ABI/obsolete/procfs-i8k
F: drivers/hwmon/dell-smm-hwmon.c
F: include/uapi/linux/i8k.h
--
2.30.2
The driver should be called dell_smm_hwmon, i8k is only
an alias now.
Signed-off-by: Armin Wolf <[email protected]>
---
.../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..52de7cd06858 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
On 1/9/22 13:42, Armin Wolf wrote:
> The driver should be called dell_smm_hwmon, i8k is only
> an alias now.
>
> Signed-off-by: Armin Wolf <[email protected]>
Acked-by: Randy Dunlap <[email protected]>
Thanks.
> ---
> .../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..52de7cd06858 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
>
--
~Randy
On Sun, Jan 09, 2022 at 10:42:46PM +0100, Armin Wolf wrote:
> The driver should be called dell_smm_hwmon, i8k is only
> an alias now.
>
> Signed-off-by: Armin Wolf <[email protected]>
> Acked-by: Randy Dunlap <[email protected]>
Series applied to hwmon-next.
Thanks,
Guenter
> ---
> .../admin-guide/kernel-parameters.txt | 29 ++++++++++++-------
> 1 file changed, 18 insertions(+), 11 deletions(-)
>
> --
> 2.30.2
>
> diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
> index 2fba82431efb..52de7cd06858 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