if_tsec_fdt.c revision 266152 
1/*-
2 * Copyright (C) 2007-2008 Semihalf, Rafal Jaworowski
3 * Copyright (C) 2006-2007 Semihalf, Piotr Kruszynski
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
18 * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
19 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
20 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
22 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
23 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 *
26 * From: FreeBSD: head/sys/dev/tsec/if_tsec_ocp.c 188712 2009-02-17 14:59:47Z raj
27 */
28
29/*
30 * FDT 'simple-bus' attachment for Freescale TSEC controller.
31 */
32#include <sys/cdefs.h>
33__FBSDID("$FreeBSD: stable/10/sys/dev/tsec/if_tsec_fdt.c 266152 2014-05-15 16:11:06Z ian $");
34
35#include <sys/param.h>
36#include <sys/systm.h>
37#include <sys/endian.h>
38#include <sys/mbuf.h>
39#include <sys/kernel.h>
40#include <sys/module.h>
41#include <sys/socket.h>
42#include <sys/sysctl.h>
43
44#include <sys/bus.h>
45#include <machine/bus.h>
46#include <sys/rman.h>
47#include <machine/resource.h>
48
49#include <net/ethernet.h>
50#include <net/if.h>
51#include <net/if_dl.h>
52#include <net/if_media.h>
53#include <net/if_arp.h>
54
55#include <dev/fdt/fdt_common.h>
56#include <dev/mii/mii.h>
57#include <dev/mii/miivar.h>
58#include <dev/ofw/ofw_bus.h>
59#include <dev/ofw/ofw_bus_subr.h>
60#include <dev/ofw/openfirm.h>
61
62#include <dev/tsec/if_tsec.h>
63#include <dev/tsec/if_tsecreg.h>
64
65#include "miibus_if.h"
66
67#define	TSEC_RID_TXIRQ	0
68#define	TSEC_RID_RXIRQ	1
69#define	TSEC_RID_ERRIRQ	2
70
71static int tsec_fdt_probe(device_t dev);
72static int tsec_fdt_attach(device_t dev);
73static int tsec_fdt_detach(device_t dev);
74static int tsec_setup_intr(struct tsec_softc *sc, struct resource **ires,
75    void **ihand, int *irid, driver_intr_t handler, const char *iname);
76static void tsec_release_intr(struct tsec_softc *sc, struct resource *ires,
77    void *ihand, int irid, const char *iname);
78
79static device_method_t tsec_methods[] = {
80	/* Device interface */
81	DEVMETHOD(device_probe,		tsec_fdt_probe),
82	DEVMETHOD(device_attach,	tsec_fdt_attach),
83	DEVMETHOD(device_detach,	tsec_fdt_detach),
84
85	DEVMETHOD(device_shutdown,	tsec_shutdown),
86	DEVMETHOD(device_suspend,	tsec_suspend),
87	DEVMETHOD(device_resume,	tsec_resume),
88
89	/* MII interface */
90	DEVMETHOD(miibus_readreg,	tsec_miibus_readreg),
91	DEVMETHOD(miibus_writereg,	tsec_miibus_writereg),
92	DEVMETHOD(miibus_statchg,	tsec_miibus_statchg),
93
94	DEVMETHOD_END
95};
96
97static driver_t tsec_fdt_driver = {
98	"tsec",
99	tsec_methods,
100	sizeof(struct tsec_softc),
101};
102
103DRIVER_MODULE(tsec, simplebus, tsec_fdt_driver, tsec_devclass, 0, 0);
104MODULE_DEPEND(tsec, simplebus, 1, 1, 1);
105MODULE_DEPEND(tsec, ether, 1, 1, 1);
106
107static int
108tsec_fdt_probe(device_t dev)
109{
110	struct tsec_softc *sc;
111	uint32_t id;
112
113	if (!ofw_bus_status_okay(dev))
114		return (ENXIO);
115
116	if (ofw_bus_get_type(dev) == NULL ||
117	    strcmp(ofw_bus_get_type(dev), "network") != 0)
118		return (ENXIO);
119
120	if (!ofw_bus_is_compatible(dev, "gianfar"))
121		return (ENXIO);
122
123	sc = device_get_softc(dev);
124
125	sc->sc_rrid = 0;
126	sc->sc_rres = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &sc->sc_rrid,
127	    RF_ACTIVE);
128	if (sc->sc_rres == NULL)
129		return (ENXIO);
130
131	sc->sc_bas.bsh = rman_get_bushandle(sc->sc_rres);
132	sc->sc_bas.bst = rman_get_bustag(sc->sc_rres);
133
134	/* Check if we are eTSEC (enhanced TSEC) */
135	id = TSEC_READ(sc, TSEC_REG_ID);
136	sc->is_etsec = ((id >> 16) == TSEC_ETSEC_ID) ? 1 : 0;
137	id |= TSEC_READ(sc, TSEC_REG_ID2);
138
139	bus_release_resource(dev, SYS_RES_MEMORY, sc->sc_rrid, sc->sc_rres);
140
141	if (id == 0) {
142		device_printf(dev, "could not identify TSEC type\n");
143		return (ENXIO);
144	}
145
146	if (sc->is_etsec)
147		device_set_desc(dev, "Enhanced Three-Speed Ethernet Controller");
148	else
149		device_set_desc(dev, "Three-Speed Ethernet Controller");
150
151	return (BUS_PROBE_DEFAULT);
152}
153
154static int
155tsec_fdt_attach(device_t dev)
156{
157	struct tsec_softc *sc;
158	phandle_t phy;
159	int error = 0;
160
161	sc = device_get_softc(dev);
162	sc->dev = dev;
163	sc->node = ofw_bus_get_node(dev);
164
165	/* Get phy address from fdt */
166	if (OF_getencprop(sc->node, "phy-handle", &phy, sizeof(phy)) <= 0) {
167		device_printf(dev, "PHY not found in device tree");
168		return (ENXIO);
169	}
170
171	phy = OF_xref_phandle(phy);
172	OF_decode_addr(OF_parent(phy), 0, &sc->phy_bst, &sc->phy_bsh);
173	OF_getencprop(phy, "reg", &sc->phyaddr, sizeof(sc->phyaddr));
174
175	/* Init timer */
176	callout_init(&sc->tsec_callout, 1);
177
178	/* Init locks */
179	mtx_init(&sc->transmit_lock, device_get_nameunit(dev), "TSEC TX lock",
180	    MTX_DEF);
181	mtx_init(&sc->receive_lock, device_get_nameunit(dev), "TSEC RX lock",
182	    MTX_DEF);
183	mtx_init(&sc->ic_lock, device_get_nameunit(dev), "TSEC IC lock",
184	    MTX_DEF);
185
186	/* Allocate IO memory for TSEC registers */
187	sc->sc_rrid = 0;
188	sc->sc_rres = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &sc->sc_rrid,
189	    RF_ACTIVE);
190	if (sc->sc_rres == NULL) {
191		device_printf(dev, "could not allocate IO memory range!\n");
192		goto fail1;
193	}
194	sc->sc_bas.bsh = rman_get_bushandle(sc->sc_rres);
195	sc->sc_bas.bst = rman_get_bustag(sc->sc_rres);
196
197	/* TSEC attach */
198	if (tsec_attach(sc) != 0) {
199		device_printf(dev, "could not be configured\n");
200		goto fail2;
201	}
202
203	/* Set up interrupts (TX/RX/ERR) */
204	sc->sc_transmit_irid = TSEC_RID_TXIRQ;
205	error = tsec_setup_intr(sc, &sc->sc_transmit_ires,
206	    &sc->sc_transmit_ihand, &sc->sc_transmit_irid,
207	    tsec_transmit_intr, "TX");
208	if (error)
209		goto fail2;
210
211	sc->sc_receive_irid = TSEC_RID_RXIRQ;
212	error = tsec_setup_intr(sc, &sc->sc_receive_ires,
213	    &sc->sc_receive_ihand, &sc->sc_receive_irid,
214	    tsec_receive_intr, "RX");
215	if (error)
216		goto fail3;
217
218	sc->sc_error_irid = TSEC_RID_ERRIRQ;
219	error = tsec_setup_intr(sc, &sc->sc_error_ires,
220	    &sc->sc_error_ihand, &sc->sc_error_irid,
221	    tsec_error_intr, "ERR");
222	if (error)
223		goto fail4;
224
225	return (0);
226
227fail4:
228	tsec_release_intr(sc, sc->sc_receive_ires, sc->sc_receive_ihand,
229	    sc->sc_receive_irid, "RX");
230fail3:
231	tsec_release_intr(sc, sc->sc_transmit_ires, sc->sc_transmit_ihand,
232	    sc->sc_transmit_irid, "TX");
233fail2:
234	bus_release_resource(dev, SYS_RES_MEMORY, sc->sc_rrid, sc->sc_rres);
235fail1:
236	mtx_destroy(&sc->receive_lock);
237	mtx_destroy(&sc->transmit_lock);
238	return (ENXIO);
239}
240
241static int
242tsec_setup_intr(struct tsec_softc *sc, struct resource **ires, void **ihand,
243    int *irid, driver_intr_t handler, const char *iname)
244{
245	int error;
246
247	*ires = bus_alloc_resource_any(sc->dev, SYS_RES_IRQ, irid, RF_ACTIVE);
248	if (*ires == NULL) {
249		device_printf(sc->dev, "could not allocate %s IRQ\n", iname);
250		return (ENXIO);
251	}
252	error = bus_setup_intr(sc->dev, *ires, INTR_TYPE_NET | INTR_MPSAFE,
253	    NULL, handler, sc, ihand);
254	if (error) {
255		device_printf(sc->dev, "failed to set up %s IRQ\n", iname);
256		if (bus_release_resource(sc->dev, SYS_RES_IRQ, *irid, *ires))
257			device_printf(sc->dev, "could not release %s IRQ\n", iname);
258		*ires = NULL;
259		return (error);
260	}
261	return (0);
262}
263
264static void
265tsec_release_intr(struct tsec_softc *sc, struct resource *ires, void *ihand,
266    int irid, const char *iname)
267{
268	int error;
269
270	if (ires == NULL)
271		return;
272
273	error = bus_teardown_intr(sc->dev, ires, ihand);
274	if (error)
275		device_printf(sc->dev, "bus_teardown_intr() failed for %s intr"
276		    ", error %d\n", iname, error);
277
278	error = bus_release_resource(sc->dev, SYS_RES_IRQ, irid, ires);
279	if (error)
280		device_printf(sc->dev, "bus_release_resource() failed for %s "
281		    "intr, error %d\n", iname, error);
282}
283
284static int
285tsec_fdt_detach(device_t dev)
286{
287	struct tsec_softc *sc;
288	int error;
289
290	sc = device_get_softc(dev);
291
292	/* Wait for stopping watchdog */
293	callout_drain(&sc->tsec_callout);
294
295	/* Stop and release all interrupts */
296	tsec_release_intr(sc, sc->sc_transmit_ires, sc->sc_transmit_ihand,
297	    sc->sc_transmit_irid, "TX");
298	tsec_release_intr(sc, sc->sc_receive_ires, sc->sc_receive_ihand,
299	    sc->sc_receive_irid, "RX");
300	tsec_release_intr(sc, sc->sc_error_ires, sc->sc_error_ihand,
301	    sc->sc_error_irid, "ERR");
302
303	/* TSEC detach */
304	tsec_detach(sc);
305
306	/* Free IO memory handler */
307	if (sc->sc_rres) {
308		error = bus_release_resource(dev, SYS_RES_MEMORY, sc->sc_rrid,
309		    sc->sc_rres);
310		if (error)
311			device_printf(dev, "bus_release_resource() failed for"
312			    " IO memory, error %d\n", error);
313	}
314
315	/* Destroy locks */
316	mtx_destroy(&sc->receive_lock);
317	mtx_destroy(&sc->transmit_lock);
318	mtx_destroy(&sc->ic_lock);
319	return (0);
320}
321
322void
323tsec_get_hwaddr(struct tsec_softc *sc, uint8_t *addr)
324{
325	union {
326		uint32_t reg[2];
327		uint8_t addr[6];
328	} hw;
329	int i;
330
331	hw.reg[0] = hw.reg[1] = 0;
332
333	/* Retrieve the hardware address from the device tree. */
334	i = OF_getprop(sc->node, "local-mac-address", (void *)hw.addr, 6);
335	if (i == 6 && (hw.reg[0] != 0 || hw.reg[1] != 0)) {
336		bcopy(hw.addr, addr, 6);
337		return;
338	}
339
340	/* Also try the mac-address property, which is second-best */
341	i = OF_getprop(sc->node, "mac-address", (void *)hw.addr, 6);
342	if (i == 6 && (hw.reg[0] != 0 || hw.reg[1] != 0)) {
343		bcopy(hw.addr, addr, 6);
344		return;
345	}
346
347	/*
348	 * Fall back -- use the currently programmed address in the hope that
349	 * it was set be firmware...
350	 */
351	hw.reg[0] = TSEC_READ(sc, TSEC_REG_MACSTNADDR1);
352	hw.reg[1] = TSEC_READ(sc, TSEC_REG_MACSTNADDR2);
353	for (i = 0; i < 6; i++)
354		addr[5-i] = hw.addr[i];
355}
356