Merge branch 'master' of master.kernel.org:/pub/scm/linux/kernel/git/davem/net-2.6
[linux-2.6.git] / drivers / net / ixgbe / ixgbe.h
1 /*******************************************************************************
2
3   Intel 10 Gigabit PCI Express Linux driver
4   Copyright(c) 1999 - 2010 Intel Corporation.
5
6   This program is free software; you can redistribute it and/or modify it
7   under the terms and conditions of the GNU General Public License,
8   version 2, as published by the Free Software Foundation.
9
10   This program is distributed in the hope it will be useful, but WITHOUT
11   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
13   more details.
14
15   You should have received a copy of the GNU General Public License along with
16   this program; if not, write to the Free Software Foundation, Inc.,
17   51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
18
19   The full GNU General Public License is included in this distribution in
20   the file called "COPYING".
21
22   Contact Information:
23   e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
24   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
25
26 *******************************************************************************/
27
28 #ifndef _IXGBE_H_
29 #define _IXGBE_H_
30
31 #include <linux/types.h>
32 #include <linux/pci.h>
33 #include <linux/netdevice.h>
34 #include <linux/aer.h>
35
36 #include "ixgbe_type.h"
37 #include "ixgbe_common.h"
38 #include "ixgbe_dcb.h"
39 #if defined(CONFIG_FCOE) || defined(CONFIG_FCOE_MODULE)
40 #define IXGBE_FCOE
41 #include "ixgbe_fcoe.h"
42 #endif /* CONFIG_FCOE or CONFIG_FCOE_MODULE */
43 #ifdef CONFIG_IXGBE_DCA
44 #include <linux/dca.h>
45 #endif
46
47 #define PFX "ixgbe: "
48 #define DPRINTK(nlevel, klevel, fmt, args...) \
49         ((void)((NETIF_MSG_##nlevel & adapter->msg_enable) && \
50         printk(KERN_##klevel PFX "%s: %s: " fmt, adapter->netdev->name, \
51                 __func__ , ## args)))
52
53 /* TX/RX descriptor defines */
54 #define IXGBE_DEFAULT_TXD                   512
55 #define IXGBE_MAX_TXD                      4096
56 #define IXGBE_MIN_TXD                        64
57
58 #define IXGBE_DEFAULT_RXD                   512
59 #define IXGBE_MAX_RXD                      4096
60 #define IXGBE_MIN_RXD                        64
61
62 /* flow control */
63 #define IXGBE_DEFAULT_FCRTL             0x10000
64 #define IXGBE_MIN_FCRTL                    0x40
65 #define IXGBE_MAX_FCRTL                 0x7FF80
66 #define IXGBE_DEFAULT_FCRTH             0x20000
67 #define IXGBE_MIN_FCRTH                   0x600
68 #define IXGBE_MAX_FCRTH                 0x7FFF0
69 #define IXGBE_DEFAULT_FCPAUSE            0xFFFF
70 #define IXGBE_MIN_FCPAUSE                     0
71 #define IXGBE_MAX_FCPAUSE                0xFFFF
72
73 /* Supported Rx Buffer Sizes */
74 #define IXGBE_RXBUFFER_64    64     /* Used for packet split */
75 #define IXGBE_RXBUFFER_128   128    /* Used for packet split */
76 #define IXGBE_RXBUFFER_256   256    /* Used for packet split */
77 #define IXGBE_RXBUFFER_2048  2048
78 #define IXGBE_RXBUFFER_4096  4096
79 #define IXGBE_RXBUFFER_8192  8192
80 #define IXGBE_MAX_RXBUFFER   16384  /* largest size for a single descriptor */
81
82 #define IXGBE_RX_HDR_SIZE IXGBE_RXBUFFER_256
83
84 #define MAXIMUM_ETHERNET_VLAN_SIZE (ETH_FRAME_LEN + ETH_FCS_LEN + VLAN_HLEN)
85
86 /* How many Rx Buffers do we bundle into one write to the hardware ? */
87 #define IXGBE_RX_BUFFER_WRITE   16      /* Must be power of 2 */
88
89 #define IXGBE_TX_FLAGS_CSUM             (u32)(1)
90 #define IXGBE_TX_FLAGS_VLAN             (u32)(1 << 1)
91 #define IXGBE_TX_FLAGS_TSO              (u32)(1 << 2)
92 #define IXGBE_TX_FLAGS_IPV4             (u32)(1 << 3)
93 #define IXGBE_TX_FLAGS_FCOE             (u32)(1 << 4)
94 #define IXGBE_TX_FLAGS_FSO              (u32)(1 << 5)
95 #define IXGBE_TX_FLAGS_VLAN_MASK        0xffff0000
96 #define IXGBE_TX_FLAGS_VLAN_PRIO_MASK   0x0000e000
97 #define IXGBE_TX_FLAGS_VLAN_SHIFT       16
98
99 #define IXGBE_MAX_RSC_INT_RATE          162760
100
101 #define IXGBE_MAX_VF_MC_ENTRIES         30
102 #define IXGBE_MAX_VF_FUNCTIONS          64
103 #define IXGBE_MAX_VFTA_ENTRIES          128
104 #define MAX_EMULATION_MAC_ADDRS         16
105 #define VMDQ_P(p)   ((p) + adapter->num_vfs)
106
107 struct vf_data_storage {
108         unsigned char vf_mac_addresses[ETH_ALEN];
109         u16 vf_mc_hashes[IXGBE_MAX_VF_MC_ENTRIES];
110         u16 num_vf_mc_hashes;
111         u16 default_vf_vlan_id;
112         u16 vlans_enabled;
113         unsigned char em_mac_addresses[MAX_EMULATION_MAC_ADDRS * ETH_ALEN];
114         bool clear_to_send;
115         int rar;
116 };
117
118 /* wrapper around a pointer to a socket buffer,
119  * so a DMA handle can be stored along with the buffer */
120 struct ixgbe_tx_buffer {
121         struct sk_buff *skb;
122         dma_addr_t dma;
123         unsigned long time_stamp;
124         u16 length;
125         u16 next_to_watch;
126         u16 mapped_as_page;
127 };
128
129 struct ixgbe_rx_buffer {
130         struct sk_buff *skb;
131         dma_addr_t dma;
132         struct page *page;
133         dma_addr_t page_dma;
134         unsigned int page_offset;
135 };
136
137 struct ixgbe_queue_stats {
138         u64 packets;
139         u64 bytes;
140 };
141
142 struct ixgbe_ring {
143         void *desc;                     /* descriptor ring memory */
144         union {
145                 struct ixgbe_tx_buffer *tx_buffer_info;
146                 struct ixgbe_rx_buffer *rx_buffer_info;
147         };
148         u8 atr_sample_rate;
149         u8 atr_count;
150         u16 count;                      /* amount of descriptors */
151         u16 rx_buf_len;
152         u16 next_to_use;
153         u16 next_to_clean;
154
155         u8 queue_index; /* needed for multiqueue queue management */
156
157 #define IXGBE_RING_RX_PS_ENABLED                (u8)(1)
158         u8 flags;                       /* per ring feature flags */
159         u16 head;
160         u16 tail;
161
162         unsigned int total_bytes;
163         unsigned int total_packets;
164
165 #ifdef CONFIG_IXGBE_DCA
166         /* cpu for tx queue */
167         int cpu;
168 #endif
169
170         u16 work_limit;                 /* max work per interrupt */
171         u16 reg_idx;                    /* holds the special value that gets
172                                          * the hardware register offset
173                                          * associated with this ring, which is
174                                          * different for DCB and RSS modes
175                                          */
176
177         struct ixgbe_queue_stats stats;
178         unsigned long reinit_state;
179         u64 rsc_count;                  /* stat for coalesced packets */
180         u64 rsc_flush;                  /* stats for flushed packets */
181         u32 restart_queue;              /* track tx queue restarts */
182         u32 non_eop_descs;              /* track hardware descriptor chaining */
183
184         unsigned int size;              /* length in bytes */
185         dma_addr_t dma;                 /* phys. address of descriptor ring */
186 } ____cacheline_internodealigned_in_smp;
187
188 enum ixgbe_ring_f_enum {
189         RING_F_NONE = 0,
190         RING_F_DCB,
191         RING_F_VMDQ,  /* SR-IOV uses the same ring feature */
192         RING_F_RSS,
193         RING_F_FDIR,
194 #ifdef IXGBE_FCOE
195         RING_F_FCOE,
196 #endif /* IXGBE_FCOE */
197
198         RING_F_ARRAY_SIZE      /* must be last in enum set */
199 };
200
201 #define IXGBE_MAX_DCB_INDICES   8
202 #define IXGBE_MAX_RSS_INDICES  16
203 #define IXGBE_MAX_VMDQ_INDICES 64
204 #define IXGBE_MAX_FDIR_INDICES 64
205 #ifdef IXGBE_FCOE
206 #define IXGBE_MAX_FCOE_INDICES  8
207 #endif /* IXGBE_FCOE */
208 struct ixgbe_ring_feature {
209         int indices;
210         int mask;
211 } ____cacheline_internodealigned_in_smp;
212
213 #define MAX_RX_QUEUES 128
214 #define MAX_TX_QUEUES 128
215
216 #define MAX_RX_PACKET_BUFFERS ((adapter->flags & IXGBE_FLAG_DCB_ENABLED) \
217                               ? 8 : 1)
218 #define MAX_TX_PACKET_BUFFERS MAX_RX_PACKET_BUFFERS
219
220 /* MAX_MSIX_Q_VECTORS of these are allocated,
221  * but we only use one per queue-specific vector.
222  */
223 struct ixgbe_q_vector {
224         struct ixgbe_adapter *adapter;
225         unsigned int v_idx; /* index of q_vector within array, also used for
226                              * finding the bit in EICR and friends that
227                              * represents the vector for this ring */
228         struct napi_struct napi;
229         DECLARE_BITMAP(rxr_idx, MAX_RX_QUEUES); /* Rx ring indices */
230         DECLARE_BITMAP(txr_idx, MAX_TX_QUEUES); /* Tx ring indices */
231         u8 rxr_count;     /* Rx ring count assigned to this vector */
232         u8 txr_count;     /* Tx ring count assigned to this vector */
233         u8 tx_itr;
234         u8 rx_itr;
235         u32 eitr;
236 };
237
238 /* Helper macros to switch between ints/sec and what the register uses.
239  * And yes, it's the same math going both ways.  The lowest value
240  * supported by all of the ixgbe hardware is 8.
241  */
242 #define EITR_INTS_PER_SEC_TO_REG(_eitr) \
243         ((_eitr) ? (1000000000 / ((_eitr) * 256)) : 8)
244 #define EITR_REG_TO_INTS_PER_SEC EITR_INTS_PER_SEC_TO_REG
245
246 #define IXGBE_DESC_UNUSED(R) \
247         ((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
248         (R)->next_to_clean - (R)->next_to_use - 1)
249
250 #define IXGBE_RX_DESC_ADV(R, i)     \
251         (&(((union ixgbe_adv_rx_desc *)((R).desc))[i]))
252 #define IXGBE_TX_DESC_ADV(R, i)     \
253         (&(((union ixgbe_adv_tx_desc *)((R).desc))[i]))
254 #define IXGBE_TX_CTXTDESC_ADV(R, i)         \
255         (&(((struct ixgbe_adv_tx_context_desc *)((R).desc))[i]))
256
257 #define IXGBE_MAX_JUMBO_FRAME_SIZE        16128
258 #ifdef IXGBE_FCOE
259 /* Use 3K as the baby jumbo frame size for FCoE */
260 #define IXGBE_FCOE_JUMBO_FRAME_SIZE       3072
261 #endif /* IXGBE_FCOE */
262
263 #define OTHER_VECTOR 1
264 #define NON_Q_VECTORS (OTHER_VECTOR)
265
266 #define MAX_MSIX_VECTORS_82599 64
267 #define MAX_MSIX_Q_VECTORS_82599 64
268 #define MAX_MSIX_VECTORS_82598 18
269 #define MAX_MSIX_Q_VECTORS_82598 16
270
271 #define MAX_MSIX_Q_VECTORS MAX_MSIX_Q_VECTORS_82599
272 #define MAX_MSIX_COUNT MAX_MSIX_VECTORS_82599
273
274 #define MIN_MSIX_Q_VECTORS 2
275 #define MIN_MSIX_COUNT (MIN_MSIX_Q_VECTORS + NON_Q_VECTORS)
276
277 /* board specific private data structure */
278 struct ixgbe_adapter {
279         struct timer_list watchdog_timer;
280         struct vlan_group *vlgrp;
281         u16 bd_number;
282         struct work_struct reset_task;
283         struct ixgbe_q_vector *q_vector[MAX_MSIX_Q_VECTORS];
284         char name[MAX_MSIX_COUNT][IFNAMSIZ + 9];
285         struct ixgbe_dcb_config dcb_cfg;
286         struct ixgbe_dcb_config temp_dcb_cfg;
287         u8 dcb_set_bitmap;
288         enum ixgbe_fc_mode last_lfc_mode;
289
290         /* Interrupt Throttle Rate */
291         u32 rx_itr_setting;
292         u32 tx_itr_setting;
293         u16 eitr_low;
294         u16 eitr_high;
295
296         /* TX */
297         struct ixgbe_ring *tx_ring ____cacheline_aligned_in_smp; /* One per active queue */
298         int num_tx_queues;
299         u32 tx_timeout_count;
300         bool detect_tx_hung;
301
302         u64 restart_queue;
303         u64 lsc_int;
304
305         /* RX */
306         struct ixgbe_ring *rx_ring ____cacheline_aligned_in_smp; /* One per active queue */
307         int num_rx_queues;
308         int num_rx_pools;               /* == num_rx_queues in 82598 */
309         int num_rx_queues_per_pool;     /* 1 if 82598, can be many if 82599 */
310         u64 hw_csum_rx_error;
311         u64 hw_rx_no_dma_resources;
312         u64 non_eop_descs;
313         int num_msix_vectors;
314         int max_msix_q_vectors;         /* true count of q_vectors for device */
315         struct ixgbe_ring_feature ring_feature[RING_F_ARRAY_SIZE];
316         struct msix_entry *msix_entries;
317
318         u32 alloc_rx_page_failed;
319         u32 alloc_rx_buff_failed;
320
321         /* Some features need tri-state capability,
322          * thus the additional *_CAPABLE flags.
323          */
324         u32 flags;
325 #define IXGBE_FLAG_RX_CSUM_ENABLED              (u32)(1)
326 #define IXGBE_FLAG_MSI_CAPABLE                  (u32)(1 << 1)
327 #define IXGBE_FLAG_MSI_ENABLED                  (u32)(1 << 2)
328 #define IXGBE_FLAG_MSIX_CAPABLE                 (u32)(1 << 3)
329 #define IXGBE_FLAG_MSIX_ENABLED                 (u32)(1 << 4)
330 #define IXGBE_FLAG_RX_1BUF_CAPABLE              (u32)(1 << 6)
331 #define IXGBE_FLAG_RX_PS_CAPABLE                (u32)(1 << 7)
332 #define IXGBE_FLAG_RX_PS_ENABLED                (u32)(1 << 8)
333 #define IXGBE_FLAG_IN_NETPOLL                   (u32)(1 << 9)
334 #define IXGBE_FLAG_DCA_ENABLED                  (u32)(1 << 10)
335 #define IXGBE_FLAG_DCA_CAPABLE                  (u32)(1 << 11)
336 #define IXGBE_FLAG_IMIR_ENABLED                 (u32)(1 << 12)
337 #define IXGBE_FLAG_MQ_CAPABLE                   (u32)(1 << 13)
338 #define IXGBE_FLAG_DCB_ENABLED                  (u32)(1 << 14)
339 #define IXGBE_FLAG_RSS_ENABLED                  (u32)(1 << 16)
340 #define IXGBE_FLAG_RSS_CAPABLE                  (u32)(1 << 17)
341 #define IXGBE_FLAG_VMDQ_CAPABLE                 (u32)(1 << 18)
342 #define IXGBE_FLAG_VMDQ_ENABLED                 (u32)(1 << 19)
343 #define IXGBE_FLAG_FAN_FAIL_CAPABLE             (u32)(1 << 20)
344 #define IXGBE_FLAG_NEED_LINK_UPDATE             (u32)(1 << 22)
345 #define IXGBE_FLAG_IN_WATCHDOG_TASK             (u32)(1 << 23)
346 #define IXGBE_FLAG_IN_SFP_LINK_TASK             (u32)(1 << 24)
347 #define IXGBE_FLAG_IN_SFP_MOD_TASK              (u32)(1 << 25)
348 #define IXGBE_FLAG_FDIR_HASH_CAPABLE            (u32)(1 << 26)
349 #define IXGBE_FLAG_FDIR_PERFECT_CAPABLE         (u32)(1 << 27)
350 #define IXGBE_FLAG_FCOE_CAPABLE                 (u32)(1 << 28)
351 #define IXGBE_FLAG_FCOE_ENABLED                 (u32)(1 << 29)
352 #define IXGBE_FLAG_SRIOV_CAPABLE                (u32)(1 << 30)
353 #define IXGBE_FLAG_SRIOV_ENABLED                (u32)(1 << 31)
354
355         u32 flags2;
356 #define IXGBE_FLAG2_RSC_CAPABLE                 (u32)(1)
357 #define IXGBE_FLAG2_RSC_ENABLED                 (u32)(1 << 1)
358 /* default to trying for four seconds */
359 #define IXGBE_TRY_LINK_TIMEOUT (4 * HZ)
360
361         /* OS defined structs */
362         struct net_device *netdev;
363         struct pci_dev *pdev;
364
365         u32 test_icr;
366         struct ixgbe_ring test_tx_ring;
367         struct ixgbe_ring test_rx_ring;
368
369         /* structs defined in ixgbe_hw.h */
370         struct ixgbe_hw hw;
371         u16 msg_enable;
372         struct ixgbe_hw_stats stats;
373
374         /* Interrupt Throttle Rate */
375         u32 rx_eitr_param;
376         u32 tx_eitr_param;
377
378         unsigned long state;
379         u64 tx_busy;
380         unsigned int tx_ring_count;
381         unsigned int rx_ring_count;
382
383         u32 link_speed;
384         bool link_up;
385         unsigned long link_check_timeout;
386
387         struct work_struct watchdog_task;
388         struct work_struct sfp_task;
389         struct timer_list sfp_timer;
390         struct work_struct multispeed_fiber_task;
391         struct work_struct sfp_config_module_task;
392         u32 fdir_pballoc;
393         u32 atr_sample_rate;
394         spinlock_t fdir_perfect_lock;
395         struct work_struct fdir_reinit_task;
396 #ifdef IXGBE_FCOE
397         struct ixgbe_fcoe fcoe;
398 #endif /* IXGBE_FCOE */
399         u64 rsc_total_count;
400         u64 rsc_total_flush;
401         u32 wol;
402         u16 eeprom_version;
403
404         /* SR-IOV */
405         DECLARE_BITMAP(active_vfs, IXGBE_MAX_VF_FUNCTIONS);
406         unsigned int num_vfs;
407         struct vf_data_storage *vfinfo;
408 };
409
410 enum ixbge_state_t {
411         __IXGBE_TESTING,
412         __IXGBE_RESETTING,
413         __IXGBE_DOWN,
414         __IXGBE_FDIR_INIT_DONE,
415         __IXGBE_SFP_MODULE_NOT_FOUND
416 };
417
418 enum ixgbe_boards {
419         board_82598,
420         board_82599,
421 };
422
423 extern struct ixgbe_info ixgbe_82598_info;
424 extern struct ixgbe_info ixgbe_82599_info;
425 #ifdef CONFIG_IXGBE_DCB
426 extern const struct dcbnl_rtnl_ops dcbnl_ops;
427 extern int ixgbe_copy_dcb_cfg(struct ixgbe_dcb_config *src_dcb_cfg,
428                               struct ixgbe_dcb_config *dst_dcb_cfg,
429                               int tc_max);
430 #endif
431
432 extern char ixgbe_driver_name[];
433 extern const char ixgbe_driver_version[];
434
435 extern int ixgbe_up(struct ixgbe_adapter *adapter);
436 extern void ixgbe_down(struct ixgbe_adapter *adapter);
437 extern void ixgbe_reinit_locked(struct ixgbe_adapter *adapter);
438 extern void ixgbe_reset(struct ixgbe_adapter *adapter);
439 extern void ixgbe_set_ethtool_ops(struct net_device *netdev);
440 extern int ixgbe_setup_rx_resources(struct ixgbe_adapter *, struct ixgbe_ring *);
441 extern int ixgbe_setup_tx_resources(struct ixgbe_adapter *, struct ixgbe_ring *);
442 extern void ixgbe_free_rx_resources(struct ixgbe_adapter *, struct ixgbe_ring *);
443 extern void ixgbe_free_tx_resources(struct ixgbe_adapter *, struct ixgbe_ring *);
444 extern void ixgbe_update_stats(struct ixgbe_adapter *adapter);
445 extern int ixgbe_init_interrupt_scheme(struct ixgbe_adapter *adapter);
446 extern void ixgbe_clear_interrupt_scheme(struct ixgbe_adapter *adapter);
447 extern void ixgbe_write_eitr(struct ixgbe_q_vector *);
448 extern int ethtool_ioctl(struct ifreq *ifr);
449 extern s32 ixgbe_reinit_fdir_tables_82599(struct ixgbe_hw *hw);
450 extern s32 ixgbe_init_fdir_signature_82599(struct ixgbe_hw *hw, u32 pballoc);
451 extern s32 ixgbe_init_fdir_perfect_82599(struct ixgbe_hw *hw, u32 pballoc);
452 extern s32 ixgbe_fdir_add_signature_filter_82599(struct ixgbe_hw *hw,
453                                                  struct ixgbe_atr_input *input,
454                                                  u8 queue);
455 extern s32 ixgbe_atr_set_vlan_id_82599(struct ixgbe_atr_input *input,
456                                        u16 vlan_id);
457 extern s32 ixgbe_atr_set_src_ipv4_82599(struct ixgbe_atr_input *input,
458                                         u32 src_addr);
459 extern s32 ixgbe_atr_set_dst_ipv4_82599(struct ixgbe_atr_input *input,
460                                         u32 dst_addr);
461 extern s32 ixgbe_atr_set_src_port_82599(struct ixgbe_atr_input *input,
462                                         u16 src_port);
463 extern s32 ixgbe_atr_set_dst_port_82599(struct ixgbe_atr_input *input,
464                                         u16 dst_port);
465 extern s32 ixgbe_atr_set_flex_byte_82599(struct ixgbe_atr_input *input,
466                                          u16 flex_byte);
467 extern s32 ixgbe_atr_set_l4type_82599(struct ixgbe_atr_input *input,
468                                       u8 l4type);
469 extern void ixgbe_set_rx_mode(struct net_device *netdev);
470 #ifdef IXGBE_FCOE
471 extern void ixgbe_configure_fcoe(struct ixgbe_adapter *adapter);
472 extern int ixgbe_fso(struct ixgbe_adapter *adapter,
473                      struct ixgbe_ring *tx_ring, struct sk_buff *skb,
474                      u32 tx_flags, u8 *hdr_len);
475 extern void ixgbe_cleanup_fcoe(struct ixgbe_adapter *adapter);
476 extern int ixgbe_fcoe_ddp(struct ixgbe_adapter *adapter,
477                           union ixgbe_adv_rx_desc *rx_desc,
478                           struct sk_buff *skb);
479 extern int ixgbe_fcoe_ddp_get(struct net_device *netdev, u16 xid,
480                               struct scatterlist *sgl, unsigned int sgc);
481 extern int ixgbe_fcoe_ddp_put(struct net_device *netdev, u16 xid);
482 extern int ixgbe_fcoe_enable(struct net_device *netdev);
483 extern int ixgbe_fcoe_disable(struct net_device *netdev);
484 #ifdef CONFIG_IXGBE_DCB
485 extern u8 ixgbe_fcoe_getapp(struct ixgbe_adapter *adapter);
486 extern u8 ixgbe_fcoe_setapp(struct ixgbe_adapter *adapter, u8 up);
487 #endif /* CONFIG_IXGBE_DCB */
488 extern int ixgbe_fcoe_get_wwn(struct net_device *netdev, u64 *wwn, int type);
489 #endif /* IXGBE_FCOE */
490
491 #endif /* _IXGBE_H_ */