xref: /freebsd/sys/dev/vnic/thunder_mdio_fdt.c (revision 18250ec6c089c0c50cbd9fd87d78e03ff89916df)
1441d6780SZbigniew Bodek /*-
2441d6780SZbigniew Bodek  * Copyright (c) 2015 The FreeBSD Foundation
3441d6780SZbigniew Bodek  *
4441d6780SZbigniew Bodek  * This software was developed by Semihalf under
5441d6780SZbigniew Bodek  * the sponsorship of the FreeBSD Foundation.
6441d6780SZbigniew Bodek  *
7441d6780SZbigniew Bodek  * Redistribution and use in source and binary forms, with or without
8441d6780SZbigniew Bodek  * modification, are permitted provided that the following conditions
9441d6780SZbigniew Bodek  * are met:
10441d6780SZbigniew Bodek  * 1. Redistributions of source code must retain the above copyright
11441d6780SZbigniew Bodek  *    notice, this list of conditions and the following disclaimer.
12441d6780SZbigniew Bodek  * 2. Redistributions in binary form must reproduce the above copyright
13441d6780SZbigniew Bodek  *    notice, this list of conditions and the following disclaimer in the
14441d6780SZbigniew Bodek  *    documentation and/or other materials provided with the distribution.
15441d6780SZbigniew Bodek  *
16441d6780SZbigniew Bodek  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17441d6780SZbigniew Bodek  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18441d6780SZbigniew Bodek  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19441d6780SZbigniew Bodek  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20441d6780SZbigniew Bodek  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21441d6780SZbigniew Bodek  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22441d6780SZbigniew Bodek  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23441d6780SZbigniew Bodek  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24441d6780SZbigniew Bodek  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25441d6780SZbigniew Bodek  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26441d6780SZbigniew Bodek  * SUCH DAMAGE.
27441d6780SZbigniew Bodek  */
28441d6780SZbigniew Bodek 
29441d6780SZbigniew Bodek #include <sys/param.h>
30441d6780SZbigniew Bodek #include <sys/systm.h>
31441d6780SZbigniew Bodek #include <sys/bus.h>
32441d6780SZbigniew Bodek #include <sys/kernel.h>
33441d6780SZbigniew Bodek #include <sys/module.h>
34b9545c57SJustin Hibbits #include <sys/socket.h>
35441d6780SZbigniew Bodek 
36441d6780SZbigniew Bodek #include <dev/ofw/ofw_bus.h>
37441d6780SZbigniew Bodek #include <dev/ofw/ofw_bus_subr.h>
383f51d888SZbigniew Bodek #include <dev/fdt/simplebus.h>
393f51d888SZbigniew Bodek 
40b9545c57SJustin Hibbits #include <net/if.h>
41b9545c57SJustin Hibbits 
423f51d888SZbigniew Bodek #include <machine/bus.h>
433f51d888SZbigniew Bodek #include <machine/resource.h>
44441d6780SZbigniew Bodek 
45441d6780SZbigniew Bodek #include "thunder_mdio_var.h"
46441d6780SZbigniew Bodek 
47441d6780SZbigniew Bodek static int thunder_mdio_fdt_probe(device_t);
48441d6780SZbigniew Bodek static int thunder_mdio_fdt_attach(device_t);
49441d6780SZbigniew Bodek 
50441d6780SZbigniew Bodek static device_method_t thunder_mdio_fdt_methods[] = {
51441d6780SZbigniew Bodek 	/* Device interface */
52441d6780SZbigniew Bodek 	DEVMETHOD(device_probe,		thunder_mdio_fdt_probe),
53441d6780SZbigniew Bodek 	DEVMETHOD(device_attach,	thunder_mdio_fdt_attach),
54441d6780SZbigniew Bodek 
55441d6780SZbigniew Bodek 	/* End */
56441d6780SZbigniew Bodek 	DEVMETHOD_END
57441d6780SZbigniew Bodek };
58441d6780SZbigniew Bodek 
59441d6780SZbigniew Bodek DEFINE_CLASS_1(thunder_mdio, thunder_mdio_fdt_driver, thunder_mdio_fdt_methods,
60441d6780SZbigniew Bodek     sizeof(struct thunder_mdio_softc), thunder_mdio_driver);
61441d6780SZbigniew Bodek 
6294412ad7SJohn Baldwin EARLY_DRIVER_MODULE(thunder_mdio, ofwbus, thunder_mdio_fdt_driver, 0, 0,
6394412ad7SJohn Baldwin     BUS_PASS_BUS + BUS_PASS_ORDER_MIDDLE);
6494412ad7SJohn Baldwin EARLY_DRIVER_MODULE(thunder_mdio, mdionexus, thunder_mdio_fdt_driver, 0, 0,
6594412ad7SJohn Baldwin     BUS_PASS_BUS + BUS_PASS_ORDER_MIDDLE);
663f51d888SZbigniew Bodek 
673f51d888SZbigniew Bodek static struct ofw_compat_data mdio_compat_data[] = {
683f51d888SZbigniew Bodek 	{"cavium,octeon-3860-mdio",	true},
693f51d888SZbigniew Bodek 	{"cavium,thunder-8890-mdio",	true},
703f51d888SZbigniew Bodek 	{NULL,				false}
713f51d888SZbigniew Bodek };
72441d6780SZbigniew Bodek 
73441d6780SZbigniew Bodek static int
thunder_mdio_fdt_probe(device_t dev)74441d6780SZbigniew Bodek thunder_mdio_fdt_probe(device_t dev)
75441d6780SZbigniew Bodek {
76441d6780SZbigniew Bodek 
773f51d888SZbigniew Bodek 	if (!ofw_bus_status_okay(dev))
783f51d888SZbigniew Bodek 		return (ENXIO);
793f51d888SZbigniew Bodek 	if (!ofw_bus_search_compatible(dev, mdio_compat_data)->ocd_data)
803f51d888SZbigniew Bodek 		return (ENXIO);
813f51d888SZbigniew Bodek 
82441d6780SZbigniew Bodek 	device_set_desc(dev, THUNDER_MDIO_DEVSTR);
83441d6780SZbigniew Bodek 	return (BUS_PROBE_DEFAULT);
84441d6780SZbigniew Bodek }
85441d6780SZbigniew Bodek 
86441d6780SZbigniew Bodek static int
thunder_mdio_fdt_attach(device_t dev)87441d6780SZbigniew Bodek thunder_mdio_fdt_attach(device_t dev)
88441d6780SZbigniew Bodek {
89441d6780SZbigniew Bodek 	phandle_t node;
90441d6780SZbigniew Bodek 	int ret;
91441d6780SZbigniew Bodek 
92441d6780SZbigniew Bodek 	/* Call core attach */
93441d6780SZbigniew Bodek 	ret = thunder_mdio_attach(dev);
94441d6780SZbigniew Bodek 	if (ret != 0)
95441d6780SZbigniew Bodek 		return (ret);
96441d6780SZbigniew Bodek 	/*
97441d6780SZbigniew Bodek 	 * Register device to this node/xref.
98441d6780SZbigniew Bodek 	 * Thanks to that we will be able to retrieve device_t structure
99441d6780SZbigniew Bodek 	 * while holding only node reference acquired from FDT.
100441d6780SZbigniew Bodek 	 */
101441d6780SZbigniew Bodek 	node = ofw_bus_get_node(dev);
102441d6780SZbigniew Bodek 	OF_device_register_xref(OF_xref_from_node(node), dev);
103441d6780SZbigniew Bodek 
104441d6780SZbigniew Bodek 	return (0);
105441d6780SZbigniew Bodek }
1063f51d888SZbigniew Bodek 
1073f51d888SZbigniew Bodek struct mdionexus_softc {
1083f51d888SZbigniew Bodek 	struct simplebus_softc simplebus_sc;
1093f51d888SZbigniew Bodek };
1103f51d888SZbigniew Bodek 
1113f51d888SZbigniew Bodek static device_probe_t mdionexus_fdt_probe;
1123f51d888SZbigniew Bodek static device_attach_t mdionexus_fdt_attach;
1133f51d888SZbigniew Bodek 
1143f51d888SZbigniew Bodek static const struct ofw_bus_devinfo * mdionexus_ofw_get_devinfo(device_t,
1153f51d888SZbigniew Bodek     device_t);
1163f51d888SZbigniew Bodek 
1173f51d888SZbigniew Bodek static device_method_t mdionexus_fdt_methods[] = {
1183f51d888SZbigniew Bodek 	/* Device interface */
1193f51d888SZbigniew Bodek 	DEVMETHOD(device_probe,		mdionexus_fdt_probe),
1203f51d888SZbigniew Bodek 	DEVMETHOD(device_attach,	mdionexus_fdt_attach),
1213f51d888SZbigniew Bodek 
1223f51d888SZbigniew Bodek 	/* Bus interface */
1233f51d888SZbigniew Bodek 	DEVMETHOD(bus_alloc_resource,		bus_generic_alloc_resource),
1243f51d888SZbigniew Bodek 	DEVMETHOD(bus_release_resource,		bus_generic_release_resource),
1253f51d888SZbigniew Bodek 	DEVMETHOD(bus_activate_resource,	bus_generic_activate_resource),
1263f51d888SZbigniew Bodek 
1273f51d888SZbigniew Bodek 	/* ofw_bus interface */
1283f51d888SZbigniew Bodek 	DEVMETHOD(ofw_bus_get_devinfo,	mdionexus_ofw_get_devinfo),
1293f51d888SZbigniew Bodek 	DEVMETHOD(ofw_bus_get_compat,	ofw_bus_gen_get_compat),
1303f51d888SZbigniew Bodek 	DEVMETHOD(ofw_bus_get_model,	ofw_bus_gen_get_model),
1313f51d888SZbigniew Bodek 	DEVMETHOD(ofw_bus_get_name,	ofw_bus_gen_get_name),
1323f51d888SZbigniew Bodek 	DEVMETHOD(ofw_bus_get_node,	ofw_bus_gen_get_node),
1333f51d888SZbigniew Bodek 	DEVMETHOD(ofw_bus_get_type,	ofw_bus_gen_get_type),
1343f51d888SZbigniew Bodek 
1353f51d888SZbigniew Bodek 	DEVMETHOD_END
1363f51d888SZbigniew Bodek };
1373f51d888SZbigniew Bodek 
1383f51d888SZbigniew Bodek DEFINE_CLASS_0(mdionexus, mdionexus_fdt_driver, mdionexus_fdt_methods,
1393f51d888SZbigniew Bodek     sizeof(struct mdionexus_softc));
1403f51d888SZbigniew Bodek 
14194412ad7SJohn Baldwin EARLY_DRIVER_MODULE(mdionexus, mrmlbus, mdionexus_fdt_driver, 0, 0,
14294412ad7SJohn Baldwin     BUS_PASS_BUS + BUS_PASS_ORDER_MIDDLE);
1433f51d888SZbigniew Bodek 
1443f51d888SZbigniew Bodek static int mdionexus_ofw_fill_ranges(phandle_t, struct simplebus_softc *);
1453f51d888SZbigniew Bodek static int mdionexus_ofw_bus_attach(device_t);
1463f51d888SZbigniew Bodek 
1473f51d888SZbigniew Bodek static int
mdionexus_fdt_probe(device_t dev)1483f51d888SZbigniew Bodek mdionexus_fdt_probe(device_t dev)
1493f51d888SZbigniew Bodek {
1503f51d888SZbigniew Bodek 
1513f51d888SZbigniew Bodek 	if (!ofw_bus_status_okay(dev))
1523f51d888SZbigniew Bodek 		return (ENXIO);
1533f51d888SZbigniew Bodek 
1543f51d888SZbigniew Bodek 	if (!ofw_bus_is_compatible(dev, "cavium,thunder-8890-mdio-nexus"))
1553f51d888SZbigniew Bodek 		return (ENXIO);
1563f51d888SZbigniew Bodek 
1573f51d888SZbigniew Bodek 	device_set_desc(dev, "Cavium ThunderX MDIO nexus");
1583f51d888SZbigniew Bodek 	return (BUS_PROBE_SPECIFIC);
1593f51d888SZbigniew Bodek }
1603f51d888SZbigniew Bodek 
1613f51d888SZbigniew Bodek static int
mdionexus_fdt_attach(device_t dev)1623f51d888SZbigniew Bodek mdionexus_fdt_attach(device_t dev)
1633f51d888SZbigniew Bodek {
1643f51d888SZbigniew Bodek 	int err;
1653f51d888SZbigniew Bodek 
1663f51d888SZbigniew Bodek 	err = mdionexus_ofw_bus_attach(dev);
1673f51d888SZbigniew Bodek 	if (err != 0)
1683f51d888SZbigniew Bodek 		return (err);
1693f51d888SZbigniew Bodek 
170*18250ec6SJohn Baldwin 	bus_attach_children(dev);
171*18250ec6SJohn Baldwin 	return (0);
1723f51d888SZbigniew Bodek }
1733f51d888SZbigniew Bodek 
1743f51d888SZbigniew Bodek /* OFW bus interface */
1753f51d888SZbigniew Bodek struct mdionexus_ofw_devinfo {
1763f51d888SZbigniew Bodek 	struct ofw_bus_devinfo	di_dinfo;
1773f51d888SZbigniew Bodek 	struct resource_list	di_rl;
1783f51d888SZbigniew Bodek };
1793f51d888SZbigniew Bodek 
1803f51d888SZbigniew Bodek static const struct ofw_bus_devinfo *
mdionexus_ofw_get_devinfo(device_t bus __unused,device_t child)1813f51d888SZbigniew Bodek mdionexus_ofw_get_devinfo(device_t bus __unused, device_t child)
1823f51d888SZbigniew Bodek {
1833f51d888SZbigniew Bodek 	struct mdionexus_ofw_devinfo *di;
1843f51d888SZbigniew Bodek 
1853f51d888SZbigniew Bodek 	di = device_get_ivars(child);
1863f51d888SZbigniew Bodek 	return (&di->di_dinfo);
1873f51d888SZbigniew Bodek }
1883f51d888SZbigniew Bodek 
1893f51d888SZbigniew Bodek /* Helper functions */
1903f51d888SZbigniew Bodek 
1913f51d888SZbigniew Bodek static int
mdionexus_ofw_fill_ranges(phandle_t node,struct simplebus_softc * sc)1923f51d888SZbigniew Bodek mdionexus_ofw_fill_ranges(phandle_t node, struct simplebus_softc *sc)
1933f51d888SZbigniew Bodek {
1943f51d888SZbigniew Bodek 	int host_address_cells;
1953f51d888SZbigniew Bodek 	cell_t *base_ranges;
1963f51d888SZbigniew Bodek 	ssize_t nbase_ranges;
1973f51d888SZbigniew Bodek 	int err;
1983f51d888SZbigniew Bodek 	int i, j, k;
1993f51d888SZbigniew Bodek 
2003f51d888SZbigniew Bodek 	err = OF_searchencprop(OF_parent(node), "#address-cells",
2013f51d888SZbigniew Bodek 	    &host_address_cells, sizeof(host_address_cells));
2023f51d888SZbigniew Bodek 	if (err <= 0)
2033f51d888SZbigniew Bodek 		return (-1);
2043f51d888SZbigniew Bodek 
2053f51d888SZbigniew Bodek 	nbase_ranges = OF_getproplen(node, "ranges");
2063f51d888SZbigniew Bodek 	if (nbase_ranges < 0)
2073f51d888SZbigniew Bodek 		return (-1);
2083f51d888SZbigniew Bodek 	sc->nranges = nbase_ranges / sizeof(cell_t) /
2093f51d888SZbigniew Bodek 	    (sc->acells + host_address_cells + sc->scells);
2103f51d888SZbigniew Bodek 	if (sc->nranges == 0)
2113f51d888SZbigniew Bodek 		return (0);
2123f51d888SZbigniew Bodek 
2133f51d888SZbigniew Bodek 	sc->ranges = malloc(sc->nranges * sizeof(sc->ranges[0]),
2143f51d888SZbigniew Bodek 	    M_THUNDER_MDIO, M_WAITOK);
2153f51d888SZbigniew Bodek 	base_ranges = malloc(nbase_ranges, M_THUNDER_MDIO, M_WAITOK);
2163f51d888SZbigniew Bodek 	OF_getencprop(node, "ranges", base_ranges, nbase_ranges);
2173f51d888SZbigniew Bodek 
2183f51d888SZbigniew Bodek 	for (i = 0, j = 0; i < sc->nranges; i++) {
2193f51d888SZbigniew Bodek 		sc->ranges[i].bus = 0;
2203f51d888SZbigniew Bodek 		for (k = 0; k < sc->acells; k++) {
2213f51d888SZbigniew Bodek 			sc->ranges[i].bus <<= 32;
2223f51d888SZbigniew Bodek 			sc->ranges[i].bus |= base_ranges[j++];
2233f51d888SZbigniew Bodek 		}
2243f51d888SZbigniew Bodek 		sc->ranges[i].host = 0;
2253f51d888SZbigniew Bodek 		for (k = 0; k < host_address_cells; k++) {
2263f51d888SZbigniew Bodek 			sc->ranges[i].host <<= 32;
2273f51d888SZbigniew Bodek 			sc->ranges[i].host |= base_ranges[j++];
2283f51d888SZbigniew Bodek 		}
2293f51d888SZbigniew Bodek 		sc->ranges[i].size = 0;
2303f51d888SZbigniew Bodek 		for (k = 0; k < sc->scells; k++) {
2313f51d888SZbigniew Bodek 			sc->ranges[i].size <<= 32;
2323f51d888SZbigniew Bodek 			sc->ranges[i].size |= base_ranges[j++];
2333f51d888SZbigniew Bodek 		}
2343f51d888SZbigniew Bodek 	}
2353f51d888SZbigniew Bodek 
2363f51d888SZbigniew Bodek 	free(base_ranges, M_THUNDER_MDIO);
2373f51d888SZbigniew Bodek 	return (sc->nranges);
2383f51d888SZbigniew Bodek }
2393f51d888SZbigniew Bodek 
2403f51d888SZbigniew Bodek static int
mdionexus_ofw_bus_attach(device_t dev)2413f51d888SZbigniew Bodek mdionexus_ofw_bus_attach(device_t dev)
2423f51d888SZbigniew Bodek {
2433f51d888SZbigniew Bodek 	struct simplebus_softc *sc;
2443f51d888SZbigniew Bodek 	struct mdionexus_ofw_devinfo *di;
2453f51d888SZbigniew Bodek 	device_t child;
2463f51d888SZbigniew Bodek 	phandle_t parent, node;
2473f51d888SZbigniew Bodek 
2483f51d888SZbigniew Bodek 	parent = ofw_bus_get_node(dev);
2493f51d888SZbigniew Bodek 	simplebus_init(dev, parent);
2503f51d888SZbigniew Bodek 
2513f51d888SZbigniew Bodek 	sc = (struct simplebus_softc *)device_get_softc(dev);
2523f51d888SZbigniew Bodek 
2533f51d888SZbigniew Bodek 	if (mdionexus_ofw_fill_ranges(parent, sc) < 0) {
2543f51d888SZbigniew Bodek 		device_printf(dev, "could not get ranges\n");
2553f51d888SZbigniew Bodek 		return (ENXIO);
2563f51d888SZbigniew Bodek 	}
2573f51d888SZbigniew Bodek 	/* Iterate through all bus subordinates */
2583f51d888SZbigniew Bodek 	for (node = OF_child(parent); node > 0; node = OF_peer(node)) {
2593f51d888SZbigniew Bodek 		/* Allocate and populate devinfo. */
2603f51d888SZbigniew Bodek 		di = malloc(sizeof(*di), M_THUNDER_MDIO, M_WAITOK | M_ZERO);
2613f51d888SZbigniew Bodek 		if (ofw_bus_gen_setup_devinfo(&di->di_dinfo, node) != 0) {
2623f51d888SZbigniew Bodek 			free(di, M_THUNDER_MDIO);
2633f51d888SZbigniew Bodek 			continue;
2643f51d888SZbigniew Bodek 		}
2653f51d888SZbigniew Bodek 
2663f51d888SZbigniew Bodek 		/* Initialize and populate resource list. */
2673f51d888SZbigniew Bodek 		resource_list_init(&di->di_rl);
2683f51d888SZbigniew Bodek 		ofw_bus_reg_to_rl(dev, node, sc->acells, sc->scells,
2693f51d888SZbigniew Bodek 		    &di->di_rl);
2703f51d888SZbigniew Bodek 		ofw_bus_intr_to_rl(dev, node, &di->di_rl, NULL);
2713f51d888SZbigniew Bodek 
2723f51d888SZbigniew Bodek 		/* Add newbus device for this FDT node */
2735b56413dSWarner Losh 		child = device_add_child(dev, NULL, DEVICE_UNIT_ANY);
2743f51d888SZbigniew Bodek 		if (child == NULL) {
2753f51d888SZbigniew Bodek 			resource_list_free(&di->di_rl);
2763f51d888SZbigniew Bodek 			ofw_bus_gen_destroy_devinfo(&di->di_dinfo);
2773f51d888SZbigniew Bodek 			free(di, M_THUNDER_MDIO);
2783f51d888SZbigniew Bodek 			continue;
2793f51d888SZbigniew Bodek 		}
2803f51d888SZbigniew Bodek 
2813f51d888SZbigniew Bodek 		device_set_ivars(child, di);
2823f51d888SZbigniew Bodek 	}
2833f51d888SZbigniew Bodek 
2843f51d888SZbigniew Bodek 	return (0);
2853f51d888SZbigniew Bodek }
286