1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017 Intel Corporation
8 /* In QLEN must be whole number of 32 descriptors. */
9 #define IAVF_ALIGN_RING_DESC 32
10 #define IAVF_MIN_RING_DESC 64
11 #define IAVF_MAX_RING_DESC 4096
12 #define IAVF_DMA_MEM_ALIGN 4096
13 /* Base address of the HW descriptor ring should be 128B aligned. */
14 #define IAVF_RING_BASE_ALIGN 128
16 /* used for Rx Bulk Allocate */
17 #define IAVF_RX_MAX_BURST 32
19 /* used for Vector PMD */
20 #define IAVF_VPMD_RX_MAX_BURST 32
21 #define IAVF_VPMD_TX_MAX_BURST 32
22 #define IAVF_RXQ_REARM_THRESH 32
23 #define IAVF_VPMD_DESCS_PER_LOOP 4
24 #define IAVF_VPMD_TX_MAX_FREE_BUF 64
26 #define IAVF_TX_NO_VECTOR_FLAGS ( \
27 DEV_TX_OFFLOAD_MULTI_SEGS | \
28 DEV_TX_OFFLOAD_TCP_TSO)
30 #define IAVF_TX_VECTOR_OFFLOAD ( \
31 DEV_TX_OFFLOAD_VLAN_INSERT | \
32 DEV_TX_OFFLOAD_QINQ_INSERT | \
33 DEV_TX_OFFLOAD_IPV4_CKSUM | \
34 DEV_TX_OFFLOAD_SCTP_CKSUM | \
35 DEV_TX_OFFLOAD_UDP_CKSUM | \
36 DEV_TX_OFFLOAD_TCP_CKSUM)
38 #define IAVF_RX_VECTOR_OFFLOAD ( \
39 DEV_RX_OFFLOAD_CHECKSUM | \
40 DEV_RX_OFFLOAD_SCTP_CKSUM | \
41 DEV_RX_OFFLOAD_VLAN | \
42 DEV_RX_OFFLOAD_RSS_HASH)
44 #define IAVF_VECTOR_PATH 0
45 #define IAVF_VECTOR_OFFLOAD_PATH 1
47 #define DEFAULT_TX_RS_THRESH 32
48 #define DEFAULT_TX_FREE_THRESH 32
50 #define IAVF_MIN_TSO_MSS 88
51 #define IAVF_MAX_TSO_MSS 9668
52 #define IAVF_TSO_MAX_SEG UINT8_MAX
53 #define IAVF_TX_MAX_MTU_SEG 8
55 #define IAVF_TX_CKSUM_OFFLOAD_MASK ( \
60 #define IAVF_TX_OFFLOAD_MASK ( \
70 #define IAVF_TX_OFFLOAD_NOTSUP_MASK \
71 (PKT_TX_OFFLOAD_MASK ^ IAVF_TX_OFFLOAD_MASK)
75 * These descriptors are used instead of the legacy version descriptors
77 union iavf_16b_rx_flex_desc {
79 __le64 pkt_addr; /* Packet buffer address */
80 __le64 hdr_addr; /* Header buffer address */
81 /* bit 0 of hdr_addr is DD bit */
85 u8 rxdid; /* descriptor builder profile ID */
86 u8 mir_id_umb_cast; /* mirror=[5:0], umb=[7:6] */
87 __le16 ptype_flex_flags0; /* ptype=[9:0], ff0=[15:10] */
88 __le16 pkt_len; /* [15:14] are reserved */
89 __le16 hdr_len_sph_flex_flags1; /* header=[10:0] */
101 union iavf_32b_rx_flex_desc {
103 __le64 pkt_addr; /* Packet buffer address */
104 __le64 hdr_addr; /* Header buffer address */
105 /* bit 0 of hdr_addr is DD bit */
111 u8 rxdid; /* descriptor builder profile ID */
112 u8 mir_id_umb_cast; /* mirror=[5:0], umb=[7:6] */
113 __le16 ptype_flex_flags0; /* ptype=[9:0], ff0=[15:10] */
114 __le16 pkt_len; /* [15:14] are reserved */
115 __le16 hdr_len_sph_flex_flags1; /* header=[10:0] */
117 /* ff1/ext=[15:12] */
120 __le16 status_error0;
126 __le16 status_error1;
142 } wb; /* writeback */
145 /* HW desc structure, both 16-byte and 32-byte types are supported */
146 #ifdef RTE_LIBRTE_IAVF_16BYTE_RX_DESC
147 #define iavf_rx_desc iavf_16byte_rx_desc
148 #define iavf_rx_flex_desc iavf_16b_rx_flex_desc
150 #define iavf_rx_desc iavf_32byte_rx_desc
151 #define iavf_rx_flex_desc iavf_32b_rx_flex_desc
154 typedef void (*iavf_rxd_to_pkt_fields_t)(struct iavf_rx_queue *rxq,
156 volatile union iavf_rx_flex_desc *rxdp);
158 struct iavf_rxq_ops {
159 void (*release_mbufs)(struct iavf_rx_queue *rxq);
162 struct iavf_txq_ops {
163 void (*release_mbufs)(struct iavf_tx_queue *txq);
166 /* Structure associated with each Rx queue. */
167 struct iavf_rx_queue {
168 struct rte_mempool *mp; /* mbuf pool to populate Rx ring */
169 const struct rte_memzone *mz; /* memzone for Rx ring */
170 volatile union iavf_rx_desc *rx_ring; /* Rx ring virtual address */
171 uint64_t rx_ring_phys_addr; /* Rx ring DMA address */
172 struct rte_mbuf **sw_ring; /* address of SW ring */
173 uint16_t nb_rx_desc; /* ring length */
174 uint16_t rx_tail; /* current value of tail */
175 volatile uint8_t *qrx_tail; /* register address of tail */
176 uint16_t rx_free_thresh; /* max free RX desc to hold */
177 uint16_t nb_rx_hold; /* number of held free RX desc */
178 struct rte_mbuf *pkt_first_seg; /* first segment of current packet */
179 struct rte_mbuf *pkt_last_seg; /* last segment of current packet */
180 struct rte_mbuf fake_mbuf; /* dummy mbuf */
184 uint16_t rxrearm_nb; /* number of remaining to be re-armed */
185 uint16_t rxrearm_start; /* the idx we start the re-arming from */
186 uint64_t mbuf_initializer; /* value to init mbufs */
189 uint16_t rx_nb_avail; /* number of staged packets ready */
190 uint16_t rx_next_avail; /* index of next staged packets */
191 uint16_t rx_free_trigger; /* triggers rx buffer allocation */
192 struct rte_mbuf *rx_stage[IAVF_RX_MAX_BURST * 2]; /* store mbuf */
194 uint16_t port_id; /* device port ID */
195 uint8_t crc_len; /* 0 if CRC stripped, 4 otherwise */
196 uint8_t fdir_enabled; /* 0 if FDIR disabled, 1 when enabled */
197 uint16_t queue_id; /* Rx queue index */
198 uint16_t rx_buf_len; /* The packet buffer size */
199 uint16_t rx_hdr_len; /* The header buffer size */
200 uint16_t max_pkt_len; /* Maximum packet length */
201 struct iavf_vsi *vsi; /**< the VSI this queue belongs to */
203 bool q_set; /* if rx queue has been configured */
204 bool rx_deferred_start; /* don't start this queue in dev start */
205 const struct iavf_rxq_ops *ops;
207 #define IAVF_RX_FLAGS_VLAN_TAG_LOC_L2TAG1 BIT(0)
208 #define IAVF_RX_FLAGS_VLAN_TAG_LOC_L2TAG2_2 BIT(1)
209 uint8_t proto_xtr; /* protocol extraction type */
210 uint64_t xtr_ol_flag;
211 /* flexible descriptor metadata extraction offload flag */
212 iavf_rxd_to_pkt_fields_t rxd_to_pkt_fields;
213 /* handle flexible descriptor by RXDID */
217 struct iavf_tx_entry {
218 struct rte_mbuf *mbuf;
223 struct iavf_tx_vec_entry {
224 struct rte_mbuf *mbuf;
227 /* Structure associated with each TX queue. */
228 struct iavf_tx_queue {
229 const struct rte_memzone *mz; /* memzone for Tx ring */
230 volatile struct iavf_tx_desc *tx_ring; /* Tx ring virtual address */
231 uint64_t tx_ring_phys_addr; /* Tx ring DMA address */
232 struct iavf_tx_entry *sw_ring; /* address array of SW ring */
233 uint16_t nb_tx_desc; /* ring length */
234 uint16_t tx_tail; /* current value of tail */
235 volatile uint8_t *qtx_tail; /* register address of tail */
236 /* number of used desc since RS bit set */
239 uint16_t last_desc_cleaned; /* last desc have been cleaned*/
240 uint16_t free_thresh;
246 uint16_t next_dd; /* next to set RS, for VPMD */
247 uint16_t next_rs; /* next to check DD, for VPMD */
249 bool q_set; /* if rx queue has been configured */
250 bool tx_deferred_start; /* don't start this queue in dev start */
251 const struct iavf_txq_ops *ops;
252 #define IAVF_TX_FLAGS_VLAN_TAG_LOC_L2TAG1 BIT(0)
253 #define IAVF_TX_FLAGS_VLAN_TAG_LOC_L2TAG2 BIT(1)
258 /* Offload features */
259 union iavf_tx_offload {
262 uint64_t l2_len:7; /* L2 (MAC) Header Length. */
263 uint64_t l3_len:9; /* L3 (IP) Header Length. */
264 uint64_t l4_len:8; /* L4 Header Length. */
265 uint64_t tso_segsz:16; /* TCP TSO segment size */
266 /* uint64_t unused : 24; */
270 /* Rx Flex Descriptor
271 * RxDID Profile ID 16-21
272 * Flex-field 0: RSS hash lower 16-bits
273 * Flex-field 1: RSS hash upper 16-bits
274 * Flex-field 2: Flow ID lower 16-bits
275 * Flex-field 3: Flow ID upper 16-bits
279 struct iavf_32b_rx_flex_desc_comms {
283 __le16 ptype_flexi_flags0;
285 __le16 hdr_len_sph_flex_flags1;
288 __le16 status_error0;
293 __le16 status_error1;
310 /* Rx Flex Descriptor
311 * RxDID Profile ID 22-23 (swap Hash and FlowID)
312 * Flex-field 0: Flow ID lower 16-bits
313 * Flex-field 1: Flow ID upper 16-bits
314 * Flex-field 2: RSS hash lower 16-bits
315 * Flex-field 3: RSS hash upper 16-bits
319 struct iavf_32b_rx_flex_desc_comms_ovs {
323 __le16 ptype_flexi_flags0;
325 __le16 hdr_len_sph_flex_flags1;
328 __le16 status_error0;
333 __le16 status_error1;
350 /* Receive Flex Descriptor profile IDs: There are a total
351 * of 64 profiles where profile IDs 0/1 are for legacy; and
352 * profiles 2-63 are flex profiles that can be programmed
353 * with a specific metadata (profile 7 reserved for HW)
356 IAVF_RXDID_LEGACY_0 = 0,
357 IAVF_RXDID_LEGACY_1 = 1,
358 IAVF_RXDID_FLEX_NIC = 2,
359 IAVF_RXDID_FLEX_NIC_2 = 6,
361 IAVF_RXDID_COMMS_GENERIC = 16,
362 IAVF_RXDID_COMMS_AUX_VLAN = 17,
363 IAVF_RXDID_COMMS_AUX_IPV4 = 18,
364 IAVF_RXDID_COMMS_AUX_IPV6 = 19,
365 IAVF_RXDID_COMMS_AUX_IPV6_FLOW = 20,
366 IAVF_RXDID_COMMS_AUX_TCP = 21,
367 IAVF_RXDID_COMMS_OVS_1 = 22,
368 IAVF_RXDID_COMMS_OVS_2 = 23,
369 IAVF_RXDID_COMMS_AUX_IP_OFFSET = 25,
370 IAVF_RXDID_LAST = 63,
373 enum iavf_rx_flex_desc_status_error_0_bits {
374 /* Note: These are predefined bit offsets */
375 IAVF_RX_FLEX_DESC_STATUS0_DD_S = 0,
376 IAVF_RX_FLEX_DESC_STATUS0_EOF_S,
377 IAVF_RX_FLEX_DESC_STATUS0_HBO_S,
378 IAVF_RX_FLEX_DESC_STATUS0_L3L4P_S,
379 IAVF_RX_FLEX_DESC_STATUS0_XSUM_IPE_S,
380 IAVF_RX_FLEX_DESC_STATUS0_XSUM_L4E_S,
381 IAVF_RX_FLEX_DESC_STATUS0_XSUM_EIPE_S,
382 IAVF_RX_FLEX_DESC_STATUS0_XSUM_EUDPE_S,
383 IAVF_RX_FLEX_DESC_STATUS0_LPBK_S,
384 IAVF_RX_FLEX_DESC_STATUS0_IPV6EXADD_S,
385 IAVF_RX_FLEX_DESC_STATUS0_RXE_S,
386 IAVF_RX_FLEX_DESC_STATUS0_CRCP_S,
387 IAVF_RX_FLEX_DESC_STATUS0_RSS_VALID_S,
388 IAVF_RX_FLEX_DESC_STATUS0_L2TAG1P_S,
389 IAVF_RX_FLEX_DESC_STATUS0_XTRMD0_VALID_S,
390 IAVF_RX_FLEX_DESC_STATUS0_XTRMD1_VALID_S,
391 IAVF_RX_FLEX_DESC_STATUS0_LAST /* this entry must be last!!! */
394 enum iavf_rx_flex_desc_status_error_1_bits {
395 /* Note: These are predefined bit offsets */
396 IAVF_RX_FLEX_DESC_STATUS1_CPM_S = 0, /* 4 bits */
397 IAVF_RX_FLEX_DESC_STATUS1_NAT_S = 4,
398 IAVF_RX_FLEX_DESC_STATUS1_CRYPTO_S = 5,
399 /* [10:6] reserved */
400 IAVF_RX_FLEX_DESC_STATUS1_L2TAG2P_S = 11,
401 IAVF_RX_FLEX_DESC_STATUS1_XTRMD2_VALID_S = 12,
402 IAVF_RX_FLEX_DESC_STATUS1_XTRMD3_VALID_S = 13,
403 IAVF_RX_FLEX_DESC_STATUS1_XTRMD4_VALID_S = 14,
404 IAVF_RX_FLEX_DESC_STATUS1_XTRMD5_VALID_S = 15,
405 IAVF_RX_FLEX_DESC_STATUS1_LAST /* this entry must be last!!! */
408 /* for iavf_32b_rx_flex_desc.ptype_flex_flags0 member */
409 #define IAVF_RX_FLEX_DESC_PTYPE_M (0x3FF) /* 10-bits */
411 /* for iavf_32b_rx_flex_desc.pkt_len member */
412 #define IAVF_RX_FLX_DESC_PKT_LEN_M (0x3FFF) /* 14-bits */
414 int iavf_dev_rx_queue_setup(struct rte_eth_dev *dev,
417 unsigned int socket_id,
418 const struct rte_eth_rxconf *rx_conf,
419 struct rte_mempool *mp);
421 int iavf_dev_rx_queue_start(struct rte_eth_dev *dev, uint16_t rx_queue_id);
422 int iavf_dev_rx_queue_stop(struct rte_eth_dev *dev, uint16_t rx_queue_id);
423 void iavf_dev_rx_queue_release(void *rxq);
425 int iavf_dev_tx_queue_setup(struct rte_eth_dev *dev,
428 unsigned int socket_id,
429 const struct rte_eth_txconf *tx_conf);
430 int iavf_dev_tx_queue_start(struct rte_eth_dev *dev, uint16_t tx_queue_id);
431 int iavf_dev_tx_queue_stop(struct rte_eth_dev *dev, uint16_t tx_queue_id);
432 int iavf_dev_tx_done_cleanup(void *txq, uint32_t free_cnt);
433 void iavf_dev_tx_queue_release(void *txq);
434 void iavf_stop_queues(struct rte_eth_dev *dev);
435 uint16_t iavf_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
437 uint16_t iavf_recv_pkts_flex_rxd(void *rx_queue,
438 struct rte_mbuf **rx_pkts,
440 uint16_t iavf_recv_scattered_pkts(void *rx_queue,
441 struct rte_mbuf **rx_pkts,
443 uint16_t iavf_recv_scattered_pkts_flex_rxd(void *rx_queue,
444 struct rte_mbuf **rx_pkts,
446 uint16_t iavf_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
448 uint16_t iavf_prep_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
450 void iavf_set_rx_function(struct rte_eth_dev *dev);
451 void iavf_set_tx_function(struct rte_eth_dev *dev);
452 void iavf_dev_rxq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
453 struct rte_eth_rxq_info *qinfo);
454 void iavf_dev_txq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
455 struct rte_eth_txq_info *qinfo);
456 uint32_t iavf_dev_rxq_count(struct rte_eth_dev *dev, uint16_t queue_id);
457 int iavf_dev_rx_desc_status(void *rx_queue, uint16_t offset);
458 int iavf_dev_tx_desc_status(void *tx_queue, uint16_t offset);
460 uint16_t iavf_recv_pkts_vec(void *rx_queue, struct rte_mbuf **rx_pkts,
462 uint16_t iavf_recv_pkts_vec_flex_rxd(void *rx_queue, struct rte_mbuf **rx_pkts,
464 uint16_t iavf_recv_scattered_pkts_vec(void *rx_queue,
465 struct rte_mbuf **rx_pkts,
467 uint16_t iavf_recv_scattered_pkts_vec_flex_rxd(void *rx_queue,
468 struct rte_mbuf **rx_pkts,
470 uint16_t iavf_xmit_fixed_burst_vec(void *tx_queue, struct rte_mbuf **tx_pkts,
472 uint16_t iavf_recv_pkts_vec_avx2(void *rx_queue, struct rte_mbuf **rx_pkts,
474 uint16_t iavf_recv_pkts_vec_avx2_flex_rxd(void *rx_queue,
475 struct rte_mbuf **rx_pkts,
477 uint16_t iavf_recv_scattered_pkts_vec_avx2(void *rx_queue,
478 struct rte_mbuf **rx_pkts,
480 uint16_t iavf_recv_scattered_pkts_vec_avx2_flex_rxd(void *rx_queue,
481 struct rte_mbuf **rx_pkts,
483 uint16_t iavf_xmit_pkts_vec(void *tx_queue, struct rte_mbuf **tx_pkts,
485 uint16_t iavf_xmit_pkts_vec_avx2(void *tx_queue, struct rte_mbuf **tx_pkts,
487 int iavf_get_monitor_addr(void *rx_queue, struct rte_power_monitor_cond *pmc);
488 int iavf_rx_vec_dev_check(struct rte_eth_dev *dev);
489 int iavf_tx_vec_dev_check(struct rte_eth_dev *dev);
490 int iavf_rxq_vec_setup(struct iavf_rx_queue *rxq);
491 int iavf_txq_vec_setup(struct iavf_tx_queue *txq);
492 uint16_t iavf_recv_pkts_vec_avx512(void *rx_queue, struct rte_mbuf **rx_pkts,
494 uint16_t iavf_recv_pkts_vec_avx512_offload(void *rx_queue,
495 struct rte_mbuf **rx_pkts,
497 uint16_t iavf_recv_pkts_vec_avx512_flex_rxd(void *rx_queue,
498 struct rte_mbuf **rx_pkts,
500 uint16_t iavf_recv_pkts_vec_avx512_flex_rxd_offload(void *rx_queue,
501 struct rte_mbuf **rx_pkts,
503 uint16_t iavf_recv_scattered_pkts_vec_avx512(void *rx_queue,
504 struct rte_mbuf **rx_pkts,
506 uint16_t iavf_recv_scattered_pkts_vec_avx512_offload(void *rx_queue,
507 struct rte_mbuf **rx_pkts,
509 uint16_t iavf_recv_scattered_pkts_vec_avx512_flex_rxd(void *rx_queue,
510 struct rte_mbuf **rx_pkts,
512 uint16_t iavf_recv_scattered_pkts_vec_avx512_flex_rxd_offload(void *rx_queue,
513 struct rte_mbuf **rx_pkts,
515 uint16_t iavf_xmit_pkts_vec_avx512(void *tx_queue, struct rte_mbuf **tx_pkts,
517 uint16_t iavf_xmit_pkts_vec_avx512_offload(void *tx_queue,
518 struct rte_mbuf **tx_pkts,
520 int iavf_txq_vec_setup_avx512(struct iavf_tx_queue *txq);
522 uint8_t iavf_proto_xtr_type_to_rxdid(uint8_t xtr_type);
524 const uint32_t *iavf_get_default_ptype_table(void);
527 void iavf_dump_rx_descriptor(struct iavf_rx_queue *rxq,
528 const volatile void *desc,
531 #ifdef RTE_LIBRTE_IAVF_16BYTE_RX_DESC
532 const volatile union iavf_16byte_rx_desc *rx_desc = desc;
534 printf("Queue %d Rx_desc %d: QW0: 0x%016"PRIx64" QW1: 0x%016"PRIx64"\n",
535 rxq->queue_id, rx_id, rx_desc->read.pkt_addr,
536 rx_desc->read.hdr_addr);
538 const volatile union iavf_32byte_rx_desc *rx_desc = desc;
540 printf("Queue %d Rx_desc %d: QW0: 0x%016"PRIx64" QW1: 0x%016"PRIx64
541 " QW2: 0x%016"PRIx64" QW3: 0x%016"PRIx64"\n", rxq->queue_id,
542 rx_id, rx_desc->read.pkt_addr, rx_desc->read.hdr_addr,
543 rx_desc->read.rsvd1, rx_desc->read.rsvd2);
547 /* All the descriptors are 16 bytes, so just use one of them
548 * to print the qwords
551 void iavf_dump_tx_descriptor(const struct iavf_tx_queue *txq,
552 const volatile void *desc, uint16_t tx_id)
555 const volatile struct iavf_tx_desc *tx_desc = desc;
556 enum iavf_tx_desc_dtype_value type;
558 type = (enum iavf_tx_desc_dtype_value)rte_le_to_cpu_64(
559 tx_desc->cmd_type_offset_bsz &
560 rte_cpu_to_le_64(IAVF_TXD_QW1_DTYPE_MASK));
562 case IAVF_TX_DESC_DTYPE_DATA:
563 name = "Tx_data_desc";
565 case IAVF_TX_DESC_DTYPE_CONTEXT:
566 name = "Tx_context_desc";
569 name = "unknown_desc";
573 printf("Queue %d %s %d: QW0: 0x%016"PRIx64" QW1: 0x%016"PRIx64"\n",
574 txq->queue_id, name, tx_id, tx_desc->buffer_addr,
575 tx_desc->cmd_type_offset_bsz);
578 #define FDIR_PROC_ENABLE_PER_QUEUE(ad, on) do { \
580 for (i = 0; i < (ad)->eth_dev->data->nb_rx_queues; i++) { \
581 struct iavf_rx_queue *rxq = (ad)->eth_dev->data->rx_queues[i]; \
584 rxq->fdir_enabled = on; \
586 PMD_DRV_LOG(DEBUG, "FDIR processing on RX set to %d", on); \
589 /* Enable/disable flow director Rx processing in data path. */
591 void iavf_fdir_rx_proc_enable(struct iavf_adapter *ad, bool on)
594 /* enable flow director processing */
595 FDIR_PROC_ENABLE_PER_QUEUE(ad, on);
598 if (ad->fdir_ref_cnt >= 1) {
601 if (ad->fdir_ref_cnt == 0)
602 FDIR_PROC_ENABLE_PER_QUEUE(ad, on);
607 #ifdef RTE_LIBRTE_IAVF_DEBUG_DUMP_DESC
608 #define IAVF_DUMP_RX_DESC(rxq, desc, rx_id) \
609 iavf_dump_rx_descriptor(rxq, desc, rx_id)
610 #define IAVF_DUMP_TX_DESC(txq, desc, tx_id) \
611 iavf_dump_tx_descriptor(txq, desc, tx_id)
613 #define IAVF_DUMP_RX_DESC(rxq, desc, rx_id) do { } while (0)
614 #define IAVF_DUMP_TX_DESC(txq, desc, tx_id) do { } while (0)
617 #endif /* _IAVF_RXTX_H_ */