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
  35 #ifndef _IXGBE_ETHDEV_H_
  36 #define _IXGBE_ETHDEV_H_
  37 #include "ixgbe/ixgbe_dcb.h"
  38 #include "ixgbe/ixgbe_dcb_82599.h"
  39 #include "ixgbe/ixgbe_dcb_82598.h"
  40
  41 /* need update link, bit flag */
  42 #define IXGBE_FLAG_NEED_LINK_UPDATE (uint32_t)(1 << 0)
  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_RX_BUF_THRESHOLD 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 };
  83
  84 struct ixgbe_stat_mapping_registers {
  85         uint32_t tqsm[IXGBE_NB_STAT_MAPPING_REGS];
  86         uint32_t rqsmr[IXGBE_NB_STAT_MAPPING_REGS];
  87 };
  88
  89 struct ixgbe_vfta {
  90         uint32_t vfta[IXGBE_VFTA_SIZE];
  91 };
  92
  93 struct ixgbe_hwstrip {
  94         uint32_t bitmap[IXGBE_HWSTRIP_BITMAP_SIZE];
  95 };
  96
  97 /*
  98  * Structure to store private data for each driver instance (for each port).
  99  */
 100 struct ixgbe_adapter {
 101         struct ixgbe_hw             hw;
 102         struct ixgbe_hw_stats       stats;
 103         struct ixgbe_hw_fdir_info   fdir;
 104         struct ixgbe_interrupt      intr;
 105         struct ixgbe_stat_mapping_registers stat_mappings;
 106         struct ixgbe_vfta           shadow_vfta;
 107         struct ixgbe_hwstrip            hwstrip;
 108         struct ixgbe_dcb_config     dcb_config;
 109 };
 110
 111 #define IXGBE_DEV_PRIVATE_TO_HW(adapter)\
 112         (&((struct ixgbe_adapter *)adapter)->hw)
 113
 114 #define IXGBE_DEV_PRIVATE_TO_STATS(adapter) \
 115         (&((struct ixgbe_adapter *)adapter)->stats)
 116
 117 #define IXGBE_DEV_PRIVATE_TO_INTR(adapter) \
 118         (&((struct ixgbe_adapter *)adapter)->intr)
 119
 120 #define IXGBE_DEV_PRIVATE_TO_FDIR_INFO(adapter) \
 121         (&((struct ixgbe_adapter *)adapter)->fdir)
 122
 123 #define IXGBE_DEV_PRIVATE_TO_STAT_MAPPINGS(adapter) \
 124         (&((struct ixgbe_adapter *)adapter)->stat_mappings)
 125
 126 #define IXGBE_DEV_PRIVATE_TO_VFTA(adapter) \
 127         (&((struct ixgbe_adapter *)adapter)->shadow_vfta)
 128
 129 #define IXGBE_DEV_PRIVATE_TO_HWSTRIP_BITMAP(adapter) \
 130         (&((struct ixgbe_adapter *)adapter)->hwstrip)
 131
 132 #define IXGBE_DEV_PRIVATE_TO_DCB_CFG(adapter) \
 133         (&((struct ixgbe_adapter *)adapter)->dcb_config)
 134
 135 /*
 136  * RX/TX function prototypes
 137  */
 138 void ixgbe_dev_clear_queues(struct rte_eth_dev *dev);
 139
 140 void ixgbe_dev_rx_queue_release(void *rxq);
 141
 142 void ixgbe_dev_tx_queue_release(void *txq);
 143
 144 int  ixgbe_dev_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
 145                 uint16_t nb_rx_desc, unsigned int socket_id,
 146                 const struct rte_eth_rxconf *rx_conf,
 147                 struct rte_mempool *mb_pool);
 148
 149 int  ixgbe_dev_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
 150                 uint16_t nb_tx_desc, unsigned int socket_id,
 151                 const struct rte_eth_txconf *tx_conf);
 152
 153 int ixgbe_dev_rx_init(struct rte_eth_dev *dev);
 154
 155 void ixgbe_dev_tx_init(struct rte_eth_dev *dev);
 156
 157 void ixgbe_dev_rxtx_start(struct rte_eth_dev *dev);
 158
 159 int ixgbevf_dev_rx_init(struct rte_eth_dev *dev);
 160
 161 void ixgbevf_dev_tx_init(struct rte_eth_dev *dev);
 162
 163 void ixgbevf_dev_rxtx_start(struct rte_eth_dev *dev);
 164
 165 uint16_t ixgbe_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 166                 uint16_t nb_pkts);
 167
 168 #ifdef RTE_LIBRTE_IXGBE_RX_ALLOW_BULK_ALLOC
 169 uint16_t ixgbe_recv_pkts_bulk_alloc(void *rx_queue, struct rte_mbuf **rx_pkts,
 170                 uint16_t nb_pkts);
 171 #endif
 172
 173 uint16_t ixgbe_recv_scattered_pkts(void *rx_queue,
 174                 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
 175
 176 uint16_t ixgbe_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 177                 uint16_t nb_pkts);
 178
 179 uint16_t ixgbe_xmit_pkts_simple(void *tx_queue, struct rte_mbuf **tx_pkts,
 180                 uint16_t nb_pkts);
 181
 182 /*
 183  * Flow director function prototypes
 184  */
 185 int ixgbe_fdir_configure(struct rte_eth_dev *dev);
 186
 187 int ixgbe_fdir_add_signature_filter(struct rte_eth_dev *dev,
 188                 struct rte_fdir_filter *fdir_filter, uint8_t queue);
 189
 190 int ixgbe_fdir_update_signature_filter(struct rte_eth_dev *dev,
 191                 struct rte_fdir_filter *fdir_filter, uint8_t queue);
 192
 193 int ixgbe_fdir_remove_signature_filter(struct rte_eth_dev *dev,
 194                 struct rte_fdir_filter *fdir_filter);
 195
 196 void ixgbe_fdir_info_get(struct rte_eth_dev *dev,
 197                 struct rte_eth_fdir *fdir);
 198
 199 int ixgbe_fdir_add_perfect_filter(struct rte_eth_dev *dev,
 200                 struct rte_fdir_filter *fdir_filter, uint16_t soft_id,
 201                 uint8_t queue, uint8_t drop);
 202
 203 int ixgbe_fdir_update_perfect_filter(struct rte_eth_dev *dev,
 204                 struct rte_fdir_filter *fdir_filter,uint16_t soft_id,
 205                 uint8_t queue, uint8_t drop);
 206
 207 int ixgbe_fdir_remove_perfect_filter(struct rte_eth_dev *dev,
 208                 struct rte_fdir_filter *fdir_filter, uint16_t soft_id);
 209
 210 int ixgbe_fdir_set_masks(struct rte_eth_dev *dev,
 211                 struct rte_fdir_masks *fdir_masks);
 212
 213 void ixgbe_configure_dcb(struct rte_eth_dev *dev);
 214
 215 #endif /* _IXGBE_ETHDEV_H_ */