/*      $NetBSD: if_tlp_eisa.c,v 1.30 2023/12/20 04:32:30 thorpej Exp $ */

/*-
 * Copyright (c) 1999, 2000 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
 * NASA Ames Research Center.
 *
 * 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
 */

/*
 * EISA bus front-end for the Digital Semiconductor ``Tulip'' (21x4x)
 * Ethernet controller family driver.
 */

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: if_tlp_eisa.c,v 1.30 2023/12/20 04:32:30 thorpej Exp $");

#include "opt_inet.h"

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/mbuf.h>
#include <sys/kmem.h>
#include <sys/kernel.h>
#include <sys/socket.h>
#include <sys/ioctl.h>
#include <sys/errno.h>
#include <sys/device.h>

#include <machine/endian.h>

#include <net/if.h>
#include <net/if_dl.h>
#include <net/if_media.h>
#include <net/if_ether.h>

#ifdef INET
#include <netinet/in.h>
#include <netinet/if_inarp.h>
#endif


#include <sys/bus.h>
#include <sys/intr.h>

#include <dev/mii/miivar.h>
#include <dev/mii/mii_bitbang.h>

#include <dev/ic/tulipreg.h>
#include <dev/ic/tulipvar.h>

#include <dev/eisa/eisareg.h>
#include <dev/eisa/eisavar.h>
#include <dev/eisa/eisadevs.h>

#include <dev/pci/pcireg.h>

/*
 * DE425 configuration registers; literal offsets from CSR base.
 * This is effectively the 21040 PCI configuration space interleaved
 * into the CSR space (CSRs are space 16 bytes on the DE425).
 *
 * What a cool address decoder hack they must have on that board...
 */
#define DE425_CFID              0x08    /* Configuration ID */
#define DE425_CFCS              0x0c    /* Configuration Command-Status */
#define DE425_CFRV              0x18    /* Configuration Revision */
#define DE425_CFLT              0x1c    /* Configuration Latency Timer */
#define DE425_CBIO              0x28    /* Configuration Base I/O Address */
#define DE425_CFDA              0x2c    /* Configuration Driver Area */
#define DE425_ENETROM           0xc90   /* Offset in I/O space for ENETROM */
#define DE425_CFG0              0xc88   /* IRQ Configuration Register */

struct tulip_eisa_softc {
        struct tulip_softc sc_tulip;    /* real Tulip softc */

        /* EISA-specific goo. */
        void    *sc_ih;                 /* interrupt handle */
};

static int      tlp_eisa_match(device_t, cfdata_t, void *);
static void     tlp_eisa_attach(device_t, device_t, void *);

CFATTACH_DECL_NEW(tlp_eisa, sizeof(struct tulip_eisa_softc),
    tlp_eisa_match, tlp_eisa_attach, NULL, NULL);

static const int tlp_eisa_irqs[] = { 5, 9, 10, 11 };

struct tulip_eisa_product {
        const char      *name;  /* device name */
        tulip_chip_t    chip;   /* base Tulip chip type */
};

static const struct tulip_eisa_product dec4250 = {
        .name = "DEC DE425",
        .chip = TULIP_CHIP_DE425,
};

static const struct device_compatible_entry compat_data[] = {
        { .compat = "DEC4250",          .data = &dec4250 },
        DEVICE_COMPAT_EOL
};

static int
tlp_eisa_match(device_t parent, cfdata_t match,
    void *aux)
{
        struct eisa_attach_args *ea = aux;

        return (eisa_compatible_match(ea, compat_data));
}

static void
tlp_eisa_attach(device_t parent, device_t self, void *aux)
{
        static const u_int8_t testpat[] =
            { 0xff, 0, 0x55, 0xaa, 0xff, 0, 0x55, 0xaa };
        struct tulip_eisa_softc *esc = device_private(self);
        struct tulip_softc *sc = &esc->sc_tulip;
        struct eisa_attach_args *ea = aux;
        const struct device_compatible_entry *dce;
        eisa_chipset_tag_t ec = ea->ea_ec;
        eisa_intr_handle_t ih;
        bus_space_tag_t iot = ea->ea_iot;
        bus_space_handle_t ioh;
        const char *intrstr;
        const struct tulip_eisa_product *tep;
        u_int8_t enaddr[ETHER_ADDR_LEN], tmpbuf[sizeof(testpat)];
        u_int32_t val;
        int irq, ist, i, cnt;
        char intrbuf[EISA_INTRSTR_LEN];

        /*
         * Map the device.
         */
        if (bus_space_map(iot, EISA_SLOT_ADDR(ea->ea_slot),
            EISA_SLOT_SIZE, 0, &ioh)) {
                aprint_error(": unable to map I/O space\n");
                return;
        }

        sc->sc_dev = self;
        sc->sc_st = iot;
        sc->sc_sh = ioh;

        dce = eisa_compatible_lookup(ea, compat_data);
        KASSERT(dce != NULL);
        tep = dce->data;

        sc->sc_chip = tep->chip;

        /*
         * DE425's registers are 16 bytes long; the PCI configuration
         * space registers are interleaved in the I/O space.
         */
        sc->sc_regshift = 4;

        /*
         * No power management hooks.
         */
        sc->sc_flags |= TULIPF_ENABLED;

        /*
         * CBIO must map the EISA slot, and I/O access and Bus Mastering
         * must be enabled.
         */
        bus_space_write_4(iot, ioh, DE425_CBIO, EISA_SLOT_ADDR(ea->ea_slot));
        bus_space_write_4(iot, ioh, DE425_CFCS,
            bus_space_read_4(iot, ioh, DE425_CFCS) |
            PCI_COMMAND_IO_ENABLE | PCI_COMMAND_MASTER_ENABLE);

        /*
         * Get revision info.
         */
        sc->sc_rev = bus_space_read_4(iot, ioh, DE425_CFRV) & 0xff;

        aprint_normal(": %s Ethernet, pass %d.%d\n",
            tep->name, (sc->sc_rev >> 4) & 0xf, sc->sc_rev & 0xf);

        sc->sc_dmat = ea->ea_dmat;

        /*
         * EISA doesn't have a cache line register.
         */
        sc->sc_cacheline = 0;

        /*
         * Find the beginning of the Ethernet Address ROM.
         */
        for (i = 0, cnt = 0; i < sizeof(testpat) && cnt < 32; cnt++) {
                tmpbuf[i] = bus_space_read_1(iot, ioh, DE425_ENETROM);
                if (tmpbuf[i] == testpat[i])
                        i++;
                else
                        i = 0;
        }

        /*
         * ...and now read the contents of the Ethernet Address ROM.
         */
        sc->sc_srom_addrbits = 4;       /* 32 bytes */
        sc->sc_srom = kmem_alloc(TULIP_ROM_SIZE(4), KM_SLEEP);
        for (i = 0; i < TULIP_ROM_SIZE(4); i++)
                sc->sc_srom[i] = bus_space_read_1(iot, ioh, DE425_ENETROM);

        /*
         * None of the DE425 boards have the new-style SROMs.
         */
        if (tlp_parse_old_srom(sc, enaddr) == 0) {
                aprint_error_dev(self, "unable to decode old-style SROM\n");
                return;
        }

        /*
         * All DE425 boards use the 21040 media switch.
         */
        sc->sc_mediasw = &tlp_21040_mediasw;

        /*
         * Figure out which IRQ we want to use, and determine if it's
         * edge- or level-triggered.
         */
        val = bus_space_read_4(iot, ioh, DE425_CFG0);
        irq = tlp_eisa_irqs[(val >> 1) & 0x03];
        ist = (val & 0x01) ? IST_EDGE : IST_LEVEL;

        /*
         * Map and establish our interrupt.
         */
        if (eisa_intr_map(ec, irq, &ih)) {
                aprint_error_dev(self, "unable to map interrupt (%u)\n", irq);
                return;
        }
        intrstr = eisa_intr_string(ec, ih, intrbuf, sizeof(intrbuf));
        esc->sc_ih = eisa_intr_establish(ec, ih, ist, IPL_NET, tlp_intr, sc);
        if (esc->sc_ih == NULL) {
                aprint_error_dev(self, "unable to establish interrupt");
                if (intrstr != NULL)
                        aprint_error(" at %s", intrstr);
                aprint_error("\n");
                return;
        }
        if (intrstr != NULL) {
                aprint_normal_dev(self, "interrupting at %s (%s trigger)\n",
                    ist == IST_EDGE ? "edge" : "level", intrstr);
        }

        /*
         * Finish off the attach.
         */
        tlp_attach(sc, enaddr);
}