xref: /dpdk/drivers/net/mlx4/mlx4.h (revision ba6a168a06581b5b3d523f984722a3e5f65bbb82)
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright 2012 6WIND S.A.
3  * Copyright 2012 Mellanox Technologies, Ltd
4  */
5 
6 #ifndef RTE_PMD_MLX4_H_
7 #define RTE_PMD_MLX4_H_
8 
9 #include <net/if.h>
10 #include <stdint.h>
11 #include <sys/queue.h>
12 
13 /* Verbs headers do not support -pedantic. */
14 #ifdef PEDANTIC
15 #pragma GCC diagnostic ignored "-Wpedantic"
16 #endif
17 #include <infiniband/verbs.h>
18 #ifdef PEDANTIC
19 #pragma GCC diagnostic error "-Wpedantic"
20 #endif
21 
22 #include <ethdev_driver.h>
23 #include <rte_ether.h>
24 #include <rte_interrupts.h>
25 #include <rte_mempool.h>
26 #include <rte_rwlock.h>
27 
28 #include "mlx4_mr.h"
29 
30 #ifndef IBV_RX_HASH_INNER
31 /** This is not necessarily defined by supported RDMA core versions. */
32 #define IBV_RX_HASH_INNER (1ull << 31)
33 #endif /* IBV_RX_HASH_INNER */
34 
35 /** Maximum number of simultaneous MAC addresses. This value is arbitrary. */
36 #define MLX4_MAX_MAC_ADDRESSES 128
37 
38 /** Request send completion once in every 64 sends, might be less. */
39 #define MLX4_PMD_TX_PER_COMP_REQ 64
40 
41 /** Maximum size for inline data. */
42 #define MLX4_PMD_MAX_INLINE 0
43 
44 /** Fixed RSS hash key size in bytes. Cannot be modified. */
45 #define MLX4_RSS_HASH_KEY_SIZE 40
46 
47 /** Interrupt alarm timeout value in microseconds. */
48 #define MLX4_INTR_ALARM_TIMEOUT 100000
49 
50 /* Maximum packet headers size (L2+L3+L4) for TSO. */
51 #define MLX4_MAX_TSO_HEADER 192
52 
53 /** Port parameter. */
54 #define MLX4_PMD_PORT_KVARG "port"
55 
56 /** Enable extending memsegs when creating a MR. */
57 #define MLX4_MR_EXT_MEMSEG_EN_KVARG "mr_ext_memseg_en"
58 
59 enum {
60 	PCI_VENDOR_ID_MELLANOX = 0x15b3,
61 };
62 
63 enum {
64 	PCI_DEVICE_ID_MELLANOX_CONNECTX3 = 0x1003,
65 	PCI_DEVICE_ID_MELLANOX_CONNECTX3VF = 0x1004,
66 	PCI_DEVICE_ID_MELLANOX_CONNECTX3PRO = 0x1007,
67 };
68 
69 /* Request types for IPC. */
70 enum mlx4_mp_req_type {
71 	MLX4_MP_REQ_VERBS_CMD_FD = 1,
72 	MLX4_MP_REQ_CREATE_MR,
73 	MLX4_MP_REQ_START_RXTX,
74 	MLX4_MP_REQ_STOP_RXTX,
75 };
76 
77 /* Parameters for IPC. */
78 struct mlx4_mp_param {
79 	enum mlx4_mp_req_type type;
80 	int port_id;
81 	int result;
82 	union {
83 		uintptr_t addr; /* MLX4_MP_REQ_CREATE_MR */
84 	} args;
85 };
86 
87 /** Request timeout for IPC. */
88 #define MLX4_MP_REQ_TIMEOUT_SEC 5
89 
90 /** Key string for IPC. */
91 #define MLX4_MP_NAME "net_mlx4_mp"
92 
93 /** Driver name reported to lower layers and used in log output. */
94 #define MLX4_DRIVER_NAME "net_mlx4"
95 
96 struct mlx4_drop;
97 struct mlx4_rss;
98 struct rxq;
99 struct txq;
100 struct rte_flow;
101 
102 /**
103  * Type of object being allocated.
104  */
105 enum mlx4_verbs_alloc_type {
106 	MLX4_VERBS_ALLOC_TYPE_NONE,
107 	MLX4_VERBS_ALLOC_TYPE_TX_QUEUE,
108 	MLX4_VERBS_ALLOC_TYPE_RX_QUEUE,
109 };
110 
111 /**
112  * Verbs allocator needs a context to know in the callback which kind of
113  * resources it is allocating.
114  */
115 struct mlx4_verbs_alloc_ctx {
116 	int enabled;
117 	enum mlx4_verbs_alloc_type type; /* Kind of object being allocated. */
118 	const void *obj; /* Pointer to the DPDK object. */
119 };
120 
121 LIST_HEAD(mlx4_dev_list, mlx4_priv);
122 LIST_HEAD(mlx4_mr_list, mlx4_mr);
123 
124 /* Shared data between primary and secondary processes. */
125 struct mlx4_shared_data {
126 	rte_spinlock_t lock;
127 	/* Global spinlock for primary and secondary processes. */
128 	int init_done; /* Whether primary has done initialization. */
129 	unsigned int secondary_cnt; /* Number of secondary processes init'd. */
130 	struct mlx4_dev_list mem_event_cb_list;
131 	rte_rwlock_t mem_event_rwlock;
132 };
133 
134 /* Per-process data structure, not visible to other processes. */
135 struct mlx4_local_data {
136 	int init_done; /* Whether a secondary has done initialization. */
137 };
138 
139 extern struct mlx4_shared_data *mlx4_shared_data;
140 
141 /* Per-process private structure. */
142 struct mlx4_proc_priv {
143 	size_t uar_table_sz;
144 	/* Size of UAR register table. */
145 	void *uar_table[];
146 	/* Table of UAR registers for each process. */
147 };
148 
149 #define MLX4_PROC_PRIV(port_id) \
150 	((struct mlx4_proc_priv *)rte_eth_devices[port_id].process_private)
151 
152 /** Private data structure. */
153 struct mlx4_priv {
154 	LIST_ENTRY(mlx4_priv) mem_event_cb;
155 	/**< Called by memory event callback. */
156 	struct rte_eth_dev_data *dev_data;  /* Pointer to device data. */
157 	struct ibv_context *ctx; /**< Verbs context. */
158 	struct ibv_device_attr device_attr; /**< Device properties. */
159 	struct ibv_pd *pd; /**< Protection Domain. */
160 	/* Device properties. */
161 	unsigned int if_index;	/**< Associated network device index */
162 	uint16_t mtu; /**< Configured MTU. */
163 	uint8_t port; /**< Physical port number. */
164 	uint32_t started:1; /**< Device started, flows enabled. */
165 	uint32_t vf:1; /**< This is a VF device. */
166 	uint32_t intr_alarm:1; /**< An interrupt alarm is scheduled. */
167 	uint32_t isolated:1; /**< Toggle isolated mode. */
168 	uint32_t rss_init:1; /**< Common RSS context is initialized. */
169 	uint32_t hw_csum:1; /**< Checksum offload is supported. */
170 	uint32_t hw_csum_l2tun:1; /**< Checksum support for L2 tunnels. */
171 	uint32_t hw_fcs_strip:1; /**< FCS stripping toggling is supported. */
172 	uint32_t tso:1; /**< Transmit segmentation offload is supported. */
173 	uint32_t mr_ext_memseg_en:1;
174 	/** Whether memseg should be extended for MR creation. */
175 	uint32_t tso_max_payload_sz; /**< Max supported TSO payload size. */
176 	uint32_t hw_rss_max_qps; /**< Max Rx Queues supported by RSS. */
177 	uint64_t hw_rss_sup; /**< Supported RSS hash fields (Verbs format). */
178 	struct rte_intr_handle *intr_handle; /**< Port interrupt handle. */
179 	struct mlx4_drop *drop; /**< Shared resources for drop flow rules. */
180 	struct {
181 		uint32_t dev_gen; /* Generation number to flush local caches. */
182 		rte_rwlock_t rwlock; /* MR Lock. */
183 		struct mlx4_mr_btree cache; /* Global MR cache table. */
184 		struct mlx4_mr_list mr_list; /* Registered MR list. */
185 		struct mlx4_mr_list mr_free_list; /* Freed MR list. */
186 	} mr;
187 	LIST_HEAD(, mlx4_rss) rss; /**< Shared targets for Rx flow rules. */
188 	LIST_HEAD(, rte_flow) flows; /**< Configured flow rule handles. */
189 	struct rte_ether_addr mac[MLX4_MAX_MAC_ADDRESSES];
190 	/**< Configured MAC addresses. Unused entries are zeroed. */
191 	uint32_t mac_mc; /**< Number of trailing multicast entries in mac[]. */
192 	struct mlx4_verbs_alloc_ctx verbs_alloc_ctx;
193 	/**< Context for Verbs allocator. */
194 };
195 
196 #define PORT_ID(priv) ((priv)->dev_data->port_id)
197 #define ETH_DEV(priv) (&rte_eth_devices[PORT_ID(priv)])
198 
199 int mlx4_proc_priv_init(struct rte_eth_dev *dev);
200 void mlx4_proc_priv_uninit(struct rte_eth_dev *dev);
201 
202 
203 /* mlx4_ethdev.c */
204 
205 int mlx4_get_ifname(const struct mlx4_priv *priv, char (*ifname)[IF_NAMESIZE]);
206 int mlx4_get_mac(struct mlx4_priv *priv, uint8_t (*mac)[RTE_ETHER_ADDR_LEN]);
207 int mlx4_mtu_get(struct mlx4_priv *priv, uint16_t *mtu);
208 int mlx4_mtu_set(struct rte_eth_dev *dev, uint16_t mtu);
209 int mlx4_dev_set_link_down(struct rte_eth_dev *dev);
210 int mlx4_dev_set_link_up(struct rte_eth_dev *dev);
211 int mlx4_promiscuous_enable(struct rte_eth_dev *dev);
212 int mlx4_promiscuous_disable(struct rte_eth_dev *dev);
213 int mlx4_allmulticast_enable(struct rte_eth_dev *dev);
214 int mlx4_allmulticast_disable(struct rte_eth_dev *dev);
215 void mlx4_mac_addr_remove(struct rte_eth_dev *dev, uint32_t index);
216 int mlx4_mac_addr_add(struct rte_eth_dev *dev, struct rte_ether_addr *mac_addr,
217 		      uint32_t index, uint32_t vmdq);
218 int mlx4_mac_addr_set(struct rte_eth_dev *dev, struct rte_ether_addr *mac_addr);
219 int mlx4_set_mc_addr_list(struct rte_eth_dev *dev, struct rte_ether_addr *list,
220 			  uint32_t num);
221 int mlx4_vlan_filter_set(struct rte_eth_dev *dev, uint16_t vlan_id, int on);
222 int mlx4_stats_get(struct rte_eth_dev *dev, struct rte_eth_stats *stats);
223 int mlx4_stats_reset(struct rte_eth_dev *dev);
224 int mlx4_fw_version_get(struct rte_eth_dev *dev, char *fw_ver, size_t fw_size);
225 int mlx4_dev_infos_get(struct rte_eth_dev *dev,
226 		       struct rte_eth_dev_info *info);
227 int mlx4_link_update(struct rte_eth_dev *dev, int wait_to_complete);
228 int mlx4_flow_ctrl_get(struct rte_eth_dev *dev,
229 		       struct rte_eth_fc_conf *fc_conf);
230 int mlx4_flow_ctrl_set(struct rte_eth_dev *dev,
231 		       struct rte_eth_fc_conf *fc_conf);
232 const uint32_t *mlx4_dev_supported_ptypes_get(struct rte_eth_dev *dev,
233 					      size_t *no_of_elements);
234 int mlx4_is_removed(struct rte_eth_dev *dev);
235 
236 /* mlx4_intr.c */
237 
238 int mlx4_intr_uninstall(struct mlx4_priv *priv);
239 int mlx4_intr_install(struct mlx4_priv *priv);
240 int mlx4_rxq_intr_enable(struct mlx4_priv *priv);
241 void mlx4_rxq_intr_disable(struct mlx4_priv *priv);
242 int mlx4_rx_intr_disable(struct rte_eth_dev *dev, uint16_t idx);
243 int mlx4_rx_intr_enable(struct rte_eth_dev *dev, uint16_t idx);
244 
245 /* mlx4_mp.c */
246 void mlx4_mp_req_start_rxtx(struct rte_eth_dev *dev);
247 void mlx4_mp_req_stop_rxtx(struct rte_eth_dev *dev);
248 int mlx4_mp_req_mr_create(struct rte_eth_dev *dev, uintptr_t addr);
249 int mlx4_mp_req_verbs_cmd_fd(struct rte_eth_dev *dev);
250 int mlx4_mp_init_primary(void);
251 void mlx4_mp_uninit_primary(void);
252 int mlx4_mp_init_secondary(void);
253 void mlx4_mp_uninit_secondary(void);
254 
255 #endif /* RTE_PMD_MLX4_H_ */
256