/*
* Device driver for National Semiconductor DS8390/WD83C690 based ethernet
* adapters.
*
* Copyright (c) 1994, 1995 Charles M. Hannum. All rights reserved.
*
* Copyright (C) 1993, David Greenman. This software may be used, modified,
* copied, distributed, and sold, in both source and binary form provided that
* the above copyright and these terms are retained. Under no circumstances is
* the author responsible for the proper functioning of this software, nor does
* the author assume any responsibility for damages incurred with its use.
*/
/* Print additional info when attached. */
aprint_normal_dev(sc->sc_dev, "Ethernet address %s\n",
ether_sprintf(sc->sc_enaddr));
/*
* Initialize media structures. We'll default to pointing ec_ifmedia
* at our embedded media structure. A card front-end can initialize
* ec_mii if it has an MII interface. (Note that sc_media is an
* alias of sc_mii.mii_media in dp8390_softc.)
*/
sc->sc_ec.ec_ifmedia = &sc->sc_media;
(*sc->sc_media_init)(sc);
/* We can support 802.1Q VLAN-sized frames. */
sc->sc_ec.ec_capabilities |= ETHERCAP_VLAN_MTU;
/* Attach the interface. */
if_attach(ifp);
if_deferred_start_init(ifp, NULL);
ether_ifattach(ifp, sc->sc_enaddr);
s = splnet();
dp8390_stop(sc);
dp8390_init(sc);
splx(s);
}
/*
* Take interface offline.
*/
static void
dp8390_halt(struct dp8390_softc *sc)
{
bus_space_tag_t regt = sc->sc_regt;
bus_space_handle_t regh = sc->sc_regh;
int n = 5000;
/* Stop everything on the interface, and select page 0 registers. */
NIC_BARRIER(regt, regh);
NIC_PUT(regt, regh, ED_P0_CR,
sc->cr_proto | ED_CR_PAGE_0 | ED_CR_STP);
NIC_BARRIER(regt, regh);
/*
* Wait for interface to enter stopped state, but limit # of checks to
* 'n' (about 5ms). It shouldn't even take 5us on modern DS8390's, but
* just in case it's an old one.
*/
while (((NIC_GET(regt, regh, ED_P0_ISR) & ED_ISR_RST) == 0) && --n)
DELAY(1);
}
/*
* Initialize the NIC in the exact order outlined in the NS manual.
* This init procedure is "mandatory"...don't change what or when
* things happen.
*/
/*
* Enable the following interrupts: receive/transmit complete,
* receive/transmit error, and Receiver OverWrite.
*
* Counter overflow and Remote DMA complete are *not* enabled.
*/
NIC_PUT(regt, regh, ED_P0_IMR,
ED_IMR_PRXE | ED_IMR_PTXE | ED_IMR_RXEE | ED_IMR_TXEE |
ED_IMR_OVWE);
/*
* Clear all interrupts. A '1' in each bit position clears the
* corresponding flag.
*/
NIC_PUT(regt, regh, ED_P0_ISR, 0xff);
/* Program command register for page 1. */
NIC_BARRIER(regt, regh);
NIC_PUT(regt, regh, ED_P0_CR,
sc->cr_proto | ED_CR_PAGE_1 | ED_CR_STP);
NIC_BARRIER(regt, regh);
/* Copy out our station address. */
for (i = 0; i < ETHER_ADDR_LEN; i++)
NIC_PUT(regt, regh, ED_P1_PAR0 + i, CLLADDR(ifp->if_sadl)[i]);
/* Set multicast filter on chip. */
dp8390_getmcaf(&sc->sc_ec, mcaf);
for (i = 0; i < 8; i++)
NIC_PUT(regt, regh, ED_P1_MAR0 + i, mcaf[i]);
/*
* Set current page pointer to one page after the boundary pointer, as
* recommended in the National manual.
*/
sc->next_packet = sc->rec_page_start + 1;
NIC_PUT(regt, regh, ED_P1_CURR, sc->next_packet);
/* Program command register for page 0. */
NIC_BARRIER(regt, regh);
NIC_PUT(regt, regh, ED_P1_CR,
sc->cr_proto | ED_CR_PAGE_0 | ED_CR_STP);
NIC_BARRIER(regt, regh);
/* Accept broadcast and multicast packets by default. */
i = ED_RCR_AB | ED_RCR_AM | sc->rcr_proto;
if (ifp->if_flags & IFF_PROMISC) {
/*
* Set promiscuous mode. Multicast filter was set earlier so
* that we should receive all multicast packets.
*/
i |= ED_RCR_PRO | ED_RCR_AR | ED_RCR_SEP;
}
NIC_PUT(regt, regh, ED_P0_RCR, i);
/* Take interface out of loopback. */
NIC_PUT(regt, regh, ED_P0_TCR, 0);
/* Do any card-specific initialization, if applicable. */
if (sc->init_card != NULL)
(*sc->init_card)(sc);
/* Fire up the interface. */
NIC_BARRIER(regt, regh);
NIC_PUT(regt, regh, ED_P0_CR,
sc->cr_proto | ED_CR_PAGE_0 | ED_CR_STA);
/* Set 'running' flag, and clear output active flag. */
ifp->if_flags |= IFF_RUNNING;
/* ...and attempt to start output. */
dp8390_start(ifp);
}
/*
* This routine actually starts the transmission on the interface.
*/
static void
dp8390_xmit(struct dp8390_softc *sc)
{
bus_space_tag_t regt = sc->sc_regt;
bus_space_handle_t regh = sc->sc_regh;
struct ifnet *ifp = &sc->sc_ec.ec_if;
u_short len;
/* Point to next transmit buffer slot and wrap if necessary. */
if (++sc->txb_next_tx == sc->txb_cnt)
sc->txb_next_tx = 0;
/* Set a timer just in case we never hear from the board again. */
ifp->if_timer = 2;
}
/*
* Start output on interface.
* We make one assumption here:
* 1) that the current priority is set to splnet _before_ this code
* is called *and* is returned to the appropriate priority after
* return
*/
void
dp8390_start(struct ifnet *ifp)
{
struct dp8390_softc *sc = ifp->if_softc;
struct mbuf *m0;
int buffer;
int len;
if ((ifp->if_flags & IFF_RUNNING) == 0)
return;
outloop:
/* See if there is room to put another packet in the buffer. */
if (sc->txb_inuse == sc->txb_cnt) {
/* No room. */
return;
}
IFQ_DEQUEUE(&ifp->if_snd, m0);
if (m0 == NULL)
return;
/* We need to use m->m_pkthdr.len, so require the header */
KASSERT(m0->m_flags & M_PKTHDR);
/* Tap off here if there is a BPF listener. */
bpf_mtap(ifp, m0, BPF_D_OUT);
/* txb_new points to next open buffer slot. */
buffer = sc->mem_start +
((sc->txb_new * ED_TXBUF_SIZE) << ED_PAGE_SHIFT);
len = (*sc->write_mbuf)(sc, m0, buffer);
m_freem(m0);
sc->txb_len[sc->txb_new] = len;
/* Point to next buffer slot and wrap if necessary. */
if (++sc->txb_new == sc->txb_cnt)
sc->txb_new = 0;
/* Start the first packet transmitting. */
if (sc->txb_inuse++ == 0)
dp8390_xmit(sc);
/* Loop back to the top to possibly buffer more packets. */
goto outloop;
}
loop:
/* Set NIC to page 1 registers to get 'current' pointer. */
NIC_BARRIER(regt, regh);
NIC_PUT(regt, regh, ED_P0_CR,
sc->cr_proto | ED_CR_PAGE_1 | ED_CR_STA);
NIC_BARRIER(regt, regh);
/*
* 'sc->next_packet' is the logical beginning of the ring-buffer - i.e.
* it points to where new data has been buffered. The 'CURR' (current)
* register points to the logical end of the ring-buffer - i.e. it
* points to where additional new data will be added. We loop here
* until the logical beginning equals the logical end (or in other
* words, until the ring-buffer is empty).
*/
current = NIC_GET(regt, regh, ED_P1_CURR);
if (sc->next_packet == current)
return;
/* Set NIC to page 0 registers to update boundary register. */
NIC_BARRIER(regt, regh);
NIC_PUT(regt, regh, ED_P1_CR,
sc->cr_proto | ED_CR_PAGE_0 | ED_CR_STA);
NIC_BARRIER(regt, regh);
do {
/* Get pointer to this buffer's header structure. */
packet_ptr = sc->mem_ring +
((sc->next_packet - sc->rec_page_start) << ED_PAGE_SHIFT);
(*sc->read_hdr)(sc, packet_ptr, &packet_hdr);
len = packet_hdr.count;
/*
* Try do deal with old, buggy chips that sometimes duplicate
* the low byte of the length into the high byte. We do this
* by simply ignoring the high byte of the length and always
* recalculating it.
*
* NOTE: sc->next_packet is pointing at the current packet.
*/
if (packet_hdr.next_packet >= sc->next_packet)
nlen = (packet_hdr.next_packet - sc->next_packet);
else
nlen = ((packet_hdr.next_packet - sc->rec_page_start) +
(sc->rec_page_stop - sc->next_packet));
--nlen;
if ((len & ED_PAGE_MASK) + sizeof(packet_hdr) > ED_PAGE_SIZE)
--nlen;
len = (len & ED_PAGE_MASK) | (nlen << ED_PAGE_SHIFT);
#ifdef DIAGNOSTIC
if (len != packet_hdr.count) {
aprint_verbose_dev(sc->sc_dev, "length does not match "
"next packet pointer\n");
aprint_verbose_dev(sc->sc_dev, "len %04x nlen %04x "
"start %02x first %02x curr %02x next %02x "
"stop %02x\n", packet_hdr.count, len,
sc->rec_page_start, sc->next_packet, current,
packet_hdr.next_packet, sc->rec_page_stop);
}
#endif
/*
* Be fairly liberal about what we allow as a "reasonable"
* length so that a [crufty] packet will make it to BPF (and
* can thus be analyzed). Note that all that is really
* important is that we have a length that will fit into one
* mbuf cluster or less; the upper layer protocols can then
* figure out the length from their own length field(s).
*/
if (len <= MCLBYTES &&
packet_hdr.next_packet >= sc->rec_page_start &&
packet_hdr.next_packet < sc->rec_page_stop) {
/* Go get packet. */
dp8390_read(sc,
packet_ptr + sizeof(struct dp8390_ring),
len - sizeof(struct dp8390_ring));
} else {
/* Really BAD. The ring pointers are corrupted. */
log(LOG_ERR, "%s: NIC memory corrupt - "
"invalid packet length %d\n",
device_xname(sc->sc_dev), len);
if_statinc(&sc->sc_ec.ec_if, if_ierrors);
dp8390_reset(sc);
return;
}
/* Update next packet pointer. */
sc->next_packet = packet_hdr.next_packet;
/*
* Update NIC boundary pointer - being careful to keep it one
* buffer behind (as recommended by NS databook).
*/
boundary = sc->next_packet - 1;
if (boundary < sc->rec_page_start)
boundary = sc->rec_page_stop - 1;
NIC_PUT(regt, regh, ED_P0_BNRY, boundary);
} while (sc->next_packet != current);
/* Loop until there are no more new interrupts. */
for (;;) {
/*
* Reset all the bits that we are 'acknowledging' by writing a
* '1' to each bit position that was set.
* (Writing a '1' *clears* the bit.)
*/
NIC_PUT(regt, regh, ED_P0_ISR, isr);
/* Work around for AX88190 bug */
if ((sc->sc_flags & DP8390_DO_AX88190_WORKAROUND) != 0)
while ((NIC_GET(regt, regh, ED_P0_ISR) & isr) != 0) {
NIC_PUT(regt, regh, ED_P0_ISR, 0);
NIC_PUT(regt, regh, ED_P0_ISR, isr);
}
/*
* Handle transmitter interrupts. Handle these first because
* the receiver will reset the board under some conditions.
*
* If the chip was reset while a packet was transmitting, it
* may still deliver a TX interrupt. In this case, just ignore
* the interrupt.
*/
if ((isr & (ED_ISR_PTX | ED_ISR_TXE)) != 0 &&
sc->txb_inuse != 0) {
net_stat_ref_t nsr = IF_STAT_GETREF(ifp);
uint8_t collisions =
NIC_GET(regt, regh, ED_P0_NCR) & 0x0f;
/*
* Check for transmit error. If a TX completed with an
* error, we end up throwing the packet away. Really
* the only error that is possible is excessive
* collisions, and in this case it is best to allow the
* automatic mechanisms of TCP to backoff the flow. Of
* course, with UDP we're screwed, but this is expected
* when a network is heavily loaded.
*/
if ((isr & ED_ISR_TXE) != 0) {
/* Excessive collisions (16). */
if ((NIC_GET(regt, regh, ED_P0_TSR)
& ED_TSR_ABT) && (collisions == 0)) {
/*
* When collisions total 16, the P0_NCR
* will indicate 0, and the TSR_ABT is
* set.
*/
collisions = 16;
}
/* Update output errors counter. */
if_statinc_ref(ifp, nsr, if_oerrors);
} else {
/*
* Throw away the non-error status bits.
*
* XXX
* It may be useful to detect loss of carrier
* and late collisions here.
*/
(void)NIC_GET(regt, regh, ED_P0_TSR);
/*
* Update total number of successfully
* transmitted packets.
*/
if_statinc_ref(ifp, nsr, if_opackets);
}
/* Clear watchdog timer. */
ifp->if_timer = 0;
/*
* Add in total number of collisions on last
* transmission.
*/
if (collisions) {
if_statadd_ref(ifp, nsr, if_collisions,
collisions);
}
IF_STAT_PUTREF(ifp);
/*
* Decrement buffer in-use count if not zero (can only
* be zero if a transmitter interrupt occurred while
* not actually transmitting).
* If data is ready to transmit, start it transmitting,
* otherwise defer until after handling receiver.
*/
if (--sc->txb_inuse != 0)
dp8390_xmit(sc);
}
/* Handle receiver interrupts. */
if ((isr & (ED_ISR_PRX | ED_ISR_RXE | ED_ISR_OVW)) != 0) {
/*
* Overwrite warning. In order to make sure that a
* lockup of the local DMA hasn't occurred, we reset
* and re-init the NIC. The NSC manual suggests only a
* partial reset/re-init is necessary - but some chips
* seem to want more. The DMA lockup has been seen
* only with early rev chips - Methinks this bug was
* fixed in later revs. -DG
*/
if ((isr & ED_ISR_OVW) != 0) {
if_statinc(ifp, if_ierrors);
#ifdef DIAGNOSTIC
log(LOG_WARNING, "%s: warning - receiver "
"ring buffer overrun\n",
device_xname(sc->sc_dev));
#endif
/* Stop/reset/re-init NIC. */
dp8390_reset(sc);
} else {
/*
* Receiver Error. One or more of: CRC error,
* frame alignment error FIFO overrun, or
* missed packet.
*/
if ((isr & ED_ISR_RXE) != 0) {
if_statinc(ifp, if_ierrors);
#ifdef DEBUG
if (dp8390_debug) {
printf("%s: receive error %x\n",
device_xname(sc->sc_dev),
NIC_GET(regt, regh,
ED_P0_RSR));
}
#endif
}
/*
* Go get the packet(s)
* XXX - Doing this on an error is dubious
* because there shouldn't be any data to get
* (we've configured the interface to not
* accept packets with errors).
*/
(*sc->recv_int)(sc);
}
}
/*
* If it looks like the transmitter can take more data, attempt
* to start output on the interface. This is done after
* handling the receiver to give the receiver priority.
*/
if_schedule_deferred_start(ifp);
/*
* Return NIC CR to standard state: page 0, remote DMA
* complete, start (toggling the TXP bit off, even if was just
* set in the transmit routine, is *okay* - it is 'edge'
* triggered from low to high).
*/
NIC_BARRIER(regt, regh);
NIC_PUT(regt, regh, ED_P0_CR,
sc->cr_proto | ED_CR_PAGE_0 | ED_CR_STA);
NIC_BARRIER(regt, regh);
/*
* If the Network Talley Counters overflow, read them to reset
* them. It appears that old 8390's won't clear the ISR flag
* otherwise - resulting in an infinite loop.
*/
if ((isr & ED_ISR_CNT) != 0) {
(void)NIC_GET(regt, regh, ED_P0_CNTR0);
(void)NIC_GET(regt, regh, ED_P0_CNTR1);
(void)NIC_GET(regt, regh, ED_P0_CNTR2);
}
case SIOCSIFFLAGS:
if ((error = ifioctl_common(ifp, cmd, data)) != 0)
break;
switch (ifp->if_flags & (IFF_UP | IFF_RUNNING)) {
case IFF_RUNNING:
/*
* If interface is marked down and it is running, then
* stop it.
*/
dp8390_stop(sc);
ifp->if_flags &= ~IFF_RUNNING;
dp8390_disable(sc);
break;
case IFF_UP:
/*
* If interface is marked up and it is stopped, then
* start it.
*/
if ((error = dp8390_enable(sc)) != 0)
break;
dp8390_init(sc);
break;
case IFF_UP | IFF_RUNNING:
/*
* Reset the interface to pick up changes in any other
* flags that affect hardware registers.
*/
dp8390_stop(sc);
dp8390_init(sc);
break;
default:
break;
}
break;
case SIOCADDMULTI:
case SIOCDELMULTI:
if (sc->sc_enabled == 0) {
error = EIO;
break;
}
/* Update our multicast list. */
if ((error = ether_ioctl(ifp, cmd, data)) == ENETRESET) {
/*
* Multicast list has changed; set the hardware filter
* accordingly.
*/
if (ifp->if_flags & IFF_RUNNING) {
dp8390_stop(sc); /* XXX for ds_setmcaf? */
dp8390_init(sc);
}
error = 0;
}
break;
/*
* Retrieve packet from buffer memory and send to the next level up via
* ether_input(). If there is a BPF listener, give a copy to BPF, too.
*/
void
dp8390_read(struct dp8390_softc *sc, int buf, u_short len)
{
struct ifnet *ifp = &sc->sc_ec.ec_if;
struct mbuf *m;
/* Pull packet off interface. */
m = dp8390_get(sc, buf, len);
if (m == NULL) {
if_statinc(ifp, if_ierrors);
return;
}
if_percpuq_enqueue(ifp->if_percpuq, m);
}
/*
* Supporting routines.
*/
/*
* Compute the multicast address filter from the list of multicast addresses we
* need to listen to.
*/
void
dp8390_getmcaf(struct ethercom *ec, uint8_t *af)
{
struct ifnet *ifp = &ec->ec_if;
struct ether_multi *enm;
uint32_t crc;
int i;
struct ether_multistep step;
/*
* Set up multicast address filter by passing all multicast addresses
* through a crc generator, and then using the high order 6 bits as an
* index into the 64 bit logical address filter. The high order bit
* selects the word, while the rest of the bits select the bit within
* the word.
*/
if (ifp->if_flags & IFF_PROMISC) {
ifp->if_flags |= IFF_ALLMULTI;
for (i = 0; i < 8; i++)
af[i] = 0xff;
return;
}
for (i = 0; i < 8; i++)
af[i] = 0;
ETHER_LOCK(ec);
ETHER_FIRST_MULTI(step, ec, enm);
while (enm != NULL) {
if (memcmp(enm->enm_addrlo, enm->enm_addrhi,
sizeof(enm->enm_addrlo)) != 0) {
/*
* We must listen to a range of multicast addresses.
* For now, just accept all multicasts, rather than
* trying to set only those filter bits needed to match
* the range. (At this time, the only use of address
* ranges is for IP multicast routing, for which the
* range is big enough to require all bits set.)
*/
ifp->if_flags |= IFF_ALLMULTI;
for (i = 0; i < 8; i++)
af[i] = 0xff;
ETHER_UNLOCK(ec);
return;
}
/*
* Copy data from receive buffer to a new mbuf chain allocating mbufs
* as needed. Return pointer to first mbuf in chain.
* sc = dp8390 info (softc)
* src = pointer in dp8390 ring buffer
* total_len = amount of data to copy
*/
struct mbuf *
dp8390_get(struct dp8390_softc *sc, int src, u_short total_len)
{
struct ifnet *ifp = &sc->sc_ec.ec_if;
struct mbuf *m, *m0, *newm;
u_short len;
MGETHDR(m0, M_DONTWAIT, MT_DATA);
if (m0 == NULL)
return NULL;
m_set_rcvif(m0, ifp);
m0->m_pkthdr.len = total_len;
len = MHLEN;
m = m0;
while (total_len > 0) {
if (total_len >= MINCLSIZE) {
MCLGET(m, M_DONTWAIT);
if ((m->m_flags & M_EXT) == 0)
goto bad;
len = MCLBYTES;
}
/* Make sure the data after the Ethernet header is aligned. */
if (m == m0) {
char *newdata = (char *)
ALIGN(m->m_data + sizeof(struct ether_header)) -
sizeof(struct ether_header);
len -= newdata - m->m_data;
m->m_data = newdata;
}
total_len -= len;
if (total_len > 0) {
MGET(newm, M_DONTWAIT, MT_DATA);
if (newm == NULL)
goto bad;
len = MLEN;
m = m->m_next = newm;
}
}
return m0;
bad:
m_freem(m0);
return NULL;
}
/*
* Default driver support functions.
*
* NOTE: all support functions assume 8-bit shared memory.
*/
/*
* Zero NIC buffer memory and verify that it is clear.
*/
static int
dp8390_test_mem(struct dp8390_softc *sc)
{
bus_space_tag_t buft = sc->sc_buft;
bus_space_handle_t bufh = sc->sc_bufh;
int i;
for (i = 0; i < sc->mem_size; ++i) {
if (bus_space_read_1(buft, bufh, sc->mem_start + i)) {
printf(": failed to clear NIC buffer at offset %x - "
"check configuration\n", (sc->mem_start + i));
return 1;
}
}
return 0;
}
/*
* Read a packet header from the ring, given the source offset.
*/
static void
dp8390_read_hdr(struct dp8390_softc *sc, int src, struct dp8390_ring *hdrp)
{
bus_space_tag_t buft = sc->sc_buft;
bus_space_handle_t bufh = sc->sc_bufh;
/*
* The byte count includes a 4 byte header that was added by
* the NIC.
*/
hdrp->rsr = bus_space_read_1(buft, bufh, src);
hdrp->next_packet = bus_space_read_1(buft, bufh, src + 1);
hdrp->count = bus_space_read_1(buft, bufh, src + 2) |
(bus_space_read_1(buft, bufh, src + 3) << 8);
}
/*
* Copy `amount' bytes from a packet in the ring buffer to a linear
* destination buffer, given a source offset and destination address.
* Takes into account ring-wrap.
*/
static int
dp8390_ring_copy(struct dp8390_softc *sc, int src, void *dst, u_short amount)
{
bus_space_tag_t buft = sc->sc_buft;
bus_space_handle_t bufh = sc->sc_bufh;
u_short tmp_amount;
/* Does copy wrap to lower addr in ring buffer? */
if (src + amount > sc->mem_end) {
tmp_amount = sc->mem_end - src;
/* Copy amount up to end of NIC memory. */
bus_space_read_region_1(buft, bufh, src, dst, tmp_amount);
/*
* Copy a packet from an mbuf to the transmit buffer on the card.
*
* Currently uses an extra buffer/extra memory copy, unless the whole
* packet fits in one mbuf.
*/
static int
dp8390_write_mbuf(struct dp8390_softc *sc, struct mbuf *m, int buf)
{
bus_space_tag_t buft = sc->sc_buft;
bus_space_handle_t bufh = sc->sc_bufh;
uint8_t *data;
int len, totlen = 0;
for (; m ; m = m->m_next) {
data = mtod(m, uint8_t *);
len = m->m_len;
if (len > 0) {
bus_space_write_region_1(buft, bufh, buf, data, len);
totlen += len;
buf += len;
}
}
if (totlen < ETHER_MIN_LEN - ETHER_CRC_LEN) {
bus_space_set_region_1(buft, bufh, buf, 0,
ETHER_MIN_LEN - ETHER_CRC_LEN - totlen);
totlen = ETHER_MIN_LEN - ETHER_CRC_LEN;
}
return totlen;
}
/*
* Enable power on the interface.
*/
int
dp8390_enable(struct dp8390_softc *sc)
{
