d3bf5efc1f
When detaching device trees parent devices must be detached prior to detaching its children. This is because parent devices can have pointers to the child devices in their softcs which are not invalidated by device_delete_child(). This can cause use after free issues and panic(). Device drivers implementing trees, must ensure its detach function detaches or deletes all its children before returning. While at it remove now redundant device_detach() calls before device_delete_child() and device_delete_children(), mostly in the USB controller drivers. Tested by: Jan Henrik Sylvester <me@janh.de> Reviewed by: jhb Differential Revision: https://reviews.freebsd.org/D8070 MFC after: 2 weeks
362 lines
9.7 KiB
C
362 lines
9.7 KiB
C
/*-
|
|
* Copyright (c) 2012 Ganbold Tsagaankhuu <ganbold@freebsd.org>
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
* SUCH DAMAGE.
|
|
*/
|
|
|
|
/*
|
|
* Allwinner A10 attachment driver for the USB Enhanced Host Controller.
|
|
*/
|
|
|
|
#include <sys/cdefs.h>
|
|
__FBSDID("$FreeBSD$");
|
|
|
|
#include "opt_bus.h"
|
|
|
|
#include <sys/param.h>
|
|
#include <sys/systm.h>
|
|
#include <sys/bus.h>
|
|
#include <sys/rman.h>
|
|
#include <sys/condvar.h>
|
|
#include <sys/kernel.h>
|
|
#include <sys/module.h>
|
|
|
|
#include <machine/bus.h>
|
|
#include <dev/ofw/ofw_bus.h>
|
|
#include <dev/ofw/ofw_bus_subr.h>
|
|
|
|
#include <dev/usb/usb.h>
|
|
#include <dev/usb/usbdi.h>
|
|
|
|
#include <dev/usb/usb_core.h>
|
|
#include <dev/usb/usb_busdma.h>
|
|
#include <dev/usb/usb_process.h>
|
|
#include <dev/usb/usb_util.h>
|
|
|
|
#include <dev/usb/usb_controller.h>
|
|
#include <dev/usb/usb_bus.h>
|
|
#include <dev/usb/controller/ehci.h>
|
|
#include <dev/usb/controller/ehcireg.h>
|
|
|
|
#include <arm/allwinner/aw_machdep.h>
|
|
#include <dev/extres/clk/clk.h>
|
|
#include <dev/extres/hwreset/hwreset.h>
|
|
#include <dev/extres/phy/phy.h>
|
|
|
|
#define EHCI_HC_DEVSTR "Allwinner Integrated USB 2.0 controller"
|
|
|
|
#define SW_USB_PMU_IRQ_ENABLE 0x800
|
|
|
|
#define SW_SDRAM_REG_HPCR_USB1 (0x250 + ((1 << 2) * 4))
|
|
#define SW_SDRAM_REG_HPCR_USB2 (0x250 + ((1 << 2) * 5))
|
|
#define SW_SDRAM_BP_HPCR_ACCESS (1 << 0)
|
|
|
|
#define SW_ULPI_BYPASS (1 << 0)
|
|
#define SW_AHB_INCRX_ALIGN (1 << 8)
|
|
#define SW_AHB_INCR4 (1 << 9)
|
|
#define SW_AHB_INCR8 (1 << 10)
|
|
|
|
#define USB_CONF(d) \
|
|
(void *)ofw_bus_search_compatible((d), compat_data)->ocd_data
|
|
|
|
#define A10_READ_4(sc, reg) \
|
|
bus_space_read_4((sc)->sc_io_tag, (sc)->sc_io_hdl, reg)
|
|
|
|
#define A10_WRITE_4(sc, reg, data) \
|
|
bus_space_write_4((sc)->sc_io_tag, (sc)->sc_io_hdl, reg, data)
|
|
|
|
static device_attach_t a10_ehci_attach;
|
|
static device_detach_t a10_ehci_detach;
|
|
|
|
struct aw_ehci_softc {
|
|
ehci_softc_t sc;
|
|
clk_t clk;
|
|
hwreset_t rst;
|
|
phy_t phy;
|
|
};
|
|
|
|
struct aw_ehci_conf {
|
|
bool sdram_init;
|
|
};
|
|
|
|
static const struct aw_ehci_conf a10_ehci_conf = {
|
|
.sdram_init = true,
|
|
};
|
|
|
|
static const struct aw_ehci_conf a31_ehci_conf = {
|
|
.sdram_init = false,
|
|
};
|
|
|
|
static struct ofw_compat_data compat_data[] = {
|
|
{ "allwinner,sun4i-a10-ehci", (uintptr_t)&a10_ehci_conf },
|
|
{ "allwinner,sun5i-a13-ehci", (uintptr_t)&a10_ehci_conf },
|
|
{ "allwinner,sun6i-a31-ehci", (uintptr_t)&a31_ehci_conf },
|
|
{ "allwinner,sun7i-a20-ehci", (uintptr_t)&a10_ehci_conf },
|
|
{ "allwinner,sun8i-a83t-ehci", (uintptr_t)&a31_ehci_conf },
|
|
{ "allwinner,sun8i-h3-ehci", (uintptr_t)&a31_ehci_conf },
|
|
{ NULL, (uintptr_t)NULL }
|
|
};
|
|
|
|
static int
|
|
a10_ehci_probe(device_t self)
|
|
{
|
|
|
|
if (!ofw_bus_status_okay(self))
|
|
return (ENXIO);
|
|
|
|
if (ofw_bus_search_compatible(self, compat_data)->ocd_data == 0)
|
|
return (ENXIO);
|
|
|
|
device_set_desc(self, EHCI_HC_DEVSTR);
|
|
|
|
return (BUS_PROBE_DEFAULT);
|
|
}
|
|
|
|
static int
|
|
a10_ehci_attach(device_t self)
|
|
{
|
|
struct aw_ehci_softc *aw_sc = device_get_softc(self);
|
|
ehci_softc_t *sc = &aw_sc->sc;
|
|
const struct aw_ehci_conf *conf;
|
|
bus_space_handle_t bsh;
|
|
int err;
|
|
int rid;
|
|
uint32_t reg_value = 0;
|
|
|
|
conf = USB_CONF(self);
|
|
|
|
/* initialise some bus fields */
|
|
sc->sc_bus.parent = self;
|
|
sc->sc_bus.devices = sc->sc_devices;
|
|
sc->sc_bus.devices_max = EHCI_MAX_DEVICES;
|
|
sc->sc_bus.dma_bits = 32;
|
|
|
|
/* get all DMA memory */
|
|
if (usb_bus_mem_alloc_all(&sc->sc_bus,
|
|
USB_GET_DMA_TAG(self), &ehci_iterate_hw_softc)) {
|
|
return (ENOMEM);
|
|
}
|
|
|
|
sc->sc_bus.usbrev = USB_REV_2_0;
|
|
|
|
rid = 0;
|
|
sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid, RF_ACTIVE);
|
|
if (!sc->sc_io_res) {
|
|
device_printf(self, "Could not map memory\n");
|
|
goto error;
|
|
}
|
|
|
|
sc->sc_io_tag = rman_get_bustag(sc->sc_io_res);
|
|
sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res);
|
|
bsh = rman_get_bushandle(sc->sc_io_res);
|
|
|
|
sc->sc_io_size = rman_get_size(sc->sc_io_res);
|
|
|
|
if (bus_space_subregion(sc->sc_io_tag, bsh, 0x00,
|
|
sc->sc_io_size, &sc->sc_io_hdl) != 0)
|
|
panic("%s: unable to subregion USB host registers",
|
|
device_get_name(self));
|
|
|
|
rid = 0;
|
|
sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid,
|
|
RF_SHAREABLE | RF_ACTIVE);
|
|
if (sc->sc_irq_res == NULL) {
|
|
device_printf(self, "Could not allocate irq\n");
|
|
goto error;
|
|
}
|
|
sc->sc_bus.bdev = device_add_child(self, "usbus", -1);
|
|
if (!sc->sc_bus.bdev) {
|
|
device_printf(self, "Could not add USB device\n");
|
|
goto error;
|
|
}
|
|
device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
|
|
device_set_desc(sc->sc_bus.bdev, EHCI_HC_DEVSTR);
|
|
|
|
sprintf(sc->sc_vendor, "Allwinner");
|
|
|
|
err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
|
|
NULL, (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl);
|
|
if (err) {
|
|
device_printf(self, "Could not setup irq, %d\n", err);
|
|
sc->sc_intr_hdl = NULL;
|
|
goto error;
|
|
}
|
|
|
|
sc->sc_flags |= EHCI_SCFLG_DONTRESET;
|
|
|
|
/* De-assert reset */
|
|
if (hwreset_get_by_ofw_idx(self, 0, 0, &aw_sc->rst) == 0) {
|
|
err = hwreset_deassert(aw_sc->rst);
|
|
if (err != 0) {
|
|
device_printf(self, "Could not de-assert reset\n");
|
|
goto error;
|
|
}
|
|
}
|
|
|
|
/* Enable clock for USB */
|
|
err = clk_get_by_ofw_index(self, 0, 0, &aw_sc->clk);
|
|
if (err != 0) {
|
|
device_printf(self, "Could not get clock\n");
|
|
goto error;
|
|
}
|
|
err = clk_enable(aw_sc->clk);
|
|
if (err != 0) {
|
|
device_printf(self, "Could not enable clock\n");
|
|
goto error;
|
|
}
|
|
|
|
/* Enable USB PHY */
|
|
err = phy_get_by_ofw_name(self, 0, "usb", &aw_sc->phy);
|
|
if (err != 0) {
|
|
device_printf(self, "Could not get phy\n");
|
|
goto error;
|
|
}
|
|
err = phy_enable(self, aw_sc->phy);
|
|
if (err != 0) {
|
|
device_printf(self, "Could not enable phy\n");
|
|
goto error;
|
|
}
|
|
|
|
/* Enable passby */
|
|
reg_value = A10_READ_4(sc, SW_USB_PMU_IRQ_ENABLE);
|
|
reg_value |= SW_AHB_INCR8; /* AHB INCR8 enable */
|
|
reg_value |= SW_AHB_INCR4; /* AHB burst type INCR4 enable */
|
|
reg_value |= SW_AHB_INCRX_ALIGN; /* AHB INCRX align enable */
|
|
reg_value |= SW_ULPI_BYPASS; /* ULPI bypass enable */
|
|
A10_WRITE_4(sc, SW_USB_PMU_IRQ_ENABLE, reg_value);
|
|
|
|
/* Configure port */
|
|
if (conf->sdram_init) {
|
|
reg_value = A10_READ_4(sc, SW_SDRAM_REG_HPCR_USB2);
|
|
reg_value |= SW_SDRAM_BP_HPCR_ACCESS;
|
|
A10_WRITE_4(sc, SW_SDRAM_REG_HPCR_USB2, reg_value);
|
|
}
|
|
|
|
err = ehci_init(sc);
|
|
if (!err) {
|
|
err = device_probe_and_attach(sc->sc_bus.bdev);
|
|
}
|
|
if (err) {
|
|
device_printf(self, "USB init failed err=%d\n", err);
|
|
goto error;
|
|
}
|
|
return (0);
|
|
|
|
error:
|
|
if (aw_sc->clk)
|
|
clk_release(aw_sc->clk);
|
|
a10_ehci_detach(self);
|
|
return (ENXIO);
|
|
}
|
|
|
|
static int
|
|
a10_ehci_detach(device_t self)
|
|
{
|
|
struct aw_ehci_softc *aw_sc = device_get_softc(self);
|
|
ehci_softc_t *sc = &aw_sc->sc;
|
|
const struct aw_ehci_conf *conf;
|
|
int err;
|
|
uint32_t reg_value = 0;
|
|
|
|
conf = USB_CONF(self);
|
|
|
|
/* during module unload there are lots of children leftover */
|
|
device_delete_children(self);
|
|
|
|
if (sc->sc_irq_res && sc->sc_intr_hdl) {
|
|
/*
|
|
* only call ehci_detach() after ehci_init()
|
|
*/
|
|
ehci_detach(sc);
|
|
|
|
err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl);
|
|
|
|
if (err)
|
|
/* XXX or should we panic? */
|
|
device_printf(self, "Could not tear down irq, %d\n",
|
|
err);
|
|
sc->sc_intr_hdl = NULL;
|
|
}
|
|
|
|
if (sc->sc_irq_res) {
|
|
bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res);
|
|
sc->sc_irq_res = NULL;
|
|
}
|
|
if (sc->sc_io_res) {
|
|
bus_release_resource(self, SYS_RES_MEMORY, 0,
|
|
sc->sc_io_res);
|
|
sc->sc_io_res = NULL;
|
|
}
|
|
usb_bus_mem_free_all(&sc->sc_bus, &ehci_iterate_hw_softc);
|
|
|
|
/* Disable configure port */
|
|
if (conf->sdram_init) {
|
|
reg_value = A10_READ_4(sc, SW_SDRAM_REG_HPCR_USB2);
|
|
reg_value &= ~SW_SDRAM_BP_HPCR_ACCESS;
|
|
A10_WRITE_4(sc, SW_SDRAM_REG_HPCR_USB2, reg_value);
|
|
}
|
|
|
|
/* Disable passby */
|
|
reg_value = A10_READ_4(sc, SW_USB_PMU_IRQ_ENABLE);
|
|
reg_value &= ~SW_AHB_INCR8; /* AHB INCR8 disable */
|
|
reg_value &= ~SW_AHB_INCR4; /* AHB burst type INCR4 disable */
|
|
reg_value &= ~SW_AHB_INCRX_ALIGN; /* AHB INCRX align disable */
|
|
reg_value &= ~SW_ULPI_BYPASS; /* ULPI bypass disable */
|
|
A10_WRITE_4(sc, SW_USB_PMU_IRQ_ENABLE, reg_value);
|
|
|
|
/* Disable clock for USB */
|
|
clk_disable(aw_sc->clk);
|
|
clk_release(aw_sc->clk);
|
|
|
|
/* Assert reset */
|
|
if (aw_sc->rst != NULL) {
|
|
hwreset_assert(aw_sc->rst);
|
|
hwreset_release(aw_sc->rst);
|
|
}
|
|
|
|
return (0);
|
|
}
|
|
|
|
static device_method_t ehci_methods[] = {
|
|
/* Device interface */
|
|
DEVMETHOD(device_probe, a10_ehci_probe),
|
|
DEVMETHOD(device_attach, a10_ehci_attach),
|
|
DEVMETHOD(device_detach, a10_ehci_detach),
|
|
DEVMETHOD(device_suspend, bus_generic_suspend),
|
|
DEVMETHOD(device_resume, bus_generic_resume),
|
|
DEVMETHOD(device_shutdown, bus_generic_shutdown),
|
|
|
|
DEVMETHOD_END
|
|
};
|
|
|
|
static driver_t ehci_driver = {
|
|
.name = "ehci",
|
|
.methods = ehci_methods,
|
|
.size = sizeof(struct aw_ehci_softc),
|
|
};
|
|
|
|
static devclass_t ehci_devclass;
|
|
|
|
DRIVER_MODULE(ehci, simplebus, ehci_driver, ehci_devclass, 0, 0);
|
|
MODULE_DEPEND(ehci, usb, 1, 1, 1);
|