New upstream version 18.02
[deb_dpdk.git] / drivers / net / avf / avf_rxtx.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2017 Intel Corporation
3  */
4
5 #ifndef _AVF_RXTX_H_
6 #define _AVF_RXTX_H_
7
8 /* In QLEN must be whole number of 32 descriptors. */
9 #define AVF_ALIGN_RING_DESC      32
10 #define AVF_MIN_RING_DESC        64
11 #define AVF_MAX_RING_DESC        4096
12 #define AVF_DMA_MEM_ALIGN        4096
13 /* Base address of the HW descriptor ring should be 128B aligned. */
14 #define AVF_RING_BASE_ALIGN      128
15
16 /* used for Rx Bulk Allocate */
17 #define AVF_RX_MAX_BURST         32
18
19 /* used for Vector PMD */
20 #define AVF_VPMD_RX_MAX_BURST    32
21 #define AVF_VPMD_TX_MAX_BURST    32
22 #define AVF_VPMD_DESCS_PER_LOOP  4
23 #define AVF_VPMD_TX_MAX_FREE_BUF 64
24
25 #define AVF_SIMPLE_FLAGS ((uint32_t)ETH_TXQ_FLAGS_NOMULTSEGS | \
26                           ETH_TXQ_FLAGS_NOOFFLOADS)
27
28 #define DEFAULT_TX_RS_THRESH     32
29 #define DEFAULT_TX_FREE_THRESH   32
30
31 #define AVF_MIN_TSO_MSS          256
32 #define AVF_MAX_TSO_MSS          9668
33 #define AVF_TSO_MAX_SEG          UINT8_MAX
34 #define AVF_TX_MAX_MTU_SEG       8
35
36 #define AVF_TX_CKSUM_OFFLOAD_MASK (              \
37                 PKT_TX_IP_CKSUM |                \
38                 PKT_TX_L4_MASK |                 \
39                 PKT_TX_TCP_SEG)
40
41 #define AVF_TX_OFFLOAD_MASK (  \
42                 PKT_TX_VLAN_PKT |                \
43                 PKT_TX_IP_CKSUM |                \
44                 PKT_TX_L4_MASK |                 \
45                 PKT_TX_TCP_SEG)
46
47 #define AVF_TX_OFFLOAD_NOTSUP_MASK \
48                 (PKT_TX_OFFLOAD_MASK ^ AVF_TX_OFFLOAD_MASK)
49
50 /* HW desc structure, both 16-byte and 32-byte types are supported */
51 #ifdef RTE_LIBRTE_AVF_16BYTE_RX_DESC
52 #define avf_rx_desc avf_16byte_rx_desc
53 #else
54 #define avf_rx_desc avf_32byte_rx_desc
55 #endif
56
57 struct avf_rxq_ops {
58         void (*release_mbufs)(struct avf_rx_queue *rxq);
59 };
60
61 struct avf_txq_ops {
62         void (*release_mbufs)(struct avf_tx_queue *txq);
63 };
64
65 /* Structure associated with each Rx queue. */
66 struct avf_rx_queue {
67         struct rte_mempool *mp;       /* mbuf pool to populate Rx ring */
68         const struct rte_memzone *mz; /* memzone for Rx ring */
69         volatile union avf_rx_desc *rx_ring; /* Rx ring virtual address */
70         uint64_t rx_ring_phys_addr;   /* Rx ring DMA address */
71         struct rte_mbuf **sw_ring;     /* address of SW ring */
72         uint16_t nb_rx_desc;          /* ring length */
73         uint16_t rx_tail;             /* current value of tail */
74         volatile uint8_t *qrx_tail;   /* register address of tail */
75         uint16_t rx_free_thresh;      /* max free RX desc to hold */
76         uint16_t nb_rx_hold;          /* number of held free RX desc */
77         struct rte_mbuf *pkt_first_seg; /* first segment of current packet */
78         struct rte_mbuf *pkt_last_seg;  /* last segment of current packet */
79         struct rte_mbuf fake_mbuf;      /* dummy mbuf */
80
81         /* used for VPMD */
82         uint16_t rxrearm_nb;       /* number of remaining to be re-armed */
83         uint16_t rxrearm_start;    /* the idx we start the re-arming from */
84         uint64_t mbuf_initializer; /* value to init mbufs */
85
86         /* for rx bulk */
87         uint16_t rx_nb_avail;      /* number of staged packets ready */
88         uint16_t rx_next_avail;    /* index of next staged packets */
89         uint16_t rx_free_trigger;  /* triggers rx buffer allocation */
90         struct rte_mbuf *rx_stage[AVF_RX_MAX_BURST * 2]; /* store mbuf */
91
92         uint16_t port_id;        /* device port ID */
93         uint8_t crc_len;        /* 0 if CRC stripped, 4 otherwise */
94         uint16_t queue_id;      /* Rx queue index */
95         uint16_t rx_buf_len;    /* The packet buffer size */
96         uint16_t rx_hdr_len;    /* The header buffer size */
97         uint16_t max_pkt_len;   /* Maximum packet length */
98
99         bool q_set;             /* if rx queue has been configured */
100         bool rx_deferred_start; /* don't start this queue in dev start */
101         const struct avf_rxq_ops *ops;
102 };
103
104 struct avf_tx_entry {
105         struct rte_mbuf *mbuf;
106         uint16_t next_id;
107         uint16_t last_id;
108 };
109
110 /* Structure associated with each TX queue. */
111 struct avf_tx_queue {
112         const struct rte_memzone *mz;  /* memzone for Tx ring */
113         volatile struct avf_tx_desc *tx_ring; /* Tx ring virtual address */
114         uint64_t tx_ring_phys_addr;    /* Tx ring DMA address */
115         struct avf_tx_entry *sw_ring;  /* address array of SW ring */
116         uint16_t nb_tx_desc;           /* ring length */
117         uint16_t tx_tail;              /* current value of tail */
118         volatile uint8_t *qtx_tail;    /* register address of tail */
119         /* number of used desc since RS bit set */
120         uint16_t nb_used;
121         uint16_t nb_free;
122         uint16_t last_desc_cleaned;    /* last desc have been cleaned*/
123         uint16_t free_thresh;
124         uint16_t rs_thresh;
125
126         uint16_t port_id;
127         uint16_t queue_id;
128         uint32_t txq_flags;
129         uint16_t next_dd;              /* next to set RS, for VPMD */
130         uint16_t next_rs;              /* next to check DD,  for VPMD */
131
132         bool q_set;                    /* if rx queue has been configured */
133         bool tx_deferred_start;        /* don't start this queue in dev start */
134         const struct avf_txq_ops *ops;
135 };
136
137 /* Offload features */
138 union avf_tx_offload {
139         uint64_t data;
140         struct {
141                 uint64_t l2_len:7; /* L2 (MAC) Header Length. */
142                 uint64_t l3_len:9; /* L3 (IP) Header Length. */
143                 uint64_t l4_len:8; /* L4 Header Length. */
144                 uint64_t tso_segsz:16; /* TCP TSO segment size */
145                 /* uint64_t unused : 24; */
146         };
147 };
148
149 int avf_dev_rx_queue_setup(struct rte_eth_dev *dev,
150                            uint16_t queue_idx,
151                            uint16_t nb_desc,
152                            unsigned int socket_id,
153                            const struct rte_eth_rxconf *rx_conf,
154                            struct rte_mempool *mp);
155
156 int avf_dev_rx_queue_start(struct rte_eth_dev *dev, uint16_t rx_queue_id);
157 int avf_dev_rx_queue_stop(struct rte_eth_dev *dev, uint16_t rx_queue_id);
158 void avf_dev_rx_queue_release(void *rxq);
159
160 int avf_dev_tx_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_txconf *tx_conf);
165 int avf_dev_tx_queue_start(struct rte_eth_dev *dev, uint16_t tx_queue_id);
166 int avf_dev_tx_queue_stop(struct rte_eth_dev *dev, uint16_t tx_queue_id);
167 void avf_dev_tx_queue_release(void *txq);
168 void avf_stop_queues(struct rte_eth_dev *dev);
169 uint16_t avf_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
170                        uint16_t nb_pkts);
171 uint16_t avf_recv_scattered_pkts(void *rx_queue,
172                                  struct rte_mbuf **rx_pkts,
173                                  uint16_t nb_pkts);
174 uint16_t avf_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
175                        uint16_t nb_pkts);
176 uint16_t avf_prep_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
177                        uint16_t nb_pkts);
178 void avf_set_rx_function(struct rte_eth_dev *dev);
179 void avf_set_tx_function(struct rte_eth_dev *dev);
180 void avf_dev_rxq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
181                           struct rte_eth_rxq_info *qinfo);
182 void avf_dev_txq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
183                           struct rte_eth_txq_info *qinfo);
184 uint32_t avf_dev_rxq_count(struct rte_eth_dev *dev, uint16_t queue_id);
185 int avf_dev_rx_desc_status(void *rx_queue, uint16_t offset);
186 int avf_dev_tx_desc_status(void *tx_queue, uint16_t offset);
187
188 uint16_t avf_recv_pkts_vec(void *rx_queue, struct rte_mbuf **rx_pkts,
189                            uint16_t nb_pkts);
190 uint16_t avf_recv_scattered_pkts_vec(void *rx_queue,
191                                      struct rte_mbuf **rx_pkts,
192                                      uint16_t nb_pkts);
193 uint16_t avf_xmit_fixed_burst_vec(void *tx_queue, struct rte_mbuf **tx_pkts,
194                                   uint16_t nb_pkts);
195 int avf_rxq_vec_setup(struct avf_rx_queue *rxq);
196 int avf_txq_vec_setup(struct avf_tx_queue *txq);
197
198 static inline
199 void avf_dump_rx_descriptor(struct avf_rx_queue *rxq,
200                             const void *desc,
201                             uint16_t rx_id)
202 {
203 #ifdef RTE_LIBRTE_AVF_16BYTE_RX_DESC
204         const union avf_16byte_rx_desc *rx_desc = desc;
205
206         printf("Queue %d Rx_desc %d: QW0: 0x%016"PRIx64" QW1: 0x%016"PRIx64"\n",
207                rxq->queue_id, rx_id, rx_desc->read.pkt_addr,
208                rx_desc->read.hdr_addr);
209 #else
210         const union avf_32byte_rx_desc *rx_desc = desc;
211
212         printf("Queue %d Rx_desc %d: QW0: 0x%016"PRIx64" QW1: 0x%016"PRIx64
213                " QW2: 0x%016"PRIx64" QW3: 0x%016"PRIx64"\n", rxq->queue_id,
214                rx_id, rx_desc->read.pkt_addr, rx_desc->read.hdr_addr,
215                rx_desc->read.rsvd1, rx_desc->read.rsvd2);
216 #endif
217 }
218
219 /* All the descriptors are 16 bytes, so just use one of them
220  * to print the qwords
221  */
222 static inline
223 void avf_dump_tx_descriptor(const struct avf_tx_queue *txq,
224                             const void *desc, uint16_t tx_id)
225 {
226         char *name;
227         const struct avf_tx_desc *tx_desc = desc;
228         enum avf_tx_desc_dtype_value type;
229
230         type = (enum avf_tx_desc_dtype_value)rte_le_to_cpu_64(
231                 tx_desc->cmd_type_offset_bsz &
232                 rte_cpu_to_le_64(AVF_TXD_QW1_DTYPE_MASK));
233         switch (type) {
234         case AVF_TX_DESC_DTYPE_DATA:
235                 name = "Tx_data_desc";
236                 break;
237         case AVF_TX_DESC_DTYPE_CONTEXT:
238                 name = "Tx_context_desc";
239                 break;
240         default:
241                 name = "unknown_desc";
242                 break;
243         }
244
245         printf("Queue %d %s %d: QW0: 0x%016"PRIx64" QW1: 0x%016"PRIx64"\n",
246                txq->queue_id, name, tx_id, tx_desc->buffer_addr,
247                tx_desc->cmd_type_offset_bsz);
248 }
249
250 #ifdef DEBUG_DUMP_DESC
251 #define AVF_DUMP_RX_DESC(rxq, desc, rx_id) \
252         avf_dump_rx_descriptor(rxq, desc, rx_id)
253 #define AVF_DUMP_TX_DESC(txq, desc, tx_id) \
254         avf_dump_tx_descriptor(txq, desc, tx_id)
255 #else
256 #define AVF_DUMP_RX_DESC(rxq, desc, rx_id) do { } while (0)
257 #define AVF_DUMP_TX_DESC(txq, desc, tx_id) do { } while (0)
258 #endif
259
260 #endif /* _AVF_RXTX_H_ */