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