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