xref: /freebsd/sys/dev/neta/if_mvneta_fdt.c (revision 5572fda3a2f305fc4fb4c853d8d578c13d59c1a5)
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 #ifdef MVNETA_DEBUG
62 #define	STATIC /* nothing */
63 #else
64 #define	STATIC static
65 #endif
66 
67 #define	PHY_MODE_MAXLEN	10
68 #define	INBAND_STATUS_MAXLEN 16
69 
70 static int mvneta_fdt_probe(device_t);
71 static int mvneta_fdt_attach(device_t);
72 
73 static device_method_t mvneta_fdt_methods[] = {
74 	/* Device interface */
75 	DEVMETHOD(device_probe,		mvneta_fdt_probe),
76 	DEVMETHOD(device_attach,	mvneta_fdt_attach),
77 
78 	/* End */
79 	DEVMETHOD_END
80 };
81 
82 DEFINE_CLASS_1(mvneta, mvneta_fdt_driver, mvneta_fdt_methods,
83     sizeof(struct mvneta_softc), mvneta_driver);
84 
85 static devclass_t mvneta_fdt_devclass;
86 
87 DRIVER_MODULE(mvneta, ofwbus, mvneta_fdt_driver, mvneta_fdt_devclass, 0, 0);
88 DRIVER_MODULE(mvneta, simplebus, mvneta_fdt_driver, mvneta_fdt_devclass, 0, 0);
89 
90 static int mvneta_fdt_phy_acquire(device_t);
91 
92 static struct ofw_compat_data compat_data[] = {
93 	{"marvell,armada-370-neta",	true},
94 	{"marvell,armada-3700-neta",	true},
95 	{NULL,				false}
96 };
97 
98 SIMPLEBUS_PNP_INFO(compat_data);
99 
100 static int
101 mvneta_fdt_probe(device_t dev)
102 {
103 
104 	if (!ofw_bus_status_okay(dev))
105 		return (ENXIO);
106 
107 	if (!ofw_bus_search_compatible(dev, compat_data)->ocd_data)
108 		return (ENXIO);
109 
110 	device_set_desc(dev, "NETA controller");
111 	return (BUS_PROBE_DEFAULT);
112 }
113 
114 static int
115 mvneta_fdt_attach(device_t dev)
116 {
117 	struct mvneta_softc *sc;
118 	uint32_t tx_csum_limit;
119 	int err;
120 
121 	sc = device_get_softc(dev);
122 
123 	/* Try to fetch PHY information from FDT */
124 	err = mvneta_fdt_phy_acquire(dev);
125 	if (err != 0)
126 		return (err);
127 
128 	if (ofw_bus_is_compatible(dev, "marvell,armada-370-neta")) {
129 		tx_csum_limit = MVNETA_A370_MAX_CSUM_MTU;
130 	} else {
131 		tx_csum_limit = MVNETA_A3700_MAX_CSUM_MTU;
132 	}
133 
134 	if (ofw_bus_has_prop(dev, "tx-csum-limit")) {
135 		err = OF_getprop(ofw_bus_get_node(dev), "tx-csum-limit",
136 			    &tx_csum_limit, sizeof(tx_csum_limit));
137 		if (err <= 0) {
138 			device_printf(dev,
139 				"Failed to acquire tx-csum-limit property\n");
140 			return (ENXIO);
141 		}
142 	}
143 	sc->tx_csum_limit = tx_csum_limit;
144 
145 	return (mvneta_attach(dev));
146 }
147 
148 static int
149 mvneta_fdt_phy_acquire(device_t dev)
150 {
151 	struct mvneta_softc *sc;
152 	phandle_t node, child, phy_handle;
153 	char phymode[PHY_MODE_MAXLEN];
154 	char managed[INBAND_STATUS_MAXLEN];
155 	char *name;
156 
157 	sc = device_get_softc(dev);
158 	node = ofw_bus_get_node(dev);
159 
160 	/* PHY mode is crucial */
161 	if (OF_getprop(node, "phy-mode", phymode, sizeof(phymode)) <= 0) {
162 		device_printf(dev, "Failed to acquire PHY mode from FDT.\n");
163 		return (ENXIO);
164 	}
165 
166 	if (strncmp(phymode, "rgmii-id", 8) == 0)
167 		sc->phy_mode = MVNETA_PHY_RGMII_ID;
168 	else if (strncmp(phymode, "rgmii", 5) == 0)
169 		sc->phy_mode = MVNETA_PHY_RGMII;
170 	else if (strncmp(phymode, "sgmii", 5) == 0)
171 		sc->phy_mode = MVNETA_PHY_SGMII;
172 	else if (strncmp(phymode, "qsgmii", 6) == 0)
173 		sc->phy_mode = MVNETA_PHY_QSGMII;
174 	else
175 		sc->phy_mode = MVNETA_PHY_SGMII;
176 
177 	/* Check if in-band link status will be used */
178 	if (OF_getprop(node, "managed", managed, sizeof(managed)) > 0) {
179 		if (strncmp(managed, "in-band-status", 14) == 0) {
180 			sc->use_inband_status = TRUE;
181 			device_printf(dev, "Use in-band link status.\n");
182 			return (0);
183 		}
184 	}
185 
186 	if (OF_getencprop(node, "phy", (void *)&phy_handle,
187 	    sizeof(phy_handle)) <= 0) {
188 		/* Test for fixed-link (present i.e. in 388-gp) */
189 		for (child = OF_child(node); child != 0; child = OF_peer(child)) {
190 			if (OF_getprop_alloc(child,
191 			    "name", (void **)&name) <= 0) {
192 				continue;
193 			}
194 			if (strncmp(name, "fixed-link", 10) == 0) {
195 				free(name, M_OFWPROP);
196 				if (OF_getencprop(child, "speed",
197 				    &sc->phy_speed, sizeof(sc->phy_speed)) <= 0) {
198 					if (bootverbose) {
199 						device_printf(dev,
200 						    "No PHY information.\n");
201 					}
202 					return (ENXIO);
203 				}
204 				if (OF_hasprop(child, "full-duplex"))
205 					sc->phy_fdx = TRUE;
206 				else
207 					sc->phy_fdx = FALSE;
208 
209 				/* Keep this flag just for the record */
210 				sc->phy_addr = MII_PHY_ANY;
211 
212 				return (0);
213 			}
214 			free(name, M_OFWPROP);
215 		}
216 		if (bootverbose) {
217 			device_printf(dev,
218 			    "Could not find PHY information in FDT.\n");
219 		}
220 		return (ENXIO);
221 	} else {
222 		phy_handle = OF_instance_to_package(phy_handle);
223 		if (OF_getencprop(phy_handle, "reg", &sc->phy_addr,
224 		    sizeof(sc->phy_addr)) <= 0) {
225 			device_printf(dev,
226 			    "Could not find PHY address in FDT.\n");
227 			return (ENXIO);
228 		}
229 	}
230 
231 	return (0);
232 }
233 
234 int
235 mvneta_fdt_mac_address(struct mvneta_softc *sc, uint8_t *addr)
236 {
237 	phandle_t node;
238 	uint8_t lmac[ETHER_ADDR_LEN];
239 	uint8_t zeromac[] = {[0 ... (ETHER_ADDR_LEN - 1)] = 0};
240 	int len;
241 
242 	/*
243 	 * Retrieve hw address from the device tree.
244 	 */
245 	node = ofw_bus_get_node(sc->dev);
246 	if (node == 0)
247 		return (ENXIO);
248 
249 	len = OF_getprop(node, "local-mac-address", (void *)lmac, sizeof(lmac));
250 	if (len != ETHER_ADDR_LEN)
251 		return (ENOENT);
252 
253 	if (memcmp(lmac, zeromac, ETHER_ADDR_LEN) == 0) {
254 		/* Invalid MAC address (all zeros) */
255 		return (EINVAL);
256 	}
257 	memcpy(addr, lmac, ETHER_ADDR_LEN);
258 
259 	return (0);
260 }
261 
262 STATIC boolean_t
263 mvneta_find_ethernet_prop_switch(phandle_t ethernet, phandle_t node)
264 {
265 	boolean_t ret;
266 	phandle_t child, switch_eth_handle, switch_eth;
267 
268 	for (child = OF_child(node); child != 0; child = OF_peer(child)) {
269 		if (OF_getencprop(child, "ethernet", (void*)&switch_eth_handle,
270 		    sizeof(switch_eth_handle)) > 0) {
271 			if (switch_eth_handle > 0) {
272 				switch_eth = OF_node_from_xref(
273 				    switch_eth_handle);
274 
275 				if (switch_eth == ethernet)
276 					return (true);
277 			}
278 		}
279 
280 		ret = mvneta_find_ethernet_prop_switch(ethernet, child);
281 		if (ret != 0)
282 			return (ret);
283 	}
284 
285 	return (false);
286 }
287 
288 boolean_t
289 mvneta_has_switch_fdt(device_t self)
290 {
291 	phandle_t node;
292 
293 	node = ofw_bus_get_node(self);
294 
295 	return mvneta_find_ethernet_prop_switch(node, OF_finddevice("/"));
296 }
297