2 * Copyright (c) 1998, 1999 Scott Mitchell
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * $Id: if_xe.c,v 1.20 1999/06/13 19:17:40 scott Exp $
27 * $FreeBSD: src/sys/dev/xe/if_xe.c,v 1.13.2.6 2003/02/05 22:03:57 mbr Exp $
28 * $DragonFly: src/sys/dev/netif/xe/if_xe.c,v 1.13 2004/07/23 07:16:30 joerg Exp $
34 * I've pushed this fairly far, but there are some things that need to be
35 * done here. I'm documenting them here in case I get destracted. -- imp
37 * xe_cem56fix -- need to figure out how to map the extra stuff.
41 * Portions of this software were derived from Werner Koch's xirc2ps driver
42 * for Linux under the terms of the following license (from v1.30 of the
45 * Copyright (c) 1997 by Werner Koch (dd9jn)
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, and the entire permission notice in its entirety,
52 * including the disclaimer of warranties.
53 * 2. Redistributions in binary form must reproduce the above copyright
54 * notice, this list of conditions and the following disclaimer in the
55 * documentation and/or other materials provided with the distribution.
56 * 3. The name of the author may not be used to endorse or promote
57 * products derived from this software without specific prior
60 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
61 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
62 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
63 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
64 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
65 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
66 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
67 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
68 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
69 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
70 * OF THE POSSIBILITY OF SUCH DAMAGE.
74 * FreeBSD device driver for Xircom CreditCard PCMCIA Ethernet adapters. The
75 * following cards are currently known to work with the driver:
76 * Xircom CreditCard 10/100 (CE3)
77 * Xircom CreditCard Ethernet + Modem 28 (CEM28)
78 * Xircom CreditCard Ethernet 10/100 + Modem 56 (CEM56)
79 * Xircom RealPort Ethernet 10
80 * Xircom RealPort Ethernet 10/100
81 * Xircom RealPort Ethernet 10/100 + Modem 56 (REM56, REM56G)
82 * Intel EtherExpress Pro/100 PC Card Mobile Adapter 16 (Pro/100 M16A)
83 * Compaq Netelligent 10/100 PC Card (CPQ-10/100)
85 * Some other cards *should* work, but support for them is either broken or in
86 * an unknown state at the moment. I'm always interested in hearing from
87 * people who own any of these cards:
88 * Xircom CreditCard 10Base-T (PS-CE2-10)
89 * Xircom CreditCard Ethernet + ModemII (CEM2)
90 * Xircom CEM28 and CEM33 Ethernet/Modem cards (may be variants of CEM2?)
92 * Thanks to all who assisted with the development and testing of the driver,
93 * especially: Werner Koch, Duke Kamstra, Duncan Barclay, Jason George, Dru
94 * Nelson, Mike Kephart, Bill Rainey and Douglas Rand. Apologies if I've left
95 * out anyone who deserves a mention here.
97 * Special thanks to Ade Lovett for both hosting the mailing list and doing
98 * the CEM56/REM56 support code; and the FreeBSD UK Users' Group for hosting
103 * Driver web page: http://ukug.uk.freebsd.org/~scott/xe_drv/
105 * Mailing list: http://www.lovett.com/lists/freebsd-xircom/
106 * or send "subscribe freebsd-xircom" to <majordomo@lovett.com>
108 * Author email: <scott@uk.freebsd.org>
112 #include <sys/param.h>
113 #include <sys/cdefs.h>
114 #include <sys/errno.h>
115 #include <sys/kernel.h>
116 #include <sys/mbuf.h>
117 #include <sys/select.h>
118 #include <sys/socket.h>
119 #include <sys/sockio.h>
120 #include <sys/systm.h>
123 #include <sys/module.h>
126 #include <machine/bus.h>
127 #include <machine/resource.h>
128 #include <sys/rman.h>
130 #include <net/ethernet.h>
132 #include <net/if_arp.h>
133 #include <net/if_dl.h>
134 #include <net/if_media.h>
135 #include <net/if_mib.h>
138 #include <bus/pccard/pccardvar.h>
141 #include "if_xereg.h"
142 #include "if_xevar.h"
144 #include <machine/clock.h>
147 * MII command structure
149 struct xe_mii_frame {
150 u_int8_t mii_stdelim;
152 u_int8_t mii_phyaddr;
153 u_int8_t mii_regaddr;
154 u_int8_t mii_turnaround;
159 * Media autonegotiation progress constants
161 #define XE_AUTONEG_NONE 0 /* No autonegotiation in progress */
162 #define XE_AUTONEG_WAITING 1 /* Waiting for transmitter to go idle */
163 #define XE_AUTONEG_STARTED 2 /* Waiting for autonegotiation to complete */
164 #define XE_AUTONEG_100TX 3 /* Trying to force 100baseTX link */
165 #define XE_AUTONEG_FAIL 4 /* Autonegotiation failed */
169 * Prototypes start here
171 static int xe_probe (device_t dev);
172 static int xe_attach (device_t dev);
173 static int xe_detach (device_t dev);
174 static int xe_activate (device_t dev);
175 static void xe_deactivate (device_t dev);
176 static void xe_init (void *xscp);
177 static void xe_start (struct ifnet *ifp);
178 static int xe_ioctl (struct ifnet *ifp, u_long command, caddr_t data, struct ucred *);
179 static void xe_watchdog (struct ifnet *ifp);
180 static int xe_media_change (struct ifnet *ifp);
181 static void xe_media_status (struct ifnet *ifp, struct ifmediareq *mrp);
182 static timeout_t xe_setmedia;
183 static void xe_hard_reset (struct xe_softc *scp);
184 static void xe_soft_reset (struct xe_softc *scp);
185 static void xe_stop (struct xe_softc *scp);
186 static void xe_enable_intr (struct xe_softc *scp);
187 static void xe_disable_intr (struct xe_softc *scp);
188 static void xe_setmulti (struct xe_softc *scp);
189 static void xe_setaddrs (struct xe_softc *scp);
190 static int xe_pio_write_packet (struct xe_softc *scp, struct mbuf *mbp);
192 static u_int32_t xe_compute_crc (u_int8_t *data, int len);
193 static int xe_compute_hashbit (u_int32_t crc);
199 static void xe_mii_sync (struct xe_softc *scp);
200 static int xe_mii_init (struct xe_softc *scp);
201 static void xe_mii_send (struct xe_softc *scp, u_int32_t bits, int cnt);
202 static int xe_mii_readreg (struct xe_softc *scp, struct xe_mii_frame *frame);
203 static int xe_mii_writereg (struct xe_softc *scp, struct xe_mii_frame *frame);
204 static u_int16_t xe_phy_readreg (struct xe_softc *scp, u_int16_t reg);
205 static void xe_phy_writereg (struct xe_softc *scp, u_int16_t reg, u_int16_t data);
208 * Debug functions -- uncomment for VERY verbose dignostic information.
209 * Set to 1 for less verbose information
211 /* #define XE_DEBUG 2 */
213 #define XE_REG_DUMP(scp) xe_reg_dump((scp))
214 #define XE_MII_DUMP(scp) xe_mii_dump((scp))
215 static void xe_reg_dump (struct xe_softc *scp);
216 static void xe_mii_dump (struct xe_softc *scp);
218 #define XE_REG_DUMP(scp)
219 #define XE_MII_DUMP(scp)
223 * Fixing for RealPort cards - they need a little furtling to get the
227 xe_cem56fix(device_t dev)
229 struct xe_softc *sc = (struct xe_softc *) device_get_softc(dev);
231 bus_space_handle_t bsh;
237 device_printf(dev, "Hacking your Realport, master\n");
241 device_printf(dev, "Realport port 0x%0lx, size 0x%0lx\n",
242 bus_get_resource_start(dev, SYS_RES_IOPORT, sc->port_rid),
243 bus_get_resource_count(dev, SYS_RES_IOPORT, sc->port_rid));
247 r = bus_alloc_resource(dev, SYS_RES_MEMORY, &rid, 0, ~0, 4 << 10, RF_ACTIVE);
250 device_printf(dev, "Can't map in attribute memory\n");
255 bsh = rman_get_bushandle(r);
256 bst = rman_get_bustag(r);
258 CARD_SET_RES_FLAGS(device_get_parent(dev), dev, SYS_RES_MEMORY, rid,
261 bus_space_write_1(bst, bsh, DINGO_ECOR, DINGO_ECOR_IRQ_LEVEL |
262 DINGO_ECOR_INT_ENABLE |
263 DINGO_ECOR_IOB_ENABLE |
264 DINGO_ECOR_ETH_ENABLE);
265 ioport = bus_get_resource_start(dev, SYS_RES_IOPORT, sc->port_rid);
266 bus_space_write_1(bst, bsh, DINGO_EBAR0, ioport & 0xff);
267 bus_space_write_1(bst, bsh, DINGO_EBAR1, (ioport >> 8) & 0xff);
269 bus_space_write_1(bst, bsh, DINGO_DCOR0, DINGO_DCOR0_SF_INT);
270 bus_space_write_1(bst, bsh, DINGO_DCOR1, DINGO_DCOR1_INT_LEVEL |
272 bus_space_write_1(bst, bsh, DINGO_DCOR2, 0x00);
273 bus_space_write_1(bst, bsh, DINGO_DCOR3, 0x00);
274 bus_space_write_1(bst, bsh, DINGO_DCOR4, 0x00);
276 bus_release_resource(dev, SYS_RES_MEMORY, rid, r);
283 * PCMCIA probe routine.
284 * Probe and identify the device. Called by the slot manager when the card is
285 * inserted or the machine wakes up from suspend mode. Assmes that the slot
286 * structure has been initialised already.
289 xe_probe(device_t dev)
291 struct xe_softc *scp = (struct xe_softc *) device_get_softc(dev);
293 bus_space_handle_t bsh;
295 u_char ver_str[CISTPL_BUFSIZE>>1];
304 device_printf(dev, "xe: Probing\n");
309 r = bus_alloc_resource(dev, SYS_RES_MEMORY, &rid, 0, ~0, 4 << 10, RF_ACTIVE);
312 device_printf(dev, "Can't map in cis\n");
316 bsh = rman_get_bushandle(r);
317 bst = rman_get_bustag(r);
320 CARD_SET_RES_FLAGS(device_get_parent(dev), dev, SYS_RES_MEMORY, rid,
323 /* Grep through CIS looking for relevant tuples */
328 u_int8_t rev, media, prod;
330 switch (CISTPL_TYPE(buf)) {
332 case 0x15: /* Grab version string (needed to ID some weird CE2's) */
334 device_printf(dev, "Got version string (0x15)\n");
336 for (i = 0; i < CISTPL_LEN(buf); ver_str[i] = CISTPL_DATA(buf, i++));
338 ver_str[(CISTPL_BUFSIZE>>1) - 1] = CISTPL_LEN(buf);
342 case 0x20: /* Figure out what type of card we have */
344 device_printf(dev, "Got card ID (0x20)\n");
346 vendor = CISTPL_DATA(buf, 0) + (CISTPL_DATA(buf, 1) << 8);
347 rev = CISTPL_DATA(buf, 2);
348 media = CISTPL_DATA(buf, 3);
349 prod = CISTPL_DATA(buf, 4);
351 switch (vendor) { /* Get vendor ID */
353 scp->vendor = "Xircom"; break;
356 scp->vendor = "Compaq"; break;
358 scp->vendor = "Intel"; break;
360 scp->vendor = "Unknown";
363 if (!((prod & 0x40) && (media & 0x01))) {
365 device_printf(dev, "Not a PCMCIA Ethernet card!\n");
367 rc = ENODEV; /* Not a PCMCIA Ethernet device */
369 if (media & 0x10) { /* Ethernet/modem cards */
371 device_printf(dev, "Card is Ethernet/modem combo\n");
374 switch (prod & 0x0f) {
376 scp->card_type = "CEM"; break;
379 scp->card_type = "CEM2"; break;
382 scp->card_type = "CEM3"; break;
385 scp->card_type = "CEM33"; break;
388 scp->card_type = "CEM56M"; break;
390 case 7: /* Some kind of RealPort card */
393 scp->card_type = "CEM56"; break;
397 } else { /* Ethernet-only cards */
399 device_printf(dev, "Card is Ethernet only\n");
401 switch (prod & 0x0f) {
403 scp->card_type = "CE"; break;
406 scp->card_type = "CE2"; break;
409 scp->card_type = "CE3"; break;
418 case 0x22: /* Get MAC address */
419 if ((CISTPL_LEN(buf) == 8) &&
420 (CISTPL_DATA(buf, 0) == 0x04) &&
421 (CISTPL_DATA(buf, 1) == ETHER_ADDR_LEN)) {
423 device_printf(dev, "Got MAC address (0x22)\n");
425 for (i = 0; i < ETHER_ADDR_LEN; i++)
426 scp->arpcom.ac_enaddr[i] = CISTPL_DATA(buf, i+2);
434 if (CISTPL_TYPE(buf) == 0xff)
436 /* Skip to next tuple */
437 buf += ((CISTPL_LEN(buf) + 2) << 1);
442 bus_release_resource(dev, SYS_RES_MEMORY, rid, r);
447 /* Die now if something went wrong above */
451 /* Check for certain strange CE2's that look like CE's */
452 if (strcmp(scp->card_type, "CE") == 0) {
453 u_char *str = ver_str;
455 device_printf(dev, "Checking for weird CE2 string\n");
457 str += strlen(str) + 1; /* Skip forward to 3rd version string */
458 str += strlen(str) + 1;
459 str += strlen(str) + 1;
460 for (i = 0; i < strlen(str) - 2; i++) {
461 if (bcmp(&str[i], "CE2", 3) ==0) { /* Look for "CE2" string */
462 scp->card_type = "CE2";
467 /* Reject unsupported cards */
468 if (strcmp(scp->card_type, "CE") == 0 || strcmp(scp->card_type, "CEM") == 0) {
469 device_printf(dev, "Sorry, your %s card is not supported :(\n",
479 * The device entry is being removed, probably because someone ejected the
480 * card. The interface should have been brought down manually before calling
481 * this function; if not you may well lose packets. In any case, I shut down
482 * the card and the interface, and hope for the best.
485 xe_detach(device_t dev) {
486 struct xe_softc *sc = device_get_softc(dev);
488 sc->arpcom.ac_if.if_flags &= ~IFF_RUNNING;
489 ether_ifdetach(&sc->arpcom.ac_if);
498 xe_attach (device_t dev) {
499 struct xe_softc *scp = device_get_softc(dev);
503 device_printf(dev, "attach\n");
506 if ((err = xe_activate(dev)) != 0)
509 /* Fill in some private data */
510 scp->ifp = &scp->arpcom.ac_if;
511 scp->ifm = &scp->ifmedia;
512 scp->autoneg_status = 0;
514 /* Hack RealPorts into submission */
515 if (scp->dingo && xe_cem56fix(dev) < 0) {
516 device_printf(dev, "Unable to fix your RealPort\n");
521 /* Hopefully safe to read this here */
523 scp->version = XE_INB(XE_BOV);
526 /* Initialise the ifnet structure */
527 scp->ifp->if_softc = scp;
528 if_initname(scp->ifp, "xe", device_get_unit(dev));
529 scp->ifp->if_timer = 0;
530 scp->ifp->if_flags = (IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST);
531 scp->ifp->if_linkmib = &scp->mibdata;
532 scp->ifp->if_linkmiblen = sizeof scp->mibdata;
533 scp->ifp->if_start = xe_start;
534 scp->ifp->if_ioctl = xe_ioctl;
535 scp->ifp->if_watchdog = xe_watchdog;
536 scp->ifp->if_init = xe_init;
537 scp->ifp->if_snd.ifq_maxlen = IFQ_MAXLEN;
539 /* Initialise the ifmedia structure */
540 ifmedia_init(scp->ifm, 0, xe_media_change, xe_media_status);
541 callout_handle_init(&scp->chand);
544 * Fill in supported media types. Some cards _do_ support full duplex
545 * operation, but this driver doesn't, yet. Therefore we leave those modes
546 * out of the list. We support some form of autoselection in all cases.
549 ifmedia_add(scp->ifm, IFM_ETHER|IFM_100_TX, 0, NULL);
550 ifmedia_add(scp->ifm, IFM_ETHER|IFM_10_T, 0, NULL);
553 ifmedia_add(scp->ifm, IFM_ETHER|IFM_10_T, 0, NULL);
554 ifmedia_add(scp->ifm, IFM_ETHER|IFM_10_2, 0, NULL);
556 ifmedia_add(scp->ifm, IFM_ETHER|IFM_AUTO, 0, NULL);
558 /* Default is to autoselect best supported media type */
559 ifmedia_set(scp->ifm, IFM_ETHER|IFM_AUTO);
561 /* Print some useful information */
562 device_printf(dev, "%s %s, bonding version %#x%s%s\n",
566 scp->mohawk ? ", 100Mbps capable" : "",
567 scp->modem ? ", with modem" : "");
569 XE_SELECT_PAGE(0x10);
570 device_printf(dev, "DingoID = %#x, RevisionID = %#x, VendorID = %#x\n",
573 XE_INW(XE_VendorID));
576 XE_SELECT_PAGE(0x45);
577 device_printf(dev, "CE2 version = %#x\n", XE_INB(XE_REV));
580 /* Attach the interface */
581 ether_ifattach(scp->ifp, scp->arpcom.ac_enaddr);
589 * Initialize device. Completes the reset procedure on the card and starts
590 * output. If there's an autonegotiation in progress we DON'T do anything;
591 * the media selection code will call us again when it's done.
594 xe_init(void *xscp) {
595 struct xe_softc *scp = xscp;
599 device_printf(scp->dev, "init\n");
602 if (TAILQ_EMPTY(&scp->ifp->if_addrhead)) return;
604 /* Reset transmitter flags */
607 scp->tx_collisions = 0;
608 scp->ifp->if_timer = 0;
612 XE_SELECT_PAGE(0x42);
613 XE_OUTB(XE_SWC0, 0x20); /* Disable source insertion (WTF is that?) */
616 * Set the 'local memory dividing line' -- splits the 32K card memory into
617 * 8K for transmit buffers and 24K for receive. This is done automatically
618 * on newer revision cards.
620 if (scp->srev != 1) {
622 XE_OUTW(XE_RBS, 0x2000);
625 /* Set up multicast addresses */
628 /* Fix the data offset register -- reset leaves it off-by-one */
630 XE_OUTW(XE_DO, 0x2000);
633 * Set MAC interrupt masks and clear status regs. The bit names are direct
634 * from the Linux code; I have no idea what most of them do.
636 XE_SELECT_PAGE(0x40); /* Bit 7..0 */
637 XE_OUTB(XE_RX0Msk, 0xff); /* ROK, RAB, rsv, RO, CRC, AE, PTL, MP */
638 XE_OUTB(XE_TX0Msk, 0xff); /* TOK, TAB, SQE, LL, TU, JAB, EXC, CRS */
639 XE_OUTB(XE_TX0Msk+1, 0xb0); /* rsv, rsv, PTD, EXT, rsv, rsv, rsv, rsv */
640 XE_OUTB(XE_RST0, 0x00); /* ROK, RAB, REN, RO, CRC, AE, PTL, MP */
641 XE_OUTB(XE_TXST0, 0x00); /* TOK, TAB, SQE, LL, TU, JAB, EXC, CRS */
642 XE_OUTB(XE_TXST1, 0x00); /* TEN, rsv, PTD, EXT, retry_counter:4 */
645 * Check for an in-progress autonegotiation. If one is active, just set
646 * IFF_RUNNING and return. The media selection code will call us again when
649 if (scp->autoneg_status) {
650 scp->ifp->if_flags |= IFF_RUNNING;
653 /* Enable receiver, put MAC online */
654 XE_SELECT_PAGE(0x40);
655 XE_OUTB(XE_CMD0, XE_CMD0_RX_ENABLE|XE_CMD0_ONLINE);
657 /* Set up IMR, enable interrupts */
660 /* Attempt to start output */
661 scp->ifp->if_flags |= IFF_RUNNING;
662 scp->ifp->if_flags &= ~IFF_OACTIVE;
671 * Start output on interface. We make two assumptions here:
672 * 1) that the current priority is set to splimp _before_ this code
673 * is called *and* is returned to the appropriate priority after
675 * 2) that the IFF_OACTIVE flag is checked before this code is called
676 * (i.e. that the output part of the interface is idle)
679 xe_start(struct ifnet *ifp) {
680 struct xe_softc *scp = ifp->if_softc;
684 * Loop while there are packets to be sent, and space to send them.
687 IF_DEQUEUE(&ifp->if_snd, mbp); /* Suck a packet off the send queue */
691 * We are using the !OACTIVE flag to indicate to the outside world that
692 * we can accept an additional packet rather than that the transmitter
693 * is _actually_ active. Indeed, the transmitter may be active, but if
694 * we haven't filled all the buffers with data then we still want to
697 ifp->if_flags &= ~IFF_OACTIVE;
701 if (xe_pio_write_packet(scp, mbp) != 0) {
702 IF_PREPEND(&ifp->if_snd, mbp); /* Push the packet back onto the queue */
703 ifp->if_flags |= IFF_OACTIVE;
707 /* Tap off here if there is a bpf listener */
710 device_printf(scp->dev, "sending output packet to BPF\n");
715 ifp->if_timer = 5; /* In case we don't hear from the card again */
724 * Process an ioctl request. Adapted from the ed driver.
727 xe_ioctl (struct ifnet *ifp, u_long command, caddr_t data, struct ucred *cr) {
728 struct xe_softc *scp;
741 error = ether_ioctl(ifp, command, data);
746 * If the interface is marked up and stopped, then start it. If it is
747 * marked down and running, then stop it.
749 if (ifp->if_flags & IFF_UP) {
750 if (!(ifp->if_flags & IFF_RUNNING)) {
757 if (ifp->if_flags & IFF_RUNNING)
764 * Multicast list has (maybe) changed; set the hardware filter
765 * accordingly. This also serves to deal with promiscuous mode if we have
766 * a BPF listener active.
775 * Someone wants to get/set media options.
777 error = ifmedia_ioctl(ifp, (struct ifreq *)data, &scp->ifmedia, command);
791 * Card interrupt handler.
793 * This function is probably more complicated than it needs to be, as it
794 * attempts to deal with the case where multiple packets get sent between
795 * interrupts. This is especially annoying when working out the collision
796 * stats. Not sure whether this case ever really happens or not (maybe on a
797 * slow/heavily loaded machine?) so it's probably best to leave this like it
800 * Note that the crappy PIO used to get packets on and off the card means that
801 * you will spend a lot of time in this routine -- I can get my P150 to spend
802 * 90% of its time servicing interrupts if I really hammer the network. Could
803 * fix this, but then you'd start dropping/losing packets. The moral of this
804 * story? If you want good network performance _and_ some cycles left over to
805 * get your work done, don't buy a Xircom card. Or convince them to tell me
806 * how to do memory-mapped I/O :)
811 struct xe_softc *scp = (struct xe_softc *) xscp;
814 u_int16_t rx_bytes, rxs, txs;
815 u_int8_t psr, isr, esr, rsr;
817 ifp = &scp->arpcom.ac_if;
818 rx_bytes = 0; /* Bytes received on this interrupt */
819 result = 0; /* Set true if the interrupt is for us */
822 XE_OUTB(XE_CR, 0); /* Disable interrupts */
825 psr = XE_INB(XE_PR); /* Stash the current register page */
828 * Read ISR to see what caused this interrupt. Note that this clears the
829 * ISR on CE2 type cards.
831 if ((isr = XE_INB(XE_ISR)) && isr != 0xff) {
833 result = 1; /* This device did generate an int */
834 esr = XE_INB(XE_ESR); /* Read the other status registers */
835 XE_SELECT_PAGE(0x40);
836 rxs = XE_INB(XE_RST0);
837 XE_OUTB(XE_RST0, ~rxs & 0xff);
838 txs = XE_INB(XE_TXST0);
839 txs |= XE_INB(XE_TXST1) << 8;
840 XE_OUTB(XE_TXST0, 0);
841 XE_OUTB(XE_TXST1, 0);
845 printf("xe%d: ISR=%#2.2x ESR=%#2.2x RST=%#2.2x TXST=%#4.4x\n", unit, isr, esr, rxs, txs);
849 * Handle transmit interrupts
851 if (isr & XE_ISR_TX_PACKET) {
852 u_int8_t new_tpr, sent;
854 if ((new_tpr = XE_INB(XE_TPR)) < scp->tx_tpr) /* Update packet count */
855 sent = (0xff - scp->tx_tpr) + new_tpr; /* TPR rolled over */
857 sent = new_tpr - scp->tx_tpr;
859 if (sent > 0) { /* Packets sent since last interrupt */
860 scp->tx_tpr = new_tpr;
861 scp->tx_queued -= sent;
862 ifp->if_opackets += sent;
863 ifp->if_collisions += scp->tx_collisions;
866 * Collision stats are a PITA. If multiples frames have been sent, we
867 * distribute any outstanding collision count equally amongst them.
868 * However, if we're missing interrupts we're quite likely to also
869 * miss some collisions; thus the total count will be off anyway.
870 * Likewise, if we miss a frame dropped due to excessive collisions
871 * any outstanding collisions count will be held against the next
872 * frame to be successfully sent. Hopefully it averages out in the
874 * XXX - This will screw up if tx_collisions/sent > 14. FIX IT!
876 switch (scp->tx_collisions) {
880 scp->mibdata.dot3StatsSingleCollisionFrames++;
881 scp->mibdata.dot3StatsCollFrequencies[0]++;
885 scp->mibdata.dot3StatsMultipleCollisionFrames++;
886 scp->mibdata.dot3StatsCollFrequencies[scp->tx_collisions-1]++;
888 else { /* Distribute across multiple frames */
889 scp->mibdata.dot3StatsMultipleCollisionFrames += sent;
891 dot3StatsCollFrequencies[scp->tx_collisions/sent] += sent - scp->tx_collisions%sent;
893 dot3StatsCollFrequencies[scp->tx_collisions/sent + 1] += scp->tx_collisions%sent;
896 scp->tx_collisions = 0;
899 ifp->if_flags &= ~IFF_OACTIVE;
901 if (txs & 0x0002) { /* Excessive collisions (packet dropped) */
902 ifp->if_collisions += 16;
904 scp->tx_collisions = 0;
905 scp->mibdata.dot3StatsExcessiveCollisions++;
906 scp->mibdata.dot3StatsMultipleCollisionFrames++;
907 scp->mibdata.dot3StatsCollFrequencies[15]++;
908 XE_OUTB(XE_CR, XE_CR_RESTART_TX);
910 if (txs & 0x0040) /* Transmit aborted -- probably collisions */
911 scp->tx_collisions++;
915 * Handle receive interrupts
917 while ((esr = XE_INB(XE_ESR)) & XE_ESR_FULL_PACKET_RX) {
919 if ((rsr = XE_INB(XE_RSR)) & XE_RSR_RX_OK) {
920 struct ether_header *ehp;
924 len = XE_INW(XE_RBC);
931 * Limit the amount of time we spend in this loop, dropping packets if
932 * necessary. The Linux code does this with considerably more
933 * finesse, adjusting the threshold dynamically.
935 if ((rx_bytes += len) > 22000) {
937 scp->mibData.dot3StatsMissedFrames++;
938 XE_OUTW(XE_DO, 0x8000);
946 MGETHDR(mbp, MB_DONTWAIT, MT_DATA); /* Allocate a header mbuf */
948 mbp->m_pkthdr.rcvif = ifp;
949 mbp->m_pkthdr.len = mbp->m_len = len;
952 * If the mbuf header isn't big enough for the packet, attach an
953 * mbuf cluster to hold it. The +2 is to allow for the nasty little
954 * alignment hack below.
956 if (len + 2 > MHLEN) {
957 MCLGET(mbp, MB_DONTWAIT);
958 if ((mbp->m_flags & M_EXT) == 0) {
967 * The Ethernet header is 14 bytes long; thus the actual packet data
968 * won't be 32-bit aligned when it's dumped into the mbuf. We
969 * offset everything by 2 bytes to fix this. Apparently the
970 * alignment is important for NFS, damn its eyes.
973 ehp = mtod(mbp, struct ether_header *);
976 * Now get the packet, including the Ethernet header and trailer (?)
977 * We use programmed I/O, because we don't know how to do shared
978 * memory with these cards. So yes, it's real slow, and heavy on
979 * the interrupts (CPU on my P150 maxed out at ~950KBps incoming).
981 if (scp->srev == 0) { /* Workaround a bug in old cards */
985 rhs = XE_INW(XE_RHSA);
988 rhs += 3; /* Skip control info */
993 if (rhs + len > 0x8000) {
997 * XXX - This i-- seems very wrong, but it's what the Linux guys
998 * XXX - do. Need someone with an old CE2 to test this for me.
999 * XXX - 99/3/28: Changed the first i-- to an i++, maybe that'll
1000 * XXX - fix it? It seems as though the previous version would
1001 * XXX - have caused an infinite loop (what, another one?).
1003 for (i = 0; i < len; i++, rhs++) {
1004 ((char *)ehp)[i] = XE_INB(XE_EDP);
1005 if (rhs == 0x8000) {
1012 bus_space_read_multi_2(scp->bst, scp->bsh, XE_EDP,
1013 (u_int16_t *) ehp, len >> 1);
1016 bus_space_read_multi_2(scp->bst, scp->bsh, XE_EDP,
1017 (u_int16_t *) ehp, len >> 1);
1019 /* Deliver packet to upper layers */
1021 mbp->m_pkthdr.len = mbp->m_len = len;
1022 (*ifp->if_input)(ifp, mbp); /* Send the packet on its way */
1023 ifp->if_ipackets++; /* Success! */
1025 XE_OUTW(XE_DO, 0x8000); /* skip_rx_packet command */
1028 else if (rsr & XE_RSR_LONG_PACKET) { /* Packet length >1518 bytes */
1029 scp->mibdata.dot3StatsFrameTooLongs++;
1032 else if (rsr & XE_RSR_CRC_ERROR) { /* Bad checksum on packet */
1033 scp->mibdata.dot3StatsFCSErrors++;
1036 else if (rsr & XE_RSR_ALIGN_ERROR) { /* Packet alignment error */
1037 scp->mibdata.dot3StatsAlignmentErrors++;
1041 if (rxs & 0x10) { /* Receiver overrun */
1042 scp->mibdata.dot3StatsInternalMacReceiveErrors++;
1044 XE_OUTB(XE_CR, XE_CR_CLEAR_OVERRUN);
1048 XE_SELECT_PAGE(psr); /* Restore saved page */
1049 XE_OUTB(XE_CR, XE_CR_ENABLE_INTR); /* Re-enable interrupts */
1051 /* Could force an int here, instead of dropping packets? */
1052 /* XE_OUTB(XE_CR, XE_CR_ENABLE_INTR|XE_CE_FORCE_INTR); */
1059 * Device timeout/watchdog routine. Called automatically if we queue a packet
1060 * for transmission but don't get an interrupt within a specified timeout
1061 * (usually 5 seconds). When this happens we assume the worst and reset the
1065 xe_watchdog(struct ifnet *ifp) {
1066 struct xe_softc *scp = ifp->if_softc;
1068 device_printf(scp->dev, "watchdog timeout; resetting card\n");
1070 ifp->if_oerrors += scp->tx_queued;
1079 * Change media selection.
1082 xe_media_change(struct ifnet *ifp) {
1083 struct xe_softc *scp = ifp->if_softc;
1086 printf("%s: media_change\n", ifp->if_xname);
1089 if (IFM_TYPE(scp->ifm->ifm_media) != IFM_ETHER)
1093 * Some card/media combos aren't always possible -- filter those out here.
1095 if ((IFM_SUBTYPE(scp->ifm->ifm_media) == IFM_AUTO ||
1096 IFM_SUBTYPE(scp->ifm->ifm_media) == IFM_100_TX) && !scp->phy_ok)
1106 * Return current media selection.
1109 xe_media_status(struct ifnet *ifp, struct ifmediareq *mrp) {
1112 printf("%s: media_status\n", ifp->if_xname);
1115 mrp->ifm_active = ((struct xe_softc *)ifp->if_softc)->media;
1122 * Select active media.
1124 static void xe_setmedia(void *xscp) {
1125 struct xe_softc *scp = xscp;
1126 u_int16_t bmcr, bmsr, anar, lpar;
1129 device_printf(scp->dev, "setmedia\n");
1132 /* Cancel any pending timeout */
1133 untimeout(xe_setmedia, scp, scp->chand);
1134 xe_disable_intr(scp);
1137 scp->media = IFM_ETHER;
1138 switch (IFM_SUBTYPE(scp->ifm->ifm_media)) {
1140 case IFM_AUTO: /* Autoselect media */
1141 scp->media = IFM_ETHER|IFM_AUTO;
1144 * Autoselection is really awful. It goes something like this:
1146 * Wait until the transmitter goes idle (2sec timeout).
1148 * IF a 100Mbit PHY exists
1149 * Start NWAY autonegotiation (3.5sec timeout)
1151 * Select 100baseTX or 10baseT, whichever was detected
1154 * IF a 100Mbit PHY exists
1155 * Try to force a 100baseTX link (3sec timeout)
1164 * IF nothing selected so far
1165 * IF a 100Mbit PHY exists
1168 * Select 10baseT or 10base2, whichever is connected
1172 switch (scp->autoneg_status) {
1174 case XE_AUTONEG_NONE:
1176 device_printf(scp->dev, "Waiting for idle transmitter\n");
1178 scp->arpcom.ac_if.if_flags |= IFF_OACTIVE;
1179 scp->autoneg_status = XE_AUTONEG_WAITING;
1180 scp->chand = timeout(xe_setmedia, scp, hz * 2);
1183 case XE_AUTONEG_WAITING:
1187 device_printf(scp->dev, "Starting autonegotiation\n");
1189 bmcr = xe_phy_readreg(scp, PHY_BMCR);
1190 bmcr &= ~(PHY_BMCR_AUTONEGENBL);
1191 xe_phy_writereg(scp, PHY_BMCR, bmcr);
1192 anar = xe_phy_readreg(scp, PHY_ANAR);
1193 anar &= ~(PHY_ANAR_100BT4|PHY_ANAR_100BTXFULL|PHY_ANAR_10BTFULL);
1194 anar |= PHY_ANAR_100BTXHALF|PHY_ANAR_10BTHALF;
1195 xe_phy_writereg(scp, PHY_ANAR, anar);
1196 bmcr |= PHY_BMCR_AUTONEGENBL|PHY_BMCR_AUTONEGRSTR;
1197 xe_phy_writereg(scp, PHY_BMCR, bmcr);
1198 scp->autoneg_status = XE_AUTONEG_STARTED;
1199 scp->chand = timeout(xe_setmedia, scp, hz * 7/2);
1203 scp->autoneg_status = XE_AUTONEG_FAIL;
1207 case XE_AUTONEG_STARTED:
1208 bmsr = xe_phy_readreg(scp, PHY_BMSR);
1209 lpar = xe_phy_readreg(scp, PHY_LPAR);
1210 if (bmsr & (PHY_BMSR_AUTONEGCOMP|PHY_BMSR_LINKSTAT)) {
1212 device_printf(scp->dev, "Autonegotiation complete!\n");
1215 * XXX - Shouldn't have to do this, but (on my hub at least) the
1216 * XXX - transmitter won't work after a successful autoneg. So we see
1217 * XXX - what the negotiation result was and force that mode. I'm
1218 * XXX - sure there is an easy fix for this.
1220 if (lpar & PHY_LPAR_100BTXHALF) {
1221 xe_phy_writereg(scp, PHY_BMCR, PHY_BMCR_SPEEDSEL);
1224 XE_OUTB(XE_MSR, XE_INB(XE_MSR) | 0x08);
1225 scp->media = IFM_ETHER|IFM_100_TX;
1226 scp->autoneg_status = XE_AUTONEG_NONE;
1230 * XXX - Bit of a hack going on in here.
1231 * XXX - This is derived from Ken Hughes patch to the Linux driver
1232 * XXX - to make it work with 10Mbit _autonegotiated_ links on CE3B
1233 * XXX - cards. What's a CE3B and how's it differ from a plain CE3?
1234 * XXX - these are the things we need to find out.
1236 xe_phy_writereg(scp, PHY_BMCR, 0x0000);
1239 XE_OUTB(XE_MSR, XE_INB(XE_MSR) | 0x08);
1240 XE_SELECT_PAGE(0x42);
1241 XE_OUTB(XE_SWC1, 0x80);
1242 scp->media = IFM_ETHER|IFM_10_T;
1243 scp->autoneg_status = XE_AUTONEG_NONE;
1245 /*XE_OUTB(XE_MSR, XE_INB(XE_MSR) & ~0x08);*/ /* Disable PHY? */
1246 /*scp->autoneg_status = XE_AUTONEG_FAIL;*/
1251 device_printf(scp->dev, "Autonegotiation failed; trying 100baseTX\n");
1256 xe_phy_writereg(scp, PHY_BMCR, PHY_BMCR_SPEEDSEL);
1257 scp->autoneg_status = XE_AUTONEG_100TX;
1258 scp->chand = timeout(xe_setmedia, scp, hz * 3);
1262 scp->autoneg_status = XE_AUTONEG_FAIL;
1267 case XE_AUTONEG_100TX:
1268 (void)xe_phy_readreg(scp, PHY_BMSR);
1269 bmsr = xe_phy_readreg(scp, PHY_BMSR);
1270 if (bmsr & PHY_BMSR_LINKSTAT) {
1272 device_printf(scp->dev, "Got 100baseTX link!\n");
1276 XE_OUTB(XE_MSR, XE_INB(XE_MSR) | 0x08);
1277 scp->media = IFM_ETHER|IFM_100_TX;
1278 scp->autoneg_status = XE_AUTONEG_NONE;
1282 device_printf(scp->dev, "Autonegotiation failed; disabling PHY\n");
1285 xe_phy_writereg(scp, PHY_BMCR, 0x0000);
1287 XE_OUTB(XE_MSR, XE_INB(XE_MSR) & ~0x08); /* Disable PHY? */
1288 scp->autoneg_status = XE_AUTONEG_FAIL;
1294 * If we got down here _and_ autoneg_status is XE_AUTONEG_FAIL, then
1295 * either autonegotiation failed, or never got started to begin with. In
1296 * either case, select a suitable 10Mbit media and hope it works. We
1297 * don't need to reset the card again, since it will have been done
1298 * already by the big switch above.
1300 if (scp->autoneg_status == XE_AUTONEG_FAIL) {
1302 device_printf(scp->dev, "Selecting 10baseX\n");
1305 XE_SELECT_PAGE(0x42);
1306 XE_OUTB(XE_SWC1, 0x80);
1307 scp->media = IFM_ETHER|IFM_10_T;
1308 scp->autoneg_status = XE_AUTONEG_NONE;
1312 XE_OUTB(XE_GPR0, 4);
1314 XE_SELECT_PAGE(0x42);
1315 XE_OUTB(XE_SWC1, (XE_INB(XE_ESR) & XE_ESR_MEDIA_SELECT) ? 0x80 : 0xc0);
1316 scp->media = IFM_ETHER|((XE_INB(XE_ESR) & XE_ESR_MEDIA_SELECT) ? IFM_10_T : IFM_10_2);
1317 scp->autoneg_status = XE_AUTONEG_NONE;
1324 * If a specific media has been requested, we just reset the card and
1325 * select it (one small exception -- if 100baseTX is requested by there is
1326 * no PHY, we fall back to 10baseT operation).
1328 case IFM_100_TX: /* Force 100baseTX */
1332 device_printf(scp->dev, "Selecting 100baseTX\n");
1334 XE_SELECT_PAGE(0x42);
1335 XE_OUTB(XE_SWC1, 0);
1336 xe_phy_writereg(scp, PHY_BMCR, PHY_BMCR_SPEEDSEL);
1338 XE_OUTB(XE_MSR, XE_INB(XE_MSR) | 0x08);
1339 scp->media |= IFM_100_TX;
1344 case IFM_10_T: /* Force 10baseT */
1347 device_printf(scp->dev, "Selecting 10baseT\n");
1350 xe_phy_writereg(scp, PHY_BMCR, 0x0000);
1352 XE_OUTB(XE_MSR, XE_INB(XE_MSR) & ~0x08); /* Disable PHY */
1354 XE_SELECT_PAGE(0x42);
1355 XE_OUTB(XE_SWC1, 0x80);
1356 scp->media |= IFM_10_T;
1362 device_printf(scp->dev, "Selecting 10base2\n");
1364 XE_SELECT_PAGE(0x42);
1365 XE_OUTB(XE_SWC1, 0xc0);
1366 scp->media |= IFM_10_2;
1372 * Finally, the LEDs are set to match whatever media was chosen and the
1373 * transmitter is unblocked.
1376 device_printf(scp->dev, "Setting LEDs\n");
1379 switch (IFM_SUBTYPE(scp->media)) {
1382 XE_OUTB(XE_LED, 0x3b);
1384 XE_OUTB(0x0b, 0x04); /* 100Mbit LED */
1388 XE_OUTB(XE_LED, 0x3a);
1392 /* Restart output? */
1393 scp->ifp->if_flags &= ~IFF_OACTIVE;
1399 * Hard reset (power cycle) the card.
1402 xe_hard_reset(struct xe_softc *scp) {
1406 device_printf(scp->dev, "hard_reset\n");
1412 * Power cycle the card.
1415 XE_OUTB(XE_GPR1, 0); /* Power off */
1419 XE_OUTB(XE_GPR1, 1); /* And back on again */
1421 XE_OUTB(XE_GPR1, 5); /* Also set AIC bit, whatever that is */
1430 * Soft reset the card. Also makes sure that the ML6692 and 10Mbit controller
1431 * are powered up, sets the silicon revision number in softc, disables
1432 * interrupts and checks for the prescence of a 100Mbit PHY. This should
1433 * leave us in a position where we can access the PHY and do media
1434 * selection. The function imposes a 0.5s delay while the hardware powers up.
1437 xe_soft_reset(struct xe_softc *scp) {
1441 device_printf(scp->dev, "soft_reset\n");
1447 * Reset the card, (again).
1450 XE_OUTB(XE_CR, XE_CR_SOFT_RESET);
1457 * set GP1 and GP2 as outputs (bits 2 & 3)
1458 * set GP1 low to power on the ML6692 (bit 0)
1459 * set GP2 high to power on the 10Mhz chip (bit 1)
1462 XE_OUTB(XE_GPR0, 0x0e);
1466 * Wait for everything to wake up.
1471 * Get silicon revision number.
1475 scp->srev = (XE_INB(XE_BOV) & 0x70) >> 4;
1477 scp->srev = (XE_INB(XE_BOV) & 0x30) >> 4;
1479 device_printf(scp->dev, "silicon revision = %d\n", scp->srev);
1483 * Shut off interrupts.
1485 xe_disable_intr(scp);
1491 scp->phy_ok = xe_mii_init(scp);
1501 * Take interface offline. This is done by powering down the device, which I
1502 * assume means just shutting down the transceiver and Ethernet logic. This
1503 * requires a _hard_ reset to recover from, as we need to power up again.
1506 xe_stop(struct xe_softc *scp) {
1510 device_printf(scp->dev, "stop\n");
1516 * Shut off interrupts.
1518 xe_disable_intr(scp);
1524 XE_OUTB(XE_GPR1, 0);
1528 * ~IFF_RUNNING == interface down.
1530 scp->ifp->if_flags &= ~IFF_RUNNING;
1531 scp->ifp->if_flags &= ~IFF_OACTIVE;
1532 scp->ifp->if_timer = 0;
1539 * Enable Ethernet interrupts from the card.
1542 xe_enable_intr(struct xe_softc *scp) {
1544 device_printf(scp->dev, "enable_intr\n");
1548 XE_OUTB(XE_IMR0, 0xff); /* Unmask everything */
1549 XE_OUTB(XE_IMR1, 0x01); /* Unmask TX underrun detection */
1553 XE_OUTB(XE_CR, XE_CR_ENABLE_INTR); /* Enable interrupts */
1554 if (scp->modem && !scp->dingo) { /* This bit is just magic */
1555 if (!(XE_INB(0x10) & 0x01)) {
1556 XE_OUTB(0x10, 0x11); /* Unmask master int enable bit */
1563 * Disable all Ethernet interrupts from the card.
1566 xe_disable_intr(struct xe_softc *scp) {
1568 device_printf(scp->dev, "disable_intr\n");
1572 XE_OUTB(XE_CR, 0); /* Disable interrupts */
1573 if (scp->modem && !scp->dingo) { /* More magic (does this work?) */
1574 XE_OUTB(0x10, 0x10); /* Mask the master int enable bit */
1578 XE_OUTB(XE_IMR0, 0); /* Forbid all interrupts */
1579 XE_OUTB(XE_IMR1, 0);
1585 * Set up multicast filter and promiscuous mode
1588 xe_setmulti(struct xe_softc *scp) {
1590 struct ifmultiaddr *maddr;
1593 ifp = &scp->arpcom.ac_if;
1594 maddr = ifp->if_multiaddrs.lh_first;
1596 /* Get length of multicast list */
1597 for (count = 0; maddr != NULL; maddr = maddr->ifma_link.le_next, count++);
1599 if ((ifp->if_flags & IFF_PROMISC) || (ifp->if_flags & IFF_ALLMULTI) || (count > 9)) {
1601 * Go into promiscuous mode if either of the PROMISC or ALLMULTI flags are
1602 * set, or if we have been asked to deal with more than 9 multicast
1603 * addresses. To do this: set MPE and PME in SWC1
1605 XE_SELECT_PAGE(0x42);
1606 XE_OUTB(XE_SWC1, 0x06);
1608 else if ((ifp->if_flags & IFF_MULTICAST) && (count > 0)) {
1610 * Program the filters for up to 9 addresses
1612 XE_SELECT_PAGE(0x42);
1613 XE_OUTB(XE_SWC1, 0x01);
1614 XE_SELECT_PAGE(0x40);
1615 XE_OUTB(XE_CMD0, XE_CMD0_OFFLINE);
1616 /*xe_reg_dump(scp);*/
1618 /*xe_reg_dump(scp);*/
1619 XE_SELECT_PAGE(0x40);
1620 XE_OUTB(XE_CMD0, XE_CMD0_RX_ENABLE|XE_CMD0_ONLINE);
1624 * No multicast operation (default)
1626 XE_SELECT_PAGE(0x42);
1627 XE_OUTB(XE_SWC1, 0);
1634 * Set up all on-chip addresses (for multicast). AFAICS, there are 10
1635 * of these things; the first is our MAC address, the other 9 are mcast
1636 * addresses, padded with the MAC address if there aren't enough.
1637 * XXX - This doesn't work right, but I'm not sure why yet. We seem to be
1638 * XXX - doing much the same as the Linux code, which is weird enough that
1639 * XXX - it's probably right (despite my earlier comments to the contrary).
1642 xe_setaddrs(struct xe_softc *scp) {
1643 struct ifmultiaddr *maddr;
1645 u_int8_t page, slot, byte, i;
1647 maddr = scp->arpcom.ac_if.if_multiaddrs.lh_first;
1649 XE_SELECT_PAGE(page = 0x50);
1651 for (slot = 0, byte = 8; slot < 10; slot++) {
1654 addr = (u_int8_t *)(&scp->arpcom.ac_enaddr);
1656 while (maddr != NULL && maddr->ifma_addr->sa_family != AF_LINK)
1657 maddr = maddr->ifma_link.le_next;
1659 addr = LLADDR((struct sockaddr_dl *)maddr->ifma_addr);
1661 addr = (u_int8_t *)(&scp->arpcom.ac_enaddr);
1664 for (i = 0; i < 6; i++, byte++) {
1667 printf(":%x", addr[i]);
1669 device_printf(scp->dev, "individual addresses %d: %x", slot, addr[0]);
1675 XE_SELECT_PAGE(page);
1679 XE_OUTB(byte, addr[5 - i]);
1681 XE_OUTB(byte, addr[i]);
1693 * Write an outgoing packet to the card using programmed I/O.
1696 xe_pio_write_packet(struct xe_softc *scp, struct mbuf *mbp) {
1698 u_int16_t len, pad, free, ok;
1700 u_int8_t savebyte[2], wantbyte;
1702 /* Get total packet length */
1703 for (len = 0, mbp2 = mbp; mbp2 != NULL; len += mbp2->m_len, mbp2 = mbp2->m_next);
1705 /* Packets < minimum length may need to be padded out */
1707 if (len < ETHER_MIN_LEN - ETHER_CRC_LEN) {
1708 pad = (ETHER_MIN_LEN - ETHER_CRC_LEN - len + 1) >> 1;
1709 len = ETHER_MIN_LEN - ETHER_CRC_LEN;
1712 /* Check transmit buffer space */
1714 XE_OUTW(XE_TRS, len+2);
1715 free = XE_INW(XE_TSO);
1718 if (free <= len + 2)
1721 /* Send packet length to card */
1722 XE_OUTW(XE_EDP, len);
1725 * Write packet to card using PIO (code stolen from the ed driver)
1728 while (mbp != NULL) {
1731 data = mtod(mbp, caddr_t);
1732 if (wantbyte) { /* Finish the last word */
1733 savebyte[1] = *data;
1734 XE_OUTW(XE_EDP, *(u_short *)savebyte);
1739 if (len > 1) { /* Output contiguous words */
1740 bus_space_write_multi_2(scp->bst, scp->bsh, XE_EDP, (u_int16_t *) data,
1745 if (len == 1) { /* Save last byte, if necessary */
1746 savebyte[0] = *data;
1752 if (wantbyte) /* Last byte for odd-length packets */
1753 XE_OUTW(XE_EDP, *(u_short *)savebyte);
1756 * For CE3 cards, just tell 'em to send -- apparently the card will pad out
1757 * short packets with random cruft. Otherwise, write nonsense words to fill
1758 * out the packet. I guess it is then sent automatically (?)
1761 XE_OUTB(XE_CR, XE_CR_TX_PACKET|XE_CR_ENABLE_INTR);
1764 XE_OUTW(XE_EDP, 0xdead);
1773 * Compute the 32-bit Ethernet CRC for the given buffer.
1776 xe_compute_crc(u_int8_t *data, int len) {
1777 u_int32_t crc = 0xffffffff;
1778 u_int32_t poly = 0x04c11db6;
1779 u_int8_t current, crc31, bit;
1782 for (i = 0; i < len; i++) {
1784 for (k = 1; k <= 8; k++) {
1785 if (crc & 0x80000000) {
1791 bit = crc31 ^ (current & 0x01);
1795 crc = (crc ^ poly)|1;
1804 * Convert a CRC into an index into the multicast hash table. What we do is
1805 * take the most-significant 6 bits of the CRC, reverse them, and use that as
1806 * the bit number in the hash table. Bits 5:3 of the result give the byte
1807 * within the table (0-7); bits 2:0 give the bit number within that byte (also
1808 * 0-7), ie. the number of shifts needed to get it into the lsb position.
1811 xe_compute_hashbit(u_int32_t crc) {
1812 u_int8_t hashbit = 0;
1815 for (i = 0; i < 6; i++) {
1817 if (crc & 0x80000000) {
1822 return (hashbit >> 2);
1829 /**************************************************************
1831 * M I I F U N C T I O N S *
1833 **************************************************************/
1836 * Alternative MII/PHY handling code adapted from the xl driver. It doesn't
1837 * seem to work any better than the xirc2_ps stuff, but it's cleaner code.
1838 * XXX - this stuff shouldn't be here. It should all be abstracted off to
1839 * XXX - some kind of common MII-handling code, shared by all drivers. But
1840 * XXX - that's a whole other mission.
1842 #define XE_MII_SET(x) XE_OUTB(XE_GPR2, (XE_INB(XE_GPR2) | 0x04) | (x))
1843 #define XE_MII_CLR(x) XE_OUTB(XE_GPR2, (XE_INB(XE_GPR2) | 0x04) & ~(x))
1847 * Sync the PHYs by setting data bit and strobing the clock 32 times.
1850 xe_mii_sync(struct xe_softc *scp) {
1854 XE_MII_SET(XE_MII_DIR|XE_MII_WRD);
1856 for (i = 0; i < 32; i++) {
1857 XE_MII_SET(XE_MII_CLK);
1859 XE_MII_CLR(XE_MII_CLK);
1866 * Look for a MII-compliant PHY. If we find one, reset it.
1869 xe_mii_init(struct xe_softc *scp) {
1872 status = xe_phy_readreg(scp, PHY_BMSR);
1873 if ((status & 0xff00) != 0x7800) {
1875 device_printf(scp->dev, "no PHY found, %0x\n", status);
1881 device_printf(scp->dev, "PHY OK!\n");
1885 xe_phy_writereg(scp, PHY_BMCR, PHY_BMCR_RESET);
1887 while(xe_phy_readreg(scp, PHY_BMCR) & PHY_BMCR_RESET);
1895 * Clock a series of bits through the MII.
1898 xe_mii_send(struct xe_softc *scp, u_int32_t bits, int cnt) {
1902 XE_MII_CLR(XE_MII_CLK);
1904 for (i = (0x1 << (cnt - 1)); i; i >>= 1) {
1906 XE_MII_SET(XE_MII_WRD);
1908 XE_MII_CLR(XE_MII_WRD);
1911 XE_MII_CLR(XE_MII_CLK);
1913 XE_MII_SET(XE_MII_CLK);
1919 * Read an PHY register through the MII.
1922 xe_mii_readreg(struct xe_softc *scp, struct xe_mii_frame *frame) {
1928 * Set up frame for RX.
1930 frame->mii_stdelim = XE_MII_STARTDELIM;
1931 frame->mii_opcode = XE_MII_READOP;
1932 frame->mii_turnaround = 0;
1933 frame->mii_data = 0;
1936 XE_OUTB(XE_GPR2, 0);
1939 * Turn on data xmit.
1941 XE_MII_SET(XE_MII_DIR);
1946 * Send command/address info.
1948 xe_mii_send(scp, frame->mii_stdelim, 2);
1949 xe_mii_send(scp, frame->mii_opcode, 2);
1950 xe_mii_send(scp, frame->mii_phyaddr, 5);
1951 xe_mii_send(scp, frame->mii_regaddr, 5);
1954 XE_MII_CLR((XE_MII_CLK|XE_MII_WRD));
1956 XE_MII_SET(XE_MII_CLK);
1959 /* Turn off xmit. */
1960 XE_MII_CLR(XE_MII_DIR);
1963 XE_MII_CLR(XE_MII_CLK);
1965 ack = XE_INB(XE_GPR2) & XE_MII_RDD;
1966 XE_MII_SET(XE_MII_CLK);
1970 * Now try reading data bits. If the ack failed, we still
1971 * need to clock through 16 cycles to keep the PHY(s) in sync.
1974 for(i = 0; i < 16; i++) {
1975 XE_MII_CLR(XE_MII_CLK);
1977 XE_MII_SET(XE_MII_CLK);
1983 for (i = 0x8000; i; i >>= 1) {
1984 XE_MII_CLR(XE_MII_CLK);
1987 if (XE_INB(XE_GPR2) & XE_MII_RDD)
1988 frame->mii_data |= i;
1991 XE_MII_SET(XE_MII_CLK);
1997 XE_MII_CLR(XE_MII_CLK);
1999 XE_MII_SET(XE_MII_CLK);
2011 * Write to a PHY register through the MII.
2014 xe_mii_writereg(struct xe_softc *scp, struct xe_mii_frame *frame) {
2020 * Set up frame for TX.
2022 frame->mii_stdelim = XE_MII_STARTDELIM;
2023 frame->mii_opcode = XE_MII_WRITEOP;
2024 frame->mii_turnaround = XE_MII_TURNAROUND;
2029 * Turn on data output.
2031 XE_MII_SET(XE_MII_DIR);
2035 xe_mii_send(scp, frame->mii_stdelim, 2);
2036 xe_mii_send(scp, frame->mii_opcode, 2);
2037 xe_mii_send(scp, frame->mii_phyaddr, 5);
2038 xe_mii_send(scp, frame->mii_regaddr, 5);
2039 xe_mii_send(scp, frame->mii_turnaround, 2);
2040 xe_mii_send(scp, frame->mii_data, 16);
2043 XE_MII_SET(XE_MII_CLK);
2045 XE_MII_CLR(XE_MII_CLK);
2051 XE_MII_CLR(XE_MII_DIR);
2060 * Read a register from the PHY.
2063 xe_phy_readreg(struct xe_softc *scp, u_int16_t reg) {
2064 struct xe_mii_frame frame;
2066 bzero((char *)&frame, sizeof(frame));
2068 frame.mii_phyaddr = 0;
2069 frame.mii_regaddr = reg;
2070 xe_mii_readreg(scp, &frame);
2072 return(frame.mii_data);
2077 * Write to a PHY register.
2080 xe_phy_writereg(struct xe_softc *scp, u_int16_t reg, u_int16_t data) {
2081 struct xe_mii_frame frame;
2083 bzero((char *)&frame, sizeof(frame));
2085 frame.mii_phyaddr = 0;
2086 frame.mii_regaddr = reg;
2087 frame.mii_data = data;
2088 xe_mii_writereg(scp, &frame);
2096 * A bit of debugging code.
2099 xe_mii_dump(struct xe_softc *scp) {
2104 device_printf(scp->dev, "MII registers: ");
2105 for (i = 0; i < 2; i++) {
2106 printf(" %d:%04x", i, xe_phy_readreg(scp, i));
2108 for (i = 4; i < 7; i++) {
2109 printf(" %d:%04x", i, xe_phy_readreg(scp, i));
2117 xe_reg_dump(struct xe_softc *scp) {
2122 device_printf(scp->dev, "Common registers: ");
2123 for (i = 0; i < 8; i++) {
2124 printf(" %2.2x", XE_INB(i));
2128 for (page = 0; page <= 8; page++) {
2129 device_printf(scp->dev, "Register page %2.2x: ", page);
2130 XE_SELECT_PAGE(page);
2131 for (i = 8; i < 16; i++) {
2132 printf(" %2.2x", XE_INB(i));
2137 for (page = 0x10; page < 0x5f; page++) {
2138 if ((page >= 0x11 && page <= 0x3f) ||
2140 (page >= 0x43 && page <= 0x4f) ||
2143 device_printf(scp->dev, "Register page %2.2x: ", page);
2144 XE_SELECT_PAGE(page);
2145 for (i = 8; i < 16; i++) {
2146 printf(" %2.2x", XE_INB(i));
2156 xe_activate(device_t dev)
2158 struct xe_softc *sc = device_get_softc(dev);
2162 sc->port_rid = 0; /* 0 is managed by pccard */
2163 sc->port_res = bus_alloc_resource(dev, SYS_RES_IOPORT,
2164 &sc->port_rid, 0, ~0, 16, RF_ACTIVE);
2167 * Find a 16 byte aligned ioport for the card.
2170 device_printf(dev, "Finding an aligned port for RealPort\n");
2171 #endif /* XE_DEBUG */
2172 sc->port_rid = 1; /* 0 is managed by pccard */
2175 sc->port_res = bus_alloc_resource(dev,
2176 SYS_RES_IOPORT, &sc->port_rid, start, 0x3ff, 16,
2178 if (sc->port_res == 0)
2179 break; /* we failed */
2180 if ((rman_get_start(sc->port_res) & 0xf) == 0)
2182 bus_release_resource(dev, SYS_RES_IOPORT, sc->port_rid,
2184 start = (rman_get_start(sc->port_res) + 15) & ~0xf;
2187 device_printf(dev, "port 0x%0lx, size 0x%0lx\n",
2188 bus_get_resource_start(dev, SYS_RES_IOPORT, sc->port_rid),
2189 bus_get_resource_count(dev, SYS_RES_IOPORT, sc->port_rid));
2190 #endif /* XE_DEBUG */
2192 if (!sc->port_res) {
2194 device_printf(dev, "Cannot allocate ioport\n");
2200 sc->irq_res = bus_alloc_resource(dev, SYS_RES_IRQ, &sc->irq_rid,
2201 0, ~0, 1, RF_ACTIVE);
2204 device_printf(dev, "Cannot allocate irq\n");
2209 if ((err = bus_setup_intr(dev, sc->irq_res, INTR_TYPE_NET, xe_intr, sc,
2210 &sc->intrhand)) != 0) {
2215 sc->bst = rman_get_bustag(sc->port_res);
2216 sc->bsh = rman_get_bushandle(sc->port_res);
2221 xe_deactivate(device_t dev)
2223 struct xe_softc *sc = device_get_softc(dev);
2226 bus_teardown_intr(dev, sc->irq_res, sc->intrhand);
2229 bus_release_resource(dev, SYS_RES_IOPORT, sc->port_rid,
2233 bus_release_resource(dev, SYS_RES_IRQ, sc->irq_rid,
2239 static device_method_t xe_pccard_methods[] = {
2240 /* Device interface */
2241 DEVMETHOD(device_probe, xe_probe),
2242 DEVMETHOD(device_attach, xe_attach),
2243 DEVMETHOD(device_detach, xe_detach),
2248 static driver_t xe_pccard_driver = {
2251 sizeof(struct xe_softc),
2254 devclass_t xe_devclass;
2256 DECLARE_DUMMY_MODULE(if_xe);
2257 DRIVER_MODULE(if_xe, pccard, xe_pccard_driver, xe_devclass, 0, 0);