xref: /linux/drivers/net/ethernet/intel/ice/ice.h (revision cca0d69baf950e5a82c21d09917b4cc654c83fe9)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Copyright (c) 2018, Intel Corporation. */
3 
4 #ifndef _ICE_H_
5 #define _ICE_H_
6 
7 #include <linux/types.h>
8 #include <linux/errno.h>
9 #include <linux/kernel.h>
10 #include <linux/module.h>
11 #include <linux/firmware.h>
12 #include <linux/netdevice.h>
13 #include <linux/compiler.h>
14 #include <linux/etherdevice.h>
15 #include <linux/skbuff.h>
16 #include <linux/cpumask.h>
17 #include <linux/rtnetlink.h>
18 #include <linux/if_vlan.h>
19 #include <linux/dma-mapping.h>
20 #include <linux/pci.h>
21 #include <linux/workqueue.h>
22 #include <linux/wait.h>
23 #include <linux/interrupt.h>
24 #include <linux/ethtool.h>
25 #include <linux/timer.h>
26 #include <linux/delay.h>
27 #include <linux/bitmap.h>
28 #include <linux/log2.h>
29 #include <linux/ip.h>
30 #include <linux/sctp.h>
31 #include <linux/ipv6.h>
32 #include <linux/pkt_sched.h>
33 #include <linux/if_bridge.h>
34 #include <linux/ctype.h>
35 #include <linux/linkmode.h>
36 #include <linux/bpf.h>
37 #include <linux/btf.h>
38 #include <linux/auxiliary_bus.h>
39 #include <linux/avf/virtchnl.h>
40 #include <linux/cpu_rmap.h>
41 #include <linux/dim.h>
42 #include <linux/gnss.h>
43 #include <net/pkt_cls.h>
44 #include <net/pkt_sched.h>
45 #include <net/tc_act/tc_mirred.h>
46 #include <net/tc_act/tc_gact.h>
47 #include <net/ip.h>
48 #include <net/devlink.h>
49 #include <net/ipv6.h>
50 #include <net/xdp_sock.h>
51 #include <net/xdp_sock_drv.h>
52 #include <net/geneve.h>
53 #include <net/gre.h>
54 #include <net/udp_tunnel.h>
55 #include <net/vxlan.h>
56 #include <net/gtp.h>
57 #include <linux/ppp_defs.h>
58 #include "ice_devids.h"
59 #include "ice_type.h"
60 #include "ice_txrx.h"
61 #include "ice_dcb.h"
62 #include "ice_switch.h"
63 #include "ice_common.h"
64 #include "ice_flow.h"
65 #include "ice_sched.h"
66 #include "ice_idc_int.h"
67 #include "ice_sriov.h"
68 #include "ice_vf_mbx.h"
69 #include "ice_ptp.h"
70 #include "ice_fdir.h"
71 #include "ice_xsk.h"
72 #include "ice_arfs.h"
73 #include "ice_repr.h"
74 #include "ice_eswitch.h"
75 #include "ice_lag.h"
76 #include "ice_vsi_vlan_ops.h"
77 #include "ice_gnss.h"
78 #include "ice_irq.h"
79 #include "ice_dpll.h"
80 #include "ice_adapter.h"
81 
82 #define ICE_BAR0		0
83 #define ICE_REQ_DESC_MULTIPLE	32
84 #define ICE_MIN_NUM_DESC	64
85 #define ICE_MAX_NUM_DESC	8160
86 #define ICE_DFLT_MIN_RX_DESC	512
87 #define ICE_DFLT_NUM_TX_DESC	256
88 #define ICE_DFLT_NUM_RX_DESC	2048
89 
90 #define ICE_DFLT_TRAFFIC_CLASS	BIT(0)
91 #define ICE_INT_NAME_STR_LEN	(IFNAMSIZ + 16)
92 #define ICE_AQ_LEN		192
93 #define ICE_MBXSQ_LEN		64
94 #define ICE_SBQ_LEN		64
95 #define ICE_MIN_LAN_TXRX_MSIX	1
96 #define ICE_MIN_LAN_OICR_MSIX	1
97 #define ICE_MIN_MSIX		(ICE_MIN_LAN_TXRX_MSIX + ICE_MIN_LAN_OICR_MSIX)
98 #define ICE_FDIR_MSIX		2
99 #define ICE_RDMA_NUM_AEQ_MSIX	4
100 #define ICE_MIN_RDMA_MSIX	2
101 #define ICE_ESWITCH_MSIX	1
102 #define ICE_NO_VSI		0xffff
103 #define ICE_VSI_MAP_CONTIG	0
104 #define ICE_VSI_MAP_SCATTER	1
105 #define ICE_MAX_SCATTER_TXQS	16
106 #define ICE_MAX_SCATTER_RXQS	16
107 #define ICE_Q_WAIT_RETRY_LIMIT	10
108 #define ICE_Q_WAIT_MAX_RETRY	(5 * ICE_Q_WAIT_RETRY_LIMIT)
109 #define ICE_MAX_LG_RSS_QS	256
110 #define ICE_INVAL_Q_INDEX	0xffff
111 
112 #define ICE_MAX_RXQS_PER_TC		256	/* Used when setting VSI context per TC Rx queues */
113 
114 #define ICE_CHNL_START_TC		1
115 
116 #define ICE_MAX_RESET_WAIT		20
117 
118 #define ICE_VSIQF_HKEY_ARRAY_SIZE	((VSIQF_HKEY_MAX_INDEX + 1) *	4)
119 
120 #define ICE_DFLT_NETIF_M (NETIF_MSG_DRV | NETIF_MSG_PROBE | NETIF_MSG_LINK)
121 
122 #define ICE_MAX_MTU	(ICE_AQ_SET_MAC_FRAME_SIZE_MAX - ICE_ETH_PKT_HDR_PAD)
123 
124 #define ICE_MAX_TSO_SIZE 131072
125 
126 #define ICE_UP_TABLE_TRANSLATE(val, i) \
127 		(((val) << ICE_AQ_VSI_UP_TABLE_UP##i##_S) & \
128 		  ICE_AQ_VSI_UP_TABLE_UP##i##_M)
129 
130 #define ICE_TX_DESC(R, i) (&(((struct ice_tx_desc *)((R)->desc))[i]))
131 #define ICE_RX_DESC(R, i) (&(((union ice_32b_rx_flex_desc *)((R)->desc))[i]))
132 #define ICE_TX_CTX_DESC(R, i) (&(((struct ice_tx_ctx_desc *)((R)->desc))[i]))
133 #define ICE_TX_FDIRDESC(R, i) (&(((struct ice_fltr_desc *)((R)->desc))[i]))
134 
135 /* Minimum BW limit is 500 Kbps for any scheduler node */
136 #define ICE_MIN_BW_LIMIT		500
137 /* User can specify BW in either Kbit/Mbit/Gbit and OS converts it in bytes.
138  * use it to convert user specified BW limit into Kbps
139  */
140 #define ICE_BW_KBPS_DIVISOR		125
141 
142 /* Default recipes have priority 4 and below, hence priority values between 5..7
143  * can be used as filter priority for advanced switch filter (advanced switch
144  * filters need new recipe to be created for specified extraction sequence
145  * because default recipe extraction sequence does not represent custom
146  * extraction)
147  */
148 #define ICE_SWITCH_FLTR_PRIO_QUEUE	7
149 /* prio 6 is reserved for future use (e.g. switch filter with L3 fields +
150  * (Optional: IP TOS/TTL) + L4 fields + (optionally: TCP fields such as
151  * SYN/FIN/RST))
152  */
153 #define ICE_SWITCH_FLTR_PRIO_RSVD	6
154 #define ICE_SWITCH_FLTR_PRIO_VSI	5
155 #define ICE_SWITCH_FLTR_PRIO_QGRP	ICE_SWITCH_FLTR_PRIO_VSI
156 
157 /* Macro for each VSI in a PF */
158 #define ice_for_each_vsi(pf, i) \
159 	for ((i) = 0; (i) < (pf)->num_alloc_vsi; (i)++)
160 
161 /* Macros for each Tx/Xdp/Rx ring in a VSI */
162 #define ice_for_each_txq(vsi, i) \
163 	for ((i) = 0; (i) < (vsi)->num_txq; (i)++)
164 
165 #define ice_for_each_xdp_txq(vsi, i) \
166 	for ((i) = 0; (i) < (vsi)->num_xdp_txq; (i)++)
167 
168 #define ice_for_each_rxq(vsi, i) \
169 	for ((i) = 0; (i) < (vsi)->num_rxq; (i)++)
170 
171 /* Macros for each allocated Tx/Rx ring whether used or not in a VSI */
172 #define ice_for_each_alloc_txq(vsi, i) \
173 	for ((i) = 0; (i) < (vsi)->alloc_txq; (i)++)
174 
175 #define ice_for_each_alloc_rxq(vsi, i) \
176 	for ((i) = 0; (i) < (vsi)->alloc_rxq; (i)++)
177 
178 #define ice_for_each_q_vector(vsi, i) \
179 	for ((i) = 0; (i) < (vsi)->num_q_vectors; (i)++)
180 
181 #define ice_for_each_chnl_tc(i)	\
182 	for ((i) = ICE_CHNL_START_TC; (i) < ICE_CHNL_MAX_TC; (i)++)
183 
184 #define ICE_UCAST_PROMISC_BITS (ICE_PROMISC_UCAST_TX | ICE_PROMISC_UCAST_RX)
185 
186 #define ICE_UCAST_VLAN_PROMISC_BITS (ICE_PROMISC_UCAST_TX | \
187 				     ICE_PROMISC_UCAST_RX | \
188 				     ICE_PROMISC_VLAN_TX  | \
189 				     ICE_PROMISC_VLAN_RX)
190 
191 #define ICE_MCAST_PROMISC_BITS (ICE_PROMISC_MCAST_TX | ICE_PROMISC_MCAST_RX)
192 
193 #define ICE_MCAST_VLAN_PROMISC_BITS (ICE_PROMISC_MCAST_TX | \
194 				     ICE_PROMISC_MCAST_RX | \
195 				     ICE_PROMISC_VLAN_TX  | \
196 				     ICE_PROMISC_VLAN_RX)
197 
198 #define ice_pf_to_dev(pf) (&((pf)->pdev->dev))
199 
200 #define ice_pf_src_tmr_owned(pf) ((pf)->hw.func_caps.ts_func_info.src_tmr_owned)
201 
202 enum ice_feature {
203 	ICE_F_DSCP,
204 	ICE_F_PHY_RCLK,
205 	ICE_F_SMA_CTRL,
206 	ICE_F_CGU,
207 	ICE_F_GNSS,
208 	ICE_F_ROCE_LAG,
209 	ICE_F_SRIOV_LAG,
210 	ICE_F_MAX
211 };
212 
213 DECLARE_STATIC_KEY_FALSE(ice_xdp_locking_key);
214 
215 struct ice_channel {
216 	struct list_head list;
217 	u8 type;
218 	u16 sw_id;
219 	u16 base_q;
220 	u16 num_rxq;
221 	u16 num_txq;
222 	u16 vsi_num;
223 	u8 ena_tc;
224 	struct ice_aqc_vsi_props info;
225 	u64 max_tx_rate;
226 	u64 min_tx_rate;
227 	atomic_t num_sb_fltr;
228 	struct ice_vsi *ch_vsi;
229 };
230 
231 struct ice_txq_meta {
232 	u32 q_teid;	/* Tx-scheduler element identifier */
233 	u16 q_id;	/* Entry in VSI's txq_map bitmap */
234 	u16 q_handle;	/* Relative index of Tx queue within TC */
235 	u16 vsi_idx;	/* VSI index that Tx queue belongs to */
236 	u8 tc;		/* TC number that Tx queue belongs to */
237 };
238 
239 struct ice_tc_info {
240 	u16 qoffset;
241 	u16 qcount_tx;
242 	u16 qcount_rx;
243 	u8 netdev_tc;
244 };
245 
246 struct ice_tc_cfg {
247 	u8 numtc; /* Total number of enabled TCs */
248 	u16 ena_tc; /* Tx map */
249 	struct ice_tc_info tc_info[ICE_MAX_TRAFFIC_CLASS];
250 };
251 
252 struct ice_qs_cfg {
253 	struct mutex *qs_mutex;  /* will be assigned to &pf->avail_q_mutex */
254 	unsigned long *pf_map;
255 	unsigned long pf_map_size;
256 	unsigned int q_count;
257 	unsigned int scatter_count;
258 	u16 *vsi_map;
259 	u16 vsi_map_offset;
260 	u8 mapping_mode;
261 };
262 
263 struct ice_sw {
264 	struct ice_pf *pf;
265 	u16 sw_id;		/* switch ID for this switch */
266 	u16 bridge_mode;	/* VEB/VEPA/Port Virtualizer */
267 };
268 
269 enum ice_pf_state {
270 	ICE_TESTING,
271 	ICE_DOWN,
272 	ICE_NEEDS_RESTART,
273 	ICE_PREPARED_FOR_RESET,	/* set by driver when prepared */
274 	ICE_RESET_OICR_RECV,		/* set by driver after rcv reset OICR */
275 	ICE_PFR_REQ,		/* set by driver */
276 	ICE_CORER_REQ,		/* set by driver */
277 	ICE_GLOBR_REQ,		/* set by driver */
278 	ICE_CORER_RECV,		/* set by OICR handler */
279 	ICE_GLOBR_RECV,		/* set by OICR handler */
280 	ICE_EMPR_RECV,		/* set by OICR handler */
281 	ICE_SUSPENDED,		/* set on module remove path */
282 	ICE_RESET_FAILED,		/* set by reset/rebuild */
283 	/* When checking for the PF to be in a nominal operating state, the
284 	 * bits that are grouped at the beginning of the list need to be
285 	 * checked. Bits occurring before ICE_STATE_NOMINAL_CHECK_BITS will
286 	 * be checked. If you need to add a bit into consideration for nominal
287 	 * operating state, it must be added before
288 	 * ICE_STATE_NOMINAL_CHECK_BITS. Do not move this entry's position
289 	 * without appropriate consideration.
290 	 */
291 	ICE_STATE_NOMINAL_CHECK_BITS,
292 	ICE_ADMINQ_EVENT_PENDING,
293 	ICE_MAILBOXQ_EVENT_PENDING,
294 	ICE_SIDEBANDQ_EVENT_PENDING,
295 	ICE_MDD_EVENT_PENDING,
296 	ICE_VFLR_EVENT_PENDING,
297 	ICE_FLTR_OVERFLOW_PROMISC,
298 	ICE_VF_DIS,
299 	ICE_CFG_BUSY,
300 	ICE_SERVICE_SCHED,
301 	ICE_SERVICE_DIS,
302 	ICE_FD_FLUSH_REQ,
303 	ICE_OICR_INTR_DIS,		/* Global OICR interrupt disabled */
304 	ICE_MDD_VF_PRINT_PENDING,	/* set when MDD event handle */
305 	ICE_VF_RESETS_DISABLED,	/* disable resets during ice_remove */
306 	ICE_LINK_DEFAULT_OVERRIDE_PENDING,
307 	ICE_PHY_INIT_COMPLETE,
308 	ICE_FD_VF_FLUSH_CTX,		/* set at FD Rx IRQ or timeout */
309 	ICE_AUX_ERR_PENDING,
310 	ICE_STATE_NBITS		/* must be last */
311 };
312 
313 enum ice_vsi_state {
314 	ICE_VSI_DOWN,
315 	ICE_VSI_NEEDS_RESTART,
316 	ICE_VSI_NETDEV_ALLOCD,
317 	ICE_VSI_NETDEV_REGISTERED,
318 	ICE_VSI_UMAC_FLTR_CHANGED,
319 	ICE_VSI_MMAC_FLTR_CHANGED,
320 	ICE_VSI_PROMISC_CHANGED,
321 	ICE_VSI_REBUILD_PENDING,
322 	ICE_VSI_STATE_NBITS		/* must be last */
323 };
324 
325 struct ice_vsi_stats {
326 	struct ice_ring_stats **tx_ring_stats;  /* Tx ring stats array */
327 	struct ice_ring_stats **rx_ring_stats;  /* Rx ring stats array */
328 };
329 
330 /* struct that defines a VSI, associated with a dev */
331 struct ice_vsi {
332 	struct net_device *netdev;
333 	struct ice_sw *vsw;		 /* switch this VSI is on */
334 	struct ice_pf *back;		 /* back pointer to PF */
335 	struct ice_rx_ring **rx_rings;	 /* Rx ring array */
336 	struct ice_tx_ring **tx_rings;	 /* Tx ring array */
337 	struct ice_q_vector **q_vectors; /* q_vector array */
338 
339 	irqreturn_t (*irq_handler)(int irq, void *data);
340 
341 	u64 tx_linearize;
342 	DECLARE_BITMAP(state, ICE_VSI_STATE_NBITS);
343 	unsigned int current_netdev_flags;
344 	u32 tx_restart;
345 	u32 tx_busy;
346 	u32 rx_buf_failed;
347 	u32 rx_page_failed;
348 	u16 num_q_vectors;
349 	/* tell if only dynamic irq allocation is allowed */
350 	bool irq_dyn_alloc;
351 
352 	u16 vsi_num;			/* HW (absolute) index of this VSI */
353 	u16 idx;			/* software index in pf->vsi[] */
354 
355 	u16 num_gfltr;
356 	u16 num_bfltr;
357 
358 	/* RSS config */
359 	u16 rss_table_size;	/* HW RSS table size */
360 	u16 rss_size;		/* Allocated RSS queues */
361 	u8 rss_hfunc;		/* User configured hash type */
362 	u8 *rss_hkey_user;	/* User configured hash keys */
363 	u8 *rss_lut_user;	/* User configured lookup table entries */
364 	u8 rss_lut_type;	/* used to configure Get/Set RSS LUT AQ call */
365 
366 	/* aRFS members only allocated for the PF VSI */
367 #define ICE_MAX_ARFS_LIST	1024
368 #define ICE_ARFS_LST_MASK	(ICE_MAX_ARFS_LIST - 1)
369 	struct hlist_head *arfs_fltr_list;
370 	struct ice_arfs_active_fltr_cntrs *arfs_fltr_cntrs;
371 	spinlock_t arfs_lock;	/* protects aRFS hash table and filter state */
372 	atomic_t *arfs_last_fltr_id;
373 
374 	u16 max_frame;
375 	u16 rx_buf_len;
376 
377 	struct ice_aqc_vsi_props info;	 /* VSI properties */
378 	struct ice_vsi_vlan_info vlan_info;	/* vlan config to be restored */
379 
380 	/* VSI stats */
381 	struct rtnl_link_stats64 net_stats;
382 	struct rtnl_link_stats64 net_stats_prev;
383 	struct ice_eth_stats eth_stats;
384 	struct ice_eth_stats eth_stats_prev;
385 
386 	struct list_head tmp_sync_list;		/* MAC filters to be synced */
387 	struct list_head tmp_unsync_list;	/* MAC filters to be unsynced */
388 
389 	u8 irqs_ready:1;
390 	u8 current_isup:1;		 /* Sync 'link up' logging */
391 	u8 stat_offsets_loaded:1;
392 	struct ice_vsi_vlan_ops inner_vlan_ops;
393 	struct ice_vsi_vlan_ops outer_vlan_ops;
394 	u16 num_vlan;
395 
396 	/* queue information */
397 	u8 tx_mapping_mode;		 /* ICE_MAP_MODE_[CONTIG|SCATTER] */
398 	u8 rx_mapping_mode;		 /* ICE_MAP_MODE_[CONTIG|SCATTER] */
399 	u16 *txq_map;			 /* index in pf->avail_txqs */
400 	u16 *rxq_map;			 /* index in pf->avail_rxqs */
401 	u16 alloc_txq;			 /* Allocated Tx queues */
402 	u16 num_txq;			 /* Used Tx queues */
403 	u16 alloc_rxq;			 /* Allocated Rx queues */
404 	u16 num_rxq;			 /* Used Rx queues */
405 	u16 req_txq;			 /* User requested Tx queues */
406 	u16 req_rxq;			 /* User requested Rx queues */
407 	u16 num_rx_desc;
408 	u16 num_tx_desc;
409 	u16 qset_handle[ICE_MAX_TRAFFIC_CLASS];
410 	struct ice_tc_cfg tc_cfg;
411 	struct bpf_prog *xdp_prog;
412 	struct ice_tx_ring **xdp_rings;	 /* XDP ring array */
413 	u16 num_xdp_txq;		 /* Used XDP queues */
414 	u8 xdp_mapping_mode;		 /* ICE_MAP_MODE_[CONTIG|SCATTER] */
415 	struct mutex xdp_state_lock;
416 
417 	struct net_device **target_netdevs;
418 
419 	struct tc_mqprio_qopt_offload mqprio_qopt; /* queue parameters */
420 
421 	/* Channel Specific Fields */
422 	struct ice_vsi *tc_map_vsi[ICE_CHNL_MAX_TC];
423 	u16 cnt_q_avail;
424 	u16 next_base_q;	/* next queue to be used for channel setup */
425 	struct list_head ch_list;
426 	u16 num_chnl_rxq;
427 	u16 num_chnl_txq;
428 	u16 ch_rss_size;
429 	u16 num_chnl_fltr;
430 	/* store away rss size info before configuring ADQ channels so that,
431 	 * it can be used after tc-qdisc delete, to get back RSS setting as
432 	 * they were before
433 	 */
434 	u16 orig_rss_size;
435 	/* this keeps tracks of all enabled TC with and without DCB
436 	 * and inclusive of ADQ, vsi->mqprio_opt keeps track of queue
437 	 * information
438 	 */
439 	u8 all_numtc;
440 	u16 all_enatc;
441 
442 	/* store away TC info, to be used for rebuild logic */
443 	u8 old_numtc;
444 	u16 old_ena_tc;
445 
446 	/* setup back reference, to which aggregator node this VSI
447 	 * corresponds to
448 	 */
449 	struct ice_agg_node *agg_node;
450 
451 	struct_group_tagged(ice_vsi_cfg_params, params,
452 		struct ice_port_info *port_info; /* back pointer to port_info */
453 		struct ice_channel *ch; /* VSI's channel structure, may be NULL */
454 		struct ice_vf *vf; /* VF associated with this VSI, may be NULL */
455 		u32 flags; /* VSI flags used for rebuild and configuration */
456 		enum ice_vsi_type type; /* the type of the VSI */
457 	);
458 } ____cacheline_internodealigned_in_smp;
459 
460 /* struct that defines an interrupt vector */
461 struct ice_q_vector {
462 	struct ice_vsi *vsi;
463 
464 	u16 v_idx;			/* index in the vsi->q_vector array. */
465 	u16 reg_idx;			/* PF relative register index */
466 	u8 num_ring_rx;			/* total number of Rx rings in vector */
467 	u8 num_ring_tx;			/* total number of Tx rings in vector */
468 	u8 wb_on_itr:1;			/* if true, WB on ITR is enabled */
469 	/* in usecs, need to use ice_intrl_to_usecs_reg() before writing this
470 	 * value to the device
471 	 */
472 	u8 intrl;
473 
474 	struct napi_struct napi;
475 
476 	struct ice_ring_container rx;
477 	struct ice_ring_container tx;
478 
479 	cpumask_t affinity_mask;
480 	struct irq_affinity_notify affinity_notify;
481 
482 	struct ice_channel *ch;
483 
484 	char name[ICE_INT_NAME_STR_LEN];
485 
486 	u16 total_events;	/* net_dim(): number of interrupts processed */
487 	u16 vf_reg_idx;		/* VF relative register index */
488 	struct msi_map irq;
489 } ____cacheline_internodealigned_in_smp;
490 
491 enum ice_pf_flags {
492 	ICE_FLAG_FLTR_SYNC,
493 	ICE_FLAG_RDMA_ENA,
494 	ICE_FLAG_RSS_ENA,
495 	ICE_FLAG_SRIOV_ENA,
496 	ICE_FLAG_SRIOV_CAPABLE,
497 	ICE_FLAG_DCB_CAPABLE,
498 	ICE_FLAG_DCB_ENA,
499 	ICE_FLAG_FD_ENA,
500 	ICE_FLAG_PTP_SUPPORTED,		/* PTP is supported by NVM */
501 	ICE_FLAG_ADV_FEATURES,
502 	ICE_FLAG_TC_MQPRIO,		/* support for Multi queue TC */
503 	ICE_FLAG_CLS_FLOWER,
504 	ICE_FLAG_LINK_DOWN_ON_CLOSE_ENA,
505 	ICE_FLAG_TOTAL_PORT_SHUTDOWN_ENA,
506 	ICE_FLAG_NO_MEDIA,
507 	ICE_FLAG_FW_LLDP_AGENT,
508 	ICE_FLAG_MOD_POWER_UNSUPPORTED,
509 	ICE_FLAG_PHY_FW_LOAD_FAILED,
510 	ICE_FLAG_ETHTOOL_CTXT,		/* set when ethtool holds RTNL lock */
511 	ICE_FLAG_LEGACY_RX,
512 	ICE_FLAG_VF_TRUE_PROMISC_ENA,
513 	ICE_FLAG_MDD_AUTO_RESET_VF,
514 	ICE_FLAG_VF_VLAN_PRUNING,
515 	ICE_FLAG_LINK_LENIENT_MODE_ENA,
516 	ICE_FLAG_PLUG_AUX_DEV,
517 	ICE_FLAG_UNPLUG_AUX_DEV,
518 	ICE_FLAG_MTU_CHANGED,
519 	ICE_FLAG_GNSS,			/* GNSS successfully initialized */
520 	ICE_FLAG_DPLL,			/* SyncE/PTP dplls initialized */
521 	ICE_PF_FLAGS_NBITS		/* must be last */
522 };
523 
524 enum ice_misc_thread_tasks {
525 	ICE_MISC_THREAD_TX_TSTAMP,
526 	ICE_MISC_THREAD_NBITS		/* must be last */
527 };
528 
529 struct ice_eswitch {
530 	struct ice_vsi *uplink_vsi;
531 	struct ice_esw_br_offloads *br_offloads;
532 	struct xarray reprs;
533 	bool is_running;
534 };
535 
536 struct ice_agg_node {
537 	u32 agg_id;
538 #define ICE_MAX_VSIS_IN_AGG_NODE	64
539 	u32 num_vsis;
540 	u8 valid;
541 };
542 
543 struct ice_pf {
544 	struct pci_dev *pdev;
545 	struct ice_adapter *adapter;
546 
547 	struct devlink_region *nvm_region;
548 	struct devlink_region *sram_region;
549 	struct devlink_region *devcaps_region;
550 
551 	/* devlink port data */
552 	struct devlink_port devlink_port;
553 
554 	/* OS reserved IRQ details */
555 	struct msix_entry *msix_entries;
556 	struct ice_irq_tracker irq_tracker;
557 	/* First MSIX vector used by SR-IOV VFs. Calculated by subtracting the
558 	 * number of MSIX vectors needed for all SR-IOV VFs from the number of
559 	 * MSIX vectors allowed on this PF.
560 	 */
561 	u16 sriov_base_vector;
562 	unsigned long *sriov_irq_bm;	/* bitmap to track irq usage */
563 	u16 sriov_irq_size;		/* size of the irq_bm bitmap */
564 
565 	u16 ctrl_vsi_idx;		/* control VSI index in pf->vsi array */
566 
567 	struct ice_vsi **vsi;		/* VSIs created by the driver */
568 	struct ice_vsi_stats **vsi_stats;
569 	struct ice_sw *first_sw;	/* first switch created by firmware */
570 	u16 eswitch_mode;		/* current mode of eswitch */
571 	struct dentry *ice_debugfs_pf;
572 	struct dentry *ice_debugfs_pf_fwlog;
573 	/* keep track of all the dentrys for FW log modules */
574 	struct dentry **ice_debugfs_pf_fwlog_modules;
575 	struct ice_vfs vfs;
576 	DECLARE_BITMAP(features, ICE_F_MAX);
577 	DECLARE_BITMAP(state, ICE_STATE_NBITS);
578 	DECLARE_BITMAP(flags, ICE_PF_FLAGS_NBITS);
579 	DECLARE_BITMAP(misc_thread, ICE_MISC_THREAD_NBITS);
580 	unsigned long *avail_txqs;	/* bitmap to track PF Tx queue usage */
581 	unsigned long *avail_rxqs;	/* bitmap to track PF Rx queue usage */
582 	unsigned long serv_tmr_period;
583 	unsigned long serv_tmr_prev;
584 	struct timer_list serv_tmr;
585 	struct work_struct serv_task;
586 	struct mutex avail_q_mutex;	/* protects access to avail_[rx|tx]qs */
587 	struct mutex sw_mutex;		/* lock for protecting VSI alloc flow */
588 	struct mutex tc_mutex;		/* lock to protect TC changes */
589 	struct mutex adev_mutex;	/* lock to protect aux device access */
590 	struct mutex lag_mutex;		/* protect ice_lag struct in PF */
591 	u32 msg_enable;
592 	struct ice_ptp ptp;
593 	struct gnss_serial *gnss_serial;
594 	struct gnss_device *gnss_dev;
595 	u16 num_rdma_msix;		/* Total MSIX vectors for RDMA driver */
596 	u16 rdma_base_vector;
597 
598 	/* spinlock to protect the AdminQ wait list */
599 	spinlock_t aq_wait_lock;
600 	struct hlist_head aq_wait_list;
601 	wait_queue_head_t aq_wait_queue;
602 	bool fw_emp_reset_disabled;
603 
604 	wait_queue_head_t reset_wait_queue;
605 
606 	u32 hw_csum_rx_error;
607 	u32 hw_rx_eipe_error;
608 	u32 oicr_err_reg;
609 	struct msi_map oicr_irq;	/* Other interrupt cause MSIX vector */
610 	struct msi_map ll_ts_irq;	/* LL_TS interrupt MSIX vector */
611 	u16 max_pf_txqs;	/* Total Tx queues PF wide */
612 	u16 max_pf_rxqs;	/* Total Rx queues PF wide */
613 	u16 num_lan_msix;	/* Total MSIX vectors for base driver */
614 	u16 num_lan_tx;		/* num LAN Tx queues setup */
615 	u16 num_lan_rx;		/* num LAN Rx queues setup */
616 	u16 next_vsi;		/* Next free slot in pf->vsi[] - 0-based! */
617 	u16 num_alloc_vsi;
618 	u16 corer_count;	/* Core reset count */
619 	u16 globr_count;	/* Global reset count */
620 	u16 empr_count;		/* EMP reset count */
621 	u16 pfr_count;		/* PF reset count */
622 
623 	u8 wol_ena : 1;		/* software state of WoL */
624 	u32 wakeup_reason;	/* last wakeup reason */
625 	struct ice_hw_port_stats stats;
626 	struct ice_hw_port_stats stats_prev;
627 	struct ice_hw hw;
628 	u8 stat_prev_loaded:1; /* has previous stats been loaded */
629 	u8 rdma_mode;
630 	u16 dcbx_cap;
631 	u32 tx_timeout_count;
632 	unsigned long tx_timeout_last_recovery;
633 	u32 tx_timeout_recovery_level;
634 	char int_name[ICE_INT_NAME_STR_LEN];
635 	char int_name_ll_ts[ICE_INT_NAME_STR_LEN];
636 	struct auxiliary_device *adev;
637 	int aux_idx;
638 	u32 sw_int_count;
639 	/* count of tc_flower filters specific to channel (aka where filter
640 	 * action is "hw_tc <tc_num>")
641 	 */
642 	u16 num_dmac_chnl_fltrs;
643 	struct hlist_head tc_flower_fltr_list;
644 
645 	u64 supported_rxdids;
646 
647 	__le64 nvm_phy_type_lo; /* NVM PHY type low */
648 	__le64 nvm_phy_type_hi; /* NVM PHY type high */
649 	struct ice_link_default_override_tlv link_dflt_override;
650 	struct ice_lag *lag; /* Link Aggregation information */
651 
652 	struct ice_eswitch eswitch;
653 	struct ice_esw_br_port *br_port;
654 
655 #define ICE_INVALID_AGG_NODE_ID		0
656 #define ICE_PF_AGG_NODE_ID_START	1
657 #define ICE_MAX_PF_AGG_NODES		32
658 	struct ice_agg_node pf_agg_node[ICE_MAX_PF_AGG_NODES];
659 #define ICE_VF_AGG_NODE_ID_START	65
660 #define ICE_MAX_VF_AGG_NODES		32
661 	struct ice_agg_node vf_agg_node[ICE_MAX_VF_AGG_NODES];
662 	struct ice_dplls dplls;
663 	struct device *hwmon_dev;
664 };
665 
666 extern struct workqueue_struct *ice_lag_wq;
667 
668 struct ice_netdev_priv {
669 	struct ice_vsi *vsi;
670 	struct ice_repr *repr;
671 	/* indirect block callbacks on registered higher level devices
672 	 * (e.g. tunnel devices)
673 	 *
674 	 * tc_indr_block_cb_priv_list is used to look up indirect callback
675 	 * private data
676 	 */
677 	struct list_head tc_indr_block_priv_list;
678 };
679 
680 /**
681  * ice_vector_ch_enabled
682  * @qv: pointer to q_vector, can be NULL
683  *
684  * This function returns true if vector is channel enabled otherwise false
685  */
686 static inline bool ice_vector_ch_enabled(struct ice_q_vector *qv)
687 {
688 	return !!qv->ch; /* Enable it to run with TC */
689 }
690 
691 /**
692  * ice_ptp_pf_handles_tx_interrupt - Check if PF handles Tx interrupt
693  * @pf: Board private structure
694  *
695  * Return true if this PF should respond to the Tx timestamp interrupt
696  * indication in the miscellaneous OICR interrupt handler.
697  */
698 static inline bool ice_ptp_pf_handles_tx_interrupt(struct ice_pf *pf)
699 {
700 	return pf->ptp.tx_interrupt_mode != ICE_PTP_TX_INTERRUPT_NONE;
701 }
702 
703 /**
704  * ice_irq_dynamic_ena - Enable default interrupt generation settings
705  * @hw: pointer to HW struct
706  * @vsi: pointer to VSI struct, can be NULL
707  * @q_vector: pointer to q_vector, can be NULL
708  */
709 static inline void
710 ice_irq_dynamic_ena(struct ice_hw *hw, struct ice_vsi *vsi,
711 		    struct ice_q_vector *q_vector)
712 {
713 	u32 vector = (vsi && q_vector) ? q_vector->reg_idx :
714 				((struct ice_pf *)hw->back)->oicr_irq.index;
715 	int itr = ICE_ITR_NONE;
716 	u32 val;
717 
718 	/* clear the PBA here, as this function is meant to clean out all
719 	 * previous interrupts and enable the interrupt
720 	 */
721 	val = GLINT_DYN_CTL_INTENA_M | GLINT_DYN_CTL_CLEARPBA_M |
722 	      (itr << GLINT_DYN_CTL_ITR_INDX_S);
723 	if (vsi)
724 		if (test_bit(ICE_VSI_DOWN, vsi->state))
725 			return;
726 	wr32(hw, GLINT_DYN_CTL(vector), val);
727 }
728 
729 /**
730  * ice_netdev_to_pf - Retrieve the PF struct associated with a netdev
731  * @netdev: pointer to the netdev struct
732  */
733 static inline struct ice_pf *ice_netdev_to_pf(struct net_device *netdev)
734 {
735 	struct ice_netdev_priv *np = netdev_priv(netdev);
736 
737 	return np->vsi->back;
738 }
739 
740 static inline bool ice_is_xdp_ena_vsi(struct ice_vsi *vsi)
741 {
742 	return !!READ_ONCE(vsi->xdp_prog);
743 }
744 
745 static inline void ice_set_ring_xdp(struct ice_tx_ring *ring)
746 {
747 	ring->flags |= ICE_TX_FLAGS_RING_XDP;
748 }
749 
750 /**
751  * ice_get_xp_from_qid - get ZC XSK buffer pool bound to a queue ID
752  * @vsi: pointer to VSI
753  * @qid: index of a queue to look at XSK buff pool presence
754  *
755  * Return: A pointer to xsk_buff_pool structure if there is a buffer pool
756  * attached and configured as zero-copy, NULL otherwise.
757  */
758 static inline struct xsk_buff_pool *ice_get_xp_from_qid(struct ice_vsi *vsi,
759 							u16 qid)
760 {
761 	struct xsk_buff_pool *pool = xsk_get_pool_from_qid(vsi->netdev, qid);
762 
763 	if (!ice_is_xdp_ena_vsi(vsi))
764 		return NULL;
765 
766 	return (pool && pool->dev) ? pool : NULL;
767 }
768 
769 /**
770  * ice_rx_xsk_pool - assign XSK buff pool to Rx ring
771  * @ring: Rx ring to use
772  *
773  * Sets XSK buff pool pointer on Rx ring.
774  */
775 static inline void ice_rx_xsk_pool(struct ice_rx_ring *ring)
776 {
777 	struct ice_vsi *vsi = ring->vsi;
778 	u16 qid = ring->q_index;
779 
780 	WRITE_ONCE(ring->xsk_pool, ice_get_xp_from_qid(vsi, qid));
781 }
782 
783 /**
784  * ice_tx_xsk_pool - assign XSK buff pool to XDP ring
785  * @vsi: pointer to VSI
786  * @qid: index of a queue to look at XSK buff pool presence
787  *
788  * Sets XSK buff pool pointer on XDP ring.
789  *
790  * XDP ring is picked from Rx ring, whereas Rx ring is picked based on provided
791  * queue id. Reason for doing so is that queue vectors might have assigned more
792  * than one XDP ring, e.g. when user reduced the queue count on netdev; Rx ring
793  * carries a pointer to one of these XDP rings for its own purposes, such as
794  * handling XDP_TX action, therefore we can piggyback here on the
795  * rx_ring->xdp_ring assignment that was done during XDP rings initialization.
796  */
797 static inline void ice_tx_xsk_pool(struct ice_vsi *vsi, u16 qid)
798 {
799 	struct ice_tx_ring *ring;
800 
801 	ring = vsi->rx_rings[qid]->xdp_ring;
802 	if (!ring)
803 		return;
804 
805 	WRITE_ONCE(ring->xsk_pool, ice_get_xp_from_qid(vsi, qid));
806 }
807 
808 /**
809  * ice_get_main_vsi - Get the PF VSI
810  * @pf: PF instance
811  *
812  * returns pf->vsi[0], which by definition is the PF VSI
813  */
814 static inline struct ice_vsi *ice_get_main_vsi(struct ice_pf *pf)
815 {
816 	if (pf->vsi)
817 		return pf->vsi[0];
818 
819 	return NULL;
820 }
821 
822 /**
823  * ice_get_netdev_priv_vsi - return VSI associated with netdev priv.
824  * @np: private netdev structure
825  */
826 static inline struct ice_vsi *ice_get_netdev_priv_vsi(struct ice_netdev_priv *np)
827 {
828 	/* In case of port representor return source port VSI. */
829 	if (np->repr)
830 		return np->repr->src_vsi;
831 	else
832 		return np->vsi;
833 }
834 
835 /**
836  * ice_get_ctrl_vsi - Get the control VSI
837  * @pf: PF instance
838  */
839 static inline struct ice_vsi *ice_get_ctrl_vsi(struct ice_pf *pf)
840 {
841 	/* if pf->ctrl_vsi_idx is ICE_NO_VSI, control VSI was not set up */
842 	if (!pf->vsi || pf->ctrl_vsi_idx == ICE_NO_VSI)
843 		return NULL;
844 
845 	return pf->vsi[pf->ctrl_vsi_idx];
846 }
847 
848 /**
849  * ice_find_vsi - Find the VSI from VSI ID
850  * @pf: The PF pointer to search in
851  * @vsi_num: The VSI ID to search for
852  */
853 static inline struct ice_vsi *ice_find_vsi(struct ice_pf *pf, u16 vsi_num)
854 {
855 	int i;
856 
857 	ice_for_each_vsi(pf, i)
858 		if (pf->vsi[i] && pf->vsi[i]->vsi_num == vsi_num)
859 			return  pf->vsi[i];
860 	return NULL;
861 }
862 
863 /**
864  * ice_is_switchdev_running - check if switchdev is configured
865  * @pf: pointer to PF structure
866  *
867  * Returns true if eswitch mode is set to DEVLINK_ESWITCH_MODE_SWITCHDEV
868  * and switchdev is configured, false otherwise.
869  */
870 static inline bool ice_is_switchdev_running(struct ice_pf *pf)
871 {
872 	return pf->eswitch.is_running;
873 }
874 
875 #define ICE_FD_STAT_CTR_BLOCK_COUNT	256
876 #define ICE_FD_STAT_PF_IDX(base_idx) \
877 			((base_idx) * ICE_FD_STAT_CTR_BLOCK_COUNT)
878 #define ICE_FD_SB_STAT_IDX(base_idx) ICE_FD_STAT_PF_IDX(base_idx)
879 #define ICE_FD_STAT_CH			1
880 #define ICE_FD_CH_STAT_IDX(base_idx) \
881 			(ICE_FD_STAT_PF_IDX(base_idx) + ICE_FD_STAT_CH)
882 
883 /**
884  * ice_is_adq_active - any active ADQs
885  * @pf: pointer to PF
886  *
887  * This function returns true if there are any ADQs configured (which is
888  * determined by looking at VSI type (which should be VSI_PF), numtc, and
889  * TC_MQPRIO flag) otherwise return false
890  */
891 static inline bool ice_is_adq_active(struct ice_pf *pf)
892 {
893 	struct ice_vsi *vsi;
894 
895 	vsi = ice_get_main_vsi(pf);
896 	if (!vsi)
897 		return false;
898 
899 	/* is ADQ configured */
900 	if (vsi->tc_cfg.numtc > ICE_CHNL_START_TC &&
901 	    test_bit(ICE_FLAG_TC_MQPRIO, pf->flags))
902 		return true;
903 
904 	return false;
905 }
906 
907 void ice_debugfs_fwlog_init(struct ice_pf *pf);
908 void ice_debugfs_pf_deinit(struct ice_pf *pf);
909 void ice_debugfs_init(void);
910 void ice_debugfs_exit(void);
911 void ice_pf_fwlog_update_module(struct ice_pf *pf, int log_level, int module);
912 
913 bool netif_is_ice(const struct net_device *dev);
914 int ice_vsi_setup_tx_rings(struct ice_vsi *vsi);
915 int ice_vsi_setup_rx_rings(struct ice_vsi *vsi);
916 int ice_vsi_open_ctrl(struct ice_vsi *vsi);
917 int ice_vsi_open(struct ice_vsi *vsi);
918 void ice_set_ethtool_ops(struct net_device *netdev);
919 void ice_set_ethtool_repr_ops(struct net_device *netdev);
920 void ice_set_ethtool_safe_mode_ops(struct net_device *netdev);
921 u16 ice_get_avail_txq_count(struct ice_pf *pf);
922 u16 ice_get_avail_rxq_count(struct ice_pf *pf);
923 int ice_vsi_recfg_qs(struct ice_vsi *vsi, int new_rx, int new_tx, bool locked);
924 void ice_update_vsi_stats(struct ice_vsi *vsi);
925 void ice_update_pf_stats(struct ice_pf *pf);
926 void
927 ice_fetch_u64_stats_per_ring(struct u64_stats_sync *syncp,
928 			     struct ice_q_stats stats, u64 *pkts, u64 *bytes);
929 int ice_up(struct ice_vsi *vsi);
930 int ice_down(struct ice_vsi *vsi);
931 int ice_down_up(struct ice_vsi *vsi);
932 int ice_vsi_cfg_lan(struct ice_vsi *vsi);
933 struct ice_vsi *ice_lb_vsi_setup(struct ice_pf *pf, struct ice_port_info *pi);
934 
935 enum ice_xdp_cfg {
936 	ICE_XDP_CFG_FULL,	/* Fully apply new config in .ndo_bpf() */
937 	ICE_XDP_CFG_PART,	/* Save/use part of config in VSI rebuild */
938 };
939 
940 int ice_vsi_determine_xdp_res(struct ice_vsi *vsi);
941 int ice_prepare_xdp_rings(struct ice_vsi *vsi, struct bpf_prog *prog,
942 			  enum ice_xdp_cfg cfg_type);
943 int ice_destroy_xdp_rings(struct ice_vsi *vsi, enum ice_xdp_cfg cfg_type);
944 void ice_map_xdp_rings(struct ice_vsi *vsi);
945 int
946 ice_xdp_xmit(struct net_device *dev, int n, struct xdp_frame **frames,
947 	     u32 flags);
948 int ice_set_rss_lut(struct ice_vsi *vsi, u8 *lut, u16 lut_size);
949 int ice_get_rss_lut(struct ice_vsi *vsi, u8 *lut, u16 lut_size);
950 int ice_set_rss_key(struct ice_vsi *vsi, u8 *seed);
951 int ice_get_rss_key(struct ice_vsi *vsi, u8 *seed);
952 int ice_set_rss_hfunc(struct ice_vsi *vsi, u8 hfunc);
953 void ice_fill_rss_lut(u8 *lut, u16 rss_table_size, u16 rss_size);
954 int ice_schedule_reset(struct ice_pf *pf, enum ice_reset_req reset);
955 void ice_print_link_msg(struct ice_vsi *vsi, bool isup);
956 int ice_plug_aux_dev(struct ice_pf *pf);
957 void ice_unplug_aux_dev(struct ice_pf *pf);
958 int ice_init_rdma(struct ice_pf *pf);
959 void ice_deinit_rdma(struct ice_pf *pf);
960 const char *ice_aq_str(enum ice_aq_err aq_err);
961 bool ice_is_wol_supported(struct ice_hw *hw);
962 void ice_fdir_del_all_fltrs(struct ice_vsi *vsi);
963 int
964 ice_fdir_write_fltr(struct ice_pf *pf, struct ice_fdir_fltr *input, bool add,
965 		    bool is_tun);
966 void ice_vsi_manage_fdir(struct ice_vsi *vsi, bool ena);
967 int ice_add_fdir_ethtool(struct ice_vsi *vsi, struct ethtool_rxnfc *cmd);
968 int ice_del_fdir_ethtool(struct ice_vsi *vsi, struct ethtool_rxnfc *cmd);
969 int ice_get_ethtool_fdir_entry(struct ice_hw *hw, struct ethtool_rxnfc *cmd);
970 int
971 ice_get_fdir_fltr_ids(struct ice_hw *hw, struct ethtool_rxnfc *cmd,
972 		      u32 *rule_locs);
973 void ice_fdir_rem_adq_chnl(struct ice_hw *hw, u16 vsi_idx);
974 void ice_fdir_release_flows(struct ice_hw *hw);
975 void ice_fdir_replay_flows(struct ice_hw *hw);
976 void ice_fdir_replay_fltrs(struct ice_pf *pf);
977 int ice_fdir_create_dflt_rules(struct ice_pf *pf);
978 
979 enum ice_aq_task_state {
980 	ICE_AQ_TASK_NOT_PREPARED,
981 	ICE_AQ_TASK_WAITING,
982 	ICE_AQ_TASK_COMPLETE,
983 	ICE_AQ_TASK_CANCELED,
984 };
985 
986 struct ice_aq_task {
987 	struct hlist_node entry;
988 	struct ice_rq_event_info event;
989 	enum ice_aq_task_state state;
990 	u16 opcode;
991 };
992 
993 void ice_aq_prep_for_event(struct ice_pf *pf, struct ice_aq_task *task,
994 			   u16 opcode);
995 int ice_aq_wait_for_event(struct ice_pf *pf, struct ice_aq_task *task,
996 			  unsigned long timeout);
997 int ice_open(struct net_device *netdev);
998 int ice_open_internal(struct net_device *netdev);
999 int ice_stop(struct net_device *netdev);
1000 void ice_service_task_schedule(struct ice_pf *pf);
1001 int ice_load(struct ice_pf *pf);
1002 void ice_unload(struct ice_pf *pf);
1003 void ice_adv_lnk_speed_maps_init(void);
1004 int ice_init_dev(struct ice_pf *pf);
1005 void ice_deinit_dev(struct ice_pf *pf);
1006 
1007 /**
1008  * ice_set_rdma_cap - enable RDMA support
1009  * @pf: PF struct
1010  */
1011 static inline void ice_set_rdma_cap(struct ice_pf *pf)
1012 {
1013 	if (pf->hw.func_caps.common_cap.rdma && pf->num_rdma_msix) {
1014 		set_bit(ICE_FLAG_RDMA_ENA, pf->flags);
1015 		set_bit(ICE_FLAG_PLUG_AUX_DEV, pf->flags);
1016 	}
1017 }
1018 
1019 /**
1020  * ice_clear_rdma_cap - disable RDMA support
1021  * @pf: PF struct
1022  */
1023 static inline void ice_clear_rdma_cap(struct ice_pf *pf)
1024 {
1025 	/* defer unplug to service task to avoid RTNL lock and
1026 	 * clear PLUG bit so that pending plugs don't interfere
1027 	 */
1028 	clear_bit(ICE_FLAG_PLUG_AUX_DEV, pf->flags);
1029 	set_bit(ICE_FLAG_UNPLUG_AUX_DEV, pf->flags);
1030 	clear_bit(ICE_FLAG_RDMA_ENA, pf->flags);
1031 }
1032 
1033 extern const struct xdp_metadata_ops ice_xdp_md_ops;
1034 #endif /* _ICE_H_ */
1035