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_NO_VECTOR_FLAGS ( \
27 DEV_TX_OFFLOAD_MULTI_SEGS | \
28 DEV_TX_OFFLOAD_VLAN_INSERT | \
29 DEV_TX_OFFLOAD_SCTP_CKSUM | \
30 DEV_TX_OFFLOAD_UDP_CKSUM | \
31 DEV_TX_OFFLOAD_TCP_TSO | \
32 DEV_TX_OFFLOAD_TCP_CKSUM)
34 #define DEFAULT_TX_RS_THRESH 32
35 #define DEFAULT_TX_FREE_THRESH 32
37 #define IAVF_MIN_TSO_MSS 256
38 #define IAVF_MAX_TSO_MSS 9668
39 #define IAVF_TSO_MAX_SEG UINT8_MAX
40 #define IAVF_TX_MAX_MTU_SEG 8
42 #define IAVF_TX_CKSUM_OFFLOAD_MASK ( \
47 #define IAVF_TX_OFFLOAD_MASK ( \
57 #define IAVF_TX_OFFLOAD_NOTSUP_MASK \
58 (PKT_TX_OFFLOAD_MASK ^ IAVF_TX_OFFLOAD_MASK)
62 * These descriptors are used instead of the legacy version descriptors
64 union iavf_16b_rx_flex_desc {
66 __le64 pkt_addr; /* Packet buffer address */
67 __le64 hdr_addr; /* Header buffer address */
68 /* bit 0 of hdr_addr is DD bit */
72 u8 rxdid; /* descriptor builder profile ID */
73 u8 mir_id_umb_cast; /* mirror=[5:0], umb=[7:6] */
74 __le16 ptype_flex_flags0; /* ptype=[9:0], ff0=[15:10] */
75 __le16 pkt_len; /* [15:14] are reserved */
76 __le16 hdr_len_sph_flex_flags1; /* header=[10:0] */
88 union iavf_32b_rx_flex_desc {
90 __le64 pkt_addr; /* Packet buffer address */
91 __le64 hdr_addr; /* Header buffer address */
92 /* bit 0 of hdr_addr is DD bit */
98 u8 rxdid; /* descriptor builder profile ID */
99 u8 mir_id_umb_cast; /* mirror=[5:0], umb=[7:6] */
100 __le16 ptype_flex_flags0; /* ptype=[9:0], ff0=[15:10] */
101 __le16 pkt_len; /* [15:14] are reserved */
102 __le16 hdr_len_sph_flex_flags1; /* header=[10:0] */
104 /* ff1/ext=[15:12] */
107 __le16 status_error0;
113 __le16 status_error1;
129 } wb; /* writeback */
132 /* HW desc structure, both 16-byte and 32-byte types are supported */
133 #ifdef RTE_LIBRTE_IAVF_16BYTE_RX_DESC
134 #define iavf_rx_desc iavf_16byte_rx_desc
135 #define iavf_rx_flex_desc iavf_16b_rx_flex_desc
137 #define iavf_rx_desc iavf_32byte_rx_desc
138 #define iavf_rx_flex_desc iavf_32b_rx_flex_desc
141 typedef void (*iavf_rxd_to_pkt_fields_t)(struct iavf_rx_queue *rxq,
143 volatile union iavf_rx_flex_desc *rxdp);
145 struct iavf_rxq_ops {
146 void (*release_mbufs)(struct iavf_rx_queue *rxq);
149 struct iavf_txq_ops {
150 void (*release_mbufs)(struct iavf_tx_queue *txq);
153 /* Structure associated with each Rx queue. */
154 struct iavf_rx_queue {
155 struct rte_mempool *mp; /* mbuf pool to populate Rx ring */
156 const struct rte_memzone *mz; /* memzone for Rx ring */
157 volatile union iavf_rx_desc *rx_ring; /* Rx ring virtual address */
158 uint64_t rx_ring_phys_addr; /* Rx ring DMA address */
159 struct rte_mbuf **sw_ring; /* address of SW ring */
160 uint16_t nb_rx_desc; /* ring length */
161 uint16_t rx_tail; /* current value of tail */
162 volatile uint8_t *qrx_tail; /* register address of tail */
163 uint16_t rx_free_thresh; /* max free RX desc to hold */
164 uint16_t nb_rx_hold; /* number of held free RX desc */
165 struct rte_mbuf *pkt_first_seg; /* first segment of current packet */
166 struct rte_mbuf *pkt_last_seg; /* last segment of current packet */
167 struct rte_mbuf fake_mbuf; /* dummy mbuf */
171 uint16_t rxrearm_nb; /* number of remaining to be re-armed */
172 uint16_t rxrearm_start; /* the idx we start the re-arming from */
173 uint64_t mbuf_initializer; /* value to init mbufs */
176 uint16_t rx_nb_avail; /* number of staged packets ready */
177 uint16_t rx_next_avail; /* index of next staged packets */
178 uint16_t rx_free_trigger; /* triggers rx buffer allocation */
179 struct rte_mbuf *rx_stage[IAVF_RX_MAX_BURST * 2]; /* store mbuf */
181 uint16_t port_id; /* device port ID */
182 uint8_t crc_len; /* 0 if CRC stripped, 4 otherwise */
183 uint8_t fdir_enabled; /* 0 if FDIR disabled, 1 when enabled */
184 uint16_t queue_id; /* Rx queue index */
185 uint16_t rx_buf_len; /* The packet buffer size */
186 uint16_t rx_hdr_len; /* The header buffer size */
187 uint16_t max_pkt_len; /* Maximum packet length */
188 struct iavf_vsi *vsi; /**< the VSI this queue belongs to */
190 bool q_set; /* if rx queue has been configured */
191 bool rx_deferred_start; /* don't start this queue in dev start */
192 const struct iavf_rxq_ops *ops;
194 #define IAVF_RX_FLAGS_VLAN_TAG_LOC_L2TAG1 BIT(0)
195 #define IAVF_RX_FLAGS_VLAN_TAG_LOC_L2TAG2_2 BIT(1)
196 uint8_t proto_xtr; /* protocol extraction type */
197 uint64_t xtr_ol_flag;
198 /* flexible descriptor metadata extraction offload flag */
199 iavf_rxd_to_pkt_fields_t rxd_to_pkt_fields;
200 /* handle flexible descriptor by RXDID */
203 struct iavf_tx_entry {
204 struct rte_mbuf *mbuf;
209 struct iavf_tx_vec_entry {
210 struct rte_mbuf *mbuf;
213 /* Structure associated with each TX queue. */
214 struct iavf_tx_queue {
215 const struct rte_memzone *mz; /* memzone for Tx ring */
216 volatile struct iavf_tx_desc *tx_ring; /* Tx ring virtual address */
217 uint64_t tx_ring_phys_addr; /* Tx ring DMA address */
218 struct iavf_tx_entry *sw_ring; /* address array of SW ring */
219 uint16_t nb_tx_desc; /* ring length */
220 uint16_t tx_tail; /* current value of tail */
221 volatile uint8_t *qtx_tail; /* register address of tail */
222 /* number of used desc since RS bit set */
225 uint16_t last_desc_cleaned; /* last desc have been cleaned*/
226 uint16_t free_thresh;
232 uint16_t next_dd; /* next to set RS, for VPMD */
233 uint16_t next_rs; /* next to check DD, for VPMD */
235 bool q_set; /* if rx queue has been configured */
236 bool tx_deferred_start; /* don't start this queue in dev start */
237 const struct iavf_txq_ops *ops;
238 #define IAVF_TX_FLAGS_VLAN_TAG_LOC_L2TAG1 BIT(0)
239 #define IAVF_TX_FLAGS_VLAN_TAG_LOC_L2TAG2 BIT(1)
243 /* Offload features */
244 union iavf_tx_offload {
247 uint64_t l2_len:7; /* L2 (MAC) Header Length. */
248 uint64_t l3_len:9; /* L3 (IP) Header Length. */
249 uint64_t l4_len:8; /* L4 Header Length. */
250 uint64_t tso_segsz:16; /* TCP TSO segment size */
251 /* uint64_t unused : 24; */
255 /* Rx Flex Descriptor
256 * RxDID Profile ID 16-21
257 * Flex-field 0: RSS hash lower 16-bits
258 * Flex-field 1: RSS hash upper 16-bits
259 * Flex-field 2: Flow ID lower 16-bits
260 * Flex-field 3: Flow ID upper 16-bits
264 struct iavf_32b_rx_flex_desc_comms {
268 __le16 ptype_flexi_flags0;
270 __le16 hdr_len_sph_flex_flags1;
273 __le16 status_error0;
278 __le16 status_error1;
295 /* Rx Flex Descriptor
296 * RxDID Profile ID 22-23 (swap Hash and FlowID)
297 * Flex-field 0: Flow ID lower 16-bits
298 * Flex-field 1: Flow ID upper 16-bits
299 * Flex-field 2: RSS hash lower 16-bits
300 * Flex-field 3: RSS hash upper 16-bits
304 struct iavf_32b_rx_flex_desc_comms_ovs {
308 __le16 ptype_flexi_flags0;
310 __le16 hdr_len_sph_flex_flags1;
313 __le16 status_error0;
318 __le16 status_error1;
335 /* Receive Flex Descriptor profile IDs: There are a total
336 * of 64 profiles where profile IDs 0/1 are for legacy; and
337 * profiles 2-63 are flex profiles that can be programmed
338 * with a specific metadata (profile 7 reserved for HW)
341 IAVF_RXDID_LEGACY_0 = 0,
342 IAVF_RXDID_LEGACY_1 = 1,
343 IAVF_RXDID_FLEX_NIC = 2,
344 IAVF_RXDID_FLEX_NIC_2 = 6,
346 IAVF_RXDID_COMMS_GENERIC = 16,
347 IAVF_RXDID_COMMS_AUX_VLAN = 17,
348 IAVF_RXDID_COMMS_AUX_IPV4 = 18,
349 IAVF_RXDID_COMMS_AUX_IPV6 = 19,
350 IAVF_RXDID_COMMS_AUX_IPV6_FLOW = 20,
351 IAVF_RXDID_COMMS_AUX_TCP = 21,
352 IAVF_RXDID_COMMS_OVS_1 = 22,
353 IAVF_RXDID_COMMS_OVS_2 = 23,
354 IAVF_RXDID_COMMS_AUX_IP_OFFSET = 25,
355 IAVF_RXDID_LAST = 63,
358 enum iavf_rx_flex_desc_status_error_0_bits {
359 /* Note: These are predefined bit offsets */
360 IAVF_RX_FLEX_DESC_STATUS0_DD_S = 0,
361 IAVF_RX_FLEX_DESC_STATUS0_EOF_S,
362 IAVF_RX_FLEX_DESC_STATUS0_HBO_S,
363 IAVF_RX_FLEX_DESC_STATUS0_L3L4P_S,
364 IAVF_RX_FLEX_DESC_STATUS0_XSUM_IPE_S,
365 IAVF_RX_FLEX_DESC_STATUS0_XSUM_L4E_S,
366 IAVF_RX_FLEX_DESC_STATUS0_XSUM_EIPE_S,
367 IAVF_RX_FLEX_DESC_STATUS0_XSUM_EUDPE_S,
368 IAVF_RX_FLEX_DESC_STATUS0_LPBK_S,
369 IAVF_RX_FLEX_DESC_STATUS0_IPV6EXADD_S,
370 IAVF_RX_FLEX_DESC_STATUS0_RXE_S,
371 IAVF_RX_FLEX_DESC_STATUS0_CRCP_S,
372 IAVF_RX_FLEX_DESC_STATUS0_RSS_VALID_S,
373 IAVF_RX_FLEX_DESC_STATUS0_L2TAG1P_S,
374 IAVF_RX_FLEX_DESC_STATUS0_XTRMD0_VALID_S,
375 IAVF_RX_FLEX_DESC_STATUS0_XTRMD1_VALID_S,
376 IAVF_RX_FLEX_DESC_STATUS0_LAST /* this entry must be last!!! */
379 enum iavf_rx_flex_desc_status_error_1_bits {
380 /* Note: These are predefined bit offsets */
381 IAVF_RX_FLEX_DESC_STATUS1_CPM_S = 0, /* 4 bits */
382 IAVF_RX_FLEX_DESC_STATUS1_NAT_S = 4,
383 IAVF_RX_FLEX_DESC_STATUS1_CRYPTO_S = 5,
384 /* [10:6] reserved */
385 IAVF_RX_FLEX_DESC_STATUS1_L2TAG2P_S = 11,
386 IAVF_RX_FLEX_DESC_STATUS1_XTRMD2_VALID_S = 12,
387 IAVF_RX_FLEX_DESC_STATUS1_XTRMD3_VALID_S = 13,
388 IAVF_RX_FLEX_DESC_STATUS1_XTRMD4_VALID_S = 14,
389 IAVF_RX_FLEX_DESC_STATUS1_XTRMD5_VALID_S = 15,
390 IAVF_RX_FLEX_DESC_STATUS1_LAST /* this entry must be last!!! */
393 /* for iavf_32b_rx_flex_desc.ptype_flex_flags0 member */
394 #define IAVF_RX_FLEX_DESC_PTYPE_M (0x3FF) /* 10-bits */
396 /* for iavf_32b_rx_flex_desc.pkt_len member */
397 #define IAVF_RX_FLX_DESC_PKT_LEN_M (0x3FFF) /* 14-bits */
399 int iavf_dev_rx_queue_setup(struct rte_eth_dev *dev,
402 unsigned int socket_id,
403 const struct rte_eth_rxconf *rx_conf,
404 struct rte_mempool *mp);
406 int iavf_dev_rx_queue_start(struct rte_eth_dev *dev, uint16_t rx_queue_id);
407 int iavf_dev_rx_queue_stop(struct rte_eth_dev *dev, uint16_t rx_queue_id);
408 void iavf_dev_rx_queue_release(void *rxq);
410 int iavf_dev_tx_queue_setup(struct rte_eth_dev *dev,
413 unsigned int socket_id,
414 const struct rte_eth_txconf *tx_conf);
415 int iavf_dev_tx_queue_start(struct rte_eth_dev *dev, uint16_t tx_queue_id);
416 int iavf_dev_tx_queue_stop(struct rte_eth_dev *dev, uint16_t tx_queue_id);
417 int iavf_dev_tx_done_cleanup(void *txq, uint32_t free_cnt);
418 void iavf_dev_tx_queue_release(void *txq);
419 void iavf_stop_queues(struct rte_eth_dev *dev);
420 uint16_t iavf_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
422 uint16_t iavf_recv_pkts_flex_rxd(void *rx_queue,
423 struct rte_mbuf **rx_pkts,
425 uint16_t iavf_recv_scattered_pkts(void *rx_queue,
426 struct rte_mbuf **rx_pkts,
428 uint16_t iavf_recv_scattered_pkts_flex_rxd(void *rx_queue,
429 struct rte_mbuf **rx_pkts,
431 uint16_t iavf_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
433 uint16_t iavf_prep_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
435 void iavf_set_rx_function(struct rte_eth_dev *dev);
436 void iavf_set_tx_function(struct rte_eth_dev *dev);
437 void iavf_dev_rxq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
438 struct rte_eth_rxq_info *qinfo);
439 void iavf_dev_txq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
440 struct rte_eth_txq_info *qinfo);
441 uint32_t iavf_dev_rxq_count(struct rte_eth_dev *dev, uint16_t queue_id);
442 int iavf_dev_rx_desc_status(void *rx_queue, uint16_t offset);
443 int iavf_dev_tx_desc_status(void *tx_queue, uint16_t offset);
445 uint16_t iavf_recv_pkts_vec(void *rx_queue, struct rte_mbuf **rx_pkts,
447 uint16_t iavf_recv_pkts_vec_flex_rxd(void *rx_queue, struct rte_mbuf **rx_pkts,
449 uint16_t iavf_recv_scattered_pkts_vec(void *rx_queue,
450 struct rte_mbuf **rx_pkts,
452 uint16_t iavf_recv_scattered_pkts_vec_flex_rxd(void *rx_queue,
453 struct rte_mbuf **rx_pkts,
455 uint16_t iavf_xmit_fixed_burst_vec(void *tx_queue, struct rte_mbuf **tx_pkts,
457 uint16_t iavf_recv_pkts_vec_avx2(void *rx_queue, struct rte_mbuf **rx_pkts,
459 uint16_t iavf_recv_pkts_vec_avx2_flex_rxd(void *rx_queue,
460 struct rte_mbuf **rx_pkts,
462 uint16_t iavf_recv_scattered_pkts_vec_avx2(void *rx_queue,
463 struct rte_mbuf **rx_pkts,
465 uint16_t iavf_recv_scattered_pkts_vec_avx2_flex_rxd(void *rx_queue,
466 struct rte_mbuf **rx_pkts,
468 uint16_t iavf_xmit_pkts_vec(void *tx_queue, struct rte_mbuf **tx_pkts,
470 uint16_t iavf_xmit_pkts_vec_avx2(void *tx_queue, struct rte_mbuf **tx_pkts,
472 int iavf_rx_vec_dev_check(struct rte_eth_dev *dev);
473 int iavf_tx_vec_dev_check(struct rte_eth_dev *dev);
474 int iavf_rxq_vec_setup(struct iavf_rx_queue *rxq);
475 int iavf_txq_vec_setup(struct iavf_tx_queue *txq);
476 uint16_t iavf_recv_pkts_vec_avx512(void *rx_queue, struct rte_mbuf **rx_pkts,
478 uint16_t iavf_recv_pkts_vec_avx512_flex_rxd(void *rx_queue,
479 struct rte_mbuf **rx_pkts,
481 uint16_t iavf_recv_scattered_pkts_vec_avx512(void *rx_queue,
482 struct rte_mbuf **rx_pkts,
484 uint16_t iavf_recv_scattered_pkts_vec_avx512_flex_rxd(void *rx_queue,
485 struct rte_mbuf **rx_pkts,
487 uint16_t iavf_xmit_pkts_vec_avx512(void *tx_queue, struct rte_mbuf **tx_pkts,
489 int iavf_txq_vec_setup_avx512(struct iavf_tx_queue *txq);
491 uint8_t iavf_proto_xtr_type_to_rxdid(uint8_t xtr_type);
493 const uint32_t *iavf_get_default_ptype_table(void);
496 void iavf_dump_rx_descriptor(struct iavf_rx_queue *rxq,
497 const volatile void *desc,
500 #ifdef RTE_LIBRTE_IAVF_16BYTE_RX_DESC
501 const volatile union iavf_16byte_rx_desc *rx_desc = desc;
503 printf("Queue %d Rx_desc %d: QW0: 0x%016"PRIx64" QW1: 0x%016"PRIx64"\n",
504 rxq->queue_id, rx_id, rx_desc->read.pkt_addr,
505 rx_desc->read.hdr_addr);
507 const volatile union iavf_32byte_rx_desc *rx_desc = desc;
509 printf("Queue %d Rx_desc %d: QW0: 0x%016"PRIx64" QW1: 0x%016"PRIx64
510 " QW2: 0x%016"PRIx64" QW3: 0x%016"PRIx64"\n", rxq->queue_id,
511 rx_id, rx_desc->read.pkt_addr, rx_desc->read.hdr_addr,
512 rx_desc->read.rsvd1, rx_desc->read.rsvd2);
516 /* All the descriptors are 16 bytes, so just use one of them
517 * to print the qwords
520 void iavf_dump_tx_descriptor(const struct iavf_tx_queue *txq,
521 const volatile void *desc, uint16_t tx_id)
524 const volatile struct iavf_tx_desc *tx_desc = desc;
525 enum iavf_tx_desc_dtype_value type;
527 type = (enum iavf_tx_desc_dtype_value)rte_le_to_cpu_64(
528 tx_desc->cmd_type_offset_bsz &
529 rte_cpu_to_le_64(IAVF_TXD_QW1_DTYPE_MASK));
531 case IAVF_TX_DESC_DTYPE_DATA:
532 name = "Tx_data_desc";
534 case IAVF_TX_DESC_DTYPE_CONTEXT:
535 name = "Tx_context_desc";
538 name = "unknown_desc";
542 printf("Queue %d %s %d: QW0: 0x%016"PRIx64" QW1: 0x%016"PRIx64"\n",
543 txq->queue_id, name, tx_id, tx_desc->buffer_addr,
544 tx_desc->cmd_type_offset_bsz);
547 #define FDIR_PROC_ENABLE_PER_QUEUE(ad, on) do { \
549 for (i = 0; i < (ad)->eth_dev->data->nb_rx_queues; i++) { \
550 struct iavf_rx_queue *rxq = (ad)->eth_dev->data->rx_queues[i]; \
553 rxq->fdir_enabled = on; \
555 PMD_DRV_LOG(DEBUG, "FDIR processing on RX set to %d", on); \
558 /* Enable/disable flow director Rx processing in data path. */
560 void iavf_fdir_rx_proc_enable(struct iavf_adapter *ad, bool on)
563 /* enable flow director processing */
564 FDIR_PROC_ENABLE_PER_QUEUE(ad, on);
567 if (ad->fdir_ref_cnt >= 1) {
570 if (ad->fdir_ref_cnt == 0)
571 FDIR_PROC_ENABLE_PER_QUEUE(ad, on);
576 #ifdef RTE_LIBRTE_IAVF_DEBUG_DUMP_DESC
577 #define IAVF_DUMP_RX_DESC(rxq, desc, rx_id) \
578 iavf_dump_rx_descriptor(rxq, desc, rx_id)
579 #define IAVF_DUMP_TX_DESC(txq, desc, tx_id) \
580 iavf_dump_tx_descriptor(txq, desc, tx_id)
582 #define IAVF_DUMP_RX_DESC(rxq, desc, rx_id) do { } while (0)
583 #define IAVF_DUMP_TX_DESC(txq, desc, tx_id) do { } while (0)
586 #endif /* _IAVF_RXTX_H_ */