1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2012 Hans Petter Selasky.
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 #include <sys/cdefs.h>
29 #include <sys/param.h>
30 #include <sys/systm.h>
31 #include <sys/bus.h>
32 #include <sys/condvar.h>
33 #include <sys/kernel.h>
34 #include <sys/lock.h>
35 #include <sys/malloc.h>
36 #include <sys/module.h>
37 #include <sys/mutex.h>
38 #include <sys/rman.h>
39
40 #include <dev/ofw/openfirm.h>
41 #include <dev/ofw/ofw_bus.h>
42 #include <dev/ofw/ofw_bus_subr.h>
43
44 #include <dev/usb/usb.h>
45 #include <dev/usb/usbdi.h>
46
47 #include <dev/usb/usb_core.h>
48 #include <dev/usb/usb_busdma.h>
49 #include <dev/usb/usb_process.h>
50 #include <dev/usb/usb_util.h>
51
52 #include <dev/usb/usb_controller.h>
53 #include <dev/usb/usb_bus.h>
54
55 #include <dev/usb/controller/dwc_otg.h>
56 #include <dev/usb/controller/dwc_otg_fdt.h>
57
58 static device_probe_t dwc_otg_probe;
59
60 static struct ofw_compat_data compat_data[] = {
61 { "synopsys,designware-hs-otg2", 1 },
62 { "snps,dwc2", 1 },
63 { NULL, 0 }
64 };
65
66 static int
dwc_otg_probe(device_t dev)67 dwc_otg_probe(device_t dev)
68 {
69
70 if (!ofw_bus_status_okay(dev))
71 return (ENXIO);
72
73 if (!ofw_bus_search_compatible(dev, compat_data)->ocd_data)
74 return (ENXIO);
75
76 device_set_desc(dev, "DWC OTG 2.0 integrated USB controller");
77
78 return (BUS_PROBE_DEFAULT);
79 }
80
81 static int
dwc_otg_irq_index(device_t dev,int * rid)82 dwc_otg_irq_index(device_t dev, int *rid)
83 {
84 int idx, rv;
85 phandle_t node;
86
87 node = ofw_bus_get_node(dev);
88 rv = ofw_bus_find_string_index(node, "interrupt-names", "usb", &idx);
89 if (rv != 0)
90 return (rv);
91 *rid = idx;
92 return (0);
93 }
94
95 int
dwc_otg_attach(device_t dev)96 dwc_otg_attach(device_t dev)
97 {
98 struct dwc_otg_fdt_softc *sc = device_get_softc(dev);
99 char usb_mode[24];
100 int err;
101 int rid;
102
103 sc->sc_otg.sc_bus.parent = dev;
104
105 /* get USB mode, if any */
106 if (OF_getprop(ofw_bus_get_node(dev), "dr_mode",
107 &usb_mode, sizeof(usb_mode)) > 0) {
108 /* ensure proper zero termination */
109 usb_mode[sizeof(usb_mode) - 1] = 0;
110
111 if (strcasecmp(usb_mode, "host") == 0)
112 sc->sc_otg.sc_mode = DWC_MODE_HOST;
113 else if (strcasecmp(usb_mode, "peripheral") == 0)
114 sc->sc_otg.sc_mode = DWC_MODE_DEVICE;
115 else if (strcasecmp(usb_mode, "otg") != 0) {
116 device_printf(dev, "Invalid FDT dr_mode: %s\n",
117 usb_mode);
118 }
119 }
120
121 rid = 0;
122 sc->sc_otg.sc_io_res =
123 bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
124
125 if (!(sc->sc_otg.sc_io_res))
126 goto error;
127
128 /*
129 * brcm,bcm2708-usb FDT provides two interrupts, we need only the USB
130 * interrupt (VC_USB). The latest FDT for it provides an
131 * interrupt-names property and swapped them around, while older ones
132 * did not have interrupt-names and put the usb interrupt in the second
133 * position. We'll attempt to use interrupt-names first with a fallback
134 * to the old method of assuming the index based on the compatible
135 * string.
136 */
137 if (dwc_otg_irq_index(dev, &rid) != 0)
138 rid = ofw_bus_is_compatible(dev, "brcm,bcm2708-usb") ? 1 : 0;
139 sc->sc_otg.sc_irq_res =
140 bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
141 if (sc->sc_otg.sc_irq_res == NULL)
142 goto error;
143
144 sc->sc_otg.sc_bus.bdev = device_add_child(dev, "usbus", -1);
145 if (sc->sc_otg.sc_bus.bdev == NULL)
146 goto error;
147
148 err = dwc_otg_init(&sc->sc_otg);
149 if (err == 0) {
150 err = device_probe_and_attach(sc->sc_otg.sc_bus.bdev);
151 }
152 if (err)
153 goto error;
154
155 return (0);
156
157 error:
158 dwc_otg_detach(dev);
159 return (ENXIO);
160 }
161
162 int
dwc_otg_detach(device_t dev)163 dwc_otg_detach(device_t dev)
164 {
165 struct dwc_otg_fdt_softc *sc = device_get_softc(dev);
166
167 /* during module unload there are lots of children leftover */
168 device_delete_children(dev);
169
170 if (sc->sc_otg.sc_irq_res && sc->sc_otg.sc_intr_hdl) {
171 /*
172 * only call dwc_otg_uninit() after dwc_otg_init()
173 */
174 dwc_otg_uninit(&sc->sc_otg);
175
176 bus_teardown_intr(dev, sc->sc_otg.sc_irq_res,
177 sc->sc_otg.sc_intr_hdl);
178 sc->sc_otg.sc_intr_hdl = NULL;
179 }
180 /* free IRQ channel, if any */
181 if (sc->sc_otg.sc_irq_res) {
182 bus_release_resource(dev, SYS_RES_IRQ, 0,
183 sc->sc_otg.sc_irq_res);
184 sc->sc_otg.sc_irq_res = NULL;
185 }
186 /* free memory resource, if any */
187 if (sc->sc_otg.sc_io_res) {
188 bus_release_resource(dev, SYS_RES_MEMORY, 0,
189 sc->sc_otg.sc_io_res);
190 sc->sc_otg.sc_io_res = NULL;
191 }
192 usb_bus_mem_free_all(&sc->sc_otg.sc_bus, NULL);
193
194 return (0);
195 }
196
197 static device_method_t dwc_otg_methods[] = {
198 /* Device interface */
199 DEVMETHOD(device_probe, dwc_otg_probe),
200 DEVMETHOD(device_attach, dwc_otg_attach),
201 DEVMETHOD(device_detach, dwc_otg_detach),
202 DEVMETHOD(device_suspend, bus_generic_suspend),
203 DEVMETHOD(device_resume, bus_generic_resume),
204 DEVMETHOD(device_shutdown, bus_generic_shutdown),
205
206 DEVMETHOD_END
207 };
208
209 driver_t dwc_otg_driver = {
210 .name = "dwcotg",
211 .methods = dwc_otg_methods,
212 .size = sizeof(struct dwc_otg_fdt_softc),
213 };
214
215 DRIVER_MODULE(dwcotg, simplebus, dwc_otg_driver, 0, 0);
216 MODULE_DEPEND(dwcotg, usb, 1, 1, 1);
217