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