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 | ||
1da177e4 LT |
84 | #define E1000_MAX_INTR 10 |
85 | ||
86 | /* TX/RX descriptor defines */ | |
87 | #define E1000_DEFAULT_TXD 256 | |
88 | #define E1000_MAX_TXD 256 | |
b5954464 | 89 | #define E1000_MIN_TXD 48 |
1da177e4 LT |
90 | #define E1000_MAX_82544_TXD 4096 |
91 | ||
92 | #define E1000_DEFAULT_RXD 256 | |
93 | #define E1000_MAX_RXD 256 | |
b5954464 | 94 | #define E1000_MIN_RXD 48 |
1da177e4 LT |
95 | #define E1000_MAX_82544_RXD 4096 |
96 | ||
94c9e5a8 JB |
97 | #define E1000_MIN_ITR_USECS 10 /* 100000 irq/sec */ |
98 | #define E1000_MAX_ITR_USECS 10000 /* 100 irq/sec */ | |
99 | ||
eb0f8054 AK |
100 | /* this is the size past which hardware will drop packets when setting LPE=0 */ |
101 | #define MAXIMUM_ETHERNET_VLAN_SIZE 1522 | |
102 | ||
1da177e4 | 103 | /* Supported Rx Buffer Sizes */ |
2d7edb92 MC |
104 | #define E1000_RXBUFFER_128 128 /* Used for packet split */ |
105 | #define E1000_RXBUFFER_256 256 /* Used for packet split */ | |
9e2feace AK |
106 | #define E1000_RXBUFFER_512 512 |
107 | #define E1000_RXBUFFER_1024 1024 | |
1da177e4 LT |
108 | #define E1000_RXBUFFER_2048 2048 |
109 | #define E1000_RXBUFFER_4096 4096 | |
110 | #define E1000_RXBUFFER_8192 8192 | |
111 | #define E1000_RXBUFFER_16384 16384 | |
112 | ||
113 | /* SmartSpeed delimiters */ | |
114 | #define E1000_SMARTSPEED_DOWNSHIFT 3 | |
115 | #define E1000_SMARTSPEED_MAX 15 | |
116 | ||
117 | /* Packet Buffer allocations */ | |
118 | #define E1000_PBA_BYTES_SHIFT 0xA | |
119 | #define E1000_TX_HEAD_ADDR_SHIFT 7 | |
120 | #define E1000_PBA_TX_MASK 0xFFFF0000 | |
121 | ||
122 | /* Flow Control Watermarks */ | |
123 | #define E1000_FC_HIGH_DIFF 0x1638 /* High: 5688 bytes below Rx FIFO size */ | |
124 | #define E1000_FC_LOW_DIFF 0x1640 /* Low: 5696 bytes below Rx FIFO size */ | |
125 | ||
edbbb3ca | 126 | #define E1000_FC_PAUSE_TIME 0xFFFF /* pause for the max or until send xon */ |
1da177e4 LT |
127 | |
128 | /* How many Tx Descriptors do we need to call netif_wake_queue ? */ | |
129 | #define E1000_TX_QUEUE_WAKE 16 | |
130 | /* How many Rx Buffers do we bundle into one write to the hardware ? */ | |
131 | #define E1000_RX_BUFFER_WRITE 16 /* Must be power of 2 */ | |
132 | ||
2648345f | 133 | #define AUTO_ALL_MODES 0 |
70cf362b | 134 | #define E1000_EEPROM_82544_APM 0x0004 |
2648345f | 135 | #define E1000_EEPROM_APME 0x0400 |
1da177e4 LT |
136 | |
137 | #ifndef E1000_MASTER_SLAVE | |
138 | /* Switch to override PHY master/slave setting */ | |
139 | #define E1000_MASTER_SLAVE e1000_ms_hw_default | |
140 | #endif | |
141 | ||
b1184020 | 142 | #define E1000_MNG_VLAN_NONE (-1) |
2d7edb92 | 143 | |
1da177e4 LT |
144 | /* wrapper around a pointer to a socket buffer, |
145 | * so a DMA handle can be stored along with the buffer */ | |
146 | struct e1000_buffer { | |
147 | struct sk_buff *skb; | |
c6963ef5 | 148 | dma_addr_t dma; |
edbbb3ca | 149 | struct page *page; |
1da177e4 | 150 | unsigned long time_stamp; |
406874a7 JP |
151 | u16 length; |
152 | u16 next_to_watch; | |
602c0554 | 153 | u16 mapped_as_page; |
1da177e4 LT |
154 | }; |
155 | ||
581d708e MC |
156 | struct e1000_tx_ring { |
157 | /* pointer to the descriptor ring memory */ | |
158 | void *desc; | |
159 | /* physical address of the descriptor ring */ | |
160 | dma_addr_t dma; | |
161 | /* length of descriptor ring in bytes */ | |
162 | unsigned int size; | |
163 | /* number of descriptors in the ring */ | |
164 | unsigned int count; | |
165 | /* next descriptor to associate a buffer with */ | |
166 | unsigned int next_to_use; | |
167 | /* next descriptor to check for DD status bit */ | |
168 | unsigned int next_to_clean; | |
169 | /* array of buffer information structs */ | |
170 | struct e1000_buffer *buffer_info; | |
171 | ||
406874a7 JP |
172 | u16 tdh; |
173 | u16 tdt; | |
c3033b01 | 174 | bool last_tx_tso; |
581d708e MC |
175 | }; |
176 | ||
177 | struct e1000_rx_ring { | |
1da177e4 LT |
178 | /* pointer to the descriptor ring memory */ |
179 | void *desc; | |
180 | /* physical address of the descriptor ring */ | |
181 | dma_addr_t dma; | |
182 | /* length of descriptor ring in bytes */ | |
183 | unsigned int size; | |
184 | /* number of descriptors in the ring */ | |
185 | unsigned int count; | |
186 | /* next descriptor to associate a buffer with */ | |
187 | unsigned int next_to_use; | |
188 | /* next descriptor to check for DD status bit */ | |
189 | unsigned int next_to_clean; | |
190 | /* array of buffer information structs */ | |
191 | struct e1000_buffer *buffer_info; | |
edbbb3ca | 192 | struct sk_buff *rx_skb_top; |
581d708e | 193 | |
545c67c0 JK |
194 | /* cpu for rx queue */ |
195 | int cpu; | |
196 | ||
406874a7 JP |
197 | u16 rdh; |
198 | u16 rdt; | |
1da177e4 LT |
199 | }; |
200 | ||
b1184020 JP |
201 | #define E1000_DESC_UNUSED(R) \ |
202 | ((((R)->next_to_clean > (R)->next_to_use) \ | |
203 | ? 0 : (R)->count) + (R)->next_to_clean - (R)->next_to_use - 1) | |
1da177e4 | 204 | |
b1184020 | 205 | #define E1000_RX_DESC_EXT(R, i) \ |
2d7edb92 | 206 | (&(((union e1000_rx_desc_extended *)((R).desc))[i])) |
1da177e4 LT |
207 | #define E1000_GET_DESC(R, i, type) (&(((struct type *)((R).desc))[i])) |
208 | #define E1000_RX_DESC(R, i) E1000_GET_DESC(R, i, e1000_rx_desc) | |
209 | #define E1000_TX_DESC(R, i) E1000_GET_DESC(R, i, e1000_tx_desc) | |
210 | #define E1000_CONTEXT_DESC(R, i) E1000_GET_DESC(R, i, e1000_context_desc) | |
211 | ||
212 | /* board specific private data structure */ | |
213 | ||
214 | struct e1000_adapter { | |
215 | struct timer_list tx_fifo_stall_timer; | |
216 | struct timer_list watchdog_timer; | |
217 | struct timer_list phy_info_timer; | |
218 | struct vlan_group *vlgrp; | |
406874a7 JP |
219 | u16 mng_vlan_id; |
220 | u32 bd_number; | |
221 | u32 rx_buffer_len; | |
222 | u32 wol; | |
223 | u32 smartspeed; | |
224 | u32 en_mng_pt; | |
225 | u16 link_speed; | |
226 | u16 link_duplex; | |
1da177e4 | 227 | spinlock_t stats_lock; |
835bb129 JB |
228 | unsigned int total_tx_bytes; |
229 | unsigned int total_tx_packets; | |
230 | unsigned int total_rx_bytes; | |
231 | unsigned int total_rx_packets; | |
232 | /* Interrupt Throttle Rate */ | |
406874a7 JP |
233 | u32 itr; |
234 | u32 itr_setting; | |
235 | u16 tx_itr; | |
236 | u16 rx_itr; | |
835bb129 | 237 | |
87041639 | 238 | struct work_struct reset_task; |
406874a7 | 239 | u8 fc_autoneg; |
1da177e4 LT |
240 | |
241 | struct timer_list blink_timer; | |
242 | unsigned long led_status; | |
243 | ||
244 | /* TX */ | |
581d708e | 245 | struct e1000_tx_ring *tx_ring; /* One per active queue */ |
fcfb1224 | 246 | unsigned int restart_queue; |
406874a7 JP |
247 | u32 txd_cmd; |
248 | u32 tx_int_delay; | |
249 | u32 tx_abs_int_delay; | |
250 | u32 gotcl; | |
251 | u64 gotcl_old; | |
252 | u64 tpt_old; | |
253 | u64 colc_old; | |
254 | u32 tx_timeout_count; | |
255 | u32 tx_fifo_head; | |
256 | u32 tx_head_addr; | |
257 | u32 tx_fifo_size; | |
258 | u8 tx_timeout_factor; | |
1da177e4 | 259 | atomic_t tx_fifo_stall; |
c3033b01 JP |
260 | bool pcix_82544; |
261 | bool detect_tx_hung; | |
1da177e4 LT |
262 | |
263 | /* RX */ | |
e982f17c JP |
264 | bool (*clean_rx)(struct e1000_adapter *adapter, |
265 | struct e1000_rx_ring *rx_ring, | |
266 | int *work_done, int work_to_do); | |
e982f17c JP |
267 | void (*alloc_rx_buf)(struct e1000_adapter *adapter, |
268 | struct e1000_rx_ring *rx_ring, | |
269 | int cleaned_count); | |
581d708e | 270 | struct e1000_rx_ring *rx_ring; /* One per active queue */ |
bea3348e | 271 | struct napi_struct napi; |
c3570acb | 272 | |
f56799ea JK |
273 | int num_tx_queues; |
274 | int num_rx_queues; | |
581d708e | 275 | |
406874a7 JP |
276 | u64 hw_csum_err; |
277 | u64 hw_csum_good; | |
406874a7 JP |
278 | u32 alloc_rx_buff_failed; |
279 | u32 rx_int_delay; | |
280 | u32 rx_abs_int_delay; | |
c3033b01 | 281 | bool rx_csum; |
406874a7 JP |
282 | u32 gorcl; |
283 | u64 gorcl_old; | |
1da177e4 | 284 | |
1da177e4 LT |
285 | /* OS defined structs */ |
286 | struct net_device *netdev; | |
287 | struct pci_dev *pdev; | |
1da177e4 LT |
288 | |
289 | /* structs defined in e1000_hw.h */ | |
290 | struct e1000_hw hw; | |
291 | struct e1000_hw_stats stats; | |
292 | struct e1000_phy_info phy_info; | |
293 | struct e1000_phy_stats phy_stats; | |
294 | ||
406874a7 | 295 | u32 test_icr; |
581d708e MC |
296 | struct e1000_tx_ring test_tx_ring; |
297 | struct e1000_rx_ring test_rx_ring; | |
1da177e4 | 298 | |
1da177e4 | 299 | int msg_enable; |
e94bd23f | 300 | |
7e6c9861 | 301 | /* to not mess up cache alignment, always add to the bottom */ |
c3033b01 JP |
302 | bool tso_force; |
303 | bool smart_power_down; /* phy smart power down */ | |
304 | bool quad_port_a; | |
2db10a08 | 305 | unsigned long flags; |
406874a7 | 306 | u32 eeprom_wol; |
81250297 TI |
307 | |
308 | /* for ioport free */ | |
309 | int bars; | |
310 | int need_ioport; | |
40a14dea JB |
311 | |
312 | bool discarding; | |
1da177e4 | 313 | }; |
30dcbf29 | 314 | |
2db10a08 | 315 | enum e1000_state_t { |
1314bbf3 | 316 | __E1000_TESTING, |
2db10a08 | 317 | __E1000_RESETTING, |
1314bbf3 | 318 | __E1000_DOWN |
2db10a08 | 319 | }; |
30dcbf29 | 320 | |
675ad473 ET |
321 | #undef pr_fmt |
322 | #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt | |
323 | ||
324 | extern struct net_device *e1000_get_hw_dev(struct e1000_hw *hw); | |
325 | #define e_dbg(format, arg...) \ | |
326 | netdev_dbg(e1000_get_hw_dev(hw), format, ## arg) | |
feb8f478 ET |
327 | #define e_err(msglvl, format, arg...) \ |
328 | netif_err(adapter, msglvl, adapter->netdev, format, ## arg) | |
329 | #define e_info(msglvl, format, arg...) \ | |
330 | netif_info(adapter, msglvl, adapter->netdev, format, ## arg) | |
331 | #define e_warn(msglvl, format, arg...) \ | |
332 | netif_warn(adapter, msglvl, adapter->netdev, format, ## arg) | |
333 | #define e_notice(msglvl, format, arg...) \ | |
334 | netif_notice(adapter, msglvl, adapter->netdev, format, ## arg) | |
675ad473 ET |
335 | #define e_dev_info(format, arg...) \ |
336 | dev_info(&adapter->pdev->dev, format, ## arg) | |
337 | #define e_dev_warn(format, arg...) \ | |
338 | dev_warn(&adapter->pdev->dev, format, ## arg) | |
feb8f478 ET |
339 | #define e_dev_err(format, arg...) \ |
340 | dev_err(&adapter->pdev->dev, format, ## arg) | |
675ad473 | 341 | |
abec42a4 SH |
342 | extern char e1000_driver_name[]; |
343 | extern const char e1000_driver_version[]; | |
344 | ||
c03e83b0 JP |
345 | extern int e1000_up(struct e1000_adapter *adapter); |
346 | extern void e1000_down(struct e1000_adapter *adapter); | |
347 | extern void e1000_reinit_locked(struct e1000_adapter *adapter); | |
348 | extern void e1000_reset(struct e1000_adapter *adapter); | |
349 | extern int e1000_set_spd_dplx(struct e1000_adapter *adapter, u16 spddplx); | |
350 | extern int e1000_setup_all_rx_resources(struct e1000_adapter *adapter); | |
351 | extern int e1000_setup_all_tx_resources(struct e1000_adapter *adapter); | |
352 | extern void e1000_free_all_rx_resources(struct e1000_adapter *adapter); | |
353 | extern void e1000_free_all_tx_resources(struct e1000_adapter *adapter); | |
354 | extern void e1000_update_stats(struct e1000_adapter *adapter); | |
b548192a | 355 | extern bool e1000_has_link(struct e1000_adapter *adapter); |
abec42a4 SH |
356 | extern void e1000_power_up_phy(struct e1000_adapter *); |
357 | extern void e1000_set_ethtool_ops(struct net_device *netdev); | |
358 | extern void e1000_check_options(struct e1000_adapter *adapter); | |
675ad473 | 359 | extern char *e1000_get_hw_dev_name(struct e1000_hw *hw); |
abec42a4 | 360 | |
1da177e4 | 361 | #endif /* _E1000_H_ */ |