4 * Copyright(c) 2010-2014 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 "ixgbe/ixgbe_dcb.h"
37 #include "ixgbe/ixgbe_dcb_82599.h"
38 #include "ixgbe/ixgbe_dcb_82598.h"
39 #include "ixgbe_bypass.h"
41 /* need update link, bit flag */
42 #define IXGBE_FLAG_NEED_LINK_UPDATE (uint32_t)(1 << 0)
43 #define IXGBE_FLAG_MAILBOX (uint32_t)(1 << 1)
46 * Defines that were not part of ixgbe_type.h as they are not used by the
49 #define IXGBE_ADVTXD_MAC_1588 0x00080000 /* IEEE1588 Timestamp packet */
50 #define IXGBE_RXD_STAT_TMST 0x10000 /* Timestamped Packet indication */
51 #define IXGBE_ADVTXD_TUCMD_L4T_RSV 0x00001800 /* L4 Packet TYPE, resvd */
52 #define IXGBE_RXDADV_ERR_CKSUM_BIT 30
53 #define IXGBE_RXDADV_ERR_CKSUM_MSK 3
54 #define IXGBE_ADVTXD_MACLEN_SHIFT 9 /* Bit shift for l2_len */
55 #define IXGBE_NB_STAT_MAPPING_REGS 32
56 #define IXGBE_EXTENDED_VLAN (uint32_t)(1 << 26) /* EXTENDED VLAN ENABLE */
57 #define IXGBE_VFTA_SIZE 128
58 #define IXGBE_VLAN_TAG_SIZE 4
59 #define IXGBE_MAX_RX_QUEUE_NUM 128
61 #define NBBY 8 /* number of bits in a byte */
63 #define IXGBE_HWSTRIP_BITMAP_SIZE (IXGBE_MAX_RX_QUEUE_NUM / (sizeof(uint32_t) * NBBY))
65 /* Loopback operation modes */
66 /* 82599 specific loopback operation types */
67 #define IXGBE_LPBK_82599_NONE 0x0 /* Default value. Loopback is disabled. */
68 #define IXGBE_LPBK_82599_TX_RX 0x1 /* Tx->Rx loopback operation is enabled. */
70 #define IXGBE_MAX_JUMBO_FRAME_SIZE 0x2600 /* Maximum Jumbo frame size. */
72 #define IXGBE_RTTBCNRC_RF_INT_MASK_BASE 0x000003FF
73 #define IXGBE_RTTBCNRC_RF_INT_MASK_M \
74 (IXGBE_RTTBCNRC_RF_INT_MASK_BASE << IXGBE_RTTBCNRC_RF_INT_SHIFT)
76 #define IXGBE_MAX_QUEUE_NUM_PER_VF 8
78 #define IXGBE_SYN_FILTER_ENABLE 0x00000001 /* syn filter enable field */
79 #define IXGBE_SYN_FILTER_QUEUE 0x000000FE /* syn filter queue field */
80 #define IXGBE_SYN_FILTER_QUEUE_SHIFT 1 /* syn filter queue field shift */
81 #define IXGBE_SYN_FILTER_SYNQFP 0x80000000 /* syn filter SYNQFP */
83 #define IXGBE_ETQF_UP 0x00070000 /* ethertype filter priority field */
84 #define IXGBE_ETQF_SHIFT 16
85 #define IXGBE_ETQF_UP_EN 0x00080000
86 #define IXGBE_ETQF_ETHERTYPE 0x0000FFFF /* ethertype filter ethertype field */
87 #define IXGBE_ETQF_MAX_PRI 7
89 #define IXGBE_SDPQF_DSTPORT 0xFFFF0000 /* dst port field */
90 #define IXGBE_SDPQF_DSTPORT_SHIFT 16 /* dst port field shift */
91 #define IXGBE_SDPQF_SRCPORT 0x0000FFFF /* src port field */
93 #define IXGBE_L34T_IMIR_SIZE_BP 0x00001000
94 #define IXGBE_L34T_IMIR_RESERVE 0x00080000 /* bit 13 to 19 must be set to 1000000b. */
95 #define IXGBE_L34T_IMIR_LLI 0x00100000
96 #define IXGBE_L34T_IMIR_QUEUE 0x0FE00000
97 #define IXGBE_L34T_IMIR_QUEUE_SHIFT 21
98 #define IXGBE_5TUPLE_MAX_PRI 7
99 #define IXGBE_5TUPLE_MIN_PRI 1
101 #define IXGBE_RSS_OFFLOAD_ALL ( \
103 ETH_RSS_NONFRAG_IPV4_TCP | \
104 ETH_RSS_NONFRAG_IPV4_UDP | \
106 ETH_RSS_NONFRAG_IPV6_TCP | \
107 ETH_RSS_NONFRAG_IPV6_UDP | \
109 ETH_RSS_IPV6_TCP_EX | \
113 * Information about the fdir mode.
116 struct ixgbe_hw_fdir_mask {
117 uint16_t vlan_tci_mask;
118 uint32_t src_ipv4_mask;
119 uint32_t dst_ipv4_mask;
120 uint16_t src_ipv6_mask;
121 uint16_t dst_ipv6_mask;
122 uint16_t src_port_mask;
123 uint16_t dst_port_mask;
124 uint16_t flex_bytes_mask;
127 struct ixgbe_hw_fdir_info {
128 struct ixgbe_hw_fdir_mask mask;
129 uint8_t flex_bytes_offset;
140 /* structure for interrupt relative data */
141 struct ixgbe_interrupt {
146 struct ixgbe_stat_mapping_registers {
147 uint32_t tqsm[IXGBE_NB_STAT_MAPPING_REGS];
148 uint32_t rqsmr[IXGBE_NB_STAT_MAPPING_REGS];
152 uint32_t vfta[IXGBE_VFTA_SIZE];
155 struct ixgbe_hwstrip {
156 uint32_t bitmap[IXGBE_HWSTRIP_BITMAP_SIZE];
160 * VF data which used by PF host only
162 #define IXGBE_MAX_VF_MC_ENTRIES 30
163 #define IXGBE_MAX_MR_RULE_ENTRIES 4 /* number of mirroring rules supported */
164 #define IXGBE_MAX_UTA 128
166 struct ixgbe_uta_info {
167 uint8_t uc_filter_type;
169 uint32_t uta_shadow[IXGBE_MAX_UTA];
172 struct ixgbe_mirror_info {
173 struct rte_eth_vmdq_mirror_conf mr_conf[ETH_VMDQ_NUM_MIRROR_RULE];
174 /**< store PF mirror rules configuration*/
177 struct ixgbe_vf_info {
178 uint8_t vf_mac_addresses[ETHER_ADDR_LEN];
179 uint16_t vf_mc_hashes[IXGBE_MAX_VF_MC_ENTRIES];
180 uint16_t num_vf_mc_hashes;
181 uint16_t default_vf_vlan_id;
182 uint16_t vlans_enabled;
184 uint16_t tx_rate[IXGBE_MAX_QUEUE_NUM_PER_VF];
186 uint8_t spoofchk_enabled;
191 * Possible l4type of 5tuple filters.
193 enum ixgbe_5tuple_protocol {
194 IXGBE_FILTER_PROTOCOL_TCP = 0,
195 IXGBE_FILTER_PROTOCOL_UDP,
196 IXGBE_FILTER_PROTOCOL_SCTP,
197 IXGBE_FILTER_PROTOCOL_NONE,
200 TAILQ_HEAD(ixgbe_5tuple_filter_list, ixgbe_5tuple_filter);
202 struct ixgbe_5tuple_filter_info {
207 enum ixgbe_5tuple_protocol proto; /* l4 protocol. */
208 uint8_t priority; /* seven levels (001b-111b), 111b is highest,
209 used when more than one filter matches. */
210 uint8_t dst_ip_mask:1, /* if mask is 1b, do not compare dst ip. */
211 src_ip_mask:1, /* if mask is 1b, do not compare src ip. */
212 dst_port_mask:1, /* if mask is 1b, do not compare dst port. */
213 src_port_mask:1, /* if mask is 1b, do not compare src port. */
214 proto_mask:1; /* if mask is 1b, do not compare protocol. */
217 /* 5tuple filter structure */
218 struct ixgbe_5tuple_filter {
219 TAILQ_ENTRY(ixgbe_5tuple_filter) entries;
220 uint16_t index; /* the index of 5tuple filter */
221 struct ixgbe_5tuple_filter_info filter_info;
222 uint16_t queue; /* rx queue assigned to */
225 #define IXGBE_5TUPLE_ARRAY_SIZE \
226 (RTE_ALIGN(IXGBE_MAX_FTQF_FILTERS, (sizeof(uint32_t) * NBBY)) / \
227 (sizeof(uint32_t) * NBBY))
230 * Structure to store filters' info.
232 struct ixgbe_filter_info {
233 uint8_t ethertype_mask; /* Bit mask for every used ethertype filter */
234 /* store used ethertype filters*/
235 uint16_t ethertype_filters[IXGBE_MAX_ETQF_FILTERS];
236 /* Bit mask for every used 5tuple filter */
237 uint32_t fivetuple_mask[IXGBE_5TUPLE_ARRAY_SIZE];
238 struct ixgbe_5tuple_filter_list fivetuple_list;
242 * Structure to store private data for each driver instance (for each port).
244 struct ixgbe_adapter {
246 struct ixgbe_hw_stats stats;
247 struct ixgbe_hw_fdir_info fdir;
248 struct ixgbe_interrupt intr;
249 struct ixgbe_stat_mapping_registers stat_mappings;
250 struct ixgbe_vfta shadow_vfta;
251 struct ixgbe_hwstrip hwstrip;
252 struct ixgbe_dcb_config dcb_config;
253 struct ixgbe_mirror_info mr_data;
254 struct ixgbe_vf_info *vfdata;
255 struct ixgbe_uta_info uta_info;
256 #ifdef RTE_NIC_BYPASS
257 struct ixgbe_bypass_info bps;
258 #endif /* RTE_NIC_BYPASS */
259 struct ixgbe_filter_info filter;
262 #define IXGBE_DEV_PRIVATE_TO_HW(adapter)\
263 (&((struct ixgbe_adapter *)adapter)->hw)
265 #define IXGBE_DEV_PRIVATE_TO_STATS(adapter) \
266 (&((struct ixgbe_adapter *)adapter)->stats)
268 #define IXGBE_DEV_PRIVATE_TO_INTR(adapter) \
269 (&((struct ixgbe_adapter *)adapter)->intr)
271 #define IXGBE_DEV_PRIVATE_TO_FDIR_INFO(adapter) \
272 (&((struct ixgbe_adapter *)adapter)->fdir)
274 #define IXGBE_DEV_PRIVATE_TO_STAT_MAPPINGS(adapter) \
275 (&((struct ixgbe_adapter *)adapter)->stat_mappings)
277 #define IXGBE_DEV_PRIVATE_TO_VFTA(adapter) \
278 (&((struct ixgbe_adapter *)adapter)->shadow_vfta)
280 #define IXGBE_DEV_PRIVATE_TO_HWSTRIP_BITMAP(adapter) \
281 (&((struct ixgbe_adapter *)adapter)->hwstrip)
283 #define IXGBE_DEV_PRIVATE_TO_DCB_CFG(adapter) \
284 (&((struct ixgbe_adapter *)adapter)->dcb_config)
286 #define IXGBE_DEV_PRIVATE_TO_P_VFDATA(adapter) \
287 (&((struct ixgbe_adapter *)adapter)->vfdata)
289 #define IXGBE_DEV_PRIVATE_TO_PFDATA(adapter) \
290 (&((struct ixgbe_adapter *)adapter)->mr_data)
292 #define IXGBE_DEV_PRIVATE_TO_UTA(adapter) \
293 (&((struct ixgbe_adapter *)adapter)->uta_info)
295 #define IXGBE_DEV_PRIVATE_TO_FILTER_INFO(adapter) \
296 (&((struct ixgbe_adapter *)adapter)->filter)
299 * RX/TX function prototypes
301 void ixgbe_dev_clear_queues(struct rte_eth_dev *dev);
303 void ixgbe_dev_rx_queue_release(void *rxq);
305 void ixgbe_dev_tx_queue_release(void *txq);
307 int ixgbe_dev_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
308 uint16_t nb_rx_desc, unsigned int socket_id,
309 const struct rte_eth_rxconf *rx_conf,
310 struct rte_mempool *mb_pool);
312 int ixgbe_dev_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
313 uint16_t nb_tx_desc, unsigned int socket_id,
314 const struct rte_eth_txconf *tx_conf);
316 uint32_t ixgbe_dev_rx_queue_count(struct rte_eth_dev *dev,
317 uint16_t rx_queue_id);
319 int ixgbe_dev_rx_descriptor_done(void *rx_queue, uint16_t offset);
321 int ixgbe_dev_rx_init(struct rte_eth_dev *dev);
323 void ixgbe_dev_tx_init(struct rte_eth_dev *dev);
325 int ixgbe_dev_rxtx_start(struct rte_eth_dev *dev);
327 int ixgbe_dev_rx_queue_start(struct rte_eth_dev *dev, uint16_t rx_queue_id);
329 int ixgbe_dev_rx_queue_stop(struct rte_eth_dev *dev, uint16_t rx_queue_id);
331 int ixgbe_dev_tx_queue_start(struct rte_eth_dev *dev, uint16_t tx_queue_id);
333 int ixgbe_dev_tx_queue_stop(struct rte_eth_dev *dev, uint16_t tx_queue_id);
335 int ixgbevf_dev_rx_init(struct rte_eth_dev *dev);
337 void ixgbevf_dev_tx_init(struct rte_eth_dev *dev);
339 void ixgbevf_dev_rxtx_start(struct rte_eth_dev *dev);
341 uint16_t ixgbe_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
344 #ifdef RTE_LIBRTE_IXGBE_RX_ALLOW_BULK_ALLOC
345 uint16_t ixgbe_recv_pkts_bulk_alloc(void *rx_queue, struct rte_mbuf **rx_pkts,
349 uint16_t ixgbe_recv_scattered_pkts(void *rx_queue,
350 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
352 uint16_t ixgbe_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
355 uint16_t ixgbe_xmit_pkts_simple(void *tx_queue, struct rte_mbuf **tx_pkts,
358 int ixgbe_dev_rss_hash_update(struct rte_eth_dev *dev,
359 struct rte_eth_rss_conf *rss_conf);
361 int ixgbe_dev_rss_hash_conf_get(struct rte_eth_dev *dev,
362 struct rte_eth_rss_conf *rss_conf);
365 * Flow director function prototypes
367 int ixgbe_fdir_configure(struct rte_eth_dev *dev);
369 void ixgbe_configure_dcb(struct rte_eth_dev *dev);
372 * misc function prototypes
374 void ixgbe_vlan_hw_filter_enable(struct rte_eth_dev *dev);
376 void ixgbe_vlan_hw_filter_disable(struct rte_eth_dev *dev);
378 void ixgbe_vlan_hw_strip_enable_all(struct rte_eth_dev *dev);
380 void ixgbe_vlan_hw_strip_disable_all(struct rte_eth_dev *dev);
382 void ixgbe_pf_host_init(struct rte_eth_dev *eth_dev);
384 void ixgbe_pf_mbx_process(struct rte_eth_dev *eth_dev);
386 int ixgbe_pf_host_configure(struct rte_eth_dev *eth_dev);
388 uint32_t ixgbe_convert_vm_rx_mask_to_val(uint16_t rx_mask, uint32_t orig_val);
390 int ixgbe_fdir_ctrl_func(struct rte_eth_dev *dev,
391 enum rte_filter_op filter_op, void *arg);
392 #endif /* _IXGBE_ETHDEV_H_ */