sys/dev/fxp/if_fxpvar.h

   1 /*-
   2  * Copyright (c) 1995, David Greenman
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice unmodified, this list of conditions, and the following
  10  *    disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  * $FreeBSD$
  28  */
  29
  30 /*
  31  * Misc. defintions for the Intel EtherExpress Pro/100B PCI Fast
  32  * Ethernet driver
  33  */
  34
  35 /*
  36  * Number of transmit control blocks. This determines the number
  37  * of transmit buffers that can be chained in the CB list.
  38  * This must be a power of two.
  39  */
  40 #define FXP_NTXCB       128
  41
  42 /*
  43  * Size of the TxCB list.
  44  */
  45 #define FXP_TXCB_SZ     (FXP_NTXCB * sizeof(struct fxp_cb_tx))
  46
  47 /*
  48  * Macro to obtain the DMA address of a virtual address in the
  49  * TxCB list based on the base DMA address of the TxCB list.
  50  */
  51 #define FXP_TXCB_DMA_ADDR(sc, addr)                                     \
  52         (sc->fxp_desc.cbl_addr + (uintptr_t)addr -                      \
  53         (uintptr_t)sc->fxp_desc.cbl_list)
  54
  55 /*
  56  * Number of completed TX commands at which point an interrupt
  57  * will be generated to garbage collect the attached buffers.
  58  * Must be at least one less than FXP_NTXCB, and should be
  59  * enough less so that the transmitter doesn't becomes idle
  60  * during the buffer rundown (which would reduce performance).
  61  */
  62 #define FXP_CXINT_THRESH 120
  63
  64 /*
  65  * TxCB list index mask. This is used to do list wrap-around.
  66  */
  67 #define FXP_TXCB_MASK   (FXP_NTXCB - 1)
  68
  69 /*
  70  * Number of receive frame area buffers. These are large so chose
  71  * wisely.
  72  */
  73 #ifdef DEVICE_POLLING
  74 #define FXP_NRFABUFS    192
  75 #else
  76 #define FXP_NRFABUFS    64
  77 #endif
  78
  79 /*
  80  * Maximum number of seconds that the receiver can be idle before we
  81  * assume it's dead and attempt to reset it by reprogramming the
  82  * multicast filter. This is part of a work-around for a bug in the
  83  * NIC. See fxp_stats_update().
  84  */
  85 #define FXP_MAX_RX_IDLE 15
  86
  87 /*
  88  * Default maximum time, in microseconds, that an interrupt may be delayed
  89  * in an attempt to coalesce interrupts.  This is only effective if the Intel
  90  * microcode is loaded, and may be changed via either loader tunables or
  91  * sysctl.  See also the CPUSAVER_DWORD entry in rcvbundl.h.
  92  */
  93 #define TUNABLE_INT_DELAY 1000
  94
  95 /*
  96  * Default number of packets that will be bundled, before an interrupt is
  97  * generated.  This is only effective if the Intel microcode is loaded, and
  98  * may be changed via either loader tunables or sysctl.  This may not be
  99  * present in all microcode revisions, see also the CPUSAVER_BUNDLE_MAX_DWORD
 100  * entry in rcvbundl.h.
 101  */
 102 #define TUNABLE_BUNDLE_MAX 6
 103
 104 #if __FreeBSD_version < 500000
 105 #define FXP_LOCK(_sc)
 106 #define FXP_UNLOCK(_sc)
 107 #define FXP_LOCKED(_sc)
 108 #define FXP_LOCK_ASSERT(_sc, _what)
 109 #define INTR_MPSAFE             0
 110 #define mtx_init(a, b, c, d)
 111 #define mtx_destroy(a)
 112 struct mtx { int dummy; };
 113 #else
 114 #define FXP_LOCK(_sc)           mtx_lock(&(_sc)->sc_mtx)
 115 #define FXP_UNLOCK(_sc)         mtx_unlock(&(_sc)->sc_mtx)
 116 #define FXP_LOCKED(_sc)         mtx_owned(&(_sc)->sc_mtx)
 117 #define FXP_LOCK_ASSERT(_sc, _what)     mtx_assert(&(_sc)->sc_mtx, (_what))
 118 #endif
 119
 120 /*
 121  * Structures to handle TX and RX descriptors.
 122  */
 123 struct fxp_rx {
 124         struct fxp_rx *rx_next;
 125         struct mbuf *rx_mbuf;
 126         bus_dmamap_t rx_map;
 127         uint32_t rx_addr;
 128 };
 129
 130 struct fxp_tx {
 131         struct fxp_tx *tx_next;
 132         struct fxp_cb_tx *tx_cb;
 133         struct mbuf *tx_mbuf;
 134         bus_dmamap_t tx_map;
 135 };
 136
 137 struct fxp_desc_list {
 138         struct fxp_rx rx_list[FXP_NRFABUFS];
 139         struct fxp_tx tx_list[FXP_NTXCB];
 140         struct fxp_tx mcs_tx;
 141         struct fxp_rx *rx_head;
 142         struct fxp_rx *rx_tail;
 143         struct fxp_tx *tx_first;
 144         struct fxp_tx *tx_last;
 145         struct fxp_rfa *rfa_list;
 146         struct fxp_cb_tx *cbl_list;
 147         uint32_t cbl_addr;
 148         bus_dma_tag_t rx_tag;
 149 };
 150
 151 /*
 152  * NOTE: Elements are ordered for optimal cacheline behavior, and NOT
 153  *       for functional grouping.
 154  */
 155 struct fxp_softc {
 156         struct arpcom arpcom;           /* per-interface network data */
 157         struct resource *mem;           /* resource descriptor for registers */
 158         int rtp;                        /* register resource type */
 159         int rgd;                        /* register descriptor in use */
 160         struct resource *irq;           /* resource descriptor for interrupt */
 161         void *ih;                       /* interrupt handler cookie */
 162         struct mtx sc_mtx;
 163         bus_space_tag_t sc_st;          /* bus space tag */
 164         bus_space_handle_t sc_sh;       /* bus space handle */
 165         bus_dma_tag_t fxp_mtag;         /* bus DMA tag for mbufs */
 166         bus_dma_tag_t fxp_stag;         /* bus DMA tag for stats */
 167         bus_dmamap_t fxp_smap;          /* bus DMA map for stats */
 168         bus_dma_tag_t cbl_tag;          /* DMA tag for the TxCB list */
 169         bus_dmamap_t cbl_map;           /* DMA map for the TxCB list */
 170         bus_dma_tag_t mcs_tag;          /* DMA tag for the multicast setup */
 171         bus_dmamap_t mcs_map;           /* DMA map for the multicast setup */
 172         bus_dmamap_t spare_map;         /* spare DMA map */
 173         struct fxp_desc_list fxp_desc;  /* descriptors management struct */
 174         int maxtxseg;                   /* maximum # of TX segments */
 175         int tx_queued;                  /* # of active TxCB's */
 176         int need_mcsetup;               /* multicast filter needs programming */
 177         struct fxp_stats *fxp_stats;    /* Pointer to interface stats */
 178         uint32_t stats_addr;            /* DMA address of the stats structure */
 179         int rx_idle_secs;               /* # of seconds RX has been idle */
 180         struct callout stat_ch;         /* stat callout */
 181         struct fxp_cb_mcs *mcsp;        /* Pointer to mcast setup descriptor */
 182         uint32_t mcs_addr;              /* DMA address of the multicast cmd */
 183         struct ifmedia sc_media;        /* media information */
 184         device_t miibus;
 185         device_t dev;
 186         int tunable_int_delay;          /* interrupt delay value for ucode */
 187         int tunable_bundle_max;         /* max # frames per interrupt (ucode) */
 188         int tunable_noflow;             /* flow control disabled */
 189         int rnr;                        /* RNR events */
 190         int eeprom_size;                /* size of serial EEPROM */
 191         int suspended;                  /* 0 = normal  1 = suspended or dead */
 192         int cu_resume_bug;
 193         int revision;
 194         int flags;
 195         uint32_t saved_maps[5]; /* pci data */
 196         uint32_t saved_biosaddr;
 197         uint8_t saved_intline;
 198         uint8_t saved_cachelnsz;
 199         uint8_t saved_lattimer;
 200         uint8_t rfa_size;
 201         uint32_t tx_cmd;
 202 };
 203
 204 #define FXP_FLAG_MWI_ENABLE     0x0001  /* MWI enable */
 205 #define FXP_FLAG_READ_ALIGN     0x0002  /* align read access with cacheline */
 206 #define FXP_FLAG_WRITE_ALIGN    0x0004  /* end write on cacheline */
 207 #define FXP_FLAG_EXT_TXCB       0x0008  /* enable use of extended TXCB */
 208 #define FXP_FLAG_SERIAL_MEDIA   0x0010  /* 10Mbps serial interface */
 209 #define FXP_FLAG_LONG_PKT_EN    0x0020  /* enable long packet reception */
 210 #define FXP_FLAG_ALL_MCAST      0x0040  /* accept all multicast frames */
 211 #define FXP_FLAG_CU_RESUME_BUG  0x0080  /* requires workaround for CU_RESUME */
 212 #define FXP_FLAG_UCODE          0x0100  /* ucode is loaded */
 213 #define FXP_FLAG_DEFERRED_RNR   0x0200  /* DEVICE_POLLING deferred RNR */
 214 #define FXP_FLAG_EXT_RFA        0x0400  /* extended RFDs for csum offload */
 215 #define FXP_FLAG_SAVE_BAD       0x0800  /* save bad pkts: bad size, CRC, etc */
 216
 217 /* Macros to ease CSR access. */
 218 #define CSR_READ_1(sc, reg)                                             \
 219         bus_space_read_1((sc)->sc_st, (sc)->sc_sh, (reg))
 220 #define CSR_READ_2(sc, reg)                                             \
 221         bus_space_read_2((sc)->sc_st, (sc)->sc_sh, (reg))
 222 #define CSR_READ_4(sc, reg)                                             \
 223         bus_space_read_4((sc)->sc_st, (sc)->sc_sh, (reg))
 224 #define CSR_WRITE_1(sc, reg, val)                                       \
 225         bus_space_write_1((sc)->sc_st, (sc)->sc_sh, (reg), (val))
 226 #define CSR_WRITE_2(sc, reg, val)                                       \
 227         bus_space_write_2((sc)->sc_st, (sc)->sc_sh, (reg), (val))
 228 #define CSR_WRITE_4(sc, reg, val)                                       \
 229         bus_space_write_4((sc)->sc_st, (sc)->sc_sh, (reg), (val))
 230
 231 #define sc_if                   arpcom.ac_if