1 /* $NetBSD: smc90cx6.c,v 1.38 2001/07/07 15:57:53 thorpej Exp $ */
7 * Copyright (c) 1994, 1995, 1998 The NetBSD Foundation, Inc.
10 * This code is derived from software contributed to The NetBSD Foundation
11 * by Ignatios Souvatzis.
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.
21 * 3. All advertising materials mentioning features or use of this software
22 * must display the following acknowledgement:
23 * This product includes software developed by the NetBSD
24 * Foundation, Inc. and its contributors.
25 * 4. Neither the name of The NetBSD Foundation nor the names of its
26 * contributors may be used to endorse or promote products derived
27 * from this software without specific prior written permission.
29 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
30 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
31 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
32 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
33 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
34 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
35 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
36 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
37 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
39 * POSSIBILITY OF SUCH DAMAGE.
43 * Chip core driver for the SMC90c26 / SMC90c56 (and SMC90c66 in '56
44 * compatibility mode) boards
47 /* #define CMSOFTCOPY */
48 #define CMRETRANSMIT /**/
49 /* #define CM_DEBUG */
51 #include <sys/param.h>
52 #include <sys/systm.h>
53 #include <sys/sockio.h>
55 #include <sys/module.h>
56 #include <sys/kernel.h>
57 #include <sys/socket.h>
58 #include <sys/syslog.h>
61 #include <machine/bus.h>
63 #include <machine/resource.h>
65 #if __FreeBSD_version < 500000
66 #include <machine/clock.h>
70 #include <net/if_dl.h>
71 #include <net/if_types.h>
72 #include <net/if_arc.h>
74 #include <dev/cm/smc90cx6reg.h>
75 #include <dev/cm/smc90cx6var.h>
77 MODULE_DEPEND(if_cm, arcnet, 1, 1, 1);
79 /* these should be elsewhere */
82 #define ARC_MIN_FORBID_LEN 254
83 #define ARC_MAX_FORBID_LEN 256
84 #define ARC_MAX_LEN 508
85 #define ARC_ADDR_LEN 1
87 /* for watchdog timer. This should be more than enough. */
88 #define ARCTIMEOUT (5*IFNET_SLOWHZ)
93 bus_space_read_1(rman_get_bustag((sc)->port_res), \
94 rman_get_bushandle((sc)->port_res), \
96 #define PUTREG(off, value) \
97 bus_space_write_1(rman_get_bustag((sc)->port_res), \
98 rman_get_bushandle((sc)->port_res), \
100 #define GETMEM(off) \
101 bus_space_read_1(rman_get_bustag((sc)->mem_res), \
102 rman_get_bushandle((sc)->mem_res), \
104 #define PUTMEM(off, value) \
105 bus_space_write_1(rman_get_bustag((sc)->mem_res), \
106 rman_get_bushandle((sc)->mem_res), \
109 devclass_t cm_devclass;
112 * This currently uses 2 bufs for tx, 2 for rx
116 * rx has a fillcount variable. If fillcount > (NRXBUF-1),
117 * rx can be switched off from rx hard int.
118 * Else rx is restarted on the other receiver.
119 * rx soft int counts down. if it is == (NRXBUF-1), it restarts
121 * To ensure packet ordering (we need that for 1201 later), we have a counter
122 * which is incremented modulo 256 on each receive and a per buffer
123 * variable, which is set to the counter on filling. The soft int can
124 * compare both values to determine the older packet.
126 * Transmit direction:
128 * cm_start checks tx_fillcount
131 * else fill tx_act ^ 1 && inc tx_fillcount
133 * check tx_fillcount again.
134 * case 2: set IFF_DRV_OACTIVE to stop arc_output from filling us.
137 * tint clears IFF_OCATIVE, decrements and checks tx_fillcount
138 * case 1: start tx on tx_act ^ 1, softcall cm_start
139 * case 0: softcall cm_start
141 * #define fill(i) get mbuf && copy mbuf to chip(i)
144 void cm_init(void *);
145 void cm_reset(struct cm_softc *);
146 void cm_start(struct ifnet *);
147 int cm_ioctl(struct ifnet *, unsigned long, caddr_t);
148 void cm_watchdog(struct ifnet *);
149 void cm_srint(void *vsc);
150 static void cm_tint(struct cm_softc *, int);
151 void cm_reconwatch(void *);
158 struct cm_softc *sc = device_get_softc(dev);
160 error = cm_alloc_port(dev, 0, CM_IO_PORTS);
164 if (GETREG(CMSTAT) == 0xff)
167 error = cm_alloc_memory(dev, 0, 0x800);
175 * Allocate a port resource with the given resource id.
178 cm_alloc_port(dev, rid, size)
183 struct cm_softc *sc = device_get_softc(dev);
184 struct resource *res;
186 res = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid,
187 0ul, ~0ul, size, RF_ACTIVE);
191 sc->port_used = size;
199 * Allocate a memory resource with the given resource id.
202 cm_alloc_memory(dev, rid, size)
207 struct cm_softc *sc = device_get_softc(dev);
208 struct resource *res;
210 res = bus_alloc_resource(dev, SYS_RES_MEMORY, &rid,
211 0ul, ~0ul, size, RF_ACTIVE);
223 * Allocate an irq resource with the given resource id.
226 cm_alloc_irq(dev, rid)
230 struct cm_softc *sc = device_get_softc(dev);
231 struct resource *res;
233 res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
244 * Release all resources
247 cm_release_resources(dev)
250 struct cm_softc *sc = device_get_softc(dev);
253 bus_deactivate_resource(dev, SYS_RES_IOPORT,
254 sc->port_rid, sc->port_res);
255 bus_release_resource(dev, SYS_RES_IOPORT,
256 sc->port_rid, sc->port_res);
260 bus_deactivate_resource(dev, SYS_RES_MEMORY,
261 sc->mem_rid, sc->mem_res);
262 bus_release_resource(dev, SYS_RES_MEMORY,
263 sc->mem_rid, sc->mem_res);
267 bus_deactivate_resource(dev, SYS_RES_IRQ,
268 sc->irq_rid, sc->irq_res);
269 bus_release_resource(dev, SYS_RES_IRQ,
270 sc->irq_rid, sc->irq_res);
279 struct cm_softc *sc = device_get_softc(dev);
282 u_int8_t linkaddress;
284 ifp = sc->sc_ifp = if_alloc(IFT_ARCNET);
292 * read the arcnet address from the board
298 } while (!(GETREG(CMSTAT) & CM_POR));
300 linkaddress = GETMEM(CMMACOFF);
302 /* clear the int mask... */
307 PUTREG(CMCMD, CM_CONF(CONF_LONG));
308 PUTREG(CMCMD, CM_CLR(CLR_POR|CLR_RECONFIG));
309 sc->sc_recontime = sc->sc_reconcount = 0;
311 /* and reenable kernel int level */
315 * set interface to stopped condition (reset)
320 if_initname(ifp, device_get_name(dev), device_get_unit(dev));
321 ifp->if_output = arc_output;
322 ifp->if_start = cm_start;
323 ifp->if_ioctl = cm_ioctl;
324 ifp->if_watchdog = cm_watchdog;
325 ifp->if_init = cm_init;
326 /* XXX IFQ_SET_READY(&ifp->if_snd); */
327 ifp->if_snd.ifq_maxlen = IFQ_MAXLEN;
329 ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_NEEDSGIANT;
331 arc_ifattach(ifp, linkaddress);
334 sc->sc_rxcookie = softintr_establish(IPL_SOFTNET, cm_srint, sc);
335 sc->sc_txcookie = softintr_establish(IPL_SOFTNET,
336 (void (*)(void *))cm_start, ifp);
339 #if __FreeBSD_version < 500000
340 callout_init(&sc->sc_recon_ch);
342 callout_init(&sc->sc_recon_ch, 0);
345 if_printf(ifp, "link addr 0x%02x (%d)\n", linkaddress, linkaddress);
357 struct cm_softc *sc = (struct cm_softc *)xsc;
363 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0) {
365 ifp->if_drv_flags |= IFF_DRV_RUNNING;
373 * Reset the interface...
375 * this assumes that it is called inside a critical section...
388 if_printf(ifp, "reset\n");
390 /* stop and restart hardware */
395 } while (!(GETREG(CMSTAT) & CM_POR));
397 linkaddress = GETMEM(CMMACOFF);
399 #if defined(CM_DEBUG) && (CM_DEBUG > 2)
400 if_printf(ifp, "reset: card reset, link addr = 0x%02x (%d)\n",
401 linkaddress, linkaddress);
404 /* tell the routing level about the (possibly changed) link address */
405 arc_storelladdr(ifp, linkaddress);
408 /* POR is NMI, but we need it below: */
409 sc->sc_intmask = CM_RECON|CM_POR;
410 PUTREG(CMSTAT, sc->sc_intmask);
411 PUTREG(CMCMD, CM_CONF(CONF_LONG));
414 if_printf(ifp, "reset: chip configured, status=0x%02x\n",
417 PUTREG(CMCMD, CM_CLR(CLR_POR|CLR_RECONFIG));
420 if_printf(ifp, "reset: bits cleared, status=0x%02x\n",
424 sc->sc_reconcount_excessive = ARC_EXCESSIVE_RECONS;
428 sc->sc_intmask |= CM_RI;
429 sc->sc_rx_fillcount = 0;
432 PUTREG(CMCMD, CM_RXBC(2));
433 PUTREG(CMSTAT, sc->sc_intmask);
436 if_printf(ifp, "reset: started receiver, status=0x%02x\n",
440 /* and init transmitter status */
442 sc->sc_tx_fillcount = 0;
444 ifp->if_drv_flags |= IFF_DRV_RUNNING;
445 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
451 * Take interface offline
457 /* Stop the interrupts */
460 /* Stop the interface */
463 /* Stop watchdog timer */
464 sc->sc_ifp->if_timer = 0;
468 * Start output on interface. Get another datagram to send
469 * off the interface queue, and copy it to the
470 * interface becore starting the output
472 * this assumes that it is called inside a critical section...
473 * XXX hm... does it still?
480 struct cm_softc *sc = ifp->if_softc;
484 int len, tlen, offset, s, buffer;
486 u_long copystart, lencopy, perbyte;
489 #if defined(CM_DEBUG) && (CM_DEBUG > 3)
490 if_printf(ifp, "start(%p)\n", ifp);
493 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0)
498 if (sc->sc_tx_fillcount >= 2) {
503 m = arc_frag_next(ifp);
504 buffer = sc->sc_tx_act ^ 1;
512 if (m->m_len < ARC_HDRLEN)
513 m = m_pullup(m, ARC_HDRLEN);/* gcc does structure padding */
514 if_printf(ifp, "start: filling %d from %d to %d type %d\n",
515 buffer, mtod(m, u_char *)[0],
516 mtod(m, u_char *)[1], mtod(m, u_char *)[2]);
521 cm_ram_ptr = buffer * 512;
526 /* write the addresses to RAM and throw them away */
529 * Hardware does this: Yet Another Microsecond Saved.
530 * (btw, timing code says usually 2 microseconds)
531 * PUTMEM(cm_ram_ptr + 0, mtod(m, u_char *)[0]);
534 PUTMEM(cm_ram_ptr + 1, mtod(m, u_char *)[1]);
537 /* get total length left at this point */
538 tlen = m->m_pkthdr.len;
539 if (tlen < ARC_MIN_FORBID_LEN) {
541 PUTMEM(cm_ram_ptr + 2, offset);
543 PUTMEM(cm_ram_ptr + 2, 0);
544 if (tlen <= ARC_MAX_FORBID_LEN)
545 offset = 255; /* !!! */
547 if (tlen > ARC_MAX_LEN)
551 PUTMEM(cm_ram_ptr + 3, offset);
554 cm_ram_ptr += offset;
556 /* lets loop through the mbuf chain */
558 for (mp = m; mp; mp = mp->m_next) {
559 if ((len = mp->m_len)) { /* YAMS */
560 bus_space_write_region_1(
561 rman_get_bustag(sc->mem_res),
562 rman_get_bushandle(sc->mem_res),
563 cm_ram_ptr, mtod(mp, caddr_t), len);
569 sc->sc_broadcast[buffer] = (m->m_flags & M_BCAST) != 0;
570 sc->sc_retransmits[buffer] = (m->m_flags & M_BCAST) ? 1 : 5;
572 /* actually transmit the packet */
575 if (++sc->sc_tx_fillcount > 1) {
577 * We are filled up to the rim. No more bufs for the moment,
580 ifp->if_drv_flags |= IFF_DRV_OACTIVE;
583 if_printf(ifp, "start: starting transmitter on buffer %d\n",
586 /* Transmitter was off, start it */
587 sc->sc_tx_act = buffer;
590 * We still can accept another buf, so don't:
591 * ifp->if_drv_flags |= IFF_DRV_OACTIVE;
593 sc->sc_intmask |= CM_TA;
594 PUTREG(CMCMD, CM_TX(buffer));
595 PUTREG(CMSTAT, sc->sc_intmask);
597 ifp->if_timer = ARCTIMEOUT;
603 * After 10 times reading the docs, I realized
604 * that in the case the receiver NAKs the buffer request,
605 * the hardware retries till shutdown.
606 * This is integrated now in the code above.
613 * Arcnet interface receiver soft interrupt:
614 * get the stuff out of any filled buffer we find.
620 struct cm_softc *sc = (struct cm_softc *)vsc;
621 int buffer, len, offset, s, type;
624 struct arc_header *ah;
630 buffer = sc->sc_rx_act ^ 1;
633 /* Allocate header mbuf */
634 MGETHDR(m, M_DONTWAIT, MT_DATA);
638 * in case s.th. goes wrong with mem, drop it
639 * to make sure the receiver can be started again
640 * count it as input error (we dont have any other
647 m->m_pkthdr.rcvif = ifp;
650 * Align so that IP packet will be longword aligned. Here we
651 * assume that m_data of new packet is longword aligned.
652 * When implementing PHDS, we might have to change it to 2,
653 * (2*sizeof(ulong) - CM_HDRNEWLEN)), packet type dependent.
656 cm_ram_ptr = buffer * 512;
657 offset = GETMEM(cm_ram_ptr + 2);
661 offset = GETMEM(cm_ram_ptr + 3);
666 * first +2 bytes for align fixup below
667 * second +2 bytes are for src/dst addresses
669 if ((len + 2 + 2) > MHLEN) {
670 /* attach an mbuf cluster */
671 MCLGET(m, M_DONTWAIT);
673 /* Insist on getting a cluster */
674 if ((m->m_flags & M_EXT) == 0) {
685 type = GETMEM(cm_ram_ptr + offset);
686 m->m_data += 1 + arc_isphds(type);
687 /* mbuf filled with ARCnet addresses */
688 m->m_pkthdr.len = m->m_len = len + 2;
690 ah = mtod(m, struct arc_header *);
691 ah->arc_shost = GETMEM(cm_ram_ptr + 0);
692 ah->arc_dhost = GETMEM(cm_ram_ptr + 1);
694 bus_space_read_region_1(
695 rman_get_bustag(sc->mem_res), rman_get_bushandle(sc->mem_res),
696 cm_ram_ptr + offset, mtod(m, u_char *) + 2, len);
708 /* mark buffer as invalid by source id 0 */
709 PUTMEM(buffer << 9, 0);
712 if (--sc->sc_rx_fillcount == 2 - 1) {
714 /* was off, restart it on buffer just emptied */
715 sc->sc_rx_act = buffer;
716 sc->sc_intmask |= CM_RI;
718 /* this also clears the RI flag interupt: */
719 PUTREG(CMCMD, CM_RXBC(buffer));
720 PUTREG(CMSTAT, sc->sc_intmask);
723 if_printf(ifp, "srint: restarted rx on buf %d\n", buffer);
742 buffer = sc->sc_tx_act;
746 * Normal situtations first for fast path:
747 * If acknowledgement received ok or broadcast, we're ok.
751 if (isr & CM_TMA || sc->sc_broadcast[buffer])
754 else if (ifp->if_flags & IFF_LINK2 && ifp->if_timer > 0
755 && --sc->sc_retransmits[buffer] > 0) {
756 /* retransmit same buffer */
757 PUTREG(CMCMD, CM_TX(buffer));
765 /* We know we can accept another buffer at this point. */
766 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
768 if (--sc->sc_tx_fillcount > 0) {
771 * start tx on other buffer.
772 * This also clears the int flag
775 sc->sc_tx_act = buffer;
779 * sc->sc_intmask |= CM_TA;
780 * PUTREG(CMSTAT, sc->sc_intmask);
782 PUTREG(CMCMD, CM_TX(buffer));
783 /* init watchdog timer */
784 ifp->if_timer = ARCTIMEOUT;
786 #if defined(CM_DEBUG) && (CM_DEBUG > 1)
788 "tint: starting tx on buffer %d, status 0x%02x\n",
789 buffer, GETREG(CMSTAT));
792 /* have to disable TX interrupt */
793 sc->sc_intmask &= ~CM_TA;
794 PUTREG(CMSTAT, sc->sc_intmask);
795 /* ... and watchdog timer */
799 if_printf(ifp, "tint: no more buffers to send, status 0x%02x\n",
806 /* schedule soft int to fill a new buffer for us */
807 softintr_schedule(sc->sc_txcookie);
809 /* call it directly */
815 * Our interrupt routine
821 struct cm_softc *sc = arg;
822 struct ifnet *ifp = sc->sc_ifp;
824 u_char isr, maskedisr;
828 isr = GETREG(CMSTAT);
829 maskedisr = isr & sc->sc_intmask;
834 #if defined(CM_DEBUG) && (CM_DEBUG > 1)
835 if_printf(ifp, "intr: status 0x%02x, intmask 0x%02x\n",
836 isr, sc->sc_intmask);
839 if (maskedisr & CM_POR) {
841 * XXX We should never see this. Don't bother to store
843 * sc->sc_ifp->if_l2com->ac_anaddr = GETMEM(CMMACOFF);
845 PUTREG(CMCMD, CM_CLR(CLR_POR));
847 "%s: intr: got spurious power on reset int\n",
851 if (maskedisr & CM_RECON) {
854 * PUTREG(CMCMD, CM_CONF(CONF_LONG));
856 PUTREG(CMCMD, CM_CLR(CLR_RECONFIG));
857 ifp->if_collisions++;
860 * If less than 2 seconds per reconfig:
861 * If ARC_EXCESSIVE_RECONFIGS
862 * since last burst, complain and set treshold for
863 * warnings to ARC_EXCESSIVE_RECONS_REWARN.
865 * This allows for, e.g., new stations on the cable, or
866 * cable switching as long as it is over after
867 * (normally) 16 seconds.
869 * XXX TODO: check timeout bits in status word and
870 * double time if necessary.
873 callout_stop(&sc->sc_recon_ch);
874 newsec = time_second;
875 if ((newsec - sc->sc_recontime <= 2) &&
876 (++sc->sc_reconcount == ARC_EXCESSIVE_RECONS)) {
878 "%s: excessive token losses, "
882 sc->sc_recontime = newsec;
883 callout_reset(&sc->sc_recon_ch, 15 * hz,
884 cm_reconwatch, (void *)sc);
887 if (maskedisr & CM_RI) {
888 #if defined(CM_DEBUG) && (CM_DEBUG > 1)
889 if_printf(ifp, "intr: hard rint, act %d\n",
893 buffer = sc->sc_rx_act;
894 /* look if buffer is marked invalid: */
895 if (GETMEM(buffer * 512) == 0) {
897 * invalid marked buffer (or illegally
901 "%s: spurious RX interupt or sender 0 "
902 " (ignored)\n", ifp->if_xname);
904 * restart receiver on same buffer.
905 * XXX maybe better reset interface?
907 PUTREG(CMCMD, CM_RXBC(buffer));
909 if (++sc->sc_rx_fillcount > 1) {
910 sc->sc_intmask &= ~CM_RI;
911 PUTREG(CMSTAT, sc->sc_intmask);
914 sc->sc_rx_act = buffer;
917 * Start receiver on other receive
918 * buffer. This also clears the RI
921 PUTREG(CMCMD, CM_RXBC(buffer));
922 /* in RX intr, so mask is ok for RX */
925 if_printf(ifp, "strt rx for buf %d, "
927 sc->sc_rx_act, GETREG(CMSTAT));
933 * this one starts a soft int to copy out
936 softintr_schedule(sc->sc_rxcookie);
938 /* this one does the copy here */
943 if (maskedisr & CM_TA) {
946 isr = GETREG(CMSTAT);
947 maskedisr = isr & sc->sc_intmask;
949 #if defined(CM_DEBUG) && (CM_DEBUG > 1)
950 if_printf(ifp, "intr (exit): status 0x%02x, intmask 0x%02x\n",
951 isr, sc->sc_intmask);
959 struct cm_softc *sc = arg;
960 struct ifnet *ifp = sc->sc_ifp;
962 if (sc->sc_reconcount >= ARC_EXCESSIVE_RECONS) {
963 sc->sc_reconcount = 0;
964 log(LOG_WARNING, "%s: token valid again.\n",
967 sc->sc_reconcount = 0;
972 * Process an ioctl request.
973 * This code needs some work - it looks pretty ugly.
976 cm_ioctl(ifp, command, data)
988 ifa = (struct ifaddr *)data;
989 ifr = (struct ifreq *)data;
992 #if defined(CM_DEBUG) && (CM_DEBUG > 2)
993 if_printf(ifp, "ioctl() called, cmd = 0x%lx\n", command);
1002 error = arc_ioctl(ifp, command, data);
1006 if ((ifp->if_flags & IFF_UP) == 0 &&
1007 (ifp->if_drv_flags & IFF_DRV_RUNNING) != 0) {
1009 * If interface is marked down and it is running,
1013 ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
1014 } else if ((ifp->if_flags & IFF_UP) != 0 &&
1015 (ifp->if_drv_flags & IFF_DRV_RUNNING) == 0) {
1017 * If interface is marked up and it is stopped, then
1034 * watchdog routine for transmitter.
1036 * We need this, because else a receiver whose hardware is alive, but whose
1037 * software has not enabled the Receiver, would make our hardware wait forever
1038 * Discovered this after 20 times reading the docs.
1040 * Only thing we do is disable transmitter. We'll get a transmit timeout,
1041 * and the int handler will have to decide not to retransmit (in case
1042 * retransmission is implemented).
1044 * This one assumes being called inside splimp()
1051 struct cm_softc *sc = ifp->if_softc;
1053 PUTREG(CMCMD, CM_TXDIS);