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. */
71 * Information about the fdir mode.
73 struct ixgbe_hw_fdir_info {
84 /* structure for interrupt relative data */
85 struct ixgbe_interrupt {
90 struct ixgbe_stat_mapping_registers {
91 uint32_t tqsm[IXGBE_NB_STAT_MAPPING_REGS];
92 uint32_t rqsmr[IXGBE_NB_STAT_MAPPING_REGS];
96 uint32_t vfta[IXGBE_VFTA_SIZE];
99 struct ixgbe_hwstrip {
100 uint32_t bitmap[IXGBE_HWSTRIP_BITMAP_SIZE];
104 * VF data which used by PF host only
106 #define IXGBE_MAX_VF_MC_ENTRIES 30
107 #define IXGBE_MAX_MR_RULE_ENTRIES 4 /* number of mirroring rules supported */
108 #define IXGBE_MAX_UTA 128
110 struct ixgbe_uta_info {
111 uint8_t uc_filter_type;
113 uint32_t uta_shadow[IXGBE_MAX_UTA];
116 struct ixgbe_mirror_info {
117 struct rte_eth_vmdq_mirror_conf mr_conf[ETH_VMDQ_NUM_MIRROR_RULE];
118 /**< store PF mirror rules configuration*/
121 struct ixgbe_vf_info {
122 uint8_t vf_mac_addresses[ETHER_ADDR_LEN];
123 uint16_t vf_mc_hashes[IXGBE_MAX_VF_MC_ENTRIES];
124 uint16_t num_vf_mc_hashes;
125 uint16_t default_vf_vlan_id;
126 uint16_t vlans_enabled;
130 uint8_t spoofchk_enabled;
134 * Structure to store private data for each driver instance (for each port).
136 struct ixgbe_adapter {
138 struct ixgbe_hw_stats stats;
139 struct ixgbe_hw_fdir_info fdir;
140 struct ixgbe_interrupt intr;
141 struct ixgbe_stat_mapping_registers stat_mappings;
142 struct ixgbe_vfta shadow_vfta;
143 struct ixgbe_hwstrip hwstrip;
144 struct ixgbe_dcb_config dcb_config;
145 struct ixgbe_mirror_info mr_data;
146 struct ixgbe_vf_info *vfdata;
147 struct ixgbe_uta_info uta_info;
148 #ifdef RTE_NIC_BYPASS
149 struct ixgbe_bypass_info bps;
150 #endif /* RTE_NIC_BYPASS */
153 #define IXGBE_DEV_PRIVATE_TO_HW(adapter)\
154 (&((struct ixgbe_adapter *)adapter)->hw)
156 #define IXGBE_DEV_PRIVATE_TO_STATS(adapter) \
157 (&((struct ixgbe_adapter *)adapter)->stats)
159 #define IXGBE_DEV_PRIVATE_TO_INTR(adapter) \
160 (&((struct ixgbe_adapter *)adapter)->intr)
162 #define IXGBE_DEV_PRIVATE_TO_FDIR_INFO(adapter) \
163 (&((struct ixgbe_adapter *)adapter)->fdir)
165 #define IXGBE_DEV_PRIVATE_TO_STAT_MAPPINGS(adapter) \
166 (&((struct ixgbe_adapter *)adapter)->stat_mappings)
168 #define IXGBE_DEV_PRIVATE_TO_VFTA(adapter) \
169 (&((struct ixgbe_adapter *)adapter)->shadow_vfta)
171 #define IXGBE_DEV_PRIVATE_TO_HWSTRIP_BITMAP(adapter) \
172 (&((struct ixgbe_adapter *)adapter)->hwstrip)
174 #define IXGBE_DEV_PRIVATE_TO_DCB_CFG(adapter) \
175 (&((struct ixgbe_adapter *)adapter)->dcb_config)
177 #define IXGBE_DEV_PRIVATE_TO_P_VFDATA(adapter) \
178 (&((struct ixgbe_adapter *)adapter)->vfdata)
180 #define IXGBE_DEV_PRIVATE_TO_PFDATA(adapter) \
181 (&((struct ixgbe_adapter *)adapter)->mr_data)
183 #define IXGBE_DEV_PRIVATE_TO_UTA(adapter) \
184 (&((struct ixgbe_adapter *)adapter)->uta_info)
187 * RX/TX function prototypes
189 void ixgbe_dev_clear_queues(struct rte_eth_dev *dev);
191 void ixgbe_dev_rx_queue_release(void *rxq);
193 void ixgbe_dev_tx_queue_release(void *txq);
195 int ixgbe_dev_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
196 uint16_t nb_rx_desc, unsigned int socket_id,
197 const struct rte_eth_rxconf *rx_conf,
198 struct rte_mempool *mb_pool);
200 int ixgbe_dev_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
201 uint16_t nb_tx_desc, unsigned int socket_id,
202 const struct rte_eth_txconf *tx_conf);
204 uint32_t ixgbe_dev_rx_queue_count(struct rte_eth_dev *dev,
205 uint16_t rx_queue_id);
207 int ixgbe_dev_rx_descriptor_done(void *rx_queue, uint16_t offset);
209 int ixgbe_dev_rx_init(struct rte_eth_dev *dev);
211 void ixgbe_dev_tx_init(struct rte_eth_dev *dev);
213 void ixgbe_dev_rxtx_start(struct rte_eth_dev *dev);
215 int ixgbe_dev_rx_queue_start(struct rte_eth_dev *dev, uint16_t rx_queue_id);
217 int ixgbe_dev_rx_queue_stop(struct rte_eth_dev *dev, uint16_t rx_queue_id);
219 int ixgbe_dev_tx_queue_start(struct rte_eth_dev *dev, uint16_t tx_queue_id);
221 int ixgbe_dev_tx_queue_stop(struct rte_eth_dev *dev, uint16_t tx_queue_id);
223 int ixgbevf_dev_rx_init(struct rte_eth_dev *dev);
225 void ixgbevf_dev_tx_init(struct rte_eth_dev *dev);
227 void ixgbevf_dev_rxtx_start(struct rte_eth_dev *dev);
229 uint16_t ixgbe_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
232 #ifdef RTE_LIBRTE_IXGBE_RX_ALLOW_BULK_ALLOC
233 uint16_t ixgbe_recv_pkts_bulk_alloc(void *rx_queue, struct rte_mbuf **rx_pkts,
237 uint16_t ixgbe_recv_scattered_pkts(void *rx_queue,
238 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
240 uint16_t ixgbe_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
243 uint16_t ixgbe_xmit_pkts_simple(void *tx_queue, struct rte_mbuf **tx_pkts,
246 int ixgbe_dev_rss_hash_update(struct rte_eth_dev *dev,
247 struct rte_eth_rss_conf *rss_conf);
249 int ixgbe_dev_rss_hash_conf_get(struct rte_eth_dev *dev,
250 struct rte_eth_rss_conf *rss_conf);
253 * Flow director function prototypes
255 int ixgbe_fdir_configure(struct rte_eth_dev *dev);
257 int ixgbe_fdir_add_signature_filter(struct rte_eth_dev *dev,
258 struct rte_fdir_filter *fdir_filter, uint8_t queue);
260 int ixgbe_fdir_update_signature_filter(struct rte_eth_dev *dev,
261 struct rte_fdir_filter *fdir_filter, uint8_t queue);
263 int ixgbe_fdir_remove_signature_filter(struct rte_eth_dev *dev,
264 struct rte_fdir_filter *fdir_filter);
266 void ixgbe_fdir_info_get(struct rte_eth_dev *dev,
267 struct rte_eth_fdir *fdir);
269 int ixgbe_fdir_add_perfect_filter(struct rte_eth_dev *dev,
270 struct rte_fdir_filter *fdir_filter, uint16_t soft_id,
271 uint8_t queue, uint8_t drop);
273 int ixgbe_fdir_update_perfect_filter(struct rte_eth_dev *dev,
274 struct rte_fdir_filter *fdir_filter,uint16_t soft_id,
275 uint8_t queue, uint8_t drop);
277 int ixgbe_fdir_remove_perfect_filter(struct rte_eth_dev *dev,
278 struct rte_fdir_filter *fdir_filter, uint16_t soft_id);
280 int ixgbe_fdir_set_masks(struct rte_eth_dev *dev,
281 struct rte_fdir_masks *fdir_masks);
283 void ixgbe_configure_dcb(struct rte_eth_dev *dev);
286 * misc function prototypes
288 void ixgbe_vlan_hw_filter_enable(struct rte_eth_dev *dev);
290 void ixgbe_vlan_hw_filter_disable(struct rte_eth_dev *dev);
292 void ixgbe_vlan_hw_strip_enable_all(struct rte_eth_dev *dev);
294 void ixgbe_vlan_hw_strip_disable_all(struct rte_eth_dev *dev);
296 void ixgbe_pf_host_init(struct rte_eth_dev *eth_dev);
298 void ixgbe_pf_mbx_process(struct rte_eth_dev *eth_dev);
300 int ixgbe_pf_host_configure(struct rte_eth_dev *eth_dev);
302 #endif /* _IXGBE_ETHDEV_H_ */