Add new fan controller driver for the G4 MDD PowerMac. Submitted and tested

by Justin Hibbits.

Approved by:	nwhitehorn (mentor)

4 files changed, 219 insertions, 0 deletions

diff --git a/sys/conf/files.powerpc b/sys/conf/files.powerpc
index 9dcc867..7226c8f 100644
--- a/sys/conf/files.powerpc
+++ b/sys/conf/files.powerpc
@@ -162,6 +162,7 @@ powerpc/powermac/smusat.c	optional	powermac smu
 powerpc/powermac/uninorth.c	optional	powermac
 powerpc/powermac/uninorthpci.c	optional	powermac pci
 powerpc/powermac/vcoregpio.c	optional	powermac 
+powerpc/powermac/windtunnel.c	optional	powermac windtunnel
 powerpc/powerpc/altivec.c	optional	aim
 powerpc/powerpc/atomic.S	standard
 powerpc/powerpc/autoconf.c	standard
diff --git a/sys/powerpc/conf/GENERIC b/sys/powerpc/conf/GENERIC
index af4b19a..54d4639 100644
--- a/sys/powerpc/conf/GENERIC
+++ b/sys/powerpc/conf/GENERIC
@@ -180,6 +180,7 @@ device		fcu		# Apple Fan Control Unit
 device		max6690		# PowerMac7,2 temperature sensor
 device		powermac_nvram	# Open Firmware configuration NVRAM
 device		smu		# Apple System Management Unit
+device		windtunnel	# Apple G4 MDD fan controller
 
 # ADB support
 device		adb
diff --git a/sys/powerpc/conf/NOTES b/sys/powerpc/conf/NOTES
index 374106d..0045763 100644
--- a/sys/powerpc/conf/NOTES
+++ b/sys/powerpc/conf/NOTES
@@ -47,6 +47,7 @@ device		pmu		# Apple Power Management Unit
 device		smu		# Apple System Management Unit
 device		snd_ai2s	# Apple I2S Audio
 device		snd_davbus	# Apple Davbus Audio
+device		windtunnel	# Apple G4 MDD fan controller
 
 
 #####################################################################
diff --git a/sys/powerpc/powermac/windtunnel.c b/sys/powerpc/powermac/windtunnel.c
new file mode 100644
index 0000000..b4aeca3
--- /dev/null
+++ b/sys/powerpc/powermac/windtunnel.c
@@ -0,0 +1,216 @@
+/*-
+ * Copyright (c) 2011 Justin Hibbits
+ * Copyright (c) 2010 Andreas Tobler
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+ * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+ * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */
+
+#include <sys/cdefs.h>
+__FBSDID("$FreeBSD$");
+
+#include <sys/param.h>
+#include <sys/bus.h>
+#include <sys/systm.h>
+#include <sys/module.h>
+#include <sys/callout.h>
+#include <sys/conf.h>
+#include <sys/cpu.h>
+#include <sys/ctype.h>
+#include <sys/kernel.h>
+#include <sys/kthread.h>
+#include <sys/limits.h>
+#include <sys/reboot.h>
+#include <sys/rman.h>
+#include <sys/sysctl.h>
+#include <sys/unistd.h>
+
+#include <machine/bus.h>
+#include <machine/md_var.h>
+
+#include <dev/iicbus/iicbus.h>
+#include <dev/iicbus/iiconf.h>
+
+#include <dev/ofw/openfirm.h>
+#include <dev/ofw/ofw_bus.h>
+#include <powerpc/powermac/powermac_thermal.h>
+
+struct adm1030_softc {
+	struct pmac_fan fan;
+	device_t	sc_dev;
+	struct intr_config_hook enum_hook;
+	uint32_t	sc_addr;
+	phandle_t	sc_thermostat_phandle;
+	device_t	sc_thermostat_dev;
+};
+
+/* Regular bus attachment functions */
+static int	adm1030_probe(device_t);
+static int	adm1030_attach(device_t);
+
+/* Utility functions */
+static void	adm1030_start(void *xdev);
+static int	adm1030_write_byte(device_t dev, uint32_t addr, uint8_t reg, uint8_t buf);
+static int adm1030_set(struct adm1030_softc *fan, int pwm);
+
+static device_method_t adm1030_methods[] = {
+	/* Device interface */
+	DEVMETHOD(device_probe, adm1030_probe),
+	DEVMETHOD(device_attach, adm1030_attach),
+	{0, 0},
+};
+
+static driver_t	adm1030_driver = {
+	"adm1030",
+	adm1030_methods,
+	sizeof(struct adm1030_softc)
+};
+
+static devclass_t adm1030_devclass;
+
+DRIVER_MODULE(adm1030, iicbus, adm1030_driver, adm1030_devclass, 0, 0);
+
+static int
+adm1030_write_byte(device_t dev, uint32_t addr, uint8_t reg, uint8_t byte)
+{
+	unsigned char	buf[4];
+	int try = 0;
+
+	struct iic_msg	msg[] = {
+		{addr, IIC_M_WR, 0, buf}
+	};
+
+	msg[0].len = 2;
+	buf[0] = reg;
+	buf[1] = byte;
+
+	for (;;)
+	{
+		if (iicbus_transfer(dev, msg, 1) == 0)
+			return (0);
+
+		if (++try > 5) {
+			device_printf(dev, "iicbus write failed\n");
+			return (-1);
+		}
+		pause("adm1030_write_byte", hz);
+	}
+}
+
+static int
+adm1030_probe(device_t dev)
+{
+	const char     *name, *compatible;
+	struct adm1030_softc *sc;
+	phandle_t	handle;
+	phandle_t	thermostat;
+
+	name = ofw_bus_get_name(dev);
+	compatible = ofw_bus_get_compat(dev);
+	handle = ofw_bus_get_node(dev);
+
+	if (!name)
+		return (ENXIO);
+
+	if (strcmp(name, "fan") != 0 || strcmp(compatible, "adm1030") != 0)
+		return (ENXIO);
+
+	/* This driver can only be used if there's an associated temp sensor. */
+	if (OF_getprop(handle, "platform-getTemp", &thermostat, sizeof(thermostat)) < 0)
+		return (ENXIO);
+
+	sc = device_get_softc(dev);
+	sc->sc_dev = dev;
+	sc->sc_addr = iicbus_get_addr(dev);
+
+	device_set_desc(dev, "G4 MDD Fan driver");
+
+	return (0);
+}
+
+static int
+adm1030_attach(device_t dev)
+{
+	struct adm1030_softc *sc;
+
+	sc = device_get_softc(dev);
+
+	sc->enum_hook.ich_func = adm1030_start;
+	sc->enum_hook.ich_arg = dev;
+
+	/*
+	 * We have to wait until interrupts are enabled. I2C read and write
+	 * only works if the interrupts are available. The unin/i2c is
+	 * controlled by the htpic on unin. But this is not the master. The
+	 * openpic on mac-io is controlling the htpic. This one gets attached
+	 * after the mac-io probing and then the interrupts will be
+	 * available.
+	 */
+
+	if (config_intrhook_establish(&sc->enum_hook) != 0)
+		return (ENOMEM);
+
+	return (0);
+}
+
+static void
+adm1030_start(void *xdev)
+{
+	struct adm1030_softc *sc;
+
+	device_t	dev = (device_t) xdev;
+
+	sc = device_get_softc(dev);
+
+	/* Start the adm1030 device. */
+	adm1030_write_byte(sc->sc_dev, sc->sc_addr, 0x1, 0x1);
+	adm1030_write_byte(sc->sc_dev, sc->sc_addr, 0x0, 0x95);
+	adm1030_write_byte(sc->sc_dev, sc->sc_addr, 0x23, 0x91);
+
+	/* Use the RPM fields as PWM duty cycles. */
+	sc->fan.min_rpm = 0;
+	sc->fan.max_rpm = 15;
+	sc->fan.default_rpm = 2;
+
+	strcpy(sc->fan.name, "MDD Case fan");
+	sc->fan.zone = 0;
+	sc->fan.read = NULL;
+	sc->fan.set = (int (*)(struct pmac_fan *, int))adm1030_set;
+	config_intrhook_disestablish(&sc->enum_hook);
+
+	pmac_thermal_fan_register(&sc->fan);
+}
+
+static int adm1030_set(struct adm1030_softc *fan, int pwm)
+{
+	/* Clamp the PWM to 0-0xF, one nibble. */
+	if (pwm > 0xF)
+		pwm = 0xF;
+	if (pwm < 0)
+		pwm = 0;
+
+	if (adm1030_write_byte(fan->sc_dev, fan->sc_addr, 0x22, pwm) < 0)
+		return (-1);
+
+	return (0);
+}
+