drivers/net/ixgbe/ixgbe_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 _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
  41 /* need update link, bit flag */
  42 #define IXGBE_FLAG_NEED_LINK_UPDATE (uint32_t)(1 << 0)
  43 #define IXGBE_FLAG_MAILBOX          (uint32_t)(1 << 1)
  44
  45 /*
  46  * Defines that were not part of ixgbe_type.h as they are not used by the
  47  * FreeBSD driver.
  48  */
  49 #define IXGBE_ADVTXD_MAC_1588       0x00080000 /* IEEE1588 Timestamp packet */
  50 #define IXGBE_RXD_STAT_TMST         0x10000    /* Timestamped Packet indication */
  51 #define IXGBE_ADVTXD_TUCMD_L4T_RSV  0x00001800 /* L4 Packet TYPE, resvd  */
  52 #define IXGBE_RXDADV_ERR_CKSUM_BIT  30
  53 #define IXGBE_RXDADV_ERR_CKSUM_MSK  3
  54 #define IXGBE_ADVTXD_MACLEN_SHIFT   9          /* Bit shift for l2_len */
  55 #define IXGBE_NB_STAT_MAPPING_REGS  32
  56 #define IXGBE_EXTENDED_VLAN       (uint32_t)(1 << 26) /* EXTENDED VLAN ENABLE */
  57 #define IXGBE_VFTA_SIZE 128
  58 #define IXGBE_VLAN_TAG_SIZE 4
  59 #define IXGBE_MAX_RX_QUEUE_NUM  128
  60 #define IXGBE_VMDQ_DCB_NB_QUEUES     IXGBE_MAX_RX_QUEUE_NUM
  61 #define IXGBE_DCB_NB_QUEUES          IXGBE_MAX_RX_QUEUE_NUM
  62
  63 #ifndef NBBY
  64 #define NBBY    8       /* number of bits in a byte */
  65 #endif
  66 #define IXGBE_HWSTRIP_BITMAP_SIZE (IXGBE_MAX_RX_QUEUE_NUM / (sizeof(uint32_t) * NBBY))
  67
  68 /* EITR Inteval is in 2048ns uinits for 1G and 10G link */
  69 #define IXGBE_EITR_INTERVAL_UNIT_NS     2048
  70 #define IXGBE_EITR_ITR_INT_SHIFT       3
  71 #define IXGBE_EITR_INTERVAL_US(us) \
  72         (((us) * 1000 / IXGBE_EITR_INTERVAL_UNIT_NS << IXGBE_EITR_ITR_INT_SHIFT) & \
  73                 IXGBE_EITR_ITR_INT_MASK)
  74
  75
  76 /* Loopback operation modes */
  77 /* 82599 specific loopback operation types */
  78 #define IXGBE_LPBK_82599_NONE   0x0 /* Default value. Loopback is disabled. */
  79 #define IXGBE_LPBK_82599_TX_RX  0x1 /* Tx->Rx loopback operation is enabled. */
  80
  81 #define IXGBE_MAX_JUMBO_FRAME_SIZE      0x2600 /* Maximum Jumbo frame size. */
  82
  83 #define IXGBE_RTTBCNRC_RF_INT_MASK_BASE 0x000003FF
  84 #define IXGBE_RTTBCNRC_RF_INT_MASK_M \
  85         (IXGBE_RTTBCNRC_RF_INT_MASK_BASE << IXGBE_RTTBCNRC_RF_INT_SHIFT)
  86
  87 #define IXGBE_MAX_QUEUE_NUM_PER_VF  8
  88
  89 #define IXGBE_SYN_FILTER_ENABLE         0x00000001 /* syn filter enable field */
  90 #define IXGBE_SYN_FILTER_QUEUE          0x000000FE /* syn filter queue field */
  91 #define IXGBE_SYN_FILTER_QUEUE_SHIFT    1          /* syn filter queue field shift */
  92 #define IXGBE_SYN_FILTER_SYNQFP         0x80000000 /* syn filter SYNQFP */
  93
  94 #define IXGBE_ETQF_UP                   0x00070000 /* ethertype filter priority field */
  95 #define IXGBE_ETQF_SHIFT                16
  96 #define IXGBE_ETQF_UP_EN                0x00080000
  97 #define IXGBE_ETQF_ETHERTYPE            0x0000FFFF /* ethertype filter ethertype field */
  98 #define IXGBE_ETQF_MAX_PRI              7
  99
 100 #define IXGBE_SDPQF_DSTPORT             0xFFFF0000 /* dst port field */
 101 #define IXGBE_SDPQF_DSTPORT_SHIFT       16         /* dst port field shift */
 102 #define IXGBE_SDPQF_SRCPORT             0x0000FFFF /* src port field */
 103
 104 #define IXGBE_L34T_IMIR_SIZE_BP         0x00001000
 105 #define IXGBE_L34T_IMIR_RESERVE         0x00080000 /* bit 13 to 19 must be set to 1000000b. */
 106 #define IXGBE_L34T_IMIR_LLI             0x00100000
 107 #define IXGBE_L34T_IMIR_QUEUE           0x0FE00000
 108 #define IXGBE_L34T_IMIR_QUEUE_SHIFT     21
 109 #define IXGBE_5TUPLE_MAX_PRI            7
 110 #define IXGBE_5TUPLE_MIN_PRI            1
 111
 112 #define IXGBE_RSS_OFFLOAD_ALL ( \
 113         ETH_RSS_IPV4 | \
 114         ETH_RSS_NONFRAG_IPV4_TCP | \
 115         ETH_RSS_NONFRAG_IPV4_UDP | \
 116         ETH_RSS_IPV6 | \
 117         ETH_RSS_NONFRAG_IPV6_TCP | \
 118         ETH_RSS_NONFRAG_IPV6_UDP | \
 119         ETH_RSS_IPV6_EX | \
 120         ETH_RSS_IPV6_TCP_EX | \
 121         ETH_RSS_IPV6_UDP_EX)
 122
 123 #define IXGBE_VF_IRQ_ENABLE_MASK        3          /* vf irq enable mask */
 124 #define IXGBE_VF_MAXMSIVECTOR           1
 125
 126 /*
 127  * Information about the fdir mode.
 128  */
 129
 130 struct ixgbe_hw_fdir_mask {
 131         uint16_t vlan_tci_mask;
 132         uint32_t src_ipv4_mask;
 133         uint32_t dst_ipv4_mask;
 134         uint16_t src_ipv6_mask;
 135         uint16_t dst_ipv6_mask;
 136         uint16_t src_port_mask;
 137         uint16_t dst_port_mask;
 138         uint16_t flex_bytes_mask;
 139         uint8_t  mac_addr_byte_mask;
 140         uint32_t tunnel_id_mask;
 141         uint8_t  tunnel_type_mask;
 142 };
 143
 144 struct ixgbe_hw_fdir_info {
 145         struct ixgbe_hw_fdir_mask mask;
 146         uint8_t     flex_bytes_offset;
 147         uint16_t    collision;
 148         uint16_t    free;
 149         uint16_t    maxhash;
 150         uint8_t     maxlen;
 151         uint64_t    add;
 152         uint64_t    remove;
 153         uint64_t    f_add;
 154         uint64_t    f_remove;
 155 };
 156
 157 /* structure for interrupt relative data */
 158 struct ixgbe_interrupt {
 159         uint32_t flags;
 160         uint32_t mask;
 161 };
 162
 163 struct ixgbe_stat_mapping_registers {
 164         uint32_t tqsm[IXGBE_NB_STAT_MAPPING_REGS];
 165         uint32_t rqsmr[IXGBE_NB_STAT_MAPPING_REGS];
 166 };
 167
 168 struct ixgbe_vfta {
 169         uint32_t vfta[IXGBE_VFTA_SIZE];
 170 };
 171
 172 struct ixgbe_hwstrip {
 173         uint32_t bitmap[IXGBE_HWSTRIP_BITMAP_SIZE];
 174 };
 175
 176 /*
 177  * VF data which used by PF host only
 178  */
 179 #define IXGBE_MAX_VF_MC_ENTRIES         30
 180 #define IXGBE_MAX_MR_RULE_ENTRIES       4 /* number of mirroring rules supported */
 181 #define IXGBE_MAX_UTA                   128
 182
 183 struct ixgbe_uta_info {
 184         uint8_t  uc_filter_type;
 185         uint16_t uta_in_use;
 186         uint32_t uta_shadow[IXGBE_MAX_UTA];
 187 };
 188
 189 #define IXGBE_MAX_MIRROR_RULES 4  /* Maximum nb. of mirror rules. */
 190
 191 struct ixgbe_mirror_info {
 192         struct rte_eth_mirror_conf mr_conf[IXGBE_MAX_MIRROR_RULES];
 193         /**< store PF mirror rules configuration*/
 194 };
 195
 196 struct ixgbe_vf_info {
 197         uint8_t vf_mac_addresses[ETHER_ADDR_LEN];
 198         uint16_t vf_mc_hashes[IXGBE_MAX_VF_MC_ENTRIES];
 199         uint16_t num_vf_mc_hashes;
 200         uint16_t default_vf_vlan_id;
 201         uint16_t vlans_enabled;
 202         bool clear_to_send;
 203         uint16_t tx_rate[IXGBE_MAX_QUEUE_NUM_PER_VF];
 204         uint16_t vlan_count;
 205         uint8_t spoofchk_enabled;
 206         uint8_t api_version;
 207 };
 208
 209 /*
 210  *  Possible l4type of 5tuple filters.
 211  */
 212 enum ixgbe_5tuple_protocol {
 213         IXGBE_FILTER_PROTOCOL_TCP = 0,
 214         IXGBE_FILTER_PROTOCOL_UDP,
 215         IXGBE_FILTER_PROTOCOL_SCTP,
 216         IXGBE_FILTER_PROTOCOL_NONE,
 217 };
 218
 219 TAILQ_HEAD(ixgbe_5tuple_filter_list, ixgbe_5tuple_filter);
 220
 221 struct ixgbe_5tuple_filter_info {
 222         uint32_t dst_ip;
 223         uint32_t src_ip;
 224         uint16_t dst_port;
 225         uint16_t src_port;
 226         enum ixgbe_5tuple_protocol proto;        /* l4 protocol. */
 227         uint8_t priority;        /* seven levels (001b-111b), 111b is highest,
 228                                       used when more than one filter matches. */
 229         uint8_t dst_ip_mask:1,   /* if mask is 1b, do not compare dst ip. */
 230                 src_ip_mask:1,   /* if mask is 1b, do not compare src ip. */
 231                 dst_port_mask:1, /* if mask is 1b, do not compare dst port. */
 232                 src_port_mask:1, /* if mask is 1b, do not compare src port. */
 233                 proto_mask:1;    /* if mask is 1b, do not compare protocol. */
 234 };
 235
 236 /* 5tuple filter structure */
 237 struct ixgbe_5tuple_filter {
 238         TAILQ_ENTRY(ixgbe_5tuple_filter) entries;
 239         uint16_t index;       /* the index of 5tuple filter */
 240         struct ixgbe_5tuple_filter_info filter_info;
 241         uint16_t queue;       /* rx queue assigned to */
 242 };
 243
 244 #define IXGBE_5TUPLE_ARRAY_SIZE \
 245         (RTE_ALIGN(IXGBE_MAX_FTQF_FILTERS, (sizeof(uint32_t) * NBBY)) / \
 246          (sizeof(uint32_t) * NBBY))
 247
 248 /*
 249  * Structure to store filters' info.
 250  */
 251 struct ixgbe_filter_info {
 252         uint8_t ethertype_mask;  /* Bit mask for every used ethertype filter */
 253         /* store used ethertype filters*/
 254         uint16_t ethertype_filters[IXGBE_MAX_ETQF_FILTERS];
 255         /* Bit mask for every used 5tuple filter */
 256         uint32_t fivetuple_mask[IXGBE_5TUPLE_ARRAY_SIZE];
 257         struct ixgbe_5tuple_filter_list fivetuple_list;
 258 };
 259
 260 /*
 261  * Structure to store private data for each driver instance (for each port).
 262  */
 263 struct ixgbe_adapter {
 264         struct ixgbe_hw             hw;
 265         struct ixgbe_hw_stats       stats;
 266         struct ixgbe_hw_fdir_info   fdir;
 267         struct ixgbe_interrupt      intr;
 268         struct ixgbe_stat_mapping_registers stat_mappings;
 269         struct ixgbe_vfta           shadow_vfta;
 270         struct ixgbe_hwstrip            hwstrip;
 271         struct ixgbe_dcb_config     dcb_config;
 272         struct ixgbe_mirror_info    mr_data;
 273         struct ixgbe_vf_info        *vfdata;
 274         struct ixgbe_uta_info       uta_info;
 275 #ifdef RTE_NIC_BYPASS
 276         struct ixgbe_bypass_info    bps;
 277 #endif /* RTE_NIC_BYPASS */
 278         struct ixgbe_filter_info    filter;
 279
 280         bool rx_bulk_alloc_allowed;
 281         bool rx_vec_allowed;
 282 };
 283
 284 #define IXGBE_DEV_PRIVATE_TO_HW(adapter)\
 285         (&((struct ixgbe_adapter *)adapter)->hw)
 286
 287 #define IXGBE_DEV_PRIVATE_TO_STATS(adapter) \
 288         (&((struct ixgbe_adapter *)adapter)->stats)
 289
 290 #define IXGBE_DEV_PRIVATE_TO_INTR(adapter) \
 291         (&((struct ixgbe_adapter *)adapter)->intr)
 292
 293 #define IXGBE_DEV_PRIVATE_TO_FDIR_INFO(adapter) \
 294         (&((struct ixgbe_adapter *)adapter)->fdir)
 295
 296 #define IXGBE_DEV_PRIVATE_TO_STAT_MAPPINGS(adapter) \
 297         (&((struct ixgbe_adapter *)adapter)->stat_mappings)
 298
 299 #define IXGBE_DEV_PRIVATE_TO_VFTA(adapter) \
 300         (&((struct ixgbe_adapter *)adapter)->shadow_vfta)
 301
 302 #define IXGBE_DEV_PRIVATE_TO_HWSTRIP_BITMAP(adapter) \
 303         (&((struct ixgbe_adapter *)adapter)->hwstrip)
 304
 305 #define IXGBE_DEV_PRIVATE_TO_DCB_CFG(adapter) \
 306         (&((struct ixgbe_adapter *)adapter)->dcb_config)
 307
 308 #define IXGBE_DEV_PRIVATE_TO_P_VFDATA(adapter) \
 309         (&((struct ixgbe_adapter *)adapter)->vfdata)
 310
 311 #define IXGBE_DEV_PRIVATE_TO_PFDATA(adapter) \
 312         (&((struct ixgbe_adapter *)adapter)->mr_data)
 313
 314 #define IXGBE_DEV_PRIVATE_TO_UTA(adapter) \
 315         (&((struct ixgbe_adapter *)adapter)->uta_info)
 316
 317 #define IXGBE_DEV_PRIVATE_TO_FILTER_INFO(adapter) \
 318         (&((struct ixgbe_adapter *)adapter)->filter)
 319
 320 /*
 321  * RX/TX function prototypes
 322  */
 323 void ixgbe_dev_clear_queues(struct rte_eth_dev *dev);
 324
 325 void ixgbe_dev_free_queues(struct rte_eth_dev *dev);
 326
 327 void ixgbe_dev_rx_queue_release(void *rxq);
 328
 329 void ixgbe_dev_tx_queue_release(void *txq);
 330
 331 int  ixgbe_dev_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
 332                 uint16_t nb_rx_desc, unsigned int socket_id,
 333                 const struct rte_eth_rxconf *rx_conf,
 334                 struct rte_mempool *mb_pool);
 335
 336 int  ixgbe_dev_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
 337                 uint16_t nb_tx_desc, unsigned int socket_id,
 338                 const struct rte_eth_txconf *tx_conf);
 339
 340 uint32_t ixgbe_dev_rx_queue_count(struct rte_eth_dev *dev,
 341                 uint16_t rx_queue_id);
 342
 343 int ixgbe_dev_rx_descriptor_done(void *rx_queue, uint16_t offset);
 344 int ixgbevf_dev_rx_descriptor_done(void *rx_queue, uint16_t offset);
 345
 346 int ixgbe_dev_rx_init(struct rte_eth_dev *dev);
 347
 348 void ixgbe_dev_tx_init(struct rte_eth_dev *dev);
 349
 350 int ixgbe_dev_rxtx_start(struct rte_eth_dev *dev);
 351
 352 int ixgbe_dev_rx_queue_start(struct rte_eth_dev *dev, uint16_t rx_queue_id);
 353
 354 int ixgbe_dev_rx_queue_stop(struct rte_eth_dev *dev, uint16_t rx_queue_id);
 355
 356 int ixgbe_dev_tx_queue_start(struct rte_eth_dev *dev, uint16_t tx_queue_id);
 357
 358 int ixgbe_dev_tx_queue_stop(struct rte_eth_dev *dev, uint16_t tx_queue_id);
 359
 360 int ixgbevf_dev_rx_init(struct rte_eth_dev *dev);
 361
 362 void ixgbevf_dev_tx_init(struct rte_eth_dev *dev);
 363
 364 void ixgbevf_dev_rxtx_start(struct rte_eth_dev *dev);
 365
 366 uint16_t ixgbe_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 367                 uint16_t nb_pkts);
 368
 369 uint16_t ixgbe_recv_pkts_lro_single_alloc(void *rx_queue,
 370                 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
 371 uint16_t ixgbe_recv_pkts_lro_bulk_alloc(void *rx_queue,
 372                 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
 373
 374 uint16_t ixgbe_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 375                 uint16_t nb_pkts);
 376
 377 uint16_t ixgbe_xmit_pkts_simple(void *tx_queue, struct rte_mbuf **tx_pkts,
 378                 uint16_t nb_pkts);
 379
 380 int ixgbe_dev_rss_hash_update(struct rte_eth_dev *dev,
 381                               struct rte_eth_rss_conf *rss_conf);
 382
 383 int ixgbe_dev_rss_hash_conf_get(struct rte_eth_dev *dev,
 384                                 struct rte_eth_rss_conf *rss_conf);
 385
 386 uint16_t ixgbe_reta_size_get(enum ixgbe_mac_type mac_type);
 387
 388 uint32_t ixgbe_reta_reg_get(enum ixgbe_mac_type mac_type, uint16_t reta_idx);
 389
 390 uint32_t ixgbe_mrqc_reg_get(enum ixgbe_mac_type mac_type);
 391
 392 uint32_t ixgbe_rssrk_reg_get(enum ixgbe_mac_type mac_type, uint8_t i);
 393
 394 bool ixgbe_rss_update_sp(enum ixgbe_mac_type mac_type);
 395
 396 /*
 397  * Flow director function prototypes
 398  */
 399 int ixgbe_fdir_configure(struct rte_eth_dev *dev);
 400
 401 void ixgbe_configure_dcb(struct rte_eth_dev *dev);
 402
 403 /*
 404  * misc function prototypes
 405  */
 406 void ixgbe_vlan_hw_filter_enable(struct rte_eth_dev *dev);
 407
 408 void ixgbe_vlan_hw_filter_disable(struct rte_eth_dev *dev);
 409
 410 void ixgbe_vlan_hw_strip_enable_all(struct rte_eth_dev *dev);
 411
 412 void ixgbe_vlan_hw_strip_disable_all(struct rte_eth_dev *dev);
 413
 414 void ixgbe_pf_host_init(struct rte_eth_dev *eth_dev);
 415
 416 void ixgbe_pf_host_uninit(struct rte_eth_dev *eth_dev);
 417
 418 void ixgbe_pf_mbx_process(struct rte_eth_dev *eth_dev);
 419
 420 int ixgbe_pf_host_configure(struct rte_eth_dev *eth_dev);
 421
 422 uint32_t ixgbe_convert_vm_rx_mask_to_val(uint16_t rx_mask, uint32_t orig_val);
 423
 424 int ixgbe_fdir_ctrl_func(struct rte_eth_dev *dev,
 425                         enum rte_filter_op filter_op, void *arg);
 426 #endif /* _IXGBE_ETHDEV_H_ */