sys/dev/de/if_devar.h

   1 /*      $NetBSD: if_devar.h,v 1.32 1999/04/01 14:55:25 tsubai Exp $     */
   2
   3 /* $FreeBSD$ */
   4
   5 /*-
   6  * Copyright (c) 1994-1997 Matt Thomas (matt@3am-software.com)
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. The name of the author may not be used to endorse or promote products
  15  *    derived from this software without specific prior written permission
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * Id: if_devar.h,v 1.28 1997/07/03 16:55:07 thomas Exp
  29  */
  30
  31 #ifndef DEV_DE_IF_DEVAR_H
  32 #define DEV_DE_IF_DEVAR_H
  33
  34 typedef bus_addr_t tulip_csrptr_t;
  35
  36 #define TULIP_PCI_CSRSIZE       8
  37 #define TULIP_PCI_CSROFFSET     0
  38
  39 #define TULIP_CSR_READ(sc, csr)                 \
  40         bus_space_read_4((sc)->tulip_csrs_bst,  \
  41                          (sc)->tulip_csrs_bsh,  \
  42                          (sc)->tulip_csrs.csr)
  43 #define TULIP_CSR_WRITE(sc, csr, val)                   \
  44         bus_space_write_4((sc)->tulip_csrs_bst,         \
  45                           (sc)->tulip_csrs_bsh,         \
  46                           (sc)->tulip_csrs.csr, val)
  47
  48 /*
  49  * This structure contains "pointers" for the registers on
  50  * the various 21x4x chips.  CSR0 through CSR8 are common
  51  * to all chips.  After that, it gets messy...
  52  */
  53 typedef struct {
  54         tulip_csrptr_t  csr_busmode;    /* CSR0 */
  55         tulip_csrptr_t  csr_txpoll;     /* CSR1 */
  56         tulip_csrptr_t  csr_rxpoll;     /* CSR2 */
  57         tulip_csrptr_t  csr_rxlist;     /* CSR3 */
  58         tulip_csrptr_t  csr_txlist;     /* CSR4 */
  59         tulip_csrptr_t  csr_status;     /* CSR5 */
  60         tulip_csrptr_t  csr_command;    /* CSR6 */
  61         tulip_csrptr_t  csr_intr;       /* CSR7 */
  62         tulip_csrptr_t  csr_missed_frames;      /* CSR8 */
  63         tulip_csrptr_t  csr_9;          /* CSR9 */
  64         tulip_csrptr_t  csr_10;         /* CSR10 */
  65         tulip_csrptr_t  csr_11;         /* CSR11 */
  66         tulip_csrptr_t  csr_12;         /* CSR12 */
  67         tulip_csrptr_t  csr_13;         /* CSR13 */
  68         tulip_csrptr_t  csr_14;         /* CSR14 */
  69         tulip_csrptr_t  csr_15;         /* CSR15 */
  70 } tulip_regfile_t;
  71
  72 #define csr_enetrom             csr_9   /* 21040 */
  73 #define csr_reserved            csr_10  /* 21040 */
  74 #define csr_full_duplex         csr_11  /* 21040 */
  75 #define csr_bootrom             csr_10  /* 21041/21140A/?? */
  76 #define csr_gp                  csr_12  /* 21140* */
  77 #define csr_watchdog            csr_15  /* 21140* */
  78 #define csr_gp_timer            csr_11  /* 21041/21140* */
  79 #define csr_srom_mii            csr_9   /* 21041/21140* */
  80 #define csr_sia_status          csr_12  /* 2104x */
  81 #define csr_sia_connectivity    csr_13  /* 2104x */
  82 #define csr_sia_tx_rx           csr_14  /* 2104x */
  83 #define csr_sia_general         csr_15  /* 2104x */
  84
  85 /*
  86  * While 21x4x allows chaining of its descriptors, this driver
  87  * doesn't take advantage of it.  We keep the descriptors in a
  88  * traditional FIFO ring.
  89  */
  90 typedef struct {
  91         tulip_desc_t    *di_desc;
  92         struct mbuf     *di_mbuf;
  93         bus_dmamap_t    *di_map;
  94 } tulip_descinfo_t;
  95
  96 typedef struct {
  97         tulip_descinfo_t *ri_first;     /* first entry in ring */
  98         tulip_descinfo_t *ri_last;      /* one after last entry */
  99         tulip_descinfo_t *ri_nextin;    /* next to processed by host */
 100         tulip_descinfo_t *ri_nextout;   /* next to processed by adapter */
 101         int             ri_max;
 102         int             ri_free;
 103         tulip_desc_t    *ri_descs;
 104         tulip_descinfo_t *ri_descinfo;
 105         bus_dma_tag_t   ri_ring_tag;
 106         bus_dmamap_t    ri_ring_map;
 107         bus_addr_t      ri_dma_addr;
 108         bus_dma_tag_t   ri_data_tag;
 109         bus_dmamap_t    *ri_data_maps;
 110 } tulip_ringinfo_t;
 111
 112 /*
 113  * The 21040 has a stupid restriction in that the receive
 114  * buffers must be longword aligned.  But since Ethernet
 115  * headers are not a multiple of longwords in size this forces
 116  * the data to non-longword aligned.  Since IP requires the
 117  * data to be longword aligned, we need to copy it after it has
 118  * been DMA'ed in our memory.
 119  *
 120  * Since we have to copy it anyways, we might as well as allocate
 121  * dedicated receive space for the input.  This allows to use a
 122  * small receive buffer size and more ring entries to be able to
 123  * better keep with a flood of tiny Ethernet packets.
 124  *
 125  * The receive space MUST ALWAYS be a multiple of the page size.
 126  * And the number of receive descriptors multiplied by the size
 127  * of the receive buffers must equal the receive space.  This
 128  * is so that we can manipulate the page tables so that even if a
 129  * packet wraps around the end of the receive space, we can
 130  * treat it as virtually contiguous.
 131  *
 132  * The above used to be true (the stupid restriction is still true)
 133  * but we gone to directly DMA'ing into MBUFs (unless it's on an
 134  * architecture which can't handle unaligned accesses) because with
 135  * 100Mb/s cards the copying is just too much of a hit.
 136  */
 137
 138 #define TULIP_TXTIMER           4
 139 #define TULIP_RXDESCS           48
 140 #define TULIP_TXDESCS           128
 141 #define TULIP_RXQ_TARGET        32
 142 #if TULIP_RXQ_TARGET >= TULIP_RXDESCS
 143 #error  TULIP_RXQ_TARGET must be less than TULIP_RXDESCS
 144 #endif
 145 #define TULIP_RX_BUFLEN         ((MCLBYTES < 2048 ? MCLBYTES : 2048) - 16)
 146
 147 /*
 148  * Forward reference to make C happy.
 149  */
 150 typedef struct tulip_softc      tulip_softc_t;
 151
 152 /*
 153  * Enumeration of the various controllers supported.
 154  */
 155 typedef enum {
 156         TULIP_21040,
 157         TULIP_21041,
 158         TULIP_21140,
 159         TULIP_21140A,
 160         TULIP_21142,
 161         TULIP_21143,
 162         TULIP_CHIPID_UNKNOWN
 163 } tulip_chipid_t;
 164
 165 /*
 166  * Various physical media types supported.
 167  * BNCAUI is BNC or AUI since on the 21040 you can't really tell
 168  * which is in use.
 169  */
 170 typedef enum {
 171         TULIP_MEDIA_UNKNOWN,
 172         TULIP_MEDIA_10BASET,
 173         TULIP_MEDIA_10BASET_FD,
 174         TULIP_MEDIA_BNC,
 175         TULIP_MEDIA_AUI,
 176         TULIP_MEDIA_EXTSIA,
 177         TULIP_MEDIA_AUIBNC,
 178         TULIP_MEDIA_100BASETX,
 179         TULIP_MEDIA_100BASETX_FD,
 180         TULIP_MEDIA_100BASET4,
 181         TULIP_MEDIA_100BASEFX,
 182         TULIP_MEDIA_100BASEFX_FD,
 183         TULIP_MEDIA_MAX
 184 } tulip_media_t;
 185
 186 #define TULIP_BIT(b)            (1L << ((int)(b)))
 187 #define TULIP_FDBIT(m)          (1L << ((int)TULIP_MEDIA_ ## m ## _FD))
 188 #define TULIP_MBIT(m)           (1L << ((int)TULIP_MEDIA_ ## m ))
 189 #define TULIP_IS_MEDIA_FD(m)    (TULIP_BIT(m) & \
 190                                  (TULIP_FDBIT(10BASET) | \
 191                                   TULIP_FDBIT(100BASETX) | \
 192                                   TULIP_FDBIT(100BASEFX)))
 193 #define TULIP_CAN_MEDIA_FD(m)   (TULIP_BIT(m) & \
 194                                  (TULIP_MBIT(10BASET) | \
 195                                   TULIP_MBIT(100BASETX) | \
 196                                   TULIP_MBIT(100BASEFX)))
 197 #define TULIP_FD_MEDIA_OF(m)    ((tulip_media_t)((m) + 1))
 198 #define TULIP_HD_MEDIA_OF(m)    ((tulip_media_t)((m) - 1))
 199 #define TULIP_IS_MEDIA_100MB(m) ((m) >= TULIP_MEDIA_100BASETX)
 200 #define TULIP_IS_MEDIA_TP(m)    ((TULIP_BIT(m) & \
 201                                   (TULIP_MBIT(BNC) | \
 202                                    TULIP_MBIT(AUI) | \
 203                                    TULIP_MBIT(AUIBNC) | \
 204                                    TULIP_MBIT(EXTSIA))) == 0)
 205
 206 #define TULIP_SROM_ATTR_MII             0x0100
 207 #define TULIP_SROM_ATTR_NWAY            0x0200
 208 #define TULIP_SROM_ATTR_AUTOSENSE       0x0400
 209 #define TULIP_SROM_ATTR_POWERUP         0x0800
 210 #define TULIP_SROM_ATTR_NOLINKPASS      0x1000
 211
 212 typedef struct {
 213         enum {
 214                 TULIP_MEDIAINFO_NONE,
 215                 TULIP_MEDIAINFO_SIA,
 216                 TULIP_MEDIAINFO_GPR,
 217                 TULIP_MEDIAINFO_MII,
 218                 TULIP_MEDIAINFO_RESET,
 219                 TULIP_MEDIAINFO_SYM
 220         } mi_type;
 221         union {
 222                 struct {
 223                         u_int16_t sia_connectivity;
 224                         u_int16_t sia_tx_rx;
 225                         u_int16_t sia_general;
 226                         u_int32_t sia_gp_control;       /* 21142/21143 */
 227                         u_int32_t sia_gp_data;          /* 21142/21143 */
 228                 } un_sia;
 229                 struct {
 230                         u_int32_t gpr_cmdmode;
 231                         u_int32_t gpr_gpcontrol;        /* 21142/21143 */
 232                         u_int32_t gpr_gpdata;
 233                         u_int8_t gpr_actmask;
 234                         u_int8_t gpr_actdata;
 235                         u_int gpr_default:1;
 236                 } un_gpr;
 237                 struct {
 238                         u_int32_t mii_mediamask;
 239                         u_int16_t mii_capabilities;
 240                         u_int16_t mii_advertisement;
 241                         u_int16_t mii_full_duplex;
 242                         u_int16_t mii_tx_threshold;
 243                         u_int16_t mii_interrupt;        /* 21142/21143 */
 244                         u_int8_t mii_phyaddr;
 245                         u_int8_t mii_gpr_length;
 246                         u_int8_t mii_gpr_offset;
 247                         u_int8_t mii_reset_length;
 248                         u_int8_t mii_reset_offset;
 249                         u_int32_t mii_phyid;
 250                 } un_mii;
 251         } mi_un;
 252 } tulip_media_info_t;
 253
 254 #define mi_sia_connectivity     mi_un.un_sia.sia_connectivity
 255 #define mi_sia_tx_rx            mi_un.un_sia.sia_tx_rx
 256 #define mi_sia_general          mi_un.un_sia.sia_general
 257 #define mi_sia_gp_control       mi_un.un_sia.sia_gp_control
 258 #define mi_sia_gp_data          mi_un.un_sia.sia_gp_data
 259
 260 #define mi_gpcontrol            mi_un.un_gpr.gpr_gpcontrol
 261 #define mi_gpdata               mi_un.un_gpr.gpr_gpdata
 262 #define mi_actmask              mi_un.un_gpr.gpr_actmask
 263 #define mi_actdata              mi_un.un_gpr.gpr_actdata
 264 #define mi_default              mi_un.un_gpr.gpr_default
 265 #define mi_cmdmode              mi_un.un_gpr.gpr_cmdmode
 266
 267 #define mi_phyaddr              mi_un.un_mii.mii_phyaddr
 268 #define mi_gpr_length           mi_un.un_mii.mii_gpr_length
 269 #define mi_gpr_offset           mi_un.un_mii.mii_gpr_offset
 270 #define mi_reset_length         mi_un.un_mii.mii_reset_length
 271 #define mi_reset_offset         mi_un.un_mii.mii_reset_offset
 272 #define mi_capabilities         mi_un.un_mii.mii_capabilities
 273 #define mi_advertisement        mi_un.un_mii.mii_advertisement
 274 #define mi_full_duplex          mi_un.un_mii.mii_full_duplex
 275 #define mi_tx_threshold         mi_un.un_mii.mii_tx_threshold
 276 #define mi_mediamask            mi_un.un_mii.mii_mediamask
 277 #define mi_mii_interrupt        mi_un.un_mii.mii_interrupt
 278 #define mi_phyid                mi_un.un_mii.mii_phyid
 279
 280 #define TULIP_MEDIAINFO_SIA_INIT(sc, mi, chipid, media) do {            \
 281         (mi)->mi_type = TULIP_MEDIAINFO_SIA;                            \
 282         sc->tulip_mediums[TULIP_MEDIA_ ## media] = (mi);                \
 283         (mi)->mi_sia_connectivity = TULIP_ ## chipid ## _SIACONN_ ## media; \
 284         (mi)->mi_sia_tx_rx = TULIP_ ## chipid ## _SIATXRX_ ## media;    \
 285         (mi)->mi_sia_general = TULIP_ ## chipid ## _SIAGEN_ ## media;   \
 286 } while (0)
 287
 288 #define TULIP_MEDIAINFO_ADD_CAPABILITY(sc, mi, media) do {              \
 289         if ((sc)->tulip_mediums[TULIP_MEDIA_ ## media] == NULL          \
 290             && ((mi)->mi_capabilities & PHYSTS_ ## media)) {            \
 291                 (sc)->tulip_mediums[TULIP_MEDIA_ ## media] = (mi);      \
 292                 (mi)->mi_mediamask |= TULIP_BIT(TULIP_MEDIA_ ## media); \
 293         }                                                               \
 294 } while (0)
 295
 296 #define TULIP_MII_NOPHY         32
 297 /*
 298  * Some boards need to treated specially.  The following enumeration
 299  * identifies the cards with quirks (or those we just want to single
 300  * out for special merit or scorn).
 301  */
 302 typedef enum {
 303         TULIP_21040_GENERIC,    /* Generic 21040 (works with most any board) */
 304         TULIP_21140_ISV,        /* Digital Semicondutor 21140 ISV SROM Format */
 305         TULIP_21142_ISV,        /* Digital Semicondutor 21142 ISV SROM Format */
 306         TULIP_21143_ISV,        /* Digital Semicondutor 21143 ISV SROM Format */
 307         TULIP_21140_DEC_EB,     /* Digital Semicondutor 21140 Eval. Board */
 308         TULIP_21140_MII,        /* 21140[A] with MII */
 309         TULIP_21140_DEC_DE500,  /* Digital DE500-?? 10/100 */
 310         TULIP_21140_SMC_9332,   /* SMC 9332 */
 311         TULIP_21140_COGENT_EM100,       /* Cogent EM100 100 only */
 312         TULIP_21140_ZNYX_ZX34X, /* ZNYX ZX342 10/100 */
 313         TULIP_21140_ASANTE,     /* AsanteFast 10/100 */
 314         TULIP_21140_EN1207,     /* Accton EN2107 10/100 BNC */
 315         TULIP_21041_GENERIC     /* Generic 21041 card */
 316 } tulip_board_t;
 317
 318 typedef enum {
 319         TULIP_MEDIAPOLL_TIMER,          /* 100ms timer fired */
 320         TULIP_MEDIAPOLL_FASTTIMER,      /* <100ms timer fired */
 321         TULIP_MEDIAPOLL_LINKFAIL,       /* called from interrupt routine */
 322         TULIP_MEDIAPOLL_LINKPASS,       /* called from interrupt routine */
 323         TULIP_MEDIAPOLL_START,          /* start a media probe (from reset) */
 324         TULIP_MEDIAPOLL_TXPROBE_OK,     /* txprobe succeeded */
 325         TULIP_MEDIAPOLL_TXPROBE_FAILED, /* txprobe failed */
 326         TULIP_MEDIAPOLL_MAX
 327 } tulip_mediapoll_event_t;
 328
 329 typedef enum {
 330         TULIP_LINK_DOWN,        /* Link is down */
 331         TULIP_LINK_UP,          /* link is ok */
 332         TULIP_LINK_UNKNOWN      /* we can't tell either way */
 333 } tulip_link_status_t;
 334
 335 /*
 336  * This data structure is used to abstract out the quirks.
 337  * media_probe  = tries to determine the media type.
 338  * media_select = enables the current media (or autosenses)
 339  * media_poll   = autosenses media
 340  * media_preset = 21140, etal requires bit to set before the
 341  *                the software reset; hence pre-set.  Should be
 342  *                pre-reset but that's ugly.
 343  */
 344 typedef struct {
 345         tulip_board_t bd_type;
 346         void (*bd_media_probe)(tulip_softc_t * const sc);
 347         void (*bd_media_select)(tulip_softc_t * const sc);
 348         void (*bd_media_poll)(tulip_softc_t * const sc,
 349     tulip_mediapoll_event_t event);
 350         void (*bd_media_preset) (tulip_softc_t * const sc);
 351 } tulip_boardsw_t;
 352
 353 /*
 354  * The next few declarations are for MII/PHY based boards.
 355  *
 356  *    The first enumeration identifies a superset of various datums
 357  * that can be obtained from various PHY chips.  Not all PHYs will
 358  * support all datums.
 359  *    The modedata structure indicates what register contains
 360  * a datum, what mask is applied the register contents, and what the
 361  * result should be.
 362  *    The attr structure records information about a supported PHY.
 363  *    The phy structure records information about a PHY instance.
 364  */
 365 typedef enum {
 366         PHY_MODE_10T,
 367         PHY_MODE_100TX,
 368         PHY_MODE_100T4,
 369         PHY_MODE_FULLDUPLEX,
 370         PHY_MODE_MAX
 371 } tulip_phy_mode_t;
 372
 373 typedef struct {
 374         u_int16_t       pm_regno;
 375         u_int16_t       pm_mask;
 376         u_int16_t       pm_value;
 377 } tulip_phy_modedata_t;
 378
 379 typedef struct {
 380         u_int32_t       attr_id;
 381         u_int16_t       attr_flags;
 382         tulip_phy_modedata_t    attr_modes[PHY_MODE_MAX];
 383 #ifdef TULIP_DEBUG
 384         const char      *attr_name;
 385 #endif
 386 } tulip_phy_attr_t;
 387
 388 /* Definitions for tulip_phy_attr_t.attr_flags */
 389 #define PHY_NEED_HARD_RESET     0x0001
 390 #define PHY_DUAL_CYCLE_TA       0x0002
 391
 392 /*
 393  * Various probe states used when trying to autosense the media.
 394  */
 395 typedef enum {
 396         TULIP_PROBE_INACTIVE,
 397         TULIP_PROBE_PHYRESET,
 398         TULIP_PROBE_PHYAUTONEG,
 399         TULIP_PROBE_GPRTEST,
 400         TULIP_PROBE_MEDIATEST,
 401         TULIP_PROBE_FAILED
 402 } tulip_probe_state_t;
 403
 404 typedef struct {
 405         /*
 406          * Transmit Statistics
 407          */
 408         u_int32_t       dot3StatsSingleCollisionFrames;
 409         u_int32_t       dot3StatsMultipleCollisionFrames;
 410         u_int32_t       dot3StatsSQETestErrors;
 411         u_int32_t       dot3StatsDeferredTransmissions;
 412         u_int32_t       dot3StatsLateCollisions;
 413         u_int32_t       dot3StatsExcessiveCollisions;
 414         u_int32_t       dot3StatsCarrierSenseErrors;
 415         u_int32_t       dot3StatsInternalMacTransmitErrors;
 416         /* not in rfc1650! */
 417         u_int32_t       dot3StatsInternalTransmitUnderflows;
 418         /* not in rfc1650! */
 419         u_int32_t       dot3StatsInternalTransmitBabbles;
 420         /*
 421          * Receive Statistics
 422          */
 423         u_int32_t       dot3StatsMissedFrames;  /* not in rfc1650! */
 424         u_int32_t       dot3StatsAlignmentErrors;
 425         u_int32_t       dot3StatsFCSErrors;
 426         u_int32_t       dot3StatsFrameTooLongs;
 427         u_int32_t       dot3StatsInternalMacReceiveErrors;
 428 } tulip_dot3_stats_t;
 429
 430 /*
 431  * Probe information.
 432  */
 433 struct tulip_probe_info {
 434         u_int8_t        probe_count;            /* count of probe operations */
 435         int32_t         probe_timeout;          /* time (ms) of probe timeout */
 436         tulip_probe_state_t     probe_state;    /* current media probe state */
 437         tulip_media_t   probe_media;            /* current media being probed */
 438         u_int32_t       probe_mediamask;        /* medias checked */
 439         u_int32_t       probe_passes;           /* times autosense failed */
 440         u_int32_t       probe_txprobes;         /* txprobes attempted */
 441 };
 442
 443 /*
 444  * Debugging/Statistical information.
 445  */
 446 struct tulip_dbg_info {
 447         tulip_media_t   dbg_last_media;
 448         u_int32_t       dbg_intrs;
 449         u_int32_t       dbg_media_probes;
 450         u_int32_t       dbg_txprobe_nocarr;
 451         u_int32_t       dbg_txprobe_exccoll;
 452         u_int32_t       dbg_link_downed;
 453         u_int32_t       dbg_link_suspected;
 454         u_int32_t       dbg_link_intrs;
 455         u_int32_t       dbg_link_pollintrs;
 456         u_int32_t       dbg_link_failures;
 457         u_int32_t       dbg_nway_starts;
 458         u_int32_t       dbg_nway_failures;
 459         u_int16_t       dbg_phyregs[32][4];
 460         u_int32_t       dbg_rxlowbufs;
 461         u_int32_t       dbg_rxintrs;
 462         u_int32_t       dbg_last_rxintrs;
 463         u_int32_t       dbg_high_rxintrs_hz;
 464         u_int32_t       dbg_no_txmaps;
 465         u_int32_t       dbg_txput_finishes[8];
 466         u_int32_t       dbg_txprobes_ok[TULIP_MEDIA_MAX];
 467         u_int32_t       dbg_txprobes_failed[TULIP_MEDIA_MAX];
 468         u_int32_t       dbg_events[TULIP_MEDIAPOLL_MAX];
 469         u_int32_t       dbg_rxpktsperintr[TULIP_RXDESCS];
 470 };
 471
 472 /*
 473  * Performance statistics.
 474  */
 475 struct tulip_perfstat {
 476         u_quad_t        perf_intr_cycles;
 477         u_quad_t        perf_ifstart_cycles;
 478         u_quad_t        perf_ifstart_one_cycles;
 479         u_quad_t        perf_ifioctl_cycles;
 480         u_quad_t        perf_stat_cycles;
 481         u_quad_t        perf_timeout_cycles;
 482         u_quad_t        perf_txput_cycles;
 483         u_quad_t        perf_txintr_cycles;
 484         u_quad_t        perf_rxintr_cycles;
 485         u_quad_t        perf_rxget_cycles;
 486         unsigned int    perf_intr;
 487         unsigned int    perf_ifstart;
 488         unsigned int    perf_ifstart_one;
 489         unsigned int    perf_ifioctl;
 490         unsigned int    perf_stat;
 491         unsigned int    perf_timeout;
 492         unsigned int    perf_txput;
 493         unsigned int    perf_txintr;
 494         unsigned int    perf_rxintr;
 495         unsigned int    perf_rxget;
 496 };
 497 #define TULIP_PERF_CURRENT      0
 498 #define TULIP_PERF_PREVIOUS     1
 499 #define TULIP_PERF_TOTAL        2
 500 #define TULIP_PERF_MAX          3
 501
 502 /*
 503  * Per-driver-instance state.
 504  */
 505 struct tulip_softc {
 506         device_t                tulip_dev;
 507         struct ifmedia          tulip_ifmedia;
 508         int                     tulip_unit;
 509         struct ifnet            *tulip_ifp;
 510         u_char                  tulip_enaddr[ETHER_ADDR_LEN];
 511         bus_space_tag_t         tulip_csrs_bst;
 512         bus_space_handle_t      tulip_csrs_bsh;
 513         tulip_regfile_t         tulip_csrs;
 514
 515         u_int32_t               tulip_flags;
 516         u_int32_t               tulip_features;
 517         u_int32_t               tulip_intrmask;
 518         u_int32_t               tulip_cmdmode;
 519         u_int32_t               tulip_last_system_error:3;
 520         u_int32_t               tulip_txtimer:3;        /* transmission timer */
 521         u_int32_t               tulip_system_errors;
 522         u_int32_t               tulip_statusbits;       /* status bits from
 523                                                          * CSR5 that may need
 524                                                          * to be printed
 525                                                          */
 526         tulip_media_info_t      *tulip_mediums[TULIP_MEDIA_MAX];
 527         tulip_media_t           tulip_media;            /* current media type */
 528         u_int32_t               tulip_abilities;        /* remote system's
 529                                                          * abilities (as
 530                                                          * defined in IEEE
 531                                                          * 802.3u)
 532                                                          */
 533         u_int8_t                tulip_revinfo;          /* chip revision */
 534         u_int8_t                tulip_phyaddr;          /* current phy */
 535         u_int8_t                tulip_gpinit;           /* active pins on
 536                                                          * 21140
 537                                                          */
 538         u_int8_t                tulip_gpdata;   /* default gpdata for 21140 */
 539         struct tulip_probe_info tulip_probe;
 540         tulip_chipid_t          tulip_chipid;   /* type of chip we are using */
 541         const tulip_boardsw_t   *tulip_boardsw; /* board/chip characteristics */
 542         tulip_softc_t           *tulip_slaves;  /* slaved devices (ZX3xx) */
 543 #if defined(TULIP_DEBUG)
 544         struct tulip_dbg_info   tulip_dbg;
 545 #endif
 546 #if defined(TULIP_PERFSTATS)
 547         struct tulip_perfstat   tulip_perfstats[TULIP_PERF_MAX];
 548 #endif
 549         tulip_dot3_stats_t      tulip_dot3stats;
 550         tulip_ringinfo_t        tulip_rxinfo;
 551         tulip_ringinfo_t        tulip_txinfo;
 552         tulip_media_info_t      tulip_mediainfo[10];
 553         /*
 554          * The setup buffers for sending the setup frame to the chip. one is
 555          * the one being sent while the other is the one being filled.
 556          */
 557         bus_dma_tag_t           tulip_setup_tag;
 558         bus_dmamap_t            tulip_setup_map;
 559         bus_addr_t              tulip_setup_dma_addr;
 560         u_int32_t               *tulip_setupbuf;
 561         u_int32_t               tulip_setupdata[192 / sizeof(u_int32_t)];
 562         char                    tulip_boardid[24];
 563         u_int8_t                tulip_rombuf[128];      /* must be aligned */
 564
 565         /* needed for multiport boards */
 566         u_int8_t                tulip_pci_busno;
 567         u_int8_t                tulip_pci_devno;
 568
 569         u_int8_t                tulip_connidx;
 570         tulip_srom_connection_t tulip_conntype;
 571         struct callout          tulip_callout;
 572         struct mtx              tulip_mutex;
 573         struct callout  tulip_stat_timer;
 574 };
 575
 576 #define tulip_curperfstats      tulip_perfstats[TULIP_PERF_CURRENT]
 577 #define tulip_probe_count       tulip_probe.probe_count
 578 #define tulip_probe_timeout     tulip_probe.probe_timeout
 579 #define tulip_probe_state       tulip_probe.probe_state
 580 #define tulip_probe_media       tulip_probe.probe_media
 581 #define tulip_probe_mediamask   tulip_probe.probe_mediamask
 582 #define tulip_probe_passes      tulip_probe.probe_passes
 583
 584 /* Definitions for tulip_flags. */
 585 #define TULIP_WANTSETUP         0x00000001
 586 #define TULIP_WANTHASHPERFECT   0x00000002
 587 #define TULIP_WANTHASHONLY      0x00000004
 588 #define TULIP_DOINGSETUP        0x00000008
 589 #define TULIP_PRINTMEDIA        0x00000010
 590 #define TULIP_TXPROBE_ACTIVE    0x00000020
 591 #define TULIP_ALLMULTI          0x00000040
 592 #define TULIP_WANTRXACT         0x00000080
 593 #define TULIP_RXACT             0x00000100
 594 #define TULIP_INRESET           0x00000200
 595 #define TULIP_NEEDRESET         0x00000400
 596 #define TULIP_SQETEST           0x00000800
 597 #define TULIP_xxxxxx0           0x00001000
 598 #define TULIP_xxxxxx1           0x00002000
 599 #define TULIP_WANTTXSTART       0x00004000
 600 #define TULIP_NEWTXTHRESH       0x00008000
 601 #define TULIP_NOAUTOSENSE       0x00010000
 602 #define TULIP_PRINTLINKUP       0x00020000
 603 #define TULIP_LINKUP            0x00040000
 604 #define TULIP_RXBUFSLOW         0x00080000
 605 #define TULIP_NOMESSAGES        0x00100000
 606 #define TULIP_SYSTEMERROR       0x00200000
 607 #define TULIP_TIMEOUTPENDING    0x00400000
 608 #define TULIP_xxxxxx2           0x00800000
 609 #define TULIP_TRYNWAY           0x01000000
 610 #define TULIP_DIDNWAY           0x02000000
 611 #define TULIP_RXIGNORE          0x04000000
 612 #define TULIP_PROBE1STPASS      0x08000000
 613 #define TULIP_DEVICEPROBE       0x10000000
 614 #define TULIP_PROMISC           0x20000000
 615 #define TULIP_HASHONLY          0x40000000
 616 #define TULIP_xxxxxx3           0x80000000
 617
 618 /* Definitions for tulip_features. */
 619 #define TULIP_HAVE_GPR          0x00000001      /* have gp register (140[A]) */
 620 #define TULIP_HAVE_RXBADOVRFLW  0x00000002      /* RX corrupts on overflow */
 621 #define TULIP_HAVE_POWERMGMT    0x00000004      /* Snooze/sleep modes */
 622 #define TULIP_HAVE_MII          0x00000008      /* Some medium on MII */
 623 #define TULIP_HAVE_SIANWAY      0x00000010      /* SIA does NWAY */
 624 #define TULIP_HAVE_DUALSENSE    0x00000020      /* SIA senses both AUI & TP */
 625 #define TULIP_HAVE_SIAGP        0x00000040      /* SIA has a GP port */
 626 #define TULIP_HAVE_BROKEN_HASH  0x00000080      /* Broken Multicast Hash */
 627 #define TULIP_HAVE_ISVSROM      0x00000100      /* uses ISV SROM Format */
 628 #define TULIP_HAVE_BASEROM      0x00000200      /* Board ROM can be cloned */
 629 #define TULIP_HAVE_SLAVEDROM    0x00000400      /* Board ROM cloned */
 630 #define TULIP_HAVE_SLAVEDINTR   0x00000800      /* Board slaved interrupt */
 631 #define TULIP_HAVE_SHAREDINTR   0x00001000      /* Board shares interrupts */
 632 #define TULIP_HAVE_OKROM        0x00002000      /* ROM was recognized */
 633 #define TULIP_HAVE_NOMEDIA      0x00004000      /* did not detect any media */
 634 #define TULIP_HAVE_STOREFWD     0x00008000      /* have CMD_STOREFWD */
 635 #define TULIP_HAVE_SIA100       0x00010000      /* has LS100 in SIA status */
 636 #define TULIP_HAVE_OKSROM       0x00020000      /* SROM CRC is OK */
 637
 638 #define TULIP_DO_AUTOSENSE(sc)  \
 639         (IFM_SUBTYPE((sc)->tulip_ifmedia.ifm_media) == IFM_AUTO)
 640
 641 #if defined(TULIP_HDR_DATA)
 642 static const char *const tulip_chipdescs[] = {
 643         "21040 [10Mb/s]",
 644         "21041 [10Mb/s]",
 645         "21140 [10-100Mb/s]",
 646         "21140A [10-100Mb/s]",
 647         "21142 [10-100Mb/s]",
 648         "21143 [10-100Mb/s]",
 649 };
 650
 651 static const char *const tulip_mediums[] = {
 652         "unknown",              /* TULIP_MEDIA_UNKNOWN */
 653         "10baseT",              /* TULIP_MEDIA_10BASET */
 654         "Full Duplex 10baseT",  /* TULIP_MEDIA_10BASET_FD */
 655         "BNC",                  /* TULIP_MEDIA_BNC */
 656         "AUI",                  /* TULIP_MEDIA_AUI */
 657         "External SIA",         /* TULIP_MEDIA_EXTSIA */
 658         "AUI/BNC",              /* TULIP_MEDIA_AUIBNC */
 659         "100baseTX",            /* TULIP_MEDIA_100BASET */
 660         "Full Duplex 100baseTX",/* TULIP_MEDIA_100BASET_FD */
 661         "100baseT4",            /* TULIP_MEDIA_100BASET4 */
 662         "100baseFX",            /* TULIP_MEDIA_100BASEFX */
 663         "Full Duplex 100baseFX",/* TULIP_MEDIA_100BASEFX_FD */
 664 };
 665
 666 static const int tulip_media_to_ifmedia[] = {
 667         IFM_ETHER | IFM_NONE,           /* TULIP_MEDIA_UNKNOWN */
 668         IFM_ETHER | IFM_10_T,           /* TULIP_MEDIA_10BASET */
 669         IFM_ETHER | IFM_10_T | IFM_FDX, /* TULIP_MEDIA_10BASET_FD */
 670         IFM_ETHER | IFM_10_2,           /* TULIP_MEDIA_BNC */
 671         IFM_ETHER | IFM_10_5,           /* TULIP_MEDIA_AUI */
 672         IFM_ETHER | IFM_MANUAL,         /* TULIP_MEDIA_EXTSIA */
 673         IFM_ETHER | IFM_10_5,           /* TULIP_MEDIA_AUIBNC */
 674         IFM_ETHER | IFM_100_TX,         /* TULIP_MEDIA_100BASET */
 675         IFM_ETHER | IFM_100_TX | IFM_FDX,       /* TULIP_MEDIA_100BASET_FD */
 676         IFM_ETHER | IFM_100_T4,         /* TULIP_MEDIA_100BASET4 */
 677         IFM_ETHER | IFM_100_FX,         /* TULIP_MEDIA_100BASEFX */
 678         IFM_ETHER | IFM_100_FX | IFM_FDX,       /* TULIP_MEDIA_100BASEFX_FD */
 679 };
 680
 681 static const char *const tulip_system_errors[] = {
 682         "parity error",
 683         "master abort",
 684         "target abort",
 685         "reserved #3",
 686         "reserved #4",
 687         "reserved #5",
 688         "reserved #6",
 689         "reserved #7",
 690 };
 691
 692 static const char *const tulip_status_bits[] = {
 693         NULL,
 694         "transmit process stopped",
 695         NULL,
 696         "transmit jabber timeout",
 697
 698         NULL,
 699         "transmit underflow",
 700         NULL,
 701         "receive underflow",
 702
 703         "receive process stopped",
 704         "receive watchdog timeout",
 705         NULL,
 706         NULL,
 707
 708         "link failure",
 709         NULL,
 710         NULL,
 711 };
 712
 713 static const struct {
 714         tulip_srom_connection_t sc_type;
 715         tulip_media_t sc_media;
 716         u_int32_t sc_attrs;
 717 } tulip_srom_conninfo[] = {
 718         {
 719                 TULIP_SROM_CONNTYPE_10BASET, TULIP_MEDIA_10BASET
 720         },
 721         {
 722                 TULIP_SROM_CONNTYPE_BNC, TULIP_MEDIA_BNC
 723         },
 724         {
 725                 TULIP_SROM_CONNTYPE_AUI, TULIP_MEDIA_AUI
 726         },
 727         {
 728                 TULIP_SROM_CONNTYPE_100BASETX, TULIP_MEDIA_100BASETX
 729         },
 730         {
 731                 TULIP_SROM_CONNTYPE_100BASET4, TULIP_MEDIA_100BASET4
 732         },
 733         {
 734                 TULIP_SROM_CONNTYPE_100BASEFX, TULIP_MEDIA_100BASEFX
 735         },
 736         {
 737                 TULIP_SROM_CONNTYPE_MII_10BASET, TULIP_MEDIA_10BASET,
 738                 TULIP_SROM_ATTR_MII
 739         },
 740         {
 741                 TULIP_SROM_CONNTYPE_MII_100BASETX, TULIP_MEDIA_100BASETX,
 742                 TULIP_SROM_ATTR_MII
 743         },
 744         {
 745                 TULIP_SROM_CONNTYPE_MII_100BASET4, TULIP_MEDIA_100BASET4,
 746                 TULIP_SROM_ATTR_MII
 747         },
 748         {
 749                 TULIP_SROM_CONNTYPE_MII_100BASEFX, TULIP_MEDIA_100BASEFX,
 750                 TULIP_SROM_ATTR_MII
 751         },
 752         {
 753                 TULIP_SROM_CONNTYPE_10BASET_NWAY, TULIP_MEDIA_10BASET,
 754                 TULIP_SROM_ATTR_NWAY
 755         },
 756         {
 757                 TULIP_SROM_CONNTYPE_10BASET_FD, TULIP_MEDIA_10BASET_FD
 758         },
 759         {
 760                 TULIP_SROM_CONNTYPE_MII_10BASET_FD, TULIP_MEDIA_10BASET_FD,
 761                 TULIP_SROM_ATTR_MII
 762         },
 763         {
 764                 TULIP_SROM_CONNTYPE_100BASETX_FD, TULIP_MEDIA_100BASETX_FD
 765         },
 766         {
 767                 TULIP_SROM_CONNTYPE_MII_100BASETX_FD, TULIP_MEDIA_100BASETX_FD,
 768                 TULIP_SROM_ATTR_MII
 769         },
 770         {
 771                 TULIP_SROM_CONNTYPE_10BASET_NOLINKPASS, TULIP_MEDIA_10BASET,
 772                 TULIP_SROM_ATTR_NOLINKPASS
 773         },
 774         {
 775                 TULIP_SROM_CONNTYPE_AUTOSENSE, TULIP_MEDIA_UNKNOWN,
 776                 TULIP_SROM_ATTR_AUTOSENSE
 777         },
 778         {
 779                 TULIP_SROM_CONNTYPE_AUTOSENSE_POWERUP, TULIP_MEDIA_UNKNOWN,
 780                 TULIP_SROM_ATTR_AUTOSENSE | TULIP_SROM_ATTR_POWERUP
 781         },
 782         {
 783                 TULIP_SROM_CONNTYPE_AUTOSENSE_NWAY, TULIP_MEDIA_UNKNOWN,
 784                 TULIP_SROM_ATTR_AUTOSENSE | TULIP_SROM_ATTR_NWAY
 785         },
 786         {
 787                 TULIP_SROM_CONNTYPE_NOT_USED, TULIP_MEDIA_UNKNOWN
 788         }
 789 };
 790 #define TULIP_SROM_LASTCONNIDX  \
 791                 (sizeof(tulip_srom_conninfo)/sizeof(tulip_srom_conninfo[0]) - 1)
 792
 793 static const struct {
 794         tulip_media_t sm_type;
 795         tulip_srom_media_t sm_srom_type;
 796 } tulip_srom_mediums[] = {
 797         {
 798                 TULIP_MEDIA_100BASEFX_FD, TULIP_SROM_MEDIA_100BASEFX_FD
 799         },
 800         {
 801                 TULIP_MEDIA_100BASEFX, TULIP_SROM_MEDIA_100BASEFX
 802         },
 803         {
 804                 TULIP_MEDIA_100BASET4, TULIP_SROM_MEDIA_100BASET4
 805         },
 806         {
 807                 TULIP_MEDIA_100BASETX_FD, TULIP_SROM_MEDIA_100BASETX_FD
 808         },
 809         {
 810                 TULIP_MEDIA_100BASETX, TULIP_SROM_MEDIA_100BASETX
 811         },
 812         {
 813                 TULIP_MEDIA_10BASET_FD, TULIP_SROM_MEDIA_10BASET_FD
 814         },
 815         {
 816                 TULIP_MEDIA_AUI, TULIP_SROM_MEDIA_AUI
 817         },
 818         {
 819                 TULIP_MEDIA_BNC, TULIP_SROM_MEDIA_BNC
 820         },
 821         {
 822                 TULIP_MEDIA_10BASET, TULIP_SROM_MEDIA_10BASET
 823         },
 824         {
 825                 TULIP_MEDIA_UNKNOWN
 826         }
 827 };
 828
 829 #endif                          /* TULIP_HDR_DATA */
 830
 831 /*
 832  * Macro to encode 16 bits of a MAC address into the setup buffer.  Since
 833  * we are casting the two bytes in the char array to a uint16 and then
 834  * handing them to this macro, we don't need to swap the bytes in the big
 835  * endian case, just shift them left 16.
 836  */
 837 #if BYTE_ORDER == BIG_ENDIAN
 838 #define TULIP_SP_MAC(x)         ((x) << 16)
 839 #else
 840 #define TULIP_SP_MAC(x)         (x)
 841 #endif
 842
 843 /*
 844  * This driver supports a maximum of 32 tulip boards.
 845  * This should be enough for the forseeable future.
 846  */
 847 #define TULIP_MAX_DEVICES       32
 848
 849 #define _TULIP_DESC_SYNC(ri, op)                                        \
 850         bus_dmamap_sync((ri)->ri_ring_tag, (ri)->ri_ring_map, (op))
 851 #define _TULIP_MAP_SYNC(ri, di, op)                                     \
 852         bus_dmamap_sync((ri)->ri_data_tag, *(di)->di_map, (op))
 853
 854 /*
 855  * Descriptors are both read from and written to by the card (corresponding
 856  * to DMA WRITE and READ operations in bus-dma speak).  Receive maps are
 857  * written to by the card (a DMA READ operation in bus-dma) and transmit
 858  * buffers are read from by the card (a DMA WRITE operation in bus-dma).
 859  */
 860 #define TULIP_RXDESC_PRESYNC(ri)                                        \
 861         _TULIP_DESC_SYNC(ri, BUS_DMASYNC_PREREAD|BUS_DMASYNC_PREWRITE)
 862 #define TULIP_RXDESC_POSTSYNC(ri)                                       \
 863         _TULIP_DESC_SYNC(ri, BUS_DMASYNC_POSTREAD|BUS_DMASYNC_POSTWRITE)
 864 #define TULIP_RXMAP_PRESYNC(ri, di)                                     \
 865         _TULIP_MAP_SYNC(ri, di, BUS_DMASYNC_PREREAD)
 866 #define TULIP_RXMAP_POSTSYNC(ri, di)                                    \
 867         _TULIP_MAP_SYNC(ri, di, BUS_DMASYNC_POSTREAD)
 868 #define TULIP_TXDESC_PRESYNC(ri)                                        \
 869         _TULIP_DESC_SYNC(ri, BUS_DMASYNC_PREREAD|BUS_DMASYNC_PREWRITE)
 870 #define TULIP_TXDESC_POSTSYNC(ri)                                       \
 871         _TULIP_DESC_SYNC(ri, BUS_DMASYNC_POSTREAD|BUS_DMASYNC_POSTWRITE)
 872 #define TULIP_TXMAP_PRESYNC(ri, di)                                     \
 873         _TULIP_MAP_SYNC(ri, di, BUS_DMASYNC_PREWRITE)
 874 #define TULIP_TXMAP_POSTSYNC(ri, di)                                    \
 875         _TULIP_MAP_SYNC(ri, di, BUS_DMASYNC_POSTWRITE)
 876
 877 #ifdef notyet
 878 #define SIOCGADDRROM            _IOW('i', 240, struct ifreq)    /* get 128 bytes of ROM */
 879 #define SIOCGCHIPID             _IOWR('i', 241, struct ifreq)   /* get chipid */
 880 #endif
 881
 882 #if defined(TULIP_HDR_DATA)
 883 static tulip_softc_t    *tulips[TULIP_MAX_DEVICES];
 884 #endif
 885
 886 #define loudprintf                      if (bootverbose) printf
 887
 888 #if defined(TULIP_PERFSTATS)
 889 #define TULIP_PERFMERGE(sc, member) \
 890         do { (sc)->tulip_perfstats[TULIP_PERF_TOTAL].member \
 891              += (sc)->tulip_perfstats[TULIP_PERF_CURRENT].member; \
 892          (sc)->tulip_perfstats[TULIP_PERF_PREVIOUS].member \
 893               = (sc)->tulip_perfstats[TULIP_PERF_CURRENT].member; \
 894             (sc)->tulip_perfstats[TULIP_PERF_CURRENT].member = 0; } while (0)
 895 #define TULIP_PERFSTART(name) const tulip_cycle_t perfstart_ ## name = TULIP_PERFREAD();
 896 #define TULIP_PERFEND(name)     do { \
 897             (sc)->tulip_curperfstats.perf_ ## name ## _cycles += TULIP_PERFDIFF(perfstart_ ## name, TULIP_PERFREAD()); \
 898             (sc)->tulip_curperfstats.perf_ ## name ++; \
 899         } while (0)
 900
 901 typedef u_long tulip_cycle_t;
 902
 903 static __inline tulip_cycle_t
 904 TULIP_PERFREAD(void)
 905 {
 906         return (get_cyclecount());
 907 }
 908
 909 #define TULIP_PERFDIFF(s, f)    ((f) - (s))
 910 #else
 911 #define TULIP_PERFSTART(name)
 912 #define TULIP_PERFEND(name)     do { } while (0)
 913 #define TULIP_PERFMERGE(s,n)    do { } while (0)
 914 #endif  /* TULIP_PERFSTATS */
 915
 916 #define TULIP_CRC32_POLY        0xEDB88320UL    /* CRC-32 Poly -- Little
 917                                                  * Endian */
 918 #define TULIP_MAX_TXSEG         30
 919 #define TULIP_MAX_FRAGS         2
 920
 921 #define TULIP_ADDREQUAL(a1, a2) \
 922         (((u_int16_t *)a1)[0] == ((u_int16_t *)a2)[0] \
 923          && ((u_int16_t *)a1)[1] == ((u_int16_t *)a2)[1] \
 924          && ((u_int16_t *)a1)[2] == ((u_int16_t *)a2)[2])
 925 #define TULIP_ADDRBRDCST(a1) \
 926         (((u_int16_t *)a1)[0] == 0xFFFFU \
 927          && ((u_int16_t *)a1)[1] == 0xFFFFU \
 928          && ((u_int16_t *)a1)[2] == 0xFFFFU)
 929
 930 #define TULIP_MUTEX(sc)         (&(sc)->tulip_mutex)
 931 #define TULIP_LOCK(sc)          mtx_lock(TULIP_MUTEX(sc))
 932 #define TULIP_UNLOCK(sc)        mtx_unlock(TULIP_MUTEX(sc))
 933 #define TULIP_LOCK_ASSERT(sc)   mtx_assert(TULIP_MUTEX(sc), MA_OWNED)
 934
 935 #endif  /* DEV_DE_IF_DEVAR_H */