1 /*-
2 * Copyright (c) 2006 M. Warner Losh. 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 ``AS IS'' AND ANY EXPRESS OR
14 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
15 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
16 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
17 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
18 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
22 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 */
24
25 #include <sys/cdefs.h>
26 __FBSDID("$FreeBSD$");
27
28 #include <sys/stdint.h>
29 #include <sys/stddef.h>
30 #include <sys/param.h>
31 #include <sys/queue.h>
32 #include <sys/types.h>
33 #include <sys/systm.h>
34 #include <sys/kernel.h>
35 #include <sys/bus.h>
36 #include <sys/module.h>
37 #include <sys/lock.h>
38 #include <sys/mutex.h>
39 #include <sys/condvar.h>
40 #include <sys/sysctl.h>
41 #include <sys/sx.h>
42 #include <sys/unistd.h>
43 #include <sys/callout.h>
44 #include <sys/malloc.h>
45 #include <sys/priv.h>
46
47 #include <dev/usb/usb.h>
48 #include <dev/usb/usbdi.h>
49
50 #include <dev/usb/usb_core.h>
51 #include <dev/usb/usb_busdma.h>
52 #include <dev/usb/usb_process.h>
53 #include <dev/usb/usb_util.h>
54
55 #include <dev/usb/usb_controller.h>
56 #include <dev/usb/usb_bus.h>
57 #include <dev/usb/controller/ohci.h>
58 #include <dev/usb/controller/ohcireg.h>
59
60 #include <sys/rman.h>
61
62 #include <arm/at91/at91_pmcvar.h>
63
64 #define MEM_RID 0
65
66 static device_probe_t ohci_atmelarm_probe;
67 static device_attach_t ohci_atmelarm_attach;
68 static device_detach_t ohci_atmelarm_detach;
69
70 struct at91_ohci_softc {
71 struct ohci_softc sc_ohci; /* must be first */
72 struct at91_pmc_clock *mclk;
73 struct at91_pmc_clock *iclk;
74 struct at91_pmc_clock *fclk;
75 };
76
77 static int
ohci_atmelarm_probe(device_t dev)78 ohci_atmelarm_probe(device_t dev)
79 {
80
81 device_set_desc(dev, "AT91 integrated OHCI controller");
82 return (BUS_PROBE_DEFAULT);
83 }
84
85 static int
ohci_atmelarm_attach(device_t dev)86 ohci_atmelarm_attach(device_t dev)
87 {
88 struct at91_ohci_softc *sc = device_get_softc(dev);
89 int err;
90 int rid;
91
92 /* initialise some bus fields */
93 sc->sc_ohci.sc_bus.parent = dev;
94 sc->sc_ohci.sc_bus.devices = sc->sc_ohci.sc_devices;
95 sc->sc_ohci.sc_bus.devices_max = OHCI_MAX_DEVICES;
96 sc->sc_ohci.sc_bus.dma_bits = 32;
97
98 /* get all DMA memory */
99 if (usb_bus_mem_alloc_all(&sc->sc_ohci.sc_bus,
100 USB_GET_DMA_TAG(dev), &ohci_iterate_hw_softc)) {
101 return (ENOMEM);
102 }
103 sc->mclk = at91_pmc_clock_ref("mck");
104 sc->iclk = at91_pmc_clock_ref("ohci_clk");
105 sc->fclk = at91_pmc_clock_ref("uhpck");
106
107 sc->sc_ohci.sc_dev = dev;
108
109 rid = MEM_RID;
110 sc->sc_ohci.sc_io_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
111 &rid, RF_ACTIVE);
112
113 if (!(sc->sc_ohci.sc_io_res)) {
114 err = ENOMEM;
115 goto error;
116 }
117 sc->sc_ohci.sc_io_tag = rman_get_bustag(sc->sc_ohci.sc_io_res);
118 sc->sc_ohci.sc_io_hdl = rman_get_bushandle(sc->sc_ohci.sc_io_res);
119 sc->sc_ohci.sc_io_size = rman_get_size(sc->sc_ohci.sc_io_res);
120
121 rid = 0;
122 sc->sc_ohci.sc_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
123 RF_ACTIVE);
124 if (!(sc->sc_ohci.sc_irq_res)) {
125 goto error;
126 }
127 sc->sc_ohci.sc_bus.bdev = device_add_child(dev, "usbus", -1);
128 if (!(sc->sc_ohci.sc_bus.bdev)) {
129 goto error;
130 }
131 device_set_ivars(sc->sc_ohci.sc_bus.bdev, &sc->sc_ohci.sc_bus);
132
133 strlcpy(sc->sc_ohci.sc_vendor, "Atmel", sizeof(sc->sc_ohci.sc_vendor));
134
135 err = bus_setup_intr(dev, sc->sc_ohci.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
136 NULL, (driver_intr_t *)ohci_interrupt, sc, &sc->sc_ohci.sc_intr_hdl);
137 if (err) {
138 sc->sc_ohci.sc_intr_hdl = NULL;
139 goto error;
140 }
141 /*
142 * turn on the clocks from the AT91's point of view. Keep the unit in reset.
143 */
144 at91_pmc_clock_enable(sc->mclk);
145 at91_pmc_clock_enable(sc->iclk);
146 at91_pmc_clock_enable(sc->fclk);
147 bus_space_write_4(sc->sc_ohci.sc_io_tag, sc->sc_ohci.sc_io_hdl,
148 OHCI_CONTROL, 0);
149
150 err = ohci_init(&sc->sc_ohci);
151 if (!err) {
152 err = device_probe_and_attach(sc->sc_ohci.sc_bus.bdev);
153 }
154 if (err) {
155 goto error;
156 }
157 return (0);
158
159 error:
160 ohci_atmelarm_detach(dev);
161 return (ENXIO);
162 }
163
164 static int
ohci_atmelarm_detach(device_t dev)165 ohci_atmelarm_detach(device_t dev)
166 {
167 struct at91_ohci_softc *sc = device_get_softc(dev);
168 device_t bdev;
169 int err;
170
171 if (sc->sc_ohci.sc_bus.bdev) {
172 bdev = sc->sc_ohci.sc_bus.bdev;
173 device_detach(bdev);
174 device_delete_child(dev, bdev);
175 }
176 /* during module unload there are lots of children leftover */
177 device_delete_children(dev);
178
179 /*
180 * Put the controller into reset, then disable clocks and do
181 * the MI tear down. We have to disable the clocks/hardware
182 * after we do the rest of the teardown. We also disable the
183 * clocks in the opposite order we acquire them, but that
184 * doesn't seem to be absolutely necessary. We free up the
185 * clocks after we disable them, so the system could, in
186 * theory, reuse them.
187 */
188 bus_space_write_4(sc->sc_ohci.sc_io_tag, sc->sc_ohci.sc_io_hdl,
189 OHCI_CONTROL, 0);
190
191 at91_pmc_clock_disable(sc->fclk);
192 at91_pmc_clock_disable(sc->iclk);
193 at91_pmc_clock_disable(sc->mclk);
194 at91_pmc_clock_deref(sc->fclk);
195 at91_pmc_clock_deref(sc->iclk);
196 at91_pmc_clock_deref(sc->mclk);
197
198 if (sc->sc_ohci.sc_irq_res && sc->sc_ohci.sc_intr_hdl) {
199 /*
200 * only call ohci_detach() after ohci_init()
201 */
202 ohci_detach(&sc->sc_ohci);
203
204 err = bus_teardown_intr(dev, sc->sc_ohci.sc_irq_res, sc->sc_ohci.sc_intr_hdl);
205 sc->sc_ohci.sc_intr_hdl = NULL;
206 }
207 if (sc->sc_ohci.sc_irq_res) {
208 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->sc_ohci.sc_irq_res);
209 sc->sc_ohci.sc_irq_res = NULL;
210 }
211 if (sc->sc_ohci.sc_io_res) {
212 bus_release_resource(dev, SYS_RES_MEMORY, MEM_RID,
213 sc->sc_ohci.sc_io_res);
214 sc->sc_ohci.sc_io_res = NULL;
215 }
216 usb_bus_mem_free_all(&sc->sc_ohci.sc_bus, &ohci_iterate_hw_softc);
217
218 return (0);
219 }
220
221 static device_method_t ohci_methods[] = {
222 /* Device interface */
223 DEVMETHOD(device_probe, ohci_atmelarm_probe),
224 DEVMETHOD(device_attach, ohci_atmelarm_attach),
225 DEVMETHOD(device_detach, ohci_atmelarm_detach),
226 DEVMETHOD(device_suspend, bus_generic_suspend),
227 DEVMETHOD(device_resume, bus_generic_resume),
228 DEVMETHOD(device_shutdown, bus_generic_shutdown),
229
230 DEVMETHOD_END
231 };
232
233 static driver_t ohci_driver = {
234 .name = "ohci",
235 .methods = ohci_methods,
236 .size = sizeof(struct at91_ohci_softc),
237 };
238
239 static devclass_t ohci_devclass;
240
241 DRIVER_MODULE(ohci, atmelarm, ohci_driver, ohci_devclass, 0, 0);
242 MODULE_DEPEND(ohci, usb, 1, 1, 1);
243