xref: /f-stack/dpdk/drivers/net/mlx5/mlx5.h (revision 16d80a6d)
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright 2015 6WIND S.A.
3  * Copyright 2015 Mellanox Technologies, Ltd
4  */
5 
6 #ifndef RTE_PMD_MLX5_H_
7 #define RTE_PMD_MLX5_H_
8 
9 #include <stddef.h>
10 #include <stdint.h>
11 #include <limits.h>
12 #include <net/if.h>
13 #include <netinet/in.h>
14 #include <sys/queue.h>
15 
16 /* Verbs header. */
17 /* ISO C doesn't support unnamed structs/unions, disabling -pedantic. */
18 #ifdef PEDANTIC
19 #pragma GCC diagnostic ignored "-Wpedantic"
20 #endif
21 #include <infiniband/verbs.h>
22 #ifdef PEDANTIC
23 #pragma GCC diagnostic error "-Wpedantic"
24 #endif
25 
26 #include <rte_pci.h>
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>
32 #include <rte_flow.h>
33 
34 #include "mlx5_utils.h"
35 #include "mlx5_mr.h"
36 #include "mlx5_rxtx.h"
37 #include "mlx5_autoconf.h"
38 #include "mlx5_defs.h"
39 
40 enum {
41 	PCI_VENDOR_ID_MELLANOX = 0x15b3,
42 };
43 
44 enum {
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 };
56 
57 /** Switch information returned by mlx5_nl_switch_info(). */
58 struct mlx5_switch_info {
59 	uint32_t master:1; /**< Master device. */
60 	uint32_t representor:1; /**< Representor device. */
61 	int32_t port_name; /**< Representor port name. */
62 	uint64_t switch_id; /**< Switch identifier. */
63 };
64 
65 LIST_HEAD(mlx5_dev_list, mlx5_priv);
66 
67 /* Shared memory between primary and secondary processes. */
68 struct mlx5_shared_data {
69 	struct mlx5_dev_list mem_event_cb_list;
70 	rte_rwlock_t mem_event_rwlock;
71 };
72 
73 extern struct mlx5_shared_data *mlx5_shared_data;
74 
75 struct mlx5_counter_ctrl {
76 	/* Name of the counter. */
77 	char dpdk_name[RTE_ETH_XSTATS_NAME_SIZE];
78 	/* Name of the counter on the device table. */
79 	char ctr_name[RTE_ETH_XSTATS_NAME_SIZE];
80 	uint32_t ib:1; /**< Nonzero for IB counters. */
81 };
82 
83 struct mlx5_xstats_ctrl {
84 	/* Number of device stats. */
85 	uint16_t stats_n;
86 	/* Number of device stats identified by PMD. */
87 	uint16_t  mlx5_stats_n;
88 	/* Index in the device counters table. */
89 	uint16_t dev_table_idx[MLX5_MAX_XSTATS];
90 	uint64_t base[MLX5_MAX_XSTATS];
91 	struct mlx5_counter_ctrl info[MLX5_MAX_XSTATS];
92 };
93 
94 /* Flow list . */
95 TAILQ_HEAD(mlx5_flows, rte_flow);
96 
97 /* Default PMD specific parameter value. */
98 #define MLX5_ARG_UNSET (-1)
99 
100 /*
101  * Device configuration structure.
102  *
103  * Merged configuration from:
104  *
105  *  - Device capabilities,
106  *  - User device parameters disabled features.
107  */
108 struct mlx5_dev_config {
109 	unsigned int hw_csum:1; /* Checksum offload is supported. */
110 	unsigned int hw_vlan_strip:1; /* VLAN stripping is supported. */
111 	unsigned int hw_fcs_strip:1; /* FCS stripping is supported. */
112 	unsigned int hw_padding:1; /* End alignment padding is supported. */
113 	unsigned int vf:1; /* This is a VF. */
114 	unsigned int tunnel_en:1;
115 	/* Whether tunnel stateless offloads are supported. */
116 	unsigned int mpls_en:1; /* MPLS over GRE/UDP is enabled. */
117 	unsigned int cqe_comp:1; /* CQE compression is enabled. */
118 	unsigned int cqe_pad:1; /* CQE padding is enabled. */
119 	unsigned int tso:1; /* Whether TSO is supported. */
120 	unsigned int tx_vec_en:1; /* Tx vector is enabled. */
121 	unsigned int rx_vec_en:1; /* Rx vector is enabled. */
122 	unsigned int mpw_hdr_dseg:1; /* Enable DSEGs in the title WQEBB. */
123 	unsigned int l3_vxlan_en:1; /* Enable L3 VXLAN flow creation. */
124 	unsigned int vf_nl_en:1; /* Enable Netlink requests in VF mode. */
125 	unsigned int dv_flow_en:1; /* Enable DV flow. */
126 	unsigned int swp:1; /* Tx generic tunnel checksum and TSO offload. */
127 	struct {
128 		unsigned int enabled:1; /* Whether MPRQ is enabled. */
129 		unsigned int stride_num_n; /* Number of strides. */
130 		unsigned int min_stride_size_n; /* Min size of a stride. */
131 		unsigned int max_stride_size_n; /* Max size of a stride. */
132 		unsigned int max_memcpy_len;
133 		/* Maximum packet size to memcpy Rx packets. */
134 		unsigned int min_rxqs_num;
135 		/* Rx queue count threshold to enable MPRQ. */
136 	} mprq; /* Configurations for Multi-Packet RQ. */
137 	int mps; /* Multi-packet send supported mode. */
138 	unsigned int flow_prio; /* Number of flow priorities. */
139 	unsigned int tso_max_payload_sz; /* Maximum TCP payload for TSO. */
140 	unsigned int ind_table_max_size; /* Maximum indirection table size. */
141 	int txq_inline; /* Maximum packet size for inlining. */
142 	int txqs_inline; /* Queue number threshold for inlining. */
143 	int txqs_vec; /* Queue number threshold for vectorized Tx. */
144 	int inline_max_packet_sz; /* Max packet size for inlining. */
145 };
146 
147 /**
148  * Type of objet being allocated.
149  */
150 enum mlx5_verbs_alloc_type {
151 	MLX5_VERBS_ALLOC_TYPE_NONE,
152 	MLX5_VERBS_ALLOC_TYPE_TX_QUEUE,
153 	MLX5_VERBS_ALLOC_TYPE_RX_QUEUE,
154 };
155 
156 /**
157  * Verbs allocator needs a context to know in the callback which kind of
158  * resources it is allocating.
159  */
160 struct mlx5_verbs_alloc_ctx {
161 	enum mlx5_verbs_alloc_type type; /* Kind of object being allocated. */
162 	const void *obj; /* Pointer to the DPDK object. */
163 };
164 
165 LIST_HEAD(mlx5_mr_list, mlx5_mr);
166 
167 /* Flow drop context necessary due to Verbs API. */
168 struct mlx5_drop {
169 	struct mlx5_hrxq *hrxq; /* Hash Rx queue queue. */
170 	struct mlx5_rxq_ibv *rxq; /* Verbs Rx queue. */
171 };
172 
173 struct mlx5_flow_tcf_context;
174 
175 struct mlx5_priv {
176 	LIST_ENTRY(mlx5_priv) mem_event_cb;
177 	/**< Called by memory event callback. */
178 	struct rte_eth_dev_data *dev_data;  /* Pointer to device data. */
179 	struct ibv_context *ctx; /* Verbs context. */
180 	struct ibv_device_attr_ex device_attr; /* Device properties. */
181 	struct ibv_pd *pd; /* Protection Domain. */
182 	char ibdev_name[IBV_SYSFS_NAME_MAX]; /* IB device name. */
183 	char ibdev_path[IBV_SYSFS_PATH_MAX]; /* IB device path for secondary */
184 	struct ether_addr mac[MLX5_MAX_MAC_ADDRESSES]; /* MAC addresses. */
185 	BITFIELD_DECLARE(mac_own, uint64_t, MLX5_MAX_MAC_ADDRESSES);
186 	/* Bit-field of MAC addresses owned by the PMD. */
187 	uint16_t vlan_filter[MLX5_MAX_VLAN_IDS]; /* VLAN filters table. */
188 	unsigned int vlan_filter_n; /* Number of configured VLAN filters. */
189 	/* Device properties. */
190 	uint16_t mtu; /* Configured MTU. */
191 	unsigned int isolated:1; /* Whether isolated mode is enabled. */
192 	unsigned int representor:1; /* Device is a port representor. */
193 	uint16_t domain_id; /* Switch domain identifier. */
194 	int32_t representor_id; /* Port representor identifier. */
195 	/* RX/TX queues. */
196 	unsigned int rxqs_n; /* RX queues array size. */
197 	unsigned int txqs_n; /* TX queues array size. */
198 	struct mlx5_rxq_data *(*rxqs)[]; /* RX queues. */
199 	struct mlx5_txq_data *(*txqs)[]; /* TX queues. */
200 	struct rte_mempool *mprq_mp; /* Mempool for Multi-Packet RQ. */
201 	struct rte_eth_rss_conf rss_conf; /* RSS configuration. */
202 	struct rte_intr_handle intr_handle; /* Interrupt handler. */
203 	unsigned int (*reta_idx)[]; /* RETA index table. */
204 	unsigned int reta_idx_n; /* RETA index size. */
205 	struct mlx5_drop drop_queue; /* Flow drop queues. */
206 	struct mlx5_flows flows; /* RTE Flow rules. */
207 	struct mlx5_flows ctrl_flows; /* Control flow rules. */
208 	LIST_HEAD(counters, mlx5_flow_counter) flow_counters;
209 	/* Flow counters. */
210 	struct {
211 		uint32_t dev_gen; /* Generation number to flush local caches. */
212 		rte_rwlock_t rwlock; /* MR Lock. */
213 		struct mlx5_mr_btree cache; /* Global MR cache table. */
214 		struct mlx5_mr_list mr_list; /* Registered MR list. */
215 		struct mlx5_mr_list mr_free_list; /* Freed MR list. */
216 	} mr;
217 	LIST_HEAD(rxq, mlx5_rxq_ctrl) rxqsctrl; /* DPDK Rx queues. */
218 	LIST_HEAD(rxqibv, mlx5_rxq_ibv) rxqsibv; /* Verbs Rx queues. */
219 	LIST_HEAD(hrxq, mlx5_hrxq) hrxqs; /* Verbs Hash Rx queues. */
220 	LIST_HEAD(txq, mlx5_txq_ctrl) txqsctrl; /* DPDK Tx queues. */
221 	LIST_HEAD(txqibv, mlx5_txq_ibv) txqsibv; /* Verbs Tx queues. */
222 	/* Verbs Indirection tables. */
223 	LIST_HEAD(ind_tables, mlx5_ind_table_ibv) ind_tbls;
224 	LIST_HEAD(matchers, mlx5_flow_dv_matcher) matchers;
225 	LIST_HEAD(encap_decap, mlx5_flow_dv_encap_decap_resource) encaps_decaps;
226 	uint32_t link_speed_capa; /* Link speed capabilities. */
227 	struct mlx5_xstats_ctrl xstats_ctrl; /* Extended stats control. */
228 	int primary_socket; /* Unix socket for primary process. */
229 	void *uar_base; /* Reserved address space for UAR mapping */
230 	struct rte_intr_handle intr_handle_socket; /* Interrupt handler. */
231 	struct mlx5_dev_config config; /* Device configuration. */
232 	struct mlx5_verbs_alloc_ctx verbs_alloc_ctx;
233 	/* Context for Verbs allocator. */
234 	int nl_socket_rdma; /* Netlink socket (NETLINK_RDMA). */
235 	int nl_socket_route; /* Netlink socket (NETLINK_ROUTE). */
236 	uint32_t nl_sn; /* Netlink message sequence number. */
237 #ifndef RTE_ARCH_64
238 	rte_spinlock_t uar_lock_cq; /* CQs share a common distinct UAR */
239 	rte_spinlock_t uar_lock[MLX5_UAR_PAGE_NUM_MAX];
240 	/* UAR same-page access control required in 32bit implementations. */
241 #endif
242 	struct mlx5_flow_tcf_context *tcf_context; /* TC flower context. */
243 };
244 
245 #define PORT_ID(priv) ((priv)->dev_data->port_id)
246 #define ETH_DEV(priv) (&rte_eth_devices[PORT_ID(priv)])
247 
248 /* mlx5.c */
249 
250 int mlx5_getenv_int(const char *);
251 
252 /* mlx5_ethdev.c */
253 
254 int mlx5_get_ifname(const struct rte_eth_dev *dev, char (*ifname)[IF_NAMESIZE]);
255 unsigned int mlx5_ifindex(const struct rte_eth_dev *dev);
256 int mlx5_ifreq(const struct rte_eth_dev *dev, int req, struct ifreq *ifr);
257 int mlx5_get_mtu(struct rte_eth_dev *dev, uint16_t *mtu);
258 int mlx5_set_flags(struct rte_eth_dev *dev, unsigned int keep,
259 		   unsigned int flags);
260 int mlx5_dev_configure(struct rte_eth_dev *dev);
261 void mlx5_dev_infos_get(struct rte_eth_dev *dev, struct rte_eth_dev_info *info);
262 const uint32_t *mlx5_dev_supported_ptypes_get(struct rte_eth_dev *dev);
263 int mlx5_link_update(struct rte_eth_dev *dev, int wait_to_complete);
264 int mlx5_force_link_status_change(struct rte_eth_dev *dev, int status);
265 int mlx5_dev_set_mtu(struct rte_eth_dev *dev, uint16_t mtu);
266 int mlx5_dev_get_flow_ctrl(struct rte_eth_dev *dev,
267 			   struct rte_eth_fc_conf *fc_conf);
268 int mlx5_dev_set_flow_ctrl(struct rte_eth_dev *dev,
269 			   struct rte_eth_fc_conf *fc_conf);
270 int mlx5_ibv_device_to_pci_addr(const struct ibv_device *device,
271 				struct rte_pci_addr *pci_addr);
272 void mlx5_dev_link_status_handler(void *arg);
273 void mlx5_dev_interrupt_handler(void *arg);
274 void mlx5_dev_interrupt_handler_uninstall(struct rte_eth_dev *dev);
275 void mlx5_dev_interrupt_handler_install(struct rte_eth_dev *dev);
276 int mlx5_set_link_down(struct rte_eth_dev *dev);
277 int mlx5_set_link_up(struct rte_eth_dev *dev);
278 int mlx5_is_removed(struct rte_eth_dev *dev);
279 eth_tx_burst_t mlx5_select_tx_function(struct rte_eth_dev *dev);
280 eth_rx_burst_t mlx5_select_rx_function(struct rte_eth_dev *dev);
281 unsigned int mlx5_dev_to_port_id(const struct rte_device *dev,
282 				 uint16_t *port_list,
283 				 unsigned int port_list_n);
284 int mlx5_sysfs_switch_info(unsigned int ifindex,
285 			   struct mlx5_switch_info *info);
286 
287 /* mlx5_mac.c */
288 
289 int mlx5_get_mac(struct rte_eth_dev *dev, uint8_t (*mac)[ETHER_ADDR_LEN]);
290 void mlx5_mac_addr_remove(struct rte_eth_dev *dev, uint32_t index);
291 int mlx5_mac_addr_add(struct rte_eth_dev *dev, struct ether_addr *mac,
292 		      uint32_t index, uint32_t vmdq);
293 int mlx5_mac_addr_set(struct rte_eth_dev *dev, struct ether_addr *mac_addr);
294 int mlx5_set_mc_addr_list(struct rte_eth_dev *dev,
295 			  struct ether_addr *mc_addr_set, uint32_t nb_mc_addr);
296 
297 /* mlx5_rss.c */
298 
299 int mlx5_rss_hash_update(struct rte_eth_dev *dev,
300 			 struct rte_eth_rss_conf *rss_conf);
301 int mlx5_rss_hash_conf_get(struct rte_eth_dev *dev,
302 			   struct rte_eth_rss_conf *rss_conf);
303 int mlx5_rss_reta_index_resize(struct rte_eth_dev *dev, unsigned int reta_size);
304 int mlx5_dev_rss_reta_query(struct rte_eth_dev *dev,
305 			    struct rte_eth_rss_reta_entry64 *reta_conf,
306 			    uint16_t reta_size);
307 int mlx5_dev_rss_reta_update(struct rte_eth_dev *dev,
308 			     struct rte_eth_rss_reta_entry64 *reta_conf,
309 			     uint16_t reta_size);
310 
311 /* mlx5_rxmode.c */
312 
313 void mlx5_promiscuous_enable(struct rte_eth_dev *dev);
314 void mlx5_promiscuous_disable(struct rte_eth_dev *dev);
315 void mlx5_allmulticast_enable(struct rte_eth_dev *dev);
316 void mlx5_allmulticast_disable(struct rte_eth_dev *dev);
317 
318 /* mlx5_stats.c */
319 
320 void mlx5_xstats_init(struct rte_eth_dev *dev);
321 int mlx5_stats_get(struct rte_eth_dev *dev, struct rte_eth_stats *stats);
322 void mlx5_stats_reset(struct rte_eth_dev *dev);
323 int mlx5_xstats_get(struct rte_eth_dev *dev, struct rte_eth_xstat *stats,
324 		    unsigned int n);
325 void mlx5_xstats_reset(struct rte_eth_dev *dev);
326 int mlx5_xstats_get_names(struct rte_eth_dev *dev __rte_unused,
327 			  struct rte_eth_xstat_name *xstats_names,
328 			  unsigned int n);
329 
330 /* mlx5_vlan.c */
331 
332 int mlx5_vlan_filter_set(struct rte_eth_dev *dev, uint16_t vlan_id, int on);
333 void mlx5_vlan_strip_queue_set(struct rte_eth_dev *dev, uint16_t queue, int on);
334 int mlx5_vlan_offload_set(struct rte_eth_dev *dev, int mask);
335 
336 /* mlx5_trigger.c */
337 
338 int mlx5_dev_start(struct rte_eth_dev *dev);
339 void mlx5_dev_stop(struct rte_eth_dev *dev);
340 int mlx5_traffic_enable(struct rte_eth_dev *dev);
341 void mlx5_traffic_disable(struct rte_eth_dev *dev);
342 int mlx5_traffic_restart(struct rte_eth_dev *dev);
343 
344 /* mlx5_flow.c */
345 
346 int mlx5_flow_discover_priorities(struct rte_eth_dev *dev);
347 void mlx5_flow_print(struct rte_flow *flow);
348 int mlx5_flow_validate(struct rte_eth_dev *dev,
349 		       const struct rte_flow_attr *attr,
350 		       const struct rte_flow_item items[],
351 		       const struct rte_flow_action actions[],
352 		       struct rte_flow_error *error);
353 struct rte_flow *mlx5_flow_create(struct rte_eth_dev *dev,
354 				  const struct rte_flow_attr *attr,
355 				  const struct rte_flow_item items[],
356 				  const struct rte_flow_action actions[],
357 				  struct rte_flow_error *error);
358 int mlx5_flow_destroy(struct rte_eth_dev *dev, struct rte_flow *flow,
359 		      struct rte_flow_error *error);
360 void mlx5_flow_list_flush(struct rte_eth_dev *dev, struct mlx5_flows *list);
361 int mlx5_flow_flush(struct rte_eth_dev *dev, struct rte_flow_error *error);
362 int mlx5_flow_query(struct rte_eth_dev *dev, struct rte_flow *flow,
363 		    const struct rte_flow_action *action, void *data,
364 		    struct rte_flow_error *error);
365 int mlx5_flow_isolate(struct rte_eth_dev *dev, int enable,
366 		      struct rte_flow_error *error);
367 int mlx5_dev_filter_ctrl(struct rte_eth_dev *dev,
368 			 enum rte_filter_type filter_type,
369 			 enum rte_filter_op filter_op,
370 			 void *arg);
371 int mlx5_flow_start(struct rte_eth_dev *dev, struct mlx5_flows *list);
372 void mlx5_flow_stop(struct rte_eth_dev *dev, struct mlx5_flows *list);
373 int mlx5_flow_verify(struct rte_eth_dev *dev);
374 int mlx5_ctrl_flow_vlan(struct rte_eth_dev *dev,
375 			struct rte_flow_item_eth *eth_spec,
376 			struct rte_flow_item_eth *eth_mask,
377 			struct rte_flow_item_vlan *vlan_spec,
378 			struct rte_flow_item_vlan *vlan_mask);
379 int mlx5_ctrl_flow(struct rte_eth_dev *dev,
380 		   struct rte_flow_item_eth *eth_spec,
381 		   struct rte_flow_item_eth *eth_mask);
382 int mlx5_flow_create_drop_queue(struct rte_eth_dev *dev);
383 void mlx5_flow_delete_drop_queue(struct rte_eth_dev *dev);
384 
385 /* mlx5_socket.c */
386 
387 int mlx5_socket_init(struct rte_eth_dev *priv);
388 void mlx5_socket_uninit(struct rte_eth_dev *priv);
389 void mlx5_socket_handle(struct rte_eth_dev *priv);
390 int mlx5_socket_connect(struct rte_eth_dev *priv);
391 
392 /* mlx5_nl.c */
393 
394 int mlx5_nl_init(int protocol);
395 int mlx5_nl_mac_addr_add(struct rte_eth_dev *dev, struct ether_addr *mac,
396 			 uint32_t index);
397 int mlx5_nl_mac_addr_remove(struct rte_eth_dev *dev, struct ether_addr *mac,
398 			    uint32_t index);
399 void mlx5_nl_mac_addr_sync(struct rte_eth_dev *dev);
400 void mlx5_nl_mac_addr_flush(struct rte_eth_dev *dev);
401 int mlx5_nl_promisc(struct rte_eth_dev *dev, int enable);
402 int mlx5_nl_allmulti(struct rte_eth_dev *dev, int enable);
403 unsigned int mlx5_nl_ifindex(int nl, const char *name);
404 int mlx5_nl_switch_info(int nl, unsigned int ifindex,
405 			struct mlx5_switch_info *info);
406 
407 #endif /* RTE_PMD_MLX5_H_ */
408