sys/dev/e1000/if_em.h

   1 /******************************************************************************
   2
   3   Copyright (c) 2001-2015, 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
  36 #ifndef _EM_H_DEFINED_
  37 #define _EM_H_DEFINED_
  38
  39
  40 /* Tunables */
  41
  42 /*
  43  * EM_TXD: Maximum number of Transmit Descriptors
  44  * Valid Range: 80-256 for 82542 and 82543-based adapters
  45  *              80-4096 for others
  46  * Default Value: 256
  47  *   This value is the number of transmit descriptors allocated by the driver.
  48  *   Increasing this value allows the driver to queue more transmits. Each
  49  *   descriptor is 16 bytes.
  50  *   Since TDLEN should be multiple of 128bytes, the number of transmit
  51  *   desscriptors should meet the following condition.
  52  *      (num_tx_desc * sizeof(struct e1000_tx_desc)) % 128 == 0
  53  */
  54 #define EM_MIN_TXD              80
  55 #define EM_MAX_TXD              4096
  56 #define EM_DEFAULT_TXD          1024
  57
  58 /*
  59  * EM_RXD - Maximum number of receive Descriptors
  60  * Valid Range: 80-256 for 82542 and 82543-based adapters
  61  *              80-4096 for others
  62  * Default Value: 256
  63  *   This value is the number of receive descriptors allocated by the driver.
  64  *   Increasing this value allows the driver to buffer more incoming packets.
  65  *   Each descriptor is 16 bytes.  A receive buffer is also allocated for each
  66  *   descriptor. The maximum MTU size is 16110.
  67  *   Since TDLEN should be multiple of 128bytes, the number of transmit
  68  *   desscriptors should meet the following condition.
  69  *      (num_tx_desc * sizeof(struct e1000_tx_desc)) % 128 == 0
  70  */
  71 #define EM_MIN_RXD              80
  72 #define EM_MAX_RXD              4096
  73 #define EM_DEFAULT_RXD          1024
  74
  75 /*
  76  * EM_TIDV - Transmit Interrupt Delay Value
  77  * Valid Range: 0-65535 (0=off)
  78  * Default Value: 64
  79  *   This value delays the generation of transmit interrupts in units of
  80  *   1.024 microseconds. Transmit interrupt reduction can improve CPU
  81  *   efficiency if properly tuned for specific network traffic. If the
  82  *   system is reporting dropped transmits, this value may be set too high
  83  *   causing the driver to run out of available transmit descriptors.
  84  */
  85 #define EM_TIDV                         64
  86
  87 /*
  88  * EM_TADV - Transmit Absolute Interrupt Delay Value
  89  * (Not valid for 82542/82543/82544)
  90  * Valid Range: 0-65535 (0=off)
  91  * Default Value: 64
  92  *   This value, in units of 1.024 microseconds, limits the delay in which a
  93  *   transmit interrupt is generated. Useful only if EM_TIDV is non-zero,
  94  *   this value ensures that an interrupt is generated after the initial
  95  *   packet is sent on the wire within the set amount of time.  Proper tuning,
  96  *   along with EM_TIDV, may improve traffic throughput in specific
  97  *   network conditions.
  98  */
  99 #define EM_TADV                         64
 100
 101 /*
 102  * EM_RDTR - Receive Interrupt Delay Timer (Packet Timer)
 103  * Valid Range: 0-65535 (0=off)
 104  * Default Value: 0
 105  *   This value delays the generation of receive interrupts in units of 1.024
 106  *   microseconds.  Receive interrupt reduction can improve CPU efficiency if
 107  *   properly tuned for specific network traffic. Increasing this value adds
 108  *   extra latency to frame reception and can end up decreasing the throughput
 109  *   of TCP traffic. If the system is reporting dropped receives, this value
 110  *   may be set too high, causing the driver to run out of available receive
 111  *   descriptors.
 112  *
 113  *   CAUTION: When setting EM_RDTR to a value other than 0, adapters
 114  *            may hang (stop transmitting) under certain network conditions.
 115  *            If this occurs a WATCHDOG message is logged in the system
 116  *            event log. In addition, the controller is automatically reset,
 117  *            restoring the network connection. To eliminate the potential
 118  *            for the hang ensure that EM_RDTR is set to 0.
 119  */
 120 #define EM_RDTR                         0
 121
 122 /*
 123  * Receive Interrupt Absolute Delay Timer (Not valid for 82542/82543/82544)
 124  * Valid Range: 0-65535 (0=off)
 125  * Default Value: 64
 126  *   This value, in units of 1.024 microseconds, limits the delay in which a
 127  *   receive interrupt is generated. Useful only if EM_RDTR is non-zero,
 128  *   this value ensures that an interrupt is generated after the initial
 129  *   packet is received within the set amount of time.  Proper tuning,
 130  *   along with EM_RDTR, may improve traffic throughput in specific network
 131  *   conditions.
 132  */
 133 #define EM_RADV                         64
 134
 135 /*
 136  * This parameter controls the max duration of transmit watchdog.
 137  */
 138 #define EM_WATCHDOG                   (10 * hz)
 139
 140 /*
 141  * This parameter controls when the driver calls the routine to reclaim
 142  * transmit descriptors.
 143  */
 144 #define EM_TX_CLEANUP_THRESHOLD (adapter->num_tx_desc / 8)
 145
 146 /*
 147  * This parameter controls whether or not autonegotation is enabled.
 148  *              0 - Disable autonegotiation
 149  *              1 - Enable  autonegotiation
 150  */
 151 #define DO_AUTO_NEG                     1
 152
 153 /*
 154  * This parameter control whether or not the driver will wait for
 155  * autonegotiation to complete.
 156  *              1 - Wait for autonegotiation to complete
 157  *              0 - Don't wait for autonegotiation to complete
 158  */
 159 #define WAIT_FOR_AUTO_NEG_DEFAULT       0
 160
 161 /* Tunables -- End */
 162
 163 #define AUTONEG_ADV_DEFAULT     (ADVERTISE_10_HALF | ADVERTISE_10_FULL | \
 164                                 ADVERTISE_100_HALF | ADVERTISE_100_FULL | \
 165                                 ADVERTISE_1000_FULL)
 166
 167 #define AUTO_ALL_MODES          0
 168
 169 /* PHY master/slave setting */
 170 #define EM_MASTER_SLAVE         e1000_ms_hw_default
 171
 172 /*
 173  * Micellaneous constants
 174  */
 175 #define EM_VENDOR_ID                    0x8086
 176 #define EM_FLASH                        0x0014
 177
 178 #define EM_JUMBO_PBA                    0x00000028
 179 #define EM_DEFAULT_PBA                  0x00000030
 180 #define EM_SMARTSPEED_DOWNSHIFT         3
 181 #define EM_SMARTSPEED_MAX               15
 182 #define EM_MAX_LOOP                     10
 183
 184 #define MAX_NUM_MULTICAST_ADDRESSES     128
 185 #define PCI_ANY_ID                      (~0U)
 186 #define ETHER_ALIGN                     2
 187 #define EM_FC_PAUSE_TIME                0x0680
 188 #define EM_EEPROM_APME                  0x400;
 189 #define EM_82544_APME                   0x0004;
 190
 191 /*
 192  * Driver state logic for the detection of a hung state
 193  * in hardware.  Set TX_HUNG whenever a TX packet is used
 194  * (data is sent) and clear it when txeof() is invoked if
 195  * any descriptors from the ring are cleaned/reclaimed.
 196  * Increment internal counter if no descriptors are cleaned
 197  * and compare to TX_MAXTRIES.  When counter > TX_MAXTRIES,
 198  * reset adapter.
 199  */
 200 #define EM_TX_IDLE                      0x00000000
 201 #define EM_TX_BUSY                      0x00000001
 202 #define EM_TX_HUNG                      0x80000000
 203 #define EM_TX_MAXTRIES                  10
 204
 205 /*
 206  * TDBA/RDBA should be aligned on 16 byte boundary. But TDLEN/RDLEN should be
 207  * multiple of 128 bytes. So we align TDBA/RDBA on 128 byte boundary. This will
 208  * also optimize cache line size effect. H/W supports up to cache line size 128.
 209  */
 210 #define EM_DBA_ALIGN                    128
 211
 212 #define SPEED_MODE_BIT (1<<21)          /* On PCI-E MACs only */
 213
 214 /* PCI Config defines */
 215 #define EM_BAR_TYPE(v)          ((v) & EM_BAR_TYPE_MASK)
 216 #define EM_BAR_TYPE_MASK        0x00000001
 217 #define EM_BAR_TYPE_MMEM        0x00000000
 218 #define EM_BAR_TYPE_FLASH       0x0014
 219 #define EM_BAR_MEM_TYPE(v)      ((v) & EM_BAR_MEM_TYPE_MASK)
 220 #define EM_BAR_MEM_TYPE_MASK    0x00000006
 221 #define EM_BAR_MEM_TYPE_32BIT   0x00000000
 222 #define EM_BAR_MEM_TYPE_64BIT   0x00000004
 223 #define EM_MSIX_BAR             3       /* On 82575 */
 224
 225 /* More backward compatibility */
 226 #if __FreeBSD_version < 900000
 227 #define SYSCTL_ADD_UQUAD SYSCTL_ADD_QUAD
 228 #endif
 229
 230 /* Defines for printing debug information */
 231 #define DEBUG_INIT  0
 232 #define DEBUG_IOCTL 0
 233 #define DEBUG_HW    0
 234
 235 #define INIT_DEBUGOUT(S)            if (DEBUG_INIT)  printf(S "\n")
 236 #define INIT_DEBUGOUT1(S, A)        if (DEBUG_INIT)  printf(S "\n", A)
 237 #define INIT_DEBUGOUT2(S, A, B)     if (DEBUG_INIT)  printf(S "\n", A, B)
 238 #define IOCTL_DEBUGOUT(S)           if (DEBUG_IOCTL) printf(S "\n")
 239 #define IOCTL_DEBUGOUT1(S, A)       if (DEBUG_IOCTL) printf(S "\n", A)
 240 #define IOCTL_DEBUGOUT2(S, A, B)    if (DEBUG_IOCTL) printf(S "\n", A, B)
 241 #define HW_DEBUGOUT(S)              if (DEBUG_HW) printf(S "\n")
 242 #define HW_DEBUGOUT1(S, A)          if (DEBUG_HW) printf(S "\n", A)
 243 #define HW_DEBUGOUT2(S, A, B)       if (DEBUG_HW) printf(S "\n", A, B)
 244
 245 #define EM_MAX_SCATTER          32
 246 #define EM_VFTA_SIZE            128
 247 #define EM_TSO_SIZE             (65535 + sizeof(struct ether_vlan_header))
 248 #define EM_TSO_SEG_SIZE         4096    /* Max dma segment size */
 249 #define EM_MSIX_MASK            0x01F00000 /* For 82574 use */
 250 #define EM_MSIX_LINK            0x01000000 /* For 82574 use */
 251 #define ETH_ZLEN                60
 252 #define ETH_ADDR_LEN            6
 253 #define CSUM_OFFLOAD            7       /* Offload bits in mbuf flag */
 254
 255 /*
 256  * 82574 has a nonstandard address for EIAC
 257  * and since its only used in MSIX, and in
 258  * the em driver only 82574 uses MSIX we can
 259  * solve it just using this define.
 260  */
 261 #define EM_EIAC 0x000DC
 262
 263 /*
 264  * Bus dma allocation structure used by
 265  * e1000_dma_malloc and e1000_dma_free.
 266  */
 267 struct em_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 struct adapter;
 277
 278 struct em_int_delay_info {
 279         struct adapter *adapter;        /* Back-pointer to the adapter struct */
 280         int offset;                     /* Register offset to read/write */
 281         int value;                      /* Current value in usecs */
 282 };
 283
 284 /*
 285  * The transmit ring, one per tx queue
 286  */
 287 struct tx_ring {
 288         struct adapter          *adapter;
 289         struct mtx              tx_mtx;
 290         char                    mtx_name[16];
 291         u32                     me;
 292         u32                     msix;
 293         u32                     ims;
 294         int                     busy;
 295         struct em_dma_alloc     txdma;
 296         struct e1000_tx_desc    *tx_base;
 297         struct task             tx_task;
 298         struct taskqueue        *tq;
 299         u32                     next_avail_desc;
 300         u32                     next_to_clean;
 301         struct em_buffer        *tx_buffers;
 302         volatile u16            tx_avail;
 303         u32                     tx_tso;         /* last tx was tso */
 304         u16                     last_hw_offload;
 305         u8                      last_hw_ipcso;
 306         u8                      last_hw_ipcss;
 307         u8                      last_hw_tucso;
 308         u8                      last_hw_tucss;
 309 #if __FreeBSD_version >= 800000
 310         struct buf_ring         *br;
 311 #endif
 312         /* Interrupt resources */
 313         bus_dma_tag_t           txtag;
 314         void                    *tag;
 315         struct resource         *res;
 316         unsigned long           tx_irq;
 317         unsigned long           no_desc_avail;
 318 };
 319
 320 /*
 321  * The Receive ring, one per rx queue
 322  */
 323 struct rx_ring {
 324         struct adapter          *adapter;
 325         u32                     me;
 326         u32                     msix;
 327         u32                     ims;
 328         struct mtx              rx_mtx;
 329         char                    mtx_name[16];
 330         u32                     payload;
 331         struct task             rx_task;
 332         struct taskqueue        *tq;
 333         struct e1000_rx_desc    *rx_base;
 334         struct em_dma_alloc     rxdma;
 335         u32                     next_to_refresh;
 336         u32                     next_to_check;
 337         struct em_buffer        *rx_buffers;
 338         struct mbuf             *fmp;
 339         struct mbuf             *lmp;
 340
 341         /* Interrupt resources */
 342         void                    *tag;
 343         struct resource         *res;
 344         bus_dma_tag_t           rxtag;
 345         bool                    discard;
 346
 347         /* Soft stats */
 348         unsigned long           rx_irq;
 349         unsigned long           rx_discarded;
 350         unsigned long           rx_packets;
 351         unsigned long           rx_bytes;
 352 };
 353
 354
 355 /* Our adapter structure */
 356 struct adapter {
 357         struct ifnet    *ifp;
 358         struct e1000_hw hw;
 359
 360         /* FreeBSD operating-system-specific structures. */
 361         struct e1000_osdep osdep;
 362         struct device   *dev;
 363         struct cdev     *led_dev;
 364
 365         struct resource *memory;
 366         struct resource *flash;
 367         struct resource *msix_mem;
 368
 369         struct resource *res;
 370         void            *tag;
 371         u32             linkvec;
 372         u32             ivars;
 373
 374         struct ifmedia  media;
 375         struct callout  timer;
 376         int             msix;
 377         int             if_flags;
 378         int             max_frame_size;
 379         int             min_frame_size;
 380         struct mtx      core_mtx;
 381         int             em_insert_vlan_header;
 382         u32             ims;
 383         bool            in_detach;
 384
 385         /* Task for FAST handling */
 386         struct task     link_task;
 387         struct task     que_task;
 388         struct taskqueue *tq;           /* private task queue */
 389
 390         eventhandler_tag vlan_attach;
 391         eventhandler_tag vlan_detach;
 392
 393         u16     num_vlans;
 394         u16     num_queues;
 395
 396         /*
 397          * Transmit rings:
 398          *      Allocated at run time, an array of rings.
 399          */
 400         struct tx_ring  *tx_rings;
 401         int             num_tx_desc;
 402         u32             txd_cmd;
 403
 404         /*
 405          * Receive rings:
 406          *      Allocated at run time, an array of rings.
 407          */
 408         struct rx_ring  *rx_rings;
 409         int             num_rx_desc;
 410         u32             rx_process_limit;
 411         u32             rx_mbuf_sz;
 412
 413         /* Management and WOL features */
 414         u32             wol;
 415         bool            has_manage;
 416         bool            has_amt;
 417
 418         /* Multicast array memory */
 419         u8              *mta;
 420
 421         /*
 422         ** Shadow VFTA table, this is needed because
 423         ** the real vlan filter table gets cleared during
 424         ** a soft reset and the driver needs to be able
 425         ** to repopulate it.
 426         */
 427         u32             shadow_vfta[EM_VFTA_SIZE];
 428
 429         /* Info about the interface */
 430         u16             link_active;
 431         u16             fc;
 432         u16             link_speed;
 433         u16             link_duplex;
 434         u32             smartspeed;
 435
 436         struct em_int_delay_info tx_int_delay;
 437         struct em_int_delay_info tx_abs_int_delay;
 438         struct em_int_delay_info rx_int_delay;
 439         struct em_int_delay_info rx_abs_int_delay;
 440         struct em_int_delay_info tx_itr;
 441
 442         /* Misc stats maintained by the driver */
 443         unsigned long   dropped_pkts;
 444         unsigned long   mbuf_alloc_failed;
 445         unsigned long   mbuf_cluster_failed;
 446         unsigned long   no_tx_map_avail;
 447         unsigned long   no_tx_dma_setup;
 448         unsigned long   rx_overruns;
 449         unsigned long   watchdog_events;
 450         unsigned long   link_irq;
 451
 452         struct e1000_hw_stats stats;
 453 };
 454
 455 /********************************************************************************
 456  * vendor_info_array
 457  *
 458  * This array contains the list of Subvendor/Subdevice IDs on which the driver
 459  * should load.
 460  *
 461  ********************************************************************************/
 462 typedef struct _em_vendor_info_t {
 463         unsigned int vendor_id;
 464         unsigned int device_id;
 465         unsigned int subvendor_id;
 466         unsigned int subdevice_id;
 467         unsigned int index;
 468 } em_vendor_info_t;
 469
 470 struct em_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
 477 /*
 478 ** Find the number of unrefreshed RX descriptors
 479 */
 480 static inline u16
 481 e1000_rx_unrefreshed(struct rx_ring *rxr)
 482 {
 483         struct adapter  *adapter = rxr->adapter;
 484
 485         if (rxr->next_to_check > rxr->next_to_refresh)
 486                 return (rxr->next_to_check - rxr->next_to_refresh - 1);
 487         else
 488                 return ((adapter->num_rx_desc + rxr->next_to_check) -
 489                     rxr->next_to_refresh - 1);
 490 }
 491
 492 #define EM_CORE_LOCK_INIT(_sc, _name) \
 493         mtx_init(&(_sc)->core_mtx, _name, "EM Core Lock", MTX_DEF)
 494 #define EM_TX_LOCK_INIT(_sc, _name) \
 495         mtx_init(&(_sc)->tx_mtx, _name, "EM TX Lock", MTX_DEF)
 496 #define EM_RX_LOCK_INIT(_sc, _name) \
 497         mtx_init(&(_sc)->rx_mtx, _name, "EM RX Lock", MTX_DEF)
 498 #define EM_CORE_LOCK_DESTROY(_sc)       mtx_destroy(&(_sc)->core_mtx)
 499 #define EM_TX_LOCK_DESTROY(_sc)         mtx_destroy(&(_sc)->tx_mtx)
 500 #define EM_RX_LOCK_DESTROY(_sc)         mtx_destroy(&(_sc)->rx_mtx)
 501 #define EM_CORE_LOCK(_sc)               mtx_lock(&(_sc)->core_mtx)
 502 #define EM_TX_LOCK(_sc)                 mtx_lock(&(_sc)->tx_mtx)
 503 #define EM_TX_TRYLOCK(_sc)              mtx_trylock(&(_sc)->tx_mtx)
 504 #define EM_RX_LOCK(_sc)                 mtx_lock(&(_sc)->rx_mtx)
 505 #define EM_CORE_UNLOCK(_sc)             mtx_unlock(&(_sc)->core_mtx)
 506 #define EM_TX_UNLOCK(_sc)               mtx_unlock(&(_sc)->tx_mtx)
 507 #define EM_RX_UNLOCK(_sc)               mtx_unlock(&(_sc)->rx_mtx)
 508 #define EM_CORE_LOCK_ASSERT(_sc)        mtx_assert(&(_sc)->core_mtx, MA_OWNED)
 509 #define EM_TX_LOCK_ASSERT(_sc)          mtx_assert(&(_sc)->tx_mtx, MA_OWNED)
 510 #define EM_RX_LOCK_ASSERT(_sc)          mtx_assert(&(_sc)->rx_mtx, MA_OWNED)
 511
 512 #endif /* _EM_H_DEFINED_ */