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