1 /*-
2 * Copyright (c) 2008 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 #include <dev/usb/controller/musb_otg.h>
59
60 #include <sys/rman.h>
61
62 static device_probe_t musbotg_probe;
63 static device_attach_t musbotg_attach;
64 static device_detach_t musbotg_detach;
65
66 struct musbotg_super_softc {
67 struct musbotg_softc sc_otg; /* must be first */
68 };
69
70 static void
musbotg_vbus_poll(struct musbotg_super_softc * sc)71 musbotg_vbus_poll(struct musbotg_super_softc *sc)
72 {
73 uint8_t vbus_val = 1; /* fake VBUS on - TODO */
74
75 /* just forward it */
76 musbotg_vbus_interrupt(&sc->sc_otg, vbus_val);
77 }
78
79 static void
musbotg_clocks_on(void * arg)80 musbotg_clocks_on(void *arg)
81 {
82 #if 0
83 struct musbotg_super_softc *sc = arg;
84
85 #endif
86 }
87
88 static void
musbotg_clocks_off(void * arg)89 musbotg_clocks_off(void *arg)
90 {
91 #if 0
92 struct musbotg_super_softc *sc = arg;
93
94 #endif
95 }
96
97 static void
musbotg_wrapper_interrupt(void * arg)98 musbotg_wrapper_interrupt(void *arg)
99 {
100
101 /*
102 * Nothing to do.
103 * Main driver takes care about everything
104 */
105 musbotg_interrupt(arg, 0, 0, 0);
106 }
107
108 static void
musbotg_ep_int_set(struct musbotg_softc * sc,int ep,int on)109 musbotg_ep_int_set(struct musbotg_softc *sc, int ep, int on)
110 {
111 /*
112 * Nothing to do.
113 * Main driver takes care about everything
114 */
115 }
116
117 static int
musbotg_probe(device_t dev)118 musbotg_probe(device_t dev)
119 {
120 device_set_desc(dev, "MUSB OTG integrated USB controller");
121 return (0);
122 }
123
124 static int
musbotg_attach(device_t dev)125 musbotg_attach(device_t dev)
126 {
127 struct musbotg_super_softc *sc = device_get_softc(dev);
128 int err;
129 int rid;
130
131 /* setup MUSB OTG USB controller interface softc */
132 sc->sc_otg.sc_clocks_on = &musbotg_clocks_on;
133 sc->sc_otg.sc_clocks_off = &musbotg_clocks_off;
134 sc->sc_otg.sc_clocks_arg = sc;
135
136 /* initialise some bus fields */
137 sc->sc_otg.sc_bus.parent = dev;
138 sc->sc_otg.sc_bus.devices = sc->sc_otg.sc_devices;
139 sc->sc_otg.sc_bus.devices_max = MUSB2_MAX_DEVICES;
140 sc->sc_otg.sc_bus.dma_bits = 32;
141
142 /* get all DMA memory */
143 if (usb_bus_mem_alloc_all(&sc->sc_otg.sc_bus,
144 USB_GET_DMA_TAG(dev), NULL)) {
145 return (ENOMEM);
146 }
147 rid = 0;
148 sc->sc_otg.sc_io_res =
149 bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
150
151 if (!(sc->sc_otg.sc_io_res)) {
152 err = ENOMEM;
153 goto error;
154 }
155 sc->sc_otg.sc_io_tag = rman_get_bustag(sc->sc_otg.sc_io_res);
156 sc->sc_otg.sc_io_hdl = rman_get_bushandle(sc->sc_otg.sc_io_res);
157 sc->sc_otg.sc_io_size = rman_get_size(sc->sc_otg.sc_io_res);
158
159 rid = 0;
160 sc->sc_otg.sc_irq_res =
161 bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
162 if (!(sc->sc_otg.sc_irq_res)) {
163 goto error;
164 }
165 sc->sc_otg.sc_bus.bdev = device_add_child(dev, "usbus", -1);
166 if (!(sc->sc_otg.sc_bus.bdev)) {
167 goto error;
168 }
169 device_set_ivars(sc->sc_otg.sc_bus.bdev, &sc->sc_otg.sc_bus);
170
171 sc->sc_otg.sc_id = 0;
172 sc->sc_otg.sc_platform_data = sc;
173 sc->sc_otg.sc_mode = MUSB2_DEVICE_MODE;
174
175 #if (__FreeBSD_version >= 700031)
176 err = bus_setup_intr(dev, sc->sc_otg.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
177 NULL, (driver_intr_t *)musbotg_wrapper_interrupt, sc, &sc->sc_otg.sc_intr_hdl);
178 #else
179 err = bus_setup_intr(dev, sc->sc_otg.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
180 (driver_intr_t *)musbotg_wrapper_interrupt, sc, &sc->sc_otg.sc_intr_hdl);
181 #endif
182 if (err) {
183 sc->sc_otg.sc_intr_hdl = NULL;
184 goto error;
185 }
186 err = musbotg_init(&sc->sc_otg);
187 if (!err) {
188 err = device_probe_and_attach(sc->sc_otg.sc_bus.bdev);
189 }
190 if (err) {
191 goto error;
192 } else {
193 /* poll VBUS one time */
194 musbotg_vbus_poll(sc);
195 }
196 return (0);
197
198 error:
199 musbotg_detach(dev);
200 return (ENXIO);
201 }
202
203 static int
musbotg_detach(device_t dev)204 musbotg_detach(device_t dev)
205 {
206 struct musbotg_super_softc *sc = device_get_softc(dev);
207 device_t bdev;
208 int err;
209
210 if (sc->sc_otg.sc_bus.bdev) {
211 bdev = sc->sc_otg.sc_bus.bdev;
212 device_detach(bdev);
213 device_delete_child(dev, bdev);
214 }
215 /* during module unload there are lots of children leftover */
216 device_delete_children(dev);
217
218 if (sc->sc_otg.sc_irq_res && sc->sc_otg.sc_intr_hdl) {
219 /*
220 * only call musbotg_uninit() after musbotg_init()
221 */
222 musbotg_uninit(&sc->sc_otg);
223
224 err = bus_teardown_intr(dev, sc->sc_otg.sc_irq_res,
225 sc->sc_otg.sc_intr_hdl);
226 sc->sc_otg.sc_intr_hdl = NULL;
227 }
228 /* free IRQ channel, if any */
229 if (sc->sc_otg.sc_irq_res) {
230 bus_release_resource(dev, SYS_RES_IRQ, 0,
231 sc->sc_otg.sc_irq_res);
232 sc->sc_otg.sc_irq_res = NULL;
233 }
234 /* free memory resource, if any */
235 if (sc->sc_otg.sc_io_res) {
236 bus_release_resource(dev, SYS_RES_MEMORY, 0,
237 sc->sc_otg.sc_io_res);
238 sc->sc_otg.sc_io_res = NULL;
239 }
240 usb_bus_mem_free_all(&sc->sc_otg.sc_bus, NULL);
241
242 return (0);
243 }
244
245 static device_method_t musbotg_methods[] = {
246 /* Device interface */
247 DEVMETHOD(device_probe, musbotg_probe),
248 DEVMETHOD(device_attach, musbotg_attach),
249 DEVMETHOD(device_detach, musbotg_detach),
250 DEVMETHOD(device_suspend, bus_generic_suspend),
251 DEVMETHOD(device_resume, bus_generic_resume),
252 DEVMETHOD(device_shutdown, bus_generic_shutdown),
253
254 DEVMETHOD_END
255 };
256
257 static driver_t musbotg_driver = {
258 .name = "musbotg",
259 .methods = musbotg_methods,
260 .size = sizeof(struct musbotg_super_softc),
261 };
262
263 static devclass_t musbotg_devclass;
264
265 DRIVER_MODULE(musbotg, atmelarm, musbotg_driver, musbotg_devclass, 0, 0);
266 MODULE_DEPEND(musbotg, usb, 1, 1, 1);
267