sensors-find-driver: Convert README to man page

This commit is contained in:
Michal Suchanek
2024-01-17 19:39:46 +01:00
parent 3a5737fe7b
commit 905634f182
2 changed files with 83 additions and 25 deletions
-25
View File
@@ -1,25 +0,0 @@
This directory contains tools which may help with debugging lm_sensors.
find-driver
===========
If the 'sensors' program does not report useful values for certain hardware
monitoring inputs, the problem in most cases is not in lm_sensors. lm_sensors
only reads values exported by the Linux kernel. Finding the driver responsible
for exporting the particular hardware monitoring chip may help to diagnose
the problem further. It is possible that there is a bug in the driver, however
it is even more likely that the input is simply not used on your board.
Nonetheless, identifying the driver may help you identify the piece of hardware
that reports the bogus value.
This script finds the driver and kernel module responsible for exporting
a hardware monitoring chip in sysfs. It should be given the chip name (as
reported by the 'sensors' program) as argument. For example:
$ sensors
thinkpad-isa-0000
Adapter: ISA adapter
fan1: 0 RPM
$ ./find-driver thinkpad-isa-0000
Driver: thinkpad_hwmon
Module: thinkpad_acpi
+83
View File
@@ -0,0 +1,83 @@
.\" Copyright 1999 Frodo Looijaard <frodol@dds.nl>
.\" Copyright (C) 2007-2012 Jean Delvare <jdelvare@suse.de>
.\" sensors is distributed under the GPL
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one
.\"
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.TH sensors-find-driver 1 "November 2012" "lm-sensors 3" "Linux User's Manual"
.SH NAME
sensors-find-driver \- find driver corresponding to a sensor chip
.SH SYNOPSIS
.B sensors-find-driver
.I chip-name
.SH DESCRIPTION
.B sensors-find-driver
Chip name is a string in the format
.I <chip>-<bus>-<address>
as reported by the
.I sensors
program. For example the chip name can be
.I coretemp-isa-0000
or
.I acpitz-virtual-0
.P
If the
.I sensors
program does not report useful values for certain hardware
monitoring inputs, the problem in most cases is not in lm_sensors. lm_sensors
only reads values exported by the Linux kernel. Finding the driver responsible
for exporting the particular hardware monitoring chip may help to diagnose
the problem further. It is possible that there is a bug in the driver, however
it is even more likely that the input is simply not used on your board.
Nonetheless, identifying the driver may help you identify the piece of hardware
that reports the bogus value.
This script finds the driver and kernel module responsible for exporting
a hardware monitoring chip in sysfs. It should be given the chip name as
reported by the
.I sensors
program as argument. For example:
.br
$ sensors
.br
thinkpad-isa-0000
.br
Adapter: ISA adapter
.br
fan1: 0 RPM
.br
.br
$ sensors-find-driver thinkpad-isa-0000
.br
Driver: thinkpad_hwmon
.br
Module: thinkpad_acpi
.SH AUTHOR
Frodo Looijaard and the lm_sensors group
https://hwmon.wiki.kernel.org/lm_sensors