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 _I40E_ETHDEV_H_
35 #define _I40E_ETHDEV_H_
37 #include <rte_eth_ctrl.h>
39 #define I40E_AQ_LEN 32
40 #define I40E_AQ_BUF_SZ 4096
41 /* Number of queues per TC should be one of 1, 2, 4, 8, 16, 32, 64 */
42 #define I40E_MAX_Q_PER_TC 64
43 #define I40E_NUM_DESC_DEFAULT 512
44 #define I40E_NUM_DESC_ALIGN 32
45 #define I40E_BUF_SIZE_MIN 1024
46 #define I40E_FRAME_SIZE_MAX 9728
47 #define I40E_QUEUE_BASE_ADDR_UNIT 128
48 /* number of VSIs and queue default setting */
49 #define I40E_MAX_QP_NUM_PER_VF 16
50 #define I40E_DEFAULT_QP_NUM_VMDQ 64
51 #define I40E_DEFAULT_QP_NUM_FDIR 64
52 #define I40E_UINT32_BIT_SIZE (CHAR_BIT * sizeof(uint32_t))
53 #define I40E_VFTA_SIZE (4096 / I40E_UINT32_BIT_SIZE)
54 /* Default TC traffic in case DCB is not enabled */
55 #define I40E_DEFAULT_TCMAP 0x1
58 #define I40E_FLAG_RSS (1ULL << 0)
59 #define I40E_FLAG_DCB (1ULL << 1)
60 #define I40E_FLAG_VMDQ (1ULL << 2)
61 #define I40E_FLAG_SRIOV (1ULL << 3)
62 #define I40E_FLAG_HEADER_SPLIT_DISABLED (1ULL << 4)
63 #define I40E_FLAG_HEADER_SPLIT_ENABLED (1ULL << 5)
64 #define I40E_FLAG_FDIR (1ULL << 6)
65 #define I40E_FLAG_VXLAN (1ULL << 7)
66 #define I40E_FLAG_ALL (I40E_FLAG_RSS | \
70 I40E_FLAG_HEADER_SPLIT_DISABLED | \
71 I40E_FLAG_HEADER_SPLIT_ENABLED | \
75 #define I40E_RSS_OFFLOAD_ALL ( \
76 ETH_RSS_NONF_IPV4_UDP | \
77 ETH_RSS_NONF_IPV4_TCP | \
78 ETH_RSS_NONF_IPV4_SCTP | \
79 ETH_RSS_NONF_IPV4_OTHER | \
81 ETH_RSS_NONF_IPV6_UDP | \
82 ETH_RSS_NONF_IPV6_TCP | \
83 ETH_RSS_NONF_IPV6_SCTP | \
84 ETH_RSS_NONF_IPV6_OTHER | \
88 /* All bits of RSS hash enable */
89 #define I40E_RSS_HENA_ALL ( \
90 (1ULL << I40E_FILTER_PCTYPE_NONF_IPV4_UDP) | \
91 (1ULL << I40E_FILTER_PCTYPE_NONF_IPV4_TCP) | \
92 (1ULL << I40E_FILTER_PCTYPE_NONF_IPV4_SCTP) | \
93 (1ULL << I40E_FILTER_PCTYPE_NONF_IPV4_OTHER) | \
94 (1ULL << I40E_FILTER_PCTYPE_FRAG_IPV4) | \
95 (1ULL << I40E_FILTER_PCTYPE_NONF_IPV6_UDP) | \
96 (1ULL << I40E_FILTER_PCTYPE_NONF_IPV6_TCP) | \
97 (1ULL << I40E_FILTER_PCTYPE_NONF_IPV6_SCTP) | \
98 (1ULL << I40E_FILTER_PCTYPE_NONF_IPV6_OTHER) | \
99 (1ULL << I40E_FILTER_PCTYPE_FRAG_IPV6) | \
100 (1ULL << I40E_FILTER_PCTYPE_FCOE_OX) | \
101 (1ULL << I40E_FILTER_PCTYPE_FCOE_RX) | \
102 (1ULL << I40E_FILTER_PCTYPE_FCOE_OTHER) | \
103 (1ULL << I40E_FILTER_PCTYPE_L2_PAYLOAD))
108 * MAC filter structure
110 struct i40e_mac_filter_info {
111 enum rte_mac_filter_type filter_type;
112 struct ether_addr mac_addr;
115 TAILQ_HEAD(i40e_mac_filter_list, i40e_mac_filter);
117 /* MAC filter list structure */
118 struct i40e_mac_filter {
119 TAILQ_ENTRY(i40e_mac_filter) next;
120 struct i40e_mac_filter_info mac_info;
123 TAILQ_HEAD(i40e_vsi_list_head, i40e_vsi_list);
127 /* VSI list structure */
128 struct i40e_vsi_list {
129 TAILQ_ENTRY(i40e_vsi_list) list;
130 struct i40e_vsi *vsi;
133 struct i40e_rx_queue;
134 struct i40e_tx_queue;
136 /* Structure that defines a VEB */
138 struct i40e_vsi_list_head head;
139 struct i40e_vsi *associate_vsi; /* Associate VSI who owns the VEB */
140 uint16_t seid; /* The seid of VEB itself */
141 uint16_t uplink_seid; /* The uplink seid of this VEB */
143 struct i40e_eth_stats stats;
146 /* i40e MACVLAN filter structure */
147 struct i40e_macvlan_filter {
148 struct ether_addr macaddr;
149 enum rte_mac_filter_type filter_type;
154 * Structure that defines a VSI, associated with a adapter.
157 struct i40e_adapter *adapter; /* Backreference to associated adapter */
158 struct i40e_aqc_vsi_properties_data info; /* VSI properties */
160 struct i40e_eth_stats eth_stats_offset;
161 struct i40e_eth_stats eth_stats;
163 * When drivers loaded, only a default main VSI exists. In case new VSI
164 * needs to add, HW needs to know the layout that VSIs are organized.
165 * Besides that, VSI isan element and can't switch packets, which needs
166 * to add new component VEB to perform switching. So, a new VSI needs
167 * to specify the the uplink VSI (Parent VSI) before created. The
168 * uplink VSI will check whether it had a VEB to switch packets. If no,
169 * it will try to create one. Then, uplink VSI will move the new VSI
170 * into its' sib_vsi_list to manage all the downlink VSI.
171 * sib_vsi_list: the VSI list that shared the same uplink VSI.
172 * parent_vsi : the uplink VSI. It's NULL for main VSI.
173 * veb : the VEB associates with the VSI.
175 struct i40e_vsi_list sib_vsi_list; /* sibling vsi list */
176 struct i40e_vsi *parent_vsi;
177 struct i40e_veb *veb; /* Associated veb, could be null */
179 enum i40e_vsi_type type; /* VSI types */
180 uint16_t vlan_num; /* Total VLAN number */
181 uint16_t mac_num; /* Total mac number */
182 uint32_t vfta[I40E_VFTA_SIZE]; /* VLAN bitmap */
183 struct i40e_mac_filter_list mac_list; /* macvlan filter list */
184 /* specific VSI-defined parameters, SRIOV stored the vf_id */
186 uint16_t seid; /* The seid of VSI itself */
187 uint16_t uplink_seid; /* The uplink seid of this VSI */
188 uint16_t nb_qps; /* Number of queue pairs VSI can occupy */
189 uint16_t max_macaddrs; /* Maximum number of MAC addresses */
190 uint16_t base_queue; /* The first queue index of this VSI */
192 * The offset to visit VSI related register, assigned by HW when
196 uint16_t msix_intr; /* The MSIX interrupt binds to VSI */
197 uint8_t enabled_tc; /* The traffic class enabled */
201 LIST_ENTRY(pool_entry) next;
206 LIST_HEAD(res_list, pool_entry);
208 struct i40e_res_pool_info {
209 uint32_t base; /* Resource start index */
210 uint32_t num_alloc; /* Allocated resource number */
211 uint32_t num_free; /* Total available resource number */
212 struct res_list alloc_list; /* Allocated resource list */
213 struct res_list free_list; /* Available resource list */
217 I40E_VF_INACTIVE = 0,
224 * Structure to store private data for PF host.
228 struct i40e_vsi *vsi;
229 enum I40E_VF_STATE state; /* The number of queue pairs availiable */
230 uint16_t vf_idx; /* VF index in pf->vfs */
231 uint16_t lan_nb_qps; /* Actual queues allocated */
232 uint16_t reset_cnt; /* Total vf reset times */
236 * Structure to store private data specific for PF instance.
239 struct i40e_adapter *adapter; /* The adapter this PF associate to */
240 struct i40e_vsi *main_vsi; /* pointer to main VSI structure */
241 uint16_t mac_seid; /* The seid of the MAC of this PF */
242 uint16_t main_vsi_seid; /* The seid of the main VSI */
243 uint16_t max_num_vsi;
244 struct i40e_res_pool_info qp_pool; /*Queue pair pool */
245 struct i40e_res_pool_info msix_pool; /* MSIX interrupt pool */
247 struct i40e_hw_port_stats stats_offset;
248 struct i40e_hw_port_stats stats;
251 struct rte_eth_dev_data *dev_data; /* Pointer to the device data */
252 struct ether_addr dev_addr; /* PF device mac address */
253 uint64_t flags; /* PF featuer flags */
254 /* All kinds of queue pair setting for different VSIs */
255 struct i40e_pf_vf *vfs;
257 /* Each of below queue pairs should be power of 2 since it's the
258 precondition after TC configuration applied */
259 uint16_t lan_nb_qps; /* The number of queue pairs of LAN */
260 uint16_t vmdq_nb_qps; /* The number of queue pairs of VMDq */
261 uint16_t vf_nb_qps; /* The number of queue pairs of VF */
262 uint16_t fdir_nb_qps; /* The number of queue pairs of Flow Director */
264 /* store VXLAN UDP ports */
265 uint16_t vxlan_ports[I40E_MAX_PF_UDP_OFFLOAD_PORTS];
266 uint16_t vxlan_bitmap; /* Vxlan bit mask */
270 PFMSG_LINK_CHANGE = 0x1,
271 PFMSG_RESET_IMPENDING = 0x2,
272 PFMSG_DRIVER_CLOSE = 0x4,
275 struct i40e_vsi_vlan_pvid_info {
276 uint16_t on; /* Enable or disable pvid */
278 uint16_t pvid; /* Valid in case 'on' is set to set pvid */
280 /* Valid in case 'on' is cleared. 'tagged' will reject tagged packets,
281 * while 'untagged' will reject untagged packets.
289 struct i40e_vf_rx_queues {
290 uint64_t rx_dma_addr;
291 uint32_t rx_ring_len;
295 struct i40e_vf_tx_queues {
296 uint64_t tx_dma_addr;
297 uint32_t tx_ring_len;
301 * Structure to store private data specific for VF instance.
304 struct i40e_adapter *adapter; /* The adapter this VF associate to */
305 struct rte_eth_dev_data *dev_data; /* Pointer to the device data */
306 uint16_t num_queue_pairs;
307 uint16_t max_pkt_len; /* Maximum packet length */
308 bool promisc_unicast_enabled;
309 bool promisc_multicast_enabled;
311 bool host_is_dpdk; /* The flag indicates if the host is DPDK */
312 uint16_t promisc_flags; /* Promiscuous setting */
313 uint32_t vlan[I40E_VFTA_SIZE]; /* VLAN bit map */
319 volatile uint32_t pend_cmd; /* pending command not finished yet */
320 u16 pend_msg; /* flags indicates events from pf not handled yet */
323 struct i40e_virtchnl_vf_resource *vf_res; /* All VSIs */
324 struct i40e_virtchnl_vsi_resource *vsi_res; /* LAN VSI */
329 * Structure to store private data for each PF/VF instance.
331 struct i40e_adapter {
332 /* Common for both PF and VF */
334 struct rte_eth_dev *eth_dev;
336 /* Specific for PF or VF */
343 int i40e_vsi_switch_queues(struct i40e_vsi *vsi, bool on);
344 int i40e_vsi_release(struct i40e_vsi *vsi);
345 struct i40e_vsi *i40e_vsi_setup(struct i40e_pf *pf,
346 enum i40e_vsi_type type,
347 struct i40e_vsi *uplink_vsi,
348 uint16_t user_param);
349 int i40e_switch_rx_queue(struct i40e_hw *hw, uint16_t q_idx, bool on);
350 int i40e_switch_tx_queue(struct i40e_hw *hw, uint16_t q_idx, bool on);
351 int i40e_vsi_add_vlan(struct i40e_vsi *vsi, uint16_t vlan);
352 int i40e_vsi_delete_vlan(struct i40e_vsi *vsi, uint16_t vlan);
353 int i40e_vsi_add_mac(struct i40e_vsi *vsi, struct i40e_mac_filter_info *filter);
354 int i40e_vsi_delete_mac(struct i40e_vsi *vsi, struct ether_addr *addr);
355 void i40e_update_vsi_stats(struct i40e_vsi *vsi);
356 void i40e_pf_disable_irq0(struct i40e_hw *hw);
357 void i40e_pf_enable_irq0(struct i40e_hw *hw);
358 int i40e_dev_link_update(struct rte_eth_dev *dev,
359 __rte_unused int wait_to_complete);
360 void i40e_vsi_queues_bind_intr(struct i40e_vsi *vsi);
361 void i40e_vsi_queues_unbind_intr(struct i40e_vsi *vsi);
362 int i40e_vsi_vlan_pvid_set(struct i40e_vsi *vsi,
363 struct i40e_vsi_vlan_pvid_info *info);
364 int i40e_vsi_config_vlan_stripping(struct i40e_vsi *vsi, bool on);
365 uint64_t i40e_config_hena(uint64_t flags);
366 uint64_t i40e_parse_hena(uint64_t flags);
368 /* I40E_DEV_PRIVATE_TO */
369 #define I40E_DEV_PRIVATE_TO_PF(adapter) \
370 (&((struct i40e_adapter *)adapter)->pf)
371 #define I40E_DEV_PRIVATE_TO_HW(adapter) \
372 (&((struct i40e_adapter *)adapter)->hw)
373 #define I40E_DEV_PRIVATE_TO_ADAPTER(adapter) \
374 ((struct i40e_adapter *)adapter)
376 /* I40EVF_DEV_PRIVATE_TO */
377 #define I40EVF_DEV_PRIVATE_TO_VF(adapter) \
378 (&((struct i40e_adapter *)adapter)->vf)
380 static inline struct i40e_vsi *
381 i40e_get_vsi_from_adapter(struct i40e_adapter *adapter)
388 hw = I40E_DEV_PRIVATE_TO_HW(adapter);
389 if (hw->mac.type == I40E_MAC_VF) {
390 struct i40e_vf *vf = I40EVF_DEV_PRIVATE_TO_VF(adapter);
393 struct i40e_pf *pf = I40E_DEV_PRIVATE_TO_PF(adapter);
397 #define I40E_DEV_PRIVATE_TO_VSI(adapter) \
398 i40e_get_vsi_from_adapter((struct i40e_adapter *)adapter)
401 #define I40E_VSI_TO_HW(vsi) \
402 (&(((struct i40e_vsi *)vsi)->adapter->hw))
403 #define I40E_VSI_TO_PF(vsi) \
404 (&(((struct i40e_vsi *)vsi)->adapter->pf))
405 #define I40E_VSI_TO_DEV_DATA(vsi) \
406 (((struct i40e_vsi *)vsi)->adapter->pf.dev_data)
407 #define I40E_VSI_TO_ETH_DEV(vsi) \
408 (((struct i40e_vsi *)vsi)->adapter->eth_dev)
411 #define I40E_PF_TO_HW(pf) \
412 (&(((struct i40e_pf *)pf)->adapter->hw))
413 #define I40E_PF_TO_ADAPTER(pf) \
414 ((struct i40e_adapter *)pf->adapter)
417 #define I40E_VF_TO_HW(vf) \
418 (&(((struct i40e_vf *)vf)->adapter->hw))
421 i40e_init_adminq_parameter(struct i40e_hw *hw)
423 hw->aq.num_arq_entries = I40E_AQ_LEN;
424 hw->aq.num_asq_entries = I40E_AQ_LEN;
425 hw->aq.arq_buf_size = I40E_AQ_BUF_SZ;
426 hw->aq.asq_buf_size = I40E_AQ_BUF_SZ;
429 #endif /* _I40E_ETHDEV_H_ */