1 /*******************************************************************************
3 Intel PRO/1000 Linux driver
4 Copyright(c) 1999 - 2006 Intel Corporation.
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.
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
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.
19 The full GNU General Public License is included in this distribution in
20 the file called "COPYING".
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
27 *******************************************************************************/
30 /* Linux PRO/1000 Ethernet Driver main header file */
35 #include <linux/stddef.h>
36 #include <linux/module.h>
37 #include <linux/types.h>
38 #include <asm/byteorder.h>
39 #include <linux/init.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>
59 #include <linux/capability.h>
62 #include <linux/ipv6.h>
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>
68 #include <net/checksum.h>
69 #include <linux/mii.h>
70 #include <linux/ethtool.h>
71 #include <linux/if_vlan.h>
77 #define INTEL_E1000_ETHERNET_DEVICE(device_id) {\
78 PCI_DEVICE(PCI_VENDOR_ID_INTEL, device_id)}
85 #define E1000_DBG(args...) printk(KERN_DEBUG "e1000: " args)
87 #define E1000_DBG(args...)
90 #define E1000_ERR(args...) printk(KERN_ERR "e1000: " args)
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))
98 #define E1000_MAX_INTR 10
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
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 /* this is the size past which hardware will drop packets when setting LPE=0 */
112 #define MAXIMUM_ETHERNET_VLAN_SIZE 1522
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
124 /* SmartSpeed delimiters */
125 #define E1000_SMARTSPEED_DOWNSHIFT 3
126 #define E1000_SMARTSPEED_MAX 15
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
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 */
137 #define E1000_FC_PAUSE_TIME 0x0680 /* 858 usec */
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 */
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
149 #ifndef E1000_MASTER_SLAVE
150 /* Switch to override PHY master/slave setting */
151 #define E1000_MASTER_SLAVE e1000_ms_hw_default
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
158 /* only works for sizes that are powers of 2 */
159 #define E1000_ROUNDUP(i, size) ((i) = (((i) + (size) - 1) & ~((size) - 1)))
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
{
166 unsigned long time_stamp
;
168 uint16_t next_to_watch
;
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
]; };
175 struct e1000_tx_ring
{
176 /* pointer to the descriptor ring memory */
178 /* physical address of the descriptor ring */
180 /* length of descriptor ring in bytes */
182 /* number of descriptors in the ring */
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
;
194 boolean_t last_tx_tso
;
197 struct e1000_rx_ring
{
198 /* pointer to the descriptor ring memory */
200 /* physical address of the descriptor ring */
202 /* length of descriptor ring in bytes */
204 /* number of descriptors in the ring */
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
;
216 /* cpu for rx queue */
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)
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)
236 /* board specific private data structure */
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
;
245 uint32_t rx_buffer_len
;
250 uint16_t link_duplex
;
251 spinlock_t stats_lock
;
252 #ifdef CONFIG_E1000_NAPI
253 spinlock_t tx_queue_lock
;
256 unsigned int total_tx_bytes
;
257 unsigned int total_tx_packets
;
258 unsigned int total_rx_bytes
;
259 unsigned int total_rx_packets
;
260 /* Interrupt Throttle Rate */
262 uint32_t itr_setting
;
266 struct work_struct reset_task
;
269 struct timer_list blink_timer
;
270 unsigned long led_status
;
273 struct e1000_tx_ring
*tx_ring
; /* One per active queue */
274 unsigned int restart_queue
;
275 unsigned long tx_queue_len
;
277 uint32_t tx_int_delay
;
278 uint32_t tx_abs_int_delay
;
283 uint32_t tx_timeout_count
;
284 uint32_t tx_fifo_head
;
285 uint32_t tx_head_addr
;
286 uint32_t tx_fifo_size
;
287 uint8_t tx_timeout_factor
;
288 atomic_t tx_fifo_stall
;
289 boolean_t pcix_82544
;
290 boolean_t detect_tx_hung
;
293 #ifdef CONFIG_E1000_NAPI
294 boolean_t (*clean_rx
) (struct e1000_adapter
*adapter
,
295 struct e1000_rx_ring
*rx_ring
,
296 int *work_done
, int work_to_do
);
298 boolean_t (*clean_rx
) (struct e1000_adapter
*adapter
,
299 struct e1000_rx_ring
*rx_ring
);
301 void (*alloc_rx_buf
) (struct e1000_adapter
*adapter
,
302 struct e1000_rx_ring
*rx_ring
,
304 struct e1000_rx_ring
*rx_ring
; /* One per active queue */
305 #ifdef CONFIG_E1000_NAPI
306 struct net_device
*polling_netdev
; /* One per active queue */
311 uint64_t hw_csum_err
;
312 uint64_t hw_csum_good
;
313 uint64_t rx_hdr_split
;
314 uint32_t alloc_rx_buff_failed
;
315 uint32_t rx_int_delay
;
316 uint32_t rx_abs_int_delay
;
318 unsigned int rx_ps_pages
;
321 uint16_t rx_ps_bsize0
;
324 /* OS defined structs */
325 struct net_device
*netdev
;
326 struct pci_dev
*pdev
;
327 struct net_device_stats net_stats
;
329 /* structs defined in e1000_hw.h */
331 struct e1000_hw_stats stats
;
332 struct e1000_phy_info phy_info
;
333 struct e1000_phy_stats phy_stats
;
336 struct e1000_tx_ring test_tx_ring
;
337 struct e1000_rx_ring test_rx_ring
;
340 uint32_t *config_space
;
342 #ifdef CONFIG_PCI_MSI
345 /* to not mess up cache alignment, always add to the bottom */
347 boolean_t smart_power_down
; /* phy smart power down */
348 boolean_t quad_port_a
;
359 #endif /* _E1000_H_ */