1 /* $NetBSD: lance.c,v 1.34 2005/12/24 20:27:30 perry Exp $ */
4 * Copyright (c) 1997, 1998 The NetBSD Foundation, Inc.
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Charles M. Hannum and by Jason R. Thorpe of the Numerical Aerospace
9 * Simulation Facility, NASA Ames Research Center.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by the NetBSD
22 * Foundation, Inc. and its contributors.
23 * 4. Neither the name of The NetBSD Foundation nor the names of its
24 * contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37 * POSSIBILITY OF SUCH DAMAGE.
41 * Copyright (c) 1992, 1993
42 * The Regents of the University of California. All rights reserved.
44 * This code is derived from software contributed to Berkeley by
45 * Ralph Campbell and Rick Macklem.
47 * Redistribution and use in source and binary forms, with or without
48 * modification, are permitted provided that the following conditions
50 * 1. Redistributions of source code must retain the above copyright
51 * notice, this list of conditions and the following disclaimer.
52 * 2. Redistributions in binary form must reproduce the above copyright
53 * notice, this list of conditions and the following disclaimer in the
54 * documentation and/or other materials provided with the distribution.
55 * 3. Neither the name of the University nor the names of its contributors
56 * may be used to endorse or promote products derived from this software
57 * without specific prior written permission.
59 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
60 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
61 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
62 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
63 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
64 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
65 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
66 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
67 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
68 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
71 * @(#)if_le.c 8.2 (Berkeley) 11/16/93
74 #include <sys/cdefs.h>
75 __FBSDID("$FreeBSD$");
77 #include <sys/param.h>
79 #include <sys/endian.h>
82 #include <sys/mutex.h>
83 #include <sys/socket.h>
84 #include <sys/sockio.h>
86 #include <net/ethernet.h>
88 #include <net/if_arp.h>
89 #include <net/if_dl.h>
90 #include <net/if_media.h>
91 #include <net/if_types.h>
92 #include <net/if_vlan_var.h>
94 #include <machine/bus.h>
96 #include <dev/le/lancereg.h>
97 #include <dev/le/lancevar.h>
99 devclass_t le_devclass;
101 static void lance_start(struct ifnet *);
102 static void lance_stop(struct lance_softc *);
103 static void lance_init(void *);
104 static void lance_watchdog(struct ifnet *);
105 static int lance_mediachange(struct ifnet *);
106 static void lance_mediastatus(struct ifnet *, struct ifmediareq *);
107 static int lance_ioctl(struct ifnet *, u_long, caddr_t);
110 lance_config(struct lance_softc *sc, const char* name, int unit)
115 if (LE_LOCK_INITIALIZED(sc) == 0)
118 ifp = sc->sc_ifp = if_alloc(IFT_ETHER);
122 /* Initialize ifnet structure. */
124 if_initname(ifp, name, unit);
125 ifp->if_start = lance_start;
126 ifp->if_ioctl = lance_ioctl;
127 ifp->if_watchdog = lance_watchdog;
128 ifp->if_init = lance_init;
129 ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
130 #ifdef LANCE_REVC_BUG
131 ifp->if_flags &= ~IFF_MULTICAST;
133 ifp->if_baudrate = IF_Mbps(10);
134 IFQ_SET_MAXLEN(&ifp->if_snd, IFQ_MAXLEN);
135 ifp->if_snd.ifq_drv_maxlen = IFQ_MAXLEN;
136 IFQ_SET_READY(&ifp->if_snd);
138 /* Initialize ifmedia structures. */
139 ifmedia_init(&sc->sc_media, 0, lance_mediachange, lance_mediastatus);
140 if (sc->sc_supmedia != NULL) {
141 for (i = 0; i < sc->sc_nsupmedia; i++)
142 ifmedia_add(&sc->sc_media, sc->sc_supmedia[i], 0, NULL);
143 ifmedia_set(&sc->sc_media, sc->sc_defaultmedia);
145 ifmedia_add(&sc->sc_media,
146 IFM_MAKEWORD(IFM_ETHER, IFM_MANUAL, 0, 0), 0, NULL);
147 ifmedia_set(&sc->sc_media,
148 IFM_MAKEWORD(IFM_ETHER, IFM_MANUAL, 0, 0));
151 switch (sc->sc_memsize) {
177 /* weird memory size; cope with it */
178 nbuf = sc->sc_memsize / LEBLEN;
179 sc->sc_ntbuf = nbuf / 5;
180 sc->sc_nrbuf = nbuf - sc->sc_ntbuf;
183 if_printf(ifp, "%d receive buffers, %d transmit buffers\n",
184 sc->sc_nrbuf, sc->sc_ntbuf);
186 /* Make sure the chip is stopped. */
195 lance_attach(struct lance_softc *sc)
197 struct ifnet *ifp = sc->sc_ifp;
199 /* Attach the interface. */
200 ether_ifattach(ifp, sc->sc_enaddr);
202 /* Claim 802.1q capability. */
203 ifp->if_data.ifi_hdrlen = sizeof(struct ether_vlan_header);
204 ifp->if_capabilities |= IFCAP_VLAN_MTU;
205 ifp->if_capenable |= IFCAP_VLAN_MTU;
209 lance_detach(struct lance_softc *sc)
211 struct ifnet *ifp = sc->sc_ifp;
221 lance_suspend(struct lance_softc *sc)
230 lance_resume(struct lance_softc *sc)
234 if (sc->sc_ifp->if_flags & IFF_UP)
235 lance_init_locked(sc);
240 lance_start(struct ifnet *ifp)
242 struct lance_softc *sc = ifp->if_softc;
245 (*sc->sc_start_locked)(sc);
250 lance_stop(struct lance_softc *sc)
252 struct ifnet *ifp = sc->sc_ifp;
254 LE_LOCK_ASSERT(sc, MA_OWNED);
257 * Mark the interface down and cancel the watchdog timer.
259 ifp->if_drv_flags &= ~(IFF_DRV_RUNNING | IFF_DRV_OACTIVE);
262 (*sc->sc_wrcsr)(sc, LE_CSR0, LE_C0_STOP);
266 lance_init(void *xsc)
268 struct lance_softc *sc = (struct lance_softc *)xsc;
271 lance_init_locked(sc);
276 * Initialization of interface; set up initialization block
277 * and transmit/receive descriptor rings.
280 lance_init_locked(struct lance_softc *sc)
282 struct ifnet *ifp = sc->sc_ifp;
286 LE_LOCK_ASSERT(sc, MA_OWNED);
288 (*sc->sc_wrcsr)(sc, LE_CSR0, LE_C0_STOP);
291 /* Newer LANCE chips have a reset register. */
293 (*sc->sc_hwreset)(sc);
295 /* Set the correct byte swapping mode, etc. */
296 (*sc->sc_wrcsr)(sc, LE_CSR3, sc->sc_conf3);
299 * Update our private copy of the Ethernet address.
300 * We NEED the copy so we can ensure its alignment!
302 memcpy(sc->sc_enaddr, IF_LLADDR(ifp), ETHER_ADDR_LEN);
304 /* Set up LANCE init block. */
305 (*sc->sc_meminit)(sc);
307 /* Give LANCE the physical address of its init block. */
308 a = sc->sc_addr + LE_INITADDR(sc);
309 (*sc->sc_wrcsr)(sc, LE_CSR1, a & 0xffff);
310 (*sc->sc_wrcsr)(sc, LE_CSR2, a >> 16);
312 /* Try to initialize the LANCE. */
314 (*sc->sc_wrcsr)(sc, LE_CSR0, LE_C0_INIT);
316 /* Wait for initialization to finish. */
317 for (timo = 100000; timo; timo--)
318 if ((*sc->sc_rdcsr)(sc, LE_CSR0) & LE_C0_IDON)
321 /* Set the current media. */
322 if (sc->sc_mediachange)
323 (void)(*sc->sc_mediachange)(sc);
325 if ((*sc->sc_rdcsr)(sc, LE_CSR0) & LE_C0_IDON) {
326 /* Start the LANCE. */
327 (*sc->sc_wrcsr)(sc, LE_CSR0, LE_C0_INEA | LE_C0_STRT);
328 ifp->if_drv_flags |= IFF_DRV_RUNNING;
329 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
331 (*sc->sc_start_locked)(sc);
333 if_printf(ifp, "controller failed to initialize\n");
336 (*sc->sc_hwinit)(sc);
340 * Routine to copy from mbuf chain to transmit buffer in
341 * network buffer memory.
344 lance_put(struct lance_softc *sc, int boff, struct mbuf *m)
349 LE_LOCK_ASSERT(sc, MA_OWNED);
358 (*sc->sc_copytobuf)(sc, mtod(m, caddr_t), boff, len);
364 if (tlen < LEMINSIZE) {
365 (*sc->sc_zerobuf)(sc, boff, LEMINSIZE - tlen);
372 * Pull data off an interface.
373 * Len is length of data, with local net header stripped.
374 * We copy the data into mbufs. When full cluster sized units are present
375 * we copy into clusters.
378 lance_get(struct lance_softc *sc, int boff, int totlen)
380 struct ifnet *ifp = sc->sc_ifp;
381 struct mbuf *m, *m0, *newm;
385 if (totlen <= ETHER_HDR_LEN || totlen > LEBLEN - ETHER_CRC_LEN) {
387 if_printf(ifp, "invalid packet size %d; dropping\n", totlen);
392 MGETHDR(m0, M_DONTWAIT, MT_DATA);
395 m0->m_pkthdr.rcvif = ifp;
396 m0->m_pkthdr.len = totlen;
401 if (totlen >= MINCLSIZE) {
402 MCLGET(m, M_DONTWAIT);
403 if ((m->m_flags & M_EXT) == 0)
410 ALIGN(m->m_data + ETHER_HDR_LEN) - ETHER_HDR_LEN;
411 len -= newdata - m->m_data;
415 m->m_len = len = min(totlen, len);
416 (*sc->sc_copyfrombuf)(sc, mtod(m, caddr_t), boff, len);
421 MGET(newm, M_DONTWAIT, MT_DATA);
425 m = m->m_next = newm;
437 lance_watchdog(struct ifnet *ifp)
439 struct lance_softc *sc = ifp->if_softc;
442 if_printf(ifp, "device timeout\n");
444 lance_init_locked(sc);
449 lance_mediachange(struct ifnet *ifp)
451 struct lance_softc *sc = ifp->if_softc;
454 if (sc->sc_mediachange) {
456 error = (*sc->sc_mediachange)(sc);
464 lance_mediastatus(struct ifnet *ifp, struct ifmediareq *ifmr)
466 struct lance_softc *sc = ifp->if_softc;
469 if (!(ifp->if_flags & IFF_UP)) {
474 ifmr->ifm_status = IFM_AVALID;
475 if (sc->sc_flags & LE_CARRIER)
476 ifmr->ifm_status |= IFM_ACTIVE;
478 if (sc->sc_mediastatus)
479 (*sc->sc_mediastatus)(sc, ifmr);
484 * Process an ioctl request.
487 lance_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data)
489 struct lance_softc *sc = ifp->if_softc;
490 struct ifreq *ifr = (struct ifreq *)data;
496 if (ifp->if_flags & IFF_PROMISC) {
497 if (!(sc->sc_flags & LE_PROMISC)) {
498 sc->sc_flags |= LE_PROMISC;
499 lance_init_locked(sc);
501 } else if (sc->sc_flags & LE_PROMISC) {
502 sc->sc_flags &= ~LE_PROMISC;
503 lance_init_locked(sc);
506 if ((ifp->if_flags & IFF_ALLMULTI) &&
507 !(sc->sc_flags & LE_ALLMULTI)) {
508 sc->sc_flags |= LE_ALLMULTI;
509 lance_init_locked(sc);
510 } else if (!(ifp->if_flags & IFF_ALLMULTI) &&
511 (sc->sc_flags & LE_ALLMULTI)) {
512 sc->sc_flags &= ~LE_ALLMULTI;
513 lance_init_locked(sc);
516 if (!(ifp->if_flags & IFF_UP) &&
517 ifp->if_drv_flags & IFF_DRV_RUNNING) {
519 * If interface is marked down and it is running, then
523 } else if (ifp->if_flags & IFF_UP &&
524 !(ifp->if_drv_flags & IFF_DRV_RUNNING)) {
526 * If interface is marked up and it is stopped, then
529 lance_init_locked(sc);
532 if (ifp->if_flags & IFF_DEBUG)
533 sc->sc_flags |= LE_DEBUG;
535 sc->sc_flags &= ~LE_DEBUG;
543 * Multicast list has changed; set the hardware filter
547 if (ifp->if_drv_flags & IFF_DRV_RUNNING)
548 lance_init_locked(sc);
554 error = ifmedia_ioctl(ifp, ifr, &sc->sc_media, cmd);
558 error = ether_ioctl(ifp, cmd, data);
566 * Set up the logical address filter.
569 lance_setladrf(struct lance_softc *sc, uint16_t *af)
571 struct ifnet *ifp = sc->sc_ifp;
572 struct ifmultiaddr *ifma;
576 * Set up multicast address filter by passing all multicast addresses
577 * through a crc generator, and then using the high order 6 bits as an
578 * index into the 64 bit logical address filter. The high order bit
579 * selects the word, while the rest of the bits select the bit within
583 if (ifp->if_flags & IFF_PROMISC || sc->sc_flags & LE_ALLMULTI) {
584 af[0] = af[1] = af[2] = af[3] = 0xffff;
588 af[0] = af[1] = af[2] = af[3] = 0x0000;
590 TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
591 if (ifma->ifma_addr->sa_family != AF_LINK)
594 crc = ether_crc32_le(LLADDR((struct sockaddr_dl *)
595 ifma->ifma_addr), ETHER_ADDR_LEN);
597 /* Just want the 6 most significant bits. */
600 /* Set the corresponding bit in the filter. */
601 af[crc >> 4] |= LE_HTOLE16(1 << (crc & 0xf));
607 * Routines for accessing the transmit and receive buffers.
608 * The various CPU and adapter configurations supported by this
609 * driver require three different access methods for buffers
611 * (1) contig (contiguous data; no padding),
612 * (2) gap2 (two bytes of data followed by two bytes of padding),
613 * (3) gap16 (16 bytes of data followed by 16 bytes of padding).
617 * contig: contiguous data with no padding.
619 * Buffers may have any alignment.
623 lance_copytobuf_contig(struct lance_softc *sc, void *from, int boff, int len)
625 volatile caddr_t buf = sc->sc_mem;
628 * Just call memcpy() to do the work.
630 memcpy(buf + boff, from, len);
634 lance_copyfrombuf_contig(struct lance_softc *sc, void *to, int boff, int len)
636 volatile caddr_t buf = sc->sc_mem;
639 * Just call memcpy() to do the work.
641 memcpy(to, buf + boff, len);
645 lance_zerobuf_contig(struct lance_softc *sc, int boff, int len)
647 volatile caddr_t buf = sc->sc_mem;
650 * Just let memset() do the work
652 memset(buf + boff, 0, len);
657 * Examples only; duplicate these and tweak (if necessary) in
658 * machine-specific front-ends.
662 * gap2: two bytes of data followed by two bytes of pad.
664 * Buffers must be 4-byte aligned. The code doesn't worry about
665 * doing an extra byte.
669 lance_copytobuf_gap2(struct lance_softc *sc, void *fromv, int boff, int len)
671 volatile caddr_t buf = sc->sc_mem;
672 caddr_t from = fromv;
673 volatile uint16_t *bptr;
676 /* Handle unaligned first byte. */
677 bptr = ((volatile uint16_t *)buf) + (boff - 1);
678 *bptr = (*from++ << 8) | (*bptr & 0xff);
682 bptr = ((volatile uint16_t *)buf) + boff;
684 *bptr = (from[1] << 8) | (from[0] & 0xff);
690 *bptr = (uint16_t)*from;
694 lance_copyfrombuf_gap2(struct lance_softc *sc, void *tov, int boff, int len)
696 volatile caddr_t buf = sc->sc_mem;
698 volatile uint16_t *bptr;
702 /* Handle unaligned first byte. */
703 bptr = ((volatile uint16_t *)buf) + (boff - 1);
704 *to++ = (*bptr >> 8) & 0xff;
708 bptr = ((volatile uint16_t *)buf) + boff;
712 *to++ = (tmp >> 8) & 0xff;
721 lance_zerobuf_gap2(struct lance_softc *sc, int boff, int len)
723 volatile caddr_t buf = sc->sc_mem;
724 volatile uint16_t *bptr;
726 if ((unsigned)boff & 0x1) {
727 bptr = ((volatile uint16_t *)buf) + (boff - 1);
732 bptr = ((volatile uint16_t *)buf) + boff;
741 * gap16: 16 bytes of data followed by 16 bytes of pad.
743 * Buffers must be 32-byte aligned.
747 lance_copytobuf_gap16(struct lance_softc *sc, void *fromv, int boff, int len)
749 volatile caddr_t buf = sc->sc_mem;
750 caddr_t bptr, from = fromv;
753 bptr = buf + ((boff << 1) & ~0x1f);
755 xfer = min(len, 16 - boff);
757 memcpy(bptr + boff, from, xfer);
767 lance_copyfrombuf_gap16(struct lance_softc *sc, void *tov, int boff, int len)
769 volatile caddr_t buf = sc->sc_mem;
770 caddr_t bptr, to = tov;
773 bptr = buf + ((boff << 1) & ~0x1f);
775 xfer = min(len, 16 - boff);
777 memcpy(to, bptr + boff, xfer);
787 lance_zerobuf_gap16(struct lance_softc *sc, int boff, int len)
789 volatile caddr_t buf = sc->sc_mem;
793 bptr = buf + ((boff << 1) & ~0x1f);
795 xfer = min(len, 16 - boff);
797 memset(bptr + boff, 0, xfer);
804 #endif /* Example only */