sys/dev/netif/fe/if_fe.c

   1 /*
   2  * All Rights Reserved, Copyright (C) Fujitsu Limited 1995
   3  *
   4  * This software may be used, modified, copied, distributed, and sold, in
   5  * both source and binary form provided that the above copyright, these
   6  * terms and the following disclaimer are retained.  The name of the author
   7  * and/or the contributor may not be used to endorse or promote products
   8  * derived from this software without specific prior written permission.
   9  *
  10  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND THE CONTRIBUTOR ``AS IS'' AND
  11  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  12  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  13  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR THE CONTRIBUTOR BE LIABLE
  14  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  15  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  16  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION.
  17  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  18  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  19  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  20  * SUCH DAMAGE.
  21  */
  22
  23 /*
  24  * $FreeBSD: src/sys/dev/fe/if_fe.c,v 1.65.2.1 2000/09/22 10:01:47 nyan Exp $
  25  * $DragonFly: src/sys/dev/netif/fe/if_fe.c,v 1.14 2005/05/24 09:52:13 joerg Exp $
  26  *
  27  * Device driver for Fujitsu MB86960A/MB86965A based Ethernet cards.
  28  * Contributed by M. Sekiguchi. <seki@sysrap.cs.fujitsu.co.jp>
  29  *
  30  * This version is intended to be a generic template for various
  31  * MB86960A/MB86965A based Ethernet cards.  It currently supports
  32  * Fujitsu FMV-180 series for ISA and Allied-Telesis AT1700/RE2000
  33  * series for ISA, as well as Fujitsu MBH10302 PC card.
  34  * There are some currently-
  35  * unused hooks embedded, which are primarily intended to support
  36  * other types of Ethernet cards, but the author is not sure whether
  37  * they are useful.
  38  *
  39  * This version also includes some alignments to support RE1000,
  40  * C-NET(98)P2 and so on. These cards are not for AT-compatibles,
  41  * but for NEC PC-98 bus -- a proprietary bus architecture available
  42  * only in Japan. Confusingly, it is different from the Microsoft's
  43  * PC98 architecture. :-{
  44  * Further work for PC-98 version will be available as a part of
  45  * FreeBSD(98) project.
  46  *
  47  * This software is a derivative work of if_ed.c version 1.56 by David
  48  * Greenman available as a part of FreeBSD 2.0 RELEASE source distribution.
  49  *
  50  * The following lines are retained from the original if_ed.c:
  51  *
  52  * Copyright (C) 1993, David Greenman. This software may be used, modified,
  53  *   copied, distributed, and sold, in both source and binary form provided
  54  *   that the above copyright and these terms are retained. Under no
  55  *   circumstances is the author responsible for the proper functioning
  56  *   of this software, nor does the author assume any responsibility
  57  *   for damages incurred with its use.
  58  */
  59
  60 /*
  61  * TODO:
  62  *  o   To support ISA PnP auto configuration for FMV-183/184.
  63  *  o   To support REX-9886/87(PC-98 only).
  64  *  o   To reconsider mbuf usage.
  65  *  o   To reconsider transmission buffer usage, including
  66  *      transmission buffer size (currently 4KB x 2) and pros-and-
  67  *      cons of multiple frame transmission.
  68  *  o   To test IPX codes.
  69  *  o   To test new-bus frontend.
  70  */
  71
  72 #include "opt_fe.h"
  73 #include "opt_inet.h"
  74 #include "opt_ipx.h"
  75
  76 #include <sys/param.h>
  77 #include <sys/systm.h>
  78 #include <sys/socket.h>
  79 #include <sys/sockio.h>
  80 #include <sys/mbuf.h>
  81 #include <sys/interrupt.h>
  82 #include <sys/linker_set.h>
  83 #include <sys/module.h>
  84 #include <machine/clock.h>
  85
  86 #include <sys/bus.h>
  87 #include <machine/bus.h>
  88 #include <sys/rman.h>
  89 #include <machine/resource.h>
  90
  91 #include <net/ethernet.h>
  92 #include <net/if.h>
  93 #include <net/ifq_var.h>
  94 #include <net/if_dl.h>
  95 #include <net/if_mib.h>
  96 #include <net/if_media.h>
  97
  98 #include <netinet/in.h>
  99 #include <netinet/if_ether.h>
 100
 101 #include <net/bpf.h>
 102
 103 #include <i386/isa/ic/mb86960.h>
 104 #include "if_fereg.h"
 105 #include "if_fevar.h"
 106
 107 /*
 108  * Transmit just one packet per a "send" command to 86960.
 109  * This option is intended for performance test.  An EXPERIMENTAL option.
 110  */
 111 #ifndef FE_SINGLE_TRANSMISSION
 112 #define FE_SINGLE_TRANSMISSION 0
 113 #endif
 114
 115 /*
 116  * Maximum loops when interrupt.
 117  * This option prevents an infinite loop due to hardware failure.
 118  * (Some laptops make an infinite loop after PC-Card is ejected.)
 119  */
 120 #ifndef FE_MAX_LOOP
 121 #define FE_MAX_LOOP 0x800
 122 #endif
 123
 124 /*
 125  * If you define this option, 8-bit cards are also supported.
 126  */
 127 /*#define FE_8BIT_SUPPORT*/
 128
 129 /*
 130  * Device configuration flags.
 131  */
 132
 133 /* DLCR6 settings.  */
 134 #define FE_FLAGS_DLCR6_VALUE    0x007F
 135
 136 /* Force DLCR6 override.  */
 137 #define FE_FLAGS_OVERRIDE_DLCR6 0x0080
 138
 139
 140 devclass_t fe_devclass;
 141
 142 /*
 143  * Special filter values.
 144  */
 145 static struct fe_filter const fe_filter_nothing = { FE_FILTER_NOTHING };
 146 static struct fe_filter const fe_filter_all     = { FE_FILTER_ALL };
 147
 148 /* Standard driver entry points.  These can be static.  */
 149 static void             fe_init         (void *);
 150 static inthand2_t       fe_intr;
 151 static int              fe_ioctl        (struct ifnet *, u_long, caddr_t,
 152                                          struct ucred *);
 153 static void             fe_start        (struct ifnet *);
 154 static void             fe_watchdog     (struct ifnet *);
 155 static int              fe_medchange    (struct ifnet *);
 156 static void             fe_medstat      (struct ifnet *, struct ifmediareq *);
 157
 158 /* Local functions.  Order of declaration is confused.  FIXME.  */
 159 static int      fe_get_packet   ( struct fe_softc *, u_short );
 160 static void     fe_tint         ( struct fe_softc *, u_char );
 161 static void     fe_rint         ( struct fe_softc *, u_char );
 162 static void     fe_xmit         ( struct fe_softc * );
 163 static void     fe_write_mbufs  ( struct fe_softc *, struct mbuf * );
 164 static void     fe_setmode      ( struct fe_softc * );
 165 static void     fe_loadmar      ( struct fe_softc * );
 166
 167 #ifdef DIAGNOSTIC
 168 static void     fe_emptybuffer  ( struct fe_softc * );
 169 #endif
 170
 171 DECLARE_DUMMY_MODULE(if_fe);
 172
 173 /*
 174  * Fe driver specific constants which relate to 86960/86965.
 175  */
 176
 177 /* Interrupt masks  */
 178 #define FE_TMASK ( FE_D2_COLL16 | FE_D2_TXDONE )
 179 #define FE_RMASK ( FE_D3_OVRFLO | FE_D3_CRCERR \
 180                  | FE_D3_ALGERR | FE_D3_SRTPKT | FE_D3_PKTRDY )
 181
 182 /* Maximum number of iterations for a receive interrupt.  */
 183 #define FE_MAX_RECV_COUNT ( ( 65536 - 2048 * 2 ) / 64 )
 184         /*
 185          * Maximum size of SRAM is 65536,
 186          * minimum size of transmission buffer in fe is 2x2KB,
 187          * and minimum amount of received packet including headers
 188          * added by the chip is 64 bytes.
 189          * Hence FE_MAX_RECV_COUNT is the upper limit for number
 190          * of packets in the receive buffer.
 191          */
 192
 193 /*
 194  * Miscellaneous definitions not directly related to hardware.
 195  */
 196
 197 /* The following line must be delete when "net/if_media.h" support it.  */
 198 #ifndef IFM_10_FL
 199 #define IFM_10_FL       /* 13 */ IFM_10_5
 200 #endif
 201
 202 #if 0
 203 /* Mapping between media bitmap (in fe_softc.mbitmap) and ifm_media.  */
 204 static int const bit2media [] = {
 205                         IFM_HDX | IFM_ETHER | IFM_AUTO,
 206                         IFM_HDX | IFM_ETHER | IFM_MANUAL,
 207                         IFM_HDX | IFM_ETHER | IFM_10_T,
 208                         IFM_HDX | IFM_ETHER | IFM_10_2,
 209                         IFM_HDX | IFM_ETHER | IFM_10_5,
 210                         IFM_HDX | IFM_ETHER | IFM_10_FL,
 211                         IFM_FDX | IFM_ETHER | IFM_10_T,
 212         /* More can be come here... */
 213                         0
 214 };
 215 #else
 216 /* Mapping between media bitmap (in fe_softc.mbitmap) and ifm_media.  */
 217 static int const bit2media [] = {
 218                         IFM_ETHER | IFM_AUTO,
 219                         IFM_ETHER | IFM_MANUAL,
 220                         IFM_ETHER | IFM_10_T,
 221                         IFM_ETHER | IFM_10_2,
 222                         IFM_ETHER | IFM_10_5,
 223                         IFM_ETHER | IFM_10_FL,
 224                         IFM_ETHER | IFM_10_T,
 225         /* More can be come here... */
 226                         0
 227 };
 228 #endif
 229
 230 /*
 231  * Check for specific bits in specific registers have specific values.
 232  * A common utility function called from various sub-probe routines.
 233  */
 234 int
 235 fe_simple_probe (struct fe_softc const * sc,
 236                  struct fe_simple_probe_struct const * sp)
 237 {
 238         struct fe_simple_probe_struct const *p;
 239
 240         for (p  = sp; p->mask != 0; p++) {
 241                 if ((fe_inb(sc, p->port) & p->mask) != p->bits)
 242                         return 0;
 243         }
 244         return 1;
 245 }
 246
 247 /* Test if a given 6 byte value is a valid Ethernet station (MAC)
 248    address.  "Vendor" is an expected vendor code (first three bytes,)
 249    or a zero when nothing expected.  */
 250 int
 251 valid_Ether_p (u_char const * addr, unsigned vendor)
 252 {
 253 #ifdef FE_DEBUG
 254         printf("fe?: validating %6D against %06x\n", addr, ":", vendor);
 255 #endif
 256
 257         /* All zero is not allowed as a vendor code.  */
 258         if (addr[0] == 0 && addr[1] == 0 && addr[2] == 0) return 0;
 259
 260         switch (vendor) {
 261             case 0x000000:
 262                 /* Legal Ethernet address (stored in ROM) must have
 263                    its Group and Local bits cleared.  */
 264                 if ((addr[0] & 0x03) != 0) return 0;
 265                 break;
 266             case 0x020000:
 267                 /* Same as above, but a local address is allowed in
 268                    this context.  */
 269                 if ((addr[0] & 0x01) != 0) return 0;
 270                 break;
 271             default:
 272                 /* Make sure the vendor part matches if one is given.  */
 273                 if (   addr[0] != ((vendor >> 16) & 0xFF)
 274                     || addr[1] != ((vendor >>  8) & 0xFF)
 275                     || addr[2] != ((vendor      ) & 0xFF)) return 0;
 276                 break;
 277         }
 278
 279         /* Host part must not be all-zeros nor all-ones.  */
 280         if (addr[3] == 0xFF && addr[4] == 0xFF && addr[5] == 0xFF) return 0;
 281         if (addr[3] == 0x00 && addr[4] == 0x00 && addr[5] == 0x00) return 0;
 282
 283         /* Given addr looks like an Ethernet address.  */
 284         return 1;
 285 }
 286
 287 /* Fill our softc struct with default value.  */
 288 void
 289 fe_softc_defaults (struct fe_softc *sc)
 290 {
 291         /* Prepare for typical register prototypes.  We assume a
 292            "typical" board has <32KB> of <fast> SRAM connected with a
 293            <byte-wide> data lines.  */
 294         sc->proto_dlcr4 = FE_D4_LBC_DISABLE | FE_D4_CNTRL;
 295         sc->proto_dlcr5 = 0;
 296         sc->proto_dlcr6 = FE_D6_BUFSIZ_32KB | FE_D6_TXBSIZ_2x4KB
 297                 | FE_D6_BBW_BYTE | FE_D6_SBW_WORD | FE_D6_SRAM_100ns;
 298         sc->proto_dlcr7 = FE_D7_BYTSWP_LH;
 299         sc->proto_bmpr13 = 0;
 300
 301         /* Assume the probe process (to be done later) is stable.  */
 302         sc->stability = 0;
 303
 304         /* A typical board needs no hooks.  */
 305         sc->init = NULL;
 306         sc->stop = NULL;
 307
 308         /* Assume the board has no software-controllable media selection.  */
 309         sc->mbitmap = MB_HM;
 310         sc->defmedia = MB_HM;
 311         sc->msel = NULL;
 312 }
 313
 314 /* Common error reporting routine used in probe routines for
 315    "soft configured IRQ"-type boards.  */
 316 void
 317 fe_irq_failure (char const *name, int unit, int irq, char const *list)
 318 {
 319         printf("fe%d: %s board is detected, but %s IRQ was given\n",
 320                unit, name, (irq == NO_IRQ ? "no" : "invalid"));
 321         if (list != NULL) {
 322                 printf("fe%d: specify an IRQ from %s in kernel config\n",
 323                        unit, list);
 324         }
 325 }
 326
 327 /*
 328  * Hardware (vendor) specific hooks.
 329  */
 330
 331 /*
 332  * Generic media selection scheme for MB86965 based boards.
 333  */
 334 void
 335 fe_msel_965 (struct fe_softc *sc)
 336 {
 337         u_char b13;
 338
 339         /* Find the appropriate bits for BMPR13 tranceiver control.  */
 340         switch (IFM_SUBTYPE(sc->media.ifm_media)) {
 341             case IFM_AUTO: b13 = FE_B13_PORT_AUTO | FE_B13_TPTYPE_UTP; break;
 342             case IFM_10_T: b13 = FE_B13_PORT_TP   | FE_B13_TPTYPE_UTP; break;
 343             default:       b13 = FE_B13_PORT_AUI;  break;
 344         }
 345
 346         /* Write it into the register.  It takes effect immediately.  */
 347         fe_outb(sc, FE_BMPR13, sc->proto_bmpr13 | b13);
 348 }
 349
 350
 351 /*
 352  * Fujitsu MB86965 JLI mode support routines.
 353  */
 354
 355 /*
 356  * Routines to read all bytes from the config EEPROM through MB86965A.
 357  * It is a MicroWire (3-wire) serial EEPROM with 6-bit address.
 358  * (93C06 or 93C46.)
 359  */
 360 static void
 361 fe_strobe_eeprom_jli (struct fe_softc *sc, u_short bmpr16)
 362 {
 363         /*
 364          * We must guarantee 1us (or more) interval to access slow
 365          * EEPROMs.  The following redundant code provides enough
 366          * delay with ISA timing.  (Even if the bus clock is "tuned.")
 367          * Some modification will be needed on faster busses.
 368          */
 369         fe_outb(sc, bmpr16, FE_B16_SELECT);
 370         fe_outb(sc, bmpr16, FE_B16_SELECT | FE_B16_CLOCK);
 371         fe_outb(sc, bmpr16, FE_B16_SELECT | FE_B16_CLOCK);
 372         fe_outb(sc, bmpr16, FE_B16_SELECT);
 373 }
 374
 375 void
 376 fe_read_eeprom_jli (struct fe_softc * sc, u_char * data)
 377 {
 378         u_char n, val, bit;
 379         u_char save16, save17;
 380
 381         /* Save the current value of the EEPROM interface registers.  */
 382         save16 = fe_inb(sc, FE_BMPR16);
 383         save17 = fe_inb(sc, FE_BMPR17);
 384
 385         /* Read bytes from EEPROM; two bytes per an iteration.  */
 386         for (n = 0; n < JLI_EEPROM_SIZE / 2; n++) {
 387
 388                 /* Reset the EEPROM interface.  */
 389                 fe_outb(sc, FE_BMPR16, 0x00);
 390                 fe_outb(sc, FE_BMPR17, 0x00);
 391
 392                 /* Start EEPROM access.  */
 393                 fe_outb(sc, FE_BMPR16, FE_B16_SELECT);
 394                 fe_outb(sc, FE_BMPR17, FE_B17_DATA);
 395                 fe_strobe_eeprom_jli(sc, FE_BMPR16);
 396
 397                 /* Pass the iteration count as well as a READ command.  */
 398                 val = 0x80 | n;
 399                 for (bit = 0x80; bit != 0x00; bit >>= 1) {
 400                         fe_outb(sc, FE_BMPR17, (val & bit) ? FE_B17_DATA : 0);
 401                         fe_strobe_eeprom_jli(sc, FE_BMPR16);
 402                 }
 403                 fe_outb(sc, FE_BMPR17, 0x00);
 404
 405                 /* Read a byte.  */
 406                 val = 0;
 407                 for (bit = 0x80; bit != 0x00; bit >>= 1) {
 408                         fe_strobe_eeprom_jli(sc, FE_BMPR16);
 409                         if (fe_inb(sc, FE_BMPR17) & FE_B17_DATA)
 410                                 val |= bit;
 411                 }
 412                 *data++ = val;
 413
 414                 /* Read one more byte.  */
 415                 val = 0;
 416                 for (bit = 0x80; bit != 0x00; bit >>= 1) {
 417                         fe_strobe_eeprom_jli(sc, FE_BMPR16);
 418                         if (fe_inb(sc, FE_BMPR17) & FE_B17_DATA)
 419                                 val |= bit;
 420                 }
 421                 *data++ = val;
 422         }
 423
 424 #if 0
 425         /* Reset the EEPROM interface, again.  */
 426         fe_outb(sc, FE_BMPR16, 0x00);
 427         fe_outb(sc, FE_BMPR17, 0x00);
 428 #else
 429         /* Make sure to restore the original value of EEPROM interface
 430            registers, since we are not yet sure we have MB86965A on
 431            the address.  */
 432         fe_outb(sc, FE_BMPR17, save17);
 433         fe_outb(sc, FE_BMPR16, save16);
 434 #endif
 435
 436 #if 1
 437         /* Report what we got.  */
 438         if (bootverbose) {
 439                 int i;
 440                 data -= JLI_EEPROM_SIZE;
 441                 for (i = 0; i < JLI_EEPROM_SIZE; i += 16) {
 442                         printf("fe%d: EEPROM(JLI):%3x: %16D\n",
 443                                sc->sc_unit, i, data + i, " ");
 444                 }
 445         }
 446 #endif
 447 }
 448
 449 void
 450 fe_init_jli (struct fe_softc * sc)
 451 {
 452         /* "Reset" by writing into a magic location.  */
 453         DELAY(200);
 454         fe_outb(sc, 0x1E, fe_inb(sc, 0x1E));
 455         DELAY(300);
 456 }
 457
 458
 459 /*
 460  * SSi 78Q8377A support routines.
 461  */
 462
 463 /*
 464  * Routines to read all bytes from the config EEPROM through 78Q8377A.
 465  * It is a MicroWire (3-wire) serial EEPROM with 8-bit address.  (I.e.,
 466  * 93C56 or 93C66.)
 467  *
 468  * As I don't have SSi manuals, (hmm, an old song again!) I'm not exactly
 469  * sure the following code is correct...  It is just stolen from the
 470  * C-NET(98)P2 support routine in FreeBSD(98).
 471  */
 472
 473 void
 474 fe_read_eeprom_ssi (struct fe_softc *sc, u_char *data)
 475 {
 476         u_char val, bit;
 477         int n;
 478         u_char save6, save7, save12;
 479
 480         /* Save the current value for the DLCR registers we are about
 481            to destroy.  */
 482         save6 = fe_inb(sc, FE_DLCR6);
 483         save7 = fe_inb(sc, FE_DLCR7);
 484
 485         /* Put the 78Q8377A into a state that we can access the EEPROM.  */
 486         fe_outb(sc, FE_DLCR6,
 487             FE_D6_BBW_WORD | FE_D6_SBW_WORD | FE_D6_DLC_DISABLE);
 488         fe_outb(sc, FE_DLCR7,
 489             FE_D7_BYTSWP_LH | FE_D7_RBS_BMPR | FE_D7_RDYPNS | FE_D7_POWER_UP);
 490
 491         /* Save the current value for the BMPR12 register, too.  */
 492         save12 = fe_inb(sc, FE_DLCR12);
 493
 494         /* Read bytes from EEPROM; two bytes per an iteration.  */
 495         for (n = 0; n < SSI_EEPROM_SIZE / 2; n++) {
 496
 497                 /* Start EEPROM access  */
 498                 fe_outb(sc, FE_DLCR12, SSI_EEP);
 499                 fe_outb(sc, FE_DLCR12, SSI_EEP | SSI_CSL);
 500
 501                 /* Send the following four bits to the EEPROM in the
 502                    specified order: a dummy bit, a start bit, and
 503                    command bits (10) for READ.  */
 504                 fe_outb(sc, FE_DLCR12, SSI_EEP | SSI_CSL                    );
 505                 fe_outb(sc, FE_DLCR12, SSI_EEP | SSI_CSL | SSI_CLK          );  /* 0 */
 506                 fe_outb(sc, FE_DLCR12, SSI_EEP | SSI_CSL           | SSI_DAT);
 507                 fe_outb(sc, FE_DLCR12, SSI_EEP | SSI_CSL | SSI_CLK | SSI_DAT);  /* 1 */
 508                 fe_outb(sc, FE_DLCR12, SSI_EEP | SSI_CSL           | SSI_DAT);
 509                 fe_outb(sc, FE_DLCR12, SSI_EEP | SSI_CSL | SSI_CLK | SSI_DAT);  /* 1 */
 510                 fe_outb(sc, FE_DLCR12, SSI_EEP | SSI_CSL                    );
 511                 fe_outb(sc, FE_DLCR12, SSI_EEP | SSI_CSL | SSI_CLK          );  /* 0 */
 512
 513                 /* Pass the iteration count to the chip.  */
 514                 for (bit = 0x80; bit != 0x00; bit >>= 1) {
 515                     val = ( n & bit ) ? SSI_DAT : 0;
 516                     fe_outb(sc, FE_DLCR12, SSI_EEP | SSI_CSL           | val);
 517                     fe_outb(sc, FE_DLCR12, SSI_EEP | SSI_CSL | SSI_CLK | val);
 518                 }
 519
 520                 /* Read a byte.  */
 521                 val = 0;
 522                 for (bit = 0x80; bit != 0x00; bit >>= 1) {
 523                     fe_outb(sc, FE_DLCR12, SSI_EEP | SSI_CSL);
 524                     fe_outb(sc, FE_DLCR12, SSI_EEP | SSI_CSL | SSI_CLK);
 525                     if (fe_inb(sc, FE_DLCR12) & SSI_DIN)
 526                         val |= bit;
 527                 }
 528                 *data++ = val;
 529
 530                 /* Read one more byte.  */
 531                 val = 0;
 532                 for (bit = 0x80; bit != 0x00; bit >>= 1) {
 533                     fe_outb(sc, FE_DLCR12, SSI_EEP | SSI_CSL);
 534                     fe_outb(sc, FE_DLCR12, SSI_EEP | SSI_CSL | SSI_CLK);
 535                     if (fe_inb(sc, FE_DLCR12) & SSI_DIN)
 536                         val |= bit;
 537                 }
 538                 *data++ = val;
 539
 540                 fe_outb(sc, FE_DLCR12, SSI_EEP);
 541         }
 542
 543         /* Reset the EEPROM interface.  (For now.)  */
 544         fe_outb(sc, FE_DLCR12, 0x00);
 545
 546         /* Restore the saved register values, for the case that we
 547            didn't have 78Q8377A at the given address.  */
 548         fe_outb(sc, FE_DLCR12, save12);
 549         fe_outb(sc, FE_DLCR7, save7);
 550         fe_outb(sc, FE_DLCR6, save6);
 551
 552 #if 1
 553         /* Report what we got.  */
 554         if (bootverbose) {
 555                 int i;
 556                 data -= SSI_EEPROM_SIZE;
 557                 for (i = 0; i < SSI_EEPROM_SIZE; i += 16) {
 558                         printf("fe%d: EEPROM(SSI):%3x: %16D\n",
 559                                sc->sc_unit, i, data + i, " ");
 560                 }
 561         }
 562 #endif
 563 }
 564
 565 /*
 566  * TDK/LANX boards support routines.
 567  */
 568
 569 /* It is assumed that the CLK line is low and SDA is high (float) upon entry.  */
 570 #define LNX_PH(D,K,N) \
 571         ((LNX_SDA_##D | LNX_CLK_##K) << N)
 572 #define LNX_CYCLE(D1,D2,D3,D4,K1,K2,K3,K4) \
 573         (LNX_PH(D1,K1,0)|LNX_PH(D2,K2,8)|LNX_PH(D3,K3,16)|LNX_PH(D4,K4,24))
 574
 575 #define LNX_CYCLE_START LNX_CYCLE(HI,LO,LO,HI, HI,HI,LO,LO)
 576 #define LNX_CYCLE_STOP  LNX_CYCLE(LO,LO,HI,HI, LO,HI,HI,LO)
 577 #define LNX_CYCLE_HI    LNX_CYCLE(HI,HI,HI,HI, LO,HI,LO,LO)
 578 #define LNX_CYCLE_LO    LNX_CYCLE(LO,LO,LO,HI, LO,HI,LO,LO)
 579 #define LNX_CYCLE_INIT  LNX_CYCLE(LO,HI,HI,HI, LO,LO,LO,LO)
 580
 581 static void
 582 fe_eeprom_cycle_lnx (struct fe_softc *sc, u_short reg20, u_long cycle)
 583 {
 584         fe_outb(sc, reg20, (cycle      ) & 0xFF);
 585         DELAY(15);
 586         fe_outb(sc, reg20, (cycle >>  8) & 0xFF);
 587         DELAY(15);
 588         fe_outb(sc, reg20, (cycle >> 16) & 0xFF);
 589         DELAY(15);
 590         fe_outb(sc, reg20, (cycle >> 24) & 0xFF);
 591         DELAY(15);
 592 }
 593
 594 static u_char
 595 fe_eeprom_receive_lnx (struct fe_softc *sc, u_short reg20)
 596 {
 597         u_char dat;
 598
 599         fe_outb(sc, reg20, LNX_CLK_HI | LNX_SDA_FL);
 600         DELAY(15);
 601         dat = fe_inb(sc, reg20);
 602         fe_outb(sc, reg20, LNX_CLK_LO | LNX_SDA_FL);
 603         DELAY(15);
 604         return (dat & LNX_SDA_IN);
 605 }
 606
 607 void
 608 fe_read_eeprom_lnx (struct fe_softc *sc, u_char *data)
 609 {
 610         int i;
 611         u_char n, bit, val;
 612         u_char save20;
 613         u_short reg20 = 0x14;
 614
 615         save20 = fe_inb(sc, reg20);
 616
 617         /* NOTE: DELAY() timing constants are approximately three
 618            times longer (slower) than the required minimum.  This is
 619            to guarantee a reliable operation under some tough
 620            conditions...  Fortunately, this routine is only called
 621            during the boot phase, so the speed is less important than
 622            stability.  */
 623
 624 #if 1
 625         /* Reset the X24C01's internal state machine and put it into
 626            the IDLE state.  We usually don't need this, but *if*
 627            someone (e.g., probe routine of other driver) write some
 628            garbage into the register at 0x14, synchronization will be
 629            lost, and the normal EEPROM access protocol won't work.
 630            Moreover, as there are no easy way to reset, we need a
 631            _manoeuvre_ here.  (It even lacks a reset pin, so pushing
 632            the RESET button on the PC doesn't help!)  */
 633         fe_eeprom_cycle_lnx(sc, reg20, LNX_CYCLE_INIT);
 634         for (i = 0; i < 10; i++)
 635                 fe_eeprom_cycle_lnx(sc, reg20, LNX_CYCLE_START);
 636         fe_eeprom_cycle_lnx(sc, reg20, LNX_CYCLE_STOP);
 637         DELAY(10000);
 638 #endif
 639
 640         /* Issue a start condition.  */
 641         fe_eeprom_cycle_lnx(sc, reg20, LNX_CYCLE_START);
 642
 643         /* Send seven bits of the starting address (zero, in this
 644            case) and a command bit for READ.  */
 645         val = 0x01;
 646         for (bit = 0x80; bit != 0x00; bit >>= 1) {
 647                 if (val & bit) {
 648                         fe_eeprom_cycle_lnx(sc, reg20, LNX_CYCLE_HI);
 649                 } else {
 650                         fe_eeprom_cycle_lnx(sc, reg20, LNX_CYCLE_LO);
 651                 }
 652         }
 653
 654         /* Receive an ACK bit.  */
 655         if (fe_eeprom_receive_lnx(sc, reg20)) {
 656                 /* ACK was not received.  EEPROM is not present (i.e.,
 657                    this board was not a TDK/LANX) or not working
 658                    properly.  */
 659                 if (bootverbose) {
 660                         printf("fe%d: no ACK received from EEPROM(LNX)\n",
 661                                sc->sc_unit);
 662                 }
 663                 /* Clear the given buffer to indicate we could not get
 664                    any info. and return.  */
 665                 bzero(data, LNX_EEPROM_SIZE);
 666                 goto RET;
 667         }
 668
 669         /* Read bytes from EEPROM.  */
 670         for (n = 0; n < LNX_EEPROM_SIZE; n++) {
 671
 672                 /* Read a byte and store it into the buffer.  */
 673                 val = 0x00;
 674                 for (bit = 0x80; bit != 0x00; bit >>= 1) {
 675                         if (fe_eeprom_receive_lnx(sc, reg20))
 676                                 val |= bit;
 677                 }
 678                 *data++ = val;
 679
 680                 /* Acknowledge if we have to read more.  */
 681                 if (n < LNX_EEPROM_SIZE - 1) {
 682                         fe_eeprom_cycle_lnx(sc, reg20, LNX_CYCLE_LO);
 683                 }
 684         }
 685
 686         /* Issue a STOP condition, de-activating the clock line.
 687            It will be safer to keep the clock line low than to leave
 688            it high.  */
 689         fe_eeprom_cycle_lnx(sc, reg20, LNX_CYCLE_STOP);
 690
 691     RET:
 692         fe_outb(sc, reg20, save20);
 693
 694 #if 1
 695         /* Report what we got.  */
 696         if (bootverbose) {
 697                 data -= LNX_EEPROM_SIZE;
 698                 for (i = 0; i < LNX_EEPROM_SIZE; i += 16) {
 699                         printf("fe%d: EEPROM(LNX):%3x: %16D\n",
 700                                sc->sc_unit, i, data + i, " ");
 701                 }
 702         }
 703 #endif
 704 }
 705
 706 void
 707 fe_init_lnx (struct fe_softc * sc)
 708 {
 709         /* Reset the 86960.  Do we need this?  FIXME.  */
 710         fe_outb(sc, 0x12, 0x06);
 711         DELAY(100);
 712         fe_outb(sc, 0x12, 0x07);
 713         DELAY(100);
 714
 715         /* Setup IRQ control register on the ASIC.  */
 716         fe_outb(sc, 0x14, sc->priv_info);
 717 }
 718
 719
 720 /*
 721  * Ungermann-Bass boards support routine.
 722  */
 723 void
 724 fe_init_ubn (struct fe_softc * sc)
 725 {
 726         /* Do we need this?  FIXME.  */
 727         fe_outb(sc, FE_DLCR7,
 728                 sc->proto_dlcr7 | FE_D7_RBS_BMPR | FE_D7_POWER_UP);
 729         fe_outb(sc, 0x18, 0x00);
 730         DELAY(200);
 731
 732         /* Setup IRQ control register on the ASIC.  */
 733         fe_outb(sc, 0x14, sc->priv_info);
 734 }
 735
 736
 737 /*
 738  * Install interface into kernel networking data structures
 739  */
 740 int
 741 fe_attach (device_t dev)
 742 {
 743         struct fe_softc *sc = device_get_softc(dev);
 744         int flags = device_get_flags(dev);
 745         int b, error;
 746
 747         error = bus_setup_intr(dev, sc->irq_res, INTR_TYPE_NET,
 748                                fe_intr, sc, &sc->irq_handle);
 749         if (error) {
 750                 fe_release_resource(dev);
 751                 return ENXIO;
 752         }
 753
 754         /*
 755          * Initialize ifnet structure
 756          */
 757         sc->sc_if.if_softc    = sc;
 758         if_initname(&(sc->sc_if), "fe", sc->sc_unit);
 759         sc->sc_if.if_start    = fe_start;
 760         sc->sc_if.if_ioctl    = fe_ioctl;
 761         sc->sc_if.if_watchdog = fe_watchdog;
 762         sc->sc_if.if_init     = fe_init;
 763         sc->sc_if.if_linkmib  = &sc->mibdata;
 764         sc->sc_if.if_linkmiblen = sizeof (sc->mibdata);
 765
 766 #if 0 /* I'm not sure... */
 767         sc->mibdata.dot3Compliance = DOT3COMPLIANCE_COLLS;
 768 #endif
 769
 770         /*
 771          * Set fixed interface flags.
 772          */
 773         sc->sc_if.if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
 774         ifq_set_maxlen(&sc->sc_if.if_snd, IFQ_MAXLEN);
 775         ifq_set_ready(&sc->sc_if.if_snd);
 776
 777 #if FE_SINGLE_TRANSMISSION
 778         /* Override txb config to allocate minimum.  */
 779         sc->proto_dlcr6 &= ~FE_D6_TXBSIZ
 780         sc->proto_dlcr6 |=  FE_D6_TXBSIZ_2x2KB;
 781 #endif
 782
 783         /* Modify hardware config if it is requested.  */
 784         if (flags & FE_FLAGS_OVERRIDE_DLCR6)
 785                 sc->proto_dlcr6 = flags & FE_FLAGS_DLCR6_VALUE;
 786
 787         /* Find TX buffer size, based on the hardware dependent proto.  */
 788         switch (sc->proto_dlcr6 & FE_D6_TXBSIZ) {
 789           case FE_D6_TXBSIZ_2x2KB: sc->txb_size = 2048; break;
 790           case FE_D6_TXBSIZ_2x4KB: sc->txb_size = 4096; break;
 791           case FE_D6_TXBSIZ_2x8KB: sc->txb_size = 8192; break;
 792           default:
 793                 /* Oops, we can't work with single buffer configuration.  */
 794                 if (bootverbose) {
 795                         printf("fe%d: strange TXBSIZ config; fixing\n",
 796                                sc->sc_unit);
 797                 }
 798                 sc->proto_dlcr6 &= ~FE_D6_TXBSIZ;
 799                 sc->proto_dlcr6 |=  FE_D6_TXBSIZ_2x2KB;
 800                 sc->txb_size = 2048;
 801                 break;
 802         }
 803
 804         /* Initialize the if_media interface.  */
 805         ifmedia_init(&sc->media, 0, fe_medchange, fe_medstat);
 806         for (b = 0; bit2media[b] != 0; b++) {
 807                 if (sc->mbitmap & (1 << b)) {
 808                         ifmedia_add(&sc->media, bit2media[b], 0, NULL);
 809                 }
 810         }
 811         for (b = 0; bit2media[b] != 0; b++) {
 812                 if (sc->defmedia & (1 << b)) {
 813                         ifmedia_set(&sc->media, bit2media[b]);
 814                         break;
 815                 }
 816         }
 817 #if 0   /* Turned off; this is called later, when the interface UPs.  */
 818         fe_medchange(sc);
 819 #endif
 820
 821         /* Attach and stop the interface. */
 822         ether_ifattach(&sc->sc_if, sc->sc_enaddr);
 823         fe_stop(sc);
 824
 825         /* Print additional info when attached.  */
 826         device_printf(dev, "type %s%s\n", sc->typestr,
 827                       (sc->proto_dlcr4 & FE_D4_DSC) ? ", full duplex" : "");
 828         if (bootverbose) {
 829                 int buf, txb, bbw, sbw, ram;
 830
 831                 buf = txb = bbw = sbw = ram = -1;
 832                 switch ( sc->proto_dlcr6 & FE_D6_BUFSIZ ) {
 833                   case FE_D6_BUFSIZ_8KB:  buf =  8; break;
 834                   case FE_D6_BUFSIZ_16KB: buf = 16; break;
 835                   case FE_D6_BUFSIZ_32KB: buf = 32; break;
 836                   case FE_D6_BUFSIZ_64KB: buf = 64; break;
 837                 }
 838                 switch ( sc->proto_dlcr6 & FE_D6_TXBSIZ ) {
 839                   case FE_D6_TXBSIZ_2x2KB: txb = 2; break;
 840                   case FE_D6_TXBSIZ_2x4KB: txb = 4; break;
 841                   case FE_D6_TXBSIZ_2x8KB: txb = 8; break;
 842                 }
 843                 switch ( sc->proto_dlcr6 & FE_D6_BBW ) {
 844                   case FE_D6_BBW_BYTE: bbw =  8; break;
 845                   case FE_D6_BBW_WORD: bbw = 16; break;
 846                 }
 847                 switch ( sc->proto_dlcr6 & FE_D6_SBW ) {
 848                   case FE_D6_SBW_BYTE: sbw =  8; break;
 849                   case FE_D6_SBW_WORD: sbw = 16; break;
 850                 }
 851                 switch ( sc->proto_dlcr6 & FE_D6_SRAM ) {
 852                   case FE_D6_SRAM_100ns: ram = 100; break;
 853                   case FE_D6_SRAM_150ns: ram = 150; break;
 854                 }
 855                 device_printf(dev, "SRAM %dKB %dbit %dns, TXB %dKBx2, %dbit I/O\n",
 856                               buf, bbw, ram, txb, sbw);
 857         }
 858         if (sc->stability & UNSTABLE_IRQ)
 859                 device_printf(dev, "warning: IRQ number may be incorrect\n");
 860         if (sc->stability & UNSTABLE_MAC)
 861                 device_printf(dev, "warning: above MAC address may be incorrect\n");
 862         if (sc->stability & UNSTABLE_TYPE)
 863                 device_printf(dev, "warning: hardware type was not validated\n");
 864
 865         return 0;
 866 }
 867
 868 int
 869 fe_alloc_port(device_t dev, int size)
 870 {
 871         struct fe_softc *sc = device_get_softc(dev);
 872         struct resource *res;
 873         int rid;
 874
 875         rid = 0;
 876         res = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid,
 877                                  0ul, ~0ul, size, RF_ACTIVE);
 878         if (res) {
 879                 sc->port_used = size;
 880                 sc->port_res = res;
 881                 sc->iot = rman_get_bustag(res);
 882                 sc->ioh = rman_get_bushandle(res);
 883                 return (0);
 884         }
 885
 886         return (ENOENT);
 887 }
 888
 889 int
 890 fe_alloc_irq(device_t dev, int flags)
 891 {
 892         struct fe_softc *sc = device_get_softc(dev);
 893         struct resource *res;
 894         int rid;
 895
 896         rid = 0;
 897         res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE | flags);
 898         if (res) {
 899                 sc->irq_res = res;
 900                 return (0);
 901         }
 902
 903         return (ENOENT);
 904 }
 905
 906 void
 907 fe_release_resource(device_t dev)
 908 {
 909         struct fe_softc *sc = device_get_softc(dev);
 910
 911         if (sc->port_res) {
 912                 bus_release_resource(dev, SYS_RES_IOPORT, 0, sc->port_res);
 913                 sc->port_res = NULL;
 914         }
 915         if (sc->irq_res) {
 916                 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->irq_res);
 917                 sc->irq_res = NULL;
 918         }
 919 }
 920
 921 /*
 922  * Reset interface, after some (hardware) trouble is deteced.
 923  */
 924 static void
 925 fe_reset (struct fe_softc *sc)
 926 {
 927         /* Record how many packets are lost by this accident.  */
 928         sc->sc_if.if_oerrors += sc->txb_sched + sc->txb_count;
 929         sc->mibdata.dot3StatsInternalMacTransmitErrors++;
 930
 931         /* Put the interface into known initial state.  */
 932         fe_stop(sc);
 933         if (sc->sc_if.if_flags & IFF_UP)
 934                 fe_init(sc);
 935 }
 936
 937 /*
 938  * Stop everything on the interface.
 939  *
 940  * All buffered packets, both transmitting and receiving,
 941  * if any, will be lost by stopping the interface.
 942  */
 943 void
 944 fe_stop (struct fe_softc *sc)
 945 {
 946         int s;
 947
 948         s = splimp();
 949
 950         /* Disable interrupts.  */
 951         fe_outb(sc, FE_DLCR2, 0x00);
 952         fe_outb(sc, FE_DLCR3, 0x00);
 953
 954         /* Stop interface hardware.  */
 955         DELAY(200);
 956         fe_outb(sc, FE_DLCR6, sc->proto_dlcr6 | FE_D6_DLC_DISABLE);
 957         DELAY(200);
 958
 959         /* Clear all interrupt status.  */
 960         fe_outb(sc, FE_DLCR0, 0xFF);
 961         fe_outb(sc, FE_DLCR1, 0xFF);
 962
 963         /* Put the chip in stand-by mode.  */
 964         DELAY(200);
 965         fe_outb(sc, FE_DLCR7, sc->proto_dlcr7 | FE_D7_POWER_DOWN);
 966         DELAY(200);
 967
 968         /* Reset transmitter variables and interface flags.  */
 969         sc->sc_if.if_flags &= ~(IFF_OACTIVE | IFF_RUNNING);
 970         sc->sc_if.if_timer = 0;
 971         sc->txb_free = sc->txb_size;
 972         sc->txb_count = 0;
 973         sc->txb_sched = 0;
 974
 975         /* MAR loading can be delayed.  */
 976         sc->filter_change = 0;
 977
 978         /* Call a device-specific hook.  */
 979         if (sc->stop)
 980                 sc->stop(sc);
 981
 982         (void) splx(s);
 983 }
 984
 985 /*
 986  * Device timeout/watchdog routine. Entered if the device neglects to
 987  * generate an interrupt after a transmit has been started on it.
 988  */
 989 static void
 990 fe_watchdog ( struct ifnet *ifp )
 991 {
 992         struct fe_softc *sc = (struct fe_softc *)ifp;
 993
 994         /* A "debug" message.  */
 995         printf("%s: transmission timeout (%d+%d)%s\n",
 996                ifp->if_xname, sc->txb_sched, sc->txb_count,
 997                (ifp->if_flags & IFF_UP) ? "" : " when down");
 998         if (sc->sc_if.if_opackets == 0 && sc->sc_if.if_ipackets == 0)
 999                 printf("%s: wrong IRQ setting in config?\n", ifp->if_xname);
1000         fe_reset(sc);
1001 }
1002
1003 /*
1004  * Initialize device.
1005  */
1006 static void
1007 fe_init (void * xsc)
1008 {
1009         struct fe_softc *sc = xsc;
1010         int s;
1011
1012         /* We need an address. */
1013         if (TAILQ_EMPTY(&sc->sc_if.if_addrhead)) { /* XXX unlikely */
1014 #ifdef DIAGNOSTIC
1015                 printf("fe%d: init() without any address\n", sc->sc_unit);
1016 #endif
1017                 return;
1018         }
1019
1020         /* Start initializing 86960.  */
1021         s = splimp();
1022
1023         /* Call a hook before we start initializing the chip.  */
1024         if (sc->init)
1025                 sc->init(sc);
1026
1027         /*
1028          * Make sure to disable the chip, also.
1029          * This may also help re-programming the chip after
1030          * hot insertion of PCMCIAs.
1031          */
1032         DELAY(200);
1033         fe_outb(sc, FE_DLCR6, sc->proto_dlcr6 | FE_D6_DLC_DISABLE);
1034         DELAY(200);
1035
1036         /* Power up the chip and select register bank for DLCRs.  */
1037         DELAY(200);
1038         fe_outb(sc, FE_DLCR7,
1039                 sc->proto_dlcr7 | FE_D7_RBS_DLCR | FE_D7_POWER_UP);
1040         DELAY(200);
1041
1042         /* Feed the station address.  */
1043         fe_outblk(sc, FE_DLCR8, sc->sc_enaddr, ETHER_ADDR_LEN);
1044
1045         /* Clear multicast address filter to receive nothing.  */
1046         fe_outb(sc, FE_DLCR7,
1047                 sc->proto_dlcr7 | FE_D7_RBS_MAR | FE_D7_POWER_UP);
1048         fe_outblk(sc, FE_MAR8, fe_filter_nothing.data, FE_FILTER_LEN);
1049
1050         /* Select the BMPR bank for runtime register access.  */
1051         fe_outb(sc, FE_DLCR7,
1052                 sc->proto_dlcr7 | FE_D7_RBS_BMPR | FE_D7_POWER_UP);
1053
1054         /* Initialize registers.  */
1055         fe_outb(sc, FE_DLCR0, 0xFF);    /* Clear all bits.  */
1056         fe_outb(sc, FE_DLCR1, 0xFF);    /* ditto.  */
1057         fe_outb(sc, FE_DLCR2, 0x00);
1058         fe_outb(sc, FE_DLCR3, 0x00);
1059         fe_outb(sc, FE_DLCR4, sc->proto_dlcr4);
1060         fe_outb(sc, FE_DLCR5, sc->proto_dlcr5);
1061         fe_outb(sc, FE_BMPR10, 0x00);
1062         fe_outb(sc, FE_BMPR11, FE_B11_CTRL_SKIP | FE_B11_MODE1);
1063         fe_outb(sc, FE_BMPR12, 0x00);
1064         fe_outb(sc, FE_BMPR13, sc->proto_bmpr13);
1065         fe_outb(sc, FE_BMPR14, 0x00);
1066         fe_outb(sc, FE_BMPR15, 0x00);
1067
1068         /* Enable interrupts.  */
1069         fe_outb(sc, FE_DLCR2, FE_TMASK);
1070         fe_outb(sc, FE_DLCR3, FE_RMASK);
1071
1072         /* Select requested media, just before enabling DLC.  */
1073         if (sc->msel)
1074                 sc->msel(sc);
1075
1076         /* Enable transmitter and receiver.  */
1077         DELAY(200);
1078         fe_outb(sc, FE_DLCR6, sc->proto_dlcr6 | FE_D6_DLC_ENABLE);
1079         DELAY(200);
1080
1081 #ifdef DIAGNOSTIC
1082         /*
1083          * Make sure to empty the receive buffer.
1084          *
1085          * This may be redundant, but *if* the receive buffer were full
1086          * at this point, then the driver would hang.  I have experienced
1087          * some strange hang-up just after UP.  I hope the following
1088          * code solve the problem.
1089          *
1090          * I have changed the order of hardware initialization.
1091          * I think the receive buffer cannot have any packets at this
1092          * point in this version.  The following code *must* be
1093          * redundant now.  FIXME.
1094          *
1095          * I've heard a rumore that on some PC card implementation of
1096          * 8696x, the receive buffer can have some data at this point.
1097          * The following message helps discovering the fact.  FIXME.
1098          */
1099         if (!(fe_inb(sc, FE_DLCR5) & FE_D5_BUFEMP)) {
1100                 printf("fe%d: receive buffer has some data after reset\n",
1101                        sc->sc_unit);
1102                 fe_emptybuffer(sc);
1103         }
1104
1105         /* Do we need this here?  Actually, no.  I must be paranoia.  */
1106         fe_outb(sc, FE_DLCR0, 0xFF);    /* Clear all bits.  */
1107         fe_outb(sc, FE_DLCR1, 0xFF);    /* ditto.  */
1108 #endif
1109
1110         /* Set 'running' flag, because we are now running.   */
1111         sc->sc_if.if_flags |= IFF_RUNNING;
1112
1113         /*
1114          * At this point, the interface is running properly,
1115          * except that it receives *no* packets.  we then call
1116          * fe_setmode() to tell the chip what packets to be
1117          * received, based on the if_flags and multicast group
1118          * list.  It completes the initialization process.
1119          */
1120         fe_setmode(sc);
1121
1122 #if 0
1123         /* ...and attempt to start output queued packets.  */
1124         /* TURNED OFF, because the semi-auto media prober wants to UP
1125            the interface keeping it idle.  The upper layer will soon
1126            start the interface anyway, and there are no significant
1127            delay.  */
1128         fe_start(&sc->sc_if);
1129 #endif
1130
1131         (void) splx(s);
1132 }
1133
1134 /*
1135  * This routine actually starts the transmission on the interface
1136  */
1137 static void
1138 fe_xmit (struct fe_softc *sc)
1139 {
1140         /*
1141          * Set a timer just in case we never hear from the board again.
1142          * We use longer timeout for multiple packet transmission.
1143          * I'm not sure this timer value is appropriate.  FIXME.
1144          */
1145         sc->sc_if.if_timer = 1 + sc->txb_count;
1146
1147         /* Update txb variables.  */
1148         sc->txb_sched = sc->txb_count;
1149         sc->txb_count = 0;
1150         sc->txb_free = sc->txb_size;
1151         sc->tx_excolls = 0;
1152
1153         /* Start transmitter, passing packets in TX buffer.  */
1154         fe_outb(sc, FE_BMPR10, sc->txb_sched | FE_B10_START);
1155 }
1156
1157 /*
1158  * Start output on interface.
1159  * We make two assumptions here:
1160  *  1) that the current priority is set to splimp _before_ this code
1161  *     is called *and* is returned to the appropriate priority after
1162  *     return
1163  *  2) that the IFF_OACTIVE flag is checked before this code is called
1164  *     (i.e. that the output part of the interface is idle)
1165  */
1166 void
1167 fe_start (struct ifnet *ifp)
1168 {
1169         struct fe_softc *sc = ifp->if_softc;
1170         struct mbuf *m;
1171
1172 #ifdef DIAGNOSTIC
1173         /* Just a sanity check.  */
1174         if ((sc->txb_count == 0) != (sc->txb_free == sc->txb_size)) {
1175                 /*
1176                  * Txb_count and txb_free co-works to manage the
1177                  * transmission buffer.  Txb_count keeps track of the
1178                  * used potion of the buffer, while txb_free does unused
1179                  * potion.  So, as long as the driver runs properly,
1180                  * txb_count is zero if and only if txb_free is same
1181                  * as txb_size (which represents whole buffer.)
1182                  */
1183                 printf("fe%d: inconsistent txb variables (%d, %d)\n",
1184                         sc->sc_unit, sc->txb_count, sc->txb_free);
1185                 /*
1186                  * So, what should I do, then?
1187                  *
1188                  * We now know txb_count and txb_free contradicts.  We
1189                  * cannot, however, tell which is wrong.  More
1190                  * over, we cannot peek 86960 transmission buffer or
1191                  * reset the transmission buffer.  (In fact, we can
1192                  * reset the entire interface.  I don't want to do it.)
1193                  *
1194                  * If txb_count is incorrect, leaving it as-is will cause
1195                  * sending of garbage after next interrupt.  We have to
1196                  * avoid it.  Hence, we reset the txb_count here.  If
1197                  * txb_free was incorrect, resetting txb_count just loose
1198                  * some packets.  We can live with it.
1199                  */
1200                 sc->txb_count = 0;
1201         }
1202 #endif
1203
1204         /*
1205          * First, see if there are buffered packets and an idle
1206          * transmitter - should never happen at this point.
1207          */
1208         if ((sc->txb_count > 0) && (sc->txb_sched == 0)) {
1209                 printf("fe%d: transmitter idle with %d buffered packets\n",
1210                        sc->sc_unit, sc->txb_count);
1211                 fe_xmit(sc);
1212         }
1213
1214         /*
1215          * Stop accepting more transmission packets temporarily, when
1216          * a filter change request is delayed.  Updating the MARs on
1217          * 86960 flushes the transmission buffer, so it is delayed
1218          * until all buffered transmission packets have been sent
1219          * out.
1220          */
1221         if (sc->filter_change) {
1222                 /*
1223                  * Filter change request is delayed only when the DLC is
1224                  * working.  DLC soon raise an interrupt after finishing
1225                  * the work.
1226                  */
1227                 goto indicate_active;
1228         }
1229
1230         for (;;) {
1231
1232                 /*
1233                  * See if there is room to put another packet in the buffer.
1234                  * We *could* do better job by peeking the send queue to
1235                  * know the length of the next packet.  Current version just
1236                  * tests against the worst case (i.e., longest packet).  FIXME.
1237                  *
1238                  * When adding the packet-peek feature, don't forget adding a
1239                  * test on txb_count against QUEUEING_MAX.
1240                  * There is a little chance the packet count exceeds
1241                  * the limit.  Assume transmission buffer is 8KB (2x8KB
1242                  * configuration) and an application sends a bunch of small
1243                  * (i.e., minimum packet sized) packets rapidly.  An 8KB
1244                  * buffer can hold 130 blocks of 62 bytes long...
1245                  */
1246                 if (sc->txb_free
1247                     < ETHER_MAX_LEN - ETHER_CRC_LEN + FE_DATA_LEN_LEN) {
1248                         /* No room.  */
1249                         goto indicate_active;
1250                 }
1251
1252 #if FE_SINGLE_TRANSMISSION
1253                 if (sc->txb_count > 0) {
1254                         /* Just one packet per a transmission buffer.  */
1255                         goto indicate_active;
1256                 }
1257 #endif
1258
1259                 /*
1260                  * Get the next mbuf chain for a packet to send.
1261                  */
1262                 m = ifq_dequeue(&sc->sc_if.if_snd);
1263                 if (m == NULL) {
1264                         /* No more packets to send.  */
1265                         goto indicate_inactive;
1266                 }
1267
1268                 /*
1269                  * Copy the mbuf chain into the transmission buffer.
1270                  * txb_* variables are updated as necessary.
1271                  */
1272                 fe_write_mbufs(sc, m);
1273
1274                 /* Start transmitter if it's idle.  */
1275                 if ((sc->txb_count > 0) && (sc->txb_sched == 0))
1276                         fe_xmit(sc);
1277
1278                 /*
1279                  * Tap off here if there is a bpf listener,
1280                  * and the device is *not* in promiscuous mode.
1281                  * (86960 receives self-generated packets if
1282                  * and only if it is in "receive everything"
1283                  * mode.)
1284                  */
1285                 if ((sc->sc_if.if_flags & IFF_PROMISC) == 0)
1286                         BPF_MTAP(&sc->sc_if, m);
1287
1288                 m_freem(m);
1289         }
1290
1291   indicate_inactive:
1292         /*
1293          * We are using the !OACTIVE flag to indicate to
1294          * the outside world that we can accept an
1295          * additional packet rather than that the
1296          * transmitter is _actually_ active.  Indeed, the
1297          * transmitter may be active, but if we haven't
1298          * filled all the buffers with data then we still
1299          * want to accept more.
1300          */
1301         sc->sc_if.if_flags &= ~IFF_OACTIVE;
1302         return;
1303
1304   indicate_active:
1305         /*
1306          * The transmitter is active, and there are no room for
1307          * more outgoing packets in the transmission buffer.
1308          */
1309         sc->sc_if.if_flags |= IFF_OACTIVE;
1310         return;
1311 }
1312
1313 /*
1314  * Drop (skip) a packet from receive buffer in 86960 memory.
1315  */
1316 static void
1317 fe_droppacket (struct fe_softc * sc, int len)
1318 {
1319         int i;
1320
1321         /*
1322          * 86960 manual says that we have to read 8 bytes from the buffer
1323          * before skip the packets and that there must be more than 8 bytes
1324          * remaining in the buffer when issue a skip command.
1325          * Remember, we have already read 4 bytes before come here.
1326          */
1327         if (len > 12) {
1328                 /* Read 4 more bytes, and skip the rest of the packet.  */
1329 #ifdef FE_8BIT_SUPPORT
1330                 if ((sc->proto_dlcr6 & FE_D6_SBW) == FE_D6_SBW_BYTE)
1331                 {
1332                         (void) fe_inb(sc, FE_BMPR8);
1333                         (void) fe_inb(sc, FE_BMPR8);
1334                         (void) fe_inb(sc, FE_BMPR8);
1335                         (void) fe_inb(sc, FE_BMPR8);
1336                 }
1337                 else
1338 #endif
1339                 {
1340                         (void) fe_inw(sc, FE_BMPR8);
1341                         (void) fe_inw(sc, FE_BMPR8);
1342                 }
1343                 fe_outb(sc, FE_BMPR14, FE_B14_SKIP);
1344         } else {
1345                 /* We should not come here unless receiving RUNTs.  */
1346 #ifdef FE_8BIT_SUPPORT
1347                 if ((sc->proto_dlcr6 & FE_D6_SBW) == FE_D6_SBW_BYTE)
1348                 {
1349                         for (i = 0; i < len; i++)
1350                                 (void) fe_inb(sc, FE_BMPR8);
1351                 }
1352                 else
1353 #endif
1354                 {
1355                         for (i = 0; i < len; i += 2)
1356                                 (void) fe_inw(sc, FE_BMPR8);
1357                 }
1358         }
1359 }
1360
1361 #ifdef DIAGNOSTIC
1362 /*
1363  * Empty receiving buffer.
1364  */
1365 static void
1366 fe_emptybuffer (struct fe_softc * sc)
1367 {
1368         int i;
1369         u_char saved_dlcr5;
1370
1371 #ifdef FE_DEBUG
1372         printf("fe%d: emptying receive buffer\n", sc->sc_unit);
1373 #endif
1374
1375         /*
1376          * Stop receiving packets, temporarily.
1377          */
1378         saved_dlcr5 = fe_inb(sc, FE_DLCR5);
1379         fe_outb(sc, FE_DLCR5, sc->proto_dlcr5);
1380         DELAY(1300);
1381
1382         /*
1383          * When we come here, the receive buffer management may
1384          * have been broken.  So, we cannot use skip operation.
1385          * Just discard everything in the buffer.
1386          */
1387 #ifdef FE_8BIT_SUPPORT
1388         if ((sc->proto_dlcr6 & FE_D6_SBW) == FE_D6_SBW_BYTE)
1389         {
1390                 for (i = 0; i < 65536; i++) {
1391                         if (fe_inb(sc, FE_DLCR5) & FE_D5_BUFEMP)
1392                                 break;
1393                         (void) fe_inb(sc, FE_BMPR8);
1394                 }
1395         }
1396         else
1397 #endif
1398         {
1399                 for (i = 0; i < 65536; i += 2) {
1400                         if (fe_inb(sc, FE_DLCR5) & FE_D5_BUFEMP)
1401                                 break;
1402                         (void) fe_inw(sc, FE_BMPR8);
1403                 }
1404         }
1405
1406         /*
1407          * Double check.
1408          */
1409         if (fe_inb(sc, FE_DLCR5) & FE_D5_BUFEMP) {
1410                 printf("fe%d: could not empty receive buffer\n", sc->sc_unit);
1411                 /* Hmm.  What should I do if this happens?  FIXME.  */
1412         }
1413
1414         /*
1415          * Restart receiving packets.
1416          */
1417         fe_outb(sc, FE_DLCR5, saved_dlcr5);
1418 }
1419 #endif
1420
1421 /*
1422  * Transmission interrupt handler
1423  * The control flow of this function looks silly.  FIXME.
1424  */
1425 static void
1426 fe_tint (struct fe_softc * sc, u_char tstat)
1427 {
1428         int left;
1429         int col;
1430
1431         /*
1432          * Handle "excessive collision" interrupt.
1433          */
1434         if (tstat & FE_D0_COLL16) {
1435
1436                 /*
1437                  * Find how many packets (including this collided one)
1438                  * are left unsent in transmission buffer.
1439                  */
1440                 left = fe_inb(sc, FE_BMPR10);
1441                 printf("fe%d: excessive collision (%d/%d)\n",
1442                        sc->sc_unit, left, sc->txb_sched);
1443
1444                 /*
1445                  * Clear the collision flag (in 86960) here
1446                  * to avoid confusing statistics.
1447                  */
1448                 fe_outb(sc, FE_DLCR0, FE_D0_COLLID);
1449
1450                 /*
1451                  * Restart transmitter, skipping the
1452                  * collided packet.
1453                  *
1454                  * We *must* skip the packet to keep network running
1455                  * properly.  Excessive collision error is an
1456                  * indication of the network overload.  If we
1457                  * tried sending the same packet after excessive
1458                  * collision, the network would be filled with
1459                  * out-of-time packets.  Packets belonging
1460                  * to reliable transport (such as TCP) are resent
1461                  * by some upper layer.
1462                  */
1463                 fe_outb(sc, FE_BMPR11, FE_B11_CTRL_SKIP | FE_B11_MODE1);
1464
1465                 /* Update statistics.  */
1466                 sc->tx_excolls++;
1467         }
1468
1469         /*
1470          * Handle "transmission complete" interrupt.
1471          */
1472         if (tstat & FE_D0_TXDONE) {
1473
1474                 /*
1475                  * Add in total number of collisions on last
1476                  * transmission.  We also clear "collision occurred" flag
1477                  * here.
1478                  *
1479                  * 86960 has a design flaw on collision count on multiple
1480                  * packet transmission.  When we send two or more packets
1481                  * with one start command (that's what we do when the
1482                  * transmission queue is crowded), 86960 informs us number
1483                  * of collisions occurred on the last packet on the
1484                  * transmission only.  Number of collisions on previous
1485                  * packets are lost.  I have told that the fact is clearly
1486                  * stated in the Fujitsu document.
1487                  *
1488                  * I considered not to mind it seriously.  Collision
1489                  * count is not so important, anyway.  Any comments?  FIXME.
1490                  */
1491
1492                 if (fe_inb(sc, FE_DLCR0) & FE_D0_COLLID) {
1493
1494                         /* Clear collision flag.  */
1495                         fe_outb(sc, FE_DLCR0, FE_D0_COLLID);
1496
1497                         /* Extract collision count from 86960.  */
1498                         col = fe_inb(sc, FE_DLCR4);
1499                         col = (col & FE_D4_COL) >> FE_D4_COL_SHIFT;
1500                         if (col == 0) {
1501                                 /*
1502                                  * Status register indicates collisions,
1503                                  * while the collision count is zero.
1504                                  * This can happen after multiple packet
1505                                  * transmission, indicating that one or more
1506                                  * previous packet(s) had been collided.
1507                                  *
1508                                  * Since the accurate number of collisions
1509                                  * has been lost, we just guess it as 1;
1510                                  * Am I too optimistic?  FIXME.
1511                                  */
1512                                 col = 1;
1513                         }
1514                         sc->sc_if.if_collisions += col;
1515                         if (col == 1)
1516                                 sc->mibdata.dot3StatsSingleCollisionFrames++;
1517                         else
1518                                 sc->mibdata.dot3StatsMultipleCollisionFrames++;
1519                         sc->mibdata.dot3StatsCollFrequencies[col-1]++;
1520                 }
1521
1522                 /*
1523                  * Update transmission statistics.
1524                  * Be sure to reflect number of excessive collisions.
1525                  */
1526                 col = sc->tx_excolls;
1527                 sc->sc_if.if_opackets += sc->txb_sched - col;
1528                 sc->sc_if.if_oerrors += col;
1529                 sc->sc_if.if_collisions += col * 16;
1530                 sc->mibdata.dot3StatsExcessiveCollisions += col;
1531                 sc->mibdata.dot3StatsCollFrequencies[15] += col;
1532                 sc->txb_sched = 0;
1533
1534                 /*
1535                  * The transmitter is no more active.
1536                  * Reset output active flag and watchdog timer.
1537                  */
1538                 sc->sc_if.if_flags &= ~IFF_OACTIVE;
1539                 sc->sc_if.if_timer = 0;
1540
1541                 /*
1542                  * If more data is ready to transmit in the buffer, start
1543                  * transmitting them.  Otherwise keep transmitter idle,
1544                  * even if more data is queued.  This gives receive
1545                  * process a slight priority.
1546                  */
1547                 if (sc->txb_count > 0)
1548                         fe_xmit(sc);
1549         }
1550 }
1551
1552 /*
1553  * Ethernet interface receiver interrupt.
1554  */
1555 static void
1556 fe_rint (struct fe_softc * sc, u_char rstat)
1557 {
1558         u_short len;
1559         u_char status;
1560         int i;
1561
1562         /*
1563          * Update statistics if this interrupt is caused by an error.
1564          * Note that, when the system was not sufficiently fast, the
1565          * receive interrupt might not be acknowledged immediately.  If
1566          * one or more errornous frames were received before this routine
1567          * was scheduled, they are ignored, and the following error stats
1568          * give less than real values.
1569          */
1570         if (rstat & (FE_D1_OVRFLO | FE_D1_CRCERR | FE_D1_ALGERR | FE_D1_SRTPKT)) {
1571                 if (rstat & FE_D1_OVRFLO)
1572                         sc->mibdata.dot3StatsInternalMacReceiveErrors++;
1573                 if (rstat & FE_D1_CRCERR)
1574                         sc->mibdata.dot3StatsFCSErrors++;
1575                 if (rstat & FE_D1_ALGERR)
1576                         sc->mibdata.dot3StatsAlignmentErrors++;
1577 #if 0
1578                 /* The reference MAC receiver defined in 802.3
1579                    silently ignores short frames (RUNTs) without
1580                    notifying upper layer.  RFC 1650 (dot3 MIB) is
1581                    based on the 802.3, and it has no stats entry for
1582                    RUNTs...  */
1583                 if (rstat & FE_D1_SRTPKT)
1584                         sc->mibdata.dot3StatsFrameTooShorts++; /* :-) */
1585 #endif
1586                 sc->sc_if.if_ierrors++;
1587         }
1588
1589         /*
1590          * MB86960 has a flag indicating "receive queue empty."
1591          * We just loop, checking the flag, to pull out all received
1592          * packets.
1593          *
1594          * We limit the number of iterations to avoid infinite-loop.
1595          * The upper bound is set to unrealistic high value.
1596          */
1597         for (i = 0; i < FE_MAX_RECV_COUNT * 2; i++) {
1598
1599                 /* Stop the iteration if 86960 indicates no packets.  */
1600                 if (fe_inb(sc, FE_DLCR5) & FE_D5_BUFEMP)
1601                         return;
1602
1603                 /*
1604                  * Extract a receive status byte.
1605                  * As our 86960 is in 16 bit bus access mode, we have to
1606                  * use inw() to get the status byte.  The significant
1607                  * value is returned in lower 8 bits.
1608                  */
1609 #ifdef FE_8BIT_SUPPORT
1610                 if ((sc->proto_dlcr6 & FE_D6_SBW) == FE_D6_SBW_BYTE)
1611                 {
1612                         status = fe_inb(sc, FE_BMPR8);
1613                         (void) fe_inb(sc, FE_BMPR8);
1614                 }
1615                 else
1616 #endif
1617                 {
1618                         status = (u_char) fe_inw(sc, FE_BMPR8);
1619                 }
1620
1621                 /*
1622                  * Extract the packet length.
1623                  * It is a sum of a header (14 bytes) and a payload.
1624                  * CRC has been stripped off by the 86960.
1625                  */
1626 #ifdef FE_8BIT_SUPPORT
1627                 if ((sc->proto_dlcr6 & FE_D6_SBW) == FE_D6_SBW_BYTE)
1628                 {
1629                         len  =  fe_inb(sc, FE_BMPR8);
1630                         len |= (fe_inb(sc, FE_BMPR8) << 8);
1631                 }
1632                 else
1633 #endif
1634                 {
1635                         len = fe_inw(sc, FE_BMPR8);
1636                 }
1637
1638                 /*
1639                  * AS our 86960 is programed to ignore errored frame,
1640                  * we must not see any error indication in the
1641                  * receive buffer.  So, any error condition is a
1642                  * serious error, e.g., out-of-sync of the receive
1643                  * buffer pointers.
1644                  */
1645                 if ((status & 0xF0) != 0x20 ||
1646                     len > ETHER_MAX_LEN - ETHER_CRC_LEN ||
1647                     len < ETHER_MIN_LEN - ETHER_CRC_LEN) {
1648                         printf("fe%d: RX buffer out-of-sync\n", sc->sc_unit);
1649                         sc->sc_if.if_ierrors++;
1650                         sc->mibdata.dot3StatsInternalMacReceiveErrors++;
1651                         fe_reset(sc);
1652                         return;
1653                 }
1654
1655                 /*
1656                  * Go get a packet.
1657                  */
1658                 if (fe_get_packet(sc, len) < 0) {
1659                         /*
1660                          * Negative return from fe_get_packet()
1661                          * indicates no available mbuf.  We stop
1662                          * receiving packets, even if there are more
1663                          * in the buffer.  We hope we can get more
1664                          * mbuf next time.
1665                          */
1666                         sc->sc_if.if_ierrors++;
1667                         sc->mibdata.dot3StatsMissedFrames++;
1668                         fe_droppacket(sc, len);
1669                         return;
1670                 }
1671
1672                 /* Successfully received a packet.  Update stat.  */
1673                 sc->sc_if.if_ipackets++;
1674         }
1675
1676         /* Maximum number of frames has been received.  Something
1677            strange is happening here... */
1678         printf("fe%d: unusual receive flood\n", sc->sc_unit);
1679         sc->mibdata.dot3StatsInternalMacReceiveErrors++;
1680         fe_reset(sc);
1681 }
1682
1683 /*
1684  * Ethernet interface interrupt processor
1685  */
1686 static void
1687 fe_intr (void *arg)
1688 {
1689         struct fe_softc *sc = arg;
1690         u_char tstat, rstat;
1691         int loop_count = FE_MAX_LOOP;
1692
1693         /* Loop until there are no more new interrupt conditions.  */
1694         while (loop_count-- > 0) {
1695                 /*
1696                  * Get interrupt conditions, masking unneeded flags.
1697                  */
1698                 tstat = fe_inb(sc, FE_DLCR0) & FE_TMASK;
1699                 rstat = fe_inb(sc, FE_DLCR1) & FE_RMASK;
1700                 if (tstat == 0 && rstat == 0)
1701                         return;
1702
1703                 /*
1704                  * Reset the conditions we are acknowledging.
1705                  */
1706                 fe_outb(sc, FE_DLCR0, tstat);
1707                 fe_outb(sc, FE_DLCR1, rstat);
1708
1709                 /*
1710                  * Handle transmitter interrupts.
1711                  */
1712                 if (tstat)
1713                         fe_tint(sc, tstat);
1714
1715                 /*
1716                  * Handle receiver interrupts
1717                  */
1718                 if (rstat)
1719                         fe_rint(sc, rstat);
1720
1721                 /*
1722                  * Update the multicast address filter if it is
1723                  * needed and possible.  We do it now, because
1724                  * we can make sure the transmission buffer is empty,
1725                  * and there is a good chance that the receive queue
1726                  * is empty.  It will minimize the possibility of
1727                  * packet loss.
1728                  */
1729                 if (sc->filter_change &&
1730                     sc->txb_count == 0 && sc->txb_sched == 0) {
1731                         fe_loadmar(sc);
1732                         sc->sc_if.if_flags &= ~IFF_OACTIVE;
1733                 }
1734
1735                 /*
1736                  * If it looks like the transmitter can take more data,
1737                  * attempt to start output on the interface. This is done
1738                  * after handling the receiver interrupt to give the
1739                  * receive operation priority.
1740                  *
1741                  * BTW, I'm not sure in what case the OACTIVE is on at
1742                  * this point.  Is the following test redundant?
1743                  *
1744                  * No.  This routine polls for both transmitter and
1745                  * receiver interrupts.  86960 can raise a receiver
1746                  * interrupt when the transmission buffer is full.
1747                  */
1748                 if ((sc->sc_if.if_flags & IFF_OACTIVE) == 0)
1749                         fe_start(&sc->sc_if);
1750         }
1751
1752         printf("fe%d: too many loops\n", sc->sc_unit);
1753 }
1754
1755 /*
1756  * Process an ioctl request. This code needs some work - it looks
1757  * pretty ugly.
1758  */
1759 static int
1760 fe_ioctl (struct ifnet * ifp, u_long command, caddr_t data, struct ucred *cr)
1761 {
1762         struct fe_softc *sc = ifp->if_softc;
1763         struct ifreq *ifr = (struct ifreq *)data;
1764         int s, error = 0;
1765
1766         s = splimp();
1767
1768         switch (command) {
1769
1770           case SIOCSIFADDR:
1771           case SIOCGIFADDR:
1772           case SIOCSIFMTU:
1773                 /* Just an ordinary action.  */
1774                 error = ether_ioctl(ifp, command, data);
1775                 break;
1776
1777           case SIOCSIFFLAGS:
1778                 /*
1779                  * Switch interface state between "running" and
1780                  * "stopped", reflecting the UP flag.
1781                  */
1782                 if (sc->sc_if.if_flags & IFF_UP) {
1783                         if ((sc->sc_if.if_flags & IFF_RUNNING) == 0)
1784                                 fe_init(sc);
1785                 } else {
1786                         if ((sc->sc_if.if_flags & IFF_RUNNING) != 0)
1787                                 fe_stop(sc);
1788                 }
1789
1790                 /*
1791                  * Promiscuous and/or multicast flags may have changed,
1792                  * so reprogram the multicast filter and/or receive mode.
1793                  */
1794                 fe_setmode(sc);
1795
1796                 /* Done.  */
1797                 break;
1798
1799           case SIOCADDMULTI:
1800           case SIOCDELMULTI:
1801                 /*
1802                  * Multicast list has changed; set the hardware filter
1803                  * accordingly.
1804                  */
1805                 fe_setmode(sc);
1806                 break;
1807
1808           case SIOCSIFMEDIA:
1809           case SIOCGIFMEDIA:
1810                 /* Let if_media to handle these commands and to call
1811                    us back.  */
1812                 error = ifmedia_ioctl(ifp, ifr, &sc->media, command);
1813                 break;
1814
1815           default:
1816                 error = EINVAL;
1817                 break;
1818         }
1819
1820         (void) splx(s);
1821         return (error);
1822 }
1823
1824 /*
1825  * Retrieve packet from receive buffer and send to the next level up via
1826  * ether_input().
1827  * Returns 0 if success, -1 if error (i.e., mbuf allocation failure).
1828  */
1829 static int
1830 fe_get_packet (struct fe_softc * sc, u_short len)
1831 {
1832         struct ether_header *eh;
1833         struct mbuf *m;
1834
1835         /*
1836          * NFS wants the data be aligned to the word (4 byte)
1837          * boundary.  Ethernet header has 14 bytes.  There is a
1838          * 2-byte gap.
1839          */
1840 #define NFS_MAGIC_OFFSET 2
1841
1842         /*
1843          * This function assumes that an Ethernet packet fits in an
1844          * mbuf (with a cluster attached when necessary.)  On FreeBSD
1845          * 2.0 for x86, which is the primary target of this driver, an
1846          * mbuf cluster has 4096 bytes, and we are happy.  On ancient
1847          * BSDs, such as vanilla 4.3 for 386, a cluster size was 1024,
1848          * however.  If the following #error message were printed upon
1849          * compile, you need to rewrite this function.
1850          */
1851 #if ( MCLBYTES < ETHER_MAX_LEN - ETHER_CRC_LEN + NFS_MAGIC_OFFSET )
1852 #error "Too small MCLBYTES to use fe driver."
1853 #endif
1854
1855         /*
1856          * Our strategy has one more problem.  There is a policy on
1857          * mbuf cluster allocation.  It says that we must have at
1858          * least MINCLSIZE (208 bytes on FreeBSD 2.0 for x86) to
1859          * allocate a cluster.  For a packet of a size between
1860          * (MHLEN - 2) to (MINCLSIZE - 2), our code violates the rule...
1861          * On the other hand, the current code is short, simple,
1862          * and fast, however.  It does no harmful thing, just waists
1863          * some memory.  Any comments?  FIXME.
1864          */
1865
1866         /* Allocate an mbuf with packet header info.  */
1867         MGETHDR(m, MB_DONTWAIT, MT_DATA);
1868         if (m == NULL)
1869                 return -1;
1870
1871         /* Attach a cluster if this packet doesn't fit in a normal mbuf.  */
1872         if (len > MHLEN - NFS_MAGIC_OFFSET) {
1873                 MCLGET(m, MB_DONTWAIT);
1874                 if (!(m->m_flags & M_EXT)) {
1875                         m_freem(m);
1876                         return -1;
1877                 }
1878         }
1879
1880         /* Initialize packet header info.  */
1881         m->m_pkthdr.rcvif = &sc->sc_if;
1882         m->m_pkthdr.len = len;
1883
1884         /* Set the length of this packet.  */
1885         m->m_len = len;
1886
1887         /* The following silliness is to make NFS happy */
1888         m->m_data += NFS_MAGIC_OFFSET;
1889
1890         /* Get (actually just point to) the header part.  */
1891         eh = mtod(m, struct ether_header *);
1892
1893         /* Get a packet.  */
1894 #ifdef FE_8BIT_SUPPORT
1895         if ((sc->proto_dlcr6 & FE_D6_SBW) == FE_D6_SBW_BYTE)
1896         {
1897                 fe_insb(sc, FE_BMPR8, (u_int8_t *)eh, len);
1898         }
1899         else
1900 #endif
1901         {
1902                 fe_insw(sc, FE_BMPR8, (u_int16_t *)eh, (len + 1) >> 1);
1903         }
1904
1905         /* Feed the packet to upper layer.  */
1906         (*sc->sc_if.if_input)(&sc->sc_if, m);
1907         return 0;
1908 }
1909
1910 /*
1911  * Write an mbuf chain to the transmission buffer memory using 16 bit PIO.
1912  * Returns number of bytes actually written, including length word.
1913  *
1914  * If an mbuf chain is too long for an Ethernet frame, it is not sent.
1915  * Packets shorter than Ethernet minimum are legal, and we pad them
1916  * before sending out.  An exception is "partial" packets which are
1917  * shorter than mandatory Ethernet header.
1918  */
1919 static void
1920 fe_write_mbufs (struct fe_softc *sc, struct mbuf *m)
1921 {
1922         u_short length, len;
1923         struct mbuf *mp;
1924         u_char *data;
1925         u_short savebyte;       /* WARNING: Architecture dependent!  */
1926 #define NO_PENDING_BYTE 0xFFFF
1927
1928         static u_char padding [ETHER_MIN_LEN - ETHER_CRC_LEN - ETHER_HDR_LEN];
1929
1930 #ifdef DIAGNOSTIC
1931         /* First, count up the total number of bytes to copy */
1932         length = 0;
1933         for (mp = m; mp != NULL; mp = mp->m_next)
1934                 length += mp->m_len;
1935
1936         /* Check if this matches the one in the packet header.  */
1937         if (length != m->m_pkthdr.len) {
1938                 printf("fe%d: packet length mismatch? (%d/%d)\n", sc->sc_unit,
1939                        length, m->m_pkthdr.len);
1940         }
1941 #else
1942         /* Just use the length value in the packet header.  */
1943         length = m->m_pkthdr.len;
1944 #endif
1945
1946 #ifdef DIAGNOSTIC
1947         /*
1948          * Should never send big packets.  If such a packet is passed,
1949          * it should be a bug of upper layer.  We just ignore it.
1950          * ... Partial (too short) packets, neither.
1951          */
1952         if (length < ETHER_HDR_LEN ||
1953             length > ETHER_MAX_LEN - ETHER_CRC_LEN) {
1954                 printf("fe%d: got an out-of-spec packet (%u bytes) to send\n",
1955                         sc->sc_unit, length);
1956                 sc->sc_if.if_oerrors++;
1957                 sc->mibdata.dot3StatsInternalMacTransmitErrors++;
1958                 return;
1959         }
1960 #endif
1961
1962         /*
1963          * Put the length word for this frame.
1964          * Does 86960 accept odd length?  -- Yes.
1965          * Do we need to pad the length to minimum size by ourselves?
1966          * -- Generally yes.  But for (or will be) the last
1967          * packet in the transmission buffer, we can skip the
1968          * padding process.  It may gain performance slightly.  FIXME.
1969          */
1970 #ifdef FE_8BIT_SUPPORT
1971         if ((sc->proto_dlcr6 & FE_D6_SBW) == FE_D6_SBW_BYTE)
1972         {
1973                 len = max(length, ETHER_MIN_LEN - ETHER_CRC_LEN);
1974                 fe_outb(sc, FE_BMPR8,  len & 0x00ff);
1975                 fe_outb(sc, FE_BMPR8, (len & 0xff00) >> 8);
1976         }
1977         else
1978 #endif
1979         {
1980                 fe_outw(sc, FE_BMPR8,
1981                         max(length, ETHER_MIN_LEN - ETHER_CRC_LEN));
1982         }
1983
1984         /*
1985          * Update buffer status now.
1986          * Truncate the length up to an even number, since we use outw().
1987          */
1988 #ifdef FE_8BIT_SUPPORT
1989         if ((sc->proto_dlcr6 & FE_D6_SBW) != FE_D6_SBW_BYTE)
1990 #endif
1991         {
1992                 length = (length + 1) & ~1;
1993         }
1994         sc->txb_free -= FE_DATA_LEN_LEN +
1995             max(length, ETHER_MIN_LEN - ETHER_CRC_LEN);
1996         sc->txb_count++;
1997
1998         /*
1999          * Transfer the data from mbuf chain to the transmission buffer.
2000          * MB86960 seems to require that data be transferred as words, and
2001          * only words.  So that we require some extra code to patch
2002          * over odd-length mbufs.
2003          */
2004 #ifdef FE_8BIT_SUPPORT
2005         if ((sc->proto_dlcr6 & FE_D6_SBW) == FE_D6_SBW_BYTE)
2006         {
2007                 /* 8-bit cards are easy.  */
2008                 for (mp = m; mp != 0; mp = mp->m_next) {
2009                         if (mp->m_len)
2010                                 fe_outsb(sc, FE_BMPR8, mtod(mp, caddr_t),
2011                                          mp->m_len);
2012                 }
2013         }
2014         else
2015 #endif
2016         {
2017                 /* 16-bit cards are a pain.  */
2018                 savebyte = NO_PENDING_BYTE;
2019                 for (mp = m; mp != 0; mp = mp->m_next) {
2020
2021                         /* Ignore empty mbuf.  */
2022                         len = mp->m_len;
2023                         if (len == 0)
2024                                 continue;
2025
2026                         /* Find the actual data to send.  */
2027                         data = mtod(mp, caddr_t);
2028
2029                         /* Finish the last byte.  */
2030                         if (savebyte != NO_PENDING_BYTE) {
2031                                 fe_outw(sc, FE_BMPR8, savebyte | (*data << 8));
2032                                 data++;
2033                                 len--;
2034                                 savebyte = NO_PENDING_BYTE;
2035                         }
2036
2037                         /* output contiguous words */
2038                         if (len > 1) {
2039                                 fe_outsw(sc, FE_BMPR8, (u_int16_t *)data,
2040                                          len >> 1);
2041                                 data += len & ~1;
2042                                 len &= 1;
2043                         }
2044
2045                         /* Save a remaining byte, if there is one.  */
2046                         if (len > 0)
2047                                 savebyte = *data;
2048                 }
2049
2050                 /* Spit the last byte, if the length is odd.  */
2051                 if (savebyte != NO_PENDING_BYTE)
2052                         fe_outw(sc, FE_BMPR8, savebyte);
2053         }
2054
2055         /* Pad to the Ethernet minimum length, if the packet is too short.  */
2056         if (length < ETHER_MIN_LEN - ETHER_CRC_LEN) {
2057 #ifdef FE_8BIT_SUPPORT
2058                 if ((sc->proto_dlcr6 & FE_D6_SBW) == FE_D6_SBW_BYTE)
2059                 {
2060                         fe_outsb(sc, FE_BMPR8, padding,
2061                                  ETHER_MIN_LEN - ETHER_CRC_LEN - length);
2062                 }
2063                 else
2064 #endif
2065                 {
2066                         fe_outsw(sc, FE_BMPR8, (u_int16_t *)padding,
2067                                  (ETHER_MIN_LEN - ETHER_CRC_LEN - length) >> 1);
2068                 }
2069         }
2070 }
2071
2072 /*
2073  * Compute hash value for an Ethernet address
2074  */
2075 static int
2076 fe_hash ( u_char * ep )
2077 {
2078 #define FE_HASH_MAGIC_NUMBER 0xEDB88320L
2079
2080         u_long hash = 0xFFFFFFFFL;
2081         int i, j;
2082         u_char b;
2083         u_long m;
2084
2085         for ( i = ETHER_ADDR_LEN; --i >= 0; ) {
2086                 b = *ep++;
2087                 for ( j = 8; --j >= 0; ) {
2088                         m = hash;
2089                         hash >>= 1;
2090                         if ( ( m ^ b ) & 1 ) hash ^= FE_HASH_MAGIC_NUMBER;
2091                         b >>= 1;
2092                 }
2093         }
2094         return ( ( int )( hash >> 26 ) );
2095 }
2096
2097 /*
2098  * Compute the multicast address filter from the
2099  * list of multicast addresses we need to listen to.
2100  */
2101 static struct fe_filter
2102 fe_mcaf ( struct fe_softc *sc )
2103 {
2104         int index;
2105         struct fe_filter filter;
2106         struct ifmultiaddr *ifma;
2107
2108         filter = fe_filter_nothing;
2109         for (ifma = sc->arpcom.ac_if.if_multiaddrs.lh_first; ifma;
2110              ifma = ifma->ifma_link.le_next) {
2111                 if (ifma->ifma_addr->sa_family != AF_LINK)
2112                         continue;
2113                 index = fe_hash(LLADDR((struct sockaddr_dl *)ifma->ifma_addr));
2114 #ifdef FE_DEBUG
2115                 printf("fe%d: hash(%6D) == %d\n",
2116                         sc->sc_unit, enm->enm_addrlo , ":", index);
2117 #endif
2118
2119                 filter.data[index >> 3] |= 1 << (index & 7);
2120         }
2121         return ( filter );
2122 }
2123
2124 /*
2125  * Calculate a new "multicast packet filter" and put the 86960
2126  * receiver in appropriate mode.
2127  */
2128 static void
2129 fe_setmode (struct fe_softc *sc)
2130 {
2131         int flags = sc->sc_if.if_flags;
2132
2133         /*
2134          * If the interface is not running, we postpone the update
2135          * process for receive modes and multicast address filter
2136          * until the interface is restarted.  It reduces some
2137          * complicated job on maintaining chip states.  (Earlier versions
2138          * of this driver had a bug on that point...)
2139          *
2140          * To complete the trick, fe_init() calls fe_setmode() after
2141          * restarting the interface.
2142          */
2143         if (!(flags & IFF_RUNNING))
2144                 return;
2145
2146         /*
2147          * Promiscuous mode is handled separately.
2148          */
2149         if (flags & IFF_PROMISC) {
2150                 /*
2151                  * Program 86960 to receive all packets on the segment
2152                  * including those directed to other stations.
2153                  * Multicast filter stored in MARs are ignored
2154                  * under this setting, so we don't need to update it.
2155                  *
2156                  * Promiscuous mode in FreeBSD 2 is used solely by
2157                  * BPF, and BPF only listens to valid (no error) packets.
2158                  * So, we ignore erroneous ones even in this mode.
2159                  * (Older versions of fe driver mistook the point.)
2160                  */
2161                 fe_outb(sc, FE_DLCR5,
2162                         sc->proto_dlcr5 | FE_D5_AFM0 | FE_D5_AFM1);
2163                 sc->filter_change = 0;
2164                 return;
2165         }
2166
2167         /*
2168          * Turn the chip to the normal (non-promiscuous) mode.
2169          */
2170         fe_outb(sc, FE_DLCR5, sc->proto_dlcr5 | FE_D5_AFM1);
2171
2172         /*
2173          * Find the new multicast filter value.
2174          */
2175         if (flags & IFF_ALLMULTI)
2176                 sc->filter = fe_filter_all;
2177         else
2178                 sc->filter = fe_mcaf(sc);
2179         sc->filter_change = 1;
2180
2181         /*
2182          * We have to update the multicast filter in the 86960, A.S.A.P.
2183          *
2184          * Note that the DLC (Data Link Control unit, i.e. transmitter
2185          * and receiver) must be stopped when feeding the filter, and
2186          * DLC trashes all packets in both transmission and receive
2187          * buffers when stopped.
2188          *
2189          * To reduce the packet loss, we delay the filter update
2190          * process until buffers are empty.
2191          */
2192         if (sc->txb_sched == 0 && sc->txb_count == 0 &&
2193             !(fe_inb(sc, FE_DLCR1) & FE_D1_PKTRDY)) {
2194                 /*
2195                  * Buffers are (apparently) empty.  Load
2196                  * the new filter value into MARs now.
2197                  */
2198                 fe_loadmar(sc);
2199         } else {
2200                 /*
2201                  * Buffers are not empty.  Mark that we have to update
2202                  * the MARs.  The new filter will be loaded by feintr()
2203                  * later.
2204                  */
2205         }
2206 }
2207
2208 /*
2209  * Load a new multicast address filter into MARs.
2210  *
2211  * The caller must have splimp'ed before fe_loadmar.
2212  * This function starts the DLC upon return.  So it can be called only
2213  * when the chip is working, i.e., from the driver's point of view, when
2214  * a device is RUNNING.  (I mistook the point in previous versions.)
2215  */
2216 static void
2217 fe_loadmar (struct fe_softc * sc)
2218 {
2219         /* Stop the DLC (transmitter and receiver).  */
2220         DELAY(200);
2221         fe_outb(sc, FE_DLCR6, sc->proto_dlcr6 | FE_D6_DLC_DISABLE);
2222         DELAY(200);
2223
2224         /* Select register bank 1 for MARs.  */
2225         fe_outb(sc, FE_DLCR7, sc->proto_dlcr7 | FE_D7_RBS_MAR | FE_D7_POWER_UP);
2226
2227         /* Copy filter value into the registers.  */
2228         fe_outblk(sc, FE_MAR8, sc->filter.data, FE_FILTER_LEN);
2229
2230         /* Restore the bank selection for BMPRs (i.e., runtime registers).  */
2231         fe_outb(sc, FE_DLCR7,
2232                 sc->proto_dlcr7 | FE_D7_RBS_BMPR | FE_D7_POWER_UP);
2233
2234         /* Restart the DLC.  */
2235         DELAY(200);
2236         fe_outb(sc, FE_DLCR6, sc->proto_dlcr6 | FE_D6_DLC_ENABLE);
2237         DELAY(200);
2238
2239         /* We have just updated the filter.  */
2240         sc->filter_change = 0;
2241 }
2242
2243 /* Change the media selection.  */
2244 static int
2245 fe_medchange (struct ifnet *ifp)
2246 {
2247         struct fe_softc *sc = (struct fe_softc *)ifp->if_softc;
2248
2249 #ifdef DIAGNOSTIC
2250         /* If_media should not pass any request for a media which this
2251            interface doesn't support.  */
2252         int b;
2253
2254         for (b = 0; bit2media[b] != 0; b++) {
2255                 if (bit2media[b] == sc->media.ifm_media) break;
2256         }
2257         if (((1 << b) & sc->mbitmap) == 0) {
2258                 printf("fe%d: got an unsupported media request (0x%x)\n",
2259                        sc->sc_unit, sc->media.ifm_media);
2260                 return EINVAL;
2261         }
2262 #endif
2263
2264         /* We don't actually change media when the interface is down.
2265            fe_init() will do the job, instead.  Should we also wait
2266            until the transmission buffer being empty?  Changing the
2267            media when we are sending a frame will cause two garbages
2268            on wires, one on old media and another on new.  FIXME */
2269         if (sc->sc_if.if_flags & IFF_UP) {
2270                 if (sc->msel) sc->msel(sc);
2271         }
2272
2273         return 0;
2274 }
2275
2276 /* I don't know how I can support media status callback... FIXME.  */
2277 static void
2278 fe_medstat (struct ifnet *ifp, struct ifmediareq *ifmr)
2279 {
2280         (void)ifp;
2281         (void)ifmr;
2282 }