xref: /freebsd/sys/dev/neta/if_mvneta_fdt.c (revision dd41de95a84d979615a2ef11df6850622bf6184e)
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 	struct mvneta_softc *sc;
110 	uint32_t tx_csum_limit;
111 	int err;
112 
113 	sc = device_get_softc(dev);
114 
115 	/* Try to fetch PHY information from FDT */
116 	err = mvneta_fdt_phy_acquire(dev);
117 	if (err != 0)
118 		return (err);
119 
120 	if (ofw_bus_is_compatible(dev, "marvell,armada-370-neta")) {
121 		tx_csum_limit = MVNETA_A370_MAX_CSUM_MTU;
122 	} else {
123 		tx_csum_limit = MVNETA_A3700_MAX_CSUM_MTU;
124 	}
125 
126 	if (ofw_bus_has_prop(dev, "tx-csum-limit")) {
127 		err = OF_getprop(ofw_bus_get_node(dev), "tx-csum-limit",
128 			    &tx_csum_limit, sizeof(tx_csum_limit));
129 		if (err <= 0) {
130 			device_printf(dev,
131 				"Failed to acquire tx-csum-limit property\n");
132 			return (ENXIO);
133 		}
134 	}
135 	sc->tx_csum_limit = tx_csum_limit;
136 
137 	return (mvneta_attach(dev));
138 }
139 
140 static int
141 mvneta_fdt_phy_acquire(device_t dev)
142 {
143 	struct mvneta_softc *sc;
144 	phandle_t node, child, phy_handle;
145 	char phymode[PHY_MODE_MAXLEN];
146 	char managed[INBAND_STATUS_MAXLEN];
147 	char *name;
148 
149 	sc = device_get_softc(dev);
150 	node = ofw_bus_get_node(dev);
151 
152 	/* PHY mode is crucial */
153 	if (OF_getprop(node, "phy-mode", phymode, sizeof(phymode)) <= 0) {
154 		device_printf(dev, "Failed to acquire PHY mode from FDT.\n");
155 		return (ENXIO);
156 	}
157 
158 	if (strncmp(phymode, "rgmii-id", 8) == 0)
159 		sc->phy_mode = MVNETA_PHY_RGMII_ID;
160 	else if (strncmp(phymode, "rgmii", 5) == 0)
161 		sc->phy_mode = MVNETA_PHY_RGMII;
162 	else if (strncmp(phymode, "sgmii", 5) == 0)
163 		sc->phy_mode = MVNETA_PHY_SGMII;
164 	else if (strncmp(phymode, "qsgmii", 6) == 0)
165 		sc->phy_mode = MVNETA_PHY_QSGMII;
166 	else
167 		sc->phy_mode = MVNETA_PHY_SGMII;
168 
169 	/* Check if in-band link status will be used */
170 	if (OF_getprop(node, "managed", managed, sizeof(managed)) > 0) {
171 		if (strncmp(managed, "in-band-status", 14) == 0) {
172 			sc->use_inband_status = TRUE;
173 			device_printf(dev, "Use in-band link status.\n");
174 			return (0);
175 		}
176 	}
177 
178 	if (OF_getencprop(node, "phy", (void *)&phy_handle,
179 	    sizeof(phy_handle)) <= 0) {
180 		/* Test for fixed-link (present i.e. in 388-gp) */
181 		for (child = OF_child(node); child != 0; child = OF_peer(child)) {
182 			if (OF_getprop_alloc(child,
183 			    "name", (void **)&name) <= 0) {
184 				continue;
185 			}
186 			if (strncmp(name, "fixed-link", 10) == 0) {
187 				free(name, M_OFWPROP);
188 				if (OF_getencprop(child, "speed",
189 				    &sc->phy_speed, sizeof(sc->phy_speed)) <= 0) {
190 					if (bootverbose) {
191 						device_printf(dev,
192 						    "No PHY information.\n");
193 					}
194 					return (ENXIO);
195 				}
196 				if (OF_hasprop(child, "full-duplex"))
197 					sc->phy_fdx = TRUE;
198 				else
199 					sc->phy_fdx = FALSE;
200 
201 				/* Keep this flag just for the record */
202 				sc->phy_addr = MII_PHY_ANY;
203 
204 				return (0);
205 			}
206 			free(name, M_OFWPROP);
207 		}
208 		if (bootverbose) {
209 			device_printf(dev,
210 			    "Could not find PHY information in FDT.\n");
211 		}
212 		return (ENXIO);
213 	} else {
214 		phy_handle = OF_instance_to_package(phy_handle);
215 		if (OF_getencprop(phy_handle, "reg", &sc->phy_addr,
216 		    sizeof(sc->phy_addr)) <= 0) {
217 			device_printf(dev,
218 			    "Could not find PHY address in FDT.\n");
219 			return (ENXIO);
220 		}
221 	}
222 
223 	return (0);
224 }
225 
226 int
227 mvneta_fdt_mac_address(struct mvneta_softc *sc, uint8_t *addr)
228 {
229 	phandle_t node;
230 	uint8_t lmac[ETHER_ADDR_LEN];
231 	uint8_t zeromac[] = {[0 ... (ETHER_ADDR_LEN - 1)] = 0};
232 	int len;
233 
234 	/*
235 	 * Retrieve hw address from the device tree.
236 	 */
237 	node = ofw_bus_get_node(sc->dev);
238 	if (node == 0)
239 		return (ENXIO);
240 
241 	len = OF_getprop(node, "local-mac-address", (void *)lmac, sizeof(lmac));
242 	if (len != ETHER_ADDR_LEN)
243 		return (ENOENT);
244 
245 	if (memcmp(lmac, zeromac, ETHER_ADDR_LEN) == 0) {
246 		/* Invalid MAC address (all zeros) */
247 		return (EINVAL);
248 	}
249 	memcpy(addr, lmac, ETHER_ADDR_LEN);
250 
251 	return (0);
252 }
253