4 * Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #ifndef _E1000_ETHDEV_H_
35 #define _E1000_ETHDEV_H_
39 #define E1000_INTEL_VENDOR_ID 0x8086
41 /* need update link, bit flag */
42 #define E1000_FLAG_NEED_LINK_UPDATE (uint32_t)(1 << 0)
43 #define E1000_FLAG_MAILBOX (uint32_t)(1 << 1)
46 * Defines that were not part of e1000_hw.h as they are not used by the FreeBSD
49 #define E1000_ADVTXD_POPTS_TXSM 0x00000200 /* L4 Checksum offload request */
50 #define E1000_ADVTXD_POPTS_IXSM 0x00000100 /* IP Checksum offload request */
51 #define E1000_ADVTXD_TUCMD_L4T_RSV 0x00001800 /* L4 Packet TYPE of Reserved */
52 #define E1000_RXD_STAT_TMST 0x10000 /* Timestamped Packet indication */
53 #define E1000_RXD_ERR_CKSUM_BIT 29
54 #define E1000_RXD_ERR_CKSUM_MSK 3
55 #define E1000_ADVTXD_MACLEN_SHIFT 9 /* Bit shift for l2_len */
56 #define E1000_CTRL_EXT_EXTEND_VLAN (1<<26) /* EXTENDED VLAN */
57 #define IGB_VFTA_SIZE 128
59 #define IGB_MAX_RX_QUEUE_NUM 8
60 #define IGB_MAX_RX_QUEUE_NUM_82576 16
62 #define E1000_SYN_FILTER_ENABLE 0x00000001 /* syn filter enable field */
63 #define E1000_SYN_FILTER_QUEUE 0x0000000E /* syn filter queue field */
64 #define E1000_SYN_FILTER_QUEUE_SHIFT 1 /* syn filter queue field */
65 #define E1000_RFCTL_SYNQFP 0x00080000 /* SYNQFP in RFCTL register */
67 #define E1000_ETQF_ETHERTYPE 0x0000FFFF
68 #define E1000_ETQF_QUEUE 0x00070000
69 #define E1000_ETQF_QUEUE_SHIFT 16
70 #define E1000_MAX_ETQF_FILTERS 8
72 #define E1000_IMIR_DSTPORT 0x0000FFFF
73 #define E1000_IMIR_PRIORITY 0xE0000000
74 #define E1000_MAX_TTQF_FILTERS 8
75 #define E1000_2TUPLE_MAX_PRI 7
77 #define E1000_MAX_FLEX_FILTERS 8
78 #define E1000_MAX_FHFT 4
79 #define E1000_MAX_FHFT_EXT 4
80 #define E1000_FHFT_SIZE_IN_DWD 64
81 #define E1000_MAX_FLEX_FILTER_PRI 7
82 #define E1000_MAX_FLEX_FILTER_LEN 128
83 #define E1000_MAX_FLEX_FILTER_DWDS \
84 (E1000_MAX_FLEX_FILTER_LEN / sizeof(uint32_t))
85 #define E1000_FLEX_FILTERS_MASK_SIZE \
86 (E1000_MAX_FLEX_FILTER_DWDS / 2)
87 #define E1000_FHFT_QUEUEING_LEN 0x0000007F
88 #define E1000_FHFT_QUEUEING_QUEUE 0x00000700
89 #define E1000_FHFT_QUEUEING_PRIO 0x00070000
90 #define E1000_FHFT_QUEUEING_OFFSET 0xFC
91 #define E1000_FHFT_QUEUEING_QUEUE_SHIFT 8
92 #define E1000_FHFT_QUEUEING_PRIO_SHIFT 16
93 #define E1000_WUFC_FLEX_HQ 0x00004000
95 #define E1000_SPQF_SRCPORT 0x0000FFFF
97 #define E1000_MAX_FTQF_FILTERS 8
98 #define E1000_FTQF_PROTOCOL_MASK 0x000000FF
99 #define E1000_FTQF_5TUPLE_MASK_SHIFT 28
100 #define E1000_FTQF_QUEUE_MASK 0x03ff0000
101 #define E1000_FTQF_QUEUE_SHIFT 16
102 #define E1000_FTQF_QUEUE_ENABLE 0x00000100
104 #define IGB_RSS_OFFLOAD_ALL ( \
106 ETH_RSS_NONFRAG_IPV4_TCP | \
107 ETH_RSS_NONFRAG_IPV4_UDP | \
109 ETH_RSS_NONFRAG_IPV6_TCP | \
110 ETH_RSS_NONFRAG_IPV6_UDP | \
112 ETH_RSS_IPV6_TCP_EX | \
116 * Maximum number of Ring Descriptors.
118 * Since RDLEN/TDLEN should be multiple of 128 bytes, the number of ring
119 * desscriptors should meet the following condition:
120 * (num_ring_desc * sizeof(struct e1000_rx/tx_desc)) % 128 == 0
122 #define E1000_MIN_RING_DESC 32
123 #define E1000_MAX_RING_DESC 4096
126 * TDBA/RDBA should be aligned on 16 byte boundary. But TDLEN/RDLEN should be
127 * multiple of 128 bytes. So we align TDBA/RDBA on 128 byte boundary.
128 * This will also optimize cache line size effect.
129 * H/W supports up to cache line size 128.
131 #define E1000_ALIGN 128
133 #define IGB_RXD_ALIGN (E1000_ALIGN / sizeof(union e1000_adv_rx_desc))
134 #define IGB_TXD_ALIGN (E1000_ALIGN / sizeof(union e1000_adv_tx_desc))
136 #define EM_RXD_ALIGN (E1000_ALIGN / sizeof(struct e1000_rx_desc))
137 #define EM_TXD_ALIGN (E1000_ALIGN / sizeof(struct e1000_data_desc))
139 #define E1000_MISC_VEC_ID RTE_INTR_VEC_ZERO_OFFSET
140 #define E1000_RX_VEC_START RTE_INTR_VEC_RXTX_OFFSET
142 #define IGB_TX_MAX_SEG UINT8_MAX
143 #define IGB_TX_MAX_MTU_SEG UINT8_MAX
144 #define EM_TX_MAX_SEG UINT8_MAX
145 #define EM_TX_MAX_MTU_SEG UINT8_MAX
147 #define MAC_TYPE_FILTER_SUP(type) do {\
148 if ((type) != e1000_82580 && (type) != e1000_i350 &&\
149 (type) != e1000_82576 && (type) != e1000_i210 &&\
150 (type) != e1000_i211)\
154 #define MAC_TYPE_FILTER_SUP_EXT(type) do {\
155 if ((type) != e1000_82580 && (type) != e1000_i350 &&\
156 (type) != e1000_i210 && (type) != e1000_i211)\
160 /* structure for interrupt relative data */
161 struct e1000_interrupt {
166 /* local vfta copy */
168 uint32_t vfta[IGB_VFTA_SIZE];
172 * VF data which used by PF host only
174 #define E1000_MAX_VF_MC_ENTRIES 30
175 struct e1000_vf_info {
176 uint8_t vf_mac_addresses[ETHER_ADDR_LEN];
177 uint16_t vf_mc_hashes[E1000_MAX_VF_MC_ENTRIES];
178 uint16_t num_vf_mc_hashes;
179 uint16_t default_vf_vlan_id;
180 uint16_t vlans_enabled;
186 TAILQ_HEAD(e1000_flex_filter_list, e1000_flex_filter);
188 struct e1000_flex_filter_info {
190 uint32_t dwords[E1000_MAX_FLEX_FILTER_DWDS]; /* flex bytes in dword. */
191 /* if mask bit is 1b, do not compare corresponding byte in dwords. */
192 uint8_t mask[E1000_FLEX_FILTERS_MASK_SIZE];
196 /* Flex filter structure */
197 struct e1000_flex_filter {
198 TAILQ_ENTRY(e1000_flex_filter) entries;
199 uint16_t index; /* index of flex filter */
200 struct e1000_flex_filter_info filter_info;
201 uint16_t queue; /* rx queue assigned to */
204 TAILQ_HEAD(e1000_5tuple_filter_list, e1000_5tuple_filter);
205 TAILQ_HEAD(e1000_2tuple_filter_list, e1000_2tuple_filter);
207 struct e1000_5tuple_filter_info {
212 uint8_t proto; /* l4 protocol. */
213 /* the packet matched above 5tuple and contain any set bit will hit this filter. */
215 uint8_t priority; /* seven levels (001b-111b), 111b is highest,
216 used when more than one filter matches. */
217 uint8_t dst_ip_mask:1, /* if mask is 1b, do not compare dst ip. */
218 src_ip_mask:1, /* if mask is 1b, do not compare src ip. */
219 dst_port_mask:1, /* if mask is 1b, do not compare dst port. */
220 src_port_mask:1, /* if mask is 1b, do not compare src port. */
221 proto_mask:1; /* if mask is 1b, do not compare protocol. */
224 struct e1000_2tuple_filter_info {
226 uint8_t proto; /* l4 protocol. */
227 /* the packet matched above 2tuple and contain any set bit will hit this filter. */
229 uint8_t priority; /* seven levels (001b-111b), 111b is highest,
230 used when more than one filter matches. */
231 uint8_t dst_ip_mask:1, /* if mask is 1b, do not compare dst ip. */
232 src_ip_mask:1, /* if mask is 1b, do not compare src ip. */
233 dst_port_mask:1, /* if mask is 1b, do not compare dst port. */
234 src_port_mask:1, /* if mask is 1b, do not compare src port. */
235 proto_mask:1; /* if mask is 1b, do not compare protocol. */
238 /* 5tuple filter structure */
239 struct e1000_5tuple_filter {
240 TAILQ_ENTRY(e1000_5tuple_filter) entries;
241 uint16_t index; /* the index of 5tuple filter */
242 struct e1000_5tuple_filter_info filter_info;
243 uint16_t queue; /* rx queue assigned to */
246 /* 2tuple filter structure */
247 struct e1000_2tuple_filter {
248 TAILQ_ENTRY(e1000_2tuple_filter) entries;
249 uint16_t index; /* the index of 2tuple filter */
250 struct e1000_2tuple_filter_info filter_info;
251 uint16_t queue; /* rx queue assigned to */
254 /* ethertype filter structure */
255 struct igb_ethertype_filter {
261 * Structure to store filters'info.
263 struct e1000_filter_info {
264 uint8_t ethertype_mask; /* Bit mask for every used ethertype filter */
265 /* store used ethertype filters*/
266 struct igb_ethertype_filter ethertype_filters[E1000_MAX_ETQF_FILTERS];
267 uint8_t flex_mask; /* Bit mask for every used flex filter */
268 struct e1000_flex_filter_list flex_list;
269 /* Bit mask for every used 5tuple filter */
270 uint8_t fivetuple_mask;
271 struct e1000_5tuple_filter_list fivetuple_list;
272 /* Bit mask for every used 2tuple filter */
273 uint8_t twotuple_mask;
274 struct e1000_2tuple_filter_list twotuple_list;
275 /* store the SYN filter info */
280 * Structure to store private data for each driver instance (for each port).
282 struct e1000_adapter {
284 struct e1000_hw_stats stats;
285 struct e1000_interrupt intr;
286 struct e1000_vfta shadow_vfta;
287 struct e1000_vf_info *vfdata;
288 struct e1000_filter_info filter;
290 struct rte_timecounter systime_tc;
291 struct rte_timecounter rx_tstamp_tc;
292 struct rte_timecounter tx_tstamp_tc;
295 #define E1000_DEV_PRIVATE(adapter) \
296 ((struct e1000_adapter *)adapter)
298 #define E1000_DEV_PRIVATE_TO_HW(adapter) \
299 (&((struct e1000_adapter *)adapter)->hw)
301 #define E1000_DEV_PRIVATE_TO_STATS(adapter) \
302 (&((struct e1000_adapter *)adapter)->stats)
304 #define E1000_DEV_PRIVATE_TO_INTR(adapter) \
305 (&((struct e1000_adapter *)adapter)->intr)
307 #define E1000_DEV_PRIVATE_TO_VFTA(adapter) \
308 (&((struct e1000_adapter *)adapter)->shadow_vfta)
310 #define E1000_DEV_PRIVATE_TO_P_VFDATA(adapter) \
311 (&((struct e1000_adapter *)adapter)->vfdata)
313 #define E1000_DEV_PRIVATE_TO_FILTER_INFO(adapter) \
314 (&((struct e1000_adapter *)adapter)->filter)
317 enum rte_filter_type filter_type;
321 /* ntuple filter list structure */
322 struct igb_ntuple_filter_ele {
323 TAILQ_ENTRY(igb_ntuple_filter_ele) entries;
324 struct rte_eth_ntuple_filter filter_info;
327 /* ethertype filter list structure */
328 struct igb_ethertype_filter_ele {
329 TAILQ_ENTRY(igb_ethertype_filter_ele) entries;
330 struct rte_eth_ethertype_filter filter_info;
333 /* syn filter list structure */
334 struct igb_eth_syn_filter_ele {
335 TAILQ_ENTRY(igb_eth_syn_filter_ele) entries;
336 struct rte_eth_syn_filter filter_info;
339 /* flex filter list structure */
340 struct igb_flex_filter_ele {
341 TAILQ_ENTRY(igb_flex_filter_ele) entries;
342 struct rte_eth_flex_filter filter_info;
345 /* igb_flow memory list structure */
346 struct igb_flow_mem {
347 TAILQ_ENTRY(igb_flow_mem) entries;
348 struct rte_flow *flow;
349 struct rte_eth_dev *dev;
352 TAILQ_HEAD(igb_ntuple_filter_list, igb_ntuple_filter_ele);
353 struct igb_ntuple_filter_list igb_filter_ntuple_list;
354 TAILQ_HEAD(igb_ethertype_filter_list, igb_ethertype_filter_ele);
355 struct igb_ethertype_filter_list igb_filter_ethertype_list;
356 TAILQ_HEAD(igb_syn_filter_list, igb_eth_syn_filter_ele);
357 struct igb_syn_filter_list igb_filter_syn_list;
358 TAILQ_HEAD(igb_flex_filter_list, igb_flex_filter_ele);
359 struct igb_flex_filter_list igb_filter_flex_list;
360 TAILQ_HEAD(igb_flow_mem_list, igb_flow_mem);
361 struct igb_flow_mem_list igb_flow_list;
363 extern const struct rte_flow_ops igb_flow_ops;
366 * RX/TX IGB function prototypes
368 void eth_igb_tx_queue_release(void *txq);
369 void eth_igb_rx_queue_release(void *rxq);
370 void igb_dev_clear_queues(struct rte_eth_dev *dev);
371 void igb_dev_free_queues(struct rte_eth_dev *dev);
373 int eth_igb_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
374 uint16_t nb_rx_desc, unsigned int socket_id,
375 const struct rte_eth_rxconf *rx_conf,
376 struct rte_mempool *mb_pool);
378 uint32_t eth_igb_rx_queue_count(struct rte_eth_dev *dev,
379 uint16_t rx_queue_id);
381 int eth_igb_rx_descriptor_done(void *rx_queue, uint16_t offset);
383 int eth_igb_rx_descriptor_status(void *rx_queue, uint16_t offset);
384 int eth_igb_tx_descriptor_status(void *tx_queue, uint16_t offset);
386 int eth_igb_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
387 uint16_t nb_tx_desc, unsigned int socket_id,
388 const struct rte_eth_txconf *tx_conf);
390 int eth_igb_tx_done_cleanup(void *txq, uint32_t free_cnt);
392 int eth_igb_rx_init(struct rte_eth_dev *dev);
394 void eth_igb_tx_init(struct rte_eth_dev *dev);
396 uint16_t eth_igb_xmit_pkts(void *txq, struct rte_mbuf **tx_pkts,
399 uint16_t eth_igb_prep_pkts(void *txq, struct rte_mbuf **tx_pkts,
402 uint16_t eth_igb_recv_pkts(void *rxq, struct rte_mbuf **rx_pkts,
405 uint16_t eth_igb_recv_scattered_pkts(void *rxq,
406 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
408 int eth_igb_rss_hash_update(struct rte_eth_dev *dev,
409 struct rte_eth_rss_conf *rss_conf);
411 int eth_igb_rss_hash_conf_get(struct rte_eth_dev *dev,
412 struct rte_eth_rss_conf *rss_conf);
414 int eth_igbvf_rx_init(struct rte_eth_dev *dev);
416 void eth_igbvf_tx_init(struct rte_eth_dev *dev);
419 * misc function prototypes
421 void igb_pf_host_init(struct rte_eth_dev *eth_dev);
423 void igb_pf_mbx_process(struct rte_eth_dev *eth_dev);
425 int igb_pf_host_configure(struct rte_eth_dev *eth_dev);
427 void igb_rxq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
428 struct rte_eth_rxq_info *qinfo);
430 void igb_txq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
431 struct rte_eth_txq_info *qinfo);
434 * RX/TX EM function prototypes
436 void eth_em_tx_queue_release(void *txq);
437 void eth_em_rx_queue_release(void *rxq);
439 void em_dev_clear_queues(struct rte_eth_dev *dev);
440 void em_dev_free_queues(struct rte_eth_dev *dev);
442 int eth_em_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
443 uint16_t nb_rx_desc, unsigned int socket_id,
444 const struct rte_eth_rxconf *rx_conf,
445 struct rte_mempool *mb_pool);
447 uint32_t eth_em_rx_queue_count(struct rte_eth_dev *dev,
448 uint16_t rx_queue_id);
450 int eth_em_rx_descriptor_done(void *rx_queue, uint16_t offset);
452 int eth_em_rx_descriptor_status(void *rx_queue, uint16_t offset);
453 int eth_em_tx_descriptor_status(void *tx_queue, uint16_t offset);
455 int eth_em_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
456 uint16_t nb_tx_desc, unsigned int socket_id,
457 const struct rte_eth_txconf *tx_conf);
459 int eth_em_rx_init(struct rte_eth_dev *dev);
461 void eth_em_tx_init(struct rte_eth_dev *dev);
463 uint16_t eth_em_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
466 uint16_t eth_em_prep_pkts(void *txq, struct rte_mbuf **tx_pkts,
469 uint16_t eth_em_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
472 uint16_t eth_em_recv_scattered_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
475 void em_rxq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
476 struct rte_eth_rxq_info *qinfo);
478 void em_txq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
479 struct rte_eth_txq_info *qinfo);
481 void igb_pf_host_uninit(struct rte_eth_dev *dev);
483 void igb_filterlist_flush(struct rte_eth_dev *dev);
484 int igb_delete_5tuple_filter_82576(struct rte_eth_dev *dev,
485 struct e1000_5tuple_filter *filter);
486 int igb_delete_2tuple_filter(struct rte_eth_dev *dev,
487 struct e1000_2tuple_filter *filter);
488 void igb_remove_flex_filter(struct rte_eth_dev *dev,
489 struct e1000_flex_filter *filter);
490 int igb_ethertype_filter_remove(struct e1000_filter_info *filter_info,
492 int igb_add_del_ntuple_filter(struct rte_eth_dev *dev,
493 struct rte_eth_ntuple_filter *ntuple_filter, bool add);
494 int igb_add_del_ethertype_filter(struct rte_eth_dev *dev,
495 struct rte_eth_ethertype_filter *filter,
497 int eth_igb_syn_filter_set(struct rte_eth_dev *dev,
498 struct rte_eth_syn_filter *filter,
500 int eth_igb_add_del_flex_filter(struct rte_eth_dev *dev,
501 struct rte_eth_flex_filter *filter,
503 #endif /* _E1000_ETHDEV_H_ */