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$"); 34 35 #include <sys/param.h> 36 #include <sys/systm.h> 37 #include <sys/endian.h> 38 #include <sys/lock.h> 39 #include <sys/mbuf.h> 40 #include <sys/mutex.h> 41 #include <sys/kernel.h> 42 #include <sys/module.h> 43 #include <sys/socket.h> 44 #include <sys/sysctl.h> 45 46 #include <sys/bus.h> 47 #include <machine/bus.h> 48 #include <sys/rman.h> 49 #include <machine/resource.h> 50 51 #include <net/ethernet.h> 52 #include <net/if.h> 53 #include <net/if_media.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 71 static int tsec_fdt_probe(device_t dev); 72 static int tsec_fdt_attach(device_t dev); 73 static int tsec_fdt_detach(device_t dev); 74 static int tsec_setup_intr(struct tsec_softc *sc, struct resource **ires, 75 void **ihand, int *irid, driver_intr_t handler, const char *iname); 76 static void tsec_release_intr(struct tsec_softc *sc, struct resource *ires, 77 void *ihand, int irid, const char *iname); 78 79 static 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 97 static driver_t tsec_fdt_driver = { 98 "tsec", 99 tsec_methods, 100 sizeof(struct tsec_softc), 101 }; 102 103 DRIVER_MODULE(tsec, simplebus, tsec_fdt_driver, tsec_devclass, 0, 0); 104 MODULE_DEPEND(tsec, simplebus, 1, 1, 1); 105 MODULE_DEPEND(tsec, ether, 1, 1, 1); 106 107 static int 108 tsec_fdt_probe(device_t dev) 109 { 110 struct tsec_softc *sc; 111 uint32_t id; 112 113 if (!ofw_bus_is_compatible(dev, "gianfar")) 114 return (ENXIO); 115 116 sc = device_get_softc(dev); 117 118 sc->sc_rrid = 0; 119 sc->sc_rres = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &sc->sc_rrid, 120 RF_ACTIVE); 121 if (sc->sc_rres == NULL) 122 return (ENXIO); 123 124 sc->sc_bas.bsh = rman_get_bushandle(sc->sc_rres); 125 sc->sc_bas.bst = rman_get_bustag(sc->sc_rres); 126 127 /* Check if we are eTSEC (enhanced TSEC) */ 128 id = TSEC_READ(sc, TSEC_REG_ID); 129 sc->is_etsec = ((id >> 16) == TSEC_ETSEC_ID) ? 1 : 0; 130 id |= TSEC_READ(sc, TSEC_REG_ID2); 131 132 bus_release_resource(dev, SYS_RES_MEMORY, sc->sc_rrid, sc->sc_rres); 133 134 if (id == 0) { 135 device_printf(dev, "could not identify TSEC type\n"); 136 return (ENXIO); 137 } 138 139 if (sc->is_etsec) 140 device_set_desc(dev, "Enhanced Three-Speed Ethernet Controller"); 141 else 142 device_set_desc(dev, "Three-Speed Ethernet Controller"); 143 144 return (BUS_PROBE_DEFAULT); 145 } 146 147 static int 148 tsec_fdt_attach(device_t dev) 149 { 150 struct tsec_softc *sc; 151 int error = 0; 152 153 sc = device_get_softc(dev); 154 sc->dev = dev; 155 sc->node = ofw_bus_get_node(dev); 156 157 /* Get phy address from fdt */ 158 if (fdt_get_phyaddr(sc->node, sc->dev, &sc->phyaddr, 159 (void **)&sc->phy_sc) != 0) 160 return (ENXIO); 161 162 /* Init timer */ 163 callout_init(&sc->tsec_callout, 1); 164 165 /* Init locks */ 166 mtx_init(&sc->transmit_lock, device_get_nameunit(dev), "TSEC TX lock", 167 MTX_DEF); 168 mtx_init(&sc->receive_lock, device_get_nameunit(dev), "TSEC RX lock", 169 MTX_DEF); 170 mtx_init(&sc->ic_lock, device_get_nameunit(dev), "TSEC IC lock", 171 MTX_DEF); 172 173 /* Allocate IO memory for TSEC registers */ 174 sc->sc_rrid = 0; 175 sc->sc_rres = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &sc->sc_rrid, 176 RF_ACTIVE); 177 if (sc->sc_rres == NULL) { 178 device_printf(dev, "could not allocate IO memory range!\n"); 179 goto fail1; 180 } 181 sc->sc_bas.bsh = rman_get_bushandle(sc->sc_rres); 182 sc->sc_bas.bst = rman_get_bustag(sc->sc_rres); 183 184 /* TSEC attach */ 185 if (tsec_attach(sc) != 0) { 186 device_printf(dev, "could not be configured\n"); 187 goto fail2; 188 } 189 190 /* Set up interrupts (TX/RX/ERR) */ 191 sc->sc_transmit_irid = TSEC_RID_TXIRQ; 192 error = tsec_setup_intr(sc, &sc->sc_transmit_ires, 193 &sc->sc_transmit_ihand, &sc->sc_transmit_irid, 194 tsec_transmit_intr, "TX"); 195 if (error) 196 goto fail2; 197 198 sc->sc_receive_irid = TSEC_RID_RXIRQ; 199 error = tsec_setup_intr(sc, &sc->sc_receive_ires, 200 &sc->sc_receive_ihand, &sc->sc_receive_irid, 201 tsec_receive_intr, "RX"); 202 if (error) 203 goto fail3; 204 205 sc->sc_error_irid = TSEC_RID_ERRIRQ; 206 error = tsec_setup_intr(sc, &sc->sc_error_ires, 207 &sc->sc_error_ihand, &sc->sc_error_irid, 208 tsec_error_intr, "ERR"); 209 if (error) 210 goto fail4; 211 212 return (0); 213 214 fail4: 215 tsec_release_intr(sc, sc->sc_receive_ires, sc->sc_receive_ihand, 216 sc->sc_receive_irid, "RX"); 217 fail3: 218 tsec_release_intr(sc, sc->sc_transmit_ires, sc->sc_transmit_ihand, 219 sc->sc_transmit_irid, "TX"); 220 fail2: 221 bus_release_resource(dev, SYS_RES_MEMORY, sc->sc_rrid, sc->sc_rres); 222 fail1: 223 mtx_destroy(&sc->receive_lock); 224 mtx_destroy(&sc->transmit_lock); 225 return (ENXIO); 226 } 227 228 static int 229 tsec_setup_intr(struct tsec_softc *sc, struct resource **ires, void **ihand, 230 int *irid, driver_intr_t handler, const char *iname) 231 { 232 int error; 233 234 *ires = bus_alloc_resource_any(sc->dev, SYS_RES_IRQ, irid, RF_ACTIVE); 235 if (*ires == NULL) { 236 device_printf(sc->dev, "could not allocate %s IRQ\n", iname); 237 return (ENXIO); 238 } 239 error = bus_setup_intr(sc->dev, *ires, INTR_TYPE_NET | INTR_MPSAFE, 240 NULL, handler, sc, ihand); 241 if (error) { 242 device_printf(sc->dev, "failed to set up %s IRQ\n", iname); 243 if (bus_release_resource(sc->dev, SYS_RES_IRQ, *irid, *ires)) 244 device_printf(sc->dev, "could not release %s IRQ\n", iname); 245 *ires = NULL; 246 return (error); 247 } 248 return (0); 249 } 250 251 static void 252 tsec_release_intr(struct tsec_softc *sc, struct resource *ires, void *ihand, 253 int irid, const char *iname) 254 { 255 int error; 256 257 if (ires == NULL) 258 return; 259 260 error = bus_teardown_intr(sc->dev, ires, ihand); 261 if (error) 262 device_printf(sc->dev, "bus_teardown_intr() failed for %s intr" 263 ", error %d\n", iname, error); 264 265 error = bus_release_resource(sc->dev, SYS_RES_IRQ, irid, ires); 266 if (error) 267 device_printf(sc->dev, "bus_release_resource() failed for %s " 268 "intr, error %d\n", iname, error); 269 } 270 271 static int 272 tsec_fdt_detach(device_t dev) 273 { 274 struct tsec_softc *sc; 275 int error; 276 277 sc = device_get_softc(dev); 278 279 /* Wait for stopping watchdog */ 280 callout_drain(&sc->tsec_callout); 281 282 /* Stop and release all interrupts */ 283 tsec_release_intr(sc, sc->sc_transmit_ires, sc->sc_transmit_ihand, 284 sc->sc_transmit_irid, "TX"); 285 tsec_release_intr(sc, sc->sc_receive_ires, sc->sc_receive_ihand, 286 sc->sc_receive_irid, "RX"); 287 tsec_release_intr(sc, sc->sc_error_ires, sc->sc_error_ihand, 288 sc->sc_error_irid, "ERR"); 289 290 /* TSEC detach */ 291 tsec_detach(sc); 292 293 /* Free IO memory handler */ 294 if (sc->sc_rres) { 295 error = bus_release_resource(dev, SYS_RES_MEMORY, sc->sc_rrid, 296 sc->sc_rres); 297 if (error) 298 device_printf(dev, "bus_release_resource() failed for" 299 " IO memory, error %d\n", error); 300 } 301 302 /* Destroy locks */ 303 mtx_destroy(&sc->receive_lock); 304 mtx_destroy(&sc->transmit_lock); 305 mtx_destroy(&sc->ic_lock); 306 return (0); 307 } 308 309 void 310 tsec_get_hwaddr(struct tsec_softc *sc, uint8_t *addr) 311 { 312 union { 313 uint32_t reg[2]; 314 uint8_t addr[6]; 315 } hw; 316 int i; 317 318 hw.reg[0] = hw.reg[1] = 0; 319 320 /* Retrieve the hardware address from the device tree. */ 321 i = OF_getprop(sc->node, "local-mac-address", (void *)hw.addr, 6); 322 if (i == 6 && (hw.reg[0] != 0 || hw.reg[1] != 0)) { 323 bcopy(hw.addr, addr, 6); 324 return; 325 } 326 327 /* 328 * Fall back -- use the currently programmed address in the hope that 329 * it was set be firmware... 330 */ 331 hw.reg[0] = TSEC_READ(sc, TSEC_REG_MACSTNADDR1); 332 hw.reg[1] = TSEC_READ(sc, TSEC_REG_MACSTNADDR2); 333 for (i = 0; i < 6; i++) 334 addr[5-i] = hw.addr[i]; 335 } 336