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