lib/librte_pmd_i40e/i40e_ethdev.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 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 #define I40E_AQ_LEN               32
  38 #define I40E_AQ_BUF_SZ            4096
  39 /* Number of queues per TC should be one of 1, 2, 4, 8, 16, 32, 64 */
  40 #define I40E_MAX_Q_PER_TC         64
  41 #define I40E_NUM_DESC_DEFAULT     512
  42 #define I40E_NUM_DESC_ALIGN       32
  43 #define I40E_BUF_SIZE_MIN         1024
  44 #define I40E_FRAME_SIZE_MAX       9728
  45 #define I40E_QUEUE_BASE_ADDR_UNIT 128
  46 /* number of VSIs and queue default setting */
  47 #define I40E_MAX_QP_NUM_PER_VF    16
  48 #define I40E_DEFAULT_QP_NUM_VMDQ  64
  49 #define I40E_DEFAULT_QP_NUM_FDIR  64
  50 #define I40E_UINT32_BIT_SIZE      (CHAR_BIT * sizeof(uint32_t))
  51 #define I40E_VFTA_SIZE            (4096 / I40E_UINT32_BIT_SIZE)
  52 /* Default TC traffic in case DCB is not enabled */
  53 #define I40E_DEFAULT_TCMAP        0x1
  54
  55 /* i40e flags */
  56 #define I40E_FLAG_RSS                   (1ULL << 0)
  57 #define I40E_FLAG_DCB                   (1ULL << 1)
  58 #define I40E_FLAG_VMDQ                  (1ULL << 2)
  59 #define I40E_FLAG_SRIOV                 (1ULL << 3)
  60 #define I40E_FLAG_HEADER_SPLIT_DISABLED (1ULL << 4)
  61 #define I40E_FLAG_HEADER_SPLIT_ENABLED  (1ULL << 5)
  62 #define I40E_FLAG_FDIR                  (1ULL << 6)
  63 #define I40E_FLAG_VXLAN                 (1ULL << 7)
  64 #define I40E_FLAG_ALL (I40E_FLAG_RSS | \
  65                        I40E_FLAG_DCB | \
  66                        I40E_FLAG_VMDQ | \
  67                        I40E_FLAG_SRIOV | \
  68                        I40E_FLAG_HEADER_SPLIT_DISABLED | \
  69                        I40E_FLAG_HEADER_SPLIT_ENABLED | \
  70                        I40E_FLAG_FDIR | \
  71                        I40E_FLAG_VXLAN)
  72
  73 #define I40E_RSS_OFFLOAD_ALL ( \
  74         ETH_RSS_NONF_IPV4_UDP | \
  75         ETH_RSS_NONF_IPV4_TCP | \
  76         ETH_RSS_NONF_IPV4_SCTP | \
  77         ETH_RSS_NONF_IPV4_OTHER | \
  78         ETH_RSS_FRAG_IPV4 | \
  79         ETH_RSS_NONF_IPV6_UDP | \
  80         ETH_RSS_NONF_IPV6_TCP | \
  81         ETH_RSS_NONF_IPV6_SCTP | \
  82         ETH_RSS_NONF_IPV6_OTHER | \
  83         ETH_RSS_FRAG_IPV6 | \
  84         ETH_RSS_L2_PAYLOAD)
  85
  86 /* All bits of RSS hash enable */
  87 #define I40E_RSS_HENA_ALL ( \
  88         (1ULL << I40E_FILTER_PCTYPE_NONF_IPV4_UDP) | \
  89         (1ULL << I40E_FILTER_PCTYPE_NONF_IPV4_TCP) | \
  90         (1ULL << I40E_FILTER_PCTYPE_NONF_IPV4_SCTP) | \
  91         (1ULL << I40E_FILTER_PCTYPE_NONF_IPV4_OTHER) | \
  92         (1ULL << I40E_FILTER_PCTYPE_FRAG_IPV4) | \
  93         (1ULL << I40E_FILTER_PCTYPE_NONF_IPV6_UDP) | \
  94         (1ULL << I40E_FILTER_PCTYPE_NONF_IPV6_TCP) | \
  95         (1ULL << I40E_FILTER_PCTYPE_NONF_IPV6_SCTP) | \
  96         (1ULL << I40E_FILTER_PCTYPE_NONF_IPV6_OTHER) | \
  97         (1ULL << I40E_FILTER_PCTYPE_FRAG_IPV6) | \
  98         (1ULL << I40E_FILTER_PCTYPE_FCOE_OX) | \
  99         (1ULL << I40E_FILTER_PCTYPE_FCOE_RX) | \
 100         (1ULL << I40E_FILTER_PCTYPE_FCOE_OTHER) | \
 101         (1ULL << I40E_FILTER_PCTYPE_L2_PAYLOAD))
 102
 103 struct i40e_adapter;
 104
 105 TAILQ_HEAD(i40e_mac_filter_list, i40e_mac_filter);
 106
 107 /* MAC filter list structure */
 108 struct i40e_mac_filter {
 109         TAILQ_ENTRY(i40e_mac_filter) next;
 110         struct ether_addr macaddr;
 111 };
 112
 113 TAILQ_HEAD(i40e_vsi_list_head, i40e_vsi_list);
 114
 115 struct i40e_vsi;
 116
 117 /* VSI list structure */
 118 struct i40e_vsi_list {
 119         TAILQ_ENTRY(i40e_vsi_list) list;
 120         struct i40e_vsi *vsi;
 121 };
 122
 123 struct i40e_rx_queue;
 124 struct i40e_tx_queue;
 125
 126 /* Structure that defines a VEB */
 127 struct i40e_veb {
 128         struct i40e_vsi_list_head head;
 129         struct i40e_vsi *associate_vsi; /* Associate VSI who owns the VEB */
 130         uint16_t seid; /* The seid of VEB itself */
 131         uint16_t uplink_seid; /* The uplink seid of this VEB */
 132         uint16_t stats_idx;
 133         struct i40e_eth_stats stats;
 134 };
 135
 136 /* MACVLAN filter structure */
 137 struct i40e_macvlan_filter {
 138         struct ether_addr macaddr;
 139         uint16_t vlan_id;
 140 };
 141 /*
 142  * Structure that defines a VSI, associated with a adapter.
 143  */
 144 struct i40e_vsi {
 145         struct i40e_adapter *adapter; /* Backreference to associated adapter */
 146         struct i40e_aqc_vsi_properties_data info; /* VSI properties */
 147
 148         struct i40e_eth_stats eth_stats_offset;
 149         struct i40e_eth_stats eth_stats;
 150         /*
 151          * When drivers loaded, only a default main VSI exists. In case new VSI
 152          * needs to add, HW needs to know the layout that VSIs are organized.
 153          * Besides that, VSI isan element and can't switch packets, which needs
 154          * to add new component VEB to perform switching. So, a new VSI needs
 155          * to specify the the uplink VSI (Parent VSI) before created. The
 156          * uplink VSI will check whether it had a VEB to switch packets. If no,
 157          * it will try to create one. Then, uplink VSI will move the new VSI
 158          * into its' sib_vsi_list to manage all the downlink VSI.
 159          *  sib_vsi_list: the VSI list that shared the same uplink VSI.
 160          *  parent_vsi  : the uplink VSI. It's NULL for main VSI.
 161          *  veb         : the VEB associates with the VSI.
 162          */
 163         struct i40e_vsi_list sib_vsi_list; /* sibling vsi list */
 164         struct i40e_vsi *parent_vsi;
 165         struct i40e_veb *veb;    /* Associated veb, could be null */
 166         bool offset_loaded;
 167         enum i40e_vsi_type type; /* VSI types */
 168         uint16_t vlan_num;       /* Total VLAN number */
 169         uint16_t mac_num;        /* Total mac number */
 170         uint32_t vfta[I40E_VFTA_SIZE];        /* VLAN bitmap */
 171         struct i40e_mac_filter_list mac_list; /* macvlan filter list */
 172         /* specific VSI-defined parameters, SRIOV stored the vf_id */
 173         uint32_t user_param;
 174         uint16_t seid;           /* The seid of VSI itself */
 175         uint16_t uplink_seid;    /* The uplink seid of this VSI */
 176         uint16_t nb_qps;         /* Number of queue pairs VSI can occupy */
 177         uint16_t max_macaddrs;   /* Maximum number of MAC addresses */
 178         uint16_t base_queue;     /* The first queue index of this VSI */
 179         /*
 180          * The offset to visit VSI related register, assigned by HW when
 181          * creating VSI
 182          */
 183         uint16_t vsi_id;
 184         uint16_t msix_intr; /* The MSIX interrupt binds to VSI */
 185         uint8_t enabled_tc; /* The traffic class enabled */
 186 };
 187
 188 struct pool_entry {
 189         LIST_ENTRY(pool_entry) next;
 190         uint16_t base;
 191         uint16_t len;
 192 };
 193
 194 LIST_HEAD(res_list, pool_entry);
 195
 196 struct i40e_res_pool_info {
 197         uint32_t base;              /* Resource start index */
 198         uint32_t num_alloc;         /* Allocated resource number */
 199         uint32_t num_free;          /* Total available resource number */
 200         struct res_list alloc_list; /* Allocated resource list */
 201         struct res_list free_list;  /* Available resource list */
 202 };
 203
 204 enum I40E_VF_STATE {
 205         I40E_VF_INACTIVE = 0,
 206         I40E_VF_INRESET,
 207         I40E_VF_ININIT,
 208         I40E_VF_ACTIVE,
 209 };
 210
 211 /*
 212  * Structure to store private data for PF host.
 213  */
 214 struct i40e_pf_vf {
 215         struct i40e_pf *pf;
 216         struct i40e_vsi *vsi;
 217         enum I40E_VF_STATE state; /* The number of queue pairs availiable */
 218         uint16_t vf_idx; /* VF index in pf->vfs */
 219         uint16_t lan_nb_qps; /* Actual queues allocated */
 220         uint16_t reset_cnt; /* Total vf reset times */
 221 };
 222
 223 /*
 224  * Structure to store private data specific for PF instance.
 225  */
 226 struct i40e_pf {
 227         struct i40e_adapter *adapter; /* The adapter this PF associate to */
 228         struct i40e_vsi *main_vsi; /* pointer to main VSI structure */
 229         uint16_t mac_seid; /* The seid of the MAC of this PF */
 230         uint16_t main_vsi_seid; /* The seid of the main VSI */
 231         uint16_t max_num_vsi;
 232         struct i40e_res_pool_info qp_pool;    /*Queue pair pool */
 233         struct i40e_res_pool_info msix_pool;  /* MSIX interrupt pool */
 234
 235         struct i40e_hw_port_stats stats_offset;
 236         struct i40e_hw_port_stats stats;
 237         bool offset_loaded;
 238
 239         struct rte_eth_dev_data *dev_data; /* Pointer to the device data */
 240         struct ether_addr dev_addr; /* PF device mac address */
 241         uint64_t flags; /* PF featuer flags */
 242         /* All kinds of queue pair setting for different VSIs */
 243         struct i40e_pf_vf *vfs;
 244         uint16_t vf_num;
 245         /* Each of below queue pairs should be power of 2 since it's the
 246            precondition after TC configuration applied */
 247         uint16_t lan_nb_qps; /* The number of queue pairs of LAN */
 248         uint16_t vmdq_nb_qps; /* The number of queue pairs of VMDq */
 249         uint16_t vf_nb_qps; /* The number of queue pairs of VF */
 250         uint16_t fdir_nb_qps; /* The number of queue pairs of Flow Director */
 251
 252         /* store VXLAN UDP ports */
 253         uint16_t vxlan_ports[I40E_MAX_PF_UDP_OFFLOAD_PORTS];
 254         uint16_t vxlan_bitmap; /* Vxlan bit mask */
 255 };
 256
 257 enum pending_msg {
 258         PFMSG_LINK_CHANGE = 0x1,
 259         PFMSG_RESET_IMPENDING = 0x2,
 260         PFMSG_DRIVER_CLOSE = 0x4,
 261 };
 262
 263 struct i40e_vsi_vlan_pvid_info {
 264         uint16_t on;            /* Enable or disable pvid */
 265         union {
 266                 uint16_t pvid;  /* Valid in case 'on' is set to set pvid */
 267                 struct {
 268                 /*  Valid in case 'on' is cleared. 'tagged' will reject tagged packets,
 269                  *  while 'untagged' will reject untagged packets.
 270                  */
 271                         uint8_t tagged;
 272                         uint8_t untagged;
 273                 } reject;
 274         } config;
 275 };
 276
 277 struct i40e_vf_rx_queues {
 278         uint64_t rx_dma_addr;
 279         uint32_t rx_ring_len;
 280         uint32_t buff_size;
 281 };
 282
 283 struct i40e_vf_tx_queues {
 284         uint64_t tx_dma_addr;
 285         uint32_t tx_ring_len;
 286 };
 287
 288 /*
 289  * Structure to store private data specific for VF instance.
 290  */
 291 struct i40e_vf {
 292         struct i40e_adapter *adapter; /* The adapter this VF associate to */
 293         struct rte_eth_dev_data *dev_data; /* Pointer to the device data */
 294         uint16_t num_queue_pairs;
 295         uint16_t max_pkt_len; /* Maximum packet length */
 296         bool promisc_unicast_enabled;
 297         bool promisc_multicast_enabled;
 298
 299         bool host_is_dpdk; /* The flag indicates if the host is DPDK */
 300         uint16_t promisc_flags; /* Promiscuous setting */
 301         uint32_t vlan[I40E_VFTA_SIZE]; /* VLAN bit map */
 302
 303         /* Event from pf */
 304         bool dev_closed;
 305         bool link_up;
 306         bool vf_reset;
 307         volatile uint32_t pend_cmd; /* pending command not finished yet */
 308         u16 pend_msg; /* flags indicates events from pf not handled yet */
 309
 310         /* VSI info */
 311         struct i40e_virtchnl_vf_resource *vf_res; /* All VSIs */
 312         struct i40e_virtchnl_vsi_resource *vsi_res; /* LAN VSI */
 313         struct i40e_vsi vsi;
 314 };
 315
 316 /*
 317  * Structure to store private data for each PF/VF instance.
 318  */
 319 struct i40e_adapter {
 320         /* Common for both PF and VF */
 321         struct i40e_hw hw;
 322         struct rte_eth_dev *eth_dev;
 323
 324         /* Specific for PF or VF */
 325         union {
 326                 struct i40e_pf pf;
 327                 struct i40e_vf vf;
 328         };
 329 };
 330
 331 int i40e_vsi_switch_queues(struct i40e_vsi *vsi, bool on);
 332 int i40e_vsi_release(struct i40e_vsi *vsi);
 333 struct i40e_vsi *i40e_vsi_setup(struct i40e_pf *pf,
 334                                 enum i40e_vsi_type type,
 335                                 struct i40e_vsi *uplink_vsi,
 336                                 uint16_t user_param);
 337 int i40e_switch_rx_queue(struct i40e_hw *hw, uint16_t q_idx, bool on);
 338 int i40e_switch_tx_queue(struct i40e_hw *hw, uint16_t q_idx, bool on);
 339 int i40e_vsi_add_vlan(struct i40e_vsi *vsi, uint16_t vlan);
 340 int i40e_vsi_delete_vlan(struct i40e_vsi *vsi, uint16_t vlan);
 341 int i40e_vsi_add_mac(struct i40e_vsi *vsi, struct ether_addr *addr);
 342 int i40e_vsi_delete_mac(struct i40e_vsi *vsi, struct ether_addr *addr);
 343 void i40e_update_vsi_stats(struct i40e_vsi *vsi);
 344 void i40e_pf_disable_irq0(struct i40e_hw *hw);
 345 void i40e_pf_enable_irq0(struct i40e_hw *hw);
 346 int i40e_dev_link_update(struct rte_eth_dev *dev,
 347                          __rte_unused int wait_to_complete);
 348 void i40e_vsi_queues_bind_intr(struct i40e_vsi *vsi);
 349 void i40e_vsi_queues_unbind_intr(struct i40e_vsi *vsi);
 350 int i40e_vsi_vlan_pvid_set(struct i40e_vsi *vsi,
 351                            struct i40e_vsi_vlan_pvid_info *info);
 352 int i40e_vsi_config_vlan_stripping(struct i40e_vsi *vsi, bool on);
 353 uint64_t i40e_config_hena(uint64_t flags);
 354 uint64_t i40e_parse_hena(uint64_t flags);
 355
 356 /* I40E_DEV_PRIVATE_TO */
 357 #define I40E_DEV_PRIVATE_TO_PF(adapter) \
 358         (&((struct i40e_adapter *)adapter)->pf)
 359 #define I40E_DEV_PRIVATE_TO_HW(adapter) \
 360         (&((struct i40e_adapter *)adapter)->hw)
 361 #define I40E_DEV_PRIVATE_TO_ADAPTER(adapter) \
 362         ((struct i40e_adapter *)adapter)
 363
 364 /* I40EVF_DEV_PRIVATE_TO */
 365 #define I40EVF_DEV_PRIVATE_TO_VF(adapter) \
 366         (&((struct i40e_adapter *)adapter)->vf)
 367
 368 static inline struct i40e_vsi *
 369 i40e_get_vsi_from_adapter(struct i40e_adapter *adapter)
 370 {
 371         struct i40e_hw *hw;
 372
 373         if (!adapter)
 374                 return NULL;
 375
 376         hw = I40E_DEV_PRIVATE_TO_HW(adapter);
 377         if (hw->mac.type == I40E_MAC_VF) {
 378                 struct i40e_vf *vf = I40EVF_DEV_PRIVATE_TO_VF(adapter);
 379                 return &vf->vsi;
 380         } else {
 381                 struct i40e_pf *pf = I40E_DEV_PRIVATE_TO_PF(adapter);
 382                 return pf->main_vsi;
 383         }
 384 }
 385 #define I40E_DEV_PRIVATE_TO_VSI(adapter) \
 386         i40e_get_vsi_from_adapter((struct i40e_adapter *)adapter)
 387
 388 /* I40E_VSI_TO */
 389 #define I40E_VSI_TO_HW(vsi) \
 390         (&(((struct i40e_vsi *)vsi)->adapter->hw))
 391 #define I40E_VSI_TO_PF(vsi) \
 392         (&(((struct i40e_vsi *)vsi)->adapter->pf))
 393 #define I40E_VSI_TO_DEV_DATA(vsi) \
 394         (((struct i40e_vsi *)vsi)->adapter->pf.dev_data)
 395 #define I40E_VSI_TO_ETH_DEV(vsi) \
 396         (((struct i40e_vsi *)vsi)->adapter->eth_dev)
 397
 398 /* I40E_PF_TO */
 399 #define I40E_PF_TO_HW(pf) \
 400         (&(((struct i40e_pf *)pf)->adapter->hw))
 401 #define I40E_PF_TO_ADAPTER(pf) \
 402         ((struct i40e_adapter *)pf->adapter)
 403
 404 /* I40E_VF_TO */
 405 #define I40E_VF_TO_HW(vf) \
 406         (&(((struct i40e_vf *)vf)->adapter->hw))
 407
 408 static inline void
 409 i40e_init_adminq_parameter(struct i40e_hw *hw)
 410 {
 411         hw->aq.num_arq_entries = I40E_AQ_LEN;
 412         hw->aq.num_asq_entries = I40E_AQ_LEN;
 413         hw->aq.arq_buf_size = I40E_AQ_BUF_SZ;
 414         hw->aq.asq_buf_size = I40E_AQ_BUF_SZ;
 415 }
 416
 417 #endif /* _I40E_ETHDEV_H_ */