1 /******************************************************************************
3 Copyright (c) 2001-2012, 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>
54 #include <net/if_arp.h>
56 #include <net/ethernet.h>
57 #include <net/if_dl.h>
58 #include <net/if_media.h>
61 #include <net/if_types.h>
62 #include <net/if_vlan_var.h>
64 #include <netinet/in_systm.h>
65 #include <netinet/in.h>
66 #include <netinet/if_ether.h>
67 #include <netinet/ip.h>
68 #include <netinet/ip6.h>
69 #include <netinet/tcp.h>
70 #include <netinet/tcp_lro.h>
71 #include <netinet/udp.h>
73 #include <machine/in_cksum.h>
76 #include <machine/bus.h>
78 #include <machine/resource.h>
81 #include <machine/clock.h>
82 #include <dev/pci/pcivar.h>
83 #include <dev/pci/pcireg.h>
85 #include <sys/sysctl.h>
86 #include <sys/endian.h>
87 #include <sys/taskqueue.h>
90 #include <machine/smp.h>
92 #include "ixgbe_api.h"
97 * TxDescriptors Valid Range: 64-4096 Default Value: 256 This value is the
98 * number of transmit descriptors allocated by the driver. Increasing this
99 * value allows the driver to queue more transmits. Each descriptor is 16
100 * bytes. Performance tests have show the 2K value to be optimal for top
103 #define DEFAULT_TXD 1024
104 #define PERFORM_TXD 2048
109 * RxDescriptors Valid Range: 64-4096 Default Value: 256 This value is the
110 * number of receive descriptors allocated for each RX queue. Increasing this
111 * value allows the driver to buffer more incoming packets. Each descriptor
112 * is 16 bytes. A receive buffer is also allocated for each descriptor.
114 * Note: with 8 rings and a dual port card, it is possible to bump up
115 * against the system mbuf pool limit, you can tune nmbclusters
116 * to adjust for this.
118 #define DEFAULT_RXD 1024
119 #define PERFORM_RXD 2048
123 /* Alignment for rings */
124 #define DBA_ALIGN 128
127 * This parameter controls the maximum no of times the driver will loop in
128 * the isr. Minimum Value = 1
133 * This is the max watchdog interval, ie. the time that can
134 * pass between any two TX clean operations, such only happening
135 * when the TX hardware is functioning.
137 #define IXGBE_WATCHDOG (10 * hz)
140 * This parameters control when the driver calls the routine to reclaim
141 * transmit descriptors.
143 #define IXGBE_TX_CLEANUP_THRESHOLD (adapter->num_tx_desc / 8)
144 #define IXGBE_TX_OP_THRESHOLD (adapter->num_tx_desc / 32)
146 #define IXGBE_MAX_FRAME_SIZE 0x3F00
148 /* Flow control constants */
149 #define IXGBE_FC_PAUSE 0xFFFF
150 #define IXGBE_FC_HI 0x20000
151 #define IXGBE_FC_LO 0x10000
154 * Used for optimizing small rx mbufs. Effort is made to keep the copy
155 * small and aligned for the CPU L1 cache.
157 * MHLEN is typically 168 bytes, giving us 8-byte alignment. Getting
158 * 32 byte alignment needed for the fast bcopy results in 8 bytes being
159 * wasted. Getting 64 byte alignment, which _should_ be ideal for
160 * modern Intel CPUs, results in 40 bytes wasted and a significant drop
161 * in observed efficiency of the optimization, 97.9% -> 81.8%.
163 #define IXGBE_RX_COPY_LEN 160
164 #define IXGBE_RX_COPY_ALIGN (MHLEN - IXGBE_RX_COPY_LEN)
166 /* Keep older OS drivers building... */
167 #if !defined(SYSCTL_ADD_UQUAD)
168 #define SYSCTL_ADD_UQUAD SYSCTL_ADD_QUAD
171 /* Defines for printing debug information */
173 #define DEBUG_IOCTL 0
176 #define INIT_DEBUGOUT(S) if (DEBUG_INIT) printf(S "\n")
177 #define INIT_DEBUGOUT1(S, A) if (DEBUG_INIT) printf(S "\n", A)
178 #define INIT_DEBUGOUT2(S, A, B) if (DEBUG_INIT) printf(S "\n", A, B)
179 #define IOCTL_DEBUGOUT(S) if (DEBUG_IOCTL) printf(S "\n")
180 #define IOCTL_DEBUGOUT1(S, A) if (DEBUG_IOCTL) printf(S "\n", A)
181 #define IOCTL_DEBUGOUT2(S, A, B) if (DEBUG_IOCTL) printf(S "\n", A, B)
182 #define HW_DEBUGOUT(S) if (DEBUG_HW) printf(S "\n")
183 #define HW_DEBUGOUT1(S, A) if (DEBUG_HW) printf(S "\n", A)
184 #define HW_DEBUGOUT2(S, A, B) if (DEBUG_HW) printf(S "\n", A, B)
186 #define MAX_NUM_MULTICAST_ADDRESSES 128
187 #define IXGBE_82598_SCATTER 100
188 #define IXGBE_82599_SCATTER 32
189 #define MSIX_82598_BAR 3
190 #define MSIX_82599_BAR 4
191 #define IXGBE_TSO_SIZE 262140
192 #define IXGBE_TX_BUFFER_SIZE ((u32) 1514)
193 #define IXGBE_RX_HDR 128
194 #define IXGBE_VFTA_SIZE 128
195 #define IXGBE_BR_SIZE 4096
196 #define IXGBE_QUEUE_MIN_FREE 32
198 /* IOCTL define to gather SFP+ Diagnostic data */
199 #define SIOCGI2C SIOCGIFGENERIC
201 /* Offload bits in mbuf flag */
202 #if __FreeBSD_version >= 800000
203 #define CSUM_OFFLOAD (CSUM_IP|CSUM_TCP|CSUM_UDP|CSUM_SCTP)
205 #define CSUM_OFFLOAD (CSUM_IP|CSUM_TCP|CSUM_UDP)
209 * Interrupt Moderation parameters
211 #define IXGBE_LOW_LATENCY 128
212 #define IXGBE_AVE_LATENCY 400
213 #define IXGBE_BULK_LATENCY 1200
214 #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 /* This is used to get SFP+ module data */
234 struct ixgbe_i2c_req {
241 struct ixgbe_tx_buf {
247 struct ixgbe_rx_buf {
252 #define IXGBE_RX_COPY 0x01
257 * Bus dma allocation structure used by ixgbe_dma_malloc and ixgbe_dma_free.
259 struct ixgbe_dma_alloc {
260 bus_addr_t dma_paddr;
262 bus_dma_tag_t dma_tag;
263 bus_dmamap_t dma_map;
264 bus_dma_segment_t dma_seg;
270 ** Driver queue struct: this is the interrupt container
271 ** for the associated tx and rx ring.
274 struct adapter *adapter;
275 u32 msix; /* This queue's MSIX vector */
276 u32 eims; /* This queue's EIMS bit */
278 struct resource *res;
282 struct task que_task;
283 struct taskqueue *tq;
288 * The transmit ring, one per queue
291 struct adapter *adapter;
301 union ixgbe_adv_tx_desc *tx_base;
302 struct ixgbe_dma_alloc txdma;
305 struct ixgbe_tx_buf *tx_buffers;
306 volatile u16 tx_avail;
310 #ifndef IXGBE_LEGACY_TX
312 struct task txq_task;
318 u32 bytes; /* used for AIM */
327 * The Receive ring, one per rx queue
330 struct adapter *adapter;
333 union ixgbe_adv_rx_desc *rx_base;
334 struct ixgbe_dma_alloc rxdma;
344 struct ixgbe_rx_buf *rx_buffers;
347 u32 bytes; /* Used for AIM calc */
362 /* Our adapter structure */
367 struct ixgbe_osdep osdep;
370 struct resource *pci_mem;
371 struct resource *msix_mem;
374 * Interrupt resources: this set is
375 * either used for legacy, or for Link
379 struct resource *res;
381 struct ifmedia media;
382 struct callout timer;
388 eventhandler_tag vlan_attach;
389 eventhandler_tag vlan_detach;
395 ** Shadow VFTA table, this is needed because
396 ** the real vlan filter table gets cleared during
397 ** a soft reset and the driver needs to be able
400 u32 shadow_vfta[IXGBE_VFTA_SIZE];
402 /* Info about the interface */
404 u32 fc; /* local flow ctrl setting */
405 int advertise; /* link speeds */
413 /* Mbuf cluster size */
416 /* Support for pluggable optics */
418 struct task link_task; /* Link tasklet */
419 struct task mod_task; /* SFP tasklet */
420 struct task msf_task; /* Multispeed Fiber */
423 struct task fdir_task;
425 struct taskqueue *tq;
429 ** This is the irq holder, it has
430 ** and RX/TX pair or rings associated
433 struct ix_queue *queues;
437 * Allocated at run time, an array of rings.
439 struct tx_ring *tx_rings;
444 * Allocated at run time, an array of rings.
446 struct rx_ring *rx_rings;
450 /* Multicast array memory */
453 /* Misc stats maintained by the driver */
454 unsigned long dropped_pkts;
455 unsigned long mbuf_defrag_failed;
456 unsigned long mbuf_header_failed;
457 unsigned long mbuf_packet_failed;
458 unsigned long no_tx_map_avail;
459 unsigned long no_tx_dma_setup;
460 unsigned long watchdog_events;
461 unsigned long tso_tx;
462 unsigned long link_irq;
464 struct ixgbe_hw_stats stats;
467 /* Precision Time Sync (IEEE 1588) defines */
468 #define ETHERTYPE_IEEE1588 0x88F7
469 #define PICOSECS_PER_TICK 20833
470 #define TSYNC_UDP_PORT 319 /* UDP port for the protocol */
471 #define IXGBE_ADVTXD_TSTAMP 0x00080000
474 #define IXGBE_CORE_LOCK_INIT(_sc, _name) \
475 mtx_init(&(_sc)->core_mtx, _name, "IXGBE Core Lock", MTX_DEF)
476 #define IXGBE_CORE_LOCK_DESTROY(_sc) mtx_destroy(&(_sc)->core_mtx)
477 #define IXGBE_TX_LOCK_DESTROY(_sc) mtx_destroy(&(_sc)->tx_mtx)
478 #define IXGBE_RX_LOCK_DESTROY(_sc) mtx_destroy(&(_sc)->rx_mtx)
479 #define IXGBE_CORE_LOCK(_sc) mtx_lock(&(_sc)->core_mtx)
480 #define IXGBE_TX_LOCK(_sc) mtx_lock(&(_sc)->tx_mtx)
481 #define IXGBE_TX_TRYLOCK(_sc) mtx_trylock(&(_sc)->tx_mtx)
482 #define IXGBE_RX_LOCK(_sc) mtx_lock(&(_sc)->rx_mtx)
483 #define IXGBE_CORE_UNLOCK(_sc) mtx_unlock(&(_sc)->core_mtx)
484 #define IXGBE_TX_UNLOCK(_sc) mtx_unlock(&(_sc)->tx_mtx)
485 #define IXGBE_RX_UNLOCK(_sc) mtx_unlock(&(_sc)->rx_mtx)
486 #define IXGBE_CORE_LOCK_ASSERT(_sc) mtx_assert(&(_sc)->core_mtx, MA_OWNED)
487 #define IXGBE_TX_LOCK_ASSERT(_sc) mtx_assert(&(_sc)->tx_mtx, MA_OWNED)
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 struct adapter *adapter = rxr->adapter;
527 if (rxr->next_to_check > rxr->next_to_refresh)
528 return (rxr->next_to_check - rxr->next_to_refresh - 1);
530 return ((adapter->num_rx_desc + rxr->next_to_check) -
531 rxr->next_to_refresh - 1);
534 #endif /* _IXGBE_H_ */