1 /* $NetBSD: lance.c,v 1.34 2005/12/24 20:27:30 perry Exp $ */
4 * SPDX-License-Identifier: BSD-2-Clause-NetBSD
6 * Copyright (c) 1997, 1998 The NetBSD Foundation, Inc.
9 * This code is derived from software contributed to The NetBSD Foundation
10 * by Charles M. Hannum and by Jason R. Thorpe of the Numerical Aerospace
11 * Simulation Facility, NASA Ames Research Center.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
22 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
23 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
24 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
25 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
26 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGE.
36 * Copyright (c) 1992, 1993
37 * The Regents of the University of California. All rights reserved.
39 * This code is derived from software contributed to Berkeley by
40 * Ralph Campbell and Rick Macklem.
42 * Redistribution and use in source and binary forms, with or without
43 * modification, are permitted provided that the following conditions
45 * 1. Redistributions of source code must retain the above copyright
46 * notice, this list of conditions and the following disclaimer.
47 * 2. Redistributions in binary form must reproduce the above copyright
48 * notice, this list of conditions and the following disclaimer in the
49 * documentation and/or other materials provided with the distribution.
50 * 3. Neither the name of the University nor the names of its contributors
51 * may be used to endorse or promote products derived from this software
52 * without specific prior written permission.
54 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
55 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
56 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
57 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
58 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
59 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
60 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
61 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
62 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
63 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
66 * @(#)if_le.c 8.2 (Berkeley) 11/16/93
69 #include <sys/cdefs.h>
70 __FBSDID("$FreeBSD$");
72 #include <sys/param.h>
74 #include <sys/endian.h>
76 #include <sys/kernel.h>
77 #include <sys/malloc.h>
79 #include <sys/mutex.h>
80 #include <sys/socket.h>
81 #include <sys/sockio.h>
83 #include <net/ethernet.h>
85 #include <net/if_var.h>
86 #include <net/if_arp.h>
87 #include <net/if_dl.h>
88 #include <net/if_media.h>
89 #include <net/if_types.h>
90 #include <net/if_vlan_var.h>
92 #include <machine/bus.h>
94 #include <dev/le/lancereg.h>
95 #include <dev/le/lancevar.h>
97 devclass_t le_devclass;
99 static void lance_start(struct ifnet *);
100 static void lance_stop(struct lance_softc *);
101 static void lance_init(void *);
102 static void lance_watchdog(void *s);
103 static int lance_mediachange(struct ifnet *);
104 static void lance_mediastatus(struct ifnet *, struct ifmediareq *);
105 static int lance_ioctl(struct ifnet *, u_long, caddr_t);
108 lance_config(struct lance_softc *sc, const char* name, int unit)
113 if (LE_LOCK_INITIALIZED(sc) == 0)
116 ifp = sc->sc_ifp = if_alloc(IFT_ETHER);
120 callout_init_mtx(&sc->sc_wdog_ch, &sc->sc_mtx, 0);
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_init = lance_init;
128 ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
129 #ifdef LANCE_REVC_BUG
130 ifp->if_flags &= ~IFF_MULTICAST;
132 ifp->if_baudrate = IF_Mbps(10);
133 IFQ_SET_MAXLEN(&ifp->if_snd, ifqmaxlen);
134 ifp->if_snd.ifq_drv_maxlen = ifqmaxlen;
135 IFQ_SET_READY(&ifp->if_snd);
137 /* Initialize ifmedia structures. */
138 ifmedia_init(&sc->sc_media, 0, lance_mediachange, lance_mediastatus);
139 if (sc->sc_supmedia != NULL) {
140 for (i = 0; i < sc->sc_nsupmedia; i++)
141 ifmedia_add(&sc->sc_media, sc->sc_supmedia[i], 0, NULL);
142 ifmedia_set(&sc->sc_media, sc->sc_defaultmedia);
144 ifmedia_add(&sc->sc_media,
145 IFM_MAKEWORD(IFM_ETHER, IFM_MANUAL, 0, 0), 0, NULL);
146 ifmedia_set(&sc->sc_media,
147 IFM_MAKEWORD(IFM_ETHER, IFM_MANUAL, 0, 0));
150 switch (sc->sc_memsize) {
176 /* weird memory size; cope with it */
177 nbuf = sc->sc_memsize / LEBLEN;
178 sc->sc_ntbuf = nbuf / 5;
179 sc->sc_nrbuf = nbuf - sc->sc_ntbuf;
182 if_printf(ifp, "%d receive buffers, %d transmit buffers\n",
183 sc->sc_nrbuf, sc->sc_ntbuf);
185 /* Make sure the chip is stopped. */
194 lance_attach(struct lance_softc *sc)
196 struct ifnet *ifp = sc->sc_ifp;
198 /* Attach the interface. */
199 ether_ifattach(ifp, sc->sc_enaddr);
201 /* Claim 802.1q capability. */
202 ifp->if_hdrlen = sizeof(struct ether_vlan_header);
203 ifp->if_capabilities |= IFCAP_VLAN_MTU;
204 ifp->if_capenable |= IFCAP_VLAN_MTU;
208 lance_detach(struct lance_softc *sc)
210 struct ifnet *ifp = sc->sc_ifp;
215 callout_drain(&sc->sc_wdog_ch);
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);
260 callout_stop(&sc->sc_wdog_ch);
261 sc->sc_wdog_timer = 0;
263 (*sc->sc_wrcsr)(sc, LE_CSR0, LE_C0_STOP);
267 lance_init(void *xsc)
269 struct lance_softc *sc = (struct lance_softc *)xsc;
272 lance_init_locked(sc);
277 * Initialization of interface; set up initialization block
278 * and transmit/receive descriptor rings.
281 lance_init_locked(struct lance_softc *sc)
283 struct ifnet *ifp = sc->sc_ifp;
287 LE_LOCK_ASSERT(sc, MA_OWNED);
289 (*sc->sc_wrcsr)(sc, LE_CSR0, LE_C0_STOP);
292 /* Newer LANCE chips have a reset register. */
294 (*sc->sc_hwreset)(sc);
296 /* Set the correct byte swapping mode, etc. */
297 (*sc->sc_wrcsr)(sc, LE_CSR3, sc->sc_conf3);
299 /* Set the current media. This may require the chip to be stopped. */
300 if (sc->sc_mediachange)
301 (void)(*sc->sc_mediachange)(sc);
304 * Update our private copy of the Ethernet address.
305 * We NEED the copy so we can ensure its alignment!
307 memcpy(sc->sc_enaddr, IF_LLADDR(ifp), ETHER_ADDR_LEN);
309 /* Set up LANCE init block. */
310 (*sc->sc_meminit)(sc);
312 /* Give LANCE the physical address of its init block. */
313 a = sc->sc_addr + LE_INITADDR(sc);
314 (*sc->sc_wrcsr)(sc, LE_CSR1, a & 0xffff);
315 (*sc->sc_wrcsr)(sc, LE_CSR2, a >> 16);
317 /* Try to initialize the LANCE. */
319 (*sc->sc_wrcsr)(sc, LE_CSR0, LE_C0_INIT);
321 /* Wait for initialization to finish. */
322 for (timo = 100000; timo; timo--)
323 if ((*sc->sc_rdcsr)(sc, LE_CSR0) & LE_C0_IDON)
326 if ((*sc->sc_rdcsr)(sc, LE_CSR0) & LE_C0_IDON) {
327 /* Start the LANCE. */
328 (*sc->sc_wrcsr)(sc, LE_CSR0, LE_C0_INEA | LE_C0_STRT);
329 ifp->if_drv_flags |= IFF_DRV_RUNNING;
330 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
331 sc->sc_wdog_timer = 0;
332 callout_reset(&sc->sc_wdog_ch, hz, lance_watchdog, sc);
333 (*sc->sc_start_locked)(sc);
335 if_printf(ifp, "controller failed to initialize\n");
338 (*sc->sc_hwinit)(sc);
342 * Routine to copy from mbuf chain to transmit buffer in
343 * network buffer memory.
346 lance_put(struct lance_softc *sc, int boff, struct mbuf *m)
351 LE_LOCK_ASSERT(sc, MA_OWNED);
360 (*sc->sc_copytobuf)(sc, mtod(m, caddr_t), boff, len);
366 if (tlen < LEMINSIZE) {
367 (*sc->sc_zerobuf)(sc, boff, LEMINSIZE - tlen);
374 * Pull data off an interface.
375 * Len is length of data, with local net header stripped.
376 * We copy the data into mbufs. When full cluster sized units are present
377 * we copy into clusters.
380 lance_get(struct lance_softc *sc, int boff, int totlen)
382 struct ifnet *ifp = sc->sc_ifp;
383 struct mbuf *m, *m0, *newm;
387 if (totlen <= ETHER_HDR_LEN || totlen > LEBLEN - ETHER_CRC_LEN) {
389 if_printf(ifp, "invalid packet size %d; dropping\n", totlen);
394 MGETHDR(m0, M_NOWAIT, MT_DATA);
397 m0->m_pkthdr.rcvif = ifp;
398 m0->m_pkthdr.len = totlen;
403 if (totlen >= MINCLSIZE) {
404 if (!(MCLGET(m, M_NOWAIT)))
411 ALIGN(m->m_data + ETHER_HDR_LEN) - ETHER_HDR_LEN;
412 len -= newdata - m->m_data;
416 m->m_len = len = min(totlen, len);
417 (*sc->sc_copyfrombuf)(sc, mtod(m, caddr_t), boff, len);
422 MGET(newm, M_NOWAIT, MT_DATA);
426 m = m->m_next = newm;
438 lance_watchdog(void *xsc)
440 struct lance_softc *sc = (struct lance_softc *)xsc;
441 struct ifnet *ifp = sc->sc_ifp;
443 LE_LOCK_ASSERT(sc, MA_OWNED);
445 if (sc->sc_wdog_timer == 0 || --sc->sc_wdog_timer != 0) {
446 callout_reset(&sc->sc_wdog_ch, hz, lance_watchdog, sc);
450 if_printf(ifp, "device timeout\n");
451 if_inc_counter(ifp, IFCOUNTER_OERRORS, 1);
452 lance_init_locked(sc);
456 lance_mediachange(struct ifnet *ifp)
458 struct lance_softc *sc = ifp->if_softc;
460 if (sc->sc_mediachange) {
462 * For setting the port in LE_CSR15 the PCnet chips must
463 * be powered down or stopped and unlike documented may
464 * not take effect without an initialization. So don't
465 * invoke (*sc_mediachange) directly here but go through
466 * lance_init_locked().
470 lance_init_locked(sc);
471 if (!IFQ_DRV_IS_EMPTY(&ifp->if_snd))
472 (*sc->sc_start_locked)(sc);
479 lance_mediastatus(struct ifnet *ifp, struct ifmediareq *ifmr)
481 struct lance_softc *sc = ifp->if_softc;
484 if (!(ifp->if_flags & IFF_UP)) {
489 ifmr->ifm_status = IFM_AVALID;
490 if (sc->sc_flags & LE_CARRIER)
491 ifmr->ifm_status |= IFM_ACTIVE;
493 if (sc->sc_mediastatus)
494 (*sc->sc_mediastatus)(sc, ifmr);
499 * Process an ioctl request.
502 lance_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data)
504 struct lance_softc *sc = ifp->if_softc;
505 struct ifreq *ifr = (struct ifreq *)data;
511 if (ifp->if_flags & IFF_PROMISC) {
512 if (!(sc->sc_flags & LE_PROMISC)) {
513 sc->sc_flags |= LE_PROMISC;
514 lance_init_locked(sc);
516 } else if (sc->sc_flags & LE_PROMISC) {
517 sc->sc_flags &= ~LE_PROMISC;
518 lance_init_locked(sc);
521 if ((ifp->if_flags & IFF_ALLMULTI) &&
522 !(sc->sc_flags & LE_ALLMULTI)) {
523 sc->sc_flags |= LE_ALLMULTI;
524 lance_init_locked(sc);
525 } else if (!(ifp->if_flags & IFF_ALLMULTI) &&
526 (sc->sc_flags & LE_ALLMULTI)) {
527 sc->sc_flags &= ~LE_ALLMULTI;
528 lance_init_locked(sc);
531 if (!(ifp->if_flags & IFF_UP) &&
532 ifp->if_drv_flags & IFF_DRV_RUNNING) {
534 * If interface is marked down and it is running, then
538 } else if (ifp->if_flags & IFF_UP &&
539 !(ifp->if_drv_flags & IFF_DRV_RUNNING)) {
541 * If interface is marked up and it is stopped, then
544 lance_init_locked(sc);
547 if (ifp->if_flags & IFF_DEBUG)
548 sc->sc_flags |= LE_DEBUG;
550 sc->sc_flags &= ~LE_DEBUG;
558 * Multicast list has changed; set the hardware filter
562 if (ifp->if_drv_flags & IFF_DRV_RUNNING)
563 lance_init_locked(sc);
569 error = ifmedia_ioctl(ifp, ifr, &sc->sc_media, cmd);
573 error = ether_ioctl(ifp, cmd, data);
581 * Set up the logical address filter.
584 lance_setladrf(struct lance_softc *sc, uint16_t *af)
586 struct ifnet *ifp = sc->sc_ifp;
587 struct ifmultiaddr *ifma;
591 * Set up multicast address filter by passing all multicast addresses
592 * through a crc generator, and then using the high order 6 bits as an
593 * index into the 64 bit logical address filter. The high order bit
594 * selects the word, while the rest of the bits select the bit within
598 if (ifp->if_flags & IFF_PROMISC || sc->sc_flags & LE_ALLMULTI) {
599 af[0] = af[1] = af[2] = af[3] = 0xffff;
603 af[0] = af[1] = af[2] = af[3] = 0x0000;
605 CK_STAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
606 if (ifma->ifma_addr->sa_family != AF_LINK)
609 crc = ether_crc32_le(LLADDR((struct sockaddr_dl *)
610 ifma->ifma_addr), ETHER_ADDR_LEN);
612 /* Just want the 6 most significant bits. */
615 /* Set the corresponding bit in the filter. */
616 af[crc >> 4] |= LE_HTOLE16(1 << (crc & 0xf));
618 if_maddr_runlock(ifp);
622 * Routines for accessing the transmit and receive buffers.
623 * The various CPU and adapter configurations supported by this
624 * driver require three different access methods for buffers
626 * (1) contig (contiguous data; no padding),
627 * (2) gap2 (two bytes of data followed by two bytes of padding),
628 * (3) gap16 (16 bytes of data followed by 16 bytes of padding).
632 * contig: contiguous data with no padding.
634 * Buffers may have any alignment.
638 lance_copytobuf_contig(struct lance_softc *sc, void *from, int boff, int len)
640 volatile caddr_t buf = sc->sc_mem;
643 * Just call memcpy() to do the work.
645 memcpy(buf + boff, from, len);
649 lance_copyfrombuf_contig(struct lance_softc *sc, void *to, int boff, int len)
651 volatile caddr_t buf = sc->sc_mem;
654 * Just call memcpy() to do the work.
656 memcpy(to, buf + boff, len);
660 lance_zerobuf_contig(struct lance_softc *sc, int boff, int len)
662 volatile caddr_t buf = sc->sc_mem;
665 * Just let memset() do the work
667 memset(buf + boff, 0, len);
672 * Examples only; duplicate these and tweak (if necessary) in
673 * machine-specific front-ends.
677 * gap2: two bytes of data followed by two bytes of pad.
679 * Buffers must be 4-byte aligned. The code doesn't worry about
680 * doing an extra byte.
684 lance_copytobuf_gap2(struct lance_softc *sc, void *fromv, int boff, int len)
686 volatile caddr_t buf = sc->sc_mem;
687 caddr_t from = fromv;
688 volatile uint16_t *bptr;
691 /* Handle unaligned first byte. */
692 bptr = ((volatile uint16_t *)buf) + (boff - 1);
693 *bptr = (*from++ << 8) | (*bptr & 0xff);
697 bptr = ((volatile uint16_t *)buf) + boff;
699 *bptr = (from[1] << 8) | (from[0] & 0xff);
705 *bptr = (uint16_t)*from;
709 lance_copyfrombuf_gap2(struct lance_softc *sc, void *tov, int boff, int len)
711 volatile caddr_t buf = sc->sc_mem;
713 volatile uint16_t *bptr;
717 /* Handle unaligned first byte. */
718 bptr = ((volatile uint16_t *)buf) + (boff - 1);
719 *to++ = (*bptr >> 8) & 0xff;
723 bptr = ((volatile uint16_t *)buf) + boff;
727 *to++ = (tmp >> 8) & 0xff;
736 lance_zerobuf_gap2(struct lance_softc *sc, int boff, int len)
738 volatile caddr_t buf = sc->sc_mem;
739 volatile uint16_t *bptr;
741 if ((unsigned)boff & 0x1) {
742 bptr = ((volatile uint16_t *)buf) + (boff - 1);
747 bptr = ((volatile uint16_t *)buf) + boff;
756 * gap16: 16 bytes of data followed by 16 bytes of pad.
758 * Buffers must be 32-byte aligned.
762 lance_copytobuf_gap16(struct lance_softc *sc, void *fromv, int boff, int len)
764 volatile caddr_t buf = sc->sc_mem;
765 caddr_t bptr, from = fromv;
768 bptr = buf + ((boff << 1) & ~0x1f);
770 xfer = min(len, 16 - boff);
772 memcpy(bptr + boff, from, xfer);
782 lance_copyfrombuf_gap16(struct lance_softc *sc, void *tov, int boff, int len)
784 volatile caddr_t buf = sc->sc_mem;
785 caddr_t bptr, to = tov;
788 bptr = buf + ((boff << 1) & ~0x1f);
790 xfer = min(len, 16 - boff);
792 memcpy(to, bptr + boff, xfer);
802 lance_zerobuf_gap16(struct lance_softc *sc, int boff, int len)
804 volatile caddr_t buf = sc->sc_mem;
808 bptr = buf + ((boff << 1) & ~0x1f);
810 xfer = min(len, 16 - boff);
812 memset(bptr + boff, 0, xfer);
819 #endif /* Example only */