root/sys/powerpc/mpc85xx/pci_mpc85xx.c
/*-
 * SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright 2006-2007 by Juniper Networks.
 * Copyright 2008 Semihalf.
 * Copyright 2010 The FreeBSD Foundation
 * All rights reserved.
 *
 * Portions of this software were developed by Semihalf
 * 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.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 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.
 *
 * From: FreeBSD: src/sys/powerpc/mpc85xx/pci_ocp.c,v 1.9 2010/03/23 23:46:28 marcel
 */

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/ktr.h>
#include <sys/sockio.h>
#include <sys/mbuf.h>
#include <sys/malloc.h>
#include <sys/kernel.h>
#include <sys/module.h>
#include <sys/socket.h>
#include <sys/queue.h>
#include <sys/bus.h>
#include <sys/lock.h>
#include <sys/mutex.h>
#include <sys/queue.h>
#include <sys/rman.h>
#include <sys/endian.h>
#include <sys/vmem.h>

#include <vm/vm.h>
#include <vm/pmap.h>

#include <dev/ofw/ofw_pci.h>
#include <dev/ofw/ofw_bus.h>
#include <dev/ofw/ofw_bus_subr.h>
#include <dev/ofw/ofwpci.h>
#include <dev/pci/pcivar.h>
#include <dev/pci/pcireg.h>
#include <dev/pci/pcib_private.h>

#include "ofw_bus_if.h"
#include "pcib_if.h"
#include "pic_if.h"

#include <machine/resource.h>
#include <machine/bus.h>
#include <machine/intr_machdep.h>

#include <powerpc/mpc85xx/mpc85xx.h>

#define REG_CFG_ADDR    0x0000
#define CONFIG_ACCESS_ENABLE    0x80000000

#define REG_CFG_DATA    0x0004
#define REG_INT_ACK     0x0008

#define REG_PEX_IP_BLK_REV1     0x0bf8
#define   IP_MJ_M                 0x0000ff00
#define   IP_MJ_S                 8
#define   IP_MN_M                 0x000000ff
#define   IP_MN_S                 0

#define REG_POTAR(n)    (0x0c00 + 0x20 * (n))
#define REG_POTEAR(n)   (0x0c04 + 0x20 * (n))
#define REG_POWBAR(n)   (0x0c08 + 0x20 * (n))
#define REG_POWAR(n)    (0x0c10 + 0x20 * (n))

#define REG_PITAR(n)    (0x0e00 - 0x20 * (n))
#define REG_PIWBAR(n)   (0x0e08 - 0x20 * (n))
#define REG_PIWBEAR(n)  (0x0e0c - 0x20 * (n))
#define REG_PIWAR(n)    (0x0e10 - 0x20 * (n))
#define   PIWAR_EN        0x80000000
#define   PIWAR_PF        0x40000000
#define   PIWAR_TRGT_M    0x00f00000
#define   PIWAR_TRGT_S    20
#define   PIWAR_TRGT_CCSR         0xe
#define   PIWAR_TRGT_LOCAL        0xf

#define REG_PEX_MES_DR  0x0020
#define REG_PEX_MES_IER 0x0028
#define REG_PEX_ERR_DR  0x0e00
#define REG_PEX_ERR_EN  0x0e08

#define REG_PEX_ERR_DR          0x0e00
#define REG_PEX_ERR_DR_ME       0x80000000
#define REG_PEX_ERR_DR_PCT      0x800000
#define REG_PEX_ERR_DR_PAT      0x400000
#define REG_PEX_ERR_DR_PCAC     0x200000
#define REG_PEX_ERR_DR_PNM      0x100000
#define REG_PEX_ERR_DR_CDNSC    0x80000
#define REG_PEX_ERR_DR_CRSNC    0x40000
#define REG_PEX_ERR_DR_ICCA     0x20000
#define REG_PEX_ERR_DR_IACA     0x10000
#define REG_PEX_ERR_DR_CRST     0x8000
#define REG_PEX_ERR_DR_MIS      0x4000
#define REG_PEX_ERR_DR_IOIS     0x2000
#define REG_PEX_ERR_DR_CIS      0x1000
#define REG_PEX_ERR_DR_CIEP     0x800
#define REG_PEX_ERR_DR_IOIEP    0x400
#define REG_PEX_ERR_DR_OAC      0x200
#define REG_PEX_ERR_DR_IOIA     0x100
#define REG_PEX_ERR_DR_IMBA     0x80
#define REG_PEX_ERR_DR_IIOBA    0x40
#define REG_PEX_ERR_DR_LDDE     0x20
#define REG_PEX_ERR_EN          0x0e08

#define PCIR_LTSSM      0x404
#define LTSSM_STAT_L0   0x16

#define DEVFN(b, s, f)  ((b << 16) | (s << 8) | f)

#define FSL_NUM_MSIS    256     /* 8 registers of 32 bits (8 hardware IRQs) */
#define PCI_SLOT_FIRST  0x1     /* used to be 0x11 but qemu-ppce500 starts from 0x1 */

struct fsl_pcib_softc {
        struct ofw_pci_softc pci_sc;
        device_t        sc_dev;
        struct mtx      sc_cfg_mtx;
        int             sc_ip_maj;
        int             sc_ip_min;

        int             sc_iomem_target;
        bus_addr_t      sc_iomem_start, sc_iomem_end;
        int             sc_ioport_target;
        bus_addr_t      sc_ioport_start, sc_ioport_end;

        struct resource *sc_res;
        bus_space_handle_t sc_bsh;
        bus_space_tag_t sc_bst;
        int             sc_rid;

        struct resource *sc_irq_res;
        void            *sc_ih;

        int             sc_busnr;
        int             sc_pcie;
        uint8_t         sc_pcie_capreg;         /* PCI-E Capability Reg Set */
};

struct fsl_pcib_err_dr {
        const char      *msg;
        uint32_t        err_dr_mask;
};

struct fsl_msi_map {
        SLIST_ENTRY(fsl_msi_map) slist;
        uint32_t        irq_base;
        bus_addr_t      target;
};

SLIST_HEAD(msi_head, fsl_msi_map) fsl_msis = SLIST_HEAD_INITIALIZER(msi_head);

static const struct fsl_pcib_err_dr pci_err[] = {
        {"ME",          REG_PEX_ERR_DR_ME},
        {"PCT",         REG_PEX_ERR_DR_PCT},
        {"PAT",         REG_PEX_ERR_DR_PAT},
        {"PCAC",        REG_PEX_ERR_DR_PCAC},
        {"PNM",         REG_PEX_ERR_DR_PNM},
        {"CDNSC",       REG_PEX_ERR_DR_CDNSC},
        {"CRSNC",       REG_PEX_ERR_DR_CRSNC},
        {"ICCA",        REG_PEX_ERR_DR_ICCA},
        {"IACA",        REG_PEX_ERR_DR_IACA},
        {"CRST",        REG_PEX_ERR_DR_CRST},
        {"MIS",         REG_PEX_ERR_DR_MIS},
        {"IOIS",        REG_PEX_ERR_DR_IOIS},
        {"CIS",         REG_PEX_ERR_DR_CIS},
        {"CIEP",        REG_PEX_ERR_DR_CIEP},
        {"IOIEP",       REG_PEX_ERR_DR_IOIEP},
        {"OAC",         REG_PEX_ERR_DR_OAC},
        {"IOIA",        REG_PEX_ERR_DR_IOIA},
        {"IMBA",        REG_PEX_ERR_DR_IMBA},
        {"IIOBA",       REG_PEX_ERR_DR_IIOBA},
        {"LDDE",        REG_PEX_ERR_DR_LDDE}
};

/* Local forward declerations. */
static uint32_t fsl_pcib_cfgread(struct fsl_pcib_softc *, u_int, u_int, u_int,
    u_int, int);
static void fsl_pcib_cfgwrite(struct fsl_pcib_softc *, u_int, u_int, u_int,
    u_int, uint32_t, int);
static int fsl_pcib_decode_win(phandle_t, struct fsl_pcib_softc *);
static void fsl_pcib_err_init(device_t);
static void fsl_pcib_inbound(struct fsl_pcib_softc *, int, int, uint64_t,
    uint64_t, uint64_t);
static void fsl_pcib_outbound(struct fsl_pcib_softc *, int, int, uint64_t,
    uint64_t, uint64_t);

/* Forward declerations. */
static int fsl_pcib_attach(device_t);
static int fsl_pcib_detach(device_t);
static int fsl_pcib_probe(device_t);

static int fsl_pcib_maxslots(device_t);
static uint32_t fsl_pcib_read_config(device_t, u_int, u_int, u_int, u_int, int);
static void fsl_pcib_write_config(device_t, u_int, u_int, u_int, u_int,
    uint32_t, int);
static int fsl_pcib_alloc_msi(device_t dev, device_t child,
    int count, int maxcount, int *irqs);
static int fsl_pcib_release_msi(device_t dev, device_t child,
    int count, int *irqs);
static int fsl_pcib_alloc_msix(device_t dev, device_t child, int *irq);
static int fsl_pcib_release_msix(device_t dev, device_t child, int irq);
static int fsl_pcib_map_msi(device_t dev, device_t child,
    int irq, uint64_t *addr, uint32_t *data);

static vmem_t *msi_vmem;        /* Global MSI vmem, holds all MSI ranges. */

/*
 * Bus interface definitions.
 */
static device_method_t fsl_pcib_methods[] = {
        /* Device interface */
        DEVMETHOD(device_probe,         fsl_pcib_probe),
        DEVMETHOD(device_attach,        fsl_pcib_attach),
        DEVMETHOD(device_detach,        fsl_pcib_detach),

        /* pcib interface */
        DEVMETHOD(pcib_maxslots,        fsl_pcib_maxslots),
        DEVMETHOD(pcib_read_config,     fsl_pcib_read_config),
        DEVMETHOD(pcib_write_config,    fsl_pcib_write_config),
        DEVMETHOD(pcib_alloc_msi,       fsl_pcib_alloc_msi),
        DEVMETHOD(pcib_release_msi,     fsl_pcib_release_msi),
        DEVMETHOD(pcib_alloc_msix,      fsl_pcib_alloc_msix),
        DEVMETHOD(pcib_release_msix,    fsl_pcib_release_msix),
        DEVMETHOD(pcib_map_msi,         fsl_pcib_map_msi),

        DEVMETHOD_END
};

DEFINE_CLASS_1(pcib, fsl_pcib_driver, fsl_pcib_methods,
    sizeof(struct fsl_pcib_softc), ofw_pcib_driver);
EARLY_DRIVER_MODULE(pcib, ofwbus, fsl_pcib_driver, 0, 0, BUS_PASS_BUS);

static void
fsl_pcib_err_intr(void *v)
{
        struct fsl_pcib_softc *sc;
        device_t dev;
        uint32_t err_reg, clear_reg;
        uint8_t i;

        dev = (device_t)v;
        sc = device_get_softc(dev);

        clear_reg = 0;
        err_reg = bus_space_read_4(sc->sc_bst, sc->sc_bsh, REG_PEX_ERR_DR);

        /* Check which one error occurred */
        for (i = 0; i < sizeof(pci_err)/sizeof(struct fsl_pcib_err_dr); i++) {
                if (err_reg & pci_err[i].err_dr_mask) {
                        device_printf(dev, "PCI %d: report %s error\n",
                            device_get_unit(dev), pci_err[i].msg);
                        clear_reg |= pci_err[i].err_dr_mask;
                }
        }

        /* Clear pending errors */
        bus_space_write_4(sc->sc_bst, sc->sc_bsh, REG_PEX_ERR_DR, clear_reg);
}

static int
fsl_pcib_probe(device_t dev)
{

        if (ofw_bus_get_type(dev) == NULL ||
            strcmp(ofw_bus_get_type(dev), "pci") != 0)
                return (ENXIO);

        if (!(ofw_bus_is_compatible(dev, "fsl,mpc8540-pci") ||
            ofw_bus_is_compatible(dev, "fsl,mpc8540-pcie") ||
            ofw_bus_is_compatible(dev, "fsl,mpc8548-pcie") ||
            ofw_bus_is_compatible(dev, "fsl,p5020-pcie") ||
            ofw_bus_is_compatible(dev, "fsl,p5040-pcie") ||
            ofw_bus_is_compatible(dev, "fsl,qoriq-pcie-v2.2") ||
            ofw_bus_is_compatible(dev, "fsl,qoriq-pcie-v2.4") ||
            ofw_bus_is_compatible(dev, "fsl,qoriq-pcie")))
                return (ENXIO);

        device_set_desc(dev, "Freescale Integrated PCI/PCI-E Controller");
        return (BUS_PROBE_DEFAULT);
}

static int
fsl_pcib_attach(device_t dev)
{
        struct fsl_pcib_softc *sc;
        phandle_t node;
        uint32_t cfgreg, brctl, ipreg;
        int do_reset, error, rid;
        uint8_t ltssm, capptr;

        sc = device_get_softc(dev);
        sc->sc_dev = dev;

        sc->sc_rid = 0;
        sc->sc_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &sc->sc_rid,
            RF_ACTIVE);
        if (sc->sc_res == NULL) {
                device_printf(dev, "could not map I/O memory\n");
                return (ENXIO);
        }
        sc->sc_bst = rman_get_bustag(sc->sc_res);
        sc->sc_bsh = rman_get_bushandle(sc->sc_res);
        sc->sc_busnr = 0;

        ipreg = bus_read_4(sc->sc_res, REG_PEX_IP_BLK_REV1);
        sc->sc_ip_min = (ipreg & IP_MN_M) >> IP_MN_S;
        sc->sc_ip_maj = (ipreg & IP_MJ_M) >> IP_MJ_S;
        mtx_init(&sc->sc_cfg_mtx, "pcicfg", NULL, MTX_SPIN);

        cfgreg = fsl_pcib_cfgread(sc, 0, 0, 0, PCIR_VENDOR, 2);
        if (cfgreg != 0x1057 && cfgreg != 0x1957)
                goto err;

        capptr = fsl_pcib_cfgread(sc, 0, 0, 0, PCIR_CAP_PTR, 1);
        while (capptr != 0) {
                cfgreg = fsl_pcib_cfgread(sc, 0, 0, 0, capptr, 2);
                switch (cfgreg & 0xff) {
                case PCIY_PCIX:
                        break;
                case PCIY_EXPRESS:
                        sc->sc_pcie = 1;
                        sc->sc_pcie_capreg = capptr;
                        break;
                }
                capptr = (cfgreg >> 8) & 0xff;
        }

        node = ofw_bus_get_node(dev);

        /*
         * Initialize generic OF PCI interface (ranges, etc.)
         */

        error = ofw_pcib_init(dev);
        if (error)
                goto err;

        /*
         * Configure decode windows for PCI(E) access.
         */
        if (fsl_pcib_decode_win(node, sc) != 0)
                goto err1;

        cfgreg = fsl_pcib_cfgread(sc, 0, 0, 0, PCIR_COMMAND, 2);
        cfgreg |= PCIM_CMD_SERRESPEN | PCIM_CMD_BUSMASTEREN | PCIM_CMD_MEMEN |
            PCIM_CMD_PORTEN;
        fsl_pcib_cfgwrite(sc, 0, 0, 0, PCIR_COMMAND, cfgreg, 2);

        do_reset = 0;
        resource_int_value("pcib", device_get_unit(dev), "reset", &do_reset);
        if (do_reset) {
                /* Reset the bus.  Needed for Radeon video cards. */
                brctl = fsl_pcib_read_config(sc->sc_dev, 0, 0, 0,
                    PCIR_BRIDGECTL_1, 1);
                brctl |= PCIB_BCR_SECBUS_RESET;
                fsl_pcib_write_config(sc->sc_dev, 0, 0, 0,
                    PCIR_BRIDGECTL_1, brctl, 1);
                DELAY(100000);
                brctl &= ~PCIB_BCR_SECBUS_RESET;
                fsl_pcib_write_config(sc->sc_dev, 0, 0, 0,
                    PCIR_BRIDGECTL_1, brctl, 1);
                DELAY(100000);
        }

        if (sc->sc_pcie) {
                ltssm = fsl_pcib_cfgread(sc, 0, 0, 0, PCIR_LTSSM, 1);
                if (ltssm < LTSSM_STAT_L0) {
                        /* Stay attached, it may change later. */
                        if (bootverbose)
                                printf("PCI %d: no PCIE link, skipping\n",
                                    device_get_unit(dev));
                        return (0);
                }
        }

        /* Allocate irq */
        rid = 0;
        sc->sc_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
            RF_ACTIVE | RF_SHAREABLE);
        if (sc->sc_irq_res == NULL) {
                error = fsl_pcib_detach(dev);
                if (error != 0) {
                        device_printf(dev,
                            "Detach of the driver failed with error %d\n",
                            error);
                }
                return (ENXIO);
        }

        /* Setup interrupt handler */
        error = bus_setup_intr(dev, sc->sc_irq_res, INTR_TYPE_MISC | INTR_MPSAFE,
            NULL, fsl_pcib_err_intr, dev, &sc->sc_ih);
        if (error != 0) {
                device_printf(dev, "Could not setup irq, %d\n", error);
                sc->sc_ih = NULL;
                error = fsl_pcib_detach(dev);
                if (error != 0) {
                        device_printf(dev,
                            "Detach of the driver failed with error %d\n",
                            error);
                }
                return (ENXIO);
        }

        fsl_pcib_err_init(dev);

        return (ofw_pcib_attach(dev));

err1:
        ofw_pcib_fini(dev);
err:
        if (sc->sc_irq_res != NULL)
                bus_release_resource(dev, sc->sc_irq_res);
        if (sc->sc_res != NULL)
                bus_release_resource(dev, sc->sc_res);
        mtx_destroy(&sc->sc_cfg_mtx);

        return (ENXIO);
}

static uint32_t
fsl_pcib_cfgread(struct fsl_pcib_softc *sc, u_int bus, u_int slot, u_int func,
    u_int reg, int bytes)
{
        uint32_t addr, data;

        addr = CONFIG_ACCESS_ENABLE;
        addr |= (bus & 0xff) << 16;
        addr |= (slot & 0x1f) << 11;
        addr |= (func & 0x7) << 8;
        addr |= reg & 0xfc;
        if (sc->sc_pcie)
                addr |= (reg & 0xf00) << 16;

        mtx_lock_spin(&sc->sc_cfg_mtx);
        bus_space_write_4(sc->sc_bst, sc->sc_bsh, REG_CFG_ADDR, addr);

        switch (bytes) {
        case 1:
                data = bus_space_read_1(sc->sc_bst, sc->sc_bsh,
                    REG_CFG_DATA + (reg & 3));
                break;
        case 2:
                data = le16toh(bus_space_read_2(sc->sc_bst, sc->sc_bsh,
                    REG_CFG_DATA + (reg & 2)));
                break;
        case 4:
                data = le32toh(bus_space_read_4(sc->sc_bst, sc->sc_bsh,
                    REG_CFG_DATA));
                break;
        default:
                data = ~0;
                break;
        }
        mtx_unlock_spin(&sc->sc_cfg_mtx);
        return (data);
}

static void
fsl_pcib_cfgwrite(struct fsl_pcib_softc *sc, u_int bus, u_int slot, u_int func,
    u_int reg, uint32_t data, int bytes)
{
        uint32_t addr;

        addr = CONFIG_ACCESS_ENABLE;
        addr |= (bus & 0xff) << 16;
        addr |= (slot & 0x1f) << 11;
        addr |= (func & 0x7) << 8;
        addr |= reg & 0xfc;
        if (sc->sc_pcie)
                addr |= (reg & 0xf00) << 16;

        mtx_lock_spin(&sc->sc_cfg_mtx);
        bus_space_write_4(sc->sc_bst, sc->sc_bsh, REG_CFG_ADDR, addr);

        switch (bytes) {
        case 1:
                bus_space_write_1(sc->sc_bst, sc->sc_bsh,
                    REG_CFG_DATA + (reg & 3), data);
                break;
        case 2:
                bus_space_write_2(sc->sc_bst, sc->sc_bsh,
                    REG_CFG_DATA + (reg & 2), htole16(data));
                break;
        case 4:
                bus_space_write_4(sc->sc_bst, sc->sc_bsh,
                    REG_CFG_DATA, htole32(data));
                break;
        }
        mtx_unlock_spin(&sc->sc_cfg_mtx);
}

#if 0
static void
dump(struct fsl_pcib_softc *sc)
{
        unsigned int i;

#define RD(o)   bus_space_read_4(sc->sc_bst, sc->sc_bsh, o)
        for (i = 0; i < 5; i++) {
                printf("POTAR%u  =0x%08x\n", i, RD(REG_POTAR(i)));
                printf("POTEAR%u =0x%08x\n", i, RD(REG_POTEAR(i)));
                printf("POWBAR%u =0x%08x\n", i, RD(REG_POWBAR(i)));
                printf("POWAR%u  =0x%08x\n", i, RD(REG_POWAR(i)));
        }
        printf("\n");
        for (i = 1; i < 4; i++) {
                printf("PITAR%u  =0x%08x\n", i, RD(REG_PITAR(i)));
                printf("PIWBAR%u =0x%08x\n", i, RD(REG_PIWBAR(i)));
                printf("PIWBEAR%u=0x%08x\n", i, RD(REG_PIWBEAR(i)));
                printf("PIWAR%u  =0x%08x\n", i, RD(REG_PIWAR(i)));
        }
        printf("\n");
#undef RD

        for (i = 0; i < 0x48; i += 4) {
                printf("cfg%02x=0x%08x\n", i, fsl_pcib_cfgread(sc, 0, 0, 0,
                    i, 4));
        }
}
#endif

static int
fsl_pcib_maxslots(device_t dev)
{
        struct fsl_pcib_softc *sc = device_get_softc(dev);

        return ((sc->sc_pcie) ? 0 : PCI_SLOTMAX);
}

static uint32_t
fsl_pcib_read_config(device_t dev, u_int bus, u_int slot, u_int func,
    u_int reg, int bytes)
{
        struct fsl_pcib_softc *sc = device_get_softc(dev);

        if (bus == sc->sc_busnr && !sc->sc_pcie &&
            slot < PCI_SLOT_FIRST)
                return (~0);

        return (fsl_pcib_cfgread(sc, bus, slot, func, reg, bytes));
}

static void
fsl_pcib_write_config(device_t dev, u_int bus, u_int slot, u_int func,
    u_int reg, uint32_t val, int bytes)
{
        struct fsl_pcib_softc *sc = device_get_softc(dev);

        if (bus == sc->sc_busnr && !sc->sc_pcie &&
            slot < PCI_SLOT_FIRST)
                return;
        fsl_pcib_cfgwrite(sc, bus, slot, func, reg, val, bytes);
}

static void
fsl_pcib_inbound(struct fsl_pcib_softc *sc, int wnd, int tgt, uint64_t start,
    uint64_t size, uint64_t pci_start)
{
        uint32_t attr, bar, tar;

        KASSERT(wnd > 0, ("%s: inbound window 0 is invalid", __func__));

        attr = PIWAR_EN;

        switch (tgt) {
        case -1:
                attr &= ~PIWAR_EN;
                break;
        case PIWAR_TRGT_LOCAL:
                attr |= (ffsl(size) - 2);
        default:
                attr |= (tgt << PIWAR_TRGT_S);
                break;
        }
        tar = start >> 12;
        bar = pci_start >> 12;

        bus_space_write_4(sc->sc_bst, sc->sc_bsh, REG_PITAR(wnd), tar);
        bus_space_write_4(sc->sc_bst, sc->sc_bsh, REG_PIWBEAR(wnd), 0);
        bus_space_write_4(sc->sc_bst, sc->sc_bsh, REG_PIWBAR(wnd), bar);
        bus_space_write_4(sc->sc_bst, sc->sc_bsh, REG_PIWAR(wnd), attr);
}

static void
fsl_pcib_outbound(struct fsl_pcib_softc *sc, int wnd, int res, uint64_t start,
    uint64_t size, uint64_t pci_start)
{
        uint32_t attr, bar, tar;

        switch (res) {
        case SYS_RES_MEMORY:
                attr = 0x80044000 | (ffsll(size) - 2);
                break;
        case SYS_RES_IOPORT:
                attr = 0x80088000 | (ffsll(size) - 2);
                break;
        default:
                attr = 0x0004401f;
                break;
        }
        bar = start >> 12;
        tar = pci_start >> 12;

        bus_space_write_4(sc->sc_bst, sc->sc_bsh, REG_POTAR(wnd), tar);
        bus_space_write_4(sc->sc_bst, sc->sc_bsh, REG_POTEAR(wnd), 0);
        bus_space_write_4(sc->sc_bst, sc->sc_bsh, REG_POWBAR(wnd), bar);
        bus_space_write_4(sc->sc_bst, sc->sc_bsh, REG_POWAR(wnd), attr);
}

static void
fsl_pcib_err_init(device_t dev)
{
        struct fsl_pcib_softc *sc;
        uint16_t sec_stat, dsr;
        uint32_t dcr, err_en;

        sc = device_get_softc(dev);

        sec_stat = fsl_pcib_cfgread(sc, 0, 0, 0, PCIR_SECSTAT_1, 2);
        if (sec_stat)
                fsl_pcib_cfgwrite(sc, 0, 0, 0, PCIR_SECSTAT_1, 0xffff, 2);
        if (sc->sc_pcie) {
                /* Clear error bits */
                bus_space_write_4(sc->sc_bst, sc->sc_bsh, REG_PEX_MES_IER,
                    0xffffffff);
                bus_space_write_4(sc->sc_bst, sc->sc_bsh, REG_PEX_MES_DR,
                    0xffffffff);
                bus_space_write_4(sc->sc_bst, sc->sc_bsh, REG_PEX_ERR_DR,
                    0xffffffff);

                dsr = fsl_pcib_cfgread(sc, 0, 0, 0,
                    sc->sc_pcie_capreg + PCIER_DEVICE_STA, 2);
                if (dsr)
                        fsl_pcib_cfgwrite(sc, 0, 0, 0,
                            sc->sc_pcie_capreg + PCIER_DEVICE_STA,
                            0xffff, 2);

                /* Enable all errors reporting */
                err_en = 0x00bfff00;
                bus_space_write_4(sc->sc_bst, sc->sc_bsh, REG_PEX_ERR_EN,
                    err_en);

                /* Enable error reporting: URR, FER, NFER */
                dcr = fsl_pcib_cfgread(sc, 0, 0, 0,
                    sc->sc_pcie_capreg + PCIER_DEVICE_CTL, 4);
                dcr |= PCIEM_CTL_URR_ENABLE | PCIEM_CTL_FER_ENABLE |
                    PCIEM_CTL_NFER_ENABLE;
                fsl_pcib_cfgwrite(sc, 0, 0, 0,
                    sc->sc_pcie_capreg + PCIER_DEVICE_CTL, dcr, 4);
        }
}

static int
fsl_pcib_detach(device_t dev)
{
        struct fsl_pcib_softc *sc;
        int error;

        error = bus_generic_detach(dev);
        if (error != 0)
                return (error);

        sc = device_get_softc(dev);
        ofw_pcib_fini(dev);

        mtx_destroy(&sc->sc_cfg_mtx);

        if (sc->sc_irq_res != NULL)
                bus_release_resource(dev, sc->sc_irq_res);
        if (sc->sc_res != NULL)
                bus_release_resource(dev, sc->sc_res);

        return (0);
}

static int
fsl_pcib_decode_win(phandle_t node, struct fsl_pcib_softc *sc)
{
        device_t dev;
        int error, i, trgt;

        dev = sc->sc_dev;

        fsl_pcib_outbound(sc, 0, -1, 0, 0, 0);

        /*
         * Configure LAW decode windows.
         */
        error = law_pci_target(sc->sc_res, &sc->sc_iomem_target,
            &sc->sc_ioport_target);
        if (error != 0) {
                device_printf(dev, "could not retrieve PCI LAW target info\n");
                return (error);
        }

        for (i = 0; i < sc->pci_sc.sc_nrange; i++) {
                switch (sc->pci_sc.sc_range[i].pci_hi &
                    OFW_PCI_PHYS_HI_SPACEMASK) {
                case OFW_PCI_PHYS_HI_SPACE_CONFIG:
                        continue;
                case OFW_PCI_PHYS_HI_SPACE_IO:
                        trgt = sc->sc_ioport_target;
                        fsl_pcib_outbound(sc, 2, SYS_RES_IOPORT,
                            sc->pci_sc.sc_range[i].host,
                            sc->pci_sc.sc_range[i].size,
                            sc->pci_sc.sc_range[i].pci);
                        sc->sc_ioport_start = sc->pci_sc.sc_range[i].pci;
                        sc->sc_ioport_end = sc->pci_sc.sc_range[i].pci +
                            sc->pci_sc.sc_range[i].size - 1;
                        break;
                case OFW_PCI_PHYS_HI_SPACE_MEM32:
                case OFW_PCI_PHYS_HI_SPACE_MEM64:
                        trgt = sc->sc_iomem_target;
                        fsl_pcib_outbound(sc, 1, SYS_RES_MEMORY,
                            sc->pci_sc.sc_range[i].host,
                            sc->pci_sc.sc_range[i].size,
                            sc->pci_sc.sc_range[i].pci);
                        sc->sc_iomem_start = sc->pci_sc.sc_range[i].pci;
                        sc->sc_iomem_end = sc->pci_sc.sc_range[i].pci +
                            sc->pci_sc.sc_range[i].size - 1;
                        break;
                default:
                        panic("Unknown range type %#x\n",
                            sc->pci_sc.sc_range[i].pci_hi &
                            OFW_PCI_PHYS_HI_SPACEMASK);
                }
                error = law_enable(trgt, sc->pci_sc.sc_range[i].host,
                    sc->pci_sc.sc_range[i].size);
                if (error != 0) {
                        device_printf(dev, "could not program LAW for range "
                            "%d\n", i);
                        return (error);
                }
        }

        /*
         * Set outbout and inbound windows.
         */
        fsl_pcib_outbound(sc, 3, -1, 0, 0, 0);
        fsl_pcib_outbound(sc, 4, -1, 0, 0, 0);

        fsl_pcib_inbound(sc, 1, -1, 0, 0, 0);
        fsl_pcib_inbound(sc, 2, -1, 0, 0, 0);
        fsl_pcib_inbound(sc, 3, PIWAR_TRGT_LOCAL, 0,
            ptoa(Maxmem), 0);

        /* Direct-map the CCSR for MSIs. */
        /* Freescale PCIe 2.x has a dedicated MSI window. */
        /* inbound window 8 makes it hit 0xD00 offset, the MSI window. */
        if (sc->sc_ip_maj >= 2)
                fsl_pcib_inbound(sc, 8, PIWAR_TRGT_CCSR, ccsrbar_pa,
                    ccsrbar_size, ccsrbar_pa);
        else
                fsl_pcib_inbound(sc, 1, PIWAR_TRGT_CCSR, ccsrbar_pa,
                    ccsrbar_size, ccsrbar_pa);

        return (0);
}

static int fsl_pcib_alloc_msi(device_t dev, device_t child,
    int count, int maxcount, int *irqs)
{
        vmem_addr_t start;
        int err, i;

        if (msi_vmem == NULL)
                return (ENODEV);

        err = vmem_xalloc(msi_vmem, count, powerof2(count), 0, 0,
            VMEM_ADDR_MIN, VMEM_ADDR_MAX, M_BESTFIT | M_WAITOK, &start);

        if (err)
                return (err);

        for (i = 0; i < count; i++)
                irqs[i] = start + i;

        return (0);
}

static int fsl_pcib_release_msi(device_t dev, device_t child,
    int count, int *irqs)
{
        if (msi_vmem == NULL)
                return (ENODEV);

        vmem_xfree(msi_vmem, irqs[0], count);
        return (0);
}

static int fsl_pcib_alloc_msix(device_t dev, device_t child, int *irq)
{
        return (fsl_pcib_alloc_msi(dev, child, 1, 1, irq));
}

static int fsl_pcib_release_msix(device_t dev, device_t child, int irq)
{
        return (fsl_pcib_release_msi(dev, child, 1, &irq));
}

static int fsl_pcib_map_msi(device_t dev, device_t child,
    int irq, uint64_t *addr, uint32_t *data)
{
        struct fsl_msi_map *mp;

        SLIST_FOREACH(mp, &fsl_msis, slist) {
                if (irq >= mp->irq_base && irq < mp->irq_base + FSL_NUM_MSIS)
                        break;
        }

        if (mp == NULL)
                return (ENODEV);

        *data = (irq & 255);
        *addr = ccsrbar_pa + mp->target;

        return (0);
}

/*
 * Linux device trees put the msi@<x> as children of the SoC, with ranges based
 * on the CCSR.  Since rman doesn't permit overlapping or sub-ranges between
 * devices (bus_space_subregion(9) could do it, but let's not touch the PIC
 * driver just to allocate a subregion for a sibling driver).  This driver will
 * use ccsr_write() and ccsr_read() instead.
 */

#define FSL_NUM_IRQS            8
#define FSL_NUM_MSI_PER_IRQ     32
#define FSL_MSI_TARGET  0x140

struct fsl_msi_softc {
        vm_offset_t     sc_base;
        vm_offset_t     sc_target;
        int             sc_msi_base_irq;
        struct fsl_msi_map sc_map;
        struct fsl_msi_irq {
                /* This struct gets passed as the filter private data. */
                struct fsl_msi_softc *sc_ptr;   /* Pointer back to softc. */
                struct resource *res;
                int irq;
                void *cookie;
                int vectors[FSL_NUM_MSI_PER_IRQ];
                vm_offset_t reg;
        } sc_msi_irq[FSL_NUM_IRQS];
};

static int
fsl_msi_intr_filter(void *priv)
{
        struct fsl_msi_irq *data = priv;
        uint32_t reg;
        int i;

        reg = ccsr_read4(ccsrbar_va + data->reg);
        i = 0;
        while (reg != 0) {
                if (reg & 1)
                        powerpc_dispatch_intr(data->vectors[i], NULL);
                reg >>= 1;
                i++;
        }

        return (FILTER_HANDLED);
}

static int
fsl_msi_probe(device_t dev)
{
        if (!ofw_bus_is_compatible(dev, "fsl,mpic-msi") &&
            !ofw_bus_is_compatible(dev, "fsl,mpic-msi-v4.3"))
                return (ENXIO);

        device_set_desc(dev, "Freescale MSI");

        return (BUS_PROBE_DEFAULT);
}

static int
fsl_msi_attach(device_t dev)
{
        struct fsl_msi_softc *sc;
        struct fsl_msi_irq *irq;
        int i;

        sc = device_get_softc(dev);

        if (msi_vmem == NULL)
                msi_vmem = vmem_create("MPIC MSI", 0, 0, 1, 0, M_BESTFIT | M_WAITOK);

        /* Manually play with resource entries. */
        sc->sc_base = bus_get_resource_start(dev, SYS_RES_MEMORY, 0);
        sc->sc_map.target = bus_get_resource_start(dev, SYS_RES_MEMORY, 1);

        if (sc->sc_map.target == 0)
                sc->sc_map.target = sc->sc_base + FSL_MSI_TARGET;

        for (i = 0; i < FSL_NUM_IRQS; i++) {
                irq = &sc->sc_msi_irq[i];
                irq->irq = i;
                irq->reg = sc->sc_base + 16 * i;
                irq->res = bus_alloc_resource_any(dev, SYS_RES_IRQ,
                    &irq->irq, RF_ACTIVE);
                bus_setup_intr(dev, irq->res, INTR_TYPE_MISC | INTR_MPSAFE,
                    fsl_msi_intr_filter, NULL, irq, &irq->cookie);
        }
        sc->sc_map.irq_base = powerpc_register_pic(dev, ofw_bus_get_node(dev),
            FSL_NUM_MSIS, 0, 0);

        /* Let vmem and the IRQ subsystem work their magic for allocations. */
        vmem_add(msi_vmem, sc->sc_map.irq_base, FSL_NUM_MSIS, M_WAITOK);

        SLIST_INSERT_HEAD(&fsl_msis, &sc->sc_map, slist);

        return (0);
}

static void
fsl_msi_enable(device_t dev, u_int irq, u_int vector, void **priv)
{
        struct fsl_msi_softc *sc;
        struct fsl_msi_irq *irqd;

        sc = device_get_softc(dev);

        irqd = &sc->sc_msi_irq[irq / FSL_NUM_MSI_PER_IRQ];
        irqd->vectors[irq % FSL_NUM_MSI_PER_IRQ] = vector;
}

static device_method_t fsl_msi_methods[] = {
        DEVMETHOD(device_probe,         fsl_msi_probe),
        DEVMETHOD(device_attach,        fsl_msi_attach),

        DEVMETHOD(pic_enable,           fsl_msi_enable),
        DEVMETHOD_END
};

static driver_t fsl_msi_driver = {
        "fsl_msi",
        fsl_msi_methods,
        sizeof(struct fsl_msi_softc)
};

EARLY_DRIVER_MODULE(fsl_msi, simplebus, fsl_msi_driver, 0, 0,
    BUS_PASS_INTERRUPT + 1);