191e1a36f31d1b4214469b3e26831f7adaf2152a
[dpdk.git] / drivers / net / enic / enic.h
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_VERSION             "1.0.0.6"
55 #define DRV_COPYRIGHT           "Copyright 2008-2015 Cisco Systems, Inc"
56
57 #define ENIC_WQ_MAX             8
58 /* With Rx scatter support, we use two RQs on VIC per RQ used by app. Both
59  * RQs use the same CQ.
60  */
61 #define ENIC_RQ_MAX             16
62 #define ENIC_CQ_MAX             (ENIC_WQ_MAX + (ENIC_RQ_MAX / 2))
63 #define ENIC_INTR_MAX           (ENIC_CQ_MAX + 2)
64
65 #define VLAN_ETH_HLEN           18
66
67 #define ENICPMD_SETTING(enic, f) ((enic->config.flags & VENETF_##f) ? 1 : 0)
68
69 #define ENICPMD_BDF_LENGTH      13   /* 0000:00:00.0'\0' */
70 #define ENIC_CALC_IP_CKSUM      1
71 #define ENIC_CALC_TCP_UDP_CKSUM 2
72 #define ENIC_MAX_MTU            9000
73 #define ENIC_PAGE_SIZE          4096
74 #define PAGE_ROUND_UP(x) \
75         ((((unsigned long)(x)) + ENIC_PAGE_SIZE-1) & (~(ENIC_PAGE_SIZE-1)))
76
77 #define ENICPMD_VFIO_PATH          "/dev/vfio/vfio"
78 /*#define ENIC_DESC_COUNT_MAKE_ODD (x) do{if ((~(x)) & 1) { (x)--; } }while(0)*/
79
80 #define PCI_DEVICE_ID_CISCO_VIC_ENET         0x0043  /* ethernet vnic */
81 #define PCI_DEVICE_ID_CISCO_VIC_ENET_VF      0x0071  /* enet SRIOV VF */
82
83
84 #define ENICPMD_FDIR_MAX           64
85
86 struct enic_fdir_node {
87         struct rte_eth_fdir_filter filter;
88         u16 fltr_id;
89         u16 rq_index;
90 };
91
92 struct enic_fdir {
93         struct rte_eth_fdir_stats stats;
94         struct rte_hash *hash;
95         struct enic_fdir_node *nodes[ENICPMD_FDIR_MAX];
96 };
97
98 struct enic_soft_stats {
99         rte_atomic64_t rx_nombuf;
100         rte_atomic64_t rx_packet_errors;
101 };
102
103 struct enic_memzone_entry {
104         const struct rte_memzone *rz;
105         LIST_ENTRY(enic_memzone_entry) entries;
106 };
107
108 /* Per-instance private data structure */
109 struct enic {
110         struct enic *next;
111         struct rte_pci_device *pdev;
112         struct vnic_enet_config config;
113         struct vnic_dev_bar bar0;
114         struct vnic_dev *vdev;
115
116         unsigned int port_id;
117         struct rte_eth_dev *rte_dev;
118         struct enic_fdir fdir;
119         char bdf_name[ENICPMD_BDF_LENGTH];
120         int dev_fd;
121         int iommu_group_fd;
122         int iommu_groupid;
123         int eventfd;
124         uint8_t mac_addr[ETH_ALEN];
125         pthread_t err_intr_thread;
126         int promisc;
127         int allmulti;
128         u8 ig_vlan_strip_en;
129         int link_status;
130         u8 hw_ip_checksum;
131         u16 max_mtu;
132
133         unsigned int flags;
134         unsigned int priv_flags;
135
136         /* work queue */
137         struct vnic_wq wq[ENIC_WQ_MAX];
138         unsigned int wq_count;
139
140         /* receive queue */
141         struct vnic_rq rq[ENIC_RQ_MAX];
142         unsigned int rq_count;
143
144         /* completion queue */
145         struct vnic_cq cq[ENIC_CQ_MAX];
146         unsigned int cq_count;
147
148         /* interrupt resource */
149         struct vnic_intr intr;
150         unsigned int intr_count;
151
152         /* software counters */
153         struct enic_soft_stats soft_stats;
154
155         /* linked list storing memory allocations */
156         LIST_HEAD(enic_memzone_list, enic_memzone_entry) memzone_list;
157         rte_spinlock_t memzone_list_lock;
158
159 };
160
161 static inline unsigned int enic_sop_rq(unsigned int rq)
162 {
163         return rq * 2;
164 }
165
166 static inline unsigned int enic_data_rq(unsigned int rq)
167 {
168         return rq * 2 + 1;
169 }
170
171 static inline unsigned int enic_vnic_rq_count(struct enic *enic)
172 {
173         return enic->rq_count * 2;
174 }
175
176 static inline unsigned int enic_cq_rq(__rte_unused struct enic *enic, unsigned int rq)
177 {
178         /* Scatter rx uses two receive queues together with one
179          * completion queue, so the completion queue number is no
180          * longer the same as the rq number.
181          */
182         return rq / 2;
183 }
184
185 static inline unsigned int enic_cq_wq(struct enic *enic, unsigned int wq)
186 {
187         return enic->rq_count + wq;
188 }
189
190 static inline unsigned int enic_msix_err_intr(__rte_unused struct enic *enic)
191 {
192         return 0;
193 }
194
195 static inline struct enic *pmd_priv(struct rte_eth_dev *eth_dev)
196 {
197         return (struct enic *)eth_dev->data->dev_private;
198 }
199
200 static inline uint32_t
201 enic_ring_add(uint32_t n_descriptors, uint32_t i0, uint32_t i1)
202 {
203         uint32_t d = i0 + i1;
204         d -= (d >= n_descriptors) ? n_descriptors : 0;
205         return d;
206 }
207
208 static inline uint32_t
209 enic_ring_sub(uint32_t n_descriptors, uint32_t i0, uint32_t i1)
210 {
211         int32_t d = i1 - i0;
212         return (uint32_t)((d < 0) ? ((int32_t)n_descriptors + d) : d);
213 }
214
215 static inline uint32_t
216 enic_ring_incr(uint32_t n_descriptors, uint32_t idx)
217 {
218         idx++;
219         if (unlikely(idx == n_descriptors))
220                 idx = 0;
221         return idx;
222 }
223
224 extern void enic_fdir_stats_get(struct enic *enic,
225         struct rte_eth_fdir_stats *stats);
226 extern int enic_fdir_add_fltr(struct enic *enic,
227         struct rte_eth_fdir_filter *params);
228 extern int enic_fdir_del_fltr(struct enic *enic,
229         struct rte_eth_fdir_filter *params);
230 extern void enic_free_wq(void *txq);
231 extern int enic_alloc_intr_resources(struct enic *enic);
232 extern int enic_setup_finish(struct enic *enic);
233 extern int enic_alloc_wq(struct enic *enic, uint16_t queue_idx,
234         unsigned int socket_id, uint16_t nb_desc);
235 extern void enic_start_wq(struct enic *enic, uint16_t queue_idx);
236 extern int enic_stop_wq(struct enic *enic, uint16_t queue_idx);
237 extern void enic_start_rq(struct enic *enic, uint16_t queue_idx);
238 extern int enic_stop_rq(struct enic *enic, uint16_t queue_idx);
239 extern void enic_free_rq(void *rxq);
240 extern int enic_alloc_rq(struct enic *enic, uint16_t queue_idx,
241         unsigned int socket_id, struct rte_mempool *mp,
242         uint16_t nb_desc);
243 extern int enic_set_rss_nic_cfg(struct enic *enic);
244 extern int enic_set_vnic_res(struct enic *enic);
245 extern void enic_set_hdr_split_size(struct enic *enic, u16 split_hdr_size);
246 extern int enic_enable(struct enic *enic);
247 extern int enic_disable(struct enic *enic);
248 extern void enic_remove(struct enic *enic);
249 extern int enic_get_link_status(struct enic *enic);
250 extern void enic_dev_stats_get(struct enic *enic,
251         struct rte_eth_stats *r_stats);
252 extern void enic_dev_stats_clear(struct enic *enic);
253 extern void enic_add_packet_filter(struct enic *enic);
254 extern void enic_set_mac_address(struct enic *enic, uint8_t *mac_addr);
255 extern void enic_del_mac_address(struct enic *enic);
256 extern unsigned int enic_cleanup_wq(struct enic *enic, struct vnic_wq *wq);
257 extern void enic_send_pkt(struct enic *enic, struct vnic_wq *wq,
258                           struct rte_mbuf *tx_pkt, unsigned short len,
259                           uint8_t sop, uint8_t eop, uint8_t cq_entry,
260                           uint16_t ol_flags, uint16_t vlan_tag);
261
262 extern void enic_post_wq_index(struct vnic_wq *wq);
263 extern int enic_probe(struct enic *enic);
264 extern int enic_clsf_init(struct enic *enic);
265 extern void enic_clsf_destroy(struct enic *enic);
266 uint16_t enic_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
267                         uint16_t nb_pkts);
268 uint16_t enic_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
269                                uint16_t nb_pkts);
270 int enic_set_mtu(struct enic *enic, uint16_t new_mtu);
271 #endif /* _ENIC_H_ */