f16f7781627cad593e570298d50d32108fdc99bc
[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 /* DPDK headers don't like -pedantic. */
54 #ifdef PEDANTIC
55 #pragma GCC diagnostic ignored "-Wpedantic"
56 #endif
57 #include <rte_pci.h>
58 #include <rte_ether.h>
59 #include <rte_ethdev.h>
60 #include <rte_spinlock.h>
61 #include <rte_interrupts.h>
62 #include <rte_errno.h>
63 #include <rte_flow.h>
64 #ifdef PEDANTIC
65 #pragma GCC diagnostic error "-Wpedantic"
66 #endif
67
68 #include "mlx5_utils.h"
69 #include "mlx5_rxtx.h"
70 #include "mlx5_autoconf.h"
71 #include "mlx5_defs.h"
72
73 #if !defined(HAVE_VERBS_IBV_EXP_CQ_COMPRESSED_CQE) || \
74         !defined(HAVE_VERBS_MLX5_ETH_VLAN_INLINE_HEADER_SIZE)
75 #error Mellanox OFED >= 3.3 is required, please refer to the documentation.
76 #endif
77
78 enum {
79         PCI_VENDOR_ID_MELLANOX = 0x15b3,
80 };
81
82 enum {
83         PCI_DEVICE_ID_MELLANOX_CONNECTX4 = 0x1013,
84         PCI_DEVICE_ID_MELLANOX_CONNECTX4VF = 0x1014,
85         PCI_DEVICE_ID_MELLANOX_CONNECTX4LX = 0x1015,
86         PCI_DEVICE_ID_MELLANOX_CONNECTX4LXVF = 0x1016,
87         PCI_DEVICE_ID_MELLANOX_CONNECTX5 = 0x1017,
88         PCI_DEVICE_ID_MELLANOX_CONNECTX5VF = 0x1018,
89         PCI_DEVICE_ID_MELLANOX_CONNECTX5EX = 0x1019,
90         PCI_DEVICE_ID_MELLANOX_CONNECTX5EXVF = 0x101a,
91 };
92
93 struct mlx5_xstats_ctrl {
94         /* Number of device stats. */
95         uint16_t stats_n;
96         /* Index in the device counters table. */
97         uint16_t dev_table_idx[MLX5_MAX_XSTATS];
98         uint64_t base[MLX5_MAX_XSTATS];
99 };
100
101 struct priv {
102         struct rte_eth_dev *dev; /* Ethernet device. */
103         struct ibv_context *ctx; /* Verbs context. */
104         struct ibv_device_attr device_attr; /* Device properties. */
105         struct ibv_pd *pd; /* Protection Domain. */
106         /*
107          * MAC addresses array and configuration bit-field.
108          * An extra entry that cannot be modified by the DPDK is reserved
109          * for broadcast frames (destination MAC address ff:ff:ff:ff:ff:ff).
110          */
111         struct ether_addr mac[MLX5_MAX_MAC_ADDRESSES];
112         BITFIELD_DECLARE(mac_configured, uint32_t, MLX5_MAX_MAC_ADDRESSES);
113         uint16_t vlan_filter[MLX5_MAX_VLAN_IDS]; /* VLAN filters table. */
114         unsigned int vlan_filter_n; /* Number of configured VLAN filters. */
115         /* Device properties. */
116         uint16_t mtu; /* Configured MTU. */
117         uint8_t port; /* Physical port number. */
118         unsigned int started:1; /* Device started, flows enabled. */
119         unsigned int promisc_req:1; /* Promiscuous mode requested. */
120         unsigned int allmulti_req:1; /* All multicast mode requested. */
121         unsigned int hw_csum:1; /* Checksum offload is supported. */
122         unsigned int hw_csum_l2tun:1; /* Same for L2 tunnels. */
123         unsigned int hw_vlan_strip:1; /* VLAN stripping is supported. */
124         unsigned int hw_fcs_strip:1; /* FCS stripping is supported. */
125         unsigned int hw_padding:1; /* End alignment padding is supported. */
126         unsigned int sriov:1; /* This is a VF or PF with VF devices. */
127         unsigned int mps:2; /* Multi-packet send mode (0: disabled). */
128         unsigned int mpw_hdr_dseg:1; /* Enable DSEGs in the title WQEBB. */
129         unsigned int cqe_comp:1; /* Whether CQE compression is enabled. */
130         unsigned int pending_alarm:1; /* An alarm is pending. */
131         unsigned int tso:1; /* Whether TSO is supported. */
132         unsigned int tunnel_en:1;
133         unsigned int isolated:1; /* Whether isolated mode is enabled. */
134         /* Whether Tx offloads for tunneled packets are supported. */
135         unsigned int max_tso_payload_sz; /* Maximum TCP payload for TSO. */
136         unsigned int txq_inline; /* Maximum packet size for inlining. */
137         unsigned int txqs_inline; /* Queue number threshold for inlining. */
138         unsigned int inline_max_packet_sz; /* Max packet size for inlining. */
139         /* RX/TX queues. */
140         unsigned int rxqs_n; /* RX queues array size. */
141         unsigned int txqs_n; /* TX queues array size. */
142         struct rxq *(*rxqs)[]; /* RX queues. */
143         struct txq *(*txqs)[]; /* TX queues. */
144         /* Indirection tables referencing all RX WQs. */
145         struct ibv_exp_rwq_ind_table *(*ind_tables)[];
146         unsigned int ind_tables_n; /* Number of indirection tables. */
147         unsigned int ind_table_max_size; /* Maximum indirection table size. */
148         /* Hash RX QPs feeding the indirection table. */
149         struct hash_rxq (*hash_rxqs)[];
150         unsigned int hash_rxqs_n; /* Hash RX QPs array size. */
151         /* RSS configuration array indexed by hash RX queue type. */
152         struct rte_eth_rss_conf *(*rss_conf)[];
153         uint64_t rss_hf; /* RSS DPDK bit field of active RSS. */
154         struct rte_intr_handle intr_handle; /* Interrupt handler. */
155         unsigned int (*reta_idx)[]; /* RETA index table. */
156         unsigned int reta_idx_n; /* RETA index size. */
157         struct fdir_filter_list *fdir_filter_list; /* Flow director rules. */
158         struct fdir_queue *fdir_drop_queue; /* Flow director drop queue. */
159         struct rte_flow_drop *flow_drop_queue; /* Flow drop queue. */
160         TAILQ_HEAD(mlx5_flows, rte_flow) flows; /* RTE Flow rules. */
161         uint32_t link_speed_capa; /* Link speed capabilities. */
162         struct mlx5_xstats_ctrl xstats_ctrl; /* Extended stats control. */
163         rte_spinlock_t lock; /* Lock for control functions. */
164 };
165
166 /* Local storage for secondary process data. */
167 struct mlx5_secondary_data {
168         struct rte_eth_dev_data data; /* Local device data. */
169         struct priv *primary_priv; /* Private structure from primary. */
170         struct rte_eth_dev_data *shared_dev_data; /* Shared device data. */
171         rte_spinlock_t lock; /* Port configuration lock. */
172 } mlx5_secondary_data[RTE_MAX_ETHPORTS];
173
174 /**
175  * Lock private structure to protect it from concurrent access in the
176  * control path.
177  *
178  * @param priv
179  *   Pointer to private structure.
180  */
181 static inline void
182 priv_lock(struct priv *priv)
183 {
184         rte_spinlock_lock(&priv->lock);
185 }
186
187 /**
188  * Unlock private structure.
189  *
190  * @param priv
191  *   Pointer to private structure.
192  */
193 static inline void
194 priv_unlock(struct priv *priv)
195 {
196         rte_spinlock_unlock(&priv->lock);
197 }
198
199 /* mlx5.c */
200
201 int mlx5_getenv_int(const char *);
202
203 /* mlx5_ethdev.c */
204
205 struct priv *mlx5_get_priv(struct rte_eth_dev *dev);
206 int mlx5_is_secondary(void);
207 int priv_get_ifname(const struct priv *, char (*)[IF_NAMESIZE]);
208 int priv_ifreq(const struct priv *, int req, struct ifreq *);
209 int priv_is_ib_cntr(const char *);
210 int priv_get_cntr_sysfs(struct priv *, const char *, uint64_t *);
211 int priv_get_num_vfs(struct priv *, uint16_t *);
212 int priv_get_mtu(struct priv *, uint16_t *);
213 int priv_set_flags(struct priv *, unsigned int, unsigned int);
214 int mlx5_dev_configure(struct rte_eth_dev *);
215 void mlx5_dev_infos_get(struct rte_eth_dev *, struct rte_eth_dev_info *);
216 const uint32_t *mlx5_dev_supported_ptypes_get(struct rte_eth_dev *dev);
217 int mlx5_link_update(struct rte_eth_dev *, int);
218 int mlx5_dev_set_mtu(struct rte_eth_dev *, uint16_t);
219 int mlx5_dev_get_flow_ctrl(struct rte_eth_dev *, struct rte_eth_fc_conf *);
220 int mlx5_dev_set_flow_ctrl(struct rte_eth_dev *, struct rte_eth_fc_conf *);
221 int mlx5_ibv_device_to_pci_addr(const struct ibv_device *,
222                                 struct rte_pci_addr *);
223 void mlx5_dev_link_status_handler(void *);
224 void mlx5_dev_interrupt_handler(void *);
225 void priv_dev_interrupt_handler_uninstall(struct priv *, struct rte_eth_dev *);
226 void priv_dev_interrupt_handler_install(struct priv *, struct rte_eth_dev *);
227 int mlx5_set_link_down(struct rte_eth_dev *dev);
228 int mlx5_set_link_up(struct rte_eth_dev *dev);
229 struct priv *mlx5_secondary_data_setup(struct priv *priv);
230 void priv_select_tx_function(struct priv *);
231 void priv_select_rx_function(struct priv *);
232
233 /* mlx5_mac.c */
234
235 int priv_get_mac(struct priv *, uint8_t (*)[ETHER_ADDR_LEN]);
236 void hash_rxq_mac_addrs_del(struct hash_rxq *);
237 void priv_mac_addrs_disable(struct priv *);
238 void mlx5_mac_addr_remove(struct rte_eth_dev *, uint32_t);
239 int hash_rxq_mac_addrs_add(struct hash_rxq *);
240 int priv_mac_addr_add(struct priv *, unsigned int,
241                       const uint8_t (*)[ETHER_ADDR_LEN]);
242 int priv_mac_addrs_enable(struct priv *);
243 int mlx5_mac_addr_add(struct rte_eth_dev *, struct ether_addr *, uint32_t,
244                       uint32_t);
245 void mlx5_mac_addr_set(struct rte_eth_dev *, struct ether_addr *);
246
247 /* mlx5_rss.c */
248
249 int rss_hash_rss_conf_new_key(struct priv *, const uint8_t *, unsigned int,
250                               uint64_t);
251 int mlx5_rss_hash_update(struct rte_eth_dev *, struct rte_eth_rss_conf *);
252 int mlx5_rss_hash_conf_get(struct rte_eth_dev *, struct rte_eth_rss_conf *);
253 int priv_rss_reta_index_resize(struct priv *, unsigned int);
254 int mlx5_dev_rss_reta_query(struct rte_eth_dev *,
255                             struct rte_eth_rss_reta_entry64 *, uint16_t);
256 int mlx5_dev_rss_reta_update(struct rte_eth_dev *,
257                              struct rte_eth_rss_reta_entry64 *, uint16_t);
258
259 /* mlx5_rxmode.c */
260
261 int priv_special_flow_enable(struct priv *, enum hash_rxq_flow_type);
262 void priv_special_flow_disable(struct priv *, enum hash_rxq_flow_type);
263 int priv_special_flow_enable_all(struct priv *);
264 void priv_special_flow_disable_all(struct priv *);
265 void mlx5_promiscuous_enable(struct rte_eth_dev *);
266 void mlx5_promiscuous_disable(struct rte_eth_dev *);
267 void mlx5_allmulticast_enable(struct rte_eth_dev *);
268 void mlx5_allmulticast_disable(struct rte_eth_dev *);
269
270 /* mlx5_stats.c */
271
272 void priv_xstats_init(struct priv *);
273 void mlx5_stats_get(struct rte_eth_dev *, struct rte_eth_stats *);
274 void mlx5_stats_reset(struct rte_eth_dev *);
275 int mlx5_xstats_get(struct rte_eth_dev *,
276                     struct rte_eth_xstat *, unsigned int);
277 void mlx5_xstats_reset(struct rte_eth_dev *);
278 int mlx5_xstats_get_names(struct rte_eth_dev *,
279                           struct rte_eth_xstat_name *, unsigned int);
280
281 /* mlx5_vlan.c */
282
283 int mlx5_vlan_filter_set(struct rte_eth_dev *, uint16_t, int);
284 void mlx5_vlan_offload_set(struct rte_eth_dev *, int);
285 void mlx5_vlan_strip_queue_set(struct rte_eth_dev *, uint16_t, int);
286
287 /* mlx5_trigger.c */
288
289 int mlx5_dev_start(struct rte_eth_dev *);
290 void mlx5_dev_stop(struct rte_eth_dev *);
291
292 /* mlx5_fdir.c */
293
294 void priv_fdir_queue_destroy(struct priv *, struct fdir_queue *);
295 int fdir_init_filters_list(struct priv *);
296 void priv_fdir_delete_filters_list(struct priv *);
297 void priv_fdir_disable(struct priv *);
298 void priv_fdir_enable(struct priv *);
299 int mlx5_dev_filter_ctrl(struct rte_eth_dev *, enum rte_filter_type,
300                          enum rte_filter_op, void *);
301
302 /* mlx5_flow.c */
303
304 int mlx5_flow_validate(struct rte_eth_dev *, const struct rte_flow_attr *,
305                        const struct rte_flow_item [],
306                        const struct rte_flow_action [],
307                        struct rte_flow_error *);
308 struct rte_flow *mlx5_flow_create(struct rte_eth_dev *,
309                                   const struct rte_flow_attr *,
310                                   const struct rte_flow_item [],
311                                   const struct rte_flow_action [],
312                                   struct rte_flow_error *);
313 int mlx5_flow_destroy(struct rte_eth_dev *, struct rte_flow *,
314                       struct rte_flow_error *);
315 int mlx5_flow_flush(struct rte_eth_dev *, struct rte_flow_error *);
316 int mlx5_flow_isolate(struct rte_eth_dev *, int, struct rte_flow_error *);
317 int priv_flow_start(struct priv *);
318 void priv_flow_stop(struct priv *);
319 int priv_flow_rxq_in_use(struct priv *, struct rxq *);
320
321 #endif /* RTE_PMD_MLX5_H_ */