enic.h revision 6b3e017e
1/*
2 * Copyright 2008-2014 Cisco Systems, Inc.  All rights reserved.
3 * Copyright 2007 Nuova Systems, Inc.  All rights reserved.
4 *
5 * Copyright (c) 2014, Cisco Systems, Inc.
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 *
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 *
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
18 * distribution.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGE.
32 *
33 */
34
35#ifndef _ENIC_H_
36#define _ENIC_H_
37
38#include "vnic_enet.h"
39#include "vnic_dev.h"
40#include "vnic_wq.h"
41#include "vnic_rq.h"
42#include "vnic_cq.h"
43#include "vnic_intr.h"
44#include "vnic_stats.h"
45#include "vnic_nic.h"
46#include "vnic_rss.h"
47#include "enic_res.h"
48#include "cq_enet_desc.h"
49#include <sys/queue.h>
50#include <rte_spinlock.h>
51
52#define DRV_NAME		"enic_pmd"
53#define DRV_DESCRIPTION		"Cisco VIC Ethernet NIC Poll-mode Driver"
54#define DRV_COPYRIGHT		"Copyright 2008-2015 Cisco Systems, Inc"
55
56#define ENIC_WQ_MAX		8
57/* With Rx scatter support, we use two RQs on VIC per RQ used by app. Both
58 * RQs use the same CQ.
59 */
60#define ENIC_RQ_MAX		16
61#define ENIC_CQ_MAX		(ENIC_WQ_MAX + (ENIC_RQ_MAX / 2))
62#define ENIC_INTR_MAX		(ENIC_CQ_MAX + 2)
63
64#define VLAN_ETH_HLEN           18
65
66#define ENICPMD_SETTING(enic, f) ((enic->config.flags & VENETF_##f) ? 1 : 0)
67
68#define ENICPMD_BDF_LENGTH      13   /* 0000:00:00.0'\0' */
69#define ENIC_CALC_IP_CKSUM      1
70#define ENIC_CALC_TCP_UDP_CKSUM 2
71#define ENIC_MAX_MTU            9000
72#define ENIC_PAGE_SIZE          4096
73#define PAGE_ROUND_UP(x) \
74	((((unsigned long)(x)) + ENIC_PAGE_SIZE-1) & (~(ENIC_PAGE_SIZE-1)))
75
76#define ENICPMD_VFIO_PATH          "/dev/vfio/vfio"
77/*#define ENIC_DESC_COUNT_MAKE_ODD (x) do{if ((~(x)) & 1) { (x)--; } }while(0)*/
78
79#define PCI_DEVICE_ID_CISCO_VIC_ENET         0x0043  /* ethernet vnic */
80#define PCI_DEVICE_ID_CISCO_VIC_ENET_VF      0x0071  /* enet SRIOV VF */
81
82
83#define ENICPMD_FDIR_MAX           64
84
85struct enic_fdir_node {
86	struct rte_eth_fdir_filter filter;
87	u16 fltr_id;
88	u16 rq_index;
89};
90
91struct enic_fdir {
92	struct rte_eth_fdir_stats stats;
93	struct rte_hash *hash;
94	struct enic_fdir_node *nodes[ENICPMD_FDIR_MAX];
95	u32 modes;
96	u32 types_mask;
97	void (*copy_fltr_fn)(struct filter_v2 *filt,
98			     struct rte_eth_fdir_input *input,
99			     struct rte_eth_fdir_masks *masks);
100};
101
102struct enic_soft_stats {
103	rte_atomic64_t rx_nombuf;
104	rte_atomic64_t rx_packet_errors;
105};
106
107struct enic_memzone_entry {
108	const struct rte_memzone *rz;
109	LIST_ENTRY(enic_memzone_entry) entries;
110};
111
112/* Per-instance private data structure */
113struct enic {
114	struct enic *next;
115	struct rte_pci_device *pdev;
116	struct vnic_enet_config config;
117	struct vnic_dev_bar bar0;
118	struct vnic_dev *vdev;
119
120	unsigned int port_id;
121	struct rte_eth_dev *rte_dev;
122	struct enic_fdir fdir;
123	char bdf_name[ENICPMD_BDF_LENGTH];
124	int dev_fd;
125	int iommu_group_fd;
126	int iommu_groupid;
127	int eventfd;
128	uint8_t mac_addr[ETH_ALEN];
129	pthread_t err_intr_thread;
130	int promisc;
131	int allmulti;
132	u8 ig_vlan_strip_en;
133	int link_status;
134	u8 hw_ip_checksum;
135	u16 max_mtu;
136	u16 adv_filters;
137
138	unsigned int flags;
139	unsigned int priv_flags;
140
141	/* work queue */
142	struct vnic_wq wq[ENIC_WQ_MAX];
143	unsigned int wq_count;
144
145	/* receive queue */
146	struct vnic_rq rq[ENIC_RQ_MAX];
147	unsigned int rq_count;
148
149	/* completion queue */
150	struct vnic_cq cq[ENIC_CQ_MAX];
151	unsigned int cq_count;
152
153	/* interrupt resource */
154	struct vnic_intr intr;
155	unsigned int intr_count;
156
157	/* software counters */
158	struct enic_soft_stats soft_stats;
159
160	/* configured resources on vic */
161	unsigned int conf_rq_count;
162	unsigned int conf_wq_count;
163	unsigned int conf_cq_count;
164	unsigned int conf_intr_count;
165
166	/* linked list storing memory allocations */
167	LIST_HEAD(enic_memzone_list, enic_memzone_entry) memzone_list;
168	rte_spinlock_t memzone_list_lock;
169	rte_spinlock_t mtu_lock;
170
171};
172
173/* Get the CQ index from a Start of Packet(SOP) RQ index */
174static inline unsigned int enic_sop_rq_idx_to_cq_idx(unsigned int sop_idx)
175{
176	return sop_idx / 2;
177}
178
179/* Get the RTE RQ index from a Start of Packet(SOP) RQ index */
180static inline unsigned int enic_sop_rq_idx_to_rte_idx(unsigned int sop_idx)
181{
182	return sop_idx / 2;
183}
184
185/* Get the Start of Packet(SOP) RQ index from a RTE RQ index */
186static inline unsigned int enic_rte_rq_idx_to_sop_idx(unsigned int rte_idx)
187{
188	return rte_idx * 2;
189}
190
191/* Get the Data RQ index from a RTE RQ index */
192static inline unsigned int enic_rte_rq_idx_to_data_idx(unsigned int rte_idx)
193{
194	return rte_idx * 2 + 1;
195}
196
197static inline unsigned int enic_vnic_rq_count(struct enic *enic)
198{
199	return enic->rq_count * 2;
200}
201
202static inline unsigned int enic_cq_rq(__rte_unused struct enic *enic, unsigned int rq)
203{
204	/* Scatter rx uses two receive queues together with one
205	 * completion queue, so the completion queue number is no
206	 * longer the same as the rq number.
207	 */
208	return rq / 2;
209}
210
211static inline unsigned int enic_cq_wq(struct enic *enic, unsigned int wq)
212{
213	return enic->rq_count + wq;
214}
215
216static inline unsigned int enic_msix_err_intr(__rte_unused struct enic *enic)
217{
218	return 0;
219}
220
221static inline struct enic *pmd_priv(struct rte_eth_dev *eth_dev)
222{
223	return (struct enic *)eth_dev->data->dev_private;
224}
225
226static inline uint32_t
227enic_ring_add(uint32_t n_descriptors, uint32_t i0, uint32_t i1)
228{
229	uint32_t d = i0 + i1;
230	d -= (d >= n_descriptors) ? n_descriptors : 0;
231	return d;
232}
233
234static inline uint32_t
235enic_ring_sub(uint32_t n_descriptors, uint32_t i0, uint32_t i1)
236{
237	int32_t d = i1 - i0;
238	return (uint32_t)((d < 0) ? ((int32_t)n_descriptors + d) : d);
239}
240
241static inline uint32_t
242enic_ring_incr(uint32_t n_descriptors, uint32_t idx)
243{
244	idx++;
245	if (unlikely(idx == n_descriptors))
246		idx = 0;
247	return idx;
248}
249
250extern void enic_fdir_stats_get(struct enic *enic,
251	struct rte_eth_fdir_stats *stats);
252extern int enic_fdir_add_fltr(struct enic *enic,
253	struct rte_eth_fdir_filter *params);
254extern int enic_fdir_del_fltr(struct enic *enic,
255	struct rte_eth_fdir_filter *params);
256extern void enic_free_wq(void *txq);
257extern int enic_alloc_intr_resources(struct enic *enic);
258extern int enic_setup_finish(struct enic *enic);
259extern int enic_alloc_wq(struct enic *enic, uint16_t queue_idx,
260	unsigned int socket_id, uint16_t nb_desc);
261extern void enic_start_wq(struct enic *enic, uint16_t queue_idx);
262extern int enic_stop_wq(struct enic *enic, uint16_t queue_idx);
263extern void enic_start_rq(struct enic *enic, uint16_t queue_idx);
264extern int enic_stop_rq(struct enic *enic, uint16_t queue_idx);
265extern void enic_free_rq(void *rxq);
266extern int enic_alloc_rq(struct enic *enic, uint16_t queue_idx,
267	unsigned int socket_id, struct rte_mempool *mp,
268	uint16_t nb_desc, uint16_t free_thresh);
269extern int enic_set_rss_nic_cfg(struct enic *enic);
270extern int enic_set_vnic_res(struct enic *enic);
271extern void enic_set_hdr_split_size(struct enic *enic, u16 split_hdr_size);
272extern int enic_enable(struct enic *enic);
273extern int enic_disable(struct enic *enic);
274extern void enic_remove(struct enic *enic);
275extern int enic_get_link_status(struct enic *enic);
276extern void enic_dev_stats_get(struct enic *enic,
277	struct rte_eth_stats *r_stats);
278extern void enic_dev_stats_clear(struct enic *enic);
279extern void enic_add_packet_filter(struct enic *enic);
280extern void enic_set_mac_address(struct enic *enic, uint8_t *mac_addr);
281extern void enic_del_mac_address(struct enic *enic);
282extern unsigned int enic_cleanup_wq(struct enic *enic, struct vnic_wq *wq);
283extern void enic_send_pkt(struct enic *enic, struct vnic_wq *wq,
284			  struct rte_mbuf *tx_pkt, unsigned short len,
285			  uint8_t sop, uint8_t eop, uint8_t cq_entry,
286			  uint16_t ol_flags, uint16_t vlan_tag);
287
288extern void enic_post_wq_index(struct vnic_wq *wq);
289extern int enic_probe(struct enic *enic);
290extern int enic_clsf_init(struct enic *enic);
291extern void enic_clsf_destroy(struct enic *enic);
292uint16_t enic_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
293			uint16_t nb_pkts);
294uint16_t enic_dummy_recv_pkts(__rte_unused void *rx_queue,
295			      __rte_unused struct rte_mbuf **rx_pkts,
296			      __rte_unused uint16_t nb_pkts);
297uint16_t enic_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
298			       uint16_t nb_pkts);
299int enic_set_mtu(struct enic *enic, uint16_t new_mtu);
300int enic_link_update(struct enic *enic);
301void enic_fdir_info(struct enic *enic);
302void enic_fdir_info_get(struct enic *enic, struct rte_eth_fdir_info *stats);
303void copy_fltr_v1(struct filter_v2 *fltr, struct rte_eth_fdir_input *input,
304		  struct rte_eth_fdir_masks *masks);
305void copy_fltr_v2(__rte_unused struct filter_v2 *fltr,
306		  __rte_unused struct rte_eth_fdir_input *input,
307		  __rte_unused struct rte_eth_fdir_masks *masks);
308#endif /* _ENIC_H_ */
309