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