lib/librte_pmd_ixgbe/ixgbe_rxtx.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 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_RXTX_H_
  35 #define _IXGBE_RXTX_H_
  36
  37
  38 #define RTE_PMD_IXGBE_TX_MAX_BURST 32
  39 #define RTE_PMD_IXGBE_RX_MAX_BURST 32
  40
  41 #ifdef RTE_LIBRTE_IXGBE_RX_ALLOW_BULK_ALLOC
  42 #define RTE_IXGBE_DESCS_PER_LOOP           4
  43 #elif defined(RTE_IXGBE_INC_VECTOR)
  44 #define RTE_IXGBE_DESCS_PER_LOOP           4
  45 #else
  46 #define RTE_IXGBE_DESCS_PER_LOOP           1
  47 #endif
  48
  49 #define RTE_MBUF_DATA_DMA_ADDR(mb) \
  50         (uint64_t) ((mb)->buf_physaddr + (mb)->data_off)
  51
  52 #define RTE_MBUF_DATA_DMA_ADDR_DEFAULT(mb) \
  53         (uint64_t) ((mb)->buf_physaddr + RTE_PKTMBUF_HEADROOM)
  54
  55 #ifdef RTE_IXGBE_INC_VECTOR
  56 #define RTE_IXGBE_VPMD_RX_BURST         32
  57 #define RTE_IXGBE_VPMD_TX_BURST         32
  58 #define RTE_IXGBE_RXQ_REARM_THRESH      RTE_IXGBE_VPMD_RX_BURST
  59 #define RTE_IXGBE_TX_MAX_FREE_BUF_SZ    64
  60 #endif
  61
  62 #define RX_RING_SZ ((IXGBE_MAX_RING_DESC + RTE_IXGBE_DESCS_PER_LOOP - 1) * \
  63                     sizeof(union ixgbe_adv_rx_desc))
  64
  65 #ifdef RTE_PMD_PACKET_PREFETCH
  66 #define rte_packet_prefetch(p)  rte_prefetch1(p)
  67 #else
  68 #define rte_packet_prefetch(p)  do {} while(0)
  69 #endif
  70
  71 #define RTE_IXGBE_REGISTER_POLL_WAIT_10_MS  10
  72 #define RTE_IXGBE_WAIT_100_US               100
  73 #define RTE_IXGBE_VMTXSW_REGISTER_COUNT     2
  74
  75 /**
  76  * Structure associated with each descriptor of the RX ring of a RX queue.
  77  */
  78 struct ixgbe_rx_entry {
  79         struct rte_mbuf *mbuf; /**< mbuf associated with RX descriptor. */
  80 };
  81
  82 struct ixgbe_scattered_rx_entry {
  83         struct rte_mbuf *fbuf; /**< First segment of the fragmented packet. */
  84 };
  85
  86 /**
  87  * Structure associated with each descriptor of the TX ring of a TX queue.
  88  */
  89 struct ixgbe_tx_entry {
  90         struct rte_mbuf *mbuf; /**< mbuf associated with TX desc, if any. */
  91         uint16_t next_id; /**< Index of next descriptor in ring. */
  92         uint16_t last_id; /**< Index of last scattered descriptor. */
  93 };
  94
  95 /**
  96  * Structure associated with each descriptor of the TX ring of a TX queue.
  97  */
  98 struct ixgbe_tx_entry_v {
  99         struct rte_mbuf *mbuf; /**< mbuf associated with TX desc, if any. */
 100 };
 101
 102 /**
 103  * Structure associated with each RX queue.
 104  */
 105 struct ixgbe_rx_queue {
 106         struct rte_mempool  *mb_pool; /**< mbuf pool to populate RX ring. */
 107         volatile union ixgbe_adv_rx_desc *rx_ring; /**< RX ring virtual address. */
 108         uint64_t            rx_ring_phys_addr; /**< RX ring DMA address. */
 109         volatile uint32_t   *rdt_reg_addr; /**< RDT register address. */
 110         volatile uint32_t   *rdh_reg_addr; /**< RDH register address. */
 111         struct ixgbe_rx_entry *sw_ring; /**< address of RX software ring. */
 112         struct ixgbe_scattered_rx_entry *sw_sc_ring; /**< address of scattered Rx software ring. */
 113         struct rte_mbuf *pkt_first_seg; /**< First segment of current packet. */
 114         struct rte_mbuf *pkt_last_seg; /**< Last segment of current packet. */
 115         uint64_t            mbuf_initializer; /**< value to init mbufs */
 116         uint16_t            nb_rx_desc; /**< number of RX descriptors. */
 117         uint16_t            rx_tail;  /**< current value of RDT register. */
 118         uint16_t            nb_rx_hold; /**< number of held free RX desc. */
 119 #ifdef RTE_LIBRTE_IXGBE_RX_ALLOW_BULK_ALLOC
 120         uint16_t rx_nb_avail; /**< nr of staged pkts ready to ret to app */
 121         uint16_t rx_next_avail; /**< idx of next staged pkt to ret to app */
 122         uint16_t rx_free_trigger; /**< triggers rx buffer allocation */
 123 #endif
 124 #ifdef RTE_IXGBE_INC_VECTOR
 125         uint16_t            rxrearm_nb; /**< the idx we start the re-arming from */
 126         uint16_t            rxrearm_start;  /**< number of remaining to be re-armed */
 127 #endif
 128         uint16_t            rx_free_thresh; /**< max free RX desc to hold. */
 129         uint16_t            queue_id; /**< RX queue index. */
 130         uint16_t            reg_idx;  /**< RX queue register index. */
 131         uint8_t             port_id;  /**< Device port identifier. */
 132         uint8_t             crc_len;  /**< 0 if CRC stripped, 4 otherwise. */
 133         uint8_t             drop_en;  /**< If not 0, set SRRCTL.Drop_En. */
 134         uint8_t             rx_deferred_start; /**< not in global dev start. */
 135 #ifdef RTE_LIBRTE_IXGBE_RX_ALLOW_BULK_ALLOC
 136         /** need to alloc dummy mbuf, for wraparound when scanning hw ring */
 137         struct rte_mbuf fake_mbuf;
 138         /** hold packets to return to application */
 139         struct rte_mbuf *rx_stage[RTE_PMD_IXGBE_RX_MAX_BURST*2];
 140 #endif
 141 };
 142
 143 /**
 144  * IXGBE CTX Constants
 145  */
 146 enum ixgbe_advctx_num {
 147         IXGBE_CTX_0    = 0, /**< CTX0 */
 148         IXGBE_CTX_1    = 1, /**< CTX1  */
 149         IXGBE_CTX_NUM  = 2, /**< CTX NUMBER  */
 150 };
 151
 152 /** Offload features */
 153 union ixgbe_tx_offload {
 154         uint64_t data;
 155         struct {
 156                 uint64_t l2_len:7; /**< L2 (MAC) Header Length. */
 157                 uint64_t l3_len:9; /**< L3 (IP) Header Length. */
 158                 uint64_t l4_len:8; /**< L4 (TCP/UDP) Header Length. */
 159                 uint64_t tso_segsz:16; /**< TCP TSO segment size */
 160                 uint64_t vlan_tci:16;
 161                 /**< VLAN Tag Control Identifier (CPU order). */
 162         };
 163 };
 164
 165 /*
 166  * Compare mask for vlan_macip_len.data,
 167  * should be in sync with ixgbe_vlan_macip.f layout.
 168  * */
 169 #define TX_VLAN_CMP_MASK        0xFFFF0000  /**< VLAN length - 16-bits. */
 170 #define TX_MAC_LEN_CMP_MASK     0x0000FE00  /**< MAC length - 7-bits. */
 171 #define TX_IP_LEN_CMP_MASK      0x000001FF  /**< IP  length - 9-bits. */
 172 /** MAC+IP  length. */
 173 #define TX_MACIP_LEN_CMP_MASK   (TX_MAC_LEN_CMP_MASK | TX_IP_LEN_CMP_MASK)
 174
 175 /**
 176  * Structure to check if new context need be built
 177  */
 178
 179 struct ixgbe_advctx_info {
 180         uint64_t flags;           /**< ol_flags for context build. */
 181         /**< tx offload: vlan, tso, l2-l3-l4 lengths. */
 182         union ixgbe_tx_offload tx_offload;
 183         /** compare mask for tx offload. */
 184         union ixgbe_tx_offload tx_offload_mask;
 185 };
 186
 187 /**
 188  * Structure associated with each TX queue.
 189  */
 190 struct ixgbe_tx_queue {
 191         /** TX ring virtual address. */
 192         volatile union ixgbe_adv_tx_desc *tx_ring;
 193         uint64_t            tx_ring_phys_addr; /**< TX ring DMA address. */
 194         struct ixgbe_tx_entry *sw_ring;      /**< virtual address of SW ring. */
 195         volatile uint32_t   *tdt_reg_addr; /**< Address of TDT register. */
 196         uint16_t            nb_tx_desc;    /**< number of TX descriptors. */
 197         uint16_t            tx_tail;       /**< current value of TDT reg. */
 198         uint16_t            tx_free_thresh;/**< minimum TX before freeing. */
 199         /** Number of TX descriptors to use before RS bit is set. */
 200         uint16_t            tx_rs_thresh;
 201         /** Number of TX descriptors used since RS bit was set. */
 202         uint16_t            nb_tx_used;
 203         /** Index to last TX descriptor to have been cleaned. */
 204         uint16_t            last_desc_cleaned;
 205         /** Total number of TX descriptors ready to be allocated. */
 206         uint16_t            nb_tx_free;
 207         uint16_t tx_next_dd; /**< next desc to scan for DD bit */
 208         uint16_t tx_next_rs; /**< next desc to set RS bit */
 209         uint16_t            queue_id;      /**< TX queue index. */
 210         uint16_t            reg_idx;       /**< TX queue register index. */
 211         uint8_t             port_id;       /**< Device port identifier. */
 212         uint8_t             pthresh;       /**< Prefetch threshold register. */
 213         uint8_t             hthresh;       /**< Host threshold register. */
 214         uint8_t             wthresh;       /**< Write-back threshold reg. */
 215         uint32_t txq_flags; /**< Holds flags for this TXq */
 216         uint32_t            ctx_curr;      /**< Hardware context states. */
 217         /** Hardware context0 history. */
 218         struct ixgbe_advctx_info ctx_cache[IXGBE_CTX_NUM];
 219         const struct ixgbe_txq_ops *ops;       /**< txq ops */
 220         uint8_t             tx_deferred_start; /**< not in global dev start. */
 221 };
 222
 223 struct ixgbe_txq_ops {
 224         void (*release_mbufs)(struct ixgbe_tx_queue *txq);
 225         void (*free_swring)(struct ixgbe_tx_queue *txq);
 226         void (*reset)(struct ixgbe_tx_queue *txq);
 227 };
 228
 229 /*
 230  * The "simple" TX queue functions require that the following
 231  * flags are set when the TX queue is configured:
 232  *  - ETH_TXQ_FLAGS_NOMULTSEGS
 233  *  - ETH_TXQ_FLAGS_NOVLANOFFL
 234  *  - ETH_TXQ_FLAGS_NOXSUMSCTP
 235  *  - ETH_TXQ_FLAGS_NOXSUMUDP
 236  *  - ETH_TXQ_FLAGS_NOXSUMTCP
 237  * and that the RS bit threshold (tx_rs_thresh) is at least equal to
 238  * RTE_PMD_IXGBE_TX_MAX_BURST.
 239  */
 240 #define IXGBE_SIMPLE_FLAGS ((uint32_t)ETH_TXQ_FLAGS_NOMULTSEGS | \
 241                             ETH_TXQ_FLAGS_NOOFFLOADS)
 242
 243 /*
 244  * Populate descriptors with the following info:
 245  * 1.) buffer_addr = phys_addr + headroom
 246  * 2.) cmd_type_len = DCMD_DTYP_FLAGS | pkt_len
 247  * 3.) olinfo_status = pkt_len << PAYLEN_SHIFT
 248  */
 249
 250 /* Defines for Tx descriptor */
 251 #define DCMD_DTYP_FLAGS (IXGBE_ADVTXD_DTYP_DATA |\
 252                          IXGBE_ADVTXD_DCMD_IFCS |\
 253                          IXGBE_ADVTXD_DCMD_DEXT |\
 254                          IXGBE_ADVTXD_DCMD_EOP)
 255
 256
 257 /* Takes an ethdev and a queue and sets up the tx function to be used based on
 258  * the queue parameters. Used in tx_queue_setup by primary process and then
 259  * in dev_init by secondary process when attaching to an existing ethdev.
 260  */
 261 void ixgbe_set_tx_function(struct rte_eth_dev *dev, struct ixgbe_tx_queue *txq);
 262
 263 /**
 264  * Sets the rx_pkt_burst callback in the ixgbe rte_eth_dev instance.
 265  *
 266  * Sets the callback based on the device parameters:
 267  *  - ixgbe_hw.rx_bulk_alloc_allowed
 268  *  - rte_eth_dev_data.scattered_rx
 269  *  - rte_eth_dev_data.lro
 270  *  - conditions checked in ixgbe_rx_vec_condition_check()
 271  *
 272  *  This means that the parameters above have to be configured prior to calling
 273  *  to this function.
 274  *
 275  * @dev rte_eth_dev handle
 276  */
 277 void ixgbe_set_rx_function(struct rte_eth_dev *dev);
 278
 279 uint16_t ixgbe_recv_pkts_vec(void *rx_queue, struct rte_mbuf **rx_pkts,
 280                 uint16_t nb_pkts);
 281 uint16_t ixgbe_recv_scattered_pkts_vec(void *rx_queue,
 282                 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
 283 int ixgbe_rx_vec_dev_conf_condition_check(struct rte_eth_dev *dev);
 284 int ixgbe_rxq_vec_setup(struct ixgbe_rx_queue *rxq);
 285
 286 #ifdef RTE_IXGBE_INC_VECTOR
 287
 288 uint16_t ixgbe_xmit_pkts_vec(void *tx_queue, struct rte_mbuf **tx_pkts,
 289                 uint16_t nb_pkts);
 290 int ixgbe_txq_vec_setup(struct ixgbe_tx_queue *txq);
 291
 292 #endif /* RTE_IXGBE_INC_VECTOR */
 293 #endif /* _IXGBE_RXTX_H_ */