sys/dev/netif/e1000/if_em.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
  34
  35 #ifndef _EM_H_DEFINED_
  36 #define _EM_H_DEFINED_
  37
  38
  39 /* Tunables */
  40
  41 /*
  42  * EM_TXD: Maximum number of Transmit Descriptors
  43  * Valid Range: 80-256 for 82542 and 82543-based adapters
  44  *              80-4096 for others
  45  * Default Value: 256
  46  *   This value is the number of transmit descriptors allocated by the driver.
  47  *   Increasing this value allows the driver to queue more transmits. Each
  48  *   descriptor is 16 bytes.
  49  *   Since TDLEN should be multiple of 128bytes, the number of transmit
  50  *   desscriptors should meet the following condition.
  51  *      (num_tx_desc * sizeof(struct e1000_tx_desc)) % 128 == 0
  52  */
  53 #define EM_MIN_TXD              80
  54 #define EM_MAX_TXD_82543        256
  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_82543        256
  73 #define EM_MAX_RXD              4096
  74 #define EM_DEFAULT_RXD          1024
  75
  76 /*
  77  * EM_TIDV - Transmit Interrupt Delay Value
  78  * Valid Range: 0-65535 (0=off)
  79  * Default Value: 64
  80  *   This value delays the generation of transmit interrupts in units of
  81  *   1.024 microseconds. Transmit interrupt reduction can improve CPU
  82  *   efficiency if properly tuned for specific network traffic. If the
  83  *   system is reporting dropped transmits, this value may be set too high
  84  *   causing the driver to run out of available transmit descriptors.
  85  */
  86 #define EM_TIDV                         64
  87
  88 /*
  89  * EM_TADV - Transmit Absolute Interrupt Delay Value
  90  * (Not valid for 82542/82543/82544)
  91  * Valid Range: 0-65535 (0=off)
  92  * Default Value: 64
  93  *   This value, in units of 1.024 microseconds, limits the delay in which a
  94  *   transmit interrupt is generated. Useful only if EM_TIDV is non-zero,
  95  *   this value ensures that an interrupt is generated after the initial
  96  *   packet is sent on the wire within the set amount of time.  Proper tuning,
  97  *   along with EM_TIDV, may improve traffic throughput in specific
  98  *   network conditions.
  99  */
 100 #define EM_TADV                         64
 101
 102 /*
 103  * EM_RDTR - Receive Interrupt Delay Timer (Packet Timer)
 104  * Valid Range: 0-65535 (0=off)
 105  * Default Value: 0
 106  *   This value delays the generation of receive interrupts in units of 1.024
 107  *   microseconds.  Receive interrupt reduction can improve CPU efficiency if
 108  *   properly tuned for specific network traffic. Increasing this value adds
 109  *   extra latency to frame reception and can end up decreasing the throughput
 110  *   of TCP traffic. If the system is reporting dropped receives, this value
 111  *   may be set too high, causing the driver to run out of available receive
 112  *   descriptors.
 113  *
 114  *   CAUTION: When setting EM_RDTR to a value other than 0, adapters
 115  *            may hang (stop transmitting) under certain network conditions.
 116  *            If this occurs a WATCHDOG message is logged in the system
 117  *            event log. In addition, the controller is automatically reset,
 118  *            restoring the network connection. To eliminate the potential
 119  *            for the hang ensure that EM_RDTR is set to 0.
 120  */
 121 #define EM_RDTR                         0
 122
 123 /*
 124  * Receive Interrupt Absolute Delay Timer (Not valid for 82542/82543/82544)
 125  * Valid Range: 0-65535 (0=off)
 126  * Default Value: 64
 127  *   This value, in units of 1.024 microseconds, limits the delay in which a
 128  *   receive interrupt is generated. Useful only if EM_RDTR is non-zero,
 129  *   this value ensures that an interrupt is generated after the initial
 130  *   packet is received within the set amount of time.  Proper tuning,
 131  *   along with EM_RDTR, may improve traffic throughput in specific network
 132  *   conditions.
 133  */
 134 #define EM_RADV                         64
 135
 136 /*
 137  * This parameter controls the max duration of transmit watchdog.
 138  */
 139 #define EM_WATCHDOG                   (10 * hz)
 140
 141 /*
 142  * This parameter controls when the driver calls the routine to reclaim
 143  * transmit descriptors.
 144  */
 145 #define EM_TX_CLEANUP_THRESHOLD (adapter->num_tx_desc / 8)
 146 #define EM_TX_OP_THRESHOLD      (adapter->num_tx_desc / 32)
 147
 148 /*
 149  * This parameter controls whether or not autonegotation is enabled.
 150  *              0 - Disable autonegotiation
 151  *              1 - Enable  autonegotiation
 152  */
 153 #define DO_AUTO_NEG                     1
 154
 155 /*
 156  * This parameter control whether or not the driver will wait for
 157  * autonegotiation to complete.
 158  *              1 - Wait for autonegotiation to complete
 159  *              0 - Don't wait for autonegotiation to complete
 160  */
 161 #define WAIT_FOR_AUTO_NEG_DEFAULT       0
 162
 163 /* Tunables -- End */
 164
 165 #define AUTONEG_ADV_DEFAULT     (ADVERTISE_10_HALF | ADVERTISE_10_FULL | \
 166                                 ADVERTISE_100_HALF | ADVERTISE_100_FULL | \
 167                                 ADVERTISE_1000_FULL)
 168
 169 #define AUTO_ALL_MODES          0
 170
 171 /* PHY master/slave setting */
 172 #define EM_MASTER_SLAVE         e1000_ms_hw_default
 173
 174 /*
 175  * Micellaneous constants
 176  */
 177 #define EM_VENDOR_ID                    0x8086
 178 #define EM_FLASH                        0x0014
 179
 180 #define EM_JUMBO_PBA                    0x00000028
 181 #define EM_DEFAULT_PBA                  0x00000030
 182 #define EM_SMARTSPEED_DOWNSHIFT         3
 183 #define EM_SMARTSPEED_MAX               15
 184 #define EM_MAX_INTR                     10
 185
 186 #define MAX_NUM_MULTICAST_ADDRESSES     128
 187 #define PCI_ANY_ID                      (~0U)
 188 #define ETHER_ALIGN                     2
 189 #define EM_FC_PAUSE_TIME                0x0680
 190 #define EM_EEPROM_APME                  0x400;
 191 #define EM_82544_APME                   0x0004;
 192
 193 /* Code compatilbility between 6 and 7 */
 194 #ifndef ETHER_BPF_MTAP
 195 #define ETHER_BPF_MTAP                  BPF_MTAP
 196 #endif
 197
 198 /*
 199  * TDBA/RDBA should be aligned on 16 byte boundary. But TDLEN/RDLEN should be
 200  * multiple of 128 bytes. So we align TDBA/RDBA on 128 byte boundary. This will
 201  * also optimize cache line size effect. H/W supports up to cache line size 128.
 202  */
 203 #define EM_DBA_ALIGN                    128
 204
 205 #define SPEED_MODE_BIT (1<<21)          /* On PCI-E MACs only */
 206
 207 /* PCI Config defines */
 208 #define EM_BAR_TYPE(v)          ((v) & EM_BAR_TYPE_MASK)
 209 #define EM_BAR_TYPE_MASK        0x00000001
 210 #define EM_BAR_TYPE_MMEM        0x00000000
 211 #define EM_BAR_TYPE_IO          0x00000001
 212 #define EM_BAR_TYPE_FLASH       0x0014
 213 #define EM_BAR_MEM_TYPE(v)      ((v) & EM_BAR_MEM_TYPE_MASK)
 214 #define EM_BAR_MEM_TYPE_MASK    0x00000006
 215 #define EM_BAR_MEM_TYPE_32BIT   0x00000000
 216 #define EM_BAR_MEM_TYPE_64BIT   0x00000004
 217 #define EM_MSIX_BAR             3       /* On 82575 */
 218
 219 /* Defines for printing debug information */
 220 #define DEBUG_INIT  0
 221 #define DEBUG_IOCTL 0
 222 #define DEBUG_HW    0
 223
 224 #define INIT_DEBUGOUT(S)            if (DEBUG_INIT)  kprintf(S "\n")
 225 #define INIT_DEBUGOUT1(S, A)        if (DEBUG_INIT)  kprintf(S "\n", A)
 226 #define INIT_DEBUGOUT2(S, A, B)     if (DEBUG_INIT)  kprintf(S "\n", A, B)
 227 #define IOCTL_DEBUGOUT(S)           if (DEBUG_IOCTL) kprintf(S "\n")
 228 #define IOCTL_DEBUGOUT1(S, A)       if (DEBUG_IOCTL) kprintf(S "\n", A)
 229 #define IOCTL_DEBUGOUT2(S, A, B)    if (DEBUG_IOCTL) kprintf(S "\n", A, B)
 230 #define HW_DEBUGOUT(S)              if (DEBUG_HW) kprintf(S "\n")
 231 #define HW_DEBUGOUT1(S, A)          if (DEBUG_HW) kprintf(S "\n", A)
 232 #define HW_DEBUGOUT2(S, A, B)       if (DEBUG_HW) kprintf(S "\n", A, B)
 233
 234 #define EM_MAX_SCATTER          64
 235 #define EM_VFTA_SIZE            128
 236 #define EM_TSO_SIZE             (65535 + sizeof(struct ether_vlan_header))
 237 #define EM_TSO_SEG_SIZE         4096    /* Max dma segment size */
 238 #define EM_MSIX_MASK            0x01F00000 /* For 82574 use */
 239 #define ETH_ZLEN                60
 240 #define ETH_ADDR_LEN            6
 241 #define CSUM_OFFLOAD            7       /* Offload bits in mbuf flag */
 242
 243 /*
 244  * 82574 has a nonstandard address for EIAC
 245  * and since its only used in MSIX, and in
 246  * the em driver only 82574 uses MSIX we can
 247  * solve it just using this define.
 248  */
 249 #define EM_EIAC 0x000DC
 250
 251 /* Used in for 82547 10Mb Half workaround */
 252 #define EM_PBA_BYTES_SHIFT      0xA
 253 #define EM_TX_HEAD_ADDR_SHIFT   7
 254 #define EM_PBA_TX_MASK          0xFFFF0000
 255 #define EM_FIFO_HDR             0x10
 256 #define EM_82547_PKT_THRESH     0x3e0
 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 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 /* Our adapter structure */
 285 struct adapter {
 286         struct arpcom           arpcom;
 287
 288         struct ifnet    *ifp;
 289 #if __FreeBSD_version >= 800000
 290         struct buf_ring *br;
 291 #endif
 292         struct e1000_hw hw;
 293
 294         /* FreeBSD operating-system-specific structures. */
 295         struct e1000_osdep osdep;
 296         struct device   *dev;
 297
 298         struct resource *memory;
 299         struct resource *flash;
 300         struct resource *msix;
 301
 302         struct resource *ioport;
 303         int             io_rid;
 304
 305         /* 82574 may use 3 int vectors */
 306         struct resource *res[3];
 307         void            *tag[3];
 308         int             rid[3];
 309
 310         struct ifmedia  media;
 311         struct callout  timer;
 312         struct callout  tx_fifo_timer;
 313         bool            watchdog_check;
 314         int             watchdog_time;
 315         int             msi;
 316         int             if_flags;
 317         int             max_frame_size;
 318         int             min_frame_size;
 319         struct lock     core_spin;
 320         struct lock     tx_spin;
 321         struct lock     rx_spin;
 322         int             em_insert_vlan_header;
 323
 324         /* Task for FAST handling */
 325         struct task     link_task;
 326         struct task     rxtx_task;
 327         struct task     rx_task;
 328         struct task     tx_task;
 329         struct taskqueue *tq;           /* private task queue */
 330
 331         eventhandler_tag vlan_attach;
 332         eventhandler_tag vlan_detach;
 333         u32     num_vlans;
 334
 335         /* Management and WOL features */
 336         u32             wol;
 337         bool            has_manage;
 338         bool            has_amt;
 339
 340         /* Info about the board itself */
 341         uint8_t         link_active;
 342         uint16_t        link_speed;
 343         uint16_t        link_duplex;
 344         uint32_t        smartspeed;
 345         struct em_int_delay_info tx_int_delay;
 346         struct em_int_delay_info tx_abs_int_delay;
 347         struct em_int_delay_info rx_int_delay;
 348         struct em_int_delay_info rx_abs_int_delay;
 349
 350         /*
 351          * Transmit definitions
 352          *
 353          * We have an array of num_tx_desc descriptors (handled
 354          * by the controller) paired with an array of tx_buffers
 355          * (at tx_buffer_area).
 356          * The index of the next available descriptor is next_avail_tx_desc.
 357          * The number of remaining tx_desc is num_tx_desc_avail.
 358          */
 359         struct em_dma_alloc     txdma;          /* bus_dma glue for tx desc */
 360         struct e1000_tx_desc    *tx_desc_base;
 361         uint32_t                next_avail_tx_desc;
 362         uint32_t                next_tx_to_clean;
 363         volatile uint16_t       num_tx_desc_avail;
 364         uint16_t                num_tx_desc;
 365         uint16_t                last_hw_offload;
 366         uint32_t                txd_cmd;
 367         struct em_buffer        *tx_buffer_area;
 368         bus_dma_tag_t           txtag;          /* dma tag for tx */
 369         uint32_t                tx_tso;         /* last tx was tso */
 370
 371         /*
 372          * Receive definitions
 373          *
 374          * we have an array of num_rx_desc rx_desc (handled by the
 375          * controller), and paired with an array of rx_buffers
 376          * (at rx_buffer_area).
 377          * The next pair to check on receive is at offset next_rx_desc_to_check
 378          */
 379         struct em_dma_alloc     rxdma;          /* bus_dma glue for rx desc */
 380         struct e1000_rx_desc    *rx_desc_base;
 381         uint32_t                next_rx_desc_to_check;
 382         uint32_t                rx_buffer_len;
 383         uint16_t                num_rx_desc;
 384         int                     rx_process_limit;
 385         struct em_buffer        *rx_buffer_area;
 386         bus_dma_tag_t           rxtag;
 387         bus_dmamap_t            rx_sparemap;
 388
 389         /*
 390          * First/last mbuf pointers, for
 391          * collecting multisegment RX packets.
 392          */
 393         struct mbuf            *fmp;
 394         struct mbuf            *lmp;
 395
 396         /* Misc stats maintained by the driver */
 397         unsigned long   dropped_pkts;
 398         unsigned long   mbuf_alloc_failed;
 399         unsigned long   mbuf_cluster_failed;
 400         unsigned long   no_tx_desc_avail1;
 401         unsigned long   no_tx_desc_avail2;
 402         unsigned long   no_tx_map_avail;
 403         unsigned long   no_tx_dma_setup;
 404         unsigned long   watchdog_events;
 405         unsigned long   rx_overruns;
 406         unsigned long   rx_irq;
 407         unsigned long   tx_irq;
 408         unsigned long   link_irq;
 409
 410         /* 82547 workaround */
 411         uint32_t        tx_fifo_size;
 412         uint32_t        tx_fifo_head;
 413         uint32_t        tx_fifo_head_addr;
 414         uint64_t        tx_fifo_reset_cnt;
 415         uint64_t        tx_fifo_wrk_cnt;
 416         uint32_t        tx_head_addr;
 417
 418         /* For 82544 PCIX Workaround */
 419         boolean_t       pcix_82544;
 420         boolean_t       in_detach;
 421
 422 #ifdef EM_IEEE1588
 423         /* IEEE 1588 precision time support */
 424         struct cyclecounter     cycles;
 425         struct nettimer         clock;
 426         struct nettime_compare  compare;
 427         struct hwtstamp_ctrl    hwtstamp;
 428 #endif
 429
 430         /* sysctl tree glue */
 431         struct sysctl_ctx_list  sysctl_ctx;
 432         struct sysctl_oid       *sysctl_tree;
 433
 434         struct e1000_hw_stats stats;
 435 };
 436
 437 /* ******************************************************************************
 438  * vendor_info_array
 439  *
 440  * This array contains the list of Subvendor/Subdevice IDs on which the driver
 441  * should load.
 442  *
 443  * ******************************************************************************/
 444 typedef struct _em_vendor_info_t {
 445         unsigned int vendor_id;
 446         unsigned int device_id;
 447         unsigned int subvendor_id;
 448         unsigned int subdevice_id;
 449         unsigned int index;
 450 } em_vendor_info_t;
 451
 452 struct em_buffer {
 453         int             next_eop;  /* Index of the desc to watch */
 454         struct mbuf    *m_head;
 455         bus_dmamap_t    map;         /* bus_dma map for packet */
 456 };
 457
 458 /* For 82544 PCIX  Workaround */
 459 typedef struct _ADDRESS_LENGTH_PAIR
 460 {
 461         uint64_t   address;
 462         uint32_t   length;
 463 } ADDRESS_LENGTH_PAIR, *PADDRESS_LENGTH_PAIR;
 464
 465 typedef struct _DESCRIPTOR_PAIR
 466 {
 467         ADDRESS_LENGTH_PAIR descriptor[4];
 468         uint32_t   elements;
 469 } DESC_ARRAY, *PDESC_ARRAY;
 470
 471 #define EM_CORE_LOCK_INIT(_sc, _name) \
 472         lockinit(&(_sc)->core_spin, "emcore", 0, 0)
 473 #define EM_TX_LOCK_INIT(_sc, _name) \
 474         lockinit(&(_sc)->tx_spin, "emtx", 0, 0)
 475 #define EM_RX_LOCK_INIT(_sc, _name) \
 476         lockinit(&(_sc)->rx_spi, "emrx", 0, 0n)
 477 #define EM_CORE_LOCK_DESTROY(_sc)       lockuninit(&(_sc)->core_spin)
 478 #define EM_TX_LOCK_DESTROY(_sc)         lockuninit(&(_sc)->tx_spin)
 479 #define EM_RX_LOCK_DESTROY(_sc)         lockuninit(&(_sc)->rx_spin)
 480 #define EM_CORE_LOCK(_sc)               lockmgr(&(_sc)->core_spin, LK_EXCLUSIVE)
 481 #define EM_TX_LOCK(_sc)                 lockmgr(&(_sc)->tx_spin, LK_EXCLUSIVE)
 482 #define EM_TX_TRYLOCK(_sc)              (lockmgr(&(_sc)->tx_spin, LK_EXCLUSIVE | LK_NOWAIT) == 0)
 483 #define EM_RX_LOCK(_sc)                 lockmgr(&(_sc)->rx_spin, LK_EXCLUSIVE)
 484 #define EM_CORE_UNLOCK(_sc)             lockmgr(&(_sc)->core_spin, LK_RELEASE)
 485 #define EM_TX_UNLOCK(_sc)               lockmgr(&(_sc)->tx_spin, LK_RELEASE)
 486 #define EM_RX_UNLOCK(_sc)               lockmgr(&(_sc)->rx_spin, LK_RELEASE)
 487 #define EM_CORE_LOCK_ASSERT(_sc)
 488 #define EM_TX_LOCK_ASSERT(_sc)
 489
 490 #endif /* _EM_H_DEFINED_ */