xref: /freebsd/sys/dev/usb/controller/dwc_otg_fdt.c (revision 67be1e195acfaec99ce4fffeb17111ce085755f7)
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
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
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
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
162 dwc_otg_detach(device_t dev)
163 {
164 	struct dwc_otg_fdt_softc *sc = device_get_softc(dev);
165 
166 	/* during module unload there are lots of children leftover */
167 	device_delete_children(dev);
168 
169 	if (sc->sc_otg.sc_irq_res && sc->sc_otg.sc_intr_hdl) {
170 		/*
171 		 * only call dwc_otg_uninit() after dwc_otg_init()
172 		 */
173 		dwc_otg_uninit(&sc->sc_otg);
174 
175 		bus_teardown_intr(dev, sc->sc_otg.sc_irq_res,
176 		    sc->sc_otg.sc_intr_hdl);
177 		sc->sc_otg.sc_intr_hdl = NULL;
178 	}
179 	/* free IRQ channel, if any */
180 	if (sc->sc_otg.sc_irq_res) {
181 		bus_release_resource(dev, SYS_RES_IRQ, 0,
182 		    sc->sc_otg.sc_irq_res);
183 		sc->sc_otg.sc_irq_res = NULL;
184 	}
185 	/* free memory resource, if any */
186 	if (sc->sc_otg.sc_io_res) {
187 		bus_release_resource(dev, SYS_RES_MEMORY, 0,
188 		    sc->sc_otg.sc_io_res);
189 		sc->sc_otg.sc_io_res = NULL;
190 	}
191 	usb_bus_mem_free_all(&sc->sc_otg.sc_bus, NULL);
192 
193 	return (0);
194 }
195 
196 static device_method_t dwc_otg_methods[] = {
197 	/* Device interface */
198 	DEVMETHOD(device_probe, dwc_otg_probe),
199 	DEVMETHOD(device_attach, dwc_otg_attach),
200 	DEVMETHOD(device_detach, dwc_otg_detach),
201 	DEVMETHOD(device_suspend, bus_generic_suspend),
202 	DEVMETHOD(device_resume, bus_generic_resume),
203 	DEVMETHOD(device_shutdown, bus_generic_shutdown),
204 
205 	DEVMETHOD_END
206 };
207 
208 driver_t dwc_otg_driver = {
209 	.name = "dwcotg",
210 	.methods = dwc_otg_methods,
211 	.size = sizeof(struct dwc_otg_fdt_softc),
212 };
213 
214 DRIVER_MODULE(dwcotg, simplebus, dwc_otg_driver, 0, 0);
215 MODULE_DEPEND(dwcotg, usb, 1, 1, 1);
216