4 * Copyright 2015 6WIND S.A.
5 * Copyright 2015 Mellanox.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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.
34 #ifndef RTE_PMD_MLX5_H_
35 #define RTE_PMD_MLX5_H_
41 #include <netinet/in.h>
44 /* ISO C doesn't support unnamed structs/unions, disabling -pedantic. */
46 #pragma GCC diagnostic ignored "-Wpedantic"
48 #include <infiniband/verbs.h>
50 #pragma GCC diagnostic error "-Wpedantic"
54 #include <rte_ether.h>
55 #include <rte_ethdev.h>
56 #include <rte_spinlock.h>
57 #include <rte_interrupts.h>
58 #include <rte_errno.h>
61 #include "mlx5_utils.h"
62 #include "mlx5_rxtx.h"
63 #include "mlx5_autoconf.h"
64 #include "mlx5_defs.h"
67 PCI_VENDOR_ID_MELLANOX = 0x15b3,
71 PCI_DEVICE_ID_MELLANOX_CONNECTX4 = 0x1013,
72 PCI_DEVICE_ID_MELLANOX_CONNECTX4VF = 0x1014,
73 PCI_DEVICE_ID_MELLANOX_CONNECTX4LX = 0x1015,
74 PCI_DEVICE_ID_MELLANOX_CONNECTX4LXVF = 0x1016,
75 PCI_DEVICE_ID_MELLANOX_CONNECTX5 = 0x1017,
76 PCI_DEVICE_ID_MELLANOX_CONNECTX5VF = 0x1018,
77 PCI_DEVICE_ID_MELLANOX_CONNECTX5EX = 0x1019,
78 PCI_DEVICE_ID_MELLANOX_CONNECTX5EXVF = 0x101a,
81 struct mlx5_xstats_ctrl {
82 /* Number of device stats. */
84 /* Index in the device counters table. */
85 uint16_t dev_table_idx[MLX5_MAX_XSTATS];
86 uint64_t base[MLX5_MAX_XSTATS];
90 struct rte_eth_dev *dev; /* Ethernet device of master process. */
91 struct ibv_context *ctx; /* Verbs context. */
92 struct ibv_device_attr_ex device_attr; /* Device properties. */
93 struct ibv_pd *pd; /* Protection Domain. */
94 char ibdev_path[IBV_SYSFS_PATH_MAX]; /* IB device path for secondary */
96 * MAC addresses array and configuration bit-field.
97 * An extra entry that cannot be modified by the DPDK is reserved
98 * for broadcast frames (destination MAC address ff:ff:ff:ff:ff:ff).
100 struct ether_addr mac[MLX5_MAX_MAC_ADDRESSES];
101 BITFIELD_DECLARE(mac_configured, uint32_t, MLX5_MAX_MAC_ADDRESSES);
102 uint16_t vlan_filter[MLX5_MAX_VLAN_IDS]; /* VLAN filters table. */
103 unsigned int vlan_filter_n; /* Number of configured VLAN filters. */
104 /* Device properties. */
105 uint16_t mtu; /* Configured MTU. */
106 uint8_t port; /* Physical port number. */
107 unsigned int promisc_req:1; /* Promiscuous mode requested. */
108 unsigned int allmulti_req:1; /* All multicast mode requested. */
109 unsigned int hw_csum:1; /* Checksum offload is supported. */
110 unsigned int hw_csum_l2tun:1; /* Same for L2 tunnels. */
111 unsigned int hw_vlan_strip:1; /* VLAN stripping is supported. */
112 unsigned int hw_fcs_strip:1; /* FCS stripping is supported. */
113 unsigned int hw_padding:1; /* End alignment padding is supported. */
114 unsigned int sriov:1; /* This is a VF or PF with VF devices. */
115 unsigned int mps:2; /* Multi-packet send mode (0: disabled). */
116 unsigned int mpw_hdr_dseg:1; /* Enable DSEGs in the title WQEBB. */
117 unsigned int cqe_comp:1; /* Whether CQE compression is enabled. */
118 unsigned int pending_alarm:1; /* An alarm is pending. */
119 unsigned int tso:1; /* Whether TSO is supported. */
120 unsigned int tunnel_en:1;
121 unsigned int isolated:1; /* Whether isolated mode is enabled. */
122 unsigned int tx_vec_en:1; /* Whether Tx vector is enabled. */
123 unsigned int rx_vec_en:1; /* Whether Rx vector is enabled. */
124 /* Whether Tx offloads for tunneled packets are supported. */
125 unsigned int max_tso_payload_sz; /* Maximum TCP payload for TSO. */
126 unsigned int txq_inline; /* Maximum packet size for inlining. */
127 unsigned int txqs_inline; /* Queue number threshold for inlining. */
128 unsigned int inline_max_packet_sz; /* Max packet size for inlining. */
130 unsigned int rxqs_n; /* RX queues array size. */
131 unsigned int txqs_n; /* TX queues array size. */
132 struct mlx5_rxq_data *(*rxqs)[]; /* RX queues. */
133 struct mlx5_txq_data *(*txqs)[]; /* TX queues. */
134 /* Indirection tables referencing all RX WQs. */
135 struct ibv_rwq_ind_table *(*ind_tables)[];
136 unsigned int ind_tables_n; /* Number of indirection tables. */
137 unsigned int ind_table_max_size; /* Maximum indirection table size. */
138 /* Hash RX QPs feeding the indirection table. */
139 struct hash_rxq (*hash_rxqs)[];
140 unsigned int hash_rxqs_n; /* Hash RX QPs array size. */
141 /* RSS configuration array indexed by hash RX queue type. */
142 struct rte_eth_rss_conf *(*rss_conf)[];
143 uint64_t rss_hf; /* RSS DPDK bit field of active RSS. */
144 struct rte_intr_handle intr_handle; /* Interrupt handler. */
145 unsigned int (*reta_idx)[]; /* RETA index table. */
146 unsigned int reta_idx_n; /* RETA index size. */
147 struct rte_flow_drop *flow_drop_queue; /* Flow drop queue. */
148 TAILQ_HEAD(mlx5_flows, rte_flow) flows; /* RTE Flow rules. */
149 LIST_HEAD(mr, mlx5_mr) mr; /* Memory region. */
150 LIST_HEAD(rxqibv, mlx5_rxq_ibv) rxqsibv; /* Verbs Rx queues. */
151 LIST_HEAD(txqibv, mlx5_txq_ibv) txqsibv; /* Verbs Tx queues. */
152 uint32_t link_speed_capa; /* Link speed capabilities. */
153 struct mlx5_xstats_ctrl xstats_ctrl; /* Extended stats control. */
154 rte_spinlock_t lock; /* Lock for control functions. */
155 int primary_socket; /* Unix socket for primary process. */
156 struct rte_intr_handle intr_handle_socket; /* Interrupt handler. */
160 * Lock private structure to protect it from concurrent access in the
164 * Pointer to private structure.
167 priv_lock(struct priv *priv)
169 rte_spinlock_lock(&priv->lock);
173 * Unlock private structure.
176 * Pointer to private structure.
179 priv_unlock(struct priv *priv)
181 rte_spinlock_unlock(&priv->lock);
186 int mlx5_getenv_int(const char *);
190 struct priv *mlx5_get_priv(struct rte_eth_dev *dev);
191 int mlx5_is_secondary(void);
192 int priv_get_ifname(const struct priv *, char (*)[IF_NAMESIZE]);
193 int priv_ifreq(const struct priv *, int req, struct ifreq *);
194 int priv_is_ib_cntr(const char *);
195 int priv_get_cntr_sysfs(struct priv *, const char *, uint64_t *);
196 int priv_get_num_vfs(struct priv *, uint16_t *);
197 int priv_get_mtu(struct priv *, uint16_t *);
198 int priv_set_flags(struct priv *, unsigned int, unsigned int);
199 int mlx5_dev_configure(struct rte_eth_dev *);
200 void mlx5_dev_infos_get(struct rte_eth_dev *, struct rte_eth_dev_info *);
201 const uint32_t *mlx5_dev_supported_ptypes_get(struct rte_eth_dev *dev);
202 int mlx5_link_update(struct rte_eth_dev *, int);
203 int mlx5_dev_set_mtu(struct rte_eth_dev *, uint16_t);
204 int mlx5_dev_get_flow_ctrl(struct rte_eth_dev *, struct rte_eth_fc_conf *);
205 int mlx5_dev_set_flow_ctrl(struct rte_eth_dev *, struct rte_eth_fc_conf *);
206 int mlx5_ibv_device_to_pci_addr(const struct ibv_device *,
207 struct rte_pci_addr *);
208 void mlx5_dev_link_status_handler(void *);
209 void mlx5_dev_interrupt_handler(void *);
210 void priv_dev_interrupt_handler_uninstall(struct priv *, struct rte_eth_dev *);
211 void priv_dev_interrupt_handler_install(struct priv *, struct rte_eth_dev *);
212 int mlx5_set_link_down(struct rte_eth_dev *dev);
213 int mlx5_set_link_up(struct rte_eth_dev *dev);
214 void priv_dev_select_tx_function(struct priv *priv, struct rte_eth_dev *dev);
215 void priv_dev_select_rx_function(struct priv *priv, struct rte_eth_dev *dev);
219 int priv_get_mac(struct priv *, uint8_t (*)[ETHER_ADDR_LEN]);
220 void hash_rxq_mac_addrs_del(struct hash_rxq *);
221 void priv_mac_addrs_disable(struct priv *);
222 void mlx5_mac_addr_remove(struct rte_eth_dev *, uint32_t);
223 int hash_rxq_mac_addrs_add(struct hash_rxq *);
224 int priv_mac_addr_add(struct priv *, unsigned int,
225 const uint8_t (*)[ETHER_ADDR_LEN]);
226 int priv_mac_addrs_enable(struct priv *);
227 int mlx5_mac_addr_add(struct rte_eth_dev *, struct ether_addr *, uint32_t,
229 void mlx5_mac_addr_set(struct rte_eth_dev *, struct ether_addr *);
233 int rss_hash_rss_conf_new_key(struct priv *, const uint8_t *, unsigned int,
235 int mlx5_rss_hash_update(struct rte_eth_dev *, struct rte_eth_rss_conf *);
236 int mlx5_rss_hash_conf_get(struct rte_eth_dev *, struct rte_eth_rss_conf *);
237 int priv_rss_reta_index_resize(struct priv *, unsigned int);
238 int mlx5_dev_rss_reta_query(struct rte_eth_dev *,
239 struct rte_eth_rss_reta_entry64 *, uint16_t);
240 int mlx5_dev_rss_reta_update(struct rte_eth_dev *,
241 struct rte_eth_rss_reta_entry64 *, uint16_t);
245 int priv_special_flow_enable(struct priv *, enum hash_rxq_flow_type);
246 void priv_special_flow_disable(struct priv *, enum hash_rxq_flow_type);
247 int priv_special_flow_enable_all(struct priv *);
248 void priv_special_flow_disable_all(struct priv *);
249 void mlx5_promiscuous_enable(struct rte_eth_dev *);
250 void mlx5_promiscuous_disable(struct rte_eth_dev *);
251 void mlx5_allmulticast_enable(struct rte_eth_dev *);
252 void mlx5_allmulticast_disable(struct rte_eth_dev *);
256 void priv_xstats_init(struct priv *);
257 void mlx5_stats_get(struct rte_eth_dev *, struct rte_eth_stats *);
258 void mlx5_stats_reset(struct rte_eth_dev *);
259 int mlx5_xstats_get(struct rte_eth_dev *,
260 struct rte_eth_xstat *, unsigned int);
261 void mlx5_xstats_reset(struct rte_eth_dev *);
262 int mlx5_xstats_get_names(struct rte_eth_dev *,
263 struct rte_eth_xstat_name *, unsigned int);
267 int mlx5_vlan_filter_set(struct rte_eth_dev *, uint16_t, int);
268 void mlx5_vlan_offload_set(struct rte_eth_dev *, int);
269 void mlx5_vlan_strip_queue_set(struct rte_eth_dev *, uint16_t, int);
273 int mlx5_dev_start(struct rte_eth_dev *);
274 void mlx5_dev_stop(struct rte_eth_dev *);
278 int mlx5_dev_filter_ctrl(struct rte_eth_dev *, enum rte_filter_type,
279 enum rte_filter_op, void *);
280 int mlx5_flow_validate(struct rte_eth_dev *, const struct rte_flow_attr *,
281 const struct rte_flow_item [],
282 const struct rte_flow_action [],
283 struct rte_flow_error *);
284 struct rte_flow *mlx5_flow_create(struct rte_eth_dev *,
285 const struct rte_flow_attr *,
286 const struct rte_flow_item [],
287 const struct rte_flow_action [],
288 struct rte_flow_error *);
289 int mlx5_flow_destroy(struct rte_eth_dev *, struct rte_flow *,
290 struct rte_flow_error *);
291 int mlx5_flow_flush(struct rte_eth_dev *, struct rte_flow_error *);
292 int mlx5_flow_isolate(struct rte_eth_dev *, int, struct rte_flow_error *);
293 int priv_flow_start(struct priv *);
294 void priv_flow_stop(struct priv *);
295 int priv_flow_verify(struct priv *);
299 int priv_socket_init(struct priv *priv);
300 int priv_socket_uninit(struct priv *priv);
301 void priv_socket_handle(struct priv *priv);
302 int priv_socket_connect(struct priv *priv);
306 struct mlx5_mr *priv_mr_new(struct priv *, struct rte_mempool *);
307 struct mlx5_mr *priv_mr_get(struct priv *, struct rte_mempool *);
308 int priv_mr_release(struct priv *, struct mlx5_mr *);
309 int priv_mr_verify(struct priv *);
311 #endif /* RTE_PMD_MLX5_H_ */