2 * Copyright (c) 1994-2000
3 * Paul Richards. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer,
10 * verbatim and that no modifications are made prior to this
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. The name Paul Richards may not be used to endorse or promote products
16 * derived from this software without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY PAUL RICHARDS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL PAUL RICHARDS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
40 * Check all the XXX comments -- some of them are just things I've left
41 * unfinished rather than "difficult" problems that were hacked around.
45 * Check how all the arpcom flags get set and used.
47 * Re-inline and re-static all routines after debugging.
49 * Remember to assign iobase in SHMEM probe routines.
51 * Replace all occurences of LANCE-controller-card etc in prints by the name
52 * strings of the appropriate type -- nifty window dressing
54 * Add DEPCA support -- mostly done.
60 /* Some defines that should really be in generic locations */
62 #define MULTICAST_FILTER_LEN 8
64 #include <sys/param.h>
65 #include <sys/systm.h>
67 #include <sys/kernel.h>
68 #include <sys/malloc.h>
70 #include <sys/module.h>
71 #include <sys/socket.h>
72 #include <sys/sockio.h>
73 #include <sys/syslog.h>
75 #include <machine/bus.h>
76 #include <machine/resource.h>
79 #include <net/ethernet.h>
81 #include <net/if_dl.h>
82 #include <net/if_types.h>
84 #include <netinet/in.h>
85 #include <netinet/if_ether.h>
89 #include <machine/md_var.h>
91 #include <dev/lnc/if_lncvar.h>
92 #include <dev/lnc/if_lncreg.h>
94 devclass_t lnc_devclass;
96 static char const * const nic_ident[] = {
101 "CNET98S", /* PC-98 */
104 static char const * const ic_ident[] = {
119 static void lnc_setladrf(struct lnc_softc *sc);
120 static void lnc_reset(struct lnc_softc *sc);
121 static void lnc_free_mbufs(struct lnc_softc *sc);
122 static __inline int alloc_mbuf_cluster(struct lnc_softc *sc,
123 struct host_ring_entry *desc);
124 static __inline struct mbuf *chain_mbufs(struct lnc_softc *sc,
127 static __inline struct mbuf *mbuf_packet(struct lnc_softc *sc,
130 static void lnc_rint(struct lnc_softc *sc);
131 static void lnc_tint(struct lnc_softc *sc);
133 static void lnc_init(void *);
134 static __inline int mbuf_to_buffer(struct mbuf *m, char *buffer);
135 static __inline struct mbuf *chain_to_cluster(struct mbuf *m);
136 static void lnc_start(struct ifnet *ifp);
137 static int lnc_ioctl(struct ifnet *ifp, u_long command, caddr_t data);
138 static void lnc_watchdog(struct ifnet *ifp);
140 void lnc_dump_state(struct lnc_softc *sc);
141 void mbuf_dump_chain(struct mbuf *m);
145 read_csr(struct lnc_softc *sc, u_short port)
147 lnc_outw(sc->rap, port);
148 return (lnc_inw(sc->rdp));
152 write_csr(struct lnc_softc *sc, u_short port, u_short val)
154 lnc_outw(sc->rap, port);
155 lnc_outw(sc->rdp, val);
159 write_bcr(struct lnc_softc *sc, u_short port, u_short val)
161 lnc_outw(sc->rap, port);
162 lnc_outw(sc->bdp, val);
165 static __inline u_short
166 read_bcr(struct lnc_softc *sc, u_short port)
168 lnc_outw(sc->rap, port);
169 return (lnc_inw(sc->bdp));
173 lance_probe(struct lnc_softc *sc)
175 write_csr(sc, CSR0, STOP);
177 if ((lnc_inw(sc->rdp) & STOP) && ! (read_csr(sc, CSR3))) {
179 * Check to see if it's a C-LANCE. For the LANCE the INEA bit
180 * cannot be set while the STOP bit is. This restriction is
181 * removed for the C-LANCE.
183 write_csr(sc, CSR0, INEA);
184 if (read_csr(sc, CSR0) & INEA)
193 lnc_release_resources(device_t dev)
195 lnc_softc_t *sc = device_get_softc(dev);
198 bus_teardown_intr(dev, sc->irqres, sc->intrhand);
199 bus_release_resource(dev, SYS_RES_IRQ, sc->irqrid, sc->irqres);
203 bus_release_resource(dev, SYS_RES_IOPORT,
204 sc->portrid, sc->portres);
206 bus_release_resource(dev, SYS_RES_DRQ, sc->drqrid, sc->drqres);
210 bus_dmamap_unload(sc->dmat, sc->dmamap);
211 bus_dmamem_free(sc->dmat, sc->recv_ring, sc->dmamap);
213 bus_dma_tag_destroy(sc->dmat);
218 * Set up the logical address filter for multicast packets
221 lnc_setladrf(struct lnc_softc *sc)
223 struct ifnet *ifp = &sc->arpcom.ac_if;
224 struct ifmultiaddr *ifma;
228 if (sc->flags & IFF_ALLMULTI) {
229 for (i=0; i < MULTICAST_FILTER_LEN; i++)
230 sc->init_block->ladrf[i] = 0xFF;
235 * For each multicast address, calculate a crc for that address and
236 * then use the high order 6 bits of the crc as a hash code where
237 * bits 3-5 select the byte of the address filter and bits 0-2 select
238 * the bit within that byte.
241 bzero(sc->init_block->ladrf, MULTICAST_FILTER_LEN);
242 TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
243 if (ifma->ifma_addr->sa_family != AF_LINK)
246 index = ether_crc32_le(LLADDR((struct sockaddr_dl *)
247 ifma->ifma_addr), ETHER_ADDR_LEN) >> 26;
248 sc->init_block->ladrf[index >> 3] |= 1 << (index & 7);
253 lnc_stop(struct lnc_softc *sc)
255 write_csr(sc, CSR0, STOP);
259 lnc_reset(struct lnc_softc *sc)
265 lnc_free_mbufs(struct lnc_softc *sc)
270 * We rely on other routines to keep the buff.mbuf field valid. If
271 * it's not NULL then we assume it points to an allocated mbuf.
274 for (i = 0; i < NDESC(sc->nrdre); i++)
275 if ((sc->recv_ring + i)->buff.mbuf)
276 m_free((sc->recv_ring + i)->buff.mbuf);
278 for (i = 0; i < NDESC(sc->ntdre); i++)
279 if ((sc->trans_ring + i)->buff.mbuf)
280 m_free((sc->trans_ring + i)->buff.mbuf);
287 alloc_mbuf_cluster(struct lnc_softc *sc, struct host_ring_entry *desc)
289 register struct mds *md = desc->md;
293 /* Try and get cluster off local cache */
294 if (sc->mbuf_count) {
297 sc->mbufs = m->m_next;
298 /* XXX m->m_data = m->m_ext.ext_buf;*/
300 MGET(m, M_DONTWAIT, MT_DATA);
303 MCLGET(m, M_DONTWAIT);
304 if (!m->m_ext.ext_buf) {
311 addr = kvtop(m->m_data);
313 md->md1= ((addr >> 16) & 0xff) | OWN;
314 md->md2 = -(short)(MCLBYTES - sizeof(struct pkthdr));
319 static __inline struct mbuf *
320 chain_mbufs(struct lnc_softc *sc, int start_of_packet, int pkt_len)
322 struct mbuf *head, *m;
323 struct host_ring_entry *desc;
326 * Turn head into a pkthdr mbuf --
327 * assumes a pkthdr type mbuf was
328 * allocated to the descriptor
332 desc = sc->recv_ring + start_of_packet;
334 head = desc->buff.mbuf;
335 head->m_flags |= M_PKTHDR;
336 bzero(&head->m_pkthdr, sizeof(head->m_pkthdr));
341 m->m_len = min((MCLBYTES - sizeof(struct pkthdr)), pkt_len);
343 if (alloc_mbuf_cluster(sc, desc))
344 return((struct mbuf *)NULL);
345 INC_MD_PTR(start_of_packet, sc->nrdre)
346 desc = sc->recv_ring + start_of_packet;
347 m->m_next = desc->buff.mbuf;
348 } while (start_of_packet != sc->recv_next);
354 static __inline struct mbuf *
355 mbuf_packet(struct lnc_softc *sc, int start_of_packet, int pkt_len)
358 struct host_ring_entry *start;
359 struct mbuf *head,*m,*m_prev;
360 char *data,*mbuf_data;
364 /* Get a pkthdr mbuf for the start of packet */
365 MGETHDR(head, M_DONTWAIT, MT_DATA);
367 LNCSTATS(drop_packet)
373 start = sc->recv_ring + start_of_packet;
374 /*blen = -(start->md->md2);*/
375 blen = RECVBUFSIZE; /* XXX More PCnet-32 crap */
376 data = start->buff.data;
377 mbuf_data = m->m_data;
379 while (start_of_packet != sc->recv_next) {
381 * If the data left fits in a single buffer then set
382 * blen to the size of the data left.
388 * amount is least of data in current ring buffer and
389 * amount of space left in current mbuf.
391 amount = min(blen, M_TRAILINGSPACE(m));
393 /* mbuf must be empty */
395 MGET(m, M_DONTWAIT, MT_DATA);
400 if (pkt_len >= MINCLSIZE)
401 MCLGET(m, M_DONTWAIT);
404 amount = min(blen, M_TRAILINGSPACE(m));
405 mbuf_data = m->m_data;
407 bcopy(data, mbuf_data, amount);
415 start->md->md1 &= HADR;
416 start->md->md1 |= OWN;
417 start->md->md2 = -RECVBUFSIZE; /* XXX - shouldn't be necessary */
418 INC_MD_PTR(start_of_packet, sc->nrdre)
419 start = sc->recv_ring + start_of_packet;
420 data = start->buff.data;
421 /*blen = -(start->md->md2);*/
422 blen = RECVBUFSIZE; /* XXX More PCnet-32 crap */
430 lnc_rint(struct lnc_softc *sc)
432 struct ifnet *ifp = &sc->arpcom.ac_if;
433 struct host_ring_entry *next, *start;
436 struct ether_header *eh;
442 * The LANCE will issue a RINT interrupt when the ownership of the
443 * last buffer of a receive packet has been relinquished by the LANCE.
444 * Therefore, it can be assumed that a complete packet can be found
445 * before hitting buffers that are still owned by the LANCE, if not
446 * then there is a bug in the driver that is causing the descriptors
447 * to get out of sync.
451 if ((sc->recv_ring + sc->recv_next)->md->md1 & OWN) {
452 log(LOG_ERR, "%s: Receive interrupt with buffer still owned by controller -- Resetting\n", ifp->if_xname);
456 if (!((sc->recv_ring + sc->recv_next)->md->md1 & STP)) {
457 log(LOG_ERR, "%s: Receive interrupt but not start of packet -- Resetting\n", ifp->if_xname);
464 next = sc->recv_ring + sc->recv_next;
465 while ((flags = next->md->md1) & STP) {
467 /* Make a note of the start of the packet */
468 start_of_packet = sc->recv_next;
471 * Find the end of the packet. Even if not data chaining,
472 * jabber packets can overrun into a second descriptor.
473 * If there is no error, then the ENP flag is set in the last
474 * descriptor of the packet. If there is an error then the ERR
475 * flag will be set in the descriptor where the error occured.
476 * Therefore, to find the last buffer of a packet we search for
480 if (!(flags & (ENP | MDERR))) {
482 INC_MD_PTR(sc->recv_next, sc->nrdre)
483 next = sc->recv_ring + sc->recv_next;
484 flags = next->md->md1;
485 } while (!(flags & (STP | OWN | ENP | MDERR)));
488 log(LOG_ERR, "%s: Start of packet found before end of previous in receive ring -- Resetting\n", ifp->if_xname);
495 * Looked ahead into a packet still
498 sc->recv_next = start_of_packet;
501 log(LOG_ERR, "%s: End of received packet not found-- Resetting\n", ifp->if_xname);
508 pkt_len = (next->md->md3 & MCNT) - FCS_LEN;
510 /* Move pointer onto start of next packet */
511 INC_MD_PTR(sc->recv_next, sc->nrdre)
512 next = sc->recv_ring + sc->recv_next;
515 const char *if_xname = ifp->if_xname;
518 log(LOG_ERR, "%s: Receive buffer error\n", if_xname);
521 /* OFLO only valid if ENP is not set */
522 if (!(flags & ENP)) {
524 log(LOG_ERR, "%s: Receive overflow error \n", if_xname);
526 } else if (flags & ENP) {
527 if ((ifp->if_flags & IFF_PROMISC)==0) {
529 * FRAM and CRC are valid only if ENP
530 * is set and OFLO is not.
534 log(LOG_ERR, "%s: Framing error\n", if_xname);
536 * FRAM is only set if there's a CRC
537 * error so avoid multiple messages
539 } else if (flags & CRC) {
541 log(LOG_ERR, "%s: Receive CRC error\n", if_xname);
549 while (start_of_packet != sc->recv_next) {
550 start = sc->recv_ring + start_of_packet;
551 start->md->md2 = -RECVBUFSIZE; /* XXX - shouldn't be necessary */
552 start->md->md1 &= HADR;
553 start->md->md1 |= OWN;
554 INC_MD_PTR(start_of_packet, sc->nrdre)
556 } else { /* Valid packet */
561 if (sc->nic.mem_mode == DMA_MBUF)
562 head = chain_mbufs(sc, start_of_packet, pkt_len);
564 head = mbuf_packet(sc, start_of_packet, pkt_len);
568 * First mbuf in packet holds the
569 * ethernet and packet headers
571 head->m_pkthdr.rcvif = ifp;
572 head->m_pkthdr.len = pkt_len ;
573 eh = (struct ether_header *) head->m_data;
576 * vmware ethernet hardware emulation loops
577 * packets back to itself, violates IFF_SIMPLEX.
578 * drop it if it is from myself.
580 if (bcmp(eh->ether_shost,
581 sc->arpcom.ac_enaddr, ETHER_ADDR_LEN) == 0) {
584 (*ifp->if_input)(ifp, head);
587 log(LOG_ERR,"%s: Packet dropped, no mbufs\n",ifp->if_xname);
588 LNCSTATS(drop_packet)
596 * At this point all completely received packets have been processed
597 * so clear RINT since any packets that have arrived while we were in
598 * here have been dealt with.
601 lnc_outw(sc->rdp, RINT | INEA);
605 lnc_tint(struct lnc_softc *sc)
607 struct host_ring_entry *next, *start;
612 * If the driver is reset in this routine then we return immediately to
613 * the interrupt driver routine. Any interrupts that have occured
614 * since the reset will be dealt with there. sc->trans_next
615 * should point to the start of the first packet that was awaiting
616 * transmission after the last transmit interrupt was dealt with. The
617 * LANCE should have relinquished ownership of that descriptor before
618 * the interrupt. Therefore, sc->trans_next should point to a
619 * descriptor with STP set and OWN cleared. If not then the driver's
620 * pointers are out of sync with the LANCE, which signifies a bug in
621 * the driver. Therefore, the following two checks are really
622 * diagnostic, since if the driver is working correctly they should
627 if ((sc->trans_ring + sc->trans_next)->md->md1 & OWN) {
628 log(LOG_ERR, "%s: Transmit interrupt with buffer still owned by controller -- Resetting\n", sc->arpcom.ac_if.if_xname);
636 * The LANCE will write the status information for the packet it just
637 * tried to transmit in one of two places. If the packet was
638 * transmitted successfully then the status will be written into the
639 * last descriptor of the packet. If the transmit failed then the
640 * status will be written into the descriptor that was being accessed
641 * when the error occured and all subsequent descriptors in that
642 * packet will have been relinquished by the LANCE.
644 * At this point we know that sc->trans_next points to the start
645 * of a packet that the LANCE has just finished trying to transmit.
646 * We now search for a buffer with either ENP or ERR set.
652 start_of_packet = sc->trans_next;
653 next = sc->trans_ring + sc->trans_next;
656 if (!(next->md->md1 & STP)) {
657 log(LOG_ERR, "%s: Transmit interrupt but not start of packet -- Resetting\n", sc->arpcom.ac_if.if_xname);
664 * Find end of packet.
667 if (!(next->md->md1 & (ENP | MDERR))) {
669 INC_MD_PTR(sc->trans_next, sc->ntdre)
670 next = sc->trans_ring + sc->trans_next;
671 } while (!(next->md->md1 & (STP | OWN | ENP | MDERR)));
673 if (next->md->md1 & STP) {
674 log(LOG_ERR, "%s: Start of packet found before end of previous in transmit ring -- Resetting\n", sc->arpcom.ac_if.if_xname);
678 if (next->md->md1 & OWN) {
681 * Looked ahead into a packet still
684 sc->trans_next = start_of_packet;
687 log(LOG_ERR, "%s: End of transmitted packet not found -- Resetting\n", sc->arpcom.ac_if.if_xname);
694 * Check for ERR first since other flags are irrelevant if an
697 if (next->md->md1 & MDERR) {
700 sc->arpcom.ac_if.if_oerrors++;
702 if (next->md->md3 & LCOL) {
704 log(LOG_ERR, "%s: Transmit late collision -- Net error?\n", sc->arpcom.ac_if.if_xname);
705 sc->arpcom.ac_if.if_collisions++;
707 * Clear TBUFF since it's not valid when LCOL
710 next->md->md3 &= ~TBUFF;
712 if (next->md->md3 & LCAR) {
714 log(LOG_ERR, "%s: Loss of carrier during transmit -- Net error?\n", sc->arpcom.ac_if.if_xname);
716 if (next->md->md3 & RTRY) {
718 log(LOG_ERR, "%s: Transmit of packet failed after 16 attempts -- TDR = %d\n", sc->arpcom.ac_if.if_xname, ((sc->trans_ring + sc->trans_next)->md->md3 & TDR));
719 sc->arpcom.ac_if.if_collisions += 16;
721 * Clear TBUFF since it's not valid when RTRY
724 next->md->md3 &= ~TBUFF;
727 * TBUFF is only valid if neither LCOL nor RTRY are set.
728 * We need to check UFLO after LCOL and RTRY so that we
729 * know whether or not TBUFF is valid. If either are
730 * set then TBUFF will have been cleared above. A
731 * UFLO error will turn off the transmitter so we
736 if (next->md->md3 & UFLO) {
739 * If an UFLO has occured it's possibly due
742 if (next->md->md3 & TBUFF) {
744 log(LOG_ERR, "%s: Transmit buffer error -- Resetting\n", sc->arpcom.ac_if.if_xname);
746 log(LOG_ERR, "%s: Transmit underflow error -- Resetting\n", sc->arpcom.ac_if.if_xname);
751 INC_MD_PTR(sc->trans_next, sc->ntdre)
752 next = sc->trans_ring + sc->trans_next;
753 } while (!(next->md->md1 & STP) && (sc->trans_next != sc->next_to_send));
757 * Since we check for ERR first then if we get here
758 * the packet was transmitted correctly. There may
759 * still have been non-fatal errors though.
760 * Don't bother checking for DEF, waste of time.
763 sc->arpcom.ac_if.if_opackets++;
765 if (next->md->md1 & MORE) {
767 sc->arpcom.ac_if.if_collisions += 2;
771 * ONE is invalid if LCOL is set. If LCOL was set then
772 * ERR would have also been set and we would have
773 * returned from lnc_tint above. Therefore we can
774 * assume if we arrive here that ONE is valid.
778 if (next->md->md1 & ONE) {
780 sc->arpcom.ac_if.if_collisions++;
782 INC_MD_PTR(sc->trans_next, sc->ntdre)
783 next = sc->trans_ring + sc->trans_next;
787 * Clear descriptors and free any mbufs.
791 start = sc->trans_ring + start_of_packet;
792 start->md->md1 &= HADR;
793 if (sc->nic.mem_mode == DMA_MBUF) {
794 /* Cache clusters on a local queue */
795 if ((start->buff.mbuf->m_flags & M_EXT) && (sc->mbuf_count < MBUF_CACHE_LIMIT)) {
796 if (sc->mbuf_count) {
797 start->buff.mbuf->m_next = sc->mbufs;
798 sc->mbufs = start->buff.mbuf;
800 sc->mbufs = start->buff.mbuf;
802 start->buff.mbuf = 0;
805 * XXX should this be m_freem()?
807 m_free(start->buff.mbuf);
808 start->buff.mbuf = NULL;
811 sc->pending_transmits--;
812 INC_MD_PTR(start_of_packet, sc->ntdre)
813 }while (start_of_packet != sc->trans_next);
816 * There's now at least one free descriptor
817 * in the ring so indicate that we can accept
818 * more packets again.
821 sc->arpcom.ac_if.if_flags &= ~IFF_OACTIVE;
825 } while (sc->pending_transmits && !(next->md->md1 & OWN));
828 * Clear TINT since we've dealt with all
829 * the completed transmissions.
832 lnc_outw(sc->rdp, TINT | INEA);
836 lnc_attach_common(device_t dev)
838 lnc_softc_t *sc = device_get_softc(dev);
842 switch (sc->nic.ident) {
852 /* Set default mode */
853 sc->nic.mode = NORMAL;
855 /* Fill in arpcom structure entries */
857 sc->arpcom.ac_if.if_softc = sc;
858 if_initname(&sc->arpcom.ac_if, device_get_name(dev),
859 device_get_unit(dev));
860 sc->arpcom.ac_if.if_flags = IFF_BROADCAST | IFF_SIMPLEX |
861 IFF_MULTICAST | IFF_NEEDSGIANT;
862 sc->arpcom.ac_if.if_timer = 0;
863 sc->arpcom.ac_if.if_start = lnc_start;
864 sc->arpcom.ac_if.if_ioctl = lnc_ioctl;
865 sc->arpcom.ac_if.if_watchdog = lnc_watchdog;
866 sc->arpcom.ac_if.if_init = lnc_init;
867 IFQ_SET_MAXLEN(&sc->arpcom.ac_if.if_snd, IFQ_MAXLEN);
868 sc->arpcom.ac_if.if_snd.ifq_drv_maxlen = IFQ_MAXLEN;
869 IFQ_SET_READY(&sc->arpcom.ac_if.if_snd);
871 /* Extract MAC address from PROM */
872 for (i = 0; i < ETHER_ADDR_LEN; i++)
873 sc->arpcom.ac_enaddr[i] = lnc_inb(i * skip);
876 * XXX -- should check return status of if_attach
879 ether_ifattach(&sc->arpcom.ac_if, sc->arpcom.ac_enaddr);
881 if (sc->nic.ic == LANCE || sc->nic.ic == C_LANCE)
882 if_printf(&sc->arpcom.ac_if, "%s (%s)\n",
883 nic_ident[sc->nic.ident], ic_ident[sc->nic.ic]);
885 if_printf(&sc->arpcom.ac_if, "%s\n", ic_ident[sc->nic.ic]);
894 struct lnc_softc *sc = xsc;
898 /* Shut down interface */
902 sc->arpcom.ac_if.if_flags |= IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST; /* XXX??? */
905 * This sets up the memory area for the controller. Memory is set up for
906 * the initialisation block (12 words of contiguous memory starting
907 * on a word boundary),the transmit and receive ring structures (each
908 * entry is 4 words long and must start on a quadword boundary) and
911 * The alignment tests are particularly paranoid.
915 sc->trans_ring = sc->recv_ring + NDESC(sc->nrdre);
918 if (sc->nic.mem_mode == SHMEM)
919 lnc_mem = (char *)(uintptr_t)sc->nic.iobase;
921 lnc_mem = (char *) (sc->trans_ring + NDESC(sc->ntdre));
923 lnc_mem = (char *)(((long)lnc_mem + 1) & ~1);
924 sc->init_block = (struct init_block *) ((long) lnc_mem & ~1);
925 lnc_mem = (char *) (sc->init_block + 1);
926 lnc_mem = (char *)(((long)lnc_mem + 7) & ~7);
928 /* Initialise pointers to descriptor entries */
929 for (i = 0; i < NDESC(sc->nrdre); i++) {
930 (sc->recv_ring + i)->md = (struct mds *) lnc_mem;
931 lnc_mem += sizeof(struct mds);
933 for (i = 0; i < NDESC(sc->ntdre); i++) {
934 (sc->trans_ring + i)->md = (struct mds *) lnc_mem;
935 lnc_mem += sizeof(struct mds);
938 /* Initialise the remaining ring entries */
940 if (sc->nic.mem_mode == DMA_MBUF) {
945 /* Free previously allocated mbufs */
946 if (sc->flags & LNC_INITIALISED)
950 for (i = 0; i < NDESC(sc->nrdre); i++) {
951 if (alloc_mbuf_cluster(sc, sc->recv_ring+i)) {
952 log(LOG_ERR, "Initialisation failed -- no mbufs\n");
958 for (i = 0; i < NDESC(sc->ntdre); i++) {
959 (sc->trans_ring + i)->buff.mbuf = 0;
960 (sc->trans_ring + i)->md->md0 = 0;
961 (sc->trans_ring + i)->md->md1 = 0;
962 (sc->trans_ring + i)->md->md2 = 0;
963 (sc->trans_ring + i)->md->md3 = 0;
966 for (i = 0; i < NDESC(sc->nrdre); i++) {
967 (sc->recv_ring + i)->md->md0 = kvtop(lnc_mem);
968 (sc->recv_ring + i)->md->md1 = ((kvtop(lnc_mem) >> 16) & 0xff) | OWN;
969 (sc->recv_ring + i)->md->md2 = -RECVBUFSIZE;
970 (sc->recv_ring + i)->md->md3 = 0;
971 (sc->recv_ring + i)->buff.data = lnc_mem;
972 lnc_mem += RECVBUFSIZE;
974 for (i = 0; i < NDESC(sc->ntdre); i++) {
975 (sc->trans_ring + i)->md->md0 = kvtop(lnc_mem);
976 (sc->trans_ring + i)->md->md1 = ((kvtop(lnc_mem) >> 16) & 0xff);
977 (sc->trans_ring + i)->md->md2 = 0;
978 (sc->trans_ring + i)->md->md3 = 0;
979 (sc->trans_ring + i)->buff.data = lnc_mem;
980 lnc_mem += TRANSBUFSIZE;
984 sc->next_to_send = 0;
986 /* Set up initialisation block */
988 sc->init_block->mode = sc->nic.mode;
990 for (i = 0; i < ETHER_ADDR_LEN; i++)
991 sc->init_block->padr[i] = sc->arpcom.ac_enaddr[i];
995 sc->init_block->rdra = kvtop(sc->recv_ring->md);
996 sc->init_block->rlen = ((kvtop(sc->recv_ring->md) >> 16) & 0xff) | (sc->nrdre << 13);
997 sc->init_block->tdra = kvtop(sc->trans_ring->md);
998 sc->init_block->tlen = ((kvtop(sc->trans_ring->md) >> 16) & 0xff) | (sc->ntdre << 13);
1001 /* Set flags to show that the memory area is valid */
1002 sc->flags |= LNC_INITIALISED;
1004 sc->pending_transmits = 0;
1006 /* Give the LANCE the physical address of the initialisation block */
1008 if (sc->nic.ic == PCnet_Home) {
1010 /* Set PHY_SEL to HomeRun */
1011 media = read_bcr(sc, BCR49);
1014 write_bcr(sc, BCR49, media);
1017 write_csr(sc, CSR1, kvtop(sc->init_block));
1018 write_csr(sc, CSR2, (kvtop(sc->init_block) >> 16) & 0xff);
1021 * Depending on which controller this is, CSR3 has different meanings.
1022 * For the Am7990 it controls DMA operations, for the Am79C960 it
1023 * controls interrupt masks and transmitter algorithms. In either
1024 * case, none of the flags are set.
1028 write_csr(sc, CSR3, 0);
1030 /* Let's see if it starts */
1032 printf("Enabling lnc interrupts\n");
1033 sc->arpcom.ac_if.if_timer = 10;
1034 write_csr(sc, CSR0, INIT|INEA);
1038 * Now that the initialisation is complete there's no reason to
1039 * access anything except CSR0, so we leave RAP pointing there
1040 * so we can just access RDP from now on, saving an outw each
1044 write_csr(sc, CSR0, INIT);
1045 for(i=0; i < 1000; i++)
1046 if (read_csr(sc, CSR0) & IDON)
1049 if (read_csr(sc, CSR0) & IDON) {
1051 * Enable interrupts, start the LANCE, mark the interface as
1052 * running and transmit any pending packets.
1054 write_csr(sc, CSR0, STRT | INEA);
1055 sc->arpcom.ac_if.if_flags |= IFF_RUNNING;
1056 sc->arpcom.ac_if.if_flags &= ~IFF_OACTIVE;
1057 lnc_start(&sc->arpcom.ac_if);
1059 log(LOG_ERR, "%s: Initialisation failed\n",
1060 sc->arpcom.ac_if.if_xname);
1066 * The interrupt flag (INTR) will be set and provided that the interrupt enable
1067 * flag (INEA) is also set, the interrupt pin will be driven low when any of
1068 * the following occur:
1070 * 1) Completion of the initialisation routine (IDON). 2) The reception of a
1071 * packet (RINT). 3) The transmission of a packet (TINT). 4) A transmitter
1072 * timeout error (BABL). 5) A missed packet (MISS). 6) A memory error (MERR).
1074 * The interrupt flag is cleared when all of the above conditions are cleared.
1076 * If the driver is reset from this routine then it first checks to see if any
1077 * interrupts have ocurred since the reset and handles them before returning.
1078 * This is because the NIC may signify a pending interrupt in CSR0 using the
1079 * INTR flag even if a hardware interrupt is currently inhibited (at least I
1080 * think it does from reading the data sheets). We may as well deal with
1081 * these pending interrupts now rather than get the overhead of another
1082 * hardware interrupt immediately upon returning from the interrupt handler.
1089 lnc_softc_t *sc = arg;
1093 * INEA is the only bit that can be cleared by writing a 0 to it so
1094 * we have to include it in any writes that clear other flags.
1097 while ((csr0 = lnc_inw(sc->rdp)) & INTR) {
1100 * Clear interrupt flags early to avoid race conditions. The
1101 * controller can still set these flags even while we're in
1102 * this interrupt routine. If the flag is still set from the
1103 * event that caused this interrupt any new events will
1107 lnc_outw(sc->rdp, csr0);
1108 /*lnc_outw(sc->rdp, IDON | CERR | BABL | MISS | MERR | RINT | TINT | INEA);*/
1113 sc->arpcom.ac_if.if_timer = 0;
1114 write_csr(sc, CSR0, STRT | INEA);
1115 sc->arpcom.ac_if.if_flags |= IFF_RUNNING;
1116 sc->arpcom.ac_if.if_flags &= ~IFF_OACTIVE;
1117 lnc_start(&sc->arpcom.ac_if);
1124 log(LOG_ERR, "%s: Heartbeat error -- SQE test failed\n", sc->arpcom.ac_if.if_xname);
1128 log(LOG_ERR, "%s: Babble error - more than 1519 bytes transmitted\n", sc->arpcom.ac_if.if_xname);
1130 sc->arpcom.ac_if.if_oerrors++;
1133 log(LOG_ERR, "%s: Missed packet -- no receive buffer\n", sc->arpcom.ac_if.if_xname);
1135 sc->arpcom.ac_if.if_ierrors++;
1138 log(LOG_ERR, "%s: Memory error -- Resetting\n", sc->arpcom.ac_if.if_xname);
1150 sc->arpcom.ac_if.if_timer = 0;
1155 * If there's room in the transmit descriptor ring then queue
1156 * some more transmit packets.
1159 if (!(sc->arpcom.ac_if.if_flags & IFF_OACTIVE))
1160 lnc_start(&sc->arpcom.ac_if);
1165 mbuf_to_buffer(struct mbuf *m, char *buffer)
1170 for( ; m; m = m->m_next) {
1171 bcopy(mtod(m, caddr_t), buffer, m->m_len);
1179 static __inline struct mbuf *
1180 chain_to_cluster(struct mbuf *m)
1184 MGET(new, M_DONTWAIT, MT_DATA);
1186 MCLGET(new, M_DONTWAIT);
1187 if (new->m_ext.ext_buf) {
1188 new->m_len = mbuf_to_buffer(m, new->m_data);
1198 * IFF_OACTIVE and IFF_RUNNING are checked in ether_output so it's redundant
1199 * to check them again since we wouldn't have got here if they were not
1200 * appropriately set. This is also called from lnc_init and lncintr but the
1201 * flags should be ok at those points too.
1205 lnc_start(struct ifnet *ifp)
1208 struct lnc_softc *sc = ifp->if_softc;
1209 struct host_ring_entry *desc;
1212 struct mbuf *head, *m;
1215 int no_entries_needed;
1219 IFQ_DRV_DEQUEUE(&sc->arpcom.ac_if.if_snd, head);
1223 if (sc->nic.mem_mode == DMA_MBUF) {
1225 no_entries_needed = 0;
1226 for (m=head; m; m = m->m_next)
1227 no_entries_needed++;
1230 * We try and avoid bcopy as much as possible
1231 * but there are two cases when we use it.
1233 * 1) If there are not enough free entries in the ring
1234 * to hold each mbuf in the chain then compact the
1235 * chain into a single cluster.
1237 * 2) The Am7990 and Am79C90 must not have less than
1238 * 100 bytes in the first descriptor of a chained
1239 * packet so it's necessary to shuffle the mbuf
1240 * contents to ensure this.
1244 if (no_entries_needed > (NDESC(sc->ntdre) - sc->pending_transmits)) {
1245 if (!(head = chain_to_cluster(head))) {
1246 log(LOG_ERR, "%s: Couldn't get mbuf for transmit packet -- Resetting \n ",ifp->if_xname);
1250 } else if ((sc->nic.ic == LANCE) || (sc->nic.ic == C_LANCE)) {
1251 if ((head->m_len < 100) && (head->m_next)) {
1252 len = 100 - head->m_len;
1253 if (M_TRAILINGSPACE(head) < len) {
1255 * Move data to start of data
1256 * area. We assume the first
1257 * mbuf has a packet header
1258 * and is not a cluster.
1260 bcopy((caddr_t)head->m_data, (caddr_t)head->m_pktdat, head->m_len);
1261 head->m_data = head->m_pktdat;
1264 while (m && (len > 0)) {
1265 chunk = min(len, m->m_len);
1266 bcopy(mtod(m, caddr_t), mtod(head, caddr_t) + head->m_len, chunk);
1268 head->m_len += chunk;
1271 if (m->m_len <= 0) {
1279 tmp = sc->next_to_send;
1282 * On entering this loop we know that tmp points to a
1283 * descriptor with a clear OWN bit.
1286 desc = sc->trans_ring + tmp;
1287 len = ETHER_MIN_LEN;
1288 for (m = head; m; m = m->m_next) {
1289 desc->buff.mbuf = m;
1290 addr = kvtop(m->m_data);
1291 desc->md->md0 = addr;
1292 desc->md->md1 = ((addr >> 16) & 0xff);
1294 desc->md->md2 = -m->m_len;
1295 sc->pending_transmits++;
1298 INC_MD_PTR(tmp, sc->ntdre)
1299 desc = sc->trans_ring + tmp;
1302 end_of_packet = tmp;
1303 DEC_MD_PTR(tmp, sc->ntdre)
1304 desc = sc->trans_ring + tmp;
1305 desc->md->md1 |= ENP;
1308 desc->md->md2 -= len;
1311 * Set OWN bits in reverse order, otherwise the Lance
1312 * could start sending the packet before all the
1313 * buffers have been relinquished by the host.
1316 while (tmp != sc->next_to_send) {
1317 desc->md->md1 |= OWN;
1318 DEC_MD_PTR(tmp, sc->ntdre)
1319 desc = sc->trans_ring + tmp;
1321 sc->next_to_send = end_of_packet;
1322 desc->md->md1 |= STP | OWN;
1324 sc->pending_transmits++;
1325 desc = sc->trans_ring + sc->next_to_send;
1326 len = mbuf_to_buffer(head, desc->buff.data);
1328 desc->md->md2 = -max(len, ETHER_MIN_LEN - ETHER_CRC_LEN);
1329 desc->md->md1 |= OWN | STP | ENP;
1330 INC_MD_PTR(sc->next_to_send, sc->ntdre)
1333 /* Force an immediate poll of the transmit ring */
1334 lnc_outw(sc->rdp, TDMD | INEA);
1337 * Set a timer so if the buggy Am7990.h shuts
1338 * down we can wake it up.
1343 BPF_MTAP(&sc->arpcom.ac_if, head);
1345 if (sc->nic.mem_mode != DMA_MBUF)
1348 } while (sc->pending_transmits < NDESC(sc->ntdre));
1351 * Transmit ring is full so set IFF_OACTIVE
1352 * since we can't buffer any more packets.
1355 sc->arpcom.ac_if.if_flags |= IFF_OACTIVE;
1356 LNCSTATS(trans_ring_full)
1360 lnc_ioctl(struct ifnet * ifp, u_long command, caddr_t data)
1363 struct lnc_softc *sc = ifp->if_softc;
1371 if (ifp->if_flags & IFF_DEBUG)
1376 if (ifp->if_flags & IFF_PROMISC) {
1377 if (!(sc->nic.mode & PROM)) {
1378 sc->nic.mode |= PROM;
1381 } else if (sc->nic.mode & PROM) {
1382 sc->nic.mode &= ~PROM;
1386 if ((ifp->if_flags & IFF_ALLMULTI) &&
1387 !(sc->flags & LNC_ALLMULTI)) {
1388 sc->flags |= LNC_ALLMULTI;
1390 } else if (!(ifp->if_flags & IFF_ALLMULTI) &&
1391 (sc->flags & LNC_ALLMULTI)) {
1392 sc->flags &= ~LNC_ALLMULTI;
1396 if ((ifp->if_flags & IFF_UP) == 0 &&
1397 (ifp->if_flags & IFF_RUNNING) != 0) {
1399 * If interface is marked down and it is running,
1403 ifp->if_flags &= ~IFF_RUNNING;
1404 } else if ((ifp->if_flags & IFF_UP) != 0 &&
1405 (ifp->if_flags & IFF_RUNNING) == 0) {
1407 * If interface is marked up and it is stopped, then
1419 error = ether_ioctl(ifp, command, data);
1427 lnc_watchdog(struct ifnet *ifp)
1429 log(LOG_ERR, "%s: Device timeout -- Resetting\n", ifp->if_xname);
1431 lnc_reset(ifp->if_softc);
1436 lnc_dump_state(struct lnc_softc *sc)
1440 printf("\nDriver/NIC [%s] state dump\n", sc->arpcom.ac_if.if_xname);
1441 printf("Memory access mode: %b\n", sc->nic.mem_mode, MEM_MODES);
1442 printf("Host memory\n");
1443 printf("-----------\n");
1445 printf("Receive ring: base = %p, next = %p\n",
1446 (void *)sc->recv_ring, (void *)(sc->recv_ring + sc->recv_next));
1447 for (i = 0; i < NDESC(sc->nrdre); i++)
1448 printf("\t%d:%p md = %p buff = %p\n",
1449 i, (void *)(sc->recv_ring + i),
1450 (void *)(sc->recv_ring + i)->md,
1451 (void *)(sc->recv_ring + i)->buff.data);
1453 printf("Transmit ring: base = %p, next = %p\n",
1454 (void *)sc->trans_ring, (void *)(sc->trans_ring + sc->trans_next));
1455 for (i = 0; i < NDESC(sc->ntdre); i++)
1456 printf("\t%d:%p md = %p buff = %p\n",
1457 i, (void *)(sc->trans_ring + i),
1458 (void *)(sc->trans_ring + i)->md,
1459 (void *)(sc->trans_ring + i)->buff.data);
1460 printf("Lance memory (may be on host(DMA) or card(SHMEM))\n");
1461 printf("Init block = %p\n", (void *)sc->init_block);
1462 printf("\tmode = %b rlen:rdra = %x:%x tlen:tdra = %x:%x\n",
1463 sc->init_block->mode, INIT_MODE, sc->init_block->rlen,
1464 sc->init_block->rdra, sc->init_block->tlen, sc->init_block->tdra);
1465 printf("Receive descriptor ring\n");
1466 for (i = 0; i < NDESC(sc->nrdre); i++)
1467 printf("\t%d buffer = 0x%x%x, BCNT = %d,\tMCNT = %u,\tflags = %b\n",
1468 i, ((sc->recv_ring + i)->md->md1 & HADR),
1469 (sc->recv_ring + i)->md->md0,
1470 -(short) (sc->recv_ring + i)->md->md2,
1471 (sc->recv_ring + i)->md->md3,
1472 (((sc->recv_ring + i)->md->md1 & ~HADR) >> 8), RECV_MD1);
1473 printf("Transmit descriptor ring\n");
1474 for (i = 0; i < NDESC(sc->ntdre); i++)
1475 printf("\t%d buffer = 0x%x%x, BCNT = %d,\tflags = %b %b\n",
1476 i, ((sc->trans_ring + i)->md->md1 & HADR),
1477 (sc->trans_ring + i)->md->md0,
1478 -(short) (sc->trans_ring + i)->md->md2,
1479 ((sc->trans_ring + i)->md->md1 >> 8), TRANS_MD1,
1480 ((sc->trans_ring + i)->md->md3 >> 10), TRANS_MD3);
1481 printf("\nnext_to_send = %x\n", sc->next_to_send);
1482 printf("\n CSR0 = %b CSR1 = %x CSR2 = %x CSR3 = %x\n\n",
1483 read_csr(sc, CSR0), CSR0_FLAGS, read_csr(sc, CSR1),
1484 read_csr(sc, CSR2), read_csr(sc, CSR3));
1486 /* Set RAP back to CSR0 */
1487 lnc_outw(sc->rap, CSR0);
1491 mbuf_dump_chain(struct mbuf * m)
1494 #define MBUF_FLAGS \
1495 "\20\1M_EXT\2M_PKTHDR\3M_EOR\4UNKNOWN\5M_BCAST\6M_MCAST"
1498 log(LOG_DEBUG, "m == NULL\n");
1500 log(LOG_DEBUG, "m = %p\n", (void *)m);
1501 log(LOG_DEBUG, "m_hdr.mh_next = %p\n",
1502 (void *)m->m_hdr.mh_next);
1503 log(LOG_DEBUG, "m_hdr.mh_nextpkt = %p\n",
1504 (void *)m->m_hdr.mh_nextpkt);
1505 log(LOG_DEBUG, "m_hdr.mh_len = %d\n", m->m_hdr.mh_len);
1506 log(LOG_DEBUG, "m_hdr.mh_data = %p\n",
1507 (void *)m->m_hdr.mh_data);
1508 log(LOG_DEBUG, "m_hdr.mh_type = %d\n", m->m_hdr.mh_type);
1509 log(LOG_DEBUG, "m_hdr.mh_flags = %b\n", m->m_hdr.mh_flags,
1511 if (!(m->m_hdr.mh_flags & (M_PKTHDR | M_EXT)))
1512 log(LOG_DEBUG, "M_dat.M_databuf = %p\n",
1513 (void *)m->M_dat.M_databuf);
1515 if (m->m_hdr.mh_flags & M_PKTHDR) {
1516 log(LOG_DEBUG, "M_dat.MH.MH_pkthdr.len = %d\n",
1517 m->M_dat.MH.MH_pkthdr.len);
1519 "M_dat.MH.MH_pkthdr.rcvif = %p\n",
1520 (void *)m->M_dat.MH.MH_pkthdr.rcvif);
1521 if (!(m->m_hdr.mh_flags & M_EXT))
1523 "M_dat.MH.MH_dat.MH_databuf = %p\n",
1524 (void *)m->M_dat.MH.MH_dat.MH_databuf);
1526 if (m->m_hdr.mh_flags & M_EXT) {
1528 "M_dat.MH.MH_dat.MH_ext.ext_buff %p\n",
1529 (void *)m->M_dat.MH.MH_dat.MH_ext.ext_buf);
1531 "M_dat.MH.MH_dat.MH_ext.ext_free %p\n",
1532 (void *)m->M_dat.MH.MH_dat.MH_ext.ext_free);
1534 "M_dat.MH.MH_dat.MH_ext.ext_size %d\n",
1535 m->M_dat.MH.MH_dat.MH_ext.ext_size);
1538 } while ((m = m->m_next) != NULL);