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>
81 #include <sys/kernel.h>
83 #include <sys/mutex.h>
84 #include <sys/socket.h>
85 #include <sys/sockio.h>
87 #include <net/ethernet.h>
89 #include <net/if_var.h>
90 #include <net/if_arp.h>
91 #include <net/if_dl.h>
92 #include <net/if_media.h>
93 #include <net/if_types.h>
94 #include <net/if_vlan_var.h>
96 #include <machine/bus.h>
98 #include <dev/le/lancereg.h>
99 #include <dev/le/lancevar.h>
101 devclass_t le_devclass;
103 static void lance_start(struct ifnet *);
104 static void lance_stop(struct lance_softc *);
105 static void lance_init(void *);
106 static void lance_watchdog(void *s);
107 static int lance_mediachange(struct ifnet *);
108 static void lance_mediastatus(struct ifnet *, struct ifmediareq *);
109 static int lance_ioctl(struct ifnet *, u_long, caddr_t);
112 lance_config(struct lance_softc *sc, const char* name, int unit)
117 if (LE_LOCK_INITIALIZED(sc) == 0)
120 ifp = sc->sc_ifp = if_alloc(IFT_ETHER);
124 callout_init_mtx(&sc->sc_wdog_ch, &sc->sc_mtx, 0);
126 /* Initialize ifnet structure. */
128 if_initname(ifp, name, unit);
129 ifp->if_start = lance_start;
130 ifp->if_ioctl = lance_ioctl;
131 ifp->if_init = lance_init;
132 ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
133 #ifdef LANCE_REVC_BUG
134 ifp->if_flags &= ~IFF_MULTICAST;
136 ifp->if_baudrate = IF_Mbps(10);
137 IFQ_SET_MAXLEN(&ifp->if_snd, ifqmaxlen);
138 ifp->if_snd.ifq_drv_maxlen = ifqmaxlen;
139 IFQ_SET_READY(&ifp->if_snd);
141 /* Initialize ifmedia structures. */
142 ifmedia_init(&sc->sc_media, 0, lance_mediachange, lance_mediastatus);
143 if (sc->sc_supmedia != NULL) {
144 for (i = 0; i < sc->sc_nsupmedia; i++)
145 ifmedia_add(&sc->sc_media, sc->sc_supmedia[i], 0, NULL);
146 ifmedia_set(&sc->sc_media, sc->sc_defaultmedia);
148 ifmedia_add(&sc->sc_media,
149 IFM_MAKEWORD(IFM_ETHER, IFM_MANUAL, 0, 0), 0, NULL);
150 ifmedia_set(&sc->sc_media,
151 IFM_MAKEWORD(IFM_ETHER, IFM_MANUAL, 0, 0));
154 switch (sc->sc_memsize) {
180 /* weird memory size; cope with it */
181 nbuf = sc->sc_memsize / LEBLEN;
182 sc->sc_ntbuf = nbuf / 5;
183 sc->sc_nrbuf = nbuf - sc->sc_ntbuf;
186 if_printf(ifp, "%d receive buffers, %d transmit buffers\n",
187 sc->sc_nrbuf, sc->sc_ntbuf);
189 /* Make sure the chip is stopped. */
198 lance_attach(struct lance_softc *sc)
200 struct ifnet *ifp = sc->sc_ifp;
202 /* Attach the interface. */
203 ether_ifattach(ifp, sc->sc_enaddr);
205 /* Claim 802.1q capability. */
206 ifp->if_data.ifi_hdrlen = sizeof(struct ether_vlan_header);
207 ifp->if_capabilities |= IFCAP_VLAN_MTU;
208 ifp->if_capenable |= IFCAP_VLAN_MTU;
212 lance_detach(struct lance_softc *sc)
214 struct ifnet *ifp = sc->sc_ifp;
219 callout_drain(&sc->sc_wdog_ch);
225 lance_suspend(struct lance_softc *sc)
234 lance_resume(struct lance_softc *sc)
238 if (sc->sc_ifp->if_flags & IFF_UP)
239 lance_init_locked(sc);
244 lance_start(struct ifnet *ifp)
246 struct lance_softc *sc = ifp->if_softc;
249 (*sc->sc_start_locked)(sc);
254 lance_stop(struct lance_softc *sc)
256 struct ifnet *ifp = sc->sc_ifp;
258 LE_LOCK_ASSERT(sc, MA_OWNED);
261 * Mark the interface down and cancel the watchdog timer.
263 ifp->if_drv_flags &= ~(IFF_DRV_RUNNING | IFF_DRV_OACTIVE);
264 callout_stop(&sc->sc_wdog_ch);
265 sc->sc_wdog_timer = 0;
267 (*sc->sc_wrcsr)(sc, LE_CSR0, LE_C0_STOP);
271 lance_init(void *xsc)
273 struct lance_softc *sc = (struct lance_softc *)xsc;
276 lance_init_locked(sc);
281 * Initialization of interface; set up initialization block
282 * and transmit/receive descriptor rings.
285 lance_init_locked(struct lance_softc *sc)
287 struct ifnet *ifp = sc->sc_ifp;
291 LE_LOCK_ASSERT(sc, MA_OWNED);
293 (*sc->sc_wrcsr)(sc, LE_CSR0, LE_C0_STOP);
296 /* Newer LANCE chips have a reset register. */
298 (*sc->sc_hwreset)(sc);
300 /* Set the correct byte swapping mode, etc. */
301 (*sc->sc_wrcsr)(sc, LE_CSR3, sc->sc_conf3);
303 /* Set the current media. This may require the chip to be stopped. */
304 if (sc->sc_mediachange)
305 (void)(*sc->sc_mediachange)(sc);
308 * Update our private copy of the Ethernet address.
309 * We NEED the copy so we can ensure its alignment!
311 memcpy(sc->sc_enaddr, IF_LLADDR(ifp), ETHER_ADDR_LEN);
313 /* Set up LANCE init block. */
314 (*sc->sc_meminit)(sc);
316 /* Give LANCE the physical address of its init block. */
317 a = sc->sc_addr + LE_INITADDR(sc);
318 (*sc->sc_wrcsr)(sc, LE_CSR1, a & 0xffff);
319 (*sc->sc_wrcsr)(sc, LE_CSR2, a >> 16);
321 /* Try to initialize the LANCE. */
323 (*sc->sc_wrcsr)(sc, LE_CSR0, LE_C0_INIT);
325 /* Wait for initialization to finish. */
326 for (timo = 100000; timo; timo--)
327 if ((*sc->sc_rdcsr)(sc, LE_CSR0) & LE_C0_IDON)
330 if ((*sc->sc_rdcsr)(sc, LE_CSR0) & LE_C0_IDON) {
331 /* Start the LANCE. */
332 (*sc->sc_wrcsr)(sc, LE_CSR0, LE_C0_INEA | LE_C0_STRT);
333 ifp->if_drv_flags |= IFF_DRV_RUNNING;
334 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
335 sc->sc_wdog_timer = 0;
336 callout_reset(&sc->sc_wdog_ch, hz, lance_watchdog, sc);
337 (*sc->sc_start_locked)(sc);
339 if_printf(ifp, "controller failed to initialize\n");
342 (*sc->sc_hwinit)(sc);
346 * Routine to copy from mbuf chain to transmit buffer in
347 * network buffer memory.
350 lance_put(struct lance_softc *sc, int boff, struct mbuf *m)
355 LE_LOCK_ASSERT(sc, MA_OWNED);
364 (*sc->sc_copytobuf)(sc, mtod(m, caddr_t), boff, len);
370 if (tlen < LEMINSIZE) {
371 (*sc->sc_zerobuf)(sc, boff, LEMINSIZE - tlen);
378 * Pull data off an interface.
379 * Len is length of data, with local net header stripped.
380 * We copy the data into mbufs. When full cluster sized units are present
381 * we copy into clusters.
384 lance_get(struct lance_softc *sc, int boff, int totlen)
386 struct ifnet *ifp = sc->sc_ifp;
387 struct mbuf *m, *m0, *newm;
391 if (totlen <= ETHER_HDR_LEN || totlen > LEBLEN - ETHER_CRC_LEN) {
393 if_printf(ifp, "invalid packet size %d; dropping\n", totlen);
398 MGETHDR(m0, M_NOWAIT, MT_DATA);
401 m0->m_pkthdr.rcvif = ifp;
402 m0->m_pkthdr.len = totlen;
407 if (totlen >= MINCLSIZE) {
409 if ((m->m_flags & M_EXT) == 0)
416 ALIGN(m->m_data + ETHER_HDR_LEN) - ETHER_HDR_LEN;
417 len -= newdata - m->m_data;
421 m->m_len = len = min(totlen, len);
422 (*sc->sc_copyfrombuf)(sc, mtod(m, caddr_t), boff, len);
427 MGET(newm, M_NOWAIT, MT_DATA);
431 m = m->m_next = newm;
443 lance_watchdog(void *xsc)
445 struct lance_softc *sc = (struct lance_softc *)xsc;
446 struct ifnet *ifp = sc->sc_ifp;
448 LE_LOCK_ASSERT(sc, MA_OWNED);
450 if (sc->sc_wdog_timer == 0 || --sc->sc_wdog_timer != 0) {
451 callout_reset(&sc->sc_wdog_ch, hz, lance_watchdog, sc);
455 if_printf(ifp, "device timeout\n");
457 lance_init_locked(sc);
461 lance_mediachange(struct ifnet *ifp)
463 struct lance_softc *sc = ifp->if_softc;
465 if (sc->sc_mediachange) {
467 * For setting the port in LE_CSR15 the PCnet chips must
468 * be powered down or stopped and unlike documented may
469 * not take effect without an initialization. So don't
470 * invoke (*sc_mediachange) directly here but go through
471 * lance_init_locked().
475 lance_init_locked(sc);
476 if (!IFQ_DRV_IS_EMPTY(&ifp->if_snd))
477 (*sc->sc_start_locked)(sc);
484 lance_mediastatus(struct ifnet *ifp, struct ifmediareq *ifmr)
486 struct lance_softc *sc = ifp->if_softc;
489 if (!(ifp->if_flags & IFF_UP)) {
494 ifmr->ifm_status = IFM_AVALID;
495 if (sc->sc_flags & LE_CARRIER)
496 ifmr->ifm_status |= IFM_ACTIVE;
498 if (sc->sc_mediastatus)
499 (*sc->sc_mediastatus)(sc, ifmr);
504 * Process an ioctl request.
507 lance_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data)
509 struct lance_softc *sc = ifp->if_softc;
510 struct ifreq *ifr = (struct ifreq *)data;
516 if (ifp->if_flags & IFF_PROMISC) {
517 if (!(sc->sc_flags & LE_PROMISC)) {
518 sc->sc_flags |= LE_PROMISC;
519 lance_init_locked(sc);
521 } else if (sc->sc_flags & LE_PROMISC) {
522 sc->sc_flags &= ~LE_PROMISC;
523 lance_init_locked(sc);
526 if ((ifp->if_flags & IFF_ALLMULTI) &&
527 !(sc->sc_flags & LE_ALLMULTI)) {
528 sc->sc_flags |= LE_ALLMULTI;
529 lance_init_locked(sc);
530 } else if (!(ifp->if_flags & IFF_ALLMULTI) &&
531 (sc->sc_flags & LE_ALLMULTI)) {
532 sc->sc_flags &= ~LE_ALLMULTI;
533 lance_init_locked(sc);
536 if (!(ifp->if_flags & IFF_UP) &&
537 ifp->if_drv_flags & IFF_DRV_RUNNING) {
539 * If interface is marked down and it is running, then
543 } else if (ifp->if_flags & IFF_UP &&
544 !(ifp->if_drv_flags & IFF_DRV_RUNNING)) {
546 * If interface is marked up and it is stopped, then
549 lance_init_locked(sc);
552 if (ifp->if_flags & IFF_DEBUG)
553 sc->sc_flags |= LE_DEBUG;
555 sc->sc_flags &= ~LE_DEBUG;
563 * Multicast list has changed; set the hardware filter
567 if (ifp->if_drv_flags & IFF_DRV_RUNNING)
568 lance_init_locked(sc);
574 error = ifmedia_ioctl(ifp, ifr, &sc->sc_media, cmd);
578 error = ether_ioctl(ifp, cmd, data);
586 * Set up the logical address filter.
589 lance_setladrf(struct lance_softc *sc, uint16_t *af)
591 struct ifnet *ifp = sc->sc_ifp;
592 struct ifmultiaddr *ifma;
596 * Set up multicast address filter by passing all multicast addresses
597 * through a crc generator, and then using the high order 6 bits as an
598 * index into the 64 bit logical address filter. The high order bit
599 * selects the word, while the rest of the bits select the bit within
603 if (ifp->if_flags & IFF_PROMISC || sc->sc_flags & LE_ALLMULTI) {
604 af[0] = af[1] = af[2] = af[3] = 0xffff;
608 af[0] = af[1] = af[2] = af[3] = 0x0000;
610 TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
611 if (ifma->ifma_addr->sa_family != AF_LINK)
614 crc = ether_crc32_le(LLADDR((struct sockaddr_dl *)
615 ifma->ifma_addr), ETHER_ADDR_LEN);
617 /* Just want the 6 most significant bits. */
620 /* Set the corresponding bit in the filter. */
621 af[crc >> 4] |= LE_HTOLE16(1 << (crc & 0xf));
623 if_maddr_runlock(ifp);
627 * Routines for accessing the transmit and receive buffers.
628 * The various CPU and adapter configurations supported by this
629 * driver require three different access methods for buffers
631 * (1) contig (contiguous data; no padding),
632 * (2) gap2 (two bytes of data followed by two bytes of padding),
633 * (3) gap16 (16 bytes of data followed by 16 bytes of padding).
637 * contig: contiguous data with no padding.
639 * Buffers may have any alignment.
643 lance_copytobuf_contig(struct lance_softc *sc, void *from, int boff, int len)
645 volatile caddr_t buf = sc->sc_mem;
648 * Just call memcpy() to do the work.
650 memcpy(buf + boff, from, len);
654 lance_copyfrombuf_contig(struct lance_softc *sc, void *to, int boff, int len)
656 volatile caddr_t buf = sc->sc_mem;
659 * Just call memcpy() to do the work.
661 memcpy(to, buf + boff, len);
665 lance_zerobuf_contig(struct lance_softc *sc, int boff, int len)
667 volatile caddr_t buf = sc->sc_mem;
670 * Just let memset() do the work
672 memset(buf + boff, 0, len);
677 * Examples only; duplicate these and tweak (if necessary) in
678 * machine-specific front-ends.
682 * gap2: two bytes of data followed by two bytes of pad.
684 * Buffers must be 4-byte aligned. The code doesn't worry about
685 * doing an extra byte.
689 lance_copytobuf_gap2(struct lance_softc *sc, void *fromv, int boff, int len)
691 volatile caddr_t buf = sc->sc_mem;
692 caddr_t from = fromv;
693 volatile uint16_t *bptr;
696 /* Handle unaligned first byte. */
697 bptr = ((volatile uint16_t *)buf) + (boff - 1);
698 *bptr = (*from++ << 8) | (*bptr & 0xff);
702 bptr = ((volatile uint16_t *)buf) + boff;
704 *bptr = (from[1] << 8) | (from[0] & 0xff);
710 *bptr = (uint16_t)*from;
714 lance_copyfrombuf_gap2(struct lance_softc *sc, void *tov, int boff, int len)
716 volatile caddr_t buf = sc->sc_mem;
718 volatile uint16_t *bptr;
722 /* Handle unaligned first byte. */
723 bptr = ((volatile uint16_t *)buf) + (boff - 1);
724 *to++ = (*bptr >> 8) & 0xff;
728 bptr = ((volatile uint16_t *)buf) + boff;
732 *to++ = (tmp >> 8) & 0xff;
741 lance_zerobuf_gap2(struct lance_softc *sc, int boff, int len)
743 volatile caddr_t buf = sc->sc_mem;
744 volatile uint16_t *bptr;
746 if ((unsigned)boff & 0x1) {
747 bptr = ((volatile uint16_t *)buf) + (boff - 1);
752 bptr = ((volatile uint16_t *)buf) + boff;
761 * gap16: 16 bytes of data followed by 16 bytes of pad.
763 * Buffers must be 32-byte aligned.
767 lance_copytobuf_gap16(struct lance_softc *sc, void *fromv, int boff, int len)
769 volatile caddr_t buf = sc->sc_mem;
770 caddr_t bptr, from = fromv;
773 bptr = buf + ((boff << 1) & ~0x1f);
775 xfer = min(len, 16 - boff);
777 memcpy(bptr + boff, from, xfer);
787 lance_copyfrombuf_gap16(struct lance_softc *sc, void *tov, int boff, int len)
789 volatile caddr_t buf = sc->sc_mem;
790 caddr_t bptr, to = tov;
793 bptr = buf + ((boff << 1) & ~0x1f);
795 xfer = min(len, 16 - boff);
797 memcpy(to, bptr + boff, xfer);
807 lance_zerobuf_gap16(struct lance_softc *sc, int boff, int len)
809 volatile caddr_t buf = sc->sc_mem;
813 bptr = buf + ((boff << 1) & ~0x1f);
815 xfer = min(len, 16 - boff);
817 memset(bptr + boff, 0, xfer);
824 #endif /* Example only */