xref: /freebsd/sys/dev/ixl/ixl.h (revision a48d00d27617b9641c70900bcda4309e16f0ddb5)
161ae650dSJack F Vogel /******************************************************************************
261ae650dSJack F Vogel 
3b6c8f260SJack F Vogel   Copyright (c) 2013-2015, Intel Corporation
461ae650dSJack F Vogel   All rights reserved.
561ae650dSJack F Vogel 
661ae650dSJack F Vogel   Redistribution and use in source and binary forms, with or without
761ae650dSJack F Vogel   modification, are permitted provided that the following conditions are met:
861ae650dSJack F Vogel 
961ae650dSJack F Vogel    1. Redistributions of source code must retain the above copyright notice,
1061ae650dSJack F Vogel       this list of conditions and the following disclaimer.
1161ae650dSJack F Vogel 
1261ae650dSJack F Vogel    2. Redistributions in binary form must reproduce the above copyright
1361ae650dSJack F Vogel       notice, this list of conditions and the following disclaimer in the
1461ae650dSJack F Vogel       documentation and/or other materials provided with the distribution.
1561ae650dSJack F Vogel 
1661ae650dSJack F Vogel    3. Neither the name of the Intel Corporation nor the names of its
1761ae650dSJack F Vogel       contributors may be used to endorse or promote products derived from
1861ae650dSJack F Vogel       this software without specific prior written permission.
1961ae650dSJack F Vogel 
2061ae650dSJack F Vogel   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
2161ae650dSJack F Vogel   AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
2261ae650dSJack F Vogel   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
2361ae650dSJack F Vogel   ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
2461ae650dSJack F Vogel   LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
2561ae650dSJack F Vogel   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
2661ae650dSJack F Vogel   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
2761ae650dSJack F Vogel   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
2861ae650dSJack F Vogel   CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
2961ae650dSJack F Vogel   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
3061ae650dSJack F Vogel   POSSIBILITY OF SUCH DAMAGE.
3161ae650dSJack F Vogel 
3261ae650dSJack F Vogel ******************************************************************************/
3361ae650dSJack F Vogel /*$FreeBSD$*/
3461ae650dSJack F Vogel 
3561ae650dSJack F Vogel 
3661ae650dSJack F Vogel #ifndef _IXL_H_
3761ae650dSJack F Vogel #define _IXL_H_
3861ae650dSJack F Vogel 
3961ae650dSJack F Vogel 
4061ae650dSJack F Vogel #include <sys/param.h>
4161ae650dSJack F Vogel #include <sys/systm.h>
4261ae650dSJack F Vogel #include <sys/buf_ring.h>
4361ae650dSJack F Vogel #include <sys/mbuf.h>
4461ae650dSJack F Vogel #include <sys/protosw.h>
4561ae650dSJack F Vogel #include <sys/socket.h>
4661ae650dSJack F Vogel #include <sys/malloc.h>
4761ae650dSJack F Vogel #include <sys/kernel.h>
4861ae650dSJack F Vogel #include <sys/module.h>
4961ae650dSJack F Vogel #include <sys/sockio.h>
5013b40804SSteven Hartland #include <sys/eventhandler.h>
5161ae650dSJack F Vogel 
5261ae650dSJack F Vogel #include <net/if.h>
5313b40804SSteven Hartland #include <net/if_var.h>
5461ae650dSJack F Vogel #include <net/if_arp.h>
5561ae650dSJack F Vogel #include <net/bpf.h>
5661ae650dSJack F Vogel #include <net/ethernet.h>
5761ae650dSJack F Vogel #include <net/if_dl.h>
5861ae650dSJack F Vogel #include <net/if_media.h>
5961ae650dSJack F Vogel 
6061ae650dSJack F Vogel #include <net/bpf.h>
6161ae650dSJack F Vogel #include <net/if_types.h>
6261ae650dSJack F Vogel #include <net/if_vlan_var.h>
6361ae650dSJack F Vogel 
6461ae650dSJack F Vogel #include <netinet/in_systm.h>
6561ae650dSJack F Vogel #include <netinet/in.h>
6661ae650dSJack F Vogel #include <netinet/if_ether.h>
6761ae650dSJack F Vogel #include <netinet/ip.h>
6861ae650dSJack F Vogel #include <netinet/ip6.h>
6961ae650dSJack F Vogel #include <netinet/tcp.h>
7061ae650dSJack F Vogel #include <netinet/tcp_lro.h>
7161ae650dSJack F Vogel #include <netinet/udp.h>
7261ae650dSJack F Vogel #include <netinet/sctp.h>
7361ae650dSJack F Vogel 
7461ae650dSJack F Vogel #include <machine/in_cksum.h>
7561ae650dSJack F Vogel 
7661ae650dSJack F Vogel #include <sys/bus.h>
7761ae650dSJack F Vogel #include <machine/bus.h>
7861ae650dSJack F Vogel #include <sys/rman.h>
7961ae650dSJack F Vogel #include <machine/resource.h>
8061ae650dSJack F Vogel #include <vm/vm.h>
8161ae650dSJack F Vogel #include <vm/pmap.h>
8261ae650dSJack F Vogel #include <machine/clock.h>
8361ae650dSJack F Vogel #include <dev/pci/pcivar.h>
8461ae650dSJack F Vogel #include <dev/pci/pcireg.h>
8561ae650dSJack F Vogel #include <sys/proc.h>
8661ae650dSJack F Vogel #include <sys/sysctl.h>
8761ae650dSJack F Vogel #include <sys/endian.h>
8861ae650dSJack F Vogel #include <sys/taskqueue.h>
8961ae650dSJack F Vogel #include <sys/pcpu.h>
9061ae650dSJack F Vogel #include <sys/smp.h>
9161ae650dSJack F Vogel #include <machine/smp.h>
9261ae650dSJack F Vogel 
9356c2c47bSJack F Vogel #ifdef PCI_IOV
9456c2c47bSJack F Vogel #include <sys/nv.h>
9556c2c47bSJack F Vogel #include <sys/iov_schema.h>
96*a48d00d2SEric Joyner #include <dev/pci/pci_iov.h>
9756c2c47bSJack F Vogel #endif
9856c2c47bSJack F Vogel 
9961ae650dSJack F Vogel #include "i40e_type.h"
10061ae650dSJack F Vogel #include "i40e_prototype.h"
10161ae650dSJack F Vogel 
102393c4bb1SJack F Vogel #if defined(IXL_DEBUG) || defined(IXL_DEBUG_SYSCTL)
10361ae650dSJack F Vogel #include <sys/sbuf.h>
10461ae650dSJack F Vogel 
10561ae650dSJack F Vogel #define MAC_FORMAT "%02x:%02x:%02x:%02x:%02x:%02x"
10661ae650dSJack F Vogel #define MAC_FORMAT_ARGS(mac_addr) \
10761ae650dSJack F Vogel 	(mac_addr)[0], (mac_addr)[1], (mac_addr)[2], (mac_addr)[3], \
10861ae650dSJack F Vogel 	(mac_addr)[4], (mac_addr)[5]
10961ae650dSJack F Vogel #define ON_OFF_STR(is_set) ((is_set) ? "On" : "Off")
110393c4bb1SJack F Vogel #endif /* IXL_DEBUG || IXL_DEBUG_SYSCTL */
11161ae650dSJack F Vogel 
112393c4bb1SJack F Vogel #ifdef IXL_DEBUG
113393c4bb1SJack F Vogel /* Enable debug sysctls */
114393c4bb1SJack F Vogel #ifndef IXL_DEBUG_SYSCTL
115393c4bb1SJack F Vogel #define IXL_DEBUG_SYSCTL 1
116393c4bb1SJack F Vogel #endif
11761ae650dSJack F Vogel 
11861ae650dSJack F Vogel #define _DBG_PRINTF(S, ...)		printf("%s: " S "\n", __func__, ##__VA_ARGS__)
11961ae650dSJack F Vogel #define _DEV_DBG_PRINTF(dev, S, ...)	device_printf(dev, "%s: " S "\n", __func__, ##__VA_ARGS__)
12061ae650dSJack F Vogel #define _IF_DBG_PRINTF(ifp, S, ...)	if_printf(ifp, "%s: " S "\n", __func__, ##__VA_ARGS__)
12161ae650dSJack F Vogel 
12261ae650dSJack F Vogel /* Defines for printing generic debug information */
12361ae650dSJack F Vogel #define DPRINTF(...)			_DBG_PRINTF(__VA_ARGS__)
12461ae650dSJack F Vogel #define DDPRINTF(...)			_DEV_DBG_PRINTF(__VA_ARGS__)
12561ae650dSJack F Vogel #define IDPRINTF(...)			_IF_DBG_PRINTF(__VA_ARGS__)
12661ae650dSJack F Vogel 
12761ae650dSJack F Vogel /* Defines for printing specific debug information */
12861ae650dSJack F Vogel #define DEBUG_INIT  1
12961ae650dSJack F Vogel #define DEBUG_IOCTL 1
13061ae650dSJack F Vogel #define DEBUG_HW    1
13161ae650dSJack F Vogel 
13261ae650dSJack F Vogel #define INIT_DEBUGOUT(...)		if (DEBUG_INIT) _DBG_PRINTF(__VA_ARGS__)
13361ae650dSJack F Vogel #define INIT_DBG_DEV(...)		if (DEBUG_INIT) _DEV_DBG_PRINTF(__VA_ARGS__)
13461ae650dSJack F Vogel #define INIT_DBG_IF(...)		if (DEBUG_INIT) _IF_DBG_PRINTF(__VA_ARGS__)
13561ae650dSJack F Vogel 
13661ae650dSJack F Vogel #define IOCTL_DEBUGOUT(...)		if (DEBUG_IOCTL) _DBG_PRINTF(__VA_ARGS__)
13761ae650dSJack F Vogel #define IOCTL_DBG_IF2(ifp, S, ...)	if (DEBUG_IOCTL) \
13861ae650dSJack F Vogel 					    if_printf(ifp, S "\n", ##__VA_ARGS__)
13961ae650dSJack F Vogel #define IOCTL_DBG_IF(...)		if (DEBUG_IOCTL) _IF_DBG_PRINTF(__VA_ARGS__)
14061ae650dSJack F Vogel 
14161ae650dSJack F Vogel #define HW_DEBUGOUT(...)		if (DEBUG_HW) _DBG_PRINTF(__VA_ARGS__)
14261ae650dSJack F Vogel 
143393c4bb1SJack F Vogel #else /* no IXL_DEBUG */
14461ae650dSJack F Vogel #define DEBUG_INIT  0
14561ae650dSJack F Vogel #define DEBUG_IOCTL 0
14661ae650dSJack F Vogel #define DEBUG_HW    0
14761ae650dSJack F Vogel 
14861ae650dSJack F Vogel #define DPRINTF(...)
14961ae650dSJack F Vogel #define DDPRINTF(...)
15061ae650dSJack F Vogel #define IDPRINTF(...)
15161ae650dSJack F Vogel 
15261ae650dSJack F Vogel #define INIT_DEBUGOUT(...)
15361ae650dSJack F Vogel #define INIT_DBG_DEV(...)
15461ae650dSJack F Vogel #define INIT_DBG_IF(...)
15561ae650dSJack F Vogel #define IOCTL_DEBUGOUT(...)
15661ae650dSJack F Vogel #define IOCTL_DBG_IF2(...)
15761ae650dSJack F Vogel #define IOCTL_DBG_IF(...)
15861ae650dSJack F Vogel #define HW_DEBUGOUT(...)
159393c4bb1SJack F Vogel #endif /* IXL_DEBUG */
16061ae650dSJack F Vogel 
16161ae650dSJack F Vogel /* Tunables */
16261ae650dSJack F Vogel 
16361ae650dSJack F Vogel /*
16461ae650dSJack F Vogel  * Ring Descriptors Valid Range: 32-4096 Default Value: 1024 This value is the
16561ae650dSJack F Vogel  * number of tx/rx descriptors allocated by the driver. Increasing this
16661ae650dSJack F Vogel  * value allows the driver to queue more operations. Each descriptor is 16
16761ae650dSJack F Vogel  * or 32 bytes (configurable in FVL)
16861ae650dSJack F Vogel  */
16961ae650dSJack F Vogel #define DEFAULT_RING	1024
17061ae650dSJack F Vogel #define PERFORM_RING	2048
17161ae650dSJack F Vogel #define MAX_RING	4096
17261ae650dSJack F Vogel #define MIN_RING	32
17361ae650dSJack F Vogel 
17461ae650dSJack F Vogel /*
17561ae650dSJack F Vogel ** Default number of entries in Tx queue buf_ring.
17661ae650dSJack F Vogel */
177e5100ee2SJack F Vogel #define SMALL_TXBRSZ 4096
178e5100ee2SJack F Vogel /* This may require mbuf cluster tuning */
179e5100ee2SJack F Vogel #define DEFAULT_TXBRSZ (SMALL_TXBRSZ * SMALL_TXBRSZ)
18061ae650dSJack F Vogel 
18161ae650dSJack F Vogel /* Alignment for rings */
18261ae650dSJack F Vogel #define DBA_ALIGN	128
18361ae650dSJack F Vogel 
18461ae650dSJack F Vogel /*
18561ae650dSJack F Vogel  * This parameter controls the maximum no of times the driver will loop in
18661ae650dSJack F Vogel  * the isr. Minimum Value = 1
18761ae650dSJack F Vogel  */
18861ae650dSJack F Vogel #define MAX_LOOP	10
18961ae650dSJack F Vogel 
19061ae650dSJack F Vogel /*
19161ae650dSJack F Vogel  * This is the max watchdog interval, ie. the time that can
19261ae650dSJack F Vogel  * pass between any two TX clean operations, such only happening
19361ae650dSJack F Vogel  * when the TX hardware is functioning.
19461ae650dSJack F Vogel  */
19561ae650dSJack F Vogel #define IXL_WATCHDOG                   (10 * hz)
19661ae650dSJack F Vogel 
19761ae650dSJack F Vogel /*
19861ae650dSJack F Vogel  * This parameters control when the driver calls the routine to reclaim
19961ae650dSJack F Vogel  * transmit descriptors.
20061ae650dSJack F Vogel  */
20161ae650dSJack F Vogel #define IXL_TX_CLEANUP_THRESHOLD	(que->num_desc / 8)
20261ae650dSJack F Vogel #define IXL_TX_OP_THRESHOLD		(que->num_desc / 32)
20361ae650dSJack F Vogel 
20461ae650dSJack F Vogel /* Flow control constants */
20561ae650dSJack F Vogel #define IXL_FC_PAUSE		0xFFFF
20661ae650dSJack F Vogel #define IXL_FC_HI		0x20000
20761ae650dSJack F Vogel #define IXL_FC_LO		0x10000
20861ae650dSJack F Vogel 
20961ae650dSJack F Vogel #define MAX_MULTICAST_ADDR	128
21061ae650dSJack F Vogel 
21161ae650dSJack F Vogel #define IXL_BAR			3
21261ae650dSJack F Vogel #define IXL_ADM_LIMIT		2
21361ae650dSJack F Vogel #define IXL_TSO_SIZE		65535
21461ae650dSJack F Vogel #define IXL_TX_BUF_SZ		((u32) 1514)
21561ae650dSJack F Vogel #define IXL_AQ_BUF_SZ		((u32) 4096)
21661ae650dSJack F Vogel #define IXL_RX_HDR		128
217b6c8f260SJack F Vogel /* Controls the length of the Admin Queue */
21861ae650dSJack F Vogel #define IXL_AQ_LEN		256
219b6c8f260SJack F Vogel #define IXL_AQ_LEN_MAX		1024
22061ae650dSJack F Vogel #define IXL_AQ_BUFSZ		4096
22161ae650dSJack F Vogel #define IXL_RX_LIMIT		512
22261ae650dSJack F Vogel #define IXL_RX_ITR		0
22361ae650dSJack F Vogel #define IXL_TX_ITR		1
22461ae650dSJack F Vogel #define IXL_ITR_NONE		3
22561ae650dSJack F Vogel #define IXL_QUEUE_EOL		0x7FF
22661ae650dSJack F Vogel #define IXL_MAX_FRAME		0x2600
22761ae650dSJack F Vogel #define IXL_MAX_TX_SEGS		8
22861ae650dSJack F Vogel #define IXL_MAX_TSO_SEGS	66
22961ae650dSJack F Vogel #define IXL_SPARSE_CHAIN	6
23061ae650dSJack F Vogel #define IXL_QUEUE_HUNG		0x80000000
231393c4bb1SJack F Vogel #define IXL_KEYSZ		10
23261ae650dSJack F Vogel 
23356c2c47bSJack F Vogel #define IXL_VF_MAX_BUFFER	0x3F80
23456c2c47bSJack F Vogel #define IXL_VF_MAX_HDR_BUFFER	0x840
23556c2c47bSJack F Vogel #define IXL_VF_MAX_FRAME	0x3FFF
23656c2c47bSJack F Vogel 
23761ae650dSJack F Vogel /* ERJ: hardware can support ~1.5k filters between all functions */
23861ae650dSJack F Vogel #define IXL_MAX_FILTERS	256
23961ae650dSJack F Vogel #define IXL_MAX_TX_BUSY	10
24061ae650dSJack F Vogel 
24161ae650dSJack F Vogel #define IXL_NVM_VERSION_LO_SHIFT	0
24261ae650dSJack F Vogel #define IXL_NVM_VERSION_LO_MASK		(0xff << IXL_NVM_VERSION_LO_SHIFT)
24361ae650dSJack F Vogel #define IXL_NVM_VERSION_HI_SHIFT	12
24461ae650dSJack F Vogel #define IXL_NVM_VERSION_HI_MASK		(0xf << IXL_NVM_VERSION_HI_SHIFT)
24561ae650dSJack F Vogel 
24661ae650dSJack F Vogel 
24761ae650dSJack F Vogel /*
24861ae650dSJack F Vogel  * Interrupt Moderation parameters
24961ae650dSJack F Vogel  */
25061ae650dSJack F Vogel #define IXL_MAX_ITR		0x07FF
25161ae650dSJack F Vogel #define IXL_ITR_100K		0x0005
25261ae650dSJack F Vogel #define IXL_ITR_20K		0x0019
25361ae650dSJack F Vogel #define IXL_ITR_8K		0x003E
25461ae650dSJack F Vogel #define IXL_ITR_4K		0x007A
25561ae650dSJack F Vogel #define IXL_ITR_DYNAMIC		0x8000
25661ae650dSJack F Vogel #define IXL_LOW_LATENCY		0
25761ae650dSJack F Vogel #define IXL_AVE_LATENCY		1
25861ae650dSJack F Vogel #define IXL_BULK_LATENCY	2
25961ae650dSJack F Vogel 
26061ae650dSJack F Vogel /* MacVlan Flags */
26161ae650dSJack F Vogel #define IXL_FILTER_USED		(u16)(1 << 0)
26261ae650dSJack F Vogel #define IXL_FILTER_VLAN		(u16)(1 << 1)
26361ae650dSJack F Vogel #define IXL_FILTER_ADD		(u16)(1 << 2)
26461ae650dSJack F Vogel #define IXL_FILTER_DEL		(u16)(1 << 3)
26561ae650dSJack F Vogel #define IXL_FILTER_MC		(u16)(1 << 4)
26661ae650dSJack F Vogel 
26761ae650dSJack F Vogel /* used in the vlan field of the filter when not a vlan */
26861ae650dSJack F Vogel #define IXL_VLAN_ANY		-1
26961ae650dSJack F Vogel 
27061ae650dSJack F Vogel #define CSUM_OFFLOAD_IPV4	(CSUM_IP|CSUM_TCP|CSUM_UDP|CSUM_SCTP)
27161ae650dSJack F Vogel #define CSUM_OFFLOAD_IPV6	(CSUM_TCP_IPV6|CSUM_UDP_IPV6|CSUM_SCTP_IPV6)
27261ae650dSJack F Vogel #define CSUM_OFFLOAD		(CSUM_OFFLOAD_IPV4|CSUM_OFFLOAD_IPV6|CSUM_TSO)
27361ae650dSJack F Vogel 
27461ae650dSJack F Vogel /* Misc flags for ixl_vsi.flags */
27561ae650dSJack F Vogel #define IXL_FLAGS_KEEP_TSO4	(1 << 0)
27661ae650dSJack F Vogel #define IXL_FLAGS_KEEP_TSO6	(1 << 1)
27761ae650dSJack F Vogel 
27856c2c47bSJack F Vogel #define IXL_VF_RESET_TIMEOUT	100
27956c2c47bSJack F Vogel 
28056c2c47bSJack F Vogel #define IXL_VSI_DATA_PORT	0x01
28156c2c47bSJack F Vogel 
28256c2c47bSJack F Vogel #define IXLV_MAX_QUEUES		16
28356c2c47bSJack F Vogel #define IXL_MAX_VSI_QUEUES	(2 * (I40E_VSILAN_QTABLE_MAX_INDEX + 1))
28456c2c47bSJack F Vogel 
28556c2c47bSJack F Vogel #define IXL_RX_CTX_BASE_UNITS	128
28656c2c47bSJack F Vogel #define IXL_TX_CTX_BASE_UNITS	128
28756c2c47bSJack F Vogel 
28856c2c47bSJack F Vogel #define IXL_VPINT_LNKLSTN_REG(hw, vector, vf_num) \
28956c2c47bSJack F Vogel 	I40E_VPINT_LNKLSTN(((vector) - 1) + \
29056c2c47bSJack F Vogel 	    (((hw)->func_caps.num_msix_vectors_vf - 1) * (vf_num)))
29156c2c47bSJack F Vogel 
29256c2c47bSJack F Vogel #define IXL_VFINT_DYN_CTLN_REG(hw, vector, vf_num) \
29356c2c47bSJack F Vogel 	I40E_VFINT_DYN_CTLN(((vector) - 1) + \
29456c2c47bSJack F Vogel 	    (((hw)->func_caps.num_msix_vectors_vf - 1) * (vf_num)))
29556c2c47bSJack F Vogel 
29656c2c47bSJack F Vogel #define IXL_PF_PCI_CIAA_VF_DEVICE_STATUS	0xAA
29756c2c47bSJack F Vogel 
29856c2c47bSJack F Vogel #define IXL_PF_PCI_CIAD_VF_TRANS_PENDING_MASK	0x20
29956c2c47bSJack F Vogel 
30056c2c47bSJack F Vogel #define IXL_GLGEN_VFLRSTAT_INDEX(glb_vf)	((glb_vf) / 32)
30156c2c47bSJack F Vogel #define IXL_GLGEN_VFLRSTAT_MASK(glb_vf)	(1 << ((glb_vf) % 32))
30256c2c47bSJack F Vogel 
30356c2c47bSJack F Vogel #define IXL_MAX_ITR_IDX		3
30456c2c47bSJack F Vogel 
30556c2c47bSJack F Vogel #define IXL_END_OF_INTR_LNKLST	0x7FF
30656c2c47bSJack F Vogel 
30761ae650dSJack F Vogel #define IXL_TX_LOCK(_sc)                mtx_lock(&(_sc)->mtx)
30861ae650dSJack F Vogel #define IXL_TX_UNLOCK(_sc)              mtx_unlock(&(_sc)->mtx)
30961ae650dSJack F Vogel #define IXL_TX_LOCK_DESTROY(_sc)        mtx_destroy(&(_sc)->mtx)
31061ae650dSJack F Vogel #define IXL_TX_TRYLOCK(_sc)             mtx_trylock(&(_sc)->mtx)
31161ae650dSJack F Vogel #define IXL_TX_LOCK_ASSERT(_sc)         mtx_assert(&(_sc)->mtx, MA_OWNED)
31261ae650dSJack F Vogel 
31361ae650dSJack F Vogel #define IXL_RX_LOCK(_sc)                mtx_lock(&(_sc)->mtx)
31461ae650dSJack F Vogel #define IXL_RX_UNLOCK(_sc)              mtx_unlock(&(_sc)->mtx)
31561ae650dSJack F Vogel #define IXL_RX_LOCK_DESTROY(_sc)        mtx_destroy(&(_sc)->mtx)
31661ae650dSJack F Vogel 
317*a48d00d2SEric Joyner /* Pre-11 counter(9) compatibility */
318b6c8f260SJack F Vogel #if __FreeBSD_version >= 1100036
3194b443922SGleb Smirnoff #define IXL_SET_IPACKETS(vsi, count)	(vsi)->ipackets = (count)
3204b443922SGleb Smirnoff #define IXL_SET_IERRORS(vsi, count)	(vsi)->ierrors = (count)
3214b443922SGleb Smirnoff #define IXL_SET_OPACKETS(vsi, count)	(vsi)->opackets = (count)
3224b443922SGleb Smirnoff #define IXL_SET_OERRORS(vsi, count)	(vsi)->oerrors = (count)
3234b443922SGleb Smirnoff #define IXL_SET_COLLISIONS(vsi, count)	/* Do nothing; collisions is always 0. */
3244b443922SGleb Smirnoff #define IXL_SET_IBYTES(vsi, count)	(vsi)->ibytes = (count)
3254b443922SGleb Smirnoff #define IXL_SET_OBYTES(vsi, count)	(vsi)->obytes = (count)
3264b443922SGleb Smirnoff #define IXL_SET_IMCASTS(vsi, count)	(vsi)->imcasts = (count)
3274b443922SGleb Smirnoff #define IXL_SET_OMCASTS(vsi, count)	(vsi)->omcasts = (count)
3284b443922SGleb Smirnoff #define IXL_SET_IQDROPS(vsi, count)	(vsi)->iqdrops = (count)
329625d12c6SJohn Baldwin #define IXL_SET_OQDROPS(vsi, count)	(vsi)->oqdrops = (count)
3304b443922SGleb Smirnoff #define IXL_SET_NOPROTO(vsi, count)	(vsi)->noproto = (count)
3314b443922SGleb Smirnoff #else
3324b443922SGleb Smirnoff #define IXL_SET_IPACKETS(vsi, count)	(vsi)->ifp->if_ipackets = (count)
3334b443922SGleb Smirnoff #define IXL_SET_IERRORS(vsi, count)	(vsi)->ifp->if_ierrors = (count)
3344b443922SGleb Smirnoff #define IXL_SET_OPACKETS(vsi, count)	(vsi)->ifp->if_opackets = (count)
3354b443922SGleb Smirnoff #define IXL_SET_OERRORS(vsi, count)	(vsi)->ifp->if_oerrors = (count)
3364b443922SGleb Smirnoff #define IXL_SET_COLLISIONS(vsi, count)	(vsi)->ifp->if_collisions = (count)
3374b443922SGleb Smirnoff #define IXL_SET_IBYTES(vsi, count)	(vsi)->ifp->if_ibytes = (count)
3384b443922SGleb Smirnoff #define IXL_SET_OBYTES(vsi, count)	(vsi)->ifp->if_obytes = (count)
3394b443922SGleb Smirnoff #define IXL_SET_IMCASTS(vsi, count)	(vsi)->ifp->if_imcasts = (count)
3404b443922SGleb Smirnoff #define IXL_SET_OMCASTS(vsi, count)	(vsi)->ifp->if_omcasts = (count)
3414b443922SGleb Smirnoff #define IXL_SET_IQDROPS(vsi, count)	(vsi)->ifp->if_iqdrops = (count)
3424b443922SGleb Smirnoff #define IXL_SET_OQDROPS(vsi, odrops)	(vsi)->ifp->if_snd.ifq_drops = (odrops)
3434b443922SGleb Smirnoff #define IXL_SET_NOPROTO(vsi, count)	(vsi)->noproto = (count)
3444b443922SGleb Smirnoff #endif
3454b443922SGleb Smirnoff 
34661ae650dSJack F Vogel /*
34761ae650dSJack F Vogel  *****************************************************************************
34861ae650dSJack F Vogel  * vendor_info_array
34961ae650dSJack F Vogel  *
35061ae650dSJack F Vogel  * This array contains the list of Subvendor/Subdevice IDs on which the driver
35161ae650dSJack F Vogel  * should load.
35261ae650dSJack F Vogel  *
35361ae650dSJack F Vogel  *****************************************************************************
35461ae650dSJack F Vogel  */
35561ae650dSJack F Vogel typedef struct _ixl_vendor_info_t {
35661ae650dSJack F Vogel 	unsigned int    vendor_id;
35761ae650dSJack F Vogel 	unsigned int    device_id;
35861ae650dSJack F Vogel 	unsigned int    subvendor_id;
35961ae650dSJack F Vogel 	unsigned int    subdevice_id;
36061ae650dSJack F Vogel 	unsigned int    index;
36161ae650dSJack F Vogel } ixl_vendor_info_t;
36261ae650dSJack F Vogel 
36361ae650dSJack F Vogel 
36461ae650dSJack F Vogel struct ixl_tx_buf {
36561ae650dSJack F Vogel 	u32		eop_index;
36661ae650dSJack F Vogel 	struct mbuf	*m_head;
36761ae650dSJack F Vogel 	bus_dmamap_t	map;
36861ae650dSJack F Vogel 	bus_dma_tag_t	tag;
36961ae650dSJack F Vogel };
37061ae650dSJack F Vogel 
37161ae650dSJack F Vogel struct ixl_rx_buf {
37261ae650dSJack F Vogel 	struct mbuf	*m_head;
37361ae650dSJack F Vogel 	struct mbuf	*m_pack;
37461ae650dSJack F Vogel 	struct mbuf	*fmp;
37561ae650dSJack F Vogel 	bus_dmamap_t	hmap;
37661ae650dSJack F Vogel 	bus_dmamap_t	pmap;
37761ae650dSJack F Vogel };
37861ae650dSJack F Vogel 
37961ae650dSJack F Vogel /*
38061ae650dSJack F Vogel ** This struct has multiple uses, multicast
38161ae650dSJack F Vogel ** addresses, vlans, and mac filters all use it.
38261ae650dSJack F Vogel */
38361ae650dSJack F Vogel struct ixl_mac_filter {
38461ae650dSJack F Vogel 	SLIST_ENTRY(ixl_mac_filter) next;
38561ae650dSJack F Vogel 	u8	macaddr[ETHER_ADDR_LEN];
38661ae650dSJack F Vogel 	s16	vlan;
38761ae650dSJack F Vogel 	u16	flags;
38861ae650dSJack F Vogel };
38961ae650dSJack F Vogel 
39061ae650dSJack F Vogel 
39161ae650dSJack F Vogel /*
39261ae650dSJack F Vogel  * The Transmit ring control struct
39361ae650dSJack F Vogel  */
39461ae650dSJack F Vogel struct tx_ring {
39561ae650dSJack F Vogel         struct ixl_queue	*que;
39661ae650dSJack F Vogel 	struct mtx		mtx;
39761ae650dSJack F Vogel 	u32			tail;
39861ae650dSJack F Vogel 	struct i40e_tx_desc	*base;
39961ae650dSJack F Vogel 	struct i40e_dma_mem	dma;
40061ae650dSJack F Vogel 	u16			next_avail;
40161ae650dSJack F Vogel 	u16			next_to_clean;
40261ae650dSJack F Vogel 	u16			atr_rate;
40361ae650dSJack F Vogel 	u16			atr_count;
40461ae650dSJack F Vogel 	u16			itr;
40561ae650dSJack F Vogel 	u16			latency;
40661ae650dSJack F Vogel 	struct ixl_tx_buf	*buffers;
40761ae650dSJack F Vogel 	volatile u16		avail;
40861ae650dSJack F Vogel 	u32			cmd;
40961ae650dSJack F Vogel 	bus_dma_tag_t		tx_tag;
41061ae650dSJack F Vogel 	bus_dma_tag_t		tso_tag;
41161ae650dSJack F Vogel 	char			mtx_name[16];
41261ae650dSJack F Vogel 	struct buf_ring		*br;
41361ae650dSJack F Vogel 
41461ae650dSJack F Vogel 	/* Used for Dynamic ITR calculation */
41561ae650dSJack F Vogel 	u32			packets;
41661ae650dSJack F Vogel 	u32 			bytes;
41761ae650dSJack F Vogel 
41861ae650dSJack F Vogel 	/* Soft Stats */
41961ae650dSJack F Vogel 	u64			tx_bytes;
42061ae650dSJack F Vogel 	u64			no_desc;
42161ae650dSJack F Vogel 	u64			total_packets;
42261ae650dSJack F Vogel };
42361ae650dSJack F Vogel 
42461ae650dSJack F Vogel 
42561ae650dSJack F Vogel /*
42661ae650dSJack F Vogel  * The Receive ring control struct
42761ae650dSJack F Vogel  */
42861ae650dSJack F Vogel struct rx_ring {
42961ae650dSJack F Vogel         struct ixl_queue	*que;
43061ae650dSJack F Vogel 	struct mtx		mtx;
43161ae650dSJack F Vogel 	union i40e_rx_desc	*base;
43261ae650dSJack F Vogel 	struct i40e_dma_mem	dma;
43361ae650dSJack F Vogel 	struct lro_ctrl		lro;
43461ae650dSJack F Vogel 	bool			lro_enabled;
43561ae650dSJack F Vogel 	bool			hdr_split;
43661ae650dSJack F Vogel 	bool			discard;
43761ae650dSJack F Vogel         u16			next_refresh;
43861ae650dSJack F Vogel         u16 			next_check;
43961ae650dSJack F Vogel 	u16			itr;
44061ae650dSJack F Vogel 	u16			latency;
44161ae650dSJack F Vogel 	char			mtx_name[16];
44261ae650dSJack F Vogel 	struct ixl_rx_buf	*buffers;
44361ae650dSJack F Vogel 	u32			mbuf_sz;
44461ae650dSJack F Vogel 	u32			tail;
44561ae650dSJack F Vogel 	bus_dma_tag_t		htag;
44661ae650dSJack F Vogel 	bus_dma_tag_t		ptag;
44761ae650dSJack F Vogel 
44861ae650dSJack F Vogel 	/* Used for Dynamic ITR calculation */
44961ae650dSJack F Vogel 	u32			packets;
45061ae650dSJack F Vogel 	u32 			bytes;
45161ae650dSJack F Vogel 
45261ae650dSJack F Vogel 	/* Soft stats */
45361ae650dSJack F Vogel 	u64			split;
45461ae650dSJack F Vogel 	u64			rx_packets;
45561ae650dSJack F Vogel 	u64 			rx_bytes;
45661ae650dSJack F Vogel 	u64 			discarded;
45761ae650dSJack F Vogel 	u64 			not_done;
45861ae650dSJack F Vogel };
45961ae650dSJack F Vogel 
46061ae650dSJack F Vogel /*
46161ae650dSJack F Vogel ** Driver queue struct: this is the interrupt container
46261ae650dSJack F Vogel **  for the associated tx and rx ring pair.
46361ae650dSJack F Vogel */
46461ae650dSJack F Vogel struct ixl_queue {
46561ae650dSJack F Vogel 	struct ixl_vsi		*vsi;
46661ae650dSJack F Vogel 	u32			me;
46761ae650dSJack F Vogel 	u32			msix;           /* This queue's MSIX vector */
46861ae650dSJack F Vogel 	u32			eims;           /* This queue's EIMS bit */
46961ae650dSJack F Vogel 	struct resource		*res;
47061ae650dSJack F Vogel 	void			*tag;
47161ae650dSJack F Vogel 	int			num_desc;	/* both tx and rx */
47261ae650dSJack F Vogel 	int			busy;
47361ae650dSJack F Vogel 	struct tx_ring		txr;
47461ae650dSJack F Vogel 	struct rx_ring		rxr;
47561ae650dSJack F Vogel 	struct task		task;
47661ae650dSJack F Vogel 	struct task		tx_task;
47761ae650dSJack F Vogel 	struct taskqueue	*tq;
47861ae650dSJack F Vogel 
47961ae650dSJack F Vogel 	/* Queue stats */
48061ae650dSJack F Vogel 	u64			irqs;
48161ae650dSJack F Vogel 	u64			tso;
48261ae650dSJack F Vogel 	u64			mbuf_defrag_failed;
48361ae650dSJack F Vogel 	u64			mbuf_hdr_failed;
48461ae650dSJack F Vogel 	u64			mbuf_pkt_failed;
48561ae650dSJack F Vogel 	u64			tx_map_avail;
48661ae650dSJack F Vogel 	u64			tx_dma_setup;
48761ae650dSJack F Vogel 	u64			dropped_pkts;
48861ae650dSJack F Vogel };
48961ae650dSJack F Vogel 
49061ae650dSJack F Vogel /*
49161ae650dSJack F Vogel ** Virtual Station interface:
49261ae650dSJack F Vogel **	there would be one of these per traffic class/type
49361ae650dSJack F Vogel **	for now just one, and its embedded in the pf
49461ae650dSJack F Vogel */
49561ae650dSJack F Vogel SLIST_HEAD(ixl_ftl_head, ixl_mac_filter);
49661ae650dSJack F Vogel struct ixl_vsi {
49761ae650dSJack F Vogel 	void 			*back;
49861ae650dSJack F Vogel 	struct ifnet		*ifp;
49961ae650dSJack F Vogel 	struct device		*dev;
50061ae650dSJack F Vogel 	struct i40e_hw		*hw;
50161ae650dSJack F Vogel 	struct ifmedia		media;
502ac83ea83SEric Joyner 	enum i40e_vsi_type	type;
50361ae650dSJack F Vogel 	u64			que_mask;
50461ae650dSJack F Vogel 	int			id;
50556c2c47bSJack F Vogel 	u16			vsi_num;
50661ae650dSJack F Vogel 	u16			msix_base;	/* station base MSIX vector */
50756c2c47bSJack F Vogel 	u16			first_queue;
50861ae650dSJack F Vogel 	u16			num_queues;
50961ae650dSJack F Vogel 	u16			rx_itr_setting;
51061ae650dSJack F Vogel 	u16			tx_itr_setting;
51161ae650dSJack F Vogel 	struct ixl_queue	*queues;	/* head of queues */
51261ae650dSJack F Vogel 	bool			link_active;
51361ae650dSJack F Vogel 	u16			seid;
51456c2c47bSJack F Vogel 	u16			uplink_seid;
51556c2c47bSJack F Vogel 	u16			downlink_seid;
51661ae650dSJack F Vogel 	u16			max_frame_size;
517ac83ea83SEric Joyner 	u16			rss_table_size;
518ac83ea83SEric Joyner 	u16			rss_size;
51961ae650dSJack F Vogel 
52061ae650dSJack F Vogel 	/* MAC/VLAN Filter list */
52161ae650dSJack F Vogel 	struct ixl_ftl_head	ftl;
52256c2c47bSJack F Vogel 	u16			num_macs;
52361ae650dSJack F Vogel 
52461ae650dSJack F Vogel 	struct i40e_aqc_vsi_properties_data info;
52561ae650dSJack F Vogel 
52661ae650dSJack F Vogel 	eventhandler_tag 	vlan_attach;
52761ae650dSJack F Vogel 	eventhandler_tag 	vlan_detach;
52861ae650dSJack F Vogel 	u16			num_vlans;
52961ae650dSJack F Vogel 
53061ae650dSJack F Vogel 	/* Per-VSI stats from hardware */
53161ae650dSJack F Vogel 	struct i40e_eth_stats	eth_stats;
53261ae650dSJack F Vogel 	struct i40e_eth_stats	eth_stats_offsets;
53361ae650dSJack F Vogel 	bool 			stat_offsets_loaded;
534e5100ee2SJack F Vogel 	/* VSI stat counters */
5354b443922SGleb Smirnoff 	u64			ipackets;
5364b443922SGleb Smirnoff 	u64			ierrors;
5374b443922SGleb Smirnoff 	u64			opackets;
5384b443922SGleb Smirnoff 	u64			oerrors;
5394b443922SGleb Smirnoff 	u64			ibytes;
5404b443922SGleb Smirnoff 	u64			obytes;
5414b443922SGleb Smirnoff 	u64			imcasts;
5424b443922SGleb Smirnoff 	u64			omcasts;
5434b443922SGleb Smirnoff 	u64			iqdrops;
5444b443922SGleb Smirnoff 	u64			oqdrops;
5454b443922SGleb Smirnoff 	u64			noproto;
54661ae650dSJack F Vogel 
54761ae650dSJack F Vogel 	/* Driver statistics */
54861ae650dSJack F Vogel 	u64			hw_filters_del;
54961ae650dSJack F Vogel 	u64			hw_filters_add;
55061ae650dSJack F Vogel 
55161ae650dSJack F Vogel 	/* Misc. */
55261ae650dSJack F Vogel 	u64 			active_queues;
55361ae650dSJack F Vogel 	u64 			flags;
55456c2c47bSJack F Vogel 	struct sysctl_oid	*vsi_node;
55561ae650dSJack F Vogel };
55661ae650dSJack F Vogel 
55761ae650dSJack F Vogel /*
55861ae650dSJack F Vogel ** Find the number of unrefreshed RX descriptors
55961ae650dSJack F Vogel */
56061ae650dSJack F Vogel static inline u16
56161ae650dSJack F Vogel ixl_rx_unrefreshed(struct ixl_queue *que)
56261ae650dSJack F Vogel {
56361ae650dSJack F Vogel         struct rx_ring	*rxr = &que->rxr;
56461ae650dSJack F Vogel 
56561ae650dSJack F Vogel 	if (rxr->next_check > rxr->next_refresh)
56661ae650dSJack F Vogel 		return (rxr->next_check - rxr->next_refresh - 1);
56761ae650dSJack F Vogel 	else
56861ae650dSJack F Vogel 		return ((que->num_desc + rxr->next_check) -
56961ae650dSJack F Vogel 		    rxr->next_refresh - 1);
57061ae650dSJack F Vogel }
57161ae650dSJack F Vogel 
57261ae650dSJack F Vogel /*
57361ae650dSJack F Vogel ** Find the next available unused filter
57461ae650dSJack F Vogel */
57561ae650dSJack F Vogel static inline struct ixl_mac_filter *
57661ae650dSJack F Vogel ixl_get_filter(struct ixl_vsi *vsi)
57761ae650dSJack F Vogel {
57861ae650dSJack F Vogel 	struct ixl_mac_filter  *f;
57961ae650dSJack F Vogel 
58061ae650dSJack F Vogel 	/* create a new empty filter */
58161ae650dSJack F Vogel 	f = malloc(sizeof(struct ixl_mac_filter),
58261ae650dSJack F Vogel 	    M_DEVBUF, M_NOWAIT | M_ZERO);
583e5100ee2SJack F Vogel 	if (f)
58461ae650dSJack F Vogel 		SLIST_INSERT_HEAD(&vsi->ftl, f, next);
58561ae650dSJack F Vogel 
58661ae650dSJack F Vogel 	return (f);
58761ae650dSJack F Vogel }
58861ae650dSJack F Vogel 
58961ae650dSJack F Vogel /*
59061ae650dSJack F Vogel ** Compare two ethernet addresses
59161ae650dSJack F Vogel */
59261ae650dSJack F Vogel static inline bool
59356c2c47bSJack F Vogel cmp_etheraddr(const u8 *ea1, const u8 *ea2)
59461ae650dSJack F Vogel {
59561ae650dSJack F Vogel 	bool cmp = FALSE;
59661ae650dSJack F Vogel 
59761ae650dSJack F Vogel 	if ((ea1[0] == ea2[0]) && (ea1[1] == ea2[1]) &&
59861ae650dSJack F Vogel 	    (ea1[2] == ea2[2]) && (ea1[3] == ea2[3]) &&
59961ae650dSJack F Vogel 	    (ea1[4] == ea2[4]) && (ea1[5] == ea2[5]))
60061ae650dSJack F Vogel 		cmp = TRUE;
60161ae650dSJack F Vogel 
60261ae650dSJack F Vogel 	return (cmp);
60361ae650dSJack F Vogel }
60461ae650dSJack F Vogel 
60561ae650dSJack F Vogel /*
60661ae650dSJack F Vogel  * Info for stats sysctls
60761ae650dSJack F Vogel  */
60861ae650dSJack F Vogel struct ixl_sysctl_info {
60961ae650dSJack F Vogel 	u64	*stat;
61061ae650dSJack F Vogel 	char	*name;
61161ae650dSJack F Vogel 	char	*description;
61261ae650dSJack F Vogel };
61361ae650dSJack F Vogel 
61461ae650dSJack F Vogel extern int ixl_atr_rate;
61561ae650dSJack F Vogel 
61661ae650dSJack F Vogel /*
61761ae650dSJack F Vogel ** ixl_fw_version_str - format the FW and NVM version strings
61861ae650dSJack F Vogel */
61961ae650dSJack F Vogel static inline char *
62061ae650dSJack F Vogel ixl_fw_version_str(struct i40e_hw *hw)
62161ae650dSJack F Vogel {
62261ae650dSJack F Vogel 	static char buf[32];
62361ae650dSJack F Vogel 
62461ae650dSJack F Vogel 	snprintf(buf, sizeof(buf),
62561ae650dSJack F Vogel 	    "f%d.%d a%d.%d n%02x.%02x e%08x",
62661ae650dSJack F Vogel 	    hw->aq.fw_maj_ver, hw->aq.fw_min_ver,
62761ae650dSJack F Vogel 	    hw->aq.api_maj_ver, hw->aq.api_min_ver,
62861ae650dSJack F Vogel 	    (hw->nvm.version & IXL_NVM_VERSION_HI_MASK) >>
62961ae650dSJack F Vogel 	    IXL_NVM_VERSION_HI_SHIFT,
63061ae650dSJack F Vogel 	    (hw->nvm.version & IXL_NVM_VERSION_LO_MASK) >>
63161ae650dSJack F Vogel 	    IXL_NVM_VERSION_LO_SHIFT,
63261ae650dSJack F Vogel 	    hw->nvm.eetrack);
63361ae650dSJack F Vogel 	return buf;
63461ae650dSJack F Vogel }
63561ae650dSJack F Vogel 
63661ae650dSJack F Vogel /*********************************************************************
63761ae650dSJack F Vogel  *  TXRX Function prototypes
63861ae650dSJack F Vogel  *********************************************************************/
63961ae650dSJack F Vogel int	ixl_allocate_tx_data(struct ixl_queue *);
64061ae650dSJack F Vogel int	ixl_allocate_rx_data(struct ixl_queue *);
64161ae650dSJack F Vogel void	ixl_init_tx_ring(struct ixl_queue *);
64261ae650dSJack F Vogel int	ixl_init_rx_ring(struct ixl_queue *);
64361ae650dSJack F Vogel bool	ixl_rxeof(struct ixl_queue *, int);
64461ae650dSJack F Vogel bool	ixl_txeof(struct ixl_queue *);
64561ae650dSJack F Vogel int	ixl_mq_start(struct ifnet *, struct mbuf *);
64661ae650dSJack F Vogel int	ixl_mq_start_locked(struct ifnet *, struct tx_ring *);
64761ae650dSJack F Vogel void	ixl_deferred_mq_start(void *, int);
64861ae650dSJack F Vogel void	ixl_qflush(struct ifnet *);
64961ae650dSJack F Vogel void	ixl_free_vsi(struct ixl_vsi *);
65061ae650dSJack F Vogel void	ixl_free_que_tx(struct ixl_queue *);
65161ae650dSJack F Vogel void	ixl_free_que_rx(struct ixl_queue *);
65261ae650dSJack F Vogel #ifdef IXL_FDIR
65361ae650dSJack F Vogel void	ixl_atr(struct ixl_queue *, struct tcphdr *, int);
65461ae650dSJack F Vogel #endif
6554b443922SGleb Smirnoff #if __FreeBSD_version >= 1100000
6564b443922SGleb Smirnoff uint64_t ixl_get_counter(if_t ifp, ift_counter cnt);
6574b443922SGleb Smirnoff #endif
65861ae650dSJack F Vogel 
65961ae650dSJack F Vogel #endif /* _IXL_H_ */
660