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_
38 #define E1000_INTEL_VENDOR_ID 0x8086
40 /* need update link, bit flag */
41 #define E1000_FLAG_NEED_LINK_UPDATE (uint32_t)(1 << 0)
42 #define E1000_FLAG_MAILBOX (uint32_t)(1 << 1)
45 * Defines that were not part of e1000_hw.h as they are not used by the FreeBSD
48 #define E1000_ADVTXD_POPTS_TXSM 0x00000200 /* L4 Checksum offload request */
49 #define E1000_ADVTXD_POPTS_IXSM 0x00000100 /* IP Checksum offload request */
50 #define E1000_ADVTXD_TUCMD_L4T_RSV 0x00001800 /* L4 Packet TYPE of Reserved */
51 #define E1000_RXD_STAT_TMST 0x10000 /* Timestamped Packet indication */
52 #define E1000_RXD_ERR_CKSUM_BIT 29
53 #define E1000_RXD_ERR_CKSUM_MSK 3
54 #define E1000_ADVTXD_MACLEN_SHIFT 9 /* Bit shift for l2_len */
55 #define E1000_CTRL_EXT_EXTEND_VLAN (1<<26) /* EXTENDED VLAN */
56 #define IGB_VFTA_SIZE 128
58 #define IGB_MAX_RX_QUEUE_NUM 8
59 #define IGB_MAX_RX_QUEUE_NUM_82576 16
61 #define E1000_SYN_FILTER_ENABLE 0x00000001 /* syn filter enable field */
62 #define E1000_SYN_FILTER_QUEUE 0x0000000E /* syn filter queue field */
63 #define E1000_SYN_FILTER_QUEUE_SHIFT 1 /* syn filter queue field */
64 #define E1000_RFCTL_SYNQFP 0x00080000 /* SYNQFP in RFCTL register */
66 #define E1000_ETQF_ETHERTYPE 0x0000FFFF
67 #define E1000_ETQF_QUEUE 0x00070000
68 #define E1000_ETQF_QUEUE_SHIFT 16
69 #define E1000_MAX_ETQF_FILTERS 8
71 #define E1000_IMIR_DSTPORT 0x0000FFFF
72 #define E1000_IMIR_PRIORITY 0xE0000000
73 #define E1000_MAX_TTQF_FILTERS 8
74 #define E1000_2TUPLE_MAX_PRI 7
76 #define E1000_MAX_FLEX_FILTERS 8
77 #define E1000_MAX_FHFT 4
78 #define E1000_MAX_FHFT_EXT 4
79 #define E1000_FHFT_SIZE_IN_DWD 64
80 #define E1000_MAX_FLEX_FILTER_PRI 7
81 #define E1000_MAX_FLEX_FILTER_LEN 128
82 #define E1000_MAX_FLEX_FILTER_DWDS \
83 (E1000_MAX_FLEX_FILTER_LEN / sizeof(uint32_t))
84 #define E1000_FLEX_FILTERS_MASK_SIZE \
85 (E1000_MAX_FLEX_FILTER_DWDS / 4)
86 #define E1000_FHFT_QUEUEING_LEN 0x0000007F
87 #define E1000_FHFT_QUEUEING_QUEUE 0x00000700
88 #define E1000_FHFT_QUEUEING_PRIO 0x00070000
89 #define E1000_FHFT_QUEUEING_OFFSET 0xFC
90 #define E1000_FHFT_QUEUEING_QUEUE_SHIFT 8
91 #define E1000_FHFT_QUEUEING_PRIO_SHIFT 16
92 #define E1000_WUFC_FLEX_HQ 0x00004000
94 #define E1000_SPQF_SRCPORT 0x0000FFFF
96 #define E1000_MAX_FTQF_FILTERS 8
97 #define E1000_FTQF_PROTOCOL_MASK 0x000000FF
98 #define E1000_FTQF_5TUPLE_MASK_SHIFT 28
99 #define E1000_FTQF_QUEUE_MASK 0x03ff0000
100 #define E1000_FTQF_QUEUE_SHIFT 16
101 #define E1000_FTQF_QUEUE_ENABLE 0x00000100
103 #define IGB_RSS_OFFLOAD_ALL ( \
105 ETH_RSS_NONFRAG_IPV4_TCP | \
106 ETH_RSS_NONFRAG_IPV4_UDP | \
108 ETH_RSS_NONFRAG_IPV6_TCP | \
109 ETH_RSS_NONFRAG_IPV6_UDP | \
111 ETH_RSS_IPV6_TCP_EX | \
115 * Maximum number of Ring Descriptors.
117 * Since RDLEN/TDLEN should be multiple of 128 bytes, the number of ring
118 * desscriptors should meet the following condition:
119 * (num_ring_desc * sizeof(struct e1000_rx/tx_desc)) % 128 == 0
121 #define E1000_MIN_RING_DESC 32
122 #define E1000_MAX_RING_DESC 4096
125 * TDBA/RDBA should be aligned on 16 byte boundary. But TDLEN/RDLEN should be
126 * multiple of 128 bytes. So we align TDBA/RDBA on 128 byte boundary.
127 * This will also optimize cache line size effect.
128 * H/W supports up to cache line size 128.
130 #define E1000_ALIGN 128
132 #define IGB_RXD_ALIGN (E1000_ALIGN / sizeof(union e1000_adv_rx_desc))
133 #define IGB_TXD_ALIGN (E1000_ALIGN / sizeof(union e1000_adv_tx_desc))
135 #define EM_RXD_ALIGN (E1000_ALIGN / sizeof(struct e1000_rx_desc))
136 #define EM_TXD_ALIGN (E1000_ALIGN / sizeof(struct e1000_data_desc))
138 #define E1000_MISC_VEC_ID RTE_INTR_VEC_ZERO_OFFSET
139 #define E1000_RX_VEC_START RTE_INTR_VEC_RXTX_OFFSET
141 #define IGB_TX_MAX_SEG UINT8_MAX
142 #define IGB_TX_MAX_MTU_SEG UINT8_MAX
143 #define EM_TX_MAX_SEG UINT8_MAX
144 #define EM_TX_MAX_MTU_SEG UINT8_MAX
146 #define MAC_TYPE_FILTER_SUP(type) do {\
147 if ((type) != e1000_82580 && (type) != e1000_i350 &&\
148 (type) != e1000_82576 && (type) != e1000_i210 &&\
149 (type) != e1000_i211)\
153 #define MAC_TYPE_FILTER_SUP_EXT(type) do {\
154 if ((type) != e1000_82580 && (type) != e1000_i350 &&\
155 (type) != e1000_i210 && (type) != e1000_i211)\
159 /* structure for interrupt relative data */
160 struct e1000_interrupt {
165 /* local vfta copy */
167 uint32_t vfta[IGB_VFTA_SIZE];
171 * VF data which used by PF host only
173 #define E1000_MAX_VF_MC_ENTRIES 30
174 struct e1000_vf_info {
175 uint8_t vf_mac_addresses[ETHER_ADDR_LEN];
176 uint16_t vf_mc_hashes[E1000_MAX_VF_MC_ENTRIES];
177 uint16_t num_vf_mc_hashes;
178 uint16_t default_vf_vlan_id;
179 uint16_t vlans_enabled;
185 TAILQ_HEAD(e1000_flex_filter_list, e1000_flex_filter);
187 struct e1000_flex_filter_info {
189 uint32_t dwords[E1000_MAX_FLEX_FILTER_DWDS]; /* flex bytes in dword. */
190 /* if mask bit is 1b, do not compare corresponding byte in dwords. */
191 uint8_t mask[E1000_FLEX_FILTERS_MASK_SIZE];
195 /* Flex filter structure */
196 struct e1000_flex_filter {
197 TAILQ_ENTRY(e1000_flex_filter) entries;
198 uint16_t index; /* index of flex filter */
199 struct e1000_flex_filter_info filter_info;
200 uint16_t queue; /* rx queue assigned to */
203 TAILQ_HEAD(e1000_5tuple_filter_list, e1000_5tuple_filter);
204 TAILQ_HEAD(e1000_2tuple_filter_list, e1000_2tuple_filter);
206 struct e1000_5tuple_filter_info {
211 uint8_t proto; /* l4 protocol. */
212 /* the packet matched above 5tuple and contain any set bit will hit this filter. */
214 uint8_t priority; /* seven levels (001b-111b), 111b is highest,
215 used when more than one filter matches. */
216 uint8_t dst_ip_mask:1, /* if mask is 1b, do not compare dst ip. */
217 src_ip_mask:1, /* if mask is 1b, do not compare src ip. */
218 dst_port_mask:1, /* if mask is 1b, do not compare dst port. */
219 src_port_mask:1, /* if mask is 1b, do not compare src port. */
220 proto_mask:1; /* if mask is 1b, do not compare protocol. */
223 struct e1000_2tuple_filter_info {
225 uint8_t proto; /* l4 protocol. */
226 /* the packet matched above 2tuple and contain any set bit will hit this filter. */
228 uint8_t priority; /* seven levels (001b-111b), 111b is highest,
229 used when more than one filter matches. */
230 uint8_t dst_ip_mask:1, /* if mask is 1b, do not compare dst ip. */
231 src_ip_mask:1, /* if mask is 1b, do not compare src ip. */
232 dst_port_mask:1, /* if mask is 1b, do not compare dst port. */
233 src_port_mask:1, /* if mask is 1b, do not compare src port. */
234 proto_mask:1; /* if mask is 1b, do not compare protocol. */
237 /* 5tuple filter structure */
238 struct e1000_5tuple_filter {
239 TAILQ_ENTRY(e1000_5tuple_filter) entries;
240 uint16_t index; /* the index of 5tuple filter */
241 struct e1000_5tuple_filter_info filter_info;
242 uint16_t queue; /* rx queue assigned to */
245 /* 2tuple filter structure */
246 struct e1000_2tuple_filter {
247 TAILQ_ENTRY(e1000_2tuple_filter) entries;
248 uint16_t index; /* the index of 2tuple filter */
249 struct e1000_2tuple_filter_info filter_info;
250 uint16_t queue; /* rx queue assigned to */
253 /* ethertype filter structure */
254 struct igb_ethertype_filter {
260 * Structure to store filters'info.
262 struct e1000_filter_info {
263 uint8_t ethertype_mask; /* Bit mask for every used ethertype filter */
264 /* store used ethertype filters*/
265 struct igb_ethertype_filter ethertype_filters[E1000_MAX_ETQF_FILTERS];
266 uint8_t flex_mask; /* Bit mask for every used flex filter */
267 struct e1000_flex_filter_list flex_list;
268 /* Bit mask for every used 5tuple filter */
269 uint8_t fivetuple_mask;
270 struct e1000_5tuple_filter_list fivetuple_list;
271 /* Bit mask for every used 2tuple filter */
272 uint8_t twotuple_mask;
273 struct e1000_2tuple_filter_list twotuple_list;
274 /* store the SYN filter info */
279 * Structure to store private data for each driver instance (for each port).
281 struct e1000_adapter {
283 struct e1000_hw_stats stats;
284 struct e1000_interrupt intr;
285 struct e1000_vfta shadow_vfta;
286 struct e1000_vf_info *vfdata;
287 struct e1000_filter_info filter;
289 struct rte_timecounter systime_tc;
290 struct rte_timecounter rx_tstamp_tc;
291 struct rte_timecounter tx_tstamp_tc;
294 #define E1000_DEV_PRIVATE(adapter) \
295 ((struct e1000_adapter *)adapter)
297 #define E1000_DEV_PRIVATE_TO_HW(adapter) \
298 (&((struct e1000_adapter *)adapter)->hw)
300 #define E1000_DEV_PRIVATE_TO_STATS(adapter) \
301 (&((struct e1000_adapter *)adapter)->stats)
303 #define E1000_DEV_PRIVATE_TO_INTR(adapter) \
304 (&((struct e1000_adapter *)adapter)->intr)
306 #define E1000_DEV_PRIVATE_TO_VFTA(adapter) \
307 (&((struct e1000_adapter *)adapter)->shadow_vfta)
309 #define E1000_DEV_PRIVATE_TO_P_VFDATA(adapter) \
310 (&((struct e1000_adapter *)adapter)->vfdata)
312 #define E1000_DEV_PRIVATE_TO_FILTER_INFO(adapter) \
313 (&((struct e1000_adapter *)adapter)->filter)
316 enum rte_filter_type filter_type;
320 /* ntuple filter list structure */
321 struct igb_ntuple_filter_ele {
322 TAILQ_ENTRY(igb_ntuple_filter_ele) entries;
323 struct rte_eth_ntuple_filter filter_info;
326 /* ethertype filter list structure */
327 struct igb_ethertype_filter_ele {
328 TAILQ_ENTRY(igb_ethertype_filter_ele) entries;
329 struct rte_eth_ethertype_filter filter_info;
332 /* syn filter list structure */
333 struct igb_eth_syn_filter_ele {
334 TAILQ_ENTRY(igb_eth_syn_filter_ele) entries;
335 struct rte_eth_syn_filter filter_info;
338 /* flex filter list structure */
339 struct igb_flex_filter_ele {
340 TAILQ_ENTRY(igb_flex_filter_ele) entries;
341 struct rte_eth_flex_filter filter_info;
344 /* igb_flow memory list structure */
345 struct igb_flow_mem {
346 TAILQ_ENTRY(igb_flow_mem) entries;
347 struct rte_flow *flow;
348 struct rte_eth_dev *dev;
351 TAILQ_HEAD(igb_ntuple_filter_list, igb_ntuple_filter_ele);
352 struct igb_ntuple_filter_list igb_filter_ntuple_list;
353 TAILQ_HEAD(igb_ethertype_filter_list, igb_ethertype_filter_ele);
354 struct igb_ethertype_filter_list igb_filter_ethertype_list;
355 TAILQ_HEAD(igb_syn_filter_list, igb_eth_syn_filter_ele);
356 struct igb_syn_filter_list igb_filter_syn_list;
357 TAILQ_HEAD(igb_flex_filter_list, igb_flex_filter_ele);
358 struct igb_flex_filter_list igb_filter_flex_list;
359 TAILQ_HEAD(igb_flow_mem_list, igb_flow_mem);
360 struct igb_flow_mem_list igb_flow_list;
362 extern const struct rte_flow_ops igb_flow_ops;
365 * RX/TX IGB function prototypes
367 void eth_igb_tx_queue_release(void *txq);
368 void eth_igb_rx_queue_release(void *rxq);
369 void igb_dev_clear_queues(struct rte_eth_dev *dev);
370 void igb_dev_free_queues(struct rte_eth_dev *dev);
372 int eth_igb_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
373 uint16_t nb_rx_desc, unsigned int socket_id,
374 const struct rte_eth_rxconf *rx_conf,
375 struct rte_mempool *mb_pool);
377 uint32_t eth_igb_rx_queue_count(struct rte_eth_dev *dev,
378 uint16_t rx_queue_id);
380 int eth_igb_rx_descriptor_done(void *rx_queue, uint16_t offset);
382 int eth_igb_rx_descriptor_status(void *rx_queue, uint16_t offset);
383 int eth_igb_tx_descriptor_status(void *tx_queue, uint16_t offset);
385 int eth_igb_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
386 uint16_t nb_tx_desc, unsigned int socket_id,
387 const struct rte_eth_txconf *tx_conf);
389 int eth_igb_tx_done_cleanup(void *txq, uint32_t free_cnt);
391 int eth_igb_rx_init(struct rte_eth_dev *dev);
393 void eth_igb_tx_init(struct rte_eth_dev *dev);
395 uint16_t eth_igb_xmit_pkts(void *txq, struct rte_mbuf **tx_pkts,
398 uint16_t eth_igb_prep_pkts(void *txq, struct rte_mbuf **tx_pkts,
401 uint16_t eth_igb_recv_pkts(void *rxq, struct rte_mbuf **rx_pkts,
404 uint16_t eth_igb_recv_scattered_pkts(void *rxq,
405 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
407 int eth_igb_rss_hash_update(struct rte_eth_dev *dev,
408 struct rte_eth_rss_conf *rss_conf);
410 int eth_igb_rss_hash_conf_get(struct rte_eth_dev *dev,
411 struct rte_eth_rss_conf *rss_conf);
413 int eth_igbvf_rx_init(struct rte_eth_dev *dev);
415 void eth_igbvf_tx_init(struct rte_eth_dev *dev);
418 * misc function prototypes
420 void igb_pf_host_init(struct rte_eth_dev *eth_dev);
422 void igb_pf_mbx_process(struct rte_eth_dev *eth_dev);
424 int igb_pf_host_configure(struct rte_eth_dev *eth_dev);
426 void igb_rxq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
427 struct rte_eth_rxq_info *qinfo);
429 void igb_txq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
430 struct rte_eth_txq_info *qinfo);
433 * RX/TX EM function prototypes
435 void eth_em_tx_queue_release(void *txq);
436 void eth_em_rx_queue_release(void *rxq);
438 void em_dev_clear_queues(struct rte_eth_dev *dev);
439 void em_dev_free_queues(struct rte_eth_dev *dev);
441 int eth_em_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
442 uint16_t nb_rx_desc, unsigned int socket_id,
443 const struct rte_eth_rxconf *rx_conf,
444 struct rte_mempool *mb_pool);
446 uint32_t eth_em_rx_queue_count(struct rte_eth_dev *dev,
447 uint16_t rx_queue_id);
449 int eth_em_rx_descriptor_done(void *rx_queue, uint16_t offset);
451 int eth_em_rx_descriptor_status(void *rx_queue, uint16_t offset);
452 int eth_em_tx_descriptor_status(void *tx_queue, uint16_t offset);
454 int eth_em_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
455 uint16_t nb_tx_desc, unsigned int socket_id,
456 const struct rte_eth_txconf *tx_conf);
458 int eth_em_rx_init(struct rte_eth_dev *dev);
460 void eth_em_tx_init(struct rte_eth_dev *dev);
462 uint16_t eth_em_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
465 uint16_t eth_em_prep_pkts(void *txq, struct rte_mbuf **tx_pkts,
468 uint16_t eth_em_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
471 uint16_t eth_em_recv_scattered_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
474 void em_rxq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
475 struct rte_eth_rxq_info *qinfo);
477 void em_txq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
478 struct rte_eth_txq_info *qinfo);
480 void igb_pf_host_uninit(struct rte_eth_dev *dev);
482 void igb_filterlist_flush(struct rte_eth_dev *dev);
483 int igb_delete_5tuple_filter_82576(struct rte_eth_dev *dev,
484 struct e1000_5tuple_filter *filter);
485 int igb_delete_2tuple_filter(struct rte_eth_dev *dev,
486 struct e1000_2tuple_filter *filter);
487 void igb_remove_flex_filter(struct rte_eth_dev *dev,
488 struct e1000_flex_filter *filter);
489 int igb_ethertype_filter_remove(struct e1000_filter_info *filter_info,
491 int igb_add_del_ntuple_filter(struct rte_eth_dev *dev,
492 struct rte_eth_ntuple_filter *ntuple_filter, bool add);
493 int igb_add_del_ethertype_filter(struct rte_eth_dev *dev,
494 struct rte_eth_ethertype_filter *filter,
496 int eth_igb_syn_filter_set(struct rte_eth_dev *dev,
497 struct rte_eth_syn_filter *filter,
499 int eth_igb_add_del_flex_filter(struct rte_eth_dev *dev,
500 struct rte_eth_flex_filter *filter,
502 #endif /* _E1000_ETHDEV_H_ */