/*-
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * Copyright (c) 2008 Citrix Systems, Inc.
 * 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.
 */

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

#include <machine/bus.h>
#include <machine/resource.h>
#include <sys/rman.h>

#include <xen/xen-os.h>
#include <xen/features.h>
#include <xen/hypervisor.h>
#include <xen/hvm.h>
#include <xen/xen_intr.h>

#include <dev/pci/pcireg.h>
#include <dev/pci/pcivar.h>

#include <dev/xen/xenpci/xenpcivar.h>

static int
xenpci_irq_init(device_t device, struct xenpci_softc *scp)
{
        int error;

        error = BUS_SETUP_INTR(device_get_parent(device), device,
                               scp->res_irq, INTR_MPSAFE|INTR_TYPE_MISC,
                               xen_intr_handle_upcall, NULL, NULL,
                               &scp->intr_cookie);
        if (error)
                return error;

#ifdef SMP
        /*
         * When using the PCI event delivery callback we cannot assign
         * events to specific vCPUs, so all events are delivered to vCPU#0 by
         * Xen. Since the PCI interrupt can fire on any CPU by default, we
         * need to bind it to vCPU#0 in order to ensure that
         * xen_intr_handle_upcall always gets called on vCPU#0.
         */
        error = BUS_BIND_INTR(device_get_parent(device), device,
                              scp->res_irq, 0);
        if (error)
                return error;
#endif

        xen_hvm_set_callback(device);
        return (0);
}

/*
 * Deallocate anything allocated by xenpci_allocate_resources.
 */
static int
xenpci_deallocate_resources(device_t dev)
{
        struct xenpci_softc *scp = device_get_softc(dev);

        if (scp->res_irq != 0) {
                bus_deactivate_resource(dev, SYS_RES_IRQ,
                        scp->rid_irq, scp->res_irq);
                bus_release_resource(dev, SYS_RES_IRQ,
                        scp->rid_irq, scp->res_irq);
                scp->res_irq = 0;
        }

        return (0);
}

/*
 * Allocate irq and memory resources.
 */
static int
xenpci_allocate_resources(device_t dev)
{
        struct xenpci_softc *scp = device_get_softc(dev);

        scp->res_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ,
                        &scp->rid_irq, RF_SHAREABLE|RF_ACTIVE);
        if (scp->res_irq == NULL) {
                printf("xenpci Could not allocate irq.\n");
                goto errexit;
        }

        return (0);

errexit:
        /* Cleanup anything we may have assigned. */
        xenpci_deallocate_resources(dev);
        return (ENXIO); /* For want of a better idea. */
}

/*
 * Probe - just check device ID.
 */
static int
xenpci_probe(device_t dev)
{
        uint32_t device_id = pci_get_devid(dev);

        if (device_id != 0x00015853 && device_id != 0x00025853)
                return (ENXIO);

        device_set_desc(dev, "Xen Platform Device");
        return (BUS_PROBE_DEFAULT);
}

/*
 * Attach - find resources and talk to Xen.
 */
static int
xenpci_attach(device_t dev)
{
        struct xenpci_softc *scp = device_get_softc(dev);
        int error;

        error = xenpci_allocate_resources(dev);
        if (error) {
                device_printf(dev, "xenpci_allocate_resources failed(%d).\n",
                    error);
                goto errexit;
        }

        /*
         * Hook the irq up to evtchn
         */
        error = xenpci_irq_init(dev, scp);
        if (error) {
                device_printf(dev, "xenpci_irq_init failed(%d).\n",
                        error);
                goto errexit;
        }

        return (0);

errexit:
        /*
         * Undo anything we may have done.
         */
        xenpci_deallocate_resources(dev);
        return (error);
}

/*
 * Detach - reverse anything done by attach.
 */
static int
xenpci_detach(device_t dev)
{
        struct xenpci_softc *scp = device_get_softc(dev);
        device_t parent = device_get_parent(dev);

        /*
         * Take our interrupt handler out of the list of handlers
         * that can handle this irq.
         */
        if (scp->intr_cookie != NULL) {
                if (BUS_TEARDOWN_INTR(parent, dev,
                    scp->res_irq, scp->intr_cookie) != 0)
                        device_printf(dev,
                            "intr teardown failed.. continuing\n");
                scp->intr_cookie = NULL;
        }

        /*
         * Deallocate any system resources we may have
         * allocated on behalf of this driver.
         */
        return (xenpci_deallocate_resources(dev));
}

static int
xenpci_resume(device_t dev)
{
        xen_hvm_set_callback(dev);
        return (0);
}

static device_method_t xenpci_methods[] = {
        /* Device interface */
        DEVMETHOD(device_probe,         xenpci_probe),
        DEVMETHOD(device_attach,        xenpci_attach),
        DEVMETHOD(device_detach,        xenpci_detach),
        DEVMETHOD(device_resume,        xenpci_resume),

        DEVMETHOD_END
};

static driver_t xenpci_driver = {
        "xenpci",
        xenpci_methods,
        sizeof(struct xenpci_softc),
};

DRIVER_MODULE(xenpci, pci, xenpci_driver, 0, 0);