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 /* Request types for IPC. */
60 enum mlx5_mp_req_type {
61 MLX5_MP_REQ_VERBS_CMD_FD = 1,
62 MLX5_MP_REQ_START_RXTX,
63 MLX5_MP_REQ_STOP_RXTX,
66 /* Pameters for IPC. */
67 struct mlx5_mp_param {
68 enum mlx5_mp_req_type type;
73 /** Request timeout for IPC. */
74 #define MLX5_MP_REQ_TIMEOUT_SEC 5
76 /** Key string for IPC. */
77 #define MLX5_MP_NAME "net_mlx5_mp"
79 /** Switch information returned by mlx5_nl_switch_info(). */
80 struct mlx5_switch_info {
81 uint32_t master:1; /**< Master device. */
82 uint32_t representor:1; /**< Representor device. */
83 uint32_t port_name_new:1; /**< Rep. port name is in new format. */
84 int32_t port_name; /**< Representor port name. */
85 uint64_t switch_id; /**< Switch identifier. */
88 LIST_HEAD(mlx5_dev_list, mlx5_priv);
90 /* Shared data between primary and secondary processes. */
91 struct mlx5_shared_data {
93 /* Global spinlock for primary and secondary processes. */
94 int init_done; /* Whether primary has done initialization. */
95 unsigned int secondary_cnt; /* Number of secondary processes init'd. */
97 /* Reserved UAR address space for TXQ UAR(hw doorbell) mapping. */
98 struct mlx5_dev_list mem_event_cb_list;
99 rte_rwlock_t mem_event_rwlock;
102 /* Per-process data structure, not visible to other processes. */
103 struct mlx5_local_data {
104 int init_done; /* Whether a secondary has done initialization. */
106 /* Reserved UAR address space for TXQ UAR(hw doorbell) mapping. */
109 extern struct mlx5_shared_data *mlx5_shared_data;
111 struct mlx5_counter_ctrl {
112 /* Name of the counter. */
113 char dpdk_name[RTE_ETH_XSTATS_NAME_SIZE];
114 /* Name of the counter on the device table. */
115 char ctr_name[RTE_ETH_XSTATS_NAME_SIZE];
116 uint32_t ib:1; /**< Nonzero for IB counters. */
119 struct mlx5_xstats_ctrl {
120 /* Number of device stats. */
122 /* Number of device stats identified by PMD. */
123 uint16_t mlx5_stats_n;
124 /* Index in the device counters table. */
125 uint16_t dev_table_idx[MLX5_MAX_XSTATS];
126 uint64_t base[MLX5_MAX_XSTATS];
127 struct mlx5_counter_ctrl info[MLX5_MAX_XSTATS];
130 struct mlx5_stats_ctrl {
131 /* Base for imissed counter. */
132 uint64_t imissed_base;
135 /* devx counter object */
136 struct mlx5_devx_counter_set {
137 struct mlx5dv_devx_obj *obj;
138 int id; /* Flow counter ID */
142 TAILQ_HEAD(mlx5_flows, rte_flow);
144 /* Default PMD specific parameter value. */
145 #define MLX5_ARG_UNSET (-1)
148 * Device configuration structure.
150 * Merged configuration from:
152 * - Device capabilities,
153 * - User device parameters disabled features.
155 struct mlx5_dev_config {
156 unsigned int hw_csum:1; /* Checksum offload is supported. */
157 unsigned int hw_vlan_strip:1; /* VLAN stripping is supported. */
158 unsigned int hw_fcs_strip:1; /* FCS stripping is supported. */
159 unsigned int hw_padding:1; /* End alignment padding is supported. */
160 unsigned int vf:1; /* This is a VF. */
161 unsigned int tunnel_en:1;
162 /* Whether tunnel stateless offloads are supported. */
163 unsigned int mpls_en:1; /* MPLS over GRE/UDP is enabled. */
164 unsigned int cqe_comp:1; /* CQE compression is enabled. */
165 unsigned int cqe_pad:1; /* CQE padding is enabled. */
166 unsigned int tso:1; /* Whether TSO is supported. */
167 unsigned int tx_vec_en:1; /* Tx vector is enabled. */
168 unsigned int rx_vec_en:1; /* Rx vector is enabled. */
169 unsigned int mpw_hdr_dseg:1; /* Enable DSEGs in the title WQEBB. */
170 unsigned int l3_vxlan_en:1; /* Enable L3 VXLAN flow creation. */
171 unsigned int vf_nl_en:1; /* Enable Netlink requests in VF mode. */
172 unsigned int dv_flow_en:1; /* Enable DV flow. */
173 unsigned int swp:1; /* Tx generic tunnel checksum and TSO offload. */
174 unsigned int devx:1; /* Whether devx interface is available or not. */
176 unsigned int enabled:1; /* Whether MPRQ is enabled. */
177 unsigned int stride_num_n; /* Number of strides. */
178 unsigned int min_stride_size_n; /* Min size of a stride. */
179 unsigned int max_stride_size_n; /* Max size of a stride. */
180 unsigned int max_memcpy_len;
181 /* Maximum packet size to memcpy Rx packets. */
182 unsigned int min_rxqs_num;
183 /* Rx queue count threshold to enable MPRQ. */
184 } mprq; /* Configurations for Multi-Packet RQ. */
185 int mps; /* Multi-packet send supported mode. */
186 unsigned int flow_prio; /* Number of flow priorities. */
187 unsigned int tso_max_payload_sz; /* Maximum TCP payload for TSO. */
188 unsigned int ind_table_max_size; /* Maximum indirection table size. */
189 int txq_inline; /* Maximum packet size for inlining. */
190 int txqs_inline; /* Queue number threshold for inlining. */
191 int txqs_vec; /* Queue number threshold for vectorized Tx. */
192 int inline_max_packet_sz; /* Max packet size for inlining. */
196 * Type of objet being allocated.
198 enum mlx5_verbs_alloc_type {
199 MLX5_VERBS_ALLOC_TYPE_NONE,
200 MLX5_VERBS_ALLOC_TYPE_TX_QUEUE,
201 MLX5_VERBS_ALLOC_TYPE_RX_QUEUE,
205 * Verbs allocator needs a context to know in the callback which kind of
206 * resources it is allocating.
208 struct mlx5_verbs_alloc_ctx {
209 enum mlx5_verbs_alloc_type type; /* Kind of object being allocated. */
210 const void *obj; /* Pointer to the DPDK object. */
213 LIST_HEAD(mlx5_mr_list, mlx5_mr);
215 /* Flow drop context necessary due to Verbs API. */
217 struct mlx5_hrxq *hrxq; /* Hash Rx queue queue. */
218 struct mlx5_rxq_ibv *rxq; /* Verbs Rx queue. */
221 struct mlx5_flow_tcf_context;
223 /* Per port data of shared IB device. */
224 struct mlx5_ibv_shared_port {
227 * Interrupt handler port_id. Used by shared interrupt
228 * handler to find the corresponding rte_eth device
229 * by IB port index. If value is equal or greater
230 * RTE_MAX_ETHPORTS it means there is no subhandler
231 * installed for specified IB port index.
236 * Shared Infiniband device context for Master/Representors
237 * which belong to same IB device with multiple IB ports.
239 struct mlx5_ibv_shared {
240 LIST_ENTRY(mlx5_ibv_shared) next;
242 uint32_t devx:1; /* Opened with DV. */
243 uint32_t max_port; /* Maximal IB device port index. */
244 struct ibv_context *ctx; /* Verbs/DV context. */
245 struct ibv_pd *pd; /* Protection Domain. */
246 char ibdev_name[IBV_SYSFS_NAME_MAX]; /* IB device name. */
247 char ibdev_path[IBV_SYSFS_PATH_MAX]; /* IB device path for secondary */
248 struct ibv_device_attr_ex device_attr; /* Device properties. */
249 pthread_mutex_t intr_mutex; /* Interrupt config mutex. */
250 uint32_t intr_cnt; /* Interrupt handler reference counter. */
251 struct rte_intr_handle intr_handle; /* Interrupt handler for device. */
252 struct mlx5_ibv_shared_port port[]; /* per device port data array. */
256 LIST_ENTRY(mlx5_priv) mem_event_cb;
257 /**< Called by memory event callback. */
258 struct rte_eth_dev_data *dev_data; /* Pointer to device data. */
259 struct mlx5_ibv_shared *sh; /* Shared IB device context. */
260 uint32_t ibv_port; /* IB device port number. */
261 struct ether_addr mac[MLX5_MAX_MAC_ADDRESSES]; /* MAC addresses. */
262 BITFIELD_DECLARE(mac_own, uint64_t, MLX5_MAX_MAC_ADDRESSES);
263 /* Bit-field of MAC addresses owned by the PMD. */
264 uint16_t vlan_filter[MLX5_MAX_VLAN_IDS]; /* VLAN filters table. */
265 unsigned int vlan_filter_n; /* Number of configured VLAN filters. */
266 /* Device properties. */
267 uint16_t mtu; /* Configured MTU. */
268 unsigned int isolated:1; /* Whether isolated mode is enabled. */
269 unsigned int representor:1; /* Device is a port representor. */
270 unsigned int master:1; /* Device is a E-Switch master. */
271 uint16_t domain_id; /* Switch domain identifier. */
272 uint16_t vport_id; /* Associated VF vport index (if any). */
273 int32_t representor_id; /* Port representor identifier. */
275 unsigned int rxqs_n; /* RX queues array size. */
276 unsigned int txqs_n; /* TX queues array size. */
277 struct mlx5_rxq_data *(*rxqs)[]; /* RX queues. */
278 struct mlx5_txq_data *(*txqs)[]; /* TX queues. */
279 struct rte_mempool *mprq_mp; /* Mempool for Multi-Packet RQ. */
280 struct rte_eth_rss_conf rss_conf; /* RSS configuration. */
281 unsigned int (*reta_idx)[]; /* RETA index table. */
282 unsigned int reta_idx_n; /* RETA index size. */
283 struct mlx5_drop drop_queue; /* Flow drop queues. */
284 struct mlx5_flows flows; /* RTE Flow rules. */
285 struct mlx5_flows ctrl_flows; /* Control flow rules. */
286 LIST_HEAD(counters, mlx5_flow_counter) flow_counters;
289 uint32_t dev_gen; /* Generation number to flush local caches. */
290 rte_rwlock_t rwlock; /* MR Lock. */
291 struct mlx5_mr_btree cache; /* Global MR cache table. */
292 struct mlx5_mr_list mr_list; /* Registered MR list. */
293 struct mlx5_mr_list mr_free_list; /* Freed MR list. */
295 LIST_HEAD(rxq, mlx5_rxq_ctrl) rxqsctrl; /* DPDK Rx queues. */
296 LIST_HEAD(rxqibv, mlx5_rxq_ibv) rxqsibv; /* Verbs Rx queues. */
297 LIST_HEAD(hrxq, mlx5_hrxq) hrxqs; /* Verbs Hash Rx queues. */
298 LIST_HEAD(txq, mlx5_txq_ctrl) txqsctrl; /* DPDK Tx queues. */
299 LIST_HEAD(txqibv, mlx5_txq_ibv) txqsibv; /* Verbs Tx queues. */
300 /* Verbs Indirection tables. */
301 LIST_HEAD(ind_tables, mlx5_ind_table_ibv) ind_tbls;
302 LIST_HEAD(matchers, mlx5_flow_dv_matcher) matchers;
303 LIST_HEAD(encap_decap, mlx5_flow_dv_encap_decap_resource) encaps_decaps;
304 LIST_HEAD(modify_cmd, mlx5_flow_dv_modify_hdr_resource) modify_cmds;
305 uint32_t link_speed_capa; /* Link speed capabilities. */
306 struct mlx5_xstats_ctrl xstats_ctrl; /* Extended stats control. */
307 struct mlx5_stats_ctrl stats_ctrl; /* Stats control. */
308 struct mlx5_dev_config config; /* Device configuration. */
309 struct mlx5_verbs_alloc_ctx verbs_alloc_ctx;
310 /* Context for Verbs allocator. */
311 int nl_socket_rdma; /* Netlink socket (NETLINK_RDMA). */
312 int nl_socket_route; /* Netlink socket (NETLINK_ROUTE). */
313 uint32_t nl_sn; /* Netlink message sequence number. */
315 rte_spinlock_t uar_lock_cq; /* CQs share a common distinct UAR */
316 rte_spinlock_t uar_lock[MLX5_UAR_PAGE_NUM_MAX];
317 /* UAR same-page access control required in 32bit implementations. */
319 struct mlx5_flow_tcf_context *tcf_context; /* TC flower context. */
322 #define PORT_ID(priv) ((priv)->dev_data->port_id)
323 #define ETH_DEV(priv) (&rte_eth_devices[PORT_ID(priv)])
327 int mlx5_getenv_int(const char *);
331 int mlx5_get_ifname(const struct rte_eth_dev *dev, char (*ifname)[IF_NAMESIZE]);
332 unsigned int mlx5_ifindex(const struct rte_eth_dev *dev);
333 int mlx5_ifreq(const struct rte_eth_dev *dev, int req, struct ifreq *ifr);
334 int mlx5_get_mtu(struct rte_eth_dev *dev, uint16_t *mtu);
335 int mlx5_set_flags(struct rte_eth_dev *dev, unsigned int keep,
337 int mlx5_dev_configure(struct rte_eth_dev *dev);
338 void mlx5_dev_infos_get(struct rte_eth_dev *dev, struct rte_eth_dev_info *info);
339 int mlx5_fw_version_get(struct rte_eth_dev *dev, char *fw_ver, size_t fw_size);
340 const uint32_t *mlx5_dev_supported_ptypes_get(struct rte_eth_dev *dev);
341 int mlx5_link_update(struct rte_eth_dev *dev, int wait_to_complete);
342 int mlx5_force_link_status_change(struct rte_eth_dev *dev, int status);
343 int mlx5_dev_set_mtu(struct rte_eth_dev *dev, uint16_t mtu);
344 int mlx5_dev_get_flow_ctrl(struct rte_eth_dev *dev,
345 struct rte_eth_fc_conf *fc_conf);
346 int mlx5_dev_set_flow_ctrl(struct rte_eth_dev *dev,
347 struct rte_eth_fc_conf *fc_conf);
348 int mlx5_ibv_device_to_pci_addr(const struct ibv_device *device,
349 struct rte_pci_addr *pci_addr);
350 void mlx5_dev_link_status_handler(void *arg);
351 void mlx5_dev_interrupt_handler(void *arg);
352 void mlx5_dev_interrupt_handler_uninstall(struct rte_eth_dev *dev);
353 void mlx5_dev_interrupt_handler_install(struct rte_eth_dev *dev);
354 int mlx5_set_link_down(struct rte_eth_dev *dev);
355 int mlx5_set_link_up(struct rte_eth_dev *dev);
356 int mlx5_is_removed(struct rte_eth_dev *dev);
357 eth_tx_burst_t mlx5_select_tx_function(struct rte_eth_dev *dev);
358 eth_rx_burst_t mlx5_select_rx_function(struct rte_eth_dev *dev);
359 unsigned int mlx5_dev_to_port_id(const struct rte_device *dev,
361 unsigned int port_list_n);
362 int mlx5_sysfs_switch_info(unsigned int ifindex,
363 struct mlx5_switch_info *info);
364 bool mlx5_translate_port_name(const char *port_name_in,
365 struct mlx5_switch_info *port_info_out);
369 int mlx5_get_mac(struct rte_eth_dev *dev, uint8_t (*mac)[ETHER_ADDR_LEN]);
370 void mlx5_mac_addr_remove(struct rte_eth_dev *dev, uint32_t index);
371 int mlx5_mac_addr_add(struct rte_eth_dev *dev, struct ether_addr *mac,
372 uint32_t index, uint32_t vmdq);
373 int mlx5_mac_addr_set(struct rte_eth_dev *dev, struct ether_addr *mac_addr);
374 int mlx5_set_mc_addr_list(struct rte_eth_dev *dev,
375 struct ether_addr *mc_addr_set, uint32_t nb_mc_addr);
379 int mlx5_rss_hash_update(struct rte_eth_dev *dev,
380 struct rte_eth_rss_conf *rss_conf);
381 int mlx5_rss_hash_conf_get(struct rte_eth_dev *dev,
382 struct rte_eth_rss_conf *rss_conf);
383 int mlx5_rss_reta_index_resize(struct rte_eth_dev *dev, unsigned int reta_size);
384 int mlx5_dev_rss_reta_query(struct rte_eth_dev *dev,
385 struct rte_eth_rss_reta_entry64 *reta_conf,
387 int mlx5_dev_rss_reta_update(struct rte_eth_dev *dev,
388 struct rte_eth_rss_reta_entry64 *reta_conf,
393 void mlx5_promiscuous_enable(struct rte_eth_dev *dev);
394 void mlx5_promiscuous_disable(struct rte_eth_dev *dev);
395 void mlx5_allmulticast_enable(struct rte_eth_dev *dev);
396 void mlx5_allmulticast_disable(struct rte_eth_dev *dev);
400 void mlx5_stats_init(struct rte_eth_dev *dev);
401 int mlx5_stats_get(struct rte_eth_dev *dev, struct rte_eth_stats *stats);
402 void mlx5_stats_reset(struct rte_eth_dev *dev);
403 int mlx5_xstats_get(struct rte_eth_dev *dev, struct rte_eth_xstat *stats,
405 void mlx5_xstats_reset(struct rte_eth_dev *dev);
406 int mlx5_xstats_get_names(struct rte_eth_dev *dev __rte_unused,
407 struct rte_eth_xstat_name *xstats_names,
412 int mlx5_vlan_filter_set(struct rte_eth_dev *dev, uint16_t vlan_id, int on);
413 void mlx5_vlan_strip_queue_set(struct rte_eth_dev *dev, uint16_t queue, int on);
414 int mlx5_vlan_offload_set(struct rte_eth_dev *dev, int mask);
418 int mlx5_dev_start(struct rte_eth_dev *dev);
419 void mlx5_dev_stop(struct rte_eth_dev *dev);
420 int mlx5_traffic_enable(struct rte_eth_dev *dev);
421 void mlx5_traffic_disable(struct rte_eth_dev *dev);
422 int mlx5_traffic_restart(struct rte_eth_dev *dev);
426 int mlx5_flow_discover_priorities(struct rte_eth_dev *dev);
427 void mlx5_flow_print(struct rte_flow *flow);
428 int mlx5_flow_validate(struct rte_eth_dev *dev,
429 const struct rte_flow_attr *attr,
430 const struct rte_flow_item items[],
431 const struct rte_flow_action actions[],
432 struct rte_flow_error *error);
433 struct rte_flow *mlx5_flow_create(struct rte_eth_dev *dev,
434 const struct rte_flow_attr *attr,
435 const struct rte_flow_item items[],
436 const struct rte_flow_action actions[],
437 struct rte_flow_error *error);
438 int mlx5_flow_destroy(struct rte_eth_dev *dev, struct rte_flow *flow,
439 struct rte_flow_error *error);
440 void mlx5_flow_list_flush(struct rte_eth_dev *dev, struct mlx5_flows *list);
441 int mlx5_flow_flush(struct rte_eth_dev *dev, struct rte_flow_error *error);
442 int mlx5_flow_query(struct rte_eth_dev *dev, struct rte_flow *flow,
443 const struct rte_flow_action *action, void *data,
444 struct rte_flow_error *error);
445 int mlx5_flow_isolate(struct rte_eth_dev *dev, int enable,
446 struct rte_flow_error *error);
447 int mlx5_dev_filter_ctrl(struct rte_eth_dev *dev,
448 enum rte_filter_type filter_type,
449 enum rte_filter_op filter_op,
451 int mlx5_flow_start(struct rte_eth_dev *dev, struct mlx5_flows *list);
452 void mlx5_flow_stop(struct rte_eth_dev *dev, struct mlx5_flows *list);
453 int mlx5_flow_verify(struct rte_eth_dev *dev);
454 int mlx5_ctrl_flow_vlan(struct rte_eth_dev *dev,
455 struct rte_flow_item_eth *eth_spec,
456 struct rte_flow_item_eth *eth_mask,
457 struct rte_flow_item_vlan *vlan_spec,
458 struct rte_flow_item_vlan *vlan_mask);
459 int mlx5_ctrl_flow(struct rte_eth_dev *dev,
460 struct rte_flow_item_eth *eth_spec,
461 struct rte_flow_item_eth *eth_mask);
462 int mlx5_flow_create_drop_queue(struct rte_eth_dev *dev);
463 void mlx5_flow_delete_drop_queue(struct rte_eth_dev *dev);
466 void mlx5_mp_req_start_rxtx(struct rte_eth_dev *dev);
467 void mlx5_mp_req_stop_rxtx(struct rte_eth_dev *dev);
468 int mlx5_mp_req_verbs_cmd_fd(struct rte_eth_dev *dev);
469 void mlx5_mp_init_primary(void);
470 void mlx5_mp_uninit_primary(void);
471 void mlx5_mp_init_secondary(void);
472 void mlx5_mp_uninit_secondary(void);
476 int mlx5_nl_init(int protocol);
477 int mlx5_nl_mac_addr_add(struct rte_eth_dev *dev, struct ether_addr *mac,
479 int mlx5_nl_mac_addr_remove(struct rte_eth_dev *dev, struct ether_addr *mac,
481 void mlx5_nl_mac_addr_sync(struct rte_eth_dev *dev);
482 void mlx5_nl_mac_addr_flush(struct rte_eth_dev *dev);
483 int mlx5_nl_promisc(struct rte_eth_dev *dev, int enable);
484 int mlx5_nl_allmulti(struct rte_eth_dev *dev, int enable);
485 unsigned int mlx5_nl_portnum(int nl, const char *name);
486 unsigned int mlx5_nl_ifindex(int nl, const char *name, uint32_t pindex);
487 int mlx5_nl_switch_info(int nl, unsigned int ifindex,
488 struct mlx5_switch_info *info);
490 /* mlx5_devx_cmds.c */
492 int mlx5_devx_cmd_flow_counter_alloc(struct ibv_context *ctx,
493 struct mlx5_devx_counter_set *dcx);
494 int mlx5_devx_cmd_flow_counter_free(struct mlx5dv_devx_obj *obj);
495 int mlx5_devx_cmd_flow_counter_query(struct mlx5_devx_counter_set *dcx,
497 uint64_t *pkts, uint64_t *bytes);
498 #endif /* RTE_PMD_MLX5_H_ */