+DRIVER REMOVAL NOTICE
+=====================
+
+I have been unable to meet support demands for this driver, resulting
+in unpleasant experience and frustration for everyone involved.
+
+Consequently, the driver will be removed from github, effective
+August 1, 2018. Interested parties are encouraged to clone the driver
+before that time and to start maintaining it on their own.
+
+
Kernel driver it87
==================
Prefix: 'it8622'
Addresses scanned: from Super I/O config space (8 I/O ports)
Datasheet: Not publicly available
+ * IT8625E
+ Prefix: 'it8625'
+ Addresses scanned: from Super I/O config space (8 I/O ports)
+ Datasheet: Not publicly available
* IT8628E
Prefix: 'it8628'
Addresses scanned: from Super I/O config space (8 I/O ports)
Authors:
Christophe Gauthron
Jean Delvare <jdelvare@suse.de>
+ Guenter Roeck <linux@roeck-us.net>
+
+
+Building & Installing
+---------------------
+
+* make clean
+* make
+* sudo make install
+
+
+Using DKMS
+----------
+
+To install:
+
+* sudo make dkms
+
+To remove:
+
+* sudo make dkms_clean
+
+Notes:
+
+* The module does not provide a real version number, so `git describe --long`
+ is used to create one. This means that anything that changes the git state
+ will change the version. `make dkms_clean` should be run before making a
+ commit or an update with `git pull` as the Makefile is currently unable to
+ track the last installed version to replace it. If this doesn't happen, the
+ old version will need to be manually removed from dkms, before installing
+ the updated module.
+ Something like `dkms remove -m it87 -v <old version> --all`, followed by
+ `rm -rf /usr/src/it87-<old version>`, should do.
+ `dkms status it87` can be used to list the installed versions.
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 case, 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
-------------------
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
-------------------------------------------
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.