14f465f239d65d8c791618c3961b03cd6ef79fed
[cascardo/linux.git] / drivers / net / ethernet / cisco / enic / enic.h
1 /*
2  * Copyright 2008-2010 Cisco Systems, Inc.  All rights reserved.
3  * Copyright 2007 Nuova Systems, Inc.  All rights reserved.
4  *
5  * This program is free software; you may redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; version 2 of the License.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
10  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
11  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
12  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
13  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
14  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
15  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
16  * SOFTWARE.
17  *
18  */
19
20 #ifndef _ENIC_H_
21 #define _ENIC_H_
22
23 #include "vnic_enet.h"
24 #include "vnic_dev.h"
25 #include "vnic_wq.h"
26 #include "vnic_rq.h"
27 #include "vnic_cq.h"
28 #include "vnic_intr.h"
29 #include "vnic_stats.h"
30 #include "vnic_nic.h"
31 #include "vnic_rss.h"
32 #include <linux/irq.h>
33
34 #define DRV_NAME                "enic"
35 #define DRV_DESCRIPTION         "Cisco VIC Ethernet NIC Driver"
36 #define DRV_VERSION             "2.1.1.50"
37 #define DRV_COPYRIGHT           "Copyright 2008-2013 Cisco Systems, Inc"
38
39 #define ENIC_BARS_MAX           6
40
41 #define ENIC_WQ_MAX             8
42 #define ENIC_RQ_MAX             8
43 #define ENIC_CQ_MAX             (ENIC_WQ_MAX + ENIC_RQ_MAX)
44 #define ENIC_INTR_MAX           (ENIC_CQ_MAX + 2)
45
46 #define ENIC_AIC_LARGE_PKT_DIFF 3
47
48 struct enic_msix_entry {
49         int requested;
50         char devname[IFNAMSIZ];
51         irqreturn_t (*isr)(int, void *);
52         void *devid;
53 };
54
55 /* Store only the lower range.  Higher range is given by fw. */
56 struct enic_intr_mod_range {
57         u32 small_pkt_range_start;
58         u32 large_pkt_range_start;
59 };
60
61 struct enic_intr_mod_table {
62         u32 rx_rate;
63         u32 range_percent;
64 };
65
66 #define ENIC_MAX_LINK_SPEEDS            3
67 #define ENIC_LINK_SPEED_10G             10000
68 #define ENIC_LINK_SPEED_4G              4000
69 #define ENIC_LINK_40G_INDEX             2
70 #define ENIC_LINK_10G_INDEX             1
71 #define ENIC_LINK_4G_INDEX              0
72 #define ENIC_RX_COALESCE_RANGE_END      125
73 #define ENIC_AIC_TS_BREAK               100
74
75 struct enic_rx_coal {
76         u32 small_pkt_range_start;
77         u32 large_pkt_range_start;
78         u32 range_end;
79         u32 use_adaptive_rx_coalesce;
80 };
81
82 /* priv_flags */
83 #define ENIC_SRIOV_ENABLED              (1 << 0)
84
85 /* enic port profile set flags */
86 #define ENIC_PORT_REQUEST_APPLIED       (1 << 0)
87 #define ENIC_SET_REQUEST                (1 << 1)
88 #define ENIC_SET_NAME                   (1 << 2)
89 #define ENIC_SET_INSTANCE               (1 << 3)
90 #define ENIC_SET_HOST                   (1 << 4)
91
92 struct enic_port_profile {
93         u32 set;
94         u8 request;
95         char name[PORT_PROFILE_MAX];
96         u8 instance_uuid[PORT_UUID_MAX];
97         u8 host_uuid[PORT_UUID_MAX];
98         u8 vf_mac[ETH_ALEN];
99         u8 mac_addr[ETH_ALEN];
100 };
101
102 /* Per-instance private data structure */
103 struct enic {
104         struct net_device *netdev;
105         struct pci_dev *pdev;
106         struct vnic_enet_config config;
107         struct vnic_dev_bar bar[ENIC_BARS_MAX];
108         struct vnic_dev *vdev;
109         struct timer_list notify_timer;
110         struct work_struct reset;
111         struct work_struct change_mtu_work;
112         struct msix_entry msix_entry[ENIC_INTR_MAX];
113         struct enic_msix_entry msix[ENIC_INTR_MAX];
114         u32 msg_enable;
115         spinlock_t devcmd_lock;
116         u8 mac_addr[ETH_ALEN];
117         unsigned int flags;
118         unsigned int priv_flags;
119         unsigned int mc_count;
120         unsigned int uc_count;
121         u32 port_mtu;
122         struct enic_rx_coal rx_coalesce_setting;
123         u32 rx_coalesce_usecs;
124         u32 tx_coalesce_usecs;
125 #ifdef CONFIG_PCI_IOV
126         u16 num_vfs;
127 #endif
128         spinlock_t enic_api_lock;
129         struct enic_port_profile *pp;
130
131         /* work queue cache line section */
132         ____cacheline_aligned struct vnic_wq wq[ENIC_WQ_MAX];
133         spinlock_t wq_lock[ENIC_WQ_MAX];
134         unsigned int wq_count;
135         u16 loop_enable;
136         u16 loop_tag;
137
138         /* receive queue cache line section */
139         ____cacheline_aligned struct vnic_rq rq[ENIC_RQ_MAX];
140         unsigned int rq_count;
141         u64 rq_truncated_pkts;
142         u64 rq_bad_fcs;
143         struct napi_struct napi[ENIC_RQ_MAX];
144
145         /* interrupt resource cache line section */
146         ____cacheline_aligned struct vnic_intr intr[ENIC_INTR_MAX];
147         unsigned int intr_count;
148         u32 __iomem *legacy_pba;                /* memory-mapped */
149
150         /* completion queue cache line section */
151         ____cacheline_aligned struct vnic_cq cq[ENIC_CQ_MAX];
152         unsigned int cq_count;
153 };
154
155 static inline struct device *enic_get_dev(struct enic *enic)
156 {
157         return &(enic->pdev->dev);
158 }
159
160 static inline unsigned int enic_cq_rq(struct enic *enic, unsigned int rq)
161 {
162         return rq;
163 }
164
165 static inline unsigned int enic_cq_wq(struct enic *enic, unsigned int wq)
166 {
167         return enic->rq_count + wq;
168 }
169
170 static inline unsigned int enic_legacy_io_intr(void)
171 {
172         return 0;
173 }
174
175 static inline unsigned int enic_legacy_err_intr(void)
176 {
177         return 1;
178 }
179
180 static inline unsigned int enic_legacy_notify_intr(void)
181 {
182         return 2;
183 }
184
185 static inline unsigned int enic_msix_rq_intr(struct enic *enic,
186         unsigned int rq)
187 {
188         return enic->cq[enic_cq_rq(enic, rq)].interrupt_offset;
189 }
190
191 static inline unsigned int enic_msix_wq_intr(struct enic *enic,
192         unsigned int wq)
193 {
194         return enic->cq[enic_cq_wq(enic, wq)].interrupt_offset;
195 }
196
197 static inline unsigned int enic_msix_err_intr(struct enic *enic)
198 {
199         return enic->rq_count + enic->wq_count;
200 }
201
202 static inline unsigned int enic_msix_notify_intr(struct enic *enic)
203 {
204         return enic->rq_count + enic->wq_count + 1;
205 }
206
207 void enic_reset_addr_lists(struct enic *enic);
208 int enic_sriov_enabled(struct enic *enic);
209 int enic_is_valid_vf(struct enic *enic, int vf);
210 int enic_is_dynamic(struct enic *enic);
211 void enic_set_ethtool_ops(struct net_device *netdev);
212
213 #endif /* _ENIC_H_ */