/*      $NetBSD: am7990.c,v 1.68 2005/12/11 12:21:25 christos Exp $     */

/*-
 * SPDX-License-Identifier: BSD-2-Clause AND BSD-3-Clause
 *
 * Copyright (c) 1997, 1998 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Charles M. Hannum and 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) 1992, 1993
 *      The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Ralph Campbell and Rick Macklem.
 *
 * 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. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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/cdefs.h>
#include <sys/param.h>
#include <sys/bus.h>
#include <sys/endian.h>
#include <sys/lock.h>
#include <sys/mbuf.h>
#include <sys/mutex.h>
#include <sys/socket.h>

#include <net/bpf.h>
#include <net/ethernet.h>
#include <net/if.h>
#include <net/if_arp.h>
#include <net/if_dl.h>
#include <net/if_media.h>
#include <net/if_var.h>

#include <machine/bus.h>

#include <dev/le/lancereg.h>
#include <dev/le/lancevar.h>
#include <dev/le/am7990reg.h>
#include <dev/le/am7990var.h>

static void     am7990_meminit(struct lance_softc *);
static void     am7990_rint(struct lance_softc *);
static void     am7990_tint(struct lance_softc *);
static void     am7990_start_locked(struct lance_softc *sc);

#ifdef LEDEBUG
static void     am7990_recv_print(struct lance_softc *, int);
static void     am7990_xmit_print(struct lance_softc *, int);
#endif

int
am7990_config(struct am7990_softc *sc, const char* name, int unit)
{
        int error, mem;

        sc->lsc.sc_meminit = am7990_meminit;
        sc->lsc.sc_start_locked = am7990_start_locked;

        error = lance_config(&sc->lsc, name, unit);
        if (error != 0)
                return (error);

        mem = 0;
        sc->lsc.sc_initaddr = mem;
        mem += sizeof(struct leinit);
        sc->lsc.sc_rmdaddr = mem;
        mem += sizeof(struct lermd) * sc->lsc.sc_nrbuf;
        sc->lsc.sc_tmdaddr = mem;
        mem += sizeof(struct letmd) * sc->lsc.sc_ntbuf;
        sc->lsc.sc_rbufaddr = mem;
        mem += LEBLEN * sc->lsc.sc_nrbuf;
        sc->lsc.sc_tbufaddr = mem;
        mem += LEBLEN * sc->lsc.sc_ntbuf;

        if (mem > sc->lsc.sc_memsize)
                panic("%s: memsize", __func__);

        lance_attach(&sc->lsc);

        return (0);
}

void
am7990_detach(struct am7990_softc *sc)
{

        lance_detach(&sc->lsc);
}

/*
 * Set up the initialization block and the descriptor rings.
 */
static void
am7990_meminit(struct lance_softc *sc)
{
        if_t ifp = sc->sc_ifp;
        struct leinit init;
        struct lermd rmd;
        struct letmd tmd;
        u_long a;
        int bix;

        LE_LOCK_ASSERT(sc, MA_OWNED);

        if (if_getflags(ifp) & IFF_PROMISC)
                init.init_mode = LE_MODE_NORMAL | LE_MODE_PROM;
        else
                init.init_mode = LE_MODE_NORMAL;

        init.init_padr[0] = (sc->sc_enaddr[1] << 8) | sc->sc_enaddr[0];
        init.init_padr[1] = (sc->sc_enaddr[3] << 8) | sc->sc_enaddr[2];
        init.init_padr[2] = (sc->sc_enaddr[5] << 8) | sc->sc_enaddr[4];
        lance_setladrf(sc, init.init_ladrf);

        sc->sc_last_rd = 0;
        sc->sc_first_td = sc->sc_last_td = sc->sc_no_td = 0;

        a = sc->sc_addr + LE_RMDADDR(sc, 0);
        init.init_rdra = a;
        init.init_rlen = (a >> 16) | ((ffs(sc->sc_nrbuf) - 1) << 13);

        a = sc->sc_addr + LE_TMDADDR(sc, 0);
        init.init_tdra = a;
        init.init_tlen = (a >> 16) | ((ffs(sc->sc_ntbuf) - 1) << 13);

        (*sc->sc_copytodesc)(sc, &init, LE_INITADDR(sc), sizeof(init));

        /*
         * Set up receive ring descriptors.
         */
        for (bix = 0; bix < sc->sc_nrbuf; bix++) {
                a = sc->sc_addr + LE_RBUFADDR(sc, bix);
                rmd.rmd0 = a;
                rmd.rmd1_hadr = a >> 16;
                rmd.rmd1_bits = LE_R1_OWN;
                rmd.rmd2 = -LEBLEN | LE_XMD2_ONES;
                rmd.rmd3 = 0;
                (*sc->sc_copytodesc)(sc, &rmd, LE_RMDADDR(sc, bix),
                    sizeof(rmd));
        }

        /*
         * Set up transmit ring descriptors.
         */
        for (bix = 0; bix < sc->sc_ntbuf; bix++) {
                a = sc->sc_addr + LE_TBUFADDR(sc, bix);
                tmd.tmd0 = a;
                tmd.tmd1_hadr = a >> 16;
                tmd.tmd1_bits = 0;
                tmd.tmd2 = LE_XMD2_ONES;
                tmd.tmd3 = 0;
                (*sc->sc_copytodesc)(sc, &tmd, LE_TMDADDR(sc, bix),
                    sizeof(tmd));
        }
}

static void
am7990_rint(struct lance_softc *sc)
{
        if_t ifp = sc->sc_ifp;
        struct mbuf *m;
        struct lermd rmd;
        int bix, rp;
#if defined(LANCE_REVC_BUG)
        struct ether_header *eh;
        /* Make sure this is short-aligned, for ether_cmp(). */
        static uint16_t bcast_enaddr[3] = { ~0, ~0, ~0 };
#endif

        bix = sc->sc_last_rd;

        /* Process all buffers with valid data. */
        for (;;) {
                rp = LE_RMDADDR(sc, bix);
                (*sc->sc_copyfromdesc)(sc, &rmd, rp, sizeof(rmd));

                if (rmd.rmd1_bits & LE_R1_OWN)
                        break;

                m = NULL;
                if ((rmd.rmd1_bits & (LE_R1_ERR | LE_R1_STP | LE_R1_ENP)) !=
                    (LE_R1_STP | LE_R1_ENP)) {
                        if (rmd.rmd1_bits & LE_R1_ERR) {
#ifdef LEDEBUG
                                if (rmd.rmd1_bits & LE_R1_ENP) {
                                        if ((rmd.rmd1_bits & LE_R1_OFLO) == 0) {
                                                if (rmd.rmd1_bits & LE_R1_FRAM)
                                                        if_printf(ifp,
                                                            "framing error\n");
                                                if (rmd.rmd1_bits & LE_R1_CRC)
                                                        if_printf(ifp,
                                                            "crc mismatch\n");
                                        }
                                } else
                                        if (rmd.rmd1_bits & LE_R1_OFLO)
                                                if_printf(ifp, "overflow\n");
#endif
                                if (rmd.rmd1_bits & LE_R1_BUFF)
                                        if_printf(ifp,
                                            "receive buffer error\n");
                        } else if ((rmd.rmd1_bits & (LE_R1_STP | LE_R1_ENP)) !=
                            (LE_R1_STP | LE_R1_ENP))
                                if_printf(ifp, "dropping chained buffer\n");
                } else {
#ifdef LEDEBUG
                        if (sc->sc_flags & LE_DEBUG)
                                am7990_recv_print(sc, bix);
#endif
                        /* Pull the packet off the interface. */
                        m = lance_get(sc, LE_RBUFADDR(sc, bix),
                            (int)rmd.rmd3 - ETHER_CRC_LEN);
                }

                rmd.rmd1_bits = LE_R1_OWN;
                rmd.rmd2 = -LEBLEN | LE_XMD2_ONES;
                rmd.rmd3 = 0;
                (*sc->sc_copytodesc)(sc, &rmd, rp, sizeof(rmd));

                if (++bix == sc->sc_nrbuf)
                        bix = 0;

                if (m != NULL) {
                        if_inc_counter(ifp, IFCOUNTER_IPACKETS, 1);

#ifdef LANCE_REVC_BUG
                        /*
                         * The old LANCE (Rev. C) chips have a bug which
                         * causes garbage to be inserted in front of the
                         * received packet. The workaround is to ignore
                         * packets with an invalid destination address
                         * (garbage will usually not match).
                         * Of course, this precludes multicast support...
                         */
                        eh = mtod(m, struct ether_header *);
                        if (ether_cmp(eh->ether_dhost, sc->sc_enaddr) &&
                            ether_cmp(eh->ether_dhost, bcast_enaddr)) {
                                m_freem(m);
                                continue;
                        }
#endif

                        /* Pass the packet up. */
                        LE_UNLOCK(sc);
                        if_input(ifp, m);
                        LE_LOCK(sc);
                } else
                        if_inc_counter(ifp, IFCOUNTER_IERRORS, 1);
        }

        sc->sc_last_rd = bix;
}

static void
am7990_tint(struct lance_softc *sc)
{
        if_t ifp = sc->sc_ifp;
        struct letmd tmd;
        int bix;

        bix = sc->sc_first_td;

        for (;;) {
                if (sc->sc_no_td <= 0)
                        break;

                (*sc->sc_copyfromdesc)(sc, &tmd, LE_TMDADDR(sc, bix),
                    sizeof(tmd));

#ifdef LEDEBUG
                if (sc->sc_flags & LE_DEBUG)
                        if_printf(ifp, "trans tmd: "
                            "ladr %04x, hadr %02x, flags %02x, "
                            "bcnt %04x, mcnt %04x\n",
                            tmd.tmd0, tmd.tmd1_hadr, tmd.tmd1_bits,
                            tmd.tmd2, tmd.tmd3);
#endif

                if (tmd.tmd1_bits & LE_T1_OWN)
                        break;

                if_setdrvflagbits(ifp, 0, IFF_DRV_OACTIVE);

                if (tmd.tmd1_bits & LE_T1_ERR) {
                        if (tmd.tmd3 & LE_T3_BUFF)
                                if_printf(ifp, "transmit buffer error\n");
                        else if (tmd.tmd3 & LE_T3_UFLO)
                                if_printf(ifp, "underflow\n");
                        if (tmd.tmd3 & (LE_T3_BUFF | LE_T3_UFLO)) {
                                lance_init_locked(sc);
                                return;
                        }
                        if (tmd.tmd3 & LE_T3_LCAR) {
                                if (sc->sc_flags & LE_CARRIER)
                                        if_link_state_change(ifp,
                                            LINK_STATE_DOWN);
                                sc->sc_flags &= ~LE_CARRIER;
                                if (sc->sc_nocarrier)
                                        (*sc->sc_nocarrier)(sc);
                                else
                                        if_printf(ifp, "lost carrier\n");
                        }
                        if (tmd.tmd3 & LE_T3_LCOL)
                                if_inc_counter(ifp, IFCOUNTER_COLLISIONS, 1);
                        if (tmd.tmd3 & LE_T3_RTRY) {
#ifdef LEDEBUG
                                if_printf(ifp, "excessive collisions, tdr %d\n",
                                    tmd.tmd3 & LE_T3_TDR_MASK);
#endif
                                if_inc_counter(ifp, IFCOUNTER_COLLISIONS, 16);
                        }
                        if_inc_counter(ifp, IFCOUNTER_OERRORS, 1);
                } else {
                        if (tmd.tmd1_bits & LE_T1_ONE)
                                if_inc_counter(ifp, IFCOUNTER_COLLISIONS, 1);
                        else if (tmd.tmd1_bits & LE_T1_MORE)
                                /* Real number is unknown. */
                                if_inc_counter(ifp, IFCOUNTER_COLLISIONS, 2);
                        if_inc_counter(ifp, IFCOUNTER_OPACKETS, 1);
                }

                if (++bix == sc->sc_ntbuf)
                        bix = 0;

                --sc->sc_no_td;
        }

        sc->sc_first_td = bix;

        sc->sc_wdog_timer = sc->sc_no_td > 0 ? 5 : 0;
}

/*
 * Controller interrupt
 */
void
am7990_intr(void *arg)
{
        struct lance_softc *sc = arg;
        if_t ifp = sc->sc_ifp;
        uint16_t isr;

        LE_LOCK(sc);

        if (sc->sc_hwintr && (*sc->sc_hwintr)(sc) == -1) {
                if_inc_counter(ifp, IFCOUNTER_IERRORS, 1);
                lance_init_locked(sc);
                LE_UNLOCK(sc);
                return;
        }

        isr = (*sc->sc_rdcsr)(sc, LE_CSR0);
#if defined(LEDEBUG) && LEDEBUG > 1
        if (sc->sc_flags & LE_DEBUG)
                if_printf(ifp, "%s: entering with isr=%04x\n", __func__, isr);
#endif
        if ((isr & LE_C0_INTR) == 0) {
                LE_UNLOCK(sc);
                return;
        }

        /*
         * Clear interrupt source flags and turn off interrupts. If we
         * don't clear these flags before processing their sources we
         * could completely miss some interrupt events as the NIC can
         * change these flags while we're in this handler. We toggle
         * the interrupt enable bit in order to keep receiving them
         * (some chips work without this, some don't).
         */
        (*sc->sc_wrcsr)(sc, LE_CSR0, isr & ~(LE_C0_INEA | LE_C0_TDMD |
            LE_C0_STOP | LE_C0_STRT | LE_C0_INIT));

        if (isr & LE_C0_ERR) {
                if (isr & LE_C0_BABL) {
#ifdef LEDEBUG
                        if_printf(ifp, "babble\n");
#endif
                        if_inc_counter(ifp, IFCOUNTER_OERRORS, 1);
                }
#if 0
                if (isr & LE_C0_CERR) {
                        if_printf(ifp, "collision error\n");
                        if_inc_counter(ifp, IFCOUNTER_COLLISIONS, 1);
                }
#endif
                if (isr & LE_C0_MISS) {
#ifdef LEDEBUG
                        if_printf(ifp, "missed packet\n");
#endif
                        if_inc_counter(ifp, IFCOUNTER_IERRORS, 1);
                }
                if (isr & LE_C0_MERR) {
                        if_printf(ifp, "memory error\n");
                        lance_init_locked(sc);
                        LE_UNLOCK(sc);
                        return;
                }
        }

        if ((isr & LE_C0_RXON) == 0) {
                if_printf(ifp, "receiver disabled\n");
                if_inc_counter(ifp, IFCOUNTER_IERRORS, 1);
                lance_init_locked(sc);
                LE_UNLOCK(sc);
                return;
        }
        if ((isr & LE_C0_TXON) == 0) {
                if_printf(ifp, "transmitter disabled\n");
                if_inc_counter(ifp, IFCOUNTER_OERRORS, 1);
                lance_init_locked(sc);
                LE_UNLOCK(sc);
                return;
        }

        /*
         * Pretend we have carrier; if we don't this will be cleared shortly.
         */
        if (!(sc->sc_flags & LE_CARRIER))
                if_link_state_change(ifp, LINK_STATE_UP);
        sc->sc_flags |= LE_CARRIER;

        if (isr & LE_C0_RINT)
                am7990_rint(sc);
        if (isr & LE_C0_TINT)
                am7990_tint(sc);

        /* Enable interrupts again. */
        (*sc->sc_wrcsr)(sc, LE_CSR0, LE_C0_INEA);

        if (!if_sendq_empty(ifp))
                am7990_start_locked(sc);

        LE_UNLOCK(sc);
}

/*
 * Set up output on interface.
 * Get another datagram to send off of the interface queue, and map it to the
 * interface before starting the output.
 */
static void
am7990_start_locked(struct lance_softc *sc)
{
        if_t ifp = sc->sc_ifp;
        struct letmd tmd;
        struct mbuf *m;
        int bix, enq, len, rp;

        LE_LOCK_ASSERT(sc, MA_OWNED);

        if ((if_getdrvflags(ifp) & (IFF_DRV_RUNNING | IFF_DRV_OACTIVE)) !=
            IFF_DRV_RUNNING)
                return;

        bix = sc->sc_last_td;
        enq = 0;

        for (; sc->sc_no_td < sc->sc_ntbuf &&
            !if_sendq_empty(ifp);) {
                rp = LE_TMDADDR(sc, bix);
                (*sc->sc_copyfromdesc)(sc, &tmd, rp, sizeof(tmd));

                if (tmd.tmd1_bits & LE_T1_OWN) {
                        if_setdrvflagbits(ifp, IFF_DRV_OACTIVE, 0);
                        if_printf(ifp,
                            "missing buffer, no_td = %d, last_td = %d\n",
                            sc->sc_no_td, sc->sc_last_td);
                }

                m = if_dequeue(ifp);
                if (m == NULL)
                        break;

                /*
                 * If BPF is listening on this interface, let it see the packet
                 * before we commit it to the wire.
                 */
                BPF_MTAP(ifp, m);

                /*
                 * Copy the mbuf chain into the transmit buffer.
                 */
                len = lance_put(sc, LE_TBUFADDR(sc, bix), m);

#ifdef LEDEBUG
                if (len > ETHERMTU + ETHER_HDR_LEN)
                        if_printf(ifp, "packet length %d\n", len);
#endif

                /*
                 * Init transmit registers, and set transmit start flag.
                 */
                tmd.tmd1_bits = LE_T1_OWN | LE_T1_STP | LE_T1_ENP;
                tmd.tmd2 = -len | LE_XMD2_ONES;
                tmd.tmd3 = 0;

                (*sc->sc_copytodesc)(sc, &tmd, rp, sizeof(tmd));

#ifdef LEDEBUG
                if (sc->sc_flags & LE_DEBUG)
                        am7990_xmit_print(sc, bix);
#endif

                (*sc->sc_wrcsr)(sc, LE_CSR0, LE_C0_INEA | LE_C0_TDMD);
                enq++;

                if (++bix == sc->sc_ntbuf)
                        bix = 0;

                if (++sc->sc_no_td == sc->sc_ntbuf) {
                        if_setdrvflagbits(ifp, IFF_DRV_OACTIVE, 0);
                        break;
                }
        }

        sc->sc_last_td = bix;

        if (enq > 0)
                sc->sc_wdog_timer = 5;
}

#ifdef LEDEBUG
static void
am7990_recv_print(struct lance_softc *sc, int no)
{
        if_t ifp = sc->sc_ifp;
        struct ether_header eh;
        struct lermd rmd;
        uint16_t len;

        (*sc->sc_copyfromdesc)(sc, &rmd, LE_RMDADDR(sc, no), sizeof(rmd));
        len = rmd.rmd3;
        if_printf(ifp, "receive buffer %d, len = %d\n", no, len);
        if_printf(ifp, "status %04x\n", (*sc->sc_rdcsr)(sc, LE_CSR0));
        if_printf(ifp,
            "ladr %04x, hadr %02x, flags %02x, bcnt %04x, mcnt %04x\n",
            rmd.rmd0, rmd.rmd1_hadr, rmd.rmd1_bits, rmd.rmd2, rmd.rmd3);
        if (len - ETHER_CRC_LEN >= sizeof(eh)) {
                (*sc->sc_copyfrombuf)(sc, &eh, LE_RBUFADDR(sc, no), sizeof(eh));
                if_printf(ifp, "dst %s", ether_sprintf(eh.ether_dhost));
                printf(" src %s type %04x\n", ether_sprintf(eh.ether_shost),
                    ntohs(eh.ether_type));
        }
}

static void
am7990_xmit_print(struct lance_softc *sc, int no)
{
        if_t ifp = sc->sc_ifp;
        struct ether_header eh;
        struct letmd tmd;
        uint16_t len;

        (*sc->sc_copyfromdesc)(sc, &tmd, LE_TMDADDR(sc, no), sizeof(tmd));
        len = -tmd.tmd2;
        if_printf(ifp, "transmit buffer %d, len = %d\n", no, len);
        if_printf(ifp, "status %04x\n", (*sc->sc_rdcsr)(sc, LE_CSR0));
        if_printf(ifp,
            "ladr %04x, hadr %02x, flags %02x, bcnt %04x, mcnt %04x\n",
            tmd.tmd0, tmd.tmd1_hadr, tmd.tmd1_bits, tmd.tmd2, tmd.tmd3);
        if (len >= sizeof(eh)) {
                (*sc->sc_copyfrombuf)(sc, &eh, LE_TBUFADDR(sc, no), sizeof(eh));
                if_printf(ifp, "dst %s", ether_sprintf(eh.ether_dhost));
                printf(" src %s type %04x\n", ether_sprintf(eh.ether_shost),
                    ntohs(eh.ether_type));
        }
}
#endif /* LEDEBUG */