1 /*******************************************************************************
4 Copyright(c) 1999 - 2005 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/vmalloc.h>
53 #include <linux/interrupt.h>
54 #include <linux/string.h>
55 #include <linux/pagemap.h>
56 #include <linux/dma-mapping.h>
57 #include <linux/bitops.h>
60 #include <linux/capability.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>
69 #include <net/checksum.h>
71 #include <linux/workqueue.h>
72 #include <linux/mii.h>
73 #include <linux/ethtool.h>
74 #include <linux/if_vlan.h>
75 #ifdef CONFIG_E1000_MQ
76 #include <linux/cpu.h>
77 #include <linux/smp.h>
84 #define INTEL_E1000_ETHERNET_DEVICE(device_id) {\
85 PCI_DEVICE(PCI_VENDOR_ID_INTEL, device_id)}
92 #define E1000_DBG(args...) printk(KERN_DEBUG "e1000: " args)
94 #define E1000_DBG(args...)
97 #define E1000_ERR(args...) printk(KERN_ERR "e1000: " args)
100 #define DPRINTK(nlevel, klevel, fmt, args...) \
101 (void)((NETIF_MSG_##nlevel & adapter->msg_enable) && \
102 printk(KERN_##klevel PFX "%s: %s: " fmt, adapter->netdev->name, \
103 __FUNCTION__ , ## args))
105 #define E1000_MAX_INTR 10
107 /* TX/RX descriptor defines */
108 #define E1000_DEFAULT_TXD 256
109 #define E1000_MAX_TXD 256
110 #define E1000_MIN_TXD 80
111 #define E1000_MAX_82544_TXD 4096
113 #define E1000_DEFAULT_RXD 256
114 #define E1000_MAX_RXD 256
115 #define E1000_MIN_RXD 80
116 #define E1000_MAX_82544_RXD 4096
118 /* Supported Rx Buffer Sizes */
119 #define E1000_RXBUFFER_128 128 /* Used for packet split */
120 #define E1000_RXBUFFER_256 256 /* Used for packet split */
121 #define E1000_RXBUFFER_2048 2048
122 #define E1000_RXBUFFER_4096 4096
123 #define E1000_RXBUFFER_8192 8192
124 #define E1000_RXBUFFER_16384 16384
126 /* SmartSpeed delimiters */
127 #define E1000_SMARTSPEED_DOWNSHIFT 3
128 #define E1000_SMARTSPEED_MAX 15
130 /* Packet Buffer allocations */
131 #define E1000_PBA_BYTES_SHIFT 0xA
132 #define E1000_TX_HEAD_ADDR_SHIFT 7
133 #define E1000_PBA_TX_MASK 0xFFFF0000
135 /* Flow Control Watermarks */
136 #define E1000_FC_HIGH_DIFF 0x1638 /* High: 5688 bytes below Rx FIFO size */
137 #define E1000_FC_LOW_DIFF 0x1640 /* Low: 5696 bytes below Rx FIFO size */
139 #define E1000_FC_PAUSE_TIME 0x0680 /* 858 usec */
141 /* How many Tx Descriptors do we need to call netif_wake_queue ? */
142 #define E1000_TX_QUEUE_WAKE 16
143 /* How many Rx Buffers do we bundle into one write to the hardware ? */
144 #define E1000_RX_BUFFER_WRITE 16 /* Must be power of 2 */
146 #define AUTO_ALL_MODES 0
147 #define E1000_EEPROM_82544_APM 0x0004
148 #define E1000_EEPROM_APME 0x0400
150 #ifndef E1000_MASTER_SLAVE
151 /* Switch to override PHY master/slave setting */
152 #define E1000_MASTER_SLAVE e1000_ms_hw_default
155 #define E1000_MNG_VLAN_NONE -1
156 /* Number of packet split data buffers (not including the header buffer) */
157 #define PS_PAGE_BUFFERS MAX_PS_BUFFERS-1
159 /* only works for sizes that are powers of 2 */
160 #define E1000_ROUNDUP(i, size) ((i) = (((i) + (size) - 1) & ~((size) - 1)))
162 /* wrapper around a pointer to a socket buffer,
163 * so a DMA handle can be stored along with the buffer */
164 struct e1000_buffer {
167 unsigned long time_stamp;
169 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;
196 boolean_t last_tx_tso;
200 struct e1000_rx_ring {
201 /* pointer to the descriptor ring memory */
203 /* physical address of the descriptor ring */
205 /* length of descriptor ring in bytes */
207 /* number of descriptors in the ring */
209 /* next descriptor to associate a buffer with */
210 unsigned int next_to_use;
211 /* next descriptor to check for DD status bit */
212 unsigned int next_to_clean;
213 /* array of buffer information structs */
214 struct e1000_buffer *buffer_info;
215 /* arrays of page information for packet split */
216 struct e1000_ps_page *ps_page;
217 struct e1000_ps_page_dma *ps_page_dma;
224 #define E1000_DESC_UNUSED(R) \
225 ((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
226 (R)->next_to_clean - (R)->next_to_use - 1)
228 #define E1000_RX_DESC_PS(R, i) \
229 (&(((union e1000_rx_desc_packet_split *)((R).desc))[i]))
230 #define E1000_RX_DESC_EXT(R, i) \
231 (&(((union e1000_rx_desc_extended *)((R).desc))[i]))
232 #define E1000_GET_DESC(R, i, type) (&(((struct type *)((R).desc))[i]))
233 #define E1000_RX_DESC(R, i) E1000_GET_DESC(R, i, e1000_rx_desc)
234 #define E1000_TX_DESC(R, i) E1000_GET_DESC(R, i, e1000_tx_desc)
235 #define E1000_CONTEXT_DESC(R, i) E1000_GET_DESC(R, i, e1000_context_desc)
237 /* board specific private data structure */
239 struct e1000_adapter {
240 struct timer_list tx_fifo_stall_timer;
241 struct timer_list watchdog_timer;
242 struct timer_list phy_info_timer;
243 struct vlan_group *vlgrp;
244 uint16_t mng_vlan_id;
246 uint32_t rx_buffer_len;
252 uint16_t link_duplex;
253 spinlock_t stats_lock;
255 struct work_struct tx_timeout_task;
256 struct work_struct watchdog_task;
259 struct timer_list blink_timer;
260 unsigned long led_status;
263 struct e1000_tx_ring *tx_ring; /* One per active queue */
264 #ifdef CONFIG_E1000_MQ
265 struct e1000_tx_ring **cpu_tx_ring; /* per-cpu */
268 uint32_t tx_int_delay;
269 uint32_t tx_abs_int_delay;
274 uint32_t tx_fifo_head;
275 uint32_t tx_head_addr;
276 uint32_t tx_fifo_size;
277 atomic_t tx_fifo_stall;
278 boolean_t pcix_82544;
279 boolean_t detect_tx_hung;
282 #ifdef CONFIG_E1000_NAPI
283 boolean_t (*clean_rx) (struct e1000_adapter *adapter,
284 struct e1000_rx_ring *rx_ring,
285 int *work_done, int work_to_do);
287 boolean_t (*clean_rx) (struct e1000_adapter *adapter,
288 struct e1000_rx_ring *rx_ring);
290 void (*alloc_rx_buf) (struct e1000_adapter *adapter,
291 struct e1000_rx_ring *rx_ring);
292 struct e1000_rx_ring *rx_ring; /* One per active queue */
293 #ifdef CONFIG_E1000_NAPI
294 struct net_device *polling_netdev; /* One per active queue */
296 #ifdef CONFIG_E1000_MQ
297 struct net_device **cpu_netdev; /* per-cpu */
298 struct call_async_data_struct rx_sched_call_data;
299 int cpu_for_queue[4];
303 uint64_t hw_csum_err;
304 uint64_t hw_csum_good;
305 uint64_t rx_hdr_split;
306 uint32_t rx_int_delay;
307 uint32_t rx_abs_int_delay;
309 unsigned int rx_ps_pages;
312 uint16_t rx_ps_bsize0;
314 /* Interrupt Throttle Rate */
317 /* OS defined structs */
318 struct net_device *netdev;
319 struct pci_dev *pdev;
320 struct net_device_stats net_stats;
322 /* structs defined in e1000_hw.h */
324 struct e1000_hw_stats stats;
325 struct e1000_phy_info phy_info;
326 struct e1000_phy_stats phy_stats;
329 struct e1000_tx_ring test_tx_ring;
330 struct e1000_rx_ring test_rx_ring;
334 #ifdef CONFIG_PCI_MSI
338 #endif /* _E1000_H_ */