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 * Information about the fdir mode.
80 struct ixgbe_hw_fdir_info {
91 /* structure for interrupt relative data */
92 struct ixgbe_interrupt {
97 struct ixgbe_stat_mapping_registers {
98 uint32_t tqsm[IXGBE_NB_STAT_MAPPING_REGS];
99 uint32_t rqsmr[IXGBE_NB_STAT_MAPPING_REGS];
103 uint32_t vfta[IXGBE_VFTA_SIZE];
106 struct ixgbe_hwstrip {
107 uint32_t bitmap[IXGBE_HWSTRIP_BITMAP_SIZE];
111 * VF data which used by PF host only
113 #define IXGBE_MAX_VF_MC_ENTRIES 30
114 #define IXGBE_MAX_MR_RULE_ENTRIES 4 /* number of mirroring rules supported */
115 #define IXGBE_MAX_UTA 128
117 struct ixgbe_uta_info {
118 uint8_t uc_filter_type;
120 uint32_t uta_shadow[IXGBE_MAX_UTA];
123 struct ixgbe_mirror_info {
124 struct rte_eth_vmdq_mirror_conf mr_conf[ETH_VMDQ_NUM_MIRROR_RULE];
125 /**< store PF mirror rules configuration*/
128 struct ixgbe_vf_info {
129 uint8_t vf_mac_addresses[ETHER_ADDR_LEN];
130 uint16_t vf_mc_hashes[IXGBE_MAX_VF_MC_ENTRIES];
131 uint16_t num_vf_mc_hashes;
132 uint16_t default_vf_vlan_id;
133 uint16_t vlans_enabled;
135 uint16_t tx_rate[IXGBE_MAX_QUEUE_NUM_PER_VF];
137 uint8_t spoofchk_enabled;
141 * Structure to store private data for each driver instance (for each port).
143 struct ixgbe_adapter {
145 struct ixgbe_hw_stats stats;
146 struct ixgbe_hw_fdir_info fdir;
147 struct ixgbe_interrupt intr;
148 struct ixgbe_stat_mapping_registers stat_mappings;
149 struct ixgbe_vfta shadow_vfta;
150 struct ixgbe_hwstrip hwstrip;
151 struct ixgbe_dcb_config dcb_config;
152 struct ixgbe_mirror_info mr_data;
153 struct ixgbe_vf_info *vfdata;
154 struct ixgbe_uta_info uta_info;
155 #ifdef RTE_NIC_BYPASS
156 struct ixgbe_bypass_info bps;
157 #endif /* RTE_NIC_BYPASS */
160 #define IXGBE_DEV_PRIVATE_TO_HW(adapter)\
161 (&((struct ixgbe_adapter *)adapter)->hw)
163 #define IXGBE_DEV_PRIVATE_TO_STATS(adapter) \
164 (&((struct ixgbe_adapter *)adapter)->stats)
166 #define IXGBE_DEV_PRIVATE_TO_INTR(adapter) \
167 (&((struct ixgbe_adapter *)adapter)->intr)
169 #define IXGBE_DEV_PRIVATE_TO_FDIR_INFO(adapter) \
170 (&((struct ixgbe_adapter *)adapter)->fdir)
172 #define IXGBE_DEV_PRIVATE_TO_STAT_MAPPINGS(adapter) \
173 (&((struct ixgbe_adapter *)adapter)->stat_mappings)
175 #define IXGBE_DEV_PRIVATE_TO_VFTA(adapter) \
176 (&((struct ixgbe_adapter *)adapter)->shadow_vfta)
178 #define IXGBE_DEV_PRIVATE_TO_HWSTRIP_BITMAP(adapter) \
179 (&((struct ixgbe_adapter *)adapter)->hwstrip)
181 #define IXGBE_DEV_PRIVATE_TO_DCB_CFG(adapter) \
182 (&((struct ixgbe_adapter *)adapter)->dcb_config)
184 #define IXGBE_DEV_PRIVATE_TO_P_VFDATA(adapter) \
185 (&((struct ixgbe_adapter *)adapter)->vfdata)
187 #define IXGBE_DEV_PRIVATE_TO_PFDATA(adapter) \
188 (&((struct ixgbe_adapter *)adapter)->mr_data)
190 #define IXGBE_DEV_PRIVATE_TO_UTA(adapter) \
191 (&((struct ixgbe_adapter *)adapter)->uta_info)
194 * RX/TX function prototypes
196 void ixgbe_dev_clear_queues(struct rte_eth_dev *dev);
198 void ixgbe_dev_rx_queue_release(void *rxq);
200 void ixgbe_dev_tx_queue_release(void *txq);
202 int ixgbe_dev_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
203 uint16_t nb_rx_desc, unsigned int socket_id,
204 const struct rte_eth_rxconf *rx_conf,
205 struct rte_mempool *mb_pool);
207 int ixgbe_dev_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
208 uint16_t nb_tx_desc, unsigned int socket_id,
209 const struct rte_eth_txconf *tx_conf);
211 uint32_t ixgbe_dev_rx_queue_count(struct rte_eth_dev *dev,
212 uint16_t rx_queue_id);
214 int ixgbe_dev_rx_descriptor_done(void *rx_queue, uint16_t offset);
216 int ixgbe_dev_rx_init(struct rte_eth_dev *dev);
218 void ixgbe_dev_tx_init(struct rte_eth_dev *dev);
220 void ixgbe_dev_rxtx_start(struct rte_eth_dev *dev);
222 int ixgbe_dev_rx_queue_start(struct rte_eth_dev *dev, uint16_t rx_queue_id);
224 int ixgbe_dev_rx_queue_stop(struct rte_eth_dev *dev, uint16_t rx_queue_id);
226 int ixgbe_dev_tx_queue_start(struct rte_eth_dev *dev, uint16_t tx_queue_id);
228 int ixgbe_dev_tx_queue_stop(struct rte_eth_dev *dev, uint16_t tx_queue_id);
230 int ixgbevf_dev_rx_init(struct rte_eth_dev *dev);
232 void ixgbevf_dev_tx_init(struct rte_eth_dev *dev);
234 void ixgbevf_dev_rxtx_start(struct rte_eth_dev *dev);
236 uint16_t ixgbe_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
239 #ifdef RTE_LIBRTE_IXGBE_RX_ALLOW_BULK_ALLOC
240 uint16_t ixgbe_recv_pkts_bulk_alloc(void *rx_queue, struct rte_mbuf **rx_pkts,
244 uint16_t ixgbe_recv_scattered_pkts(void *rx_queue,
245 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
247 uint16_t ixgbe_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
250 uint16_t ixgbe_xmit_pkts_simple(void *tx_queue, struct rte_mbuf **tx_pkts,
253 int ixgbe_dev_rss_hash_update(struct rte_eth_dev *dev,
254 struct rte_eth_rss_conf *rss_conf);
256 int ixgbe_dev_rss_hash_conf_get(struct rte_eth_dev *dev,
257 struct rte_eth_rss_conf *rss_conf);
260 * Flow director function prototypes
262 int ixgbe_fdir_configure(struct rte_eth_dev *dev);
264 int ixgbe_fdir_add_signature_filter(struct rte_eth_dev *dev,
265 struct rte_fdir_filter *fdir_filter, uint8_t queue);
267 int ixgbe_fdir_update_signature_filter(struct rte_eth_dev *dev,
268 struct rte_fdir_filter *fdir_filter, uint8_t queue);
270 int ixgbe_fdir_remove_signature_filter(struct rte_eth_dev *dev,
271 struct rte_fdir_filter *fdir_filter);
273 void ixgbe_fdir_info_get(struct rte_eth_dev *dev,
274 struct rte_eth_fdir *fdir);
276 int ixgbe_fdir_add_perfect_filter(struct rte_eth_dev *dev,
277 struct rte_fdir_filter *fdir_filter, uint16_t soft_id,
278 uint8_t queue, uint8_t drop);
280 int ixgbe_fdir_update_perfect_filter(struct rte_eth_dev *dev,
281 struct rte_fdir_filter *fdir_filter,uint16_t soft_id,
282 uint8_t queue, uint8_t drop);
284 int ixgbe_fdir_remove_perfect_filter(struct rte_eth_dev *dev,
285 struct rte_fdir_filter *fdir_filter, uint16_t soft_id);
287 int ixgbe_fdir_set_masks(struct rte_eth_dev *dev,
288 struct rte_fdir_masks *fdir_masks);
290 void ixgbe_configure_dcb(struct rte_eth_dev *dev);
293 * misc function prototypes
295 void ixgbe_vlan_hw_filter_enable(struct rte_eth_dev *dev);
297 void ixgbe_vlan_hw_filter_disable(struct rte_eth_dev *dev);
299 void ixgbe_vlan_hw_strip_enable_all(struct rte_eth_dev *dev);
301 void ixgbe_vlan_hw_strip_disable_all(struct rte_eth_dev *dev);
303 void ixgbe_pf_host_init(struct rte_eth_dev *eth_dev);
305 void ixgbe_pf_mbx_process(struct rte_eth_dev *eth_dev);
307 int ixgbe_pf_host_configure(struct rte_eth_dev *eth_dev);
309 #endif /* _IXGBE_ETHDEV_H_ */