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