1/******************************************************************************
2
3  Copyright (c) 2013-2018, Intel Corporation
4  All rights reserved.
5
6  Redistribution and use in source and binary forms, with or without
7  modification, are permitted provided that the following conditions are met:
8
9   1. Redistributions of source code must retain the above copyright notice,
10      this list of conditions and the following disclaimer.
11
12   2. Redistributions in binary form must reproduce the above copyright
13      notice, this list of conditions and the following disclaimer in the
14      documentation and/or other materials provided with the distribution.
15
16   3. Neither the name of the Intel Corporation nor the names of its
17      contributors may be used to endorse or promote products derived from
18      this software without specific prior written permission.
19
20  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  POSSIBILITY OF SUCH DAMAGE.
31
32******************************************************************************/
33
34#ifndef _I40E_TYPE_H_
35#define _I40E_TYPE_H_
36
37#include "i40e_status.h"
38#include "i40e_osdep.h"
39#include "i40e_register.h"
40#include "i40e_adminq.h"
41#include "i40e_hmc.h"
42#include "i40e_lan_hmc.h"
43#include "i40e_devids.h"
44
45
46#define BIT(a) (1UL << (a))
47#define BIT_ULL(a) (1ULL << (a))
48
49#ifndef I40E_MASK
50/* I40E_MASK is a macro used on 32 bit registers */
51#define I40E_MASK(mask, shift) (mask << shift)
52#endif
53
54#define I40E_MAX_PF			16
55#define I40E_MAX_PF_VSI			64
56#define I40E_MAX_PF_QP			128
57#define I40E_MAX_VSI_QP			16
58#define I40E_MAX_VF_VSI			4
59#define I40E_MAX_CHAINED_RX_BUFFERS	5
60#define I40E_MAX_PF_UDP_OFFLOAD_PORTS	16
61
62/* something less than 1 minute */
63#define I40E_HEARTBEAT_TIMEOUT		(HZ * 50)
64
65/* Max default timeout in ms, */
66#define I40E_MAX_NVM_TIMEOUT		18000
67
68/* Max timeout in ms for the phy to respond */
69#define I40E_MAX_PHY_TIMEOUT		500
70
71/* Check whether address is multicast. */
72#define I40E_IS_MULTICAST(address) (bool)(((u8 *)(address))[0] & ((u8)0x01))
73
74/* Check whether an address is broadcast. */
75#define I40E_IS_BROADCAST(address)	\
76	((((u8 *)(address))[0] == ((u8)0xff)) && \
77	(((u8 *)(address))[1] == ((u8)0xff)))
78
79/* Switch from ms to the 1usec global time (this is the GTIME resolution) */
80#define I40E_MS_TO_GTIME(time)		((time) * 1000)
81
82/* forward declaration */
83struct i40e_hw;
84typedef void (*I40E_ADMINQ_CALLBACK)(struct i40e_hw *, struct i40e_aq_desc *);
85
86#define ETH_ALEN	6
87/* Data type manipulation macros. */
88#define I40E_HI_DWORD(x)	((u32)((((x) >> 16) >> 16) & 0xFFFFFFFF))
89#define I40E_LO_DWORD(x)	((u32)((x) & 0xFFFFFFFF))
90
91#define I40E_HI_WORD(x)		((u16)(((x) >> 16) & 0xFFFF))
92#define I40E_LO_WORD(x)		((u16)((x) & 0xFFFF))
93
94#define I40E_HI_BYTE(x)		((u8)(((x) >> 8) & 0xFF))
95#define I40E_LO_BYTE(x)		((u8)((x) & 0xFF))
96
97/* Number of Transmit Descriptors must be a multiple of 32. */
98#define I40E_REQ_TX_DESCRIPTOR_MULTIPLE	32
99/* Number of Receive Descriptors must be a multiple of 32 if
100 * the number of descriptors is greater than 32.
101 */
102#define I40E_REQ_RX_DESCRIPTOR_MULTIPLE	32
103
104#define I40E_DESC_UNUSED(R)	\
105	((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
106	(R)->next_to_clean - (R)->next_to_use - 1)
107
108/* bitfields for Tx queue mapping in QTX_CTL */
109#define I40E_QTX_CTL_VF_QUEUE	0x0
110#define I40E_QTX_CTL_VM_QUEUE	0x1
111#define I40E_QTX_CTL_PF_QUEUE	0x2
112
113/* debug masks - set these bits in hw->debug_mask to control output */
114enum i40e_debug_mask {
115	I40E_DEBUG_INIT			= 0x00000001,
116	I40E_DEBUG_RELEASE		= 0x00000002,
117
118	I40E_DEBUG_LINK			= 0x00000010,
119	I40E_DEBUG_PHY			= 0x00000020,
120	I40E_DEBUG_HMC			= 0x00000040,
121	I40E_DEBUG_NVM			= 0x00000080,
122	I40E_DEBUG_LAN			= 0x00000100,
123	I40E_DEBUG_FLOW			= 0x00000200,
124	I40E_DEBUG_DCB			= 0x00000400,
125	I40E_DEBUG_DIAG			= 0x00000800,
126	I40E_DEBUG_FD			= 0x00001000,
127
128	I40E_DEBUG_IWARP		= 0x00F00000,
129
130	I40E_DEBUG_AQ_MESSAGE		= 0x01000000,
131	I40E_DEBUG_AQ_DESCRIPTOR	= 0x02000000,
132	I40E_DEBUG_AQ_DESC_BUFFER	= 0x04000000,
133	I40E_DEBUG_AQ_COMMAND		= 0x06000000,
134	I40E_DEBUG_AQ			= 0x0F000000,
135
136	I40E_DEBUG_USER			= 0xF0000000,
137
138	I40E_DEBUG_ALL			= 0xFFFFFFFF
139};
140
141/* PCI Bus Info */
142#define I40E_PCI_LINK_STATUS		0xB2
143#define I40E_PCI_LINK_WIDTH		0x3F0
144#define I40E_PCI_LINK_WIDTH_1		0x10
145#define I40E_PCI_LINK_WIDTH_2		0x20
146#define I40E_PCI_LINK_WIDTH_4		0x40
147#define I40E_PCI_LINK_WIDTH_8		0x80
148#define I40E_PCI_LINK_SPEED		0xF
149#define I40E_PCI_LINK_SPEED_2500	0x1
150#define I40E_PCI_LINK_SPEED_5000	0x2
151#define I40E_PCI_LINK_SPEED_8000	0x3
152
153#define I40E_MDIO_CLAUSE22_STCODE_MASK	I40E_MASK(1, \
154						  I40E_GLGEN_MSCA_STCODE_SHIFT)
155#define I40E_MDIO_CLAUSE22_OPCODE_WRITE_MASK	I40E_MASK(1, \
156						  I40E_GLGEN_MSCA_OPCODE_SHIFT)
157#define I40E_MDIO_CLAUSE22_OPCODE_READ_MASK	I40E_MASK(2, \
158						  I40E_GLGEN_MSCA_OPCODE_SHIFT)
159
160#define I40E_MDIO_CLAUSE45_STCODE_MASK	I40E_MASK(0, \
161						  I40E_GLGEN_MSCA_STCODE_SHIFT)
162#define I40E_MDIO_CLAUSE45_OPCODE_ADDRESS_MASK	I40E_MASK(0, \
163						  I40E_GLGEN_MSCA_OPCODE_SHIFT)
164#define I40E_MDIO_CLAUSE45_OPCODE_WRITE_MASK	I40E_MASK(1, \
165						  I40E_GLGEN_MSCA_OPCODE_SHIFT)
166#define I40E_MDIO_CLAUSE45_OPCODE_READ_INC_ADDR_MASK	I40E_MASK(2, \
167						  I40E_GLGEN_MSCA_OPCODE_SHIFT)
168#define I40E_MDIO_CLAUSE45_OPCODE_READ_MASK	I40E_MASK(3, \
169						  I40E_GLGEN_MSCA_OPCODE_SHIFT)
170
171#define I40E_PHY_COM_REG_PAGE			0x1E
172#define I40E_PHY_LED_LINK_MODE_MASK		0xF0
173#define I40E_PHY_LED_MANUAL_ON			0x100
174#define I40E_PHY_LED_PROV_REG_1			0xC430
175#define I40E_PHY_LED_MODE_MASK			0xFFFF
176#define I40E_PHY_LED_MODE_ORIG			0x80000000
177
178/* Memory types */
179enum i40e_memset_type {
180	I40E_NONDMA_MEM = 0,
181	I40E_DMA_MEM
182};
183
184/* Memcpy types */
185enum i40e_memcpy_type {
186	I40E_NONDMA_TO_NONDMA = 0,
187	I40E_NONDMA_TO_DMA,
188	I40E_DMA_TO_DMA,
189	I40E_DMA_TO_NONDMA
190};
191
192/* These are structs for managing the hardware information and the operations.
193 * The structures of function pointers are filled out at init time when we
194 * know for sure exactly which hardware we're working with.  This gives us the
195 * flexibility of using the same main driver code but adapting to slightly
196 * different hardware needs as new parts are developed.  For this architecture,
197 * the Firmware and AdminQ are intended to insulate the driver from most of the
198 * future changes, but these structures will also do part of the job.
199 */
200enum i40e_mac_type {
201	I40E_MAC_UNKNOWN = 0,
202	I40E_MAC_XL710,
203	I40E_MAC_VF,
204	I40E_MAC_X722,
205	I40E_MAC_X722_VF,
206	I40E_MAC_GENERIC,
207};
208
209enum i40e_media_type {
210	I40E_MEDIA_TYPE_UNKNOWN = 0,
211	I40E_MEDIA_TYPE_FIBER,
212	I40E_MEDIA_TYPE_BASET,
213	I40E_MEDIA_TYPE_BACKPLANE,
214	I40E_MEDIA_TYPE_CX4,
215	I40E_MEDIA_TYPE_DA,
216	I40E_MEDIA_TYPE_VIRTUAL
217};
218
219enum i40e_fc_mode {
220	I40E_FC_NONE = 0,
221	I40E_FC_RX_PAUSE,
222	I40E_FC_TX_PAUSE,
223	I40E_FC_FULL,
224	I40E_FC_PFC,
225	I40E_FC_DEFAULT
226};
227
228enum i40e_set_fc_aq_failures {
229	I40E_SET_FC_AQ_FAIL_NONE = 0,
230	I40E_SET_FC_AQ_FAIL_GET = 1,
231	I40E_SET_FC_AQ_FAIL_SET = 2,
232	I40E_SET_FC_AQ_FAIL_UPDATE = 4,
233	I40E_SET_FC_AQ_FAIL_SET_UPDATE = 6
234};
235
236enum i40e_vsi_type {
237	I40E_VSI_MAIN	= 0,
238	I40E_VSI_VMDQ1	= 1,
239	I40E_VSI_VMDQ2	= 2,
240	I40E_VSI_CTRL	= 3,
241	I40E_VSI_FCOE	= 4,
242	I40E_VSI_MIRROR	= 5,
243	I40E_VSI_SRIOV	= 6,
244	I40E_VSI_FDIR	= 7,
245	I40E_VSI_IWARP	= 8,
246	I40E_VSI_TYPE_UNKNOWN
247};
248
249enum i40e_queue_type {
250	I40E_QUEUE_TYPE_RX = 0,
251	I40E_QUEUE_TYPE_TX,
252	I40E_QUEUE_TYPE_PE_CEQ,
253	I40E_QUEUE_TYPE_UNKNOWN
254};
255
256struct i40e_link_status {
257	enum i40e_aq_phy_type phy_type;
258	enum i40e_aq_link_speed link_speed;
259	u8 link_info;
260	u8 an_info;
261	u8 req_fec_info;
262	u8 fec_info;
263	u8 ext_info;
264	u8 loopback;
265	/* is Link Status Event notification to SW enabled */
266	bool lse_enable;
267	u16 max_frame_size;
268	bool crc_enable;
269	u8 pacing;
270	u8 requested_speeds;
271	u8 module_type[3];
272	/* 1st byte: module identifier */
273#define I40E_MODULE_TYPE_SFP		0x03
274#define I40E_MODULE_TYPE_QSFP		0x0D
275	/* 2nd byte: ethernet compliance codes for 10/40G */
276#define I40E_MODULE_TYPE_40G_ACTIVE	0x01
277#define I40E_MODULE_TYPE_40G_LR4	0x02
278#define I40E_MODULE_TYPE_40G_SR4	0x04
279#define I40E_MODULE_TYPE_40G_CR4	0x08
280#define I40E_MODULE_TYPE_10G_BASE_SR	0x10
281#define I40E_MODULE_TYPE_10G_BASE_LR	0x20
282#define I40E_MODULE_TYPE_10G_BASE_LRM	0x40
283#define I40E_MODULE_TYPE_10G_BASE_ER	0x80
284	/* 3rd byte: ethernet compliance codes for 1G */
285#define I40E_MODULE_TYPE_1000BASE_SX	0x01
286#define I40E_MODULE_TYPE_1000BASE_LX	0x02
287#define I40E_MODULE_TYPE_1000BASE_CX	0x04
288#define I40E_MODULE_TYPE_1000BASE_T	0x08
289};
290
291struct i40e_phy_info {
292	struct i40e_link_status link_info;
293	struct i40e_link_status link_info_old;
294	bool get_link_info;
295	enum i40e_media_type media_type;
296	/* all the phy types the NVM is capable of */
297	u64 phy_types;
298};
299
300#define I40E_CAP_PHY_TYPE_SGMII BIT_ULL(I40E_PHY_TYPE_SGMII)
301#define I40E_CAP_PHY_TYPE_1000BASE_KX BIT_ULL(I40E_PHY_TYPE_1000BASE_KX)
302#define I40E_CAP_PHY_TYPE_10GBASE_KX4 BIT_ULL(I40E_PHY_TYPE_10GBASE_KX4)
303#define I40E_CAP_PHY_TYPE_10GBASE_KR BIT_ULL(I40E_PHY_TYPE_10GBASE_KR)
304#define I40E_CAP_PHY_TYPE_40GBASE_KR4 BIT_ULL(I40E_PHY_TYPE_40GBASE_KR4)
305#define I40E_CAP_PHY_TYPE_XAUI BIT_ULL(I40E_PHY_TYPE_XAUI)
306#define I40E_CAP_PHY_TYPE_XFI BIT_ULL(I40E_PHY_TYPE_XFI)
307#define I40E_CAP_PHY_TYPE_SFI BIT_ULL(I40E_PHY_TYPE_SFI)
308#define I40E_CAP_PHY_TYPE_XLAUI BIT_ULL(I40E_PHY_TYPE_XLAUI)
309#define I40E_CAP_PHY_TYPE_XLPPI BIT_ULL(I40E_PHY_TYPE_XLPPI)
310#define I40E_CAP_PHY_TYPE_40GBASE_CR4_CU BIT_ULL(I40E_PHY_TYPE_40GBASE_CR4_CU)
311#define I40E_CAP_PHY_TYPE_10GBASE_CR1_CU BIT_ULL(I40E_PHY_TYPE_10GBASE_CR1_CU)
312#define I40E_CAP_PHY_TYPE_10GBASE_AOC BIT_ULL(I40E_PHY_TYPE_10GBASE_AOC)
313#define I40E_CAP_PHY_TYPE_40GBASE_AOC BIT_ULL(I40E_PHY_TYPE_40GBASE_AOC)
314#define I40E_CAP_PHY_TYPE_100BASE_TX BIT_ULL(I40E_PHY_TYPE_100BASE_TX)
315#define I40E_CAP_PHY_TYPE_1000BASE_T BIT_ULL(I40E_PHY_TYPE_1000BASE_T)
316#define I40E_CAP_PHY_TYPE_10GBASE_T BIT_ULL(I40E_PHY_TYPE_10GBASE_T)
317#define I40E_CAP_PHY_TYPE_10GBASE_SR BIT_ULL(I40E_PHY_TYPE_10GBASE_SR)
318#define I40E_CAP_PHY_TYPE_10GBASE_LR BIT_ULL(I40E_PHY_TYPE_10GBASE_LR)
319#define I40E_CAP_PHY_TYPE_10GBASE_SFPP_CU BIT_ULL(I40E_PHY_TYPE_10GBASE_SFPP_CU)
320#define I40E_CAP_PHY_TYPE_10GBASE_CR1 BIT_ULL(I40E_PHY_TYPE_10GBASE_CR1)
321#define I40E_CAP_PHY_TYPE_40GBASE_CR4 BIT_ULL(I40E_PHY_TYPE_40GBASE_CR4)
322#define I40E_CAP_PHY_TYPE_40GBASE_SR4 BIT_ULL(I40E_PHY_TYPE_40GBASE_SR4)
323#define I40E_CAP_PHY_TYPE_40GBASE_LR4 BIT_ULL(I40E_PHY_TYPE_40GBASE_LR4)
324#define I40E_CAP_PHY_TYPE_1000BASE_SX BIT_ULL(I40E_PHY_TYPE_1000BASE_SX)
325#define I40E_CAP_PHY_TYPE_1000BASE_LX BIT_ULL(I40E_PHY_TYPE_1000BASE_LX)
326#define I40E_CAP_PHY_TYPE_1000BASE_T_OPTICAL \
327				BIT_ULL(I40E_PHY_TYPE_1000BASE_T_OPTICAL)
328#define I40E_CAP_PHY_TYPE_20GBASE_KR2 BIT_ULL(I40E_PHY_TYPE_20GBASE_KR2)
329/*
330 * Defining the macro I40E_TYPE_OFFSET to implement a bit shift for some
331 * PHY types. There is an unused bit (31) in the I40E_CAP_PHY_TYPE_* bit
332 * fields but no corresponding gap in the i40e_aq_phy_type enumeration. So,
333 * a shift is needed to adjust for this with values larger than 31. The
334 * only affected values are I40E_PHY_TYPE_25GBASE_*.
335 */
336#define I40E_PHY_TYPE_OFFSET 1
337#define I40E_CAP_PHY_TYPE_25GBASE_KR BIT_ULL(I40E_PHY_TYPE_25GBASE_KR + \
338					     I40E_PHY_TYPE_OFFSET)
339#define I40E_CAP_PHY_TYPE_25GBASE_CR BIT_ULL(I40E_PHY_TYPE_25GBASE_CR + \
340					     I40E_PHY_TYPE_OFFSET)
341#define I40E_CAP_PHY_TYPE_25GBASE_SR BIT_ULL(I40E_PHY_TYPE_25GBASE_SR + \
342					     I40E_PHY_TYPE_OFFSET)
343#define I40E_CAP_PHY_TYPE_25GBASE_LR BIT_ULL(I40E_PHY_TYPE_25GBASE_LR + \
344					     I40E_PHY_TYPE_OFFSET)
345#define I40E_CAP_PHY_TYPE_25GBASE_AOC BIT_ULL(I40E_PHY_TYPE_25GBASE_AOC + \
346					     I40E_PHY_TYPE_OFFSET)
347#define I40E_CAP_PHY_TYPE_25GBASE_ACC BIT_ULL(I40E_PHY_TYPE_25GBASE_ACC + \
348					     I40E_PHY_TYPE_OFFSET)
349#define I40E_CAP_PHY_TYPE_2_5GBASE_T BIT_ULL(I40E_PHY_TYPE_2_5GBASE_T)
350#define I40E_CAP_PHY_TYPE_5GBASE_T BIT_ULL(I40E_PHY_TYPE_5GBASE_T)
351#define I40E_HW_CAP_MAX_GPIO			30
352#define I40E_HW_CAP_MDIO_PORT_MODE_MDIO		0
353#define I40E_HW_CAP_MDIO_PORT_MODE_I2C		1
354
355enum i40e_acpi_programming_method {
356	I40E_ACPI_PROGRAMMING_METHOD_HW_FVL = 0,
357	I40E_ACPI_PROGRAMMING_METHOD_AQC_FPK = 1
358};
359
360#define I40E_WOL_SUPPORT_MASK			0x1
361#define I40E_ACPI_PROGRAMMING_METHOD_MASK	0x2
362#define I40E_PROXY_SUPPORT_MASK			0x4
363
364/* Capabilities of a PF or a VF or the whole device */
365struct i40e_hw_capabilities {
366	u32  switch_mode;
367#define I40E_NVM_IMAGE_TYPE_EVB		0x0
368#define I40E_NVM_IMAGE_TYPE_CLOUD	0x2
369#define I40E_NVM_IMAGE_TYPE_UDP_CLOUD	0x3
370
371	/* Cloud filter modes:
372	 * Mode1: Filter on L4 port only
373	 * Mode2: Filter for non-tunneled traffic
374	 * Mode3: Filter for tunnel traffic
375	 */
376#define I40E_CLOUD_FILTER_MODE1	0x6
377#define I40E_CLOUD_FILTER_MODE2	0x7
378#define I40E_CLOUD_FILTER_MODE3	0x8
379#define I40E_SWITCH_MODE_MASK	0xF
380
381	u32  management_mode;
382	u32  mng_protocols_over_mctp;
383#define I40E_MNG_PROTOCOL_PLDM		0x2
384#define I40E_MNG_PROTOCOL_OEM_COMMANDS	0x4
385#define I40E_MNG_PROTOCOL_NCSI		0x8
386	u32  npar_enable;
387	u32  os2bmc;
388	u32  valid_functions;
389	bool sr_iov_1_1;
390	bool vmdq;
391	bool evb_802_1_qbg; /* Edge Virtual Bridging */
392	bool evb_802_1_qbh; /* Bridge Port Extension */
393	bool dcb;
394	bool fcoe;
395	bool iscsi; /* Indicates iSCSI enabled */
396	bool flex10_enable;
397	bool flex10_capable;
398	u32  flex10_mode;
399#define I40E_FLEX10_MODE_UNKNOWN	0x0
400#define I40E_FLEX10_MODE_DCC		0x1
401#define I40E_FLEX10_MODE_DCI		0x2
402
403	u32 flex10_status;
404#define I40E_FLEX10_STATUS_DCC_ERROR	0x1
405#define I40E_FLEX10_STATUS_VC_MODE	0x2
406
407	bool sec_rev_disabled;
408	bool update_disabled;
409#define I40E_NVM_MGMT_SEC_REV_DISABLED	0x1
410#define I40E_NVM_MGMT_UPDATE_DISABLED	0x2
411
412	bool mgmt_cem;
413	bool ieee_1588;
414	bool iwarp;
415	bool fd;
416	u32 fd_filters_guaranteed;
417	u32 fd_filters_best_effort;
418	bool rss;
419	u32 rss_table_size;
420	u32 rss_table_entry_width;
421	bool led[I40E_HW_CAP_MAX_GPIO];
422	bool sdp[I40E_HW_CAP_MAX_GPIO];
423	u32 nvm_image_type;
424	u32 num_flow_director_filters;
425	u32 num_vfs;
426	u32 vf_base_id;
427	u32 num_vsis;
428	u32 num_rx_qp;
429	u32 num_tx_qp;
430	u32 base_queue;
431	u32 num_msix_vectors;
432	u32 num_msix_vectors_vf;
433	u32 led_pin_num;
434	u32 sdp_pin_num;
435	u32 mdio_port_num;
436	u32 mdio_port_mode;
437	u8 rx_buf_chain_len;
438	u32 enabled_tcmap;
439	u32 maxtc;
440	u64 wr_csr_prot;
441	bool dis_unused_ports;
442	bool apm_wol_support;
443	enum i40e_acpi_programming_method acpi_prog_method;
444	bool proxy_support;
445};
446
447struct i40e_mac_info {
448	enum i40e_mac_type type;
449	u8 addr[ETH_ALEN];
450	u8 perm_addr[ETH_ALEN];
451	u8 san_addr[ETH_ALEN];
452	u8 port_addr[ETH_ALEN];
453	u16 max_fcoeq;
454};
455
456enum i40e_aq_resources_ids {
457	I40E_NVM_RESOURCE_ID = 1
458};
459
460enum i40e_aq_resource_access_type {
461	I40E_RESOURCE_READ = 1,
462	I40E_RESOURCE_WRITE
463};
464
465struct i40e_nvm_info {
466	u64 hw_semaphore_timeout; /* usec global time (GTIME resolution) */
467	u32 timeout;              /* [ms] */
468	u16 sr_size;              /* Shadow RAM size in words */
469	bool blank_nvm_mode;      /* is NVM empty (no FW present)*/
470	u16 version;              /* NVM package version */
471	u32 eetrack;              /* NVM data version */
472	u32 oem_ver;              /* OEM version info */
473};
474
475/* definitions used in NVM update support */
476
477enum i40e_nvmupd_cmd {
478	I40E_NVMUPD_INVALID,
479	I40E_NVMUPD_READ_CON,
480	I40E_NVMUPD_READ_SNT,
481	I40E_NVMUPD_READ_LCB,
482	I40E_NVMUPD_READ_SA,
483	I40E_NVMUPD_WRITE_ERA,
484	I40E_NVMUPD_WRITE_CON,
485	I40E_NVMUPD_WRITE_SNT,
486	I40E_NVMUPD_WRITE_LCB,
487	I40E_NVMUPD_WRITE_SA,
488	I40E_NVMUPD_CSUM_CON,
489	I40E_NVMUPD_CSUM_SA,
490	I40E_NVMUPD_CSUM_LCB,
491	I40E_NVMUPD_STATUS,
492	I40E_NVMUPD_EXEC_AQ,
493	I40E_NVMUPD_GET_AQ_RESULT,
494	I40E_NVMUPD_GET_AQ_EVENT,
495	I40E_NVMUPD_FEATURES,
496};
497
498enum i40e_nvmupd_state {
499	I40E_NVMUPD_STATE_INIT,
500	I40E_NVMUPD_STATE_READING,
501	I40E_NVMUPD_STATE_WRITING,
502	I40E_NVMUPD_STATE_INIT_WAIT,
503	I40E_NVMUPD_STATE_WRITE_WAIT,
504	I40E_NVMUPD_STATE_ERROR
505};
506
507/* nvm_access definition and its masks/shifts need to be accessible to
508 * application, core driver, and shared code.  Where is the right file?
509 */
510#define I40E_NVM_READ	0xB
511#define I40E_NVM_WRITE	0xC
512
513#define I40E_NVM_MOD_PNT_MASK 0xFF
514
515#define I40E_NVM_TRANS_SHIFT			8
516#define I40E_NVM_TRANS_MASK			(0xf << I40E_NVM_TRANS_SHIFT)
517#define I40E_NVM_PRESERVATION_FLAGS_SHIFT	12
518#define I40E_NVM_PRESERVATION_FLAGS_MASK \
519				(0x3 << I40E_NVM_PRESERVATION_FLAGS_SHIFT)
520#define I40E_NVM_PRESERVATION_FLAGS_SELECTED	0x01
521#define I40E_NVM_PRESERVATION_FLAGS_ALL		0x02
522#define I40E_NVM_CON				0x0
523#define I40E_NVM_SNT				0x1
524#define I40E_NVM_LCB				0x2
525#define I40E_NVM_SA				(I40E_NVM_SNT | I40E_NVM_LCB)
526#define I40E_NVM_ERA				0x4
527#define I40E_NVM_CSUM				0x8
528#define I40E_NVM_AQE				0xe
529#define I40E_NVM_EXEC				0xf
530
531#define I40E_NVM_EXEC_GET_AQ_RESULT		0x0
532#define I40E_NVM_EXEC_FEATURES			0xe
533#define I40E_NVM_EXEC_STATUS			0xf
534
535#define I40E_NVM_ADAPT_SHIFT	16
536#define I40E_NVM_ADAPT_MASK	(0xffffULL << I40E_NVM_ADAPT_SHIFT)
537
538#define I40E_NVMUPD_MAX_DATA	4096
539#define I40E_NVMUPD_IFACE_TIMEOUT 2 /* seconds */
540
541struct i40e_nvm_access {
542	u32 command;
543	u32 config;
544	u32 offset;	/* in bytes */
545	u32 data_size;	/* in bytes */
546	u8 data[1];
547};
548
549/* NVMUpdate features API */
550#define I40E_NVMUPD_FEATURES_API_VER_MAJOR		0
551#define I40E_NVMUPD_FEATURES_API_VER_MINOR		14
552#define I40E_NVMUPD_FEATURES_API_FEATURES_ARRAY_LEN	12
553
554#define I40E_NVMUPD_FEATURE_FLAT_NVM_SUPPORT		BIT(0)
555
556struct i40e_nvmupd_features {
557	u8 major;
558	u8 minor;
559	u16 size;
560	u8 features[I40E_NVMUPD_FEATURES_API_FEATURES_ARRAY_LEN];
561};
562
563/* (Q)SFP module access definitions */
564#define I40E_I2C_EEPROM_DEV_ADDR	0xA0
565#define I40E_I2C_EEPROM_DEV_ADDR2	0xA2
566#define I40E_MODULE_TYPE_ADDR		0x00
567#define I40E_MODULE_REVISION_ADDR	0x01
568#define I40E_MODULE_SFF_8472_COMP	0x5E
569#define I40E_MODULE_SFF_8472_SWAP	0x5C
570#define I40E_MODULE_SFF_ADDR_MODE	0x04
571#define I40E_MODULE_SFF_DIAG_CAPAB	0x40
572#define I40E_MODULE_TYPE_QSFP_PLUS	0x0D
573#define I40E_MODULE_TYPE_QSFP28		0x11
574#define I40E_MODULE_QSFP_MAX_LEN	640
575
576/* PCI bus types */
577enum i40e_bus_type {
578	i40e_bus_type_unknown = 0,
579	i40e_bus_type_pci,
580	i40e_bus_type_pcix,
581	i40e_bus_type_pci_express,
582	i40e_bus_type_reserved
583};
584
585/* PCI bus speeds */
586enum i40e_bus_speed {
587	i40e_bus_speed_unknown	= 0,
588	i40e_bus_speed_33	= 33,
589	i40e_bus_speed_66	= 66,
590	i40e_bus_speed_100	= 100,
591	i40e_bus_speed_120	= 120,
592	i40e_bus_speed_133	= 133,
593	i40e_bus_speed_2500	= 2500,
594	i40e_bus_speed_5000	= 5000,
595	i40e_bus_speed_8000	= 8000,
596	i40e_bus_speed_reserved
597};
598
599/* PCI bus widths */
600enum i40e_bus_width {
601	i40e_bus_width_unknown	= 0,
602	i40e_bus_width_pcie_x1	= 1,
603	i40e_bus_width_pcie_x2	= 2,
604	i40e_bus_width_pcie_x4	= 4,
605	i40e_bus_width_pcie_x8	= 8,
606	i40e_bus_width_32	= 32,
607	i40e_bus_width_64	= 64,
608	i40e_bus_width_reserved
609};
610
611/* Bus parameters */
612struct i40e_bus_info {
613	enum i40e_bus_speed speed;
614	enum i40e_bus_width width;
615	enum i40e_bus_type type;
616
617	u16 func;
618	u16 device;
619	u16 lan_id;
620	u16 bus_id;
621};
622
623/* Flow control (FC) parameters */
624struct i40e_fc_info {
625	enum i40e_fc_mode current_mode; /* FC mode in effect */
626	enum i40e_fc_mode requested_mode; /* FC mode requested by caller */
627};
628
629#define I40E_MAX_TRAFFIC_CLASS		8
630#define I40E_MAX_USER_PRIORITY		8
631#define I40E_DCBX_MAX_APPS		32
632#define I40E_LLDPDU_SIZE		1500
633#define I40E_TLV_STATUS_OPER		0x1
634#define I40E_TLV_STATUS_SYNC		0x2
635#define I40E_TLV_STATUS_ERR		0x4
636#define I40E_CEE_OPER_MAX_APPS		3
637#define I40E_APP_PROTOID_FCOE		0x8906
638#define I40E_APP_PROTOID_ISCSI		0x0cbc
639#define I40E_APP_PROTOID_FIP		0x8914
640#define I40E_APP_SEL_ETHTYPE		0x1
641#define I40E_APP_SEL_TCPIP		0x2
642#define I40E_CEE_APP_SEL_ETHTYPE	0x0
643#define I40E_CEE_APP_SEL_TCPIP		0x1
644
645/* CEE or IEEE 802.1Qaz ETS Configuration data */
646struct i40e_dcb_ets_config {
647	u8 willing;
648	u8 cbs;
649	u8 maxtcs;
650	u8 prioritytable[I40E_MAX_TRAFFIC_CLASS];
651	u8 tcbwtable[I40E_MAX_TRAFFIC_CLASS];
652	u8 tsatable[I40E_MAX_TRAFFIC_CLASS];
653};
654
655/* CEE or IEEE 802.1Qaz PFC Configuration data */
656struct i40e_dcb_pfc_config {
657	u8 willing;
658	u8 mbc;
659	u8 pfccap;
660	u8 pfcenable;
661};
662
663/* CEE or IEEE 802.1Qaz Application Priority data */
664struct i40e_dcb_app_priority_table {
665	u8  priority;
666	u8  selector;
667	u16 protocolid;
668};
669
670struct i40e_dcbx_config {
671	u8  dcbx_mode;
672#define I40E_DCBX_MODE_CEE	0x1
673#define I40E_DCBX_MODE_IEEE	0x2
674	u8  app_mode;
675#define I40E_DCBX_APPS_NON_WILLING	0x1
676	u32 numapps;
677	u32 tlv_status; /* CEE mode TLV status */
678	struct i40e_dcb_ets_config etscfg;
679	struct i40e_dcb_ets_config etsrec;
680	struct i40e_dcb_pfc_config pfc;
681	struct i40e_dcb_app_priority_table app[I40E_DCBX_MAX_APPS];
682};
683
684/* Port hardware description */
685struct i40e_hw {
686	u8 *hw_addr;
687	void *back;
688
689	/* subsystem structs */
690	struct i40e_phy_info phy;
691	struct i40e_mac_info mac;
692	struct i40e_bus_info bus;
693	struct i40e_nvm_info nvm;
694	struct i40e_fc_info fc;
695
696	/* pci info */
697	u16 device_id;
698	u16 vendor_id;
699	u16 subsystem_device_id;
700	u16 subsystem_vendor_id;
701	u8 revision_id;
702	u8 port;
703	bool adapter_stopped;
704
705	/* capabilities for entire device and PCI func */
706	struct i40e_hw_capabilities dev_caps;
707	struct i40e_hw_capabilities func_caps;
708
709	/* Flow Director shared filter space */
710	u16 fdir_shared_filter_count;
711
712	/* device profile info */
713	u8  pf_id;
714	u16 main_vsi_seid;
715
716	/* for multi-function MACs */
717	u16 partition_id;
718	u16 num_partitions;
719	u16 num_ports;
720
721	/* Closest numa node to the device */
722	u16 numa_node;
723
724	/* Admin Queue info */
725	struct i40e_adminq_info aq;
726
727	/* state of nvm update process */
728	enum i40e_nvmupd_state nvmupd_state;
729	struct i40e_aq_desc nvm_wb_desc;
730	struct i40e_aq_desc nvm_aq_event_desc;
731	struct i40e_virt_mem nvm_buff;
732	bool nvm_release_on_done;
733	u16 nvm_wait_opcode;
734
735	/* HMC info */
736	struct i40e_hmc_info hmc; /* HMC info struct */
737
738	/* LLDP/DCBX Status */
739	u16 dcbx_status;
740
741	/* DCBX info */
742	struct i40e_dcbx_config local_dcbx_config; /* Oper/Local Cfg */
743	struct i40e_dcbx_config remote_dcbx_config; /* Peer Cfg */
744	struct i40e_dcbx_config desired_dcbx_config; /* CEE Desired Cfg */
745
746	/* WoL and proxy support */
747	u16 num_wol_proxy_filters;
748	u16 wol_proxy_vsi_seid;
749
750#define I40E_HW_FLAG_AQ_SRCTL_ACCESS_ENABLE BIT_ULL(0)
751#define I40E_HW_FLAG_802_1AD_CAPABLE        BIT_ULL(1)
752#define I40E_HW_FLAG_AQ_PHY_ACCESS_CAPABLE  BIT_ULL(2)
753#define I40E_HW_FLAG_NVM_READ_REQUIRES_LOCK BIT_ULL(3)
754#define I40E_HW_FLAG_FW_LLDP_STOPPABLE	    BIT_ULL(4)
755#define I40E_HW_FLAG_FW_LLDP_PERSISTENT     BIT_ULL(5)
756#define I40E_HW_FLAG_AQ_PHY_ACCESS_EXTENDED BIT_ULL(6)
757#define I40E_HW_FLAG_DROP_MODE		    BIT_ULL(7)
758#define I40E_HW_FLAG_X722_FEC_REQUEST_CAPABLE BIT_ULL(8)
759	u64 flags;
760
761	/* Used in set switch config AQ command */
762	u16 switch_tag;
763	u16 first_tag;
764	u16 second_tag;
765
766	/* NVMUpdate features */
767	struct i40e_nvmupd_features nvmupd_features;
768
769	/* debug mask */
770	u32 debug_mask;
771	char err_str[16];
772};
773
774static INLINE bool i40e_is_vf(struct i40e_hw *hw)
775{
776	return (hw->mac.type == I40E_MAC_VF ||
777		hw->mac.type == I40E_MAC_X722_VF);
778}
779
780struct i40e_driver_version {
781	u8 major_version;
782	u8 minor_version;
783	u8 build_version;
784	u8 subbuild_version;
785	u8 driver_string[32];
786};
787
788/* RX Descriptors */
789union i40e_16byte_rx_desc {
790	struct {
791		__le64 pkt_addr; /* Packet buffer address */
792		__le64 hdr_addr; /* Header buffer address */
793	} read;
794	struct {
795		struct {
796			struct {
797				union {
798					__le16 mirroring_status;
799					__le16 fcoe_ctx_id;
800				} mirr_fcoe;
801				__le16 l2tag1;
802			} lo_dword;
803			union {
804				__le32 rss; /* RSS Hash */
805				__le32 fd_id; /* Flow director filter id */
806				__le32 fcoe_param; /* FCoE DDP Context id */
807			} hi_dword;
808		} qword0;
809		struct {
810			/* ext status/error/pktype/length */
811			__le64 status_error_len;
812		} qword1;
813	} wb;  /* writeback */
814};
815
816union i40e_32byte_rx_desc {
817	struct {
818		__le64  pkt_addr; /* Packet buffer address */
819		__le64  hdr_addr; /* Header buffer address */
820			/* bit 0 of hdr_buffer_addr is DD bit */
821		__le64  rsvd1;
822		__le64  rsvd2;
823	} read;
824	struct {
825		struct {
826			struct {
827				union {
828					__le16 mirroring_status;
829					__le16 fcoe_ctx_id;
830				} mirr_fcoe;
831				__le16 l2tag1;
832			} lo_dword;
833			union {
834				__le32 rss; /* RSS Hash */
835				__le32 fcoe_param; /* FCoE DDP Context id */
836				/* Flow director filter id in case of
837				 * Programming status desc WB
838				 */
839				__le32 fd_id;
840			} hi_dword;
841		} qword0;
842		struct {
843			/* status/error/pktype/length */
844			__le64 status_error_len;
845		} qword1;
846		struct {
847			__le16 ext_status; /* extended status */
848			__le16 rsvd;
849			__le16 l2tag2_1;
850			__le16 l2tag2_2;
851		} qword2;
852		struct {
853			union {
854				__le32 flex_bytes_lo;
855				__le32 pe_status;
856			} lo_dword;
857			union {
858				__le32 flex_bytes_hi;
859				__le32 fd_id;
860			} hi_dword;
861		} qword3;
862	} wb;  /* writeback */
863};
864
865#define I40E_RXD_QW0_MIRROR_STATUS_SHIFT	8
866#define I40E_RXD_QW0_MIRROR_STATUS_MASK	(0x3FUL << \
867					 I40E_RXD_QW0_MIRROR_STATUS_SHIFT)
868#define I40E_RXD_QW0_FCOEINDX_SHIFT	0
869#define I40E_RXD_QW0_FCOEINDX_MASK	(0xFFFUL << \
870					 I40E_RXD_QW0_FCOEINDX_SHIFT)
871
872enum i40e_rx_desc_status_bits {
873	/* Note: These are predefined bit offsets */
874	I40E_RX_DESC_STATUS_DD_SHIFT		= 0,
875	I40E_RX_DESC_STATUS_EOF_SHIFT		= 1,
876	I40E_RX_DESC_STATUS_L2TAG1P_SHIFT	= 2,
877	I40E_RX_DESC_STATUS_L3L4P_SHIFT		= 3,
878	I40E_RX_DESC_STATUS_CRCP_SHIFT		= 4,
879	I40E_RX_DESC_STATUS_TSYNINDX_SHIFT	= 5, /* 2 BITS */
880	I40E_RX_DESC_STATUS_TSYNVALID_SHIFT	= 7,
881	I40E_RX_DESC_STATUS_EXT_UDP_0_SHIFT	= 8,
882
883	I40E_RX_DESC_STATUS_UMBCAST_SHIFT	= 9, /* 2 BITS */
884	I40E_RX_DESC_STATUS_FLM_SHIFT		= 11,
885	I40E_RX_DESC_STATUS_FLTSTAT_SHIFT	= 12, /* 2 BITS */
886	I40E_RX_DESC_STATUS_LPBK_SHIFT		= 14,
887	I40E_RX_DESC_STATUS_IPV6EXADD_SHIFT	= 15,
888	I40E_RX_DESC_STATUS_RESERVED2_SHIFT	= 16, /* 2 BITS */
889	I40E_RX_DESC_STATUS_INT_UDP_0_SHIFT	= 18,
890	I40E_RX_DESC_STATUS_LAST /* this entry must be last!!! */
891};
892
893#define I40E_RXD_QW1_STATUS_SHIFT	0
894#define I40E_RXD_QW1_STATUS_MASK	((BIT(I40E_RX_DESC_STATUS_LAST) - 1) << \
895					 I40E_RXD_QW1_STATUS_SHIFT)
896
897#define I40E_RXD_QW1_STATUS_TSYNINDX_SHIFT   I40E_RX_DESC_STATUS_TSYNINDX_SHIFT
898#define I40E_RXD_QW1_STATUS_TSYNINDX_MASK	(0x3UL << \
899					     I40E_RXD_QW1_STATUS_TSYNINDX_SHIFT)
900
901#define I40E_RXD_QW1_STATUS_TSYNVALID_SHIFT  I40E_RX_DESC_STATUS_TSYNVALID_SHIFT
902#define I40E_RXD_QW1_STATUS_TSYNVALID_MASK   BIT_ULL(I40E_RXD_QW1_STATUS_TSYNVALID_SHIFT)
903
904#define I40E_RXD_QW1_STATUS_UMBCAST_SHIFT	I40E_RX_DESC_STATUS_UMBCAST
905#define I40E_RXD_QW1_STATUS_UMBCAST_MASK	(0x3UL << \
906					 I40E_RXD_QW1_STATUS_UMBCAST_SHIFT)
907
908enum i40e_rx_desc_fltstat_values {
909	I40E_RX_DESC_FLTSTAT_NO_DATA	= 0,
910	I40E_RX_DESC_FLTSTAT_RSV_FD_ID	= 1, /* 16byte desc? FD_ID : RSV */
911	I40E_RX_DESC_FLTSTAT_RSV	= 2,
912	I40E_RX_DESC_FLTSTAT_RSS_HASH	= 3,
913};
914
915#define I40E_RXD_PACKET_TYPE_UNICAST	0
916#define I40E_RXD_PACKET_TYPE_MULTICAST	1
917#define I40E_RXD_PACKET_TYPE_BROADCAST	2
918#define I40E_RXD_PACKET_TYPE_MIRRORED	3
919
920#define I40E_RXD_QW1_ERROR_SHIFT	19
921#define I40E_RXD_QW1_ERROR_MASK		(0xFFUL << I40E_RXD_QW1_ERROR_SHIFT)
922
923enum i40e_rx_desc_error_bits {
924	/* Note: These are predefined bit offsets */
925	I40E_RX_DESC_ERROR_RXE_SHIFT		= 0,
926	I40E_RX_DESC_ERROR_RECIPE_SHIFT		= 1,
927	I40E_RX_DESC_ERROR_HBO_SHIFT		= 2,
928	I40E_RX_DESC_ERROR_L3L4E_SHIFT		= 3, /* 3 BITS */
929	I40E_RX_DESC_ERROR_IPE_SHIFT		= 3,
930	I40E_RX_DESC_ERROR_L4E_SHIFT		= 4,
931	I40E_RX_DESC_ERROR_EIPE_SHIFT		= 5,
932	I40E_RX_DESC_ERROR_OVERSIZE_SHIFT	= 6,
933	I40E_RX_DESC_ERROR_PPRS_SHIFT		= 7
934};
935
936enum i40e_rx_desc_error_l3l4e_fcoe_masks {
937	I40E_RX_DESC_ERROR_L3L4E_NONE		= 0,
938	I40E_RX_DESC_ERROR_L3L4E_PROT		= 1,
939	I40E_RX_DESC_ERROR_L3L4E_FC		= 2,
940	I40E_RX_DESC_ERROR_L3L4E_DMAC_ERR	= 3,
941	I40E_RX_DESC_ERROR_L3L4E_DMAC_WARN	= 4
942};
943
944#define I40E_RXD_QW1_PTYPE_SHIFT	30
945#define I40E_RXD_QW1_PTYPE_MASK		(0xFFULL << I40E_RXD_QW1_PTYPE_SHIFT)
946
947/* Packet type non-ip values */
948enum i40e_rx_l2_ptype {
949	I40E_RX_PTYPE_L2_RESERVED			= 0,
950	I40E_RX_PTYPE_L2_MAC_PAY2			= 1,
951	I40E_RX_PTYPE_L2_TIMESYNC_PAY2			= 2,
952	I40E_RX_PTYPE_L2_FIP_PAY2			= 3,
953	I40E_RX_PTYPE_L2_OUI_PAY2			= 4,
954	I40E_RX_PTYPE_L2_MACCNTRL_PAY2			= 5,
955	I40E_RX_PTYPE_L2_LLDP_PAY2			= 6,
956	I40E_RX_PTYPE_L2_ECP_PAY2			= 7,
957	I40E_RX_PTYPE_L2_EVB_PAY2			= 8,
958	I40E_RX_PTYPE_L2_QCN_PAY2			= 9,
959	I40E_RX_PTYPE_L2_EAPOL_PAY2			= 10,
960	I40E_RX_PTYPE_L2_ARP				= 11,
961	I40E_RX_PTYPE_L2_FCOE_PAY3			= 12,
962	I40E_RX_PTYPE_L2_FCOE_FCDATA_PAY3		= 13,
963	I40E_RX_PTYPE_L2_FCOE_FCRDY_PAY3		= 14,
964	I40E_RX_PTYPE_L2_FCOE_FCRSP_PAY3		= 15,
965	I40E_RX_PTYPE_L2_FCOE_FCOTHER_PA		= 16,
966	I40E_RX_PTYPE_L2_FCOE_VFT_PAY3			= 17,
967	I40E_RX_PTYPE_L2_FCOE_VFT_FCDATA		= 18,
968	I40E_RX_PTYPE_L2_FCOE_VFT_FCRDY			= 19,
969	I40E_RX_PTYPE_L2_FCOE_VFT_FCRSP			= 20,
970	I40E_RX_PTYPE_L2_FCOE_VFT_FCOTHER		= 21,
971	I40E_RX_PTYPE_GRENAT4_MAC_PAY3			= 58,
972	I40E_RX_PTYPE_GRENAT4_MACVLAN_IPV6_ICMP_PAY4	= 87,
973	I40E_RX_PTYPE_GRENAT6_MAC_PAY3			= 124,
974	I40E_RX_PTYPE_GRENAT6_MACVLAN_IPV6_ICMP_PAY4	= 153,
975	I40E_RX_PTYPE_PARSER_ABORTED			= 255
976};
977
978struct i40e_rx_ptype_decoded {
979	u32 ptype:8;
980	u32 known:1;
981	u32 outer_ip:1;
982	u32 outer_ip_ver:1;
983	u32 outer_frag:1;
984	u32 tunnel_type:3;
985	u32 tunnel_end_prot:2;
986	u32 tunnel_end_frag:1;
987	u32 inner_prot:4;
988	u32 payload_layer:3;
989};
990
991enum i40e_rx_ptype_outer_ip {
992	I40E_RX_PTYPE_OUTER_L2	= 0,
993	I40E_RX_PTYPE_OUTER_IP	= 1
994};
995
996enum i40e_rx_ptype_outer_ip_ver {
997	I40E_RX_PTYPE_OUTER_NONE	= 0,
998	I40E_RX_PTYPE_OUTER_IPV4	= 0,
999	I40E_RX_PTYPE_OUTER_IPV6	= 1
1000};
1001
1002enum i40e_rx_ptype_outer_fragmented {
1003	I40E_RX_PTYPE_NOT_FRAG	= 0,
1004	I40E_RX_PTYPE_FRAG	= 1
1005};
1006
1007enum i40e_rx_ptype_tunnel_type {
1008	I40E_RX_PTYPE_TUNNEL_NONE		= 0,
1009	I40E_RX_PTYPE_TUNNEL_IP_IP		= 1,
1010	I40E_RX_PTYPE_TUNNEL_IP_GRENAT		= 2,
1011	I40E_RX_PTYPE_TUNNEL_IP_GRENAT_MAC	= 3,
1012	I40E_RX_PTYPE_TUNNEL_IP_GRENAT_MAC_VLAN	= 4,
1013};
1014
1015enum i40e_rx_ptype_tunnel_end_prot {
1016	I40E_RX_PTYPE_TUNNEL_END_NONE	= 0,
1017	I40E_RX_PTYPE_TUNNEL_END_IPV4	= 1,
1018	I40E_RX_PTYPE_TUNNEL_END_IPV6	= 2,
1019};
1020
1021enum i40e_rx_ptype_inner_prot {
1022	I40E_RX_PTYPE_INNER_PROT_NONE		= 0,
1023	I40E_RX_PTYPE_INNER_PROT_UDP		= 1,
1024	I40E_RX_PTYPE_INNER_PROT_TCP		= 2,
1025	I40E_RX_PTYPE_INNER_PROT_SCTP		= 3,
1026	I40E_RX_PTYPE_INNER_PROT_ICMP		= 4,
1027	I40E_RX_PTYPE_INNER_PROT_TIMESYNC	= 5
1028};
1029
1030enum i40e_rx_ptype_payload_layer {
1031	I40E_RX_PTYPE_PAYLOAD_LAYER_NONE	= 0,
1032	I40E_RX_PTYPE_PAYLOAD_LAYER_PAY2	= 1,
1033	I40E_RX_PTYPE_PAYLOAD_LAYER_PAY3	= 2,
1034	I40E_RX_PTYPE_PAYLOAD_LAYER_PAY4	= 3,
1035};
1036
1037#define I40E_RX_PTYPE_BIT_MASK		0x0FFFFFFF
1038#define I40E_RX_PTYPE_SHIFT		56
1039
1040#define I40E_RXD_QW1_LENGTH_PBUF_SHIFT	38
1041#define I40E_RXD_QW1_LENGTH_PBUF_MASK	(0x3FFFULL << \
1042					 I40E_RXD_QW1_LENGTH_PBUF_SHIFT)
1043
1044#define I40E_RXD_QW1_LENGTH_HBUF_SHIFT	52
1045#define I40E_RXD_QW1_LENGTH_HBUF_MASK	(0x7FFULL << \
1046					 I40E_RXD_QW1_LENGTH_HBUF_SHIFT)
1047
1048#define I40E_RXD_QW1_LENGTH_SPH_SHIFT	63
1049#define I40E_RXD_QW1_LENGTH_SPH_MASK	BIT_ULL(I40E_RXD_QW1_LENGTH_SPH_SHIFT)
1050
1051#define I40E_RXD_QW1_NEXTP_SHIFT	38
1052#define I40E_RXD_QW1_NEXTP_MASK		(0x1FFFULL << I40E_RXD_QW1_NEXTP_SHIFT)
1053
1054#define I40E_RXD_QW2_EXT_STATUS_SHIFT	0
1055#define I40E_RXD_QW2_EXT_STATUS_MASK	(0xFFFFFUL << \
1056					 I40E_RXD_QW2_EXT_STATUS_SHIFT)
1057
1058enum i40e_rx_desc_ext_status_bits {
1059	/* Note: These are predefined bit offsets */
1060	I40E_RX_DESC_EXT_STATUS_L2TAG2P_SHIFT	= 0,
1061	I40E_RX_DESC_EXT_STATUS_L2TAG3P_SHIFT	= 1,
1062	I40E_RX_DESC_EXT_STATUS_FLEXBL_SHIFT	= 2, /* 2 BITS */
1063	I40E_RX_DESC_EXT_STATUS_FLEXBH_SHIFT	= 4, /* 2 BITS */
1064	I40E_RX_DESC_EXT_STATUS_FDLONGB_SHIFT	= 9,
1065	I40E_RX_DESC_EXT_STATUS_FCOELONGB_SHIFT	= 10,
1066	I40E_RX_DESC_EXT_STATUS_PELONGB_SHIFT	= 11,
1067};
1068
1069#define I40E_RXD_QW2_L2TAG2_SHIFT	0
1070#define I40E_RXD_QW2_L2TAG2_MASK	(0xFFFFUL << I40E_RXD_QW2_L2TAG2_SHIFT)
1071
1072#define I40E_RXD_QW2_L2TAG3_SHIFT	16
1073#define I40E_RXD_QW2_L2TAG3_MASK	(0xFFFFUL << I40E_RXD_QW2_L2TAG3_SHIFT)
1074
1075enum i40e_rx_desc_pe_status_bits {
1076	/* Note: These are predefined bit offsets */
1077	I40E_RX_DESC_PE_STATUS_QPID_SHIFT	= 0, /* 18 BITS */
1078	I40E_RX_DESC_PE_STATUS_L4PORT_SHIFT	= 0, /* 16 BITS */
1079	I40E_RX_DESC_PE_STATUS_IPINDEX_SHIFT	= 16, /* 8 BITS */
1080	I40E_RX_DESC_PE_STATUS_QPIDHIT_SHIFT	= 24,
1081	I40E_RX_DESC_PE_STATUS_APBVTHIT_SHIFT	= 25,
1082	I40E_RX_DESC_PE_STATUS_PORTV_SHIFT	= 26,
1083	I40E_RX_DESC_PE_STATUS_URG_SHIFT	= 27,
1084	I40E_RX_DESC_PE_STATUS_IPFRAG_SHIFT	= 28,
1085	I40E_RX_DESC_PE_STATUS_IPOPT_SHIFT	= 29
1086};
1087
1088#define I40E_RX_PROG_STATUS_DESC_LENGTH_SHIFT		38
1089#define I40E_RX_PROG_STATUS_DESC_LENGTH			0x2000000
1090
1091#define I40E_RX_PROG_STATUS_DESC_QW1_PROGID_SHIFT	2
1092#define I40E_RX_PROG_STATUS_DESC_QW1_PROGID_MASK	(0x7UL << \
1093				I40E_RX_PROG_STATUS_DESC_QW1_PROGID_SHIFT)
1094
1095#define I40E_RX_PROG_STATUS_DESC_QW1_STATUS_SHIFT	0
1096#define I40E_RX_PROG_STATUS_DESC_QW1_STATUS_MASK	(0x7FFFUL << \
1097				I40E_RX_PROG_STATUS_DESC_QW1_STATUS_SHIFT)
1098
1099#define I40E_RX_PROG_STATUS_DESC_QW1_ERROR_SHIFT	19
1100#define I40E_RX_PROG_STATUS_DESC_QW1_ERROR_MASK		(0x3FUL << \
1101				I40E_RX_PROG_STATUS_DESC_QW1_ERROR_SHIFT)
1102
1103enum i40e_rx_prog_status_desc_status_bits {
1104	/* Note: These are predefined bit offsets */
1105	I40E_RX_PROG_STATUS_DESC_DD_SHIFT	= 0,
1106	I40E_RX_PROG_STATUS_DESC_PROG_ID_SHIFT	= 2 /* 3 BITS */
1107};
1108
1109enum i40e_rx_prog_status_desc_prog_id_masks {
1110	I40E_RX_PROG_STATUS_DESC_FD_FILTER_STATUS	= 1,
1111	I40E_RX_PROG_STATUS_DESC_FCOE_CTXT_PROG_STATUS	= 2,
1112	I40E_RX_PROG_STATUS_DESC_FCOE_CTXT_INVL_STATUS	= 4,
1113};
1114
1115enum i40e_rx_prog_status_desc_error_bits {
1116	/* Note: These are predefined bit offsets */
1117	I40E_RX_PROG_STATUS_DESC_FD_TBL_FULL_SHIFT	= 0,
1118	I40E_RX_PROG_STATUS_DESC_NO_FD_ENTRY_SHIFT	= 1,
1119	I40E_RX_PROG_STATUS_DESC_FCOE_TBL_FULL_SHIFT	= 2,
1120	I40E_RX_PROG_STATUS_DESC_FCOE_CONFLICT_SHIFT	= 3
1121};
1122
1123#define I40E_TWO_BIT_MASK	0x3
1124#define I40E_THREE_BIT_MASK	0x7
1125#define I40E_FOUR_BIT_MASK	0xF
1126#define I40E_EIGHTEEN_BIT_MASK	0x3FFFF
1127
1128/* TX Descriptor */
1129struct i40e_tx_desc {
1130	__le64 buffer_addr; /* Address of descriptor's data buf */
1131	__le64 cmd_type_offset_bsz;
1132};
1133
1134#define I40E_TXD_QW1_DTYPE_SHIFT	0
1135#define I40E_TXD_QW1_DTYPE_MASK		(0xFUL << I40E_TXD_QW1_DTYPE_SHIFT)
1136
1137enum i40e_tx_desc_dtype_value {
1138	I40E_TX_DESC_DTYPE_DATA		= 0x0,
1139	I40E_TX_DESC_DTYPE_NOP		= 0x1, /* same as Context desc */
1140	I40E_TX_DESC_DTYPE_CONTEXT	= 0x1,
1141	I40E_TX_DESC_DTYPE_FCOE_CTX	= 0x2,
1142	I40E_TX_DESC_DTYPE_FILTER_PROG	= 0x8,
1143	I40E_TX_DESC_DTYPE_DDP_CTX	= 0x9,
1144	I40E_TX_DESC_DTYPE_FLEX_DATA	= 0xB,
1145	I40E_TX_DESC_DTYPE_FLEX_CTX_1	= 0xC,
1146	I40E_TX_DESC_DTYPE_FLEX_CTX_2	= 0xD,
1147	I40E_TX_DESC_DTYPE_DESC_DONE	= 0xF
1148};
1149
1150#define I40E_TXD_QW1_CMD_SHIFT	4
1151#define I40E_TXD_QW1_CMD_MASK	(0x3FFUL << I40E_TXD_QW1_CMD_SHIFT)
1152
1153enum i40e_tx_desc_cmd_bits {
1154	I40E_TX_DESC_CMD_EOP			= 0x0001,
1155	I40E_TX_DESC_CMD_RS			= 0x0002,
1156	I40E_TX_DESC_CMD_ICRC			= 0x0004,
1157	I40E_TX_DESC_CMD_IL2TAG1		= 0x0008,
1158	I40E_TX_DESC_CMD_DUMMY			= 0x0010,
1159	I40E_TX_DESC_CMD_IIPT_NONIP		= 0x0000, /* 2 BITS */
1160	I40E_TX_DESC_CMD_IIPT_IPV6		= 0x0020, /* 2 BITS */
1161	I40E_TX_DESC_CMD_IIPT_IPV4		= 0x0040, /* 2 BITS */
1162	I40E_TX_DESC_CMD_IIPT_IPV4_CSUM		= 0x0060, /* 2 BITS */
1163	I40E_TX_DESC_CMD_FCOET			= 0x0080,
1164	I40E_TX_DESC_CMD_L4T_EOFT_UNK		= 0x0000, /* 2 BITS */
1165	I40E_TX_DESC_CMD_L4T_EOFT_TCP		= 0x0100, /* 2 BITS */
1166	I40E_TX_DESC_CMD_L4T_EOFT_SCTP		= 0x0200, /* 2 BITS */
1167	I40E_TX_DESC_CMD_L4T_EOFT_UDP		= 0x0300, /* 2 BITS */
1168	I40E_TX_DESC_CMD_L4T_EOFT_EOF_N		= 0x0000, /* 2 BITS */
1169	I40E_TX_DESC_CMD_L4T_EOFT_EOF_T		= 0x0100, /* 2 BITS */
1170	I40E_TX_DESC_CMD_L4T_EOFT_EOF_NI	= 0x0200, /* 2 BITS */
1171	I40E_TX_DESC_CMD_L4T_EOFT_EOF_A		= 0x0300, /* 2 BITS */
1172};
1173
1174#define I40E_TXD_QW1_OFFSET_SHIFT	16
1175#define I40E_TXD_QW1_OFFSET_MASK	(0x3FFFFULL << \
1176					 I40E_TXD_QW1_OFFSET_SHIFT)
1177
1178enum i40e_tx_desc_length_fields {
1179	/* Note: These are predefined bit offsets */
1180	I40E_TX_DESC_LENGTH_MACLEN_SHIFT	= 0, /* 7 BITS */
1181	I40E_TX_DESC_LENGTH_IPLEN_SHIFT		= 7, /* 7 BITS */
1182	I40E_TX_DESC_LENGTH_L4_FC_LEN_SHIFT	= 14 /* 4 BITS */
1183};
1184
1185#define I40E_TXD_QW1_MACLEN_MASK (0x7FUL << I40E_TX_DESC_LENGTH_MACLEN_SHIFT)
1186#define I40E_TXD_QW1_IPLEN_MASK  (0x7FUL << I40E_TX_DESC_LENGTH_IPLEN_SHIFT)
1187#define I40E_TXD_QW1_L4LEN_MASK  (0xFUL << I40E_TX_DESC_LENGTH_L4_FC_LEN_SHIFT)
1188#define I40E_TXD_QW1_FCLEN_MASK  (0xFUL << I40E_TX_DESC_LENGTH_L4_FC_LEN_SHIFT)
1189
1190#define I40E_TXD_QW1_TX_BUF_SZ_SHIFT	34
1191#define I40E_TXD_QW1_TX_BUF_SZ_MASK	(0x3FFFULL << \
1192					 I40E_TXD_QW1_TX_BUF_SZ_SHIFT)
1193
1194#define I40E_TXD_QW1_L2TAG1_SHIFT	48
1195#define I40E_TXD_QW1_L2TAG1_MASK	(0xFFFFULL << I40E_TXD_QW1_L2TAG1_SHIFT)
1196
1197/* Context descriptors */
1198struct i40e_tx_context_desc {
1199	__le32 tunneling_params;
1200	__le16 l2tag2;
1201	__le16 rsvd;
1202	__le64 type_cmd_tso_mss;
1203};
1204
1205#define I40E_TXD_CTX_QW1_DTYPE_SHIFT	0
1206#define I40E_TXD_CTX_QW1_DTYPE_MASK	(0xFUL << I40E_TXD_CTX_QW1_DTYPE_SHIFT)
1207
1208#define I40E_TXD_CTX_QW1_CMD_SHIFT	4
1209#define I40E_TXD_CTX_QW1_CMD_MASK	(0xFFFFUL << I40E_TXD_CTX_QW1_CMD_SHIFT)
1210
1211enum i40e_tx_ctx_desc_cmd_bits {
1212	I40E_TX_CTX_DESC_TSO		= 0x01,
1213	I40E_TX_CTX_DESC_TSYN		= 0x02,
1214	I40E_TX_CTX_DESC_IL2TAG2	= 0x04,
1215	I40E_TX_CTX_DESC_IL2TAG2_IL2H	= 0x08,
1216	I40E_TX_CTX_DESC_SWTCH_NOTAG	= 0x00,
1217	I40E_TX_CTX_DESC_SWTCH_UPLINK	= 0x10,
1218	I40E_TX_CTX_DESC_SWTCH_LOCAL	= 0x20,
1219	I40E_TX_CTX_DESC_SWTCH_VSI	= 0x30,
1220	I40E_TX_CTX_DESC_SWPE		= 0x40
1221};
1222
1223#define I40E_TXD_CTX_QW1_TSO_LEN_SHIFT	30
1224#define I40E_TXD_CTX_QW1_TSO_LEN_MASK	(0x3FFFFULL << \
1225					 I40E_TXD_CTX_QW1_TSO_LEN_SHIFT)
1226
1227#define I40E_TXD_CTX_QW1_MSS_SHIFT	50
1228#define I40E_TXD_CTX_QW1_MSS_MASK	(0x3FFFULL << \
1229					 I40E_TXD_CTX_QW1_MSS_SHIFT)
1230
1231#define I40E_TXD_CTX_QW1_VSI_SHIFT	50
1232#define I40E_TXD_CTX_QW1_VSI_MASK	(0x1FFULL << I40E_TXD_CTX_QW1_VSI_SHIFT)
1233
1234#define I40E_TXD_CTX_QW0_EXT_IP_SHIFT	0
1235#define I40E_TXD_CTX_QW0_EXT_IP_MASK	(0x3ULL << \
1236					 I40E_TXD_CTX_QW0_EXT_IP_SHIFT)
1237
1238enum i40e_tx_ctx_desc_eipt_offload {
1239	I40E_TX_CTX_EXT_IP_NONE		= 0x0,
1240	I40E_TX_CTX_EXT_IP_IPV6		= 0x1,
1241	I40E_TX_CTX_EXT_IP_IPV4_NO_CSUM	= 0x2,
1242	I40E_TX_CTX_EXT_IP_IPV4		= 0x3
1243};
1244
1245#define I40E_TXD_CTX_QW0_EXT_IPLEN_SHIFT	2
1246#define I40E_TXD_CTX_QW0_EXT_IPLEN_MASK	(0x3FULL << \
1247					 I40E_TXD_CTX_QW0_EXT_IPLEN_SHIFT)
1248
1249#define I40E_TXD_CTX_QW0_NATT_SHIFT	9
1250#define I40E_TXD_CTX_QW0_NATT_MASK	(0x3ULL << I40E_TXD_CTX_QW0_NATT_SHIFT)
1251
1252#define I40E_TXD_CTX_UDP_TUNNELING	BIT_ULL(I40E_TXD_CTX_QW0_NATT_SHIFT)
1253#define I40E_TXD_CTX_GRE_TUNNELING	(0x2ULL << I40E_TXD_CTX_QW0_NATT_SHIFT)
1254
1255#define I40E_TXD_CTX_QW0_EIP_NOINC_SHIFT	11
1256#define I40E_TXD_CTX_QW0_EIP_NOINC_MASK	BIT_ULL(I40E_TXD_CTX_QW0_EIP_NOINC_SHIFT)
1257
1258#define I40E_TXD_CTX_EIP_NOINC_IPID_CONST	I40E_TXD_CTX_QW0_EIP_NOINC_MASK
1259
1260#define I40E_TXD_CTX_QW0_NATLEN_SHIFT	12
1261#define I40E_TXD_CTX_QW0_NATLEN_MASK	(0X7FULL << \
1262					 I40E_TXD_CTX_QW0_NATLEN_SHIFT)
1263
1264#define I40E_TXD_CTX_QW0_DECTTL_SHIFT	19
1265#define I40E_TXD_CTX_QW0_DECTTL_MASK	(0xFULL << \
1266					 I40E_TXD_CTX_QW0_DECTTL_SHIFT)
1267
1268#define I40E_TXD_CTX_QW0_L4T_CS_SHIFT	23
1269#define I40E_TXD_CTX_QW0_L4T_CS_MASK	BIT_ULL(I40E_TXD_CTX_QW0_L4T_CS_SHIFT)
1270struct i40e_nop_desc {
1271	__le64 rsvd;
1272	__le64 dtype_cmd;
1273};
1274
1275#define I40E_TXD_NOP_QW1_DTYPE_SHIFT	0
1276#define I40E_TXD_NOP_QW1_DTYPE_MASK	(0xFUL << I40E_TXD_NOP_QW1_DTYPE_SHIFT)
1277
1278#define I40E_TXD_NOP_QW1_CMD_SHIFT	4
1279#define I40E_TXD_NOP_QW1_CMD_MASK	(0x7FUL << I40E_TXD_NOP_QW1_CMD_SHIFT)
1280
1281enum i40e_tx_nop_desc_cmd_bits {
1282	/* Note: These are predefined bit offsets */
1283	I40E_TX_NOP_DESC_EOP_SHIFT	= 0,
1284	I40E_TX_NOP_DESC_RS_SHIFT	= 1,
1285	I40E_TX_NOP_DESC_RSV_SHIFT	= 2 /* 5 bits */
1286};
1287
1288struct i40e_filter_program_desc {
1289	__le32 qindex_flex_ptype_vsi;
1290	__le32 rsvd;
1291	__le32 dtype_cmd_cntindex;
1292	__le32 fd_id;
1293};
1294#define I40E_TXD_FLTR_QW0_QINDEX_SHIFT	0
1295#define I40E_TXD_FLTR_QW0_QINDEX_MASK	(0x7FFUL << \
1296					 I40E_TXD_FLTR_QW0_QINDEX_SHIFT)
1297#define I40E_TXD_FLTR_QW0_FLEXOFF_SHIFT	11
1298#define I40E_TXD_FLTR_QW0_FLEXOFF_MASK	(0x7UL << \
1299					 I40E_TXD_FLTR_QW0_FLEXOFF_SHIFT)
1300#define I40E_TXD_FLTR_QW0_PCTYPE_SHIFT	17
1301#define I40E_TXD_FLTR_QW0_PCTYPE_MASK	(0x3FUL << \
1302					 I40E_TXD_FLTR_QW0_PCTYPE_SHIFT)
1303
1304/* Packet Classifier Types for filters */
1305enum i40e_filter_pctype {
1306	/* Note: Values 0-28 are reserved for future use.
1307	 * Value 29, 30, 32 are not supported on XL710 and X710.
1308	 */
1309	I40E_FILTER_PCTYPE_NONF_UNICAST_IPV4_UDP	= 29,
1310	I40E_FILTER_PCTYPE_NONF_MULTICAST_IPV4_UDP	= 30,
1311	I40E_FILTER_PCTYPE_NONF_IPV4_UDP		= 31,
1312	I40E_FILTER_PCTYPE_NONF_IPV4_TCP_SYN_NO_ACK	= 32,
1313	I40E_FILTER_PCTYPE_NONF_IPV4_TCP		= 33,
1314	I40E_FILTER_PCTYPE_NONF_IPV4_SCTP		= 34,
1315	I40E_FILTER_PCTYPE_NONF_IPV4_OTHER		= 35,
1316	I40E_FILTER_PCTYPE_FRAG_IPV4			= 36,
1317	/* Note: Values 37-38 are reserved for future use.
1318	 * Value 39, 40, 42 are not supported on XL710 and X710.
1319	 */
1320	I40E_FILTER_PCTYPE_NONF_UNICAST_IPV6_UDP	= 39,
1321	I40E_FILTER_PCTYPE_NONF_MULTICAST_IPV6_UDP	= 40,
1322	I40E_FILTER_PCTYPE_NONF_IPV6_UDP		= 41,
1323	I40E_FILTER_PCTYPE_NONF_IPV6_TCP_SYN_NO_ACK	= 42,
1324	I40E_FILTER_PCTYPE_NONF_IPV6_TCP		= 43,
1325	I40E_FILTER_PCTYPE_NONF_IPV6_SCTP		= 44,
1326	I40E_FILTER_PCTYPE_NONF_IPV6_OTHER		= 45,
1327	I40E_FILTER_PCTYPE_FRAG_IPV6			= 46,
1328	/* Note: Value 47 is reserved for future use */
1329	I40E_FILTER_PCTYPE_FCOE_OX			= 48,
1330	I40E_FILTER_PCTYPE_FCOE_RX			= 49,
1331	I40E_FILTER_PCTYPE_FCOE_OTHER			= 50,
1332	/* Note: Values 51-62 are reserved for future use */
1333	I40E_FILTER_PCTYPE_L2_PAYLOAD			= 63,
1334};
1335
1336enum i40e_filter_program_desc_dest {
1337	I40E_FILTER_PROGRAM_DESC_DEST_DROP_PACKET		= 0x0,
1338	I40E_FILTER_PROGRAM_DESC_DEST_DIRECT_PACKET_QINDEX	= 0x1,
1339	I40E_FILTER_PROGRAM_DESC_DEST_DIRECT_PACKET_OTHER	= 0x2,
1340};
1341
1342enum i40e_filter_program_desc_fd_status {
1343	I40E_FILTER_PROGRAM_DESC_FD_STATUS_NONE			= 0x0,
1344	I40E_FILTER_PROGRAM_DESC_FD_STATUS_FD_ID		= 0x1,
1345	I40E_FILTER_PROGRAM_DESC_FD_STATUS_FD_ID_4FLEX_BYTES	= 0x2,
1346	I40E_FILTER_PROGRAM_DESC_FD_STATUS_8FLEX_BYTES		= 0x3,
1347};
1348
1349#define I40E_TXD_FLTR_QW0_DEST_VSI_SHIFT	23
1350#define I40E_TXD_FLTR_QW0_DEST_VSI_MASK	(0x1FFUL << \
1351					 I40E_TXD_FLTR_QW0_DEST_VSI_SHIFT)
1352
1353#define I40E_TXD_FLTR_QW1_DTYPE_SHIFT	0
1354#define I40E_TXD_FLTR_QW1_DTYPE_MASK	(0xFUL << I40E_TXD_FLTR_QW1_DTYPE_SHIFT)
1355
1356#define I40E_TXD_FLTR_QW1_CMD_SHIFT	4
1357#define I40E_TXD_FLTR_QW1_CMD_MASK	(0xFFFFULL << \
1358					 I40E_TXD_FLTR_QW1_CMD_SHIFT)
1359
1360#define I40E_TXD_FLTR_QW1_PCMD_SHIFT	(0x0ULL + I40E_TXD_FLTR_QW1_CMD_SHIFT)
1361#define I40E_TXD_FLTR_QW1_PCMD_MASK	(0x7ULL << I40E_TXD_FLTR_QW1_PCMD_SHIFT)
1362
1363enum i40e_filter_program_desc_pcmd {
1364	I40E_FILTER_PROGRAM_DESC_PCMD_ADD_UPDATE	= 0x1,
1365	I40E_FILTER_PROGRAM_DESC_PCMD_REMOVE		= 0x2,
1366};
1367
1368#define I40E_TXD_FLTR_QW1_DEST_SHIFT	(0x3ULL + I40E_TXD_FLTR_QW1_CMD_SHIFT)
1369#define I40E_TXD_FLTR_QW1_DEST_MASK	(0x3ULL << I40E_TXD_FLTR_QW1_DEST_SHIFT)
1370
1371#define I40E_TXD_FLTR_QW1_CNT_ENA_SHIFT	(0x7ULL + I40E_TXD_FLTR_QW1_CMD_SHIFT)
1372#define I40E_TXD_FLTR_QW1_CNT_ENA_MASK	BIT_ULL(I40E_TXD_FLTR_QW1_CNT_ENA_SHIFT)
1373
1374#define I40E_TXD_FLTR_QW1_FD_STATUS_SHIFT	(0x9ULL + \
1375						 I40E_TXD_FLTR_QW1_CMD_SHIFT)
1376#define I40E_TXD_FLTR_QW1_FD_STATUS_MASK (0x3ULL << \
1377					  I40E_TXD_FLTR_QW1_FD_STATUS_SHIFT)
1378
1379#define I40E_TXD_FLTR_QW1_ATR_SHIFT	(0xEULL + \
1380					 I40E_TXD_FLTR_QW1_CMD_SHIFT)
1381#define I40E_TXD_FLTR_QW1_ATR_MASK	BIT_ULL(I40E_TXD_FLTR_QW1_ATR_SHIFT)
1382
1383#define I40E_TXD_FLTR_QW1_CNTINDEX_SHIFT 20
1384#define I40E_TXD_FLTR_QW1_CNTINDEX_MASK	(0x1FFUL << \
1385					 I40E_TXD_FLTR_QW1_CNTINDEX_SHIFT)
1386
1387enum i40e_filter_type {
1388	I40E_FLOW_DIRECTOR_FLTR = 0,
1389	I40E_PE_QUAD_HASH_FLTR = 1,
1390	I40E_ETHERTYPE_FLTR,
1391	I40E_FCOE_CTX_FLTR,
1392	I40E_MAC_VLAN_FLTR,
1393	I40E_HASH_FLTR
1394};
1395
1396struct i40e_vsi_context {
1397	u16 seid;
1398	u16 uplink_seid;
1399	u16 vsi_number;
1400	u16 vsis_allocated;
1401	u16 vsis_unallocated;
1402	u16 flags;
1403	u8 pf_num;
1404	u8 vf_num;
1405	u8 connection_type;
1406	struct i40e_aqc_vsi_properties_data info;
1407};
1408
1409struct i40e_veb_context {
1410	u16 seid;
1411	u16 uplink_seid;
1412	u16 veb_number;
1413	u16 vebs_allocated;
1414	u16 vebs_unallocated;
1415	u16 flags;
1416	struct i40e_aqc_get_veb_parameters_completion info;
1417};
1418
1419/* Statistics collected by each port, VSI, VEB, and S-channel */
1420struct i40e_eth_stats {
1421	u64 rx_bytes;			/* gorc */
1422	u64 rx_unicast;			/* uprc */
1423	u64 rx_multicast;		/* mprc */
1424	u64 rx_broadcast;		/* bprc */
1425	u64 rx_discards;		/* rdpc */
1426	u64 rx_unknown_protocol;	/* rupp */
1427	u64 tx_bytes;			/* gotc */
1428	u64 tx_unicast;			/* uptc */
1429	u64 tx_multicast;		/* mptc */
1430	u64 tx_broadcast;		/* bptc */
1431	u64 tx_discards;		/* tdpc */
1432	u64 tx_errors;			/* tepc */
1433};
1434
1435/* Statistics collected per VEB per TC */
1436struct i40e_veb_tc_stats {
1437	u64 tc_rx_packets[I40E_MAX_TRAFFIC_CLASS];
1438	u64 tc_rx_bytes[I40E_MAX_TRAFFIC_CLASS];
1439	u64 tc_tx_packets[I40E_MAX_TRAFFIC_CLASS];
1440	u64 tc_tx_bytes[I40E_MAX_TRAFFIC_CLASS];
1441};
1442
1443/* Statistics collected by the MAC */
1444struct i40e_hw_port_stats {
1445	/* eth stats collected by the port */
1446	struct i40e_eth_stats eth;
1447
1448	/* additional port specific stats */
1449	u64 tx_dropped_link_down;	/* tdold */
1450	u64 crc_errors;			/* crcerrs */
1451	u64 illegal_bytes;		/* illerrc */
1452	u64 error_bytes;		/* errbc */
1453	u64 mac_local_faults;		/* mlfc */
1454	u64 mac_remote_faults;		/* mrfc */
1455	u64 rx_length_errors;		/* rlec */
1456	u64 link_xon_rx;		/* lxonrxc */
1457	u64 link_xoff_rx;		/* lxoffrxc */
1458	u64 priority_xon_rx[8];		/* pxonrxc[8] */
1459	u64 priority_xoff_rx[8];	/* pxoffrxc[8] */
1460	u64 link_xon_tx;		/* lxontxc */
1461	u64 link_xoff_tx;		/* lxofftxc */
1462	u64 priority_xon_tx[8];		/* pxontxc[8] */
1463	u64 priority_xoff_tx[8];	/* pxofftxc[8] */
1464	u64 priority_xon_2_xoff[8];	/* pxon2offc[8] */
1465	u64 rx_size_64;			/* prc64 */
1466	u64 rx_size_127;		/* prc127 */
1467	u64 rx_size_255;		/* prc255 */
1468	u64 rx_size_511;		/* prc511 */
1469	u64 rx_size_1023;		/* prc1023 */
1470	u64 rx_size_1522;		/* prc1522 */
1471	u64 rx_size_big;		/* prc9522 */
1472	u64 rx_undersize;		/* ruc */
1473	u64 rx_fragments;		/* rfc */
1474	u64 rx_oversize;		/* roc */
1475	u64 rx_jabber;			/* rjc */
1476	u64 tx_size_64;			/* ptc64 */
1477	u64 tx_size_127;		/* ptc127 */
1478	u64 tx_size_255;		/* ptc255 */
1479	u64 tx_size_511;		/* ptc511 */
1480	u64 tx_size_1023;		/* ptc1023 */
1481	u64 tx_size_1522;		/* ptc1522 */
1482	u64 tx_size_big;		/* ptc9522 */
1483	u64 mac_short_packet_dropped;	/* mspdc */
1484	u64 checksum_error;		/* xec */
1485	/* flow director stats */
1486	u64 fd_atr_match;
1487	u64 fd_sb_match;
1488	u64 fd_atr_tunnel_match;
1489	u32 fd_atr_status;
1490	u32 fd_sb_status;
1491	/* EEE LPI */
1492	u32 tx_lpi_status;
1493	u32 rx_lpi_status;
1494	u64 tx_lpi_count;		/* etlpic */
1495	u64 rx_lpi_count;		/* erlpic */
1496	u64 tx_lpi_duration;
1497	u64 rx_lpi_duration;
1498};
1499
1500/* Checksum and Shadow RAM pointers */
1501#define I40E_SR_NVM_CONTROL_WORD		0x00
1502#define I40E_SR_PCIE_ANALOG_CONFIG_PTR		0x03
1503#define I40E_SR_PHY_ANALOG_CONFIG_PTR		0x04
1504#define I40E_SR_OPTION_ROM_PTR			0x05
1505#define I40E_SR_RO_PCIR_REGS_AUTO_LOAD_PTR	0x06
1506#define I40E_SR_AUTO_GENERATED_POINTERS_PTR	0x07
1507#define I40E_SR_PCIR_REGS_AUTO_LOAD_PTR		0x08
1508#define I40E_SR_EMP_GLOBAL_MODULE_PTR		0x09
1509#define I40E_SR_RO_PCIE_LCB_PTR			0x0A
1510#define I40E_SR_EMP_IMAGE_PTR			0x0B
1511#define I40E_SR_PE_IMAGE_PTR			0x0C
1512#define I40E_SR_CSR_PROTECTED_LIST_PTR		0x0D
1513#define I40E_SR_MNG_CONFIG_PTR			0x0E
1514#define I40E_EMP_MODULE_PTR			0x0F
1515#define I40E_SR_EMP_MODULE_PTR			0x48
1516#define I40E_SR_PBA_FLAGS			0x15
1517#define I40E_SR_PBA_BLOCK_PTR			0x16
1518#define I40E_SR_BOOT_CONFIG_PTR			0x17
1519#define I40E_NVM_OEM_VER_OFF			0x83
1520#define I40E_SR_NVM_DEV_STARTER_VERSION		0x18
1521#define I40E_SR_NVM_WAKE_ON_LAN			0x19
1522#define I40E_SR_ALTERNATE_SAN_MAC_ADDRESS_PTR	0x27
1523#define I40E_SR_PERMANENT_SAN_MAC_ADDRESS_PTR	0x28
1524#define I40E_SR_NVM_MAP_VERSION			0x29
1525#define I40E_SR_NVM_IMAGE_VERSION		0x2A
1526#define I40E_SR_NVM_STRUCTURE_VERSION		0x2B
1527#define I40E_SR_NVM_EETRACK_LO			0x2D
1528#define I40E_SR_NVM_EETRACK_HI			0x2E
1529#define I40E_SR_VPD_PTR				0x2F
1530#define I40E_SR_PXE_SETUP_PTR			0x30
1531#define I40E_SR_PXE_CONFIG_CUST_OPTIONS_PTR	0x31
1532#define I40E_SR_NVM_ORIGINAL_EETRACK_LO		0x34
1533#define I40E_SR_NVM_ORIGINAL_EETRACK_HI		0x35
1534#define I40E_SR_SW_ETHERNET_MAC_ADDRESS_PTR	0x37
1535#define I40E_SR_POR_REGS_AUTO_LOAD_PTR		0x38
1536#define I40E_SR_EMPR_REGS_AUTO_LOAD_PTR		0x3A
1537#define I40E_SR_GLOBR_REGS_AUTO_LOAD_PTR	0x3B
1538#define I40E_SR_CORER_REGS_AUTO_LOAD_PTR	0x3C
1539#define I40E_SR_PHY_ACTIVITY_LIST_PTR		0x3D
1540#define I40E_SR_PCIE_ALT_AUTO_LOAD_PTR		0x3E
1541#define I40E_SR_SW_CHECKSUM_WORD		0x3F
1542#define I40E_SR_1ST_FREE_PROVISION_AREA_PTR	0x40
1543#define I40E_SR_4TH_FREE_PROVISION_AREA_PTR	0x42
1544#define I40E_SR_3RD_FREE_PROVISION_AREA_PTR	0x44
1545#define I40E_SR_2ND_FREE_PROVISION_AREA_PTR	0x46
1546#define I40E_SR_EMP_SR_SETTINGS_PTR		0x48
1547#define I40E_SR_FEATURE_CONFIGURATION_PTR	0x49
1548#define I40E_SR_CONFIGURATION_METADATA_PTR	0x4D
1549#define I40E_SR_IMMEDIATE_VALUES_PTR		0x4E
1550#define I40E_SR_5TH_FREE_PROVISION_AREA_PTR	0x50
1551#define I40E_SR_PRESERVATION_RULES_PTR		0x70
1552#define I40E_FPK_SR_5TH_FREE_PROVISION_AREA_PTR	0x71
1553#define I40E_SR_6TH_FREE_PROVISION_AREA_PTR	0x71
1554
1555/* Auxiliary field, mask and shift definition for Shadow RAM and NVM Flash */
1556#define I40E_SR_VPD_MODULE_MAX_SIZE		1024
1557#define I40E_SR_PCIE_ALT_MODULE_MAX_SIZE	1024
1558#define I40E_SR_CONTROL_WORD_1_SHIFT		0x06
1559#define I40E_SR_CONTROL_WORD_1_MASK	(0x03 << I40E_SR_CONTROL_WORD_1_SHIFT)
1560#define I40E_SR_CONTROL_WORD_1_NVM_BANK_VALID	BIT(5)
1561#define I40E_SR_NVM_MAP_STRUCTURE_TYPE		BIT(12)
1562#define I40E_PTR_TYPE				BIT(15)
1563#define I40E_SR_OCP_CFG_WORD0			0x2B
1564#define I40E_SR_OCP_ENABLED			BIT(15)
1565
1566/* Shadow RAM related */
1567#define I40E_SR_SECTOR_SIZE_IN_WORDS	0x800
1568#define I40E_SR_BUF_ALIGNMENT		4096
1569#define I40E_SR_WORDS_IN_1KB		512
1570/* Checksum should be calculated such that after adding all the words,
1571 * including the checksum word itself, the sum should be 0xBABA.
1572 */
1573#define I40E_SR_SW_CHECKSUM_BASE	0xBABA
1574
1575#define I40E_SRRD_SRCTL_ATTEMPTS	100000
1576
1577enum i40e_switch_element_types {
1578	I40E_SWITCH_ELEMENT_TYPE_MAC	= 1,
1579	I40E_SWITCH_ELEMENT_TYPE_PF	= 2,
1580	I40E_SWITCH_ELEMENT_TYPE_VF	= 3,
1581	I40E_SWITCH_ELEMENT_TYPE_EMP	= 4,
1582	I40E_SWITCH_ELEMENT_TYPE_BMC	= 6,
1583	I40E_SWITCH_ELEMENT_TYPE_PE	= 16,
1584	I40E_SWITCH_ELEMENT_TYPE_VEB	= 17,
1585	I40E_SWITCH_ELEMENT_TYPE_PA	= 18,
1586	I40E_SWITCH_ELEMENT_TYPE_VSI	= 19,
1587};
1588
1589/* Supported EtherType filters */
1590enum i40e_ether_type_index {
1591	I40E_ETHER_TYPE_1588		= 0,
1592	I40E_ETHER_TYPE_FIP		= 1,
1593	I40E_ETHER_TYPE_OUI_EXTENDED	= 2,
1594	I40E_ETHER_TYPE_MAC_CONTROL	= 3,
1595	I40E_ETHER_TYPE_LLDP		= 4,
1596	I40E_ETHER_TYPE_EVB_PROTOCOL1	= 5,
1597	I40E_ETHER_TYPE_EVB_PROTOCOL2	= 6,
1598	I40E_ETHER_TYPE_QCN_CNM		= 7,
1599	I40E_ETHER_TYPE_8021X		= 8,
1600	I40E_ETHER_TYPE_ARP		= 9,
1601	I40E_ETHER_TYPE_RSV1		= 10,
1602	I40E_ETHER_TYPE_RSV2		= 11,
1603};
1604
1605/* Filter context base size is 1K */
1606#define I40E_HASH_FILTER_BASE_SIZE	1024
1607/* Supported Hash filter values */
1608enum i40e_hash_filter_size {
1609	I40E_HASH_FILTER_SIZE_1K	= 0,
1610	I40E_HASH_FILTER_SIZE_2K	= 1,
1611	I40E_HASH_FILTER_SIZE_4K	= 2,
1612	I40E_HASH_FILTER_SIZE_8K	= 3,
1613	I40E_HASH_FILTER_SIZE_16K	= 4,
1614	I40E_HASH_FILTER_SIZE_32K	= 5,
1615	I40E_HASH_FILTER_SIZE_64K	= 6,
1616	I40E_HASH_FILTER_SIZE_128K	= 7,
1617	I40E_HASH_FILTER_SIZE_256K	= 8,
1618	I40E_HASH_FILTER_SIZE_512K	= 9,
1619	I40E_HASH_FILTER_SIZE_1M	= 10,
1620};
1621
1622/* DMA context base size is 0.5K */
1623#define I40E_DMA_CNTX_BASE_SIZE		512
1624/* Supported DMA context values */
1625enum i40e_dma_cntx_size {
1626	I40E_DMA_CNTX_SIZE_512		= 0,
1627	I40E_DMA_CNTX_SIZE_1K		= 1,
1628	I40E_DMA_CNTX_SIZE_2K		= 2,
1629	I40E_DMA_CNTX_SIZE_4K		= 3,
1630	I40E_DMA_CNTX_SIZE_8K		= 4,
1631	I40E_DMA_CNTX_SIZE_16K		= 5,
1632	I40E_DMA_CNTX_SIZE_32K		= 6,
1633	I40E_DMA_CNTX_SIZE_64K		= 7,
1634	I40E_DMA_CNTX_SIZE_128K		= 8,
1635	I40E_DMA_CNTX_SIZE_256K		= 9,
1636};
1637
1638/* Supported Hash look up table (LUT) sizes */
1639enum i40e_hash_lut_size {
1640	I40E_HASH_LUT_SIZE_128		= 0,
1641	I40E_HASH_LUT_SIZE_512		= 1,
1642};
1643
1644/* Structure to hold a per PF filter control settings */
1645struct i40e_filter_control_settings {
1646	/* number of PE Quad Hash filter buckets */
1647	enum i40e_hash_filter_size pe_filt_num;
1648	/* number of PE Quad Hash contexts */
1649	enum i40e_dma_cntx_size pe_cntx_num;
1650	/* number of FCoE filter buckets */
1651	enum i40e_hash_filter_size fcoe_filt_num;
1652	/* number of FCoE DDP contexts */
1653	enum i40e_dma_cntx_size fcoe_cntx_num;
1654	/* size of the Hash LUT */
1655	enum i40e_hash_lut_size	hash_lut_size;
1656	/* enable FDIR filters for PF and its VFs */
1657	bool enable_fdir;
1658	/* enable Ethertype filters for PF and its VFs */
1659	bool enable_ethtype;
1660	/* enable MAC/VLAN filters for PF and its VFs */
1661	bool enable_macvlan;
1662};
1663
1664/* Structure to hold device level control filter counts */
1665struct i40e_control_filter_stats {
1666	u16 mac_etype_used;   /* Used perfect match MAC/EtherType filters */
1667	u16 etype_used;       /* Used perfect EtherType filters */
1668	u16 mac_etype_free;   /* Un-used perfect match MAC/EtherType filters */
1669	u16 etype_free;       /* Un-used perfect EtherType filters */
1670};
1671
1672enum i40e_reset_type {
1673	I40E_RESET_POR		= 0,
1674	I40E_RESET_CORER	= 1,
1675	I40E_RESET_GLOBR	= 2,
1676	I40E_RESET_EMPR		= 3,
1677};
1678
1679/* IEEE 802.1AB LLDP Agent Variables from NVM */
1680#define I40E_NVM_LLDP_CFG_PTR   0x06
1681#define I40E_SR_LLDP_CFG_PTR    0x31
1682struct i40e_lldp_variables {
1683	u16 length;
1684	u16 adminstatus;
1685	u16 msgfasttx;
1686	u16 msgtxinterval;
1687	u16 txparams;
1688	u16 timers;
1689	u16 crc8;
1690};
1691
1692/* Offsets into Alternate Ram */
1693#define I40E_ALT_STRUCT_FIRST_PF_OFFSET		0   /* in dwords */
1694#define I40E_ALT_STRUCT_DWORDS_PER_PF		64   /* in dwords */
1695#define I40E_ALT_STRUCT_OUTER_VLAN_TAG_OFFSET	0xD  /* in dwords */
1696#define I40E_ALT_STRUCT_USER_PRIORITY_OFFSET	0xC  /* in dwords */
1697#define I40E_ALT_STRUCT_MIN_BW_OFFSET		0xE  /* in dwords */
1698#define I40E_ALT_STRUCT_MAX_BW_OFFSET		0xF  /* in dwords */
1699
1700/* Alternate Ram Bandwidth Masks */
1701#define I40E_ALT_BW_VALUE_MASK		0xFF
1702#define I40E_ALT_BW_RELATIVE_MASK	0x40000000
1703#define I40E_ALT_BW_VALID_MASK		0x80000000
1704
1705/* RSS Hash Table Size */
1706#define I40E_PFQF_CTL_0_HASHLUTSIZE_512	0x00010000
1707
1708/* INPUT SET MASK for RSS, flow director, and flexible payload */
1709#define I40E_L3_SRC_SHIFT		47
1710#define I40E_L3_SRC_MASK		(0x3ULL << I40E_L3_SRC_SHIFT)
1711#define I40E_L3_V6_SRC_SHIFT		43
1712#define I40E_L3_V6_SRC_MASK		(0xFFULL << I40E_L3_V6_SRC_SHIFT)
1713#define I40E_L3_DST_SHIFT		35
1714#define I40E_L3_DST_MASK		(0x3ULL << I40E_L3_DST_SHIFT)
1715#define I40E_L3_V6_DST_SHIFT		35
1716#define I40E_L3_V6_DST_MASK		(0xFFULL << I40E_L3_V6_DST_SHIFT)
1717#define I40E_L4_SRC_SHIFT		34
1718#define I40E_L4_SRC_MASK		(0x1ULL << I40E_L4_SRC_SHIFT)
1719#define I40E_L4_DST_SHIFT		33
1720#define I40E_L4_DST_MASK		(0x1ULL << I40E_L4_DST_SHIFT)
1721#define I40E_VERIFY_TAG_SHIFT		31
1722#define I40E_VERIFY_TAG_MASK		(0x3ULL << I40E_VERIFY_TAG_SHIFT)
1723#define I40E_VLAN_SRC_SHIFT		55
1724#define I40E_VLAN_SRC_MASK		(0x1ULL << I40E_VLAN_SRC_SHIFT)
1725
1726#define I40E_FLEX_50_SHIFT		13
1727#define I40E_FLEX_50_MASK		(0x1ULL << I40E_FLEX_50_SHIFT)
1728#define I40E_FLEX_51_SHIFT		12
1729#define I40E_FLEX_51_MASK		(0x1ULL << I40E_FLEX_51_SHIFT)
1730#define I40E_FLEX_52_SHIFT		11
1731#define I40E_FLEX_52_MASK		(0x1ULL << I40E_FLEX_52_SHIFT)
1732#define I40E_FLEX_53_SHIFT		10
1733#define I40E_FLEX_53_MASK		(0x1ULL << I40E_FLEX_53_SHIFT)
1734#define I40E_FLEX_54_SHIFT		9
1735#define I40E_FLEX_54_MASK		(0x1ULL << I40E_FLEX_54_SHIFT)
1736#define I40E_FLEX_55_SHIFT		8
1737#define I40E_FLEX_55_MASK		(0x1ULL << I40E_FLEX_55_SHIFT)
1738#define I40E_FLEX_56_SHIFT		7
1739#define I40E_FLEX_56_MASK		(0x1ULL << I40E_FLEX_56_SHIFT)
1740#define I40E_FLEX_57_SHIFT		6
1741#define I40E_FLEX_57_MASK		(0x1ULL << I40E_FLEX_57_SHIFT)
1742#define I40E_BCM_PHY_PCS_STATUS1_PAGE	0x3
1743#define I40E_BCM_PHY_PCS_STATUS1_REG	0x0001
1744#define I40E_BCM_PHY_PCS_STATUS1_RX_LPI	BIT(8)
1745#define I40E_BCM_PHY_PCS_STATUS1_TX_LPI	BIT(9)
1746
1747#endif /* _I40E_TYPE_H_ */
1748