lib/librte_pmd_ixgbe/ixgbe_ethdev.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2013 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
  40 /* need update link, bit flag */
  41 #define IXGBE_FLAG_NEED_LINK_UPDATE (uint32_t)(1 << 0)
  42 #define IXGBE_FLAG_MAILBOX          (uint32_t)(1 << 1)
  43
  44 /*
  45  * Defines that were not part of ixgbe_type.h as they are not used by the
  46  * FreeBSD driver.
  47  */
  48 #define IXGBE_ADVTXD_MAC_1588       0x00080000 /* IEEE1588 Timestamp packet */
  49 #define IXGBE_RXD_STAT_TMST         0x10000    /* Timestamped Packet indication */
  50 #define IXGBE_ADVTXD_TUCMD_L4T_RSV  0x00001800 /* L4 Packet TYPE, resvd  */
  51 #define IXGBE_RXDADV_ERR_CKSUM_BIT  30
  52 #define IXGBE_RXDADV_ERR_CKSUM_MSK  3
  53 #define IXGBE_ADVTXD_MACLEN_SHIFT   9          /* Bit shift for l2_len */
  54 #define IXGBE_NB_STAT_MAPPING_REGS  32
  55 #define IXGBE_EXTENDED_VLAN       (uint32_t)(1 << 26) /* EXTENDED VLAN ENABLE */
  56 #define IXGBE_VFTA_SIZE 128
  57 #define IXGBE_VLAN_TAG_SIZE 4
  58 #define IXGBE_MAX_RX_QUEUE_NUM  128
  59 #ifndef NBBY
  60 #define NBBY    8       /* number of bits in a byte */
  61 #endif
  62 #define IXGBE_HWSTRIP_BITMAP_SIZE (IXGBE_MAX_RX_QUEUE_NUM / (sizeof(uint32_t) * NBBY))
  63
  64
  65 /*
  66  * Information about the fdir mode.
  67  */
  68 struct ixgbe_hw_fdir_info {
  69         uint16_t    collision;
  70         uint16_t    free;
  71         uint16_t    maxhash;
  72         uint8_t     maxlen;
  73         uint64_t    add;
  74         uint64_t    remove;
  75         uint64_t    f_add;
  76         uint64_t    f_remove;
  77 };
  78
  79 /* structure for interrupt relative data */
  80 struct ixgbe_interrupt {
  81         uint32_t flags;
  82         uint32_t mask;
  83 };
  84
  85 struct ixgbe_stat_mapping_registers {
  86         uint32_t tqsm[IXGBE_NB_STAT_MAPPING_REGS];
  87         uint32_t rqsmr[IXGBE_NB_STAT_MAPPING_REGS];
  88 };
  89
  90 struct ixgbe_vfta {
  91         uint32_t vfta[IXGBE_VFTA_SIZE];
  92 };
  93
  94 struct ixgbe_hwstrip {
  95         uint32_t bitmap[IXGBE_HWSTRIP_BITMAP_SIZE];
  96 };
  97
  98 /*
  99  * VF data which used by PF host only
 100  */
 101 #define IXGBE_MAX_VF_MC_ENTRIES         30
 102 #define IXGBE_MAX_MR_RULE_ENTRIES       4 /* number of mirroring rules supported */
 103 #define IXGBE_MAX_UTA                   128
 104
 105 struct ixgbe_uta_info {
 106         uint8_t  uc_filter_type;
 107         uint16_t uta_in_use;
 108         uint32_t uta_shadow[IXGBE_MAX_UTA];
 109 };
 110
 111 struct ixgbe_mirror_info {
 112         struct rte_eth_vmdq_mirror_conf mr_conf[ETH_VMDQ_NUM_MIRROR_RULE];
 113         /**< store PF mirror rules configuration*/
 114 };
 115
 116 struct ixgbe_vf_info {
 117         uint8_t vf_mac_addresses[ETHER_ADDR_LEN];
 118         uint16_t vf_mc_hashes[IXGBE_MAX_VF_MC_ENTRIES];
 119         uint16_t num_vf_mc_hashes;
 120         uint16_t default_vf_vlan_id;
 121         uint16_t vlans_enabled;
 122         bool clear_to_send;
 123         uint16_t tx_rate;
 124         uint16_t vlan_count;
 125         uint8_t spoofchk_enabled;
 126 };
 127
 128 /*
 129  * Structure to store private data for each driver instance (for each port).
 130  */
 131 struct ixgbe_adapter {
 132         struct ixgbe_hw             hw;
 133         struct ixgbe_hw_stats       stats;
 134         struct ixgbe_hw_fdir_info   fdir;
 135         struct ixgbe_interrupt      intr;
 136         struct ixgbe_stat_mapping_registers stat_mappings;
 137         struct ixgbe_vfta           shadow_vfta;
 138         struct ixgbe_hwstrip            hwstrip;
 139         struct ixgbe_dcb_config     dcb_config;
 140         struct ixgbe_mirror_info    mr_data;
 141         struct ixgbe_vf_info        *vfdata;
 142         struct ixgbe_uta_info       uta_info;
 143 };
 144
 145 #define IXGBE_DEV_PRIVATE_TO_HW(adapter)\
 146         (&((struct ixgbe_adapter *)adapter)->hw)
 147
 148 #define IXGBE_DEV_PRIVATE_TO_STATS(adapter) \
 149         (&((struct ixgbe_adapter *)adapter)->stats)
 150
 151 #define IXGBE_DEV_PRIVATE_TO_INTR(adapter) \
 152         (&((struct ixgbe_adapter *)adapter)->intr)
 153
 154 #define IXGBE_DEV_PRIVATE_TO_FDIR_INFO(adapter) \
 155         (&((struct ixgbe_adapter *)adapter)->fdir)
 156
 157 #define IXGBE_DEV_PRIVATE_TO_STAT_MAPPINGS(adapter) \
 158         (&((struct ixgbe_adapter *)adapter)->stat_mappings)
 159
 160 #define IXGBE_DEV_PRIVATE_TO_VFTA(adapter) \
 161         (&((struct ixgbe_adapter *)adapter)->shadow_vfta)
 162
 163 #define IXGBE_DEV_PRIVATE_TO_HWSTRIP_BITMAP(adapter) \
 164         (&((struct ixgbe_adapter *)adapter)->hwstrip)
 165
 166 #define IXGBE_DEV_PRIVATE_TO_DCB_CFG(adapter) \
 167         (&((struct ixgbe_adapter *)adapter)->dcb_config)
 168
 169 #define IXGBE_DEV_PRIVATE_TO_P_VFDATA(adapter) \
 170         (&((struct ixgbe_adapter *)adapter)->vfdata)
 171
 172 #define IXGBE_DEV_PRIVATE_TO_PFDATA(adapter) \
 173         (&((struct ixgbe_adapter *)adapter)->mr_data)
 174
 175 #define IXGBE_DEV_PRIVATE_TO_UTA(adapter) \
 176         (&((struct ixgbe_adapter *)adapter)->uta_info)
 177
 178 /*
 179  * RX/TX function prototypes
 180  */
 181 void ixgbe_dev_clear_queues(struct rte_eth_dev *dev);
 182
 183 void ixgbe_dev_rx_queue_release(void *rxq);
 184
 185 void ixgbe_dev_tx_queue_release(void *txq);
 186
 187 int  ixgbe_dev_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
 188                 uint16_t nb_rx_desc, unsigned int socket_id,
 189                 const struct rte_eth_rxconf *rx_conf,
 190                 struct rte_mempool *mb_pool);
 191
 192 int  ixgbe_dev_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
 193                 uint16_t nb_tx_desc, unsigned int socket_id,
 194                 const struct rte_eth_txconf *tx_conf);
 195
 196 uint32_t ixgbe_dev_rx_queue_count(struct rte_eth_dev *dev,
 197                 uint16_t rx_queue_id);
 198
 199 int ixgbe_dev_rx_descriptor_done(void *rx_queue, uint16_t offset);
 200
 201 int ixgbe_dev_rx_init(struct rte_eth_dev *dev);
 202
 203 void ixgbe_dev_tx_init(struct rte_eth_dev *dev);
 204
 205 void ixgbe_dev_rxtx_start(struct rte_eth_dev *dev);
 206
 207 int ixgbevf_dev_rx_init(struct rte_eth_dev *dev);
 208
 209 void ixgbevf_dev_tx_init(struct rte_eth_dev *dev);
 210
 211 void ixgbevf_dev_rxtx_start(struct rte_eth_dev *dev);
 212
 213 uint16_t ixgbe_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 214                 uint16_t nb_pkts);
 215
 216 #ifdef RTE_LIBRTE_IXGBE_RX_ALLOW_BULK_ALLOC
 217 uint16_t ixgbe_recv_pkts_bulk_alloc(void *rx_queue, struct rte_mbuf **rx_pkts,
 218                 uint16_t nb_pkts);
 219 #endif
 220
 221 uint16_t ixgbe_recv_scattered_pkts(void *rx_queue,
 222                 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
 223
 224 uint16_t ixgbe_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 225                 uint16_t nb_pkts);
 226
 227 uint16_t ixgbe_xmit_pkts_simple(void *tx_queue, struct rte_mbuf **tx_pkts,
 228                 uint16_t nb_pkts);
 229
 230 /*
 231  * Flow director function prototypes
 232  */
 233 int ixgbe_fdir_configure(struct rte_eth_dev *dev);
 234
 235 int ixgbe_fdir_add_signature_filter(struct rte_eth_dev *dev,
 236                 struct rte_fdir_filter *fdir_filter, uint8_t queue);
 237
 238 int ixgbe_fdir_update_signature_filter(struct rte_eth_dev *dev,
 239                 struct rte_fdir_filter *fdir_filter, uint8_t queue);
 240
 241 int ixgbe_fdir_remove_signature_filter(struct rte_eth_dev *dev,
 242                 struct rte_fdir_filter *fdir_filter);
 243
 244 void ixgbe_fdir_info_get(struct rte_eth_dev *dev,
 245                 struct rte_eth_fdir *fdir);
 246
 247 int ixgbe_fdir_add_perfect_filter(struct rte_eth_dev *dev,
 248                 struct rte_fdir_filter *fdir_filter, uint16_t soft_id,
 249                 uint8_t queue, uint8_t drop);
 250
 251 int ixgbe_fdir_update_perfect_filter(struct rte_eth_dev *dev,
 252                 struct rte_fdir_filter *fdir_filter,uint16_t soft_id,
 253                 uint8_t queue, uint8_t drop);
 254
 255 int ixgbe_fdir_remove_perfect_filter(struct rte_eth_dev *dev,
 256                 struct rte_fdir_filter *fdir_filter, uint16_t soft_id);
 257
 258 int ixgbe_fdir_set_masks(struct rte_eth_dev *dev,
 259                 struct rte_fdir_masks *fdir_masks);
 260
 261 void ixgbe_configure_dcb(struct rte_eth_dev *dev);
 262
 263 /*
 264  * misc function prototypes
 265  */
 266 void ixgbe_vlan_hw_filter_enable(struct rte_eth_dev *dev);
 267
 268 void ixgbe_vlan_hw_filter_disable(struct rte_eth_dev *dev);
 269
 270 void ixgbe_vlan_hw_strip_enable_all(struct rte_eth_dev *dev);
 271
 272 void ixgbe_vlan_hw_strip_disable_all(struct rte_eth_dev *dev);
 273
 274 void ixgbe_pf_host_init(struct rte_eth_dev *eth_dev);
 275
 276 void ixgbe_pf_mbx_process(struct rte_eth_dev *eth_dev);
 277
 278 int ixgbe_pf_host_configure(struct rte_eth_dev *eth_dev);
 279
 280 #endif /* _IXGBE_ETHDEV_H_ */