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 _IXGBE_ETHDEV_H_
35 #define _IXGBE_ETHDEV_H_
36 #include "base/ixgbe_dcb.h"
37 #include "base/ixgbe_dcb_82599.h"
38 #include "base/ixgbe_dcb_82598.h"
39 #include "ixgbe_bypass.h"
42 /* need update link, bit flag */
43 #define IXGBE_FLAG_NEED_LINK_UPDATE (uint32_t)(1 << 0)
44 #define IXGBE_FLAG_MAILBOX (uint32_t)(1 << 1)
45 #define IXGBE_FLAG_PHY_INTERRUPT (uint32_t)(1 << 2)
48 * Defines that were not part of ixgbe_type.h as they are not used by the
51 #define IXGBE_ADVTXD_MAC_1588 0x00080000 /* IEEE1588 Timestamp packet */
52 #define IXGBE_RXD_STAT_TMST 0x10000 /* Timestamped Packet indication */
53 #define IXGBE_ADVTXD_TUCMD_L4T_RSV 0x00001800 /* L4 Packet TYPE, resvd */
54 #define IXGBE_RXDADV_ERR_CKSUM_BIT 30
55 #define IXGBE_RXDADV_ERR_CKSUM_MSK 3
56 #define IXGBE_ADVTXD_MACLEN_SHIFT 9 /* Bit shift for l2_len */
57 #define IXGBE_NB_STAT_MAPPING_REGS 32
58 #define IXGBE_EXTENDED_VLAN (uint32_t)(1 << 26) /* EXTENDED VLAN ENABLE */
59 #define IXGBE_VFTA_SIZE 128
60 #define IXGBE_VLAN_TAG_SIZE 4
61 #define IXGBE_MAX_RX_QUEUE_NUM 128
62 #define IXGBE_MAX_INTR_QUEUE_NUM 15
63 #define IXGBE_VMDQ_DCB_NB_QUEUES IXGBE_MAX_RX_QUEUE_NUM
64 #define IXGBE_DCB_NB_QUEUES IXGBE_MAX_RX_QUEUE_NUM
65 #define IXGBE_NONE_MODE_TX_NB_QUEUES 64
68 #define NBBY 8 /* number of bits in a byte */
70 #define IXGBE_HWSTRIP_BITMAP_SIZE (IXGBE_MAX_RX_QUEUE_NUM / (sizeof(uint32_t) * NBBY))
72 /* EITR Inteval is in 2048ns uinits for 1G and 10G link */
73 #define IXGBE_EITR_INTERVAL_UNIT_NS 2048
74 #define IXGBE_EITR_ITR_INT_SHIFT 3
75 #define IXGBE_EITR_INTERVAL_US(us) \
76 (((us) * 1000 / IXGBE_EITR_INTERVAL_UNIT_NS << IXGBE_EITR_ITR_INT_SHIFT) & \
77 IXGBE_EITR_ITR_INT_MASK)
80 /* Loopback operation modes */
81 /* 82599 specific loopback operation types */
82 #define IXGBE_LPBK_82599_NONE 0x0 /* Default value. Loopback is disabled. */
83 #define IXGBE_LPBK_82599_TX_RX 0x1 /* Tx->Rx loopback operation is enabled. */
85 #define IXGBE_MAX_JUMBO_FRAME_SIZE 0x2600 /* Maximum Jumbo frame size. */
87 #define IXGBE_RTTBCNRC_RF_INT_MASK_BASE 0x000003FF
88 #define IXGBE_RTTBCNRC_RF_INT_MASK_M \
89 (IXGBE_RTTBCNRC_RF_INT_MASK_BASE << IXGBE_RTTBCNRC_RF_INT_SHIFT)
91 #define IXGBE_MAX_QUEUE_NUM_PER_VF 8
93 #define IXGBE_SYN_FILTER_ENABLE 0x00000001 /* syn filter enable field */
94 #define IXGBE_SYN_FILTER_QUEUE 0x000000FE /* syn filter queue field */
95 #define IXGBE_SYN_FILTER_QUEUE_SHIFT 1 /* syn filter queue field shift */
96 #define IXGBE_SYN_FILTER_SYNQFP 0x80000000 /* syn filter SYNQFP */
98 #define IXGBE_ETQF_UP 0x00070000 /* ethertype filter priority field */
99 #define IXGBE_ETQF_SHIFT 16
100 #define IXGBE_ETQF_UP_EN 0x00080000
101 #define IXGBE_ETQF_ETHERTYPE 0x0000FFFF /* ethertype filter ethertype field */
102 #define IXGBE_ETQF_MAX_PRI 7
104 #define IXGBE_SDPQF_DSTPORT 0xFFFF0000 /* dst port field */
105 #define IXGBE_SDPQF_DSTPORT_SHIFT 16 /* dst port field shift */
106 #define IXGBE_SDPQF_SRCPORT 0x0000FFFF /* src port field */
108 #define IXGBE_L34T_IMIR_SIZE_BP 0x00001000
109 #define IXGBE_L34T_IMIR_RESERVE 0x00080000 /* bit 13 to 19 must be set to 1000000b. */
110 #define IXGBE_L34T_IMIR_LLI 0x00100000
111 #define IXGBE_L34T_IMIR_QUEUE 0x0FE00000
112 #define IXGBE_L34T_IMIR_QUEUE_SHIFT 21
113 #define IXGBE_5TUPLE_MAX_PRI 7
114 #define IXGBE_5TUPLE_MIN_PRI 1
116 #define IXGBE_RSS_OFFLOAD_ALL ( \
118 ETH_RSS_NONFRAG_IPV4_TCP | \
119 ETH_RSS_NONFRAG_IPV4_UDP | \
121 ETH_RSS_NONFRAG_IPV6_TCP | \
122 ETH_RSS_NONFRAG_IPV6_UDP | \
124 ETH_RSS_IPV6_TCP_EX | \
127 #define IXGBE_VF_IRQ_ENABLE_MASK 3 /* vf irq enable mask */
128 #define IXGBE_VF_MAXMSIVECTOR 1
130 #define IXGBE_MISC_VEC_ID RTE_INTR_VEC_ZERO_OFFSET
131 #define IXGBE_RX_VEC_START RTE_INTR_VEC_RXTX_OFFSET
134 * Information about the fdir mode.
137 struct ixgbe_hw_fdir_mask {
138 uint16_t vlan_tci_mask;
139 uint32_t src_ipv4_mask;
140 uint32_t dst_ipv4_mask;
141 uint16_t src_ipv6_mask;
142 uint16_t dst_ipv6_mask;
143 uint16_t src_port_mask;
144 uint16_t dst_port_mask;
145 uint16_t flex_bytes_mask;
146 uint8_t mac_addr_byte_mask;
147 uint32_t tunnel_id_mask;
148 uint8_t tunnel_type_mask;
151 struct ixgbe_hw_fdir_info {
152 struct ixgbe_hw_fdir_mask mask;
153 uint8_t flex_bytes_offset;
164 /* structure for interrupt relative data */
165 struct ixgbe_interrupt {
168 /*to save original mask during delayed handler */
169 uint32_t mask_original;
172 struct ixgbe_stat_mapping_registers {
173 uint32_t tqsm[IXGBE_NB_STAT_MAPPING_REGS];
174 uint32_t rqsmr[IXGBE_NB_STAT_MAPPING_REGS];
178 uint32_t vfta[IXGBE_VFTA_SIZE];
181 struct ixgbe_hwstrip {
182 uint32_t bitmap[IXGBE_HWSTRIP_BITMAP_SIZE];
186 * VF data which used by PF host only
188 #define IXGBE_MAX_VF_MC_ENTRIES 30
189 #define IXGBE_MAX_MR_RULE_ENTRIES 4 /* number of mirroring rules supported */
190 #define IXGBE_MAX_UTA 128
192 struct ixgbe_uta_info {
193 uint8_t uc_filter_type;
195 uint32_t uta_shadow[IXGBE_MAX_UTA];
198 #define IXGBE_MAX_MIRROR_RULES 4 /* Maximum nb. of mirror rules. */
200 struct ixgbe_mirror_info {
201 struct rte_eth_mirror_conf mr_conf[IXGBE_MAX_MIRROR_RULES];
202 /**< store PF mirror rules configuration*/
205 struct ixgbe_vf_info {
206 uint8_t vf_mac_addresses[ETHER_ADDR_LEN];
207 uint16_t vf_mc_hashes[IXGBE_MAX_VF_MC_ENTRIES];
208 uint16_t num_vf_mc_hashes;
209 uint16_t default_vf_vlan_id;
210 uint16_t vlans_enabled;
212 uint16_t tx_rate[IXGBE_MAX_QUEUE_NUM_PER_VF];
214 uint8_t spoofchk_enabled;
219 * Possible l4type of 5tuple filters.
221 enum ixgbe_5tuple_protocol {
222 IXGBE_FILTER_PROTOCOL_TCP = 0,
223 IXGBE_FILTER_PROTOCOL_UDP,
224 IXGBE_FILTER_PROTOCOL_SCTP,
225 IXGBE_FILTER_PROTOCOL_NONE,
228 TAILQ_HEAD(ixgbe_5tuple_filter_list, ixgbe_5tuple_filter);
230 struct ixgbe_5tuple_filter_info {
235 enum ixgbe_5tuple_protocol proto; /* l4 protocol. */
236 uint8_t priority; /* seven levels (001b-111b), 111b is highest,
237 used when more than one filter matches. */
238 uint8_t dst_ip_mask:1, /* if mask is 1b, do not compare dst ip. */
239 src_ip_mask:1, /* if mask is 1b, do not compare src ip. */
240 dst_port_mask:1, /* if mask is 1b, do not compare dst port. */
241 src_port_mask:1, /* if mask is 1b, do not compare src port. */
242 proto_mask:1; /* if mask is 1b, do not compare protocol. */
245 /* 5tuple filter structure */
246 struct ixgbe_5tuple_filter {
247 TAILQ_ENTRY(ixgbe_5tuple_filter) entries;
248 uint16_t index; /* the index of 5tuple filter */
249 struct ixgbe_5tuple_filter_info filter_info;
250 uint16_t queue; /* rx queue assigned to */
253 #define IXGBE_5TUPLE_ARRAY_SIZE \
254 (RTE_ALIGN(IXGBE_MAX_FTQF_FILTERS, (sizeof(uint32_t) * NBBY)) / \
255 (sizeof(uint32_t) * NBBY))
258 * Structure to store filters' info.
260 struct ixgbe_filter_info {
261 uint8_t ethertype_mask; /* Bit mask for every used ethertype filter */
262 /* store used ethertype filters*/
263 uint16_t ethertype_filters[IXGBE_MAX_ETQF_FILTERS];
264 /* Bit mask for every used 5tuple filter */
265 uint32_t fivetuple_mask[IXGBE_5TUPLE_ARRAY_SIZE];
266 struct ixgbe_5tuple_filter_list fivetuple_list;
270 * Structure to store private data for each driver instance (for each port).
272 struct ixgbe_adapter {
274 struct ixgbe_hw_stats stats;
275 struct ixgbe_hw_fdir_info fdir;
276 struct ixgbe_interrupt intr;
277 struct ixgbe_stat_mapping_registers stat_mappings;
278 struct ixgbe_vfta shadow_vfta;
279 struct ixgbe_hwstrip hwstrip;
280 struct ixgbe_dcb_config dcb_config;
281 struct ixgbe_mirror_info mr_data;
282 struct ixgbe_vf_info *vfdata;
283 struct ixgbe_uta_info uta_info;
284 #ifdef RTE_NIC_BYPASS
285 struct ixgbe_bypass_info bps;
286 #endif /* RTE_NIC_BYPASS */
287 struct ixgbe_filter_info filter;
289 bool rx_bulk_alloc_allowed;
291 struct rte_timecounter systime_tc;
292 struct rte_timecounter rx_tstamp_tc;
293 struct rte_timecounter tx_tstamp_tc;
296 #define IXGBE_DEV_PRIVATE_TO_HW(adapter)\
297 (&((struct ixgbe_adapter *)adapter)->hw)
299 #define IXGBE_DEV_PRIVATE_TO_STATS(adapter) \
300 (&((struct ixgbe_adapter *)adapter)->stats)
302 #define IXGBE_DEV_PRIVATE_TO_INTR(adapter) \
303 (&((struct ixgbe_adapter *)adapter)->intr)
305 #define IXGBE_DEV_PRIVATE_TO_FDIR_INFO(adapter) \
306 (&((struct ixgbe_adapter *)adapter)->fdir)
308 #define IXGBE_DEV_PRIVATE_TO_STAT_MAPPINGS(adapter) \
309 (&((struct ixgbe_adapter *)adapter)->stat_mappings)
311 #define IXGBE_DEV_PRIVATE_TO_VFTA(adapter) \
312 (&((struct ixgbe_adapter *)adapter)->shadow_vfta)
314 #define IXGBE_DEV_PRIVATE_TO_HWSTRIP_BITMAP(adapter) \
315 (&((struct ixgbe_adapter *)adapter)->hwstrip)
317 #define IXGBE_DEV_PRIVATE_TO_DCB_CFG(adapter) \
318 (&((struct ixgbe_adapter *)adapter)->dcb_config)
320 #define IXGBE_DEV_PRIVATE_TO_P_VFDATA(adapter) \
321 (&((struct ixgbe_adapter *)adapter)->vfdata)
323 #define IXGBE_DEV_PRIVATE_TO_PFDATA(adapter) \
324 (&((struct ixgbe_adapter *)adapter)->mr_data)
326 #define IXGBE_DEV_PRIVATE_TO_UTA(adapter) \
327 (&((struct ixgbe_adapter *)adapter)->uta_info)
329 #define IXGBE_DEV_PRIVATE_TO_FILTER_INFO(adapter) \
330 (&((struct ixgbe_adapter *)adapter)->filter)
333 * RX/TX function prototypes
335 void ixgbe_dev_clear_queues(struct rte_eth_dev *dev);
337 void ixgbe_dev_free_queues(struct rte_eth_dev *dev);
339 void ixgbe_dev_rx_queue_release(void *rxq);
341 void ixgbe_dev_tx_queue_release(void *txq);
343 int ixgbe_dev_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
344 uint16_t nb_rx_desc, unsigned int socket_id,
345 const struct rte_eth_rxconf *rx_conf,
346 struct rte_mempool *mb_pool);
348 int ixgbe_dev_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
349 uint16_t nb_tx_desc, unsigned int socket_id,
350 const struct rte_eth_txconf *tx_conf);
352 uint32_t ixgbe_dev_rx_queue_count(struct rte_eth_dev *dev,
353 uint16_t rx_queue_id);
355 int ixgbe_dev_rx_descriptor_done(void *rx_queue, uint16_t offset);
356 int ixgbevf_dev_rx_descriptor_done(void *rx_queue, uint16_t offset);
358 int ixgbe_dev_rx_init(struct rte_eth_dev *dev);
360 void ixgbe_dev_tx_init(struct rte_eth_dev *dev);
362 int ixgbe_dev_rxtx_start(struct rte_eth_dev *dev);
364 int ixgbe_dev_rx_queue_start(struct rte_eth_dev *dev, uint16_t rx_queue_id);
366 int ixgbe_dev_rx_queue_stop(struct rte_eth_dev *dev, uint16_t rx_queue_id);
368 int ixgbe_dev_tx_queue_start(struct rte_eth_dev *dev, uint16_t tx_queue_id);
370 int ixgbe_dev_tx_queue_stop(struct rte_eth_dev *dev, uint16_t tx_queue_id);
372 void ixgbe_rxq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
373 struct rte_eth_rxq_info *qinfo);
375 void ixgbe_txq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
376 struct rte_eth_txq_info *qinfo);
378 int ixgbevf_dev_rx_init(struct rte_eth_dev *dev);
380 void ixgbevf_dev_tx_init(struct rte_eth_dev *dev);
382 void ixgbevf_dev_rxtx_start(struct rte_eth_dev *dev);
384 uint16_t ixgbe_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
387 uint16_t ixgbe_recv_pkts_bulk_alloc(void *rx_queue, struct rte_mbuf **rx_pkts,
390 uint16_t ixgbe_recv_pkts_lro_single_alloc(void *rx_queue,
391 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
392 uint16_t ixgbe_recv_pkts_lro_bulk_alloc(void *rx_queue,
393 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
395 uint16_t ixgbe_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
398 uint16_t ixgbe_xmit_pkts_simple(void *tx_queue, struct rte_mbuf **tx_pkts,
401 int ixgbe_dev_rss_hash_update(struct rte_eth_dev *dev,
402 struct rte_eth_rss_conf *rss_conf);
404 int ixgbe_dev_rss_hash_conf_get(struct rte_eth_dev *dev,
405 struct rte_eth_rss_conf *rss_conf);
407 uint16_t ixgbe_reta_size_get(enum ixgbe_mac_type mac_type);
409 uint32_t ixgbe_reta_reg_get(enum ixgbe_mac_type mac_type, uint16_t reta_idx);
411 uint32_t ixgbe_mrqc_reg_get(enum ixgbe_mac_type mac_type);
413 uint32_t ixgbe_rssrk_reg_get(enum ixgbe_mac_type mac_type, uint8_t i);
415 bool ixgbe_rss_update_sp(enum ixgbe_mac_type mac_type);
418 * Flow director function prototypes
420 int ixgbe_fdir_configure(struct rte_eth_dev *dev);
422 void ixgbe_configure_dcb(struct rte_eth_dev *dev);
425 * misc function prototypes
427 void ixgbe_vlan_hw_filter_enable(struct rte_eth_dev *dev);
429 void ixgbe_vlan_hw_filter_disable(struct rte_eth_dev *dev);
431 void ixgbe_vlan_hw_strip_enable_all(struct rte_eth_dev *dev);
433 void ixgbe_vlan_hw_strip_disable_all(struct rte_eth_dev *dev);
435 void ixgbe_pf_host_init(struct rte_eth_dev *eth_dev);
437 void ixgbe_pf_host_uninit(struct rte_eth_dev *eth_dev);
439 void ixgbe_pf_mbx_process(struct rte_eth_dev *eth_dev);
441 int ixgbe_pf_host_configure(struct rte_eth_dev *eth_dev);
443 uint32_t ixgbe_convert_vm_rx_mask_to_val(uint16_t rx_mask, uint32_t orig_val);
445 int ixgbe_fdir_ctrl_func(struct rte_eth_dev *dev,
446 enum rte_filter_op filter_op, void *arg);
447 #endif /* _IXGBE_ETHDEV_H_ */