diff mbox series

[6/6] hwmon: (lm92) Update documentation

Message ID 20240801144918.6156-7-linux@roeck-us.net (mailing list archive)
State Accepted
Headers show
Series hwmon: (lm92) Cleanup and conversion to with_info API | expand

Commit Message

Guenter Roeck Aug. 1, 2024, 2:49 p.m. UTC 
Update datasheet references. Replace misleading 'force parameter needed'
with 'must be instantiated explicitly'. Explain the reason for the missing
auto-detection. Mention all supported chips in Kconfig.

Signed-off-by: Guenter Roeck <linux@roeck-us.net>
---
 Documentation/hwmon/lm92.rst | 26 +++++++++++++-------------
 drivers/hwmon/Kconfig        |  2 +-
 2 files changed, 14 insertions(+), 14 deletions(-)

Comments

Tzung-Bi Shih Aug. 2, 2024, 5:12 a.m. UTC | #1 
On Thu, Aug 01, 2024 at 07:49:18AM -0700, Guenter Roeck wrote:
> Update datasheet references. Replace misleading 'force parameter needed'
> with 'must be instantiated explicitly'. Explain the reason for the missing
> auto-detection. Mention all supported chips in Kconfig.
> 
> Signed-off-by: Guenter Roeck <linux@roeck-us.net>

Reviewed-by: Tzung-Bi Shih <tzungbi@kernel.org>
Guenter Roeck Aug. 2, 2024, 2:11 p.m. UTC | #2 
On 8/1/24 22:12, Tzung-Bi Shih wrote:
> On Thu, Aug 01, 2024 at 07:49:18AM -0700, Guenter Roeck wrote:
>> Update datasheet references. Replace misleading 'force parameter needed'
>> with 'must be instantiated explicitly'. Explain the reason for the missing
>> auto-detection. Mention all supported chips in Kconfig.
>>
>> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
> 
> Reviewed-by: Tzung-Bi Shih <tzungbi@kernel.org>
> 

Thanks a lot for the reviews!

Guenter
diff mbox series

Patch

diff --git a/Documentation/hwmon/lm92.rst b/Documentation/hwmon/lm92.rst
index c131b923ed36..d71cdb2af339 100644
--- a/Documentation/hwmon/lm92.rst
+++ b/Documentation/hwmon/lm92.rst
@@ -3,29 +3,29 @@  Kernel driver lm92
 
 Supported chips:
 
-  * National Semiconductor LM92
+  * National Semiconductor / Texas Instruments LM92
 
     Prefix: 'lm92'
 
     Addresses scanned: I2C 0x48 - 0x4b
 
-    Datasheet: http://www.national.com/pf/LM/LM92.html
+    Datasheet: https://www.ti.com/lit/gpn/LM92
 
-  * National Semiconductor LM76
+  * National Semiconductor / Texas Instruments LM76
 
     Prefix: 'lm92'
 
-    Addresses scanned: none, force parameter needed
+    Addresses scanned: none, must be instantiated explicitly
 
-    Datasheet: http://www.national.com/pf/LM/LM76.html
+    Datasheet: https://www.ti.com/lit/gpn/LM76
 
-  * Maxim MAX6633/MAX6634/MAX6635
+  * Maxim /Analog Devices MAX6633/MAX6634/MAX6635
 
     Prefix: 'max6635'
 
-    Addresses scanned: none, force parameter needed
+    Addresses scanned: none, must be instantiated explicitly
 
-    Datasheet: http://www.maxim-ic.com/quick_view2.cfm/qv_pk/3074
+    Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/max6633-max6635.pdf
 
 
 Authors:
@@ -36,13 +36,13 @@  Authors:
 Description
 -----------
 
-This driver implements support for the National Semiconductor LM92
-temperature sensor.
+This driver implements support for the National Semiconductor / Texas
+Instruments LM92 temperature sensor.
 
 Each LM92 temperature sensor supports a single temperature sensor. There are
 alarms for high, low, and critical thresholds. There's also an hysteresis to
 control the thresholds for resetting alarms.
 
-Support was added later for the LM76 and Maxim MAX6633/MAX6634/MAX6635,
-which are mostly compatible. They have not all been tested, so you
-may need to use the force parameter.
+The driver also supports LM76 and Maxim MAX6633/MAX6634/MAX6635, which are
+mostly compatible but do not have a vendor ID register and therefore must be
+instantiated explicitly.
diff --git a/drivers/hwmon/Kconfig b/drivers/hwmon/Kconfig
index b2ace4857130..702ed8502aa2 100644
--- a/drivers/hwmon/Kconfig
+++ b/drivers/hwmon/Kconfig
@@ -1514,7 +1514,7 @@  config SENSORS_LM92
 	select REGMAP_I2C
 	help
 	  If you say yes here you get support for National Semiconductor LM92
-	  and Maxim MAX6635 sensor chips.
+	  and LM76 as well as Maxim MAX6633/6634/6635 sensor chips.
 
 	  This driver can also be built as a module. If so, the module
 	  will be called lm92.