/*      $NetBSD: if_ep_isa.c,v 1.47 2019/12/27 04:50:41 msaitoh Exp $   */

/*-
 * Copyright (c) 1996, 1997 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.
 */

/*
 * Copyright (c) 1997 Jonathan Stone <jonathan@NetBSD.org>
 * Copyright (c) 1994 Herb Peyerl <hpeyerl@beer.org>
 * 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.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed by Herb Peyerl.
 * 4. The name of Herb Peyerl 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.
 */

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: if_ep_isa.c,v 1.47 2019/12/27 04:50:41 msaitoh Exp $");

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/mbuf.h>
#include <sys/socket.h>
#include <sys/ioctl.h>
#include <sys/errno.h>
#include <sys/syslog.h>
#include <sys/select.h>
#include <sys/device.h>
#include <sys/queue.h>

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

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

#include <dev/mii/miivar.h>

#include <dev/ic/elink3var.h>
#include <dev/ic/elink3reg.h>

#include <dev/isa/isavar.h>
#include <dev/isa/elink.h>

int ep_isa_probe(device_t , cfdata_t , void *);
void ep_isa_attach(device_t , device_t , void *);

CFATTACH_DECL_NEW(ep_isa, sizeof(struct ep_softc),
    ep_isa_probe, ep_isa_attach, NULL, NULL);

static  void epaddcard(int, int, int, int);

/*
 * This keeps track of which ISAs have been through an ep probe sequence.
 * A simple static variable isn't enough, since it's conceivable that
 * a system might have more than one ISA bus.
 *
 * The "er_bus" member is the unit number of the parent ISA bus, e.g. "0"
 * for "isa0".
 */
struct ep_isa_done_probe {
        LIST_ENTRY(ep_isa_done_probe)   er_link;
        int                             er_bus;
};
static LIST_HEAD(, ep_isa_done_probe) ep_isa_all_probes;
static int ep_isa_probes_initialized;

#define MAXEPCARDS      20      /* if you have more than 20, you lose */

static struct epcard {
        int     bus;
        int     iobase;
        int     irq;
        char    available;
        long    model;
} epcards[MAXEPCARDS];
static int nepcards;

static void
epaddcard(int bus, int iobase, int irq, int model)
{

        if (nepcards >= MAXEPCARDS)
                return;
        epcards[nepcards].bus = bus;
        epcards[nepcards].iobase = iobase;
        epcards[nepcards].irq = (irq == 2) ? 9 : irq;
        epcards[nepcards].model = model;
        epcards[nepcards].available = 1;
        nepcards++;
}

/*
 * 3c509 cards on the ISA bus are probed in ethernet address order.
 * The probe sequence requires careful orchestration, and we'd like
 * to allow the irq and base address to be wildcarded. So, we
 * probe all the cards the first time epprobe() is called. On subsequent
 * calls we look for matching cards.
 */
int
ep_isa_probe(device_t parent, cfdata_t match, void *aux)
{
        struct isa_attach_args *ia = aux;
        bus_space_tag_t iot = ia->ia_iot;
        bus_space_handle_t ioh;
        int slot, iobase, irq, i;
        u_int16_t vendor, model, eeprom_addr_cfg;
        struct ep_isa_done_probe *er;
        int bus = device_unit(parent);

        if (ISA_DIRECT_CONFIG(ia))
                return (0);

        if (ep_isa_probes_initialized == 0) {
                LIST_INIT(&ep_isa_all_probes);
                ep_isa_probes_initialized = 1;
        }

        /*
         * Probe this bus if we haven't done so already.
         */
        for (er = ep_isa_all_probes.lh_first; er != NULL;
            er = er->er_link.le_next)
                if (er->er_bus == device_unit(parent))
                        goto bus_probed;

        /*
         * Mark this bus so we don't probe it again.
         */
        er = malloc(sizeof(struct ep_isa_done_probe), M_DEVBUF, M_WAITOK);
        er->er_bus = bus;
        LIST_INSERT_HEAD(&ep_isa_all_probes, er, er_link);

        /*
         * Map the Etherlink ID port for the probe sequence.
         */
        if (bus_space_map(iot, ELINK_ID_PORT, 1, 0, &ioh)) {
                printf("ep_isa_probe: can't map Etherlink ID port\n");
                return 0;
        }

        for (slot = 0; slot < MAXEPCARDS; slot++) {
                elink_reset(iot, ioh, device_unit(parent));
                elink_idseq(iot, ioh, ELINK_509_POLY);

                /* Untag all the adapters so they will talk to us. */
                if (slot == 0)
                        bus_space_write_1(iot, ioh, 0, TAG_ADAPTER + 0);

                vendor = bswap16(epreadeeprom(iot, ioh, EEPROM_MFG_ID));
                if (vendor != MFG_ID)
                        continue;

                model = bswap16(epreadeeprom(iot, ioh, EEPROM_PROD_ID));
                /*
                 * XXX: Add a new product id to check for other cards
                 * (3c515?) and fix the check in ep_isa_attach.
                 */
                if ((model & 0xfff0) != PROD_ID_3C509) {
#ifndef trusted
                        printf(
                         "ep_isa_probe: ignoring model %04x\n", model);
#endif
                        continue;
                        }

                eeprom_addr_cfg = epreadeeprom(iot, ioh, EEPROM_ADDR_CFG);
                iobase = (eeprom_addr_cfg & 0x1f) * 0x10 + 0x200;

                irq = epreadeeprom(iot, ioh, EEPROM_RESOURCE_CFG);
                irq >>= 12;

                /* XXX Should ignore card if non-ISA(EISA) io address? -chb */

                /*
                 * Don't attach a 3c509 in PnP mode.
                 * PnP mode was added with the 3C509B.
                 * Check some EEPROM registers to make sure this is really
                 * a 3C509B and test whether it is in PnP mode.
                 */
                if ((model & 0xfff0) == PROD_ID_3C509) {
                        u_int16_t cksum, eepromrev, eeprom_cap, eeprom_hi;


                        /*
                         * Fetch all the info we need to ascertain whether
                         * the card is  PnP capable and in PnP mode.
                         * Skip over PnP cards.
                         */

                        /* secondary configurable data checksum */
                        cksum = epreadeeprom(iot, ioh, EEPROM_CHECKSUM_EL3)
                            & 0xFF;
                        for (i = EEPROM_CONFIG_HIGH;
                            i < EEPROM_CHECKSUM_EL3; i++) {
                                cksum ^= epreadeeprom(iot, ioh, i);
                        }
                        cksum = (cksum & 0xFF) ^ ((cksum >> 8) & 0xFF);

                        eepromrev = epreadeeprom(iot, ioh, EEPROM_SSI);
                        eeprom_hi = epreadeeprom(iot, ioh, EEPROM_CONFIG_HIGH);
                        eeprom_cap = epreadeeprom(iot, ioh, EEPROM_CAP);

                        /*
                         * Stop card responding to contention in future.
                         * (NB: stops rsponse to all reads from ID port.)
                         */
                        bus_space_write_1(iot, ioh, 0, TAG_ADAPTER + 1);

                        if (cksum != 0) {
#if 0
                                printf("ep_isa_probe: cksum mismatch 0x%02x\n",
                                    (int)cksum);
#endif
                        }
                        else if ((eepromrev & 0xF) < 1) {
                                /* 3C509B is adapter revision level 1. */
#if 0
                                printf("ep_isa_probe: revision level 0\n");
#endif
                        }
                        else if (eeprom_cap != 0x2083) {
#if 0
                                printf("ep_isa_probe: capabilities word mismatch0x%03x\n",
                                    (int)epreadeeprom(iot, ioh, EEPROM_CAP));
#endif
                        }
                        else
                          /*
                           * we have a 3c509B with PnP capabilities.
                           * Test partly documented bits which toggle when
                           * in PnP mode.
                           */
                        if ((eeprom_hi & 0x8) != 0 || ((eeprom_hi & 0xc) == 0 &&
                            (eeprom_addr_cfg & 0x80) != 0)) {
                                printf("3COM 3C509B Ethernet card in PnP mode\n");
                                continue;
                        }
                }

                /*
                 * XXX: this should probably not be done here
                 * because it enables the drq/irq lines from
                 * the board. Perhaps it should be done after
                 * we have checked for irq/drq collisions?
                 *
                 * According to the 3COM docs, this does not enable
                 * the irq lines. -chb
                 */
                bus_space_write_1(iot, ioh, 0, ACTIVATE_ADAPTER_TO_CONFIG);

                epaddcard(bus, iobase, irq, model);
        }
        /* XXX should we sort by ethernet address? */

        bus_space_unmap(iot, ioh, 1);

bus_probed:

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

        for (i = 0; i < nepcards; i++) {
                if (epcards[i].bus != bus)
                        continue;
                if (epcards[i].available == 0)
                        continue;

                if (ia->ia_io[0].ir_addr != ISA_UNKNOWN_PORT &&
                    ia->ia_io[0].ir_addr != epcards[i].iobase)
                        continue;

                if (ia->ia_irq[0].ir_irq != ISA_UNKNOWN_IRQ &&
                    ia->ia_irq[0].ir_irq != epcards[i].irq)
                        continue;

                goto good;
        }
        return 0;

good:
        epcards[i].available = 0;

        ia->ia_nio = 1;
        ia->ia_io[0].ir_addr = epcards[i].iobase;
        ia->ia_io[0].ir_size = 0x10;

        ia->ia_nirq = 1;
        ia->ia_irq[0].ir_irq = epcards[i].irq;

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

        ia->ia_aux = (void *)epcards[i].model;
        return 1;
}

void
ep_isa_attach(device_t parent, device_t self, void *aux)
{
        struct ep_softc *sc = device_private(self);
        struct isa_attach_args *ia = aux;
        bus_space_tag_t iot = ia->ia_iot;
        bus_space_handle_t ioh;
        int chipset;

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

        sc->sc_dev = self;
        sc->sc_iot = iot;
        sc->sc_ioh = ioh;
        sc->bustype = ELINK_BUS_ISA;

        sc->enable = NULL;
        sc->disable = NULL;
        sc->enabled = 1;

        chipset = (int)(long)ia->ia_aux;
        if ((chipset & 0xfff0) == PROD_ID_3C509) {
                aprint_normal(": 3Com 3C509 Ethernet\n");
                epconfig(sc, ELINK_CHIPSET_3C509, NULL);
        } else {
                /*
                 * XXX: Maybe a 3c515, but the check in ep_isa_probe looks
                 * at the moment only for a 3c509.
                 */
                aprint_error(": unknown 3Com Ethernet card: %04x\n", chipset);
                return;
        }

        sc->sc_ih = isa_intr_establish(ia->ia_ic, ia->ia_irq[0].ir_irq,
            IST_EDGE, IPL_NET, epintr, sc);
}