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)
94 #define DPRINTK(nlevel, klevel, fmt, args...) \
96 if (NETIF_MSG_##nlevel & adapter->msg_enable) \
97 printk(KERN_##klevel PFX "%s: %s: " fmt, \
98 adapter->netdev->name, __func__, ##args); \
101 #define E1000_MAX_INTR 10
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
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
114 /* this is the size past which hardware will drop packets when setting LPE=0 */
115 #define MAXIMUM_ETHERNET_VLAN_SIZE 1522
117 /* Supported Rx Buffer Sizes */
118 #define E1000_RXBUFFER_128 128 /* Used for packet split */
119 #define E1000_RXBUFFER_256 256 /* Used for packet split */
120 #define E1000_RXBUFFER_512 512
121 #define E1000_RXBUFFER_1024 1024
122 #define E1000_RXBUFFER_2048 2048
123 #define E1000_RXBUFFER_4096 4096
124 #define E1000_RXBUFFER_8192 8192
125 #define E1000_RXBUFFER_16384 16384
127 /* SmartSpeed delimiters */
128 #define E1000_SMARTSPEED_DOWNSHIFT 3
129 #define E1000_SMARTSPEED_MAX 15
131 /* Packet Buffer allocations */
132 #define E1000_PBA_BYTES_SHIFT 0xA
133 #define E1000_TX_HEAD_ADDR_SHIFT 7
134 #define E1000_PBA_TX_MASK 0xFFFF0000
136 /* Flow Control Watermarks */
137 #define E1000_FC_HIGH_DIFF 0x1638 /* High: 5688 bytes below Rx FIFO size */
138 #define E1000_FC_LOW_DIFF 0x1640 /* Low: 5696 bytes below Rx FIFO size */
140 #define E1000_FC_PAUSE_TIME 0x0680 /* 858 usec */
142 /* How many Tx Descriptors do we need to call netif_wake_queue ? */
143 #define E1000_TX_QUEUE_WAKE 16
144 /* How many Rx Buffers do we bundle into one write to the hardware ? */
145 #define E1000_RX_BUFFER_WRITE 16 /* Must be power of 2 */
147 #define AUTO_ALL_MODES 0
148 #define E1000_EEPROM_82544_APM 0x0004
149 #define E1000_EEPROM_ICH8_APME 0x0004
150 #define E1000_EEPROM_APME 0x0400
152 #ifndef E1000_MASTER_SLAVE
153 /* Switch to override PHY master/slave setting */
154 #define E1000_MASTER_SLAVE e1000_ms_hw_default
157 #define E1000_MNG_VLAN_NONE (-1)
158 /* Number of packet split data buffers (not including the header buffer) */
159 #define PS_PAGE_BUFFERS (MAX_PS_BUFFERS - 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
;
171 struct e1000_ps_page
{
172 struct page
*ps_page
[PS_PAGE_BUFFERS
];
175 struct e1000_ps_page_dma
{
176 u64 ps_page_dma
[PS_PAGE_BUFFERS
];
179 struct e1000_tx_ring
{
180 /* pointer to the descriptor ring memory */
182 /* physical address of the descriptor ring */
184 /* length of descriptor ring in bytes */
186 /* number of descriptors in the ring */
188 /* next descriptor to associate a buffer with */
189 unsigned int next_to_use
;
190 /* next descriptor to check for DD status bit */
191 unsigned int next_to_clean
;
192 /* array of buffer information structs */
193 struct e1000_buffer
*buffer_info
;
201 struct e1000_rx_ring
{
202 /* pointer to the descriptor ring memory */
204 /* physical address of the descriptor ring */
206 /* length of descriptor ring in bytes */
208 /* number of descriptors in the ring */
210 /* next descriptor to associate a buffer with */
211 unsigned int next_to_use
;
212 /* next descriptor to check for DD status bit */
213 unsigned int next_to_clean
;
214 /* array of buffer information structs */
215 struct e1000_buffer
*buffer_info
;
216 /* arrays of page information for packet split */
217 struct e1000_ps_page
*ps_page
;
218 struct e1000_ps_page_dma
*ps_page_dma
;
220 /* cpu for rx queue */
227 #define E1000_DESC_UNUSED(R) \
228 ((((R)->next_to_clean > (R)->next_to_use) \
229 ? 0 : (R)->count) + (R)->next_to_clean - (R)->next_to_use - 1)
231 #define E1000_RX_DESC_PS(R, i) \
232 (&(((union e1000_rx_desc_packet_split *)((R).desc))[i]))
233 #define E1000_RX_DESC_EXT(R, i) \
234 (&(((union e1000_rx_desc_extended *)((R).desc))[i]))
235 #define E1000_GET_DESC(R, i, type) (&(((struct type *)((R).desc))[i]))
236 #define E1000_RX_DESC(R, i) E1000_GET_DESC(R, i, e1000_rx_desc)
237 #define E1000_TX_DESC(R, i) E1000_GET_DESC(R, i, e1000_tx_desc)
238 #define E1000_CONTEXT_DESC(R, i) E1000_GET_DESC(R, i, e1000_context_desc)
240 /* board specific private data structure */
242 struct e1000_adapter
{
243 struct timer_list tx_fifo_stall_timer
;
244 struct timer_list watchdog_timer
;
245 struct timer_list phy_info_timer
;
246 struct vlan_group
*vlgrp
;
255 spinlock_t stats_lock
;
256 spinlock_t tx_queue_lock
;
257 unsigned int total_tx_bytes
;
258 unsigned int total_tx_packets
;
259 unsigned int total_rx_bytes
;
260 unsigned int total_rx_packets
;
261 /* Interrupt Throttle Rate */
267 struct work_struct reset_task
;
270 struct timer_list blink_timer
;
271 unsigned long led_status
;
274 struct e1000_tx_ring
*tx_ring
; /* One per active queue */
275 unsigned int restart_queue
;
276 unsigned long tx_queue_len
;
279 u32 tx_abs_int_delay
;
284 u32 tx_timeout_count
;
288 u8 tx_timeout_factor
;
289 atomic_t tx_fifo_stall
;
294 bool (*clean_rx
)(struct e1000_adapter
*adapter
,
295 struct e1000_rx_ring
*rx_ring
,
296 int *work_done
, int work_to_do
);
297 void (*alloc_rx_buf
)(struct e1000_adapter
*adapter
,
298 struct e1000_rx_ring
*rx_ring
,
300 struct e1000_rx_ring
*rx_ring
; /* One per active queue */
301 struct napi_struct napi
;
302 struct net_device
*polling_netdev
; /* One per active queue */
310 u32 alloc_rx_buff_failed
;
312 u32 rx_abs_int_delay
;
314 unsigned int rx_ps_pages
;
319 /* OS defined structs */
320 struct net_device
*netdev
;
321 struct pci_dev
*pdev
;
322 struct net_device_stats net_stats
;
324 /* structs defined in e1000_hw.h */
326 struct e1000_hw_stats stats
;
327 struct e1000_phy_info phy_info
;
328 struct e1000_phy_stats phy_stats
;
331 struct e1000_tx_ring test_tx_ring
;
332 struct e1000_rx_ring test_rx_ring
;
337 /* to not mess up cache alignment, always add to the bottom */
339 bool smart_power_down
; /* phy smart power down */
344 /* for ioport free */
355 extern char e1000_driver_name
[];
356 extern const char e1000_driver_version
[];
358 extern int e1000_up(struct e1000_adapter
*adapter
);
359 extern void e1000_down(struct e1000_adapter
*adapter
);
360 extern void e1000_reinit_locked(struct e1000_adapter
*adapter
);
361 extern void e1000_reset(struct e1000_adapter
*adapter
);
362 extern int e1000_set_spd_dplx(struct e1000_adapter
*adapter
, u16 spddplx
);
363 extern int e1000_setup_all_rx_resources(struct e1000_adapter
*adapter
);
364 extern int e1000_setup_all_tx_resources(struct e1000_adapter
*adapter
);
365 extern void e1000_free_all_rx_resources(struct e1000_adapter
*adapter
);
366 extern void e1000_free_all_tx_resources(struct e1000_adapter
*adapter
);
367 extern void e1000_update_stats(struct e1000_adapter
*adapter
);
368 extern void e1000_power_up_phy(struct e1000_adapter
*);
369 extern void e1000_set_ethtool_ops(struct net_device
*netdev
);
370 extern void e1000_check_options(struct e1000_adapter
*adapter
);
372 #endif /* _E1000_H_ */