1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2022 Beckhoff Automation GmbH & Co. KG 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 AND CONTRIBUTORS ``AS IS'' AND 16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25 * SUCH DAMAGE. 26 */ 27 28 /* 29 * Xilinx DWC3 glue 30 */ 31 32 #include <sys/cdefs.h> 33 34 #include <sys/param.h> 35 #include <sys/systm.h> 36 #include <sys/bus.h> 37 #include <sys/rman.h> 38 #include <sys/kernel.h> 39 #include <sys/module.h> 40 #include <sys/gpio.h> 41 #include <machine/bus.h> 42 43 #include <dev/fdt/simplebus.h> 44 45 #include <dev/fdt/fdt_common.h> 46 #include <dev/ofw/ofw_bus.h> 47 #include <dev/ofw/ofw_bus_subr.h> 48 #include <dev/ofw/ofw_subr.h> 49 50 #include <dev/extres/clk/clk.h> 51 #include <dev/extres/hwreset/hwreset.h> 52 #include <dev/extres/phy/phy_usb.h> 53 #include <dev/extres/syscon/syscon.h> 54 55 static struct ofw_compat_data compat_data[] = { 56 { "xlnx,zynqmp-dwc3", 1 }, 57 { NULL, 0 } 58 }; 59 60 struct xlnx_dwc3_softc { 61 struct simplebus_softc sc; 62 device_t dev; 63 hwreset_t rst_crst; 64 hwreset_t rst_hibrst; 65 hwreset_t rst_apbrst; 66 }; 67 68 static int 69 xlnx_dwc3_probe(device_t dev) 70 { 71 phandle_t node; 72 73 if (!ofw_bus_status_okay(dev)) 74 return (ENXIO); 75 76 if (ofw_bus_search_compatible(dev, compat_data)->ocd_data == 0) 77 return (ENXIO); 78 79 /* Binding says that we need a child node for the actual dwc3 controller */ 80 node = ofw_bus_get_node(dev); 81 if (OF_child(node) <= 0) 82 return (ENXIO); 83 84 device_set_desc(dev, "Xilinx ZYNQMP DWC3"); 85 return (BUS_PROBE_DEFAULT); 86 } 87 88 static int 89 xlnx_dwc3_attach(device_t dev) 90 { 91 struct xlnx_dwc3_softc *sc; 92 device_t cdev; 93 phandle_t node, child; 94 95 sc = device_get_softc(dev); 96 sc->dev = dev; 97 node = ofw_bus_get_node(dev); 98 99 /* 100 * Put module out of reset 101 * Based on the bindings this should be mandatory to have 102 * but reality shows that they aren't always there. 103 * This is the case on the DTB in the AVnet Ultra96 104 */ 105 if (hwreset_get_by_ofw_name(dev, node, "usb_crst", &sc->rst_crst) == 0) { 106 if (hwreset_deassert(sc->rst_crst) != 0) { 107 device_printf(dev, "Cannot deassert reset\n"); 108 return (ENXIO); 109 } 110 } 111 if (hwreset_get_by_ofw_name(dev, node, "usb_hibrst", &sc->rst_hibrst) == 0) { 112 if (hwreset_deassert(sc->rst_hibrst) != 0) { 113 device_printf(dev, "Cannot deassert reset\n"); 114 return (ENXIO); 115 } 116 } 117 if (hwreset_get_by_ofw_name(dev, node, "usb_apbrst", &sc->rst_apbrst) == 0) { 118 if (hwreset_deassert(sc->rst_apbrst) != 0) { 119 device_printf(dev, "Cannot deassert reset\n"); 120 return (ENXIO); 121 } 122 } 123 124 simplebus_init(dev, node); 125 if (simplebus_fill_ranges(node, &sc->sc) < 0) { 126 device_printf(dev, "could not get ranges\n"); 127 return (ENXIO); 128 } 129 130 for (child = OF_child(node); child > 0; child = OF_peer(child)) { 131 cdev = simplebus_add_device(dev, child, 0, NULL, -1, NULL); 132 if (cdev != NULL) 133 device_probe_and_attach(cdev); 134 } 135 136 return (bus_generic_attach(dev)); 137 } 138 139 static device_method_t xlnx_dwc3_methods[] = { 140 /* Device interface */ 141 DEVMETHOD(device_probe, xlnx_dwc3_probe), 142 DEVMETHOD(device_attach, xlnx_dwc3_attach), 143 144 DEVMETHOD_END 145 }; 146 147 DEFINE_CLASS_1(xlnx_dwc3, xlnx_dwc3_driver, xlnx_dwc3_methods, 148 sizeof(struct xlnx_dwc3_softc), simplebus_driver); 149 DRIVER_MODULE(xlnx_dwc3, simplebus, xlnx_dwc3_driver, 0, 0); 150