Home | History | Annotate | Line # | Download | only in ixgbe
ixgbe.h revision 1.93
      1 /* $NetBSD: ixgbe.h,v 1.93 2023/10/12 08:06:13 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/if_types.h>
     93 #include <net/if_vlanvar.h>
     94 
     95 #include <netinet/in_systm.h>
     96 #include <netinet/in.h>
     97 #include <netinet/ip.h>
     98 #include <netinet/ip6.h>
     99 #include <netinet/tcp.h>
    100 #include <netinet/udp.h>
    101 
    102 #include <sys/bus.h>
    103 #include <dev/pci/pcivar.h>
    104 #include <dev/pci/pcireg.h>
    105 #include <sys/proc.h>
    106 #include <sys/sysctl.h>
    107 #include <sys/endian.h>
    108 #include <sys/workqueue.h>
    109 #include <sys/cpu.h>
    110 #include <sys/interrupt.h>
    111 #include <sys/bitops.h>
    112 
    113 #include "ixgbe_netbsd.h"
    114 #include "ixgbe_api.h"
    115 #include "ixgbe_common.h"
    116 #include "ixgbe_vf.h"
    117 #include "ixgbe_features.h"
    118 
    119 /* Tunables */
    120 
    121 /*
    122  * TxDescriptors Valid Range: 64-4096 Default Value: 2048 This value is the
    123  * number of transmit descriptors allocated by the driver. Increasing this
    124  * value allows the driver to queue more transmits. Each descriptor is 16
    125  * bytes. Performance tests have show the 2K value to be optimal for top
    126  * performance.
    127  */
    128 #define DEFAULT_TXD	2048
    129 #define MAX_TXD		4096
    130 #define MIN_TXD		64
    131 
    132 /*
    133  * RxDescriptors Valid Range: 64-4096 Default Value: 2048 This value is the
    134  * number of receive descriptors allocated for each RX queue. Increasing this
    135  * value allows the driver to buffer more incoming packets. Each descriptor
    136  * is 16 bytes.  A receive buffer is also allocated for each descriptor.
    137  *
    138  * Note: with 8 rings and a dual port card, it is possible to bump up
    139  *	against the system mbuf pool limit, you can tune nmbclusters
    140  *	to adjust for this.
    141  */
    142 #define DEFAULT_RXD	2048
    143 #define MAX_RXD		4096
    144 #define MIN_RXD		64
    145 
    146 /* Alignment for rings */
    147 #define DBA_ALIGN	128
    148 
    149 /*
    150  * This is the max watchdog interval, ie. the time that can
    151  * pass between any two TX clean operations, such only happening
    152  * when the TX hardware is functioning.
    153  */
    154 #define IXGBE_WATCHDOG  (10 * hz)
    155 
    156 /*
    157  * This parameters control when the driver calls the routine to reclaim
    158  * transmit descriptors.
    159  */
    160 #define IXGBE_TX_CLEANUP_THRESHOLD(_a)  ((_a)->num_tx_desc / 8)
    161 #define IXGBE_TX_OP_THRESHOLD(_a)       ((_a)->num_tx_desc / 32)
    162 
    163 /* These defines are used in MTU calculations */
    164 #define IXGBE_MAX_FRAME_SIZE  9728
    165 #define IXGBE_MTU_HDR         (ETHER_HDR_LEN + ETHER_CRC_LEN)
    166 #define IXGBE_MTU_HDR_VLAN    (ETHER_HDR_LEN + ETHER_CRC_LEN + \
    167                                ETHER_VLAN_ENCAP_LEN)
    168 #define IXGBE_MAX_MTU         (IXGBE_MAX_FRAME_SIZE - IXGBE_MTU_HDR)
    169 #define IXGBE_MAX_MTU_VLAN    (IXGBE_MAX_FRAME_SIZE - IXGBE_MTU_HDR_VLAN)
    170 
    171 /* Flow control constants */
    172 #define IXGBE_FC_PAUSE        0xFFFF
    173 
    174 /*
    175  * Used for optimizing small rx mbufs.  Effort is made to keep the copy
    176  * small and aligned for the CPU L1 cache.
    177  *
    178  * MHLEN is typically 168 bytes, giving us 8-byte alignment.  Getting
    179  * 32 byte alignment needed for the fast bcopy results in 8 bytes being
    180  * wasted.  Getting 64 byte alignment, which _should_ be ideal for
    181  * modern Intel CPUs, results in 40 bytes wasted and a significant drop
    182  * in observed efficiency of the optimization, 97.9% -> 81.8%.
    183  */
    184 #define IXGBE_RX_COPY_LEN_MAX     (MHLEN - ETHER_ALIGN)
    185 
    186 /*
    187  * Default TX WTHRESH value.
    188  * Currently, we don't use the Tx Head Pointer Write Back function.
    189  */
    190 #define IXGBE_TX_WTHRESH	5
    191 
    192 /*
    193  * The max number of descriptors that one packet can use is 40 - WTHRESH - 2.
    194  * Though 82598 does not have this limit, we don't want long TX chain.
    195  * 33 should be large enough even for 64K TSO
    196  * (32 * 2K mbuf cluster and 1 x mbuf header).
    197  *
    198  * Reference: 82599-X550 datasheet 7.2.1.1 "Transmit Storage in System Memory".
    199  */
    200 #define IXGBE_82599_SCATTER_MAX	(40 - IXGBE_TX_WTHRESH - 2)
    201 #define IXGBE_SCATTER_DEFAULT	33
    202 
    203 /* Defines for printing debug information */
    204 #define DEBUG_INIT  0
    205 #define DEBUG_IOCTL 0
    206 #define DEBUG_HW    0
    207 
    208 #define INIT_DEBUGOUT(S)            if (DEBUG_INIT)  printf(S "\n")
    209 #define INIT_DEBUGOUT1(S, A)        if (DEBUG_INIT)  printf(S "\n", A)
    210 #define INIT_DEBUGOUT2(S, A, B)     if (DEBUG_INIT)  printf(S "\n", A, B)
    211 #define IOCTL_DEBUGOUT(S)           if (DEBUG_IOCTL) printf(S "\n")
    212 #define IOCTL_DEBUGOUT1(S, A)       if (DEBUG_IOCTL) printf(S "\n", A)
    213 #define IOCTL_DEBUGOUT2(S, A, B)    if (DEBUG_IOCTL) printf(S "\n", A, B)
    214 #define HW_DEBUGOUT(S)              if (DEBUG_HW) printf(S "\n")
    215 #define HW_DEBUGOUT1(S, A)          if (DEBUG_HW) printf(S "\n", A)
    216 #define HW_DEBUGOUT2(S, A, B)       if (DEBUG_HW) printf(S "\n", A, B)
    217 
    218 #define MAX_NUM_MULTICAST_ADDRESSES     128
    219 #define MSIX_82598_BAR                  3
    220 #define MSIX_82599_BAR                  4
    221 #define IXGBE_TSO_SIZE                  262140
    222 #define IXGBE_RX_HDR                    128
    223 #define IXGBE_VFTA_SIZE                 128
    224 #define IXGBE_BR_SIZE                   2048
    225 #define IXGBE_QUEUE_MIN_FREE            32
    226 #define IXGBE_MAX_TX_BUSY               10
    227 #define IXGBE_QUEUE_HUNG                0x80000000
    228 
    229 #define IXGBE_EITR_DEFAULT		128
    230 
    231 /* IOCTL define to gather SFP+ Diagnostic data */
    232 #define SIOCGI2C	SIOCGIFGENERIC
    233 
    234 /* Offload bits in mbuf flag */
    235 #define	M_CSUM_OFFLOAD	\
    236     (M_CSUM_IPv4|M_CSUM_UDPv4|M_CSUM_TCPv4|M_CSUM_UDPv6|M_CSUM_TCPv6)
    237 
    238 /* Backward compatibility items for very old versions */
    239 #ifndef pci_find_cap
    240 #define pci_find_cap pci_find_extcap
    241 #endif
    242 
    243 #ifndef DEVMETHOD_END
    244 #define DEVMETHOD_END { NULL, NULL }
    245 #endif
    246 
    247 /*
    248  * Interrupt Moderation parameters
    249  */
    250 #define IXGBE_LOW_LATENCY	128
    251 #define IXGBE_AVE_LATENCY	400
    252 #define IXGBE_BULK_LATENCY	1200
    253 
    254 /* Using 1FF (the max value), the interval is ~1.05ms */
    255 #define IXGBE_LINK_ITR_QUANTA  0x1FF
    256 #define IXGBE_LINK_ITR         ((IXGBE_LINK_ITR_QUANTA << 3) & \
    257                                 IXGBE_EITR_ITR_INT_MASK)
    258 
    259 
    260 /************************************************************************
    261  * vendor_info_array
    262  *
    263  *   Contains the list of Subvendor/Subdevice IDs on
    264  *   which the driver should load.
    265  ************************************************************************/
    266 typedef struct _ixgbe_vendor_info_t {
    267 	unsigned int vendor_id;
    268 	unsigned int device_id;
    269 	unsigned int subvendor_id;
    270 	unsigned int subdevice_id;
    271 	unsigned int index;
    272 } ixgbe_vendor_info_t;
    273 
    274 /* This is used to get SFP+ module data */
    275 struct ixgbe_i2c_req {
    276 	u8 dev_addr;
    277 	u8 offset;
    278 	u8 len;
    279 	u8 data[8];
    280 };
    281 
    282 struct ixgbe_bp_data {
    283 	u32 low;
    284 	u32 high;
    285 	u32 log;
    286 };
    287 
    288 struct ixgbe_tx_buf {
    289 	union ixgbe_adv_tx_desc	*eop;
    290 	struct mbuf             *m_head;
    291 	bus_dmamap_t            map;
    292 };
    293 
    294 struct ixgbe_rx_buf {
    295 	struct mbuf    *buf;
    296 	struct mbuf    *fmp;
    297 	bus_dmamap_t   pmap;
    298 	u_int          flags;
    299 #define IXGBE_RX_COPY  0x01
    300 	uint64_t       addr;
    301 };
    302 
    303 /*
    304  * Bus dma allocation structure used by ixgbe_dma_malloc and ixgbe_dma_free
    305  */
    306 struct ixgbe_dma_alloc {
    307 	bus_addr_t        dma_paddr;
    308 	void              *dma_vaddr;
    309 	ixgbe_dma_tag_t   *dma_tag;
    310 	bus_dmamap_t      dma_map;
    311 	bus_dma_segment_t dma_seg;
    312 	bus_size_t        dma_size;
    313 };
    314 
    315 struct ixgbe_mc_addr {
    316 	u8  addr[IXGBE_ETH_LENGTH_OF_ADDRESS];
    317 	u32 vmdq;
    318 };
    319 
    320 /*
    321  * Driver queue struct: this is the interrupt container
    322  *                      for the associated tx and rx ring.
    323  */
    324 struct ix_queue {
    325 	struct ixgbe_softc *sc;
    326 	u32              msix;           /* This queue's MSI-X vector */
    327 	u32              eitr_setting;
    328 	u32              me;
    329 	struct resource  *res;
    330 	int              busy;
    331 	struct tx_ring   *txr;
    332 	struct rx_ring   *rxr;
    333 	struct work      wq_cookie;
    334 	void             *que_si;
    335 	/* Per queue event conters */
    336 	struct evcnt     irqs;		/* Hardware interrupt */
    337 	struct evcnt     handleq;	/* software_interrupt */
    338 	struct evcnt     req;		/* deferred */
    339 	char             namebuf[32];	/* Name for sysctl */
    340 	char             evnamebuf[32];	/* Name for evcnt */
    341 
    342 	/* Lock for disabled_count and this queue's EIMS/EIMC bit */
    343 	kmutex_t         dc_mtx;
    344 	/*
    345 	 * disabled_count means:
    346 	 *     0   : this queue is enabled
    347 	 *     > 0 : this queue is disabled
    348 	 *           the value is ixgbe_disable_queue() called count
    349 	 */
    350 	int              disabled_count;
    351 	bool             txrx_use_workqueue;
    352 };
    353 
    354 /*
    355  * The transmit ring, one per queue
    356  */
    357 struct tx_ring {
    358 	struct ixgbe_softc	*sc;
    359 	kmutex_t		tx_mtx;
    360 	u32			me;
    361 	u32			tail;
    362 	int			busy;
    363 	union ixgbe_adv_tx_desc	*tx_base;
    364 	struct ixgbe_tx_buf	*tx_buffers;
    365 	struct ixgbe_dma_alloc	txdma;
    366 	volatile u16		tx_avail;
    367 	u16			next_avail_desc;
    368 	u16			next_to_clean;
    369 	u16			num_desc;
    370 	ixgbe_dma_tag_t		*txtag;
    371 #if 0
    372 	char			mtx_name[16]; /* NetBSD has no mutex name */
    373 #endif
    374 	pcq_t			*txr_interq;
    375 	struct work		wq_cookie;
    376 	void			*txr_si;
    377 	bool			txr_no_space; /* Like IFF_OACTIVE */
    378 
    379 	/* Flow Director */
    380 	u16			atr_sample;
    381 	u16			atr_count;
    382 
    383 	u64			bytes;  /* Used for AIM */
    384 	u64			packets;
    385 	/* Soft Stats */
    386 	struct evcnt		total_packets;
    387 	struct evcnt		pcq_drops;
    388 	struct evcnt		no_desc_avail;
    389 	struct evcnt		tso_tx;
    390 	/* Per queue conters.  The adapter total is in struct adapter */
    391 	u64              q_efbig_tx_dma_setup;
    392 	u64              q_mbuf_defrag_failed;
    393 	u64              q_efbig2_tx_dma_setup;
    394 	u64              q_einval_tx_dma_setup;
    395 	u64              q_other_tx_dma_setup;
    396 	u64              q_eagain_tx_dma_setup;
    397 	u64              q_enomem_tx_dma_setup;
    398 	u64              q_tso_err;
    399 };
    400 
    401 
    402 /*
    403  * The Receive ring, one per rx queue
    404  */
    405 struct rx_ring {
    406 	struct ixgbe_softc	*sc;
    407 	kmutex_t		rx_mtx;
    408 	u32			me;
    409 	u32			tail;
    410 	union ixgbe_adv_rx_desc	*rx_base;
    411 	struct ixgbe_dma_alloc	rxdma;
    412 #ifdef LRO
    413 	struct lro_ctrl		lro;
    414 #endif /* LRO */
    415 	bool			lro_enabled;
    416 	bool			hw_rsc;
    417 	bool			vtag_strip;
    418 	bool			discard_multidesc;
    419 	u16			next_to_refresh;
    420 	u16			next_to_check;
    421 	u16			num_desc;
    422 	u16			mbuf_sz;
    423 #if 0
    424 	char			mtx_name[16]; /* NetBSD has no mutex name */
    425 #endif
    426 	struct ixgbe_rx_buf	*rx_buffers;
    427 	ixgbe_dma_tag_t		*ptag;
    428 
    429 	u64			bytes; /* Used for AIM calc */
    430 	u64			packets;
    431 
    432 	/* Soft stats */
    433 	struct evcnt		rx_copies;
    434 	struct evcnt		rx_packets;
    435 	struct evcnt		rx_bytes;
    436 	struct evcnt		rx_discarded;
    437 	struct evcnt		no_mbuf;
    438 	u64			rsc_num;
    439 
    440 	/* Flow Director */
    441 	u64			flm;
    442 };
    443 
    444 struct ixgbe_vf {
    445 	u_int    pool;
    446 	u_int    rar_index;
    447 	u_int    max_frame_size;
    448 	uint32_t flags;
    449 	uint8_t  ether_addr[ETHER_ADDR_LEN];
    450 	uint16_t mc_hash[IXGBE_MAX_VF_MC];
    451 	uint16_t num_mc_hashes;
    452 	uint16_t default_vlan;
    453 	uint16_t vlan_tag;
    454 	uint16_t api_ver;
    455 };
    456 
    457 /*
    458  * NetBSD: For trafic class
    459  * Crrently, the following structure is only for statistics.
    460  */
    461 struct ixgbe_tc {
    462 	char             evnamebuf[32];
    463 };
    464 
    465 /* Our adapter structure */
    466 struct ixgbe_softc {
    467 	struct ixgbe_hw		hw;
    468 	struct ixgbe_osdep	osdep;
    469 
    470 	device_t		dev;
    471 	struct ifnet		*ifp;
    472 	struct if_percpuq	*ipq;	/* softint-based input queues */
    473 
    474 	struct resource		*pci_mem;
    475 
    476 	/* NetBSD: Interrupt resources are in osdep */
    477 
    478 	struct ifmedia		media;
    479 	callout_t		timer;
    480 	struct workqueue	*timer_wq;
    481 	struct work		timer_wc;
    482 	u_int			timer_pending;
    483 
    484 	u_short			if_flags;	/* saved ifp->if_flags */
    485 	int			ec_capenable;	/* saved ec->ec_capenable */
    486 
    487 	kmutex_t		core_mtx;
    488 
    489 	unsigned int		num_queues;
    490 
    491 	/*
    492 	 * Shadow VFTA table, this is needed because
    493 	 * the real vlan filter table gets cleared during
    494 	 * a soft reset and the driver needs to be able
    495 	 * to repopulate it.
    496 	 */
    497 	u32			shadow_vfta[IXGBE_VFTA_SIZE];
    498 
    499 	/* Info about the interface */
    500 	int			advertise;  /* link speeds */
    501 	bool			enable_aim; /* adaptive interrupt moderation */
    502 	int			max_interrupt_rate;
    503 	int			link_active; /* Use LINK_STATE_* value */
    504 	u16			max_frame_size;
    505 	u16			num_segs;
    506 	u32			link_speed;
    507 	bool			link_up;
    508 	bool                    link_enabled;
    509 	u32			vector;
    510 	u16			dmac;
    511 	u32			phy_layer;
    512 
    513 	/* Power management-related */
    514 	bool			wol_support;
    515 	u32			wufc;
    516 
    517 	/* Mbuf cluster size */
    518 	u32			rx_mbuf_sz;
    519 
    520 	bool			schedule_wqs_ok;
    521 
    522 	/* Flow Director */
    523 	int			fdir_reinit;
    524 
    525 	/* Admin task */
    526 	struct workqueue	*admin_wq; /* Link, SFP, PHY and FDIR */
    527 	struct work		admin_wc;
    528 	u_int			admin_pending;
    529 	volatile u32		task_requests;
    530 	kmutex_t		admin_mtx; /* lock for admin_pending, task_request */
    531 					   /*
    532 					    * Don't acquire this mutex while
    533 					    * holding rx_mtx or tx_mtx, and
    534 					    * vice versa.
    535 					    */
    536 
    537 	bool			txrx_use_workqueue;
    538 
    539 	/*
    540 	 * Workqueue for ixgbe_handle_que_work().
    541 	 *
    542 	 * que_wq's "enqueued flag" is not required, because twice
    543 	 * workqueue_enqueue() for ixgbe_handle_que_work() is avoided by
    544 	 * masking the queue's interrupt by EIMC. See also ixgbe_msix_que().
    545 	 */
    546 	struct workqueue	*que_wq;
    547 	/* Workqueue for ixgbe_deferred_mq_start_work() */
    548 	struct workqueue	*txr_wq;
    549 	percpu_t		*txr_wq_enqueued;
    550 
    551 	/*
    552 	 * Queues:
    553 	 *   This is the irq holder, it has
    554 	 *   and RX/TX pair or rings associated
    555 	 *   with it.
    556 	 */
    557 	struct ix_queue		*queues;
    558 
    559 	/*
    560 	 * Transmit rings
    561 	 *      Allocated at run time, an array of rings
    562 	 */
    563 	struct tx_ring		*tx_rings;
    564 	u32			num_tx_desc;
    565 	u32			tx_process_limit;
    566 
    567 	/*
    568 	 * Receive rings
    569 	 *      Allocated at run time, an array of rings
    570 	 */
    571 	struct rx_ring		*rx_rings;
    572 	u64			active_queues;
    573 	u32			num_rx_desc;
    574 	u32			rx_process_limit;
    575 	u32			rx_copy_len;
    576 
    577 	/* Multicast array memory */
    578 	struct ixgbe_mc_addr	*mta;
    579 
    580 	/* SR-IOV */
    581 	int                     iov_mode;
    582 	int			num_vfs;
    583 	int			pool;
    584 	struct ixgbe_vf		*vfs;
    585 
    586 	/* Bypass */
    587 	struct ixgbe_bp_data    bypass;
    588 
    589 	/* Netmap */
    590 	void			(*init_locked)(struct ixgbe_softc *);
    591 	void			(*stop_locked)(void *);
    592 
    593 	/* Firmware error check */
    594 	u_int                   recovery_mode;
    595 	callout_t               recovery_mode_timer;
    596 	struct workqueue        *recovery_mode_timer_wq;
    597 	struct work             recovery_mode_timer_wc;
    598 	u_int			recovery_mode_timer_pending;
    599 
    600 	/* Misc stats maintained by the driver */
    601 	struct evcnt		efbig_tx_dma_setup;
    602 	struct evcnt		mbuf_defrag_failed;
    603 	struct evcnt		efbig2_tx_dma_setup;
    604 	struct evcnt		einval_tx_dma_setup;
    605 	struct evcnt		other_tx_dma_setup;
    606 	struct evcnt		eagain_tx_dma_setup;
    607 	struct evcnt		enomem_tx_dma_setup;
    608 	struct evcnt		tso_err;
    609 	struct evcnt		watchdog_events;
    610 	struct evcnt		admin_irqev;
    611 	struct evcnt		link_workev;
    612 	struct evcnt		mod_workev;
    613 	struct evcnt		msf_workev;
    614 	struct evcnt		phy_workev;
    615 
    616 	union {
    617 		struct ixgbe_hw_stats pf;
    618 		struct ixgbevf_hw_stats	vf;
    619 	} stats;
    620 #if __FreeBSD_version >= 1100036
    621 	/* counter(9) stats */
    622 	u64			ipackets;
    623 	u64			ierrors;
    624 	u64			opackets;
    625 	u64			oerrors;
    626 	u64			ibytes;
    627 	u64			obytes;
    628 	u64			imcasts;
    629 	u64			omcasts;
    630 	u64			iqdrops;
    631 	u64			noproto;
    632 #endif
    633 	/* Feature capable/enabled flags.  See ixgbe_features.h */
    634 	u32                     feat_cap;
    635 	u32                     feat_en;
    636 
    637 	/* Traffic classes */
    638 	struct ixgbe_tc tcs[IXGBE_DCB_MAX_TRAFFIC_CLASS];
    639 
    640 	struct sysctllog	*sysctllog;
    641 	const struct sysctlnode *sysctltop;
    642 	struct timeval		lasterr_time;
    643 };
    644 
    645 /* Precision Time Sync (IEEE 1588) defines */
    646 #define ETHERTYPE_IEEE1588      0x88F7
    647 #define PICOSECS_PER_TICK       20833
    648 #define TSYNC_UDP_PORT          319 /* UDP port for the protocol */
    649 #define IXGBE_ADVTXD_TSTAMP     0x00080000
    650 
    651 
    652 #define IXGBE_CORE_LOCK_INIT(_sc, _name) \
    653 	mutex_init(&(_sc)->core_mtx, MUTEX_DEFAULT, IPL_SOFTNET)
    654 #define IXGBE_CORE_LOCK_DESTROY(_sc)      mutex_destroy(&(_sc)->core_mtx)
    655 #define IXGBE_TX_LOCK_DESTROY(_sc)        mutex_destroy(&(_sc)->tx_mtx)
    656 #define IXGBE_RX_LOCK_DESTROY(_sc)        mutex_destroy(&(_sc)->rx_mtx)
    657 #define IXGBE_CORE_LOCK(_sc)              mutex_enter(&(_sc)->core_mtx)
    658 #define IXGBE_TX_LOCK(_sc)                mutex_enter(&(_sc)->tx_mtx)
    659 #define IXGBE_TX_TRYLOCK(_sc)             mutex_tryenter(&(_sc)->tx_mtx)
    660 #define IXGBE_RX_LOCK(_sc)                mutex_enter(&(_sc)->rx_mtx)
    661 #define IXGBE_CORE_UNLOCK(_sc)            mutex_exit(&(_sc)->core_mtx)
    662 #define IXGBE_TX_UNLOCK(_sc)              mutex_exit(&(_sc)->tx_mtx)
    663 #define IXGBE_RX_UNLOCK(_sc)              mutex_exit(&(_sc)->rx_mtx)
    664 #define IXGBE_CORE_LOCK_ASSERT(_sc)       KASSERT(mutex_owned(&(_sc)->core_mtx))
    665 #define IXGBE_TX_LOCK_ASSERT(_sc)         KASSERT(mutex_owned(&(_sc)->tx_mtx))
    666 
    667 /* External PHY register addresses */
    668 #define IXGBE_PHY_CURRENT_TEMP		0xC820
    669 #define IXGBE_PHY_OVERTEMP_STATUS	0xC830
    670 
    671 /* Sysctl help messages; displayed with sysctl -d */
    672 #define IXGBE_SYSCTL_DESC_ADV_SPEED \
    673 	"\nControl advertised link speed using these flags:\n" \
    674 	"\t0x1  - advertise 100M\n" \
    675 	"\t0x2  - advertise 1G\n" \
    676 	"\t0x4  - advertise 10G\n" \
    677 	"\t0x8  - advertise 10M\n" \
    678 	"\t0x10 - advertise 2.5G\n" \
    679 	"\t0x20 - advertise 5G\n\n" \
    680 	"\t5G, 2.5G, 100M and 10M are only supported on certain adapters."
    681 
    682 #define IXGBE_SYSCTL_DESC_SET_FC \
    683 	"\nSet flow control mode using these values:\n" \
    684 	"\t0 - off\n" \
    685 	"\t1 - rx pause\n" \
    686 	"\t2 - tx pause\n" \
    687 	"\t3 - tx and rx pause"
    688 
    689 /*
    690  * Find the number of unrefreshed RX descriptors
    691  */
    692 static __inline u16
    693 ixgbe_rx_unrefreshed(struct rx_ring *rxr)
    694 {
    695 	if (rxr->next_to_check > rxr->next_to_refresh)
    696 		return (rxr->next_to_check - rxr->next_to_refresh - 1);
    697 	else
    698 		return ((rxr->num_desc + rxr->next_to_check) -
    699 		    rxr->next_to_refresh - 1);
    700 }
    701 
    702 static __inline int
    703 ixgbe_legacy_ring_empty(struct ifnet *ifp, pcq_t *dummy)
    704 {
    705 	UNREFERENCED_1PARAMETER(dummy);
    706 
    707 	return IFQ_IS_EMPTY(&ifp->if_snd);
    708 }
    709 
    710 static __inline int
    711 ixgbe_mq_ring_empty(struct ifnet *dummy, pcq_t *interq)
    712 {
    713 	UNREFERENCED_1PARAMETER(dummy);
    714 
    715 	return (pcq_peek(interq) == NULL);
    716 }
    717 
    718 /*
    719  * This checks for a zero mac addr, something that will be likely
    720  * unless the Admin on the Host has created one.
    721  */
    722 static __inline bool
    723 ixv_check_ether_addr(u8 *addr)
    724 {
    725 	bool status = TRUE;
    726 
    727 	if ((addr[0] == 0 && addr[1]== 0 && addr[2] == 0 &&
    728 	    addr[3] == 0 && addr[4]== 0 && addr[5] == 0))
    729 		status = FALSE;
    730 
    731 	return (status);
    732 }
    733 
    734 /*
    735  * This checks the sc->recovery_mode software flag which is
    736  * set by ixgbe_fw_recovery_mode().
    737  *
    738  */
    739 static inline bool
    740 ixgbe_fw_recovery_mode_swflag(struct ixgbe_softc *sc)
    741 {
    742 	return (sc->feat_en & IXGBE_FEATURE_RECOVERY_MODE) &&
    743 	    atomic_load_acq_uint(&sc->recovery_mode);
    744 }
    745 
    746 /* Shared Prototypes */
    747 void ixgbe_legacy_start(struct ifnet *);
    748 int  ixgbe_legacy_start_locked(struct ifnet *, struct tx_ring *);
    749 int  ixgbe_mq_start(struct ifnet *, struct mbuf *);
    750 int  ixgbe_mq_start_locked(struct ifnet *, struct tx_ring *);
    751 void ixgbe_deferred_mq_start(void *);
    752 void ixgbe_deferred_mq_start_work(struct work *, void *);
    753 void ixgbe_drain_all(struct ixgbe_softc *);
    754 
    755 int  ixgbe_allocate_queues(struct ixgbe_softc *);
    756 void ixgbe_free_queues(struct ixgbe_softc *);
    757 int  ixgbe_setup_transmit_structures(struct ixgbe_softc *);
    758 void ixgbe_free_transmit_structures(struct ixgbe_softc *);
    759 int  ixgbe_setup_receive_structures(struct ixgbe_softc *);
    760 void ixgbe_free_receive_structures(struct ixgbe_softc *);
    761 bool ixgbe_txeof(struct tx_ring *);
    762 bool ixgbe_rxeof(struct ix_queue *);
    763 
    764 #define IXGBE_REQUEST_TASK_MOD		0x01
    765 #define IXGBE_REQUEST_TASK_MOD_WOI	0x02
    766 #define IXGBE_REQUEST_TASK_MSF		0x04
    767 #define IXGBE_REQUEST_TASK_MSF_WOI	0x08
    768 #define IXGBE_REQUEST_TASK_MBX		0x10
    769 #define IXGBE_REQUEST_TASK_FDIR		0x20
    770 #define IXGBE_REQUEST_TASK_PHY		0x40
    771 #define IXGBE_REQUEST_TASK_LSC		0x80
    772 
    773 /* For NetBSD */
    774 const struct sysctlnode *ixgbe_sysctl_instance(struct ixgbe_softc *);
    775 
    776 #include "ixgbe_bypass.h"
    777 #include "ixgbe_fdir.h"
    778 #include "ixgbe_rss.h"
    779 #include "ixgbe_netmap.h"
    780 
    781 #endif /* _IXGBE_H_ */
    782