1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2015 6WIND S.A.
3 * Copyright 2015 Mellanox Technologies, Ltd
6 #ifndef RTE_PMD_MLX5_H_
7 #define RTE_PMD_MLX5_H_
13 #include <netinet/in.h>
14 #include <sys/queue.h>
17 /* ISO C doesn't support unnamed structs/unions, disabling -pedantic. */
19 #pragma GCC diagnostic ignored "-Wpedantic"
21 #include <infiniband/verbs.h>
23 #pragma GCC diagnostic error "-Wpedantic"
27 #include <rte_ether.h>
28 #include <rte_ethdev_driver.h>
29 #include <rte_rwlock.h>
30 #include <rte_interrupts.h>
31 #include <rte_errno.h>
34 #include "mlx5_utils.h"
36 #include "mlx5_rxtx.h"
37 #include "mlx5_autoconf.h"
38 #include "mlx5_defs.h"
41 PCI_VENDOR_ID_MELLANOX = 0x15b3,
45 PCI_DEVICE_ID_MELLANOX_CONNECTX4 = 0x1013,
46 PCI_DEVICE_ID_MELLANOX_CONNECTX4VF = 0x1014,
47 PCI_DEVICE_ID_MELLANOX_CONNECTX4LX = 0x1015,
48 PCI_DEVICE_ID_MELLANOX_CONNECTX4LXVF = 0x1016,
49 PCI_DEVICE_ID_MELLANOX_CONNECTX5 = 0x1017,
50 PCI_DEVICE_ID_MELLANOX_CONNECTX5VF = 0x1018,
51 PCI_DEVICE_ID_MELLANOX_CONNECTX5EX = 0x1019,
52 PCI_DEVICE_ID_MELLANOX_CONNECTX5EXVF = 0x101a,
53 PCI_DEVICE_ID_MELLANOX_CONNECTX5BF = 0xa2d2,
54 PCI_DEVICE_ID_MELLANOX_CONNECTX5BFVF = 0xa2d3,
55 PCI_DEVICE_ID_MELLANOX_CONNECTX6 = 0x101b,
56 PCI_DEVICE_ID_MELLANOX_CONNECTX6VF = 0x101c,
59 /** Switch information returned by mlx5_nl_switch_info(). */
60 struct mlx5_switch_info {
61 uint32_t master:1; /**< Master device. */
62 uint32_t representor:1; /**< Representor device. */
63 uint32_t port_name_new:1; /**< Rep. port name is in new format. */
64 int32_t port_name; /**< Representor port name. */
65 uint64_t switch_id; /**< Switch identifier. */
68 LIST_HEAD(mlx5_dev_list, mlx5_priv);
70 /* Shared memory between primary and secondary processes. */
71 struct mlx5_shared_data {
72 struct mlx5_dev_list mem_event_cb_list;
73 rte_rwlock_t mem_event_rwlock;
76 extern struct mlx5_shared_data *mlx5_shared_data;
78 struct mlx5_counter_ctrl {
79 /* Name of the counter. */
80 char dpdk_name[RTE_ETH_XSTATS_NAME_SIZE];
81 /* Name of the counter on the device table. */
82 char ctr_name[RTE_ETH_XSTATS_NAME_SIZE];
83 uint32_t ib:1; /**< Nonzero for IB counters. */
86 struct mlx5_xstats_ctrl {
87 /* Number of device stats. */
89 /* Number of device stats identified by PMD. */
90 uint16_t mlx5_stats_n;
91 /* Index in the device counters table. */
92 uint16_t dev_table_idx[MLX5_MAX_XSTATS];
93 uint64_t base[MLX5_MAX_XSTATS];
94 struct mlx5_counter_ctrl info[MLX5_MAX_XSTATS];
97 struct mlx5_stats_ctrl {
98 /* Base for imissed counter. */
99 uint64_t imissed_base;
102 /* devx counter object */
103 struct mlx5_devx_counter_set {
104 struct mlx5dv_devx_obj *obj;
105 int id; /* Flow counter ID */
109 TAILQ_HEAD(mlx5_flows, rte_flow);
111 /* Default PMD specific parameter value. */
112 #define MLX5_ARG_UNSET (-1)
115 * Device configuration structure.
117 * Merged configuration from:
119 * - Device capabilities,
120 * - User device parameters disabled features.
122 struct mlx5_dev_config {
123 unsigned int hw_csum:1; /* Checksum offload is supported. */
124 unsigned int hw_vlan_strip:1; /* VLAN stripping is supported. */
125 unsigned int hw_fcs_strip:1; /* FCS stripping is supported. */
126 unsigned int hw_padding:1; /* End alignment padding is supported. */
127 unsigned int vf:1; /* This is a VF. */
128 unsigned int tunnel_en:1;
129 /* Whether tunnel stateless offloads are supported. */
130 unsigned int mpls_en:1; /* MPLS over GRE/UDP is enabled. */
131 unsigned int cqe_comp:1; /* CQE compression is enabled. */
132 unsigned int cqe_pad:1; /* CQE padding is enabled. */
133 unsigned int tso:1; /* Whether TSO is supported. */
134 unsigned int tx_vec_en:1; /* Tx vector is enabled. */
135 unsigned int rx_vec_en:1; /* Rx vector is enabled. */
136 unsigned int mpw_hdr_dseg:1; /* Enable DSEGs in the title WQEBB. */
137 unsigned int l3_vxlan_en:1; /* Enable L3 VXLAN flow creation. */
138 unsigned int vf_nl_en:1; /* Enable Netlink requests in VF mode. */
139 unsigned int dv_flow_en:1; /* Enable DV flow. */
140 unsigned int swp:1; /* Tx generic tunnel checksum and TSO offload. */
141 unsigned int devx:1; /* Whether devx interface is available or not. */
143 unsigned int enabled:1; /* Whether MPRQ is enabled. */
144 unsigned int stride_num_n; /* Number of strides. */
145 unsigned int min_stride_size_n; /* Min size of a stride. */
146 unsigned int max_stride_size_n; /* Max size of a stride. */
147 unsigned int max_memcpy_len;
148 /* Maximum packet size to memcpy Rx packets. */
149 unsigned int min_rxqs_num;
150 /* Rx queue count threshold to enable MPRQ. */
151 } mprq; /* Configurations for Multi-Packet RQ. */
152 int mps; /* Multi-packet send supported mode. */
153 unsigned int flow_prio; /* Number of flow priorities. */
154 unsigned int tso_max_payload_sz; /* Maximum TCP payload for TSO. */
155 unsigned int ind_table_max_size; /* Maximum indirection table size. */
156 int txq_inline; /* Maximum packet size for inlining. */
157 int txqs_inline; /* Queue number threshold for inlining. */
158 int txqs_vec; /* Queue number threshold for vectorized Tx. */
159 int inline_max_packet_sz; /* Max packet size for inlining. */
163 * Type of objet being allocated.
165 enum mlx5_verbs_alloc_type {
166 MLX5_VERBS_ALLOC_TYPE_NONE,
167 MLX5_VERBS_ALLOC_TYPE_TX_QUEUE,
168 MLX5_VERBS_ALLOC_TYPE_RX_QUEUE,
172 * Verbs allocator needs a context to know in the callback which kind of
173 * resources it is allocating.
175 struct mlx5_verbs_alloc_ctx {
176 enum mlx5_verbs_alloc_type type; /* Kind of object being allocated. */
177 const void *obj; /* Pointer to the DPDK object. */
180 LIST_HEAD(mlx5_mr_list, mlx5_mr);
182 /* Flow drop context necessary due to Verbs API. */
184 struct mlx5_hrxq *hrxq; /* Hash Rx queue queue. */
185 struct mlx5_rxq_ibv *rxq; /* Verbs Rx queue. */
188 struct mlx5_flow_tcf_context;
191 LIST_ENTRY(mlx5_priv) mem_event_cb;
192 /**< Called by memory event callback. */
193 struct rte_eth_dev_data *dev_data; /* Pointer to device data. */
194 struct ibv_context *ctx; /* Verbs context. */
195 struct ibv_device_attr_ex device_attr; /* Device properties. */
196 struct ibv_pd *pd; /* Protection Domain. */
197 char ibdev_name[IBV_SYSFS_NAME_MAX]; /* IB device name. */
198 char ibdev_path[IBV_SYSFS_PATH_MAX]; /* IB device path for secondary */
199 struct ether_addr mac[MLX5_MAX_MAC_ADDRESSES]; /* MAC addresses. */
200 BITFIELD_DECLARE(mac_own, uint64_t, MLX5_MAX_MAC_ADDRESSES);
201 /* Bit-field of MAC addresses owned by the PMD. */
202 uint16_t vlan_filter[MLX5_MAX_VLAN_IDS]; /* VLAN filters table. */
203 unsigned int vlan_filter_n; /* Number of configured VLAN filters. */
204 /* Device properties. */
205 uint16_t mtu; /* Configured MTU. */
206 unsigned int isolated:1; /* Whether isolated mode is enabled. */
207 unsigned int representor:1; /* Device is a port representor. */
208 uint16_t domain_id; /* Switch domain identifier. */
209 int32_t representor_id; /* Port representor identifier. */
211 unsigned int rxqs_n; /* RX queues array size. */
212 unsigned int txqs_n; /* TX queues array size. */
213 struct mlx5_rxq_data *(*rxqs)[]; /* RX queues. */
214 struct mlx5_txq_data *(*txqs)[]; /* TX queues. */
215 struct rte_mempool *mprq_mp; /* Mempool for Multi-Packet RQ. */
216 struct rte_eth_rss_conf rss_conf; /* RSS configuration. */
217 struct rte_intr_handle intr_handle; /* Interrupt handler. */
218 unsigned int (*reta_idx)[]; /* RETA index table. */
219 unsigned int reta_idx_n; /* RETA index size. */
220 struct mlx5_drop drop_queue; /* Flow drop queues. */
221 struct mlx5_flows flows; /* RTE Flow rules. */
222 struct mlx5_flows ctrl_flows; /* Control flow rules. */
223 LIST_HEAD(counters, mlx5_flow_counter) flow_counters;
226 uint32_t dev_gen; /* Generation number to flush local caches. */
227 rte_rwlock_t rwlock; /* MR Lock. */
228 struct mlx5_mr_btree cache; /* Global MR cache table. */
229 struct mlx5_mr_list mr_list; /* Registered MR list. */
230 struct mlx5_mr_list mr_free_list; /* Freed MR list. */
232 LIST_HEAD(rxq, mlx5_rxq_ctrl) rxqsctrl; /* DPDK Rx queues. */
233 LIST_HEAD(rxqibv, mlx5_rxq_ibv) rxqsibv; /* Verbs Rx queues. */
234 LIST_HEAD(hrxq, mlx5_hrxq) hrxqs; /* Verbs Hash Rx queues. */
235 LIST_HEAD(txq, mlx5_txq_ctrl) txqsctrl; /* DPDK Tx queues. */
236 LIST_HEAD(txqibv, mlx5_txq_ibv) txqsibv; /* Verbs Tx queues. */
237 /* Verbs Indirection tables. */
238 LIST_HEAD(ind_tables, mlx5_ind_table_ibv) ind_tbls;
239 LIST_HEAD(matchers, mlx5_flow_dv_matcher) matchers;
240 LIST_HEAD(encap_decap, mlx5_flow_dv_encap_decap_resource) encaps_decaps;
241 LIST_HEAD(modify_cmd, mlx5_flow_dv_modify_hdr_resource) modify_cmds;
242 uint32_t link_speed_capa; /* Link speed capabilities. */
243 struct mlx5_xstats_ctrl xstats_ctrl; /* Extended stats control. */
244 struct mlx5_stats_ctrl stats_ctrl; /* Stats control. */
245 int primary_socket; /* Unix socket for primary process. */
246 void *uar_base; /* Reserved address space for UAR mapping */
247 struct rte_intr_handle intr_handle_socket; /* Interrupt handler. */
248 struct mlx5_dev_config config; /* Device configuration. */
249 struct mlx5_verbs_alloc_ctx verbs_alloc_ctx;
250 /* Context for Verbs allocator. */
251 int nl_socket_rdma; /* Netlink socket (NETLINK_RDMA). */
252 int nl_socket_route; /* Netlink socket (NETLINK_ROUTE). */
253 uint32_t nl_sn; /* Netlink message sequence number. */
255 rte_spinlock_t uar_lock_cq; /* CQs share a common distinct UAR */
256 rte_spinlock_t uar_lock[MLX5_UAR_PAGE_NUM_MAX];
257 /* UAR same-page access control required in 32bit implementations. */
259 struct mlx5_flow_tcf_context *tcf_context; /* TC flower context. */
262 #define PORT_ID(priv) ((priv)->dev_data->port_id)
263 #define ETH_DEV(priv) (&rte_eth_devices[PORT_ID(priv)])
267 int mlx5_getenv_int(const char *);
271 int mlx5_get_ifname(const struct rte_eth_dev *dev, char (*ifname)[IF_NAMESIZE]);
272 unsigned int mlx5_ifindex(const struct rte_eth_dev *dev);
273 int mlx5_ifreq(const struct rte_eth_dev *dev, int req, struct ifreq *ifr);
274 int mlx5_get_mtu(struct rte_eth_dev *dev, uint16_t *mtu);
275 int mlx5_set_flags(struct rte_eth_dev *dev, unsigned int keep,
277 int mlx5_dev_configure(struct rte_eth_dev *dev);
278 void mlx5_dev_infos_get(struct rte_eth_dev *dev, struct rte_eth_dev_info *info);
279 int mlx5_fw_version_get(struct rte_eth_dev *dev, char *fw_ver, size_t fw_size);
280 const uint32_t *mlx5_dev_supported_ptypes_get(struct rte_eth_dev *dev);
281 int mlx5_link_update(struct rte_eth_dev *dev, int wait_to_complete);
282 int mlx5_force_link_status_change(struct rte_eth_dev *dev, int status);
283 int mlx5_dev_set_mtu(struct rte_eth_dev *dev, uint16_t mtu);
284 int mlx5_dev_get_flow_ctrl(struct rte_eth_dev *dev,
285 struct rte_eth_fc_conf *fc_conf);
286 int mlx5_dev_set_flow_ctrl(struct rte_eth_dev *dev,
287 struct rte_eth_fc_conf *fc_conf);
288 int mlx5_ibv_device_to_pci_addr(const struct ibv_device *device,
289 struct rte_pci_addr *pci_addr);
290 void mlx5_dev_link_status_handler(void *arg);
291 void mlx5_dev_interrupt_handler(void *arg);
292 void mlx5_dev_interrupt_handler_uninstall(struct rte_eth_dev *dev);
293 void mlx5_dev_interrupt_handler_install(struct rte_eth_dev *dev);
294 int mlx5_set_link_down(struct rte_eth_dev *dev);
295 int mlx5_set_link_up(struct rte_eth_dev *dev);
296 int mlx5_is_removed(struct rte_eth_dev *dev);
297 eth_tx_burst_t mlx5_select_tx_function(struct rte_eth_dev *dev);
298 eth_rx_burst_t mlx5_select_rx_function(struct rte_eth_dev *dev);
299 unsigned int mlx5_dev_to_port_id(const struct rte_device *dev,
301 unsigned int port_list_n);
302 int mlx5_sysfs_switch_info(unsigned int ifindex,
303 struct mlx5_switch_info *info);
304 bool mlx5_translate_port_name(const char *port_name_in,
305 struct mlx5_switch_info *port_info_out);
309 int mlx5_get_mac(struct rte_eth_dev *dev, uint8_t (*mac)[ETHER_ADDR_LEN]);
310 void mlx5_mac_addr_remove(struct rte_eth_dev *dev, uint32_t index);
311 int mlx5_mac_addr_add(struct rte_eth_dev *dev, struct ether_addr *mac,
312 uint32_t index, uint32_t vmdq);
313 int mlx5_mac_addr_set(struct rte_eth_dev *dev, struct ether_addr *mac_addr);
314 int mlx5_set_mc_addr_list(struct rte_eth_dev *dev,
315 struct ether_addr *mc_addr_set, uint32_t nb_mc_addr);
319 int mlx5_rss_hash_update(struct rte_eth_dev *dev,
320 struct rte_eth_rss_conf *rss_conf);
321 int mlx5_rss_hash_conf_get(struct rte_eth_dev *dev,
322 struct rte_eth_rss_conf *rss_conf);
323 int mlx5_rss_reta_index_resize(struct rte_eth_dev *dev, unsigned int reta_size);
324 int mlx5_dev_rss_reta_query(struct rte_eth_dev *dev,
325 struct rte_eth_rss_reta_entry64 *reta_conf,
327 int mlx5_dev_rss_reta_update(struct rte_eth_dev *dev,
328 struct rte_eth_rss_reta_entry64 *reta_conf,
333 void mlx5_promiscuous_enable(struct rte_eth_dev *dev);
334 void mlx5_promiscuous_disable(struct rte_eth_dev *dev);
335 void mlx5_allmulticast_enable(struct rte_eth_dev *dev);
336 void mlx5_allmulticast_disable(struct rte_eth_dev *dev);
340 void mlx5_stats_init(struct rte_eth_dev *dev);
341 int mlx5_stats_get(struct rte_eth_dev *dev, struct rte_eth_stats *stats);
342 void mlx5_stats_reset(struct rte_eth_dev *dev);
343 int mlx5_xstats_get(struct rte_eth_dev *dev, struct rte_eth_xstat *stats,
345 void mlx5_xstats_reset(struct rte_eth_dev *dev);
346 int mlx5_xstats_get_names(struct rte_eth_dev *dev __rte_unused,
347 struct rte_eth_xstat_name *xstats_names,
352 int mlx5_vlan_filter_set(struct rte_eth_dev *dev, uint16_t vlan_id, int on);
353 void mlx5_vlan_strip_queue_set(struct rte_eth_dev *dev, uint16_t queue, int on);
354 int mlx5_vlan_offload_set(struct rte_eth_dev *dev, int mask);
358 int mlx5_dev_start(struct rte_eth_dev *dev);
359 void mlx5_dev_stop(struct rte_eth_dev *dev);
360 int mlx5_traffic_enable(struct rte_eth_dev *dev);
361 void mlx5_traffic_disable(struct rte_eth_dev *dev);
362 int mlx5_traffic_restart(struct rte_eth_dev *dev);
366 int mlx5_flow_discover_priorities(struct rte_eth_dev *dev);
367 void mlx5_flow_print(struct rte_flow *flow);
368 int mlx5_flow_validate(struct rte_eth_dev *dev,
369 const struct rte_flow_attr *attr,
370 const struct rte_flow_item items[],
371 const struct rte_flow_action actions[],
372 struct rte_flow_error *error);
373 struct rte_flow *mlx5_flow_create(struct rte_eth_dev *dev,
374 const struct rte_flow_attr *attr,
375 const struct rte_flow_item items[],
376 const struct rte_flow_action actions[],
377 struct rte_flow_error *error);
378 int mlx5_flow_destroy(struct rte_eth_dev *dev, struct rte_flow *flow,
379 struct rte_flow_error *error);
380 void mlx5_flow_list_flush(struct rte_eth_dev *dev, struct mlx5_flows *list);
381 int mlx5_flow_flush(struct rte_eth_dev *dev, struct rte_flow_error *error);
382 int mlx5_flow_query(struct rte_eth_dev *dev, struct rte_flow *flow,
383 const struct rte_flow_action *action, void *data,
384 struct rte_flow_error *error);
385 int mlx5_flow_isolate(struct rte_eth_dev *dev, int enable,
386 struct rte_flow_error *error);
387 int mlx5_dev_filter_ctrl(struct rte_eth_dev *dev,
388 enum rte_filter_type filter_type,
389 enum rte_filter_op filter_op,
391 int mlx5_flow_start(struct rte_eth_dev *dev, struct mlx5_flows *list);
392 void mlx5_flow_stop(struct rte_eth_dev *dev, struct mlx5_flows *list);
393 int mlx5_flow_verify(struct rte_eth_dev *dev);
394 int mlx5_ctrl_flow_vlan(struct rte_eth_dev *dev,
395 struct rte_flow_item_eth *eth_spec,
396 struct rte_flow_item_eth *eth_mask,
397 struct rte_flow_item_vlan *vlan_spec,
398 struct rte_flow_item_vlan *vlan_mask);
399 int mlx5_ctrl_flow(struct rte_eth_dev *dev,
400 struct rte_flow_item_eth *eth_spec,
401 struct rte_flow_item_eth *eth_mask);
402 int mlx5_flow_create_drop_queue(struct rte_eth_dev *dev);
403 void mlx5_flow_delete_drop_queue(struct rte_eth_dev *dev);
407 int mlx5_socket_init(struct rte_eth_dev *priv);
408 void mlx5_socket_uninit(struct rte_eth_dev *priv);
409 void mlx5_socket_handle(struct rte_eth_dev *priv);
410 int mlx5_socket_connect(struct rte_eth_dev *priv);
414 int mlx5_nl_init(int protocol);
415 int mlx5_nl_mac_addr_add(struct rte_eth_dev *dev, struct ether_addr *mac,
417 int mlx5_nl_mac_addr_remove(struct rte_eth_dev *dev, struct ether_addr *mac,
419 void mlx5_nl_mac_addr_sync(struct rte_eth_dev *dev);
420 void mlx5_nl_mac_addr_flush(struct rte_eth_dev *dev);
421 int mlx5_nl_promisc(struct rte_eth_dev *dev, int enable);
422 int mlx5_nl_allmulti(struct rte_eth_dev *dev, int enable);
423 unsigned int mlx5_nl_ifindex(int nl, const char *name);
424 int mlx5_nl_switch_info(int nl, unsigned int ifindex,
425 struct mlx5_switch_info *info);
427 /* mlx5_devx_cmds.c */
429 int mlx5_devx_cmd_flow_counter_alloc(struct ibv_context *ctx,
430 struct mlx5_devx_counter_set *dcx);
431 int mlx5_devx_cmd_flow_counter_free(struct mlx5dv_devx_obj *obj);
432 int mlx5_devx_cmd_flow_counter_query(struct mlx5_devx_counter_set *dcx,
434 uint64_t *pkts, uint64_t *bytes);
435 #endif /* RTE_PMD_MLX5_H_ */