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