Round #1 of improving pcf(4).

This splits the driver into a bus-independant backend, plus bus-specific
frontends.  The old pcf(4) (i386/ISA) frontend is now in pcf_isa.c, the
frontend in envctrl.c is for sparc64/Ebus2 (Sun device name: SUNW,envctrl
from Sun E450 machines).  More frontends are expected to appear in future.

This is not yet ready for public consumption, but it basically works.
Nicolas will bring over his ISA-specific fixes soon.

Reviewed by:	nsouch

1 files changed, 196 insertions, 0 deletions

diff --git a/sys/dev/pcf/envctrl.c b/sys/dev/pcf/envctrl.c
new file mode 100644
index 0000000..8126924
--- /dev/null
+++ b/sys/dev/pcf/envctrl.c
@@ -0,0 +1,196 @@
+/*-
+ * Copyright (c) 2004 Joerg Wunsch
+ *
+ * derived from sys/i386/isa/pcf.c which is:
+ *
+ * Copyright (c) 1998 Nicolas Souchu, Marc Bouget
+ * 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 AND CONTRIBUTORS ``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 OR CONTRIBUTORS 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$");
+
+/*
+ * Device specific driver for the SUNW,envctrl device found on some
+ * UltraSPARC Sun systems.  This device is a Philips PCF8584 sitting
+ * on the Ebus2.
+ */
+
+#include <sys/param.h>
+#include <sys/systm.h>
+#include <sys/bus.h>
+#include <sys/conf.h>
+#include <sys/kernel.h>
+#include <sys/malloc.h>
+#include <sys/resource.h>
+#include <sys/uio.h>
+
+#include <machine/bus.h>
+#include <machine/resource.h>
+
+#include <sys/rman.h>
+
+#include <dev/ofw/openfirm.h>
+
+#include <sparc64/ebus/ebusvar.h>
+
+#include <dev/iicbus/iiconf.h>
+#include <dev/pcf/pcfvar.h>
+#include "iicbus_if.h"
+
+#undef PCF_DEFAULT_ADDR
+#define PCF_DEFAULT_ADDR	0x55 /* SUNW,pcf default */
+
+static int envctrl_probe(device_t);
+static int envctrl_attach(device_t);
+static int envctrl_detach(device_t);
+
+static device_method_t envctrl_methods[] = {
+	/* device interface */
+	DEVMETHOD(device_probe,		envctrl_probe),
+	DEVMETHOD(device_attach,	envctrl_attach),
+	DEVMETHOD(device_detach,	envctrl_detach),
+
+	/* iicbus interface */
+	DEVMETHOD(iicbus_callback,	iicbus_null_callback),
+	DEVMETHOD(iicbus_repeated_start, pcf_repeated_start),
+	DEVMETHOD(iicbus_start,		pcf_start),
+	DEVMETHOD(iicbus_stop,		pcf_stop),
+	DEVMETHOD(iicbus_write,		pcf_write),
+	DEVMETHOD(iicbus_read,		pcf_read),
+	DEVMETHOD(iicbus_reset,		pcf_rst_card),
+	{ 0, 0 }
+};
+
+static devclass_t envctrl_devclass;
+
+static driver_t envctrl_driver = {
+	"envctrl",
+	envctrl_methods,
+	sizeof(struct pcf_softc),
+};
+
+static int
+envctrl_probe(device_t dev)
+{
+
+	if (strcmp("SUNW,envctrl", ebus_get_name(dev)) == 0) {
+		device_set_desc(dev, "EBus SUNW,envctrl");
+		return (0);
+	}
+	return (ENXIO);
+}
+
+static int
+envctrl_attach(device_t dev)
+{
+	struct pcf_softc *sc;
+	int rv = ENXIO;
+
+	sc = DEVTOSOFTC(dev);
+	bzero(sc, sizeof(struct pcf_softc));
+
+	/* IO port is mandatory */
+	sc->res_ioport = bus_alloc_resource_any(dev, SYS_RES_IOPORT,
+						&sc->rid_ioport, RF_ACTIVE);
+	if (sc->res_ioport == 0) {
+		device_printf(dev, "cannot reserve I/O port range\n");
+		goto error;
+	}
+
+	sc->pcf_flags = device_get_flags(dev);
+
+	if (!(sc->pcf_flags & IIC_POLLED)) {
+		sc->res_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &sc->rid_irq,
+						     RF_ACTIVE);
+		if (sc->res_irq == 0) {
+			device_printf(dev, "can't reserve irq, polled mode.\n");
+			sc->pcf_flags |= IIC_POLLED;
+		}
+	}
+
+	/* reset the chip */
+	pcf_rst_card(dev, IIC_FASTEST, PCF_DEFAULT_ADDR, NULL);
+
+	rv = BUS_SETUP_INTR(device_get_parent(dev), dev, sc->res_irq,
+			    INTR_TYPE_NET /* | INTR_ENTROPY */,
+			    pcf_intr, sc, &sc->intr_cookie);
+	if (rv) {
+		device_printf(dev, "could not setup IRQ\n");
+		goto error;
+	}
+
+	if ((sc->iicbus = device_add_child(dev, "iicbus", -1)) == NULL)
+		device_printf(dev, "could not allocate iicbus instance\n");
+
+	/* probe and attach the iicbus */
+	bus_generic_attach(dev);
+
+	return (0);
+
+error:
+	if (sc->res_irq != 0) {
+		bus_deactivate_resource(dev, SYS_RES_IRQ, sc->rid_irq,
+					sc->res_irq);
+		bus_release_resource(dev, SYS_RES_IRQ, sc->rid_irq,
+				     sc->res_irq);
+	}
+	if (sc->res_ioport != 0) {
+		bus_deactivate_resource(dev, SYS_RES_IOPORT, sc->rid_ioport,
+					sc->res_ioport);
+		bus_release_resource(dev, SYS_RES_IOPORT, sc->rid_ioport,
+				     sc->res_ioport);
+	}
+	return (rv);
+}
+
+static int
+envctrl_detach(device_t dev)
+{
+	struct pcf_softc *sc;
+	int rv;
+
+	sc = DEVTOSOFTC(dev);
+
+	if ((rv = bus_generic_detach(dev)) != 0)
+		return (rv);
+
+	if ((rv = device_delete_child(dev, sc->iicbus)) != 0)
+		return (rv);
+
+	if (sc->res_irq != 0) {
+		BUS_TEARDOWN_INTR(device_get_parent(dev), dev, sc->res_irq,
+				  sc->intr_cookie);
+		bus_deactivate_resource(dev, SYS_RES_IRQ, sc->rid_irq, sc->res_irq);
+		bus_release_resource(dev, SYS_RES_IRQ, sc->rid_irq, sc->res_irq);
+	}
+
+	bus_deactivate_resource(dev, SYS_RES_IOPORT, sc->rid_ioport, sc->res_ioport);
+	bus_release_resource(dev, SYS_RES_IOPORT, sc->rid_ioport, sc->res_ioport);
+
+	return (0);
+}
+
+DRIVER_MODULE(pcf, ebus, envctrl_driver, envctrl_devclass, 0, 0);
+MODULE_DEPEND(pcf, iicbus, PCF_MINVER, PCF_PREFVER, PCF_MAXVER);
+MODULE_VERSION(pcf, PCF_MODVER);