09b5bd99e87f9dbb103ed2c5466bbaaeec2518e8
[dpdk.git] / drivers / net / iavf / iavf_rxtx.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2017 Intel Corporation
3  */
4
5 #ifndef _IAVF_RXTX_H_
6 #define _IAVF_RXTX_H_
7
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
15
16 /* used for Rx Bulk Allocate */
17 #define IAVF_RX_MAX_BURST         32
18
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
25
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)
33
34 #define DEFAULT_TX_RS_THRESH     32
35 #define DEFAULT_TX_FREE_THRESH   32
36
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
41
42 #define IAVF_TX_CKSUM_OFFLOAD_MASK (             \
43                 PKT_TX_IP_CKSUM |                \
44                 PKT_TX_L4_MASK |                 \
45                 PKT_TX_TCP_SEG)
46
47 #define IAVF_TX_OFFLOAD_MASK (  \
48                 PKT_TX_OUTER_IPV6 |              \
49                 PKT_TX_OUTER_IPV4 |              \
50                 PKT_TX_IPV6 |                    \
51                 PKT_TX_IPV4 |                    \
52                 PKT_TX_VLAN_PKT |                \
53                 PKT_TX_IP_CKSUM |                \
54                 PKT_TX_L4_MASK |                 \
55                 PKT_TX_TCP_SEG)
56
57 #define IAVF_TX_OFFLOAD_NOTSUP_MASK \
58                 (PKT_TX_OFFLOAD_MASK ^ IAVF_TX_OFFLOAD_MASK)
59
60 /* HW desc structure, both 16-byte and 32-byte types are supported */
61 #ifdef RTE_LIBRTE_IAVF_16BYTE_RX_DESC
62 #define iavf_rx_desc iavf_16byte_rx_desc
63 #else
64 #define iavf_rx_desc iavf_32byte_rx_desc
65 #endif
66
67 struct iavf_rxq_ops {
68         void (*release_mbufs)(struct iavf_rx_queue *rxq);
69 };
70
71 struct iavf_txq_ops {
72         void (*release_mbufs)(struct iavf_tx_queue *txq);
73 };
74
75 /* Structure associated with each Rx queue. */
76 struct iavf_rx_queue {
77         struct rte_mempool *mp;       /* mbuf pool to populate Rx ring */
78         const struct rte_memzone *mz; /* memzone for Rx ring */
79         volatile union iavf_rx_desc *rx_ring; /* Rx ring virtual address */
80         uint64_t rx_ring_phys_addr;   /* Rx ring DMA address */
81         struct rte_mbuf **sw_ring;     /* address of SW ring */
82         uint16_t nb_rx_desc;          /* ring length */
83         uint16_t rx_tail;             /* current value of tail */
84         volatile uint8_t *qrx_tail;   /* register address of tail */
85         uint16_t rx_free_thresh;      /* max free RX desc to hold */
86         uint16_t nb_rx_hold;          /* number of held free RX desc */
87         struct rte_mbuf *pkt_first_seg; /* first segment of current packet */
88         struct rte_mbuf *pkt_last_seg;  /* last segment of current packet */
89         struct rte_mbuf fake_mbuf;      /* dummy mbuf */
90
91         /* used for VPMD */
92         uint16_t rxrearm_nb;       /* number of remaining to be re-armed */
93         uint16_t rxrearm_start;    /* the idx we start the re-arming from */
94         uint64_t mbuf_initializer; /* value to init mbufs */
95
96         /* for rx bulk */
97         uint16_t rx_nb_avail;      /* number of staged packets ready */
98         uint16_t rx_next_avail;    /* index of next staged packets */
99         uint16_t rx_free_trigger;  /* triggers rx buffer allocation */
100         struct rte_mbuf *rx_stage[IAVF_RX_MAX_BURST * 2]; /* store mbuf */
101
102         uint16_t port_id;        /* device port ID */
103         uint8_t crc_len;        /* 0 if CRC stripped, 4 otherwise */
104         uint16_t queue_id;      /* Rx queue index */
105         uint16_t rx_buf_len;    /* The packet buffer size */
106         uint16_t rx_hdr_len;    /* The header buffer size */
107         uint16_t max_pkt_len;   /* Maximum packet length */
108         struct iavf_vsi *vsi; /**< the VSI this queue belongs to */
109
110         bool q_set;             /* if rx queue has been configured */
111         bool rx_deferred_start; /* don't start this queue in dev start */
112         const struct iavf_rxq_ops *ops;
113 };
114
115 struct iavf_tx_entry {
116         struct rte_mbuf *mbuf;
117         uint16_t next_id;
118         uint16_t last_id;
119 };
120
121 /* Structure associated with each TX queue. */
122 struct iavf_tx_queue {
123         const struct rte_memzone *mz;  /* memzone for Tx ring */
124         volatile struct iavf_tx_desc *tx_ring; /* Tx ring virtual address */
125         uint64_t tx_ring_phys_addr;    /* Tx ring DMA address */
126         struct iavf_tx_entry *sw_ring;  /* address array of SW ring */
127         uint16_t nb_tx_desc;           /* ring length */
128         uint16_t tx_tail;              /* current value of tail */
129         volatile uint8_t *qtx_tail;    /* register address of tail */
130         /* number of used desc since RS bit set */
131         uint16_t nb_used;
132         uint16_t nb_free;
133         uint16_t last_desc_cleaned;    /* last desc have been cleaned*/
134         uint16_t free_thresh;
135         uint16_t rs_thresh;
136
137         uint16_t port_id;
138         uint16_t queue_id;
139         uint64_t offloads;
140         uint16_t next_dd;              /* next to set RS, for VPMD */
141         uint16_t next_rs;              /* next to check DD,  for VPMD */
142
143         bool q_set;                    /* if rx queue has been configured */
144         bool tx_deferred_start;        /* don't start this queue in dev start */
145         const struct iavf_txq_ops *ops;
146 };
147
148 /* Offload features */
149 union iavf_tx_offload {
150         uint64_t data;
151         struct {
152                 uint64_t l2_len:7; /* L2 (MAC) Header Length. */
153                 uint64_t l3_len:9; /* L3 (IP) Header Length. */
154                 uint64_t l4_len:8; /* L4 Header Length. */
155                 uint64_t tso_segsz:16; /* TCP TSO segment size */
156                 /* uint64_t unused : 24; */
157         };
158 };
159
160 int iavf_dev_rx_queue_setup(struct rte_eth_dev *dev,
161                            uint16_t queue_idx,
162                            uint16_t nb_desc,
163                            unsigned int socket_id,
164                            const struct rte_eth_rxconf *rx_conf,
165                            struct rte_mempool *mp);
166
167 int iavf_dev_rx_queue_start(struct rte_eth_dev *dev, uint16_t rx_queue_id);
168 int iavf_dev_rx_queue_stop(struct rte_eth_dev *dev, uint16_t rx_queue_id);
169 void iavf_dev_rx_queue_release(void *rxq);
170
171 int iavf_dev_tx_queue_setup(struct rte_eth_dev *dev,
172                            uint16_t queue_idx,
173                            uint16_t nb_desc,
174                            unsigned int socket_id,
175                            const struct rte_eth_txconf *tx_conf);
176 int iavf_dev_tx_queue_start(struct rte_eth_dev *dev, uint16_t tx_queue_id);
177 int iavf_dev_tx_queue_stop(struct rte_eth_dev *dev, uint16_t tx_queue_id);
178 void iavf_dev_tx_queue_release(void *txq);
179 void iavf_stop_queues(struct rte_eth_dev *dev);
180 uint16_t iavf_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
181                        uint16_t nb_pkts);
182 uint16_t iavf_recv_scattered_pkts(void *rx_queue,
183                                  struct rte_mbuf **rx_pkts,
184                                  uint16_t nb_pkts);
185 uint16_t iavf_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
186                        uint16_t nb_pkts);
187 uint16_t iavf_prep_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
188                        uint16_t nb_pkts);
189 void iavf_set_rx_function(struct rte_eth_dev *dev);
190 void iavf_set_tx_function(struct rte_eth_dev *dev);
191 void iavf_dev_rxq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
192                           struct rte_eth_rxq_info *qinfo);
193 void iavf_dev_txq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
194                           struct rte_eth_txq_info *qinfo);
195 uint32_t iavf_dev_rxq_count(struct rte_eth_dev *dev, uint16_t queue_id);
196 int iavf_dev_rx_desc_status(void *rx_queue, uint16_t offset);
197 int iavf_dev_tx_desc_status(void *tx_queue, uint16_t offset);
198
199 uint16_t iavf_recv_pkts_vec(void *rx_queue, struct rte_mbuf **rx_pkts,
200                            uint16_t nb_pkts);
201 uint16_t iavf_recv_scattered_pkts_vec(void *rx_queue,
202                                      struct rte_mbuf **rx_pkts,
203                                      uint16_t nb_pkts);
204 uint16_t iavf_xmit_fixed_burst_vec(void *tx_queue, struct rte_mbuf **tx_pkts,
205                                   uint16_t nb_pkts);
206 uint16_t iavf_recv_pkts_vec_avx2(void *rx_queue, struct rte_mbuf **rx_pkts,
207                                  uint16_t nb_pkts);
208 uint16_t iavf_recv_scattered_pkts_vec_avx2(void *rx_queue,
209                                            struct rte_mbuf **rx_pkts,
210                                            uint16_t nb_pkts);
211 uint16_t iavf_xmit_pkts_vec(void *tx_queue, struct rte_mbuf **tx_pkts,
212                             uint16_t nb_pkts);
213 uint16_t iavf_xmit_pkts_vec_avx2(void *tx_queue, struct rte_mbuf **tx_pkts,
214                                  uint16_t nb_pkts);
215 int iavf_rx_vec_dev_check(struct rte_eth_dev *dev);
216 int iavf_tx_vec_dev_check(struct rte_eth_dev *dev);
217 int iavf_rxq_vec_setup(struct iavf_rx_queue *rxq);
218 int iavf_txq_vec_setup(struct iavf_tx_queue *txq);
219
220 const uint32_t *iavf_get_default_ptype_table(void);
221
222 static inline
223 void iavf_dump_rx_descriptor(struct iavf_rx_queue *rxq,
224                             const volatile void *desc,
225                             uint16_t rx_id)
226 {
227 #ifdef RTE_LIBRTE_IAVF_16BYTE_RX_DESC
228         const volatile union iavf_16byte_rx_desc *rx_desc = desc;
229
230         printf("Queue %d Rx_desc %d: QW0: 0x%016"PRIx64" QW1: 0x%016"PRIx64"\n",
231                rxq->queue_id, rx_id, rx_desc->read.pkt_addr,
232                rx_desc->read.hdr_addr);
233 #else
234         const volatile union iavf_32byte_rx_desc *rx_desc = desc;
235
236         printf("Queue %d Rx_desc %d: QW0: 0x%016"PRIx64" QW1: 0x%016"PRIx64
237                " QW2: 0x%016"PRIx64" QW3: 0x%016"PRIx64"\n", rxq->queue_id,
238                rx_id, rx_desc->read.pkt_addr, rx_desc->read.hdr_addr,
239                rx_desc->read.rsvd1, rx_desc->read.rsvd2);
240 #endif
241 }
242
243 /* All the descriptors are 16 bytes, so just use one of them
244  * to print the qwords
245  */
246 static inline
247 void iavf_dump_tx_descriptor(const struct iavf_tx_queue *txq,
248                             const volatile void *desc, uint16_t tx_id)
249 {
250         const char *name;
251         const volatile struct iavf_tx_desc *tx_desc = desc;
252         enum iavf_tx_desc_dtype_value type;
253
254         type = (enum iavf_tx_desc_dtype_value)rte_le_to_cpu_64(
255                 tx_desc->cmd_type_offset_bsz &
256                 rte_cpu_to_le_64(IAVF_TXD_QW1_DTYPE_MASK));
257         switch (type) {
258         case IAVF_TX_DESC_DTYPE_DATA:
259                 name = "Tx_data_desc";
260                 break;
261         case IAVF_TX_DESC_DTYPE_CONTEXT:
262                 name = "Tx_context_desc";
263                 break;
264         default:
265                 name = "unknown_desc";
266                 break;
267         }
268
269         printf("Queue %d %s %d: QW0: 0x%016"PRIx64" QW1: 0x%016"PRIx64"\n",
270                txq->queue_id, name, tx_id, tx_desc->buffer_addr,
271                tx_desc->cmd_type_offset_bsz);
272 }
273
274 #ifdef RTE_LIBRTE_IAVF_DEBUG_DUMP_DESC
275 #define IAVF_DUMP_RX_DESC(rxq, desc, rx_id) \
276         iavf_dump_rx_descriptor(rxq, desc, rx_id)
277 #define IAVF_DUMP_TX_DESC(txq, desc, tx_id) \
278         iavf_dump_tx_descriptor(txq, desc, tx_id)
279 #else
280 #define IAVF_DUMP_RX_DESC(rxq, desc, rx_id) do { } while (0)
281 #define IAVF_DUMP_TX_DESC(txq, desc, tx_id) do { } while (0)
282 #endif
283
284 #endif /* _IAVF_RXTX_H_ */