2 * Copyright (c) 2006 M. Warner Losh. All rights reserved.
3 * Copyright (c) 2016 Emmanuel Vadot <manu@freebsd.org>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * Generic OHCI driver based on AT91 OHCI
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
35 #include <sys/param.h>
36 #include <sys/systm.h>
39 #include <sys/condvar.h>
40 #include <sys/kernel.h>
41 #include <sys/module.h>
43 #include <machine/bus.h>
44 #include <dev/ofw/ofw_bus.h>
45 #include <dev/ofw/ofw_bus_subr.h>
47 #include <dev/usb/usb.h>
48 #include <dev/usb/usbdi.h>
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>
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>
61 #include <dev/extres/clk/clk.h>
62 #include <dev/extres/hwreset/hwreset.h>
65 #include "generic_usb_if.h"
69 TAILQ_ENTRY(clk_list) next;
74 struct generic_ohci_softc {
79 TAILQ_HEAD(, clk_list) clk_list;
83 static int generic_ohci_detach(device_t);
86 generic_ohci_probe(device_t dev)
89 if (!ofw_bus_status_okay(dev))
92 if (!ofw_bus_is_compatible(dev, "generic-ohci"))
95 device_set_desc(dev, "Generic OHCI Controller");
97 return (BUS_PROBE_DEFAULT);
101 generic_ohci_attach(device_t dev)
103 struct generic_ohci_softc *sc = device_get_softc(dev);
107 struct clk_list *clkp;
111 sc->ohci_sc.sc_bus.parent = dev;
112 sc->ohci_sc.sc_bus.devices = sc->ohci_sc.sc_devices;
113 sc->ohci_sc.sc_bus.devices_max = OHCI_MAX_DEVICES;
114 sc->ohci_sc.sc_bus.dma_bits = 32;
116 /* get all DMA memory */
117 if (usb_bus_mem_alloc_all(&sc->ohci_sc.sc_bus,
118 USB_GET_DMA_TAG(dev), &ohci_iterate_hw_softc)) {
123 sc->ohci_sc.sc_io_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
125 if (sc->ohci_sc.sc_io_res == 0) {
130 sc->ohci_sc.sc_io_tag = rman_get_bustag(sc->ohci_sc.sc_io_res);
131 sc->ohci_sc.sc_io_hdl = rman_get_bushandle(sc->ohci_sc.sc_io_res);
132 sc->ohci_sc.sc_io_size = rman_get_size(sc->ohci_sc.sc_io_res);
135 sc->ohci_sc.sc_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
137 if (sc->ohci_sc.sc_irq_res == 0) {
141 sc->ohci_sc.sc_bus.bdev = device_add_child(dev, "usbus", -1);
142 if (sc->ohci_sc.sc_bus.bdev == 0) {
146 device_set_ivars(sc->ohci_sc.sc_bus.bdev, &sc->ohci_sc.sc_bus);
148 strlcpy(sc->ohci_sc.sc_vendor, "Generic",
149 sizeof(sc->ohci_sc.sc_vendor));
151 err = bus_setup_intr(dev, sc->ohci_sc.sc_irq_res,
152 INTR_TYPE_BIO | INTR_MPSAFE, NULL,
153 (driver_intr_t *)ohci_interrupt, sc, &sc->ohci_sc.sc_intr_hdl);
155 sc->ohci_sc.sc_intr_hdl = NULL;
160 TAILQ_INIT(&sc->clk_list);
162 for (off = 0; clk_get_by_ofw_index(dev, off, &clk) == 0; off++) {
163 err = clk_enable(clk);
165 device_printf(dev, "Could not enable clock %s\n",
169 clkp = malloc(sizeof(clkp), M_DEVBUF, M_WAITOK | M_ZERO);
171 TAILQ_INSERT_TAIL(&sc->clk_list, clkp, next);
174 /* De-assert reset */
175 if (hwreset_get_by_ofw_idx(dev, 0, &sc->rst) == 0) {
176 err = hwreset_deassert(sc->rst);
178 device_printf(dev, "Could not de-assert reset %d\n",
185 if (GENERIC_USB_INIT(dev) != 0) {
190 err = ohci_init(&sc->ohci_sc);
192 err = device_probe_and_attach(sc->ohci_sc.sc_bus.bdev);
198 generic_ohci_detach(dev);
203 generic_ohci_detach(device_t dev)
205 struct generic_ohci_softc *sc = device_get_softc(dev);
209 struct clk_list *clk, *clk_tmp;
212 if (sc->ohci_sc.sc_bus.bdev) {
213 bdev = sc->ohci_sc.sc_bus.bdev;
215 device_delete_child(dev, bdev);
218 /* during module unload there are lots of children leftover */
219 device_delete_children(dev);
222 * Put the controller into reset, then disable clocks and do
223 * the MI tear down. We have to disable the clocks/hardware
224 * after we do the rest of the teardown. We also disable the
225 * clocks in the opposite order we acquire them, but that
226 * doesn't seem to be absolutely necessary. We free up the
227 * clocks after we disable them, so the system could, in
228 * theory, reuse them.
230 bus_space_write_4(sc->ohci_sc.sc_io_tag, sc->ohci_sc.sc_io_hdl,
233 if (sc->ohci_sc.sc_irq_res && sc->ohci_sc.sc_intr_hdl) {
235 * only call ohci_detach() after ohci_init()
237 ohci_detach(&sc->ohci_sc);
239 err = bus_teardown_intr(dev, sc->ohci_sc.sc_irq_res,
240 sc->ohci_sc.sc_intr_hdl);
241 sc->ohci_sc.sc_intr_hdl = NULL;
243 if (sc->ohci_sc.sc_irq_res) {
244 bus_release_resource(dev, SYS_RES_IRQ, 0,
245 sc->ohci_sc.sc_irq_res);
246 sc->ohci_sc.sc_irq_res = NULL;
248 if (sc->ohci_sc.sc_io_res) {
249 bus_release_resource(dev, SYS_RES_MEMORY, 0,
250 sc->ohci_sc.sc_io_res);
251 sc->ohci_sc.sc_io_res = NULL;
253 usb_bus_mem_free_all(&sc->ohci_sc.sc_bus, &ohci_iterate_hw_softc);
257 TAILQ_FOREACH_SAFE(clk, &sc->clk_list, next, clk_tmp) {
258 err = clk_disable(clk->clk);
260 device_printf(dev, "Could not disable clock %s\n",
261 clk_get_name(clk->clk));
262 err = clk_release(clk->clk);
264 device_printf(dev, "Could not release clock %s\n",
265 clk_get_name(clk->clk));
266 TAILQ_REMOVE(&sc->clk_list, clk, next);
270 /* De-assert reset */
272 err = hwreset_assert(sc->rst);
274 device_printf(dev, "Could not assert reset\n");
275 hwreset_release(sc->rst);
279 if (GENERIC_USB_DEINIT(dev) != 0)
285 static device_method_t generic_ohci_methods[] = {
286 /* Device interface */
287 DEVMETHOD(device_probe, generic_ohci_probe),
288 DEVMETHOD(device_attach, generic_ohci_attach),
289 DEVMETHOD(device_detach, generic_ohci_detach),
291 DEVMETHOD(device_suspend, bus_generic_suspend),
292 DEVMETHOD(device_resume, bus_generic_resume),
293 DEVMETHOD(device_shutdown, bus_generic_shutdown),
298 driver_t generic_ohci_driver = {
300 .methods = generic_ohci_methods,
301 .size = sizeof(struct generic_ohci_softc),
304 static devclass_t generic_ohci_devclass;
306 DRIVER_MODULE(ohci, simplebus, generic_ohci_driver,
307 generic_ohci_devclass, 0, 0);
308 MODULE_DEPEND(ohci, usb, 1, 1, 1);