2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2009, Oleksandr Tymoshenko <gonzo@FreeBSD.org>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice unmodified, this list of conditions, and the following
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
33 #include <sys/param.h>
34 #include <sys/systm.h>
37 #include <sys/condvar.h>
38 #include <sys/kernel.h>
39 #include <sys/module.h>
41 #include <dev/usb/usb.h>
42 #include <dev/usb/usbdi.h>
44 #include <dev/usb/usb_core.h>
45 #include <dev/usb/usb_busdma.h>
46 #include <dev/usb/usb_process.h>
47 #include <dev/usb/usb_util.h>
49 #include <dev/usb/usb_controller.h>
50 #include <dev/usb/usb_bus.h>
51 #include <dev/usb/controller/ohci.h>
52 #include <dev/usb/controller/ohcireg.h>
54 #include <mips/atheros/ar71xxreg.h> /* for stuff in ar71xx_cpudef.h */
55 #include <mips/atheros/ar71xx_cpudef.h>
57 static int ar71xx_ohci_attach(device_t dev);
58 static int ar71xx_ohci_detach(device_t dev);
59 static int ar71xx_ohci_probe(device_t dev);
61 struct ar71xx_ohci_softc
63 struct ohci_softc sc_ohci;
67 ar71xx_ohci_probe(device_t dev)
69 device_set_desc(dev, "AR71XX integrated OHCI controller");
70 return (BUS_PROBE_DEFAULT);
74 ar71xx_ohci_intr(void *arg)
77 /* XXX TODO: should really see if this was our interrupt.. */
78 ar71xx_device_flush_ddr(AR71XX_CPU_DDR_FLUSH_USB);
83 ar71xx_ohci_attach(device_t dev)
85 struct ar71xx_ohci_softc *sc = device_get_softc(dev);
89 /* initialise some bus fields */
90 sc->sc_ohci.sc_bus.parent = dev;
91 sc->sc_ohci.sc_bus.devices = sc->sc_ohci.sc_devices;
92 sc->sc_ohci.sc_bus.devices_max = OHCI_MAX_DEVICES;
93 sc->sc_ohci.sc_bus.dma_bits = 32;
95 /* get all DMA memory */
96 if (usb_bus_mem_alloc_all(&sc->sc_ohci.sc_bus,
97 USB_GET_DMA_TAG(dev), &ohci_iterate_hw_softc)) {
101 sc->sc_ohci.sc_dev = dev;
104 sc->sc_ohci.sc_io_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
106 if (sc->sc_ohci.sc_io_res == NULL) {
110 sc->sc_ohci.sc_io_tag = rman_get_bustag(sc->sc_ohci.sc_io_res);
111 sc->sc_ohci.sc_io_hdl = rman_get_bushandle(sc->sc_ohci.sc_io_res);
112 sc->sc_ohci.sc_io_size = rman_get_size(sc->sc_ohci.sc_io_res);
115 sc->sc_ohci.sc_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
117 if (sc->sc_ohci.sc_irq_res == NULL) {
121 sc->sc_ohci.sc_bus.bdev = device_add_child(dev, "usbus", -1);
122 if (sc->sc_ohci.sc_bus.bdev == NULL) {
126 device_set_ivars(sc->sc_ohci.sc_bus.bdev, &sc->sc_ohci.sc_bus);
128 err = bus_setup_intr(dev, sc->sc_ohci.sc_irq_res,
129 INTR_TYPE_BIO | INTR_MPSAFE, NULL,
130 ar71xx_ohci_intr, sc, &sc->sc_ohci.sc_intr_hdl);
136 strlcpy(sc->sc_ohci.sc_vendor, "Atheros", sizeof(sc->sc_ohci.sc_vendor));
138 bus_space_write_4(sc->sc_ohci.sc_io_tag, sc->sc_ohci.sc_io_hdl, OHCI_CONTROL, 0);
140 err = ohci_init(&sc->sc_ohci);
142 err = device_probe_and_attach(sc->sc_ohci.sc_bus.bdev);
150 ar71xx_ohci_detach(dev);
157 ar71xx_ohci_detach(device_t dev)
159 struct ar71xx_ohci_softc *sc = device_get_softc(dev);
161 /* during module unload there are lots of children leftover */
162 device_delete_children(dev);
165 * Put the controller into reset, then disable clocks and do
166 * the MI tear down. We have to disable the clocks/hardware
167 * after we do the rest of the teardown. We also disable the
168 * clocks in the opposite order we acquire them, but that
169 * doesn't seem to be absolutely necessary. We free up the
170 * clocks after we disable them, so the system could, in
171 * theory, reuse them.
173 bus_space_write_4(sc->sc_ohci.sc_io_tag, sc->sc_ohci.sc_io_hdl,
176 if (sc->sc_ohci.sc_intr_hdl) {
177 bus_teardown_intr(dev, sc->sc_ohci.sc_irq_res, sc->sc_ohci.sc_intr_hdl);
178 sc->sc_ohci.sc_intr_hdl = NULL;
181 if (sc->sc_ohci.sc_irq_res && sc->sc_ohci.sc_intr_hdl) {
183 * only call ohci_detach() after ohci_init()
185 ohci_detach(&sc->sc_ohci);
187 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->sc_ohci.sc_irq_res);
188 sc->sc_ohci.sc_irq_res = NULL;
190 if (sc->sc_ohci.sc_io_res) {
191 bus_release_resource(dev, SYS_RES_MEMORY, 0, sc->sc_ohci.sc_io_res);
192 sc->sc_ohci.sc_io_res = NULL;
193 sc->sc_ohci.sc_io_tag = 0;
194 sc->sc_ohci.sc_io_hdl = 0;
196 usb_bus_mem_free_all(&sc->sc_ohci.sc_bus, &ohci_iterate_hw_softc);
201 static device_method_t ohci_methods[] = {
202 /* Device interface */
203 DEVMETHOD(device_probe, ar71xx_ohci_probe),
204 DEVMETHOD(device_attach, ar71xx_ohci_attach),
205 DEVMETHOD(device_detach, ar71xx_ohci_detach),
206 DEVMETHOD(device_suspend, bus_generic_suspend),
207 DEVMETHOD(device_resume, bus_generic_resume),
208 DEVMETHOD(device_shutdown, bus_generic_shutdown),
213 static driver_t ohci_driver = {
215 .methods = ohci_methods,
216 .size = sizeof(struct ar71xx_ohci_softc),
219 static devclass_t ohci_devclass;
221 DRIVER_MODULE(ohci, apb, ohci_driver, ohci_devclass, 0, 0);