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  * Information about the fdir mode.
  79  */
  80 struct ixgbe_hw_fdir_info {
  81         uint16_t    collision;
  82         uint16_t    free;
  83         uint16_t    maxhash;
  84         uint8_t     maxlen;
  85         uint64_t    add;
  86         uint64_t    remove;
  87         uint64_t    f_add;
  88         uint64_t    f_remove;
  89 };
  90
  91 /* structure for interrupt relative data */
  92 struct ixgbe_interrupt {
  93         uint32_t flags;
  94         uint32_t mask;
  95 };
  96
  97 struct ixgbe_stat_mapping_registers {
  98         uint32_t tqsm[IXGBE_NB_STAT_MAPPING_REGS];
  99         uint32_t rqsmr[IXGBE_NB_STAT_MAPPING_REGS];
 100 };
 101
 102 struct ixgbe_vfta {
 103         uint32_t vfta[IXGBE_VFTA_SIZE];
 104 };
 105
 106 struct ixgbe_hwstrip {
 107         uint32_t bitmap[IXGBE_HWSTRIP_BITMAP_SIZE];
 108 };
 109
 110 /*
 111  * VF data which used by PF host only
 112  */
 113 #define IXGBE_MAX_VF_MC_ENTRIES         30
 114 #define IXGBE_MAX_MR_RULE_ENTRIES       4 /* number of mirroring rules supported */
 115 #define IXGBE_MAX_UTA                   128
 116
 117 struct ixgbe_uta_info {
 118         uint8_t  uc_filter_type;
 119         uint16_t uta_in_use;
 120         uint32_t uta_shadow[IXGBE_MAX_UTA];
 121 };
 122
 123 struct ixgbe_mirror_info {
 124         struct rte_eth_vmdq_mirror_conf mr_conf[ETH_VMDQ_NUM_MIRROR_RULE];
 125         /**< store PF mirror rules configuration*/
 126 };
 127
 128 struct ixgbe_vf_info {
 129         uint8_t vf_mac_addresses[ETHER_ADDR_LEN];
 130         uint16_t vf_mc_hashes[IXGBE_MAX_VF_MC_ENTRIES];
 131         uint16_t num_vf_mc_hashes;
 132         uint16_t default_vf_vlan_id;
 133         uint16_t vlans_enabled;
 134         bool clear_to_send;
 135         uint16_t tx_rate[IXGBE_MAX_QUEUE_NUM_PER_VF];
 136         uint16_t vlan_count;
 137         uint8_t spoofchk_enabled;
 138 };
 139
 140 /*
 141  * Structure to store private data for each driver instance (for each port).
 142  */
 143 struct ixgbe_adapter {
 144         struct ixgbe_hw             hw;
 145         struct ixgbe_hw_stats       stats;
 146         struct ixgbe_hw_fdir_info   fdir;
 147         struct ixgbe_interrupt      intr;
 148         struct ixgbe_stat_mapping_registers stat_mappings;
 149         struct ixgbe_vfta           shadow_vfta;
 150         struct ixgbe_hwstrip            hwstrip;
 151         struct ixgbe_dcb_config     dcb_config;
 152         struct ixgbe_mirror_info    mr_data;
 153         struct ixgbe_vf_info        *vfdata;
 154         struct ixgbe_uta_info       uta_info;
 155 #ifdef RTE_NIC_BYPASS
 156         struct ixgbe_bypass_info    bps;
 157 #endif /* RTE_NIC_BYPASS */
 158 };
 159
 160 #define IXGBE_DEV_PRIVATE_TO_HW(adapter)\
 161         (&((struct ixgbe_adapter *)adapter)->hw)
 162
 163 #define IXGBE_DEV_PRIVATE_TO_STATS(adapter) \
 164         (&((struct ixgbe_adapter *)adapter)->stats)
 165
 166 #define IXGBE_DEV_PRIVATE_TO_INTR(adapter) \
 167         (&((struct ixgbe_adapter *)adapter)->intr)
 168
 169 #define IXGBE_DEV_PRIVATE_TO_FDIR_INFO(adapter) \
 170         (&((struct ixgbe_adapter *)adapter)->fdir)
 171
 172 #define IXGBE_DEV_PRIVATE_TO_STAT_MAPPINGS(adapter) \
 173         (&((struct ixgbe_adapter *)adapter)->stat_mappings)
 174
 175 #define IXGBE_DEV_PRIVATE_TO_VFTA(adapter) \
 176         (&((struct ixgbe_adapter *)adapter)->shadow_vfta)
 177
 178 #define IXGBE_DEV_PRIVATE_TO_HWSTRIP_BITMAP(adapter) \
 179         (&((struct ixgbe_adapter *)adapter)->hwstrip)
 180
 181 #define IXGBE_DEV_PRIVATE_TO_DCB_CFG(adapter) \
 182         (&((struct ixgbe_adapter *)adapter)->dcb_config)
 183
 184 #define IXGBE_DEV_PRIVATE_TO_P_VFDATA(adapter) \
 185         (&((struct ixgbe_adapter *)adapter)->vfdata)
 186
 187 #define IXGBE_DEV_PRIVATE_TO_PFDATA(adapter) \
 188         (&((struct ixgbe_adapter *)adapter)->mr_data)
 189
 190 #define IXGBE_DEV_PRIVATE_TO_UTA(adapter) \
 191         (&((struct ixgbe_adapter *)adapter)->uta_info)
 192
 193 /*
 194  * RX/TX function prototypes
 195  */
 196 void ixgbe_dev_clear_queues(struct rte_eth_dev *dev);
 197
 198 void ixgbe_dev_rx_queue_release(void *rxq);
 199
 200 void ixgbe_dev_tx_queue_release(void *txq);
 201
 202 int  ixgbe_dev_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
 203                 uint16_t nb_rx_desc, unsigned int socket_id,
 204                 const struct rte_eth_rxconf *rx_conf,
 205                 struct rte_mempool *mb_pool);
 206
 207 int  ixgbe_dev_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
 208                 uint16_t nb_tx_desc, unsigned int socket_id,
 209                 const struct rte_eth_txconf *tx_conf);
 210
 211 uint32_t ixgbe_dev_rx_queue_count(struct rte_eth_dev *dev,
 212                 uint16_t rx_queue_id);
 213
 214 int ixgbe_dev_rx_descriptor_done(void *rx_queue, uint16_t offset);
 215
 216 int ixgbe_dev_rx_init(struct rte_eth_dev *dev);
 217
 218 void ixgbe_dev_tx_init(struct rte_eth_dev *dev);
 219
 220 void ixgbe_dev_rxtx_start(struct rte_eth_dev *dev);
 221
 222 int ixgbe_dev_rx_queue_start(struct rte_eth_dev *dev, uint16_t rx_queue_id);
 223
 224 int ixgbe_dev_rx_queue_stop(struct rte_eth_dev *dev, uint16_t rx_queue_id);
 225
 226 int ixgbe_dev_tx_queue_start(struct rte_eth_dev *dev, uint16_t tx_queue_id);
 227
 228 int ixgbe_dev_tx_queue_stop(struct rte_eth_dev *dev, uint16_t tx_queue_id);
 229
 230 int ixgbevf_dev_rx_init(struct rte_eth_dev *dev);
 231
 232 void ixgbevf_dev_tx_init(struct rte_eth_dev *dev);
 233
 234 void ixgbevf_dev_rxtx_start(struct rte_eth_dev *dev);
 235
 236 uint16_t ixgbe_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 237                 uint16_t nb_pkts);
 238
 239 #ifdef RTE_LIBRTE_IXGBE_RX_ALLOW_BULK_ALLOC
 240 uint16_t ixgbe_recv_pkts_bulk_alloc(void *rx_queue, struct rte_mbuf **rx_pkts,
 241                 uint16_t nb_pkts);
 242 #endif
 243
 244 uint16_t ixgbe_recv_scattered_pkts(void *rx_queue,
 245                 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
 246
 247 uint16_t ixgbe_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 248                 uint16_t nb_pkts);
 249
 250 uint16_t ixgbe_xmit_pkts_simple(void *tx_queue, struct rte_mbuf **tx_pkts,
 251                 uint16_t nb_pkts);
 252
 253 int ixgbe_dev_rss_hash_update(struct rte_eth_dev *dev,
 254                               struct rte_eth_rss_conf *rss_conf);
 255
 256 int ixgbe_dev_rss_hash_conf_get(struct rte_eth_dev *dev,
 257                                 struct rte_eth_rss_conf *rss_conf);
 258
 259 /*
 260  * Flow director function prototypes
 261  */
 262 int ixgbe_fdir_configure(struct rte_eth_dev *dev);
 263
 264 int ixgbe_fdir_add_signature_filter(struct rte_eth_dev *dev,
 265                 struct rte_fdir_filter *fdir_filter, uint8_t queue);
 266
 267 int ixgbe_fdir_update_signature_filter(struct rte_eth_dev *dev,
 268                 struct rte_fdir_filter *fdir_filter, uint8_t queue);
 269
 270 int ixgbe_fdir_remove_signature_filter(struct rte_eth_dev *dev,
 271                 struct rte_fdir_filter *fdir_filter);
 272
 273 void ixgbe_fdir_info_get(struct rte_eth_dev *dev,
 274                 struct rte_eth_fdir *fdir);
 275
 276 int ixgbe_fdir_add_perfect_filter(struct rte_eth_dev *dev,
 277                 struct rte_fdir_filter *fdir_filter, uint16_t soft_id,
 278                 uint8_t queue, uint8_t drop);
 279
 280 int ixgbe_fdir_update_perfect_filter(struct rte_eth_dev *dev,
 281                 struct rte_fdir_filter *fdir_filter,uint16_t soft_id,
 282                 uint8_t queue, uint8_t drop);
 283
 284 int ixgbe_fdir_remove_perfect_filter(struct rte_eth_dev *dev,
 285                 struct rte_fdir_filter *fdir_filter, uint16_t soft_id);
 286
 287 int ixgbe_fdir_set_masks(struct rte_eth_dev *dev,
 288                 struct rte_fdir_masks *fdir_masks);
 289
 290 void ixgbe_configure_dcb(struct rte_eth_dev *dev);
 291
 292 /*
 293  * misc function prototypes
 294  */
 295 void ixgbe_vlan_hw_filter_enable(struct rte_eth_dev *dev);
 296
 297 void ixgbe_vlan_hw_filter_disable(struct rte_eth_dev *dev);
 298
 299 void ixgbe_vlan_hw_strip_enable_all(struct rte_eth_dev *dev);
 300
 301 void ixgbe_vlan_hw_strip_disable_all(struct rte_eth_dev *dev);
 302
 303 void ixgbe_pf_host_init(struct rte_eth_dev *eth_dev);
 304
 305 void ixgbe_pf_mbx_process(struct rte_eth_dev *eth_dev);
 306
 307 int ixgbe_pf_host_configure(struct rte_eth_dev *eth_dev);
 308
 309 #endif /* _IXGBE_ETHDEV_H_ */