Home | History | Annotate | Line # | Download | only in ixgbe
ixgbe.h revision 1.49
      1 /* $NetBSD: ixgbe.h,v 1.49 2018/05/23 10:11:07 msaitoh Exp $ */
      2 
      3 /******************************************************************************
      4   SPDX-License-Identifier: BSD-3-Clause
      5 
      6   Copyright (c) 2001-2017, Intel Corporation
      7   All rights reserved.
      8 
      9   Redistribution and use in source and binary forms, with or without
     10   modification, are permitted provided that the following conditions are met:
     11 
     12    1. Redistributions of source code must retain the above copyright notice,
     13       this list of conditions and the following disclaimer.
     14 
     15    2. Redistributions in binary form must reproduce the above copyright
     16       notice, this list of conditions and the following disclaimer in the
     17       documentation and/or other materials provided with the distribution.
     18 
     19    3. Neither the name of the Intel Corporation nor the names of its
     20       contributors may be used to endorse or promote products derived from
     21       this software without specific prior written permission.
     22 
     23   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
     24   AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     25   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     26   ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
     27   LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     28   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     29   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     30   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     31   CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     32   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     33   POSSIBILITY OF SUCH DAMAGE.
     34 
     35 ******************************************************************************/
     36 /*$FreeBSD: head/sys/dev/ixgbe/ixgbe.h 327031 2017-12-20 18:15:06Z erj $*/
     37 
     38 /*
     39  * Copyright (c) 2011 The NetBSD Foundation, Inc.
     40  * All rights reserved.
     41  *
     42  * This code is derived from software contributed to The NetBSD Foundation
     43  * by Coyote Point Systems, Inc.
     44  *
     45  * Redistribution and use in source and binary forms, with or without
     46  * modification, are permitted provided that the following conditions
     47  * are met:
     48  * 1. Redistributions of source code must retain the above copyright
     49  *    notice, this list of conditions and the following disclaimer.
     50  * 2. Redistributions in binary form must reproduce the above copyright
     51  *    notice, this list of conditions and the following disclaimer in the
     52  *    documentation and/or other materials provided with the distribution.
     53  *
     54  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     55  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     56  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     57  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     58  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     59  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     60  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     61  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     62  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     63  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     64  * POSSIBILITY OF SUCH DAMAGE.
     65  */
     66 
     67 
     68 #ifndef _IXGBE_H_
     69 #define _IXGBE_H_
     70 
     71 
     72 #include <sys/param.h>
     73 #include <sys/reboot.h>
     74 #include <sys/systm.h>
     75 #include <sys/pcq.h>
     76 #include <sys/mbuf.h>
     77 #include <sys/protosw.h>
     78 #include <sys/socket.h>
     79 #include <sys/malloc.h>
     80 #include <sys/kernel.h>
     81 #include <sys/module.h>
     82 #include <sys/sockio.h>
     83 #include <sys/percpu.h>
     84 
     85 #include <net/if.h>
     86 #include <net/if_arp.h>
     87 #include <net/bpf.h>
     88 #include <net/if_ether.h>
     89 #include <net/if_dl.h>
     90 #include <net/if_media.h>
     91 
     92 #include <net/bpf.h>
     93 #include <net/if_types.h>
     94 #include <net/if_vlanvar.h>
     95 
     96 #include <netinet/in_systm.h>
     97 #include <netinet/in.h>
     98 #include <netinet/ip.h>
     99 #include <netinet/ip6.h>
    100 #include <netinet/tcp.h>
    101 #include <netinet/udp.h>
    102 
    103 #include <sys/bus.h>
    104 #include <dev/pci/pcivar.h>
    105 #include <dev/pci/pcireg.h>
    106 #include <sys/proc.h>
    107 #include <sys/sysctl.h>
    108 #include <sys/endian.h>
    109 #include <sys/workqueue.h>
    110 #include <sys/cpu.h>
    111 #include <sys/interrupt.h>
    112 #include <sys/bitops.h>
    113 
    114 #include "ixgbe_netbsd.h"
    115 #include "ixgbe_api.h"
    116 #include "ixgbe_common.h"
    117 #include "ixgbe_vf.h"
    118 #include "ixgbe_features.h"
    119 
    120 /* Tunables */
    121 
    122 /*
    123  * TxDescriptors Valid Range: 64-4096 Default Value: 256 This value is the
    124  * number of transmit descriptors allocated by the driver. Increasing this
    125  * value allows the driver to queue more transmits. Each descriptor is 16
    126  * bytes. Performance tests have show the 2K value to be optimal for top
    127  * performance.
    128  */
    129 #define DEFAULT_TXD	1024
    130 #define PERFORM_TXD	2048
    131 #define MAX_TXD		4096
    132 #define MIN_TXD		64
    133 
    134 /*
    135  * RxDescriptors Valid Range: 64-4096 Default Value: 256 This value is the
    136  * number of receive descriptors allocated for each RX queue. Increasing this
    137  * value allows the driver to buffer more incoming packets. Each descriptor
    138  * is 16 bytes.  A receive buffer is also allocated for each descriptor.
    139  *
    140  * Note: with 8 rings and a dual port card, it is possible to bump up
    141  *	against the system mbuf pool limit, you can tune nmbclusters
    142  *	to adjust for this.
    143  */
    144 #define DEFAULT_RXD	1024
    145 #define PERFORM_RXD	2048
    146 #define MAX_RXD		4096
    147 #define MIN_RXD		64
    148 
    149 /* Alignment for rings */
    150 #define DBA_ALIGN	128
    151 
    152 /*
    153  * This is the max watchdog interval, ie. the time that can
    154  * pass between any two TX clean operations, such only happening
    155  * when the TX hardware is functioning.
    156  */
    157 #define IXGBE_WATCHDOG  (10 * hz)
    158 
    159 /*
    160  * This parameters control when the driver calls the routine to reclaim
    161  * transmit descriptors.
    162  */
    163 #define IXGBE_TX_CLEANUP_THRESHOLD(_a)  ((_a)->num_tx_desc / 8)
    164 #define IXGBE_TX_OP_THRESHOLD(_a)       ((_a)->num_tx_desc / 32)
    165 
    166 /* These defines are used in MTU calculations */
    167 #define IXGBE_MAX_FRAME_SIZE  9728
    168 #define IXGBE_MTU_HDR         (ETHER_HDR_LEN + ETHER_CRC_LEN)
    169 #define IXGBE_MTU_HDR_VLAN    (ETHER_HDR_LEN + ETHER_CRC_LEN + \
    170                                ETHER_VLAN_ENCAP_LEN)
    171 #define IXGBE_MAX_MTU         (IXGBE_MAX_FRAME_SIZE - IXGBE_MTU_HDR)
    172 #define IXGBE_MAX_MTU_VLAN    (IXGBE_MAX_FRAME_SIZE - IXGBE_MTU_HDR_VLAN)
    173 
    174 /* Flow control constants */
    175 #define IXGBE_FC_PAUSE        0xFFFF
    176 
    177 /*
    178  * Used for optimizing small rx mbufs.  Effort is made to keep the copy
    179  * small and aligned for the CPU L1 cache.
    180  *
    181  * MHLEN is typically 168 bytes, giving us 8-byte alignment.  Getting
    182  * 32 byte alignment needed for the fast bcopy results in 8 bytes being
    183  * wasted.  Getting 64 byte alignment, which _should_ be ideal for
    184  * modern Intel CPUs, results in 40 bytes wasted and a significant drop
    185  * in observed efficiency of the optimization, 97.9% -> 81.8%.
    186  */
    187 #define	MPKTHSIZE		(offsetof(struct _mbuf_dummy, m_pktdat))
    188 #define IXGBE_RX_COPY_HDR_PADDED  ((((MPKTHSIZE - 1) / 32) + 1) * 32)
    189 #define IXGBE_RX_COPY_LEN         (MSIZE - IXGBE_RX_COPY_HDR_PADDED)
    190 #define IXGBE_RX_COPY_ALIGN       (IXGBE_RX_COPY_HDR_PADDED - MPKTHSIZE)
    191 
    192 /* Keep older OS drivers building... */
    193 #if !defined(SYSCTL_ADD_UQUAD)
    194 #define SYSCTL_ADD_UQUAD SYSCTL_ADD_QUAD
    195 #endif
    196 
    197 /* Defines for printing debug information */
    198 #define DEBUG_INIT  0
    199 #define DEBUG_IOCTL 0
    200 #define DEBUG_HW    0
    201 
    202 #define INIT_DEBUGOUT(S)            if (DEBUG_INIT)  printf(S "\n")
    203 #define INIT_DEBUGOUT1(S, A)        if (DEBUG_INIT)  printf(S "\n", A)
    204 #define INIT_DEBUGOUT2(S, A, B)     if (DEBUG_INIT)  printf(S "\n", A, B)
    205 #define IOCTL_DEBUGOUT(S)           if (DEBUG_IOCTL) printf(S "\n")
    206 #define IOCTL_DEBUGOUT1(S, A)       if (DEBUG_IOCTL) printf(S "\n", A)
    207 #define IOCTL_DEBUGOUT2(S, A, B)    if (DEBUG_IOCTL) printf(S "\n", A, B)
    208 #define HW_DEBUGOUT(S)              if (DEBUG_HW) printf(S "\n")
    209 #define HW_DEBUGOUT1(S, A)          if (DEBUG_HW) printf(S "\n", A)
    210 #define HW_DEBUGOUT2(S, A, B)       if (DEBUG_HW) printf(S "\n", A, B)
    211 
    212 #define MAX_NUM_MULTICAST_ADDRESSES     128
    213 #define IXGBE_82598_SCATTER             100
    214 #define IXGBE_82599_SCATTER             32
    215 #define MSIX_82598_BAR                  3
    216 #define MSIX_82599_BAR                  4
    217 #define IXGBE_TSO_SIZE                  262140
    218 #define IXGBE_RX_HDR                    128
    219 #define IXGBE_VFTA_SIZE                 128
    220 #define IXGBE_BR_SIZE                   4096
    221 #define IXGBE_QUEUE_MIN_FREE            32
    222 #define IXGBE_MAX_TX_BUSY               10
    223 #define IXGBE_QUEUE_HUNG                0x80000000
    224 
    225 #define IXGBE_EITR_DEFAULT		128
    226 
    227 /* IOCTL define to gather SFP+ Diagnostic data */
    228 #define SIOCGI2C	SIOCGIFGENERIC
    229 
    230 /* Offload bits in mbuf flag */
    231 #define	M_CSUM_OFFLOAD	\
    232     (M_CSUM_IPv4|M_CSUM_UDPv4|M_CSUM_TCPv4|M_CSUM_UDPv6|M_CSUM_TCPv6)
    233 
    234 /* Backward compatibility items for very old versions */
    235 #ifndef pci_find_cap
    236 #define pci_find_cap pci_find_extcap
    237 #endif
    238 
    239 #ifndef DEVMETHOD_END
    240 #define DEVMETHOD_END { NULL, NULL }
    241 #endif
    242 
    243 /*
    244  * Interrupt Moderation parameters
    245  */
    246 #define IXGBE_LOW_LATENCY	128
    247 #define IXGBE_AVE_LATENCY	400
    248 #define IXGBE_BULK_LATENCY	1200
    249 
    250 /* Using 1FF (the max value), the interval is ~1.05ms */
    251 #define IXGBE_LINK_ITR_QUANTA  0x1FF
    252 #define IXGBE_LINK_ITR         ((IXGBE_LINK_ITR_QUANTA << 3) & \
    253                                 IXGBE_EITR_ITR_INT_MASK)
    254 
    255 
    256 /************************************************************************
    257  * vendor_info_array
    258  *
    259  *   Contains the list of Subvendor/Subdevice IDs on
    260  *   which the driver should load.
    261  ************************************************************************/
    262 typedef struct _ixgbe_vendor_info_t {
    263 	unsigned int vendor_id;
    264 	unsigned int device_id;
    265 	unsigned int subvendor_id;
    266 	unsigned int subdevice_id;
    267 	unsigned int index;
    268 } ixgbe_vendor_info_t;
    269 
    270 /* This is used to get SFP+ module data */
    271 struct ixgbe_i2c_req {
    272         u8 dev_addr;
    273         u8 offset;
    274         u8 len;
    275         u8 data[8];
    276 };
    277 
    278 struct ixgbe_bp_data {
    279 	u32 low;
    280 	u32 high;
    281 	u32 log;
    282 };
    283 
    284 struct ixgbe_tx_buf {
    285 	union ixgbe_adv_tx_desc	*eop;
    286 	struct mbuf             *m_head;
    287 	bus_dmamap_t            map;
    288 };
    289 
    290 struct ixgbe_rx_buf {
    291 	struct mbuf    *buf;
    292 	struct mbuf    *fmp;
    293 	bus_dmamap_t   pmap;
    294 	u_int          flags;
    295 #define IXGBE_RX_COPY  0x01
    296 	uint64_t       addr;
    297 };
    298 
    299 /*
    300  * Bus dma allocation structure used by ixgbe_dma_malloc and ixgbe_dma_free
    301  */
    302 struct ixgbe_dma_alloc {
    303 	bus_addr_t        dma_paddr;
    304 	void              *dma_vaddr;
    305 	ixgbe_dma_tag_t   *dma_tag;
    306 	bus_dmamap_t      dma_map;
    307 	bus_dma_segment_t dma_seg;
    308 	bus_size_t        dma_size;
    309 };
    310 
    311 struct ixgbe_mc_addr {
    312 	u8  addr[IXGBE_ETH_LENGTH_OF_ADDRESS];
    313 	u32 vmdq;
    314 };
    315 
    316 /*
    317  * Driver queue struct: this is the interrupt container
    318  *                      for the associated tx and rx ring.
    319  */
    320 struct ix_queue {
    321 	struct adapter   *adapter;
    322 	u32              msix;           /* This queue's MSI-X vector */
    323 	u32              eitr_setting;
    324 	u32              me;
    325 	struct resource  *res;
    326 	int              busy;
    327 	struct tx_ring   *txr;
    328 	struct rx_ring   *rxr;
    329 	struct work      wq_cookie;
    330 	void             *que_si;
    331 	/* Per queue event conters */
    332 	struct evcnt     irqs;		/* Hardware interrupt */
    333 	struct evcnt     handleq;	/* software_interrupt */
    334 	struct evcnt     req;		/* deferred */
    335 	char             namebuf[32];
    336 	char             evnamebuf[32];
    337 
    338 	kmutex_t         dc_mtx;	/* lock for disabled_count and this queue's EIMS/EIMC bit */
    339 	int              disabled_count;/*
    340 					 * means
    341 					 *     0   : this queue is enabled
    342 					 *     > 0 : this queue is disabled
    343 					 *           the value is ixgbe_disable_queue() called count
    344 					 */
    345 	bool             txrx_use_workqueue;
    346 };
    347 
    348 /*
    349  * The transmit ring, one per queue
    350  */
    351 struct tx_ring {
    352         struct adapter		*adapter;
    353 	kmutex_t		tx_mtx;
    354 	u32			me;
    355 	u32			tail;
    356 	int			busy;
    357 	union ixgbe_adv_tx_desc	*tx_base;
    358 	struct ixgbe_tx_buf	*tx_buffers;
    359 	struct ixgbe_dma_alloc	txdma;
    360 	volatile u16		tx_avail;
    361 	u16			next_avail_desc;
    362 	u16			next_to_clean;
    363 	u16			num_desc;
    364 	ixgbe_dma_tag_t		*txtag;
    365 #if 0
    366 	char			mtx_name[16]; /* NetBSD has no mutex name */
    367 #endif
    368 	pcq_t			*txr_interq;
    369 	struct work		wq_cookie;
    370 	void			*txr_si;
    371 	bool			txr_no_space; /* Like IFF_OACTIVE */
    372 
    373 	/* Flow Director */
    374 	u16			atr_sample;
    375 	u16			atr_count;
    376 
    377 	u64			bytes;  /* used for AIM */
    378 	u64			packets;
    379 	/* Soft Stats */
    380 	struct evcnt	   	tso_tx;
    381 	struct evcnt		no_desc_avail;
    382 	struct evcnt		total_packets;
    383 	struct evcnt		pcq_drops;
    384 	/* Per queue conters.  The adapter total is in struct adapter */
    385 	u64              q_efbig_tx_dma_setup;
    386 	u64              q_mbuf_defrag_failed;
    387 	u64              q_efbig2_tx_dma_setup;
    388 	u64              q_einval_tx_dma_setup;
    389 	u64              q_other_tx_dma_setup;
    390 	u64              q_eagain_tx_dma_setup;
    391 	u64              q_enomem_tx_dma_setup;
    392 	u64              q_tso_err;
    393 };
    394 
    395 
    396 /*
    397  * The Receive ring, one per rx queue
    398  */
    399 struct rx_ring {
    400         struct adapter		*adapter;
    401 	kmutex_t		rx_mtx;
    402 	u32			me;
    403 	u32			tail;
    404 	union ixgbe_adv_rx_desc	*rx_base;
    405 	struct ixgbe_dma_alloc	rxdma;
    406 #ifdef LRO
    407 	struct lro_ctrl		lro;
    408 #endif /* LRO */
    409 	bool			lro_enabled;
    410 	bool			hw_rsc;
    411 	bool			vtag_strip;
    412         u16			next_to_refresh;
    413         u16 			next_to_check;
    414 	u16			num_desc;
    415 	u16			mbuf_sz;
    416 #if 0
    417 	char			mtx_name[16]; /* NetBSD has no mutex name */
    418 #endif
    419 	struct ixgbe_rx_buf	*rx_buffers;
    420 	ixgbe_dma_tag_t		*ptag;
    421 
    422 	u64			bytes; /* Used for AIM calc */
    423 	u64			packets;
    424 
    425 	/* Soft stats */
    426 	struct evcnt		rx_copies;
    427 	struct evcnt		rx_packets;
    428 	struct evcnt 		rx_bytes;
    429 	struct evcnt 		rx_discarded;
    430 	struct evcnt 		no_jmbuf;
    431 	u64 			rsc_num;
    432 
    433 	/* Flow Director */
    434 	u64			flm;
    435 };
    436 
    437 #define IXGBE_MAX_VF_MC 30  /* Max number of multicast entries */
    438 
    439 struct ixgbe_vf {
    440 	u_int    pool;
    441 	u_int    rar_index;
    442 	u_int    max_frame_size;
    443 	uint32_t flags;
    444 	uint8_t  ether_addr[ETHER_ADDR_LEN];
    445 	uint16_t mc_hash[IXGBE_MAX_VF_MC];
    446 	uint16_t num_mc_hashes;
    447 	uint16_t default_vlan;
    448 	uint16_t vlan_tag;
    449 	uint16_t api_ver;
    450 };
    451 
    452 /* Our adapter structure */
    453 struct adapter {
    454 	struct ixgbe_hw		hw;
    455 	struct ixgbe_osdep	osdep;
    456 
    457 	device_t		dev;
    458 	struct ifnet		*ifp;
    459 	struct if_percpuq	*ipq;	/* softint-based input queues */
    460 
    461 	struct resource		*pci_mem;
    462 	struct resource		*msix_mem;
    463 
    464 	/* NetBSD: Interrupt resources are in osdep */
    465 
    466 	struct ifmedia		media;
    467 	callout_t		timer;
    468 	int			if_flags;
    469 
    470 	kmutex_t		core_mtx;
    471 
    472 	unsigned int		num_queues;
    473 
    474 	/*
    475 	 * Shadow VFTA table, this is needed because
    476 	 * the real vlan filter table gets cleared during
    477 	 * a soft reset and the driver needs to be able
    478 	 * to repopulate it.
    479 	 */
    480 	u32			shadow_vfta[IXGBE_VFTA_SIZE];
    481 
    482 	/* Info about the interface */
    483 	int			advertise;  /* link speeds */
    484 	bool			enable_aim; /* adaptive interrupt moderation */
    485 	bool			link_active;
    486 	u16			max_frame_size;
    487 	u16			num_segs;
    488 	u32			link_speed;
    489 	bool			link_up;
    490 	u32 			vector;
    491 	u16			dmac;
    492 	u32			phy_layer;
    493 
    494 	/* Power management-related */
    495 	bool			wol_support;
    496 	u32			wufc;
    497 
    498 	/* Mbuf cluster size */
    499 	u32			rx_mbuf_sz;
    500 
    501 	/* Support for pluggable optics */
    502 	bool			sfp_probe;
    503 	void			*link_si;  /* Link tasklet */
    504 	void			*mod_si;   /* SFP tasklet */
    505 	void			*msf_si;   /* Multispeed Fiber */
    506 	void			*mbx_si;   /* VF -> PF mailbox interrupt */
    507 
    508 	/* Flow Director */
    509 	int			fdir_reinit;
    510 	void			*fdir_si;
    511 
    512 	void			*phy_si;   /* PHY intr tasklet */
    513 
    514 	bool			txrx_use_workqueue;
    515 	struct workqueue	*que_wq;    /* workqueue for ixgbe_handle_que_work() */
    516 					    /*
    517 					     * que_wq's "enqueued flag" is not required,
    518 					     * because twice workqueue_enqueue() for
    519 					     * ixgbe_handle_que_work() is avoided by masking
    520 					     * the queue's interrupt by EIMC.
    521 					     * See also ixgbe_msix_que().
    522 					     */
    523 	struct workqueue	*txr_wq;    /* workqueue for ixgbe_deferred_mq_start_work() */
    524 	percpu_t		*txr_wq_enqueued;
    525 
    526 	/*
    527 	 * Queues:
    528 	 *   This is the irq holder, it has
    529 	 *   and RX/TX pair or rings associated
    530 	 *   with it.
    531 	 */
    532 	struct ix_queue		*queues;
    533 
    534 	/*
    535 	 * Transmit rings
    536 	 *      Allocated at run time, an array of rings
    537 	 */
    538 	struct tx_ring		*tx_rings;
    539 	u32			num_tx_desc;
    540 	u32			tx_process_limit;
    541 
    542 	/*
    543 	 * Receive rings
    544 	 *      Allocated at run time, an array of rings
    545 	 */
    546 	struct rx_ring		*rx_rings;
    547 	u64			active_queues;
    548 	u32			num_rx_desc;
    549 	u32			rx_process_limit;
    550 
    551 	/* Multicast array memory */
    552 	struct ixgbe_mc_addr	*mta;
    553 
    554 	/* SR-IOV */
    555 	int                     iov_mode;
    556 	int			num_vfs;
    557 	int			pool;
    558 	struct ixgbe_vf		*vfs;
    559 
    560 	/* Bypass */
    561 	struct ixgbe_bp_data    bypass;
    562 
    563 	/* Netmap */
    564 	void 			(*init_locked)(struct adapter *);
    565 	void 			(*stop_locked)(void *);
    566 
    567 	/* Misc stats maintained by the driver */
    568 	struct evcnt	   	efbig_tx_dma_setup;
    569 	struct evcnt   		mbuf_defrag_failed;
    570 	struct evcnt	   	efbig2_tx_dma_setup;
    571 	struct evcnt	   	einval_tx_dma_setup;
    572 	struct evcnt	   	other_tx_dma_setup;
    573 	struct evcnt	   	eagain_tx_dma_setup;
    574 	struct evcnt	   	enomem_tx_dma_setup;
    575 	struct evcnt	   	tso_err;
    576 	struct evcnt	   	watchdog_events;
    577 	struct evcnt		link_irq;
    578 	struct evcnt		link_sicount;
    579 	struct evcnt		mod_sicount;
    580 	struct evcnt		msf_sicount;
    581 	struct evcnt		phy_sicount;
    582 
    583 	union {
    584 		struct ixgbe_hw_stats pf;
    585 		struct ixgbevf_hw_stats	vf;
    586 	} stats;
    587 #if __FreeBSD_version >= 1100036
    588 	/* counter(9) stats */
    589 	u64			ipackets;
    590 	u64			ierrors;
    591 	u64			opackets;
    592 	u64			oerrors;
    593 	u64			ibytes;
    594 	u64			obytes;
    595 	u64			imcasts;
    596 	u64			omcasts;
    597 	u64			iqdrops;
    598 	u64			noproto;
    599 #endif
    600 	/* Feature capable/enabled flags.  See ixgbe_features.h */
    601 	u32                     feat_cap;
    602 	u32                     feat_en;
    603 
    604 	struct sysctllog	*sysctllog;
    605 	const struct sysctlnode *sysctltop;
    606 	ixgbe_extmem_head_t jcl_head;
    607 };
    608 
    609 /* Precision Time Sync (IEEE 1588) defines */
    610 #define ETHERTYPE_IEEE1588      0x88F7
    611 #define PICOSECS_PER_TICK       20833
    612 #define TSYNC_UDP_PORT          319 /* UDP port for the protocol */
    613 #define IXGBE_ADVTXD_TSTAMP     0x00080000
    614 
    615 
    616 #define IXGBE_CORE_LOCK_INIT(_sc, _name) \
    617         mutex_init(&(_sc)->core_mtx, MUTEX_DEFAULT, IPL_SOFTNET)
    618 #define IXGBE_CORE_LOCK_DESTROY(_sc)      mutex_destroy(&(_sc)->core_mtx)
    619 #define IXGBE_TX_LOCK_DESTROY(_sc)        mutex_destroy(&(_sc)->tx_mtx)
    620 #define IXGBE_RX_LOCK_DESTROY(_sc)        mutex_destroy(&(_sc)->rx_mtx)
    621 #define IXGBE_CORE_LOCK(_sc)              mutex_enter(&(_sc)->core_mtx)
    622 #define IXGBE_TX_LOCK(_sc)                mutex_enter(&(_sc)->tx_mtx)
    623 #define IXGBE_TX_TRYLOCK(_sc)             mutex_tryenter(&(_sc)->tx_mtx)
    624 #define IXGBE_RX_LOCK(_sc)                mutex_enter(&(_sc)->rx_mtx)
    625 #define IXGBE_CORE_UNLOCK(_sc)            mutex_exit(&(_sc)->core_mtx)
    626 #define IXGBE_TX_UNLOCK(_sc)              mutex_exit(&(_sc)->tx_mtx)
    627 #define IXGBE_RX_UNLOCK(_sc)              mutex_exit(&(_sc)->rx_mtx)
    628 #define IXGBE_CORE_LOCK_ASSERT(_sc)       KASSERT(mutex_owned(&(_sc)->core_mtx))
    629 #define IXGBE_TX_LOCK_ASSERT(_sc)         KASSERT(mutex_owned(&(_sc)->tx_mtx))
    630 
    631 /* Stats macros */
    632 #if __FreeBSD_version >= 1100036
    633 #define IXGBE_SET_IPACKETS(sc, count)    (sc)->ipackets = (count)
    634 #define IXGBE_SET_IERRORS(sc, count)     (sc)->ierrors = (count)
    635 #define IXGBE_SET_OPACKETS(sc, count)    (sc)->opackets = (count)
    636 #define IXGBE_SET_OERRORS(sc, count)     (sc)->oerrors = (count)
    637 #define IXGBE_SET_COLLISIONS(sc, count)
    638 #define IXGBE_SET_IBYTES(sc, count)      (sc)->ibytes = (count)
    639 #define IXGBE_SET_OBYTES(sc, count)      (sc)->obytes = (count)
    640 #define IXGBE_SET_IMCASTS(sc, count)     (sc)->imcasts = (count)
    641 #define IXGBE_SET_OMCASTS(sc, count)     (sc)->omcasts = (count)
    642 #define IXGBE_SET_IQDROPS(sc, count)     (sc)->iqdrops = (count)
    643 #else
    644 #define IXGBE_SET_IPACKETS(sc, count)    (sc)->ifp->if_ipackets = (count)
    645 #define IXGBE_SET_IERRORS(sc, count)     (sc)->ifp->if_ierrors = (count)
    646 #define IXGBE_SET_OPACKETS(sc, count)    (sc)->ifp->if_opackets = (count)
    647 #define IXGBE_SET_OERRORS(sc, count)     (sc)->ifp->if_oerrors = (count)
    648 #define IXGBE_SET_COLLISIONS(sc, count)  (sc)->ifp->if_collisions = (count)
    649 #define IXGBE_SET_IBYTES(sc, count)      (sc)->ifp->if_ibytes = (count)
    650 #define IXGBE_SET_OBYTES(sc, count)      (sc)->ifp->if_obytes = (count)
    651 #define IXGBE_SET_IMCASTS(sc, count)     (sc)->ifp->if_imcasts = (count)
    652 #define IXGBE_SET_OMCASTS(sc, count)     (sc)->ifp->if_omcasts = (count)
    653 #define IXGBE_SET_IQDROPS(sc, count)     (sc)->ifp->if_iqdrops = (count)
    654 #endif
    655 
    656 /* External PHY register addresses */
    657 #define IXGBE_PHY_CURRENT_TEMP		0xC820
    658 #define IXGBE_PHY_OVERTEMP_STATUS	0xC830
    659 
    660 /* Sysctl help messages; displayed with sysctl -d */
    661 #define IXGBE_SYSCTL_DESC_ADV_SPEED \
    662 	"\nControl advertised link speed using these flags:\n" \
    663 	"\t0x01 - advertise 100M\n" \
    664 	"\t0x02 - advertise 1G\n" \
    665         "\t0x04 - advertise 10G\n" \
    666         "\t0x08 - advertise 10M\n" \
    667         "\t0x10 - advertise 2.5G\n" \
    668         "\t0x20 - advertise 5G\n\n" \
    669         "\t5G, 2.5G, 100M and 10M are only supported on certain adapters."
    670 
    671 #define IXGBE_SYSCTL_DESC_SET_FC \
    672 	"\nSet flow control mode using these values:\n" \
    673 	"\t0 - off\n" \
    674 	"\t1 - rx pause\n" \
    675 	"\t2 - tx pause\n" \
    676 	"\t3 - tx and rx pause"
    677 
    678 /* Workaround to make 8.0 buildable */
    679 #if __FreeBSD_version >= 800000 && __FreeBSD_version < 800504
    680 static __inline int
    681 drbr_needs_enqueue(struct ifnet *ifp, struct buf_ring *br)
    682 {
    683 #ifdef ALTQ
    684 	if (ALTQ_IS_ENABLED(&ifp->if_snd))
    685 		return (1);
    686 #endif
    687 	return (!buf_ring_empty(br));
    688 }
    689 #endif
    690 
    691 /*
    692  * Find the number of unrefreshed RX descriptors
    693  */
    694 static __inline u16
    695 ixgbe_rx_unrefreshed(struct rx_ring *rxr)
    696 {
    697 	if (rxr->next_to_check > rxr->next_to_refresh)
    698 		return (rxr->next_to_check - rxr->next_to_refresh - 1);
    699 	else
    700 		return ((rxr->num_desc + rxr->next_to_check) -
    701 		    rxr->next_to_refresh - 1);
    702 }
    703 
    704 static __inline int
    705 ixgbe_legacy_ring_empty(struct ifnet *ifp, pcq_t *dummy)
    706 {
    707 	UNREFERENCED_1PARAMETER(dummy);
    708 
    709 	return IFQ_IS_EMPTY(&ifp->if_snd);
    710 }
    711 
    712 static __inline int
    713 ixgbe_mq_ring_empty(struct ifnet *dummy, pcq_t *interq)
    714 {
    715 	UNREFERENCED_1PARAMETER(dummy);
    716 
    717 	return (pcq_peek(interq) == NULL);
    718 }
    719 
    720 /*
    721  * This checks for a zero mac addr, something that will be likely
    722  * unless the Admin on the Host has created one.
    723  */
    724 static __inline bool
    725 ixv_check_ether_addr(u8 *addr)
    726 {
    727 	bool status = TRUE;
    728 
    729 	if ((addr[0] == 0 && addr[1]== 0 && addr[2] == 0 &&
    730 	    addr[3] == 0 && addr[4]== 0 && addr[5] == 0))
    731 		status = FALSE;
    732 
    733 	return (status);
    734 }
    735 
    736 /* Shared Prototypes */
    737 void ixgbe_legacy_start(struct ifnet *);
    738 int  ixgbe_legacy_start_locked(struct ifnet *, struct tx_ring *);
    739 int  ixgbe_mq_start(struct ifnet *, struct mbuf *);
    740 int  ixgbe_mq_start_locked(struct ifnet *, struct tx_ring *);
    741 void ixgbe_deferred_mq_start(void *);
    742 void ixgbe_deferred_mq_start_work(struct work *, void *);
    743 void ixgbe_drain_all(struct adapter *);
    744 
    745 int  ixgbe_allocate_queues(struct adapter *);
    746 int  ixgbe_setup_transmit_structures(struct adapter *);
    747 void ixgbe_free_transmit_structures(struct adapter *);
    748 int  ixgbe_setup_receive_structures(struct adapter *);
    749 void ixgbe_free_receive_structures(struct adapter *);
    750 bool ixgbe_txeof(struct tx_ring *);
    751 bool ixgbe_rxeof(struct ix_queue *);
    752 
    753 const struct sysctlnode *ixgbe_sysctl_instance(struct adapter *);
    754 
    755 /* For NetBSD */
    756 void ixgbe_jcl_reinit(struct adapter *, bus_dma_tag_t, int, size_t);
    757 
    758 #include "ixgbe_bypass.h"
    759 #include "ixgbe_fdir.h"
    760 #include "ixgbe_rss.h"
    761 #include "ixgbe_netmap.h"
    762 
    763 #endif /* _IXGBE_H_ */
    764