1 /******************************************************************************
3 Copyright (c) 2001-2013, Intel Corporation
6 Redistribution and use in source and binary forms, with or without
7 modification, are permitted provided that the following conditions are met:
9 1. Redistributions of source code must retain the above copyright notice,
10 this list of conditions and the following disclaimer.
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.
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.
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.
32 ******************************************************************************/
40 #include <sys/param.h>
41 #include <sys/systm.h>
42 #ifndef IXGBE_LEGACY_TX
43 #include <sys/buf_ring.h>
46 #include <sys/protosw.h>
47 #include <sys/socket.h>
48 #include <sys/malloc.h>
49 #include <sys/kernel.h>
50 #include <sys/module.h>
51 #include <sys/sockio.h>
52 #include <sys/eventhandler.h>
55 #include <net/if_var.h>
56 #include <net/if_arp.h>
58 #include <net/ethernet.h>
59 #include <net/if_dl.h>
60 #include <net/if_media.h>
63 #include <net/if_types.h>
64 #include <net/if_vlan_var.h>
66 #include <netinet/in_systm.h>
67 #include <netinet/in.h>
68 #include <netinet/if_ether.h>
69 #include <netinet/ip.h>
70 #include <netinet/ip6.h>
71 #include <netinet/tcp.h>
72 #include <netinet/tcp_lro.h>
73 #include <netinet/udp.h>
75 #include <machine/in_cksum.h>
78 #include <machine/bus.h>
80 #include <machine/resource.h>
83 #include <machine/clock.h>
84 #include <dev/pci/pcivar.h>
85 #include <dev/pci/pcireg.h>
87 #include <sys/sysctl.h>
88 #include <sys/endian.h>
89 #include <sys/taskqueue.h>
92 #include <machine/smp.h>
94 #include "ixgbe_api.h"
99 * TxDescriptors Valid Range: 64-4096 Default Value: 256 This value is the
100 * number of transmit descriptors allocated by the driver. Increasing this
101 * value allows the driver to queue more transmits. Each descriptor is 16
102 * bytes. Performance tests have show the 2K value to be optimal for top
105 #define DEFAULT_TXD 1024
106 #define PERFORM_TXD 2048
111 * RxDescriptors Valid Range: 64-4096 Default Value: 256 This value is the
112 * number of receive descriptors allocated for each RX queue. Increasing this
113 * value allows the driver to buffer more incoming packets. Each descriptor
114 * is 16 bytes. A receive buffer is also allocated for each descriptor.
116 * Note: with 8 rings and a dual port card, it is possible to bump up
117 * against the system mbuf pool limit, you can tune nmbclusters
118 * to adjust for this.
120 #define DEFAULT_RXD 1024
121 #define PERFORM_RXD 2048
125 /* Alignment for rings */
126 #define DBA_ALIGN 128
129 * This parameter controls the maximum no of times the driver will loop in
130 * the isr. Minimum Value = 1
135 * This is the max watchdog interval, ie. the time that can
136 * pass between any two TX clean operations, such only happening
137 * when the TX hardware is functioning.
139 #define IXGBE_WATCHDOG (10 * hz)
142 * This parameters control when the driver calls the routine to reclaim
143 * transmit descriptors.
145 #define IXGBE_TX_CLEANUP_THRESHOLD (adapter->num_tx_desc / 8)
146 #define IXGBE_TX_OP_THRESHOLD (adapter->num_tx_desc / 32)
148 #define IXGBE_MAX_FRAME_SIZE 0x3F00
150 /* Flow control constants */
151 #define IXGBE_FC_PAUSE 0xFFFF
152 #define IXGBE_FC_HI 0x20000
153 #define IXGBE_FC_LO 0x10000
156 * Used for optimizing small rx mbufs. Effort is made to keep the copy
157 * small and aligned for the CPU L1 cache.
159 * MHLEN is typically 168 bytes, giving us 8-byte alignment. Getting
160 * 32 byte alignment needed for the fast bcopy results in 8 bytes being
161 * wasted. Getting 64 byte alignment, which _should_ be ideal for
162 * modern Intel CPUs, results in 40 bytes wasted and a significant drop
163 * in observed efficiency of the optimization, 97.9% -> 81.8%.
165 #define IXGBE_RX_COPY_LEN 160
166 #define IXGBE_RX_COPY_ALIGN (MHLEN - IXGBE_RX_COPY_LEN)
168 /* Keep older OS drivers building... */
169 #if !defined(SYSCTL_ADD_UQUAD)
170 #define SYSCTL_ADD_UQUAD SYSCTL_ADD_QUAD
173 /* Defines for printing debug information */
175 #define DEBUG_IOCTL 0
178 #define INIT_DEBUGOUT(S) if (DEBUG_INIT) printf(S "\n")
179 #define INIT_DEBUGOUT1(S, A) if (DEBUG_INIT) printf(S "\n", A)
180 #define INIT_DEBUGOUT2(S, A, B) if (DEBUG_INIT) printf(S "\n", A, B)
181 #define IOCTL_DEBUGOUT(S) if (DEBUG_IOCTL) printf(S "\n")
182 #define IOCTL_DEBUGOUT1(S, A) if (DEBUG_IOCTL) printf(S "\n", A)
183 #define IOCTL_DEBUGOUT2(S, A, B) if (DEBUG_IOCTL) printf(S "\n", A, B)
184 #define HW_DEBUGOUT(S) if (DEBUG_HW) printf(S "\n")
185 #define HW_DEBUGOUT1(S, A) if (DEBUG_HW) printf(S "\n", A)
186 #define HW_DEBUGOUT2(S, A, B) if (DEBUG_HW) printf(S "\n", A, B)
188 #define MAX_NUM_MULTICAST_ADDRESSES 128
189 #define IXGBE_82598_SCATTER 100
190 #define IXGBE_82599_SCATTER 32
191 #define MSIX_82598_BAR 3
192 #define MSIX_82599_BAR 4
193 #define IXGBE_TSO_SIZE 262140
194 #define IXGBE_TX_BUFFER_SIZE ((u32) 1514)
195 #define IXGBE_RX_HDR 128
196 #define IXGBE_VFTA_SIZE 128
197 #define IXGBE_BR_SIZE 4096
198 #define IXGBE_QUEUE_MIN_FREE 32
200 /* Offload bits in mbuf flag */
201 #if __FreeBSD_version >= 800000
202 #define CSUM_OFFLOAD (CSUM_IP|CSUM_TCP|CSUM_UDP|CSUM_SCTP)
204 #define CSUM_OFFLOAD (CSUM_IP|CSUM_TCP|CSUM_UDP)
208 * Interrupt Moderation parameters
210 #define IXGBE_LOW_LATENCY 128
211 #define IXGBE_AVE_LATENCY 400
212 #define IXGBE_BULK_LATENCY 1200
213 #define IXGBE_LINK_ITR 2000
217 *****************************************************************************
220 * This array contains the list of Subvendor/Subdevice IDs on which the driver
223 *****************************************************************************
225 typedef struct _ixgbe_vendor_info_t {
226 unsigned int vendor_id;
227 unsigned int device_id;
228 unsigned int subvendor_id;
229 unsigned int subdevice_id;
231 } ixgbe_vendor_info_t;
233 struct ixgbe_tx_buf {
234 union ixgbe_adv_tx_desc *eop;
239 struct ixgbe_rx_buf {
244 #define IXGBE_RX_COPY 0x01
249 * Bus dma allocation structure used by ixgbe_dma_malloc and ixgbe_dma_free.
251 struct ixgbe_dma_alloc {
252 bus_addr_t dma_paddr;
254 bus_dma_tag_t dma_tag;
255 bus_dmamap_t dma_map;
256 bus_dma_segment_t dma_seg;
262 ** Driver queue struct: this is the interrupt container
263 ** for the associated tx and rx ring.
266 struct adapter *adapter;
267 u32 msix; /* This queue's MSIX vector */
268 u32 eims; /* This queue's EIMS bit */
270 struct resource *res;
274 struct task que_task;
275 struct taskqueue *tq;
280 * The transmit ring, one per queue
283 struct adapter *adapter;
287 union ixgbe_adv_tx_desc *tx_base;
288 struct ixgbe_tx_buf *tx_buffers;
289 struct ixgbe_dma_alloc txdma;
290 volatile u16 tx_avail;
303 #ifndef IXGBE_LEGACY_TX
305 struct task txq_task;
311 u32 bytes; /* used for AIM */
314 unsigned long tso_tx;
315 unsigned long no_tx_map_avail;
316 unsigned long no_tx_dma_setup;
323 * The Receive ring, one per rx queue
326 struct adapter *adapter;
329 union ixgbe_adv_rx_desc *rx_base;
330 struct ixgbe_dma_alloc rxdma;
341 struct ixgbe_rx_buf *rx_buffers;
344 u32 bytes; /* Used for AIM calc */
359 /* Our adapter structure */
364 struct ixgbe_osdep osdep;
367 struct resource *pci_mem;
368 struct resource *msix_mem;
371 * Interrupt resources: this set is
372 * either used for legacy, or for Link
376 struct resource *res;
378 struct ifmedia media;
379 struct callout timer;
385 eventhandler_tag vlan_attach;
386 eventhandler_tag vlan_detach;
392 ** Shadow VFTA table, this is needed because
393 ** the real vlan filter table gets cleared during
394 ** a soft reset and the driver needs to be able
397 u32 shadow_vfta[IXGBE_VFTA_SIZE];
399 /* Info about the interface */
401 u32 fc; /* local flow ctrl setting */
402 int advertise; /* link speeds */
410 /* Mbuf cluster size */
413 /* Support for pluggable optics */
415 struct task link_task; /* Link tasklet */
416 struct task mod_task; /* SFP tasklet */
417 struct task msf_task; /* Multispeed Fiber */
420 struct task fdir_task;
422 struct taskqueue *tq;
426 ** This is the irq holder, it has
427 ** and RX/TX pair or rings associated
430 struct ix_queue *queues;
434 * Allocated at run time, an array of rings.
436 struct tx_ring *tx_rings;
441 * Allocated at run time, an array of rings.
443 struct rx_ring *rx_rings;
447 /* Multicast array memory */
451 /* Misc stats maintained by the driver */
452 unsigned long dropped_pkts;
453 unsigned long mbuf_defrag_failed;
454 unsigned long mbuf_header_failed;
455 unsigned long mbuf_packet_failed;
456 unsigned long watchdog_events;
457 unsigned long link_irq;
459 struct ixgbe_hw_stats stats;
463 /* Precision Time Sync (IEEE 1588) defines */
464 #define ETHERTYPE_IEEE1588 0x88F7
465 #define PICOSECS_PER_TICK 20833
466 #define TSYNC_UDP_PORT 319 /* UDP port for the protocol */
467 #define IXGBE_ADVTXD_TSTAMP 0x00080000
470 #define IXGBE_CORE_LOCK_INIT(_sc, _name) \
471 mtx_init(&(_sc)->core_mtx, _name, "IXGBE Core Lock", MTX_DEF)
472 #define IXGBE_CORE_LOCK_DESTROY(_sc) mtx_destroy(&(_sc)->core_mtx)
473 #define IXGBE_TX_LOCK_DESTROY(_sc) mtx_destroy(&(_sc)->tx_mtx)
474 #define IXGBE_RX_LOCK_DESTROY(_sc) mtx_destroy(&(_sc)->rx_mtx)
475 #define IXGBE_CORE_LOCK(_sc) mtx_lock(&(_sc)->core_mtx)
476 #define IXGBE_TX_LOCK(_sc) mtx_lock(&(_sc)->tx_mtx)
477 #define IXGBE_TX_TRYLOCK(_sc) mtx_trylock(&(_sc)->tx_mtx)
478 #define IXGBE_RX_LOCK(_sc) mtx_lock(&(_sc)->rx_mtx)
479 #define IXGBE_CORE_UNLOCK(_sc) mtx_unlock(&(_sc)->core_mtx)
480 #define IXGBE_TX_UNLOCK(_sc) mtx_unlock(&(_sc)->tx_mtx)
481 #define IXGBE_RX_UNLOCK(_sc) mtx_unlock(&(_sc)->rx_mtx)
482 #define IXGBE_CORE_LOCK_ASSERT(_sc) mtx_assert(&(_sc)->core_mtx, MA_OWNED)
483 #define IXGBE_TX_LOCK_ASSERT(_sc) mtx_assert(&(_sc)->tx_mtx, MA_OWNED)
485 /* For backward compatibility */
486 #if !defined(PCIER_LINK_STA)
487 #define PCIER_LINK_STA PCIR_EXPRESS_LINK_STA
491 ixgbe_is_sfp(struct ixgbe_hw *hw)
493 switch (hw->phy.type) {
494 case ixgbe_phy_sfp_avago:
495 case ixgbe_phy_sfp_ftl:
496 case ixgbe_phy_sfp_intel:
497 case ixgbe_phy_sfp_unknown:
498 case ixgbe_phy_sfp_passive_tyco:
499 case ixgbe_phy_sfp_passive_unknown:
506 /* Workaround to make 8.0 buildable */
507 #if __FreeBSD_version >= 800000 && __FreeBSD_version < 800504
509 drbr_needs_enqueue(struct ifnet *ifp, struct buf_ring *br)
512 if (ALTQ_IS_ENABLED(&ifp->if_snd))
515 return (!buf_ring_empty(br));
520 ** Find the number of unrefreshed RX descriptors
523 ixgbe_rx_unrefreshed(struct rx_ring *rxr)
525 if (rxr->next_to_check > rxr->next_to_refresh)
526 return (rxr->next_to_check - rxr->next_to_refresh - 1);
528 return ((rxr->num_desc + rxr->next_to_check) -
529 rxr->next_to_refresh - 1);
532 #endif /* _IXGBE_H_ */