Merge master.kernel.org:/home/rmk/linux-2.6-arm
[linux-2.6-block.git] / drivers / net / e1000 / e1000.h
CommitLineData
1da177e4
LT
1/*******************************************************************************
2
0abb6eb1
AK
3 Intel PRO/1000 Linux driver
4 Copyright(c) 1999 - 2006 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
1da177e4 13 more details.
0abb6eb1 14
1da177e4 15 You should have received a copy of the GNU General Public License along with
0abb6eb1
AK
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
1da177e4
LT
22 Contact Information:
23 Linux NICS <linux.nics@intel.com>
3d41e30a 24 e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
1da177e4
LT
25 Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
26
27*******************************************************************************/
28
29
30/* Linux PRO/1000 Ethernet Driver main header file */
31
32#ifndef _E1000_H_
33#define _E1000_H_
34
35#include <linux/stddef.h>
1da177e4
LT
36#include <linux/module.h>
37#include <linux/types.h>
38#include <asm/byteorder.h>
39#include <linux/init.h>
40#include <linux/mm.h>
41#include <linux/errno.h>
42#include <linux/ioport.h>
43#include <linux/pci.h>
44#include <linux/kernel.h>
45#include <linux/netdevice.h>
46#include <linux/etherdevice.h>
47#include <linux/skbuff.h>
48#include <linux/delay.h>
49#include <linux/timer.h>
50#include <linux/slab.h>
51#include <linux/vmalloc.h>
52#include <linux/interrupt.h>
53#include <linux/string.h>
54#include <linux/pagemap.h>
55#include <linux/dma-mapping.h>
56#include <linux/bitops.h>
57#include <asm/io.h>
58#include <asm/irq.h>
59#include <linux/capability.h>
60#include <linux/in.h>
61#include <linux/ip.h>
87ca4e5b 62#include <linux/ipv6.h>
1da177e4
LT
63#include <linux/tcp.h>
64#include <linux/udp.h>
65#include <net/pkt_sched.h>
66#include <linux/list.h>
67#include <linux/reboot.h>
1da177e4 68#include <net/checksum.h>
1da177e4
LT
69#include <linux/mii.h>
70#include <linux/ethtool.h>
71#include <linux/if_vlan.h>
72
73#define BAR_0 0
74#define BAR_1 1
75#define BAR_5 5
76
77#define INTEL_E1000_ETHERNET_DEVICE(device_id) {\
78 PCI_DEVICE(PCI_VENDOR_ID_INTEL, device_id)}
79
80struct e1000_adapter;
81
82#include "e1000_hw.h"
83
84#ifdef DBG
85#define E1000_DBG(args...) printk(KERN_DEBUG "e1000: " args)
86#else
87#define E1000_DBG(args...)
88#endif
89
90#define E1000_ERR(args...) printk(KERN_ERR "e1000: " args)
91
92#define PFX "e1000: "
93#define DPRINTK(nlevel, klevel, fmt, args...) \
94 (void)((NETIF_MSG_##nlevel & adapter->msg_enable) && \
95 printk(KERN_##klevel PFX "%s: %s: " fmt, adapter->netdev->name, \
96 __FUNCTION__ , ## args))
97
98#define E1000_MAX_INTR 10
99
100/* TX/RX descriptor defines */
101#define E1000_DEFAULT_TXD 256
102#define E1000_MAX_TXD 256
103#define E1000_MIN_TXD 80
104#define E1000_MAX_82544_TXD 4096
105
106#define E1000_DEFAULT_RXD 256
107#define E1000_MAX_RXD 256
108#define E1000_MIN_RXD 80
109#define E1000_MAX_82544_RXD 4096
110
eb0f8054
AK
111/* this is the size past which hardware will drop packets when setting LPE=0 */
112#define MAXIMUM_ETHERNET_VLAN_SIZE 1522
113
1da177e4 114/* Supported Rx Buffer Sizes */
2d7edb92
MC
115#define E1000_RXBUFFER_128 128 /* Used for packet split */
116#define E1000_RXBUFFER_256 256 /* Used for packet split */
9e2feace
AK
117#define E1000_RXBUFFER_512 512
118#define E1000_RXBUFFER_1024 1024
1da177e4
LT
119#define E1000_RXBUFFER_2048 2048
120#define E1000_RXBUFFER_4096 4096
121#define E1000_RXBUFFER_8192 8192
122#define E1000_RXBUFFER_16384 16384
123
124/* SmartSpeed delimiters */
125#define E1000_SMARTSPEED_DOWNSHIFT 3
126#define E1000_SMARTSPEED_MAX 15
127
128/* Packet Buffer allocations */
129#define E1000_PBA_BYTES_SHIFT 0xA
130#define E1000_TX_HEAD_ADDR_SHIFT 7
131#define E1000_PBA_TX_MASK 0xFFFF0000
132
133/* Flow Control Watermarks */
134#define E1000_FC_HIGH_DIFF 0x1638 /* High: 5688 bytes below Rx FIFO size */
135#define E1000_FC_LOW_DIFF 0x1640 /* Low: 5696 bytes below Rx FIFO size */
136
137#define E1000_FC_PAUSE_TIME 0x0680 /* 858 usec */
138
139/* How many Tx Descriptors do we need to call netif_wake_queue ? */
140#define E1000_TX_QUEUE_WAKE 16
141/* How many Rx Buffers do we bundle into one write to the hardware ? */
142#define E1000_RX_BUFFER_WRITE 16 /* Must be power of 2 */
143
2648345f 144#define AUTO_ALL_MODES 0
70cf362b 145#define E1000_EEPROM_82544_APM 0x0004
cd94dd0b 146#define E1000_EEPROM_ICH8_APME 0x0004
2648345f 147#define E1000_EEPROM_APME 0x0400
1da177e4
LT
148
149#ifndef E1000_MASTER_SLAVE
150/* Switch to override PHY master/slave setting */
151#define E1000_MASTER_SLAVE e1000_ms_hw_default
152#endif
153
2d7edb92
MC
154#define E1000_MNG_VLAN_NONE -1
155/* Number of packet split data buffers (not including the header buffer) */
156#define PS_PAGE_BUFFERS MAX_PS_BUFFERS-1
157
1da177e4
LT
158/* wrapper around a pointer to a socket buffer,
159 * so a DMA handle can be stored along with the buffer */
160struct e1000_buffer {
161 struct sk_buff *skb;
c6963ef5 162 dma_addr_t dma;
1da177e4
LT
163 unsigned long time_stamp;
164 uint16_t length;
165 uint16_t next_to_watch;
166};
167
7bfa4816 168
e4c811c9
MC
169struct e1000_ps_page { struct page *ps_page[PS_PAGE_BUFFERS]; };
170struct e1000_ps_page_dma { uint64_t ps_page_dma[PS_PAGE_BUFFERS]; };
2d7edb92 171
581d708e
MC
172struct e1000_tx_ring {
173 /* pointer to the descriptor ring memory */
174 void *desc;
175 /* physical address of the descriptor ring */
176 dma_addr_t dma;
177 /* length of descriptor ring in bytes */
178 unsigned int size;
179 /* number of descriptors in the ring */
180 unsigned int count;
181 /* next descriptor to associate a buffer with */
182 unsigned int next_to_use;
183 /* next descriptor to check for DD status bit */
184 unsigned int next_to_clean;
185 /* array of buffer information structs */
186 struct e1000_buffer *buffer_info;
187
581d708e
MC
188 spinlock_t tx_lock;
189 uint16_t tdh;
190 uint16_t tdt;
fd803241 191 boolean_t last_tx_tso;
581d708e
MC
192};
193
194struct e1000_rx_ring {
1da177e4
LT
195 /* pointer to the descriptor ring memory */
196 void *desc;
197 /* physical address of the descriptor ring */
198 dma_addr_t dma;
199 /* length of descriptor ring in bytes */
200 unsigned int size;
201 /* number of descriptors in the ring */
202 unsigned int count;
203 /* next descriptor to associate a buffer with */
204 unsigned int next_to_use;
205 /* next descriptor to check for DD status bit */
206 unsigned int next_to_clean;
207 /* array of buffer information structs */
208 struct e1000_buffer *buffer_info;
2d7edb92
MC
209 /* arrays of page information for packet split */
210 struct e1000_ps_page *ps_page;
211 struct e1000_ps_page_dma *ps_page_dma;
581d708e 212
545c67c0
JK
213 /* cpu for rx queue */
214 int cpu;
215
581d708e
MC
216 uint16_t rdh;
217 uint16_t rdt;
1da177e4
LT
218};
219
220#define E1000_DESC_UNUSED(R) \
221 ((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
222 (R)->next_to_clean - (R)->next_to_use - 1)
223
2d7edb92
MC
224#define E1000_RX_DESC_PS(R, i) \
225 (&(((union e1000_rx_desc_packet_split *)((R).desc))[i]))
226#define E1000_RX_DESC_EXT(R, i) \
227 (&(((union e1000_rx_desc_extended *)((R).desc))[i]))
1da177e4
LT
228#define E1000_GET_DESC(R, i, type) (&(((struct type *)((R).desc))[i]))
229#define E1000_RX_DESC(R, i) E1000_GET_DESC(R, i, e1000_rx_desc)
230#define E1000_TX_DESC(R, i) E1000_GET_DESC(R, i, e1000_tx_desc)
231#define E1000_CONTEXT_DESC(R, i) E1000_GET_DESC(R, i, e1000_context_desc)
232
233/* board specific private data structure */
234
235struct e1000_adapter {
236 struct timer_list tx_fifo_stall_timer;
237 struct timer_list watchdog_timer;
238 struct timer_list phy_info_timer;
239 struct vlan_group *vlgrp;
8fc897b0 240 uint16_t mng_vlan_id;
1da177e4
LT
241 uint32_t bd_number;
242 uint32_t rx_buffer_len;
1da177e4
LT
243 uint32_t wol;
244 uint32_t smartspeed;
245 uint32_t en_mng_pt;
246 uint16_t link_speed;
247 uint16_t link_duplex;
248 spinlock_t stats_lock;
7bfa4816
JK
249#ifdef CONFIG_E1000_NAPI
250 spinlock_t tx_queue_lock;
251#endif
1da177e4 252 atomic_t irq_sem;
835bb129
JB
253 unsigned int total_tx_bytes;
254 unsigned int total_tx_packets;
255 unsigned int total_rx_bytes;
256 unsigned int total_rx_packets;
257 /* Interrupt Throttle Rate */
258 uint32_t itr;
259 uint32_t itr_setting;
260 uint16_t tx_itr;
261 uint16_t rx_itr;
262
87041639 263 struct work_struct reset_task;
1da177e4
LT
264 uint8_t fc_autoneg;
265
266 struct timer_list blink_timer;
267 unsigned long led_status;
268
269 /* TX */
581d708e 270 struct e1000_tx_ring *tx_ring; /* One per active queue */
fcfb1224 271 unsigned int restart_queue;
f56799ea 272 unsigned long tx_queue_len;
1da177e4
LT
273 uint32_t txd_cmd;
274 uint32_t tx_int_delay;
275 uint32_t tx_abs_int_delay;
276 uint32_t gotcl;
277 uint64_t gotcl_old;
278 uint64_t tpt_old;
279 uint64_t colc_old;
6b7660cd 280 uint32_t tx_timeout_count;
1da177e4
LT
281 uint32_t tx_fifo_head;
282 uint32_t tx_head_addr;
283 uint32_t tx_fifo_size;
66a2b0a3 284 uint8_t tx_timeout_factor;
1da177e4
LT
285 atomic_t tx_fifo_stall;
286 boolean_t pcix_82544;
287 boolean_t detect_tx_hung;
288
289 /* RX */
2d7edb92 290#ifdef CONFIG_E1000_NAPI
581d708e 291 boolean_t (*clean_rx) (struct e1000_adapter *adapter,
0f15a8fa
JK
292 struct e1000_rx_ring *rx_ring,
293 int *work_done, int work_to_do);
2d7edb92 294#else
581d708e 295 boolean_t (*clean_rx) (struct e1000_adapter *adapter,
0f15a8fa 296 struct e1000_rx_ring *rx_ring);
2d7edb92 297#endif
581d708e 298 void (*alloc_rx_buf) (struct e1000_adapter *adapter,
0f15a8fa
JK
299 struct e1000_rx_ring *rx_ring,
300 int cleaned_count);
581d708e
MC
301 struct e1000_rx_ring *rx_ring; /* One per active queue */
302#ifdef CONFIG_E1000_NAPI
303 struct net_device *polling_netdev; /* One per active queue */
581d708e 304#endif
f56799ea
JK
305 int num_tx_queues;
306 int num_rx_queues;
581d708e 307
1da177e4
LT
308 uint64_t hw_csum_err;
309 uint64_t hw_csum_good;
e4c811c9 310 uint64_t rx_hdr_split;
6b7660cd 311 uint32_t alloc_rx_buff_failed;
1da177e4
LT
312 uint32_t rx_int_delay;
313 uint32_t rx_abs_int_delay;
314 boolean_t rx_csum;
e4c811c9 315 unsigned int rx_ps_pages;
1da177e4
LT
316 uint32_t gorcl;
317 uint64_t gorcl_old;
2d7edb92 318 uint16_t rx_ps_bsize0;
1da177e4 319
1da177e4
LT
320
321 /* OS defined structs */
322 struct net_device *netdev;
323 struct pci_dev *pdev;
324 struct net_device_stats net_stats;
325
326 /* structs defined in e1000_hw.h */
327 struct e1000_hw hw;
328 struct e1000_hw_stats stats;
329 struct e1000_phy_info phy_info;
330 struct e1000_phy_stats phy_stats;
331
332 uint32_t test_icr;
581d708e
MC
333 struct e1000_tx_ring test_tx_ring;
334 struct e1000_rx_ring test_rx_ring;
1da177e4 335
1da177e4 336 int msg_enable;
fa4f7ef3 337 boolean_t have_msi;
e94bd23f 338
7e6c9861 339 /* to not mess up cache alignment, always add to the bottom */
7e6c9861 340 boolean_t tso_force;
9a53a202 341 boolean_t smart_power_down; /* phy smart power down */
120cd576 342 boolean_t quad_port_a;
2db10a08 343 unsigned long flags;
120cd576 344 uint32_t eeprom_wol;
1da177e4 345};
30dcbf29 346
2db10a08 347enum e1000_state_t {
1314bbf3 348 __E1000_TESTING,
2db10a08 349 __E1000_RESETTING,
1314bbf3 350 __E1000_DOWN
2db10a08 351};
30dcbf29 352
1da177e4 353#endif /* _E1000_H_ */