sys/dev/neta/if_mvneta_fdt.c

   1 /*
   2  * Copyright (c) 2017 Stormshield.
   3  * Copyright (c) 2017 Semihalf.
   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
  17  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  18  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
  19  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  20  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  21  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  23  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  24  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  25  * POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #include "opt_platform.h"
  29 #include <sys/cdefs.h>
  30 __FBSDID("$FreeBSD$");
  31
  32 #include <sys/param.h>
  33 #include <sys/systm.h>
  34 #include <sys/kernel.h>
  35 #include <sys/module.h>
  36 #include <sys/bus.h>
  37 #include <sys/rman.h>
  38 #include <sys/socket.h>
  39 #include <sys/taskqueue.h>
  40
  41 #include <net/ethernet.h>
  42 #include <net/if.h>
  43 #include <net/if_media.h>
  44
  45 #include <netinet/in.h>
  46 #include <netinet/ip.h>
  47 #include <netinet/tcp_lro.h>
  48
  49 #include <machine/bus.h>
  50 #include <machine/resource.h>
  51
  52 #include <dev/ofw/ofw_bus.h>
  53 #include <dev/ofw/ofw_bus_subr.h>
  54
  55 #include <dev/mii/mii.h>
  56 #include <dev/mii/miivar.h>
  57
  58 #include "if_mvnetareg.h"
  59 #include "if_mvnetavar.h"
  60
  61 #define PHY_MODE_MAXLEN 10
  62 #define INBAND_STATUS_MAXLEN 16
  63
  64 static int mvneta_fdt_probe(device_t);
  65 static int mvneta_fdt_attach(device_t);
  66
  67 static device_method_t mvneta_fdt_methods[] = {
  68         /* Device interface */
  69         DEVMETHOD(device_probe,         mvneta_fdt_probe),
  70         DEVMETHOD(device_attach,        mvneta_fdt_attach),
  71
  72         /* End */
  73         DEVMETHOD_END
  74 };
  75
  76 DEFINE_CLASS_1(mvneta, mvneta_fdt_driver, mvneta_fdt_methods,
  77     sizeof(struct mvneta_softc), mvneta_driver);
  78
  79 static devclass_t mvneta_fdt_devclass;
  80
  81 DRIVER_MODULE(mvneta, ofwbus, mvneta_fdt_driver, mvneta_fdt_devclass, 0, 0);
  82 DRIVER_MODULE(mvneta, simplebus, mvneta_fdt_driver, mvneta_fdt_devclass, 0, 0);
  83
  84 static int mvneta_fdt_phy_acquire(device_t);
  85
  86 static struct ofw_compat_data compat_data[] = {
  87         {"marvell,armada-370-neta",     true},
  88         {"marvell,armada-3700-neta",    true},
  89         {NULL,                          false}
  90 };
  91
  92 static int
  93 mvneta_fdt_probe(device_t dev)
  94 {
  95
  96         if (!ofw_bus_status_okay(dev))
  97                 return (ENXIO);
  98
  99         if (!ofw_bus_search_compatible(dev, compat_data)->ocd_data)
 100                 return (ENXIO);
 101
 102         device_set_desc(dev, "NETA controller");
 103         return (BUS_PROBE_DEFAULT);
 104 }
 105
 106 static int
 107 mvneta_fdt_attach(device_t dev)
 108 {
 109         int err;
 110
 111         /* Try to fetch PHY information from FDT */
 112         err = mvneta_fdt_phy_acquire(dev);
 113         if (err != 0)
 114                 return (err);
 115
 116         return (mvneta_attach(dev));
 117 }
 118
 119 static int
 120 mvneta_fdt_phy_acquire(device_t dev)
 121 {
 122         struct mvneta_softc *sc;
 123         phandle_t node, child, phy_handle;
 124         char phymode[PHY_MODE_MAXLEN];
 125         char managed[INBAND_STATUS_MAXLEN];
 126         char *name;
 127
 128         sc = device_get_softc(dev);
 129         node = ofw_bus_get_node(dev);
 130
 131         /* PHY mode is crucial */
 132         if (OF_getprop(node, "phy-mode", phymode, sizeof(phymode)) <= 0) {
 133                 device_printf(dev, "Failed to acquire PHY mode from FDT.\n");
 134                 return (ENXIO);
 135         }
 136
 137         if (strncmp(phymode, "rgmii-id", 8) == 0)
 138                 sc->phy_mode = MVNETA_PHY_RGMII_ID;
 139         else if (strncmp(phymode, "rgmii", 5) == 0)
 140                 sc->phy_mode = MVNETA_PHY_RGMII;
 141         else if (strncmp(phymode, "sgmii", 5) == 0)
 142                 sc->phy_mode = MVNETA_PHY_SGMII;
 143         else if (strncmp(phymode, "qsgmii", 6) == 0)
 144                 sc->phy_mode = MVNETA_PHY_QSGMII;
 145         else
 146                 sc->phy_mode = MVNETA_PHY_SGMII;
 147
 148         /* Check if in-band link status will be used */
 149         if (OF_getprop(node, "managed", managed, sizeof(managed)) > 0) {
 150                 if (strncmp(managed, "in-band-status", 14) == 0) {
 151                         sc->use_inband_status = TRUE;
 152                         device_printf(dev, "Use in-band link status.\n");
 153                         return (0);
 154                 }
 155         }
 156
 157         if (OF_getencprop(node, "phy", (void *)&phy_handle,
 158             sizeof(phy_handle)) <= 0) {
 159                 /* Test for fixed-link (present i.e. in 388-gp) */
 160                 for (child = OF_child(node); child != 0; child = OF_peer(child)) {
 161                         if (OF_getprop_alloc(child,
 162                             "name", 1, (void **)&name) <= 0) {
 163                                 continue;
 164                         }
 165                         if (strncmp(name, "fixed-link", 10) == 0) {
 166                                 free(name, M_OFWPROP);
 167                                 if (OF_getencprop(child, "speed",
 168                                     &sc->phy_speed, sizeof(sc->phy_speed)) <= 0) {
 169                                         if (bootverbose) {
 170                                                 device_printf(dev,
 171                                                     "No PHY information.\n");
 172                                         }
 173                                         return (ENXIO);
 174                                 }
 175                                 if (OF_hasprop(child, "full-duplex"))
 176                                         sc->phy_fdx = TRUE;
 177                                 else
 178                                         sc->phy_fdx = FALSE;
 179
 180                                 /* Keep this flag just for the record */
 181                                 sc->phy_addr = MII_PHY_ANY;
 182
 183                                 return (0);
 184                         }
 185                         free(name, M_OFWPROP);
 186                 }
 187                 if (bootverbose) {
 188                         device_printf(dev,
 189                             "Could not find PHY information in FDT.\n");
 190                 }
 191                 return (ENXIO);
 192         } else {
 193                 phy_handle = OF_instance_to_package(phy_handle);
 194                 if (OF_getencprop(phy_handle, "reg", &sc->phy_addr,
 195                     sizeof(sc->phy_addr)) <= 0) {
 196                         device_printf(dev,
 197                             "Could not find PHY address in FDT.\n");
 198                         return (ENXIO);
 199                 }
 200         }
 201
 202         return (0);
 203 }
 204
 205 int
 206 mvneta_fdt_mac_address(struct mvneta_softc *sc, uint8_t *addr)
 207 {
 208         phandle_t node;
 209         uint8_t lmac[ETHER_ADDR_LEN];
 210         uint8_t zeromac[] = {[0 ... (ETHER_ADDR_LEN - 1)] = 0};
 211         int len;
 212
 213         /*
 214          * Retrieve hw address from the device tree.
 215          */
 216         node = ofw_bus_get_node(sc->dev);
 217         if (node == 0)
 218                 return (ENXIO);
 219
 220         len = OF_getprop(node, "local-mac-address", (void *)lmac, sizeof(lmac));
 221         if (len != ETHER_ADDR_LEN)
 222                 return (ENOENT);
 223
 224         if (memcmp(lmac, zeromac, ETHER_ADDR_LEN) == 0) {
 225                 /* Invalid MAC address (all zeros) */
 226                 return (EINVAL);
 227         }
 228         memcpy(addr, lmac, ETHER_ADDR_LEN);
 229
 230         return (0);
 231 }