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/param.h>
30 #include <sys/systm.h>
31 #include <sys/bus.h>
32 #include <sys/kernel.h>
33 #include <sys/module.h>
34 #include <sys/socket.h>
35
36 #include <dev/ofw/ofw_bus.h>
37 #include <dev/ofw/ofw_bus_subr.h>
38 #include <dev/fdt/simplebus.h>
39
40 #include <net/if.h>
41
42 #include <machine/bus.h>
43 #include <machine/resource.h>
44
45 #include "thunder_mdio_var.h"
46
47 static int thunder_mdio_fdt_probe(device_t);
48 static int thunder_mdio_fdt_attach(device_t);
49
50 static device_method_t thunder_mdio_fdt_methods[] = {
51 /* Device interface */
52 DEVMETHOD(device_probe, thunder_mdio_fdt_probe),
53 DEVMETHOD(device_attach, thunder_mdio_fdt_attach),
54
55 /* End */
56 DEVMETHOD_END
57 };
58
59 DEFINE_CLASS_1(thunder_mdio, thunder_mdio_fdt_driver, thunder_mdio_fdt_methods,
60 sizeof(struct thunder_mdio_softc), thunder_mdio_driver);
61
62 EARLY_DRIVER_MODULE(thunder_mdio, ofwbus, thunder_mdio_fdt_driver, 0, 0,
63 BUS_PASS_BUS + BUS_PASS_ORDER_MIDDLE);
64 EARLY_DRIVER_MODULE(thunder_mdio, mdionexus, thunder_mdio_fdt_driver, 0, 0,
65 BUS_PASS_BUS + BUS_PASS_ORDER_MIDDLE);
66
67 static struct ofw_compat_data mdio_compat_data[] = {
68 {"cavium,octeon-3860-mdio", true},
69 {"cavium,thunder-8890-mdio", true},
70 {NULL, false}
71 };
72
73 static int
thunder_mdio_fdt_probe(device_t dev)74 thunder_mdio_fdt_probe(device_t dev)
75 {
76
77 if (!ofw_bus_status_okay(dev))
78 return (ENXIO);
79 if (!ofw_bus_search_compatible(dev, mdio_compat_data)->ocd_data)
80 return (ENXIO);
81
82 device_set_desc(dev, THUNDER_MDIO_DEVSTR);
83 return (BUS_PROBE_DEFAULT);
84 }
85
86 static int
thunder_mdio_fdt_attach(device_t dev)87 thunder_mdio_fdt_attach(device_t dev)
88 {
89 phandle_t node;
90 int ret;
91
92 /* Call core attach */
93 ret = thunder_mdio_attach(dev);
94 if (ret != 0)
95 return (ret);
96 /*
97 * Register device to this node/xref.
98 * Thanks to that we will be able to retrieve device_t structure
99 * while holding only node reference acquired from FDT.
100 */
101 node = ofw_bus_get_node(dev);
102 OF_device_register_xref(OF_xref_from_node(node), dev);
103
104 return (0);
105 }
106
107 struct mdionexus_softc {
108 struct simplebus_softc simplebus_sc;
109 };
110
111 static device_probe_t mdionexus_fdt_probe;
112 static device_attach_t mdionexus_fdt_attach;
113
114 static const struct ofw_bus_devinfo * mdionexus_ofw_get_devinfo(device_t,
115 device_t);
116
117 static device_method_t mdionexus_fdt_methods[] = {
118 /* Device interface */
119 DEVMETHOD(device_probe, mdionexus_fdt_probe),
120 DEVMETHOD(device_attach, mdionexus_fdt_attach),
121
122 /* Bus interface */
123 DEVMETHOD(bus_alloc_resource, bus_generic_alloc_resource),
124 DEVMETHOD(bus_release_resource, bus_generic_release_resource),
125 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
126
127 /* ofw_bus interface */
128 DEVMETHOD(ofw_bus_get_devinfo, mdionexus_ofw_get_devinfo),
129 DEVMETHOD(ofw_bus_get_compat, ofw_bus_gen_get_compat),
130 DEVMETHOD(ofw_bus_get_model, ofw_bus_gen_get_model),
131 DEVMETHOD(ofw_bus_get_name, ofw_bus_gen_get_name),
132 DEVMETHOD(ofw_bus_get_node, ofw_bus_gen_get_node),
133 DEVMETHOD(ofw_bus_get_type, ofw_bus_gen_get_type),
134
135 DEVMETHOD_END
136 };
137
138 DEFINE_CLASS_0(mdionexus, mdionexus_fdt_driver, mdionexus_fdt_methods,
139 sizeof(struct mdionexus_softc));
140
141 EARLY_DRIVER_MODULE(mdionexus, mrmlbus, mdionexus_fdt_driver, 0, 0,
142 BUS_PASS_BUS + BUS_PASS_ORDER_MIDDLE);
143
144 static int mdionexus_ofw_fill_ranges(phandle_t, struct simplebus_softc *);
145 static int mdionexus_ofw_bus_attach(device_t);
146
147 static int
mdionexus_fdt_probe(device_t dev)148 mdionexus_fdt_probe(device_t dev)
149 {
150
151 if (!ofw_bus_status_okay(dev))
152 return (ENXIO);
153
154 if (!ofw_bus_is_compatible(dev, "cavium,thunder-8890-mdio-nexus"))
155 return (ENXIO);
156
157 device_set_desc(dev, "Cavium ThunderX MDIO nexus");
158 return (BUS_PROBE_SPECIFIC);
159 }
160
161 static int
mdionexus_fdt_attach(device_t dev)162 mdionexus_fdt_attach(device_t dev)
163 {
164 int err;
165
166 err = mdionexus_ofw_bus_attach(dev);
167 if (err != 0)
168 return (err);
169
170 bus_attach_children(dev);
171 return (0);
172 }
173
174 /* OFW bus interface */
175 struct mdionexus_ofw_devinfo {
176 struct ofw_bus_devinfo di_dinfo;
177 struct resource_list di_rl;
178 };
179
180 static const struct ofw_bus_devinfo *
mdionexus_ofw_get_devinfo(device_t bus __unused,device_t child)181 mdionexus_ofw_get_devinfo(device_t bus __unused, device_t child)
182 {
183 struct mdionexus_ofw_devinfo *di;
184
185 di = device_get_ivars(child);
186 return (&di->di_dinfo);
187 }
188
189 /* Helper functions */
190
191 static int
mdionexus_ofw_fill_ranges(phandle_t node,struct simplebus_softc * sc)192 mdionexus_ofw_fill_ranges(phandle_t node, struct simplebus_softc *sc)
193 {
194 int host_address_cells;
195 cell_t *base_ranges;
196 ssize_t nbase_ranges;
197 int err;
198 int i, j, k;
199
200 err = OF_searchencprop(OF_parent(node), "#address-cells",
201 &host_address_cells, sizeof(host_address_cells));
202 if (err <= 0)
203 return (-1);
204
205 nbase_ranges = OF_getproplen(node, "ranges");
206 if (nbase_ranges < 0)
207 return (-1);
208 sc->nranges = nbase_ranges / sizeof(cell_t) /
209 (sc->acells + host_address_cells + sc->scells);
210 if (sc->nranges == 0)
211 return (0);
212
213 sc->ranges = malloc(sc->nranges * sizeof(sc->ranges[0]),
214 M_THUNDER_MDIO, M_WAITOK);
215 base_ranges = malloc(nbase_ranges, M_THUNDER_MDIO, M_WAITOK);
216 OF_getencprop(node, "ranges", base_ranges, nbase_ranges);
217
218 for (i = 0, j = 0; i < sc->nranges; i++) {
219 sc->ranges[i].bus = 0;
220 for (k = 0; k < sc->acells; k++) {
221 sc->ranges[i].bus <<= 32;
222 sc->ranges[i].bus |= base_ranges[j++];
223 }
224 sc->ranges[i].host = 0;
225 for (k = 0; k < host_address_cells; k++) {
226 sc->ranges[i].host <<= 32;
227 sc->ranges[i].host |= base_ranges[j++];
228 }
229 sc->ranges[i].size = 0;
230 for (k = 0; k < sc->scells; k++) {
231 sc->ranges[i].size <<= 32;
232 sc->ranges[i].size |= base_ranges[j++];
233 }
234 }
235
236 free(base_ranges, M_THUNDER_MDIO);
237 return (sc->nranges);
238 }
239
240 static int
mdionexus_ofw_bus_attach(device_t dev)241 mdionexus_ofw_bus_attach(device_t dev)
242 {
243 struct simplebus_softc *sc;
244 struct mdionexus_ofw_devinfo *di;
245 device_t child;
246 phandle_t parent, node;
247
248 parent = ofw_bus_get_node(dev);
249 simplebus_init(dev, parent);
250
251 sc = (struct simplebus_softc *)device_get_softc(dev);
252
253 if (mdionexus_ofw_fill_ranges(parent, sc) < 0) {
254 device_printf(dev, "could not get ranges\n");
255 return (ENXIO);
256 }
257 /* Iterate through all bus subordinates */
258 for (node = OF_child(parent); node > 0; node = OF_peer(node)) {
259 /* Allocate and populate devinfo. */
260 di = malloc(sizeof(*di), M_THUNDER_MDIO, M_WAITOK | M_ZERO);
261 if (ofw_bus_gen_setup_devinfo(&di->di_dinfo, node) != 0) {
262 free(di, M_THUNDER_MDIO);
263 continue;
264 }
265
266 /* Initialize and populate resource list. */
267 resource_list_init(&di->di_rl);
268 ofw_bus_reg_to_rl(dev, node, sc->acells, sc->scells,
269 &di->di_rl);
270 ofw_bus_intr_to_rl(dev, node, &di->di_rl, NULL);
271
272 /* Add newbus device for this FDT node */
273 child = device_add_child(dev, NULL, DEVICE_UNIT_ANY);
274 if (child == NULL) {
275 resource_list_free(&di->di_rl);
276 ofw_bus_gen_destroy_devinfo(&di->di_dinfo);
277 free(di, M_THUNDER_MDIO);
278 continue;
279 }
280
281 device_set_ivars(child, di);
282 }
283
284 return (0);
285 }
286