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