/*-
 * Copyright (c) 2015-2016 Landon Fuller <landon@landonf.org>
 * Copyright (c) 2017 The FreeBSD Foundation
 * All rights reserved.
 *
 * Portions of this software were developed by Landon Fuller
 * 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,
 *    without modification.
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
 *    redistribution must be conditioned upon including a substantially
 *    similar Disclaimer requirement for further binary redistribution.
 *
 * NO WARRANTY
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR 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 DAMAGES.
 */

#include <sys/param.h>
#include <sys/kernel.h>
#include <sys/bus.h>
#include <sys/module.h>
#include <sys/systm.h>

#include <dev/bhnd/bhnd_ids.h>
#include <dev/bhnd/bhndb/bhndbvar.h>
#include <dev/bhnd/bhndb/bhndb_hwdata.h>

#include "sibareg.h"
#include "sibavar.h"

/*
 * Supports attachment of siba(4) bus devices via a bhndb bridge.
 */

struct siba_bhndb_softc;

static int      siba_bhndb_wars_hwup(struct siba_bhndb_softc *sc);

/* siba_bhndb per-instance state */
struct siba_bhndb_softc {
        struct siba_softc       siba;   /**< common siba per-instance state */
        uint32_t                quirks; /**< bus-level quirks */
};

/* siba_bhndb quirks */
enum {
        /** When PCIe-bridged, the D11 core's initiator request
         *  timeout must be disabled to prevent D11 from entering a
         *  RESP_TIMEOUT error state. */
        SIBA_QUIRK_PCIE_D11_SB_TIMEOUT  = (1<<0)
};

/* Bus-level quirks when bridged via a PCI host bridge core */
static struct bhnd_device_quirk pci_bridge_quirks[] = {
        BHND_DEVICE_QUIRK_END
};

/* Bus-level quirks when bridged via a PCIe host bridge core */
static struct bhnd_device_quirk pcie_bridge_quirks[] = {
        BHND_CHIP_QUIRK (4311, HWREV_EQ(2),     SIBA_QUIRK_PCIE_D11_SB_TIMEOUT),
        BHND_CHIP_QUIRK (4312, HWREV_ANY,       SIBA_QUIRK_PCIE_D11_SB_TIMEOUT),
        BHND_DEVICE_QUIRK_END
};

/* Bus-level quirks specific to a particular host bridge core */
static struct bhnd_device bridge_devs[] = {
        BHND_DEVICE(BCM, PCI,   NULL, pci_bridge_quirks),
        BHND_DEVICE(BCM, PCIE,  NULL, pcie_bridge_quirks),
        BHND_DEVICE_END
};

static int
siba_bhndb_probe(device_t dev)
{
        const struct bhnd_chipid        *cid;
        int                              error;

        /* Defer to default probe implementation */
        if ((error = siba_probe(dev)) > 0)
                return (error);

        /* Check bus type */
        cid = BHNDB_GET_CHIPID(device_get_parent(dev), dev);
        if (cid->chip_type != BHND_CHIPTYPE_SIBA)
                return (ENXIO);

        /* Set device description */
        bhnd_set_default_bus_desc(dev, cid);

        return (error);
}

static int
siba_bhndb_attach(device_t dev)
{
        struct siba_bhndb_softc *sc;
        device_t                 hostb;
        int                      error;

        sc = device_get_softc(dev);
        sc->quirks = 0;

        /* Perform initial attach and enumerate our children. */
        if ((error = siba_attach(dev)))
                return (error);

        /* Fetch bus-level quirks required by the host bridge core */
        if ((hostb = bhnd_bus_find_hostb_device(dev)) != NULL) {
                sc->quirks |= bhnd_device_quirks(hostb, bridge_devs,
                    sizeof(bridge_devs[0]));
        }

        /* Apply attach/resume workarounds before any child drivers attach */
        if ((error = siba_bhndb_wars_hwup(sc)))
                goto failed;

        /* Delegate remainder to standard bhnd method implementation */
        if ((error = bhnd_generic_attach(dev)))
                goto failed;

        return (0);

failed:
        siba_detach(dev);
        return (error);
}

static int
siba_bhndb_resume(device_t dev)
{
        struct siba_bhndb_softc *sc;
        int                      error;

        sc = device_get_softc(dev);

        /* Apply attach/resume work-arounds */
        if ((error = siba_bhndb_wars_hwup(sc)))
                return (error);

        /* Call our superclass' implementation */
        return (siba_resume(dev));
}

/* Suspend all references to the device's cfg register blocks */
static void
siba_bhndb_suspend_cfgblocks(device_t dev, struct siba_devinfo *dinfo) {
        for (u_int i = 0; i < dinfo->core_id.num_cfg_blocks; i++) {
                if (dinfo->cfg_res[i] == NULL)
                        continue;

                BHNDB_SUSPEND_RESOURCE(device_get_parent(dev), dev,
                    SYS_RES_MEMORY, dinfo->cfg_res[i]->res);
        }
}

static int
siba_bhndb_suspend_child(device_t dev, device_t child)
{
        struct siba_devinfo     *dinfo;
        int                      error;

        if (device_get_parent(child) != dev)
                BUS_SUSPEND_CHILD(device_get_parent(dev), child);

        dinfo = device_get_ivars(child);

        /* Suspend the child */
        if ((error = bhnd_generic_br_suspend_child(dev, child)))
                return (error);

        /* Suspend resource references to the child's config registers */
        siba_bhndb_suspend_cfgblocks(dev, dinfo);

        return (0);
}

static int
siba_bhndb_resume_child(device_t dev, device_t child)
{
        struct siba_devinfo     *dinfo;
        int                      error;

        if (device_get_parent(child) != dev)
                BUS_SUSPEND_CHILD(device_get_parent(dev), child);

        if (!device_is_suspended(child))
                return (EBUSY);

        dinfo = device_get_ivars(child);

        /* Resume all resource references to the child's config registers */
        for (u_int i = 0; i < dinfo->core_id.num_cfg_blocks; i++) {
                if (dinfo->cfg_res[i] == NULL)
                        continue;

                error = BHNDB_RESUME_RESOURCE(device_get_parent(dev), dev,
                    SYS_RES_MEMORY, dinfo->cfg_res[i]->res);
                if (error) {
                        siba_bhndb_suspend_cfgblocks(dev, dinfo);
                        return (error);
                }
        }

        /* Resume the child */
        if ((error = bhnd_generic_br_resume_child(dev, child))) {
                siba_bhndb_suspend_cfgblocks(dev, dinfo);
                return (error);
        }

        return (0);
}

/* Work-around implementation for SIBA_QUIRK_PCIE_D11_SB_TIMEOUT */
static int
siba_bhndb_wars_pcie_clear_d11_timeout(struct siba_bhndb_softc *sc)
{
        struct siba_devinfo     *dinfo;
        device_t                 d11;
        uint32_t                 imcfg;

        /* Only applicable if there's a D11 core */
        d11 = bhnd_bus_match_child(sc->siba.dev, &(struct bhnd_core_match) {
                BHND_MATCH_CORE(BHND_MFGID_BCM, BHND_COREID_D11),
                BHND_MATCH_CORE_UNIT(0)
        });
        if (d11 == NULL)
                return (0);

        /* Clear initiator timeout in D11's CFG0 block */
        dinfo = device_get_ivars(d11);
        KASSERT(dinfo->cfg_res[0] != NULL, ("missing core config mapping"));

        imcfg = bhnd_bus_read_4(dinfo->cfg_res[0], SIBA_CFG0_IMCONFIGLOW);
        imcfg &= ~(SIBA_IMCL_RTO_MASK|SIBA_IMCL_STO_MASK);

        bhnd_bus_write_4(dinfo->cfg_res[0], SIBA_CFG0_IMCONFIGLOW, imcfg);

        return (0);
}

/**
 * Apply any hardware workarounds that are required upon attach or resume
 * of the bus.
 */
static int
siba_bhndb_wars_hwup(struct siba_bhndb_softc *sc)
{
        int error;

        if (sc->quirks & SIBA_QUIRK_PCIE_D11_SB_TIMEOUT) {
                if ((error = siba_bhndb_wars_pcie_clear_d11_timeout(sc)))
                        return (error);
        }

        return (0);
}

static device_method_t siba_bhndb_methods[] = {
        /* Device interface */
        DEVMETHOD(device_probe,                 siba_bhndb_probe),
        DEVMETHOD(device_attach,                siba_bhndb_attach),
        DEVMETHOD(device_resume,                siba_bhndb_resume),

        /* Bus interface */
        DEVMETHOD(bus_suspend_child,            siba_bhndb_suspend_child),
        DEVMETHOD(bus_resume_child,             siba_bhndb_resume_child),

        DEVMETHOD_END
};

DEFINE_CLASS_2(bhnd, siba_bhndb_driver, siba_bhndb_methods,
    sizeof(struct siba_bhndb_softc), bhnd_bhndb_driver, siba_driver);

DRIVER_MODULE(siba_bhndb, bhndb, siba_bhndb_driver, NULL, NULL);

MODULE_VERSION(siba_bhndb, 1);
MODULE_DEPEND(siba_bhndb, siba, 1, 1, 1);
MODULE_DEPEND(siba_bhndb, bhnd, 1, 1, 1);
MODULE_DEPEND(siba_bhndb, bhndb, 1, 1, 1);