dwc_otg_fdt.c revision 266152
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/10/sys/dev/usb/controller/dwc_otg_fdt.c 266152 2014-05-15 16:11:06Z ian $");
28
29#include <sys/stdint.h>
30#include <sys/stddef.h>
31#include <sys/param.h>
32#include <sys/queue.h>
33#include <sys/types.h>
34#include <sys/systm.h>
35#include <sys/kernel.h>
36#include <sys/bus.h>
37#include <sys/module.h>
38#include <sys/lock.h>
39#include <sys/mutex.h>
40#include <sys/condvar.h>
41#include <sys/sysctl.h>
42#include <sys/sx.h>
43#include <sys/unistd.h>
44#include <sys/callout.h>
45#include <sys/malloc.h>
46#include <sys/priv.h>
47#include <sys/rman.h>
48
49#include <dev/fdt/fdt_common.h>
50#include <dev/ofw/openfirm.h>
51#include <dev/ofw/ofw_bus.h>
52#include <dev/ofw/ofw_bus_subr.h>
53
54#include <dev/usb/usb.h>
55#include <dev/usb/usbdi.h>
56
57#include <dev/usb/usb_core.h>
58#include <dev/usb/usb_busdma.h>
59#include <dev/usb/usb_process.h>
60#include <dev/usb/usb_util.h>
61
62#include <dev/usb/usb_controller.h>
63#include <dev/usb/usb_bus.h>
64
65#include <dev/usb/controller/dwc_otg.h>
66
67static device_probe_t dwc_otg_probe;
68static device_attach_t dwc_otg_attach;
69static device_detach_t dwc_otg_detach;
70
71struct dwc_otg_super_softc {
72	struct dwc_otg_softc sc_otg;	/* must be first */
73};
74
75static int
76dwc_otg_probe(device_t dev)
77{
78
79	if (!ofw_bus_status_okay(dev))
80		return (ENXIO);
81
82	if (!ofw_bus_is_compatible(dev, "synopsys,designware-hs-otg2"))
83		return (ENXIO);
84
85	device_set_desc(dev, "DWC OTG 2.0 integrated USB controller");
86
87	return (0);
88}
89
90static int
91dwc_otg_attach(device_t dev)
92{
93	struct dwc_otg_super_softc *sc = device_get_softc(dev);
94	int err;
95	int rid;
96
97	/* initialise some bus fields */
98	sc->sc_otg.sc_bus.parent = dev;
99	sc->sc_otg.sc_bus.devices = sc->sc_otg.sc_devices;
100	sc->sc_otg.sc_bus.devices_max = DWC_OTG_MAX_DEVICES;
101
102	/* get all DMA memory */
103	if (usb_bus_mem_alloc_all(&sc->sc_otg.sc_bus,
104	    USB_GET_DMA_TAG(dev), NULL)) {
105		return (ENOMEM);
106	}
107	rid = 0;
108	sc->sc_otg.sc_io_res =
109	    bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
110
111	if (!(sc->sc_otg.sc_io_res)) {
112		err = ENOMEM;
113		goto error;
114	}
115	sc->sc_otg.sc_io_tag = rman_get_bustag(sc->sc_otg.sc_io_res);
116	sc->sc_otg.sc_io_hdl = rman_get_bushandle(sc->sc_otg.sc_io_res);
117	sc->sc_otg.sc_io_size = rman_get_size(sc->sc_otg.sc_io_res);
118
119	rid = 0;
120	sc->sc_otg.sc_irq_res =
121	    bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
122	if (sc->sc_otg.sc_irq_res == NULL)
123		goto error;
124
125	sc->sc_otg.sc_bus.bdev = device_add_child(dev, "usbus", -1);
126	if (sc->sc_otg.sc_bus.bdev == NULL)
127		goto error;
128
129	device_set_ivars(sc->sc_otg.sc_bus.bdev, &sc->sc_otg.sc_bus);
130
131	err = bus_setup_intr(dev, sc->sc_otg.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
132	    NULL, (driver_intr_t *)dwc_otg_interrupt, sc, &sc->sc_otg.sc_intr_hdl);
133	if (err) {
134		sc->sc_otg.sc_intr_hdl = NULL;
135		goto error;
136	}
137	err = dwc_otg_init(&sc->sc_otg);
138	if (err == 0) {
139		err = device_probe_and_attach(sc->sc_otg.sc_bus.bdev);
140	}
141	if (err)
142		goto error;
143
144
145	return (0);
146
147error:
148	dwc_otg_detach(dev);
149	return (ENXIO);
150}
151
152static int
153dwc_otg_detach(device_t dev)
154{
155	struct dwc_otg_super_softc *sc = device_get_softc(dev);
156	device_t bdev;
157	int err;
158
159	if (sc->sc_otg.sc_bus.bdev) {
160		bdev = sc->sc_otg.sc_bus.bdev;
161		device_detach(bdev);
162		device_delete_child(dev, bdev);
163	}
164	/* during module unload there are lots of children leftover */
165	device_delete_children(dev);
166
167	if (sc->sc_otg.sc_irq_res && sc->sc_otg.sc_intr_hdl) {
168		/*
169		 * only call dwc_otg_uninit() after dwc_otg_init()
170		 */
171		dwc_otg_uninit(&sc->sc_otg);
172
173		err = bus_teardown_intr(dev, sc->sc_otg.sc_irq_res,
174		    sc->sc_otg.sc_intr_hdl);
175		sc->sc_otg.sc_intr_hdl = NULL;
176	}
177	/* free IRQ channel, if any */
178	if (sc->sc_otg.sc_irq_res) {
179		bus_release_resource(dev, SYS_RES_IRQ, 0,
180		    sc->sc_otg.sc_irq_res);
181		sc->sc_otg.sc_irq_res = NULL;
182	}
183	/* free memory resource, if any */
184	if (sc->sc_otg.sc_io_res) {
185		bus_release_resource(dev, SYS_RES_MEMORY, 0,
186		    sc->sc_otg.sc_io_res);
187		sc->sc_otg.sc_io_res = NULL;
188	}
189	usb_bus_mem_free_all(&sc->sc_otg.sc_bus, NULL);
190
191	return (0);
192}
193
194static device_method_t dwc_otg_methods[] = {
195	/* Device interface */
196	DEVMETHOD(device_probe, dwc_otg_probe),
197	DEVMETHOD(device_attach, dwc_otg_attach),
198	DEVMETHOD(device_detach, dwc_otg_detach),
199	DEVMETHOD(device_suspend, bus_generic_suspend),
200	DEVMETHOD(device_resume, bus_generic_resume),
201	DEVMETHOD(device_shutdown, bus_generic_shutdown),
202
203	DEVMETHOD_END
204};
205
206static driver_t dwc_otg_driver = {
207	.name = "dwcotg",
208	.methods = dwc_otg_methods,
209	.size = sizeof(struct dwc_otg_super_softc),
210};
211
212static devclass_t dwc_otg_devclass;
213
214DRIVER_MODULE(dwcotg, simplebus, dwc_otg_driver, dwc_otg_devclass, 0, 0);
215MODULE_DEPEND(dwcotg, usb, 1, 1, 1);
216