Change mbug allocation flags from M_ to MB_ to avoid confusion with malloc
[dragonfly.git] / sys / dev / netif / xe / if_xe.c
1 /*-
2  * Copyright (c) 1998, 1999 Scott Mitchell
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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.
13  *
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
24  * SUCH DAMAGE.
25  *
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.10 2004/06/02 14:42:56 eirikn Exp $
29  */
30
31 /*
32  * XXX TODO XXX
33  *
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
36  *
37  * xe_cem56fix -- need to figure out how to map the extra stuff.
38  */
39
40 /*
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
43  * xirc2ps driver):
44  *
45  * Copyright (c) 1997 by Werner Koch (dd9jn)
46  *
47  * Redistribution and use in source and binary forms, with or without
48  * modification, are permitted provided that the following conditions
49  * are met:
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
58  *    written permission.
59  *
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.
71  */
72
73 /*              
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)
84  *
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?)
91  *
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.
96  *
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
99  * the web pages.
100  *
101  * Contact points:
102  *
103  * Driver web page: http://ukug.uk.freebsd.org/~scott/xe_drv/
104  *
105  * Mailing list: http://www.lovett.com/lists/freebsd-xircom/
106  * or send "subscribe freebsd-xircom" to <majordomo@lovett.com>
107  *
108  * Author email: <scott@uk.freebsd.org>
109  */
110
111
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>
121 #include <sys/uio.h>
122
123 #include <sys/module.h>
124 #include <sys/bus.h>
125
126 #include <machine/bus.h>
127 #include <machine/resource.h>
128 #include <sys/rman.h>
129  
130 #include <net/ethernet.h>
131 #include <net/if.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>
136 #include <net/bpf.h>
137
138 #include <bus/pccard/pccardvar.h>
139 #include "card_if.h"
140
141 #include "if_xereg.h"
142 #include "if_xevar.h"
143
144 #include <machine/clock.h>
145
146 /*
147  * MII command structure
148  */
149 struct xe_mii_frame {
150   u_int8_t  mii_stdelim;
151   u_int8_t  mii_opcode;
152   u_int8_t  mii_phyaddr;
153   u_int8_t  mii_regaddr;
154   u_int8_t  mii_turnaround;
155   u_int16_t mii_data;
156 };
157
158 /*
159  * Media autonegotiation progress constants
160  */
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 */
166
167
168 /*
169  * Prototypes start here
170  */
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);
191 #if 0
192 static u_int32_t xe_compute_crc         (u_int8_t *data, int len);
193 static int       xe_compute_hashbit     (u_int32_t crc);
194 #endif
195
196 /*
197  * MII functions
198  */
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);
206
207 /*
208  * Debug functions -- uncomment for VERY verbose dignostic information.
209  * Set to 1 for less verbose information
210  */
211 /* #define XE_DEBUG 2 */
212 #ifdef XE_DEBUG
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);
217 #else
218 #define XE_REG_DUMP(scp)
219 #define XE_MII_DUMP(scp)
220 #endif
221
222 /*
223  * Fixing for RealPort cards - they need a little furtling to get the
224  * ethernet working
225  */
226 static int
227 xe_cem56fix(device_t dev)
228 {
229   struct xe_softc *sc = (struct xe_softc *) device_get_softc(dev);
230   bus_space_tag_t bst;
231   bus_space_handle_t bsh;
232   struct resource *r;
233   int rid;
234   int ioport;
235
236 #ifdef XE_DEBUG
237   device_printf(dev, "Hacking your Realport, master\n");
238 #endif
239  
240 #if XE_DEBUG > 1
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));
244 #endif
245
246   rid = 0;
247   r = bus_alloc_resource(dev, SYS_RES_MEMORY, &rid, 0, ~0, 4 << 10, RF_ACTIVE);
248   if (!r) {
249 #if XE_DEBUG > 0
250     device_printf(dev, "Can't map in attribute memory\n");
251 #endif
252     return -1;
253   }
254
255   bsh = rman_get_bushandle(r);
256   bst = rman_get_bustag(r);
257
258   CARD_SET_RES_FLAGS(device_get_parent(dev), dev, SYS_RES_MEMORY, rid,
259       PCCARD_A_MEM_ATTR);
260
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);
268
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 |
271                                            DINGO_DCOR1_EEDIO);
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);
275
276   bus_release_resource(dev, SYS_RES_MEMORY, rid, r);
277
278   /* success! */
279   return 0;
280 }
281         
282 /*
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.
287  */
288 static int
289 xe_probe(device_t dev)
290 {
291   struct xe_softc *scp = (struct xe_softc *) device_get_softc(dev);
292   bus_space_tag_t bst;
293   bus_space_handle_t bsh;
294   int buf;
295   u_char ver_str[CISTPL_BUFSIZE>>1];
296   off_t offs;
297   int success, rc, i;
298   int rid;
299   struct resource *r;
300
301   success = 0;
302
303 #ifdef XE_DEBUG
304   device_printf(dev, "xe: Probing\n");
305 #endif
306
307   /* Map in the CIS */
308   rid = 0;
309   r = bus_alloc_resource(dev, SYS_RES_MEMORY, &rid, 0, ~0, 4 << 10, RF_ACTIVE);
310   if (!r) {
311 #ifdef XE_DEBUG
312     device_printf(dev, "Can't map in cis\n");
313 #endif
314     return ENOMEM;
315   }
316   bsh = rman_get_bushandle(r);
317   bst = rman_get_bustag(r);
318   buf = 0;
319
320   CARD_SET_RES_FLAGS(device_get_parent(dev), dev, SYS_RES_MEMORY, rid,
321       PCCARD_A_MEM_ATTR);
322
323   /* Grep through CIS looking for relevant tuples */
324   offs = 0;
325   do {
326     u_int16_t vendor;
327     u_int8_t rev, media, prod;
328
329     switch (CISTPL_TYPE(buf)) {
330
331     case 0x15:  /* Grab version string (needed to ID some weird CE2's) */
332 #if XE_DEBUG > 1
333       device_printf(dev, "Got version string (0x15)\n");
334 #endif
335       for (i = 0; i < CISTPL_LEN(buf); ver_str[i] = CISTPL_DATA(buf, i++));
336       ver_str[i] = '\0';
337       ver_str[(CISTPL_BUFSIZE>>1) - 1] = CISTPL_LEN(buf);
338       success++;
339       break;
340
341     case 0x20:  /* Figure out what type of card we have */
342 #if XE_DEBUG > 1
343       device_printf(dev, "Got card ID (0x20)\n");
344 #endif
345       vendor = CISTPL_DATA(buf, 0) + (CISTPL_DATA(buf, 1) << 8);
346       rev = CISTPL_DATA(buf, 2);
347       media = CISTPL_DATA(buf, 3);
348       prod = CISTPL_DATA(buf, 4);
349
350       switch (vendor) { /* Get vendor ID */
351       case 0x0105:
352         scp->vendor = "Xircom"; break;
353       case 0x0138:
354       case 0x0183:
355         scp->vendor = "Compaq"; break;
356       case 0x0089:
357         scp->vendor = "Intel"; break;
358       default:
359         scp->vendor = "Unknown";
360       }
361
362       if (!((prod & 0x40) && (media & 0x01))) {
363 #if XE_DEBUG > 1
364         device_printf(dev, "Not a PCMCIA Ethernet card!\n");
365 #endif
366         rc = ENODEV;            /* Not a PCMCIA Ethernet device */
367       } else {
368         if (media & 0x10) {     /* Ethernet/modem cards */
369 #if XE_DEBUG > 1
370           device_printf(dev, "Card is Ethernet/modem combo\n");
371 #endif
372           scp->modem = 1;
373           switch (prod & 0x0f) {
374           case 1:
375             scp->card_type = "CEM"; break;
376           case 2:
377             scp->ce2 = 1;
378             scp->card_type = "CEM2"; break;
379           case 3:
380             scp->ce2 = 1;
381             scp->card_type = "CEM3"; break;
382           case 4:
383             scp->ce2 = 1;
384             scp->card_type = "CEM33"; break;
385           case 5:
386             scp->mohawk = 1;
387             scp->card_type = "CEM56M"; break;
388           case 6:
389           case 7:               /* Some kind of RealPort card */
390             scp->mohawk = 1;
391             scp->dingo = 1;
392             scp->card_type = "CEM56"; break;
393           default:
394             rc = ENODEV;
395           }
396         } else {                /* Ethernet-only cards */
397 #if XE_DEBUG > 1
398           device_printf(dev, "Card is Ethernet only\n");
399 #endif
400           switch (prod & 0x0f) {
401           case 1:
402             scp->card_type = "CE"; break;
403           case 2:
404             scp->ce2 = 1;
405             scp->card_type = "CE2"; break;
406           case 3:
407             scp->mohawk = 1;
408             scp->card_type = "CE3"; break;
409           default:
410             rc = ENODEV;
411           }
412         }
413       }
414       success++;
415       break;
416
417     case 0x22:  /* Get MAC address */
418       if ((CISTPL_LEN(buf) == 8) &&
419           (CISTPL_DATA(buf, 0) == 0x04) &&
420           (CISTPL_DATA(buf, 1) == ETHER_ADDR_LEN)) {
421 #if XE_DEBUG > 1
422         device_printf(dev, "Got MAC address (0x22)\n");
423 #endif
424         for (i = 0; i < ETHER_ADDR_LEN; i++)
425           scp->arpcom.ac_enaddr[i] = CISTPL_DATA(buf, i+2);
426       }
427       success++;
428       break;
429     default:
430       break;
431     }
432
433     if (CISTPL_TYPE(buf) == 0xff)
434       break;
435     /* Skip to next tuple */
436     buf += ((CISTPL_LEN(buf) + 2) << 1);
437
438   } while (1);
439
440   /* unmap the cis */
441   bus_release_resource(dev, SYS_RES_MEMORY, rid, r);
442
443   /* Die now if something went wrong above */
444   if (success < 3)
445     return ENXIO;
446
447   /* Check for certain strange CE2's that look like CE's */
448   if (strcmp(scp->card_type, "CE") == 0) {
449     u_char *str = ver_str;
450 #if XE_DEBUG > 1
451     device_printf(dev, "Checking for weird CE2 string\n");
452 #endif
453     str += strlen(str) + 1;                     /* Skip forward to 3rd version string */
454     str += strlen(str) + 1;
455     str += strlen(str) + 1;
456     for (i = 0; i < strlen(str) - 2; i++) {
457       if (bcmp(&str[i], "CE2", 3) ==0) {        /* Look for "CE2" string */
458         scp->card_type = "CE2";
459       }
460     }
461   }
462
463   /* Reject unsupported cards */
464   if (strcmp(scp->card_type, "CE") == 0 || strcmp(scp->card_type, "CEM") == 0) {
465     device_printf(dev, "Sorry, your %s card is not supported :(\n",
466      scp->card_type);
467     return ENODEV;
468   }
469
470   /* Success */
471   return 0;
472 }
473
474 /*
475  * The device entry is being removed, probably because someone ejected the
476  * card.  The interface should have been brought down manually before calling
477  * this function; if not you may well lose packets.  In any case, I shut down
478  * the card and the interface, and hope for the best.
479  */
480 static int
481 xe_detach(device_t dev) {
482   struct xe_softc *sc = device_get_softc(dev);
483
484   sc->arpcom.ac_if.if_flags &= ~IFF_RUNNING; 
485   ether_ifdetach(&sc->arpcom.ac_if);
486   xe_deactivate(dev);
487   return 0;
488 }
489
490 /*
491  * Attach a device.
492  */
493 static int
494 xe_attach (device_t dev) {
495   struct xe_softc *scp = device_get_softc(dev);
496   int err;
497
498 #ifdef XE_DEBUG
499   device_printf(dev, "attach\n");
500 #endif
501
502   if ((err = xe_activate(dev)) != 0)
503     return (err);
504
505   /* Fill in some private data */
506   scp->ifp = &scp->arpcom.ac_if;
507   scp->ifm = &scp->ifmedia;
508   scp->autoneg_status = 0;
509
510   /* Hack RealPorts into submission */
511   if (scp->dingo && xe_cem56fix(dev) < 0) {
512     device_printf(dev, "Unable to fix your RealPort\n");
513     xe_deactivate(dev);
514     return ENODEV;
515   }
516
517   /* Hopefully safe to read this here */
518   XE_SELECT_PAGE(4);
519   scp->version = XE_INB(XE_BOV);
520
521   scp->dev = dev;
522   /* Initialise the ifnet structure */
523   scp->ifp->if_softc = scp;
524   if_initname(scp->ifp, "xe", device_get_unit(dev));
525   scp->ifp->if_timer = 0;
526   scp->ifp->if_flags = (IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST);
527   scp->ifp->if_linkmib = &scp->mibdata;
528   scp->ifp->if_linkmiblen = sizeof scp->mibdata;
529   scp->ifp->if_output = ether_output;
530   scp->ifp->if_start = xe_start;
531   scp->ifp->if_ioctl = xe_ioctl;
532   scp->ifp->if_watchdog = xe_watchdog;
533   scp->ifp->if_init = xe_init;
534   scp->ifp->if_snd.ifq_maxlen = IFQ_MAXLEN;
535
536   /* Initialise the ifmedia structure */
537   ifmedia_init(scp->ifm, 0, xe_media_change, xe_media_status);
538   callout_handle_init(&scp->chand);
539
540   /*
541    * Fill in supported media types.  Some cards _do_ support full duplex
542    * operation, but this driver doesn't, yet.  Therefore we leave those modes
543    * out of the list.  We support some form of autoselection in all cases.
544    */
545   if (scp->mohawk) {
546     ifmedia_add(scp->ifm, IFM_ETHER|IFM_100_TX, 0, NULL);
547     ifmedia_add(scp->ifm, IFM_ETHER|IFM_10_T, 0, NULL);
548   }
549   else {
550     ifmedia_add(scp->ifm, IFM_ETHER|IFM_10_T, 0, NULL);
551     ifmedia_add(scp->ifm, IFM_ETHER|IFM_10_2, 0, NULL);
552   }
553   ifmedia_add(scp->ifm, IFM_ETHER|IFM_AUTO, 0, NULL);
554
555   /* Default is to autoselect best supported media type */
556   ifmedia_set(scp->ifm, IFM_ETHER|IFM_AUTO);
557
558   /* Print some useful information */
559   device_printf(dev, "%s %s, bonding version %#x%s%s\n",
560          scp->vendor,
561          scp->card_type,
562          scp->version,
563          scp->mohawk ? ", 100Mbps capable" : "",
564          scp->modem ?  ", with modem"      : "");
565   if (scp->mohawk) {
566     XE_SELECT_PAGE(0x10);
567     device_printf(dev, "DingoID = %#x, RevisionID = %#x, VendorID = %#x\n",
568            XE_INW(XE_DINGOID),
569            XE_INW(XE_RevID),
570            XE_INW(XE_VendorID));
571   }
572   if (scp->ce2) {
573     XE_SELECT_PAGE(0x45);
574     device_printf(dev, "CE2 version = %#x\n", XE_INB(XE_REV));
575   }
576
577   /* Print MAC address */
578   device_printf(dev, "Ethernet address %6D\n", scp->arpcom.ac_enaddr, ":");
579
580   /* Attach the interface */
581   ether_ifattach(scp->ifp, scp->arpcom.ac_enaddr);
582
583   /* Done */
584   return 0;
585 }
586
587
588 /*
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.
592  */
593 static void
594 xe_init(void *xscp) {
595   struct xe_softc *scp = xscp;
596   int s;
597
598 #ifdef XE_DEBUG
599   device_printf(scp->dev, "init\n");
600 #endif
601
602   if (TAILQ_EMPTY(&scp->ifp->if_addrhead)) return;
603
604   /* Reset transmitter flags */
605   scp->tx_queued = 0;
606   scp->tx_tpr = 0;
607   scp->tx_collisions = 0;
608   scp->ifp->if_timer = 0;
609
610   s = splimp();
611
612   XE_SELECT_PAGE(0x42);
613   XE_OUTB(XE_SWC0, 0x20);       /* Disable source insertion (WTF is that?) */
614
615   /*
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.
619    */
620   if (scp->srev != 1) {
621     XE_SELECT_PAGE(2);
622     XE_OUTW(XE_RBS, 0x2000);
623   }
624
625   /* Set up multicast addresses */
626   xe_setmulti(scp);
627
628   /* Fix the data offset register -- reset leaves it off-by-one */
629   XE_SELECT_PAGE(0);
630   XE_OUTW(XE_DO, 0x2000);
631
632   /*
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.
635    */
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    */
643
644   /*
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 
647    * it's done.
648    */
649   if (scp->autoneg_status) {
650     scp->ifp->if_flags |= IFF_RUNNING;
651   }
652   else {
653     /* Enable receiver, put MAC online */
654     XE_SELECT_PAGE(0x40);
655     XE_OUTB(XE_CMD0, XE_CMD0_RX_ENABLE|XE_CMD0_ONLINE);
656
657     /* Set up IMR, enable interrupts */
658     xe_enable_intr(scp);
659
660     /* Attempt to start output */
661     scp->ifp->if_flags |= IFF_RUNNING;
662     scp->ifp->if_flags &= ~IFF_OACTIVE;
663     xe_start(scp->ifp);
664   }
665
666   (void)splx(s);
667 }
668
669
670 /*
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
674  *     return
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)
677  */
678 static void
679 xe_start(struct ifnet *ifp) {
680   struct xe_softc *scp = ifp->if_softc;
681   struct mbuf *mbp;
682
683   /*
684    * Loop while there are packets to be sent, and space to send them.
685    */
686   while (1) {
687     IF_DEQUEUE(&ifp->if_snd, mbp);      /* Suck a packet off the send queue */
688
689     if (mbp == NULL) {
690       /*
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
695        * accept more.
696        */
697       ifp->if_flags &= ~IFF_OACTIVE;
698       return;
699     }
700
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;
704       return;
705     }
706
707     /* Tap off here if there is a bpf listener */
708     if (ifp->if_bpf) {
709 #if XE_DEBUG > 1
710       device_printf(scp->dev, "sending output packet to BPF\n");
711 #endif
712       bpf_mtap(ifp, mbp);
713     }
714
715     ifp->if_timer = 5;                  /* In case we don't hear from the card again */
716     scp->tx_queued++;
717
718     m_freem(mbp);
719   }
720 }
721
722
723 /*
724  * Process an ioctl request.  Adapted from the ed driver.
725  */
726 static int
727 xe_ioctl (struct ifnet *ifp, u_long command, caddr_t data, struct ucred *cr) {
728   struct xe_softc *scp;
729   int s, error;
730
731   scp = ifp->if_softc;
732   error = 0;
733
734   s = splimp();
735
736   switch (command) {
737
738    case SIOCSIFADDR:
739    case SIOCGIFADDR:
740    case SIOCSIFMTU:
741     error = ether_ioctl(ifp, command, data);
742     break;
743
744    case SIOCSIFFLAGS:
745     /*
746      * If the interface is marked up and stopped, then start it.  If it is
747      * marked down and running, then stop it.
748      */
749     if (ifp->if_flags & IFF_UP) {
750       if (!(ifp->if_flags & IFF_RUNNING)) {
751         xe_hard_reset(scp);
752         xe_setmedia(scp);
753         xe_init(scp);
754       }
755     }
756     else {
757       if (ifp->if_flags & IFF_RUNNING)
758         xe_stop(scp);
759     }
760
761    case SIOCADDMULTI:
762    case SIOCDELMULTI:
763     /*
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.
767      */
768     xe_setmulti(scp);
769     error = 0;
770     break;
771
772    case SIOCSIFMEDIA:
773    case SIOCGIFMEDIA:
774     /*
775      * Someone wants to get/set media options.
776      */
777     error = ifmedia_ioctl(ifp, (struct ifreq *)data, &scp->ifmedia, command);
778     break;
779
780    default:
781     error = EINVAL;
782   }
783
784   (void)splx(s);
785
786   return error;
787 }
788
789
790 /*
791  * Card interrupt handler.
792  *
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
798  * is.
799  *
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 :)
807  */
808 static void
809 xe_intr(void *xscp) 
810 {
811   struct xe_softc *scp = (struct xe_softc *) xscp;
812   struct ifnet *ifp;
813   int result;
814   u_int16_t rx_bytes, rxs, txs;
815   u_int8_t psr, isr, esr, rsr;
816
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 */
820
821   if (scp->mohawk) {
822     XE_OUTB(XE_CR, 0);          /* Disable interrupts */
823   }
824
825   psr = XE_INB(XE_PR);          /* Stash the current register page */
826
827   /*
828    * Read ISR to see what caused this interrupt.  Note that this clears the
829    * ISR on CE2 type cards.
830    */
831   if ((isr = XE_INB(XE_ISR)) && isr != 0xff) {
832
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);
842     XE_SELECT_PAGE(0);
843
844 #if XE_DEBUG > 2
845     printf("xe%d: ISR=%#2.2x ESR=%#2.2x RST=%#2.2x TXST=%#4.4x\n", unit, isr, esr, rxs, txs);
846 #endif
847
848     /*
849      * Handle transmit interrupts
850      */
851     if (isr & XE_ISR_TX_PACKET) {
852       u_int8_t new_tpr, sent;
853       
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 */
856       else
857         sent = new_tpr - scp->tx_tpr;
858
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;
864
865         /*
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
873          * end!
874          * XXX - This will screw up if tx_collisions/sent > 14. FIX IT!
875          */
876         switch (scp->tx_collisions) {
877          case 0:
878           break;
879          case 1:
880           scp->mibdata.dot3StatsSingleCollisionFrames++;
881           scp->mibdata.dot3StatsCollFrequencies[0]++;
882           break;
883          default:
884           if (sent == 1) {
885             scp->mibdata.dot3StatsMultipleCollisionFrames++;
886             scp->mibdata.dot3StatsCollFrequencies[scp->tx_collisions-1]++;
887           }
888           else {                /* Distribute across multiple frames */
889             scp->mibdata.dot3StatsMultipleCollisionFrames += sent;
890             scp->mibdata.
891               dot3StatsCollFrequencies[scp->tx_collisions/sent] += sent - scp->tx_collisions%sent;
892             scp->mibdata.
893               dot3StatsCollFrequencies[scp->tx_collisions/sent + 1] += scp->tx_collisions%sent;
894           }
895         }
896         scp->tx_collisions = 0;
897       }
898       ifp->if_timer = 0;
899       ifp->if_flags &= ~IFF_OACTIVE;
900     }
901     if (txs & 0x0002) {         /* Excessive collisions (packet dropped) */
902       ifp->if_collisions += 16;
903       ifp->if_oerrors++;
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);
909     }
910     if (txs & 0x0040)           /* Transmit aborted -- probably collisions */
911       scp->tx_collisions++;
912
913
914     /*
915      * Handle receive interrupts 
916      */
917     while ((esr = XE_INB(XE_ESR)) & XE_ESR_FULL_PACKET_RX) {
918
919       if ((rsr = XE_INB(XE_RSR)) & XE_RSR_RX_OK) {
920         struct ether_header *ehp;
921         struct mbuf *mbp;
922         u_int16_t len;
923
924         len = XE_INW(XE_RBC);
925
926         if (len == 0)
927           continue;
928
929 #if 0
930         /*
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.
934          */
935         if ((rx_bytes += len) > 22000) {
936           ifp->if_iqdrops++;
937           scp->mibData.dot3StatsMissedFrames++;
938           XE_OUTW(XE_DO, 0x8000);
939           continue;
940         }
941 #endif
942
943         if (len & 0x01)
944           len++;
945
946         MGETHDR(mbp, MB_DONTWAIT, MT_DATA);     /* Allocate a header mbuf */
947         if (mbp != NULL) {
948           mbp->m_pkthdr.rcvif = ifp;
949           mbp->m_pkthdr.len = mbp->m_len = len;
950
951           /*
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.
955            */
956           if (len + 2 > MHLEN) {
957             MCLGET(mbp, MB_DONTWAIT);
958             if ((mbp->m_flags & M_EXT) == 0) {
959               m_freem(mbp);
960               mbp = NULL;
961             }
962           }
963         }
964
965         if (mbp != NULL) {
966           /*
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.
971            */
972           mbp->m_data += 2;
973           ehp = mtod(mbp, struct ether_header *);
974
975           /*
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).
980            */
981           if (scp->srev == 0) {         /* Workaround a bug in old cards */
982             u_short rhs;
983
984             XE_SELECT_PAGE(5);
985             rhs = XE_INW(XE_RHSA);
986             XE_SELECT_PAGE(0);
987
988             rhs += 3;                    /* Skip control info */
989
990             if (rhs >= 0x8000)
991               rhs = 0;
992
993             if (rhs + len > 0x8000) {
994               int i;
995
996               /*
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?).
1002                */
1003               for (i = 0; i < len; i++, rhs++) {
1004                 ((char *)ehp)[i] = XE_INB(XE_EDP);
1005                 if (rhs == 0x8000) {
1006                   rhs = 0;
1007                   i--;
1008                 }
1009               }
1010             }
1011             else
1012               bus_space_read_multi_2(scp->bst, scp->bsh, XE_EDP, 
1013                (u_int16_t *) ehp, len >> 1);
1014           }
1015           else
1016             bus_space_read_multi_2(scp->bst, scp->bsh, XE_EDP, 
1017              (u_int16_t *) ehp, len >> 1);
1018
1019           /* Deliver packet to upper layers */
1020           if (mbp != NULL) {
1021             mbp->m_pkthdr.len = mbp->m_len = len - ETHER_HDR_LEN;
1022             mbp->m_data += ETHER_HDR_LEN;       /* Strip off Ethernet header */
1023             ether_input(ifp, ehp, mbp);         /* Send the packet on its way */
1024             ifp->if_ipackets++;                 /* Success! */
1025           }
1026           XE_OUTW(XE_DO, 0x8000);               /* skip_rx_packet command */
1027         }
1028       }
1029       else if (rsr & XE_RSR_LONG_PACKET) {      /* Packet length >1518 bytes */
1030         scp->mibdata.dot3StatsFrameTooLongs++;
1031         ifp->if_ierrors++;
1032       }
1033       else if (rsr & XE_RSR_CRC_ERROR) {        /* Bad checksum on packet */
1034         scp->mibdata.dot3StatsFCSErrors++;
1035         ifp->if_ierrors++;
1036       }
1037       else if (rsr & XE_RSR_ALIGN_ERROR) {      /* Packet alignment error */
1038         scp->mibdata.dot3StatsAlignmentErrors++;
1039         ifp->if_ierrors++;
1040       }
1041     }
1042     if (rxs & 0x10) {                           /* Receiver overrun */
1043       scp->mibdata.dot3StatsInternalMacReceiveErrors++;
1044       ifp->if_ierrors++;
1045       XE_OUTB(XE_CR, XE_CR_CLEAR_OVERRUN);
1046     }
1047   }
1048
1049   XE_SELECT_PAGE(psr);                          /* Restore saved page */
1050   XE_OUTB(XE_CR, XE_CR_ENABLE_INTR);            /* Re-enable interrupts */
1051
1052   /* Could force an int here, instead of dropping packets? */
1053   /* XE_OUTB(XE_CR, XE_CR_ENABLE_INTR|XE_CE_FORCE_INTR); */
1054
1055   return;
1056 }
1057
1058
1059 /*
1060  * Device timeout/watchdog routine.  Called automatically if we queue a packet 
1061  * for transmission but don't get an interrupt within a specified timeout
1062  * (usually 5 seconds).  When this happens we assume the worst and reset the
1063  * card.
1064  */
1065 static void
1066 xe_watchdog(struct ifnet *ifp) {
1067   struct xe_softc *scp = ifp->if_softc;
1068
1069   device_printf(scp->dev, "watchdog timeout; resetting card\n");
1070   scp->tx_timeouts++;
1071   ifp->if_oerrors += scp->tx_queued;
1072   xe_stop(scp);
1073   xe_hard_reset(scp);
1074   xe_setmedia(scp);
1075   xe_init(scp);
1076 }
1077
1078
1079 /*
1080  * Change media selection.
1081  */
1082 static int
1083 xe_media_change(struct ifnet *ifp) {
1084   struct xe_softc *scp = ifp->if_softc;
1085
1086 #ifdef XE_DEBUG
1087   printf("%s: media_change\n", ifp->if_xname);
1088 #endif
1089
1090   if (IFM_TYPE(scp->ifm->ifm_media) != IFM_ETHER)
1091     return(EINVAL);
1092
1093   /*
1094    * Some card/media combos aren't always possible -- filter those out here.
1095    */
1096   if ((IFM_SUBTYPE(scp->ifm->ifm_media) == IFM_AUTO ||
1097        IFM_SUBTYPE(scp->ifm->ifm_media) == IFM_100_TX) && !scp->phy_ok)
1098     return (EINVAL);
1099
1100   xe_setmedia(scp);
1101
1102   return 0;
1103 }
1104
1105
1106 /*
1107  * Return current media selection.
1108  */
1109 static void
1110 xe_media_status(struct ifnet *ifp, struct ifmediareq *mrp) {
1111
1112 #ifdef XE_DEBUG
1113   printf("%s: media_status\n", ifp->if_xname);
1114 #endif
1115
1116   mrp->ifm_active = ((struct xe_softc *)ifp->if_softc)->media;
1117
1118   return;
1119 }
1120
1121
1122 /*
1123  * Select active media.
1124  */
1125 static void xe_setmedia(void *xscp) {
1126   struct xe_softc *scp = xscp;
1127   u_int16_t bmcr, bmsr, anar, lpar;
1128
1129 #ifdef XE_DEBUG
1130   device_printf(scp->dev, "setmedia\n");
1131 #endif
1132
1133   /* Cancel any pending timeout */
1134   untimeout(xe_setmedia, scp, scp->chand);
1135   xe_disable_intr(scp);
1136
1137   /* Select media */
1138   scp->media = IFM_ETHER;
1139   switch (IFM_SUBTYPE(scp->ifm->ifm_media)) {
1140
1141    case IFM_AUTO:       /* Autoselect media */
1142     scp->media = IFM_ETHER|IFM_AUTO;
1143
1144     /*
1145      * Autoselection is really awful.  It goes something like this:
1146      *
1147      * Wait until the transmitter goes idle (2sec timeout).
1148      * Reset card
1149      *   IF a 100Mbit PHY exists
1150      *     Start NWAY autonegotiation (3.5sec timeout)
1151      *     IF that succeeds
1152      *       Select 100baseTX or 10baseT, whichever was detected
1153      *     ELSE
1154      *       Reset card
1155      *       IF a 100Mbit PHY exists
1156      *         Try to force a 100baseTX link (3sec timeout)
1157      *         IF that succeeds
1158      *           Select 100baseTX
1159      *         ELSE
1160      *           Disable the PHY
1161      *         ENDIF
1162      *       ENDIF
1163      *     ENDIF
1164      *   ENDIF
1165      * IF nothing selected so far
1166      *   IF a 100Mbit PHY exists
1167      *     Select 10baseT
1168      *   ELSE
1169      *     Select 10baseT or 10base2, whichever is connected
1170      *   ENDIF
1171      * ENDIF
1172      */
1173     switch (scp->autoneg_status) {
1174
1175      case XE_AUTONEG_NONE:
1176 #if XE_DEBUG > 1
1177       device_printf(scp->dev, "Waiting for idle transmitter\n");
1178 #endif
1179       scp->arpcom.ac_if.if_flags |= IFF_OACTIVE;
1180       scp->autoneg_status = XE_AUTONEG_WAITING;
1181       scp->chand = timeout(xe_setmedia, scp, hz * 2);
1182       return;
1183
1184      case XE_AUTONEG_WAITING:
1185       xe_soft_reset(scp);
1186       if (scp->phy_ok) {
1187 #if XE_DEBUG > 1
1188         device_printf(scp->dev, "Starting autonegotiation\n");
1189 #endif
1190         bmcr = xe_phy_readreg(scp, PHY_BMCR);
1191         bmcr &= ~(PHY_BMCR_AUTONEGENBL);
1192         xe_phy_writereg(scp, PHY_BMCR, bmcr);
1193         anar = xe_phy_readreg(scp, PHY_ANAR);
1194         anar &= ~(PHY_ANAR_100BT4|PHY_ANAR_100BTXFULL|PHY_ANAR_10BTFULL);
1195         anar |= PHY_ANAR_100BTXHALF|PHY_ANAR_10BTHALF;
1196         xe_phy_writereg(scp, PHY_ANAR, anar);
1197         bmcr |= PHY_BMCR_AUTONEGENBL|PHY_BMCR_AUTONEGRSTR;
1198         xe_phy_writereg(scp, PHY_BMCR, bmcr);
1199         scp->autoneg_status = XE_AUTONEG_STARTED;
1200         scp->chand = timeout(xe_setmedia, scp, hz * 7/2);
1201         return;
1202       }
1203       else {
1204         scp->autoneg_status = XE_AUTONEG_FAIL;
1205       }
1206       break;
1207
1208      case XE_AUTONEG_STARTED:
1209       bmsr = xe_phy_readreg(scp, PHY_BMSR);
1210       lpar = xe_phy_readreg(scp, PHY_LPAR);
1211       if (bmsr & (PHY_BMSR_AUTONEGCOMP|PHY_BMSR_LINKSTAT)) {
1212 #if XE_DEBUG > 1
1213         device_printf(scp->dev, "Autonegotiation complete!\n");
1214 #endif
1215         /*
1216          * XXX - Shouldn't have to do this, but (on my hub at least) the
1217          * XXX - transmitter won't work after a successful autoneg.  So we see 
1218          * XXX - what the negotiation result was and force that mode.  I'm
1219          * XXX - sure there is an easy fix for this.
1220          */
1221         if (lpar & PHY_LPAR_100BTXHALF) {
1222           xe_phy_writereg(scp, PHY_BMCR, PHY_BMCR_SPEEDSEL);
1223           XE_MII_DUMP(scp);
1224           XE_SELECT_PAGE(2);
1225           XE_OUTB(XE_MSR, XE_INB(XE_MSR) | 0x08);
1226           scp->media = IFM_ETHER|IFM_100_TX;
1227           scp->autoneg_status = XE_AUTONEG_NONE;
1228         }
1229         else {
1230           /*
1231            * XXX - Bit of a hack going on in here.
1232            * XXX - This is derived from Ken Hughes patch to the Linux driver
1233            * XXX - to make it work with 10Mbit _autonegotiated_ links on CE3B
1234            * XXX - cards.  What's a CE3B and how's it differ from a plain CE3?
1235            * XXX - these are the things we need to find out.
1236            */
1237           xe_phy_writereg(scp, PHY_BMCR, 0x0000);
1238           XE_SELECT_PAGE(2);
1239           /* BEGIN HACK */
1240           XE_OUTB(XE_MSR, XE_INB(XE_MSR) | 0x08);
1241           XE_SELECT_PAGE(0x42);
1242           XE_OUTB(XE_SWC1, 0x80);
1243           scp->media = IFM_ETHER|IFM_10_T;
1244           scp->autoneg_status = XE_AUTONEG_NONE;
1245           /* END HACK */
1246           /*XE_OUTB(XE_MSR, XE_INB(XE_MSR) & ~0x08);*/  /* Disable PHY? */
1247           /*scp->autoneg_status = XE_AUTONEG_FAIL;*/
1248         }
1249       }
1250       else {
1251 #if XE_DEBUG > 1
1252         device_printf(scp->dev, "Autonegotiation failed; trying 100baseTX\n");
1253 #endif
1254         XE_MII_DUMP(scp);
1255         xe_soft_reset(scp);
1256         if (scp->phy_ok) {
1257           xe_phy_writereg(scp, PHY_BMCR, PHY_BMCR_SPEEDSEL);
1258           scp->autoneg_status = XE_AUTONEG_100TX;
1259           scp->chand = timeout(xe_setmedia, scp, hz * 3);
1260           return;
1261         }
1262         else {
1263           scp->autoneg_status = XE_AUTONEG_FAIL;
1264         }
1265       }
1266       break;
1267
1268      case XE_AUTONEG_100TX:
1269       (void)xe_phy_readreg(scp, PHY_BMSR);
1270       bmsr = xe_phy_readreg(scp, PHY_BMSR);
1271       if (bmsr & PHY_BMSR_LINKSTAT) {
1272 #if XE_DEBUG > 1
1273         device_printf(scp->dev, "Got 100baseTX link!\n");
1274 #endif
1275         XE_MII_DUMP(scp);
1276         XE_SELECT_PAGE(2);
1277         XE_OUTB(XE_MSR, XE_INB(XE_MSR) | 0x08);
1278         scp->media = IFM_ETHER|IFM_100_TX;
1279         scp->autoneg_status = XE_AUTONEG_NONE;
1280       }
1281       else {
1282 #if XE_DEBUG > 1
1283         device_printf(scp->dev, "Autonegotiation failed; disabling PHY\n");
1284 #endif
1285         XE_MII_DUMP(scp);
1286         xe_phy_writereg(scp, PHY_BMCR, 0x0000);
1287         XE_SELECT_PAGE(2);
1288         XE_OUTB(XE_MSR, XE_INB(XE_MSR) & ~0x08);        /* Disable PHY? */
1289         scp->autoneg_status = XE_AUTONEG_FAIL;
1290       }
1291       break;
1292     }
1293
1294     /*
1295      * If we got down here _and_ autoneg_status is XE_AUTONEG_FAIL, then
1296      * either autonegotiation failed, or never got started to begin with.  In
1297      * either case, select a suitable 10Mbit media and hope it works.  We
1298      * don't need to reset the card again, since it will have been done
1299      * already by the big switch above.
1300      */
1301     if (scp->autoneg_status == XE_AUTONEG_FAIL) {
1302 #if XE_DEBUG > 1
1303       device_printf(scp->dev, "Selecting 10baseX\n");
1304 #endif
1305       if (scp->mohawk) {
1306         XE_SELECT_PAGE(0x42);
1307         XE_OUTB(XE_SWC1, 0x80);
1308         scp->media = IFM_ETHER|IFM_10_T;
1309         scp->autoneg_status = XE_AUTONEG_NONE;
1310       }
1311       else {
1312         XE_SELECT_PAGE(4);
1313         XE_OUTB(XE_GPR0, 4);
1314         DELAY(50000);
1315         XE_SELECT_PAGE(0x42);
1316         XE_OUTB(XE_SWC1, (XE_INB(XE_ESR) & XE_ESR_MEDIA_SELECT) ? 0x80 : 0xc0);
1317         scp->media = IFM_ETHER|((XE_INB(XE_ESR) & XE_ESR_MEDIA_SELECT) ? IFM_10_T : IFM_10_2);
1318         scp->autoneg_status = XE_AUTONEG_NONE;
1319       }
1320     }
1321     break;
1322
1323
1324     /*
1325      * If a specific media has been requested, we just reset the card and
1326      * select it (one small exception -- if 100baseTX is requested by there is 
1327      * no PHY, we fall back to 10baseT operation).
1328      */
1329    case IFM_100_TX:     /* Force 100baseTX */
1330     xe_soft_reset(scp);
1331     if (scp->phy_ok) {
1332 #if XE_DEBUG > 1
1333       device_printf(scp->dev, "Selecting 100baseTX\n");
1334 #endif
1335       XE_SELECT_PAGE(0x42);
1336       XE_OUTB(XE_SWC1, 0);
1337       xe_phy_writereg(scp, PHY_BMCR, PHY_BMCR_SPEEDSEL);
1338       XE_SELECT_PAGE(2);
1339       XE_OUTB(XE_MSR, XE_INB(XE_MSR) | 0x08);
1340       scp->media |= IFM_100_TX;
1341       break;
1342     }
1343     /* FALLTHROUGH */
1344
1345    case IFM_10_T:       /* Force 10baseT */
1346     xe_soft_reset(scp);
1347 #if XE_DEBUG > 1
1348     device_printf(scp->dev, "Selecting 10baseT\n");
1349 #endif
1350     if (scp->phy_ok) {
1351       xe_phy_writereg(scp, PHY_BMCR, 0x0000);
1352       XE_SELECT_PAGE(2);
1353       XE_OUTB(XE_MSR, XE_INB(XE_MSR) & ~0x08);  /* Disable PHY */
1354     }
1355     XE_SELECT_PAGE(0x42);
1356     XE_OUTB(XE_SWC1, 0x80);
1357     scp->media |= IFM_10_T;
1358     break;
1359
1360    case IFM_10_2:
1361     xe_soft_reset(scp);
1362 #if XE_DEBUG > 1
1363     device_printf(scp->dev, "Selecting 10base2\n");
1364 #endif
1365     XE_SELECT_PAGE(0x42);
1366     XE_OUTB(XE_SWC1, 0xc0);
1367     scp->media |= IFM_10_2;
1368     break;
1369   }
1370
1371
1372   /*
1373    * Finally, the LEDs are set to match whatever media was chosen and the
1374    * transmitter is unblocked. 
1375    */
1376 #if XE_DEBUG > 1
1377   device_printf(scp->dev, "Setting LEDs\n");
1378 #endif
1379   XE_SELECT_PAGE(2);
1380   switch (IFM_SUBTYPE(scp->media)) {
1381    case IFM_100_TX:
1382    case IFM_10_T:
1383     XE_OUTB(XE_LED, 0x3b);
1384     if (scp->dingo)
1385       XE_OUTB(0x0b, 0x04);      /* 100Mbit LED */
1386     break;
1387
1388    case IFM_10_2:
1389     XE_OUTB(XE_LED, 0x3a);
1390     break;
1391   }
1392
1393   /* Restart output? */
1394   scp->ifp->if_flags &= ~IFF_OACTIVE;
1395   xe_init(scp);
1396 }
1397
1398
1399 /*
1400  * Hard reset (power cycle) the card.
1401  */
1402 static void
1403 xe_hard_reset(struct xe_softc *scp) {
1404   int s;
1405
1406 #ifdef XE_DEBUG
1407   device_printf(scp->dev, "hard_reset\n");
1408 #endif
1409
1410   s = splimp();
1411
1412   /*
1413    * Power cycle the card.
1414    */
1415   XE_SELECT_PAGE(4);
1416   XE_OUTB(XE_GPR1, 0);          /* Power off */
1417   DELAY(40000);
1418
1419   if (scp->mohawk)
1420     XE_OUTB(XE_GPR1, 1);        /* And back on again */
1421   else
1422     XE_OUTB(XE_GPR1, 5);        /* Also set AIC bit, whatever that is */
1423   DELAY(40000);
1424   XE_SELECT_PAGE(0);
1425
1426   (void)splx(s);
1427 }
1428
1429
1430 /*
1431  * Soft reset the card.  Also makes sure that the ML6692 and 10Mbit controller 
1432  * are powered up, sets the silicon revision number in softc, disables
1433  * interrupts and checks for the prescence of a 100Mbit PHY.  This should
1434  * leave us in a position where we can access the PHY and do media
1435  * selection. The function imposes a 0.5s delay while the hardware powers up.
1436  */
1437 static void
1438 xe_soft_reset(struct xe_softc *scp) {
1439   int s;
1440
1441 #ifdef XE_DEBUG
1442   device_printf(scp->dev, "soft_reset\n");
1443 #endif
1444
1445   s = splimp();
1446
1447   /*
1448    * Reset the card, (again).
1449    */
1450   XE_SELECT_PAGE(0);
1451   XE_OUTB(XE_CR, XE_CR_SOFT_RESET);
1452   DELAY(40000);
1453   XE_OUTB(XE_CR, 0);
1454   DELAY(40000);
1455
1456   if (scp->mohawk) {
1457     /*
1458      * set GP1 and GP2 as outputs (bits 2 & 3)
1459      * set GP1 low to power on the ML6692 (bit 0)
1460      * set GP2 high to power on the 10Mhz chip (bit 1)
1461      */
1462     XE_SELECT_PAGE(4);
1463     XE_OUTB(XE_GPR0, 0x0e);
1464   }
1465
1466   /*
1467    * Wait for everything to wake up.
1468    */
1469   DELAY(500000);
1470
1471   /*
1472    * Get silicon revision number.
1473    */
1474   XE_SELECT_PAGE(4);
1475   if (scp->mohawk)
1476     scp->srev = (XE_INB(XE_BOV) & 0x70) >> 4;
1477   else
1478     scp->srev = (XE_INB(XE_BOV) & 0x30) >> 4;
1479 #ifdef XE_DEBUG
1480   device_printf(scp->dev, "silicon revision = %d\n", scp->srev);
1481 #endif
1482   
1483   /*
1484    * Shut off interrupts.
1485    */
1486   xe_disable_intr(scp);
1487
1488   /*
1489    * Check for PHY.
1490    */
1491   if (scp->mohawk) {
1492     scp->phy_ok = xe_mii_init(scp);
1493   }
1494
1495   XE_SELECT_PAGE(0);
1496
1497   (void)splx(s);
1498 }
1499
1500
1501 /*
1502  * Take interface offline.  This is done by powering down the device, which I
1503  * assume means just shutting down the transceiver and Ethernet logic.  This
1504  * requires a _hard_ reset to recover from, as we need to power up again.
1505  */
1506 static void
1507 xe_stop(struct xe_softc *scp) {
1508   int s;
1509
1510 #ifdef XE_DEBUG
1511   device_printf(scp->dev, "stop\n");
1512 #endif
1513
1514   s = splimp();
1515
1516   /*
1517    * Shut off interrupts.
1518    */
1519   xe_disable_intr(scp);
1520
1521   /*
1522    * Power down.
1523    */
1524   XE_SELECT_PAGE(4);
1525   XE_OUTB(XE_GPR1, 0);
1526   XE_SELECT_PAGE(0);
1527
1528   /*
1529    * ~IFF_RUNNING == interface down.
1530    */
1531   scp->ifp->if_flags &= ~IFF_RUNNING;
1532   scp->ifp->if_flags &= ~IFF_OACTIVE;
1533   scp->ifp->if_timer = 0;
1534
1535   (void)splx(s);
1536 }
1537
1538
1539 /*
1540  * Enable Ethernet interrupts from the card.
1541  */
1542 static void
1543 xe_enable_intr(struct xe_softc *scp) {
1544 #ifdef XE_DEBUG
1545   device_printf(scp->dev, "enable_intr\n");
1546 #endif
1547
1548   XE_SELECT_PAGE(1);
1549   XE_OUTB(XE_IMR0, 0xff);               /* Unmask everything */
1550   XE_OUTB(XE_IMR1, 0x01);               /* Unmask TX underrun detection */
1551   DELAY(1);
1552
1553   XE_SELECT_PAGE(0);
1554   XE_OUTB(XE_CR, XE_CR_ENABLE_INTR);    /* Enable interrupts */
1555   if (scp->modem && !scp->dingo) {      /* This bit is just magic */
1556     if (!(XE_INB(0x10) & 0x01)) {
1557       XE_OUTB(0x10, 0x11);              /* Unmask master int enable bit */
1558     }
1559   }
1560 }
1561
1562
1563 /*
1564  * Disable all Ethernet interrupts from the card.
1565  */
1566 static void
1567 xe_disable_intr(struct xe_softc *scp) {
1568 #ifdef XE_DEBUG
1569   device_printf(scp->dev, "disable_intr\n");
1570 #endif
1571
1572   XE_SELECT_PAGE(0);
1573   XE_OUTB(XE_CR, 0);                    /* Disable interrupts */
1574   if (scp->modem && !scp->dingo) {      /* More magic (does this work?) */
1575     XE_OUTB(0x10, 0x10);                /* Mask the master int enable bit */
1576   }
1577
1578   XE_SELECT_PAGE(1);
1579   XE_OUTB(XE_IMR0, 0);                  /* Forbid all interrupts */
1580   XE_OUTB(XE_IMR1, 0);
1581   XE_SELECT_PAGE(0);
1582 }
1583
1584
1585 /*
1586  * Set up multicast filter and promiscuous mode
1587  */
1588 static void
1589 xe_setmulti(struct xe_softc *scp) {
1590   struct ifnet *ifp;
1591   struct ifmultiaddr *maddr;
1592   int count;
1593
1594   ifp = &scp->arpcom.ac_if;
1595   maddr = ifp->if_multiaddrs.lh_first;
1596
1597   /* Get length of multicast list */
1598   for (count = 0; maddr != NULL; maddr = maddr->ifma_link.le_next, count++);
1599
1600   if ((ifp->if_flags & IFF_PROMISC) || (ifp->if_flags & IFF_ALLMULTI) || (count > 9)) {
1601     /*
1602      * Go into promiscuous mode if either of the PROMISC or ALLMULTI flags are
1603      * set, or if we have been asked to deal with more than 9 multicast
1604      * addresses.  To do this: set MPE and PME in SWC1
1605      */
1606     XE_SELECT_PAGE(0x42);
1607     XE_OUTB(XE_SWC1, 0x06);
1608   }
1609   else if ((ifp->if_flags & IFF_MULTICAST) && (count > 0)) {
1610     /*
1611      * Program the filters for up to 9 addresses
1612      */
1613     XE_SELECT_PAGE(0x42);
1614     XE_OUTB(XE_SWC1, 0x01);
1615     XE_SELECT_PAGE(0x40);
1616     XE_OUTB(XE_CMD0, XE_CMD0_OFFLINE);
1617     /*xe_reg_dump(scp);*/
1618     xe_setaddrs(scp);
1619     /*xe_reg_dump(scp);*/
1620     XE_SELECT_PAGE(0x40);
1621     XE_OUTB(XE_CMD0, XE_CMD0_RX_ENABLE|XE_CMD0_ONLINE);
1622   }
1623   else {
1624     /*
1625      * No multicast operation (default)
1626      */
1627     XE_SELECT_PAGE(0x42);
1628     XE_OUTB(XE_SWC1, 0);
1629   }
1630   XE_SELECT_PAGE(0);
1631 }
1632
1633
1634 /*
1635  * Set up all on-chip addresses (for multicast).  AFAICS, there are 10
1636  * of these things; the first is our MAC address, the other 9 are mcast
1637  * addresses, padded with the MAC address if there aren't enough.
1638  * XXX - This doesn't work right, but I'm not sure why yet.  We seem to be
1639  * XXX - doing much the same as the Linux code, which is weird enough that
1640  * XXX - it's probably right (despite my earlier comments to the contrary).
1641  */
1642 static void
1643 xe_setaddrs(struct xe_softc *scp) {
1644   struct ifmultiaddr *maddr;
1645   u_int8_t *addr;
1646   u_int8_t page, slot, byte, i;
1647
1648   maddr = scp->arpcom.ac_if.if_multiaddrs.lh_first;
1649
1650   XE_SELECT_PAGE(page = 0x50);
1651
1652   for (slot = 0, byte = 8; slot < 10; slot++) {
1653
1654     if (slot == 0)
1655       addr = (u_int8_t *)(&scp->arpcom.ac_enaddr);
1656     else {
1657       while (maddr != NULL && maddr->ifma_addr->sa_family != AF_LINK)
1658         maddr = maddr->ifma_link.le_next;
1659       if (maddr != NULL)
1660         addr = LLADDR((struct sockaddr_dl *)maddr->ifma_addr);
1661       else
1662         addr = (u_int8_t *)(&scp->arpcom.ac_enaddr);
1663     }
1664
1665     for (i = 0; i < 6; i++, byte++) {
1666 #if XE_DEBUG > 2
1667       if (i)
1668         printf(":%x", addr[i]);
1669       else
1670         device_printf(scp->dev, "individual addresses %d: %x", slot, addr[0]);
1671 #endif
1672
1673       if (byte > 15) {
1674         page++;
1675         byte = 8;
1676         XE_SELECT_PAGE(page);
1677       }
1678
1679       if (scp->mohawk)
1680         XE_OUTB(byte, addr[5 - i]);
1681       else
1682         XE_OUTB(byte, addr[i]);
1683     }
1684 #if XE_DEBUG > 2
1685     printf("\n");
1686 #endif
1687   }
1688
1689   XE_SELECT_PAGE(0);
1690 }
1691
1692
1693 /*
1694  * Write an outgoing packet to the card using programmed I/O.
1695  */
1696 static int
1697 xe_pio_write_packet(struct xe_softc *scp, struct mbuf *mbp) {
1698   struct mbuf *mbp2;
1699   u_int16_t len, pad, free, ok;
1700   u_int8_t *data;
1701   u_int8_t savebyte[2], wantbyte;
1702
1703   /* Get total packet length */
1704   for (len = 0, mbp2 = mbp; mbp2 != NULL; len += mbp2->m_len, mbp2 = mbp2->m_next);
1705
1706   /* Packets < minimum length may need to be padded out */
1707   pad = 0;
1708   if (len < ETHER_MIN_LEN - ETHER_CRC_LEN) {
1709     pad = (ETHER_MIN_LEN - ETHER_CRC_LEN - len + 1) >> 1;
1710     len = ETHER_MIN_LEN - ETHER_CRC_LEN;
1711   }
1712
1713   /* Check transmit buffer space */
1714   XE_SELECT_PAGE(0);
1715   XE_OUTW(XE_TRS, len+2);
1716   free = XE_INW(XE_TSO);
1717   ok = free & 0x8000;
1718   free &= 0x7fff;
1719   if (free <= len + 2)
1720     return 1;
1721
1722   /* Send packet length to card */
1723   XE_OUTW(XE_EDP, len);
1724
1725   /*
1726    * Write packet to card using PIO (code stolen from the ed driver)
1727    */
1728   wantbyte = 0;
1729   while (mbp != NULL) {
1730     len = mbp->m_len;
1731     if (len > 0) {
1732       data = mtod(mbp, caddr_t);
1733       if (wantbyte) {           /* Finish the last word */
1734         savebyte[1] = *data;
1735         XE_OUTW(XE_EDP, *(u_short *)savebyte);
1736         data++;
1737         len--;
1738         wantbyte = 0;
1739       }
1740       if (len > 1) {            /* Output contiguous words */
1741         bus_space_write_multi_2(scp->bst, scp->bsh, XE_EDP, (u_int16_t *) data,
1742          len >> 1);
1743         data += len & ~1;
1744         len &= 1;
1745       }
1746       if (len == 1) {           /* Save last byte, if necessary */
1747         savebyte[0] = *data;
1748         wantbyte = 1;
1749       }
1750     }
1751     mbp = mbp->m_next;
1752   }
1753   if (wantbyte)                 /* Last byte for odd-length packets */
1754     XE_OUTW(XE_EDP, *(u_short *)savebyte);
1755
1756   /*
1757    * For CE3 cards, just tell 'em to send -- apparently the card will pad out
1758    * short packets with random cruft.  Otherwise, write nonsense words to fill 
1759    * out the packet.  I guess it is then sent automatically (?)
1760    */
1761   if (scp->mohawk)
1762     XE_OUTB(XE_CR, XE_CR_TX_PACKET|XE_CR_ENABLE_INTR);
1763   else
1764     while (pad > 0) {
1765       XE_OUTW(XE_EDP, 0xdead);
1766       pad--;
1767     }
1768
1769   return 0;
1770 }
1771
1772 #if 0
1773 /*
1774  * Compute the 32-bit Ethernet CRC for the given buffer.
1775  */
1776 static u_int32_t
1777 xe_compute_crc(u_int8_t *data, int len) {
1778   u_int32_t crc = 0xffffffff;
1779   u_int32_t poly = 0x04c11db6;
1780   u_int8_t current, crc31, bit;
1781   int i, k;
1782
1783   for (i = 0; i < len; i++) {
1784     current = data[i];
1785     for (k = 1; k <= 8; k++) {
1786       if (crc & 0x80000000) {
1787         crc31 = 0x01;
1788       }
1789       else {
1790         crc31 = 0;
1791       }
1792       bit = crc31 ^ (current & 0x01);
1793       crc <<= 1;
1794       current >>= 1;
1795       if (bit) {
1796         crc = (crc ^ poly)|1;
1797       }
1798     }
1799   }
1800   return crc;
1801 }
1802
1803
1804 /*
1805  * Convert a CRC into an index into the multicast hash table.  What we do is
1806  * take the most-significant 6 bits of the CRC, reverse them, and use that as
1807  * the bit number in the hash table.  Bits 5:3 of the result give the byte
1808  * within the table (0-7); bits 2:0 give the bit number within that byte (also 
1809  * 0-7), ie. the number of shifts needed to get it into the lsb position.
1810  */
1811 static int
1812 xe_compute_hashbit(u_int32_t crc) {
1813   u_int8_t hashbit = 0;
1814   int i;
1815
1816   for (i = 0; i < 6; i++) {
1817     hashbit >>= 1;
1818     if (crc & 0x80000000) {
1819       hashbit &= 0x80;
1820     }
1821     crc <<= 1;
1822   }
1823   return (hashbit >> 2);
1824 }
1825
1826 #endif
1827
1828
1829
1830 /**************************************************************
1831  *                                                            *
1832  *                  M I I  F U N C T I O N S                  *
1833  *                                                            *
1834  **************************************************************/
1835
1836 /*
1837  * Alternative MII/PHY handling code adapted from the xl driver.  It doesn't
1838  * seem to work any better than the xirc2_ps stuff, but it's cleaner code.
1839  * XXX - this stuff shouldn't be here.  It should all be abstracted off to
1840  * XXX - some kind of common MII-handling code, shared by all drivers.  But
1841  * XXX - that's a whole other mission.
1842  */
1843 #define XE_MII_SET(x)   XE_OUTB(XE_GPR2, (XE_INB(XE_GPR2) | 0x04) | (x))
1844 #define XE_MII_CLR(x)   XE_OUTB(XE_GPR2, (XE_INB(XE_GPR2) | 0x04) & ~(x))
1845
1846
1847 /*
1848  * Sync the PHYs by setting data bit and strobing the clock 32 times.
1849  */
1850 static void
1851 xe_mii_sync(struct xe_softc *scp) {
1852   int i;
1853
1854   XE_SELECT_PAGE(2);
1855   XE_MII_SET(XE_MII_DIR|XE_MII_WRD);
1856
1857   for (i = 0; i < 32; i++) {
1858     XE_MII_SET(XE_MII_CLK);
1859     DELAY(1);
1860     XE_MII_CLR(XE_MII_CLK);
1861     DELAY(1);
1862   }
1863 }
1864
1865
1866 /*
1867  * Look for a MII-compliant PHY.  If we find one, reset it.
1868  */
1869 static int
1870 xe_mii_init(struct xe_softc *scp) {
1871   u_int16_t status;
1872
1873   status = xe_phy_readreg(scp, PHY_BMSR);
1874   if ((status & 0xff00) != 0x7800) {
1875 #if XE_DEBUG > 1
1876     device_printf(scp->dev, "no PHY found, %0x\n", status);
1877 #endif
1878     return 0;
1879   }
1880   else {
1881 #if XE_DEBUG > 1
1882     device_printf(scp->dev, "PHY OK!\n");
1883 #endif
1884
1885     /* Reset the PHY */
1886     xe_phy_writereg(scp, PHY_BMCR, PHY_BMCR_RESET);
1887     DELAY(500);
1888     while(xe_phy_readreg(scp, PHY_BMCR) & PHY_BMCR_RESET);
1889     XE_MII_DUMP(scp);
1890     return 1;
1891   }
1892 }
1893
1894
1895 /*
1896  * Clock a series of bits through the MII.
1897  */
1898 static void
1899 xe_mii_send(struct xe_softc *scp, u_int32_t bits, int cnt) {
1900   int i;
1901
1902   XE_SELECT_PAGE(2);
1903   XE_MII_CLR(XE_MII_CLK);
1904   
1905   for (i = (0x1 << (cnt - 1)); i; i >>= 1) {
1906     if (bits & i) {
1907       XE_MII_SET(XE_MII_WRD);
1908     } else {
1909       XE_MII_CLR(XE_MII_WRD);
1910     }
1911     DELAY(1);
1912     XE_MII_CLR(XE_MII_CLK);
1913     DELAY(1);
1914     XE_MII_SET(XE_MII_CLK);
1915   }
1916 }
1917
1918
1919 /*
1920  * Read an PHY register through the MII.
1921  */
1922 static int
1923 xe_mii_readreg(struct xe_softc *scp, struct xe_mii_frame *frame) {
1924   int i, ack, s;
1925
1926   s = splimp();
1927
1928   /*
1929    * Set up frame for RX.
1930    */
1931   frame->mii_stdelim = XE_MII_STARTDELIM;
1932   frame->mii_opcode = XE_MII_READOP;
1933   frame->mii_turnaround = 0;
1934   frame->mii_data = 0;
1935         
1936   XE_SELECT_PAGE(2);
1937   XE_OUTB(XE_GPR2, 0);
1938
1939   /*
1940    * Turn on data xmit.
1941    */
1942   XE_MII_SET(XE_MII_DIR);
1943
1944   xe_mii_sync(scp);
1945
1946   /*    
1947    * Send command/address info.
1948    */
1949   xe_mii_send(scp, frame->mii_stdelim, 2);
1950   xe_mii_send(scp, frame->mii_opcode, 2);
1951   xe_mii_send(scp, frame->mii_phyaddr, 5);
1952   xe_mii_send(scp, frame->mii_regaddr, 5);
1953
1954   /* Idle bit */
1955   XE_MII_CLR((XE_MII_CLK|XE_MII_WRD));
1956   DELAY(1);
1957   XE_MII_SET(XE_MII_CLK);
1958   DELAY(1);
1959
1960   /* Turn off xmit. */
1961   XE_MII_CLR(XE_MII_DIR);
1962
1963   /* Check for ack */
1964   XE_MII_CLR(XE_MII_CLK);
1965   DELAY(1);
1966   ack = XE_INB(XE_GPR2) & XE_MII_RDD;
1967   XE_MII_SET(XE_MII_CLK);
1968   DELAY(1);
1969
1970   /*
1971    * Now try reading data bits. If the ack failed, we still
1972    * need to clock through 16 cycles to keep the PHY(s) in sync.
1973    */
1974   if (ack) {
1975     for(i = 0; i < 16; i++) {
1976       XE_MII_CLR(XE_MII_CLK);
1977       DELAY(1);
1978       XE_MII_SET(XE_MII_CLK);
1979       DELAY(1);
1980     }
1981     goto fail;
1982   }
1983
1984   for (i = 0x8000; i; i >>= 1) {
1985     XE_MII_CLR(XE_MII_CLK);
1986     DELAY(1);
1987     if (!ack) {
1988       if (XE_INB(XE_GPR2) & XE_MII_RDD)
1989         frame->mii_data |= i;
1990       DELAY(1);
1991     }
1992     XE_MII_SET(XE_MII_CLK);
1993     DELAY(1);
1994   }
1995
1996 fail:
1997
1998   XE_MII_CLR(XE_MII_CLK);
1999   DELAY(1);
2000   XE_MII_SET(XE_MII_CLK);
2001   DELAY(1);
2002
2003   splx(s);
2004
2005   if (ack)
2006     return(1);
2007   return(0);
2008 }
2009
2010
2011 /*
2012  * Write to a PHY register through the MII.
2013  */
2014 static int
2015 xe_mii_writereg(struct xe_softc *scp, struct xe_mii_frame *frame) {
2016   int s;
2017
2018   s = splimp();
2019
2020   /*
2021    * Set up frame for TX.
2022    */
2023   frame->mii_stdelim = XE_MII_STARTDELIM;
2024   frame->mii_opcode = XE_MII_WRITEOP;
2025   frame->mii_turnaround = XE_MII_TURNAROUND;
2026         
2027   XE_SELECT_PAGE(2);
2028
2029   /*            
2030    * Turn on data output.
2031    */
2032   XE_MII_SET(XE_MII_DIR);
2033
2034   xe_mii_sync(scp);
2035
2036   xe_mii_send(scp, frame->mii_stdelim, 2);
2037   xe_mii_send(scp, frame->mii_opcode, 2);
2038   xe_mii_send(scp, frame->mii_phyaddr, 5);
2039   xe_mii_send(scp, frame->mii_regaddr, 5);
2040   xe_mii_send(scp, frame->mii_turnaround, 2);
2041   xe_mii_send(scp, frame->mii_data, 16);
2042
2043   /* Idle bit. */
2044   XE_MII_SET(XE_MII_CLK);
2045   DELAY(1);
2046   XE_MII_CLR(XE_MII_CLK);
2047   DELAY(1);
2048
2049   /*
2050    * Turn off xmit.
2051    */
2052   XE_MII_CLR(XE_MII_DIR);
2053
2054   splx(s);
2055
2056   return(0);
2057 }
2058
2059
2060 /*
2061  * Read a register from the PHY.
2062  */
2063 static u_int16_t
2064 xe_phy_readreg(struct xe_softc *scp, u_int16_t reg) {
2065   struct xe_mii_frame frame;
2066
2067   bzero((char *)&frame, sizeof(frame));
2068
2069   frame.mii_phyaddr = 0;
2070   frame.mii_regaddr = reg;
2071   xe_mii_readreg(scp, &frame);
2072
2073   return(frame.mii_data);
2074 }
2075
2076
2077 /*
2078  * Write to a PHY register.
2079  */
2080 static void
2081 xe_phy_writereg(struct xe_softc *scp, u_int16_t reg, u_int16_t data) {
2082   struct xe_mii_frame frame;
2083
2084   bzero((char *)&frame, sizeof(frame));
2085
2086   frame.mii_phyaddr = 0;
2087   frame.mii_regaddr = reg;
2088   frame.mii_data = data;
2089   xe_mii_writereg(scp, &frame);
2090
2091   return;
2092 }
2093
2094
2095 #ifdef XE_DEBUG
2096 /*
2097  * A bit of debugging code.
2098  */
2099 static void
2100 xe_mii_dump(struct xe_softc *scp) {
2101   int i, s;
2102
2103   s = splimp();
2104
2105   device_printf(scp->dev, "MII registers: ");
2106   for (i = 0; i < 2; i++) {
2107     printf(" %d:%04x", i, xe_phy_readreg(scp, i));
2108   }
2109   for (i = 4; i < 7; i++) {
2110     printf(" %d:%04x", i, xe_phy_readreg(scp, i));
2111   }
2112   printf("\n");
2113
2114   (void)splx(s);
2115 }
2116
2117 static void
2118 xe_reg_dump(struct xe_softc *scp) {
2119   int page, i, s;
2120
2121   s = splimp();
2122
2123   device_printf(scp->dev, "Common registers: ");
2124   for (i = 0; i < 8; i++) {
2125     printf(" %2.2x", XE_INB(i));
2126   }
2127   printf("\n");
2128
2129   for (page = 0; page <= 8; page++) {
2130     device_printf(scp->dev, "Register page %2.2x: ", page);
2131     XE_SELECT_PAGE(page);
2132     for (i = 8; i < 16; i++) {
2133       printf(" %2.2x", XE_INB(i));
2134     }
2135     printf("\n");
2136   }
2137
2138   for (page = 0x10; page < 0x5f; page++) {
2139     if ((page >= 0x11 && page <= 0x3f) ||
2140         (page == 0x41) ||
2141         (page >= 0x43 && page <= 0x4f) ||
2142         (page >= 0x59))
2143       continue;
2144     device_printf(scp->dev, "Register page %2.2x: ", page);
2145     XE_SELECT_PAGE(page);
2146     for (i = 8; i < 16; i++) {
2147       printf(" %2.2x", XE_INB(i));
2148     }
2149     printf("\n");
2150   }
2151
2152   (void)splx(s);
2153 }
2154 #endif
2155
2156 int
2157 xe_activate(device_t dev)
2158 {
2159         struct xe_softc *sc = device_get_softc(dev);
2160         int start, err;
2161
2162         if (!sc->dingo) {
2163                 sc->port_rid = 0;       /* 0 is managed by pccard */
2164                 sc->port_res = bus_alloc_resource(dev, SYS_RES_IOPORT,
2165                     &sc->port_rid, 0, ~0, 16, RF_ACTIVE);
2166         } else {
2167                 /*
2168                  * Find a 16 byte aligned ioport for the card.
2169                  */
2170 #if XE_DEBUG > 0
2171                 device_printf(dev, "Finding an aligned port for RealPort\n");
2172 #endif /* XE_DEBUG */
2173                 sc->port_rid = 1;       /* 0 is managed by pccard */
2174                 start = 0x100;
2175                 do {
2176                         sc->port_res = bus_alloc_resource(dev,
2177                             SYS_RES_IOPORT, &sc->port_rid, start, 0x3ff, 16,
2178                             RF_ACTIVE);
2179                         if (sc->port_res == 0)
2180                                 break;          /* we failed */
2181                         if ((rman_get_start(sc->port_res) & 0xf) == 0)
2182                                 break;          /* good */
2183                         bus_release_resource(dev, SYS_RES_IOPORT, sc->port_rid, 
2184                             sc->port_res);
2185                         start = (rman_get_start(sc->port_res) + 15) & ~0xf;
2186                 } while (1);
2187 #if XE_DEBUG > 2
2188                 device_printf(dev, "port 0x%0lx, size 0x%0lx\n",
2189                     bus_get_resource_start(dev, SYS_RES_IOPORT, sc->port_rid),
2190                     bus_get_resource_count(dev, SYS_RES_IOPORT, sc->port_rid));
2191 #endif /* XE_DEBUG */
2192         }
2193         if (!sc->port_res) {
2194 #if XE_DEBUG > 0
2195                 device_printf(dev, "Cannot allocate ioport\n");
2196 #endif          
2197                 return ENOMEM;
2198         }
2199
2200         sc->irq_rid = 0;
2201         sc->irq_res = bus_alloc_resource(dev, SYS_RES_IRQ, &sc->irq_rid, 
2202             0, ~0, 1, RF_ACTIVE);
2203         if (!sc->irq_res) {
2204 #if XE_DEBUG > 0
2205                 device_printf(dev, "Cannot allocate irq\n");
2206 #endif
2207                 xe_deactivate(dev);
2208                 return ENOMEM;
2209         }
2210         if ((err = bus_setup_intr(dev, sc->irq_res, INTR_TYPE_NET, xe_intr, sc,
2211             &sc->intrhand)) != 0) {
2212                 xe_deactivate(dev);
2213                 return err;
2214         }
2215
2216         sc->bst = rman_get_bustag(sc->port_res);
2217         sc->bsh = rman_get_bushandle(sc->port_res);
2218         return (0);
2219 }
2220
2221 void
2222 xe_deactivate(device_t dev)
2223 {
2224         struct xe_softc *sc = device_get_softc(dev);
2225         
2226         if (sc->intrhand)
2227                 bus_teardown_intr(dev, sc->irq_res, sc->intrhand);
2228         sc->intrhand = 0;
2229         if (sc->port_res)
2230                 bus_release_resource(dev, SYS_RES_IOPORT, sc->port_rid, 
2231                     sc->port_res);
2232         sc->port_res = 0;
2233         if (sc->irq_res)
2234                 bus_release_resource(dev, SYS_RES_IRQ, sc->irq_rid, 
2235                     sc->irq_res);
2236         sc->irq_res = 0;
2237         return;
2238 }
2239
2240 static device_method_t xe_pccard_methods[] = {
2241         /* Device interface */
2242         DEVMETHOD(device_probe,         xe_probe),
2243         DEVMETHOD(device_attach,        xe_attach),
2244         DEVMETHOD(device_detach,        xe_detach),
2245
2246         { 0, 0 }
2247 };
2248
2249 static driver_t xe_pccard_driver = {
2250         "xe",
2251         xe_pccard_methods,
2252         sizeof(struct xe_softc),
2253 };
2254
2255 devclass_t xe_devclass;
2256
2257 DECLARE_DUMMY_MODULE(if_xe);
2258 DRIVER_MODULE(if_xe, pccard, xe_pccard_driver, xe_devclass, 0, 0);
2259