dwc_otg_atmelarm.c revision 232539
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: head/sys/dev/usb/controller/dwc_otg_atmelarm.c 232539 2012-03-05 06:41:44Z hselasky $");
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/usb/usb.h>
50#include <dev/usb/usbdi.h>
51
52#include <dev/usb/usb_core.h>
53#include <dev/usb/usb_busdma.h>
54#include <dev/usb/usb_process.h>
55#include <dev/usb/usb_util.h>
56
57#include <dev/usb/usb_controller.h>
58#include <dev/usb/usb_bus.h>
59
60#include <dev/usb/controller/dwc_otg.h>
61
62static device_probe_t dwc_otg_probe;
63static device_attach_t dwc_otg_attach;
64static device_detach_t dwc_otg_detach;
65
66struct dwc_otg_super_softc {
67	struct dwc_otg_softc sc_otg;	/* must be first */
68};
69
70static int
71dwc_otg_probe(device_t dev)
72{
73	device_set_desc(dev, "DWC OTG 2.0 integrated USB controller");
74	return (0);
75}
76
77static int
78dwc_otg_attach(device_t dev)
79{
80	struct dwc_otg_super_softc *sc = device_get_softc(dev);
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
89	/* get all DMA memory */
90	if (usb_bus_mem_alloc_all(&sc->sc_otg.sc_bus,
91	    USB_GET_DMA_TAG(dev), NULL)) {
92		return (ENOMEM);
93	}
94	rid = 0;
95	sc->sc_otg.sc_io_res =
96	    bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
97
98	if (!(sc->sc_otg.sc_io_res)) {
99		err = ENOMEM;
100		goto error;
101	}
102	sc->sc_otg.sc_io_tag = rman_get_bustag(sc->sc_otg.sc_io_res);
103	sc->sc_otg.sc_io_hdl = rman_get_bushandle(sc->sc_otg.sc_io_res);
104	sc->sc_otg.sc_io_size = rman_get_size(sc->sc_otg.sc_io_res);
105
106	rid = 0;
107	sc->sc_otg.sc_irq_res =
108	    bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
109	if (sc->sc_otg.sc_irq_res == NULL)
110		goto error;
111
112	sc->sc_otg.sc_bus.bdev = device_add_child(dev, "usbus", -1);
113	if (sc->sc_otg.sc_bus.bdev == NULL)
114		goto error;
115
116	device_set_ivars(sc->sc_otg.sc_bus.bdev, &sc->sc_otg.sc_bus);
117
118	err = bus_setup_intr(dev, sc->sc_otg.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
119	    NULL, (driver_intr_t *)dwc_otg_interrupt, sc, &sc->sc_otg.sc_intr_hdl);
120	if (err) {
121		sc->sc_otg.sc_intr_hdl = NULL;
122		goto error;
123	}
124	err = dwc_otg_init(&sc->sc_otg);
125	if (err == 0) {
126		err = device_probe_and_attach(sc->sc_otg.sc_bus.bdev);
127	}
128	if (err)
129		goto error;
130	return (0);
131
132error:
133	dwc_otg_detach(dev);
134	return (ENXIO);
135}
136
137static int
138dwc_otg_detach(device_t dev)
139{
140	struct dwc_otg_super_softc *sc = device_get_softc(dev);
141	device_t bdev;
142	int err;
143
144	if (sc->sc_otg.sc_bus.bdev) {
145		bdev = sc->sc_otg.sc_bus.bdev;
146		device_detach(bdev);
147		device_delete_child(dev, bdev);
148	}
149	/* during module unload there are lots of children leftover */
150	device_delete_children(dev);
151
152	if (sc->sc_otg.sc_irq_res && sc->sc_otg.sc_intr_hdl) {
153		/*
154		 * only call dwc_otg_uninit() after dwc_otg_init()
155		 */
156		dwc_otg_uninit(&sc->sc_otg);
157
158		err = bus_teardown_intr(dev, sc->sc_otg.sc_irq_res,
159		    sc->sc_otg.sc_intr_hdl);
160		sc->sc_otg.sc_intr_hdl = NULL;
161	}
162	/* free IRQ channel, if any */
163	if (sc->sc_otg.sc_irq_res) {
164		bus_release_resource(dev, SYS_RES_IRQ, 0,
165		    sc->sc_otg.sc_irq_res);
166		sc->sc_otg.sc_irq_res = NULL;
167	}
168	/* free memory resource, if any */
169	if (sc->sc_otg.sc_io_res) {
170		bus_release_resource(dev, SYS_RES_MEMORY, 0,
171		    sc->sc_otg.sc_io_res);
172		sc->sc_otg.sc_io_res = NULL;
173	}
174	usb_bus_mem_free_all(&sc->sc_otg.sc_bus, NULL);
175
176	return (0);
177}
178
179static device_method_t dwc_otg_methods[] = {
180	/* Device interface */
181	DEVMETHOD(device_probe, dwc_otg_probe),
182	DEVMETHOD(device_attach, dwc_otg_attach),
183	DEVMETHOD(device_detach, dwc_otg_detach),
184	DEVMETHOD(device_suspend, bus_generic_suspend),
185	DEVMETHOD(device_resume, bus_generic_resume),
186	DEVMETHOD(device_shutdown, bus_generic_shutdown),
187
188	DEVMETHOD_END
189};
190
191static driver_t dwc_otg_driver = {
192	.name = "dwc_otg",
193	.methods = dwc_otg_methods,
194	.size = sizeof(struct dwc_otg_super_softc),
195};
196
197static devclass_t dwc_otg_devclass;
198
199DRIVER_MODULE(dwcotg, atmelarm, dwc_otg_driver, dwc_otg_devclass, 0, 0);
200MODULE_DEPEND(dwcotg, usb, 1, 1, 1);
201