sys/dev/netif/bnx/if_bnxvar.h

   1 /*
   2  * Copyright (c) 2001 Wind River Systems
   3  * Copyright (c) 1997, 1998, 1999, 2001
   4  *      Bill Paul <wpaul@windriver.com>.  All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following 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  * 3. All advertising materials mentioning features or use of this software
  15  *    must display the following acknowledgement:
  16  *      This product includes software developed by Bill Paul.
  17  * 4. Neither the name of the author nor the names of any co-contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  25  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  31  * THE POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  * $FreeBSD: src/sys/dev/bge/if_bgereg.h,v 1.1.2.16 2004/09/23 20:11:18 ps Exp $
  34  * $DragonFly: src/sys/dev/netif/bge/if_bgereg.h,v 1.25 2008/10/22 14:24:24 sephe Exp $
  35  */
  36
  37 #ifndef _IF_BNXVAR_H_
  38 #define _IF_BNXVAR_H_
  39
  40 /*
  41  * Tigon general information block. This resides in host memory
  42  * and contains the status counters, ring control blocks and
  43  * producer pointers.
  44  */
  45
  46 struct bnx_gib {
  47         struct bge_stats        bnx_stats;
  48         struct bge_rcb          bnx_tx_rcb[16];
  49         struct bge_rcb          bnx_std_rx_rcb;
  50         struct bge_rcb          bnx_jumbo_rx_rcb;
  51         struct bge_rcb          bnx_mini_rx_rcb;
  52         struct bge_rcb          bnx_return_rcb;
  53 };
  54
  55 #define BNX_MIN_FRAMELEN        60
  56 #define BNX_MAX_FRAMELEN        1536
  57 #define BNX_JUMBO_FRAMELEN      9018
  58 #define BNX_JUMBO_MTU           (BNX_JUMBO_FRAMELEN-ETHER_HDR_LEN-ETHER_CRC_LEN)
  59
  60 #define BNX_TIMEOUT             5000
  61 #define BNX_FIRMWARE_TIMEOUT    100000
  62 #define BNX_TXCONS_UNSET        0xFFFF  /* impossible value */
  63
  64 /*
  65  * Other utility macros.
  66  */
  67 #define BNX_INC(x, y)           (x) = ((x) + 1) % (y)
  68
  69 /*
  70  * Register access macros. The Tigon always uses memory mapped register
  71  * accesses and all registers must be accessed with 32 bit operations.
  72  */
  73
  74 #define CSR_WRITE_4(sc, reg, val)       \
  75         bus_space_write_4(sc->bnx_btag, sc->bnx_bhandle, reg, val)
  76
  77 #define CSR_READ_4(sc, reg)             \
  78         bus_space_read_4(sc->bnx_btag, sc->bnx_bhandle, reg)
  79
  80 #define BNX_SETBIT(sc, reg, x)  \
  81         CSR_WRITE_4(sc, reg, (CSR_READ_4(sc, reg) | x))
  82
  83 #define BNX_CLRBIT(sc, reg, x)  \
  84         CSR_WRITE_4(sc, reg, (CSR_READ_4(sc, reg) & ~x))
  85
  86 #define BNX_MEMWIN_READ(sc, x, val)                             \
  87 do {                                                            \
  88         pci_write_config(sc->bnx_dev, BGE_PCI_MEMWIN_BASEADDR,  \
  89             (0xFFFF0000 & x), 4);                               \
  90         val = CSR_READ_4(sc, BGE_MEMWIN_START + (x & 0xFFFF));  \
  91 } while(0)
  92
  93 #define BNX_MEMWIN_WRITE(sc, x, val)                            \
  94 do {                                                            \
  95         pci_write_config(sc->bnx_dev, BGE_PCI_MEMWIN_BASEADDR,  \
  96             (0xFFFF0000 & x), 4);                               \
  97         CSR_WRITE_4(sc, BGE_MEMWIN_START + (x & 0xFFFF), val);  \
  98 } while(0)
  99
 100 #define RCB_WRITE_4(sc, rcb, offset, val)                       \
 101         bus_space_write_4(sc->bnx_btag, sc->bnx_bhandle,        \
 102                           rcb + offsetof(struct bge_rcb, offset), val)
 103
 104 /*
 105  * Memory management stuff. Note: the SSLOTS, MSLOTS and JSLOTS
 106  * values are tuneable. They control the actual amount of buffers
 107  * allocated for the standard, mini and jumbo receive rings.
 108  */
 109
 110 #define BNX_SSLOTS      256
 111 #define BNX_MSLOTS      256
 112 #define BNX_JSLOTS      384
 113
 114 #define BNX_JRAWLEN (BNX_JUMBO_FRAMELEN + ETHER_ALIGN)
 115 #define BNX_JLEN (BNX_JRAWLEN + \
 116         (sizeof(uint64_t) - BNX_JRAWLEN % sizeof(uint64_t)))
 117 #define BNX_JPAGESZ PAGE_SIZE
 118 #define BNX_RESID (BNX_JPAGESZ - (BNX_JLEN * BNX_JSLOTS) % BNX_JPAGESZ)
 119 #define BNX_JMEM ((BNX_JLEN * BNX_JSLOTS) + BNX_RESID)
 120
 121 struct bnx_softc;
 122
 123 struct bnx_jslot {
 124         struct bnx_softc        *bnx_sc;
 125         void                    *bnx_buf;
 126         bus_addr_t              bnx_paddr;
 127         int                     bnx_inuse;
 128         int                     bnx_slot;
 129         SLIST_ENTRY(bnx_jslot)  jslot_link;
 130 };
 131
 132 /*
 133  * Ring structures. Most of these reside in host memory and we tell
 134  * the NIC where they are via the ring control blocks. The exceptions
 135  * are the tx and command rings, which live in NIC memory and which
 136  * we access via the shared memory window.
 137  */
 138 struct bnx_ring_data {
 139         struct bge_rx_bd        *bnx_rx_jumbo_ring;
 140         bus_addr_t              bnx_rx_jumbo_ring_paddr;
 141         struct bge_status_block *bnx_status_block;
 142         bus_addr_t              bnx_status_block_paddr;
 143         void                    *bnx_jumbo_buf;
 144         struct bnx_gib          bnx_info;
 145 };
 146
 147 struct bnx_rx_buf {
 148         bus_dmamap_t            bnx_rx_dmamap;
 149         struct mbuf             *bnx_rx_mbuf;
 150         bus_addr_t              bnx_rx_paddr;
 151 };
 152
 153 struct bnx_rx_std_ring {
 154         struct lwkt_serialize   bnx_rx_std_serialize;
 155         struct bnx_softc        *bnx_sc;
 156
 157         uint16_t                bnx_rx_std;     /* current prod ring head */
 158         struct bge_rx_bd        *bnx_rx_std_ring;
 159
 160         bus_dma_tag_t           bnx_rx_mtag;    /* RX mbuf DMA tag */
 161         struct bnx_rx_buf       bnx_rx_std_buf[BGE_STD_RX_RING_CNT];
 162
 163         bus_dma_tag_t           bnx_rx_std_ring_tag;
 164         bus_dmamap_t            bnx_rx_std_ring_map;
 165         bus_addr_t              bnx_rx_std_ring_paddr;
 166 } __cachealign;
 167
 168 struct bnx_rx_ret_ring {
 169         struct lwkt_serialize   bnx_rx_ret_serialize;
 170         uint32_t                bnx_saved_status_tag;
 171         volatile uint32_t       *bnx_hw_status_tag;
 172         struct bnx_softc        *bnx_sc;
 173         struct bnx_rx_std_ring  *bnx_std;
 174
 175         /* Shadow of bnx_rx_std_ring's bnx_rx_mtag */
 176         bus_dma_tag_t           bnx_rx_mtag;
 177
 178         volatile uint16_t       *bnx_rx_considx;
 179         uint16_t                bnx_rx_saved_considx;
 180         struct bge_rx_bd        *bnx_rx_ret_ring;
 181         bus_dmamap_t            bnx_rx_tmpmap;
 182
 183         bus_dma_tag_t           bnx_rx_ret_ring_tag;
 184         bus_dmamap_t            bnx_rx_ret_ring_map;
 185         bus_addr_t              bnx_rx_ret_ring_paddr;
 186 } __cachealign;
 187
 188 /*
 189  * Mbuf pointers. We need these to keep track of the virtual addresses
 190  * of our mbuf chains since we can only convert from physical to virtual,
 191  * not the other way around.
 192  */
 193 struct bnx_chain_data {
 194         bus_dma_tag_t           bnx_parent_tag;
 195         bus_dma_tag_t           bnx_rx_jumbo_ring_tag;
 196         bus_dma_tag_t           bnx_status_tag;
 197         bus_dma_tag_t           bnx_jumbo_tag;
 198         bus_dmamap_t            bnx_rx_jumbo_ring_map;
 199         bus_dmamap_t            bnx_status_map;
 200         bus_dmamap_t            bnx_jumbo_map;
 201         struct bnx_rx_buf       bnx_rx_jumbo_chain[BGE_JUMBO_RX_RING_CNT];
 202         /* Stick the jumbo mem management stuff here too. */
 203         struct bnx_jslot        bnx_jslots[BNX_JSLOTS];
 204 };
 205
 206 struct bnx_tx_buf {
 207         bus_dmamap_t            bnx_tx_dmamap;
 208         struct mbuf             *bnx_tx_mbuf;
 209 };
 210
 211 struct bnx_tx_ring {
 212         struct lwkt_serialize   bnx_tx_serialize;
 213         uint32_t                bnx_saved_status_tag;
 214         struct bnx_softc        *bnx_sc;
 215         struct ifaltq_subque    *bnx_ifsq;
 216         volatile uint16_t       *bnx_tx_considx;
 217         uint16_t                bnx_tx_flags;
 218 #define BNX_TX_FLAG_SHORTDMA            0x0001
 219 #define BNX_TX_FLAG_FORCE_DEFRAG        0x0002
 220         uint16_t                bnx_tx_saved_considx;
 221         int                     bnx_tx_cnt;
 222         uint32_t                bnx_tx_prodidx;
 223         int                     bnx_tx_wreg;
 224         int                     bnx_tx_mbx;
 225         struct ifsubq_watchdog  bnx_tx_watchdog;
 226
 227         struct bge_tx_bd        *bnx_tx_ring;
 228
 229         bus_dma_tag_t           bnx_tx_mtag;    /* TX mbuf DMA tag */
 230         struct bnx_tx_buf       bnx_tx_buf[BGE_TX_RING_CNT];
 231
 232         bus_dma_tag_t           bnx_tx_ring_tag;
 233         bus_dmamap_t            bnx_tx_ring_map;
 234         bus_addr_t              bnx_tx_ring_paddr;
 235         int                     bnx_tx_cpuid;
 236 } __cachealign;
 237
 238 struct bnx_intr_data {
 239         struct bnx_softc        *bnx_sc;
 240         struct bnx_rx_ret_ring  *bnx_ret;
 241         struct bnx_tx_ring      *bnx_txr;
 242
 243         int                     bnx_intr_cpuid;
 244         struct lwkt_serialize   *bnx_intr_serialize;
 245         struct callout          bnx_intr_timer;
 246         void                    (*bnx_intr_check)(void *);
 247         uint16_t                bnx_rx_check_considx;
 248         uint16_t                bnx_tx_check_considx;
 249         boolean_t               bnx_intr_maylose;
 250
 251         void                    *bnx_intr_arg;
 252         driver_intr_t           *bnx_intr_func;
 253         void                    *bnx_intr_hand;
 254         struct resource         *bnx_intr_res;
 255         int                     bnx_intr_rid;
 256         const uint32_t          *bnx_saved_status_tag;
 257
 258         const char              *bnx_intr_desc;
 259         char                    bnx_intr_desc0[64];
 260 } __cachealign;
 261
 262 #define BNX_INTR_MAX            5
 263
 264 struct bnx_softc {
 265         struct arpcom           arpcom;         /* interface info */
 266         device_t                bnx_dev;
 267         device_t                bnx_miibus;
 268         bus_space_handle_t      bnx_bhandle;
 269         bus_space_tag_t         bnx_btag;
 270         struct resource         *bnx_res;
 271         struct ifmedia          bnx_ifmedia;    /* TBI media info */
 272         int                     bnx_pciecap;
 273         uint32_t                bnx_flags;      /* BNX_FLAG_ */
 274 #define BNX_FLAG_TBI            0x00000001
 275 #define BNX_FLAG_JUMBO          0x00000002
 276 #define BNX_FLAG_ONESHOT_MSI    0x00000004
 277 #define BNX_FLAG_5717_PLUS      0x00000008
 278 #define BNX_FLAG_MII_SERDES     0x00000010
 279 #define BNX_FLAG_CPMU           0x00000020
 280 #define BNX_FLAG_57765_PLUS     0x00000040
 281 #define BNX_FLAG_57765_FAMILY   0x00000080
 282 #define BNX_FLAG_STATUSTAG_BUG  0x00000100
 283 #define BNX_FLAG_TSO            0x00000200
 284 #define BNX_FLAG_NO_EEPROM      0x10000000
 285 #define BNX_FLAG_RXTX_BUNDLE    0x20000000
 286
 287         uint32_t                bnx_chipid;
 288         uint32_t                bnx_asicrev;
 289         uint32_t                bnx_chiprev;
 290         struct bnx_ring_data    bnx_ldata;      /* rings */
 291         struct bnx_chain_data   bnx_cdata;      /* mbufs */
 292
 293         struct lwkt_serialize   bnx_main_serialize;
 294         int                     bnx_serialize_cnt;
 295         struct lwkt_serialize   **bnx_serialize;
 296
 297         int                     bnx_tx_ringcnt;
 298         struct bnx_tx_ring      *bnx_tx_ring;
 299         int                     bnx_rx_retcnt;
 300         struct bnx_rx_ret_ring  *bnx_rx_ret_ring;
 301         struct bnx_rx_std_ring  bnx_rx_std_ring;
 302
 303         uint16_t                bnx_jumbo;      /* current jumo ring head */
 304         SLIST_HEAD(__bnx_jfreehead, bnx_jslot)  bnx_jfree_listhead;
 305         struct lwkt_serialize   bnx_jslot_serializer;
 306         uint32_t                bnx_rx_coal_ticks;
 307         uint32_t                bnx_tx_coal_ticks;
 308         uint32_t                bnx_rx_coal_bds;
 309         uint32_t                bnx_tx_coal_bds;
 310         uint32_t                bnx_rx_coal_bds_int;
 311         uint32_t                bnx_tx_coal_bds_int;
 312         uint32_t                bnx_mi_mode;
 313         int                     bnx_if_flags;
 314         int                     bnx_link;
 315         int                     bnx_link_evt;
 316         int                     bnx_stat_cpuid;
 317         struct callout          bnx_stat_timer;
 318
 319         int                     bnx_npoll_rxoff;
 320         int                     bnx_npoll_txoff;
 321
 322         int                     bnx_intr_type;
 323         int                     bnx_intr_cnt;
 324         struct bnx_intr_data    bnx_intr_data[BNX_INTR_MAX];
 325
 326         struct sysctl_ctx_list  bnx_sysctl_ctx;
 327         struct sysctl_oid       *bnx_sysctl_tree;
 328
 329         int                     bnx_phyno;
 330         uint32_t                bnx_coal_chg;
 331 #define BNX_RX_COAL_TICKS_CHG           0x01
 332 #define BNX_TX_COAL_TICKS_CHG           0x02
 333 #define BNX_RX_COAL_BDS_CHG             0x04
 334 #define BNX_TX_COAL_BDS_CHG             0x08
 335 #define BNX_RX_COAL_BDS_INT_CHG         0x40
 336 #define BNX_TX_COAL_BDS_INT_CHG         0x80
 337
 338         void                    (*bnx_link_upd)(struct bnx_softc *, uint32_t);
 339         uint32_t                bnx_link_chg;
 340
 341 #define BNX_TSO_NSTATS          45
 342         u_long                  bnx_tsosegs[BNX_TSO_NSTATS];
 343 };
 344
 345 #define BNX_NSEG_NEW            40
 346 #define BNX_NSEG_SPARE          33      /* enough for 64K TSO segment */
 347 #define BNX_NSEG_RSVD           4
 348
 349 /* RX coalesce ticks, unit: us */
 350 #define BNX_RX_COAL_TICKS_MIN   0
 351 #define BNX_RX_COAL_TICKS_DEF   160
 352 #define BNX_RX_COAL_TICKS_MAX   1023
 353
 354 /* TX coalesce ticks, unit: us */
 355 #define BNX_TX_COAL_TICKS_MIN   0
 356 #define BNX_TX_COAL_TICKS_DEF   1023
 357 #define BNX_TX_COAL_TICKS_MAX   1023
 358
 359 /* RX coalesce BDs */
 360 #define BNX_RX_COAL_BDS_MIN     0
 361 #define BNX_RX_COAL_BDS_DEF     0
 362 #define BNX_RX_COAL_BDS_INT_DEF 80
 363 #define BNX_RX_COAL_BDS_MAX     255
 364
 365 /* TX coalesce BDs */
 366 #define BNX_TX_COAL_BDS_MIN     0
 367 #define BNX_TX_COAL_BDS_DEF     64
 368 #define BNX_TX_COAL_BDS_INT_DEF 64
 369 #define BNX_TX_COAL_BDS_MAX     255
 370
 371 /* Number of segments sent before writing to TX related registers */
 372 #define BNX_TX_WREG_NSEGS       8
 373
 374 /* Return ring descriptor count */
 375 #define BNX_RETURN_RING_CNT     512
 376
 377 #endif  /* !_IF_BNXVAR_H_ */