e1000: integrate ich8 support into driver
[pandora-kernel.git] / drivers / net / e1000 / e1000.h
1 /*******************************************************************************
2
3   
4   Copyright(c) 1999 - 2006 Intel Corporation. All rights reserved.
5   
6   This program is free software; you can redistribute it and/or modify it 
7   under the terms of the GNU General Public License as published by the Free 
8   Software Foundation; either version 2 of the License, or (at your option) 
9   any later version.
10   
11   This program is distributed in the hope that it will be useful, but WITHOUT 
12   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 
13   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for 
14   more details.
15   
16   You should have received a copy of the GNU General Public License along with
17   this program; if not, write to the Free Software Foundation, Inc., 59 
18   Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19   
20   The full GNU General Public License is included in this distribution in the
21   file called LICENSE.
22   
23   Contact Information:
24   Linux NICS <linux.nics@intel.com>
25   e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
26   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
27
28 *******************************************************************************/
29
30
31 /* Linux PRO/1000 Ethernet Driver main header file */
32
33 #ifndef _E1000_H_
34 #define _E1000_H_
35
36 #include <linux/stddef.h>
37 #include <linux/config.h>
38 #include <linux/module.h>
39 #include <linux/types.h>
40 #include <asm/byteorder.h>
41 #include <linux/init.h>
42 #include <linux/mm.h>
43 #include <linux/errno.h>
44 #include <linux/ioport.h>
45 #include <linux/pci.h>
46 #include <linux/kernel.h>
47 #include <linux/netdevice.h>
48 #include <linux/etherdevice.h>
49 #include <linux/skbuff.h>
50 #include <linux/delay.h>
51 #include <linux/timer.h>
52 #include <linux/slab.h>
53 #include <linux/vmalloc.h>
54 #include <linux/interrupt.h>
55 #include <linux/string.h>
56 #include <linux/pagemap.h>
57 #include <linux/dma-mapping.h>
58 #include <linux/bitops.h>
59 #include <asm/io.h>
60 #include <asm/irq.h>
61 #include <linux/capability.h>
62 #include <linux/in.h>
63 #include <linux/ip.h>
64 #include <linux/tcp.h>
65 #include <linux/udp.h>
66 #include <net/pkt_sched.h>
67 #include <linux/list.h>
68 #include <linux/reboot.h>
69 #ifdef NETIF_F_TSO
70 #include <net/checksum.h>
71 #endif
72 #include <linux/mii.h>
73 #include <linux/ethtool.h>
74 #include <linux/if_vlan.h>
75
76 #define BAR_0           0
77 #define BAR_1           1
78 #define BAR_5           5
79
80 #define INTEL_E1000_ETHERNET_DEVICE(device_id) {\
81         PCI_DEVICE(PCI_VENDOR_ID_INTEL, device_id)}
82
83 struct e1000_adapter;
84
85 #include "e1000_hw.h"
86
87 #ifdef DBG
88 #define E1000_DBG(args...) printk(KERN_DEBUG "e1000: " args)
89 #else
90 #define E1000_DBG(args...)
91 #endif
92
93 #define E1000_ERR(args...) printk(KERN_ERR "e1000: " args)
94
95 #define PFX "e1000: "
96 #define DPRINTK(nlevel, klevel, fmt, args...) \
97         (void)((NETIF_MSG_##nlevel & adapter->msg_enable) && \
98         printk(KERN_##klevel PFX "%s: %s: " fmt, adapter->netdev->name, \
99                 __FUNCTION__ , ## args))
100
101 #define E1000_MAX_INTR 10
102
103 /* TX/RX descriptor defines */
104 #define E1000_DEFAULT_TXD                  256
105 #define E1000_MAX_TXD                      256
106 #define E1000_MIN_TXD                       80
107 #define E1000_MAX_82544_TXD               4096
108
109 #define E1000_DEFAULT_RXD                  256
110 #define E1000_MAX_RXD                      256
111 #define E1000_MIN_RXD                       80
112 #define E1000_MAX_82544_RXD               4096
113
114 /* Supported Rx Buffer Sizes */
115 #define E1000_RXBUFFER_128   128    /* Used for packet split */
116 #define E1000_RXBUFFER_256   256    /* Used for packet split */
117 #define E1000_RXBUFFER_512   512
118 #define E1000_RXBUFFER_1024  1024
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
144 #define AUTO_ALL_MODES            0
145 #define E1000_EEPROM_82544_APM    0x0004
146 #define E1000_EEPROM_ICH8_APME    0x0004
147 #define E1000_EEPROM_APME         0x0400
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
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
158 /* only works for sizes that are powers of 2 */
159 #define E1000_ROUNDUP(i, size) ((i) = (((i) + (size) - 1) & ~((size) - 1)))
160
161 /* wrapper around a pointer to a socket buffer,
162  * so a DMA handle can be stored along with the buffer */
163 struct e1000_buffer {
164         struct sk_buff *skb;
165         dma_addr_t dma;
166         unsigned long time_stamp;
167         uint16_t length;
168         uint16_t next_to_watch;
169 };
170
171
172 struct e1000_ps_page { struct page *ps_page[PS_PAGE_BUFFERS]; };
173 struct e1000_ps_page_dma { uint64_t ps_page_dma[PS_PAGE_BUFFERS]; };
174
175 struct e1000_tx_ring {
176         /* pointer to the descriptor ring memory */
177         void *desc;
178         /* physical address of the descriptor ring */
179         dma_addr_t dma;
180         /* length of descriptor ring in bytes */
181         unsigned int size;
182         /* number of descriptors in the ring */
183         unsigned int count;
184         /* next descriptor to associate a buffer with */
185         unsigned int next_to_use;
186         /* next descriptor to check for DD status bit */
187         unsigned int next_to_clean;
188         /* array of buffer information structs */
189         struct e1000_buffer *buffer_info;
190
191         spinlock_t tx_lock;
192         uint16_t tdh;
193         uint16_t tdt;
194         boolean_t last_tx_tso;
195 };
196
197 struct e1000_rx_ring {
198         /* pointer to the descriptor ring memory */
199         void *desc;
200         /* physical address of the descriptor ring */
201         dma_addr_t dma;
202         /* length of descriptor ring in bytes */
203         unsigned int size;
204         /* number of descriptors in the ring */
205         unsigned int count;
206         /* next descriptor to associate a buffer with */
207         unsigned int next_to_use;
208         /* next descriptor to check for DD status bit */
209         unsigned int next_to_clean;
210         /* array of buffer information structs */
211         struct e1000_buffer *buffer_info;
212         /* arrays of page information for packet split */
213         struct e1000_ps_page *ps_page;
214         struct e1000_ps_page_dma *ps_page_dma;
215
216         /* cpu for rx queue */
217         int cpu;
218
219         uint16_t rdh;
220         uint16_t rdt;
221 };
222
223 #define E1000_DESC_UNUSED(R) \
224         ((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
225         (R)->next_to_clean - (R)->next_to_use - 1)
226
227 #define E1000_RX_DESC_PS(R, i)      \
228         (&(((union e1000_rx_desc_packet_split *)((R).desc))[i]))
229 #define E1000_RX_DESC_EXT(R, i)     \
230         (&(((union e1000_rx_desc_extended *)((R).desc))[i]))
231 #define E1000_GET_DESC(R, i, type)      (&(((struct type *)((R).desc))[i]))
232 #define E1000_RX_DESC(R, i)             E1000_GET_DESC(R, i, e1000_rx_desc)
233 #define E1000_TX_DESC(R, i)             E1000_GET_DESC(R, i, e1000_tx_desc)
234 #define E1000_CONTEXT_DESC(R, i)        E1000_GET_DESC(R, i, e1000_context_desc)
235
236 /* board specific private data structure */
237
238 struct e1000_adapter {
239         struct timer_list tx_fifo_stall_timer;
240         struct timer_list watchdog_timer;
241         struct timer_list phy_info_timer;
242         struct vlan_group *vlgrp;
243         uint16_t mng_vlan_id;
244         uint32_t bd_number;
245         uint32_t rx_buffer_len;
246         uint32_t part_num;
247         uint32_t wol;
248         uint32_t ksp3_port_a;
249         uint32_t smartspeed;
250         uint32_t en_mng_pt;
251         uint16_t link_speed;
252         uint16_t link_duplex;
253         spinlock_t stats_lock;
254 #ifdef CONFIG_E1000_NAPI
255         spinlock_t tx_queue_lock;
256 #endif
257         atomic_t irq_sem;
258         struct work_struct reset_task;
259         uint8_t fc_autoneg;
260
261         struct timer_list blink_timer;
262         unsigned long led_status;
263
264         /* TX */
265         struct e1000_tx_ring *tx_ring;      /* One per active queue */
266         unsigned long tx_queue_len;
267         uint32_t txd_cmd;
268         uint32_t tx_int_delay;
269         uint32_t tx_abs_int_delay;
270         uint32_t gotcl;
271         uint64_t gotcl_old;
272         uint64_t tpt_old;
273         uint64_t colc_old;
274         uint32_t tx_timeout_count;
275         uint32_t tx_fifo_head;
276         uint32_t tx_head_addr;
277         uint32_t tx_fifo_size;
278         uint8_t  tx_timeout_factor;
279         atomic_t tx_fifo_stall;
280         boolean_t pcix_82544;
281         boolean_t detect_tx_hung;
282
283         /* RX */
284 #ifdef CONFIG_E1000_NAPI
285         boolean_t (*clean_rx) (struct e1000_adapter *adapter,
286                                struct e1000_rx_ring *rx_ring,
287                                int *work_done, int work_to_do);
288 #else
289         boolean_t (*clean_rx) (struct e1000_adapter *adapter,
290                                struct e1000_rx_ring *rx_ring);
291 #endif
292         void (*alloc_rx_buf) (struct e1000_adapter *adapter,
293                               struct e1000_rx_ring *rx_ring,
294                                 int cleaned_count);
295         struct e1000_rx_ring *rx_ring;      /* One per active queue */
296 #ifdef CONFIG_E1000_NAPI
297         struct net_device *polling_netdev;  /* One per active queue */
298 #endif
299         int num_tx_queues;
300         int num_rx_queues;
301
302         uint64_t hw_csum_err;
303         uint64_t hw_csum_good;
304         uint64_t rx_hdr_split;
305         uint32_t alloc_rx_buff_failed;
306         uint32_t rx_int_delay;
307         uint32_t rx_abs_int_delay;
308         boolean_t rx_csum;
309         unsigned int rx_ps_pages;
310         uint32_t gorcl;
311         uint64_t gorcl_old;
312         uint16_t rx_ps_bsize0;
313
314         /* Interrupt Throttle Rate */
315         uint32_t itr;
316
317         /* OS defined structs */
318         struct net_device *netdev;
319         struct pci_dev *pdev;
320         struct net_device_stats net_stats;
321
322         /* structs defined in e1000_hw.h */
323         struct e1000_hw hw;
324         struct e1000_hw_stats stats;
325         struct e1000_phy_info phy_info;
326         struct e1000_phy_stats phy_stats;
327
328         uint32_t test_icr;
329         struct e1000_tx_ring test_tx_ring;
330         struct e1000_rx_ring test_rx_ring;
331
332
333         uint32_t *config_space;
334         int msg_enable;
335 #ifdef CONFIG_PCI_MSI
336         boolean_t have_msi;
337 #endif
338         /* to not mess up cache alignment, always add to the bottom */
339 #ifdef NETIF_F_TSO
340         boolean_t tso_force;
341 #endif
342         boolean_t smart_power_down;     /* phy smart power down */
343         unsigned long flags;
344 };
345
346 enum e1000_state_t {
347         __E1000_DRIVER_TESTING,
348         __E1000_RESETTING,
349 };
350
351 /*  e1000_main.c  */
352 extern char e1000_driver_name[];
353 extern char e1000_driver_version[];
354 int e1000_up(struct e1000_adapter *adapter);
355 void e1000_down(struct e1000_adapter *adapter);
356 void e1000_reset(struct e1000_adapter *adapter);
357 void e1000_reinit_locked(struct e1000_adapter *adapter);
358 int e1000_setup_all_tx_resources(struct e1000_adapter *adapter);
359 void e1000_free_all_tx_resources(struct e1000_adapter *adapter);
360 int e1000_setup_all_rx_resources(struct e1000_adapter *adapter);
361 void e1000_free_all_rx_resources(struct e1000_adapter *adapter);
362 void e1000_update_stats(struct e1000_adapter *adapter);
363 int e1000_set_spd_dplx(struct e1000_adapter *adapter, uint16_t spddplx);
364
365 /*  e1000_ethtool.c  */
366 void e1000_set_ethtool_ops(struct net_device *netdev);
367
368 /*  e1000_param.c  */
369 void e1000_check_options(struct e1000_adapter *adapter);
370
371
372 #endif /* _E1000_H_ */