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