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