xref: /freebsd/sys/dev/vnic/thunder_mdio_fdt.c (revision 81ad626541db97eb356e2c1d4a20eb2a26a766ab)
1 /*-
2  * Copyright (c) 2015 The FreeBSD Foundation
3  *
4  * This software was developed by Semihalf under
5  * the sponsorship of the FreeBSD Foundation.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
31 
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/bus.h>
35 #include <sys/kernel.h>
36 #include <sys/module.h>
37 #include <sys/socket.h>
38 
39 #include <dev/ofw/ofw_bus.h>
40 #include <dev/ofw/ofw_bus_subr.h>
41 #include <dev/fdt/simplebus.h>
42 
43 #include <net/if.h>
44 
45 #include <machine/bus.h>
46 #include <machine/resource.h>
47 
48 #include "thunder_mdio_var.h"
49 
50 static int thunder_mdio_fdt_probe(device_t);
51 static int thunder_mdio_fdt_attach(device_t);
52 
53 static device_method_t thunder_mdio_fdt_methods[] = {
54 	/* Device interface */
55 	DEVMETHOD(device_probe,		thunder_mdio_fdt_probe),
56 	DEVMETHOD(device_attach,	thunder_mdio_fdt_attach),
57 
58 	/* End */
59 	DEVMETHOD_END
60 };
61 
62 DEFINE_CLASS_1(thunder_mdio, thunder_mdio_fdt_driver, thunder_mdio_fdt_methods,
63     sizeof(struct thunder_mdio_softc), thunder_mdio_driver);
64 
65 EARLY_DRIVER_MODULE(thunder_mdio, ofwbus, thunder_mdio_fdt_driver, 0, 0,
66     BUS_PASS_BUS + BUS_PASS_ORDER_MIDDLE);
67 EARLY_DRIVER_MODULE(thunder_mdio, mdionexus, thunder_mdio_fdt_driver, 0, 0,
68     BUS_PASS_BUS + BUS_PASS_ORDER_MIDDLE);
69 
70 static struct ofw_compat_data mdio_compat_data[] = {
71 	{"cavium,octeon-3860-mdio",	true},
72 	{"cavium,thunder-8890-mdio",	true},
73 	{NULL,				false}
74 };
75 
76 static int
77 thunder_mdio_fdt_probe(device_t dev)
78 {
79 
80 	if (!ofw_bus_status_okay(dev))
81 		return (ENXIO);
82 	if (!ofw_bus_search_compatible(dev, mdio_compat_data)->ocd_data)
83 		return (ENXIO);
84 
85 	device_set_desc(dev, THUNDER_MDIO_DEVSTR);
86 	return (BUS_PROBE_DEFAULT);
87 }
88 
89 static int
90 thunder_mdio_fdt_attach(device_t dev)
91 {
92 	phandle_t node;
93 	int ret;
94 
95 	/* Call core attach */
96 	ret = thunder_mdio_attach(dev);
97 	if (ret != 0)
98 		return (ret);
99 	/*
100 	 * Register device to this node/xref.
101 	 * Thanks to that we will be able to retrieve device_t structure
102 	 * while holding only node reference acquired from FDT.
103 	 */
104 	node = ofw_bus_get_node(dev);
105 	OF_device_register_xref(OF_xref_from_node(node), dev);
106 
107 	return (0);
108 }
109 
110 struct mdionexus_softc {
111 	struct simplebus_softc simplebus_sc;
112 };
113 
114 static device_probe_t mdionexus_fdt_probe;
115 static device_attach_t mdionexus_fdt_attach;
116 
117 static const struct ofw_bus_devinfo * mdionexus_ofw_get_devinfo(device_t,
118     device_t);
119 
120 static device_method_t mdionexus_fdt_methods[] = {
121 	/* Device interface */
122 	DEVMETHOD(device_probe,		mdionexus_fdt_probe),
123 	DEVMETHOD(device_attach,	mdionexus_fdt_attach),
124 
125 	/* Bus interface */
126 	DEVMETHOD(bus_alloc_resource,		bus_generic_alloc_resource),
127 	DEVMETHOD(bus_release_resource,		bus_generic_release_resource),
128 	DEVMETHOD(bus_activate_resource,	bus_generic_activate_resource),
129 
130 	/* ofw_bus interface */
131 	DEVMETHOD(ofw_bus_get_devinfo,	mdionexus_ofw_get_devinfo),
132 	DEVMETHOD(ofw_bus_get_compat,	ofw_bus_gen_get_compat),
133 	DEVMETHOD(ofw_bus_get_model,	ofw_bus_gen_get_model),
134 	DEVMETHOD(ofw_bus_get_name,	ofw_bus_gen_get_name),
135 	DEVMETHOD(ofw_bus_get_node,	ofw_bus_gen_get_node),
136 	DEVMETHOD(ofw_bus_get_type,	ofw_bus_gen_get_type),
137 
138 	DEVMETHOD_END
139 };
140 
141 DEFINE_CLASS_0(mdionexus, mdionexus_fdt_driver, mdionexus_fdt_methods,
142     sizeof(struct mdionexus_softc));
143 
144 EARLY_DRIVER_MODULE(mdionexus, mrmlbus, mdionexus_fdt_driver, 0, 0,
145     BUS_PASS_BUS + BUS_PASS_ORDER_MIDDLE);
146 
147 static int mdionexus_ofw_fill_ranges(phandle_t, struct simplebus_softc *);
148 static int mdionexus_ofw_bus_attach(device_t);
149 
150 static int
151 mdionexus_fdt_probe(device_t dev)
152 {
153 
154 	if (!ofw_bus_status_okay(dev))
155 		return (ENXIO);
156 
157 	if (!ofw_bus_is_compatible(dev, "cavium,thunder-8890-mdio-nexus"))
158 		return (ENXIO);
159 
160 	device_set_desc(dev, "Cavium ThunderX MDIO nexus");
161 	return (BUS_PROBE_SPECIFIC);
162 }
163 
164 static int
165 mdionexus_fdt_attach(device_t dev)
166 {
167 	int err;
168 
169 	err = mdionexus_ofw_bus_attach(dev);
170 	if (err != 0)
171 		return (err);
172 
173 	return (bus_generic_attach(dev));
174 }
175 
176 /* OFW bus interface */
177 struct mdionexus_ofw_devinfo {
178 	struct ofw_bus_devinfo	di_dinfo;
179 	struct resource_list	di_rl;
180 };
181 
182 static const struct ofw_bus_devinfo *
183 mdionexus_ofw_get_devinfo(device_t bus __unused, device_t child)
184 {
185 	struct mdionexus_ofw_devinfo *di;
186 
187 	di = device_get_ivars(child);
188 	return (&di->di_dinfo);
189 }
190 
191 /* Helper functions */
192 
193 static int
194 mdionexus_ofw_fill_ranges(phandle_t node, struct simplebus_softc *sc)
195 {
196 	int host_address_cells;
197 	cell_t *base_ranges;
198 	ssize_t nbase_ranges;
199 	int err;
200 	int i, j, k;
201 
202 	err = OF_searchencprop(OF_parent(node), "#address-cells",
203 	    &host_address_cells, sizeof(host_address_cells));
204 	if (err <= 0)
205 		return (-1);
206 
207 	nbase_ranges = OF_getproplen(node, "ranges");
208 	if (nbase_ranges < 0)
209 		return (-1);
210 	sc->nranges = nbase_ranges / sizeof(cell_t) /
211 	    (sc->acells + host_address_cells + sc->scells);
212 	if (sc->nranges == 0)
213 		return (0);
214 
215 	sc->ranges = malloc(sc->nranges * sizeof(sc->ranges[0]),
216 	    M_THUNDER_MDIO, M_WAITOK);
217 	base_ranges = malloc(nbase_ranges, M_THUNDER_MDIO, M_WAITOK);
218 	OF_getencprop(node, "ranges", base_ranges, nbase_ranges);
219 
220 	for (i = 0, j = 0; i < sc->nranges; i++) {
221 		sc->ranges[i].bus = 0;
222 		for (k = 0; k < sc->acells; k++) {
223 			sc->ranges[i].bus <<= 32;
224 			sc->ranges[i].bus |= base_ranges[j++];
225 		}
226 		sc->ranges[i].host = 0;
227 		for (k = 0; k < host_address_cells; k++) {
228 			sc->ranges[i].host <<= 32;
229 			sc->ranges[i].host |= base_ranges[j++];
230 		}
231 		sc->ranges[i].size = 0;
232 		for (k = 0; k < sc->scells; k++) {
233 			sc->ranges[i].size <<= 32;
234 			sc->ranges[i].size |= base_ranges[j++];
235 		}
236 	}
237 
238 	free(base_ranges, M_THUNDER_MDIO);
239 	return (sc->nranges);
240 }
241 
242 static int
243 mdionexus_ofw_bus_attach(device_t dev)
244 {
245 	struct simplebus_softc *sc;
246 	struct mdionexus_ofw_devinfo *di;
247 	device_t child;
248 	phandle_t parent, node;
249 
250 	parent = ofw_bus_get_node(dev);
251 	simplebus_init(dev, parent);
252 
253 	sc = (struct simplebus_softc *)device_get_softc(dev);
254 
255 	if (mdionexus_ofw_fill_ranges(parent, sc) < 0) {
256 		device_printf(dev, "could not get ranges\n");
257 		return (ENXIO);
258 	}
259 	/* Iterate through all bus subordinates */
260 	for (node = OF_child(parent); node > 0; node = OF_peer(node)) {
261 		/* Allocate and populate devinfo. */
262 		di = malloc(sizeof(*di), M_THUNDER_MDIO, M_WAITOK | M_ZERO);
263 		if (ofw_bus_gen_setup_devinfo(&di->di_dinfo, node) != 0) {
264 			free(di, M_THUNDER_MDIO);
265 			continue;
266 		}
267 
268 		/* Initialize and populate resource list. */
269 		resource_list_init(&di->di_rl);
270 		ofw_bus_reg_to_rl(dev, node, sc->acells, sc->scells,
271 		    &di->di_rl);
272 		ofw_bus_intr_to_rl(dev, node, &di->di_rl, NULL);
273 
274 		/* Add newbus device for this FDT node */
275 		child = device_add_child(dev, NULL, -1);
276 		if (child == NULL) {
277 			resource_list_free(&di->di_rl);
278 			ofw_bus_gen_destroy_devinfo(&di->di_dinfo);
279 			free(di, M_THUNDER_MDIO);
280 			continue;
281 		}
282 
283 		device_set_ivars(child, di);
284 	}
285 
286 	return (0);
287 }
288