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_VFTA_SIZE 128
  53
  54 /*
  55  * Information about the fdir mode.
  56  */
  57 struct ixgbe_hw_fdir_info {
  58         uint16_t    collision;
  59         uint16_t    free;
  60         uint16_t    maxhash;
  61         uint8_t     maxlen;
  62         uint64_t    add;
  63         uint64_t    remove;
  64         uint64_t    f_add;
  65         uint64_t    f_remove;
  66 };
  67
  68 /* structure for interrupt relative data */
  69 struct ixgbe_interrupt {
  70         uint32_t flags;
  71 };
  72
  73 struct ixgbe_stat_mapping_registers {
  74         uint32_t tqsm[IXGBE_NB_STAT_MAPPING_REGS];
  75         uint32_t rqsmr[IXGBE_NB_STAT_MAPPING_REGS];
  76 };
  77
  78 /* local VFTA copy */
  79 struct ixgbe_vfta {
  80         uint32_t vfta[IXGBE_VFTA_SIZE];
  81 };
  82
  83 /*
  84  * Structure to store private data for each driver instance (for each port).
  85  */
  86 struct ixgbe_adapter {
  87         struct ixgbe_hw             hw;
  88         struct ixgbe_hw_stats       stats;
  89         struct ixgbe_hw_fdir_info   fdir;
  90         struct ixgbe_interrupt      intr;
  91         struct ixgbe_stat_mapping_registers stat_mappings;
  92         struct ixgbe_vfta           shadow_vfta;
  93 };
  94
  95 #define IXGBE_DEV_PRIVATE_TO_HW(adapter)\
  96         (&((struct ixgbe_adapter *)adapter)->hw)
  97
  98 #define IXGBE_DEV_PRIVATE_TO_STATS(adapter) \
  99         (&((struct ixgbe_adapter *)adapter)->stats)
 100
 101 #define IXGBE_DEV_PRIVATE_TO_INTR(adapter) \
 102         (&((struct ixgbe_adapter *)adapter)->intr)
 103
 104 #define IXGBE_DEV_PRIVATE_TO_FDIR_INFO(adapter) \
 105         (&((struct ixgbe_adapter *)adapter)->fdir)
 106
 107 #define IXGBE_DEV_PRIVATE_TO_STAT_MAPPINGS(adapter) \
 108         (&((struct ixgbe_adapter *)adapter)->stat_mappings)
 109
 110 #define IXGBE_DEV_PRIVATE_TO_VFTA(adapter) \
 111         (&((struct ixgbe_adapter *)adapter)->shadow_vfta)
 112
 113
 114 /*
 115  * RX/TX function prototypes
 116  */
 117 void ixgbe_dev_clear_queues(struct rte_eth_dev *dev);
 118
 119 int ixgbe_dev_rx_queue_alloc(struct rte_eth_dev *dev, uint16_t nb_rx_queues);
 120
 121 int ixgbe_dev_tx_queue_alloc(struct rte_eth_dev *dev, uint16_t nb_tx_queues);
 122
 123 int  ixgbe_dev_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
 124                 uint16_t nb_rx_desc, unsigned int socket_id,
 125                 const struct rte_eth_rxconf *rx_conf,
 126                 struct rte_mempool *mb_pool);
 127
 128 int  ixgbe_dev_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
 129                 uint16_t nb_tx_desc, unsigned int socket_id,
 130                 const struct rte_eth_txconf *tx_conf);
 131
 132 int ixgbe_dev_rx_init(struct rte_eth_dev *dev);
 133
 134 void ixgbe_dev_tx_init(struct rte_eth_dev *dev);
 135
 136 void ixgbe_dev_rxtx_start(struct rte_eth_dev *dev);
 137
 138 int ixgbevf_dev_rx_init(struct rte_eth_dev *dev);
 139
 140 void ixgbevf_dev_tx_init(struct rte_eth_dev *dev);
 141
 142 void ixgbevf_dev_rxtx_start(struct rte_eth_dev *dev);
 143
 144 uint16_t ixgbe_recv_pkts(struct igb_rx_queue *rxq, struct rte_mbuf **rx_pkts,
 145                 uint16_t nb_pkts);
 146
 147 uint16_t ixgbe_recv_scattered_pkts(struct igb_rx_queue *rxq,
 148                 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
 149
 150 uint16_t ixgbe_xmit_pkts(struct igb_tx_queue *txq, struct rte_mbuf **tx_pkts,
 151                 uint16_t nb_pkts);
 152
 153 /*
 154  * Flow director function prototypes
 155  */
 156 int ixgbe_fdir_configure(struct rte_eth_dev *dev);
 157
 158 int ixgbe_fdir_add_signature_filter(struct rte_eth_dev *dev,
 159                 struct rte_fdir_filter *fdir_filter, uint8_t queue);
 160
 161 int ixgbe_fdir_update_signature_filter(struct rte_eth_dev *dev,
 162                 struct rte_fdir_filter *fdir_filter, uint8_t queue);
 163
 164 int ixgbe_fdir_remove_signature_filter(struct rte_eth_dev *dev,
 165                 struct rte_fdir_filter *fdir_filter);
 166
 167 void ixgbe_fdir_info_get(struct rte_eth_dev *dev,
 168                 struct rte_eth_fdir *fdir);
 169
 170 int ixgbe_fdir_add_perfect_filter(struct rte_eth_dev *dev,
 171                 struct rte_fdir_filter *fdir_filter, uint16_t soft_id,
 172                 uint8_t queue, uint8_t drop);
 173
 174 int ixgbe_fdir_update_perfect_filter(struct rte_eth_dev *dev,
 175                 struct rte_fdir_filter *fdir_filter,uint16_t soft_id,
 176                 uint8_t queue, uint8_t drop);
 177
 178 int ixgbe_fdir_remove_perfect_filter(struct rte_eth_dev *dev,
 179                 struct rte_fdir_filter *fdir_filter, uint16_t soft_id);
 180
 181 int ixgbe_fdir_set_masks(struct rte_eth_dev *dev,
 182                 struct rte_fdir_masks *fdir_masks);
 183
 184 #endif /* _IXGBE_ETHDEV_H_ */