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 struct bnx_tx_ring;
 123
 124 struct bnx_jslot {
 125         struct bnx_softc        *bnx_sc;
 126         void                    *bnx_buf;
 127         bus_addr_t              bnx_paddr;
 128         int                     bnx_inuse;
 129         int                     bnx_slot;
 130         SLIST_ENTRY(bnx_jslot)  jslot_link;
 131 };
 132
 133 /*
 134  * Ring structures. Most of these reside in host memory and we tell
 135  * the NIC where they are via the ring control blocks. The exceptions
 136  * are the tx and command rings, which live in NIC memory and which
 137  * we access via the shared memory window.
 138  */
 139 struct bnx_ring_data {
 140         struct bge_rx_bd        *bnx_rx_jumbo_ring;
 141         bus_addr_t              bnx_rx_jumbo_ring_paddr;
 142         void                    *bnx_jumbo_buf;
 143         struct bnx_gib          bnx_info;
 144 };
 145
 146 struct bnx_rx_buf {
 147         bus_dmamap_t            bnx_rx_dmamap;
 148         struct mbuf             *bnx_rx_mbuf;
 149         bus_addr_t              bnx_rx_paddr;
 150         int                     bnx_rx_len;
 151         int                     bnx_rx_refilled;
 152 } __cachealign;
 153
 154 struct bnx_rx_std_ring {
 155         struct lwkt_serialize   bnx_rx_std_serialize;
 156         struct bnx_softc        *bnx_sc;
 157
 158         uint16_t                bnx_rx_std_stop;
 159         uint16_t                bnx_rx_std;     /* current prod ring head */
 160         struct bge_rx_bd        *bnx_rx_std_ring;
 161
 162         int                     bnx_rx_std_refill __cachealign;
 163         int                     bnx_rx_std_used;
 164         u_int                   bnx_rx_std_running;
 165         struct thread           bnx_rx_std_ithread;
 166
 167         struct bnx_rx_buf       bnx_rx_std_buf[BGE_STD_RX_RING_CNT];
 168
 169         bus_dma_tag_t           bnx_rx_mtag;    /* RX mbuf DMA tag */
 170
 171         bus_dma_tag_t           bnx_rx_std_ring_tag;
 172         bus_dmamap_t            bnx_rx_std_ring_map;
 173         bus_addr_t              bnx_rx_std_ring_paddr;
 174 } __cachealign;
 175
 176 struct bnx_rx_ret_ring {
 177         struct lwkt_serialize   bnx_rx_ret_serialize;
 178         int                     bnx_rx_mbx;
 179         uint32_t                bnx_saved_status_tag;
 180         volatile uint32_t       *bnx_hw_status_tag;
 181         int                     bnx_msix_mbx;
 182         struct bnx_softc        *bnx_sc;
 183         struct bnx_rx_std_ring  *bnx_std;
 184         struct bnx_tx_ring      *bnx_txr;
 185
 186         /* Shadow of bnx_rx_std_ring's bnx_rx_mtag */
 187         bus_dma_tag_t           bnx_rx_mtag;
 188
 189         volatile uint16_t       *bnx_rx_considx;
 190         uint16_t                bnx_rx_saved_considx;
 191         uint16_t                bnx_rx_cnt;
 192         uint16_t                bnx_rx_cntmax;
 193         uint16_t                bnx_rx_mask;
 194         struct bge_rx_bd        *bnx_rx_ret_ring;
 195         bus_dmamap_t            bnx_rx_tmpmap;
 196
 197         bus_dma_tag_t           bnx_rx_ret_ring_tag;
 198         bus_dmamap_t            bnx_rx_ret_ring_map;
 199         bus_addr_t              bnx_rx_ret_ring_paddr;
 200
 201         u_long                  bnx_rx_pkt;
 202         u_long                  bnx_rx_force_sched;
 203 } __cachealign;
 204
 205 /*
 206  * Mbuf pointers. We need these to keep track of the virtual addresses
 207  * of our mbuf chains since we can only convert from physical to virtual,
 208  * not the other way around.
 209  */
 210 struct bnx_chain_data {
 211         bus_dma_tag_t           bnx_parent_tag;
 212         bus_dma_tag_t           bnx_rx_jumbo_ring_tag;
 213         bus_dma_tag_t           bnx_jumbo_tag;
 214         bus_dmamap_t            bnx_rx_jumbo_ring_map;
 215         bus_dmamap_t            bnx_jumbo_map;
 216         struct bnx_rx_buf       bnx_rx_jumbo_chain[BGE_JUMBO_RX_RING_CNT];
 217         /* Stick the jumbo mem management stuff here too. */
 218         struct bnx_jslot        bnx_jslots[BNX_JSLOTS];
 219 };
 220
 221 struct bnx_tx_buf {
 222         bus_dmamap_t            bnx_tx_dmamap;
 223         struct mbuf             *bnx_tx_mbuf;
 224 };
 225
 226 struct bnx_tx_ring {
 227         struct lwkt_serialize   bnx_tx_serialize;
 228         volatile uint32_t       *bnx_hw_status_tag;
 229         uint32_t                bnx_saved_status_tag;
 230         struct bnx_softc        *bnx_sc;
 231         struct ifaltq_subque    *bnx_ifsq;
 232         volatile uint16_t       *bnx_tx_considx;
 233         uint16_t                bnx_tx_flags;
 234 #define BNX_TX_FLAG_SHORTDMA            0x0001
 235 #define BNX_TX_FLAG_FORCE_DEFRAG        0x0002
 236         uint16_t                bnx_tx_saved_considx;
 237         int                     bnx_tx_cnt;
 238         uint32_t                bnx_tx_prodidx;
 239         int                     bnx_tx_wreg;
 240         int                     bnx_tx_mbx;
 241         struct ifsubq_watchdog  bnx_tx_watchdog;
 242
 243         struct bge_tx_bd        *bnx_tx_ring;
 244
 245         bus_dma_tag_t           bnx_tx_mtag;    /* TX mbuf DMA tag */
 246         struct bnx_tx_buf       bnx_tx_buf[BGE_TX_RING_CNT];
 247
 248         bus_dma_tag_t           bnx_tx_ring_tag;
 249         bus_dmamap_t            bnx_tx_ring_map;
 250         bus_addr_t              bnx_tx_ring_paddr;
 251         int                     bnx_tx_cpuid;
 252
 253         u_long                  bnx_tx_pkt;
 254 } __cachealign;
 255
 256 struct bnx_intr_data {
 257         struct bnx_softc        *bnx_sc;
 258         struct bnx_rx_ret_ring  *bnx_ret;
 259         struct bnx_tx_ring      *bnx_txr;
 260
 261         int                     bnx_intr_cpuid;
 262         struct lwkt_serialize   *bnx_intr_serialize;
 263         struct callout          bnx_intr_timer;
 264         void                    (*bnx_intr_check)(void *);
 265         uint16_t                bnx_rx_check_considx;
 266         uint16_t                bnx_tx_check_considx;
 267         boolean_t               bnx_intr_maylose;
 268
 269         void                    *bnx_intr_arg;
 270         driver_intr_t           *bnx_intr_func;
 271         void                    *bnx_intr_hand;
 272         struct resource         *bnx_intr_res;
 273         int                     bnx_intr_rid;
 274         int                     bnx_intr_mbx;
 275         const uint32_t          *bnx_saved_status_tag;
 276
 277         const char              *bnx_intr_desc;
 278         char                    bnx_intr_desc0[64];
 279
 280         bus_dma_tag_t           bnx_status_tag;
 281         bus_dmamap_t            bnx_status_map;
 282         struct bge_status_block *bnx_status_block;
 283         bus_addr_t              bnx_status_block_paddr;
 284 } __cachealign;
 285
 286 #define BNX_RX_RING_MAX         4
 287 #define BNX_TX_RING_MAX         4
 288 #define BNX_INTR_MAX            5
 289
 290 struct bnx_softc {
 291         struct arpcom           arpcom;         /* interface info */
 292         device_t                bnx_dev;
 293         device_t                bnx_miibus;
 294         bus_space_handle_t      bnx_bhandle;
 295         bus_space_tag_t         bnx_btag;
 296         struct resource         *bnx_res;
 297         struct ifmedia          bnx_ifmedia;    /* TBI media info */
 298         int                     bnx_pciecap;
 299         uint32_t                bnx_flags;      /* BNX_FLAG_ */
 300 #define BNX_FLAG_TBI            0x00000001
 301 #define BNX_FLAG_JUMBO          0x00000002
 302 #define BNX_FLAG_APE            0x00000004
 303 #define BNX_FLAG_5717_PLUS      0x00000008
 304 #define BNX_FLAG_MII_SERDES     0x00000010
 305 #define BNX_FLAG_CPMU           0x00000020
 306 #define BNX_FLAG_57765_PLUS     0x00000040
 307 #define BNX_FLAG_57765_FAMILY   0x00000080
 308 #define BNX_FLAG_STATUSTAG_BUG  0x00000100
 309 #define BNX_FLAG_TSO            0x00000200
 310 #define BNX_FLAG_NO_EEPROM      0x10000000
 311 #define BNX_FLAG_RXTX_BUNDLE    0x20000000
 312 #define BNX_FLAG_STD_THREAD     0x40000000
 313 #define BNX_FLAG_STATUS_HASTAG  0x80000000
 314
 315         uint32_t                bnx_chipid;
 316         uint32_t                bnx_asicrev;
 317         uint32_t                bnx_chiprev;
 318         struct bnx_ring_data    bnx_ldata;      /* rings */
 319         struct bnx_chain_data   bnx_cdata;      /* mbufs */
 320
 321         struct lwkt_serialize   bnx_main_serialize;
 322         volatile uint32_t       *bnx_hw_status;
 323         volatile uint32_t       *bnx_hw_status_tag;
 324         uint32_t                bnx_saved_status_tag;
 325         int                     bnx_link_evt;
 326         u_long                  bnx_errors;
 327         u_long                  bnx_norxbds;
 328
 329         int                     bnx_serialize_cnt;
 330         struct lwkt_serialize   **bnx_serialize;
 331
 332         int                     bnx_tx_ringcnt;
 333         struct bnx_tx_ring      *bnx_tx_ring;
 334         int                     bnx_rx_retcnt;
 335         struct bnx_rx_ret_ring  *bnx_rx_ret_ring;
 336         struct bnx_rx_std_ring  bnx_rx_std_ring;
 337
 338         uint16_t                bnx_jumbo;      /* current jumo ring head */
 339         SLIST_HEAD(__bnx_jfreehead, bnx_jslot)  bnx_jfree_listhead;
 340         struct lwkt_serialize   bnx_jslot_serializer;
 341         uint32_t                bnx_rx_coal_ticks;
 342         uint32_t                bnx_tx_coal_ticks;
 343         uint32_t                bnx_rx_coal_bds;
 344         uint32_t                bnx_rx_coal_bds_poll;
 345         uint32_t                bnx_tx_coal_bds;
 346         uint32_t                bnx_tx_coal_bds_poll;
 347         uint32_t                bnx_rx_coal_bds_int;
 348         uint32_t                bnx_tx_coal_bds_int;
 349         uint32_t                bnx_mi_mode;
 350         int                     bnx_if_flags;
 351         int                     bnx_link;
 352         int                     bnx_tick_cpuid;
 353         struct callout          bnx_tick_timer;
 354
 355         int                     bnx_npoll_rxoff;
 356         int                     bnx_npoll_txoff;
 357
 358         int                     bnx_msix_mem_rid;
 359         struct resource         *bnx_msix_mem_res;
 360         int                     bnx_intr_type;
 361         int                     bnx_intr_cnt;
 362         struct bnx_intr_data    bnx_intr_data[BNX_INTR_MAX];
 363
 364         struct sysctl_ctx_list  bnx_sysctl_ctx;
 365         struct sysctl_oid       *bnx_sysctl_tree;
 366
 367         int                     bnx_phyno;
 368         uint32_t                bnx_coal_chg;
 369 #define BNX_RX_COAL_TICKS_CHG           0x01
 370 #define BNX_TX_COAL_TICKS_CHG           0x02
 371 #define BNX_RX_COAL_BDS_CHG             0x04
 372 #define BNX_TX_COAL_BDS_CHG             0x08
 373 #define BNX_RX_COAL_BDS_INT_CHG         0x40
 374 #define BNX_TX_COAL_BDS_INT_CHG         0x80
 375
 376         void                    (*bnx_link_upd)(struct bnx_softc *, uint32_t);
 377         uint32_t                bnx_link_chg;
 378
 379         int                     bnx_rss_debug;
 380 #define BNX_TSO_NSTATS          45
 381         u_long                  bnx_tsosegs[BNX_TSO_NSTATS];
 382 };
 383
 384 #define BNX_NSEG_NEW            40
 385 #define BNX_NSEG_SPARE          33      /* enough for 64K TSO segment */
 386 #define BNX_NSEG_RSVD           4
 387
 388 /* RX coalesce ticks, unit: us */
 389 #define BNX_RX_COAL_TICKS_MIN   0
 390 #define BNX_RX_COAL_TICKS_DEF   160
 391 #define BNX_RX_COAL_TICKS_MAX   1023
 392
 393 /* TX coalesce ticks, unit: us */
 394 #define BNX_TX_COAL_TICKS_MIN   0
 395 #define BNX_TX_COAL_TICKS_DEF   1023
 396 #define BNX_TX_COAL_TICKS_MAX   1023
 397
 398 /* RX coalesce BDs */
 399 #define BNX_RX_COAL_BDS_MIN     0
 400 #define BNX_RX_COAL_BDS_DEF     0
 401 #define BNX_RX_COAL_BDS_INT_DEF 80
 402 #define BNX_RX_COAL_BDS_MAX     255
 403
 404 /* TX coalesce BDs */
 405 #define BNX_TX_COAL_BDS_MIN     0
 406 #define BNX_TX_COAL_BDS_DEF     128
 407 #define BNX_TX_COAL_BDS_POLL_DEF 64
 408 #define BNX_TX_COAL_BDS_INT_DEF 64
 409 #define BNX_TX_COAL_BDS_MAX     255
 410
 411 /* Number of segments sent before writing to TX related registers */
 412 #define BNX_TX_WREG_NSEGS       8
 413
 414 /* Return ring descriptor count */
 415 #define BNX_RETURN_RING_CNT     512
 416
 417 #define BNX_TX_RING_MAX         4
 418
 419 #define BNX_RSS_ENABLED(sc)     ((sc)->bnx_rx_retcnt > 1)
 420
 421 #endif  /* !_IF_BNXVAR_H_ */