Improve AMDTSI temp type detection, and temp 4 type detection on IT8622

[groeck-it87] / README

diff --git a/README b/README
index bab93dd4b1a43ad61c446e9a8c682800f5acda8f..9d84d9f45a4806366dd07eb2f625ed85d829d621 100644 (file)
--- a/README
+++ b/README
@@ -93,6 +93,15 @@ Supported chips:
 Authors:
     Christophe Gauthron
     Jean Delvare <jdelvare@suse.de>
+    Guenter Roeck <linux@roeck-us.net>
+
+
+Building & Installing
+---------------------
+
+* make clean
+* make
+* sudo make install
 
 
 Module Parameters
@@ -114,6 +123,26 @@ Module Parameters
   misconfigured by BIOS - PWM values would be inverted. This option tries
   to fix this. Please contact your BIOS manufacturer and ask him for fix.
 
+* force_id
+
+  Force chip ID to specified value. Should only be used for testing.
+
+* ignore_resource_conflict
+
+  Similar to acpi_enforce_resources=lax, but only affects this driver.
+  ACPI resource conflicts are ignored if this parameter is provided and
+  set to 1.
+  Provided since there are reports that system-wide acpi_enfore_resources=lax
+  can result in boot failures on some systems.
+  Note: This is inherently risky since it means that both ACPI and this driver
+  may access the chip at the same time. This can result in race conditions and,
+  worst casa, result in unexpected system reboots.
+
+* mmio
+
+  If set to 1, the driver uses MMIO to access the chip if supported. This is
+  faster and less risky (untested!).
+
 
 Hardware Interfaces
 -------------------
@@ -288,10 +317,10 @@ must be programmed to the critical CPU temperature.
 Preliminary support
 -------------------
 
-Support for IT8607E, IT8665E, and IT8686E is preliminary. Voltage readings,
-temperature readings, fan control, and fan speed measurements may be wrong
-and/or missing. Fan control and fan speed may be enabled and reported for
-non-existing fans. Please report any problems and inconsistencies.
+Support for IT8607E is preliminary. Voltage readings, temperature readings,
+fan control, and fan speed measurements may be wrong and/or missing.
+Fan control and fan speed may be enabled and reported for non-existing
+fans. Please report any problems and inconsistencies.
 
 Reporting information for unsupported chips
 -------------------------------------------
@@ -339,3 +368,11 @@ if all fans are detected and reported.
 This information _might_ give us enough information to add experimental support
 for the chip in question. No guarantees, though - unless a datasheet is
 available, something is likely to be wrong.
+
+A note on sensors-detect
+========================
+
+There is a persistent perception that changes in this driver would have impact
+on the output of sensors-detect. This is not the case. sensors-detect is an
+independent application. Changes in this driver do not affect sensors-detect,
+and changes in sensors-detect do not affect this driver.