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>
42 #include <sys/queue.h>
45 /* ISO C doesn't support unnamed structs/unions, disabling -pedantic. */
47 #pragma GCC diagnostic ignored "-Wpedantic"
49 #include <infiniband/verbs.h>
51 #pragma GCC diagnostic error "-Wpedantic"
55 #include <rte_ether.h>
56 #include <rte_ethdev.h>
57 #include <rte_spinlock.h>
58 #include <rte_interrupts.h>
59 #include <rte_errno.h>
62 #include "mlx5_utils.h"
63 #include "mlx5_rxtx.h"
64 #include "mlx5_autoconf.h"
65 #include "mlx5_defs.h"
68 PCI_VENDOR_ID_MELLANOX = 0x15b3,
72 PCI_DEVICE_ID_MELLANOX_CONNECTX4 = 0x1013,
73 PCI_DEVICE_ID_MELLANOX_CONNECTX4VF = 0x1014,
74 PCI_DEVICE_ID_MELLANOX_CONNECTX4LX = 0x1015,
75 PCI_DEVICE_ID_MELLANOX_CONNECTX4LXVF = 0x1016,
76 PCI_DEVICE_ID_MELLANOX_CONNECTX5 = 0x1017,
77 PCI_DEVICE_ID_MELLANOX_CONNECTX5VF = 0x1018,
78 PCI_DEVICE_ID_MELLANOX_CONNECTX5EX = 0x1019,
79 PCI_DEVICE_ID_MELLANOX_CONNECTX5EXVF = 0x101a,
82 struct mlx5_xstats_ctrl {
83 /* Number of device stats. */
85 /* Index in the device counters table. */
86 uint16_t dev_table_idx[MLX5_MAX_XSTATS];
87 uint64_t base[MLX5_MAX_XSTATS];
91 TAILQ_HEAD(mlx5_flows, rte_flow);
94 struct rte_eth_dev *dev; /* Ethernet device of master process. */
95 struct ibv_context *ctx; /* Verbs context. */
96 struct ibv_device_attr_ex device_attr; /* Device properties. */
97 struct ibv_pd *pd; /* Protection Domain. */
98 char ibdev_path[IBV_SYSFS_PATH_MAX]; /* IB device path for secondary */
100 * MAC addresses array and configuration bit-field.
101 * An extra entry that cannot be modified by the DPDK is reserved
102 * for broadcast frames (destination MAC address ff:ff:ff:ff:ff:ff).
104 struct ether_addr mac[MLX5_MAX_MAC_ADDRESSES];
105 BITFIELD_DECLARE(mac_configured, uint32_t, MLX5_MAX_MAC_ADDRESSES);
106 uint16_t vlan_filter[MLX5_MAX_VLAN_IDS]; /* VLAN filters table. */
107 unsigned int vlan_filter_n; /* Number of configured VLAN filters. */
108 /* Device properties. */
109 uint16_t mtu; /* Configured MTU. */
110 uint8_t port; /* Physical port number. */
111 unsigned int allmulti_req:1; /* All multicast mode requested. */
112 unsigned int hw_csum:1; /* Checksum offload is supported. */
113 unsigned int hw_csum_l2tun:1; /* Same for L2 tunnels. */
114 unsigned int hw_vlan_strip:1; /* VLAN stripping is supported. */
115 unsigned int hw_fcs_strip:1; /* FCS stripping is supported. */
116 unsigned int hw_padding:1; /* End alignment padding is supported. */
117 unsigned int sriov:1; /* This is a VF or PF with VF devices. */
118 unsigned int mps:2; /* Multi-packet send mode (0: disabled). */
119 unsigned int mpw_hdr_dseg:1; /* Enable DSEGs in the title WQEBB. */
120 unsigned int cqe_comp:1; /* Whether CQE compression is enabled. */
121 unsigned int pending_alarm:1; /* An alarm is pending. */
122 unsigned int tso:1; /* Whether TSO is supported. */
123 unsigned int tunnel_en:1;
124 unsigned int isolated:1; /* Whether isolated mode is enabled. */
125 unsigned int tx_vec_en:1; /* Whether Tx vector is enabled. */
126 unsigned int rx_vec_en:1; /* Whether Rx vector is enabled. */
127 /* Whether Tx offloads for tunneled packets are supported. */
128 unsigned int max_tso_payload_sz; /* Maximum TCP payload for TSO. */
129 unsigned int txq_inline; /* Maximum packet size for inlining. */
130 unsigned int txqs_inline; /* Queue number threshold for inlining. */
131 unsigned int inline_max_packet_sz; /* Max packet size for inlining. */
133 unsigned int rxqs_n; /* RX queues array size. */
134 unsigned int txqs_n; /* TX queues array size. */
135 struct mlx5_rxq_data *(*rxqs)[]; /* RX queues. */
136 struct mlx5_txq_data *(*txqs)[]; /* TX queues. */
137 /* Indirection tables referencing all RX WQs. */
138 struct ibv_rwq_ind_table *(*ind_tables)[];
139 unsigned int ind_tables_n; /* Number of indirection tables. */
140 unsigned int ind_table_max_size; /* Maximum indirection table size. */
141 /* Hash RX QPs feeding the indirection table. */
142 struct hash_rxq (*hash_rxqs)[];
143 unsigned int hash_rxqs_n; /* Hash RX QPs array size. */
144 /* RSS configuration array indexed by hash RX queue type. */
145 struct rte_eth_rss_conf *(*rss_conf)[];
146 uint64_t rss_hf; /* RSS DPDK bit field of active RSS. */
147 struct rte_intr_handle intr_handle; /* Interrupt handler. */
148 unsigned int (*reta_idx)[]; /* RETA index table. */
149 unsigned int reta_idx_n; /* RETA index size. */
150 struct mlx5_hrxq_drop *flow_drop_queue; /* Flow drop queue. */
151 struct mlx5_flows flows; /* RTE Flow rules. */
152 struct mlx5_flows ctrl_flows; /* Control flow rules. */
153 LIST_HEAD(mr, mlx5_mr) mr; /* Memory region. */
154 LIST_HEAD(rxq, mlx5_rxq_ctrl) rxqsctrl; /* DPDK Rx queues. */
155 LIST_HEAD(rxqibv, mlx5_rxq_ibv) rxqsibv; /* Verbs Rx queues. */
156 LIST_HEAD(hrxq, mlx5_hrxq) hrxqs; /* Verbs Hash Rx queues. */
157 LIST_HEAD(txq, mlx5_txq_ctrl) txqsctrl; /* DPDK Tx queues. */
158 LIST_HEAD(txqibv, mlx5_txq_ibv) txqsibv; /* Verbs Tx queues. */
159 /* Verbs Indirection tables. */
160 LIST_HEAD(ind_tables, mlx5_ind_table_ibv) ind_tbls;
161 uint32_t link_speed_capa; /* Link speed capabilities. */
162 struct mlx5_xstats_ctrl xstats_ctrl; /* Extended stats control. */
163 rte_spinlock_t lock; /* Lock for control functions. */
164 int primary_socket; /* Unix socket for primary process. */
165 struct rte_intr_handle intr_handle_socket; /* Interrupt handler. */
169 * Lock private structure to protect it from concurrent access in the
173 * Pointer to private structure.
176 priv_lock(struct priv *priv)
178 rte_spinlock_lock(&priv->lock);
182 * Unlock private structure.
185 * Pointer to private structure.
188 priv_unlock(struct priv *priv)
190 rte_spinlock_unlock(&priv->lock);
195 int mlx5_getenv_int(const char *);
199 struct priv *mlx5_get_priv(struct rte_eth_dev *dev);
200 int mlx5_is_secondary(void);
201 int priv_get_ifname(const struct priv *, char (*)[IF_NAMESIZE]);
202 int priv_ifreq(const struct priv *, int req, struct ifreq *);
203 int priv_is_ib_cntr(const char *);
204 int priv_get_cntr_sysfs(struct priv *, const char *, uint64_t *);
205 int priv_get_num_vfs(struct priv *, uint16_t *);
206 int priv_get_mtu(struct priv *, uint16_t *);
207 int priv_set_flags(struct priv *, unsigned int, unsigned int);
208 int mlx5_dev_configure(struct rte_eth_dev *);
209 void mlx5_dev_infos_get(struct rte_eth_dev *, struct rte_eth_dev_info *);
210 const uint32_t *mlx5_dev_supported_ptypes_get(struct rte_eth_dev *dev);
211 int mlx5_link_update(struct rte_eth_dev *, int);
212 int mlx5_dev_set_mtu(struct rte_eth_dev *, uint16_t);
213 int mlx5_dev_get_flow_ctrl(struct rte_eth_dev *, struct rte_eth_fc_conf *);
214 int mlx5_dev_set_flow_ctrl(struct rte_eth_dev *, struct rte_eth_fc_conf *);
215 int mlx5_ibv_device_to_pci_addr(const struct ibv_device *,
216 struct rte_pci_addr *);
217 void mlx5_dev_link_status_handler(void *);
218 void mlx5_dev_interrupt_handler(void *);
219 void priv_dev_interrupt_handler_uninstall(struct priv *, struct rte_eth_dev *);
220 void priv_dev_interrupt_handler_install(struct priv *, struct rte_eth_dev *);
221 int mlx5_set_link_down(struct rte_eth_dev *dev);
222 int mlx5_set_link_up(struct rte_eth_dev *dev);
223 void priv_dev_select_tx_function(struct priv *priv, struct rte_eth_dev *dev);
224 void priv_dev_select_rx_function(struct priv *priv, struct rte_eth_dev *dev);
228 int priv_get_mac(struct priv *, uint8_t (*)[ETHER_ADDR_LEN]);
229 void hash_rxq_mac_addrs_del(struct hash_rxq *);
230 void priv_mac_addrs_disable(struct priv *);
231 void mlx5_mac_addr_remove(struct rte_eth_dev *, uint32_t);
232 int hash_rxq_mac_addrs_add(struct hash_rxq *);
233 int priv_mac_addr_add(struct priv *, unsigned int,
234 const uint8_t (*)[ETHER_ADDR_LEN]);
235 int priv_mac_addrs_enable(struct priv *);
236 int mlx5_mac_addr_add(struct rte_eth_dev *, struct ether_addr *, uint32_t,
238 void mlx5_mac_addr_set(struct rte_eth_dev *, struct ether_addr *);
242 int rss_hash_rss_conf_new_key(struct priv *, const uint8_t *, unsigned int,
244 int mlx5_rss_hash_update(struct rte_eth_dev *, struct rte_eth_rss_conf *);
245 int mlx5_rss_hash_conf_get(struct rte_eth_dev *, struct rte_eth_rss_conf *);
246 int priv_rss_reta_index_resize(struct priv *, unsigned int);
247 int mlx5_dev_rss_reta_query(struct rte_eth_dev *,
248 struct rte_eth_rss_reta_entry64 *, uint16_t);
249 int mlx5_dev_rss_reta_update(struct rte_eth_dev *,
250 struct rte_eth_rss_reta_entry64 *, uint16_t);
254 int priv_special_flow_enable(struct priv *, enum hash_rxq_flow_type);
255 void priv_special_flow_disable(struct priv *, enum hash_rxq_flow_type);
256 int priv_special_flow_enable_all(struct priv *);
257 void priv_special_flow_disable_all(struct priv *);
258 void mlx5_promiscuous_enable(struct rte_eth_dev *);
259 void mlx5_promiscuous_disable(struct rte_eth_dev *);
260 void mlx5_allmulticast_enable(struct rte_eth_dev *);
261 void mlx5_allmulticast_disable(struct rte_eth_dev *);
265 void priv_xstats_init(struct priv *);
266 void mlx5_stats_get(struct rte_eth_dev *, struct rte_eth_stats *);
267 void mlx5_stats_reset(struct rte_eth_dev *);
268 int mlx5_xstats_get(struct rte_eth_dev *,
269 struct rte_eth_xstat *, unsigned int);
270 void mlx5_xstats_reset(struct rte_eth_dev *);
271 int mlx5_xstats_get_names(struct rte_eth_dev *,
272 struct rte_eth_xstat_name *, unsigned int);
276 int mlx5_vlan_filter_set(struct rte_eth_dev *, uint16_t, int);
277 void mlx5_vlan_offload_set(struct rte_eth_dev *, int);
278 void mlx5_vlan_strip_queue_set(struct rte_eth_dev *, uint16_t, int);
282 int mlx5_dev_start(struct rte_eth_dev *);
283 void mlx5_dev_stop(struct rte_eth_dev *);
287 int mlx5_dev_filter_ctrl(struct rte_eth_dev *, enum rte_filter_type,
288 enum rte_filter_op, void *);
289 int mlx5_flow_validate(struct rte_eth_dev *, const struct rte_flow_attr *,
290 const struct rte_flow_item [],
291 const struct rte_flow_action [],
292 struct rte_flow_error *);
293 struct rte_flow *mlx5_flow_create(struct rte_eth_dev *,
294 const struct rte_flow_attr *,
295 const struct rte_flow_item [],
296 const struct rte_flow_action [],
297 struct rte_flow_error *);
298 int mlx5_flow_destroy(struct rte_eth_dev *, struct rte_flow *,
299 struct rte_flow_error *);
300 void priv_flow_flush(struct priv *, struct mlx5_flows *);
301 int mlx5_flow_flush(struct rte_eth_dev *, struct rte_flow_error *);
302 int mlx5_flow_isolate(struct rte_eth_dev *, int, struct rte_flow_error *);
303 int priv_flow_start(struct priv *, struct mlx5_flows *);
304 void priv_flow_stop(struct priv *, struct mlx5_flows *);
305 int priv_flow_verify(struct priv *);
306 int mlx5_ctrl_flow(struct rte_eth_dev *, struct rte_flow_item_eth *,
307 struct rte_flow_item_eth *, unsigned int);
311 int priv_socket_init(struct priv *priv);
312 int priv_socket_uninit(struct priv *priv);
313 void priv_socket_handle(struct priv *priv);
314 int priv_socket_connect(struct priv *priv);
318 struct mlx5_mr *priv_mr_new(struct priv *, struct rte_mempool *);
319 struct mlx5_mr *priv_mr_get(struct priv *, struct rte_mempool *);
320 int priv_mr_release(struct priv *, struct mlx5_mr *);
321 int priv_mr_verify(struct priv *);
323 #endif /* RTE_PMD_MLX5_H_ */