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>
63 #include <dev/extres/phy/phy.h>
66 #include "generic_usb_if.h"
70 TAILQ_ENTRY(clk_list) next;
75 struct generic_ohci_softc {
81 TAILQ_HEAD(, clk_list) clk_list;
85 static int generic_ohci_detach(device_t);
88 generic_ohci_probe(device_t dev)
91 if (!ofw_bus_status_okay(dev))
94 if (!ofw_bus_is_compatible(dev, "generic-ohci"))
97 device_set_desc(dev, "Generic OHCI Controller");
99 return (BUS_PROBE_DEFAULT);
103 generic_ohci_attach(device_t dev)
105 struct generic_ohci_softc *sc = device_get_softc(dev);
109 struct clk_list *clkp;
113 sc->ohci_sc.sc_bus.parent = dev;
114 sc->ohci_sc.sc_bus.devices = sc->ohci_sc.sc_devices;
115 sc->ohci_sc.sc_bus.devices_max = OHCI_MAX_DEVICES;
116 sc->ohci_sc.sc_bus.dma_bits = 32;
118 /* get all DMA memory */
119 if (usb_bus_mem_alloc_all(&sc->ohci_sc.sc_bus,
120 USB_GET_DMA_TAG(dev), &ohci_iterate_hw_softc)) {
125 sc->ohci_sc.sc_io_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
127 if (sc->ohci_sc.sc_io_res == 0) {
132 sc->ohci_sc.sc_io_tag = rman_get_bustag(sc->ohci_sc.sc_io_res);
133 sc->ohci_sc.sc_io_hdl = rman_get_bushandle(sc->ohci_sc.sc_io_res);
134 sc->ohci_sc.sc_io_size = rman_get_size(sc->ohci_sc.sc_io_res);
137 sc->ohci_sc.sc_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
139 if (sc->ohci_sc.sc_irq_res == 0) {
143 sc->ohci_sc.sc_bus.bdev = device_add_child(dev, "usbus", -1);
144 if (sc->ohci_sc.sc_bus.bdev == 0) {
148 device_set_ivars(sc->ohci_sc.sc_bus.bdev, &sc->ohci_sc.sc_bus);
150 strlcpy(sc->ohci_sc.sc_vendor, "Generic",
151 sizeof(sc->ohci_sc.sc_vendor));
153 err = bus_setup_intr(dev, sc->ohci_sc.sc_irq_res,
154 INTR_TYPE_BIO | INTR_MPSAFE, NULL,
155 (driver_intr_t *)ohci_interrupt, sc, &sc->ohci_sc.sc_intr_hdl);
157 sc->ohci_sc.sc_intr_hdl = NULL;
162 TAILQ_INIT(&sc->clk_list);
164 for (off = 0; clk_get_by_ofw_index(dev, 0, off, &clk) == 0; off++) {
165 err = clk_enable(clk);
167 device_printf(dev, "Could not enable clock %s\n",
171 clkp = malloc(sizeof(*clkp), M_DEVBUF, M_WAITOK | M_ZERO);
173 TAILQ_INSERT_TAIL(&sc->clk_list, clkp, next);
176 /* De-assert reset */
177 if (hwreset_get_by_ofw_idx(dev, 0, 0, &sc->rst) == 0) {
178 err = hwreset_deassert(sc->rst);
180 device_printf(dev, "Could not de-assert reset %d\n",
187 if (phy_get_by_ofw_name(dev, 0, "usb", &sc->phy) == 0) {
188 err = phy_enable(dev, sc->phy);
190 device_printf(dev, "Could not enable phy\n");
196 if (GENERIC_USB_INIT(dev) != 0) {
201 err = ohci_init(&sc->ohci_sc);
203 err = device_probe_and_attach(sc->ohci_sc.sc_bus.bdev);
209 generic_ohci_detach(dev);
214 generic_ohci_detach(device_t dev)
216 struct generic_ohci_softc *sc = device_get_softc(dev);
220 struct clk_list *clk, *clk_tmp;
223 if (sc->ohci_sc.sc_bus.bdev) {
224 bdev = sc->ohci_sc.sc_bus.bdev;
226 device_delete_child(dev, bdev);
229 /* during module unload there are lots of children leftover */
230 device_delete_children(dev);
233 * Put the controller into reset, then disable clocks and do
234 * the MI tear down. We have to disable the clocks/hardware
235 * after we do the rest of the teardown. We also disable the
236 * clocks in the opposite order we acquire them, but that
237 * doesn't seem to be absolutely necessary. We free up the
238 * clocks after we disable them, so the system could, in
239 * theory, reuse them.
241 bus_space_write_4(sc->ohci_sc.sc_io_tag, sc->ohci_sc.sc_io_hdl,
244 if (sc->ohci_sc.sc_irq_res && sc->ohci_sc.sc_intr_hdl) {
246 * only call ohci_detach() after ohci_init()
248 ohci_detach(&sc->ohci_sc);
250 err = bus_teardown_intr(dev, sc->ohci_sc.sc_irq_res,
251 sc->ohci_sc.sc_intr_hdl);
252 sc->ohci_sc.sc_intr_hdl = NULL;
254 if (sc->ohci_sc.sc_irq_res) {
255 bus_release_resource(dev, SYS_RES_IRQ, 0,
256 sc->ohci_sc.sc_irq_res);
257 sc->ohci_sc.sc_irq_res = NULL;
259 if (sc->ohci_sc.sc_io_res) {
260 bus_release_resource(dev, SYS_RES_MEMORY, 0,
261 sc->ohci_sc.sc_io_res);
262 sc->ohci_sc.sc_io_res = NULL;
264 usb_bus_mem_free_all(&sc->ohci_sc.sc_bus, &ohci_iterate_hw_softc);
269 err = phy_disable(dev, sc->phy);
271 device_printf(dev, "Could not disable phy\n");
272 phy_release(sc->phy);
276 TAILQ_FOREACH_SAFE(clk, &sc->clk_list, next, clk_tmp) {
277 err = clk_disable(clk->clk);
279 device_printf(dev, "Could not disable clock %s\n",
280 clk_get_name(clk->clk));
281 err = clk_release(clk->clk);
283 device_printf(dev, "Could not release clock %s\n",
284 clk_get_name(clk->clk));
285 TAILQ_REMOVE(&sc->clk_list, clk, next);
289 /* De-assert reset */
291 err = hwreset_assert(sc->rst);
293 device_printf(dev, "Could not assert reset\n");
294 hwreset_release(sc->rst);
298 if (GENERIC_USB_DEINIT(dev) != 0)
304 static device_method_t generic_ohci_methods[] = {
305 /* Device interface */
306 DEVMETHOD(device_probe, generic_ohci_probe),
307 DEVMETHOD(device_attach, generic_ohci_attach),
308 DEVMETHOD(device_detach, generic_ohci_detach),
310 DEVMETHOD(device_suspend, bus_generic_suspend),
311 DEVMETHOD(device_resume, bus_generic_resume),
312 DEVMETHOD(device_shutdown, bus_generic_shutdown),
317 driver_t generic_ohci_driver = {
319 .methods = generic_ohci_methods,
320 .size = sizeof(struct generic_ohci_softc),
323 static devclass_t generic_ohci_devclass;
325 DRIVER_MODULE(ohci, simplebus, generic_ohci_driver,
326 generic_ohci_devclass, 0, 0);
327 MODULE_DEPEND(ohci, usb, 1, 1, 1);