1 /*******************************************************************************
4 Copyright(c) 1999 - 2004 Intel Corporation. All rights reserved.
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)
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
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.
20 The full GNU General Public License is included in this distribution in the
24 Linux NICS <linux.nics@intel.com>
25 Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
27 *******************************************************************************/
30 /* Linux PRO/1000 Ethernet Driver main header file */
35 #include <linux/stddef.h>
36 #include <linux/config.h>
37 #include <linux/module.h>
38 #include <linux/types.h>
39 #include <asm/byteorder.h>
40 #include <linux/init.h>
42 #include <linux/errno.h>
43 #include <linux/ioport.h>
44 #include <linux/pci.h>
45 #include <linux/kernel.h>
46 #include <linux/netdevice.h>
47 #include <linux/etherdevice.h>
48 #include <linux/skbuff.h>
49 #include <linux/delay.h>
50 #include <linux/timer.h>
51 #include <linux/slab.h>
52 #include <linux/interrupt.h>
53 #include <linux/string.h>
54 #include <linux/pagemap.h>
55 #include <linux/dma-mapping.h>
56 #include <asm/bitops.h>
59 #include <linux/capability.h>
62 #include <linux/tcp.h>
63 #include <linux/udp.h>
64 #include <net/pkt_sched.h>
65 #include <linux/list.h>
66 #include <linux/reboot.h>
68 #include <net/checksum.h>
70 #include <linux/workqueue.h>
71 #include <linux/mii.h>
72 #include <linux/ethtool.h>
73 #include <linux/if_vlan.h>
74 #include <linux/moduleparam.h>
86 #define E1000_DBG(args...) printk(KERN_DEBUG "e1000: " args)
88 #define E1000_DBG(args...)
91 #define E1000_ERR(args...) printk(KERN_ERR "e1000: " args)
94 #define DPRINTK(nlevel, klevel, fmt, args...) \
95 (void)((NETIF_MSG_##nlevel & adapter->msg_enable) && \
96 printk(KERN_##klevel PFX "%s: %s: " fmt, adapter->netdev->name, \
97 __FUNCTION__ , ## args))
99 #define E1000_MAX_INTR 10
101 /* How many descriptors for TX and RX ? */
102 #define E1000_DEFAULT_TXD 256
103 #define E1000_MAX_TXD 256
104 #define E1000_MIN_TXD 80
105 #define E1000_MAX_82544_TXD 4096
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
111 /* Supported Rx Buffer Sizes */
112 #define E1000_RXBUFFER_2048 2048
113 #define E1000_RXBUFFER_4096 4096
114 #define E1000_RXBUFFER_8192 8192
115 #define E1000_RXBUFFER_16384 16384
117 /* SmartSpeed delimiters */
118 #define E1000_SMARTSPEED_DOWNSHIFT 3
119 #define E1000_SMARTSPEED_MAX 15
121 /* Packet Buffer allocations */
122 #define E1000_PBA_BYTES_SHIFT 0xA
123 #define E1000_TX_HEAD_ADDR_SHIFT 7
124 #define E1000_PBA_TX_MASK 0xFFFF0000
126 /* Flow Control High-Watermark: 5688 bytes below Rx FIFO size */
127 #define E1000_FC_HIGH_DIFF 0x1638
129 /* Flow Control Low-Watermark: 5696 bytes below Rx FIFO size */
130 #define E1000_FC_LOW_DIFF 0x1640
132 /* Flow Control Pause Time: 858 usec */
133 #define E1000_FC_PAUSE_TIME 0x0680
135 /* How many Tx Descriptors do we need to call netif_wake_queue ? */
136 #define E1000_TX_QUEUE_WAKE 16
137 /* How many Rx Buffers do we bundle into one write to the hardware ? */
138 #define E1000_RX_BUFFER_WRITE 16 /* Must be power of 2 */
140 #define AUTO_ALL_MODES 0
141 #define E1000_EEPROM_APME 0x0400
143 #ifndef E1000_MASTER_SLAVE
144 /* Switch to override PHY master/slave setting */
145 #define E1000_MASTER_SLAVE e1000_ms_hw_default
148 /* only works for sizes that are powers of 2 */
149 #define E1000_ROUNDUP(i, size) ((i) = (((i) + (size) - 1) & ~((size) - 1)))
151 /* wrapper around a pointer to a socket buffer,
152 * so a DMA handle can be stored along with the buffer */
153 struct e1000_buffer {
156 unsigned long length;
157 unsigned long time_stamp;
158 unsigned int next_to_watch;
161 struct e1000_desc_ring {
162 /* pointer to the descriptor ring memory */
164 /* physical address of the descriptor ring */
166 /* length of descriptor ring in bytes */
168 /* number of descriptors in the ring */
170 /* next descriptor to associate a buffer with */
171 unsigned int next_to_use;
172 /* next descriptor to check for DD status bit */
173 unsigned int next_to_clean;
174 /* array of buffer information structs */
175 struct e1000_buffer *buffer_info;
178 #define E1000_DESC_UNUSED(R) \
179 ((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
180 (R)->next_to_clean - (R)->next_to_use - 1)
182 #define E1000_GET_DESC(R, i, type) (&(((struct type *)((R).desc))[i]))
183 #define E1000_RX_DESC(R, i) E1000_GET_DESC(R, i, e1000_rx_desc)
184 #define E1000_TX_DESC(R, i) E1000_GET_DESC(R, i, e1000_tx_desc)
185 #define E1000_CONTEXT_DESC(R, i) E1000_GET_DESC(R, i, e1000_context_desc)
187 /* board specific private data structure */
189 struct e1000_adapter {
190 struct timer_list tx_fifo_stall_timer;
191 struct timer_list watchdog_timer;
192 struct timer_list phy_info_timer;
193 struct vlan_group *vlgrp;
195 uint32_t rx_buffer_len;
201 uint16_t link_duplex;
202 spinlock_t stats_lock;
204 struct work_struct tx_timeout_task;
207 struct timer_list blink_timer;
208 unsigned long led_status;
211 struct e1000_desc_ring tx_ring;
214 uint32_t tx_int_delay;
215 uint32_t tx_abs_int_delay;
220 uint32_t tx_fifo_head;
221 uint32_t tx_head_addr;
222 uint32_t tx_fifo_size;
223 atomic_t tx_fifo_stall;
224 boolean_t pcix_82544;
227 struct e1000_desc_ring rx_ring;
228 uint64_t hw_csum_err;
229 uint64_t hw_csum_good;
230 uint32_t rx_int_delay;
231 uint32_t rx_abs_int_delay;
236 /* Interrupt Throttle Rate */
239 /* OS defined structs */
240 struct net_device *netdev;
241 struct pci_dev *pdev;
242 struct net_device_stats net_stats;
244 /* structs defined in e1000_hw.h */
246 struct e1000_hw_stats stats;
247 struct e1000_phy_info phy_info;
248 struct e1000_phy_stats phy_stats;
251 struct e1000_desc_ring test_tx_ring;
252 struct e1000_desc_ring test_rx_ring;
255 uint32_t pci_state[16];
258 #endif /* _E1000_H_ */