drivers/net/mlx4/mlx4.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright 2012 6WIND S.A.
   5  *   Copyright 2012 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_MLX4_H_
  35 #define RTE_PMD_MLX4_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 "-Wpedantic"
  43 #endif
  44 #include <infiniband/verbs.h>
  45 #ifdef PEDANTIC
  46 #pragma GCC diagnostic error "-Wpedantic"
  47 #endif
  48
  49 #include <rte_ethdev.h>
  50 #include <rte_ether.h>
  51 #include <rte_interrupts.h>
  52
  53 /* Request send completion once in every 64 sends, might be less. */
  54 #define MLX4_PMD_TX_PER_COMP_REQ 64
  55
  56 /* Maximum size for inline data. */
  57 #define MLX4_PMD_MAX_INLINE 0
  58
  59 /*
  60  * Maximum number of cached Memory Pools (MPs) per TX queue. Each RTE MP
  61  * from which buffers are to be transmitted will have to be mapped by this
  62  * driver to their own Memory Region (MR). This is a slow operation.
  63  *
  64  * This value is always 1 for RX queues.
  65  */
  66 #ifndef MLX4_PMD_TX_MP_CACHE
  67 #define MLX4_PMD_TX_MP_CACHE 8
  68 #endif
  69
  70 /* Interrupt alarm timeout value in microseconds. */
  71 #define MLX4_INTR_ALARM_TIMEOUT 100000
  72
  73 /* Port parameter. */
  74 #define MLX4_PMD_PORT_KVARG "port"
  75
  76 enum {
  77         PCI_VENDOR_ID_MELLANOX = 0x15b3,
  78 };
  79
  80 enum {
  81         PCI_DEVICE_ID_MELLANOX_CONNECTX3 = 0x1003,
  82         PCI_DEVICE_ID_MELLANOX_CONNECTX3VF = 0x1004,
  83         PCI_DEVICE_ID_MELLANOX_CONNECTX3PRO = 0x1007,
  84 };
  85
  86 #define MLX4_DRIVER_NAME "net_mlx4"
  87
  88 struct mlx4_rxq_stats {
  89         unsigned int idx; /**< Mapping index. */
  90         uint64_t ipackets; /**< Total of successfully received packets. */
  91         uint64_t ibytes; /**< Total of successfully received bytes. */
  92         uint64_t idropped; /**< Total of packets dropped when RX ring full. */
  93         uint64_t rx_nombuf; /**< Total of RX mbuf allocation failures. */
  94 };
  95
  96 /* RX element. */
  97 struct rxq_elt {
  98         struct ibv_recv_wr wr; /* Work Request. */
  99         struct ibv_sge sge; /* Scatter/Gather Element. */
 100         struct rte_mbuf *buf; /**< Buffer. */
 101 };
 102
 103 /* RX queue descriptor. */
 104 struct rxq {
 105         struct priv *priv; /* Back pointer to private data. */
 106         struct rte_mempool *mp; /* Memory Pool for allocations. */
 107         struct ibv_mr *mr; /* Memory Region (for mp). */
 108         struct ibv_cq *cq; /* Completion Queue. */
 109         struct ibv_qp *qp; /* Queue Pair. */
 110         struct ibv_comp_channel *channel;
 111         unsigned int port_id; /* Port ID for incoming packets. */
 112         unsigned int elts_n; /* (*elts)[] length. */
 113         unsigned int elts_head; /* Current index in (*elts)[]. */
 114         struct rxq_elt (*elts)[]; /* Rx elements. */
 115         struct mlx4_rxq_stats stats; /* RX queue counters. */
 116         unsigned int socket; /* CPU socket ID for allocations. */
 117 };
 118
 119 /* TX element. */
 120 struct txq_elt {
 121         struct ibv_send_wr wr; /* Work request. */
 122         struct ibv_sge sge; /* Scatter/gather element. */
 123         struct rte_mbuf *buf;
 124 };
 125
 126 struct mlx4_txq_stats {
 127         unsigned int idx; /**< Mapping index. */
 128         uint64_t opackets; /**< Total of successfully sent packets. */
 129         uint64_t obytes;   /**< Total of successfully sent bytes. */
 130         uint64_t odropped; /**< Total of packets not sent when TX ring full. */
 131 };
 132
 133 /* TX queue descriptor. */
 134 struct txq {
 135         struct priv *priv; /* Back pointer to private data. */
 136         struct {
 137                 const struct rte_mempool *mp; /* Cached Memory Pool. */
 138                 struct ibv_mr *mr; /* Memory Region (for mp). */
 139                 uint32_t lkey; /* mr->lkey */
 140         } mp2mr[MLX4_PMD_TX_MP_CACHE]; /* MP to MR translation table. */
 141         struct ibv_cq *cq; /* Completion Queue. */
 142         struct ibv_qp *qp; /* Queue Pair. */
 143         uint32_t max_inline; /* Max inline send size <= MLX4_PMD_MAX_INLINE. */
 144         unsigned int elts_n; /* (*elts)[] length. */
 145         struct txq_elt (*elts)[]; /* TX elements. */
 146         unsigned int elts_head; /* Current index in (*elts)[]. */
 147         unsigned int elts_tail; /* First element awaiting completion. */
 148         unsigned int elts_comp; /* Number of completion requests. */
 149         unsigned int elts_comp_cd; /* Countdown for next completion request. */
 150         unsigned int elts_comp_cd_init; /* Initial value for countdown. */
 151         struct mlx4_txq_stats stats; /* TX queue counters. */
 152         unsigned int socket; /* CPU socket ID for allocations. */
 153 };
 154
 155 struct rte_flow;
 156
 157 struct priv {
 158         struct rte_eth_dev *dev; /* Ethernet device. */
 159         struct ibv_context *ctx; /* Verbs context. */
 160         struct ibv_device_attr device_attr; /* Device properties. */
 161         struct ibv_pd *pd; /* Protection Domain. */
 162         struct ether_addr mac; /* MAC address. */
 163         struct ibv_flow *mac_flow; /* Flow associated with MAC address. */
 164         /* Device properties. */
 165         uint16_t mtu; /* Configured MTU. */
 166         uint8_t port; /* Physical port number. */
 167         unsigned int started:1; /* Device started, flows enabled. */
 168         unsigned int vf:1; /* This is a VF device. */
 169         unsigned int intr_alarm:1; /* An interrupt alarm is scheduled. */
 170         unsigned int isolated:1; /* Toggle isolated mode. */
 171         /* RX/TX queues. */
 172         unsigned int rxqs_n; /* RX queues array size. */
 173         unsigned int txqs_n; /* TX queues array size. */
 174         struct rxq *(*rxqs)[]; /* RX queues. */
 175         struct txq *(*txqs)[]; /* TX queues. */
 176         struct rte_intr_handle intr_handle; /* Port interrupt handle. */
 177         struct rte_flow_drop *flow_drop_queue; /* Flow drop queue. */
 178         LIST_HEAD(mlx4_flows, rte_flow) flows;
 179 };
 180
 181 /* mlx4.c */
 182
 183 int mlx4_link_update(struct rte_eth_dev *dev, int wait_to_complete);
 184
 185 /* mlx4_intr.c */
 186
 187 int mlx4_intr_uninstall(struct priv *priv);
 188 int mlx4_intr_install(struct priv *priv);
 189 int mlx4_rx_intr_disable(struct rte_eth_dev *dev, uint16_t idx);
 190 int mlx4_rx_intr_enable(struct rte_eth_dev *dev, uint16_t idx);
 191
 192 #endif /* RTE_PMD_MLX4_H_ */