Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /******************************************************************************* |
2 | ||
0abb6eb1 AK |
3 | Intel PRO/1000 Linux driver |
4 | Copyright(c) 1999 - 2006 Intel Corporation. | |
5 | ||
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. | |
9 | ||
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 | |
1da177e4 | 13 | more details. |
0abb6eb1 | 14 | |
1da177e4 | 15 | You should have received a copy of the GNU General Public License along with |
0abb6eb1 AK |
16 | this program; if not, write to the Free Software Foundation, Inc., |
17 | 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. | |
18 | ||
19 | The full GNU General Public License is included in this distribution in | |
20 | the file called "COPYING". | |
21 | ||
1da177e4 LT |
22 | Contact Information: |
23 | Linux NICS <linux.nics@intel.com> | |
3d41e30a | 24 | e1000-devel Mailing List <e1000-devel@lists.sourceforge.net> |
1da177e4 LT |
25 | Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497 |
26 | ||
27 | *******************************************************************************/ | |
28 | ||
29 | ||
30 | /* Linux PRO/1000 Ethernet Driver main header file */ | |
31 | ||
32 | #ifndef _E1000_H_ | |
33 | #define _E1000_H_ | |
34 | ||
35 | #include <linux/stddef.h> | |
1da177e4 LT |
36 | #include <linux/module.h> |
37 | #include <linux/types.h> | |
38 | #include <asm/byteorder.h> | |
39 | #include <linux/init.h> | |
40 | #include <linux/mm.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> | |
57 | #include <asm/io.h> | |
58 | #include <asm/irq.h> | |
59 | #include <linux/capability.h> | |
60 | #include <linux/in.h> | |
61 | #include <linux/ip.h> | |
87ca4e5b | 62 | #include <linux/ipv6.h> |
1da177e4 LT |
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> | |
1da177e4 | 68 | #include <net/checksum.h> |
1da177e4 LT |
69 | #include <linux/mii.h> |
70 | #include <linux/ethtool.h> | |
71 | #include <linux/if_vlan.h> | |
72 | ||
73 | #define BAR_0 0 | |
74 | #define BAR_1 1 | |
75 | #define BAR_5 5 | |
76 | ||
77 | #define INTEL_E1000_ETHERNET_DEVICE(device_id) {\ | |
78 | PCI_DEVICE(PCI_VENDOR_ID_INTEL, device_id)} | |
79 | ||
80 | struct e1000_adapter; | |
81 | ||
82 | #include "e1000_hw.h" | |
83 | ||
84 | #ifdef DBG | |
85 | #define E1000_DBG(args...) printk(KERN_DEBUG "e1000: " args) | |
86 | #else | |
87 | #define E1000_DBG(args...) | |
88 | #endif | |
89 | ||
90 | #define E1000_ERR(args...) printk(KERN_ERR "e1000: " args) | |
91 | ||
92 | #define PFX "e1000: " | |
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)) | |
97 | ||
98 | #define E1000_MAX_INTR 10 | |
99 | ||
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 | |
105 | ||
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 | |
110 | ||
eb0f8054 AK |
111 | /* this is the size past which hardware will drop packets when setting LPE=0 */ |
112 | #define MAXIMUM_ETHERNET_VLAN_SIZE 1522 | |
113 | ||
1da177e4 | 114 | /* Supported Rx Buffer Sizes */ |
2d7edb92 MC |
115 | #define E1000_RXBUFFER_128 128 /* Used for packet split */ |
116 | #define E1000_RXBUFFER_256 256 /* Used for packet split */ | |
9e2feace AK |
117 | #define E1000_RXBUFFER_512 512 |
118 | #define E1000_RXBUFFER_1024 1024 | |
1da177e4 LT |
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 | ||
2648345f | 144 | #define AUTO_ALL_MODES 0 |
70cf362b | 145 | #define E1000_EEPROM_82544_APM 0x0004 |
cd94dd0b | 146 | #define E1000_EEPROM_ICH8_APME 0x0004 |
2648345f | 147 | #define E1000_EEPROM_APME 0x0400 |
1da177e4 LT |
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 | ||
2d7edb92 MC |
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 | ||
1da177e4 LT |
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; | |
c6963ef5 | 165 | dma_addr_t dma; |
1da177e4 LT |
166 | unsigned long time_stamp; |
167 | uint16_t length; | |
168 | uint16_t next_to_watch; | |
169 | }; | |
170 | ||
7bfa4816 | 171 | |
e4c811c9 MC |
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]; }; | |
2d7edb92 | 174 | |
581d708e MC |
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 | ||
581d708e MC |
191 | spinlock_t tx_lock; |
192 | uint16_t tdh; | |
193 | uint16_t tdt; | |
fd803241 | 194 | boolean_t last_tx_tso; |
581d708e MC |
195 | }; |
196 | ||
197 | struct e1000_rx_ring { | |
1da177e4 LT |
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; | |
2d7edb92 MC |
212 | /* arrays of page information for packet split */ |
213 | struct e1000_ps_page *ps_page; | |
214 | struct e1000_ps_page_dma *ps_page_dma; | |
581d708e | 215 | |
545c67c0 JK |
216 | /* cpu for rx queue */ |
217 | int cpu; | |
218 | ||
581d708e MC |
219 | uint16_t rdh; |
220 | uint16_t rdt; | |
1da177e4 LT |
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 | ||
2d7edb92 MC |
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])) | |
1da177e4 LT |
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; | |
8fc897b0 | 243 | uint16_t mng_vlan_id; |
1da177e4 LT |
244 | uint32_t bd_number; |
245 | uint32_t rx_buffer_len; | |
1da177e4 LT |
246 | uint32_t wol; |
247 | uint32_t smartspeed; | |
248 | uint32_t en_mng_pt; | |
249 | uint16_t link_speed; | |
250 | uint16_t link_duplex; | |
251 | spinlock_t stats_lock; | |
7bfa4816 JK |
252 | #ifdef CONFIG_E1000_NAPI |
253 | spinlock_t tx_queue_lock; | |
254 | #endif | |
1da177e4 | 255 | atomic_t irq_sem; |
835bb129 JB |
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 */ | |
261 | uint32_t itr; | |
262 | uint32_t itr_setting; | |
263 | uint16_t tx_itr; | |
264 | uint16_t rx_itr; | |
265 | ||
87041639 | 266 | struct work_struct reset_task; |
1da177e4 LT |
267 | uint8_t fc_autoneg; |
268 | ||
269 | struct timer_list blink_timer; | |
270 | unsigned long led_status; | |
271 | ||
272 | /* TX */ | |
581d708e | 273 | struct e1000_tx_ring *tx_ring; /* One per active queue */ |
fcfb1224 | 274 | unsigned int restart_queue; |
f56799ea | 275 | unsigned long tx_queue_len; |
1da177e4 LT |
276 | uint32_t txd_cmd; |
277 | uint32_t tx_int_delay; | |
278 | uint32_t tx_abs_int_delay; | |
279 | uint32_t gotcl; | |
280 | uint64_t gotcl_old; | |
281 | uint64_t tpt_old; | |
282 | uint64_t colc_old; | |
6b7660cd | 283 | uint32_t tx_timeout_count; |
1da177e4 LT |
284 | uint32_t tx_fifo_head; |
285 | uint32_t tx_head_addr; | |
286 | uint32_t tx_fifo_size; | |
66a2b0a3 | 287 | uint8_t tx_timeout_factor; |
1da177e4 LT |
288 | atomic_t tx_fifo_stall; |
289 | boolean_t pcix_82544; | |
290 | boolean_t detect_tx_hung; | |
291 | ||
292 | /* RX */ | |
2d7edb92 | 293 | #ifdef CONFIG_E1000_NAPI |
581d708e | 294 | boolean_t (*clean_rx) (struct e1000_adapter *adapter, |
0f15a8fa JK |
295 | struct e1000_rx_ring *rx_ring, |
296 | int *work_done, int work_to_do); | |
2d7edb92 | 297 | #else |
581d708e | 298 | boolean_t (*clean_rx) (struct e1000_adapter *adapter, |
0f15a8fa | 299 | struct e1000_rx_ring *rx_ring); |
2d7edb92 | 300 | #endif |
581d708e | 301 | void (*alloc_rx_buf) (struct e1000_adapter *adapter, |
0f15a8fa JK |
302 | struct e1000_rx_ring *rx_ring, |
303 | int cleaned_count); | |
581d708e MC |
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 */ | |
581d708e | 307 | #endif |
f56799ea JK |
308 | int num_tx_queues; |
309 | int num_rx_queues; | |
581d708e | 310 | |
1da177e4 LT |
311 | uint64_t hw_csum_err; |
312 | uint64_t hw_csum_good; | |
e4c811c9 | 313 | uint64_t rx_hdr_split; |
6b7660cd | 314 | uint32_t alloc_rx_buff_failed; |
1da177e4 LT |
315 | uint32_t rx_int_delay; |
316 | uint32_t rx_abs_int_delay; | |
317 | boolean_t rx_csum; | |
e4c811c9 | 318 | unsigned int rx_ps_pages; |
1da177e4 LT |
319 | uint32_t gorcl; |
320 | uint64_t gorcl_old; | |
2d7edb92 | 321 | uint16_t rx_ps_bsize0; |
1da177e4 | 322 | |
1da177e4 LT |
323 | |
324 | /* OS defined structs */ | |
325 | struct net_device *netdev; | |
326 | struct pci_dev *pdev; | |
327 | struct net_device_stats net_stats; | |
328 | ||
329 | /* structs defined in e1000_hw.h */ | |
330 | struct e1000_hw hw; | |
331 | struct e1000_hw_stats stats; | |
332 | struct e1000_phy_info phy_info; | |
333 | struct e1000_phy_stats phy_stats; | |
334 | ||
335 | uint32_t test_icr; | |
581d708e MC |
336 | struct e1000_tx_ring test_tx_ring; |
337 | struct e1000_rx_ring test_rx_ring; | |
1da177e4 LT |
338 | |
339 | ||
87041639 | 340 | uint32_t *config_space; |
1da177e4 | 341 | int msg_enable; |
fa4f7ef3 MC |
342 | #ifdef CONFIG_PCI_MSI |
343 | boolean_t have_msi; | |
7e6c9861 JK |
344 | #endif |
345 | /* to not mess up cache alignment, always add to the bottom */ | |
7e6c9861 | 346 | boolean_t tso_force; |
9a53a202 | 347 | boolean_t smart_power_down; /* phy smart power down */ |
120cd576 | 348 | boolean_t quad_port_a; |
2db10a08 | 349 | unsigned long flags; |
120cd576 | 350 | uint32_t eeprom_wol; |
1da177e4 | 351 | }; |
30dcbf29 | 352 | |
2db10a08 | 353 | enum e1000_state_t { |
1314bbf3 | 354 | __E1000_TESTING, |
2db10a08 | 355 | __E1000_RESETTING, |
1314bbf3 | 356 | __E1000_DOWN |
2db10a08 | 357 | }; |
30dcbf29 | 358 | |
1da177e4 | 359 | #endif /* _E1000_H_ */ |