Add driver removal notice

Signed-off-by: Guenter Roeck <linux@roeck-us.net>

ISSUES

@@ -0,0 +1,24 @@
+Support for old kernel versions
+===============================
+
+The driver is known to not build for v2.6.32 kernels. Exact errors are unknown,
+though it is likely that kernel API functions are incompatible or not supported
+in v2.6.32. Patches to fix the problem will be accepted as long as they are
+implemented in compat.h.
+
+Fan issues after suspend on Gigabyte GA-AX370 Gaming 5 + Ubuntu
+===============================================================
+
+Jaka Jaksic reports that after resuming from suspend to memory on Gigabyte
+GA-AX370 Gaming 5, fans start spinning very fast, regardless of whether IT87
+is loaded or not. Analysis shows that some chip registers have a wrong value
+after resume. The working assumption is that there is a BIOS problem.
+There is no known workaround.
+
+On-board temperature display shows '00' on GA-AX370 Gaming 5
+============================================================
+
+Öyvind Saether reports that the on-board two digit alarmblock display on
+Gigabyte AX370 Gaming 5 shows '00' instead of the current temperature after
+"modprobe it87". No further information is available at this time.
+There is no known workaround.

Makefile

@@ -1,7 +1,10 @@
 # For building for the current running version of Linux
+ifndef TARGET
 TARGET		:= $(shell uname -r)
+endif
 # Or specific version
 #TARGET		:= 2.6.33.5
+
 KERNEL_MODULES	:= /lib/modules/$(TARGET)
 
 ifneq ("","$(wildcard /usr/src/linux-headers-$(TARGET)/*)")
@@ -17,9 +20,27 @@ endif
 endif
 
 #SYSTEM_MAP	:= $(KERNEL_BUILD)/System.map
+ifneq ("","$(wildcard /boot/System.map-$(TARGET))")
 SYSTEM_MAP	:= /boot/System.map-$(TARGET)
+else
+# Arch
+SYSTEM_MAP	:= /proc/kallsyms
+endif
 
 DRIVER := it87
+ifneq ("","$(wildcard .git/*)")
+DRIVER_VERSION := $(shell git describe --long)
+else
+ifneq ("", "$(wildcard VERSION)")
+DRIVER_VERSION := $(shell cat VERSION)
+else
+DRIVER_VERSION := unknown
+endif
+endif
+
+# DKMS
+DKMS_ROOT_PATH=/usr/src/$(DRIVER)-$(DRIVER_VERSION)
+MODPROBE_OUTPUT=$(shell lsmod | grep it87)
 
 # Directory below /lib/modules/$(TARGET)/kernel into which to install
 # the module:
@@ -38,13 +59,18 @@ ifneq ("","$(wildcard $(MODDESTDIR)/*.ko.xz)")
 COMPRESS_XZ := y
 endif
 
-.PHONY: all install modules modules_install clean
+.PHONY: all install modules modules_install clean dkms dkms_clean
 
 all: modules
 
 # Targets for running make directly in the external module directory:
 
-modules clean:
+IT87_CFLAGS=-DIT87_DRIVER_VERSION='\"$(DRIVER_VERSION)\"'
+
+modules:
+	@$(MAKE) EXTRA_CFLAGS="$(IT87_CFLAGS)" -C $(KERNEL_BUILD) M=$(CURDIR) $@
+
+clean:
 	@$(MAKE) -C $(KERNEL_BUILD) M=$(CURDIR) $@
 
 install: modules_install
@@ -59,3 +85,24 @@ ifeq ($(COMPRESS_XZ), y)
 	@xz -f $(MODDESTDIR)/$(DRIVER).ko
 endif
 	depmod -a -F $(SYSTEM_MAP) $(TARGET)
+
+dkms:
+	@sed -i -e '/^PACKAGE_VERSION=/ s/=.*/=\"$(DRIVER_VERSION)\"/' dkms.conf
+	@echo "$(DRIVER_VERSION)" >VERSION
+	@mkdir $(DKMS_ROOT_PATH)
+	@cp `pwd`/dkms.conf $(DKMS_ROOT_PATH)
+	@cp `pwd`/VERSION $(DKMS_ROOT_PATH)
+	@cp `pwd`/Makefile $(DKMS_ROOT_PATH)
+	@cp `pwd`/compat.h $(DKMS_ROOT_PATH)
+	@cp `pwd`/it87.c $(DKMS_ROOT_PATH)
+	@dkms add -m $(DRIVER) -v $(DRIVER_VERSION)
+	@dkms build -m $(DRIVER) -v $(DRIVER_VERSION)
+	@dkms install --force -m $(DRIVER) -v $(DRIVER_VERSION)
+	@modprobe $(DRIVER)
+
+dkms_clean:
+	@if [ ! -z "$(MODPROBE_OUTPUT)" ]; then \
+		rmmod $(DRIVER);\
+	fi
+	@dkms remove -m $(DRIVER) -v $(DRIVER_VERSION) --all
+	@rm -rf $(DKMS_ROOT_PATH)

README

@@ -1,3 +1,14 @@
+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
 ==================
 
@@ -93,6 +104,7 @@ Supported chips:
 Authors:
     Christophe Gauthron
     Jean Delvare <jdelvare@suse.de>
+    Guenter Roeck <linux@roeck-us.net>
 
 
 Building & Installing
@@ -103,6 +115,31 @@ Building & Installing
 * 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
 -----------------
 
@@ -122,6 +159,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 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
 -------------------

dkms.conf

@@ -0,0 +1,7 @@
+MAKE="make TARGET=${kernelver}"
+CLEAN="make clean"
+PACKAGE_NAME="it87"
+PACKAGE_VERSION="to be filled by make dkms"
+BUILT_MODULE_NAME[0]="it87"
+DEST_MODULE_LOCATION[0]="/kernel/drivers/hwmon/it87"
+AUTOINSTALL="yes"