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