tsec: Refactor driver's structure.

Split the driver into the core functionality part (sys/dev/tsec/if_tsec.c) and
the bus attachment (sys/dev/tsec/if_tsec_ocp.c).

This lets better integrate and maintain the driver in other environments with
different attachment abstractions (there is at least one other FreeBSD port --
MPC83xx -- which uses this TSEC driver, but with different local bus model
i.e. some OF derivative). While there, clean up and fix minor cosmetics.

Obtained from:	Semihalf

1 files changed, 340 insertions, 0 deletions

diff --git a/sys/dev/tsec/if_tsec_ocp.c b/sys/dev/tsec/if_tsec_ocp.c
new file mode 100644
index 0000000..5c1a74d
--- /dev/null
+++ b/sys/dev/tsec/if_tsec_ocp.c
@@ -0,0 +1,340 @@
+/*-
+ * Copyright (C) 2007-2008 Semihalf, Rafal Jaworowski <raj@semihalf.com>
+ * Copyright (C) 2006-2007 Semihalf, Piotr Kruszynski <ppk@semihalf.com>
+ * 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.
+ */
+
+/*
+ * OCP attachment driver for Freescale TSEC controller.
+ */
+#include <sys/cdefs.h>
+__FBSDID("$FreeBSD$");
+
+#include <sys/param.h>
+#include <sys/systm.h>
+#include <sys/endian.h>
+#include <sys/mbuf.h>
+#include <sys/kernel.h>
+#include <sys/module.h>
+#include <sys/socket.h>
+#include <sys/sysctl.h>
+
+#include <sys/bus.h>
+#include <machine/bus.h>
+#include <sys/rman.h>
+#include <machine/resource.h>
+
+#include <net/ethernet.h>
+#include <net/if.h>
+#include <net/if_dl.h>
+#include <net/if_media.h>
+#include <net/if_arp.h>
+
+#include <dev/mii/mii.h>
+#include <dev/mii/miivar.h>
+
+#include <machine/bootinfo.h>
+#include <machine/ocpbus.h>
+
+#include <dev/tsec/if_tsec.h>
+#include <dev/tsec/if_tsecreg.h>
+
+#include "miibus_if.h"
+
+#define	OCP_TSEC_RID_TXIRQ	0
+#define	OCP_TSEC_RID_RXIRQ	1
+#define	OCP_TSEC_RID_ERRIRQ	2
+
+extern struct tsec_softc *tsec0_sc;
+
+static int	tsec_ocp_probe(device_t dev);
+static int	tsec_ocp_attach(device_t dev);
+static int	tsec_ocp_detach(device_t dev);
+static int	tsec_setup_intr(struct tsec_softc *sc, struct resource **ires,
+    void **ihand, int *irid, driver_intr_t handler, const char *iname);
+static void	tsec_release_intr(struct tsec_softc *sc, struct resource *ires,
+    void *ihand, int irid, const char *iname);
+
+static device_method_t tsec_methods[] = {
+	/* Device interface */
+	DEVMETHOD(device_probe,		tsec_ocp_probe),
+	DEVMETHOD(device_attach,	tsec_ocp_attach),
+	DEVMETHOD(device_detach,	tsec_ocp_detach),
+
+	DEVMETHOD(device_shutdown,	tsec_shutdown),
+	DEVMETHOD(device_suspend,	tsec_suspend),
+	DEVMETHOD(device_resume,	tsec_resume),
+
+	/* Bus interface */
+	DEVMETHOD(bus_print_child,	bus_generic_print_child),
+	DEVMETHOD(bus_driver_added,	bus_generic_driver_added),
+
+	/* MII interface */
+	DEVMETHOD(miibus_readreg,	tsec_miibus_readreg),
+	DEVMETHOD(miibus_writereg,	tsec_miibus_writereg),
+	DEVMETHOD(miibus_statchg,	tsec_miibus_statchg),
+	{ 0, 0 }
+};
+
+static driver_t tsec_ocp_driver = {
+	"tsec",
+	tsec_methods,
+	sizeof(struct tsec_softc),
+};
+
+DRIVER_MODULE(tsec, ocpbus, tsec_ocp_driver, tsec_devclass, 0, 0);
+MODULE_DEPEND(tsec, ocpbus, 1, 1, 1);
+MODULE_DEPEND(tsec, ether, 1, 1, 1);
+
+static int
+tsec_ocp_probe(device_t dev)
+{
+	struct tsec_softc *sc;
+	device_t parent;
+	uintptr_t devtype;
+	int error;
+	uint32_t id;
+
+	parent = device_get_parent(dev);
+
+	error = BUS_READ_IVAR(parent, dev, OCPBUS_IVAR_DEVTYPE, &devtype);
+	if (error)
+		return (error);
+	if (devtype != OCPBUS_DEVTYPE_TSEC)
+		return (ENXIO);
+
+	sc = device_get_softc(dev);
+
+	sc->sc_rrid = 0;
+	sc->sc_rres = bus_alloc_resource(dev, SYS_RES_MEMORY, &sc->sc_rrid,
+	    0ul, ~0ul, TSEC_IO_SIZE, RF_ACTIVE);
+	if (sc->sc_rres == NULL)
+		return (ENXIO);
+
+	sc->sc_bas.bsh = rman_get_bushandle(sc->sc_rres);
+	sc->sc_bas.bst = rman_get_bustag(sc->sc_rres);
+
+	/* Check that we actually have a TSEC at this address */
+	id = TSEC_READ(sc, TSEC_REG_ID) | TSEC_READ(sc, TSEC_REG_ID2);
+
+	bus_release_resource(dev, SYS_RES_MEMORY, sc->sc_rrid, sc->sc_rres);
+
+	if (id == 0)
+		return (ENXIO);
+
+	device_set_desc(dev, "Three-Speed Ethernet Controller");
+	return (BUS_PROBE_DEFAULT);
+}
+
+static int
+tsec_ocp_attach(device_t dev)
+{
+	struct tsec_softc *sc;
+	int error = 0;
+
+	sc = device_get_softc(dev);
+	sc->dev = dev;
+
+	/* XXX add comment on weird FSL's MII registers access design */
+	if (device_get_unit(dev) == 0)
+		tsec0_sc = sc;
+
+	/* Init timer */
+	callout_init(&sc->tsec_callout, 1);
+
+	/* Init locks */
+	mtx_init(&sc->transmit_lock, device_get_nameunit(dev), "TSEC TX lock",
+	    MTX_DEF);
+	mtx_init(&sc->receive_lock, device_get_nameunit(dev), "TSEC RX lock",
+	    MTX_DEF);
+	
+	/* Allocate IO memory for TSEC registers */
+	sc->sc_rrid = 0;
+	sc->sc_rres = bus_alloc_resource(dev, SYS_RES_MEMORY, &sc->sc_rrid,
+	    0ul, ~0ul, TSEC_IO_SIZE, RF_ACTIVE);
+	if (sc->sc_rres == NULL) {
+		device_printf(dev, "could not allocate IO memory range!\n");
+		goto fail1;
+	}
+	sc->sc_bas.bsh = rman_get_bushandle(sc->sc_rres);
+	sc->sc_bas.bst = rman_get_bustag(sc->sc_rres);
+
+	/* TSEC attach */
+	if (tsec_attach(sc) != 0) {
+		device_printf(dev, "could not be configured\n");
+		goto fail2;
+	}
+
+	/* Set up interrupts (TX/RX/ERR) */
+	sc->sc_transmit_irid = OCP_TSEC_RID_TXIRQ;
+	error = tsec_setup_intr(sc, &sc->sc_transmit_ires,
+	    &sc->sc_transmit_ihand, &sc->sc_transmit_irid,
+	    tsec_transmit_intr, "TX");
+	if (error)
+		goto fail2;
+
+	sc->sc_receive_irid = OCP_TSEC_RID_RXIRQ;
+	error = tsec_setup_intr(sc, &sc->sc_receive_ires,
+	    &sc->sc_receive_ihand, &sc->sc_receive_irid,
+	    tsec_receive_intr, "RX");
+	if (error)
+		goto fail3;
+
+	sc->sc_error_irid = OCP_TSEC_RID_ERRIRQ;
+	error = tsec_setup_intr(sc, &sc->sc_error_ires,
+	    &sc->sc_error_ihand, &sc->sc_error_irid,
+	    tsec_error_intr, "ERR");
+	if (error)
+		goto fail4;
+
+	return (0);
+
+fail4:
+	tsec_release_intr(sc, sc->sc_receive_ires, sc->sc_receive_ihand,
+	    sc->sc_receive_irid, "RX");
+fail3:
+	tsec_release_intr(sc, sc->sc_transmit_ires, sc->sc_transmit_ihand,
+	    sc->sc_transmit_irid, "TX");
+fail2:
+	bus_release_resource(dev, SYS_RES_MEMORY, sc->sc_rrid, sc->sc_rres);
+fail1:
+	mtx_destroy(&sc->receive_lock);
+	mtx_destroy(&sc->transmit_lock);
+	return (ENXIO);
+}
+
+static int
+tsec_setup_intr(struct tsec_softc *sc, struct resource **ires, void **ihand,
+    int *irid, driver_intr_t handler, const char *iname)
+{
+	int error;
+
+	(*ires) = bus_alloc_resource_any(sc->dev, SYS_RES_IRQ, irid, RF_ACTIVE);
+	if ((*ires) == NULL) {
+		device_printf(sc->dev, "could not allocate %s IRQ\n", iname);
+		return (ENXIO);
+	}
+	error = bus_setup_intr(sc->dev, *ires, INTR_TYPE_NET | INTR_MPSAFE,
+	    NULL, handler, sc, ihand);
+	if (error) {
+		device_printf(sc->dev, "failed to set up %s IRQ\n", iname);
+		if (bus_release_resource(sc->dev, SYS_RES_IRQ, *irid, *ires))
+			device_printf(sc->dev, "could not release %s IRQ\n", iname);
+		(*ires) = NULL;
+		return (error);
+	}
+	return (0);
+}
+
+static void
+tsec_release_intr(struct tsec_softc *sc, struct resource *ires, void *ihand,
+    int irid, const char *iname)
+{
+	int error;
+
+	if (ires == NULL)
+		return;
+
+	error = bus_teardown_intr(sc->dev, ires, ihand);
+	if (error)
+		device_printf(sc->dev, "bus_teardown_intr() failed for %s intr"
+		    ", error %d\n", iname, error);
+
+	error = bus_release_resource(sc->dev, SYS_RES_IRQ, irid, ires);
+	if (error)
+		device_printf(sc->dev, "bus_release_resource() failed for %s intr"
+		    ", error %d\n", iname, error);
+}
+
+static int
+tsec_ocp_detach(device_t dev)
+{
+	struct tsec_softc *sc;
+	int error;
+
+	sc = device_get_softc(dev);
+
+	/* Wait for stopping watchdog */
+	callout_drain(&sc->tsec_callout);
+
+	/* Stop and release all interrupts */
+	tsec_release_intr(sc, sc->sc_transmit_ires, sc->sc_transmit_ihand,
+	    sc->sc_transmit_irid, "TX");
+	tsec_release_intr(sc, sc->sc_receive_ires, sc->sc_receive_ihand,
+	    sc->sc_receive_irid, "RX");
+	tsec_release_intr(sc, sc->sc_error_ires, sc->sc_error_ihand,
+	    sc->sc_error_irid, "ERR");
+
+	/* TSEC detach */
+	tsec_detach(sc);
+
+	/* Free IO memory handler */
+	if (sc->sc_rres) {
+		error = bus_release_resource(dev, SYS_RES_MEMORY, sc->sc_rrid,
+		    sc->sc_rres);
+		if (error)
+			device_printf(dev, "bus_release_resource() failed for"
+			    " IO memory, error %d\n", error);
+	}
+
+	/* Destroy locks */
+	mtx_destroy(&sc->receive_lock);
+	mtx_destroy(&sc->transmit_lock);
+	return (0);
+}
+
+void
+tsec_get_hwaddr(struct tsec_softc *sc, uint8_t *addr)
+{
+	union {
+		uint32_t reg[2];
+		uint8_t addr[6];
+	} curmac;
+	uint32_t a[6];
+	device_t parent;
+	uintptr_t macaddr;
+	int i;
+
+	parent = device_get_parent(sc->dev);
+	if (BUS_READ_IVAR(parent, sc->dev, OCPBUS_IVAR_MACADDR,
+	    &macaddr) == 0) {
+		bcopy((uint8_t *)macaddr, addr, 6);
+		return;
+	}
+
+	/*
+	 * Fall back -- use the currently programmed address in the hope that
+	 * it was set be firmware...
+	 */
+	curmac.reg[0] = TSEC_READ(sc, TSEC_REG_MACSTNADDR1);
+	curmac.reg[1] = TSEC_READ(sc, TSEC_REG_MACSTNADDR2);
+	for (i = 0; i < 6; i++)
+		a[5-i] = curmac.addr[i];
+
+	addr[0] = a[0];
+	addr[1] = a[1];
+	addr[2] = a[2];
+	addr[3] = a[3];
+	addr[4] = a[4];
+	addr[5] = a[5];
+}