sys/dev/netif/e1000/if_igb.h

   1 /******************************************************************************
   2
   3   Copyright (c) 2001-2010, Intel Corporation
   4   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 are met:
   8
   9    1. Redistributions of source code must retain the above copyright notice,
  10       this list of conditions and the following disclaimer.
  11
  12    2. Redistributions in binary form must reproduce the above copyright
  13       notice, this list of conditions and the following disclaimer in the
  14       documentation and/or other materials provided with the distribution.
  15
  16    3. Neither the name of the Intel Corporation nor the names of its
  17       contributors may be used to endorse or promote products derived from
  18       this software without specific prior written permission.
  19
  20   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  21   AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23   ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  24   LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28   CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30   POSSIBILITY OF SUCH DAMAGE.
  31
  32 ******************************************************************************/
  33 /*$FreeBSD$*/
  34
  35 #ifndef _IGB_H_DEFINED_
  36 #define _IGB_H_DEFINED_
  37
  38 /* Tunables */
  39
  40 /*
  41  * IGB_TXD: Maximum number of Transmit Descriptors
  42  *
  43  *   This value is the number of transmit descriptors allocated by the driver.
  44  *   Increasing this value allows the driver to queue more transmits. Each
  45  *   descriptor is 16 bytes.
  46  *   Since TDLEN should be multiple of 128bytes, the number of transmit
  47  *   desscriptors should meet the following condition.
  48  *      (num_tx_desc * sizeof(struct e1000_tx_desc)) % 128 == 0
  49  */
  50 #define IGB_MIN_TXD             80
  51 #define IGB_DEFAULT_TXD         256
  52 #define IGB_MAX_TXD             4096
  53
  54 /*
  55  * IGB_RXD: Maximum number of Transmit Descriptors
  56  *
  57  *   This value is the number of receive descriptors allocated by the driver.
  58  *   Increasing this value allows the driver to buffer more incoming packets.
  59  *   Each descriptor is 16 bytes.  A receive buffer is also allocated for each
  60  *   descriptor. The maximum MTU size is 16110.
  61  *   Since TDLEN should be multiple of 128bytes, the number of transmit
  62  *   desscriptors should meet the following condition.
  63  *      (num_tx_desc * sizeof(struct e1000_tx_desc)) % 128 == 0
  64  */
  65 #define IGB_MIN_RXD             80
  66 #define IGB_DEFAULT_RXD         256
  67 #define IGB_MAX_RXD             4096
  68
  69 /*
  70  * IGB_TIDV - Transmit Interrupt Delay Value
  71  * Valid Range: 0-65535 (0=off)
  72  * Default Value: 64
  73  *   This value delays the generation of transmit interrupts in units of
  74  *   1.024 microseconds. Transmit interrupt reduction can improve CPU
  75  *   efficiency if properly tuned for specific network traffic. If the
  76  *   system is reporting dropped transmits, this value may be set too high
  77  *   causing the driver to run out of available transmit descriptors.
  78  */
  79 #define IGB_TIDV                         64
  80
  81 /*
  82  * IGB_TADV - Transmit Absolute Interrupt Delay Value
  83  * Valid Range: 0-65535 (0=off)
  84  * Default Value: 64
  85  *   This value, in units of 1.024 microseconds, limits the delay in which a
  86  *   transmit interrupt is generated. Useful only if IGB_TIDV is non-zero,
  87  *   this value ensures that an interrupt is generated after the initial
  88  *   packet is sent on the wire within the set amount of time.  Proper tuning,
  89  *   along with IGB_TIDV, may improve traffic throughput in specific
  90  *   network conditions.
  91  */
  92 #define IGB_TADV                         64
  93
  94 /*
  95  * IGB_RDTR - Receive Interrupt Delay Timer (Packet Timer)
  96  * Valid Range: 0-65535 (0=off)
  97  * Default Value: 0
  98  *   This value delays the generation of receive interrupts in units of 1.024
  99  *   microseconds.  Receive interrupt reduction can improve CPU efficiency if
 100  *   properly tuned for specific network traffic. Increasing this value adds
 101  *   extra latency to frame reception and can end up decreasing the throughput
 102  *   of TCP traffic. If the system is reporting dropped receives, this value
 103  *   may be set too high, causing the driver to run out of available receive
 104  *   descriptors.
 105  *
 106  *   CAUTION: When setting IGB_RDTR to a value other than 0, adapters
 107  *            may hang (stop transmitting) under certain network conditions.
 108  *            If this occurs a WATCHDOG message is logged in the system
 109  *            event log. In addition, the controller is automatically reset,
 110  *            restoring the network connection. To eliminate the potential
 111  *            for the hang ensure that IGB_RDTR is set to 0.
 112  */
 113 #define IGB_RDTR                         0
 114
 115 /*
 116  * Receive Interrupt Absolute Delay Timer (Not valid for 82542/82543/82544)
 117  * Valid Range: 0-65535 (0=off)
 118  * Default Value: 64
 119  *   This value, in units of 1.024 microseconds, limits the delay in which a
 120  *   receive interrupt is generated. Useful only if IGB_RDTR is non-zero,
 121  *   this value ensures that an interrupt is generated after the initial
 122  *   packet is received within the set amount of time.  Proper tuning,
 123  *   along with IGB_RDTR, may improve traffic throughput in specific network
 124  *   conditions.
 125  */
 126 #define IGB_RADV                         64
 127
 128 /*
 129  * This parameter controls the duration of transmit watchdog timer.
 130  */
 131 #define IGB_WATCHDOG                   (10 * hz)
 132
 133 /*
 134  * This parameter controls when the driver calls the routine to reclaim
 135  * transmit descriptors.
 136  */
 137 #define IGB_TX_CLEANUP_THRESHOLD        (adapter->num_tx_desc / 8)
 138 #define IGB_TX_OP_THRESHOLD     (adapter->num_tx_desc / 32)
 139
 140 /*
 141  * This parameter controls whether or not autonegotation is enabled.
 142  *              0 - Disable autonegotiation
 143  *              1 - Enable  autonegotiation
 144  */
 145 #define DO_AUTO_NEG                     1
 146
 147 /*
 148  * This parameter control whether or not the driver will wait for
 149  * autonegotiation to complete.
 150  *              1 - Wait for autonegotiation to complete
 151  *              0 - Don't wait for autonegotiation to complete
 152  */
 153 #define WAIT_FOR_AUTO_NEG_DEFAULT       0
 154
 155 /* Tunables -- End */
 156
 157 #define AUTONEG_ADV_DEFAULT     (ADVERTISE_10_HALF | ADVERTISE_10_FULL | \
 158                                 ADVERTISE_100_HALF | ADVERTISE_100_FULL | \
 159                                 ADVERTISE_1000_FULL)
 160
 161 #define AUTO_ALL_MODES          0
 162
 163 /* PHY master/slave setting */
 164 #define IGB_MASTER_SLAVE                e1000_ms_hw_default
 165
 166 /*
 167  * Micellaneous constants
 168  */
 169 #define IGB_VENDOR_ID                   0x8086
 170
 171 #define IGB_JUMBO_PBA                   0x00000028
 172 #define IGB_DEFAULT_PBA                 0x00000030
 173 #define IGB_SMARTSPEED_DOWNSHIFT        3
 174 #define IGB_SMARTSPEED_MAX              15
 175 #define IGB_MAX_LOOP                    10
 176
 177 #define IGB_RX_PTHRESH                  (hw->mac.type <= e1000_82576 ? 16 : 8)
 178 #define IGB_RX_HTHRESH                  8
 179 #define IGB_RX_WTHRESH                  1
 180
 181 #define IGB_TX_PTHRESH                  8
 182 #define IGB_TX_HTHRESH                  1
 183 #define IGB_TX_WTHRESH                  ((hw->mac.type == e1000_82576 && \
 184                                           adapter->msix_mem) ? 1 : 16)
 185
 186 #define MAX_NUM_MULTICAST_ADDRESSES     128
 187 #define PCI_ANY_ID                      (~0U)
 188 #define ETHER_ALIGN                     2
 189 #define IGB_TX_BUFFER_SIZE              ((uint32_t) 1514)
 190 #define IGB_FC_PAUSE_TIME               0x0680
 191 #define IGB_EEPROM_APME                 0x400;
 192
 193 /*
 194  * TDBA/RDBA should be aligned on 16 byte boundary. But TDLEN/RDLEN should be
 195  * multiple of 128 bytes. So we align TDBA/RDBA on 128 byte boundary. This will
 196  * also optimize cache line size effect. H/W supports up to cache line size 128.
 197  */
 198 #define IGB_DBA_ALIGN                   128
 199
 200 #define SPEED_MODE_BIT (1<<21)          /* On PCI-E MACs only */
 201
 202 /* PCI Config defines */
 203 #define IGB_MSIX_BAR            3
 204
 205 /*
 206 ** This is the total number of MSIX vectors you wish
 207 ** to use, it also controls the size of resources.
 208 ** The 82575 has a total of 10, 82576 has 25. Set this
 209 ** to the real amount you need to streamline data storage.
 210 */
 211 #define IGB_MSIX_VEC            6       /* MSIX vectors configured */
 212
 213 /* Defines for printing debug information */
 214 #define DEBUG_INIT  0
 215 #define DEBUG_IOCTL 0
 216 #define DEBUG_HW    0
 217
 218 #define INIT_DEBUGOUT(S)            if (DEBUG_INIT)  kprintf(S "\n")
 219 #define INIT_DEBUGOUT1(S, A)        if (DEBUG_INIT)  kprintf(S "\n", A)
 220 #define INIT_DEBUGOUT2(S, A, B)     if (DEBUG_INIT)  kprintf(S "\n", A, B)
 221 #define IOCTL_DEBUGOUT(S)           if (DEBUG_IOCTL) kprintf(S "\n")
 222 #define IOCTL_DEBUGOUT1(S, A)       if (DEBUG_IOCTL) kprintf(S "\n", A)
 223 #define IOCTL_DEBUGOUT2(S, A, B)    if (DEBUG_IOCTL) kprintf(S "\n", A, B)
 224 #define HW_DEBUGOUT(S)              if (DEBUG_HW) kprintf(S "\n")
 225 #define HW_DEBUGOUT1(S, A)          if (DEBUG_HW) kprintf(S "\n", A)
 226 #define HW_DEBUGOUT2(S, A, B)       if (DEBUG_HW) kprintf(S "\n", A, B)
 227
 228 #define IGB_MAX_SCATTER         64
 229 #define IGB_VFTA_SIZE           128
 230 #define IGB_BR_SIZE             4096    /* ring buf size */
 231 #define IGB_TSO_SIZE            (65535 + sizeof(struct ether_vlan_header))
 232 #define IGB_TSO_SEG_SIZE        4096    /* Max dma segment size */
 233 #define IGB_HDR_BUF             128
 234 #define IGB_PKTTYPE_MASK        0x0000FFF0
 235 #define ETH_ZLEN                60
 236 #define ETH_ADDR_LEN            6
 237
 238 /* Offload bits in mbuf flag */
 239 #if __FreeBSD_version >= 800000
 240 #define CSUM_OFFLOAD            (CSUM_IP|CSUM_TCP|CSUM_UDP|CSUM_SCTP)
 241 #else
 242 #define CSUM_OFFLOAD            (CSUM_IP|CSUM_TCP|CSUM_UDP)
 243 #endif
 244
 245 /* Define the starting Interrupt rate per Queue */
 246 #define IGB_INTS_PER_SEC        8000
 247 #define IGB_DEFAULT_ITR          1000000000/(IGB_INTS_PER_SEC * 256)
 248
 249
 250 /* Header split codes for get_buf */
 251 #define IGB_CLEAN_HEADER                0x01
 252 #define IGB_CLEAN_PAYLOAD               0x02
 253 #define IGB_CLEAN_INITIAL               0x04
 254 #define IGB_CLEAN_BOTH                  (IGB_CLEAN_HEADER | IGB_CLEAN_PAYLOAD)
 255
 256 #define IGB_LINK_ITR            2000
 257
 258 /* Precision Time Sync (IEEE 1588) defines */
 259 #define ETHERTYPE_IEEE1588      0x88F7
 260 #define PICOSECS_PER_TICK       20833
 261 #define TSYNC_PORT              319 /* UDP port for the protocol */
 262
 263 /*
 264  * Bus dma allocation structure used by
 265  * e1000_dma_malloc and e1000_dma_free.
 266  */
 267 struct igb_dma_alloc {
 268         bus_addr_t              dma_paddr;
 269         caddr_t                 dma_vaddr;
 270         bus_dma_tag_t           dma_tag;
 271         bus_dmamap_t            dma_map;
 272         bus_dma_segment_t       dma_seg;
 273         int                     dma_nseg;
 274 };
 275
 276
 277 /*
 278 ** Driver queue struct: this is the interrupt container
 279 **  for the associated tx and rx ring.
 280 */
 281 struct igb_queue {
 282         struct adapter          *adapter;
 283         u32                     msix;           /* This queue's MSIX vector */
 284         u32                     eims;           /* This queue's EIMS bit */
 285         u32                     eitr_setting;
 286         struct resource         *res;
 287         void                    *tag;
 288         struct tx_ring          *txr;
 289         struct rx_ring          *rxr;
 290         struct task             que_task;
 291         struct taskqueue        *tq;
 292         u64                     irqs;
 293 };
 294
 295 /*
 296  * Transmit ring: one per queue
 297  */
 298 struct tx_ring {
 299         struct adapter          *adapter;
 300         u32                     me;
 301         struct lock             tx_lock;
 302         char                    spin_name[16];
 303         struct igb_dma_alloc    txdma;
 304         struct e1000_tx_desc    *tx_base;
 305         u32                     next_avail_desc;
 306         u32                     next_to_clean;
 307         volatile u16            tx_avail;
 308         struct igb_tx_buffer    *tx_buffers;
 309 #if __FreeBSD_version >= 800000
 310         struct buf_ring         *br;
 311 #endif
 312         bus_dma_tag_t           txtag;
 313
 314         u32                     bytes;
 315         u32                     packets;
 316
 317         bool                    watchdog_check;
 318         int                     watchdog_time;
 319         u64                     no_desc_avail;
 320         u64                     tx_packets;
 321 };
 322
 323 /*
 324  * Receive ring: one per queue
 325  */
 326 struct rx_ring {
 327         struct adapter          *adapter;
 328         u32                     me;
 329         struct igb_dma_alloc    rxdma;
 330         union e1000_adv_rx_desc *rx_base;
 331 #if NET_LRO
 332         struct lro_ctrl         lro;
 333 #endif
 334         bool                    lro_enabled;
 335         bool                    hdr_split;
 336         bool                    discard;
 337         struct lock             rx_lock;
 338         char                    spin_name[16];
 339         u32                     last_cleaned;
 340         u32                     next_to_check;
 341         struct igb_rx_buf       *rx_buffers;
 342         bus_dma_tag_t           rx_htag;        /* dma tag for rx head */
 343         bus_dmamap_t            rx_hspare_map;
 344         bus_dma_tag_t           rx_ptag;        /* dma tag for rx packet */
 345         bus_dmamap_t            rx_pspare_map;
 346         /*
 347          * First/last mbuf pointers, for
 348          * collecting multisegment RX packets.
 349          */
 350         struct mbuf            *fmp;
 351         struct mbuf            *lmp;
 352
 353         u32                     bytes;
 354         u32                     packets;
 355
 356         /* Soft stats */
 357         u64                     rx_split_packets;
 358         u64                     rx_discarded;
 359         u64                     rx_packets;
 360         u64                     rx_bytes;
 361 };
 362
 363 struct adapter {
 364         struct arpcom           arpcom;
 365         struct ifnet    *ifp;
 366         struct e1000_hw hw;
 367
 368         struct e1000_osdep osdep;
 369         device_t dev;
 370
 371         struct resource *pci_mem;
 372         struct resource *msix_mem;
 373         struct resource *res;
 374         void            *tag;
 375         u32             eims_mask;
 376
 377         int             linkvec;
 378         int             link_mask;
 379         struct task     link_task;
 380         int             link_irq;
 381
 382         struct ifmedia  media;
 383         struct callout  timer;
 384         int             msix;   /* total vectors allocated */
 385         int             if_flags;
 386         int             max_frame_size;
 387         int             min_frame_size;
 388         struct lock     core_lock;
 389         int             igb_insert_vlan_header;
 390         struct task     rxtx_task;
 391         struct taskqueue *tq;   /* adapter task queue */
 392         u16             num_queues;
 393
 394         eventhandler_tag vlan_attach;
 395         eventhandler_tag vlan_detach;
 396         u32             num_vlans;
 397
 398         /* Management and WOL features */
 399         int             wol;
 400         int             has_manage;
 401
 402         /* Info about the board itself */
 403         u8              link_active;
 404         u16             link_speed;
 405         u16             link_duplex;
 406         u32             smartspeed;
 407
 408         /* Interface queues */
 409         struct igb_queue        *queues;
 410
 411         /*
 412          * Transmit rings
 413          */
 414         struct tx_ring          *tx_rings;
 415         u16                     num_tx_desc;
 416
 417         /*
 418          * Receive rings
 419          */
 420         struct rx_ring          *rx_rings;
 421         bool                    rx_hdr_split;
 422         u16                     num_rx_desc;
 423         int                     rx_process_limit;
 424         u32                     rx_mbuf_sz;
 425         u32                     rx_mask;
 426
 427         /* Misc stats maintained by the driver */
 428         unsigned long   dropped_pkts;
 429         unsigned long   mbuf_defrag_failed;
 430         unsigned long   mbuf_header_failed;
 431         unsigned long   mbuf_packet_failed;
 432         unsigned long   no_tx_map_avail;
 433         unsigned long   no_tx_dma_setup;
 434         unsigned long   watchdog_events;
 435         unsigned long   rx_overruns;
 436
 437         boolean_t       in_detach;
 438
 439 #ifdef IGB_IEEE1588
 440         /* IEEE 1588 precision time support */
 441         struct cyclecounter     cycles;
 442         struct nettimer         clock;
 443         struct nettime_compare  compare;
 444         struct hwtstamp_ctrl    hwtstamp;
 445 #endif
 446
 447         /* sysctl tree glue */
 448         struct sysctl_ctx_list  sysctl_ctx;
 449         struct sysctl_oid       *sysctl_tree;
 450
 451         struct e1000_hw_stats stats;
 452 };
 453
 454 /* ******************************************************************************
 455  * vendor_info_array
 456  *
 457  * This array contains the list of Subvendor/Subdevice IDs on which the driver
 458  * should load.
 459  *
 460  * ******************************************************************************/
 461 typedef struct _igb_vendor_info_t {
 462         unsigned int vendor_id;
 463         unsigned int device_id;
 464         unsigned int subvendor_id;
 465         unsigned int subdevice_id;
 466         unsigned int index;
 467 } igb_vendor_info_t;
 468
 469
 470 struct igb_tx_buffer {
 471         int             next_eop;  /* Index of the desc to watch */
 472         struct mbuf    *m_head;
 473         bus_dmamap_t    map;         /* bus_dma map for packet */
 474 };
 475
 476 struct igb_rx_buf {
 477         struct mbuf    *m_head;
 478         struct mbuf    *m_pack;
 479         bus_dmamap_t    head_map;       /* bus_dma map for packet */
 480         bus_dmamap_t    pack_map;       /* bus_dma map for packet */
 481 };
 482
 483 #define IGB_CORE_LOCK_INIT(_sc, _name)  lockinit(&(_sc)->core_lock, \
 484                                                         "igb", 0, 0)
 485 #define IGB_CORE_LOCK_DESTROY(_sc)      lockuninit(&(_sc)->core_lock)
 486 #define IGB_CORE_LOCK(_sc)              lockmgr(&(_sc)->core_lock, LK_EXCLUSIVE)
 487 #define IGB_CORE_UNLOCK(_sc)            lockmgr(&(_sc)->core_lock, LK_RELEASE)
 488 #define IGB_CORE_LOCK_ASSERT(_sc)
 489
 490 #define IGB_TX_LOCK_INIT(_sc)           lockinit(&(_sc)->tx_lock, \
 491                                                         "igbtx", 0, 0)
 492 #define IGB_TX_LOCK_DESTROY(_sc)        lockuninit(&(_sc)->tx_lock)
 493 #define IGB_TX_LOCK(_sc)                lockmgr(&(_sc)->tx_lock, LK_EXCLUSIVE)
 494 #define IGB_TX_UNLOCK(_sc)              lockmgr(&(_sc)->tx_lock, LK_RELEASE)
 495 #define IGB_TX_TRYLOCK(_sc)             lockmgr(&(_sc)->tx_lock, LK_EXCLUSIVE|LK_NOWAIT)
 496 #define IGB_TX_LOCK_ASSERT(_sc)
 497
 498 #define IGB_RX_LOCK_INIT(_sc)           lockinit(&(_sc)->rx_lock, \
 499                                                         "igbrx", 0, 0)
 500 #define IGB_RX_LOCK_DESTROY(_sc)        lockuninit(&(_sc)->rx_lock)
 501 #define IGB_RX_LOCK(_sc)                lockmgr(&(_sc)->rx_lock, LK_EXCLUSIVE)
 502 #define IGB_RX_UNLOCK(_sc)              lockmgr(&(_sc)->rx_lock, LK_RELEASE)
 503 #define IGB_TX_LOCK_ASSERT(_sc)
 504
 505 #endif /* _IGB_H_DEFINED_ */
 506
 507