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 /* Loopback operation modes */
  66 /* 82599 specific loopback operation types */
  67 #define IXGBE_LPBK_82599_NONE   0x0 /* Default value. Loopback is disabled. */
  68 #define IXGBE_LPBK_82599_TX_RX  0x1 /* Tx->Rx loopback operation is enabled. */
  69
  70 #define IXGBE_MAX_JUMBO_FRAME_SIZE      0x2600 /* Maximum Jumbo frame size. */
  71
  72 #define IXGBE_RTTBCNRC_RF_INT_MASK_BASE 0x000003FF
  73 #define IXGBE_RTTBCNRC_RF_INT_MASK_M \
  74         (IXGBE_RTTBCNRC_RF_INT_MASK_BASE << IXGBE_RTTBCNRC_RF_INT_SHIFT)
  75
  76 #define IXGBE_MAX_QUEUE_NUM_PER_VF  8
  77
  78 #define IXGBE_SYN_FILTER_ENABLE         0x00000001 /* syn filter enable field */
  79 #define IXGBE_SYN_FILTER_QUEUE          0x000000FE /* syn filter queue field */
  80 #define IXGBE_SYN_FILTER_QUEUE_SHIFT    1          /* syn filter queue field shift */
  81 #define IXGBE_SYN_FILTER_SYNQFP         0x80000000 /* syn filter SYNQFP */
  82
  83 #define IXGBE_ETQF_UP                   0x00070000 /* ethertype filter priority field */
  84 #define IXGBE_ETQF_SHIFT                16
  85 #define IXGBE_ETQF_UP_EN                0x00080000
  86 #define IXGBE_ETQF_ETHERTYPE            0x0000FFFF /* ethertype filter ethertype field */
  87 #define IXGBE_ETQF_MAX_PRI              7
  88
  89 #define IXGBE_SDPQF_DSTPORT             0xFFFF0000 /* dst port field */
  90 #define IXGBE_SDPQF_DSTPORT_SHIFT       16         /* dst port field shift */
  91 #define IXGBE_SDPQF_SRCPORT             0x0000FFFF /* src port field */
  92
  93 #define IXGBE_L34T_IMIR_SIZE_BP         0x00001000
  94 #define IXGBE_L34T_IMIR_RESERVE         0x00080000 /* bit 13 to 19 must be set to 1000000b. */
  95 #define IXGBE_L34T_IMIR_LLI             0x00100000
  96 #define IXGBE_L34T_IMIR_QUEUE           0x0FE00000
  97 #define IXGBE_L34T_IMIR_QUEUE_SHIFT     21
  98 #define IXGBE_5TUPLE_MAX_PRI            7
  99 #define IXGBE_5TUPLE_MIN_PRI            1
 100
 101 /*
 102  * Information about the fdir mode.
 103  */
 104 struct ixgbe_hw_fdir_info {
 105         uint16_t    collision;
 106         uint16_t    free;
 107         uint16_t    maxhash;
 108         uint8_t     maxlen;
 109         uint64_t    add;
 110         uint64_t    remove;
 111         uint64_t    f_add;
 112         uint64_t    f_remove;
 113 };
 114
 115 /* structure for interrupt relative data */
 116 struct ixgbe_interrupt {
 117         uint32_t flags;
 118         uint32_t mask;
 119 };
 120
 121 struct ixgbe_stat_mapping_registers {
 122         uint32_t tqsm[IXGBE_NB_STAT_MAPPING_REGS];
 123         uint32_t rqsmr[IXGBE_NB_STAT_MAPPING_REGS];
 124 };
 125
 126 struct ixgbe_vfta {
 127         uint32_t vfta[IXGBE_VFTA_SIZE];
 128 };
 129
 130 struct ixgbe_hwstrip {
 131         uint32_t bitmap[IXGBE_HWSTRIP_BITMAP_SIZE];
 132 };
 133
 134 /*
 135  * VF data which used by PF host only
 136  */
 137 #define IXGBE_MAX_VF_MC_ENTRIES         30
 138 #define IXGBE_MAX_MR_RULE_ENTRIES       4 /* number of mirroring rules supported */
 139 #define IXGBE_MAX_UTA                   128
 140
 141 struct ixgbe_uta_info {
 142         uint8_t  uc_filter_type;
 143         uint16_t uta_in_use;
 144         uint32_t uta_shadow[IXGBE_MAX_UTA];
 145 };
 146
 147 struct ixgbe_mirror_info {
 148         struct rte_eth_vmdq_mirror_conf mr_conf[ETH_VMDQ_NUM_MIRROR_RULE];
 149         /**< store PF mirror rules configuration*/
 150 };
 151
 152 struct ixgbe_vf_info {
 153         uint8_t vf_mac_addresses[ETHER_ADDR_LEN];
 154         uint16_t vf_mc_hashes[IXGBE_MAX_VF_MC_ENTRIES];
 155         uint16_t num_vf_mc_hashes;
 156         uint16_t default_vf_vlan_id;
 157         uint16_t vlans_enabled;
 158         bool clear_to_send;
 159         uint16_t tx_rate[IXGBE_MAX_QUEUE_NUM_PER_VF];
 160         uint16_t vlan_count;
 161         uint8_t spoofchk_enabled;
 162 };
 163
 164 /*
 165  * Structure to store private data for each driver instance (for each port).
 166  */
 167 struct ixgbe_adapter {
 168         struct ixgbe_hw             hw;
 169         struct ixgbe_hw_stats       stats;
 170         struct ixgbe_hw_fdir_info   fdir;
 171         struct ixgbe_interrupt      intr;
 172         struct ixgbe_stat_mapping_registers stat_mappings;
 173         struct ixgbe_vfta           shadow_vfta;
 174         struct ixgbe_hwstrip            hwstrip;
 175         struct ixgbe_dcb_config     dcb_config;
 176         struct ixgbe_mirror_info    mr_data;
 177         struct ixgbe_vf_info        *vfdata;
 178         struct ixgbe_uta_info       uta_info;
 179 #ifdef RTE_NIC_BYPASS
 180         struct ixgbe_bypass_info    bps;
 181 #endif /* RTE_NIC_BYPASS */
 182 };
 183
 184 /*
 185  *  Possible l4type of 5tuple filters.
 186  */
 187 enum ixgbe_5tuple_protocol {
 188         IXGBE_FILTER_PROTOCOL_TCP = 0,
 189         IXGBE_FILTER_PROTOCOL_UDP,
 190         IXGBE_FILTER_PROTOCOL_SCTP,
 191         IXGBE_FILTER_PROTOCOL_NONE,
 192 };
 193
 194 #define IXGBE_DEV_PRIVATE_TO_HW(adapter)\
 195         (&((struct ixgbe_adapter *)adapter)->hw)
 196
 197 #define IXGBE_DEV_PRIVATE_TO_STATS(adapter) \
 198         (&((struct ixgbe_adapter *)adapter)->stats)
 199
 200 #define IXGBE_DEV_PRIVATE_TO_INTR(adapter) \
 201         (&((struct ixgbe_adapter *)adapter)->intr)
 202
 203 #define IXGBE_DEV_PRIVATE_TO_FDIR_INFO(adapter) \
 204         (&((struct ixgbe_adapter *)adapter)->fdir)
 205
 206 #define IXGBE_DEV_PRIVATE_TO_STAT_MAPPINGS(adapter) \
 207         (&((struct ixgbe_adapter *)adapter)->stat_mappings)
 208
 209 #define IXGBE_DEV_PRIVATE_TO_VFTA(adapter) \
 210         (&((struct ixgbe_adapter *)adapter)->shadow_vfta)
 211
 212 #define IXGBE_DEV_PRIVATE_TO_HWSTRIP_BITMAP(adapter) \
 213         (&((struct ixgbe_adapter *)adapter)->hwstrip)
 214
 215 #define IXGBE_DEV_PRIVATE_TO_DCB_CFG(adapter) \
 216         (&((struct ixgbe_adapter *)adapter)->dcb_config)
 217
 218 #define IXGBE_DEV_PRIVATE_TO_P_VFDATA(adapter) \
 219         (&((struct ixgbe_adapter *)adapter)->vfdata)
 220
 221 #define IXGBE_DEV_PRIVATE_TO_PFDATA(adapter) \
 222         (&((struct ixgbe_adapter *)adapter)->mr_data)
 223
 224 #define IXGBE_DEV_PRIVATE_TO_UTA(adapter) \
 225         (&((struct ixgbe_adapter *)adapter)->uta_info)
 226
 227 /*
 228  * RX/TX function prototypes
 229  */
 230 void ixgbe_dev_clear_queues(struct rte_eth_dev *dev);
 231
 232 void ixgbe_dev_rx_queue_release(void *rxq);
 233
 234 void ixgbe_dev_tx_queue_release(void *txq);
 235
 236 int  ixgbe_dev_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
 237                 uint16_t nb_rx_desc, unsigned int socket_id,
 238                 const struct rte_eth_rxconf *rx_conf,
 239                 struct rte_mempool *mb_pool);
 240
 241 int  ixgbe_dev_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
 242                 uint16_t nb_tx_desc, unsigned int socket_id,
 243                 const struct rte_eth_txconf *tx_conf);
 244
 245 uint32_t ixgbe_dev_rx_queue_count(struct rte_eth_dev *dev,
 246                 uint16_t rx_queue_id);
 247
 248 int ixgbe_dev_rx_descriptor_done(void *rx_queue, uint16_t offset);
 249
 250 int ixgbe_dev_rx_init(struct rte_eth_dev *dev);
 251
 252 void ixgbe_dev_tx_init(struct rte_eth_dev *dev);
 253
 254 void ixgbe_dev_rxtx_start(struct rte_eth_dev *dev);
 255
 256 int ixgbe_dev_rx_queue_start(struct rte_eth_dev *dev, uint16_t rx_queue_id);
 257
 258 int ixgbe_dev_rx_queue_stop(struct rte_eth_dev *dev, uint16_t rx_queue_id);
 259
 260 int ixgbe_dev_tx_queue_start(struct rte_eth_dev *dev, uint16_t tx_queue_id);
 261
 262 int ixgbe_dev_tx_queue_stop(struct rte_eth_dev *dev, uint16_t tx_queue_id);
 263
 264 int ixgbevf_dev_rx_init(struct rte_eth_dev *dev);
 265
 266 void ixgbevf_dev_tx_init(struct rte_eth_dev *dev);
 267
 268 void ixgbevf_dev_rxtx_start(struct rte_eth_dev *dev);
 269
 270 uint16_t ixgbe_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 271                 uint16_t nb_pkts);
 272
 273 #ifdef RTE_LIBRTE_IXGBE_RX_ALLOW_BULK_ALLOC
 274 uint16_t ixgbe_recv_pkts_bulk_alloc(void *rx_queue, struct rte_mbuf **rx_pkts,
 275                 uint16_t nb_pkts);
 276 #endif
 277
 278 uint16_t ixgbe_recv_scattered_pkts(void *rx_queue,
 279                 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
 280
 281 uint16_t ixgbe_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 282                 uint16_t nb_pkts);
 283
 284 uint16_t ixgbe_xmit_pkts_simple(void *tx_queue, struct rte_mbuf **tx_pkts,
 285                 uint16_t nb_pkts);
 286
 287 int ixgbe_dev_rss_hash_update(struct rte_eth_dev *dev,
 288                               struct rte_eth_rss_conf *rss_conf);
 289
 290 int ixgbe_dev_rss_hash_conf_get(struct rte_eth_dev *dev,
 291                                 struct rte_eth_rss_conf *rss_conf);
 292
 293 /*
 294  * Flow director function prototypes
 295  */
 296 int ixgbe_fdir_configure(struct rte_eth_dev *dev);
 297
 298 int ixgbe_fdir_add_signature_filter(struct rte_eth_dev *dev,
 299                 struct rte_fdir_filter *fdir_filter, uint8_t queue);
 300
 301 int ixgbe_fdir_update_signature_filter(struct rte_eth_dev *dev,
 302                 struct rte_fdir_filter *fdir_filter, uint8_t queue);
 303
 304 int ixgbe_fdir_remove_signature_filter(struct rte_eth_dev *dev,
 305                 struct rte_fdir_filter *fdir_filter);
 306
 307 void ixgbe_fdir_info_get(struct rte_eth_dev *dev,
 308                 struct rte_eth_fdir *fdir);
 309
 310 int ixgbe_fdir_add_perfect_filter(struct rte_eth_dev *dev,
 311                 struct rte_fdir_filter *fdir_filter, uint16_t soft_id,
 312                 uint8_t queue, uint8_t drop);
 313
 314 int ixgbe_fdir_update_perfect_filter(struct rte_eth_dev *dev,
 315                 struct rte_fdir_filter *fdir_filter,uint16_t soft_id,
 316                 uint8_t queue, uint8_t drop);
 317
 318 int ixgbe_fdir_remove_perfect_filter(struct rte_eth_dev *dev,
 319                 struct rte_fdir_filter *fdir_filter, uint16_t soft_id);
 320
 321 int ixgbe_fdir_set_masks(struct rte_eth_dev *dev,
 322                 struct rte_fdir_masks *fdir_masks);
 323
 324 void ixgbe_configure_dcb(struct rte_eth_dev *dev);
 325
 326 /*
 327  * misc function prototypes
 328  */
 329 void ixgbe_vlan_hw_filter_enable(struct rte_eth_dev *dev);
 330
 331 void ixgbe_vlan_hw_filter_disable(struct rte_eth_dev *dev);
 332
 333 void ixgbe_vlan_hw_strip_enable_all(struct rte_eth_dev *dev);
 334
 335 void ixgbe_vlan_hw_strip_disable_all(struct rte_eth_dev *dev);
 336
 337 void ixgbe_pf_host_init(struct rte_eth_dev *eth_dev);
 338
 339 void ixgbe_pf_mbx_process(struct rte_eth_dev *eth_dev);
 340
 341 int ixgbe_pf_host_configure(struct rte_eth_dev *eth_dev);
 342
 343 uint32_t ixgbe_convert_vm_rx_mask_to_val(uint16_t rx_mask, uint32_t orig_val);
 344 #endif /* _IXGBE_ETHDEV_H_ */