/*      $NetBSD: if_ate.c,v 1.52 2026/02/03 21:34:56 andvar Exp $       */

/*
 * All Rights Reserved, Copyright (C) Fujitsu Limited 1995
 *
 * This software may be used, modified, copied, distributed, and sold, in
 * both source and binary form provided that the above copyright, these
 * terms and the following disclaimer are retained.  The name of the author
 * and/or the contributor 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 AND THE CONTRIBUTOR ``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 THE CONTRIBUTOR 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.
 */

/*
 * Portions copyright (C) 1993, David Greenman.  This software may be used,
 * modified, copied, distributed, and sold, in both source and binary form
 * provided that the above copyright and these terms are retained.  Under no
 * circumstances is the author responsible for the proper functioning of this
 * software, nor does the author assume any responsibility for damages
 * incurred with its use.
 */

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: if_ate.c,v 1.52 2026/02/03 21:34:56 andvar Exp $");

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/device.h>
#include <sys/socket.h>
#include <sys/syslog.h>

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

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

#include <dev/ic/mb86960reg.h>
#include <dev/ic/mb86960var.h>

#include <dev/isa/isavar.h>

int     ate_match(device_t, cfdata_t, void *);
void    ate_attach(device_t, device_t, void *);

struct ate_softc {
        struct  mb86960_softc sc_mb86960;       /* real "mb86960" softc */

        /* ISA-specific goo. */
        void    *sc_ih;                         /* interrupt cookie */
};

CFATTACH_DECL_NEW(ate_isa, sizeof(struct ate_softc),
    ate_match, ate_attach, NULL, NULL);

struct fe_simple_probe_struct {
        uint8_t port;   /* Offset from the base I/O address. */
        uint8_t mask;   /* Bits to be checked. */
        uint8_t bits;   /* Values to be compared against. */
};

static inline int fe_simple_probe(bus_space_tag_t, bus_space_handle_t,
    struct fe_simple_probe_struct const *);
static int ate_find(bus_space_tag_t, bus_space_handle_t, int *, int *);
static int ate_detect(bus_space_tag_t, bus_space_handle_t,
    uint8_t enaddr[ETHER_ADDR_LEN]);

static int const ate_iomap[8] = {
        0x260, 0x280, 0x2A0, 0x240, 0x340, 0x320, 0x380, 0x300
};
#define NATE_IOMAP (sizeof (ate_iomap) / sizeof (ate_iomap[0]))
#define ATE_NPORTS 0x20

#ifdef ATE_DEBUG
#define DPRINTF printf
#else
#define DPRINTF while (/*CONSTCOND*/0) printf
#endif

/*
 * Hardware probe routines.
 */

/*
 * Determine if the device is present.
 */
int
ate_match(device_t parent, cfdata_t cf, void *aux)
{
        struct isa_attach_args *ia = aux;
        bus_space_tag_t iot = ia->ia_iot;
        bus_space_handle_t ioh;
        int i, iobase, irq, rv = 0;
        uint8_t myea[ETHER_ADDR_LEN];

        if (ia->ia_nio < 1)
                return 0;
        if (ia->ia_nirq < 1)
                return 0;

        if (ISA_DIRECT_CONFIG(ia))
                return 0;

        /* Disallow wildcarded values. */
        if (ia->ia_io[0].ir_addr == ISA_UNKNOWN_PORT)
                return 0;

        /*
         * See if the specified address is valid for MB86965A JLI mode.
         */
        for (i = 0; i < NATE_IOMAP; i++)
                if (ate_iomap[i] == ia->ia_io[0].ir_addr)
                        break;
        if (i == NATE_IOMAP) {
                DPRINTF("%s: unknown iobase 0x%x\n",
                    __func__, ia->ia_io[0].ir_addr);
                return 0;
        }

        /* Map i/o space. */
        if (bus_space_map(iot, ia->ia_io[0].ir_addr, ATE_NPORTS, 0, &ioh)) {
                DPRINTF("ate_match: couldn't map iospace 0x%x\n",
                    ia->ia_io[0].ir_addr);
                return 0;
        }

        if (ate_find(iot, ioh, &iobase, &irq) == 0) {
                DPRINTF("%s: ate_find failed\n", __func__);
                goto out;
        }

        if (iobase != ia->ia_io[0].ir_addr) {
                DPRINTF("%s: unexpected iobase in board: 0x%x\n",
                    __func__, iobase);
                goto out;
        }

        if (ate_detect(iot, ioh, myea) == 0) { /* XXX necessary? */
                DPRINTF("%s: ate_detect failed\n", __func__);
                goto out;
        }

        if (ia->ia_irq[0].ir_irq != ISA_UNKNOWN_IRQ) {
                if (ia->ia_irq[0].ir_irq != irq) {
                        aprint_error("%s: irq mismatch; "
                            "kernel configured %d != board configured %d\n",
                            __func__, ia->ia_irq[0].ir_irq, irq);
                        goto out;
                }
        } else
                ia->ia_irq[0].ir_irq = irq;

        ia->ia_nio = 1;
        ia->ia_io[0].ir_size = ATE_NPORTS;

        ia->ia_nirq = 1;

        ia->ia_niomem = 0;
        ia->ia_ndrq = 0;

        rv = 1;

 out:
        bus_space_unmap(iot, ioh, ATE_NPORTS);
        return rv;
}

/*
 * Check for specific bits in specific registers have specific values.
 */
static inline int
fe_simple_probe(bus_space_tag_t iot, bus_space_handle_t ioh,
    struct fe_simple_probe_struct const *sp)
{
        uint8_t val;
        struct fe_simple_probe_struct const *p;

        for (p = sp; p->mask != 0; p++) {
                val = bus_space_read_1(iot, ioh, p->port);
                if ((val & p->mask) != p->bits) {
                        DPRINTF("%s: %x & %x != %x\n",
                            __func__, val, p->mask, p->bits);
                        return 0;
                }
        }

        return 1;
}

/*
 * Hardware (vendor) specific probe routines.
 */

/*
 * Probe and initialization for Allied-Telesis AT1700/RE2000 series.
 */
static int
ate_find(bus_space_tag_t iot, bus_space_handle_t ioh, int *iobase, int *irq)
{
        uint8_t eeprom[FE_EEPROM_SIZE];
        int n;

        static const int irqmap[4][4] = {
                {  3,  4,  5,  9 },
                { 10, 11, 12, 15 },
                {  3, 11,  5, 15 },
                { 10, 11, 14, 15 },
        };
        static const struct fe_simple_probe_struct probe_table[] = {
                { FE_DLCR2,  0x70, 0x00 },
                { FE_DLCR4,  0x08, 0x00 },
                { FE_DLCR5,  0x80, 0x00 },
#if 0
                { FE_BMPR16, 0x1B, 0x00 },
                { FE_BMPR17, 0x7F, 0x00 },
#endif
                { 0,         0x00, 0x00 },
        };

#if ATE_DEBUG >= 4
        log(LOG_INFO, "%s: probe (0x%x) for ATE\n", __func__, iobase);
#if 0
        fe_dump(LOG_INFO, sc);
#endif
#endif

        /*
         * We should test if MB86965A is on the base address now.
         * Unfortunately, it is very hard to probe it reliably, since
         * we have no way to reset the chip under software control.
         * On cold boot, we could check the "signature" bit patterns
         * described in the Fujitsu document.  On warm boot, however,
         * we can predict almost nothing about register values.
         */
        if (fe_simple_probe(iot, ioh, probe_table) == 0)
                return 0;

        /* Check if our I/O address matches config info on 86965. */
        n = (bus_space_read_1(iot, ioh, FE_BMPR19) & FE_B19_ADDR)
            >> FE_B19_ADDR_SHIFT;
        *iobase = ate_iomap[n];

        /*
         * We are now almost sure we have an AT1700 at the given
         * address.  So, read EEPROM through 86965.  We have to write
         * into LSI registers to read from EEPROM.  I want to avoid it
         * at this stage, but I cannot test the presence of the chip
         * any further without reading EEPROM.  FIXME.
         */
        mb86965_read_eeprom(iot, ioh, eeprom);

        /* Make sure that config info in EEPROM and 86965 agree. */
        if (eeprom[FE_EEPROM_CONF] != bus_space_read_1(iot, ioh, FE_BMPR19)) {
#ifdef DIAGNOSTIC
                printf("%s: incorrect configuration in eeprom and chip\n",
                    __func__);
#endif
                return 0;
        }

        /*
         * Try to determine IRQ settings.
         * Different models use different ranges of IRQs.
         */
        n = (bus_space_read_1(iot, ioh, FE_BMPR19) & FE_B19_IRQ)
            >> FE_B19_IRQ_SHIFT;
        switch (eeprom[FE_ATI_EEP_REVISION] & 0xf0) {
        case 0x30:
                *irq = irqmap[3][n];
                break;
        case 0x10:
        case 0x50:
                *irq = irqmap[2][n];
                break;
        case 0x40:
        case 0x60:
                if (eeprom[FE_ATI_EEP_MAGIC] & 0x04) {
                        *irq = irqmap[1][n];
                        break;
                }
                /* FALLTHROUGH */
        default:
                *irq = irqmap[0][n];
                break;
        }

        return 1;
}

/*
 * Determine type and ethernet address.
 */
static int
ate_detect(bus_space_tag_t iot, bus_space_handle_t ioh,
    uint8_t enaddr[ETHER_ADDR_LEN])
{
        uint8_t eeprom[FE_EEPROM_SIZE];
        int type;

        /* Get our station address from EEPROM. */
        mb86965_read_eeprom(iot, ioh, eeprom);
        memcpy(enaddr, eeprom + FE_ATI_EEP_ADDR, ETHER_ADDR_LEN);

        /* Make sure we got a valid station address. */
        if ((enaddr[0] & 0x03) != 0x00 ||
            (enaddr[0] == 0x00 && enaddr[1] == 0x00 && enaddr[2] == 0x00)) {
                DPRINTF("%s: invalid ethernet address\n", __func__);
                return 0;
        }

        /*
         * Determine the card type.
         */
        switch (eeprom[FE_ATI_EEP_MODEL]) {
        case FE_ATI_MODEL_AT1700T:
                type = FE_TYPE_AT1700T;
                break;
        case FE_ATI_MODEL_AT1700BT:
                type = FE_TYPE_AT1700BT;
                break;
        case FE_ATI_MODEL_AT1700FT:
                type = FE_TYPE_AT1700FT;
                break;
        case FE_ATI_MODEL_AT1700AT:
                type = FE_TYPE_AT1700AT;
                break;
        default:
                type = FE_TYPE_AT_UNKNOWN;
                break;
        }

        return type;
}

void
ate_attach(device_t parent, device_t self, void *aux)
{
        struct ate_softc *isc = device_private(self);
        struct mb86960_softc *sc = &isc->sc_mb86960;
        struct isa_attach_args *ia = aux;
        bus_space_tag_t iot = ia->ia_iot;
        bus_space_handle_t ioh;
        uint8_t myea[ETHER_ADDR_LEN];
        const char *typestr;
        int type;

        sc->sc_dev = self;

        /* Map i/o space. */
        if (bus_space_map(iot, ia->ia_io[0].ir_addr, ATE_NPORTS, 0, &ioh)) {
                aprint_error(": can't map i/o space\n");
                return;
        }

        sc->sc_bst = iot;
        sc->sc_bsh = ioh;

        /* Determine the card type and get ethernet address. */
        type = ate_detect(iot, ioh, myea);
        switch (type) {
        case FE_TYPE_AT1700T:
                typestr = "AT-1700T/RE2001";
                break;
        case FE_TYPE_AT1700BT:
                typestr = "AT-1700BT/RE2003";
                break;
        case FE_TYPE_AT1700FT:
                typestr = "AT-1700FT/RE2009";
                break;
        case FE_TYPE_AT1700AT:
                typestr = "AT-1700AT/RE2005";
                break;
        case FE_TYPE_AT_UNKNOWN:
                typestr = "unknown AT-1700/RE2000";
                break;

        default:
                /* Unknown card type: maybe a new model, but... */
                aprint_error(": where did the card go?!\n");
                panic("unknown card");
        }

        aprint_normal(": %s Ethernet\n", typestr);

        /* This interface is always enabled. */
        sc->sc_stat |= FE_STAT_ENABLED;

        /*
         * Do generic MB86960 attach.
         */
        mb86960_attach(sc, myea);

        mb86960_config(sc, NULL, 0, 0);

        /* Establish the interrupt handler. */
        isc->sc_ih = isa_intr_establish(ia->ia_ic, ia->ia_irq[0].ir_irq,
            IST_EDGE, IPL_NET, mb86960_intr, sc);
        if (isc->sc_ih == NULL)
                aprint_error_dev(sc->sc_dev,
                    "couldn't establish interrupt handler\n");
}