net/mlx5: add Tx/Rx burst function selection wrapper
[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 "-pedantic"
47 #endif
48 #include <infiniband/verbs.h>
49 #ifdef PEDANTIC
50 #pragma GCC diagnostic error "-pedantic"
51 #endif
52
53 /* DPDK headers don't like -pedantic. */
54 #ifdef PEDANTIC
55 #pragma GCC diagnostic ignored "-pedantic"
56 #endif
57 #include <rte_ether.h>
58 #include <rte_ethdev.h>
59 #include <rte_spinlock.h>
60 #include <rte_interrupts.h>
61 #include <rte_errno.h>
62 #ifdef PEDANTIC
63 #pragma GCC diagnostic error "-pedantic"
64 #endif
65
66 #include "mlx5_utils.h"
67 #include "mlx5_rxtx.h"
68 #include "mlx5_autoconf.h"
69 #include "mlx5_defs.h"
70
71 #if !defined(HAVE_VERBS_IBV_EXP_CQ_COMPRESSED_CQE) || \
72         !defined(HAVE_VERBS_MLX5_ETH_VLAN_INLINE_HEADER_SIZE)
73 #error Mellanox OFED >= 3.3 is required, please refer to the documentation.
74 #endif
75
76 enum {
77         PCI_VENDOR_ID_MELLANOX = 0x15b3,
78 };
79
80 enum {
81         PCI_DEVICE_ID_MELLANOX_CONNECTX4 = 0x1013,
82         PCI_DEVICE_ID_MELLANOX_CONNECTX4VF = 0x1014,
83         PCI_DEVICE_ID_MELLANOX_CONNECTX4LX = 0x1015,
84         PCI_DEVICE_ID_MELLANOX_CONNECTX4LXVF = 0x1016,
85 };
86
87 struct priv {
88         struct rte_eth_dev *dev; /* Ethernet device. */
89         struct ibv_context *ctx; /* Verbs context. */
90         struct ibv_device_attr device_attr; /* Device properties. */
91         struct ibv_pd *pd; /* Protection Domain. */
92         /*
93          * MAC addresses array and configuration bit-field.
94          * An extra entry that cannot be modified by the DPDK is reserved
95          * for broadcast frames (destination MAC address ff:ff:ff:ff:ff:ff).
96          */
97         struct ether_addr mac[MLX5_MAX_MAC_ADDRESSES];
98         BITFIELD_DECLARE(mac_configured, uint32_t, MLX5_MAX_MAC_ADDRESSES);
99         uint16_t vlan_filter[MLX5_MAX_VLAN_IDS]; /* VLAN filters table. */
100         unsigned int vlan_filter_n; /* Number of configured VLAN filters. */
101         /* Device properties. */
102         uint16_t mtu; /* Configured MTU. */
103         uint8_t port; /* Physical port number. */
104         unsigned int started:1; /* Device started, flows enabled. */
105         unsigned int promisc_req:1; /* Promiscuous mode requested. */
106         unsigned int allmulti_req:1; /* All multicast mode requested. */
107         unsigned int hw_csum:1; /* Checksum offload is supported. */
108         unsigned int hw_csum_l2tun:1; /* Same for L2 tunnels. */
109         unsigned int hw_vlan_strip:1; /* VLAN stripping is supported. */
110         unsigned int hw_fcs_strip:1; /* FCS stripping is supported. */
111         unsigned int hw_padding:1; /* End alignment padding is supported. */
112         unsigned int sriov:1; /* This is a VF or PF with VF devices. */
113         unsigned int mps:1; /* Whether multi-packet send is supported. */
114         unsigned int pending_alarm:1; /* An alarm is pending. */
115         /* RX/TX queues. */
116         unsigned int rxqs_n; /* RX queues array size. */
117         unsigned int txqs_n; /* TX queues array size. */
118         struct rxq *(*rxqs)[]; /* RX queues. */
119         struct txq *(*txqs)[]; /* TX queues. */
120         /* Indirection tables referencing all RX WQs. */
121         struct ibv_exp_rwq_ind_table *(*ind_tables)[];
122         unsigned int ind_tables_n; /* Number of indirection tables. */
123         unsigned int ind_table_max_size; /* Maximum indirection table size. */
124         /* Hash RX QPs feeding the indirection table. */
125         struct hash_rxq (*hash_rxqs)[];
126         unsigned int hash_rxqs_n; /* Hash RX QPs array size. */
127         /* RSS configuration array indexed by hash RX queue type. */
128         struct rte_eth_rss_conf *(*rss_conf)[];
129         uint64_t rss_hf; /* RSS DPDK bit field of active RSS. */
130         struct rte_intr_handle intr_handle; /* Interrupt handler. */
131         unsigned int (*reta_idx)[]; /* RETA index table. */
132         unsigned int reta_idx_n; /* RETA index size. */
133         struct fdir_filter_list *fdir_filter_list; /* Flow director rules. */
134         rte_spinlock_t lock; /* Lock for control functions. */
135 };
136
137 /* Local storage for secondary process data. */
138 struct mlx5_secondary_data {
139         struct rte_eth_dev_data data; /* Local device data. */
140         struct priv *primary_priv; /* Private structure from primary. */
141         struct rte_eth_dev_data *shared_dev_data; /* Shared device data. */
142         rte_spinlock_t lock; /* Port configuration lock. */
143 } mlx5_secondary_data[RTE_MAX_ETHPORTS];
144
145 /**
146  * Lock private structure to protect it from concurrent access in the
147  * control path.
148  *
149  * @param priv
150  *   Pointer to private structure.
151  */
152 static inline void
153 priv_lock(struct priv *priv)
154 {
155         rte_spinlock_lock(&priv->lock);
156 }
157
158 /**
159  * Unlock private structure.
160  *
161  * @param priv
162  *   Pointer to private structure.
163  */
164 static inline void
165 priv_unlock(struct priv *priv)
166 {
167         rte_spinlock_unlock(&priv->lock);
168 }
169
170 /* mlx5.c */
171
172 int mlx5_getenv_int(const char *);
173
174 /* mlx5_ethdev.c */
175
176 struct priv *mlx5_get_priv(struct rte_eth_dev *dev);
177 int mlx5_is_secondary(void);
178 int priv_get_ifname(const struct priv *, char (*)[IF_NAMESIZE]);
179 int priv_ifreq(const struct priv *, int req, struct ifreq *);
180 int priv_get_num_vfs(struct priv *, uint16_t *);
181 int priv_get_mtu(struct priv *, uint16_t *);
182 int priv_set_flags(struct priv *, unsigned int, unsigned int);
183 int mlx5_dev_configure(struct rte_eth_dev *);
184 void mlx5_dev_infos_get(struct rte_eth_dev *, struct rte_eth_dev_info *);
185 const uint32_t *mlx5_dev_supported_ptypes_get(struct rte_eth_dev *dev);
186 int mlx5_link_update(struct rte_eth_dev *, int);
187 int mlx5_dev_set_mtu(struct rte_eth_dev *, uint16_t);
188 int mlx5_dev_get_flow_ctrl(struct rte_eth_dev *, struct rte_eth_fc_conf *);
189 int mlx5_dev_set_flow_ctrl(struct rte_eth_dev *, struct rte_eth_fc_conf *);
190 int mlx5_ibv_device_to_pci_addr(const struct ibv_device *,
191                                 struct rte_pci_addr *);
192 void mlx5_dev_link_status_handler(void *);
193 void mlx5_dev_interrupt_handler(struct rte_intr_handle *, void *);
194 void priv_dev_interrupt_handler_uninstall(struct priv *, struct rte_eth_dev *);
195 void priv_dev_interrupt_handler_install(struct priv *, struct rte_eth_dev *);
196 int mlx5_set_link_down(struct rte_eth_dev *dev);
197 int mlx5_set_link_up(struct rte_eth_dev *dev);
198 struct priv *mlx5_secondary_data_setup(struct priv *priv);
199 void priv_select_tx_function(struct priv *);
200 void priv_select_rx_function(struct priv *);
201
202 /* mlx5_mac.c */
203
204 int priv_get_mac(struct priv *, uint8_t (*)[ETHER_ADDR_LEN]);
205 void hash_rxq_mac_addrs_del(struct hash_rxq *);
206 void priv_mac_addrs_disable(struct priv *);
207 void mlx5_mac_addr_remove(struct rte_eth_dev *, uint32_t);
208 int hash_rxq_mac_addrs_add(struct hash_rxq *);
209 int priv_mac_addr_add(struct priv *, unsigned int,
210                       const uint8_t (*)[ETHER_ADDR_LEN]);
211 int priv_mac_addrs_enable(struct priv *);
212 void mlx5_mac_addr_add(struct rte_eth_dev *, struct ether_addr *, uint32_t,
213                        uint32_t);
214 void mlx5_mac_addr_set(struct rte_eth_dev *, struct ether_addr *);
215
216 /* mlx5_rss.c */
217
218 int rss_hash_rss_conf_new_key(struct priv *, const uint8_t *, unsigned int,
219                               uint64_t);
220 int mlx5_rss_hash_update(struct rte_eth_dev *, struct rte_eth_rss_conf *);
221 int mlx5_rss_hash_conf_get(struct rte_eth_dev *, struct rte_eth_rss_conf *);
222 int priv_rss_reta_index_resize(struct priv *, unsigned int);
223 int mlx5_dev_rss_reta_query(struct rte_eth_dev *,
224                             struct rte_eth_rss_reta_entry64 *, uint16_t);
225 int mlx5_dev_rss_reta_update(struct rte_eth_dev *,
226                              struct rte_eth_rss_reta_entry64 *, uint16_t);
227
228 /* mlx5_rxmode.c */
229
230 int priv_special_flow_enable(struct priv *, enum hash_rxq_flow_type);
231 void priv_special_flow_disable(struct priv *, enum hash_rxq_flow_type);
232 int priv_special_flow_enable_all(struct priv *);
233 void priv_special_flow_disable_all(struct priv *);
234 void mlx5_promiscuous_enable(struct rte_eth_dev *);
235 void mlx5_promiscuous_disable(struct rte_eth_dev *);
236 void mlx5_allmulticast_enable(struct rte_eth_dev *);
237 void mlx5_allmulticast_disable(struct rte_eth_dev *);
238
239 /* mlx5_stats.c */
240
241 void mlx5_stats_get(struct rte_eth_dev *, struct rte_eth_stats *);
242 void mlx5_stats_reset(struct rte_eth_dev *);
243
244 /* mlx5_vlan.c */
245
246 int mlx5_vlan_filter_set(struct rte_eth_dev *, uint16_t, int);
247 void mlx5_vlan_offload_set(struct rte_eth_dev *, int);
248 void mlx5_vlan_strip_queue_set(struct rte_eth_dev *, uint16_t, int);
249
250 /* mlx5_trigger.c */
251
252 int mlx5_dev_start(struct rte_eth_dev *);
253 void mlx5_dev_stop(struct rte_eth_dev *);
254
255 /* mlx5_fdir.c */
256
257 int fdir_init_filters_list(struct priv *);
258 void priv_fdir_delete_filters_list(struct priv *);
259 void priv_fdir_disable(struct priv *);
260 void priv_fdir_enable(struct priv *);
261 int mlx5_dev_filter_ctrl(struct rte_eth_dev *, enum rte_filter_type,
262                          enum rte_filter_op, void *);
263
264 #endif /* RTE_PMD_MLX5_H_ */