Preliminary cut at SONIC driver. Quadra only at this point.
authorbriggs <briggs@openbsd.org>
Sun, 14 Jan 1996 21:29:28 +0000 (21:29 +0000)
committerbriggs <briggs@openbsd.org>
Sun, 14 Jan 1996 21:29:28 +0000 (21:29 +0000)
Still apparently not getting interrupts for some reason, so this is more
or less just a checkpoint.

sys/arch/mac68k/dev/if_sn.c [new file with mode: 0644]
sys/arch/mac68k/dev/if_sn.h [new file with mode: 0644]

diff --git a/sys/arch/mac68k/dev/if_sn.c b/sys/arch/mac68k/dev/if_sn.c
new file mode 100644 (file)
index 0000000..5530835
--- /dev/null
@@ -0,0 +1,1311 @@
+/*
+ * National Semiconductor  SONIC Driver
+ * Copyright (c) 1991   Algorithmics Ltd (http://www.algor.co.uk)
+ * You may use, copy, and modify this program so long as you retain the
+ * copyright line.
+ *
+ * This driver has been substantially modified since Algorithmics donated
+ * it.
+ */
+
+#include "sn.h"
+
+#include <sys/param.h>
+#include <sys/systm.h>
+#include <sys/mbuf.h>
+#include <sys/buf.h>
+#include <sys/protosw.h>
+#include <sys/socket.h>
+#include <sys/syslog.h>
+#include <sys/ioctl.h>
+#include <sys/errno.h>
+#include <sys/device.h>
+
+#include <net/if.h>
+#include <net/netisr.h>
+#include <net/route.h>
+
+#ifdef INET
+#include <netinet/in.h>
+#include <netinet/in_systm.h>
+#include <netinet/in_var.h>
+#include <netinet/ip.h>
+#include <netinet/if_ether.h>
+#endif
+
+#ifdef NS
+#include <netns/ns.h>
+#include <netns/ns_if.h>
+#endif
+
+#ifdef RMP
+#include <netrmp/rmp.h>
+#include <netrmp/rmp_var.h>
+#endif
+
+#include <vm/vm.h>
+
+#include "bpfilter.h"
+#if NBPFILTER > 0
+#include <net/bpf.h>
+#include <net/bpfdesc.h>
+#endif
+
+#define NTXB   10      /* Number of xmit buffers */
+
+#define SONICDW 32
+typedef unsigned char uchar;
+
+#include <mac68k/dev/if_sn.h>
+#define SWR(a, x)      (a) = (x)
+#define SRD(a)         ((a) & 0xffff)
+
+#define wbflush()
+
+/*
+ * Statistics collected over time
+ */
+struct sn_stats {
+       int     ls_opacks;      /* packets transmitted */
+       int     ls_ipacks;      /* packets received */
+       int     ls_tdr;         /* contents of tdr after collision */
+       int     ls_tdef;        /* packets where had to wait */
+       int     ls_tone;        /* packets with one retry */
+       int     ls_tmore;       /* packets with more than one retry */
+       int     ls_tbuff;       /* transmit buff errors */
+       int     ls_tuflo;       /* "      uflo  "     */
+       int     ls_tlcol;
+       int     ls_tlcar;
+       int     ls_trtry;
+       int     ls_rbuff;       /* receive buff errors */
+       int     ls_rfram;       /* framing     */
+       int     ls_roflo;       /* overflow    */
+       int     ls_rcrc;
+       int     ls_rrng;        /* rx ring sequence error */
+       int     ls_babl;        /* chip babl error */
+       int     ls_cerr;        /* collision error */
+       int     ls_miss;        /* missed packet */
+       int     ls_merr;        /* memory error */
+       int     ls_copies;      /* copies due to out of range mbufs */
+       int     ls_maxmbufs;    /* max mbufs on transmit */
+       int     ls_maxslots;    /* max ring slots on transmit */
+};
+
+struct sn_softc {
+       struct  device sc_dev;
+       struct  arpcom sc_ac;
+#define        sc_if           sc_ac.ac_if     /* network visible interface */
+#define        sc_enaddr       sc_ac.ac_enaddr /* hardware ethernet address */
+
+       struct sonic_reg *sc_csr;       /* hardware pointer */
+       int     sc_rxmark;              /* position in rx ring for reading buffs */
+
+       int     sc_rramark;             /* index into rra of wp */
+
+       int     sc_txhead;              /* index of first TDA passed to chip  */
+       int     sc_missed;              /* missed packet counter */
+
+       int     txb_cnt;                /* total number of xmit buffers */
+       int     txb_inuse;              /* number of active xmit buffers */
+       int     txb_new;                /* index of next open slot. */
+
+       struct  RXpkt *sc_lrxp;         /* last RDA available to chip */
+       struct  sn_stats sc_sum;
+       short   sc_iflags;
+} sn_softc;
+
+int snmatch __P((struct device *, void *, void *));
+void snattach __P((struct device *, struct device *, void *));
+
+struct cfdriver sncd = {
+       NULL, "sn", snmatch, snattach, DV_IFNET, sizeof(struct sn_softc)
+};
+
+#include <assert.h>
+void
+__assert(file, line, failedexpr)
+       const char *file, *failedexpr;
+       int line;
+{
+       (void)printf(
+           "assertion \"%s\" failed: file \"%s\", line %d\n",
+           failedexpr, file, line);
+}
+
+void 
+m_check(m)
+       struct mbuf *m;
+{
+       if (m->m_flags & M_EXT) {
+               assert(m->m_len >= 0);
+               assert(m->m_len <= m->m_ext.ext_size);
+               assert(m->m_data >= &m->m_ext.ext_buf[0]);
+               assert(m->m_data <= &m->m_ext.ext_buf[m->m_ext.ext_size]);
+               assert(m->m_data + m->m_len <= &m->m_ext.ext_buf[m->m_ext.ext_size]);
+       } else if (m->m_flags & M_PKTHDR) {
+               assert(m->m_len >= 0);
+               assert(m->m_len <= MHLEN);
+               assert(m->m_data >= m->m_pktdat);
+               assert(m->m_data <= &m->m_pktdat[MHLEN]);
+               assert(m->m_data + m->m_len <= &m->m_pktdat[MHLEN]);
+       } else {
+               assert(m->m_len >= 0);
+               assert(m->m_len <= MLEN);
+               assert(m->m_data >= m->m_dat);
+               assert(m->m_data <= &m->m_dat[MLEN]);
+               assert(m->m_data + m->m_len <= &m->m_dat[MLEN]);
+       }
+}
+
+void 
+m_checkm(m)
+       struct mbuf *m;
+{
+       while (m) {
+               m_check(m);
+               m = m->m_next;
+       }
+}
+
+int ethdebug = 0;
+
+int snintr __P((struct sn_softc *));
+int snioctl __P((struct ifnet *ifp, u_long cmd, caddr_t data));
+void snstart __P((struct ifnet *ifp));
+void snwatchdog __P(( /*int unit */ ));
+void snreset __P((struct sn_softc *sc));
+
+/*
+ * SONIC buffers need to be aligned 16 or 32 bit aligned.
+ * These macros calculate and verify alignment.
+ */
+#if SONICDW == 32
+#define SONICALIGN 4
+#else
+#define SONICALIGN 2
+#endif
+#define SOALIGN(array) (((int)array+SONICALIGN-1) & ~(SONICALIGN-1))
+#define SOALIGNED(p) (!(((uint)p)&(SONICALIGN-1)))
+
+#define LOWER(x) ((unsigned)(x) & 0xffff)
+#define UPPER(x) ((unsigned)(x) >> 16)
+
+/*
+ * buffer sizes in 32 bit mode
+ * 1 TXpkt is 4 hdr words + (3 * FRAGMAX) + 1 link word
+ * FRAGMAX == 16 => 54 words == 216 bytes
+ *
+ * 1 RxPkt is 7 words == 28 bytes
+ * 1 Rda   is 4 words == 16 bytes
+ */
+
+#define NRRA   32              /* # receive resource descriptors */
+#define RRAMASK        0x1f            /* the reason why it must be power of two */
+
+#define NRBA   16              /* # receive buffers < NRRA */
+#define NRDA   NRBA            /* # receive descriptors */
+#define NTDA   4               /* # transmit descriptors */
+
+#define CDASIZE sizeof(struct CDA)
+#define RRASIZE (NRRA*sizeof(struct RXrsrc))
+#define RDASIZE (NRDA*sizeof(struct RXpkt))
+#define TDASIZE (NTDA*sizeof(struct TXpkt))
+
+#define FCSSIZE        4               /* size of FCS append te received packets */
+
+/*
+ * maximum receive packet size plus 2 byte pad to make each
+ * one aligned. 4 byte slop (required for eobc)
+ */
+#define RBASIZE        (sizeof(struct ether_header) + ETHERMTU + FCSSIZE + 2 + 4)
+
+/*
+ * space required for descriptors
+ */
+#define DESC_SIZE (RRASIZE + CDASIZE + RDASIZE + TDASIZE + SONICALIGN - 1)
+
+/*
+ * 16k transmit buffer area
+ */
+#define TXBSIZE        1536    /* 6*2^8 -- the same size as the 8390 TXBUF */
+#define TBASIZE        (TXBSIZE * NTXB)
+
+/*
+ * Nicely aligned pointers into the SONIC buffers
+ * p_ points at physical (K1_SEG) addresses.
+ */
+struct RXrsrc  *p_rra; /* receiver resource descriptors */
+struct RXpkt   *p_rda; /* receiver desriptors */
+struct TXpkt   *p_tda; /* transmitter descriptors */
+struct CDA     *p_cda; /* CAM descriptors */
+char           *p_rba; /* receive buffer area base */
+char           *p_tba; /* transmit buffer area base */
+
+/* Meta transmit descriptors */
+struct mtd {
+       struct  mtd *mtd_link;
+       struct  TXpkt *mtd_txp;
+       unsigned char *mtd_buf;
+} mtda[NTDA];
+
+struct mtd *mtdfree;           /* list of free meta transmit descriptors */
+struct mtd *mtdhead;           /* head of descriptors assigned to chip */
+struct mtd *mtdtail;           /* tail of descriptors assigned to chip */
+struct mtd *mtdnext;           /* next descriptor to give to chip */
+
+void mtd_free __P((struct mtd *));
+struct mtd *mtd_alloc __P((void));
+
+int sngetaddr __P((struct sn_softc *sc));
+int sninit __P((int unit));
+int snstop __P((int unit));
+int sonicput __P((struct sn_softc *sc, struct mbuf *m0));
+
+void camdump __P((struct sn_softc *sc));
+
+int
+snmatch(parent, match, aux)
+       struct device *parent;
+       void *match, *aux;
+{
+       struct cfdata *cf = match;
+       struct confargs *ca = aux;
+
+       if (matchbyname(parent, cf, aux) == 0)
+               return 0;
+
+       if (!mac68k_machine.sonic)
+               return 0;
+
+       return 1;
+}
+
+/*
+ * Interface exists: make available by filling in network interface
+ * record.  System will initialize the interface when it is ready
+ * to accept packets.
+ */
+void
+snattach(parent, self, aux)
+       struct device *parent, *self;
+       void   *aux;
+{
+extern unsigned char   SONICSPACE;
+extern unsigned long   SONICSPACE_size;
+       struct sn_softc *sc = (void *)self;
+       struct confargs *ca = aux;
+       struct ifnet *ifp = &sc->sc_if;
+       struct cfdata *cf = sc->sc_dev.dv_cfdata;
+       int base, p, pp;
+
+       /* Must allocate extra memory in case we need to round later. */
+       pp = (DESC_SIZE + NRBA*RBASIZE + 0x10000 + 4 + TBASIZE);
+       if (pp != SONICSPACE_size) {
+               printf(": SONICSPACE_size (%d) != pp (%d).  Punt!\n",
+                       SONICSPACE_size, pp);
+               return;
+       }
+       base = p = (int) &SONICSPACE;
+
+#define SONIC_IO_OFFSET        0xA000
+       sc->sc_csr = (struct sonic_reg *)(IOBase + SONIC_IO_OFFSET);
+
+/*
+ * Put the pup in reset mode (sninit() will fix it later)
+ * and clear any interrupts.
+ */
+       sc->sc_csr->s_cr = CR_RST;
+       wbflush();
+       sc->sc_csr->s_isr = 0x7fff;
+       wbflush();
+
+/*
+ * because the SONIC is basically 16bit device it 'concatenates'
+ * a higher buffer address to a 16 bit offset--this will cause wrap
+ * around problems near the end of 64k !!
+ */
+       if ((p ^ (p + RRASIZE + CDASIZE)) & 0x10000)
+               p = (p + 0x10000) & ~0xffff;
+       p_rra = (struct RXrsrc *) p;
+       p += RRASIZE;
+
+       p_cda = (struct CDA *) p;
+       p += CDASIZE;
+
+       if ((p ^ (p + RDASIZE)) & 0x10000)
+               p = (p + 0x10000) & ~0xffff;
+       p_rda = (struct RXpkt *) p;
+       p += RDASIZE;
+
+       if ((p ^ (p + TDASIZE)) & 0x10000)
+               p = (p + 0x10000) & ~0xffff;
+       p_tda = (struct TXpkt *) p;
+       p += TDASIZE;
+
+       p = SOALIGN(p);
+       p_rba = (char *) p;
+       p += NRBA * RBASIZE;
+
+       p_tba = (char *) p;
+
+#if 0
+       camdump(sc);
+#endif
+       sngetaddr(sc);
+       printf(" address %s, ", ether_sprintf(sc->sc_enaddr));
+       printf("SONIC ethernet--%d bytes at 0x%x.\n", pp, base);
+
+#if 0
+printf("sonic buffers: rra=0x%x cda=0x%x rda=0x%x tda=0x%x rba=0x%x tba=0x%x\n",
+       p_rra, p_cda, p_rda, p_tda, p_rba, p_tba);
+#endif
+
+       add_nubus_intr(9, snintr, (void *) sc);
+       enable_nubus_intr();
+
+       ifp->if_name = "sn";
+       ifp->if_unit = sc->sc_dev.dv_unit;
+       ifp->if_ioctl = snioctl;
+       ifp->if_start = snstart;
+       ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
+       ifp->if_watchdog = snwatchdog;
+#if NBPFILTER > 0
+       bpfattach(&ifp->if_bpf, ifp, DLT_EN10MB, sizeof(struct ether_header));
+#endif
+       if_attach(ifp);
+       ether_ifattach(ifp);
+}
+
+int
+snioctl(ifp, cmd, data)
+       struct ifnet *ifp;
+       u_long cmd;
+       caddr_t data;
+{
+       struct ifaddr *ifa;
+       struct sn_softc *sc = sncd.cd_devs[ifp->if_unit];
+       int     s = splnet(), err = 0;
+       int     temp;
+
+       switch (cmd) {
+
+       case SIOCSIFADDR:
+               ifa = (struct ifaddr *)data;
+               ifp->if_flags |= IFF_UP;
+               switch (ifa->ifa_addr->sa_family) {
+#ifdef INET
+               case AF_INET:
+                       (void)sninit(ifp->if_unit);
+                       arp_ifinit(&sc->sc_ac, ifa);
+                       break;
+#endif
+#ifdef NS
+               case AF_NS:
+                       {
+                               struct ns_addr *ina = &(IA_SNS(ifa)->sns_addr);
+
+                               if (ns_nullhost(*ina)) {
+                                       ina->x_host = *(union ns_host *)(sc->sc_enaddr);
+                               } else {
+                                       /* XXX
+                                        * add an extra i/f address to
+                                        * sonic filter
+                                        */
+                               }
+                       }
+                       (void)sninit(ifp->if_unit);
+                       break;
+#endif /* NS */
+               default:
+                       (void)sninit(ifp->if_unit);
+                       break;
+               }
+               break;
+
+       case SIOCSIFFLAGS:
+               if ((ifp->if_flags & IFF_UP) == 0 &&
+                   ifp->if_flags & IFF_RUNNING) {
+                       snstop(ifp->if_unit);
+                       ifp->if_flags &= ~IFF_RUNNING;
+               } else if (ifp->if_flags & IFF_UP &&
+                   (ifp->if_flags & IFF_RUNNING) == 0)
+                       (void)sninit(ifp->if_unit);
+               /*
+                * If the state of the promiscuous bit changes, the interface
+                * must be reset to effect the change.
+                */
+               if (((ifp->if_flags ^ sc->sc_iflags) & IFF_PROMISC) &&
+                   (ifp->if_flags & IFF_RUNNING)) {
+                       sc->sc_iflags = ifp->if_flags;
+                       printf("change in flags\n");
+                       temp = sc->sc_if.if_flags & IFF_UP;
+                       snreset(sc);
+                       sc->sc_if.if_flags |= temp;
+                       snstart(ifp);
+               }
+               break;
+
+       case SIOCADDMULTI:
+       case SIOCDELMULTI:
+               if(cmd == SIOCADDMULTI)
+                       err = ether_addmulti((struct ifreq *)data, &sc->sc_ac);
+               else
+                       err = ether_delmulti((struct ifreq *)data, &sc->sc_ac);
+
+               if (err == ENETRESET) {
+                       /*
+                        * Multicast list has changed; set the hardware
+                        * filter accordingly. But remember UP flag!
+                        */
+                       temp = sc->sc_if.if_flags & IFF_UP;
+                       snreset(sc);
+                       sc->sc_if.if_flags |= temp;
+                       err = 0;
+               }
+               break;
+       default:
+               err = EINVAL;
+       }
+       splx(s);
+       return (err);
+}
+
+/*
+ * Encapsulate a packet of type family for the local net.
+ * Use trailer local net encapsulation if enough data in first
+ * packet leaves a multiple of 512 bytes of data in remainder.
+ */
+void
+snstart(ifp)
+       struct ifnet *ifp;
+{
+       struct sn_softc *sc = sncd.cd_devs[ifp->if_unit];
+       struct mbuf *m;
+       int     len;
+
+       if ((sc->sc_if.if_flags & (IFF_RUNNING | IFF_OACTIVE)) != IFF_RUNNING)
+               return;
+
+outloop:
+       /* Check for room in the xmit buffer. */
+       if (sc->txb_inuse == sc->txb_cnt) {
+               ifp->if_flags |= IFF_OACTIVE;
+               return;
+       }
+
+       IF_DEQUEUE(&sc->sc_if.if_snd, m);
+       if (m == 0)
+               return;
+
+       /* We need the header for m_pkthdr.len. */
+       if ((m->m_flags & M_PKTHDR) == 0)
+               panic("snstart: no header mbuf");
+
+#if NBPFILTER > 0
+       /*
+        * If bpf is listening on this interface, let it
+        * see the packet before we commit it to the wire.
+        */
+       if (sc->sc_if.if_bpf)
+               bpf_mtap(sc->sc_if.if_bpf, m);
+#endif
+
+       /*
+        * If there is nothing in the o/p queue, and there is room in
+        * the Tx ring, then send the packet directly.  Otherwise append
+        * it to the o/p queue.
+        */
+       len = sonicput(sc, m);
+#if DIAGNOSTIC
+       if (len != m->m_pkthdr.len) {
+               printf("snstart: len %d != m->m_pkthdr.len %d.\n",
+                       len, m->m_pkthdr.len);
+       }
+#endif
+       len = m->m_pkthdr.len;
+
+       m_freem(m);
+
+       /* Point to next buffer slot and wrap if necessary. */
+       if (++sc->txb_new == sc->txb_cnt)
+               sc->txb_new = 0;
+
+       sc->txb_inuse++;
+
+       sc->sc_if.if_opackets++;        /* # of pkts */
+       sc->sc_sum.ls_opacks++;         /* # of pkts */
+
+       /* Jump back for possibly more punishment. */
+       goto outloop;
+}
+
+/*
+ * This is called from sonicioctl() when /etc/ifconfig is run to set
+ * the address or switch the i/f on.
+ */
+void caminitialise __P((void));
+void camentry __P((int, unsigned char *ea));
+void camprogram __P((struct sn_softc *));
+void initialise_tda __P((struct sn_softc *));
+void initialise_rda __P((struct sn_softc *));
+void initialise_rra __P((struct sn_softc *));
+void initialise_tba __P((struct sn_softc *));
+
+/*
+ * reset and restart the SONIC.  Called in case of fatal
+ * hardware/software errors.
+ */
+void
+snreset(sc)
+       struct sn_softc *sc;
+{
+       printf("snreset\n");
+       snstop(sc->sc_dev.dv_unit);
+       sninit(sc->sc_dev.dv_unit);
+}
+
+int 
+sninit(unit)
+       int unit;
+{
+       struct sn_softc *sc = sncd.cd_devs[unit];
+       struct sonic_reg *csr = sc->sc_csr;
+       int s, error;
+
+       if (sc->sc_if.if_flags & IFF_RUNNING)
+               /* already running */
+               return (0);
+
+       s = splnet();
+
+       csr->s_cr = CR_RST;     /* s_dcr only accessable reset mode! */
+
+       /* config it */
+       csr->s_dcr = DCR_LBR | DCR_SYNC | DCR_WAIT0 | DCR_DW32 | DCR_DMABLOCK |
+           DCR_RFT16 | DCR_TFT16;
+       csr->s_rcr = RCR_BRD | RCR_LBNONE;
+       csr->s_imr = IMR_PRXEN | IMR_PTXEN | IMR_TXEREN | IMR_HBLEN | IMR_LCDEN;
+
+       /* clear pending interrupts */
+       csr->s_isr = 0x7fff;
+
+       /* clear tally counters */
+       csr->s_crct = -1;
+       csr->s_faet = -1;
+       csr->s_mpt = -1;
+
+       initialise_tda(sc);
+       initialise_rda(sc);
+       initialise_rra(sc);
+       initialise_tba(sc);
+
+       /* enable the chip */
+       csr->s_cr = 0;
+       wbflush();
+
+       /* program the CAM with our address */
+       caminitialise();
+       camentry(0, sc->sc_enaddr);
+       camprogram(sc);
+
+       /* get it to read resource descriptors */
+       csr->s_cr = CR_RRRA;
+       wbflush();
+       while (csr->s_cr & CR_RRRA)
+               continue;
+
+       /* enable rx */
+       csr->s_cr = CR_RXEN;
+       wbflush();
+
+       /* flag interface as "running" */
+       sc->sc_if.if_flags |= IFF_RUNNING;
+
+       splx(s);
+       return (0);
+
+bad:
+       snstop(sc->sc_dev.dv_unit);
+       return (error);
+}
+
+/*
+ * close down an interface and free its buffers
+ * Called on final close of device, or if sninit() fails
+ * part way through.
+ */
+int 
+snstop(unit)
+       int unit;
+{
+       struct sn_softc *sc = sncd.cd_devs[unit];
+       struct mtd *mtd;
+       int s = splnet();
+
+       /* stick chip in reset */
+       sc->sc_csr->s_cr = CR_RST;
+       wbflush();
+
+       /* free all receive buffers (currently static so nothing to do) */
+
+       /* free all pending transmit mbufs */
+       while (mtd = mtdhead) {
+               mtdhead = mtdhead->mtd_link;
+               mtd->mtd_buf = 0;
+               mtd_free(mtd);
+       }
+       mtdnext = mtd_alloc();
+       sc->txb_inuse = 0;
+
+       sc->sc_if.if_timer = 0;
+       sc->sc_if.if_flags &= ~(IFF_RUNNING | IFF_UP);
+
+       splx(s);
+       return (0);
+}
+
+/*
+ * Called if any Tx packets remain unsent after 5 seconds,
+ * In all cases we just reset the chip, and any retransmission
+ * will be handled by higher level protocol timeouts.
+ */
+void
+snwatchdog(unit)
+       int unit;
+{
+       struct sn_softc *sc = sncd.cd_devs[unit];
+       int temp;
+
+       if (mtdhead && mtdhead->mtd_buf) {
+               /* something still pending for transmit */
+               if (mtdhead->mtd_txp->status == 0)
+                       log(LOG_ERR, "%s%d: Tx - timeout\n",
+                           sc->sc_if.if_name, sc->sc_if.if_unit);
+               else
+                       log(LOG_ERR, "%s%d: Tx - lost interrupt\n",
+                           sc->sc_if.if_name, sc->sc_if.if_unit);
+               temp = sc->sc_if.if_flags & IFF_UP;
+               snreset(sc);
+               sc->sc_if.if_flags |= temp;
+       }
+}
+
+/*
+ * stuff packet into sonic (at splnet)
+ */
+int 
+sonicput(sc, m0)
+       struct sn_softc *sc;
+       struct mbuf *m0;
+{
+       struct sonic_reg *csr = sc->sc_csr;
+       unsigned char   *buff, *buffer, *data;
+       struct TXpkt *txp;
+       struct mtd *mtdnew;
+       struct mbuf *m;
+       int i, len = 0, totlen = 0;
+
+       /* grab the replacement mtd */
+       if ((mtdnew = mtd_alloc()) == 0)
+               return (0);
+
+       /* We are guaranteed, if we get here, that the xmit buffer is free. */
+       buff = buffer = p_tba + sc->txb_new * TXBSIZE;
+       
+       /* this packet goes to mdtnext fill in the TDA */
+       mtdnext->mtd_buf = buffer;
+       txp = mtdnext->mtd_txp;
+       SWR(txp->config, 0);
+
+       for (m = m0; m; m = m->m_next) {
+               data = mtod(m, u_char *);
+               len = m->m_len;
+               totlen += len;
+               bcopy(data, buff, len);
+               buff += len;
+       }
+       if (totlen >= TXBSIZE) {
+               panic("packet overflow in sonicput.");
+       }
+       SWR(txp->u[0].frag_ptrlo, LOWER(buffer));
+       SWR(txp->u[0].frag_ptrhi, UPPER(buffer));
+       SWR(txp->u[0].frag_size, totlen);
+
+       if (len < ETHERMIN + sizeof(struct ether_header)) {
+               int pad = ETHERMIN + sizeof(struct ether_header) - totlen;
+printf("Padding %d to %d bytes\n", totlen, totlen+pad);
+               bzero(buffer + totlen, pad);
+               SWR(txp->u[0].frag_size, pad + SRD(txp->u[0].frag_size));
+               totlen = ETHERMIN + sizeof(struct ether_header);
+       }
+       SWR(txp->frag_count, 1);
+       SWR(txp->pkt_size, totlen);
+
+       /* link onto the next mtd that will be used */
+       SWR(txp->u[0].tlink, LOWER(mtdnew->mtd_txp) | EOL);
+
+       if (mtdhead == 0) {
+               /* no current transmit list start with this one */
+               mtdtail = mtdhead = mtdnext;
+               csr->s_ctda = LOWER(txp);
+       } else {
+               /*
+                * have a transmit list append it to end note
+                * mtdnext is already physicaly linked to mtdtail in
+                * mtdtail->mtd_txp->u[mtdtail->mtd_txp->frag_count].tlink
+                */
+               SWR(mtdtail->mtd_txp->u[mtdtail->mtd_txp->frag_count].tlink,
+                   SRD(mtdtail->mtd_txp->u[mtdtail->mtd_txp->frag_count].tlink) & ~EOL);
+               mtdtail = mtdnext;
+       }
+       mtdnext->mtd_link = mtdnew;
+       mtdnext = mtdnew;
+
+       /* make sure chip is running */
+       wbflush();
+       csr->s_cr = CR_TXP;
+       wbflush();
+       sc->sc_if.if_timer = 5; /* 5 seconds to watch for failing to transmit */
+       return (totlen);
+}
+
+/*
+ *  Read out the ethernet address from the cam. It is stored
+ *  there by the boot when doing a loopback test. Thus we don't
+ *  have to fetch it from nv ram.
+ */
+int 
+sngetaddr(sc)
+       struct sn_softc *sc;
+{
+       unsigned i, x, y;
+       char   *cp, *ea;
+
+       sc->sc_csr->s_cr = CR_RST;
+       wbflush();
+       sc->sc_csr->s_cep = 15; /* For some reason, Apple fills top first. */
+       i = sc->sc_csr->s_cap2;
+       wbflush();
+       sc->sc_enaddr[5] = i >> 8;
+       sc->sc_enaddr[4] = i;
+       i = sc->sc_csr->s_cap1;
+       wbflush();
+       sc->sc_enaddr[3] = i >> 8;
+       sc->sc_enaddr[2] = i;
+       i = sc->sc_csr->s_cap0;
+       wbflush();
+       sc->sc_enaddr[1] = i >> 8;
+       sc->sc_enaddr[0] = i;
+
+       sc->sc_csr->s_cr = 0;
+       wbflush();
+       return (0);
+}
+
+void sonictxint __P((struct sn_softc *));
+void sonicrxint __P((struct sn_softc *));
+
+int sonic_read __P((struct sn_softc *, struct RXpkt *));
+struct mbuf *sonic_get __P((struct sn_softc *, struct ether_header *, int));
+
+void 
+mtd_free(mtd)
+       struct mtd *mtd;
+{
+       mtd->mtd_link = mtdfree;
+       mtdfree = mtd;
+}
+
+struct mtd *
+mtd_alloc()
+{
+       struct mtd *mtd = mtdfree;
+
+       if (mtd) {
+               mtdfree = mtd->mtd_link;
+               mtd->mtd_link = 0;
+       }
+       return (mtd);
+}
+
+/*
+ * CAM support
+ */
+void 
+caminitialise()
+{
+       int     i;
+
+       for (i = 0; i < MAXCAM; i++)
+               SWR(p_cda->desc[i].cam_ep, i);
+       SWR(p_cda->enable, 0);
+}
+
+void 
+camentry(entry, ea)
+       int entry;
+       unsigned char *ea;
+{
+       SWR(p_cda->desc[entry].cam_ep, entry);
+       SWR(p_cda->desc[entry].cam_ap2, (ea[5] << 8) | ea[4]);
+       SWR(p_cda->desc[entry].cam_ap1, (ea[3] << 8) | ea[2]);
+       SWR(p_cda->desc[entry].cam_ap0, (ea[1] << 8) | ea[0]);
+       SWR(p_cda->enable, SRD(p_cda->enable) | (1 << entry));
+}
+
+void 
+camprogram(sc)
+       struct sn_softc *sc;
+{
+       struct sonic_reg *csr;
+       int     timeout;
+       int     i;
+
+       csr = sc->sc_csr;
+       csr->s_cdp = LOWER(p_cda);
+       csr->s_cdc = MAXCAM;
+       csr->s_cr = CR_LCAM;
+       wbflush();
+
+       timeout = 10000;
+       while (csr->s_cr & CR_LCAM && timeout--)
+               continue;
+       if (timeout == 0) {
+               /* XXX */
+               panic("sonic: CAM initialisation failed\n");
+       }
+       timeout = 10000;
+       while ((csr->s_isr & ISR_LCD) == 0 && timeout--)
+               continue;
+
+       if (csr->s_isr & ISR_LCD)
+               csr->s_isr = ISR_LCD;
+       else
+               printf("sonic: CAM initialisation without interrupt\n");
+}
+
+#if 0
+void 
+camdump(sc)
+       struct sn_softc *sc;
+{
+       struct sonic_reg *csr = sc->sc_csr;
+       int i;
+
+       printf("CAM entries:\n");
+       csr->s_cr = CR_RST;
+       wbflush();
+
+       for (i = 0; i < 16; i++) {
+               ushort  ap2, ap1, ap0;
+               csr->s_cep = i;
+               wbflush();
+               ap2 = csr->s_cap2;
+               ap1 = csr->s_cap1;
+               ap0 = csr->s_cap0;
+               printf("%d: ap2=0x%x ap1=0x%x ap0=0x%x\n", i, ap2, ap1, ap0);
+       }
+       printf("CAM enable 0x%x\n", csr->s_cep);
+
+       csr->s_cr = 0;
+       wbflush();
+}
+#endif
+
+void 
+initialise_tda(sc)
+       struct sn_softc *sc;
+{
+       struct sonic_reg *csr;
+       struct mtd *mtd;
+       int     i;
+
+       csr = sc->sc_csr;
+
+       mtdfree = mtdhead = mtdtail = (struct mtd *) 0;
+
+       for (i = 0; i < NTDA; i++) {
+               mtd = &mtda[i];
+               mtd->mtd_txp = &p_tda[i];
+               mtd->mtd_buf = 0;
+               mtd_free(mtd);
+       }
+       mtdnext = mtd_alloc();
+
+       csr->s_utda = UPPER(p_tda);
+}
+
+void 
+initialise_rda(sc)
+       struct sn_softc *sc;
+{
+       struct sonic_reg *csr;
+       int     i;
+
+       csr = sc->sc_csr;
+
+       /* link the RDA's together into a circular list */
+       for (i = 0; i < (NRDA - 1); i++) {
+               SWR(p_rda[i].rlink, LOWER(&p_rda[i + 1]));
+               SWR(p_rda[i].in_use, 1);
+       }
+       SWR(p_rda[NRDA - 1].rlink, LOWER(&p_rda[0]) | EOL);
+       SWR(p_rda[NRDA - 1].in_use, 1);
+
+       /* mark end of receive descriptor list */
+       sc->sc_lrxp = &p_rda[NRDA - 1];
+
+       sc->sc_rxmark = 0;
+
+       csr->s_urda = UPPER(&p_rda[0]);
+       csr->s_crda = LOWER(&p_rda[0]);
+       wbflush();
+}
+
+void 
+initialise_rra(sc)
+       struct sn_softc *sc;
+{
+       struct sonic_reg *csr;
+       int     i;
+
+       csr = sc->sc_csr;
+
+       csr->s_eobc = RBASIZE / 2 - 2;  /* must be >= MAXETHERPKT */
+       csr->s_urra = UPPER(p_rra);
+       csr->s_rsa = LOWER(p_rra);
+       csr->s_rea = LOWER(&p_rra[NRRA]);
+       csr->s_rrp = LOWER(p_rra);
+
+       /* fill up SOME of the rra with buffers */
+       for (i = 0; i < NRBA; i++) {
+               SWR(p_rra[i].buff_ptrhi, UPPER(&p_rba[i * RBASIZE]));
+               SWR(p_rra[i].buff_ptrlo, LOWER(&p_rba[i * RBASIZE]));
+               SWR(p_rra[i].buff_wchi, UPPER(RBASIZE / 2));
+               SWR(p_rra[i].buff_wclo, LOWER(RBASIZE / 2));
+       }
+       sc->sc_rramark = NRBA;
+       csr->s_rwp = LOWER(&p_rra[sc->sc_rramark]);
+       wbflush();
+}
+
+void 
+initialise_tba(sc)
+       struct sn_softc *sc;
+{
+       int     i;
+
+       sc->txb_cnt = NTXB;
+       sc->txb_inuse = 0;
+       sc->txb_new = 0;
+}
+
+int 
+snintr(sc)
+       struct sn_softc *sc;
+{
+       struct sonic_reg *csr = sc->sc_csr;
+       int     isr;
+
+       while (isr = (csr->s_isr & ISR_ALL)) {
+printf("snintr: %x.\n", isr);
+               /* scrub the interrupts that we are going to service */
+               csr->s_isr = isr;
+               wbflush();
+
+               if (isr & (ISR_BR | ISR_LCD | ISR_PINT | ISR_TC))
+                       printf("sonic: unexpected interrupt status 0x%x\n", isr);
+
+               if (isr & (ISR_TXDN | ISR_TXER))
+                       sonictxint(sc);
+
+               if (isr & ISR_PKTRX)
+                       sonicrxint(sc);
+
+               if (isr & (ISR_HBL | ISR_RDE | ISR_RBE | ISR_RBAE | ISR_RFO)) {
+                       if (isr & ISR_HBL)
+                               printf("sonic: no heartbeat\n");
+                       if (isr & ISR_RDE)
+                               printf("sonic: receive descriptors exhausted\n");
+                       if (isr & ISR_RBE)
+                               printf("sonic: receive buffers exhausted\n");
+                       if (isr & ISR_RBAE)
+                               printf("sonic: receive buffer area exhausted\n");
+                       if (isr & ISR_RFO)
+                               printf("sonic: receive FIFO overrun\n");
+               }
+               if (isr & (ISR_CRC | ISR_FAE | ISR_MP)) {
+#ifdef notdef
+                       if (isr & ISR_CRC)
+                               sc->sc_crctally++;
+                       if (isr & ISR_FAE)
+                               sc->sc_faetally++;
+                       if (isr & ISR_MP)
+                               sc->sc_mptally++;
+#endif
+               }
+               snstart(&sc->sc_if);
+       }
+       return (1);
+}
+
+/*
+ * Transmit interrupt routine
+ */
+void 
+sonictxint(sc)
+       struct sn_softc *sc;
+{
+       struct TXpkt *txp;
+       struct sonic_reg *csr;
+       struct mtd *mtd;
+
+       if (mtdhead == (struct mtd *) 0)
+               return;
+
+       csr = sc->sc_csr;
+
+       while (mtd = mtdhead) {
+               if (mtd->mtd_buf == 0)
+                       break;
+
+               txp = mtd->mtd_txp;
+
+               if (SRD(txp->status) == 0)      /* it hasn't really gone yet */
+                       return;
+
+               if (ethdebug) {
+                       struct ether_header *eh;
+
+                       eh = (struct ether_header *) mtd->mtd_buf;
+                       printf("xmit status=0x%x len=%d type=0x%x from %s",
+                           txp->status,
+                           txp->pkt_size,
+                           htons(eh->ether_type),
+                           ether_sprintf(eh->ether_shost));
+                       printf(" (to %s)\n", ether_sprintf(eh->ether_dhost));
+               }
+               sc->txb_inuse--;
+               mtd->mtd_buf = 0;
+               mtdhead = mtd->mtd_link;
+
+               mtd_free(mtd);
+
+               /* XXX - Do stats here. */
+
+               if ((SRD(txp->status) & TCR_PTX) == 0) {
+                       printf("sonic: Tx packet status=0x%x\n", txp->status);
+
+                       if (mtdhead != mtdnext) {
+                               printf("resubmitting remaining packets\n");
+                               csr->s_ctda = LOWER(mtdhead->mtd_txp);
+                               csr->s_cr = CR_TXP;
+                               wbflush();
+                               return;
+                       }
+               }
+       }
+       /* mtdhead should be at mtdnext (go) */
+       assert(mtdhead == mtdnext);
+       assert(mtdhead->mtd_link == 0);
+       mtdhead = 0;
+}
+
+/*
+ * Receive interrupt routine
+ */
+void 
+sonicrxint(sc)
+       struct sn_softc *sc;
+{
+       struct sonic_reg *csr = sc->sc_csr;
+       struct RXpkt *rxp;
+       u_long  addr;
+       int     orra;
+
+       rxp = &p_rda[sc->sc_rxmark];
+
+       while (SRD(rxp->in_use) == 0) {
+               unsigned status = SRD(rxp->status);
+               if ((status & RCR_LPKT) == 0)
+                       printf("sonic: more than one packet in RBA!\n");
+               assert(PSNSEQ(SRD(rxp->seq_no)) == 0);
+
+               if (status & RCR_PRX) {
+                       if (sonic_read(sc, rxp)) {
+                               sc->sc_if.if_ipackets++;
+                               sc->sc_sum.ls_ipacks++;
+                               sc->sc_missed = 0;
+                       }
+               } else
+                       sc->sc_if.if_ierrors++;
+
+               /*
+                * give receive buffer area back to chip XXX what buffer
+                * did the sonic use for this descriptor answer look at
+                * the rba sequence number !! 
+                */
+               orra = RBASEQ(SRD(rxp->seq_no)) & RRAMASK;
+
+               assert(SRD(rxp->pkt_ptrhi) == SRD(p_rra[orra].buff_ptrhi));
+               assert(SRD(rxp->pkt_ptrlo) == SRD(p_rra[orra].buff_ptrlo));
+               assert(SRD(p_rra[orra].buff_wclo));
+
+               /*
+                * orra is now empty of packets and can be freed if
+                * sonic read didnt copy it out then we would have to
+                * wait !!
+                * (dont bother add it back in again straight away)
+                */
+               p_rra[sc->sc_rramark] = p_rra[orra];
+
+               /* zap old rra for fun */
+               p_rra[orra].buff_wchi = 0;
+               p_rra[orra].buff_wclo = 0;
+
+               sc->sc_rramark = (sc->sc_rramark + 1) & RRAMASK;
+               csr->s_rwp = LOWER(&p_rra[sc->sc_rramark]);
+               wbflush();
+
+               /*
+                * give receive descriptor back to chip simple
+                * list is circular
+                */
+               SWR(rxp->in_use, 1);
+               SWR(rxp->rlink, SRD(rxp->rlink) | EOL);
+               SWR(sc->sc_lrxp->rlink, SRD(sc->sc_lrxp->rlink) & ~EOL);
+               sc->sc_lrxp = rxp;
+
+               if (++sc->sc_rxmark >= NRDA)
+                       sc->sc_rxmark = 0;
+               rxp = &p_rda[sc->sc_rxmark];
+       }
+}
+
+/*
+ * sonic_read -- pull packet off interface and forward to
+ * appropriate protocol handler
+ */
+int 
+sonic_read(sc, rxp)
+       struct sn_softc *sc;
+       struct RXpkt *rxp;
+{
+       struct ifnet *ifp = &sc->sc_if;
+       /*extern char *ether_sprintf();*/
+       struct ether_header *et;
+       struct mbuf *m;
+       int     len, off, i;
+       caddr_t pkt;
+
+       /*
+         * Get input data length.
+         * Get pointer to ethernet header (in input buffer).
+         * Deal with trailer protocol: if type is PUP trailer
+         * get true type from first 16-bit word past data.
+         * Remember that type was trailer by setting off.
+         */
+
+       len = SRD(rxp->byte_count) - sizeof(struct ether_header) - FCSSIZE;
+       pkt = (caddr_t)((SRD(rxp->pkt_ptrhi) << 16) | SRD(rxp->pkt_ptrlo));
+       et = (struct ether_header *)pkt;
+
+       if (ethdebug) {
+               printf("rcvd 0x%x status=0x%x, len=%d type=0x%x from %s",
+                   et, rxp->status, len, htons(et->ether_type),
+                   ether_sprintf(et->ether_shost));
+               printf(" (to %s)\n", ether_sprintf(et->ether_dhost));
+       }
+       if (len < ETHERMIN || len > ETHERMTU) {
+               printf("sonic: invalid packet length %d bytes\n", len);
+               return (0);
+       }
+
+#if NBPFILTER > 0
+       /*
+        * Check if there's a bpf filter listening on this interface.
+        * If so, hand off the raw packet to enet, then discard things
+        * not destined for us (but be sure to keep broadcast/multicast).
+        */
+       if (sc->sc_if.if_bpf) {
+               bpf_tap(sc->sc_if.if_bpf, pkt,
+                   len + sizeof(struct ether_header));
+               if ((ifp->if_flags & IFF_PROMISC) != 0 &&
+                   (et->ether_dhost[0] & 1) == 0 && /* !mcast and !bcast */
+                   bcmp(et->ether_dhost, sc->sc_enaddr,
+                           sizeof(et->ether_dhost)) != 0)
+                       return;
+       }
+#endif
+       m = sonic_get(sc, et, len);
+       if (m == NULL)
+               return (0);
+       ether_input(ifp, et, m);
+       return(1);
+}
+
+#define sonicdataaddr(eh, off, type)       ((type)(((caddr_t)((eh)+1)+(off))))
+
+/*
+ * munge the received packet into an mbuf chain
+ * because we are using stupid buffer management this
+ * is slow.
+ */
+struct mbuf *
+sonic_get(sc, eh, datalen)
+       struct sn_softc *sc;
+       struct ether_header *eh;
+       int datalen;
+{
+       struct mbuf *m;
+       struct mbuf *top = 0, **mp = &top;
+       int     len;
+       char   *spkt = sonicdataaddr(eh, 0, caddr_t);
+       char   *epkt = spkt + datalen;
+       char *cp = spkt;
+
+       epkt = cp + datalen;
+       MGETHDR(m, M_DONTWAIT, MT_DATA);
+       if (m == 0)
+               return (0);
+       m->m_pkthdr.rcvif = &sc->sc_if;
+       m->m_pkthdr.len = datalen;
+       m->m_len = MHLEN;
+
+       while (datalen > 0) {
+               if (top) {
+                       MGET(m, M_DONTWAIT, MT_DATA);
+                       if (m == 0) {
+                               m_freem(top);
+                               return (0);
+                       }
+                       m->m_len = MLEN;
+               }
+               len = min(datalen, epkt - cp);
+               if (len >= MINCLSIZE) {
+                       MCLGET(m, M_DONTWAIT);
+                       if (m->m_flags & M_EXT)
+                               m->m_len = len = min(len, MCLBYTES);
+                       else
+                               len = m->m_len;
+               } else {
+                       /*
+                        * Place initial small packet/header at end of mbuf.
+                        */
+                       if (len < m->m_len) {
+                               if (top == 0 && len + max_linkhdr <= m->m_len)
+                                       m->m_data += max_linkhdr;
+                               m->m_len = len;
+                       } else
+                               len = m->m_len;
+               }
+               bcopy(cp, mtod(m, caddr_t), (unsigned) len);
+               cp += len;
+               *mp = m;
+               mp = &m->m_next;
+               datalen -= len;
+               if (cp == epkt)
+                       cp = spkt;
+       }
+       return (top);
+}
diff --git a/sys/arch/mac68k/dev/if_sn.h b/sys/arch/mac68k/dev/if_sn.h
new file mode 100644 (file)
index 0000000..9b2789e
--- /dev/null
@@ -0,0 +1,346 @@
+/*
+ * Copyright (c) 1991   Algorithmics Ltd (http://www.algor.co.uk)
+ * You may use, copy, and modify this program so long as you retain the
+ * copyright line.
+ */
+
+/*
+ * if_sonic.h -- National Semiconductor DP83932BVF (SONIC)
+ */
+
+/*
+ * Accessing SONIC data structures and registers as 32 bit values
+ * makes code endianess independent.  The SONIC is however always in
+ * bigendian mode so it is necessary to ensure that data structures shared
+ * between the CPU and the SONIC are always in bigendian order.
+ */
+
+/*
+ * Receive Resource Descriptor
+ * This structure describes the buffers into which packets
+ * will be received.  Note that more than one packet may be
+ * packed into a single buffer if constraints permit.
+ */
+#if SONICDW == 32
+struct RXrsrc {
+       u_long  buff_ptrlo;     /* buffer address LO */
+       u_long  buff_ptrhi;     /* buffer address HI */
+       u_long  buff_wclo;      /* buffer size (16bit words) LO */ 
+       u_long  buff_wchi;      /* buffer size (16bit words) HI */
+};
+#endif
+
+/*
+ * Receive Descriptor
+ * This structure holds information about packets received.
+ */
+#if SONICDW == 32
+struct RXpkt {
+       u_long  status;         /* + receive status */
+       u_long  byte_count;     /* + packet byte count (including FCS) */
+       u_long  pkt_ptrlo;      /* + packet data LO (in RBA) */
+       u_long  pkt_ptrhi;      /* + packet data HI (in RBA) */
+       u_long  seq_no;         /* + RBA sequence numbers */
+       u_long  rlink;          /* link to next receive descriptor */
+       u_long  in_use;         /* + packet available to SONIC */
+};
+#endif
+#define RBASEQ(x) (((x)>>8)&0xff)
+#define PSNSEQ(x) ((x) & 0xff)
+
+/*
+ * Transmit Descriptor
+ * This structure holds information about packets to be transmitted.
+ */
+#define FRAGMAX        32              /* maximum number of fragments in a packet */
+#if SONICDW == 32
+struct TXpkt {
+       u_long  status;         /* + transmitted packet status */
+       u_long  config;         /* transmission configuration */
+       u_long  pkt_size;       /* entire packet size in bytes */
+       u_long  frag_count;     /* # fragments in packet */
+       union {
+               struct {
+                       u_long  _frag_ptrlo;    /* pointer to packet fragment LO */
+                       u_long  _frag_ptrhi;    /* pointer to packet fragment HI */
+                       u_long  _frag_size;     /* fragment size */
+               } u_frag;
+               struct {
+                       u_long  _tlink;         /* link to next transmit descriptor */
+               } u_link;
+       } u[FRAGMAX];
+       u_long  :32;            /* This makes tcp->u[FRAGMAX].u_link.link valid! */
+};
+#endif
+
+#define frag_ptrlo u_frag._frag_ptrlo
+#define frag_ptrhi u_frag._frag_ptrhi
+#define frag_size u_frag._frag_size
+#define tlink u_link._tlink
+
+#define EOL    0x0001          /* end of list marker for link fields */
+
+#define MAXCAM 16      /* number of user entries in CAM */
+#if SONICDW == 32
+struct CDA {
+       struct {
+               u_long  cam_ep;         /* CAM Entry Pointer */
+               u_long  cam_ap0;        /* CAM Address Port 0 xx-xx-xx-xx-YY-YY */
+               u_long  cam_ap1;        /* CAM Address Port 1 xx-xx-YY-YY-xxxx */
+               u_long  cam_ap2;        /* CAM Address Port 2 YY-YY-xx-xx-xx-xx */
+       } desc[MAXCAM];
+       u_long  enable;         /* mask enabling CAM entries */
+};
+#endif
+
+/*
+ * SONIC registers as seen by the processor
+ */
+struct sonic_reg {
+       volatile u_long s_cr;           /* 00: Command */
+       volatile u_long s_dcr;          /* 01: Data Configuration */
+       volatile u_long s_rcr;          /* 02: Receive Control */
+       volatile u_long s_tcr;          /* 03: Transmit Control */
+       volatile u_long s_imr;          /* 04: Interrupt Mask */
+       volatile u_long s_isr;          /* 05: Interrupt Status */
+       volatile u_long s_utda;         /* 06: Upper Transmit Descriptor Address */
+       volatile u_long s_ctda;         /* 07: Current Transmit Descriptor Address */
+       volatile u_long _s_tps;         /* 08* Transmit Packet Size */
+       volatile u_long _s_tfc;         /* 09* Transmit Fragment Count */
+       volatile u_long _s_tsa0;        /* 0a* Transmit Start Address 0 */
+       volatile u_long _s_tsa1;        /* 0b* Transmit Start Address 1 */
+       volatile u_long _s_tfs;         /* 0c* Transmit Fragment Size */
+       volatile u_long s_urda;         /* 0d: Upper Receive Descriptor Address */
+       volatile u_long s_crda;         /* 0e: Current Receive Descriptor Address */
+       volatile u_long _s_crba0;       /* 0f* Current Receive Buffer Address 0 */
+       volatile u_long _s_crba1;       /* 10* Current Receive Buffer Address 1 */
+       volatile u_long _s_rbwc0;       /* 11* Remaining Buffer Word Count 0 */
+       volatile u_long _s_rbwc1;       /* 12* Remaining Buffer Word Count 1 */
+       volatile u_long s_eobc;         /* 13: End Of Buffer Word Count */
+       volatile u_long s_urra;         /* 14: Upper Receive Resource Address */
+       volatile u_long s_rsa;          /* 15: Resource Start Address */
+       volatile u_long s_rea;          /* 16: Resource End Address */
+       volatile u_long s_rrp;          /* 17: Resource Read Pointer */
+       volatile u_long s_rwp;          /* 18: Resource Write Pointer */
+       volatile u_long _s_trba0;       /* 19* Temporary Receive Buffer Address 0 */
+       volatile u_long _s_trba1;       /* 1a* Temporary Receive Buffer Address 1 */
+       volatile u_long _s_tbwc0;       /* 1b* Temporary Buffer Word Count 0 */
+       volatile u_long _s_tbwc1;       /* 1c* Temporary Buffer Word Count 1 */
+       volatile u_long _s_addr0;       /* 1d* Address Generator 0 */
+       volatile u_long _s_addr1;       /* 1e* Address Generator 1 */
+       volatile u_long _s_llfa;        /* 1f* Last Link Field Address */
+       volatile u_long _s_ttda;        /* 20* Temp Transmit Descriptor Address */
+       volatile u_long s_cep;          /* 21: CAM Entry Pointer */
+       volatile u_long s_cap2;         /* 22: CAM Address Port 2 */
+       volatile u_long s_cap1;         /* 23: CAM Address Port 1 */
+       volatile u_long s_cap0;         /* 24: CAM Address Port 0 */
+       volatile u_long s_ce;           /* 25: CAM Enable */
+       volatile u_long s_cdp;          /* 26: CAM Descriptor Pointer */
+       volatile u_long s_cdc;          /* 27: CAM Descriptor Count */
+       volatile u_long s_sr;           /* 28: Silicon Revision */
+       volatile u_long s_wt0;          /* 29: Watchdog Timer 0 */
+       volatile u_long s_wt1;          /* 2a: Watchdog Timer 1 */
+       volatile u_long s_rsc;          /* 2b: Receive Sequence Counter */
+       volatile u_long s_crct;         /* 2c: CRC Error Tally */
+       volatile u_long s_faet;         /* 2d: FAE Tally */
+       volatile u_long s_mpt;          /* 2e: Missed Packet Tally */
+       volatile u_long _s_mdt;         /* 2f* Maximum Deferral Timer */
+       volatile u_long _s_rtc;         /* 30* Receive Test Control */
+       volatile u_long _s_ttc;         /* 31* Transmit Test Control */
+       volatile u_long _s_dtc;         /* 32* DMA Test Control */
+       volatile u_long _s_cc0;         /* 33* CAM Comparison 0 */
+       volatile u_long _s_cc1;         /* 34* CAM Comparison 1 */
+       volatile u_long _s_cc2;         /* 35* CAM Comparison 2 */
+       volatile u_long _s_cm;          /* 36* CAM Match */
+       volatile u_long :32;            /* 37* reserved */
+       volatile u_long :32;            /* 38* reserved */
+       volatile u_long _s_rbc;         /* 39* Receiver Byte Count */
+       volatile u_long :32;            /* 3a* reserved */
+       volatile u_long _s_tbo;         /* 3b* Transmitter Backoff Counter */
+       volatile u_long _s_trc;         /* 3c* Transmitter Random Counter */
+       volatile u_long _s_tbm;         /* 3d* Transmitter Backoff Mask */
+       volatile u_long :32;            /* 3e* Reserved */
+       volatile u_long s_dcr2;         /* 3f Data Configuration 2 (AVF) */
+};
+
+/*
+ * Register Interpretations
+ */
+
+/*
+ * The command register is used for issuing commands to the SONIC.
+ * With the exception of CR_RST, the bit is reset when the operation
+ * completes.
+ */
+#define CR_LCAM                0x0200  /* load CAM with descriptor at s_cdp */
+#define CR_RRRA                0x0100  /* read next RRA descriptor at s_rrp */
+#define CR_RST         0x0080  /* software reset */
+#define CR_ST          0x0020  /* start timer */
+#define CR_STP         0x0010  /* stop timer */
+#define CR_RXEN                0x0008  /* receiver enable */
+#define CR_RXDIS       0x0004  /* receiver disable */
+#define CR_TXP         0x0002  /* transmit packets */
+#define CR_HTX         0x0001  /* halt transmission */
+
+/*
+ * The data configuration register establishes the SONIC's bus cycle
+ * operation.  This register can only be accessed when the SONIC is in
+ * reset mode (s_cr.CR_RST is set.)
+ */
+#define DCR_EXBUS      0x8000  /* extended bus mode (AVF) */
+#define DCR_LBR                0x2000  /* latched bus retry */
+#define DCR_PO1                0x1000  /* programmable output 1 */
+#define DCR_PO0                0x0800  /* programmable output 0 */
+#define DCR_STERM      0x0400  /* synchronous termination */
+#define DCR_USR1       0x0200  /* reflects USR1 input pin */
+#define DCR_USR0       0x0100  /* reflects USR0 input pin */
+#define DCR_WC1                0x0080  /* wait state control 1 */
+#define DCR_WC0                0x0040  /* wait state control 0 */
+#define DCR_DW         0x0020  /* data width select */
+#define DCR_BMS                0x0010  /* DMA block mode select */
+#define DCR_RFT1       0x0008  /* receive FIFO threshold control 1 */
+#define DCR_RFT0       0x0004  /* receive FIFO threshold control 0 */
+#define DCR_TFT1       0x0002  /* transmit FIFO threshold control 1 */
+#define DCR_TFT0       0x0001  /* transmit FIFO threshold control 0 */
+
+/* data configuration register aliases */
+#define DCR_SYNC       DCR_STERM /* synchronous (memory cycle 2 clocks) */
+#define DCR_ASYNC      0         /* asynchronous (memory cycle 3 clocks) */
+
+#define DCR_WAIT0      0                 /* 0 wait states added */
+#define DCR_WAIT1      DCR_WC0           /* 1 wait state added */
+#define DCR_WAIT2      DCR_WC1           /* 2 wait states added */
+#define DCR_WAIT3      (DCR_WC1|DCR_WC0) /* 3 wait states added */
+
+#define DCR_DW16       0       /* use 16-bit DMA accesses */
+#define DCR_DW32       DCR_DW  /* use 32-bit DMA accesses */
+
+#define DCR_DMAEF      0       /* DMA until TX/RX FIFO has emptied/filled */
+#define DCR_DMABLOCK   DCR_BMS /* DMA until RX/TX threshold crossed */
+
+#define DCR_RFT4       0               /* receive threshold 4 bytes */
+#define DCR_RFT8       DCR_RFT0        /* receive threshold 8 bytes */
+#define DCR_RFT16      DCR_RFT1        /* receive threshold 16 bytes */
+#define DCR_RFT24      (DCR_RFT1|DCR_RFT0) /* receive threshold 24 bytes */
+
+#define DCR_TFT8       0               /* transmit threshold 8 bytes */
+#define DCR_TFT16      DCR_TFT0        /* transmit threshold 16 bytes */
+#define DCR_TFT24      DCR_TFT1        /* transmit threshold 24 bytes */
+#define DCR_TFT28      (DCR_TFT1|DCR_TFT0) /* transmit threshold 28 bytes */
+
+/*
+ * The receive control register is used to filter incoming packets and
+ * provides status information on packets received.
+ * The contents of the register are copied into the RXpkt.status field
+ * when a packet is received. RCR_MC - RCR_PRX are then reset.
+ */
+#define RCR_ERR                0x8000  /* accept packets with CRC errors */
+#define RCR_RNT                0x4000  /* accept runt (length < 64) packets */
+#define RCR_BRD                0x2000  /* accept broadcast packets */
+#define RCR_PRO                0x1000  /* accept all physical address packets */
+#define RCR_AMC                0x0800  /* accept all multicast packets */
+#define RCR_LB1                0x0400  /* loopback control 1 */
+#define RCR_LB0                0x0200  /* loopback control 0 */
+#define RCR_MC         0x0100  /* multicast packet received */
+#define RCR_BC         0x0080  /* broadcast packet received */
+#define RCR_LPKT       0x0040  /* last packet in RBA (RBWC < EOBC) */
+#define RCR_CRS                0x0020  /* carrier sense activity */
+#define RCR_COL                0x0010  /* collision activity */
+#define RCR_CRC                0x0008  /* CRC error */
+#define RCR_FAE                0x0004  /* frame alignment error */
+#define RCR_LBK                0x0002  /* loopback packet received */
+#define RCR_PRX                0x0001  /* packet received without errors */
+
+/* receiver control register aliases */
+/* the loopback control bits provide the following options */
+#define RCR_LBNONE     0               /* no loopback - normal operation */
+#define RCR_LBMAC      RCR_LB0         /* MAC loopback */
+#define RCR_LBENDEC    RCR_LB1         /* ENDEC loopback */
+#define RCR_LBTRANS    (RCR_LB1|RCR_LB0) /* transceiver loopback */
+
+/*
+ * The transmit control register controls the SONIC's transmit operations.
+ * TCR_PINT - TCR_EXDIS are loaded from the TXpkt.config field at the
+ * start of transmission.  TCR_EXD-TCR_PTX are cleared at the beginning
+ * of transmission and updated when the transmission is completed.
+ */
+#define TCR_PINT       0x8000  /* interrupt when transmission starts */
+#define TCR_POWC       0x4000  /* program out of window collision timer */
+#define TCR_CRCI       0x2000  /* transmit packet without 4 byte FCS */
+#define TCR_EXDIS      0x1000  /* disable excessive deferral timer */
+#define TCR_EXD                0x0400  /* excessive deferrals occurred (>3.2ms) */
+#define TCR_DEF                0x0200  /* deferred transmissions occurred */
+#define TCR_NCRS       0x0100  /* carrier not present during transmission */
+#define TCR_CRSL       0x0080  /* carrier lost during transmission */
+#define TCR_EXC                0x0040  /* excessive collisions (>16) detected */
+#define TCR_OWC                0x0020  /* out of window (bad) collision occurred */
+#define TCR_PMB                0x0008  /* packet monitored bad - the tansmitted
+                                * packet had a bad source address or CRC */
+#define TCR_FU         0x0004  /* FIFO underrun (memory access failed) */
+#define TCR_BCM                0x0002  /* byte count mismatch (TXpkt.pkt_size
+                                * != sum(TXpkt.frag_size) */
+#define TCR_PTX                0x0001  /* packet transmitted without errors */
+
+/* transmit control register aliases */
+#define TCR_OWCSFD     0        /* start after start of frame delimiter */
+#define TCR_OWCPRE     TCR_POWC /* start after first bit of preamble */
+
+
+/*
+ * The interrupt mask register masks the interrupts that
+ * are generated from the interrupt status register.
+ * All reserved bits should be written with 0.
+ */
+#define IMR_BREN       0x4000  /* bus retry occurred enable */
+#define IMR_HBLEN      0x2000  /* heartbeat lost enable */
+#define IMR_LCDEN      0x1000  /* load CAM done interrupt enable */
+#define IMR_PINTEN     0x0800  /* programmable interrupt enable */
+#define IMR_PRXEN      0x0400  /* packet received enable */
+#define IMR_PTXEN      0x0200  /* packet transmitted enable */
+#define IMR_TXEREN     0x0100  /* transmit error enable */
+#define IMR_TCEN       0x0080  /* timer complete enable */
+#define IMR_RDEEN      0x0040  /* receive descriptors exhausted enable */
+#define IMR_RBEEN      0x0020  /* receive buffers exhausted enable */
+#define IMR_RBAEEN     0x0010  /* receive buffer area exceeded enable */
+#define IMR_CRCEN      0x0008  /* CRC tally counter rollover enable */
+#define IMR_FAEEN      0x0004  /* FAE tally counter rollover enable */
+#define IMR_MPEN       0x0002  /* MP tally counter rollover enable */
+#define IMR_RFOEN      0x0001  /* receive FIFO overrun enable */
+
+
+/*
+ * The interrupt status register indicates the source of an interrupt when
+ * the INT pin goes active.  The interrupt is acknowledged by writing
+ * the appropriate bit(s) in this register.
+ */
+#define ISR_ALL                0xffff  /* all interrupts */
+#define ISR_BR         0x4000  /* bus retry occurred */
+#define ISR_HBL                0x2000  /* CD heartbeat lost */
+#define ISR_LCD                0x1000  /* load CAM command has completed */
+#define ISR_PINT       0x0800  /* programmed interrupt from TXpkt.config */
+#define ISR_PKTRX      0x0400  /* packet received */
+#define ISR_TXDN       0x0200  /* no remaining packets to be transmitted */
+#define ISR_TXER       0x0100  /* packet transmission caused error */
+#define ISR_TC         0x0080  /* timer complete */
+#define ISR_RDE                0x0040  /* receive descriptors exhausted */
+#define ISR_RBE                0x0020  /* receive buffers exhausted */
+#define ISR_RBAE       0x0010  /* receive buffer area exceeded */
+#define ISR_CRC                0x0008  /* CRC tally counter rollover */
+#define ISR_FAE                0x0004  /* FAE tally counter rollover */
+#define ISR_MP         0x0002  /* MP tally counter rollover */
+#define ISR_RFO                0x0001  /* receive FIFO overrun */
+
+/*
+ * The second data configuration register allows additional user defined
+ * pins to be controlled.  These bits are only available if s_dcr.DCR_EXBUS
+ * is set.
+ */
+#define DCR2_EXPO3     0x8000  /* EXUSR3 output */
+#define DCR2_EXPO2     0x4000  /* EXUSR2 output */
+#define DCR2_EXPO1     0x2000  /* EXUSR1 output */
+#define DCR2_EXPO0     0x1000  /* EXUSR0 output */
+#define DCR2_PHL       0x0010  /* extend HOLD signal by 1/2 clock */
+#define DCR2_LRDY      0x0008  /* set latched ready mode */
+#define DCR2_PCM       0x0004  /* packet compress on match */
+#define DCR2_PCNM      0x0002  /* packet compress on mismatch */
+#define DCR2_RJM       0x0001  /* reject on match */