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.
20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
34 * Copyright (c) 1992, 1993
35 * The Regents of the University of California. All rights reserved.
37 * This code is derived from software contributed to Berkeley by
38 * Ralph Campbell and Rick Macklem.
40 * Redistribution and use in source and binary forms, with or without
41 * modification, are permitted provided that the following conditions
43 * 1. Redistributions of source code must retain the above copyright
44 * notice, this list of conditions and the following disclaimer.
45 * 2. Redistributions in binary form must reproduce the above copyright
46 * notice, this list of conditions and the following disclaimer in the
47 * documentation and/or other materials provided with the distribution.
48 * 3. Neither the name of the University nor the names of its contributors
49 * may be used to endorse or promote products derived from this software
50 * without specific prior written permission.
52 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
53 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
54 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
55 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
56 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
57 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
58 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
59 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
60 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
61 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
64 * @(#)if_le.c 8.2 (Berkeley) 11/16/93
67 #include <sys/cdefs.h>
68 __FBSDID("$FreeBSD$");
70 #include <sys/param.h>
72 #include <sys/endian.h>
74 #include <sys/kernel.h>
76 #include <sys/mutex.h>
77 #include <sys/socket.h>
78 #include <sys/sockio.h>
80 #include <net/ethernet.h>
82 #include <net/if_arp.h>
83 #include <net/if_dl.h>
84 #include <net/if_media.h>
85 #include <net/if_types.h>
86 #include <net/if_vlan_var.h>
88 #include <machine/bus.h>
90 #include <dev/le/lancereg.h>
91 #include <dev/le/lancevar.h>
93 devclass_t le_devclass;
95 static void lance_start(struct ifnet *);
96 static void lance_stop(struct lance_softc *);
97 static void lance_init(void *);
98 static void lance_watchdog(void *s);
99 static int lance_mediachange(struct ifnet *);
100 static void lance_mediastatus(struct ifnet *, struct ifmediareq *);
101 static int lance_ioctl(struct ifnet *, u_long, caddr_t);
104 lance_config(struct lance_softc *sc, const char* name, int unit)
109 if (LE_LOCK_INITIALIZED(sc) == 0)
112 ifp = sc->sc_ifp = if_alloc(IFT_ETHER);
116 callout_init_mtx(&sc->sc_wdog_ch, &sc->sc_mtx, 0);
118 /* Initialize ifnet structure. */
120 if_initname(ifp, name, unit);
121 ifp->if_start = lance_start;
122 ifp->if_ioctl = lance_ioctl;
123 ifp->if_init = lance_init;
124 ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
125 #ifdef LANCE_REVC_BUG
126 ifp->if_flags &= ~IFF_MULTICAST;
128 ifp->if_baudrate = IF_Mbps(10);
129 IFQ_SET_MAXLEN(&ifp->if_snd, ifqmaxlen);
130 ifp->if_snd.ifq_drv_maxlen = ifqmaxlen;
131 IFQ_SET_READY(&ifp->if_snd);
133 /* Initialize ifmedia structures. */
134 ifmedia_init(&sc->sc_media, 0, lance_mediachange, lance_mediastatus);
135 if (sc->sc_supmedia != NULL) {
136 for (i = 0; i < sc->sc_nsupmedia; i++)
137 ifmedia_add(&sc->sc_media, sc->sc_supmedia[i], 0, NULL);
138 ifmedia_set(&sc->sc_media, sc->sc_defaultmedia);
140 ifmedia_add(&sc->sc_media,
141 IFM_MAKEWORD(IFM_ETHER, IFM_MANUAL, 0, 0), 0, NULL);
142 ifmedia_set(&sc->sc_media,
143 IFM_MAKEWORD(IFM_ETHER, IFM_MANUAL, 0, 0));
146 switch (sc->sc_memsize) {
172 /* weird memory size; cope with it */
173 nbuf = sc->sc_memsize / LEBLEN;
174 sc->sc_ntbuf = nbuf / 5;
175 sc->sc_nrbuf = nbuf - sc->sc_ntbuf;
178 if_printf(ifp, "%d receive buffers, %d transmit buffers\n",
179 sc->sc_nrbuf, sc->sc_ntbuf);
181 /* Make sure the chip is stopped. */
190 lance_attach(struct lance_softc *sc)
192 struct ifnet *ifp = sc->sc_ifp;
194 /* Attach the interface. */
195 ether_ifattach(ifp, sc->sc_enaddr);
197 /* Claim 802.1q capability. */
198 ifp->if_data.ifi_hdrlen = sizeof(struct ether_vlan_header);
199 ifp->if_capabilities |= IFCAP_VLAN_MTU;
200 ifp->if_capenable |= IFCAP_VLAN_MTU;
204 lance_detach(struct lance_softc *sc)
206 struct ifnet *ifp = sc->sc_ifp;
211 callout_drain(&sc->sc_wdog_ch);
217 lance_suspend(struct lance_softc *sc)
226 lance_resume(struct lance_softc *sc)
230 if (sc->sc_ifp->if_flags & IFF_UP)
231 lance_init_locked(sc);
236 lance_start(struct ifnet *ifp)
238 struct lance_softc *sc = ifp->if_softc;
241 (*sc->sc_start_locked)(sc);
246 lance_stop(struct lance_softc *sc)
248 struct ifnet *ifp = sc->sc_ifp;
250 LE_LOCK_ASSERT(sc, MA_OWNED);
253 * Mark the interface down and cancel the watchdog timer.
255 ifp->if_drv_flags &= ~(IFF_DRV_RUNNING | IFF_DRV_OACTIVE);
256 callout_stop(&sc->sc_wdog_ch);
257 sc->sc_wdog_timer = 0;
259 (*sc->sc_wrcsr)(sc, LE_CSR0, LE_C0_STOP);
263 lance_init(void *xsc)
265 struct lance_softc *sc = (struct lance_softc *)xsc;
268 lance_init_locked(sc);
273 * Initialization of interface; set up initialization block
274 * and transmit/receive descriptor rings.
277 lance_init_locked(struct lance_softc *sc)
279 struct ifnet *ifp = sc->sc_ifp;
283 LE_LOCK_ASSERT(sc, MA_OWNED);
285 (*sc->sc_wrcsr)(sc, LE_CSR0, LE_C0_STOP);
288 /* Newer LANCE chips have a reset register. */
290 (*sc->sc_hwreset)(sc);
292 /* Set the correct byte swapping mode, etc. */
293 (*sc->sc_wrcsr)(sc, LE_CSR3, sc->sc_conf3);
295 /* Set the current media. This may require the chip to be stopped. */
296 if (sc->sc_mediachange)
297 (void)(*sc->sc_mediachange)(sc);
300 * Update our private copy of the Ethernet address.
301 * We NEED the copy so we can ensure its alignment!
303 memcpy(sc->sc_enaddr, IF_LLADDR(ifp), ETHER_ADDR_LEN);
305 /* Set up LANCE init block. */
306 (*sc->sc_meminit)(sc);
308 /* Give LANCE the physical address of its init block. */
309 a = sc->sc_addr + LE_INITADDR(sc);
310 (*sc->sc_wrcsr)(sc, LE_CSR1, a & 0xffff);
311 (*sc->sc_wrcsr)(sc, LE_CSR2, a >> 16);
313 /* Try to initialize the LANCE. */
315 (*sc->sc_wrcsr)(sc, LE_CSR0, LE_C0_INIT);
317 /* Wait for initialization to finish. */
318 for (timo = 100000; timo; timo--)
319 if ((*sc->sc_rdcsr)(sc, LE_CSR0) & LE_C0_IDON)
322 if ((*sc->sc_rdcsr)(sc, LE_CSR0) & LE_C0_IDON) {
323 /* Start the LANCE. */
324 (*sc->sc_wrcsr)(sc, LE_CSR0, LE_C0_INEA | LE_C0_STRT);
325 ifp->if_drv_flags |= IFF_DRV_RUNNING;
326 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
327 sc->sc_wdog_timer = 0;
328 callout_reset(&sc->sc_wdog_ch, hz, lance_watchdog, sc);
329 (*sc->sc_start_locked)(sc);
331 if_printf(ifp, "controller failed to initialize\n");
334 (*sc->sc_hwinit)(sc);
338 * Routine to copy from mbuf chain to transmit buffer in
339 * network buffer memory.
342 lance_put(struct lance_softc *sc, int boff, struct mbuf *m)
347 LE_LOCK_ASSERT(sc, MA_OWNED);
356 (*sc->sc_copytobuf)(sc, mtod(m, caddr_t), boff, len);
362 if (tlen < LEMINSIZE) {
363 (*sc->sc_zerobuf)(sc, boff, LEMINSIZE - tlen);
370 * Pull data off an interface.
371 * Len is length of data, with local net header stripped.
372 * We copy the data into mbufs. When full cluster sized units are present
373 * we copy into clusters.
376 lance_get(struct lance_softc *sc, int boff, int totlen)
378 struct ifnet *ifp = sc->sc_ifp;
379 struct mbuf *m, *m0, *newm;
383 if (totlen <= ETHER_HDR_LEN || totlen > LEBLEN - ETHER_CRC_LEN) {
385 if_printf(ifp, "invalid packet size %d; dropping\n", totlen);
390 MGETHDR(m0, M_NOWAIT, MT_DATA);
393 m0->m_pkthdr.rcvif = ifp;
394 m0->m_pkthdr.len = totlen;
399 if (totlen >= MINCLSIZE) {
401 if ((m->m_flags & M_EXT) == 0)
408 ALIGN(m->m_data + ETHER_HDR_LEN) - ETHER_HDR_LEN;
409 len -= newdata - m->m_data;
413 m->m_len = len = min(totlen, len);
414 (*sc->sc_copyfrombuf)(sc, mtod(m, caddr_t), boff, len);
419 MGET(newm, M_NOWAIT, MT_DATA);
423 m = m->m_next = newm;
435 lance_watchdog(void *xsc)
437 struct lance_softc *sc = (struct lance_softc *)xsc;
438 struct ifnet *ifp = sc->sc_ifp;
440 LE_LOCK_ASSERT(sc, MA_OWNED);
442 if (sc->sc_wdog_timer == 0 || --sc->sc_wdog_timer != 0) {
443 callout_reset(&sc->sc_wdog_ch, hz, lance_watchdog, sc);
447 if_printf(ifp, "device timeout\n");
449 lance_init_locked(sc);
453 lance_mediachange(struct ifnet *ifp)
455 struct lance_softc *sc = ifp->if_softc;
457 if (sc->sc_mediachange) {
459 * For setting the port in LE_CSR15 the PCnet chips must
460 * be powered down or stopped and unlike documented may
461 * not take effect without an initialization. So don't
462 * invoke (*sc_mediachange) directly here but go through
463 * lance_init_locked().
467 lance_init_locked(sc);
468 if (!IFQ_DRV_IS_EMPTY(&ifp->if_snd))
469 (*sc->sc_start_locked)(sc);
476 lance_mediastatus(struct ifnet *ifp, struct ifmediareq *ifmr)
478 struct lance_softc *sc = ifp->if_softc;
481 if (!(ifp->if_flags & IFF_UP)) {
486 ifmr->ifm_status = IFM_AVALID;
487 if (sc->sc_flags & LE_CARRIER)
488 ifmr->ifm_status |= IFM_ACTIVE;
490 if (sc->sc_mediastatus)
491 (*sc->sc_mediastatus)(sc, ifmr);
496 * Process an ioctl request.
499 lance_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data)
501 struct lance_softc *sc = ifp->if_softc;
502 struct ifreq *ifr = (struct ifreq *)data;
508 if (ifp->if_flags & IFF_PROMISC) {
509 if (!(sc->sc_flags & LE_PROMISC)) {
510 sc->sc_flags |= LE_PROMISC;
511 lance_init_locked(sc);
513 } else if (sc->sc_flags & LE_PROMISC) {
514 sc->sc_flags &= ~LE_PROMISC;
515 lance_init_locked(sc);
518 if ((ifp->if_flags & IFF_ALLMULTI) &&
519 !(sc->sc_flags & LE_ALLMULTI)) {
520 sc->sc_flags |= LE_ALLMULTI;
521 lance_init_locked(sc);
522 } else if (!(ifp->if_flags & IFF_ALLMULTI) &&
523 (sc->sc_flags & LE_ALLMULTI)) {
524 sc->sc_flags &= ~LE_ALLMULTI;
525 lance_init_locked(sc);
528 if (!(ifp->if_flags & IFF_UP) &&
529 ifp->if_drv_flags & IFF_DRV_RUNNING) {
531 * If interface is marked down and it is running, then
535 } else if (ifp->if_flags & IFF_UP &&
536 !(ifp->if_drv_flags & IFF_DRV_RUNNING)) {
538 * If interface is marked up and it is stopped, then
541 lance_init_locked(sc);
544 if (ifp->if_flags & IFF_DEBUG)
545 sc->sc_flags |= LE_DEBUG;
547 sc->sc_flags &= ~LE_DEBUG;
555 * Multicast list has changed; set the hardware filter
559 if (ifp->if_drv_flags & IFF_DRV_RUNNING)
560 lance_init_locked(sc);
566 error = ifmedia_ioctl(ifp, ifr, &sc->sc_media, cmd);
570 error = ether_ioctl(ifp, cmd, data);
578 * Set up the logical address filter.
581 lance_setladrf(struct lance_softc *sc, uint16_t *af)
583 struct ifnet *ifp = sc->sc_ifp;
584 struct ifmultiaddr *ifma;
588 * Set up multicast address filter by passing all multicast addresses
589 * through a crc generator, and then using the high order 6 bits as an
590 * index into the 64 bit logical address filter. The high order bit
591 * selects the word, while the rest of the bits select the bit within
595 if (ifp->if_flags & IFF_PROMISC || sc->sc_flags & LE_ALLMULTI) {
596 af[0] = af[1] = af[2] = af[3] = 0xffff;
600 af[0] = af[1] = af[2] = af[3] = 0x0000;
602 TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
603 if (ifma->ifma_addr->sa_family != AF_LINK)
606 crc = ether_crc32_le(LLADDR((struct sockaddr_dl *)
607 ifma->ifma_addr), ETHER_ADDR_LEN);
609 /* Just want the 6 most significant bits. */
612 /* Set the corresponding bit in the filter. */
613 af[crc >> 4] |= LE_HTOLE16(1 << (crc & 0xf));
615 if_maddr_runlock(ifp);
619 * Routines for accessing the transmit and receive buffers.
620 * The various CPU and adapter configurations supported by this
621 * driver require three different access methods for buffers
623 * (1) contig (contiguous data; no padding),
624 * (2) gap2 (two bytes of data followed by two bytes of padding),
625 * (3) gap16 (16 bytes of data followed by 16 bytes of padding).
629 * contig: contiguous data with no padding.
631 * Buffers may have any alignment.
635 lance_copytobuf_contig(struct lance_softc *sc, void *from, int boff, int len)
637 volatile caddr_t buf = sc->sc_mem;
640 * Just call memcpy() to do the work.
642 memcpy(buf + boff, from, len);
646 lance_copyfrombuf_contig(struct lance_softc *sc, void *to, int boff, int len)
648 volatile caddr_t buf = sc->sc_mem;
651 * Just call memcpy() to do the work.
653 memcpy(to, buf + boff, len);
657 lance_zerobuf_contig(struct lance_softc *sc, int boff, int len)
659 volatile caddr_t buf = sc->sc_mem;
662 * Just let memset() do the work
664 memset(buf + boff, 0, len);
669 * Examples only; duplicate these and tweak (if necessary) in
670 * machine-specific front-ends.
674 * gap2: two bytes of data followed by two bytes of pad.
676 * Buffers must be 4-byte aligned. The code doesn't worry about
677 * doing an extra byte.
681 lance_copytobuf_gap2(struct lance_softc *sc, void *fromv, int boff, int len)
683 volatile caddr_t buf = sc->sc_mem;
684 caddr_t from = fromv;
685 volatile uint16_t *bptr;
688 /* Handle unaligned first byte. */
689 bptr = ((volatile uint16_t *)buf) + (boff - 1);
690 *bptr = (*from++ << 8) | (*bptr & 0xff);
694 bptr = ((volatile uint16_t *)buf) + boff;
696 *bptr = (from[1] << 8) | (from[0] & 0xff);
702 *bptr = (uint16_t)*from;
706 lance_copyfrombuf_gap2(struct lance_softc *sc, void *tov, int boff, int len)
708 volatile caddr_t buf = sc->sc_mem;
710 volatile uint16_t *bptr;
714 /* Handle unaligned first byte. */
715 bptr = ((volatile uint16_t *)buf) + (boff - 1);
716 *to++ = (*bptr >> 8) & 0xff;
720 bptr = ((volatile uint16_t *)buf) + boff;
724 *to++ = (tmp >> 8) & 0xff;
733 lance_zerobuf_gap2(struct lance_softc *sc, int boff, int len)
735 volatile caddr_t buf = sc->sc_mem;
736 volatile uint16_t *bptr;
738 if ((unsigned)boff & 0x1) {
739 bptr = ((volatile uint16_t *)buf) + (boff - 1);
744 bptr = ((volatile uint16_t *)buf) + boff;
753 * gap16: 16 bytes of data followed by 16 bytes of pad.
755 * Buffers must be 32-byte aligned.
759 lance_copytobuf_gap16(struct lance_softc *sc, void *fromv, int boff, int len)
761 volatile caddr_t buf = sc->sc_mem;
762 caddr_t bptr, from = fromv;
765 bptr = buf + ((boff << 1) & ~0x1f);
767 xfer = min(len, 16 - boff);
769 memcpy(bptr + boff, from, xfer);
779 lance_copyfrombuf_gap16(struct lance_softc *sc, void *tov, int boff, int len)
781 volatile caddr_t buf = sc->sc_mem;
782 caddr_t bptr, to = tov;
785 bptr = buf + ((boff << 1) & ~0x1f);
787 xfer = min(len, 16 - boff);
789 memcpy(to, bptr + boff, xfer);
799 lance_zerobuf_gap16(struct lance_softc *sc, int boff, int len)
801 volatile caddr_t buf = sc->sc_mem;
805 bptr = buf + ((boff << 1) & ~0x1f);
807 xfer = min(len, 16 - boff);
809 memset(bptr + boff, 0, xfer);
816 #endif /* Example only */