Skip to contentSkip to conversation

hwmon: Add documentation for tmp421 driver

PATCH In review Andre Prendel 2 participants 2 messages Jun 15, 2009 – Jun 16, 2009

lore
Share & tools
lore
#0 lore raw

PATCH 2/2 hwmon: Add documentation for tmp421 driver

This patch adds documentation for driver tmp421.

---
 tmp421 |   36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

Index: linux-2.6/Documentation/hwmon/tmp421
=================================--- /dev/null 1970-01-01 00:00:00.000000000 +0000
+++ linux-2.6/Documentation/hwmon/tmp421 2009-06-11 21:50:46.000000000 +0200
@@ -0,0 +1,36 @@
+Kernel driver tmp421
+==========
+
+Supported chips:
+ * Texas Instruments TMP421

+    Prefix: 'tmp421'
+    Addresses scanned: I2C 0x2a, 0x4c, 0x4d, 0x4e and 0x4f
+    Datasheet: http://focus.ti.com/docs/prod/folders/print/tmp421.html
+  * Texas Instruments TMP422
+    Prefix: 'tmp422'
+    Addresses scanned: I2C 0x2a, 0x4c, 0x4d, 0x4e and 0x4f
+    Datasheet: http://focus.ti.com/docs/prod/folders/print/tmp421.html
+  * Texas Instruments TMP423
+    Prefix: 'tmp423'
+    Addresses scanned: I2C 0x2a, 0x4c, 0x4d, 0x4e and 0x4f
+    Datasheet: http://focus.ti.com/docs/prod/folders/print/tmp421.html

+
+Authors:
+ Andre Prendel <[email protected]>
+
+Description
+-----------
+
+This driver implements support for Texas Instruments TMP421, TMP422 +and TMP423 temperature sensor chips. These chips implements one local +and up to one (TMP421), up to two (TMP422) or up to three (TMP423) +remote sensors. Temperature is measured in degrees Celsius. The chips +are wired over I2C/SMBus and specified over a temperature range of +-40°C to +125°C. Resolution for both the local and remote channels is +0.0625°C.
+
+The chips supports only temperature measurement and exports these +values via following sysfs-interface:
+
+temp[1-4]_input
+temp[2-4]_fault

_______________________________________________
lm-sensors mailing list
[email protected]
http://lists.lm-sensors.org/mailman/listinfo/lm-sensors

#1 lore raw

Re: [lm-sensors] [PATCH 2/2] hwmon: Add documentation for tmp421

Quoted 26 lines · Andre Prendel

This patch adds documentation for driver tmp421.

---
 tmp421 |   36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

Index: linux-2.6/Documentation/hwmon/tmp421
=================================> --- /dev/null 1970-01-01 00:00:00.000000000 +0000
+++ linux-2.6/Documentation/hwmon/tmp421 2009-06-11 21:50:46.000000000 +0200

(quoted diff) +15 -0
@@ -0,0 +1,36 @@
+Kernel driver tmp421
+==========
+
+Supported chips:
+  * Texas Instruments TMP421
+    Prefix: 'tmp421'
+    Addresses scanned: I2C 0x2a, 0x4c, 0x4d, 0x4e and 0x4f
+    Datasheet: http://focus.ti.com/docs/prod/folders/print/tmp421.html
+  * Texas Instruments TMP422
+    Prefix: 'tmp422'
+    Addresses scanned: I2C 0x2a, 0x4c, 0x4d, 0x4e and 0x4f
+    Datasheet: http://focus.ti.com/docs/prod/folders/print/tmp421.html
+  * Texas Instruments TMP423
+    Prefix: 'tmp423'
+    Addresses scanned: I2C 0x2a, 0x4c, 0x4d, 0x4e and 0x4f

Review line 25

Quoted 10 lines
(quoted diff) +10 -0
+    Datasheet: http://focus.ti.com/docs/prod/folders/print/tmp421.html
+
+Authors:
+	Andre Prendel <[email protected]>
+
+Description
+-----------
+
+This driver implements support for Texas Instruments TMP421, TMP422
+and TMP423 temperature sensor chips. These chips implements one local

Spelling: implement.

Review line 30

Quoted 5 lines
(quoted diff) +5 -0
+and up to one (TMP421), up to two (TMP422) or up to three (TMP423)
+remote sensors. Temperature is measured in degrees Celsius. The chips
+are wired over I2C/SMBus and specified over a temperature range of
+-40°C to +125°C. Resolution for both the local and remote channels is
+0.0625°C.

The degree symbol is not ASCII, I'd suggest spelling it "degree C" to avoid charset headaches.

Review line 32

Quoted 2 lines
(quoted diff) +2 -0
+
+The chips supports only temperature measurement and exports these

Spelling: support. Also, the drivers exports the values to sysfs, not the chips.

Review line 36

Quoted 4 lines
(quoted diff) +4 -0
+values via following sysfs-interface:
+
+temp[1-4]_input
+temp[2-4]_fault

Maybe you could add a section explaining that not all possible addresses are probed by default, why and how to work around it if needed.

Signature · 6 lines
Jean Delvare

_______________________________________________
lm-sensors mailing list
[email protected]
http://lists.lm-sensors.org/mailman/listinfo/lm-sensors