0946ee69e3f53903f3917c8fe905b46242465282
[dpdk.git] / drivers / net / ice / ice_rxtx.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2018 Intel Corporation
3  */
4
5 #ifndef _ICE_RXTX_H_
6 #define _ICE_RXTX_H_
7
8 #include "ice_ethdev.h"
9
10 #define ICE_ALIGN_RING_DESC  32
11 #define ICE_MIN_RING_DESC    64
12 #define ICE_MAX_RING_DESC    4096
13 #define ICE_DMA_MEM_ALIGN    4096
14 #define ICE_RING_BASE_ALIGN  128
15
16 #define ICE_RX_MAX_BURST 32
17 #define ICE_TX_MAX_BURST 32
18
19 #define ICE_CHK_Q_ENA_COUNT        100
20 #define ICE_CHK_Q_ENA_INTERVAL_US  100
21
22 #ifdef RTE_LIBRTE_ICE_16BYTE_RX_DESC
23 #define ice_rx_flex_desc ice_16b_rx_flex_desc
24 #else
25 #define ice_rx_flex_desc ice_32b_rx_flex_desc
26 #endif
27
28 #define ICE_SUPPORT_CHAIN_NUM 5
29
30 #define ICE_TD_CMD                      ICE_TX_DESC_CMD_EOP
31
32 #define ICE_VPMD_RX_BURST           32
33 #define ICE_VPMD_TX_BURST           32
34 #define ICE_RXQ_REARM_THRESH        32
35 #define ICE_MAX_RX_BURST            ICE_RXQ_REARM_THRESH
36 #define ICE_TX_MAX_FREE_BUF_SZ      64
37 #define ICE_DESCS_PER_LOOP          4
38
39 #define ICE_FDIR_PKT_LEN        512
40
41 typedef void (*ice_rx_release_mbufs_t)(struct ice_rx_queue *rxq);
42 typedef void (*ice_tx_release_mbufs_t)(struct ice_tx_queue *txq);
43
44 struct ice_rx_entry {
45         struct rte_mbuf *mbuf;
46 };
47
48 struct ice_rx_queue {
49         struct rte_mempool *mp; /* mbuf pool to populate RX ring */
50         volatile union ice_rx_flex_desc *rx_ring;/* RX ring virtual address */
51         rte_iova_t rx_ring_dma; /* RX ring DMA address */
52         struct ice_rx_entry *sw_ring; /* address of RX soft ring */
53         uint16_t nb_rx_desc; /* number of RX descriptors */
54         uint16_t rx_free_thresh; /* max free RX desc to hold */
55         uint16_t rx_tail; /* current value of tail */
56         uint16_t nb_rx_hold; /* number of held free RX desc */
57         struct rte_mbuf *pkt_first_seg; /**< first segment of current packet */
58         struct rte_mbuf *pkt_last_seg; /**< last segment of current packet */
59         uint16_t rx_nb_avail; /**< number of staged packets ready */
60         uint16_t rx_next_avail; /**< index of next staged packets */
61         uint16_t rx_free_trigger; /**< triggers rx buffer allocation */
62         struct rte_mbuf fake_mbuf; /**< dummy mbuf */
63         struct rte_mbuf *rx_stage[ICE_RX_MAX_BURST * 2];
64
65         uint16_t rxrearm_nb;    /**< number of remaining to be re-armed */
66         uint16_t rxrearm_start; /**< the idx we start the re-arming from */
67         uint64_t mbuf_initializer; /**< value to init mbufs */
68
69         uint8_t port_id; /* device port ID */
70         uint8_t crc_len; /* 0 if CRC stripped, 4 otherwise */
71         uint16_t queue_id; /* RX queue index */
72         uint16_t reg_idx; /* RX queue register index */
73         uint8_t drop_en; /* if not 0, set register bit */
74         volatile uint8_t *qrx_tail; /* register address of tail */
75         struct ice_vsi *vsi; /* the VSI this queue belongs to */
76         uint16_t rx_buf_len; /* The packet buffer size */
77         uint16_t rx_hdr_len; /* The header buffer size */
78         uint16_t max_pkt_len; /* Maximum packet length */
79         bool q_set; /* indicate if rx queue has been configured */
80         bool rx_deferred_start; /* don't start this queue in dev start */
81         uint8_t proto_xtr; /* Protocol extraction from flexible descriptor */
82         ice_rx_release_mbufs_t rx_rel_mbufs;
83 };
84
85 struct ice_tx_entry {
86         struct rte_mbuf *mbuf;
87         uint16_t next_id;
88         uint16_t last_id;
89 };
90
91 struct ice_tx_queue {
92         uint16_t nb_tx_desc; /* number of TX descriptors */
93         rte_iova_t tx_ring_dma; /* TX ring DMA address */
94         volatile struct ice_tx_desc *tx_ring; /* TX ring virtual address */
95         struct ice_tx_entry *sw_ring; /* virtual address of SW ring */
96         uint16_t tx_tail; /* current value of tail register */
97         volatile uint8_t *qtx_tail; /* register address of tail */
98         uint16_t nb_tx_used; /* number of TX desc used since RS bit set */
99         /* index to last TX descriptor to have been cleaned */
100         uint16_t last_desc_cleaned;
101         /* Total number of TX descriptors ready to be allocated. */
102         uint16_t nb_tx_free;
103         /* Start freeing TX buffers if there are less free descriptors than
104          * this value.
105          */
106         uint16_t tx_free_thresh;
107         /* Number of TX descriptors to use before RS bit is set. */
108         uint16_t tx_rs_thresh;
109         uint8_t pthresh; /**< Prefetch threshold register. */
110         uint8_t hthresh; /**< Host threshold register. */
111         uint8_t wthresh; /**< Write-back threshold reg. */
112         uint8_t port_id; /* Device port identifier. */
113         uint16_t queue_id; /* TX queue index. */
114         uint32_t q_teid; /* TX schedule node id. */
115         uint16_t reg_idx;
116         uint64_t offloads;
117         struct ice_vsi *vsi; /* the VSI this queue belongs to */
118         uint16_t tx_next_dd;
119         uint16_t tx_next_rs;
120         bool tx_deferred_start; /* don't start this queue in dev start */
121         bool q_set; /* indicate if tx queue has been configured */
122         ice_tx_release_mbufs_t tx_rel_mbufs;
123 };
124
125 /* Offload features */
126 union ice_tx_offload {
127         uint64_t data;
128         struct {
129                 uint64_t l2_len:7; /* L2 (MAC) Header Length. */
130                 uint64_t l3_len:9; /* L3 (IP) Header Length. */
131                 uint64_t l4_len:8; /* L4 Header Length. */
132                 uint64_t tso_segsz:16; /* TCP TSO segment size */
133                 uint64_t outer_l2_len:8; /* outer L2 Header Length */
134                 uint64_t outer_l3_len:16; /* outer L3 Header Length */
135         };
136 };
137
138 int ice_rx_queue_setup(struct rte_eth_dev *dev,
139                        uint16_t queue_idx,
140                        uint16_t nb_desc,
141                        unsigned int socket_id,
142                        const struct rte_eth_rxconf *rx_conf,
143                        struct rte_mempool *mp);
144 int ice_tx_queue_setup(struct rte_eth_dev *dev,
145                        uint16_t queue_idx,
146                        uint16_t nb_desc,
147                        unsigned int socket_id,
148                        const struct rte_eth_txconf *tx_conf);
149 int ice_rx_queue_start(struct rte_eth_dev *dev, uint16_t rx_queue_id);
150 int ice_rx_queue_stop(struct rte_eth_dev *dev, uint16_t rx_queue_id);
151 int ice_tx_queue_start(struct rte_eth_dev *dev, uint16_t tx_queue_id);
152 int ice_tx_queue_stop(struct rte_eth_dev *dev, uint16_t tx_queue_id);
153 int ice_fdir_rx_queue_start(struct rte_eth_dev *dev, uint16_t rx_queue_id);
154 int ice_fdir_tx_queue_start(struct rte_eth_dev *dev, uint16_t tx_queue_id);
155 int ice_fdir_rx_queue_stop(struct rte_eth_dev *dev, uint16_t rx_queue_id);
156 int ice_fdir_tx_queue_stop(struct rte_eth_dev *dev, uint16_t tx_queue_id);
157 void ice_rx_queue_release(void *rxq);
158 void ice_tx_queue_release(void *txq);
159 void ice_clear_queues(struct rte_eth_dev *dev);
160 void ice_free_queues(struct rte_eth_dev *dev);
161 int ice_fdir_setup_tx_resources(struct ice_pf *pf);
162 int ice_fdir_setup_rx_resources(struct ice_pf *pf);
163 uint16_t ice_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
164                        uint16_t nb_pkts);
165 uint16_t ice_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
166                        uint16_t nb_pkts);
167 void ice_set_rx_function(struct rte_eth_dev *dev);
168 uint16_t ice_prep_pkts(__rte_unused void *tx_queue, struct rte_mbuf **tx_pkts,
169                        uint16_t nb_pkts);
170 void ice_set_tx_function_flag(struct rte_eth_dev *dev,
171                               struct ice_tx_queue *txq);
172 void ice_set_tx_function(struct rte_eth_dev *dev);
173 uint32_t ice_rx_queue_count(struct rte_eth_dev *dev, uint16_t rx_queue_id);
174 void ice_rxq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
175                       struct rte_eth_rxq_info *qinfo);
176 void ice_txq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
177                       struct rte_eth_txq_info *qinfo);
178 int ice_rx_burst_mode_get(struct rte_eth_dev *dev, uint16_t queue_id,
179                           struct rte_eth_burst_mode *mode);
180 int ice_tx_burst_mode_get(struct rte_eth_dev *dev, uint16_t queue_id,
181                           struct rte_eth_burst_mode *mode);
182 int ice_rx_descriptor_status(void *rx_queue, uint16_t offset);
183 int ice_tx_descriptor_status(void *tx_queue, uint16_t offset);
184 void ice_set_default_ptype_table(struct rte_eth_dev *dev);
185 const uint32_t *ice_dev_supported_ptypes_get(struct rte_eth_dev *dev);
186
187 int ice_rx_vec_dev_check(struct rte_eth_dev *dev);
188 int ice_tx_vec_dev_check(struct rte_eth_dev *dev);
189 int ice_rxq_vec_setup(struct ice_rx_queue *rxq);
190 int ice_txq_vec_setup(struct ice_tx_queue *txq);
191 uint16_t ice_recv_pkts_vec(void *rx_queue, struct rte_mbuf **rx_pkts,
192                            uint16_t nb_pkts);
193 uint16_t ice_recv_scattered_pkts_vec(void *rx_queue, struct rte_mbuf **rx_pkts,
194                                      uint16_t nb_pkts);
195 uint16_t ice_xmit_pkts_vec(void *tx_queue, struct rte_mbuf **tx_pkts,
196                            uint16_t nb_pkts);
197 uint16_t ice_recv_pkts_vec_avx2(void *rx_queue, struct rte_mbuf **rx_pkts,
198                                 uint16_t nb_pkts);
199 uint16_t ice_recv_scattered_pkts_vec_avx2(void *rx_queue,
200                                           struct rte_mbuf **rx_pkts,
201                                           uint16_t nb_pkts);
202 uint16_t ice_xmit_pkts_vec_avx2(void *tx_queue, struct rte_mbuf **tx_pkts,
203                                 uint16_t nb_pkts);
204 int ice_fdir_programming(struct ice_pf *pf, struct ice_fltr_desc *fdir_desc);
205 int ice_tx_done_cleanup(void *txq, uint32_t free_cnt);
206
207 #endif /* _ICE_RXTX_H_ */