Changeset 2989

Timestamp:

05/06/05 16:41:55 (8 years ago)

Author:

mds

Message:

updates

Files:

• lm-sensors/trunk/doc/developers/new_drivers (modified) (5 diffs)

lm-sensors/trunk/doc/developers/new_drivers

@@ -11 +11 @@
 
 These instructions are for 2.4-kernel-compatible drivers.
-If you wish to write a driver for 2.5 only, email us for information.
+If you wish to write a driver for 2.6 only, not all of the following
+steps apply.
 
 ---------------------------------------------------------------------
@@ -74 +75 @@
 
 * Test the module.
-  This is usually the boring part...
   Test with a recent 2.4 kernel.
+  For bus drivers, use i2cdetect and i2cdump. For i2cdump, test all supported
+  bus access modes (see i2cdump man page).
+  For chip drivers, cat all files in applicable /proc or /sys directory
+  and check for problems. Write all supported settings.
+  Check ALARM indications.
 
 * Add detection information to prog/detect/sensors-detect.
@@ -96 +101 @@
   makes the included 'sensors' program pretty-print your chip information.
 
-* Add a call to the procedure in prog/sensors/main.c (for chip drivers only).
-  Put it at the bottom of do_a_print().
+* Add an line for the procedure in the matches[] table in
+  prog/sensors/main.c (for chip drivers only).
+  This tells sensors to call your new procedure when the chip name matches.
 
 * Add entries to etc/sensors.conf.eg (for chip drivers only).
   If needed, you can set defaults here.
+
+* Test the userspace apps (sensors-detect and sensors).
+  Test setting limits with sensors -s.
 
 * Add the name of the device to the README file.
@@ -109 +118 @@
 
 * Write a doc/chips/xxx or doc/busses/xxx file.
+
+* Add entry to doc/chips/SUMMARY (for chip drivers only).
 
 * Clearly specify licensing and copyright.
@@ -124 +135 @@
   or check them in.
 
-* If you want to have your driver integrated to Linux 2.5, you have to
+* If you want to have your driver integrated to Linux 2.6, you have to
   port your driver to the new sysfs interface. Once done and preferably
   after testing, submit a patch to the Linux kernel mailing list
-  <linux-kernel at vger dot kernel dot org> and Greg KH (greg at kroah
+  <linux-kernel at vger dot kernel dot org>, our mailing list
+  <sensors at stimpy dot netroedge.com>,and Greg KH (greg at kroah
   dot com).