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/param.h>
33 #include <sys/systm.h>
34 #include <sys/bus.h>
35 #include <sys/rman.h>
36 #include <sys/kernel.h>
37 #include <sys/module.h>
38 #include <sys/gpio.h>
39 #include <machine/bus.h>
40
41 #include <dev/fdt/simplebus.h>
42
43 #include <dev/fdt/fdt_common.h>
44 #include <dev/ofw/ofw_bus.h>
45 #include <dev/ofw/ofw_bus_subr.h>
46 #include <dev/ofw/ofw_subr.h>
47
48 #include <dev/clk/clk.h>
49 #include <dev/hwreset/hwreset.h>
50 #include <dev/phy/phy_usb.h>
51 #include <dev/syscon/syscon.h>
52
53 static struct ofw_compat_data compat_data[] = {
54 { "xlnx,zynqmp-dwc3", 1 },
55 { NULL, 0 }
56 };
57
58 struct xlnx_dwc3_softc {
59 struct simplebus_softc sc;
60 device_t dev;
61 hwreset_t rst_crst;
62 hwreset_t rst_hibrst;
63 hwreset_t rst_apbrst;
64 };
65
66 static int
xlnx_dwc3_probe(device_t dev)67 xlnx_dwc3_probe(device_t dev)
68 {
69 phandle_t node;
70
71 if (!ofw_bus_status_okay(dev))
72 return (ENXIO);
73
74 if (ofw_bus_search_compatible(dev, compat_data)->ocd_data == 0)
75 return (ENXIO);
76
77 /* Binding says that we need a child node for the actual dwc3 controller */
78 node = ofw_bus_get_node(dev);
79 if (OF_child(node) <= 0)
80 return (ENXIO);
81
82 device_set_desc(dev, "Xilinx ZYNQMP DWC3");
83 return (BUS_PROBE_DEFAULT);
84 }
85
86 static int
xlnx_dwc3_attach(device_t dev)87 xlnx_dwc3_attach(device_t dev)
88 {
89 struct xlnx_dwc3_softc *sc;
90 device_t cdev;
91 phandle_t node, child;
92
93 sc = device_get_softc(dev);
94 sc->dev = dev;
95 node = ofw_bus_get_node(dev);
96
97 /*
98 * Put module out of reset
99 * Based on the bindings this should be mandatory to have
100 * but reality shows that they aren't always there.
101 * This is the case on the DTB in the AVnet Ultra96
102 */
103 if (hwreset_get_by_ofw_name(dev, node, "usb_crst", &sc->rst_crst) == 0) {
104 if (hwreset_deassert(sc->rst_crst) != 0) {
105 device_printf(dev, "Cannot deassert reset\n");
106 return (ENXIO);
107 }
108 }
109 if (hwreset_get_by_ofw_name(dev, node, "usb_hibrst", &sc->rst_hibrst) == 0) {
110 if (hwreset_deassert(sc->rst_hibrst) != 0) {
111 device_printf(dev, "Cannot deassert reset\n");
112 return (ENXIO);
113 }
114 }
115 if (hwreset_get_by_ofw_name(dev, node, "usb_apbrst", &sc->rst_apbrst) == 0) {
116 if (hwreset_deassert(sc->rst_apbrst) != 0) {
117 device_printf(dev, "Cannot deassert reset\n");
118 return (ENXIO);
119 }
120 }
121
122 simplebus_init(dev, node);
123 if (simplebus_fill_ranges(node, &sc->sc) < 0) {
124 device_printf(dev, "could not get ranges\n");
125 return (ENXIO);
126 }
127
128 for (child = OF_child(node); child > 0; child = OF_peer(child)) {
129 cdev = simplebus_add_device(dev, child, 0, NULL, -1, NULL);
130 if (cdev != NULL)
131 device_probe_and_attach(cdev);
132 }
133
134 bus_attach_children(dev);
135 return (0);
136 }
137
138 static device_method_t xlnx_dwc3_methods[] = {
139 /* Device interface */
140 DEVMETHOD(device_probe, xlnx_dwc3_probe),
141 DEVMETHOD(device_attach, xlnx_dwc3_attach),
142
143 DEVMETHOD_END
144 };
145
146 DEFINE_CLASS_1(xlnx_dwc3, xlnx_dwc3_driver, xlnx_dwc3_methods,
147 sizeof(struct xlnx_dwc3_softc), simplebus_driver);
148 DRIVER_MODULE(xlnx_dwc3, simplebus, xlnx_dwc3_driver, 0, 0);
149