net/mlx5: add reference counter on memory region
[dpdk.git] / drivers / net / mlx5 / mlx5.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright 2015 6WIND S.A.
5  *   Copyright 2015 Mellanox.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
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
16  *       distribution.
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.
20  *
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.
32  */
33
34 #ifndef RTE_PMD_MLX5_H_
35 #define RTE_PMD_MLX5_H_
36
37 #include <stddef.h>
38 #include <stdint.h>
39 #include <limits.h>
40 #include <net/if.h>
41 #include <netinet/in.h>
42
43 /* Verbs header. */
44 /* ISO C doesn't support unnamed structs/unions, disabling -pedantic. */
45 #ifdef PEDANTIC
46 #pragma GCC diagnostic ignored "-Wpedantic"
47 #endif
48 #include <infiniband/verbs.h>
49 #ifdef PEDANTIC
50 #pragma GCC diagnostic error "-Wpedantic"
51 #endif
52
53 #include <rte_pci.h>
54 #include <rte_ether.h>
55 #include <rte_ethdev.h>
56 #include <rte_spinlock.h>
57 #include <rte_interrupts.h>
58 #include <rte_errno.h>
59 #include <rte_flow.h>
60
61 #include "mlx5_utils.h"
62 #include "mlx5_rxtx.h"
63 #include "mlx5_autoconf.h"
64 #include "mlx5_defs.h"
65
66 enum {
67         PCI_VENDOR_ID_MELLANOX = 0x15b3,
68 };
69
70 enum {
71         PCI_DEVICE_ID_MELLANOX_CONNECTX4 = 0x1013,
72         PCI_DEVICE_ID_MELLANOX_CONNECTX4VF = 0x1014,
73         PCI_DEVICE_ID_MELLANOX_CONNECTX4LX = 0x1015,
74         PCI_DEVICE_ID_MELLANOX_CONNECTX4LXVF = 0x1016,
75         PCI_DEVICE_ID_MELLANOX_CONNECTX5 = 0x1017,
76         PCI_DEVICE_ID_MELLANOX_CONNECTX5VF = 0x1018,
77         PCI_DEVICE_ID_MELLANOX_CONNECTX5EX = 0x1019,
78         PCI_DEVICE_ID_MELLANOX_CONNECTX5EXVF = 0x101a,
79 };
80
81 struct mlx5_xstats_ctrl {
82         /* Number of device stats. */
83         uint16_t stats_n;
84         /* Index in the device counters table. */
85         uint16_t dev_table_idx[MLX5_MAX_XSTATS];
86         uint64_t base[MLX5_MAX_XSTATS];
87 };
88
89 struct priv {
90         struct rte_eth_dev *dev; /* Ethernet device of master process. */
91         struct ibv_context *ctx; /* Verbs context. */
92         struct ibv_device_attr_ex device_attr; /* Device properties. */
93         struct ibv_pd *pd; /* Protection Domain. */
94         char ibdev_path[IBV_SYSFS_PATH_MAX]; /* IB device path for secondary */
95         /*
96          * MAC addresses array and configuration bit-field.
97          * An extra entry that cannot be modified by the DPDK is reserved
98          * for broadcast frames (destination MAC address ff:ff:ff:ff:ff:ff).
99          */
100         struct ether_addr mac[MLX5_MAX_MAC_ADDRESSES];
101         BITFIELD_DECLARE(mac_configured, uint32_t, MLX5_MAX_MAC_ADDRESSES);
102         uint16_t vlan_filter[MLX5_MAX_VLAN_IDS]; /* VLAN filters table. */
103         unsigned int vlan_filter_n; /* Number of configured VLAN filters. */
104         /* Device properties. */
105         uint16_t mtu; /* Configured MTU. */
106         uint8_t port; /* Physical port number. */
107         unsigned int promisc_req:1; /* Promiscuous mode requested. */
108         unsigned int allmulti_req:1; /* All multicast mode requested. */
109         unsigned int hw_csum:1; /* Checksum offload is supported. */
110         unsigned int hw_csum_l2tun:1; /* Same for L2 tunnels. */
111         unsigned int hw_vlan_strip:1; /* VLAN stripping is supported. */
112         unsigned int hw_fcs_strip:1; /* FCS stripping is supported. */
113         unsigned int hw_padding:1; /* End alignment padding is supported. */
114         unsigned int sriov:1; /* This is a VF or PF with VF devices. */
115         unsigned int mps:2; /* Multi-packet send mode (0: disabled). */
116         unsigned int mpw_hdr_dseg:1; /* Enable DSEGs in the title WQEBB. */
117         unsigned int cqe_comp:1; /* Whether CQE compression is enabled. */
118         unsigned int pending_alarm:1; /* An alarm is pending. */
119         unsigned int tso:1; /* Whether TSO is supported. */
120         unsigned int tunnel_en:1;
121         unsigned int isolated:1; /* Whether isolated mode is enabled. */
122         unsigned int tx_vec_en:1; /* Whether Tx vector is enabled. */
123         unsigned int rx_vec_en:1; /* Whether Rx vector is enabled. */
124         /* Whether Tx offloads for tunneled packets are supported. */
125         unsigned int max_tso_payload_sz; /* Maximum TCP payload for TSO. */
126         unsigned int txq_inline; /* Maximum packet size for inlining. */
127         unsigned int txqs_inline; /* Queue number threshold for inlining. */
128         unsigned int inline_max_packet_sz; /* Max packet size for inlining. */
129         /* RX/TX queues. */
130         unsigned int rxqs_n; /* RX queues array size. */
131         unsigned int txqs_n; /* TX queues array size. */
132         struct mlx5_rxq_data *(*rxqs)[]; /* RX queues. */
133         struct mlx5_txq_data *(*txqs)[]; /* TX queues. */
134         /* Indirection tables referencing all RX WQs. */
135         struct ibv_rwq_ind_table *(*ind_tables)[];
136         unsigned int ind_tables_n; /* Number of indirection tables. */
137         unsigned int ind_table_max_size; /* Maximum indirection table size. */
138         /* Hash RX QPs feeding the indirection table. */
139         struct hash_rxq (*hash_rxqs)[];
140         unsigned int hash_rxqs_n; /* Hash RX QPs array size. */
141         /* RSS configuration array indexed by hash RX queue type. */
142         struct rte_eth_rss_conf *(*rss_conf)[];
143         uint64_t rss_hf; /* RSS DPDK bit field of active RSS. */
144         struct rte_intr_handle intr_handle; /* Interrupt handler. */
145         unsigned int (*reta_idx)[]; /* RETA index table. */
146         unsigned int reta_idx_n; /* RETA index size. */
147         struct rte_flow_drop *flow_drop_queue; /* Flow drop queue. */
148         TAILQ_HEAD(mlx5_flows, rte_flow) flows; /* RTE Flow rules. */
149         LIST_HEAD(mr, mlx5_mr) mr; /* Memory region. */
150         uint32_t link_speed_capa; /* Link speed capabilities. */
151         struct mlx5_xstats_ctrl xstats_ctrl; /* Extended stats control. */
152         rte_spinlock_t lock; /* Lock for control functions. */
153         int primary_socket; /* Unix socket for primary process. */
154         struct rte_intr_handle intr_handle_socket; /* Interrupt handler. */
155 };
156
157 /**
158  * Lock private structure to protect it from concurrent access in the
159  * control path.
160  *
161  * @param priv
162  *   Pointer to private structure.
163  */
164 static inline void
165 priv_lock(struct priv *priv)
166 {
167         rte_spinlock_lock(&priv->lock);
168 }
169
170 /**
171  * Unlock private structure.
172  *
173  * @param priv
174  *   Pointer to private structure.
175  */
176 static inline void
177 priv_unlock(struct priv *priv)
178 {
179         rte_spinlock_unlock(&priv->lock);
180 }
181
182 /* mlx5.c */
183
184 int mlx5_getenv_int(const char *);
185
186 /* mlx5_ethdev.c */
187
188 struct priv *mlx5_get_priv(struct rte_eth_dev *dev);
189 int mlx5_is_secondary(void);
190 int priv_get_ifname(const struct priv *, char (*)[IF_NAMESIZE]);
191 int priv_ifreq(const struct priv *, int req, struct ifreq *);
192 int priv_is_ib_cntr(const char *);
193 int priv_get_cntr_sysfs(struct priv *, const char *, uint64_t *);
194 int priv_get_num_vfs(struct priv *, uint16_t *);
195 int priv_get_mtu(struct priv *, uint16_t *);
196 int priv_set_flags(struct priv *, unsigned int, unsigned int);
197 int mlx5_dev_configure(struct rte_eth_dev *);
198 void mlx5_dev_infos_get(struct rte_eth_dev *, struct rte_eth_dev_info *);
199 const uint32_t *mlx5_dev_supported_ptypes_get(struct rte_eth_dev *dev);
200 int mlx5_link_update(struct rte_eth_dev *, int);
201 int mlx5_dev_set_mtu(struct rte_eth_dev *, uint16_t);
202 int mlx5_dev_get_flow_ctrl(struct rte_eth_dev *, struct rte_eth_fc_conf *);
203 int mlx5_dev_set_flow_ctrl(struct rte_eth_dev *, struct rte_eth_fc_conf *);
204 int mlx5_ibv_device_to_pci_addr(const struct ibv_device *,
205                                 struct rte_pci_addr *);
206 void mlx5_dev_link_status_handler(void *);
207 void mlx5_dev_interrupt_handler(void *);
208 void priv_dev_interrupt_handler_uninstall(struct priv *, struct rte_eth_dev *);
209 void priv_dev_interrupt_handler_install(struct priv *, struct rte_eth_dev *);
210 int mlx5_set_link_down(struct rte_eth_dev *dev);
211 int mlx5_set_link_up(struct rte_eth_dev *dev);
212 void priv_dev_select_tx_function(struct priv *priv, struct rte_eth_dev *dev);
213 void priv_dev_select_rx_function(struct priv *priv, struct rte_eth_dev *dev);
214
215 /* mlx5_mac.c */
216
217 int priv_get_mac(struct priv *, uint8_t (*)[ETHER_ADDR_LEN]);
218 void hash_rxq_mac_addrs_del(struct hash_rxq *);
219 void priv_mac_addrs_disable(struct priv *);
220 void mlx5_mac_addr_remove(struct rte_eth_dev *, uint32_t);
221 int hash_rxq_mac_addrs_add(struct hash_rxq *);
222 int priv_mac_addr_add(struct priv *, unsigned int,
223                       const uint8_t (*)[ETHER_ADDR_LEN]);
224 int priv_mac_addrs_enable(struct priv *);
225 int mlx5_mac_addr_add(struct rte_eth_dev *, struct ether_addr *, uint32_t,
226                       uint32_t);
227 void mlx5_mac_addr_set(struct rte_eth_dev *, struct ether_addr *);
228
229 /* mlx5_rss.c */
230
231 int rss_hash_rss_conf_new_key(struct priv *, const uint8_t *, unsigned int,
232                               uint64_t);
233 int mlx5_rss_hash_update(struct rte_eth_dev *, struct rte_eth_rss_conf *);
234 int mlx5_rss_hash_conf_get(struct rte_eth_dev *, struct rte_eth_rss_conf *);
235 int priv_rss_reta_index_resize(struct priv *, unsigned int);
236 int mlx5_dev_rss_reta_query(struct rte_eth_dev *,
237                             struct rte_eth_rss_reta_entry64 *, uint16_t);
238 int mlx5_dev_rss_reta_update(struct rte_eth_dev *,
239                              struct rte_eth_rss_reta_entry64 *, uint16_t);
240
241 /* mlx5_rxmode.c */
242
243 int priv_special_flow_enable(struct priv *, enum hash_rxq_flow_type);
244 void priv_special_flow_disable(struct priv *, enum hash_rxq_flow_type);
245 int priv_special_flow_enable_all(struct priv *);
246 void priv_special_flow_disable_all(struct priv *);
247 void mlx5_promiscuous_enable(struct rte_eth_dev *);
248 void mlx5_promiscuous_disable(struct rte_eth_dev *);
249 void mlx5_allmulticast_enable(struct rte_eth_dev *);
250 void mlx5_allmulticast_disable(struct rte_eth_dev *);
251
252 /* mlx5_stats.c */
253
254 void priv_xstats_init(struct priv *);
255 void mlx5_stats_get(struct rte_eth_dev *, struct rte_eth_stats *);
256 void mlx5_stats_reset(struct rte_eth_dev *);
257 int mlx5_xstats_get(struct rte_eth_dev *,
258                     struct rte_eth_xstat *, unsigned int);
259 void mlx5_xstats_reset(struct rte_eth_dev *);
260 int mlx5_xstats_get_names(struct rte_eth_dev *,
261                           struct rte_eth_xstat_name *, unsigned int);
262
263 /* mlx5_vlan.c */
264
265 int mlx5_vlan_filter_set(struct rte_eth_dev *, uint16_t, int);
266 void mlx5_vlan_offload_set(struct rte_eth_dev *, int);
267 void mlx5_vlan_strip_queue_set(struct rte_eth_dev *, uint16_t, int);
268
269 /* mlx5_trigger.c */
270
271 int mlx5_dev_start(struct rte_eth_dev *);
272 void mlx5_dev_stop(struct rte_eth_dev *);
273
274 /* mlx5_flow.c */
275
276 int mlx5_dev_filter_ctrl(struct rte_eth_dev *, enum rte_filter_type,
277                          enum rte_filter_op, void *);
278 int mlx5_flow_validate(struct rte_eth_dev *, const struct rte_flow_attr *,
279                        const struct rte_flow_item [],
280                        const struct rte_flow_action [],
281                        struct rte_flow_error *);
282 struct rte_flow *mlx5_flow_create(struct rte_eth_dev *,
283                                   const struct rte_flow_attr *,
284                                   const struct rte_flow_item [],
285                                   const struct rte_flow_action [],
286                                   struct rte_flow_error *);
287 int mlx5_flow_destroy(struct rte_eth_dev *, struct rte_flow *,
288                       struct rte_flow_error *);
289 int mlx5_flow_flush(struct rte_eth_dev *, struct rte_flow_error *);
290 int mlx5_flow_isolate(struct rte_eth_dev *, int, struct rte_flow_error *);
291 int priv_flow_start(struct priv *);
292 void priv_flow_stop(struct priv *);
293 int priv_flow_rxq_in_use(struct priv *, struct mlx5_rxq_data *);
294 int priv_flow_verify(struct priv *);
295
296 /* mlx5_socket.c */
297
298 int priv_socket_init(struct priv *priv);
299 int priv_socket_uninit(struct priv *priv);
300 void priv_socket_handle(struct priv *priv);
301 int priv_socket_connect(struct priv *priv);
302
303 /* mlx5_mr.c */
304
305 struct mlx5_mr *priv_mr_new(struct priv *, struct rte_mempool *);
306 struct mlx5_mr *priv_mr_get(struct priv *, struct rte_mempool *);
307 int priv_mr_release(struct priv *, struct mlx5_mr *);
308 int priv_mr_verify(struct priv *);
309
310 #endif /* RTE_PMD_MLX5_H_ */