igb: streamline Rx buffer allocation and cleanup
[linux-2.6-block.git] / drivers / net / ethernet / intel / igb / igb.h
CommitLineData
9d5c8243
AK
1/*******************************************************************************
2
3 Intel(R) Gigabit Ethernet Linux driver
4297f99b 4 Copyright(c) 2007-2011 Intel Corporation.
9d5c8243
AK
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
29/* Linux PRO/1000 Ethernet Driver main header file */
30
31#ifndef _IGB_H_
32#define _IGB_H_
33
34#include "e1000_mac.h"
35#include "e1000_82575.h"
36
38c845c7 37#include <linux/clocksource.h>
33af6bcc
PO
38#include <linux/timecompare.h>
39#include <linux/net_tstamp.h>
b2cb09b1
JP
40#include <linux/bitops.h>
41#include <linux/if_vlan.h>
38c845c7 42
9d5c8243
AK
43struct igb_adapter;
44
6eb5a7f1
AD
45/* ((1000000000ns / (6000ints/s * 1024ns)) << 2 = 648 */
46#define IGB_START_ITR 648
9d5c8243 47
9d5c8243
AK
48/* TX/RX descriptor defines */
49#define IGB_DEFAULT_TXD 256
50#define IGB_MIN_TXD 80
51#define IGB_MAX_TXD 4096
52
53#define IGB_DEFAULT_RXD 256
54#define IGB_MIN_RXD 80
55#define IGB_MAX_RXD 4096
56
57#define IGB_DEFAULT_ITR 3 /* dynamic */
58#define IGB_MAX_ITR_USECS 10000
59#define IGB_MIN_ITR_USECS 10
047e0030
AD
60#define NON_Q_VECTORS 1
61#define MAX_Q_VECTORS 8
9d5c8243
AK
62
63/* Transmit and receive queues */
a99955fc
AD
64#define IGB_MAX_RX_QUEUES (adapter->vfs_allocated_count ? 2 : \
65 (hw->mac.type > e1000_82575 ? 8 : 4))
66#define IGB_ABS_MAX_TX_QUEUES 8
67#define IGB_MAX_TX_QUEUES IGB_MAX_RX_QUEUES
9d5c8243 68
4ae196df
AD
69#define IGB_MAX_VF_MC_ENTRIES 30
70#define IGB_MAX_VF_FUNCTIONS 8
71#define IGB_MAX_VFTA_ENTRIES 128
72
73struct vf_data_storage {
74 unsigned char vf_mac_addresses[ETH_ALEN];
75 u16 vf_mc_hashes[IGB_MAX_VF_MC_ENTRIES];
76 u16 num_vf_mc_hashes;
ae641bdc 77 u16 vlans_enabled;
f2ca0dbe
AD
78 u32 flags;
79 unsigned long last_nack;
8151d294
WM
80 u16 pf_vlan; /* When set, guest VLAN config not allowed. */
81 u16 pf_qos;
17dc566c 82 u16 tx_rate;
4ae196df
AD
83};
84
f2ca0dbe 85#define IGB_VF_FLAG_CTS 0x00000001 /* VF is clear to send data */
7d5753f0
AD
86#define IGB_VF_FLAG_UNI_PROMISC 0x00000002 /* VF has unicast promisc */
87#define IGB_VF_FLAG_MULTI_PROMISC 0x00000004 /* VF has multicast promisc */
8151d294 88#define IGB_VF_FLAG_PF_SET_MAC 0x00000008 /* PF has set MAC address */
f2ca0dbe 89
9d5c8243
AK
90/* RX descriptor control thresholds.
91 * PTHRESH - MAC will consider prefetch if it has fewer than this number of
92 * descriptors available in its onboard memory.
93 * Setting this to 0 disables RX descriptor prefetch.
94 * HTHRESH - MAC will only prefetch if there are at least this many descriptors
95 * available in host memory.
96 * If PTHRESH is 0, this should also be 0.
97 * WTHRESH - RX descriptor writeback threshold - MAC will delay writing back
98 * descriptors until either it has this many to write back, or the
99 * ITR timer expires.
100 */
58fd62f5 101#define IGB_RX_PTHRESH 8
9d5c8243 102#define IGB_RX_HTHRESH 8
85b430b4
AD
103#define IGB_TX_PTHRESH 8
104#define IGB_TX_HTHRESH 1
a74420e0
AD
105#define IGB_RX_WTHRESH ((hw->mac.type == e1000_82576 && \
106 adapter->msix_entries) ? 1 : 4)
85b430b4 107#define IGB_TX_WTHRESH ((hw->mac.type == e1000_82576 && \
a74420e0 108 adapter->msix_entries) ? 1 : 16)
9d5c8243
AK
109
110/* this is the size past which hardware will drop packets when setting LPE=0 */
111#define MAXIMUM_ETHERNET_VLAN_SIZE 1522
112
113/* Supported Rx Buffer Sizes */
44390ca6 114#define IGB_RXBUFFER_512 512
9d5c8243 115#define IGB_RXBUFFER_16384 16384
44390ca6 116#define IGB_RX_HDR_LEN IGB_RXBUFFER_512
9d5c8243 117
9d5c8243
AK
118/* How many Tx Descriptors do we need to call netif_wake_queue ? */
119#define IGB_TX_QUEUE_WAKE 16
120/* How many Rx Buffers do we bundle into one write to the hardware ? */
121#define IGB_RX_BUFFER_WRITE 16 /* Must be power of 2 */
122
123#define AUTO_ALL_MODES 0
124#define IGB_EEPROM_APME 0x0400
125
126#ifndef IGB_MASTER_SLAVE
127/* Switch to override PHY master/slave setting */
128#define IGB_MASTER_SLAVE e1000_ms_hw_default
129#endif
130
131#define IGB_MNG_VLAN_NONE -1
132
133/* wrapper around a pointer to a socket buffer,
134 * so a DMA handle can be stored along with the buffer */
135struct igb_buffer {
136 struct sk_buff *skb;
137 dma_addr_t dma;
138 union {
139 /* TX */
140 struct {
141 unsigned long time_stamp;
0e014cb1
AD
142 u16 length;
143 u16 next_to_watch;
2873957d 144 unsigned int bytecount;
40e90c26 145 u16 gso_segs;
2244d07b 146 u8 tx_flags;
2873957d 147 u8 mapped_as_page;
9d5c8243
AK
148 };
149 /* RX */
150 struct {
151 struct page *page;
6366ad33
AD
152 dma_addr_t page_dma;
153 u16 page_offset;
9d5c8243
AK
154 };
155 };
156};
157
8c0ab70a 158struct igb_tx_queue_stats {
9d5c8243
AK
159 u64 packets;
160 u64 bytes;
04a5fcaa 161 u64 restart_queue;
12dcd86b 162 u64 restart_queue2;
9d5c8243
AK
163};
164
8c0ab70a
JDB
165struct igb_rx_queue_stats {
166 u64 packets;
167 u64 bytes;
168 u64 drops;
04a5fcaa
AD
169 u64 csum_err;
170 u64 alloc_failed;
8c0ab70a
JDB
171};
172
047e0030 173struct igb_q_vector {
9d5c8243 174 struct igb_adapter *adapter; /* backlink */
047e0030
AD
175 struct igb_ring *rx_ring;
176 struct igb_ring *tx_ring;
177 struct napi_struct napi;
178
179 u32 eims_value;
180 u16 cpu;
181
182 u16 itr_val;
183 u8 set_itr;
047e0030
AD
184 void __iomem *itr_register;
185
186 char name[IFNAMSIZ + 9];
187};
188
189struct igb_ring {
190 struct igb_q_vector *q_vector; /* backlink to q_vector */
e694e964 191 struct net_device *netdev; /* back pointer to net_device */
59d71989 192 struct device *dev; /* device pointer for dma mapping */
047e0030 193 dma_addr_t dma; /* phys address of the ring */
e694e964 194 void *desc; /* descriptor ring memory */
047e0030 195 unsigned int size; /* length of desc. ring in bytes */
2e5655e7 196 u16 count; /* number of desc. in the ring */
9d5c8243
AK
197 u16 next_to_use;
198 u16 next_to_clean;
2e5655e7
AD
199 u8 queue_index;
200 u8 reg_idx;
fce99e34
AD
201 void __iomem *head;
202 void __iomem *tail;
9d5c8243
AK
203 struct igb_buffer *buffer_info; /* array of buffer info structs */
204
9d5c8243
AK
205 unsigned int total_bytes;
206 unsigned int total_packets;
207
85ad76b2
AD
208 u32 flags;
209
9d5c8243
AK
210 union {
211 /* TX */
212 struct {
8c0ab70a 213 struct igb_tx_queue_stats tx_stats;
12dcd86b
ED
214 struct u64_stats_sync tx_syncp;
215 struct u64_stats_sync tx_syncp2;
9d5c8243
AK
216 bool detect_tx_hung;
217 };
218 /* RX */
219 struct {
8c0ab70a 220 struct igb_rx_queue_stats rx_stats;
12dcd86b 221 struct u64_stats_sync rx_syncp;
9d5c8243
AK
222 };
223 };
9d5c8243
AK
224};
225
85ad76b2
AD
226#define IGB_RING_FLAG_RX_CSUM 0x00000001 /* RX CSUM enabled */
227#define IGB_RING_FLAG_RX_SCTP_CSUM 0x00000002 /* SCTP CSUM offload enabled */
228
229#define IGB_RING_FLAG_TX_CTX_IDX 0x00000001 /* HW requires context index */
230
231#define IGB_ADVTXD_DCMD (E1000_TXD_CMD_EOP | E1000_TXD_CMD_RS)
232
9d5c8243
AK
233#define E1000_RX_DESC_ADV(R, i) \
234 (&(((union e1000_adv_rx_desc *)((R).desc))[i]))
235#define E1000_TX_DESC_ADV(R, i) \
236 (&(((union e1000_adv_tx_desc *)((R).desc))[i]))
237#define E1000_TX_CTXTDESC_ADV(R, i) \
238 (&(((struct e1000_adv_tx_context_desc *)((R).desc))[i]))
9d5c8243 239
d7ee5b3a
AD
240/* igb_desc_unused - calculate if we have unused descriptors */
241static inline int igb_desc_unused(struct igb_ring *ring)
242{
243 if (ring->next_to_clean > ring->next_to_use)
244 return ring->next_to_clean - ring->next_to_use - 1;
245
246 return ring->count + ring->next_to_clean - ring->next_to_use - 1;
247}
248
9d5c8243 249/* board specific private data structure */
9d5c8243
AK
250struct igb_adapter {
251 struct timer_list watchdog_timer;
252 struct timer_list phy_info_timer;
b2cb09b1 253 unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
9d5c8243
AK
254 u16 mng_vlan_id;
255 u32 bd_number;
9d5c8243
AK
256 u32 wol;
257 u32 en_mng_pt;
258 u16 link_speed;
259 u16 link_duplex;
2e5655e7 260
9d5c8243 261 /* Interrupt Throttle Rate */
4fc82adf
AD
262 u32 rx_itr_setting;
263 u32 tx_itr_setting;
9d5c8243
AK
264 u16 tx_itr;
265 u16 rx_itr;
9d5c8243
AK
266
267 struct work_struct reset_task;
268 struct work_struct watchdog_task;
269 bool fc_autoneg;
270 u8 tx_timeout_factor;
271 struct timer_list blink_timer;
272 unsigned long led_status;
273
274 /* TX */
3025a446 275 struct igb_ring *tx_ring[16];
9d5c8243
AK
276 u32 tx_timeout_count;
277
278 /* RX */
3025a446 279 struct igb_ring *rx_ring[16];
9d5c8243
AK
280 int num_tx_queues;
281 int num_rx_queues;
282
9d5c8243
AK
283 u32 max_frame_size;
284 u32 min_frame_size;
285
286 /* OS defined structs */
287 struct net_device *netdev;
9d5c8243 288 struct pci_dev *pdev;
38c845c7
PO
289 struct cyclecounter cycles;
290 struct timecounter clock;
33af6bcc
PO
291 struct timecompare compare;
292 struct hwtstamp_config hwtstamp_config;
9d5c8243 293
12dcd86b
ED
294 spinlock_t stats64_lock;
295 struct rtnl_link_stats64 stats64;
296
9d5c8243
AK
297 /* structs defined in e1000_hw.h */
298 struct e1000_hw hw;
299 struct e1000_hw_stats stats;
300 struct e1000_phy_info phy_info;
301 struct e1000_phy_stats phy_stats;
302
303 u32 test_icr;
304 struct igb_ring test_tx_ring;
305 struct igb_ring test_rx_ring;
306
307 int msg_enable;
047e0030
AD
308
309 unsigned int num_q_vectors;
310 struct igb_q_vector *q_vector[MAX_Q_VECTORS];
9d5c8243
AK
311 struct msix_entry *msix_entries;
312 u32 eims_enable_mask;
844290e5 313 u32 eims_other;
9d5c8243
AK
314
315 /* to not mess up cache alignment, always add to the bottom */
316 unsigned long state;
7dfc16fa 317 unsigned int flags;
9d5c8243 318 u32 eeprom_wol;
42bfd33a 319
1bfaf07b 320 struct igb_ring *multi_tx_table[IGB_ABS_MAX_TX_QUEUES];
2e5655e7
AD
321 u16 tx_ring_count;
322 u16 rx_ring_count;
1bfaf07b 323 unsigned int vfs_allocated_count;
4ae196df 324 struct vf_data_storage *vf_data;
17dc566c 325 int vf_rate_link_speed;
a99955fc 326 u32 rss_queues;
13800469 327 u32 wvbr;
9d5c8243
AK
328};
329
7dfc16fa 330#define IGB_FLAG_HAS_MSI (1 << 0)
cbd347ad
AD
331#define IGB_FLAG_DCA_ENABLED (1 << 1)
332#define IGB_FLAG_QUAD_PORT_A (1 << 2)
4fc82adf 333#define IGB_FLAG_QUEUE_PAIRS (1 << 3)
831ec0b4
CW
334#define IGB_FLAG_DMAC (1 << 4)
335
336/* DMA Coalescing defines */
337#define IGB_MIN_TXPBSIZE 20408
338#define IGB_TX_BUF_4096 4096
339#define IGB_DMCTLX_DCFLUSH_DIS 0x80000000 /* Disable DMA Coal Flush */
7dfc16fa 340
c5b9bd5e 341#define IGB_82576_TSYNC_SHIFT 19
55cac248 342#define IGB_82580_TSYNC_SHIFT 24
757b77e2 343#define IGB_TS_HDR_LEN 16
9d5c8243
AK
344enum e1000_state_t {
345 __IGB_TESTING,
346 __IGB_RESETTING,
347 __IGB_DOWN
348};
349
350enum igb_boards {
351 board_82575,
352};
353
354extern char igb_driver_name[];
355extern char igb_driver_version[];
356
9d5c8243
AK
357extern int igb_up(struct igb_adapter *);
358extern void igb_down(struct igb_adapter *);
359extern void igb_reinit_locked(struct igb_adapter *);
360extern void igb_reset(struct igb_adapter *);
14ad2513 361extern int igb_set_spd_dplx(struct igb_adapter *, u32, u8);
80785298
AD
362extern int igb_setup_tx_resources(struct igb_ring *);
363extern int igb_setup_rx_resources(struct igb_ring *);
68fd9910
AD
364extern void igb_free_tx_resources(struct igb_ring *);
365extern void igb_free_rx_resources(struct igb_ring *);
d7ee5b3a
AD
366extern void igb_configure_tx_ring(struct igb_adapter *, struct igb_ring *);
367extern void igb_configure_rx_ring(struct igb_adapter *, struct igb_ring *);
368extern void igb_setup_tctl(struct igb_adapter *);
369extern void igb_setup_rctl(struct igb_adapter *);
b1a436c3
AD
370extern netdev_tx_t igb_xmit_frame_ring_adv(struct sk_buff *, struct igb_ring *);
371extern void igb_unmap_and_free_tx_resource(struct igb_ring *,
372 struct igb_buffer *);
c023cd88 373extern void igb_alloc_rx_buffers_adv(struct igb_ring *, u16);
12dcd86b 374extern void igb_update_stats(struct igb_adapter *, struct rtnl_link_stats64 *);
3145535a 375extern bool igb_has_link(struct igb_adapter *adapter);
9d5c8243 376extern void igb_set_ethtool_ops(struct net_device *);
88a268c1 377extern void igb_power_up_link(struct igb_adapter *);
9d5c8243 378
f5f4cf08
AD
379static inline s32 igb_reset_phy(struct e1000_hw *hw)
380{
a8d2a0c2
AD
381 if (hw->phy.ops.reset)
382 return hw->phy.ops.reset(hw);
f5f4cf08
AD
383
384 return 0;
385}
386
387static inline s32 igb_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data)
388{
a8d2a0c2
AD
389 if (hw->phy.ops.read_reg)
390 return hw->phy.ops.read_reg(hw, offset, data);
f5f4cf08
AD
391
392 return 0;
393}
394
395static inline s32 igb_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data)
396{
a8d2a0c2
AD
397 if (hw->phy.ops.write_reg)
398 return hw->phy.ops.write_reg(hw, offset, data);
f5f4cf08
AD
399
400 return 0;
401}
402
403static inline s32 igb_get_phy_info(struct e1000_hw *hw)
404{
405 if (hw->phy.ops.get_phy_info)
406 return hw->phy.ops.get_phy_info(hw);
407
408 return 0;
409}
410
9d5c8243 411#endif /* _IGB_H_ */