Add a driver for the 'clock-board' device (the clock board is an

inevitable component in Sun Exx00 machines and provides serial ports,
NVRAM and TOD amongst others which are handled by uart(4) and eeprom(4)
respectively). This driver currently only prints out information about
the chassis on attach and allows to blink the 'Cycling' LED (which is
duplicated on the front panel) of the clock board just like fhc(4) does
for the other boards. The device name for the LED is /dev/led/clockboard.

Obtained from:	OpenBSD
Tested by:	joerg

5 files changed, 262 insertions, 0 deletions

diff --git a/sys/conf/files.sparc64 b/sys/conf/files.sparc64
index 0d7bfcc..a7d4691 100644
--- a/sys/conf/files.sparc64
+++ b/sys/conf/files.sparc64
@@ -50,6 +50,7 @@ libkern/flsl.c			standard
 sparc64/central/central.c	optional	central
 sparc64/creator/creator_upa.c	optional	creator sc
 sparc64/ebus/ebus.c		optional	ebus
+sparc64/fhc/clkbrd.c		optional	clkbrd fhc
 sparc64/fhc/fhc.c		optional	fhc
 sparc64/fhc/fhc_central.c	optional	fhc central
 sparc64/fhc/fhc_nexus.c		optional	fhc
diff --git a/sys/sparc64/conf/GENERIC b/sys/sparc64/conf/GENERIC
index 42224bb..1e642e4 100644
--- a/sys/sparc64/conf/GENERIC
+++ b/sys/sparc64/conf/GENERIC
@@ -127,6 +127,7 @@ device		ses		# SCSI Environmental Services (and SAF-TE)
 
 # Builtin hardware
 device		auxio		# auxiliary I/O device
+device		clkbrd		# Clock Board (blinkenlight on Sun Exx00)
 device		genclock	# Generic clock interface
 device		eeprom		# eeprom (really a front-end for the MK48Txx)
 device		mk48txx		# Mostek MK48Txx clocks
diff --git a/sys/sparc64/conf/NOTES b/sys/sparc64/conf/NOTES
index 44d2925..45f789f 100644
--- a/sys/sparc64/conf/NOTES
+++ b/sys/sparc64/conf/NOTES
@@ -50,6 +50,7 @@ device		mc146818	# Motorola MC146818 and compatible clocks
 #
 
 device		auxio		# auxiliary I/O device
+device		clkbrd		# Clock Board (blinkenlight on Sun Exx00)
 device		creator		# Creator, Creator3D and Elite3D graphics cards
 
 device		ofw_console	# Open Firmware console device
diff --git a/sys/sparc64/fhc/clkbrd.c b/sys/sparc64/fhc/clkbrd.c
new file mode 100644
index 0000000..db32c1f
--- /dev/null
+++ b/sys/sparc64/fhc/clkbrd.c
@@ -0,0 +1,212 @@
+/*-
+ * Copyright (c) 2004 Jason L. Wright (jason@thought.net)
+ * Copyright (c) 2005 Marius Strobl <marius@FreeBSD.org>
+ * 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.
+ *
+ *	from: OpenBSD: clkbrd.c,v 1.5 2004/10/01 18:18:49 jason Exp
+ */
+
+#include <sys/cdefs.h>
+__FBSDID("$FreeBSD$");
+
+#include <sys/param.h>
+#include <sys/systm.h>
+#include <sys/kernel.h>
+#include <sys/module.h>
+#include <sys/resource.h>
+#include <sys/rman.h>
+
+#include <dev/led/led.h>
+#include <dev/ofw/ofw_bus.h>
+
+#include <machine/bus.h>
+#include <machine/resource.h>
+
+#include <sparc64/fhc/clkbrdreg.h>
+
+#define	CLKBRD_NREG	3
+
+#define	CLKBRD_CF	0
+#define	CLKBRD_CLK	1
+#define	CLKBRD_CLKVER	2
+
+struct clkbrd_softc {
+	struct device		*sc_dev;
+	struct resource		*sc_res[CLKBRD_NREG];
+	int			sc_rid[CLKBRD_NREG];
+	bus_space_tag_t		sc_bt[CLKBRD_NREG];
+	bus_space_handle_t	sc_bh[CLKBRD_NREG];
+	uint8_t			sc_clk_ctrl;
+	struct cdev		*sc_led_dev;
+	int			sc_flags;
+#define	CLKBRD_HAS_CLKVER	(1 << 0)
+};
+
+static devclass_t clkbrd_devclass;
+
+static device_probe_t clkbrd_probe;
+static device_attach_t clkbrd_attach;
+static device_detach_t clkbrd_detach;
+
+static void clkbrd_free_resources(struct clkbrd_softc *);
+static void clkbrd_led_func(void *, int);
+
+static device_method_t clkbrd_methods[] = {
+	/* Device interface */
+	DEVMETHOD(device_probe,		clkbrd_probe),
+	DEVMETHOD(device_attach,	clkbrd_attach),
+	DEVMETHOD(device_detach,	clkbrd_detach),
+
+        { 0, 0 }
+};
+
+static driver_t clkbrd_driver = {
+        "clkbrd",
+        clkbrd_methods,
+        sizeof(struct clkbrd_softc),
+};
+
+DRIVER_MODULE(clkbrd, fhc, clkbrd_driver, clkbrd_devclass, 0, 0);
+
+static int
+clkbrd_probe(device_t dev)
+{
+
+	if (strcmp(ofw_bus_get_name(dev), "clock-board") == 0) {
+		device_set_desc(dev, "Clock Board");
+		return (0);
+	}
+	return (ENXIO);
+}
+
+static int
+clkbrd_attach(device_t dev)
+{
+	struct clkbrd_softc *sc;
+	int i, slots;
+	uint8_t r;
+
+	sc = device_get_softc(dev);
+	bzero(sc, sizeof(struct clkbrd_softc));
+	sc->sc_dev = dev;
+
+	for (i = CLKBRD_CF; i <= CLKBRD_CLKVER; i++) {
+		sc->sc_rid[i] = i;
+		sc->sc_res[i] = bus_alloc_resource_any(sc->sc_dev,
+		    SYS_RES_MEMORY, &sc->sc_rid[i], RF_ACTIVE);
+		if (sc->sc_res[i] == NULL) {
+			if (i != CLKBRD_CLKVER) {
+				device_printf(sc->sc_dev,
+				    "could not allocate resource %d\n", i);
+				goto fail;
+			}
+			continue;
+		}
+		sc->sc_bt[i] = rman_get_bustag(sc->sc_res[i]);
+		sc->sc_bh[i] = rman_get_bushandle(sc->sc_res[i]);
+		if (i == CLKBRD_CLKVER)
+			sc->sc_flags |= CLKBRD_HAS_CLKVER;
+	}
+
+	slots = 4;
+	r = bus_space_read_1(sc->sc_bt[CLKBRD_CLK], sc->sc_bh[CLKBRD_CLK],
+	    CLK_STS1);
+	switch (r & 0xc0) {
+	case 0x40:
+		slots = 16;
+		break;
+	case 0xc0:
+		slots = 8;
+		break;
+	case 0x80:
+		if (sc->sc_flags & CLKBRD_HAS_CLKVER) {
+			r = bus_space_read_1(sc->sc_bt[CLKBRD_CLKVER],
+			    sc->sc_bh[CLKBRD_CLKVER], 0);
+			if (r != 0 && (r & 0x80) == 0)
+					slots = 5;
+		}
+	}
+
+	device_printf(sc->sc_dev, "Sun Enterprise Exx00 machine: %d slots\n",
+	    slots);
+
+	sc->sc_clk_ctrl = bus_space_read_1(sc->sc_bt[CLKBRD_CLK],
+	    sc->sc_bh[CLKBRD_CLK], CLK_CTRL);
+	sc->sc_led_dev = led_create(clkbrd_led_func, sc, "clockboard");
+
+	return (0);
+
+ fail:
+	clkbrd_free_resources(sc);
+
+	return (ENXIO);
+}
+
+static int
+clkbrd_detach(device_t dev)
+{
+	struct clkbrd_softc *sc;
+
+	sc = device_get_softc(dev);
+
+	led_destroy(sc->sc_led_dev);
+	bus_space_write_1(sc->sc_bt[CLKBRD_CLK], sc->sc_bh[CLKBRD_CLK],
+	    CLK_CTRL, sc->sc_clk_ctrl);
+	bus_space_read_1(sc->sc_bt[CLKBRD_CLK], sc->sc_bh[CLKBRD_CLK],
+	    CLK_CTRL);
+	clkbrd_free_resources(sc);
+
+	return (0);
+}
+
+static void
+clkbrd_free_resources(struct clkbrd_softc *sc)
+{
+	int i;
+
+	for (i = CLKBRD_CF; i <= CLKBRD_CLKVER; i++)
+		if (sc->sc_res[i] != NULL)
+			bus_release_resource(sc->sc_dev, SYS_RES_MEMORY,
+			    sc->sc_rid[i], sc->sc_res[i]);
+}
+
+static void
+clkbrd_led_func(void *arg, int onoff)
+{
+	struct clkbrd_softc *sc;
+	uint8_t r;
+
+	sc = (struct clkbrd_softc *)arg;
+
+	r = bus_space_read_1(sc->sc_bt[CLKBRD_CLK], sc->sc_bh[CLKBRD_CLK],
+	    CLK_CTRL);
+	if (onoff)
+		r |= CLK_CTRL_RLED;
+	else
+		r &= ~CLK_CTRL_RLED;
+	bus_space_write_1(sc->sc_bt[CLKBRD_CLK], sc->sc_bh[CLKBRD_CLK],
+	    CLK_CTRL, r);
+	bus_space_read_1(sc->sc_bt[CLKBRD_CLK], sc->sc_bh[CLKBRD_CLK],
+	    CLK_CTRL);
+}
diff --git a/sys/sparc64/fhc/clkbrdreg.h b/sys/sparc64/fhc/clkbrdreg.h
new file mode 100644
index 0000000..6aa3c1a
--- /dev/null
+++ b/sys/sparc64/fhc/clkbrdreg.h
@@ -0,0 +1,47 @@
+/*-
+ * Copyright (c) 2004 Jason L. Wright (jason@thought.net)
+ * 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.
+ *
+ *	from: OpenBSD: clkbrdreg.h,v 1.2 2004/10/01 15:36:30 jason Exp
+ *
+ * $FreeBSD$
+ */
+
+#define	CLK_CTRL	0x00
+#define	CLK_STS1	0x10
+#define	CLK_STS2	0x20
+#define	CLK_PSTS1	0x30
+#define	CLK_PPRES	0x40
+#define	CLK_TEMP	0x50
+#define	CLK_IRQ		0x60
+#define	CLK_PSTS2	0x70
+
+#define	CLK_CTRL_IEN_FAN	0x80	/* intr enable: fan failure */
+#define	CLK_CTRL_IEN_DC		0x40	/* intr enable: pwr supply DC */
+#define	CLK_CTRL_IEN_AC		0x20	/* intr enable: AC pwr supply */
+#define	CLK_CTRL_IEN_BRD	0x10	/* intr enable: board insert */
+#define	CLK_CTRL_POFF		0x08	/* turn off system power */
+#define	CLK_CTRL_LLED		0x04	/* left led (reversed) */
+#define	CLK_CTRL_MLED		0x02	/* middle led */
+#define	CLK_CTRL_RLED		0x01	/* right led */