xref: /freebsd/sys/dev/usb/controller/dwc_otg_fdt.c (revision a35f04fba2ebb8f86d4cbdc710c89a094572b08e)
1 /*-
2  * Copyright (c) 2012 Hans Petter Selasky. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23  * SUCH DAMAGE.
24  */
25 
26 #include <sys/cdefs.h>
27 __FBSDID("$FreeBSD$");
28 
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
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 int
82 dwc_otg_attach(device_t dev)
83 {
84 	struct dwc_otg_fdt_softc *sc = device_get_softc(dev);
85 	char usb_mode[24];
86 	int err;
87 	int rid;
88 
89 	/* initialise some bus fields */
90 	sc->sc_otg.sc_bus.parent = dev;
91 	sc->sc_otg.sc_bus.devices = sc->sc_otg.sc_devices;
92 	sc->sc_otg.sc_bus.devices_max = DWC_OTG_MAX_DEVICES;
93 	sc->sc_otg.sc_bus.dma_bits = 32;
94 
95 	/* get USB mode, if any */
96 	if (OF_getprop(ofw_bus_get_node(dev), "dr_mode",
97 	    &usb_mode, sizeof(usb_mode)) > 0) {
98 
99 		/* ensure proper zero termination */
100 		usb_mode[sizeof(usb_mode) - 1] = 0;
101 
102 		if (strcasecmp(usb_mode, "host") == 0)
103 			sc->sc_otg.sc_mode = DWC_MODE_HOST;
104 		else if (strcasecmp(usb_mode, "peripheral") == 0)
105 			sc->sc_otg.sc_mode = DWC_MODE_DEVICE;
106 		else if (strcasecmp(usb_mode, "otg") != 0) {
107 			device_printf(dev, "Invalid FDT dr_mode: %s\n",
108 			    usb_mode);
109 		}
110 	}
111 
112 	/* get all DMA memory */
113 	if (usb_bus_mem_alloc_all(&sc->sc_otg.sc_bus,
114 	    USB_GET_DMA_TAG(dev), NULL)) {
115 		return (ENOMEM);
116 	}
117 	rid = 0;
118 	sc->sc_otg.sc_io_res =
119 	    bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
120 
121 	if (!(sc->sc_otg.sc_io_res)) {
122 		err = ENOMEM;
123 		goto error;
124 	}
125 	sc->sc_otg.sc_io_tag = rman_get_bustag(sc->sc_otg.sc_io_res);
126 	sc->sc_otg.sc_io_hdl = rman_get_bushandle(sc->sc_otg.sc_io_res);
127 	sc->sc_otg.sc_io_size = rman_get_size(sc->sc_otg.sc_io_res);
128 
129 
130 	/*
131 	 * brcm,bcm2708-usb FDT provides two interrupts,
132 	 * we need only second one (VC_USB)
133 	 */
134 	rid = ofw_bus_is_compatible(dev, "brcm,bcm2708-usb") ? 1 : 0;
135 	sc->sc_otg.sc_irq_res =
136 	    bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
137 	if (sc->sc_otg.sc_irq_res == NULL)
138 		goto error;
139 
140 	sc->sc_otg.sc_bus.bdev = device_add_child(dev, "usbus", -1);
141 	if (sc->sc_otg.sc_bus.bdev == NULL)
142 		goto error;
143 
144 	device_set_ivars(sc->sc_otg.sc_bus.bdev, &sc->sc_otg.sc_bus);
145 
146 	err = bus_setup_intr(dev, sc->sc_otg.sc_irq_res, INTR_TYPE_TTY | INTR_MPSAFE,
147 	    &dwc_otg_filter_interrupt, &dwc_otg_interrupt, sc, &sc->sc_otg.sc_intr_hdl);
148 	if (err) {
149 		sc->sc_otg.sc_intr_hdl = NULL;
150 		goto error;
151 	}
152 	err = dwc_otg_init(&sc->sc_otg);
153 	if (err == 0) {
154 		err = device_probe_and_attach(sc->sc_otg.sc_bus.bdev);
155 	}
156 	if (err)
157 		goto error;
158 
159 
160 	return (0);
161 
162 error:
163 	dwc_otg_detach(dev);
164 	return (ENXIO);
165 }
166 
167 int
168 dwc_otg_detach(device_t dev)
169 {
170 	struct dwc_otg_fdt_softc *sc = device_get_softc(dev);
171 	int err;
172 
173 	/* during module unload there are lots of children leftover */
174 	device_delete_children(dev);
175 
176 	if (sc->sc_otg.sc_irq_res && sc->sc_otg.sc_intr_hdl) {
177 		/*
178 		 * only call dwc_otg_uninit() after dwc_otg_init()
179 		 */
180 		dwc_otg_uninit(&sc->sc_otg);
181 
182 		err = bus_teardown_intr(dev, sc->sc_otg.sc_irq_res,
183 		    sc->sc_otg.sc_intr_hdl);
184 		sc->sc_otg.sc_intr_hdl = NULL;
185 	}
186 	/* free IRQ channel, if any */
187 	if (sc->sc_otg.sc_irq_res) {
188 		bus_release_resource(dev, SYS_RES_IRQ, 0,
189 		    sc->sc_otg.sc_irq_res);
190 		sc->sc_otg.sc_irq_res = NULL;
191 	}
192 	/* free memory resource, if any */
193 	if (sc->sc_otg.sc_io_res) {
194 		bus_release_resource(dev, SYS_RES_MEMORY, 0,
195 		    sc->sc_otg.sc_io_res);
196 		sc->sc_otg.sc_io_res = NULL;
197 	}
198 	usb_bus_mem_free_all(&sc->sc_otg.sc_bus, NULL);
199 
200 	return (0);
201 }
202 
203 static device_method_t dwc_otg_methods[] = {
204 	/* Device interface */
205 	DEVMETHOD(device_probe, dwc_otg_probe),
206 	DEVMETHOD(device_attach, dwc_otg_attach),
207 	DEVMETHOD(device_detach, dwc_otg_detach),
208 	DEVMETHOD(device_suspend, bus_generic_suspend),
209 	DEVMETHOD(device_resume, bus_generic_resume),
210 	DEVMETHOD(device_shutdown, bus_generic_shutdown),
211 
212 	DEVMETHOD_END
213 };
214 
215 driver_t dwc_otg_driver = {
216 	.name = "dwcotg",
217 	.methods = dwc_otg_methods,
218 	.size = sizeof(struct dwc_otg_fdt_softc),
219 };
220 
221 static devclass_t dwc_otg_devclass;
222 
223 DRIVER_MODULE(dwcotg, simplebus, dwc_otg_driver, dwc_otg_devclass, 0, 0);
224 MODULE_DEPEND(dwcotg, usb, 1, 1, 1);
225