net/enic: support mbuf fast free offload
[dpdk.git] / drivers / net / enic / enic.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright 2008-2017 Cisco Systems, Inc.  All rights reserved.
3  * Copyright 2007 Nuova Systems, Inc.  All rights reserved.
4  */
5
6 #ifndef _ENIC_H_
7 #define _ENIC_H_
8
9 #include "vnic_enet.h"
10 #include "vnic_dev.h"
11 #include "vnic_wq.h"
12 #include "vnic_rq.h"
13 #include "vnic_cq.h"
14 #include "vnic_intr.h"
15 #include "vnic_stats.h"
16 #include "vnic_nic.h"
17 #include "vnic_rss.h"
18 #include "enic_res.h"
19 #include "cq_enet_desc.h"
20 #include <stdbool.h>
21 #include <sys/queue.h>
22 #include <rte_spinlock.h>
23
24 #define DRV_NAME                "enic_pmd"
25 #define DRV_DESCRIPTION         "Cisco VIC Ethernet NIC Poll-mode Driver"
26 #define DRV_COPYRIGHT           "Copyright 2008-2015 Cisco Systems, Inc"
27
28 #define ENIC_MAX_MAC_ADDR       64
29
30 #define VLAN_ETH_HLEN           18
31
32 #define ENICPMD_SETTING(enic, f) ((enic->config.flags & VENETF_##f) ? 1 : 0)
33
34 #define ENICPMD_BDF_LENGTH      13   /* 0000:00:00.0'\0' */
35 #define ENIC_CALC_IP_CKSUM      1
36 #define ENIC_CALC_TCP_UDP_CKSUM 2
37 #define ENIC_MAX_MTU            9000
38 #define ENIC_PAGE_SIZE          4096
39 #define PAGE_ROUND_UP(x) \
40         ((((unsigned long)(x)) + ENIC_PAGE_SIZE-1) & (~(ENIC_PAGE_SIZE-1)))
41
42 #define ENICPMD_VFIO_PATH          "/dev/vfio/vfio"
43 /*#define ENIC_DESC_COUNT_MAKE_ODD (x) do{if ((~(x)) & 1) { (x)--; } }while(0)*/
44
45 #define PCI_DEVICE_ID_CISCO_VIC_ENET         0x0043  /* ethernet vnic */
46 #define PCI_DEVICE_ID_CISCO_VIC_ENET_VF      0x0071  /* enet SRIOV VF */
47
48 /* Special Filter id for non-specific packet flagging. Don't change value */
49 #define ENIC_MAGIC_FILTER_ID 0xffff
50
51 #define ENICPMD_FDIR_MAX           64
52
53 /* HW default VXLAN port */
54 #define ENIC_DEFAULT_VXLAN_PORT    4789
55
56 /*
57  * Interrupt 0: LSC and errors
58  * Interrupt 1: rx queue 0
59  * Interrupt 2: rx queue 1
60  * ...
61  */
62 #define ENICPMD_LSC_INTR_OFFSET 0
63 #define ENICPMD_RXQ_INTR_OFFSET 1
64
65 struct enic_fdir_node {
66         struct rte_eth_fdir_filter filter;
67         u16 fltr_id;
68         u16 rq_index;
69 };
70
71 struct enic_fdir {
72         struct rte_eth_fdir_stats stats;
73         struct rte_hash *hash;
74         struct enic_fdir_node *nodes[ENICPMD_FDIR_MAX];
75         u32 modes;
76         u32 types_mask;
77         void (*copy_fltr_fn)(struct filter_v2 *filt,
78                              struct rte_eth_fdir_input *input,
79                              struct rte_eth_fdir_masks *masks);
80 };
81
82 struct enic_soft_stats {
83         rte_atomic64_t rx_nombuf;
84         rte_atomic64_t rx_packet_errors;
85         rte_atomic64_t tx_oversized;
86 };
87
88 struct enic_memzone_entry {
89         const struct rte_memzone *rz;
90         LIST_ENTRY(enic_memzone_entry) entries;
91 };
92
93 struct rte_flow {
94         LIST_ENTRY(rte_flow) next;
95         u16 enic_filter_id;
96         struct filter_v2 enic_filter;
97 };
98
99 /* Per-instance private data structure */
100 struct enic {
101         struct enic *next;
102         struct rte_pci_device *pdev;
103         struct vnic_enet_config config;
104         struct vnic_dev_bar bar0;
105         struct vnic_dev *vdev;
106
107         unsigned int port_id;
108         bool overlay_offload;
109         struct rte_eth_dev *rte_dev;
110         struct enic_fdir fdir;
111         char bdf_name[ENICPMD_BDF_LENGTH];
112         int dev_fd;
113         int iommu_group_fd;
114         int iommu_groupid;
115         int eventfd;
116         uint8_t mac_addr[ETH_ALEN];
117         pthread_t err_intr_thread;
118         int promisc;
119         int allmulti;
120         u8 ig_vlan_strip_en;
121         int link_status;
122         u8 hw_ip_checksum;
123         u16 max_mtu;
124         u8 adv_filters;
125         u32 flow_filter_mode;
126         u8 filter_actions; /* HW supported actions */
127         bool vxlan;
128         bool disable_overlay; /* devargs disable_overlay=1 */
129         bool nic_cfg_chk;     /* NIC_CFG_CHK available */
130         bool udp_rss_weak;    /* Bodega style UDP RSS */
131         uint8_t ig_vlan_rewrite_mode; /* devargs ig-vlan-rewrite */
132         uint16_t vxlan_port;  /* current vxlan port pushed to NIC */
133
134         unsigned int flags;
135         unsigned int priv_flags;
136
137         /* work queue (len = conf_wq_count) */
138         struct vnic_wq *wq;
139         unsigned int wq_count; /* equals eth_dev nb_tx_queues */
140
141         /* receive queue (len = conf_rq_count) */
142         struct vnic_rq *rq;
143         unsigned int rq_count; /* equals eth_dev nb_rx_queues */
144
145         /* completion queue (len = conf_cq_count) */
146         struct vnic_cq *cq;
147         unsigned int cq_count; /* equals rq_count + wq_count */
148
149         /* interrupt vectors (len = conf_intr_count) */
150         struct vnic_intr *intr;
151         unsigned int intr_count; /* equals enabled interrupts (lsc + rxqs) */
152
153         /* software counters */
154         struct enic_soft_stats soft_stats;
155
156         /* configured resources on vic */
157         unsigned int conf_rq_count;
158         unsigned int conf_wq_count;
159         unsigned int conf_cq_count;
160         unsigned int conf_intr_count;
161
162         /* linked list storing memory allocations */
163         LIST_HEAD(enic_memzone_list, enic_memzone_entry) memzone_list;
164         rte_spinlock_t memzone_list_lock;
165         rte_spinlock_t mtu_lock;
166
167         LIST_HEAD(enic_flows, rte_flow) flows;
168         rte_spinlock_t flows_lock;
169
170         /* RSS */
171         uint16_t reta_size;
172         uint8_t hash_key_size;
173         uint64_t flow_type_rss_offloads; /* 0 indicates RSS not supported */
174         /*
175          * Keep a copy of current RSS config for queries, as we cannot retrieve
176          * it from the NIC.
177          */
178         uint8_t rss_hash_type; /* NIC_CFG_RSS_HASH_TYPE flags */
179         uint8_t rss_enable;
180         uint64_t rss_hf; /* ETH_RSS flags */
181         union vnic_rss_key rss_key;
182         union vnic_rss_cpu rss_cpu;
183
184         uint64_t rx_offload_capa; /* DEV_RX_OFFLOAD flags */
185         uint64_t tx_offload_capa; /* DEV_TX_OFFLOAD flags */
186         uint64_t tx_queue_offload_capa; /* DEV_TX_OFFLOAD flags */
187         uint64_t tx_offload_mask; /* PKT_TX flags accepted */
188 };
189
190 /* Compute ethdev's max packet size from MTU */
191 static inline uint32_t enic_mtu_to_max_rx_pktlen(uint32_t mtu)
192 {
193         /* ethdev max size includes eth and crc whereas NIC MTU does not */
194         return mtu + ETHER_HDR_LEN + ETHER_CRC_LEN;
195 }
196
197 /* Get the CQ index from a Start of Packet(SOP) RQ index */
198 static inline unsigned int enic_sop_rq_idx_to_cq_idx(unsigned int sop_idx)
199 {
200         return sop_idx / 2;
201 }
202
203 /* Get the RTE RQ index from a Start of Packet(SOP) RQ index */
204 static inline unsigned int enic_sop_rq_idx_to_rte_idx(unsigned int sop_idx)
205 {
206         return sop_idx / 2;
207 }
208
209 /* Get the Start of Packet(SOP) RQ index from a RTE RQ index */
210 static inline unsigned int enic_rte_rq_idx_to_sop_idx(unsigned int rte_idx)
211 {
212         return rte_idx * 2;
213 }
214
215 /* Get the Data RQ index from a RTE RQ index */
216 static inline unsigned int enic_rte_rq_idx_to_data_idx(unsigned int rte_idx)
217 {
218         return rte_idx * 2 + 1;
219 }
220
221 static inline unsigned int enic_vnic_rq_count(struct enic *enic)
222 {
223         return enic->rq_count * 2;
224 }
225
226 static inline unsigned int enic_cq_rq(__rte_unused struct enic *enic, unsigned int rq)
227 {
228         /* Scatter rx uses two receive queues together with one
229          * completion queue, so the completion queue number is no
230          * longer the same as the rq number.
231          */
232         return rq / 2;
233 }
234
235 static inline unsigned int enic_cq_wq(struct enic *enic, unsigned int wq)
236 {
237         return enic->rq_count + wq;
238 }
239
240 static inline struct enic *pmd_priv(struct rte_eth_dev *eth_dev)
241 {
242         return (struct enic *)eth_dev->data->dev_private;
243 }
244
245 static inline uint32_t
246 enic_ring_add(uint32_t n_descriptors, uint32_t i0, uint32_t i1)
247 {
248         uint32_t d = i0 + i1;
249         d -= (d >= n_descriptors) ? n_descriptors : 0;
250         return d;
251 }
252
253 static inline uint32_t
254 enic_ring_sub(uint32_t n_descriptors, uint32_t i0, uint32_t i1)
255 {
256         int32_t d = i1 - i0;
257         return (uint32_t)((d < 0) ? ((int32_t)n_descriptors + d) : d);
258 }
259
260 static inline uint32_t
261 enic_ring_incr(uint32_t n_descriptors, uint32_t idx)
262 {
263         idx++;
264         if (unlikely(idx == n_descriptors))
265                 idx = 0;
266         return idx;
267 }
268
269 void enic_fdir_stats_get(struct enic *enic,
270                          struct rte_eth_fdir_stats *stats);
271 int enic_fdir_add_fltr(struct enic *enic,
272                        struct rte_eth_fdir_filter *params);
273 int enic_fdir_del_fltr(struct enic *enic,
274                        struct rte_eth_fdir_filter *params);
275 void enic_free_wq(void *txq);
276 int enic_alloc_intr_resources(struct enic *enic);
277 int enic_setup_finish(struct enic *enic);
278 int enic_alloc_wq(struct enic *enic, uint16_t queue_idx,
279                   unsigned int socket_id, uint16_t nb_desc);
280 void enic_start_wq(struct enic *enic, uint16_t queue_idx);
281 int enic_stop_wq(struct enic *enic, uint16_t queue_idx);
282 void enic_start_rq(struct enic *enic, uint16_t queue_idx);
283 int enic_stop_rq(struct enic *enic, uint16_t queue_idx);
284 void enic_free_rq(void *rxq);
285 int enic_alloc_rq(struct enic *enic, uint16_t queue_idx,
286                   unsigned int socket_id, struct rte_mempool *mp,
287                   uint16_t nb_desc, uint16_t free_thresh);
288 int enic_set_vnic_res(struct enic *enic);
289 int enic_init_rss_nic_cfg(struct enic *enic);
290 int enic_set_rss_conf(struct enic *enic,
291                       struct rte_eth_rss_conf *rss_conf);
292 int enic_set_rss_reta(struct enic *enic, union vnic_rss_cpu *rss_cpu);
293 int enic_set_vlan_strip(struct enic *enic);
294 int enic_enable(struct enic *enic);
295 int enic_disable(struct enic *enic);
296 void enic_remove(struct enic *enic);
297 int enic_get_link_status(struct enic *enic);
298 int enic_dev_stats_get(struct enic *enic,
299                        struct rte_eth_stats *r_stats);
300 void enic_dev_stats_clear(struct enic *enic);
301 void enic_add_packet_filter(struct enic *enic);
302 int enic_set_mac_address(struct enic *enic, uint8_t *mac_addr);
303 int enic_del_mac_address(struct enic *enic, int mac_index);
304 unsigned int enic_cleanup_wq(struct enic *enic, struct vnic_wq *wq);
305 void enic_send_pkt(struct enic *enic, struct vnic_wq *wq,
306                    struct rte_mbuf *tx_pkt, unsigned short len,
307                    uint8_t sop, uint8_t eop, uint8_t cq_entry,
308                    uint16_t ol_flags, uint16_t vlan_tag);
309
310 void enic_post_wq_index(struct vnic_wq *wq);
311 int enic_probe(struct enic *enic);
312 int enic_clsf_init(struct enic *enic);
313 void enic_clsf_destroy(struct enic *enic);
314 uint16_t enic_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
315                         uint16_t nb_pkts);
316 uint16_t enic_dummy_recv_pkts(void *rx_queue,
317                               struct rte_mbuf **rx_pkts,
318                               uint16_t nb_pkts);
319 uint16_t enic_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
320                         uint16_t nb_pkts);
321 uint16_t enic_prep_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
322                         uint16_t nb_pkts);
323 int enic_set_mtu(struct enic *enic, uint16_t new_mtu);
324 int enic_link_update(struct enic *enic);
325 void enic_fdir_info(struct enic *enic);
326 void enic_fdir_info_get(struct enic *enic, struct rte_eth_fdir_info *stats);
327 void copy_fltr_v1(struct filter_v2 *fltr, struct rte_eth_fdir_input *input,
328                   struct rte_eth_fdir_masks *masks);
329 void copy_fltr_v2(struct filter_v2 *fltr, struct rte_eth_fdir_input *input,
330                   struct rte_eth_fdir_masks *masks);
331 extern const struct rte_flow_ops enic_flow_ops;
332 #endif /* _ENIC_H_ */