1 /******************************************************************************
3 Copyright (c) 2001-2017, 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 #include <sys/buf_ring.h>
44 #include <sys/protosw.h>
45 #include <sys/socket.h>
46 #include <sys/malloc.h>
47 #include <sys/kernel.h>
48 #include <sys/module.h>
49 #include <sys/sockio.h>
50 #include <sys/eventhandler.h>
53 #include <net/if_var.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>
93 #include "ixv_features.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 is the max watchdog interval, ie. the time that can
130 * pass between any two TX clean operations, such only happening
131 * when the TX hardware is functioning.
133 #define IXGBE_WATCHDOG (10 * hz)
136 * This parameters control when the driver calls the routine to reclaim
137 * transmit descriptors.
139 #define IXGBE_TX_CLEANUP_THRESHOLD(_a) ((_a)->num_tx_desc / 8)
140 #define IXGBE_TX_OP_THRESHOLD(_a) ((_a)->num_tx_desc / 32)
142 /* These defines are used in MTU calculations */
143 #define IXGBE_MAX_FRAME_SIZE 9728
144 #define IXGBE_MTU_HDR (ETHER_HDR_LEN + ETHER_CRC_LEN)
145 #define IXGBE_MTU_HDR_VLAN (ETHER_HDR_LEN + ETHER_CRC_LEN + \
146 ETHER_VLAN_ENCAP_LEN)
147 #define IXGBE_MAX_MTU (IXGBE_MAX_FRAME_SIZE - IXGBE_MTU_HDR)
148 #define IXGBE_MAX_MTU_VLAN (IXGBE_MAX_FRAME_SIZE - IXGBE_MTU_HDR_VLAN)
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 #if __FreeBSD_version < 1002000
166 #define MPKTHSIZE (sizeof(struct m_hdr) + sizeof(struct pkthdr))
168 #define IXGBE_RX_COPY_HDR_PADDED ((((MPKTHSIZE - 1) / 32) + 1) * 32)
169 #define IXGBE_RX_COPY_LEN (MSIZE - IXGBE_RX_COPY_HDR_PADDED)
170 #define IXGBE_RX_COPY_ALIGN (IXGBE_RX_COPY_HDR_PADDED - MPKTHSIZE)
172 /* Keep older OS drivers building... */
173 #if !defined(SYSCTL_ADD_UQUAD)
174 #define SYSCTL_ADD_UQUAD SYSCTL_ADD_QUAD
177 /* Defines for printing debug information */
179 #define DEBUG_IOCTL 0
182 #define INIT_DEBUGOUT(S) if (DEBUG_INIT) printf(S "\n")
183 #define INIT_DEBUGOUT1(S, A) if (DEBUG_INIT) printf(S "\n", A)
184 #define INIT_DEBUGOUT2(S, A, B) if (DEBUG_INIT) printf(S "\n", A, B)
185 #define IOCTL_DEBUGOUT(S) if (DEBUG_IOCTL) printf(S "\n")
186 #define IOCTL_DEBUGOUT1(S, A) if (DEBUG_IOCTL) printf(S "\n", A)
187 #define IOCTL_DEBUGOUT2(S, A, B) if (DEBUG_IOCTL) printf(S "\n", A, B)
188 #define HW_DEBUGOUT(S) if (DEBUG_HW) printf(S "\n")
189 #define HW_DEBUGOUT1(S, A) if (DEBUG_HW) printf(S "\n", A)
190 #define HW_DEBUGOUT2(S, A, B) if (DEBUG_HW) printf(S "\n", A, B)
192 #define MAX_NUM_MULTICAST_ADDRESSES 128
193 #define IXGBE_82598_SCATTER 100
194 #define IXGBE_82599_SCATTER 32
195 #define MSIX_82598_BAR 3
196 #define MSIX_82599_BAR 4
197 #define IXGBE_TSO_SIZE 262140
198 #define IXGBE_RX_HDR 128
199 #define IXGBE_VFTA_SIZE 128
200 #define IXGBE_BR_SIZE 4096
201 #define IXGBE_QUEUE_MIN_FREE 32
202 #define IXGBE_MAX_TX_BUSY 10
203 #define IXGBE_QUEUE_HUNG 0x80000000
205 #define IXGBE_EITR_DEFAULT 128
207 /* Supported offload bits in mbuf flag */
208 #if __FreeBSD_version >= 1000000
209 #define CSUM_OFFLOAD (CSUM_IP_TSO|CSUM_IP6_TSO|CSUM_IP| \
210 CSUM_IP_UDP|CSUM_IP_TCP|CSUM_IP_SCTP| \
211 CSUM_IP6_UDP|CSUM_IP6_TCP|CSUM_IP6_SCTP)
212 #elif __FreeBSD_version >= 800000
213 #define CSUM_OFFLOAD (CSUM_IP|CSUM_TCP|CSUM_UDP|CSUM_SCTP)
215 #define CSUM_OFFLOAD (CSUM_IP|CSUM_TCP|CSUM_UDP)
218 /* Backward compatibility items for very old versions */
220 #define pci_find_cap pci_find_extcap
223 #ifndef DEVMETHOD_END
224 #define DEVMETHOD_END { NULL, NULL }
228 * Interrupt Moderation parameters
230 #define IXGBE_LOW_LATENCY 128
231 #define IXGBE_AVE_LATENCY 400
232 #define IXGBE_BULK_LATENCY 1200
234 /* Using 1FF (the max value), the interval is ~1.05ms */
235 #define IXGBE_LINK_ITR_QUANTA 0x1FF
236 #define IXGBE_LINK_ITR ((IXGBE_LINK_ITR_QUANTA << 3) & \
237 IXGBE_EITR_ITR_INT_MASK)
239 /* MAC type macros */
240 #define IXGBE_IS_X550VF(_adapter) \
241 ((_adapter->hw.mac.type == ixgbe_mac_X550_vf) || \
242 (_adapter->hw.mac.type == ixgbe_mac_X550EM_x_vf) || \
243 (_adapter->hw.mac.type == ixgbe_mac_X550EM_a_vf))
245 #define IXGBE_IS_VF(_x) 1
248 /************************************************************************
251 * This array contains the list of Subvendor/Subdevice IDs on
252 * which the driver should load.
253 ************************************************************************/
254 typedef struct _ixgbe_vendor_info_t {
255 unsigned int vendor_id;
256 unsigned int device_id;
257 unsigned int subvendor_id;
258 unsigned int subdevice_id;
260 } ixgbe_vendor_info_t;
262 struct ixgbe_bp_data {
268 struct ixgbe_tx_buf {
269 union ixgbe_adv_tx_desc *eop;
274 struct ixgbe_rx_buf {
279 #define IXGBE_RX_COPY 0x01
284 * Bus dma allocation structure used by ixgbe_dma_malloc and ixgbe_dma_free
286 struct ixgbe_dma_alloc {
287 bus_addr_t dma_paddr;
289 bus_dma_tag_t dma_tag;
290 bus_dmamap_t dma_map;
291 bus_dma_segment_t dma_seg;
296 struct ixgbe_mc_addr {
297 u8 addr[IXGBE_ETH_LENGTH_OF_ADDRESS];
302 * Driver queue struct: this is the interrupt container
303 * for the associated tx and rx ring.
306 struct adapter *adapter;
307 u32 msix; /* This queue's MSI-X vector */
308 u32 eims; /* This queue's EIMS bit */
311 struct resource *res;
316 struct task que_task;
317 struct taskqueue *tq;
322 * The transmit ring, one per queue
325 struct adapter *adapter;
330 union ixgbe_adv_tx_desc *tx_base;
331 struct ixgbe_tx_buf *tx_buffers;
332 struct ixgbe_dma_alloc txdma;
333 volatile u16 tx_avail;
341 struct task txq_task;
347 u32 bytes; /* used for AIM */
359 * The Receive ring, one per rx queue
362 struct adapter *adapter;
366 union ixgbe_adv_rx_desc *rx_base;
367 struct ixgbe_dma_alloc rxdma;
377 struct ixgbe_rx_buf *rx_buffers;
380 u32 bytes; /* Used for AIM calc */
395 #define IXGBE_MAX_VF_MC 30 /* Max number of multicast entries */
400 u_int max_frame_size;
402 uint8_t ether_addr[ETHER_ADDR_LEN];
403 uint16_t mc_hash[IXGBE_MAX_VF_MC];
404 uint16_t num_mc_hashes;
405 uint16_t default_vlan;
410 /* Our adapter structure */
413 struct ixgbe_osdep osdep;
418 struct resource *pci_mem;
419 struct resource *msix_mem;
422 * Interrupt resources: this set is
423 * either used for legacy, or for Link
427 struct resource *res;
429 struct ifmedia media;
430 struct callout timer;
436 eventhandler_tag vlan_attach;
437 eventhandler_tag vlan_detach;
443 * Shadow VFTA table, this is needed because
444 * the real vlan filter table gets cleared during
445 * a soft reset and the driver needs to be able
448 u32 shadow_vfta[IXGBE_VFTA_SIZE];
450 /* Info about the interface */
451 int advertise; /* link speeds */
452 bool enable_aim; /* adaptive interrupt moderation */
462 /* Power management-related */
466 /* Mbuf cluster size */
469 /* Support for pluggable optics */
471 struct task link_task; /* Link tasklet */
472 struct task mod_task; /* SFP tasklet */
473 struct task msf_task; /* Multispeed Fiber */
474 struct task mbx_task; /* VF -> PF mailbox interrupt */
478 struct task fdir_task;
480 struct task phy_task; /* PHY intr tasklet */
481 struct taskqueue *tq;
485 * This is the irq holder, it has
486 * and RX/TX pair or rings associated
489 struct ix_queue *queues;
493 * Allocated at run time, an array of rings
495 struct tx_ring *tx_rings;
497 u32 tx_process_limit;
501 * Allocated at run time, an array of rings
503 struct rx_ring *rx_rings;
506 u32 rx_process_limit;
508 /* Multicast array memory */
509 struct ixgbe_mc_addr *mta;
515 struct ixgbe_vf *vfs;
518 struct ixgbe_bp_data bypass;
521 void (*init_locked)(struct adapter *);
522 void (*stop_locked)(void *);
524 /* Misc stats maintained by the driver */
525 unsigned long dropped_pkts;
526 unsigned long mbuf_defrag_failed;
527 unsigned long mbuf_header_failed;
528 unsigned long mbuf_packet_failed;
529 unsigned long watchdog_events;
530 unsigned long link_irq;
531 struct ixgbevf_hw_stats stats_vf;
532 #if __FreeBSD_version >= 1100036
533 /* counter(9) stats */
545 /* Feature capable/enabled flags. See ixgbe_features.h */
551 /* Precision Time Sync (IEEE 1588) defines */
552 #define ETHERTYPE_IEEE1588 0x88F7
553 #define PICOSECS_PER_TICK 20833
554 #define TSYNC_UDP_PORT 319 /* UDP port for the protocol */
555 #define IXGBE_ADVTXD_TSTAMP 0x00080000
558 #define IXGBE_CORE_LOCK_INIT(_sc, _name) \
559 mtx_init(&(_sc)->core_mtx, _name, "IXGBE Core Lock", MTX_DEF)
560 #define IXGBE_CORE_LOCK_DESTROY(_sc) mtx_destroy(&(_sc)->core_mtx)
561 #define IXGBE_TX_LOCK_DESTROY(_sc) mtx_destroy(&(_sc)->tx_mtx)
562 #define IXGBE_RX_LOCK_DESTROY(_sc) mtx_destroy(&(_sc)->rx_mtx)
563 #define IXGBE_CORE_LOCK(_sc) mtx_lock(&(_sc)->core_mtx)
564 #define IXGBE_TX_LOCK(_sc) mtx_lock(&(_sc)->tx_mtx)
565 #define IXGBE_TX_TRYLOCK(_sc) mtx_trylock(&(_sc)->tx_mtx)
566 #define IXGBE_RX_LOCK(_sc) mtx_lock(&(_sc)->rx_mtx)
567 #define IXGBE_CORE_UNLOCK(_sc) mtx_unlock(&(_sc)->core_mtx)
568 #define IXGBE_TX_UNLOCK(_sc) mtx_unlock(&(_sc)->tx_mtx)
569 #define IXGBE_RX_UNLOCK(_sc) mtx_unlock(&(_sc)->rx_mtx)
570 #define IXGBE_CORE_LOCK_ASSERT(_sc) mtx_assert(&(_sc)->core_mtx, MA_OWNED)
571 #define IXGBE_TX_LOCK_ASSERT(_sc) mtx_assert(&(_sc)->tx_mtx, MA_OWNED)
573 /* For backward compatibility */
574 #if !defined(PCIER_LINK_STA)
575 #define PCIER_LINK_STA PCIR_EXPRESS_LINK_STA
579 #if __FreeBSD_version >= 1100036
580 #define IXGBE_SET_IPACKETS(sc, count) (sc)->ipackets = (count)
581 #define IXGBE_SET_IERRORS(sc, count) (sc)->ierrors = (count)
582 #define IXGBE_SET_OPACKETS(sc, count) (sc)->opackets = (count)
583 #define IXGBE_SET_OERRORS(sc, count) (sc)->oerrors = (count)
584 #define IXGBE_SET_COLLISIONS(sc, count)
585 #define IXGBE_SET_IBYTES(sc, count) (sc)->ibytes = (count)
586 #define IXGBE_SET_OBYTES(sc, count) (sc)->obytes = (count)
587 #define IXGBE_SET_IMCASTS(sc, count) (sc)->imcasts = (count)
588 #define IXGBE_SET_OMCASTS(sc, count) (sc)->omcasts = (count)
589 #define IXGBE_SET_IQDROPS(sc, count) (sc)->iqdrops = (count)
591 #define IXGBE_SET_IPACKETS(sc, count) (sc)->ifp->if_ipackets = (count)
592 #define IXGBE_SET_IERRORS(sc, count) (sc)->ifp->if_ierrors = (count)
593 #define IXGBE_SET_OPACKETS(sc, count) (sc)->ifp->if_opackets = (count)
594 #define IXGBE_SET_OERRORS(sc, count) (sc)->ifp->if_oerrors = (count)
595 #define IXGBE_SET_COLLISIONS(sc, count) (sc)->ifp->if_collisions = (count)
596 #define IXGBE_SET_IBYTES(sc, count) (sc)->ifp->if_ibytes = (count)
597 #define IXGBE_SET_OBYTES(sc, count) (sc)->ifp->if_obytes = (count)
598 #define IXGBE_SET_IMCASTS(sc, count) (sc)->ifp->if_imcasts = (count)
599 #define IXGBE_SET_OMCASTS(sc, count) (sc)->ifp->if_omcasts = (count)
600 #define IXGBE_SET_IQDROPS(sc, count) (sc)->ifp->if_iqdrops = (count)
603 /* External PHY register addresses */
604 #define IXGBE_PHY_CURRENT_TEMP 0xC820
605 #define IXGBE_PHY_OVERTEMP_STATUS 0xC830
607 /* Sysctl help messages; displayed with sysctl -d */
608 #define IXGBE_SYSCTL_DESC_ADV_SPEED \
609 "\nControl advertised link speed using these flags:\n" \
610 "\t0x1 - advertise 100M\n" \
611 "\t0x2 - advertise 1G\n" \
612 "\t0x4 - advertise 10G\n" \
613 "\t0x8 - advertise 10M\n\n" \
614 "\t100M and 10M are only supported on certain adapters.\n"
616 #define IXGBE_SYSCTL_DESC_SET_FC \
617 "\nSet flow control mode using these values:\n" \
621 "\t3 - tx and rx pause"
623 /* Workaround to make 8.0 buildable */
624 #if __FreeBSD_version >= 800000 && __FreeBSD_version < 800504
626 drbr_needs_enqueue(struct ifnet *ifp, struct buf_ring *br)
629 if (ALTQ_IS_ENABLED(&ifp->if_snd))
632 return (!buf_ring_empty(br));
637 * Find the number of unrefreshed RX descriptors
640 ixgbe_rx_unrefreshed(struct rx_ring *rxr)
642 if (rxr->next_to_check > rxr->next_to_refresh)
643 return (rxr->next_to_check - rxr->next_to_refresh - 1);
645 return ((rxr->num_desc + rxr->next_to_check) -
646 rxr->next_to_refresh - 1);
650 ixgbe_legacy_ring_empty(struct ifnet *ifp, struct buf_ring *dummy)
652 UNREFERENCED_1PARAMETER(dummy);
654 return IFQ_DRV_IS_EMPTY(&ifp->if_snd);
658 * This checks for a zero mac addr, something that will be likely
659 * unless the Admin on the Host has created one.
662 ixv_check_ether_addr(u8 *addr)
666 if ((addr[0] == 0 && addr[1]== 0 && addr[2] == 0 &&
667 addr[3] == 0 && addr[4]== 0 && addr[5] == 0))
673 /* Shared Prototypes */
674 void ixv_legacy_start(struct ifnet *);
675 int ixv_legacy_start_locked(struct ifnet *, struct tx_ring *);
676 int ixv_mq_start(struct ifnet *, struct mbuf *);
677 int ixv_mq_start_locked(struct ifnet *, struct tx_ring *);
678 void ixv_qflush(struct ifnet *);
679 void ixv_deferred_mq_start(void *, int);
680 void ixv_init_locked(struct adapter *);
682 int ixv_allocate_queues(struct adapter *);
683 int ixv_setup_transmit_structures(struct adapter *);
684 void ixv_free_transmit_structures(struct adapter *);
685 int ixv_setup_receive_structures(struct adapter *);
686 void ixv_free_receive_structures(struct adapter *);
687 void ixv_txeof(struct tx_ring *);
688 bool ixv_rxeof(struct ix_queue *);
691 #include "ixv_netmap.h"
693 #endif /* _IXGBE_H_ */