/*-
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * Copyright (C) 2002 Benno Rice.
 * 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 Benno Rice ``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 TOOLS GMBH 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/systm.h>
#include <sys/module.h>
#include <sys/bus.h>
#include <sys/conf.h>
#include <sys/kernel.h>

#include <dev/ofw/openfirm.h>
#include <dev/ofw/ofw_pci.h>
#include <dev/ofw/ofw_bus.h>
#include <dev/ofw/ofw_bus_subr.h>

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

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

#include <sys/rman.h>

#include <powerpc/powermac/uninorthvar.h>

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

/*
 * Driver for the Uninorth chip itself.
 */

static MALLOC_DEFINE(M_UNIN, "unin", "unin device information");

/*
 * Device interface.
 */

static int  unin_chip_probe(device_t);
static int  unin_chip_attach(device_t);

/*
 * Bus interface.
 */
static int  unin_chip_print_child(device_t dev, device_t child);
static void unin_chip_probe_nomatch(device_t, device_t);
static struct rman *unin_chip_get_rman(device_t, int, u_int);
static struct resource *unin_chip_alloc_resource(device_t, device_t, int, int,
                                                 rman_res_t, rman_res_t,
                                                 rman_res_t, u_int);
static int  unin_chip_adjust_resource(device_t, device_t,
                                      struct resource *, rman_res_t,
                                      rman_res_t);
static int  unin_chip_activate_resource(device_t, device_t,
                                        struct resource *);
static int  unin_chip_deactivate_resource(device_t, device_t,
                                          struct resource *);
static int  unin_chip_map_resource(device_t, device_t, struct resource *,
                                   struct resource_map_request *,
                                   struct resource_map *);
static int  unin_chip_unmap_resource(device_t, device_t, struct resource *,
                                     struct resource_map *);
static int  unin_chip_release_resource(device_t, device_t, struct resource *);
static struct resource_list *unin_chip_get_resource_list (device_t, device_t);

/*
 * OFW Bus interface
 */

static ofw_bus_get_devinfo_t unin_chip_get_devinfo;

/*
 * Local routines
 */

static void             unin_enable_gmac(device_t dev);
static void             unin_enable_mpic(device_t dev);

/*
 * Driver methods.
 */
static device_method_t unin_chip_methods[] = {
        /* Device interface */
        DEVMETHOD(device_probe,         unin_chip_probe),
        DEVMETHOD(device_attach,        unin_chip_attach),

        /* Bus interface */
        DEVMETHOD(bus_print_child,      unin_chip_print_child),
        DEVMETHOD(bus_probe_nomatch,    unin_chip_probe_nomatch),
        DEVMETHOD(bus_setup_intr,       bus_generic_setup_intr),
        DEVMETHOD(bus_teardown_intr,    bus_generic_teardown_intr),

        DEVMETHOD(bus_get_rman,         unin_chip_get_rman),
        DEVMETHOD(bus_alloc_resource,   unin_chip_alloc_resource),
        DEVMETHOD(bus_adjust_resource,  unin_chip_adjust_resource),
        DEVMETHOD(bus_release_resource, unin_chip_release_resource),
        DEVMETHOD(bus_activate_resource, unin_chip_activate_resource),
        DEVMETHOD(bus_deactivate_resource, unin_chip_deactivate_resource),
        DEVMETHOD(bus_map_resource,     unin_chip_map_resource),
        DEVMETHOD(bus_unmap_resource,   unin_chip_unmap_resource),
        DEVMETHOD(bus_get_resource_list, unin_chip_get_resource_list),

        DEVMETHOD(bus_child_pnpinfo,    ofw_bus_gen_child_pnpinfo),

        /* ofw_bus interface */
        DEVMETHOD(ofw_bus_get_devinfo,  unin_chip_get_devinfo),
        DEVMETHOD(ofw_bus_get_compat,   ofw_bus_gen_get_compat),
        DEVMETHOD(ofw_bus_get_model,    ofw_bus_gen_get_model),
        DEVMETHOD(ofw_bus_get_name,     ofw_bus_gen_get_name),
        DEVMETHOD(ofw_bus_get_node,     ofw_bus_gen_get_node),
        DEVMETHOD(ofw_bus_get_type,     ofw_bus_gen_get_type),
        { 0, 0 }
};

static driver_t unin_chip_driver = {
        "unin",
        unin_chip_methods,
        sizeof(struct unin_chip_softc)
};

/*
 * Assume there is only one unin chip in a PowerMac, so that pmu.c functions can
 * suspend the chip after the whole rest of the device tree is suspended, not
 * earlier.
 */
static device_t         unin_chip;

EARLY_DRIVER_MODULE(unin, ofwbus, unin_chip_driver, 0, 0, BUS_PASS_BUS);

/*
 * Add an interrupt to the dev's resource list if present
 */
static void
unin_chip_add_intr(phandle_t devnode, struct unin_chip_devinfo *dinfo)
{
        phandle_t iparent;
        int     *intr;
        int     i, nintr;
        int     icells;

        if (dinfo->udi_ninterrupts >= 6) {
                printf("unin: device has more than 6 interrupts\n");
                return;
        }

        nintr = OF_getprop_alloc_multi(devnode, "interrupts", sizeof(*intr), 
                (void **)&intr);
        if (nintr == -1) {
                nintr = OF_getprop_alloc_multi(devnode, "AAPL,interrupts", 
                        sizeof(*intr), (void **)&intr);
                if (nintr == -1)
                        return;
        }

        if (intr[0] == -1)
                return;

        if (OF_getprop(devnode, "interrupt-parent", &iparent, sizeof(iparent))
            <= 0)
                panic("Interrupt but no interrupt parent!\n");

        if (OF_searchprop(iparent, "#interrupt-cells", &icells, sizeof(icells))
            <= 0)
                icells = 1;

        for (i = 0; i < nintr; i+=icells) {
                u_int irq = MAP_IRQ(iparent, intr[i]);

                resource_list_add(&dinfo->udi_resources, SYS_RES_IRQ,
                    dinfo->udi_ninterrupts, irq, irq, 1);

                if (icells > 1) {
                        powerpc_config_intr(irq,
                            (intr[i+1] & 1) ? INTR_TRIGGER_LEVEL :
                            INTR_TRIGGER_EDGE, INTR_POLARITY_LOW);
                }

                dinfo->udi_interrupts[dinfo->udi_ninterrupts] = irq;
                dinfo->udi_ninterrupts++;
        }
}

static void
unin_chip_add_reg(phandle_t devnode, struct unin_chip_devinfo *dinfo)
{
        struct  unin_chip_reg *reg;
        int     i, nreg;

        nreg = OF_getprop_alloc_multi(devnode, "reg", sizeof(*reg), (void **)&reg);
        if (nreg == -1)
                return;

        for (i = 0; i < nreg; i++) {
                resource_list_add(&dinfo->udi_resources, SYS_RES_MEMORY, i,
                                  reg[i].mr_base,
                                  reg[i].mr_base + reg[i].mr_size,
                                  reg[i].mr_size);
        }
}

static void
unin_update_reg(device_t dev, uint32_t regoff, uint32_t set, uint32_t clr)
{
        volatile u_int *reg;
        struct unin_chip_softc *sc;
        u_int32_t tmpl;

        sc = device_get_softc(dev);
        reg = (void *)(sc->sc_addr + regoff);
        tmpl = inl(reg);
        tmpl &= ~clr;
        tmpl |= set;
        outl(reg, tmpl);
}

static void
unin_enable_gmac(device_t dev)
{
        unin_update_reg(dev, UNIN_CLOCKCNTL, UNIN_CLOCKCNTL_GMAC, 0);
}

static void
unin_enable_mpic(device_t dev)
{
        unin_update_reg(dev, UNIN_TOGGLE_REG, UNIN_MPIC_RESET | UNIN_MPIC_OUTPUT_ENABLE, 0);
}

static int
unin_chip_probe(device_t dev)
{
        const char      *name;

        name = ofw_bus_get_name(dev);

        if (name == NULL)
                return (ENXIO);

        if (strcmp(name, "uni-n") != 0 && strcmp(name, "u3") != 0
            && strcmp(name, "u4") != 0)
                return (ENXIO);

        device_set_desc(dev, "Apple UniNorth System Controller");
        return (0);
}

static int
unin_chip_attach(device_t dev)
{
        struct unin_chip_softc *sc;
        struct unin_chip_devinfo *dinfo;
        phandle_t  root;
        phandle_t  child;
        phandle_t  iparent;
        device_t   cdev;
        cell_t     acells, scells;
        char compat[32];
        char name[32];
        u_int irq, reg[3];
        int error, i = 0;

        sc = device_get_softc(dev);
        root = ofw_bus_get_node(dev);

        if (OF_getprop(root, "reg", reg, sizeof(reg)) < 8)
                return (ENXIO);

        acells = scells = 1;
        OF_getprop(OF_parent(root), "#address-cells", &acells, sizeof(acells));
        OF_getprop(OF_parent(root), "#size-cells", &scells, sizeof(scells));

        i = 0;
        sc->sc_physaddr = reg[i++];
        if (acells == 2) {
                sc->sc_physaddr <<= 32;
                sc->sc_physaddr |= reg[i++];
        }
        sc->sc_size = reg[i++];
        if (scells == 2) {
                sc->sc_size <<= 32;
                sc->sc_size |= reg[i++];
        }

        sc->sc_mem_rman.rm_type = RMAN_ARRAY;
        sc->sc_mem_rman.rm_descr = "UniNorth Device Memory";

        error = rman_init(&sc->sc_mem_rman);

        if (error) {
                device_printf(dev, "rman_init() failed. error = %d\n", error);
                return (error);
        }

        error = rman_manage_region(&sc->sc_mem_rman, sc->sc_physaddr,
                                   sc->sc_physaddr + sc->sc_size - 1);  
        if (error) {
                device_printf(dev,
                              "rman_manage_region() failed. error = %d\n",
                              error);
                return (error);
        }

        if (unin_chip == NULL)
                unin_chip = dev;

        /*
         * Iterate through the sub-devices
         */
        for (child = OF_child(root); child != 0; child = OF_peer(child)) {
                dinfo = malloc(sizeof(*dinfo), M_UNIN, M_WAITOK | M_ZERO);
                if (ofw_bus_gen_setup_devinfo(&dinfo->udi_obdinfo, child)
                    != 0)
                {
                        free(dinfo, M_UNIN);
                        continue;
                }

                resource_list_init(&dinfo->udi_resources);
                dinfo->udi_ninterrupts = 0;
                unin_chip_add_intr(child, dinfo);

                /*
                 * Some Apple machines do have a bug in OF, they miss
                 * the interrupt entries on the U3 I2C node. That means they
                 * do not have an entry with number of interrupts nor the
                 * entry of the interrupt parent handle.
                 * We define an interrupt and hardwire it to the /u3/mpic
                 * handle.
                 */

                if (OF_getprop(child, "name", name, sizeof(name)) <= 0)
                        device_printf(dev, "device has no name!\n");
                if (dinfo->udi_ninterrupts == 0 &&
                    (strcmp(name, "i2c-bus") == 0 ||
                     strcmp(name, "i2c")  == 0)) {
                        if (OF_getprop(child, "interrupt-parent", &iparent,
                                       sizeof(iparent)) <= 0) {
                                iparent = OF_finddevice("/u3/mpic");
                                device_printf(dev, "Set /u3/mpic as iparent!\n");
                        }
                        /* Add an interrupt number 0 to the parent. */
                        irq = MAP_IRQ(iparent, 0);
                        resource_list_add(&dinfo->udi_resources, SYS_RES_IRQ,
                                          dinfo->udi_ninterrupts, irq, irq, 1);
                        dinfo->udi_interrupts[dinfo->udi_ninterrupts] = irq;
                        dinfo->udi_ninterrupts++;
                }

                unin_chip_add_reg(child, dinfo);

                cdev = device_add_child(dev, NULL, DEVICE_UNIT_ANY);
                if (cdev == NULL) {
                        device_printf(dev, "<%s>: device_add_child failed\n",
                                      dinfo->udi_obdinfo.obd_name);
                        resource_list_free(&dinfo->udi_resources);
                        ofw_bus_gen_destroy_devinfo(&dinfo->udi_obdinfo);
                        free(dinfo, M_UNIN);
                        continue;
                }

                device_set_ivars(cdev, dinfo);
        }

        /*
         * Only map the first page, since that is where the registers
         * of interest lie.
         */
        sc->sc_addr = (vm_offset_t)pmap_mapdev(sc->sc_physaddr, PAGE_SIZE);

        sc->sc_version = *(u_int *)sc->sc_addr;
        device_printf(dev, "Version %d\n", sc->sc_version);

        /*
         * Enable the GMAC Ethernet cell and the integrated OpenPIC
         * if Open Firmware says they are used.
         */
        for (child = OF_child(root); child; child = OF_peer(child)) {
                memset(compat, 0, sizeof(compat));
                OF_getprop(child, "compatible", compat, sizeof(compat));
                if (strcmp(compat, "gmac") == 0)
                        unin_enable_gmac(dev);
                if (strcmp(compat, "chrp,open-pic") == 0)
                        unin_enable_mpic(dev);
        }

        /*
         * GMAC lives under the PCI bus, so just check if enet is gmac.
         */
        child = OF_finddevice("enet");
        memset(compat, 0, sizeof(compat));
        OF_getprop(child, "compatible", compat, sizeof(compat));
        if (strcmp(compat, "gmac") == 0)
                unin_enable_gmac(dev);

        bus_attach_children(dev);
        return (0);
}

static int
unin_chip_print_child(device_t dev, device_t child)
{
        struct unin_chip_devinfo *dinfo;
        struct resource_list *rl;
        int retval = 0;

        dinfo = device_get_ivars(child);
        rl = &dinfo->udi_resources;

        retval += bus_print_child_header(dev, child);

        retval += resource_list_print_type(rl, "mem", SYS_RES_MEMORY, "%#jx");
        retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%jd");

        retval += bus_print_child_footer(dev, child);

        return (retval);
}

static void
unin_chip_probe_nomatch(device_t dev, device_t child)
{
        struct unin_chip_devinfo *dinfo;
        struct resource_list *rl;
        const char *type;

        if (bootverbose) {
                dinfo = device_get_ivars(child);
                rl = &dinfo->udi_resources;

                if ((type = ofw_bus_get_type(child)) == NULL)
                        type = "(unknown)";
                device_printf(dev, "<%s, %s>", type, ofw_bus_get_name(child));
                resource_list_print_type(rl, "mem", SYS_RES_MEMORY, "%#jx");
                resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%jd");
                printf(" (no driver attached)\n");
        }
}

static struct rman *
unin_chip_get_rman(device_t bus, int type, u_int flags)
{
        struct          unin_chip_softc *sc;

        sc = device_get_softc(bus);
        switch (type) {
        case SYS_RES_MEMORY:
        case SYS_RES_IOPORT:
                return (&sc->sc_mem_rman);
        default:
                return (NULL);
        }
}

static struct resource *
unin_chip_alloc_resource(device_t bus, device_t child, int type, int rid,
                         rman_res_t start, rman_res_t end, rman_res_t count,
                         u_int flags)
{
        rman_res_t      adjstart, adjend, adjcount;
        struct          unin_chip_devinfo *dinfo;
        struct          resource_list_entry *rle;

        dinfo = device_get_ivars(child);

        switch (type) {
        case SYS_RES_MEMORY:
        case SYS_RES_IOPORT:
                rle = resource_list_find(&dinfo->udi_resources, SYS_RES_MEMORY,
                                         rid);
                if (rle == NULL) {
                        device_printf(bus, "no rle for %s memory %d\n",
                                      device_get_nameunit(child), rid);
                        return (NULL);
                }

                rle->end = rle->end - 1; /* Hack? */

                if (start < rle->start)
                        adjstart = rle->start;
                else if (start > rle->end)
                        adjstart = rle->end;
                else
                        adjstart = start;

                if (end < rle->start)
                        adjend = rle->start;
                else if (end > rle->end)
                        adjend = rle->end;
                else
                        adjend = end;

                adjcount = adjend - adjstart;

                return (bus_generic_rman_alloc_resource(bus, child,
                    SYS_RES_MEMORY, rid, adjstart, adjend, adjcount, flags));
        case SYS_RES_IRQ:
                /* Check for passthrough from subattachments. */
                if (device_get_parent(child) != bus)
                        return BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
                                                  type, rid, start, end, count,
                                                  flags);

                rle = resource_list_find(&dinfo->udi_resources, SYS_RES_IRQ,
                    rid);
                if (rle == NULL) {
                        if (dinfo->udi_ninterrupts >= 6) {
                                device_printf(bus,
                                              "%s has more than 6 interrupts\n",
                                              device_get_nameunit(child));
                                return (NULL);
                        }
                        resource_list_add(&dinfo->udi_resources, SYS_RES_IRQ,
                                          dinfo->udi_ninterrupts, start, start,
                                          1);

                        dinfo->udi_interrupts[dinfo->udi_ninterrupts] = start;
                        dinfo->udi_ninterrupts++;
                }

                return (resource_list_alloc(&dinfo->udi_resources, bus, child,
                                            type, rid, start, end, count,
                                            flags));
        default:
                device_printf(bus, "unknown resource request from %s\n",
                              device_get_nameunit(child));
                return (NULL);
        }
}

static int
unin_chip_adjust_resource(device_t bus, device_t child, struct resource *r,
    rman_res_t start, rman_res_t end)
{
        switch (rman_get_type(r)) {
        case SYS_RES_IOPORT:
        case SYS_RES_MEMORY:
                return (bus_generic_rman_adjust_resource(bus, child, r, start,
                    end));
        case SYS_RES_IRQ:
                return (bus_generic_adjust_resource(bus, child, r, start, end));
        default:
                return (EINVAL);
        }
}

static int
unin_chip_release_resource(device_t bus, device_t child, struct resource *res)
{
        switch (rman_get_type(res)) {
        case SYS_RES_IOPORT:
        case SYS_RES_MEMORY:
                return (bus_generic_rman_release_resource(bus, child, res));
        case SYS_RES_IRQ:
                return (bus_generic_rl_release_resource(bus, child, res));
        default:
                return (EINVAL);
        }
}

static int
unin_chip_activate_resource(device_t bus, device_t child, struct resource *res)
{
        switch (rman_get_type(res)) {
        case SYS_RES_IOPORT:
        case SYS_RES_MEMORY:
                return (bus_generic_rman_activate_resource(bus, child, res));
        case SYS_RES_IRQ:
                return (bus_generic_activate_resource(bus, child, res));
        default:
                return (EINVAL);
        }
}

static int
unin_chip_deactivate_resource(device_t bus, device_t child,
                              struct resource *res)
{
        switch (rman_get_type(res)) {
        case SYS_RES_IOPORT:
        case SYS_RES_MEMORY:
                return (bus_generic_rman_deactivate_resource(bus, child, res));
        case SYS_RES_IRQ:
                return (bus_generic_deactivate_resource(bus, child, res));
        default:
                return (EINVAL);
        }
}

static int
unin_chip_map_resource(device_t bus, device_t child, struct resource *r,
    struct resource_map_request *argsp, struct resource_map *map)
{
        struct resource_map_request args;
        rman_res_t length, start;
        int error;

        /* Resources must be active to be mapped. */
        if (!(rman_get_flags(r) & RF_ACTIVE))
                return (ENXIO);

        /* Mappings are only supported on I/O and memory resources. */
        switch (rman_get_type(r)) {
        case SYS_RES_IOPORT:
        case SYS_RES_MEMORY:
                break;
        default:
                return (EINVAL);
        }

        resource_init_map_request(&args);
        error = resource_validate_map_request(r, argsp, &args, &start, &length);
        if (error)
                return (error);

        if (bootverbose)
                printf("nexus mapdev: start %jx, len %jd\n",
                    (uintmax_t)start, (uintmax_t)length);

        map->r_vaddr = pmap_mapdev_attr(start, length, args.memattr);
        if (map->r_vaddr == NULL)
                return (ENOMEM);
        map->r_bustag = &bs_be_tag;
        map->r_size = length;
        map->r_bushandle = (bus_space_handle_t)map->r_vaddr;
        return (0);
}

static int
unin_chip_unmap_resource(device_t bus, device_t child, struct resource *r,
    struct resource_map *map)
{
        /*
         * If this is a memory resource, unmap it.
         */
        switch (rman_get_type(r)) {
        case SYS_RES_IOPORT:
        case SYS_RES_MEMORY:
                pmap_unmapdev(map->r_vaddr, map->r_size);
                break;
        default:
                return (EINVAL);
        }
        return (0);
}

static struct resource_list *
unin_chip_get_resource_list (device_t dev, device_t child)
{
        struct unin_chip_devinfo *dinfo;

        dinfo = device_get_ivars(child);
        return (&dinfo->udi_resources);
}

static const struct ofw_bus_devinfo *
unin_chip_get_devinfo(device_t dev, device_t child)
{
        struct unin_chip_devinfo *dinfo;

        dinfo = device_get_ivars(child);
        return (&dinfo->udi_obdinfo);
}

int
unin_chip_wake(device_t dev)
{

        if (dev == NULL)
                dev = unin_chip;
        unin_update_reg(dev, UNIN_PWR_MGMT, UNIN_PWR_NORMAL, UNIN_PWR_MASK);
        DELAY(10);
        unin_update_reg(dev, UNIN_HWINIT_STATE, UNIN_RUNNING, 0);
        DELAY(100);

        return (0);
}

int
unin_chip_sleep(device_t dev, int idle)
{
        if (dev == NULL)
                dev = unin_chip;

        unin_update_reg(dev, UNIN_HWINIT_STATE, UNIN_SLEEPING, 0);
        DELAY(10);
        if (idle)
                unin_update_reg(dev, UNIN_PWR_MGMT, UNIN_PWR_IDLE2, UNIN_PWR_MASK);
        else
                unin_update_reg(dev, UNIN_PWR_MGMT, UNIN_PWR_SLEEP, UNIN_PWR_MASK);
        DELAY(10);

        return (0);
}