lib/librte_pmd_ixgbe/ixgbe_ethdev.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2012 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
  38 /* need update link, bit flag */
  39 #define IXGBE_FLAG_NEED_LINK_UPDATE (uint32_t)(1 << 0)
  40
  41 /*
  42  * Defines that were not part of ixgbe_type.h as they are not used by the
  43  * FreeBSD driver.
  44  */
  45 #define IXGBE_ADVTXD_MAC_1588       0x00080000 /* IEEE1588 Timestamp packet */
  46 #define IXGBE_RXD_STAT_TMST         0x10000    /* Timestamped Packet indication */
  47 #define IXGBE_ADVTXD_TUCMD_L4T_RSV  0x00001800 /* L4 Packet TYPE, resvd  */
  48 #define IXGBE_RXDADV_ERR_CKSUM_BIT  30
  49 #define IXGBE_RXDADV_ERR_CKSUM_MSK  3
  50 #define IXGBE_ADVTXD_MACLEN_SHIFT   9          /* Bit shift for l2_len */
  51 #define IXGBE_NB_STAT_MAPPING_REGS  32
  52 #define IXGBE_EXTENDED_VLAN       (uint32_t)(1 << 26) /* EXTENDED VLAN ENABLE */
  53 #define IXGBE_VFTA_SIZE 128
  54 #define IXGBE_HWSTRIP_BITMAP_SIZE (IXGBE_MAX_RX_QUEUE_NUM / (sizeof(uint32_t) * NBBY))
  55
  56
  57 /*
  58  * Information about the fdir mode.
  59  */
  60 struct ixgbe_hw_fdir_info {
  61         uint16_t    collision;
  62         uint16_t    free;
  63         uint16_t    maxhash;
  64         uint8_t     maxlen;
  65         uint64_t    add;
  66         uint64_t    remove;
  67         uint64_t    f_add;
  68         uint64_t    f_remove;
  69 };
  70
  71 /* structure for interrupt relative data */
  72 struct ixgbe_interrupt {
  73         uint32_t flags;
  74 };
  75
  76 struct ixgbe_stat_mapping_registers {
  77         uint32_t tqsm[IXGBE_NB_STAT_MAPPING_REGS];
  78         uint32_t rqsmr[IXGBE_NB_STAT_MAPPING_REGS];
  79 };
  80
  81 struct ixgbe_vfta {
  82         uint32_t vfta[IXGBE_VFTA_SIZE];
  83 };
  84
  85 struct ixgbe_hwstrip {
  86         uint32_t bitmap[IXGBE_HWSTRIP_BITMAP_SIZE];
  87 };
  88
  89 /*
  90  * Structure to store private data for each driver instance (for each port).
  91  */
  92 struct ixgbe_adapter {
  93         struct ixgbe_hw             hw;
  94         struct ixgbe_hw_stats       stats;
  95         struct ixgbe_hw_fdir_info   fdir;
  96         struct ixgbe_interrupt      intr;
  97         struct ixgbe_stat_mapping_registers stat_mappings;
  98         struct ixgbe_vfta           shadow_vfta;
  99         struct ixgbe_hwstrip            hwstrip;
 100 };
 101
 102 #define IXGBE_DEV_PRIVATE_TO_HW(adapter)\
 103         (&((struct ixgbe_adapter *)adapter)->hw)
 104
 105 #define IXGBE_DEV_PRIVATE_TO_STATS(adapter) \
 106         (&((struct ixgbe_adapter *)adapter)->stats)
 107
 108 #define IXGBE_DEV_PRIVATE_TO_INTR(adapter) \
 109         (&((struct ixgbe_adapter *)adapter)->intr)
 110
 111 #define IXGBE_DEV_PRIVATE_TO_FDIR_INFO(adapter) \
 112         (&((struct ixgbe_adapter *)adapter)->fdir)
 113
 114 #define IXGBE_DEV_PRIVATE_TO_STAT_MAPPINGS(adapter) \
 115         (&((struct ixgbe_adapter *)adapter)->stat_mappings)
 116
 117 #define IXGBE_DEV_PRIVATE_TO_VFTA(adapter) \
 118         (&((struct ixgbe_adapter *)adapter)->shadow_vfta)
 119
 120 #define IXGBE_DEV_PRIVATE_TO_HWSTRIP_BITMAP(adapter) \
 121         (&((struct ixgbe_adapter *)adapter)->hwstrip)
 122
 123 /*
 124  * RX/TX function prototypes
 125  */
 126 void ixgbe_dev_clear_queues(struct rte_eth_dev *dev);
 127
 128 void ixgbe_dev_rx_queue_release(void *rxq);
 129
 130 void ixgbe_dev_tx_queue_release(void *txq);
 131
 132 int  ixgbe_dev_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
 133                 uint16_t nb_rx_desc, unsigned int socket_id,
 134                 const struct rte_eth_rxconf *rx_conf,
 135                 struct rte_mempool *mb_pool);
 136
 137 int  ixgbe_dev_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
 138                 uint16_t nb_tx_desc, unsigned int socket_id,
 139                 const struct rte_eth_txconf *tx_conf);
 140
 141 int ixgbe_dev_rx_init(struct rte_eth_dev *dev);
 142
 143 void ixgbe_dev_tx_init(struct rte_eth_dev *dev);
 144
 145 void ixgbe_dev_rxtx_start(struct rte_eth_dev *dev);
 146
 147 int ixgbevf_dev_rx_init(struct rte_eth_dev *dev);
 148
 149 void ixgbevf_dev_tx_init(struct rte_eth_dev *dev);
 150
 151 void ixgbevf_dev_rxtx_start(struct rte_eth_dev *dev);
 152
 153 uint16_t ixgbe_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 154                 uint16_t nb_pkts);
 155
 156 #ifdef RTE_LIBRTE_IXGBE_RX_ALLOW_BULK_ALLOC
 157 uint16_t ixgbe_recv_pkts_bulk_alloc(void *rx_queue, struct rte_mbuf **rx_pkts,
 158                 uint16_t nb_pkts);
 159 #endif
 160
 161 uint16_t ixgbe_recv_scattered_pkts(void *rx_queue,
 162                 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
 163
 164 uint16_t ixgbe_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 165                 uint16_t nb_pkts);
 166
 167 uint16_t ixgbe_xmit_pkts_simple(void *tx_queue, struct rte_mbuf **tx_pkts,
 168                 uint16_t nb_pkts);
 169
 170 /*
 171  * Flow director function prototypes
 172  */
 173 int ixgbe_fdir_configure(struct rte_eth_dev *dev);
 174
 175 int ixgbe_fdir_add_signature_filter(struct rte_eth_dev *dev,
 176                 struct rte_fdir_filter *fdir_filter, uint8_t queue);
 177
 178 int ixgbe_fdir_update_signature_filter(struct rte_eth_dev *dev,
 179                 struct rte_fdir_filter *fdir_filter, uint8_t queue);
 180
 181 int ixgbe_fdir_remove_signature_filter(struct rte_eth_dev *dev,
 182                 struct rte_fdir_filter *fdir_filter);
 183
 184 void ixgbe_fdir_info_get(struct rte_eth_dev *dev,
 185                 struct rte_eth_fdir *fdir);
 186
 187 int ixgbe_fdir_add_perfect_filter(struct rte_eth_dev *dev,
 188                 struct rte_fdir_filter *fdir_filter, uint16_t soft_id,
 189                 uint8_t queue, uint8_t drop);
 190
 191 int ixgbe_fdir_update_perfect_filter(struct rte_eth_dev *dev,
 192                 struct rte_fdir_filter *fdir_filter,uint16_t soft_id,
 193                 uint8_t queue, uint8_t drop);
 194
 195 int ixgbe_fdir_remove_perfect_filter(struct rte_eth_dev *dev,
 196                 struct rte_fdir_filter *fdir_filter, uint16_t soft_id);
 197
 198 int ixgbe_fdir_set_masks(struct rte_eth_dev *dev,
 199                 struct rte_fdir_masks *fdir_masks);
 200
 201 #endif /* _IXGBE_ETHDEV_H_ */