Branch data Line data Source code
1 : : /* SPDX-License-Identifier: BSD-3-Clause
2 : : * Copyright(c) 2018-2021 Beijing WangXun Technology Co., Ltd.
3 : : * Copyright(c) 2010-2017 Intel Corporation
4 : : */
5 : :
6 : : #ifndef _NGBE_ETHDEV_H_
7 : : #define _NGBE_ETHDEV_H_
8 : :
9 : : #include "ngbe_ptypes.h"
10 : : #include <rte_time.h>
11 : : #include <rte_ethdev.h>
12 : : #include <rte_ethdev_core.h>
13 : :
14 : : /* need update link, bit flag */
15 : : #define NGBE_FLAG_NEED_LINK_UPDATE ((uint32_t)(1 << 0))
16 : : #define NGBE_FLAG_MAILBOX ((uint32_t)(1 << 1))
17 : : #define NGBE_FLAG_PHY_INTERRUPT ((uint32_t)(1 << 2))
18 : : #define NGBE_FLAG_MACSEC ((uint32_t)(1 << 3))
19 : : #define NGBE_FLAG_NEED_LINK_CONFIG ((uint32_t)(1 << 4))
20 : : #define NGBE_FLAG_OVERHEAT ((uint32_t)(1 << 5))
21 : :
22 : : #define NGBE_VFTA_SIZE 128
23 : : #define NGBE_HKEY_MAX_INDEX 10
24 : : /*Default value of Max Rx Queue*/
25 : : #define NGBE_MAX_RX_QUEUE_NUM 8
26 : :
27 : : #ifndef NBBY
28 : : #define NBBY 8 /* number of bits in a byte */
29 : : #endif
30 : : #define NGBE_HWSTRIP_BITMAP_SIZE \
31 : : (NGBE_MAX_RX_QUEUE_NUM / (sizeof(uint32_t) * NBBY))
32 : :
33 : : #define NGBE_QUEUE_ITR_INTERVAL_DEFAULT 500 /* 500us */
34 : :
35 : : /* The overhead from MTU to max frame size. */
36 : : #define NGBE_ETH_OVERHEAD (RTE_ETHER_HDR_LEN + RTE_ETHER_CRC_LEN)
37 : :
38 : : #define NGBE_RSS_OFFLOAD_ALL ( \
39 : : RTE_ETH_RSS_IPV4 | \
40 : : RTE_ETH_RSS_NONFRAG_IPV4_TCP | \
41 : : RTE_ETH_RSS_NONFRAG_IPV4_UDP | \
42 : : RTE_ETH_RSS_IPV6 | \
43 : : RTE_ETH_RSS_NONFRAG_IPV6_TCP | \
44 : : RTE_ETH_RSS_NONFRAG_IPV6_UDP | \
45 : : RTE_ETH_RSS_IPV6_EX | \
46 : : RTE_ETH_RSS_IPV6_TCP_EX | \
47 : : RTE_ETH_RSS_IPV6_UDP_EX)
48 : :
49 : : #define NGBE_MISC_VEC_ID RTE_INTR_VEC_ZERO_OFFSET
50 : : #define NGBE_RX_VEC_START RTE_INTR_VEC_RXTX_OFFSET
51 : :
52 : : /* structure for interrupt relative data */
53 : : struct ngbe_interrupt {
54 : : uint32_t flags;
55 : : uint32_t mask_misc;
56 : : uint32_t mask_misc_orig; /* save mask during delayed handler */
57 : : uint64_t mask;
58 : : uint64_t mask_orig; /* save mask during delayed handler */
59 : : };
60 : :
61 : : #define NGBE_NB_STAT_MAPPING 32
62 : : #define NB_QMAP_FIELDS_PER_QSM_REG 4
63 : : #define QMAP_FIELD_RESERVED_BITS_MASK 0x0f
64 : : struct ngbe_stat_mappings {
65 : : uint32_t tqsm[NGBE_NB_STAT_MAPPING];
66 : : uint32_t rqsm[NGBE_NB_STAT_MAPPING];
67 : : };
68 : :
69 : : struct ngbe_vfta {
70 : : uint32_t vfta[NGBE_VFTA_SIZE];
71 : : };
72 : :
73 : : struct ngbe_hwstrip {
74 : : uint32_t bitmap[NGBE_HWSTRIP_BITMAP_SIZE];
75 : : };
76 : :
77 : : /**
78 : : * Response sent back to ngbe driver from user app after callback
79 : : */
80 : : enum ngbe_mb_event_rsp {
81 : : NGBE_MB_EVENT_NOOP_ACK, /**< skip mbox request and ACK */
82 : : NGBE_MB_EVENT_NOOP_NACK, /**< skip mbox request and NACK */
83 : : NGBE_MB_EVENT_PROCEED, /**< proceed with mbox request */
84 : : NGBE_MB_EVENT_MAX /**< max value of this enum */
85 : : };
86 : :
87 : : /**
88 : : * Data sent to the user application when the callback is executed.
89 : : */
90 : : struct ngbe_mb_event_param {
91 : : uint16_t vfid; /**< Virtual Function number */
92 : : uint16_t msg_type; /**< VF to PF message type, defined in ngbe_mbx.h */
93 : : uint16_t retval; /**< return value */
94 : : void *msg; /**< pointer to message */
95 : : };
96 : :
97 : : /*
98 : : * VF data which used by PF host only
99 : : */
100 : : #define NGBE_MAX_VF_MC_ENTRIES 30
101 : :
102 : : struct ngbe_uta_info {
103 : : uint8_t uc_filter_type;
104 : : uint16_t uta_in_use;
105 : : uint32_t uta_shadow[NGBE_MAX_UTA];
106 : : };
107 : :
108 : : struct ngbe_vf_info {
109 : : uint8_t vf_mac_addresses[RTE_ETHER_ADDR_LEN];
110 : : uint16_t vf_mc_hashes[NGBE_MAX_VF_MC_ENTRIES];
111 : : uint16_t num_vf_mc_hashes;
112 : : bool clear_to_send;
113 : : uint16_t vlan_count;
114 : : uint8_t api_version;
115 : : uint16_t switch_domain_id;
116 : : uint16_t xcast_mode;
117 : : uint16_t mac_count;
118 : : };
119 : :
120 : : /*
121 : : * Structure to store private data for each driver instance (for each port).
122 : : */
123 : : struct ngbe_adapter {
124 : : struct ngbe_hw hw;
125 : : struct ngbe_hw_stats stats;
126 : : struct ngbe_interrupt intr;
127 : : struct ngbe_stat_mappings stat_mappings;
128 : : struct ngbe_vfta shadow_vfta;
129 : : struct ngbe_hwstrip hwstrip;
130 : : struct ngbe_vf_info *vfdata;
131 : : struct ngbe_uta_info uta_info;
132 : : bool rx_bulk_alloc_allowed;
133 : : struct rte_timecounter systime_tc;
134 : : struct rte_timecounter rx_tstamp_tc;
135 : : struct rte_timecounter tx_tstamp_tc;
136 : :
137 : : /* For RSS reta table update */
138 : : uint8_t rss_reta_updated;
139 : : };
140 : :
141 : : static inline struct ngbe_adapter *
142 : : ngbe_dev_adapter(struct rte_eth_dev *dev)
143 : : {
144 [ # # # # : 0 : struct ngbe_adapter *ad = dev->data->dev_private;
# # # # #
# # # #
# ]
145 : :
146 : : return ad;
147 : : }
148 : :
149 : : static inline struct ngbe_hw *
150 : : ngbe_dev_hw(struct rte_eth_dev *dev)
151 : : {
152 : : struct ngbe_adapter *ad = ngbe_dev_adapter(dev);
153 [ # # # # : 0 : struct ngbe_hw *hw = &ad->hw;
# # # # #
# ]
154 : :
155 : : return hw;
156 : : }
157 : :
158 : : #define NGBE_DEV_STATS(dev) \
159 : : (&((struct ngbe_adapter *)(dev)->data->dev_private)->stats)
160 : :
161 : : static inline struct ngbe_interrupt *
162 : : ngbe_dev_intr(struct rte_eth_dev *dev)
163 : : {
164 : : struct ngbe_adapter *ad = ngbe_dev_adapter(dev);
165 : : struct ngbe_interrupt *intr = &ad->intr;
166 : :
167 : : return intr;
168 : : }
169 : :
170 : : #define NGBE_DEV_STAT_MAPPINGS(dev) \
171 : : (&((struct ngbe_adapter *)(dev)->data->dev_private)->stat_mappings)
172 : :
173 : : #define NGBE_DEV_VFTA(dev) \
174 : : (&((struct ngbe_adapter *)(dev)->data->dev_private)->shadow_vfta)
175 : :
176 : : #define NGBE_DEV_HWSTRIP(dev) \
177 : : (&((struct ngbe_adapter *)(dev)->data->dev_private)->hwstrip)
178 : :
179 : : #define NGBE_DEV_VFDATA(dev) \
180 : : (&((struct ngbe_adapter *)(dev)->data->dev_private)->vfdata)
181 : :
182 : : #define NGBE_DEV_UTA_INFO(dev) \
183 : : (&((struct ngbe_adapter *)(dev)->data->dev_private)->uta_info)
184 : :
185 : : /*
186 : : * Rx/Tx function prototypes
187 : : */
188 : : void ngbe_dev_clear_queues(struct rte_eth_dev *dev);
189 : :
190 : : void ngbe_dev_free_queues(struct rte_eth_dev *dev);
191 : :
192 : : void ngbe_dev_rx_queue_release(struct rte_eth_dev *dev, uint16_t qid);
193 : :
194 : : void ngbe_dev_tx_queue_release(struct rte_eth_dev *dev, uint16_t qid);
195 : :
196 : : int ngbe_dev_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
197 : : uint16_t nb_rx_desc, unsigned int socket_id,
198 : : const struct rte_eth_rxconf *rx_conf,
199 : : struct rte_mempool *mb_pool);
200 : :
201 : : int ngbe_dev_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
202 : : uint16_t nb_tx_desc, unsigned int socket_id,
203 : : const struct rte_eth_txconf *tx_conf);
204 : :
205 : : uint32_t ngbe_dev_rx_queue_count(void *rx_queue);
206 : :
207 : : int ngbe_dev_rx_descriptor_status(void *rx_queue, uint16_t offset);
208 : : int ngbe_dev_tx_descriptor_status(void *tx_queue, uint16_t offset);
209 : :
210 : : int ngbe_dev_rx_init(struct rte_eth_dev *dev);
211 : :
212 : : void ngbe_dev_tx_init(struct rte_eth_dev *dev);
213 : :
214 : : int ngbe_dev_rxtx_start(struct rte_eth_dev *dev);
215 : :
216 : : void ngbe_dev_save_rx_queue(struct ngbe_hw *hw, uint16_t rx_queue_id);
217 : : void ngbe_dev_store_rx_queue(struct ngbe_hw *hw, uint16_t rx_queue_id);
218 : : void ngbe_dev_save_tx_queue(struct ngbe_hw *hw, uint16_t tx_queue_id);
219 : : void ngbe_dev_store_tx_queue(struct ngbe_hw *hw, uint16_t tx_queue_id);
220 : :
221 : : int ngbe_dev_rx_queue_start(struct rte_eth_dev *dev, uint16_t rx_queue_id);
222 : :
223 : : int ngbe_dev_rx_queue_stop(struct rte_eth_dev *dev, uint16_t rx_queue_id);
224 : :
225 : : int ngbe_dev_tx_queue_start(struct rte_eth_dev *dev, uint16_t tx_queue_id);
226 : :
227 : : int ngbe_dev_tx_queue_stop(struct rte_eth_dev *dev, uint16_t tx_queue_id);
228 : :
229 : : void ngbe_rxq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
230 : : struct rte_eth_rxq_info *qinfo);
231 : :
232 : : void ngbe_txq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
233 : : struct rte_eth_txq_info *qinfo);
234 : :
235 : : int
236 : : ngbe_rx_burst_mode_get(struct rte_eth_dev *dev, __rte_unused uint16_t queue_id,
237 : : struct rte_eth_burst_mode *mode);
238 : : int
239 : : ngbe_tx_burst_mode_get(struct rte_eth_dev *dev, __rte_unused uint16_t queue_id,
240 : : struct rte_eth_burst_mode *mode);
241 : :
242 : : uint16_t ngbe_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
243 : : uint16_t nb_pkts);
244 : :
245 : : uint16_t ngbe_recv_pkts_bulk_alloc(void *rx_queue, struct rte_mbuf **rx_pkts,
246 : : uint16_t nb_pkts);
247 : :
248 : : uint16_t ngbe_recv_pkts_sc_single_alloc(void *rx_queue,
249 : : struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
250 : : uint16_t ngbe_recv_pkts_sc_bulk_alloc(void *rx_queue,
251 : : struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
252 : :
253 : : uint16_t ngbe_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
254 : : uint16_t nb_pkts);
255 : :
256 : : uint16_t ngbe_xmit_pkts_simple(void *tx_queue, struct rte_mbuf **tx_pkts,
257 : : uint16_t nb_pkts);
258 : :
259 : : uint16_t ngbe_prep_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
260 : : uint16_t nb_pkts);
261 : :
262 : : int ngbe_dev_rss_hash_update(struct rte_eth_dev *dev,
263 : : struct rte_eth_rss_conf *rss_conf);
264 : :
265 : : int ngbe_dev_rss_hash_conf_get(struct rte_eth_dev *dev,
266 : : struct rte_eth_rss_conf *rss_conf);
267 : :
268 : : void ngbe_set_ivar_map(struct ngbe_hw *hw, int8_t direction,
269 : : uint8_t queue, uint8_t msix_vector);
270 : :
271 : : void ngbe_configure_port(struct rte_eth_dev *dev);
272 : :
273 : : int
274 : : ngbe_dev_link_update_share(struct rte_eth_dev *dev,
275 : : int wait_to_complete);
276 : :
277 : : /*
278 : : * misc function prototypes
279 : : */
280 : : void ngbe_vlan_hw_filter_enable(struct rte_eth_dev *dev);
281 : :
282 : : void ngbe_vlan_hw_filter_disable(struct rte_eth_dev *dev);
283 : :
284 : : void ngbe_vlan_hw_strip_config(struct rte_eth_dev *dev);
285 : :
286 : : int ngbe_pf_host_init(struct rte_eth_dev *eth_dev);
287 : :
288 : : void ngbe_pf_host_uninit(struct rte_eth_dev *eth_dev);
289 : :
290 : : void ngbe_pf_mbx_process(struct rte_eth_dev *eth_dev);
291 : :
292 : : int ngbe_pf_host_configure(struct rte_eth_dev *eth_dev);
293 : :
294 : : /* High threshold controlling when to start sending XOFF frames. */
295 : : #define NGBE_FC_XOFF_HITH 128 /*KB*/
296 : : /* Low threshold controlling when to start sending XON frames. */
297 : : #define NGBE_FC_XON_LOTH 64 /*KB*/
298 : :
299 : : /* Timer value included in XOFF frames. */
300 : : #define NGBE_FC_PAUSE_TIME 0x680
301 : :
302 : : #define NGBE_LINK_DOWN_CHECK_TIMEOUT 4000 /* ms */
303 : : #define NGBE_LINK_UP_CHECK_TIMEOUT 1000 /* ms */
304 : : #define NGBE_VMDQ_NUM_UC_MAC 4096 /* Maximum nb. of UC MAC addr. */
305 : :
306 : : /*
307 : : * Default values for Rx/Tx configuration
308 : : */
309 : : #define NGBE_DEFAULT_RX_FREE_THRESH 32
310 : : #define NGBE_DEFAULT_RX_PTHRESH 8
311 : : #define NGBE_DEFAULT_RX_HTHRESH 8
312 : : #define NGBE_DEFAULT_RX_WTHRESH 0
313 : :
314 : : #define NGBE_DEFAULT_TX_FREE_THRESH 32
315 : : #define NGBE_DEFAULT_TX_PTHRESH 32
316 : : #define NGBE_DEFAULT_TX_HTHRESH 0
317 : : #define NGBE_DEFAULT_TX_WTHRESH 0
318 : :
319 : : /* Additional timesync values. */
320 : : #define NGBE_INCVAL_1GB 0x2000000 /* all speed is same in Emerald */
321 : : #define NGBE_INCVAL_SHIFT_1GB 22 /* all speed is same in Emerald */
322 : :
323 : : #define NGBE_CYCLECOUNTER_MASK 0xffffffffffffffffULL
324 : :
325 : : /* store statistics names and its offset in stats structure */
326 : : struct rte_ngbe_xstats_name_off {
327 : : char name[RTE_ETH_XSTATS_NAME_SIZE];
328 : : unsigned int offset;
329 : : };
330 : :
331 : : const uint32_t *ngbe_dev_supported_ptypes_get(struct rte_eth_dev *dev);
332 : : int ngbe_dev_set_mc_addr_list(struct rte_eth_dev *dev,
333 : : struct rte_ether_addr *mc_addr_set,
334 : : uint32_t nb_mc_addr);
335 : : int ngbe_dev_rss_reta_update(struct rte_eth_dev *dev,
336 : : struct rte_eth_rss_reta_entry64 *reta_conf,
337 : : uint16_t reta_size);
338 : : int ngbe_dev_rss_reta_query(struct rte_eth_dev *dev,
339 : : struct rte_eth_rss_reta_entry64 *reta_conf,
340 : : uint16_t reta_size);
341 : : void ngbe_vlan_hw_strip_bitmap_set(struct rte_eth_dev *dev,
342 : : uint16_t queue, bool on);
343 : : void ngbe_config_vlan_strip_on_all_queues(struct rte_eth_dev *dev,
344 : : int mask);
345 : : void ngbe_read_stats_registers(struct ngbe_hw *hw,
346 : : struct ngbe_hw_stats *hw_stats);
347 : :
348 : : #endif /* _NGBE_ETHDEV_H_ */
|