/*-
 * Copyright (c) 2012 Ganbold Tsagaankhuu <ganbold@freebsd.org>
 * Copyright (c) 2016 The FreeBSD Foundation
 * All rights reserved.
 *
 * This software was developed by Andrew Turner under
 * sponsorship from the FreeBSD Foundation.
 *
 * 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.
 */

/*
 * Generic EHCI driver based on the Allwinner A10 EHCI driver
 */

#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/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 "generic_ehci.h"

int
generic_ehci_attach(device_t self)
{
        ehci_softc_t *sc = device_get_softc(self);
        int err;
        int rid;

        /* 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);
        sc->sc_io_size = rman_get_size(sc->sc_io_res);

        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", DEVICE_UNIT_ANY);
        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);

        strlcpy(sc->sc_vendor, "Generic", sizeof(sc->sc_vendor));

        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;

        err = ehci_init(sc);
        if (!err)
                err = device_probe_and_attach(sc->sc_bus.bdev);
        if (err)
                goto error;

        return (0);

error:
        generic_ehci_detach(self);
        return (ENXIO);
}

int
generic_ehci_detach(device_t self)
{
        ehci_softc_t *sc = device_get_softc(self);
        int err;

        /* during module unload there are lots of children leftover */
        err = bus_generic_detach(self);
        if (err != 0)
                return (err);

        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);

        return (0);
}

static device_method_t ehci_methods[] = {
        /* Device interface */
        DEVMETHOD(device_attach,        generic_ehci_attach),
        DEVMETHOD(device_detach,        generic_ehci_detach),
        DEVMETHOD(device_suspend,       bus_generic_suspend),
        DEVMETHOD(device_resume,        bus_generic_resume),
        DEVMETHOD(device_shutdown,      bus_generic_shutdown),

        DEVMETHOD_END
};

driver_t generic_ehci_driver = {
        .name = "ehci",
        .methods = ehci_methods,
        .size = sizeof(ehci_softc_t),
};