Merge git://git.kernel.org/pub/scm/linux/kernel/git/hirofumi/fatfs-2.6
[pandora-kernel.git] / drivers / net / benet / be.h
1 /*
2  * Copyright (C) 2005 - 2010 ServerEngines
3  * All rights reserved.
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License version 2
7  * as published by the Free Software Foundation.  The full GNU General
8  * Public License is included in this distribution in the file called COPYING.
9  *
10  * Contact Information:
11  * linux-drivers@serverengines.com
12  *
13  * ServerEngines
14  * 209 N. Fair Oaks Ave
15  * Sunnyvale, CA 94085
16  */
17
18 #ifndef BE_H
19 #define BE_H
20
21 #include <linux/pci.h>
22 #include <linux/etherdevice.h>
23 #include <linux/version.h>
24 #include <linux/delay.h>
25 #include <net/tcp.h>
26 #include <net/ip.h>
27 #include <net/ipv6.h>
28 #include <linux/if_vlan.h>
29 #include <linux/workqueue.h>
30 #include <linux/interrupt.h>
31 #include <linux/firmware.h>
32 #include <linux/slab.h>
33
34 #include "be_hw.h"
35
36 #define DRV_VER                 "2.102.147u"
37 #define DRV_NAME                "be2net"
38 #define BE_NAME                 "ServerEngines BladeEngine2 10Gbps NIC"
39 #define BE3_NAME                "ServerEngines BladeEngine3 10Gbps NIC"
40 #define OC_NAME                 "Emulex OneConnect 10Gbps NIC"
41 #define OC_NAME1                "Emulex OneConnect 10Gbps NIC (be3)"
42 #define DRV_DESC                "ServerEngines BladeEngine 10Gbps NIC Driver"
43
44 #define BE_VENDOR_ID            0x19a2
45 #define BE_DEVICE_ID1           0x211
46 #define BE_DEVICE_ID2           0x221
47 #define OC_DEVICE_ID1           0x700
48 #define OC_DEVICE_ID2           0x710
49
50 static inline char *nic_name(struct pci_dev *pdev)
51 {
52         switch (pdev->device) {
53         case OC_DEVICE_ID1:
54                 return OC_NAME;
55         case OC_DEVICE_ID2:
56                 return OC_NAME1;
57         case BE_DEVICE_ID2:
58                 return BE3_NAME;
59         default:
60                 return BE_NAME;
61         }
62 }
63
64 /* Number of bytes of an RX frame that are copied to skb->data */
65 #define BE_HDR_LEN              64
66 #define BE_MAX_JUMBO_FRAME_SIZE 9018
67 #define BE_MIN_MTU              256
68
69 #define BE_NUM_VLANS_SUPPORTED  64
70 #define BE_MAX_EQD              96
71 #define BE_MAX_TX_FRAG_COUNT    30
72
73 #define EVNT_Q_LEN              1024
74 #define TX_Q_LEN                2048
75 #define TX_CQ_LEN               1024
76 #define RX_Q_LEN                1024    /* Does not support any other value */
77 #define RX_CQ_LEN               1024
78 #define MCC_Q_LEN               128     /* total size not to exceed 8 pages */
79 #define MCC_CQ_LEN              256
80
81 #define BE_NAPI_WEIGHT          64
82 #define MAX_RX_POST             BE_NAPI_WEIGHT /* Frags posted at a time */
83 #define RX_FRAGS_REFILL_WM      (RX_Q_LEN - MAX_RX_POST)
84
85 #define FW_VER_LEN              32
86
87 #define BE_MAX_VF               32
88
89 struct be_dma_mem {
90         void *va;
91         dma_addr_t dma;
92         u32 size;
93 };
94
95 struct be_queue_info {
96         struct be_dma_mem dma_mem;
97         u16 len;
98         u16 entry_size; /* Size of an element in the queue */
99         u16 id;
100         u16 tail, head;
101         bool created;
102         atomic_t used;  /* Number of valid elements in the queue */
103 };
104
105 static inline u32 MODULO(u16 val, u16 limit)
106 {
107         BUG_ON(limit & (limit - 1));
108         return val & (limit - 1);
109 }
110
111 static inline void index_adv(u16 *index, u16 val, u16 limit)
112 {
113         *index = MODULO((*index + val), limit);
114 }
115
116 static inline void index_inc(u16 *index, u16 limit)
117 {
118         *index = MODULO((*index + 1), limit);
119 }
120
121 static inline void *queue_head_node(struct be_queue_info *q)
122 {
123         return q->dma_mem.va + q->head * q->entry_size;
124 }
125
126 static inline void *queue_tail_node(struct be_queue_info *q)
127 {
128         return q->dma_mem.va + q->tail * q->entry_size;
129 }
130
131 static inline void queue_head_inc(struct be_queue_info *q)
132 {
133         index_inc(&q->head, q->len);
134 }
135
136 static inline void queue_tail_inc(struct be_queue_info *q)
137 {
138         index_inc(&q->tail, q->len);
139 }
140
141 struct be_eq_obj {
142         struct be_queue_info q;
143         char desc[32];
144
145         /* Adaptive interrupt coalescing (AIC) info */
146         bool enable_aic;
147         u16 min_eqd;            /* in usecs */
148         u16 max_eqd;            /* in usecs */
149         u16 cur_eqd;            /* in usecs */
150
151         struct napi_struct napi;
152 };
153
154 struct be_mcc_obj {
155         struct be_queue_info q;
156         struct be_queue_info cq;
157         bool rearm_cq;
158 };
159
160 struct be_drvr_stats {
161         u32 be_tx_reqs;         /* number of TX requests initiated */
162         u32 be_tx_stops;        /* number of times TX Q was stopped */
163         u32 be_fwd_reqs;        /* number of send reqs through forwarding i/f */
164         u32 be_tx_wrbs;         /* number of tx WRBs used */
165         u32 be_tx_events;       /* number of tx completion events  */
166         u32 be_tx_compl;        /* number of tx completion entries processed */
167         ulong be_tx_jiffies;
168         u64 be_tx_bytes;
169         u64 be_tx_bytes_prev;
170         u64 be_tx_pkts;
171         u32 be_tx_rate;
172
173         u32 cache_barrier[16];
174
175         u32 be_ethrx_post_fail;/* number of ethrx buffer alloc failures */
176         u32 be_rx_polls;        /* number of times NAPI called poll function */
177         u32 be_rx_events;       /* number of ucast rx completion events  */
178         u32 be_rx_compl;        /* number of rx completion entries processed */
179         ulong be_rx_jiffies;
180         u64 be_rx_bytes;
181         u64 be_rx_bytes_prev;
182         u64 be_rx_pkts;
183         u32 be_rx_rate;
184         /* number of non ether type II frames dropped where
185          * frame len > length field of Mac Hdr */
186         u32 be_802_3_dropped_frames;
187         /* number of non ether type II frames malformed where
188          * in frame len < length field of Mac Hdr */
189         u32 be_802_3_malformed_frames;
190         u32 be_rxcp_err;        /* Num rx completion entries w/ err set. */
191         ulong rx_fps_jiffies;   /* jiffies at last FPS calc */
192         u32 be_rx_frags;
193         u32 be_prev_rx_frags;
194         u32 be_rx_fps;          /* Rx frags per second */
195 };
196
197 struct be_stats_obj {
198         struct be_drvr_stats drvr_stats;
199         struct be_dma_mem cmd;
200 };
201
202 struct be_tx_obj {
203         struct be_queue_info q;
204         struct be_queue_info cq;
205         /* Remember the skbs that were transmitted */
206         struct sk_buff *sent_skb_list[TX_Q_LEN];
207 };
208
209 /* Struct to remember the pages posted for rx frags */
210 struct be_rx_page_info {
211         struct page *page;
212         DEFINE_DMA_UNMAP_ADDR(bus);
213         u16 page_offset;
214         bool last_page_user;
215 };
216
217 struct be_rx_obj {
218         struct be_queue_info q;
219         struct be_queue_info cq;
220         struct be_rx_page_info page_info_tbl[RX_Q_LEN];
221 };
222
223 #define BE_NUM_MSIX_VECTORS             2       /* 1 each for Tx and Rx */
224 struct be_adapter {
225         struct pci_dev *pdev;
226         struct net_device *netdev;
227
228         u8 __iomem *csr;
229         u8 __iomem *db;         /* Door Bell */
230         u8 __iomem *pcicfg;     /* PCI config space */
231
232         spinlock_t mbox_lock;   /* For serializing mbox cmds to BE card */
233         struct be_dma_mem mbox_mem;
234         /* Mbox mem is adjusted to align to 16 bytes. The allocated addr
235          * is stored for freeing purpose */
236         struct be_dma_mem mbox_mem_alloced;
237
238         struct be_mcc_obj mcc_obj;
239         spinlock_t mcc_lock;    /* For serializing mcc cmds to BE card */
240         spinlock_t mcc_cq_lock;
241
242         struct msix_entry msix_entries[BE_NUM_MSIX_VECTORS];
243         bool msix_enabled;
244         bool isr_registered;
245
246         /* TX Rings */
247         struct be_eq_obj tx_eq;
248         struct be_tx_obj tx_obj;
249
250         u32 cache_line_break[8];
251
252         /* Rx rings */
253         struct be_eq_obj rx_eq;
254         struct be_rx_obj rx_obj;
255         u32 big_page_size;      /* Compounded page size shared by rx wrbs */
256         bool rx_post_starved;   /* Zero rx frags have been posted to BE */
257
258         struct vlan_group *vlan_grp;
259         u16 vlans_added;
260         u16 max_vlans;  /* Number of vlans supported */
261         u8 vlan_tag[VLAN_GROUP_ARRAY_LEN];
262         struct be_dma_mem mc_cmd_mem;
263
264         struct be_stats_obj stats;
265         /* Work queue used to perform periodic tasks like getting statistics */
266         struct delayed_work work;
267
268         /* Ethtool knobs and info */
269         bool rx_csum;           /* BE card must perform rx-checksumming */
270         char fw_ver[FW_VER_LEN];
271         u32 if_handle;          /* Used to configure filtering */
272         u32 pmac_id;            /* MAC addr handle used by BE card */
273
274         bool eeh_err;
275         bool link_up;
276         u32 port_num;
277         bool promiscuous;
278         bool wol;
279         u32 cap;
280         u32 rx_fc;              /* Rx flow control */
281         u32 tx_fc;              /* Tx flow control */
282         int link_speed;
283         u8 port_type;
284         u8 transceiver;
285         u8 generation;          /* BladeEngine ASIC generation */
286
287         bool sriov_enabled;
288         u32 vf_if_handle[BE_MAX_VF];
289         u32 vf_pmac_id[BE_MAX_VF];
290         u8 base_eq_id;
291 };
292
293 #define be_physfn(adapter) (!adapter->pdev->is_virtfn)
294
295 /* BladeEngine Generation numbers */
296 #define BE_GEN2 2
297 #define BE_GEN3 3
298
299 extern const struct ethtool_ops be_ethtool_ops;
300
301 #define drvr_stats(adapter)             (&adapter->stats.drvr_stats)
302
303 #define BE_SET_NETDEV_OPS(netdev, ops)  (netdev->netdev_ops = ops)
304
305 #define PAGE_SHIFT_4K           12
306 #define PAGE_SIZE_4K            (1 << PAGE_SHIFT_4K)
307
308 /* Returns number of pages spanned by the data starting at the given addr */
309 #define PAGES_4K_SPANNED(_address, size)                                \
310                 ((u32)((((size_t)(_address) & (PAGE_SIZE_4K - 1)) +     \
311                         (size) + (PAGE_SIZE_4K - 1)) >> PAGE_SHIFT_4K))
312
313 /* Byte offset into the page corresponding to given address */
314 #define OFFSET_IN_PAGE(addr)                                            \
315                  ((size_t)(addr) & (PAGE_SIZE_4K-1))
316
317 /* Returns bit offset within a DWORD of a bitfield */
318 #define AMAP_BIT_OFFSET(_struct, field)                                 \
319                 (((size_t)&(((_struct *)0)->field))%32)
320
321 /* Returns the bit mask of the field that is NOT shifted into location. */
322 static inline u32 amap_mask(u32 bitsize)
323 {
324         return (bitsize == 32 ? 0xFFFFFFFF : (1 << bitsize) - 1);
325 }
326
327 static inline void
328 amap_set(void *ptr, u32 dw_offset, u32 mask, u32 offset, u32 value)
329 {
330         u32 *dw = (u32 *) ptr + dw_offset;
331         *dw &= ~(mask << offset);
332         *dw |= (mask & value) << offset;
333 }
334
335 #define AMAP_SET_BITS(_struct, field, ptr, val)                         \
336                 amap_set(ptr,                                           \
337                         offsetof(_struct, field)/32,                    \
338                         amap_mask(sizeof(((_struct *)0)->field)),       \
339                         AMAP_BIT_OFFSET(_struct, field),                \
340                         val)
341
342 static inline u32 amap_get(void *ptr, u32 dw_offset, u32 mask, u32 offset)
343 {
344         u32 *dw = (u32 *) ptr;
345         return mask & (*(dw + dw_offset) >> offset);
346 }
347
348 #define AMAP_GET_BITS(_struct, field, ptr)                              \
349                 amap_get(ptr,                                           \
350                         offsetof(_struct, field)/32,                    \
351                         amap_mask(sizeof(((_struct *)0)->field)),       \
352                         AMAP_BIT_OFFSET(_struct, field))
353
354 #define be_dws_cpu_to_le(wrb, len)      swap_dws(wrb, len)
355 #define be_dws_le_to_cpu(wrb, len)      swap_dws(wrb, len)
356 static inline void swap_dws(void *wrb, int len)
357 {
358 #ifdef __BIG_ENDIAN
359         u32 *dw = wrb;
360         BUG_ON(len % 4);
361         do {
362                 *dw = cpu_to_le32(*dw);
363                 dw++;
364                 len -= 4;
365         } while (len);
366 #endif                          /* __BIG_ENDIAN */
367 }
368
369 static inline u8 is_tcp_pkt(struct sk_buff *skb)
370 {
371         u8 val = 0;
372
373         if (ip_hdr(skb)->version == 4)
374                 val = (ip_hdr(skb)->protocol == IPPROTO_TCP);
375         else if (ip_hdr(skb)->version == 6)
376                 val = (ipv6_hdr(skb)->nexthdr == NEXTHDR_TCP);
377
378         return val;
379 }
380
381 static inline u8 is_udp_pkt(struct sk_buff *skb)
382 {
383         u8 val = 0;
384
385         if (ip_hdr(skb)->version == 4)
386                 val = (ip_hdr(skb)->protocol == IPPROTO_UDP);
387         else if (ip_hdr(skb)->version == 6)
388                 val = (ipv6_hdr(skb)->nexthdr == NEXTHDR_UDP);
389
390         return val;
391 }
392
393 extern void be_cq_notify(struct be_adapter *adapter, u16 qid, bool arm,
394                 u16 num_popped);
395 extern void be_link_status_update(struct be_adapter *adapter, bool link_up);
396 extern void netdev_stats_update(struct be_adapter *adapter);
397 extern int be_load_fw(struct be_adapter *adapter, u8 *func);
398 #endif                          /* BE_H */