ixgbe: Introduce MSI-X queue vector code
[safe/jmp/linux-2.6] / drivers / net / ixgbe / ixgbe.h
1 /*******************************************************************************
2
3   Intel 10 Gigabit PCI Express Linux driver
4   Copyright(c) 1999 - 2007 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   Linux NICS <linux.nics@intel.com>
24   e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
25   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
26
27 *******************************************************************************/
28
29 #ifndef _IXGBE_H_
30 #define _IXGBE_H_
31
32 #include <linux/types.h>
33 #include <linux/pci.h>
34 #include <linux/netdevice.h>
35
36 #include "ixgbe_type.h"
37 #include "ixgbe_common.h"
38
39
40 #define IXGBE_ERR(args...) printk(KERN_ERR "ixgbe: " args)
41
42 #define PFX "ixgbe: "
43 #define DPRINTK(nlevel, klevel, fmt, args...) \
44         ((void)((NETIF_MSG_##nlevel & adapter->msg_enable) && \
45         printk(KERN_##klevel PFX "%s: %s: " fmt, adapter->netdev->name, \
46                 __FUNCTION__ , ## args)))
47
48 /* TX/RX descriptor defines */
49 #define IXGBE_DEFAULT_TXD                  1024
50 #define IXGBE_MAX_TXD                      4096
51 #define IXGBE_MIN_TXD                        64
52
53 #define IXGBE_DEFAULT_RXD                  1024
54 #define IXGBE_MAX_RXD                      4096
55 #define IXGBE_MIN_RXD                        64
56
57 #define IXGBE_DEFAULT_RXQ                          1
58 #define IXGBE_MAX_RXQ                              1
59 #define IXGBE_MIN_RXQ                              1
60
61 #define IXGBE_DEFAULT_ITR_RX_USECS          125  /*   8k irqs/sec */
62 #define IXGBE_DEFAULT_ITR_TX_USECS          250  /*   4k irqs/sec */
63 #define IXGBE_MIN_ITR_USECS                 100  /* 500k irqs/sec */
64 #define IXGBE_MAX_ITR_USECS               10000  /* 100  irqs/sec */
65
66 /* flow control */
67 #define IXGBE_DEFAULT_FCRTL             0x10000
68 #define IXGBE_MIN_FCRTL                       0
69 #define IXGBE_MAX_FCRTL                 0x7FF80
70 #define IXGBE_DEFAULT_FCRTH             0x20000
71 #define IXGBE_MIN_FCRTH                       0
72 #define IXGBE_MAX_FCRTH                 0x7FFF0
73 #define IXGBE_DEFAULT_FCPAUSE            0x6800  /* may be too long */
74 #define IXGBE_MIN_FCPAUSE                     0
75 #define IXGBE_MAX_FCPAUSE                0xFFFF
76
77 /* Supported Rx Buffer Sizes */
78 #define IXGBE_RXBUFFER_64    64     /* Used for packet split */
79 #define IXGBE_RXBUFFER_128   128    /* Used for packet split */
80 #define IXGBE_RXBUFFER_256   256    /* Used for packet split */
81 #define IXGBE_RXBUFFER_2048  2048
82
83 #define IXGBE_RX_HDR_SIZE IXGBE_RXBUFFER_256
84
85 #define MAXIMUM_ETHERNET_VLAN_SIZE (ETH_FRAME_LEN + ETH_FCS_LEN + VLAN_HLEN)
86
87 /* How many Tx Descriptors do we need to call netif_wake_queue? */
88 #define IXGBE_TX_QUEUE_WAKE 16
89
90 /* How many Rx Buffers do we bundle into one write to the hardware ? */
91 #define IXGBE_RX_BUFFER_WRITE   16      /* Must be power of 2 */
92
93 #define IXGBE_TX_FLAGS_CSUM             (u32)(1)
94 #define IXGBE_TX_FLAGS_VLAN             (u32)(1 << 1)
95 #define IXGBE_TX_FLAGS_TSO              (u32)(1 << 2)
96 #define IXGBE_TX_FLAGS_IPV4             (u32)(1 << 3)
97 #define IXGBE_TX_FLAGS_VLAN_MASK        0xffff0000
98 #define IXGBE_TX_FLAGS_VLAN_SHIFT       16
99
100 /* wrapper around a pointer to a socket buffer,
101  * so a DMA handle can be stored along with the buffer */
102 struct ixgbe_tx_buffer {
103         struct sk_buff *skb;
104         dma_addr_t dma;
105         unsigned long time_stamp;
106         u16 length;
107         u16 next_to_watch;
108 };
109
110 struct ixgbe_rx_buffer {
111         struct sk_buff *skb;
112         dma_addr_t dma;
113         struct page *page;
114         dma_addr_t page_dma;
115 };
116
117 struct ixgbe_queue_stats {
118         u64 packets;
119         u64 bytes;
120 };
121
122 struct ixgbe_ring {
123         void *desc;                     /* descriptor ring memory */
124         dma_addr_t dma;                 /* phys. address of descriptor ring */
125         unsigned int size;              /* length in bytes */
126         unsigned int count;             /* amount of descriptors */
127         unsigned int next_to_use;
128         unsigned int next_to_clean;
129
130         int queue_index; /* needed for multiqueue queue management */
131         union {
132                 struct ixgbe_tx_buffer *tx_buffer_info;
133                 struct ixgbe_rx_buffer *rx_buffer_info;
134         };
135
136         u16 head;
137         u16 tail;
138
139
140         u16 reg_idx; /* holds the special value that gets the hardware register
141                       * offset associated with this ring, which is different
142                       * for DCE and RSS modes */
143         struct ixgbe_queue_stats stats;
144         u8 v_idx; /* maps directly to the index for this ring in the hardware
145                    * vector array, can also be used for finding the bit in EICR
146                    * and friends that represents the vector for this ring */
147
148         u32 eims_value;
149         u16 itr_register;
150
151         char name[IFNAMSIZ + 5];
152         u16 work_limit;                /* max work per interrupt */
153 };
154
155 #define RING_F_VMDQ 1
156 #define RING_F_RSS  2
157 #define IXGBE_MAX_RSS_INDICES  16
158 #define IXGBE_MAX_VMDQ_INDICES 16
159 struct ixgbe_ring_feature {
160         int indices;
161         int mask;
162 };
163
164 #define MAX_RX_QUEUES 64
165 #define MAX_TX_QUEUES 32
166
167 /* MAX_MSIX_Q_VECTORS of these are allocated,
168  * but we only use one per queue-specific vector.
169  */
170 struct ixgbe_q_vector {
171         struct ixgbe_adapter *adapter;
172         struct napi_struct napi;
173         DECLARE_BITMAP(rxr_idx, MAX_RX_QUEUES); /* Rx ring indices */
174         DECLARE_BITMAP(txr_idx, MAX_TX_QUEUES); /* Tx ring indices */
175         u8 rxr_count;     /* Rx ring count assigned to this vector */
176         u8 txr_count;     /* Tx ring count assigned to this vector */
177         u32 eitr;
178 };
179
180 /* Helper macros to switch between ints/sec and what the register uses.
181  * And yes, it's the same math going both ways.
182  */
183 #define EITR_INTS_PER_SEC_TO_REG(_eitr) \
184         ((_eitr) ? (1000000000 / ((_eitr) * 256)) : 0)
185 #define EITR_REG_TO_INTS_PER_SEC EITR_INTS_PER_SEC_TO_REG
186
187 #define IXGBE_DESC_UNUSED(R) \
188         ((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
189         (R)->next_to_clean - (R)->next_to_use - 1)
190
191 #define IXGBE_RX_DESC_ADV(R, i)     \
192         (&(((union ixgbe_adv_rx_desc *)((R).desc))[i]))
193 #define IXGBE_TX_DESC_ADV(R, i)     \
194         (&(((union ixgbe_adv_tx_desc *)((R).desc))[i]))
195 #define IXGBE_TX_CTXTDESC_ADV(R, i)         \
196         (&(((struct ixgbe_adv_tx_context_desc *)((R).desc))[i]))
197
198 #define IXGBE_MAX_JUMBO_FRAME_SIZE        16128
199
200 #define OTHER_VECTOR 1
201 #define NON_Q_VECTORS (OTHER_VECTOR)
202
203 #define MAX_MSIX_Q_VECTORS 16
204 #define MIN_MSIX_Q_VECTORS 2
205 #define MAX_MSIX_COUNT (MAX_MSIX_Q_VECTORS + NON_Q_VECTORS)
206 #define MIN_MSIX_COUNT (MIN_MSIX_Q_VECTORS + NON_Q_VECTORS)
207
208 /* board specific private data structure */
209 struct ixgbe_adapter {
210         struct timer_list watchdog_timer;
211         struct vlan_group *vlgrp;
212         u16 bd_number;
213         u16 rx_buf_len;
214         struct work_struct reset_task;
215         struct ixgbe_q_vector q_vector[MAX_MSIX_Q_VECTORS];
216         char name[MAX_MSIX_COUNT][IFNAMSIZ + 5];
217
218         /* TX */
219         struct ixgbe_ring *tx_ring;     /* One per active queue */
220         u64 restart_queue;
221         u64 lsc_int;
222         u64 hw_tso_ctxt;
223         u64 hw_tso6_ctxt;
224         u32 tx_timeout_count;
225         bool detect_tx_hung;
226
227         /* RX */
228         struct ixgbe_ring *rx_ring;     /* One per active queue */
229         u64 hw_csum_tx_good;
230         u64 hw_csum_rx_error;
231         u64 hw_csum_rx_good;
232         u64 non_eop_descs;
233         int num_tx_queues;
234         int num_rx_queues;
235         int num_msix_vectors;
236         struct ixgbe_ring_feature ring_feature[3];
237         struct msix_entry *msix_entries;
238
239         u64 rx_hdr_split;
240         u32 alloc_rx_page_failed;
241         u32 alloc_rx_buff_failed;
242
243         /* Some features need tri-state capability,
244          * thus the additional *_CAPABLE flags.
245          */
246         u32 flags;
247 #define IXGBE_FLAG_RX_CSUM_ENABLED              (u32)(1 << 0)
248 #define IXGBE_FLAG_MSI_ENABLED                  (u32)(1 << 1)
249 #define IXGBE_FLAG_MSIX_ENABLED                 (u32)(1 << 2)
250 #define IXGBE_FLAG_RX_PS_ENABLED                (u32)(1 << 3)
251 #define IXGBE_FLAG_IN_NETPOLL                   (u32)(1 << 4)
252 #define IXGBE_FLAG_IMIR_ENABLED                 (u32)(1 << 5)
253 #define IXGBE_FLAG_RSS_ENABLED                  (u32)(1 << 6)
254 #define IXGBE_FLAG_VMDQ_ENABLED                 (u32)(1 << 7)
255
256         /* OS defined structs */
257         struct net_device *netdev;
258         struct pci_dev *pdev;
259         struct net_device_stats net_stats;
260
261         /* structs defined in ixgbe_hw.h */
262         struct ixgbe_hw hw;
263         u16 msg_enable;
264         struct ixgbe_hw_stats stats;
265
266         /* Interrupt Throttle Rate */
267         u32 rx_eitr;
268         u32 tx_eitr;
269
270         unsigned long state;
271         u64 tx_busy;
272 };
273
274 enum ixbge_state_t {
275         __IXGBE_TESTING,
276         __IXGBE_RESETTING,
277         __IXGBE_DOWN
278 };
279
280 enum ixgbe_boards {
281         board_82598,
282 };
283
284 extern struct ixgbe_info ixgbe_82598_info;
285
286 extern char ixgbe_driver_name[];
287 extern const char ixgbe_driver_version[];
288
289 extern int ixgbe_up(struct ixgbe_adapter *adapter);
290 extern void ixgbe_down(struct ixgbe_adapter *adapter);
291 extern void ixgbe_reinit_locked(struct ixgbe_adapter *adapter);
292 extern void ixgbe_reset(struct ixgbe_adapter *adapter);
293 extern void ixgbe_update_stats(struct ixgbe_adapter *adapter);
294 extern void ixgbe_set_ethtool_ops(struct net_device *netdev);
295 extern int ixgbe_setup_rx_resources(struct ixgbe_adapter *adapter,
296                                     struct ixgbe_ring *rxdr);
297 extern int ixgbe_setup_tx_resources(struct ixgbe_adapter *adapter,
298                                     struct ixgbe_ring *txdr);
299
300 #endif /* _IXGBE_H_ */