drivers/net/mlx5/mlx5_rxtx.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright 2015 6WIND S.A.
   5  *   Copyright 2015 Mellanox.
   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 6WIND S.A. 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 RTE_PMD_MLX5_RXTX_H_
  35 #define RTE_PMD_MLX5_RXTX_H_
  36
  37 #include <stdint.h>
  38
  39 /* Verbs header. */
  40 /* ISO C doesn't support unnamed structs/unions, disabling -pedantic. */
  41 #ifdef PEDANTIC
  42 #pragma GCC diagnostic ignored "-pedantic"
  43 #endif
  44 #include <infiniband/verbs.h>
  45 #ifdef PEDANTIC
  46 #pragma GCC diagnostic error "-pedantic"
  47 #endif
  48
  49 /* DPDK headers don't like -pedantic. */
  50 #ifdef PEDANTIC
  51 #pragma GCC diagnostic ignored "-pedantic"
  52 #endif
  53 #include <rte_mbuf.h>
  54 #include <rte_mempool.h>
  55 #ifdef PEDANTIC
  56 #pragma GCC diagnostic error "-pedantic"
  57 #endif
  58
  59 #include "mlx5_utils.h"
  60 #include "mlx5.h"
  61 #include "mlx5_defs.h"
  62
  63 /* RX element. */
  64 struct rxq_elt {
  65         struct ibv_recv_wr wr; /* Work Request. */
  66         struct ibv_sge sge; /* Scatter/Gather Element. */
  67         /* mbuf pointer is derived from WR_ID(wr.wr_id).offset. */
  68 };
  69
  70 struct priv;
  71
  72 /* RX queue descriptor. */
  73 struct rxq {
  74         struct priv *priv; /* Back pointer to private data. */
  75         struct rte_mempool *mp; /* Memory Pool for allocations. */
  76         struct ibv_mr *mr; /* Memory Region (for mp). */
  77         struct ibv_cq *cq; /* Completion Queue. */
  78         struct ibv_qp *qp; /* Queue Pair. */
  79         struct ibv_exp_qp_burst_family *if_qp; /* QP burst interface. */
  80         struct ibv_exp_cq_family *if_cq; /* CQ interface. */
  81         unsigned int port_id; /* Port ID for incoming packets. */
  82         unsigned int elts_n; /* (*elts)[] length. */
  83         unsigned int elts_head; /* Current index in (*elts)[]. */
  84         union {
  85                 struct rxq_elt (*no_sp)[]; /* RX elements. */
  86         } elts;
  87         uint32_t mb_len; /* Length of a mp-issued mbuf. */
  88         unsigned int socket; /* CPU socket ID for allocations. */
  89         struct ibv_exp_res_domain *rd; /* Resource Domain. */
  90 };
  91
  92 /* TX element. */
  93 struct txq_elt {
  94         struct rte_mbuf *buf;
  95 };
  96
  97 /* Linear buffer type. It is used when transmitting buffers with too many
  98  * segments that do not fit the hardware queue (see max_send_sge).
  99  * Extra segments are copied (linearized) in such buffers, replacing the
 100  * last SGE during TX.
 101  * The size is arbitrary but large enough to hold a jumbo frame with
 102  * 8 segments considering mbuf.buf_len is about 2048 bytes. */
 103 typedef uint8_t linear_t[16384];
 104
 105 /* TX queue descriptor. */
 106 struct txq {
 107         struct priv *priv; /* Back pointer to private data. */
 108         struct {
 109                 struct rte_mempool *mp; /* Cached Memory Pool. */
 110                 struct ibv_mr *mr; /* Memory Region (for mp). */
 111                 uint32_t lkey; /* mr->lkey */
 112         } mp2mr[MLX5_PMD_TX_MP_CACHE]; /* MP to MR translation table. */
 113         struct ibv_cq *cq; /* Completion Queue. */
 114         struct ibv_qp *qp; /* Queue Pair. */
 115         struct ibv_exp_qp_burst_family *if_qp; /* QP burst interface. */
 116         struct ibv_exp_cq_family *if_cq; /* CQ interface. */
 117 #if MLX5_PMD_MAX_INLINE > 0
 118         uint32_t max_inline; /* Max inline send size <= MLX5_PMD_MAX_INLINE. */
 119 #endif
 120         unsigned int elts_n; /* (*elts)[] length. */
 121         struct txq_elt (*elts)[]; /* TX elements. */
 122         unsigned int elts_head; /* Current index in (*elts)[]. */
 123         unsigned int elts_tail; /* First element awaiting completion. */
 124         unsigned int elts_comp; /* Number of completion requests. */
 125         unsigned int elts_comp_cd; /* Countdown for next completion request. */
 126         unsigned int elts_comp_cd_init; /* Initial value for countdown. */
 127         linear_t (*elts_linear)[]; /* Linearized buffers. */
 128         struct ibv_mr *mr_linear; /* Memory Region for linearized buffers. */
 129         unsigned int socket; /* CPU socket ID for allocations. */
 130         struct ibv_exp_res_domain *rd; /* Resource Domain. */
 131 };
 132
 133 /* mlx5_rxq.c */
 134
 135 void rxq_cleanup(struct rxq *);
 136 int rxq_setup(struct rte_eth_dev *, struct rxq *, uint16_t, unsigned int,
 137               const struct rte_eth_rxconf *, struct rte_mempool *);
 138 int mlx5_rx_queue_setup(struct rte_eth_dev *, uint16_t, uint16_t, unsigned int,
 139                         const struct rte_eth_rxconf *, struct rte_mempool *);
 140 void mlx5_rx_queue_release(void *);
 141
 142 /* mlx5_txq.c */
 143
 144 void txq_cleanup(struct txq *);
 145 int mlx5_tx_queue_setup(struct rte_eth_dev *, uint16_t, uint16_t, unsigned int,
 146                         const struct rte_eth_txconf *);
 147 void mlx5_tx_queue_release(void *);
 148
 149 /* mlx5_rxtx.c */
 150
 151 uint16_t mlx5_tx_burst(void *, struct rte_mbuf **, uint16_t);
 152 uint16_t mlx5_rx_burst(void *, struct rte_mbuf **, uint16_t);
 153 uint16_t removed_tx_burst(void *, struct rte_mbuf **, uint16_t);
 154 uint16_t removed_rx_burst(void *, struct rte_mbuf **, uint16_t);
 155
 156 #endif /* RTE_PMD_MLX5_RXTX_H_ */