1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2018 Intel Corporation
8 #include <rte_kvargs.h>
10 #include <rte_ethdev_driver.h>
12 #include "base/ice_common.h"
13 #include "base/ice_adminq_cmd.h"
15 #define ICE_VLAN_TAG_SIZE 4
17 #define ICE_ADMINQ_LEN 32
18 #define ICE_SBIOQ_LEN 32
19 #define ICE_MAILBOXQ_LEN 32
20 #define ICE_ADMINQ_BUF_SZ 4096
21 #define ICE_SBIOQ_BUF_SZ 4096
22 #define ICE_MAILBOXQ_BUF_SZ 4096
23 /* Number of queues per TC should be one of 1, 2, 4, 8, 16, 32, 64 */
24 #define ICE_MAX_Q_PER_TC 64
25 #define ICE_NUM_DESC_DEFAULT 512
26 #define ICE_BUF_SIZE_MIN 1024
27 #define ICE_FRAME_SIZE_MAX 9728
28 #define ICE_QUEUE_BASE_ADDR_UNIT 128
29 /* number of VSIs and queue default setting */
30 #define ICE_MAX_QP_NUM_PER_VF 16
31 #define ICE_DEFAULT_QP_NUM_FDIR 1
32 #define ICE_UINT32_BIT_SIZE (CHAR_BIT * sizeof(uint32_t))
33 #define ICE_VFTA_SIZE (4096 / ICE_UINT32_BIT_SIZE)
34 /* Maximun number of MAC addresses */
35 #define ICE_NUM_MACADDR_MAX 64
36 /* Maximum number of VFs */
37 #define ICE_MAX_VF 128
38 #define ICE_MAX_INTR_QUEUE_NUM 256
40 #define ICE_MISC_VEC_ID RTE_INTR_VEC_ZERO_OFFSET
41 #define ICE_RX_VEC_ID RTE_INTR_VEC_RXTX_OFFSET
43 #define ICE_MAX_PKT_TYPE 1024
46 * vlan_id is a 12 bit number.
47 * The VFTA array is actually a 4096 bit array, 128 of 32bit elements.
48 * 2^5 = 32. The val of lower 5 bits specifies the bit in the 32bit element.
49 * The higher 7 bit val specifies VFTA array index.
51 #define ICE_VFTA_BIT(vlan_id) (1 << ((vlan_id) & 0x1F))
52 #define ICE_VFTA_IDX(vlan_id) ((vlan_id) >> 5)
54 /* Default TC traffic in case DCB is not enabled */
55 #define ICE_DEFAULT_TCMAP 0x1
56 #define ICE_FDIR_QUEUE_ID 0
58 /* Always assign pool 0 to main VSI, VMDQ will start from 1 */
59 #define ICE_VMDQ_POOL_BASE 1
61 #define ICE_DEFAULT_RX_FREE_THRESH 32
62 #define ICE_DEFAULT_RX_PTHRESH 8
63 #define ICE_DEFAULT_RX_HTHRESH 8
64 #define ICE_DEFAULT_RX_WTHRESH 0
66 #define ICE_DEFAULT_TX_FREE_THRESH 32
67 #define ICE_DEFAULT_TX_PTHRESH 32
68 #define ICE_DEFAULT_TX_HTHRESH 0
69 #define ICE_DEFAULT_TX_WTHRESH 0
70 #define ICE_DEFAULT_TX_RSBIT_THRESH 32
72 /* Bit shift and mask */
73 #define ICE_4_BIT_WIDTH (CHAR_BIT / 2)
74 #define ICE_4_BIT_MASK RTE_LEN2MASK(ICE_4_BIT_WIDTH, uint8_t)
75 #define ICE_8_BIT_WIDTH CHAR_BIT
76 #define ICE_8_BIT_MASK UINT8_MAX
77 #define ICE_16_BIT_WIDTH (CHAR_BIT * 2)
78 #define ICE_16_BIT_MASK UINT16_MAX
79 #define ICE_32_BIT_WIDTH (CHAR_BIT * 4)
80 #define ICE_32_BIT_MASK UINT32_MAX
81 #define ICE_40_BIT_WIDTH (CHAR_BIT * 5)
82 #define ICE_40_BIT_MASK RTE_LEN2MASK(ICE_40_BIT_WIDTH, uint64_t)
83 #define ICE_48_BIT_WIDTH (CHAR_BIT * 6)
84 #define ICE_48_BIT_MASK RTE_LEN2MASK(ICE_48_BIT_WIDTH, uint64_t)
86 #define ICE_FLAG_RSS BIT_ULL(0)
87 #define ICE_FLAG_DCB BIT_ULL(1)
88 #define ICE_FLAG_VMDQ BIT_ULL(2)
89 #define ICE_FLAG_SRIOV BIT_ULL(3)
90 #define ICE_FLAG_HEADER_SPLIT_DISABLED BIT_ULL(4)
91 #define ICE_FLAG_HEADER_SPLIT_ENABLED BIT_ULL(5)
92 #define ICE_FLAG_FDIR BIT_ULL(6)
93 #define ICE_FLAG_VXLAN BIT_ULL(7)
94 #define ICE_FLAG_RSS_AQ_CAPABLE BIT_ULL(8)
95 #define ICE_FLAG_VF_MAC_BY_PF BIT_ULL(9)
96 #define ICE_FLAG_ALL (ICE_FLAG_RSS | \
100 ICE_FLAG_HEADER_SPLIT_DISABLED | \
101 ICE_FLAG_HEADER_SPLIT_ENABLED | \
104 ICE_FLAG_RSS_AQ_CAPABLE | \
105 ICE_FLAG_VF_MAC_BY_PF)
107 #define ICE_RSS_OFFLOAD_ALL ( \
108 ETH_RSS_FRAG_IPV4 | \
109 ETH_RSS_NONFRAG_IPV4_TCP | \
110 ETH_RSS_NONFRAG_IPV4_UDP | \
111 ETH_RSS_NONFRAG_IPV4_SCTP | \
112 ETH_RSS_NONFRAG_IPV4_OTHER | \
113 ETH_RSS_FRAG_IPV6 | \
114 ETH_RSS_NONFRAG_IPV6_TCP | \
115 ETH_RSS_NONFRAG_IPV6_UDP | \
116 ETH_RSS_NONFRAG_IPV6_SCTP | \
117 ETH_RSS_NONFRAG_IPV6_OTHER | \
121 * The overhead from MTU to max frame size.
122 * Considering QinQ packet, the VLAN tag needs to be counted twice.
124 #define ICE_ETH_OVERHEAD \
125 (RTE_ETHER_HDR_LEN + RTE_ETHER_CRC_LEN + ICE_VLAN_TAG_SIZE * 2)
127 /* DDP package type */
129 ICE_PKG_TYPE_UNKNOWN,
130 ICE_PKG_TYPE_OS_DEFAULT,
137 * MAC filter structure
139 struct ice_mac_filter_info {
140 struct rte_ether_addr mac_addr;
143 TAILQ_HEAD(ice_mac_filter_list, ice_mac_filter);
145 /* MAC filter list structure */
146 struct ice_mac_filter {
147 TAILQ_ENTRY(ice_mac_filter) next;
148 struct ice_mac_filter_info mac_info;
152 * VLAN filter structure
154 struct ice_vlan_filter_info {
158 TAILQ_HEAD(ice_vlan_filter_list, ice_vlan_filter);
160 /* VLAN filter list structure */
161 struct ice_vlan_filter {
162 TAILQ_ENTRY(ice_vlan_filter) next;
163 struct ice_vlan_filter_info vlan_info;
167 LIST_ENTRY(pool_entry) next;
172 LIST_HEAD(res_list, pool_entry);
174 struct ice_res_pool_info {
175 uint32_t base; /* Resource start index */
176 uint32_t num_alloc; /* Allocated resource number */
177 uint32_t num_free; /* Total available resource number */
178 struct res_list alloc_list; /* Allocated resource list */
179 struct res_list free_list; /* Available resource list */
182 TAILQ_HEAD(ice_vsi_list_head, ice_vsi_list);
186 /* VSI list structure */
187 struct ice_vsi_list {
188 TAILQ_ENTRY(ice_vsi_list) list;
196 * Structure that defines a VSI, associated with a adapter.
199 struct ice_adapter *adapter; /* Backreference to associated adapter */
200 struct ice_aqc_vsi_props info; /* VSI properties */
202 * When drivers loaded, only a default main VSI exists. In case new VSI
203 * needs to add, HW needs to know the layout that VSIs are organized.
204 * Besides that, VSI isan element and can't switch packets, which needs
205 * to add new component VEB to perform switching. So, a new VSI needs
206 * to specify the the uplink VSI (Parent VSI) before created. The
207 * uplink VSI will check whether it had a VEB to switch packets. If no,
208 * it will try to create one. Then, uplink VSI will move the new VSI
209 * into its' sib_vsi_list to manage all the downlink VSI.
210 * sib_vsi_list: the VSI list that shared the same uplink VSI.
211 * parent_vsi : the uplink VSI. It's NULL for main VSI.
212 * veb : the VEB associates with the VSI.
214 struct ice_vsi_list sib_vsi_list; /* sibling vsi list */
215 struct ice_vsi *parent_vsi;
216 enum ice_vsi_type type; /* VSI types */
217 uint16_t vlan_num; /* Total VLAN number */
218 uint16_t mac_num; /* Total mac number */
219 struct ice_mac_filter_list mac_list; /* macvlan filter list */
220 struct ice_vlan_filter_list vlan_list; /* vlan filter list */
221 uint16_t nb_qps; /* Number of queue pairs VSI can occupy */
222 uint16_t nb_used_qps; /* Number of queue pairs VSI uses */
223 uint16_t max_macaddrs; /* Maximum number of MAC addresses */
224 uint16_t base_queue; /* The first queue index of this VSI */
225 uint16_t vsi_id; /* Hardware Id */
226 uint16_t idx; /* vsi_handle: SW index in hw->vsi_ctx */
227 /* VF number to which the VSI connects, valid when VSI is VF type */
229 uint16_t msix_intr; /* The MSIX interrupt binds to VSI */
230 uint16_t nb_msix; /* The max number of msix vector */
231 uint8_t enabled_tc; /* The traffic class enabled */
232 uint8_t vlan_anti_spoof_on; /* The VLAN anti-spoofing enabled */
233 uint8_t vlan_filter_on; /* The VLAN filter enabled */
234 /* information about rss configuration */
239 struct ice_eth_stats eth_stats_offset;
240 struct ice_eth_stats eth_stats;
245 TAILQ_HEAD(ice_flow_list, rte_flow);
247 struct ice_flow_parser_node;
248 TAILQ_HEAD(ice_parser_list, ice_flow_parser_node);
250 struct ice_fdir_filter_conf {
251 struct ice_fdir_fltr input;
255 #define ICE_FDIR_COUNTER_DEFAULT_POOL_SIZE 1
256 #define ICE_FDIR_COUNTER_MAX_POOL_SIZE 32
257 #define ICE_FDIR_COUNTERS_PER_BLOCK 256
258 #define ICE_FDIR_COUNTER_INDEX(base_idx) \
259 ((base_idx) * ICE_FDIR_COUNTERS_PER_BLOCK)
260 struct ice_fdir_counter {
261 TAILQ_ENTRY(ice_fdir_counter) next;
270 TAILQ_HEAD(ice_fdir_counter_list, ice_fdir_counter);
272 struct ice_fdir_counter_pool {
273 TAILQ_ENTRY(ice_fdir_counter_pool) next;
274 struct ice_fdir_counter_list counter_list;
275 struct ice_fdir_counter counters[0];
278 TAILQ_HEAD(ice_fdir_counter_pool_list, ice_fdir_counter_pool);
280 struct ice_fdir_counter_pool_container {
281 struct ice_fdir_counter_pool_list pool_list;
282 struct ice_fdir_counter_pool *pools[ICE_FDIR_COUNTER_MAX_POOL_SIZE];
287 * A structure used to define fields of a FDIR related info.
289 struct ice_fdir_info {
290 struct ice_vsi *fdir_vsi; /* pointer to fdir VSI structure */
291 struct ice_tx_queue *txq;
292 struct ice_rx_queue *rxq;
293 void *prg_pkt; /* memory for fdir program packet */
294 uint64_t dma_addr; /* physic address of packet memory*/
295 struct ice_fdir_filter_conf conf;
297 struct ice_fdir_counter_pool_container counter;
301 struct ice_adapter *adapter; /* The adapter this PF associate to */
302 struct ice_vsi *main_vsi; /* pointer to main VSI structure */
303 /* Used for next free software vsi idx.
304 * To save the effort, we don't recycle the index.
305 * Suppose the indexes are more than enough.
307 uint16_t next_vsi_idx;
308 uint16_t vsis_allocated;
309 uint16_t vsis_unallocated;
310 struct ice_res_pool_info qp_pool; /*Queue pair pool */
311 struct ice_res_pool_info msix_pool; /* MSIX interrupt pool */
312 struct rte_eth_dev_data *dev_data; /* Pointer to the device data */
313 struct rte_ether_addr dev_addr; /* PF device mac address */
314 uint64_t flags; /* PF feature flags */
315 uint16_t hash_lut_size; /* The size of hash lookup table */
316 uint16_t lan_nb_qp_max;
317 uint16_t lan_nb_qps; /* The number of queue pairs of LAN */
318 uint16_t base_queue; /* The base queue pairs index in the device */
319 uint8_t *proto_xtr; /* Protocol extraction type for all queues */
320 uint16_t fdir_nb_qps; /* The number of queue pairs of Flow Director */
321 uint16_t fdir_qp_offset;
322 struct ice_fdir_info fdir; /* flow director info */
323 uint16_t hw_prof_cnt[ICE_FLTR_PTYPE_MAX][ICE_FD_HW_SEG_MAX];
324 uint16_t fdir_fltr_cnt[ICE_FLTR_PTYPE_MAX][ICE_FD_HW_SEG_MAX];
325 struct ice_hw_port_stats stats_offset;
326 struct ice_hw_port_stats stats;
327 /* internal packet statistics, it should be excluded from the total */
328 struct ice_eth_stats internal_stats_offset;
329 struct ice_eth_stats internal_stats;
331 bool adapter_stopped;
332 struct ice_flow_list flow_list;
333 struct ice_parser_list rss_parser_list;
334 struct ice_parser_list perm_parser_list;
335 struct ice_parser_list dist_parser_list;
338 #define ICE_MAX_QUEUE_NUM 2048
341 * Cache devargs parse result.
344 int safe_mode_support;
345 uint8_t proto_xtr_dflt;
346 int pipe_mode_support;
347 uint8_t proto_xtr[ICE_MAX_QUEUE_NUM];
351 * Structure to store private data for each PF/VF instance.
354 /* Common for both PF and VF */
356 struct rte_eth_dev *eth_dev;
358 bool rx_bulk_alloc_allowed;
361 bool tx_simple_allowed;
362 /* ptype mapping table */
363 uint32_t ptype_tbl[ICE_MAX_PKT_TYPE] __rte_cache_min_aligned;
365 struct ice_devargs devargs;
366 enum ice_pkg_type active_pkg_type; /* loaded ddp package type */
369 struct ice_vsi_vlan_pvid_info {
370 uint16_t on; /* Enable or disable pvid */
372 uint16_t pvid; /* Valid in case 'on' is set to set pvid */
374 /* Valid in case 'on' is cleared. 'tagged' will reject
375 * tagged packets, while 'untagged' will reject
384 #define ICE_DEV_TO_PCI(eth_dev) \
385 RTE_DEV_TO_PCI((eth_dev)->device)
387 /* ICE_DEV_PRIVATE_TO */
388 #define ICE_DEV_PRIVATE_TO_PF(adapter) \
389 (&((struct ice_adapter *)adapter)->pf)
390 #define ICE_DEV_PRIVATE_TO_HW(adapter) \
391 (&((struct ice_adapter *)adapter)->hw)
392 #define ICE_DEV_PRIVATE_TO_ADAPTER(adapter) \
393 ((struct ice_adapter *)adapter)
396 #define ICE_VSI_TO_HW(vsi) \
397 (&(((struct ice_vsi *)vsi)->adapter->hw))
398 #define ICE_VSI_TO_PF(vsi) \
399 (&(((struct ice_vsi *)vsi)->adapter->pf))
400 #define ICE_VSI_TO_ETH_DEV(vsi) \
401 (((struct ice_vsi *)vsi)->adapter->eth_dev)
404 #define ICE_PF_TO_HW(pf) \
405 (&(((struct ice_pf *)pf)->adapter->hw))
406 #define ICE_PF_TO_ADAPTER(pf) \
407 ((struct ice_adapter *)(pf)->adapter)
408 #define ICE_PF_TO_ETH_DEV(pf) \
409 (((struct ice_pf *)pf)->adapter->eth_dev)
412 ice_setup_vsi(struct ice_pf *pf, enum ice_vsi_type type);
414 ice_release_vsi(struct ice_vsi *vsi);
417 ice_align_floor(int n)
421 return 1 << (sizeof(n) * CHAR_BIT - 1 - __builtin_clz(n));
424 #define ICE_PHY_TYPE_SUPPORT_50G(phy_type) \
425 (((phy_type) & ICE_PHY_TYPE_LOW_50GBASE_CR2) || \
426 ((phy_type) & ICE_PHY_TYPE_LOW_50GBASE_SR2) || \
427 ((phy_type) & ICE_PHY_TYPE_LOW_50GBASE_LR2) || \
428 ((phy_type) & ICE_PHY_TYPE_LOW_50GBASE_KR2) || \
429 ((phy_type) & ICE_PHY_TYPE_LOW_50G_LAUI2_AOC_ACC) || \
430 ((phy_type) & ICE_PHY_TYPE_LOW_50G_LAUI2) || \
431 ((phy_type) & ICE_PHY_TYPE_LOW_50G_AUI2_AOC_ACC) || \
432 ((phy_type) & ICE_PHY_TYPE_LOW_50G_AUI2) || \
433 ((phy_type) & ICE_PHY_TYPE_LOW_50GBASE_CP) || \
434 ((phy_type) & ICE_PHY_TYPE_LOW_50GBASE_SR) || \
435 ((phy_type) & ICE_PHY_TYPE_LOW_50GBASE_FR) || \
436 ((phy_type) & ICE_PHY_TYPE_LOW_50GBASE_LR) || \
437 ((phy_type) & ICE_PHY_TYPE_LOW_50GBASE_KR_PAM4) || \
438 ((phy_type) & ICE_PHY_TYPE_LOW_50G_AUI1_AOC_ACC) || \
439 ((phy_type) & ICE_PHY_TYPE_LOW_50G_AUI1))
441 #define ICE_PHY_TYPE_SUPPORT_100G_LOW(phy_type) \
442 (((phy_type) & ICE_PHY_TYPE_LOW_100GBASE_CR4) || \
443 ((phy_type) & ICE_PHY_TYPE_LOW_100GBASE_SR4) || \
444 ((phy_type) & ICE_PHY_TYPE_LOW_100GBASE_LR4) || \
445 ((phy_type) & ICE_PHY_TYPE_LOW_100GBASE_KR4) || \
446 ((phy_type) & ICE_PHY_TYPE_LOW_100G_CAUI4_AOC_ACC) || \
447 ((phy_type) & ICE_PHY_TYPE_LOW_100G_CAUI4) || \
448 ((phy_type) & ICE_PHY_TYPE_LOW_100G_AUI4_AOC_ACC) || \
449 ((phy_type) & ICE_PHY_TYPE_LOW_100G_AUI4) || \
450 ((phy_type) & ICE_PHY_TYPE_LOW_100GBASE_CR_PAM4) || \
451 ((phy_type) & ICE_PHY_TYPE_LOW_100GBASE_KR_PAM4) || \
452 ((phy_type) & ICE_PHY_TYPE_LOW_100GBASE_CP2) || \
453 ((phy_type) & ICE_PHY_TYPE_LOW_100GBASE_SR2) || \
454 ((phy_type) & ICE_PHY_TYPE_LOW_100GBASE_DR))
456 #define ICE_PHY_TYPE_SUPPORT_100G_HIGH(phy_type) \
457 (((phy_type) & ICE_PHY_TYPE_HIGH_100GBASE_KR2_PAM4) || \
458 ((phy_type) & ICE_PHY_TYPE_HIGH_100G_CAUI2_AOC_ACC) || \
459 ((phy_type) & ICE_PHY_TYPE_HIGH_100G_CAUI2) || \
460 ((phy_type) & ICE_PHY_TYPE_HIGH_100G_AUI2_AOC_ACC) || \
461 ((phy_type) & ICE_PHY_TYPE_HIGH_100G_AUI2))
463 #endif /* _ICE_ETHDEV_H_ */