drivers/net/i40e/i40e_rxtx.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2015 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 _I40E_RXTX_H_
  35 #define _I40E_RXTX_H_
  36
  37 /**
  38  * 32 bits tx flags, high 16 bits for L2TAG1 (VLAN),
  39  * low 16 bits for others.
  40  */
  41 #define I40E_TX_FLAG_L2TAG1_SHIFT 16
  42 #define I40E_TX_FLAG_L2TAG1_MASK  0xffff0000
  43 #define I40E_TX_FLAG_CSUM         ((uint32_t)(1 << 0))
  44 #define I40E_TX_FLAG_INSERT_VLAN  ((uint32_t)(1 << 1))
  45 #define I40E_TX_FLAG_TSYN         ((uint32_t)(1 << 2))
  46
  47 #define RTE_PMD_I40E_RX_MAX_BURST 32
  48 #define RTE_PMD_I40E_TX_MAX_BURST 32
  49
  50 #define RTE_I40E_VPMD_RX_BURST        32
  51 #define RTE_I40E_VPMD_TX_BURST        32
  52 #define RTE_I40E_RXQ_REARM_THRESH      32
  53 #define RTE_I40E_MAX_RX_BURST          RTE_I40E_RXQ_REARM_THRESH
  54 #define RTE_I40E_TX_MAX_FREE_BUF_SZ    64
  55 #define RTE_I40E_DESCS_PER_LOOP    4
  56
  57 #define I40E_RXBUF_SZ_1024 1024
  58 #define I40E_RXBUF_SZ_2048 2048
  59
  60 /* In none-PXE mode QLEN must be whole number of 32 descriptors. */
  61 #define I40E_ALIGN_RING_DESC    32
  62
  63 #define I40E_MIN_RING_DESC      64
  64 #define I40E_MAX_RING_DESC      4096
  65
  66 #undef container_of
  67 #define container_of(ptr, type, member) ({ \
  68                 typeof(((type *)0)->member)(*__mptr) = (ptr); \
  69                 (type *)((char *)__mptr - offsetof(type, member)); })
  70
  71 #define I40E_TD_CMD (I40E_TX_DESC_CMD_ICRC |\
  72                      I40E_TX_DESC_CMD_EOP)
  73
  74 enum i40e_header_split_mode {
  75         i40e_header_split_none = 0,
  76         i40e_header_split_enabled = 1,
  77         i40e_header_split_always = 2,
  78         i40e_header_split_reserved
  79 };
  80
  81 #define I40E_HEADER_SPLIT_NONE    ((uint8_t)0)
  82 #define I40E_HEADER_SPLIT_L2      ((uint8_t)(1 << 0))
  83 #define I40E_HEADER_SPLIT_IP      ((uint8_t)(1 << 1))
  84 #define I40E_HEADER_SPLIT_UDP_TCP ((uint8_t)(1 << 2))
  85 #define I40E_HEADER_SPLIT_SCTP    ((uint8_t)(1 << 3))
  86 #define I40E_HEADER_SPLIT_ALL (I40E_HEADER_SPLIT_L2 | \
  87                                I40E_HEADER_SPLIT_IP | \
  88                                I40E_HEADER_SPLIT_UDP_TCP | \
  89                                I40E_HEADER_SPLIT_SCTP)
  90
  91 /* HW desc structure, both 16-byte and 32-byte types are supported */
  92 #ifdef RTE_LIBRTE_I40E_16BYTE_RX_DESC
  93 #define i40e_rx_desc i40e_16byte_rx_desc
  94 #else
  95 #define i40e_rx_desc i40e_32byte_rx_desc
  96 #endif
  97
  98 struct i40e_rx_entry {
  99         struct rte_mbuf *mbuf;
 100 };
 101
 102 /*
 103  * Structure associated with each RX queue.
 104  */
 105 struct i40e_rx_queue {
 106         struct rte_mempool *mp; /**< mbuf pool to populate RX ring */
 107         volatile union i40e_rx_desc *rx_ring;/**< RX ring virtual address */
 108         uint64_t rx_ring_phys_addr; /**< RX ring DMA address */
 109         struct i40e_rx_entry *sw_ring; /**< address of RX soft ring */
 110         uint16_t nb_rx_desc; /**< number of RX descriptors */
 111         uint16_t rx_free_thresh; /**< max free RX desc to hold */
 112         uint16_t rx_tail; /**< current value of tail */
 113         uint16_t nb_rx_hold; /**< number of held free RX desc */
 114         struct rte_mbuf *pkt_first_seg; /**< first segment of current packet */
 115         struct rte_mbuf *pkt_last_seg; /**< last segment of current packet */
 116 #ifdef RTE_LIBRTE_I40E_RX_ALLOW_BULK_ALLOC
 117         uint16_t rx_nb_avail; /**< number of staged packets ready */
 118         uint16_t rx_next_avail; /**< index of next staged packets */
 119         uint16_t rx_free_trigger; /**< triggers rx buffer allocation */
 120         struct rte_mbuf fake_mbuf; /**< dummy mbuf */
 121         struct rte_mbuf *rx_stage[RTE_PMD_I40E_RX_MAX_BURST * 2];
 122 #endif
 123
 124         uint16_t rxrearm_nb;    /**< number of remaining to be re-armed */
 125         uint16_t rxrearm_start; /**< the idx we start the re-arming from */
 126         uint64_t mbuf_initializer; /**< value to init mbufs */
 127
 128         uint8_t port_id; /**< device port ID */
 129         uint8_t crc_len; /**< 0 if CRC stripped, 4 otherwise */
 130         uint16_t queue_id; /**< RX queue index */
 131         uint16_t reg_idx; /**< RX queue register index */
 132         uint8_t drop_en; /**< if not 0, set register bit */
 133         volatile uint8_t *qrx_tail; /**< register address of tail */
 134         struct i40e_vsi *vsi; /**< the VSI this queue belongs to */
 135         uint16_t rx_buf_len; /* The packet buffer size */
 136         uint16_t rx_hdr_len; /* The header buffer size */
 137         uint16_t max_pkt_len; /* Maximum packet length */
 138         uint8_t hs_mode; /* Header Split mode */
 139         bool q_set; /**< indicate if rx queue has been configured */
 140         bool rx_deferred_start; /**< don't start this queue in dev start */
 141         uint16_t rx_using_sse; /**<flag indicate the usage of vPMD for rx */
 142         uint8_t dcb_tc;         /**< Traffic class of rx queue */
 143 };
 144
 145 struct i40e_tx_entry {
 146         struct rte_mbuf *mbuf;
 147         uint16_t next_id;
 148         uint16_t last_id;
 149 };
 150
 151 /*
 152  * Structure associated with each TX queue.
 153  */
 154 struct i40e_tx_queue {
 155         uint16_t nb_tx_desc; /**< number of TX descriptors */
 156         uint64_t tx_ring_phys_addr; /**< TX ring DMA address */
 157         volatile struct i40e_tx_desc *tx_ring; /**< TX ring virtual address */
 158         struct i40e_tx_entry *sw_ring; /**< virtual address of SW ring */
 159         uint16_t tx_tail; /**< current value of tail register */
 160         volatile uint8_t *qtx_tail; /**< register address of tail */
 161         uint16_t nb_tx_used; /**< number of TX desc used since RS bit set */
 162         /**< index to last TX descriptor to have been cleaned */
 163         uint16_t last_desc_cleaned;
 164         /**< Total number of TX descriptors ready to be allocated. */
 165         uint16_t nb_tx_free;
 166         /**< Start freeing TX buffers if there are less free descriptors than
 167              this value. */
 168         uint16_t tx_free_thresh;
 169         /** Number of TX descriptors to use before RS bit is set. */
 170         uint16_t tx_rs_thresh;
 171         uint8_t pthresh; /**< Prefetch threshold register. */
 172         uint8_t hthresh; /**< Host threshold register. */
 173         uint8_t wthresh; /**< Write-back threshold reg. */
 174         uint8_t port_id; /**< Device port identifier. */
 175         uint16_t queue_id; /**< TX queue index. */
 176         uint16_t reg_idx;
 177         uint32_t txq_flags;
 178         struct i40e_vsi *vsi; /**< the VSI this queue belongs to */
 179         uint16_t tx_next_dd;
 180         uint16_t tx_next_rs;
 181         bool q_set; /**< indicate if tx queue has been configured */
 182         bool tx_deferred_start; /**< don't start this queue in dev start */
 183         uint8_t dcb_tc;         /**< Traffic class of tx queue */
 184 };
 185
 186 /** Offload features */
 187 union i40e_tx_offload {
 188         uint64_t data;
 189         struct {
 190                 uint64_t l2_len:7; /**< L2 (MAC) Header Length. */
 191                 uint64_t l3_len:9; /**< L3 (IP) Header Length. */
 192                 uint64_t l4_len:8; /**< L4 Header Length. */
 193                 uint64_t tso_segsz:16; /**< TCP TSO segment size */
 194                 uint64_t outer_l2_len:8; /**< outer L2 Header Length */
 195                 uint64_t outer_l3_len:16; /**< outer L3 Header Length */
 196         };
 197 };
 198
 199 int i40e_dev_rx_queue_start(struct rte_eth_dev *dev, uint16_t rx_queue_id);
 200 int i40e_dev_rx_queue_stop(struct rte_eth_dev *dev, uint16_t rx_queue_id);
 201 int i40e_dev_tx_queue_start(struct rte_eth_dev *dev, uint16_t tx_queue_id);
 202 int i40e_dev_tx_queue_stop(struct rte_eth_dev *dev, uint16_t tx_queue_id);
 203 const uint32_t *i40e_dev_supported_ptypes_get(struct rte_eth_dev *dev);
 204 int i40e_dev_rx_queue_setup(struct rte_eth_dev *dev,
 205                             uint16_t queue_idx,
 206                             uint16_t nb_desc,
 207                             unsigned int socket_id,
 208                             const struct rte_eth_rxconf *rx_conf,
 209                             struct rte_mempool *mp);
 210 int i40e_dev_tx_queue_setup(struct rte_eth_dev *dev,
 211                             uint16_t queue_idx,
 212                             uint16_t nb_desc,
 213                             unsigned int socket_id,
 214                             const struct rte_eth_txconf *tx_conf);
 215 void i40e_dev_rx_queue_release(void *rxq);
 216 void i40e_dev_tx_queue_release(void *txq);
 217 uint16_t i40e_recv_pkts(void *rx_queue,
 218                         struct rte_mbuf **rx_pkts,
 219                         uint16_t nb_pkts);
 220 uint16_t i40e_recv_scattered_pkts(void *rx_queue,
 221                                   struct rte_mbuf **rx_pkts,
 222                                   uint16_t nb_pkts);
 223 uint16_t i40e_xmit_pkts(void *tx_queue,
 224                         struct rte_mbuf **tx_pkts,
 225                         uint16_t nb_pkts);
 226 int i40e_tx_queue_init(struct i40e_tx_queue *txq);
 227 int i40e_rx_queue_init(struct i40e_rx_queue *rxq);
 228 void i40e_free_tx_resources(struct i40e_tx_queue *txq);
 229 void i40e_free_rx_resources(struct i40e_rx_queue *rxq);
 230 void i40e_dev_clear_queues(struct rte_eth_dev *dev);
 231 void i40e_dev_free_queues(struct rte_eth_dev *dev);
 232 void i40e_reset_rx_queue(struct i40e_rx_queue *rxq);
 233 void i40e_reset_tx_queue(struct i40e_tx_queue *txq);
 234 void i40e_tx_queue_release_mbufs(struct i40e_tx_queue *txq);
 235 int i40e_alloc_rx_queue_mbufs(struct i40e_rx_queue *rxq);
 236 void i40e_rx_queue_release_mbufs(struct i40e_rx_queue *rxq);
 237
 238 uint32_t i40e_dev_rx_queue_count(struct rte_eth_dev *dev,
 239                                  uint16_t rx_queue_id);
 240 int i40e_dev_rx_descriptor_done(void *rx_queue, uint16_t offset);
 241
 242 uint16_t i40e_recv_pkts_vec(void *rx_queue, struct rte_mbuf **rx_pkts,
 243                             uint16_t nb_pkts);
 244 uint16_t i40e_recv_scattered_pkts_vec(void *rx_queue,
 245                                       struct rte_mbuf **rx_pkts,
 246                                       uint16_t nb_pkts);
 247 int i40e_rx_vec_dev_conf_condition_check(struct rte_eth_dev *dev);
 248 int i40e_rxq_vec_setup(struct i40e_rx_queue *rxq);
 249 int i40e_txq_vec_setup(struct i40e_tx_queue *txq);
 250 void i40e_rx_queue_release_mbufs_vec(struct i40e_rx_queue *rxq);
 251 uint16_t i40e_xmit_pkts_vec(void *tx_queue, struct rte_mbuf **tx_pkts,
 252                             uint16_t nb_pkts);
 253 void i40e_set_rx_function(struct rte_eth_dev *dev);
 254 void i40e_set_tx_function_flag(struct rte_eth_dev *dev,
 255                                struct i40e_tx_queue *txq);
 256 void i40e_set_tx_function(struct rte_eth_dev *dev);
 257
 258 #endif /* _I40E_RXTX_H_ */