net/i40e: support floating VEB
[dpdk.git] / drivers / net / i40e / i40e_ethdev.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
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
16  *       distribution.
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.
20  *
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.
32  */
33
34 #ifndef _I40E_ETHDEV_H_
35 #define _I40E_ETHDEV_H_
36
37 #include <rte_eth_ctrl.h>
38 #include <rte_time.h>
39
40 #define I40E_VLAN_TAG_SIZE        4
41
42 #define I40E_AQ_LEN               32
43 #define I40E_AQ_BUF_SZ            4096
44 /* Number of queues per TC should be one of 1, 2, 4, 8, 16, 32, 64 */
45 #define I40E_MAX_Q_PER_TC         64
46 #define I40E_NUM_DESC_DEFAULT     512
47 #define I40E_NUM_DESC_ALIGN       32
48 #define I40E_BUF_SIZE_MIN         1024
49 #define I40E_FRAME_SIZE_MAX       9728
50 #define I40E_QUEUE_BASE_ADDR_UNIT 128
51 /* number of VSIs and queue default setting */
52 #define I40E_MAX_QP_NUM_PER_VF    16
53 #define I40E_DEFAULT_QP_NUM_FDIR  1
54 #define I40E_UINT32_BIT_SIZE      (CHAR_BIT * sizeof(uint32_t))
55 #define I40E_VFTA_SIZE            (4096 / I40E_UINT32_BIT_SIZE)
56 /* Maximun number of MAC addresses */
57 #define I40E_NUM_MACADDR_MAX       64
58 /* Maximum number of VFs */
59 #define I40E_MAX_VF               128
60
61 /*
62  * vlan_id is a 12 bit number.
63  * The VFTA array is actually a 4096 bit array, 128 of 32bit elements.
64  * 2^5 = 32. The val of lower 5 bits specifies the bit in the 32bit element.
65  * The higher 7 bit val specifies VFTA array index.
66  */
67 #define I40E_VFTA_BIT(vlan_id)    (1 << ((vlan_id) & 0x1F))
68 #define I40E_VFTA_IDX(vlan_id)    ((vlan_id) >> 5)
69
70 /* Default TC traffic in case DCB is not enabled */
71 #define I40E_DEFAULT_TCMAP        0x1
72 #define I40E_FDIR_QUEUE_ID        0
73
74 /* Always assign pool 0 to main VSI, VMDQ will start from 1 */
75 #define I40E_VMDQ_POOL_BASE       1
76
77 #define I40E_DEFAULT_RX_FREE_THRESH  32
78 #define I40E_DEFAULT_RX_PTHRESH      8
79 #define I40E_DEFAULT_RX_HTHRESH      8
80 #define I40E_DEFAULT_RX_WTHRESH      0
81
82 #define I40E_DEFAULT_TX_FREE_THRESH  32
83 #define I40E_DEFAULT_TX_PTHRESH      32
84 #define I40E_DEFAULT_TX_HTHRESH      0
85 #define I40E_DEFAULT_TX_WTHRESH      0
86 #define I40E_DEFAULT_TX_RSBIT_THRESH 32
87
88 /* Bit shift and mask */
89 #define I40E_4_BIT_WIDTH  (CHAR_BIT / 2)
90 #define I40E_4_BIT_MASK   RTE_LEN2MASK(I40E_4_BIT_WIDTH, uint8_t)
91 #define I40E_8_BIT_WIDTH  CHAR_BIT
92 #define I40E_8_BIT_MASK   UINT8_MAX
93 #define I40E_16_BIT_WIDTH (CHAR_BIT * 2)
94 #define I40E_16_BIT_MASK  UINT16_MAX
95 #define I40E_32_BIT_WIDTH (CHAR_BIT * 4)
96 #define I40E_32_BIT_MASK  UINT32_MAX
97 #define I40E_48_BIT_WIDTH (CHAR_BIT * 6)
98 #define I40E_48_BIT_MASK  RTE_LEN2MASK(I40E_48_BIT_WIDTH, uint64_t)
99
100 /* Linux PF host with virtchnl version 1.1 */
101 #define PF_IS_V11(vf) \
102         (((vf)->version_major == I40E_VIRTCHNL_VERSION_MAJOR) && \
103         ((vf)->version_minor == 1))
104
105 /* index flex payload per layer */
106 enum i40e_flxpld_layer_idx {
107         I40E_FLXPLD_L2_IDX    = 0,
108         I40E_FLXPLD_L3_IDX    = 1,
109         I40E_FLXPLD_L4_IDX    = 2,
110         I40E_MAX_FLXPLD_LAYER = 3,
111 };
112 #define I40E_MAX_FLXPLD_FIED        3  /* max number of flex payload fields */
113 #define I40E_FDIR_BITMASK_NUM_WORD  2  /* max number of bitmask words */
114 #define I40E_FDIR_MAX_FLEXWORD_NUM  8  /* max number of flexpayload words */
115 #define I40E_FDIR_MAX_FLEX_LEN      16 /* len in bytes of flex payload */
116 #define I40E_INSET_MASK_NUM_REG     2  /* number of input set mask registers */
117
118 /* i40e flags */
119 #define I40E_FLAG_RSS                   (1ULL << 0)
120 #define I40E_FLAG_DCB                   (1ULL << 1)
121 #define I40E_FLAG_VMDQ                  (1ULL << 2)
122 #define I40E_FLAG_SRIOV                 (1ULL << 3)
123 #define I40E_FLAG_HEADER_SPLIT_DISABLED (1ULL << 4)
124 #define I40E_FLAG_HEADER_SPLIT_ENABLED  (1ULL << 5)
125 #define I40E_FLAG_FDIR                  (1ULL << 6)
126 #define I40E_FLAG_VXLAN                 (1ULL << 7)
127 #define I40E_FLAG_RSS_AQ_CAPABLE        (1ULL << 8)
128 #define I40E_FLAG_ALL (I40E_FLAG_RSS | \
129                        I40E_FLAG_DCB | \
130                        I40E_FLAG_VMDQ | \
131                        I40E_FLAG_SRIOV | \
132                        I40E_FLAG_HEADER_SPLIT_DISABLED | \
133                        I40E_FLAG_HEADER_SPLIT_ENABLED | \
134                        I40E_FLAG_FDIR | \
135                        I40E_FLAG_VXLAN | \
136                        I40E_FLAG_RSS_AQ_CAPABLE)
137
138 #define I40E_RSS_OFFLOAD_ALL ( \
139         ETH_RSS_FRAG_IPV4 | \
140         ETH_RSS_NONFRAG_IPV4_TCP | \
141         ETH_RSS_NONFRAG_IPV4_UDP | \
142         ETH_RSS_NONFRAG_IPV4_SCTP | \
143         ETH_RSS_NONFRAG_IPV4_OTHER | \
144         ETH_RSS_FRAG_IPV6 | \
145         ETH_RSS_NONFRAG_IPV6_TCP | \
146         ETH_RSS_NONFRAG_IPV6_UDP | \
147         ETH_RSS_NONFRAG_IPV6_SCTP | \
148         ETH_RSS_NONFRAG_IPV6_OTHER | \
149         ETH_RSS_L2_PAYLOAD)
150
151 /* All bits of RSS hash enable */
152 #define I40E_RSS_HENA_ALL ( \
153         (1ULL << I40E_FILTER_PCTYPE_NONF_IPV4_UDP) | \
154         (1ULL << I40E_FILTER_PCTYPE_NONF_IPV4_TCP) | \
155         (1ULL << I40E_FILTER_PCTYPE_NONF_IPV4_SCTP) | \
156         (1ULL << I40E_FILTER_PCTYPE_NONF_IPV4_OTHER) | \
157         (1ULL << I40E_FILTER_PCTYPE_FRAG_IPV4) | \
158         (1ULL << I40E_FILTER_PCTYPE_NONF_IPV6_UDP) | \
159         (1ULL << I40E_FILTER_PCTYPE_NONF_IPV6_TCP) | \
160         (1ULL << I40E_FILTER_PCTYPE_NONF_IPV6_SCTP) | \
161         (1ULL << I40E_FILTER_PCTYPE_NONF_IPV6_OTHER) | \
162         (1ULL << I40E_FILTER_PCTYPE_FRAG_IPV6) | \
163         (1ULL << I40E_FILTER_PCTYPE_FCOE_OX) | \
164         (1ULL << I40E_FILTER_PCTYPE_FCOE_RX) | \
165         (1ULL << I40E_FILTER_PCTYPE_FCOE_OTHER) | \
166         (1ULL << I40E_FILTER_PCTYPE_L2_PAYLOAD))
167
168 #define I40E_MISC_VEC_ID                RTE_INTR_VEC_ZERO_OFFSET
169 #define I40E_RX_VEC_START               RTE_INTR_VEC_RXTX_OFFSET
170
171 /* Default queue interrupt throttling time in microseconds */
172 #define I40E_ITR_INDEX_DEFAULT          0
173 #define I40E_QUEUE_ITR_INTERVAL_DEFAULT 32 /* 32 us */
174 #define I40E_QUEUE_ITR_INTERVAL_MAX     8160 /* 8160 us */
175
176 struct i40e_adapter;
177
178 /**
179  * MAC filter structure
180  */
181 struct i40e_mac_filter_info {
182         enum rte_mac_filter_type filter_type;
183         struct ether_addr mac_addr;
184 };
185
186 TAILQ_HEAD(i40e_mac_filter_list, i40e_mac_filter);
187
188 /* MAC filter list structure */
189 struct i40e_mac_filter {
190         TAILQ_ENTRY(i40e_mac_filter) next;
191         struct i40e_mac_filter_info mac_info;
192 };
193
194 TAILQ_HEAD(i40e_vsi_list_head, i40e_vsi_list);
195
196 struct i40e_vsi;
197
198 /* VSI list structure */
199 struct i40e_vsi_list {
200         TAILQ_ENTRY(i40e_vsi_list) list;
201         struct i40e_vsi *vsi;
202 };
203
204 struct i40e_rx_queue;
205 struct i40e_tx_queue;
206
207 /* Bandwidth limit information */
208 struct i40e_bw_info {
209         uint16_t bw_limit;      /* BW Limit (0 = disabled) */
210         uint8_t  bw_max;        /* Max BW limit if enabled */
211
212         /* Relative credits within same TC with respect to other VSIs or Comps */
213         uint8_t  bw_ets_share_credits[I40E_MAX_TRAFFIC_CLASS];
214         /* Bandwidth limit per TC */
215         uint8_t  bw_ets_credits[I40E_MAX_TRAFFIC_CLASS];
216         /* Max bandwidth limit per TC */
217         uint8_t  bw_ets_max[I40E_MAX_TRAFFIC_CLASS];
218 };
219
220 /* Structure that defines a VEB */
221 struct i40e_veb {
222         struct i40e_vsi_list_head head;
223         struct i40e_vsi *associate_vsi; /* Associate VSI who owns the VEB */
224         struct i40e_pf *associate_pf; /* Associate PF who owns the VEB */
225         uint16_t seid; /* The seid of VEB itself */
226         uint16_t uplink_seid; /* The uplink seid of this VEB */
227         uint16_t stats_idx;
228         struct i40e_eth_stats stats;
229         uint8_t enabled_tc;   /* The traffic class enabled */
230         struct i40e_bw_info bw_info; /* VEB bandwidth information */
231 };
232
233 /* i40e MACVLAN filter structure */
234 struct i40e_macvlan_filter {
235         struct ether_addr macaddr;
236         enum rte_mac_filter_type filter_type;
237         uint16_t vlan_id;
238 };
239
240 /*
241  * Structure that defines a VSI, associated with a adapter.
242  */
243 struct i40e_vsi {
244         struct i40e_adapter *adapter; /* Backreference to associated adapter */
245         struct i40e_aqc_vsi_properties_data info; /* VSI properties */
246
247         struct i40e_eth_stats eth_stats_offset;
248         struct i40e_eth_stats eth_stats;
249         /*
250          * When drivers loaded, only a default main VSI exists. In case new VSI
251          * needs to add, HW needs to know the layout that VSIs are organized.
252          * Besides that, VSI isan element and can't switch packets, which needs
253          * to add new component VEB to perform switching. So, a new VSI needs
254          * to specify the the uplink VSI (Parent VSI) before created. The
255          * uplink VSI will check whether it had a VEB to switch packets. If no,
256          * it will try to create one. Then, uplink VSI will move the new VSI
257          * into its' sib_vsi_list to manage all the downlink VSI.
258          *  sib_vsi_list: the VSI list that shared the same uplink VSI.
259          *  parent_vsi  : the uplink VSI. It's NULL for main VSI.
260          *  veb         : the VEB associates with the VSI.
261          */
262         struct i40e_vsi_list sib_vsi_list; /* sibling vsi list */
263         struct i40e_vsi *parent_vsi;
264         struct i40e_veb *veb;    /* Associated veb, could be null */
265         struct i40e_veb *floating_veb; /* Associated floating veb */
266         bool offset_loaded;
267         enum i40e_vsi_type type; /* VSI types */
268         uint16_t vlan_num;       /* Total VLAN number */
269         uint16_t mac_num;        /* Total mac number */
270         uint32_t vfta[I40E_VFTA_SIZE];        /* VLAN bitmap */
271         struct i40e_mac_filter_list mac_list; /* macvlan filter list */
272         /* specific VSI-defined parameters, SRIOV stored the vf_id */
273         uint32_t user_param;
274         uint16_t seid;           /* The seid of VSI itself */
275         uint16_t uplink_seid;    /* The uplink seid of this VSI */
276         uint16_t nb_qps;         /* Number of queue pairs VSI can occupy */
277         uint16_t nb_used_qps;    /* Number of queue pairs VSI uses */
278         uint16_t max_macaddrs;   /* Maximum number of MAC addresses */
279         uint16_t base_queue;     /* The first queue index of this VSI */
280         /*
281          * The offset to visit VSI related register, assigned by HW when
282          * creating VSI
283          */
284         uint16_t vsi_id;
285         uint16_t msix_intr; /* The MSIX interrupt binds to VSI */
286         uint16_t nb_msix;   /* The max number of msix vector */
287         uint8_t enabled_tc; /* The traffic class enabled */
288         struct i40e_bw_info bw_info; /* VSI bandwidth information */
289 };
290
291 struct pool_entry {
292         LIST_ENTRY(pool_entry) next;
293         uint16_t base;
294         uint16_t len;
295 };
296
297 LIST_HEAD(res_list, pool_entry);
298
299 struct i40e_res_pool_info {
300         uint32_t base;              /* Resource start index */
301         uint32_t num_alloc;         /* Allocated resource number */
302         uint32_t num_free;          /* Total available resource number */
303         struct res_list alloc_list; /* Allocated resource list */
304         struct res_list free_list;  /* Available resource list */
305 };
306
307 enum I40E_VF_STATE {
308         I40E_VF_INACTIVE = 0,
309         I40E_VF_INRESET,
310         I40E_VF_ININIT,
311         I40E_VF_ACTIVE,
312 };
313
314 /*
315  * Structure to store private data for PF host.
316  */
317 struct i40e_pf_vf {
318         struct i40e_pf *pf;
319         struct i40e_vsi *vsi;
320         enum I40E_VF_STATE state; /* The number of queue pairs availiable */
321         uint16_t vf_idx; /* VF index in pf->vfs */
322         uint16_t lan_nb_qps; /* Actual queues allocated */
323         uint16_t reset_cnt; /* Total vf reset times */
324         struct ether_addr mac_addr;  /* Default MAC address */
325 };
326
327 /*
328  * Structure to store private data for flow control.
329  */
330 struct i40e_fc_conf {
331         uint16_t pause_time; /* Flow control pause timer */
332         /* FC high water 0-7 for pfc and 8 for lfc unit:kilobytes */
333         uint32_t high_water[I40E_MAX_TRAFFIC_CLASS + 1];
334         /* FC low water  0-7 for pfc and 8 for lfc unit:kilobytes */
335         uint32_t low_water[I40E_MAX_TRAFFIC_CLASS + 1];
336 };
337
338 /*
339  * Structure to store private data for VMDQ instance
340  */
341 struct i40e_vmdq_info {
342         struct i40e_pf *pf;
343         struct i40e_vsi *vsi;
344 };
345
346 /*
347  * Structure to store flex pit for flow diretor.
348  */
349 struct i40e_fdir_flex_pit {
350         uint8_t src_offset;    /* offset in words from the beginning of payload */
351         uint8_t size;          /* size in words */
352         uint8_t dst_offset;    /* offset in words of flexible payload */
353 };
354
355 struct i40e_fdir_flex_mask {
356         uint8_t word_mask;  /**< Bit i enables word i of flexible payload */
357         struct {
358                 uint8_t offset;
359                 uint16_t mask;
360         } bitmask[I40E_FDIR_BITMASK_NUM_WORD];
361 };
362
363 #define I40E_FILTER_PCTYPE_MAX 64
364 /*
365  *  A structure used to define fields of a FDIR related info.
366  */
367 struct i40e_fdir_info {
368         struct i40e_vsi *fdir_vsi;     /* pointer to fdir VSI structure */
369         uint16_t match_counter_index;  /* Statistic counter index used for fdir*/
370         struct i40e_tx_queue *txq;
371         struct i40e_rx_queue *rxq;
372         void *prg_pkt;                 /* memory for fdir program packet */
373         uint64_t dma_addr;             /* physic address of packet memory*/
374         /* input set bits for each pctype */
375         uint64_t input_set[I40E_FILTER_PCTYPE_MAX];
376         /*
377          * the rule how bytes stream is extracted as flexible payload
378          * for each payload layer, the setting can up to three elements
379          */
380         struct i40e_fdir_flex_pit flex_set[I40E_MAX_FLXPLD_LAYER * I40E_MAX_FLXPLD_FIED];
381         struct i40e_fdir_flex_mask flex_mask[I40E_FILTER_PCTYPE_MAX];
382 };
383
384 #define I40E_MIRROR_MAX_ENTRIES_PER_RULE   64
385 #define I40E_MAX_MIRROR_RULES           64
386 /*
387  * Mirror rule structure
388  */
389 struct i40e_mirror_rule {
390         TAILQ_ENTRY(i40e_mirror_rule) rules;
391         uint8_t rule_type;
392         uint16_t index;          /* the sw index of mirror rule */
393         uint16_t id;             /* the rule id assigned by firmware */
394         uint16_t dst_vsi_seid;   /* destination vsi for this mirror rule. */
395         uint16_t num_entries;
396         /* the info stores depend on the rule type.
397             If type is I40E_MIRROR_TYPE_VLAN, vlan ids are stored here.
398             If type is I40E_MIRROR_TYPE_VPORT_*, vsi's seid are stored.
399          */
400         uint16_t entries[I40E_MIRROR_MAX_ENTRIES_PER_RULE];
401 };
402
403 TAILQ_HEAD(i40e_mirror_rule_list, i40e_mirror_rule);
404
405 /*
406  * Structure to store private data specific for PF instance.
407  */
408 struct i40e_pf {
409         struct i40e_adapter *adapter; /* The adapter this PF associate to */
410         struct i40e_vsi *main_vsi; /* pointer to main VSI structure */
411         uint16_t mac_seid; /* The seid of the MAC of this PF */
412         uint16_t main_vsi_seid; /* The seid of the main VSI */
413         uint16_t max_num_vsi;
414         struct i40e_res_pool_info qp_pool;    /*Queue pair pool */
415         struct i40e_res_pool_info msix_pool;  /* MSIX interrupt pool */
416
417         struct i40e_hw_port_stats stats_offset;
418         struct i40e_hw_port_stats stats;
419         bool offset_loaded;
420
421         struct rte_eth_dev_data *dev_data; /* Pointer to the device data */
422         struct ether_addr dev_addr; /* PF device mac address */
423         uint64_t flags; /* PF feature flags */
424         /* All kinds of queue pair setting for different VSIs */
425         struct i40e_pf_vf *vfs;
426         uint16_t vf_num;
427         /* Each of below queue pairs should be power of 2 since it's the
428            precondition after TC configuration applied */
429         uint16_t lan_nb_qp_max;
430         uint16_t lan_nb_qps; /* The number of queue pairs of LAN */
431         uint16_t lan_qp_offset;
432         uint16_t vmdq_nb_qp_max;
433         uint16_t vmdq_nb_qps; /* The number of queue pairs of VMDq */
434         uint16_t vmdq_qp_offset;
435         uint16_t vf_nb_qp_max;
436         uint16_t vf_nb_qps; /* The number of queue pairs of VF */
437         uint16_t vf_qp_offset;
438         uint16_t fdir_nb_qps; /* The number of queue pairs of Flow Director */
439         uint16_t fdir_qp_offset;
440
441         uint16_t hash_lut_size; /* The size of hash lookup table */
442         /* input set bits for each pctype */
443         uint64_t hash_input_set[I40E_FILTER_PCTYPE_MAX];
444         /* store VXLAN UDP ports */
445         uint16_t vxlan_ports[I40E_MAX_PF_UDP_OFFLOAD_PORTS];
446         uint16_t vxlan_bitmap; /* Vxlan bit mask */
447
448         /* VMDQ related info */
449         uint16_t max_nb_vmdq_vsi; /* Max number of VMDQ VSIs supported */
450         uint16_t nb_cfg_vmdq_vsi; /* number of VMDQ VSIs configured */
451         struct i40e_vmdq_info *vmdq;
452
453         struct i40e_fdir_info fdir; /* flow director info */
454         struct i40e_fc_conf fc_conf; /* Flow control conf */
455         struct i40e_mirror_rule_list mirror_list;
456         uint16_t nb_mirror_rule;   /* The number of mirror rules */
457         bool floating_veb; /* The flag to use the floating VEB */
458         /* The floating enable flag for the specific VF */
459         bool floating_veb_list[I40E_MAX_VF];
460 };
461
462 enum pending_msg {
463         PFMSG_LINK_CHANGE = 0x1,
464         PFMSG_RESET_IMPENDING = 0x2,
465         PFMSG_DRIVER_CLOSE = 0x4,
466 };
467
468 struct i40e_vsi_vlan_pvid_info {
469         uint16_t on;            /* Enable or disable pvid */
470         union {
471                 uint16_t pvid;  /* Valid in case 'on' is set to set pvid */
472                 struct {
473                 /*  Valid in case 'on' is cleared. 'tagged' will reject tagged packets,
474                  *  while 'untagged' will reject untagged packets.
475                  */
476                         uint8_t tagged;
477                         uint8_t untagged;
478                 } reject;
479         } config;
480 };
481
482 struct i40e_vf_rx_queues {
483         uint64_t rx_dma_addr;
484         uint32_t rx_ring_len;
485         uint32_t buff_size;
486 };
487
488 struct i40e_vf_tx_queues {
489         uint64_t tx_dma_addr;
490         uint32_t tx_ring_len;
491 };
492
493 /*
494  * Structure to store private data specific for VF instance.
495  */
496 struct i40e_vf {
497         struct i40e_adapter *adapter; /* The adapter this VF associate to */
498         struct rte_eth_dev_data *dev_data; /* Pointer to the device data */
499         uint16_t num_queue_pairs;
500         uint16_t max_pkt_len; /* Maximum packet length */
501         bool promisc_unicast_enabled;
502         bool promisc_multicast_enabled;
503
504         uint32_t version_major; /* Major version number */
505         uint32_t version_minor; /* Minor version number */
506         uint16_t promisc_flags; /* Promiscuous setting */
507         uint32_t vlan[I40E_VFTA_SIZE]; /* VLAN bit map */
508
509         /* Event from pf */
510         bool dev_closed;
511         bool link_up;
512         enum i40e_aq_link_speed link_speed;
513         bool vf_reset;
514         volatile uint32_t pend_cmd; /* pending command not finished yet */
515         uint32_t cmd_retval; /* return value of the cmd response from PF */
516         u16 pend_msg; /* flags indicates events from pf not handled yet */
517         uint8_t *aq_resp; /* buffer to store the adminq response from PF */
518
519         /* VSI info */
520         struct i40e_virtchnl_vf_resource *vf_res; /* All VSIs */
521         struct i40e_virtchnl_vsi_resource *vsi_res; /* LAN VSI */
522         struct i40e_vsi vsi;
523         uint64_t flags;
524 };
525
526 /*
527  * Structure to store private data for each PF/VF instance.
528  */
529 struct i40e_adapter {
530         /* Common for both PF and VF */
531         struct i40e_hw hw;
532         struct rte_eth_dev *eth_dev;
533
534         /* Specific for PF or VF */
535         union {
536                 struct i40e_pf pf;
537                 struct i40e_vf vf;
538         };
539
540         /* For vector PMD */
541         bool rx_bulk_alloc_allowed;
542         bool rx_vec_allowed;
543         bool tx_simple_allowed;
544         bool tx_vec_allowed;
545
546         /* For PTP */
547         struct rte_timecounter systime_tc;
548         struct rte_timecounter rx_tstamp_tc;
549         struct rte_timecounter tx_tstamp_tc;
550 };
551
552 int i40e_dev_switch_queues(struct i40e_pf *pf, bool on);
553 int i40e_vsi_release(struct i40e_vsi *vsi);
554 struct i40e_vsi *i40e_vsi_setup(struct i40e_pf *pf,
555                                 enum i40e_vsi_type type,
556                                 struct i40e_vsi *uplink_vsi,
557                                 uint16_t user_param);
558 int i40e_switch_rx_queue(struct i40e_hw *hw, uint16_t q_idx, bool on);
559 int i40e_switch_tx_queue(struct i40e_hw *hw, uint16_t q_idx, bool on);
560 int i40e_vsi_add_vlan(struct i40e_vsi *vsi, uint16_t vlan);
561 int i40e_vsi_delete_vlan(struct i40e_vsi *vsi, uint16_t vlan);
562 int i40e_vsi_add_mac(struct i40e_vsi *vsi, struct i40e_mac_filter_info *filter);
563 int i40e_vsi_delete_mac(struct i40e_vsi *vsi, struct ether_addr *addr);
564 void i40e_update_vsi_stats(struct i40e_vsi *vsi);
565 void i40e_pf_disable_irq0(struct i40e_hw *hw);
566 void i40e_pf_enable_irq0(struct i40e_hw *hw);
567 int i40e_dev_link_update(struct rte_eth_dev *dev,
568                          __rte_unused int wait_to_complete);
569 void i40e_vsi_queues_bind_intr(struct i40e_vsi *vsi);
570 void i40e_vsi_queues_unbind_intr(struct i40e_vsi *vsi);
571 int i40e_vsi_vlan_pvid_set(struct i40e_vsi *vsi,
572                            struct i40e_vsi_vlan_pvid_info *info);
573 int i40e_vsi_config_vlan_stripping(struct i40e_vsi *vsi, bool on);
574 int i40e_vsi_config_vlan_filter(struct i40e_vsi *vsi, bool on);
575 uint64_t i40e_config_hena(uint64_t flags);
576 uint64_t i40e_parse_hena(uint64_t flags);
577 enum i40e_status_code i40e_fdir_setup_tx_resources(struct i40e_pf *pf);
578 enum i40e_status_code i40e_fdir_setup_rx_resources(struct i40e_pf *pf);
579 int i40e_fdir_setup(struct i40e_pf *pf);
580 const struct rte_memzone *i40e_memzone_reserve(const char *name,
581                                         uint32_t len,
582                                         int socket_id);
583 int i40e_fdir_configure(struct rte_eth_dev *dev);
584 void i40e_fdir_teardown(struct i40e_pf *pf);
585 enum i40e_filter_pctype i40e_flowtype_to_pctype(uint16_t flow_type);
586 uint16_t i40e_pctype_to_flowtype(enum i40e_filter_pctype pctype);
587 int i40e_fdir_ctrl_func(struct rte_eth_dev *dev,
588                           enum rte_filter_op filter_op,
589                           void *arg);
590 int i40e_select_filter_input_set(struct i40e_hw *hw,
591                                  struct rte_eth_input_set_conf *conf,
592                                  enum rte_filter_type filter);
593 int i40e_hash_filter_inset_select(struct i40e_hw *hw,
594                              struct rte_eth_input_set_conf *conf);
595 int i40e_fdir_filter_inset_select(struct i40e_pf *pf,
596                              struct rte_eth_input_set_conf *conf);
597
598 void i40e_rxq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
599         struct rte_eth_rxq_info *qinfo);
600 void i40e_txq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
601         struct rte_eth_txq_info *qinfo);
602
603 /* I40E_DEV_PRIVATE_TO */
604 #define I40E_DEV_PRIVATE_TO_PF(adapter) \
605         (&((struct i40e_adapter *)adapter)->pf)
606 #define I40E_DEV_PRIVATE_TO_HW(adapter) \
607         (&((struct i40e_adapter *)adapter)->hw)
608 #define I40E_DEV_PRIVATE_TO_ADAPTER(adapter) \
609         ((struct i40e_adapter *)adapter)
610
611 /* I40EVF_DEV_PRIVATE_TO */
612 #define I40EVF_DEV_PRIVATE_TO_VF(adapter) \
613         (&((struct i40e_adapter *)adapter)->vf)
614
615 static inline struct i40e_vsi *
616 i40e_get_vsi_from_adapter(struct i40e_adapter *adapter)
617 {
618         struct i40e_hw *hw;
619
620         if (!adapter)
621                 return NULL;
622
623         hw = I40E_DEV_PRIVATE_TO_HW(adapter);
624         if (hw->mac.type == I40E_MAC_VF || hw->mac.type == I40E_MAC_X722_VF) {
625                 struct i40e_vf *vf = I40EVF_DEV_PRIVATE_TO_VF(adapter);
626                 return &vf->vsi;
627         } else {
628                 struct i40e_pf *pf = I40E_DEV_PRIVATE_TO_PF(adapter);
629                 return pf->main_vsi;
630         }
631 }
632 #define I40E_DEV_PRIVATE_TO_MAIN_VSI(adapter) \
633         i40e_get_vsi_from_adapter((struct i40e_adapter *)adapter)
634
635 /* I40E_VSI_TO */
636 #define I40E_VSI_TO_HW(vsi) \
637         (&(((struct i40e_vsi *)vsi)->adapter->hw))
638 #define I40E_VSI_TO_PF(vsi) \
639         (&(((struct i40e_vsi *)vsi)->adapter->pf))
640 #define I40E_VSI_TO_VF(vsi) \
641         (&(((struct i40e_vsi *)vsi)->adapter->vf))
642 #define I40E_VSI_TO_DEV_DATA(vsi) \
643         (((struct i40e_vsi *)vsi)->adapter->pf.dev_data)
644 #define I40E_VSI_TO_ETH_DEV(vsi) \
645         (((struct i40e_vsi *)vsi)->adapter->eth_dev)
646
647 /* I40E_PF_TO */
648 #define I40E_PF_TO_HW(pf) \
649         (&(((struct i40e_pf *)pf)->adapter->hw))
650 #define I40E_PF_TO_ADAPTER(pf) \
651         ((struct i40e_adapter *)pf->adapter)
652
653 /* I40E_VF_TO */
654 #define I40E_VF_TO_HW(vf) \
655         (&(((struct i40e_vf *)vf)->adapter->hw))
656
657 static inline void
658 i40e_init_adminq_parameter(struct i40e_hw *hw)
659 {
660         hw->aq.num_arq_entries = I40E_AQ_LEN;
661         hw->aq.num_asq_entries = I40E_AQ_LEN;
662         hw->aq.arq_buf_size = I40E_AQ_BUF_SZ;
663         hw->aq.asq_buf_size = I40E_AQ_BUF_SZ;
664 }
665
666 static inline int
667 i40e_align_floor(int n)
668 {
669         if (n == 0)
670                 return 0;
671         return 1 << (sizeof(n) * CHAR_BIT - 1 - __builtin_clz(n));
672 }
673
674 static inline uint16_t
675 i40e_calc_itr_interval(int16_t interval)
676 {
677         if (interval < 0 || interval > I40E_QUEUE_ITR_INTERVAL_MAX)
678                 interval = I40E_QUEUE_ITR_INTERVAL_DEFAULT;
679
680         /* Convert to hardware count, as writing each 1 represents 2 us */
681         return interval / 2;
682 }
683
684 #define I40E_VALID_FLOW(flow_type) \
685         ((flow_type) == RTE_ETH_FLOW_FRAG_IPV4 || \
686         (flow_type) == RTE_ETH_FLOW_NONFRAG_IPV4_TCP || \
687         (flow_type) == RTE_ETH_FLOW_NONFRAG_IPV4_UDP || \
688         (flow_type) == RTE_ETH_FLOW_NONFRAG_IPV4_SCTP || \
689         (flow_type) == RTE_ETH_FLOW_NONFRAG_IPV4_OTHER || \
690         (flow_type) == RTE_ETH_FLOW_FRAG_IPV6 || \
691         (flow_type) == RTE_ETH_FLOW_NONFRAG_IPV6_TCP || \
692         (flow_type) == RTE_ETH_FLOW_NONFRAG_IPV6_UDP || \
693         (flow_type) == RTE_ETH_FLOW_NONFRAG_IPV6_SCTP || \
694         (flow_type) == RTE_ETH_FLOW_NONFRAG_IPV6_OTHER || \
695         (flow_type) == RTE_ETH_FLOW_L2_PAYLOAD)
696
697 #define I40E_VALID_PCTYPE(pctype) \
698         ((pctype) == I40E_FILTER_PCTYPE_FRAG_IPV4 || \
699         (pctype) == I40E_FILTER_PCTYPE_NONF_IPV4_TCP || \
700         (pctype) == I40E_FILTER_PCTYPE_NONF_IPV4_UDP || \
701         (pctype) == I40E_FILTER_PCTYPE_NONF_IPV4_SCTP || \
702         (pctype) == I40E_FILTER_PCTYPE_NONF_IPV4_OTHER || \
703         (pctype) == I40E_FILTER_PCTYPE_FRAG_IPV6 || \
704         (pctype) == I40E_FILTER_PCTYPE_NONF_IPV6_UDP || \
705         (pctype) == I40E_FILTER_PCTYPE_NONF_IPV6_TCP || \
706         (pctype) == I40E_FILTER_PCTYPE_NONF_IPV6_SCTP || \
707         (pctype) == I40E_FILTER_PCTYPE_NONF_IPV6_OTHER || \
708         (pctype) == I40E_FILTER_PCTYPE_L2_PAYLOAD)
709
710 #endif /* _I40E_ETHDEV_H_ */