dwc_otg_fdt.c revision 308401
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: stable/11/sys/dev/usb/controller/dwc_otg_fdt.c 308401 2016-11-07 08:36:06Z hselasky $");
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
58static device_probe_t dwc_otg_probe;
59static device_detach_t dwc_otg_detach;
60
61static int
62dwc_otg_probe(device_t dev)
63{
64
65	if (!ofw_bus_status_okay(dev))
66		return (ENXIO);
67
68	if (!ofw_bus_is_compatible(dev, "synopsys,designware-hs-otg2"))
69		return (ENXIO);
70
71	device_set_desc(dev, "DWC OTG 2.0 integrated USB controller");
72
73	return (BUS_PROBE_DEFAULT);
74}
75
76int
77dwc_otg_attach(device_t dev)
78{
79	struct dwc_otg_fdt_softc *sc = device_get_softc(dev);
80	char usb_mode[24];
81	int err;
82	int rid;
83
84	/* initialise some bus fields */
85	sc->sc_otg.sc_bus.parent = dev;
86	sc->sc_otg.sc_bus.devices = sc->sc_otg.sc_devices;
87	sc->sc_otg.sc_bus.devices_max = DWC_OTG_MAX_DEVICES;
88	sc->sc_otg.sc_bus.dma_bits = 32;
89
90	/* get USB mode, if any */
91	if (OF_getprop(ofw_bus_get_node(dev), "dr_mode",
92	    &usb_mode, sizeof(usb_mode)) > 0) {
93
94		/* ensure proper zero termination */
95		usb_mode[sizeof(usb_mode) - 1] = 0;
96
97		if (strcasecmp(usb_mode, "host") == 0)
98			sc->sc_otg.sc_mode = DWC_MODE_HOST;
99		else if (strcasecmp(usb_mode, "peripheral") == 0)
100			sc->sc_otg.sc_mode = DWC_MODE_DEVICE;
101		else if (strcasecmp(usb_mode, "otg") != 0) {
102			device_printf(dev, "Invalid FDT dr_mode: %s\n",
103			    usb_mode);
104		}
105	}
106
107	/* get all DMA memory */
108	if (usb_bus_mem_alloc_all(&sc->sc_otg.sc_bus,
109	    USB_GET_DMA_TAG(dev), NULL)) {
110		return (ENOMEM);
111	}
112	rid = 0;
113	sc->sc_otg.sc_io_res =
114	    bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
115
116	if (!(sc->sc_otg.sc_io_res)) {
117		err = ENOMEM;
118		goto error;
119	}
120	sc->sc_otg.sc_io_tag = rman_get_bustag(sc->sc_otg.sc_io_res);
121	sc->sc_otg.sc_io_hdl = rman_get_bushandle(sc->sc_otg.sc_io_res);
122	sc->sc_otg.sc_io_size = rman_get_size(sc->sc_otg.sc_io_res);
123
124
125	/*
126	 * brcm,bcm2708-usb FDT provides two interrupts,
127	 * we need only second one (VC_USB)
128	 */
129	rid = ofw_bus_is_compatible(dev, "brcm,bcm2708-usb") ? 1 : 0;
130	sc->sc_otg.sc_irq_res =
131	    bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
132	if (sc->sc_otg.sc_irq_res == NULL)
133		goto error;
134
135	sc->sc_otg.sc_bus.bdev = device_add_child(dev, "usbus", -1);
136	if (sc->sc_otg.sc_bus.bdev == NULL)
137		goto error;
138
139	device_set_ivars(sc->sc_otg.sc_bus.bdev, &sc->sc_otg.sc_bus);
140
141	err = bus_setup_intr(dev, sc->sc_otg.sc_irq_res, INTR_TYPE_TTY | INTR_MPSAFE,
142	    &dwc_otg_filter_interrupt, &dwc_otg_interrupt, sc, &sc->sc_otg.sc_intr_hdl);
143	if (err) {
144		sc->sc_otg.sc_intr_hdl = 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
155	return (0);
156
157error:
158	dwc_otg_detach(dev);
159	return (ENXIO);
160}
161
162static int
163dwc_otg_detach(device_t dev)
164{
165	struct dwc_otg_fdt_softc *sc = device_get_softc(dev);
166	int err;
167
168	/* during module unload there are lots of children leftover */
169	device_delete_children(dev);
170
171	if (sc->sc_otg.sc_irq_res && sc->sc_otg.sc_intr_hdl) {
172		/*
173		 * only call dwc_otg_uninit() after dwc_otg_init()
174		 */
175		dwc_otg_uninit(&sc->sc_otg);
176
177		err = bus_teardown_intr(dev, sc->sc_otg.sc_irq_res,
178		    sc->sc_otg.sc_intr_hdl);
179		sc->sc_otg.sc_intr_hdl = NULL;
180	}
181	/* free IRQ channel, if any */
182	if (sc->sc_otg.sc_irq_res) {
183		bus_release_resource(dev, SYS_RES_IRQ, 0,
184		    sc->sc_otg.sc_irq_res);
185		sc->sc_otg.sc_irq_res = NULL;
186	}
187	/* free memory resource, if any */
188	if (sc->sc_otg.sc_io_res) {
189		bus_release_resource(dev, SYS_RES_MEMORY, 0,
190		    sc->sc_otg.sc_io_res);
191		sc->sc_otg.sc_io_res = NULL;
192	}
193	usb_bus_mem_free_all(&sc->sc_otg.sc_bus, NULL);
194
195	return (0);
196}
197
198static device_method_t dwc_otg_methods[] = {
199	/* Device interface */
200	DEVMETHOD(device_probe, dwc_otg_probe),
201	DEVMETHOD(device_attach, dwc_otg_attach),
202	DEVMETHOD(device_detach, dwc_otg_detach),
203	DEVMETHOD(device_suspend, bus_generic_suspend),
204	DEVMETHOD(device_resume, bus_generic_resume),
205	DEVMETHOD(device_shutdown, bus_generic_shutdown),
206
207	DEVMETHOD_END
208};
209
210driver_t dwc_otg_driver = {
211	.name = "dwcotg",
212	.methods = dwc_otg_methods,
213	.size = sizeof(struct dwc_otg_fdt_softc),
214};
215
216static devclass_t dwc_otg_devclass;
217
218DRIVER_MODULE(dwcotg, simplebus, dwc_otg_driver, dwc_otg_devclass, 0, 0);
219MODULE_DEPEND(dwcotg, usb, 1, 1, 1);
220