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