New upstream version 17.08
[deb_dpdk.git] / drivers / net / ixgbe / ixgbe_ethdev.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2016 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 _IXGBE_ETHDEV_H_
35 #define _IXGBE_ETHDEV_H_
36 #include "base/ixgbe_type.h"
37 #include "base/ixgbe_dcb.h"
38 #include "base/ixgbe_dcb_82599.h"
39 #include "base/ixgbe_dcb_82598.h"
40 #include "ixgbe_bypass.h"
41 #include <rte_time.h>
42 #include <rte_hash.h>
43 #include <rte_pci.h>
44 #include <rte_tm_driver.h>
45
46 /* need update link, bit flag */
47 #define IXGBE_FLAG_NEED_LINK_UPDATE (uint32_t)(1 << 0)
48 #define IXGBE_FLAG_MAILBOX          (uint32_t)(1 << 1)
49 #define IXGBE_FLAG_PHY_INTERRUPT    (uint32_t)(1 << 2)
50 #define IXGBE_FLAG_MACSEC           (uint32_t)(1 << 3)
51 #define IXGBE_FLAG_NEED_LINK_CONFIG (uint32_t)(1 << 4)
52
53 /*
54  * Defines that were not part of ixgbe_type.h as they are not used by the
55  * FreeBSD driver.
56  */
57 #define IXGBE_ADVTXD_MAC_1588       0x00080000 /* IEEE1588 Timestamp packet */
58 #define IXGBE_RXD_STAT_TMST         0x10000    /* Timestamped Packet indication */
59 #define IXGBE_ADVTXD_TUCMD_L4T_RSV  0x00001800 /* L4 Packet TYPE, resvd  */
60 #define IXGBE_RXDADV_ERR_CKSUM_BIT  30
61 #define IXGBE_RXDADV_ERR_CKSUM_MSK  3
62 #define IXGBE_ADVTXD_MACLEN_SHIFT   9          /* Bit shift for l2_len */
63 #define IXGBE_NB_STAT_MAPPING_REGS  32
64 #define IXGBE_EXTENDED_VLAN       (uint32_t)(1 << 26) /* EXTENDED VLAN ENABLE */
65 #define IXGBE_VFTA_SIZE 128
66 #define IXGBE_VLAN_TAG_SIZE 4
67 #define IXGBE_MAX_RX_QUEUE_NUM  128
68 #define IXGBE_MAX_INTR_QUEUE_NUM        15
69 #define IXGBE_VMDQ_DCB_NB_QUEUES     IXGBE_MAX_RX_QUEUE_NUM
70 #define IXGBE_DCB_NB_QUEUES          IXGBE_MAX_RX_QUEUE_NUM
71 #define IXGBE_NONE_MODE_TX_NB_QUEUES 64
72
73 #ifndef NBBY
74 #define NBBY    8       /* number of bits in a byte */
75 #endif
76 #define IXGBE_HWSTRIP_BITMAP_SIZE (IXGBE_MAX_RX_QUEUE_NUM / (sizeof(uint32_t) * NBBY))
77
78 /* EITR Interval is in 2048ns uinits for 1G and 10G link */
79 #define IXGBE_EITR_INTERVAL_UNIT_NS     2048
80 #define IXGBE_EITR_ITR_INT_SHIFT       3
81 #define IXGBE_EITR_INTERVAL_US(us) \
82         (((us) * 1000 / IXGBE_EITR_INTERVAL_UNIT_NS << IXGBE_EITR_ITR_INT_SHIFT) & \
83                 IXGBE_EITR_ITR_INT_MASK)
84
85
86 /* Loopback operation modes */
87 /* 82599 specific loopback operation types */
88 #define IXGBE_LPBK_82599_NONE   0x0 /* Default value. Loopback is disabled. */
89 #define IXGBE_LPBK_82599_TX_RX  0x1 /* Tx->Rx loopback operation is enabled. */
90
91 #define IXGBE_MAX_JUMBO_FRAME_SIZE      0x2600 /* Maximum Jumbo frame size. */
92
93 #define IXGBE_RTTBCNRC_RF_INT_MASK_BASE 0x000003FF
94 #define IXGBE_RTTBCNRC_RF_INT_MASK_M \
95         (IXGBE_RTTBCNRC_RF_INT_MASK_BASE << IXGBE_RTTBCNRC_RF_INT_SHIFT)
96
97 #define IXGBE_MAX_QUEUE_NUM_PER_VF  8
98
99 #define IXGBE_SYN_FILTER_ENABLE         0x00000001 /* syn filter enable field */
100 #define IXGBE_SYN_FILTER_QUEUE          0x000000FE /* syn filter queue field */
101 #define IXGBE_SYN_FILTER_QUEUE_SHIFT    1          /* syn filter queue field shift */
102 #define IXGBE_SYN_FILTER_SYNQFP         0x80000000 /* syn filter SYNQFP */
103
104 #define IXGBE_ETQF_UP                   0x00070000 /* ethertype filter priority field */
105 #define IXGBE_ETQF_SHIFT                16
106 #define IXGBE_ETQF_UP_EN                0x00080000
107 #define IXGBE_ETQF_ETHERTYPE            0x0000FFFF /* ethertype filter ethertype field */
108 #define IXGBE_ETQF_MAX_PRI              7
109
110 #define IXGBE_SDPQF_DSTPORT             0xFFFF0000 /* dst port field */
111 #define IXGBE_SDPQF_DSTPORT_SHIFT       16         /* dst port field shift */
112 #define IXGBE_SDPQF_SRCPORT             0x0000FFFF /* src port field */
113
114 #define IXGBE_L34T_IMIR_SIZE_BP         0x00001000
115 #define IXGBE_L34T_IMIR_RESERVE         0x00080000 /* bit 13 to 19 must be set to 1000000b. */
116 #define IXGBE_L34T_IMIR_LLI             0x00100000
117 #define IXGBE_L34T_IMIR_QUEUE           0x0FE00000
118 #define IXGBE_L34T_IMIR_QUEUE_SHIFT     21
119 #define IXGBE_5TUPLE_MAX_PRI            7
120 #define IXGBE_5TUPLE_MIN_PRI            1
121
122 #define IXGBE_RSS_OFFLOAD_ALL ( \
123         ETH_RSS_IPV4 | \
124         ETH_RSS_NONFRAG_IPV4_TCP | \
125         ETH_RSS_NONFRAG_IPV4_UDP | \
126         ETH_RSS_IPV6 | \
127         ETH_RSS_NONFRAG_IPV6_TCP | \
128         ETH_RSS_NONFRAG_IPV6_UDP | \
129         ETH_RSS_IPV6_EX | \
130         ETH_RSS_IPV6_TCP_EX | \
131         ETH_RSS_IPV6_UDP_EX)
132
133 #define IXGBE_VF_IRQ_ENABLE_MASK        3          /* vf irq enable mask */
134 #define IXGBE_VF_MAXMSIVECTOR           1
135
136 #define IXGBE_MISC_VEC_ID               RTE_INTR_VEC_ZERO_OFFSET
137 #define IXGBE_RX_VEC_START              RTE_INTR_VEC_RXTX_OFFSET
138
139 #define IXGBE_SECTX_MINSECIFG_MASK      0x0000000F
140
141 #define IXGBE_MACSEC_PNTHRSH            0xFFFFFE00
142
143 #define IXGBE_MAX_FDIR_FILTER_NUM       (1024 * 32)
144 #define IXGBE_MAX_L2_TN_FILTER_NUM      128
145
146 #define MAC_TYPE_FILTER_SUP_EXT(type)    do {\
147         if ((type) != ixgbe_mac_82599EB && (type) != ixgbe_mac_X540)\
148                 return -ENOTSUP;\
149 } while (0)
150
151 #define MAC_TYPE_FILTER_SUP(type)    do {\
152         if ((type) != ixgbe_mac_82599EB && (type) != ixgbe_mac_X540 &&\
153                 (type) != ixgbe_mac_X550 && (type) != ixgbe_mac_X550EM_x &&\
154                 (type) != ixgbe_mac_X550EM_a)\
155                 return -ENOTSUP;\
156 } while (0)
157
158 /* Link speed for X550 auto negotiation */
159 #define IXGBE_LINK_SPEED_X550_AUTONEG   (IXGBE_LINK_SPEED_100_FULL | \
160                                          IXGBE_LINK_SPEED_1GB_FULL | \
161                                          IXGBE_LINK_SPEED_2_5GB_FULL | \
162                                          IXGBE_LINK_SPEED_5GB_FULL | \
163                                          IXGBE_LINK_SPEED_10GB_FULL)
164
165 /*
166  * Information about the fdir mode.
167  */
168 struct ixgbe_hw_fdir_mask {
169         uint16_t vlan_tci_mask;
170         uint32_t src_ipv4_mask;
171         uint32_t dst_ipv4_mask;
172         uint16_t src_ipv6_mask;
173         uint16_t dst_ipv6_mask;
174         uint16_t src_port_mask;
175         uint16_t dst_port_mask;
176         uint16_t flex_bytes_mask;
177         uint8_t  mac_addr_byte_mask;
178         uint32_t tunnel_id_mask;
179         uint8_t  tunnel_type_mask;
180 };
181
182 struct ixgbe_fdir_filter {
183         TAILQ_ENTRY(ixgbe_fdir_filter) entries;
184         union ixgbe_atr_input ixgbe_fdir; /* key of fdir filter*/
185         uint32_t fdirflags; /* drop or forward */
186         uint32_t fdirhash; /* hash value for fdir */
187         uint8_t queue; /* assigned rx queue */
188 };
189
190 /* list of fdir filters */
191 TAILQ_HEAD(ixgbe_fdir_filter_list, ixgbe_fdir_filter);
192
193 struct ixgbe_fdir_rule {
194         struct ixgbe_hw_fdir_mask mask;
195         union ixgbe_atr_input ixgbe_fdir; /* key of fdir filter*/
196         bool b_spec; /* If TRUE, ixgbe_fdir, fdirflags, queue have meaning. */
197         bool b_mask; /* If TRUE, mask has meaning. */
198         enum rte_fdir_mode mode; /* IP, MAC VLAN, Tunnel */
199         uint32_t fdirflags; /* drop or forward */
200         uint32_t soft_id; /* an unique value for this rule */
201         uint8_t queue; /* assigned rx queue */
202         uint8_t flex_bytes_offset;
203 };
204
205 struct ixgbe_hw_fdir_info {
206         struct ixgbe_hw_fdir_mask mask;
207         uint8_t     flex_bytes_offset;
208         uint16_t    collision;
209         uint16_t    free;
210         uint16_t    maxhash;
211         uint8_t     maxlen;
212         uint64_t    add;
213         uint64_t    remove;
214         uint64_t    f_add;
215         uint64_t    f_remove;
216         struct ixgbe_fdir_filter_list fdir_list; /* filter list*/
217         /* store the pointers of the filters, index is the hash value. */
218         struct ixgbe_fdir_filter **hash_map;
219         struct rte_hash *hash_handle; /* cuckoo hash handler */
220         bool mask_added; /* If already got mask from consistent filter */
221 };
222
223 /* structure for interrupt relative data */
224 struct ixgbe_interrupt {
225         uint32_t flags;
226         uint32_t mask;
227         /*to save original mask during delayed handler */
228         uint32_t mask_original;
229 };
230
231 struct ixgbe_stat_mapping_registers {
232         uint32_t tqsm[IXGBE_NB_STAT_MAPPING_REGS];
233         uint32_t rqsmr[IXGBE_NB_STAT_MAPPING_REGS];
234 };
235
236 struct ixgbe_vfta {
237         uint32_t vfta[IXGBE_VFTA_SIZE];
238 };
239
240 struct ixgbe_hwstrip {
241         uint32_t bitmap[IXGBE_HWSTRIP_BITMAP_SIZE];
242 };
243
244 /*
245  * VF data which used by PF host only
246  */
247 #define IXGBE_MAX_VF_MC_ENTRIES         30
248 #define IXGBE_MAX_MR_RULE_ENTRIES       4 /* number of mirroring rules supported */
249 #define IXGBE_MAX_UTA                   128
250
251 struct ixgbe_uta_info {
252         uint8_t  uc_filter_type;
253         uint16_t uta_in_use;
254         uint32_t uta_shadow[IXGBE_MAX_UTA];
255 };
256
257 #define IXGBE_MAX_MIRROR_RULES 4  /* Maximum nb. of mirror rules. */
258
259 struct ixgbe_mirror_info {
260         struct rte_eth_mirror_conf mr_conf[IXGBE_MAX_MIRROR_RULES];
261         /**< store PF mirror rules configuration*/
262 };
263
264 struct ixgbe_vf_info {
265         uint8_t vf_mac_addresses[ETHER_ADDR_LEN];
266         uint16_t vf_mc_hashes[IXGBE_MAX_VF_MC_ENTRIES];
267         uint16_t num_vf_mc_hashes;
268         uint16_t default_vf_vlan_id;
269         uint16_t vlans_enabled;
270         bool clear_to_send;
271         uint16_t tx_rate[IXGBE_MAX_QUEUE_NUM_PER_VF];
272         uint16_t vlan_count;
273         uint8_t spoofchk_enabled;
274         uint8_t api_version;
275 };
276
277 /*
278  *  Possible l4type of 5tuple filters.
279  */
280 enum ixgbe_5tuple_protocol {
281         IXGBE_FILTER_PROTOCOL_TCP = 0,
282         IXGBE_FILTER_PROTOCOL_UDP,
283         IXGBE_FILTER_PROTOCOL_SCTP,
284         IXGBE_FILTER_PROTOCOL_NONE,
285 };
286
287 TAILQ_HEAD(ixgbe_5tuple_filter_list, ixgbe_5tuple_filter);
288
289 struct ixgbe_5tuple_filter_info {
290         uint32_t dst_ip;
291         uint32_t src_ip;
292         uint16_t dst_port;
293         uint16_t src_port;
294         enum ixgbe_5tuple_protocol proto;        /* l4 protocol. */
295         uint8_t priority;        /* seven levels (001b-111b), 111b is highest,
296                                       used when more than one filter matches. */
297         uint8_t dst_ip_mask:1,   /* if mask is 1b, do not compare dst ip. */
298                 src_ip_mask:1,   /* if mask is 1b, do not compare src ip. */
299                 dst_port_mask:1, /* if mask is 1b, do not compare dst port. */
300                 src_port_mask:1, /* if mask is 1b, do not compare src port. */
301                 proto_mask:1;    /* if mask is 1b, do not compare protocol. */
302 };
303
304 /* 5tuple filter structure */
305 struct ixgbe_5tuple_filter {
306         TAILQ_ENTRY(ixgbe_5tuple_filter) entries;
307         uint16_t index;       /* the index of 5tuple filter */
308         struct ixgbe_5tuple_filter_info filter_info;
309         uint16_t queue;       /* rx queue assigned to */
310 };
311
312 #define IXGBE_5TUPLE_ARRAY_SIZE \
313         (RTE_ALIGN(IXGBE_MAX_FTQF_FILTERS, (sizeof(uint32_t) * NBBY)) / \
314          (sizeof(uint32_t) * NBBY))
315
316 struct ixgbe_ethertype_filter {
317         uint16_t ethertype;
318         uint32_t etqf;
319         uint32_t etqs;
320         /**
321          * If this filter is added by configuration,
322          * it should not be removed.
323          */
324         bool     conf;
325 };
326
327 /*
328  * Structure to store filters' info.
329  */
330 struct ixgbe_filter_info {
331         uint8_t ethertype_mask;  /* Bit mask for every used ethertype filter */
332         /* store used ethertype filters*/
333         struct ixgbe_ethertype_filter ethertype_filters[IXGBE_MAX_ETQF_FILTERS];
334         /* Bit mask for every used 5tuple filter */
335         uint32_t fivetuple_mask[IXGBE_5TUPLE_ARRAY_SIZE];
336         struct ixgbe_5tuple_filter_list fivetuple_list;
337         /* store the SYN filter info */
338         uint32_t syn_info;
339 };
340
341 struct ixgbe_l2_tn_key {
342         enum rte_eth_tunnel_type          l2_tn_type;
343         uint32_t                          tn_id;
344 };
345
346 struct ixgbe_l2_tn_filter {
347         TAILQ_ENTRY(ixgbe_l2_tn_filter)    entries;
348         struct ixgbe_l2_tn_key             key;
349         uint32_t                           pool;
350 };
351
352 TAILQ_HEAD(ixgbe_l2_tn_filter_list, ixgbe_l2_tn_filter);
353
354 struct ixgbe_l2_tn_info {
355         struct ixgbe_l2_tn_filter_list      l2_tn_list;
356         struct ixgbe_l2_tn_filter         **hash_map;
357         struct rte_hash                    *hash_handle;
358         bool e_tag_en; /* e-tag enabled */
359         bool e_tag_fwd_en; /* e-tag based forwarding enabled */
360         bool e_tag_ether_type; /* ether type for e-tag */
361 };
362
363 struct rte_flow {
364         enum rte_filter_type filter_type;
365         void *rule;
366 };
367 /* ntuple filter list structure */
368 struct ixgbe_ntuple_filter_ele {
369         TAILQ_ENTRY(ixgbe_ntuple_filter_ele) entries;
370         struct rte_eth_ntuple_filter filter_info;
371 };
372 /* ethertype filter list structure */
373 struct ixgbe_ethertype_filter_ele {
374         TAILQ_ENTRY(ixgbe_ethertype_filter_ele) entries;
375         struct rte_eth_ethertype_filter filter_info;
376 };
377 /* syn filter list structure */
378 struct ixgbe_eth_syn_filter_ele {
379         TAILQ_ENTRY(ixgbe_eth_syn_filter_ele) entries;
380         struct rte_eth_syn_filter filter_info;
381 };
382 /* fdir filter list structure */
383 struct ixgbe_fdir_rule_ele {
384         TAILQ_ENTRY(ixgbe_fdir_rule_ele) entries;
385         struct ixgbe_fdir_rule filter_info;
386 };
387 /* l2_tunnel filter list structure */
388 struct ixgbe_eth_l2_tunnel_conf_ele {
389         TAILQ_ENTRY(ixgbe_eth_l2_tunnel_conf_ele) entries;
390         struct rte_eth_l2_tunnel_conf filter_info;
391 };
392 /* ixgbe_flow memory list structure */
393 struct ixgbe_flow_mem {
394         TAILQ_ENTRY(ixgbe_flow_mem) entries;
395         struct rte_flow *flow;
396 };
397
398 TAILQ_HEAD(ixgbe_ntuple_filter_list, ixgbe_ntuple_filter_ele);
399 struct ixgbe_ntuple_filter_list filter_ntuple_list;
400 TAILQ_HEAD(ixgbe_ethertype_filter_list, ixgbe_ethertype_filter_ele);
401 struct ixgbe_ethertype_filter_list filter_ethertype_list;
402 TAILQ_HEAD(ixgbe_syn_filter_list, ixgbe_eth_syn_filter_ele);
403 struct ixgbe_syn_filter_list filter_syn_list;
404 TAILQ_HEAD(ixgbe_fdir_rule_filter_list, ixgbe_fdir_rule_ele);
405 struct ixgbe_fdir_rule_filter_list filter_fdir_list;
406 TAILQ_HEAD(ixgbe_l2_tunnel_filter_list, ixgbe_eth_l2_tunnel_conf_ele);
407 struct ixgbe_l2_tunnel_filter_list filter_l2_tunnel_list;
408 TAILQ_HEAD(ixgbe_flow_mem_list, ixgbe_flow_mem);
409 struct ixgbe_flow_mem_list ixgbe_flow_list;
410
411 /*
412  * Statistics counters collected by the MACsec
413  */
414 struct ixgbe_macsec_stats {
415         /* TX port statistics */
416         uint64_t out_pkts_untagged;
417         uint64_t out_pkts_encrypted;
418         uint64_t out_pkts_protected;
419         uint64_t out_octets_encrypted;
420         uint64_t out_octets_protected;
421
422         /* RX port statistics */
423         uint64_t in_pkts_untagged;
424         uint64_t in_pkts_badtag;
425         uint64_t in_pkts_nosci;
426         uint64_t in_pkts_unknownsci;
427         uint64_t in_octets_decrypted;
428         uint64_t in_octets_validated;
429
430         /* RX SC statistics */
431         uint64_t in_pkts_unchecked;
432         uint64_t in_pkts_delayed;
433         uint64_t in_pkts_late;
434
435         /* RX SA statistics */
436         uint64_t in_pkts_ok;
437         uint64_t in_pkts_invalid;
438         uint64_t in_pkts_notvalid;
439         uint64_t in_pkts_unusedsa;
440         uint64_t in_pkts_notusingsa;
441 };
442
443 /* The configuration of bandwidth */
444 struct ixgbe_bw_conf {
445         uint8_t tc_num; /* Number of TCs. */
446 };
447
448 /* Struct to store Traffic Manager shaper profile. */
449 struct ixgbe_tm_shaper_profile {
450         TAILQ_ENTRY(ixgbe_tm_shaper_profile) node;
451         uint32_t shaper_profile_id;
452         uint32_t reference_count;
453         struct rte_tm_shaper_params profile;
454 };
455
456 TAILQ_HEAD(ixgbe_shaper_profile_list, ixgbe_tm_shaper_profile);
457
458 /* node type of Traffic Manager */
459 enum ixgbe_tm_node_type {
460         IXGBE_TM_NODE_TYPE_PORT,
461         IXGBE_TM_NODE_TYPE_TC,
462         IXGBE_TM_NODE_TYPE_QUEUE,
463         IXGBE_TM_NODE_TYPE_MAX,
464 };
465
466 /* Struct to store Traffic Manager node configuration. */
467 struct ixgbe_tm_node {
468         TAILQ_ENTRY(ixgbe_tm_node) node;
469         uint32_t id;
470         uint32_t priority;
471         uint32_t weight;
472         uint32_t reference_count;
473         uint16_t no;
474         struct ixgbe_tm_node *parent;
475         struct ixgbe_tm_shaper_profile *shaper_profile;
476         struct rte_tm_node_params params;
477 };
478
479 TAILQ_HEAD(ixgbe_tm_node_list, ixgbe_tm_node);
480
481 /* The configuration of Traffic Manager */
482 struct ixgbe_tm_conf {
483         struct ixgbe_shaper_profile_list shaper_profile_list;
484         struct ixgbe_tm_node *root; /* root node - port */
485         struct ixgbe_tm_node_list tc_list; /* node list for all the TCs */
486         struct ixgbe_tm_node_list queue_list; /* node list for all the queues */
487         /**
488          * The number of added TC nodes.
489          * It should be no more than the TC number of this port.
490          */
491         uint32_t nb_tc_node;
492         /**
493          * The number of added queue nodes.
494          * It should be no more than the queue number of this port.
495          */
496         uint32_t nb_queue_node;
497         /**
498          * This flag is used to check if APP can change the TM node
499          * configuration.
500          * When it's true, means the configuration is applied to HW,
501          * APP should not change the configuration.
502          * As we don't support on-the-fly configuration, when starting
503          * the port, APP should call the hierarchy_commit API to set this
504          * flag to true. When stopping the port, this flag should be set
505          * to false.
506          */
507         bool committed;
508 };
509
510 /*
511  * Structure to store private data for each driver instance (for each port).
512  */
513 struct ixgbe_adapter {
514         struct ixgbe_hw             hw;
515         struct ixgbe_hw_stats       stats;
516         struct ixgbe_macsec_stats   macsec_stats;
517         struct ixgbe_hw_fdir_info   fdir;
518         struct ixgbe_interrupt      intr;
519         struct ixgbe_stat_mapping_registers stat_mappings;
520         struct ixgbe_vfta           shadow_vfta;
521         struct ixgbe_hwstrip            hwstrip;
522         struct ixgbe_dcb_config     dcb_config;
523         struct ixgbe_mirror_info    mr_data;
524         struct ixgbe_vf_info        *vfdata;
525         struct ixgbe_uta_info       uta_info;
526 #ifdef RTE_LIBRTE_IXGBE_BYPASS
527         struct ixgbe_bypass_info    bps;
528 #endif /* RTE_LIBRTE_IXGBE_BYPASS */
529         struct ixgbe_filter_info    filter;
530         struct ixgbe_l2_tn_info     l2_tn;
531         struct ixgbe_bw_conf        bw_conf;
532
533         bool rx_bulk_alloc_allowed;
534         bool rx_vec_allowed;
535         struct rte_timecounter      systime_tc;
536         struct rte_timecounter      rx_tstamp_tc;
537         struct rte_timecounter      tx_tstamp_tc;
538         struct ixgbe_tm_conf        tm_conf;
539 };
540
541 #define IXGBE_DEV_PRIVATE_TO_HW(adapter)\
542         (&((struct ixgbe_adapter *)adapter)->hw)
543
544 #define IXGBE_DEV_PRIVATE_TO_STATS(adapter) \
545         (&((struct ixgbe_adapter *)adapter)->stats)
546
547 #define IXGBE_DEV_PRIVATE_TO_MACSEC_STATS(adapter) \
548         (&((struct ixgbe_adapter *)adapter)->macsec_stats)
549
550 #define IXGBE_DEV_PRIVATE_TO_INTR(adapter) \
551         (&((struct ixgbe_adapter *)adapter)->intr)
552
553 #define IXGBE_DEV_PRIVATE_TO_FDIR_INFO(adapter) \
554         (&((struct ixgbe_adapter *)adapter)->fdir)
555
556 #define IXGBE_DEV_PRIVATE_TO_STAT_MAPPINGS(adapter) \
557         (&((struct ixgbe_adapter *)adapter)->stat_mappings)
558
559 #define IXGBE_DEV_PRIVATE_TO_VFTA(adapter) \
560         (&((struct ixgbe_adapter *)adapter)->shadow_vfta)
561
562 #define IXGBE_DEV_PRIVATE_TO_HWSTRIP_BITMAP(adapter) \
563         (&((struct ixgbe_adapter *)adapter)->hwstrip)
564
565 #define IXGBE_DEV_PRIVATE_TO_DCB_CFG(adapter) \
566         (&((struct ixgbe_adapter *)adapter)->dcb_config)
567
568 #define IXGBE_DEV_PRIVATE_TO_P_VFDATA(adapter) \
569         (&((struct ixgbe_adapter *)adapter)->vfdata)
570
571 #define IXGBE_DEV_PRIVATE_TO_PFDATA(adapter) \
572         (&((struct ixgbe_adapter *)adapter)->mr_data)
573
574 #define IXGBE_DEV_PRIVATE_TO_UTA(adapter) \
575         (&((struct ixgbe_adapter *)adapter)->uta_info)
576
577 #define IXGBE_DEV_PRIVATE_TO_FILTER_INFO(adapter) \
578         (&((struct ixgbe_adapter *)adapter)->filter)
579
580 #define IXGBE_DEV_PRIVATE_TO_L2_TN_INFO(adapter) \
581         (&((struct ixgbe_adapter *)adapter)->l2_tn)
582
583 #define IXGBE_DEV_PRIVATE_TO_BW_CONF(adapter) \
584         (&((struct ixgbe_adapter *)adapter)->bw_conf)
585
586 #define IXGBE_DEV_PRIVATE_TO_TM_CONF(adapter) \
587         (&((struct ixgbe_adapter *)adapter)->tm_conf)
588
589 /*
590  * RX/TX function prototypes
591  */
592 void ixgbe_dev_clear_queues(struct rte_eth_dev *dev);
593
594 void ixgbe_dev_free_queues(struct rte_eth_dev *dev);
595
596 void ixgbe_dev_rx_queue_release(void *rxq);
597
598 void ixgbe_dev_tx_queue_release(void *txq);
599
600 int  ixgbe_dev_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
601                 uint16_t nb_rx_desc, unsigned int socket_id,
602                 const struct rte_eth_rxconf *rx_conf,
603                 struct rte_mempool *mb_pool);
604
605 int  ixgbe_dev_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
606                 uint16_t nb_tx_desc, unsigned int socket_id,
607                 const struct rte_eth_txconf *tx_conf);
608
609 uint32_t ixgbe_dev_rx_queue_count(struct rte_eth_dev *dev,
610                 uint16_t rx_queue_id);
611
612 int ixgbe_dev_rx_descriptor_done(void *rx_queue, uint16_t offset);
613
614 int ixgbe_dev_rx_descriptor_status(void *rx_queue, uint16_t offset);
615 int ixgbe_dev_tx_descriptor_status(void *tx_queue, uint16_t offset);
616
617 int ixgbe_dev_rx_init(struct rte_eth_dev *dev);
618
619 void ixgbe_dev_tx_init(struct rte_eth_dev *dev);
620
621 int ixgbe_dev_rxtx_start(struct rte_eth_dev *dev);
622
623 int ixgbe_dev_rx_queue_start(struct rte_eth_dev *dev, uint16_t rx_queue_id);
624
625 int ixgbe_dev_rx_queue_stop(struct rte_eth_dev *dev, uint16_t rx_queue_id);
626
627 int ixgbe_dev_tx_queue_start(struct rte_eth_dev *dev, uint16_t tx_queue_id);
628
629 int ixgbe_dev_tx_queue_stop(struct rte_eth_dev *dev, uint16_t tx_queue_id);
630
631 void ixgbe_rxq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
632         struct rte_eth_rxq_info *qinfo);
633
634 void ixgbe_txq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
635         struct rte_eth_txq_info *qinfo);
636
637 int ixgbevf_dev_rx_init(struct rte_eth_dev *dev);
638
639 void ixgbevf_dev_tx_init(struct rte_eth_dev *dev);
640
641 void ixgbevf_dev_rxtx_start(struct rte_eth_dev *dev);
642
643 uint16_t ixgbe_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
644                 uint16_t nb_pkts);
645
646 uint16_t ixgbe_recv_pkts_bulk_alloc(void *rx_queue, struct rte_mbuf **rx_pkts,
647                                     uint16_t nb_pkts);
648
649 uint16_t ixgbe_recv_pkts_lro_single_alloc(void *rx_queue,
650                 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
651 uint16_t ixgbe_recv_pkts_lro_bulk_alloc(void *rx_queue,
652                 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
653
654 uint16_t ixgbe_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
655                 uint16_t nb_pkts);
656
657 uint16_t ixgbe_xmit_pkts_simple(void *tx_queue, struct rte_mbuf **tx_pkts,
658                 uint16_t nb_pkts);
659
660 uint16_t ixgbe_prep_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
661                 uint16_t nb_pkts);
662
663 int ixgbe_dev_rss_hash_update(struct rte_eth_dev *dev,
664                               struct rte_eth_rss_conf *rss_conf);
665
666 int ixgbe_dev_rss_hash_conf_get(struct rte_eth_dev *dev,
667                                 struct rte_eth_rss_conf *rss_conf);
668
669 uint16_t ixgbe_reta_size_get(enum ixgbe_mac_type mac_type);
670
671 uint32_t ixgbe_reta_reg_get(enum ixgbe_mac_type mac_type, uint16_t reta_idx);
672
673 uint32_t ixgbe_mrqc_reg_get(enum ixgbe_mac_type mac_type);
674
675 uint32_t ixgbe_rssrk_reg_get(enum ixgbe_mac_type mac_type, uint8_t i);
676
677 bool ixgbe_rss_update_sp(enum ixgbe_mac_type mac_type);
678
679 int ixgbe_add_del_ntuple_filter(struct rte_eth_dev *dev,
680                         struct rte_eth_ntuple_filter *filter,
681                         bool add);
682 int ixgbe_add_del_ethertype_filter(struct rte_eth_dev *dev,
683                         struct rte_eth_ethertype_filter *filter,
684                         bool add);
685 int ixgbe_syn_filter_set(struct rte_eth_dev *dev,
686                         struct rte_eth_syn_filter *filter,
687                         bool add);
688 int
689 ixgbe_dev_l2_tunnel_filter_add(struct rte_eth_dev *dev,
690                                struct rte_eth_l2_tunnel_conf *l2_tunnel,
691                                bool restore);
692 int
693 ixgbe_dev_l2_tunnel_filter_del(struct rte_eth_dev *dev,
694                                struct rte_eth_l2_tunnel_conf *l2_tunnel);
695 void ixgbe_filterlist_flush(void);
696 /*
697  * Flow director function prototypes
698  */
699 int ixgbe_fdir_configure(struct rte_eth_dev *dev);
700 int ixgbe_fdir_set_input_mask(struct rte_eth_dev *dev);
701 int ixgbe_fdir_set_flexbytes_offset(struct rte_eth_dev *dev,
702                                     uint16_t offset);
703 int ixgbe_fdir_filter_program(struct rte_eth_dev *dev,
704                               struct ixgbe_fdir_rule *rule,
705                               bool del, bool update);
706
707 void ixgbe_configure_dcb(struct rte_eth_dev *dev);
708
709 /*
710  * misc function prototypes
711  */
712 void ixgbe_vlan_hw_filter_enable(struct rte_eth_dev *dev);
713
714 void ixgbe_vlan_hw_filter_disable(struct rte_eth_dev *dev);
715
716 void ixgbe_vlan_hw_strip_enable_all(struct rte_eth_dev *dev);
717
718 void ixgbe_vlan_hw_strip_disable_all(struct rte_eth_dev *dev);
719
720 void ixgbe_pf_host_init(struct rte_eth_dev *eth_dev);
721
722 void ixgbe_pf_host_uninit(struct rte_eth_dev *eth_dev);
723
724 void ixgbe_pf_mbx_process(struct rte_eth_dev *eth_dev);
725
726 int ixgbe_pf_host_configure(struct rte_eth_dev *eth_dev);
727
728 uint32_t ixgbe_convert_vm_rx_mask_to_val(uint16_t rx_mask, uint32_t orig_val);
729
730 int ixgbe_fdir_ctrl_func(struct rte_eth_dev *dev,
731                         enum rte_filter_op filter_op, void *arg);
732 void ixgbe_fdir_filter_restore(struct rte_eth_dev *dev);
733 int ixgbe_clear_all_fdir_filter(struct rte_eth_dev *dev);
734
735 extern const struct rte_flow_ops ixgbe_flow_ops;
736
737 void ixgbe_clear_all_ethertype_filter(struct rte_eth_dev *dev);
738 void ixgbe_clear_all_ntuple_filter(struct rte_eth_dev *dev);
739 void ixgbe_clear_syn_filter(struct rte_eth_dev *dev);
740 int ixgbe_clear_all_l2_tn_filter(struct rte_eth_dev *dev);
741
742 int ixgbe_disable_sec_tx_path_generic(struct ixgbe_hw *hw);
743
744 int ixgbe_enable_sec_tx_path_generic(struct ixgbe_hw *hw);
745
746 int ixgbe_vt_check(struct ixgbe_hw *hw);
747 int ixgbe_set_vf_rate_limit(struct rte_eth_dev *dev, uint16_t vf,
748                             uint16_t tx_rate, uint64_t q_msk);
749 bool is_ixgbe_supported(struct rte_eth_dev *dev);
750 int ixgbe_tm_ops_get(struct rte_eth_dev *dev, void *ops);
751 void ixgbe_tm_conf_init(struct rte_eth_dev *dev);
752 void ixgbe_tm_conf_uninit(struct rte_eth_dev *dev);
753 int ixgbe_set_queue_rate_limit(struct rte_eth_dev *dev, uint16_t queue_idx,
754                                uint16_t tx_rate);
755
756 static inline int
757 ixgbe_ethertype_filter_lookup(struct ixgbe_filter_info *filter_info,
758                               uint16_t ethertype)
759 {
760         int i;
761
762         for (i = 0; i < IXGBE_MAX_ETQF_FILTERS; i++) {
763                 if (filter_info->ethertype_filters[i].ethertype == ethertype &&
764                     (filter_info->ethertype_mask & (1 << i)))
765                         return i;
766         }
767         return -1;
768 }
769
770 static inline int
771 ixgbe_ethertype_filter_insert(struct ixgbe_filter_info *filter_info,
772                               struct ixgbe_ethertype_filter *ethertype_filter)
773 {
774         int i;
775
776         for (i = 0; i < IXGBE_MAX_ETQF_FILTERS; i++) {
777                 if (!(filter_info->ethertype_mask & (1 << i))) {
778                         filter_info->ethertype_mask |= 1 << i;
779                         filter_info->ethertype_filters[i].ethertype =
780                                 ethertype_filter->ethertype;
781                         filter_info->ethertype_filters[i].etqf =
782                                 ethertype_filter->etqf;
783                         filter_info->ethertype_filters[i].etqs =
784                                 ethertype_filter->etqs;
785                         filter_info->ethertype_filters[i].conf =
786                                 ethertype_filter->conf;
787                         return i;
788                 }
789         }
790         return -1;
791 }
792
793 static inline int
794 ixgbe_ethertype_filter_remove(struct ixgbe_filter_info *filter_info,
795                               uint8_t idx)
796 {
797         if (idx >= IXGBE_MAX_ETQF_FILTERS)
798                 return -1;
799         filter_info->ethertype_mask &= ~(1 << idx);
800         filter_info->ethertype_filters[idx].ethertype = 0;
801         filter_info->ethertype_filters[idx].etqf = 0;
802         filter_info->ethertype_filters[idx].etqs = 0;
803         filter_info->ethertype_filters[idx].etqs = FALSE;
804         return idx;
805 }
806
807 #endif /* _IXGBE_ETHDEV_H_ */