tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1/*******************************************************************************
2
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
13 more details.
14
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.
18
19 The full GNU General Public License is included in this distribution in
20 the file called "COPYING".
21
22 Contact Information:
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
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>
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>
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>
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
80struct e1000_adapter;
81
82#include "e1000_hw.h"
83
84#define E1000_MAX_INTR 10
85
86/* TX/RX descriptor defines */
87#define E1000_DEFAULT_TXD 256
88#define E1000_MAX_TXD 256
89#define E1000_MIN_TXD 48
90#define E1000_MAX_82544_TXD 4096
91
92#define E1000_DEFAULT_RXD 256
93#define E1000_MAX_RXD 256
94#define E1000_MIN_RXD 48
95#define E1000_MAX_82544_RXD 4096
96
97#define E1000_MIN_ITR_USECS 10 /* 100000 irq/sec */
98#define E1000_MAX_ITR_USECS 10000 /* 100 irq/sec */
99
100/* this is the size past which hardware will drop packets when setting LPE=0 */
101#define MAXIMUM_ETHERNET_VLAN_SIZE 1522
102
103/* Supported Rx Buffer Sizes */
104#define E1000_RXBUFFER_128 128 /* Used for packet split */
105#define E1000_RXBUFFER_256 256 /* Used for packet split */
106#define E1000_RXBUFFER_512 512
107#define E1000_RXBUFFER_1024 1024
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
126#define E1000_FC_PAUSE_TIME 0xFFFF /* pause for the max or until send xon */
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
133#define AUTO_ALL_MODES 0
134#define E1000_EEPROM_82544_APM 0x0004
135#define E1000_EEPROM_APME 0x0400
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
142#define E1000_MNG_VLAN_NONE (-1)
143
144/* wrapper around a pointer to a socket buffer,
145 * so a DMA handle can be stored along with the buffer */
146struct e1000_buffer {
147 struct sk_buff *skb;
148 dma_addr_t dma;
149 struct page *page;
150 unsigned long time_stamp;
151 u16 length;
152 u16 next_to_watch;
153 u16 mapped_as_page;
154};
155
156struct 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
172 u16 tdh;
173 u16 tdt;
174 bool last_tx_tso;
175};
176
177struct e1000_rx_ring {
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;
192 struct sk_buff *rx_skb_top;
193
194 /* cpu for rx queue */
195 int cpu;
196
197 u16 rdh;
198 u16 rdt;
199};
200
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)
204
205#define E1000_RX_DESC_EXT(R, i) \
206 (&(((union e1000_rx_desc_extended *)((R).desc))[i]))
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
214struct 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;
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;
227 spinlock_t stats_lock;
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 */
233 u32 itr;
234 u32 itr_setting;
235 u16 tx_itr;
236 u16 rx_itr;
237
238 struct work_struct reset_task;
239 u8 fc_autoneg;
240
241 struct timer_list blink_timer;
242 unsigned long led_status;
243
244 /* TX */
245 struct e1000_tx_ring *tx_ring; /* One per active queue */
246 unsigned int restart_queue;
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;
259 atomic_t tx_fifo_stall;
260 bool pcix_82544;
261 bool detect_tx_hung;
262
263 /* RX */
264 bool (*clean_rx)(struct e1000_adapter *adapter,
265 struct e1000_rx_ring *rx_ring,
266 int *work_done, int work_to_do);
267 void (*alloc_rx_buf)(struct e1000_adapter *adapter,
268 struct e1000_rx_ring *rx_ring,
269 int cleaned_count);
270 struct e1000_rx_ring *rx_ring; /* One per active queue */
271 struct napi_struct napi;
272
273 int num_tx_queues;
274 int num_rx_queues;
275
276 u64 hw_csum_err;
277 u64 hw_csum_good;
278 u32 alloc_rx_buff_failed;
279 u32 rx_int_delay;
280 u32 rx_abs_int_delay;
281 bool rx_csum;
282 u32 gorcl;
283 u64 gorcl_old;
284
285 /* OS defined structs */
286 struct net_device *netdev;
287 struct pci_dev *pdev;
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
295 u32 test_icr;
296 struct e1000_tx_ring test_tx_ring;
297 struct e1000_rx_ring test_rx_ring;
298
299 int msg_enable;
300
301 /* to not mess up cache alignment, always add to the bottom */
302 bool tso_force;
303 bool smart_power_down; /* phy smart power down */
304 bool quad_port_a;
305 unsigned long flags;
306 u32 eeprom_wol;
307
308 /* for ioport free */
309 int bars;
310 int need_ioport;
311
312 bool discarding;
313
314 struct work_struct fifo_stall_task;
315 struct work_struct phy_info_task;
316};
317
318enum e1000_state_t {
319 __E1000_TESTING,
320 __E1000_RESETTING,
321 __E1000_DOWN
322};
323
324#undef pr_fmt
325#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
326
327extern struct net_device *e1000_get_hw_dev(struct e1000_hw *hw);
328#define e_dbg(format, arg...) \
329 netdev_dbg(e1000_get_hw_dev(hw), format, ## arg)
330#define e_err(msglvl, format, arg...) \
331 netif_err(adapter, msglvl, adapter->netdev, format, ## arg)
332#define e_info(msglvl, format, arg...) \
333 netif_info(adapter, msglvl, adapter->netdev, format, ## arg)
334#define e_warn(msglvl, format, arg...) \
335 netif_warn(adapter, msglvl, adapter->netdev, format, ## arg)
336#define e_notice(msglvl, format, arg...) \
337 netif_notice(adapter, msglvl, adapter->netdev, format, ## arg)
338#define e_dev_info(format, arg...) \
339 dev_info(&adapter->pdev->dev, format, ## arg)
340#define e_dev_warn(format, arg...) \
341 dev_warn(&adapter->pdev->dev, format, ## arg)
342#define e_dev_err(format, arg...) \
343 dev_err(&adapter->pdev->dev, format, ## arg)
344
345extern char e1000_driver_name[];
346extern const char e1000_driver_version[];
347
348extern int e1000_up(struct e1000_adapter *adapter);
349extern void e1000_down(struct e1000_adapter *adapter);
350extern void e1000_reinit_locked(struct e1000_adapter *adapter);
351extern void e1000_reset(struct e1000_adapter *adapter);
352extern int e1000_set_spd_dplx(struct e1000_adapter *adapter, u16 spddplx);
353extern int e1000_setup_all_rx_resources(struct e1000_adapter *adapter);
354extern int e1000_setup_all_tx_resources(struct e1000_adapter *adapter);
355extern void e1000_free_all_rx_resources(struct e1000_adapter *adapter);
356extern void e1000_free_all_tx_resources(struct e1000_adapter *adapter);
357extern void e1000_update_stats(struct e1000_adapter *adapter);
358extern bool e1000_has_link(struct e1000_adapter *adapter);
359extern void e1000_power_up_phy(struct e1000_adapter *);
360extern void e1000_set_ethtool_ops(struct net_device *netdev);
361extern void e1000_check_options(struct e1000_adapter *adapter);
362extern char *e1000_get_hw_dev_name(struct e1000_hw *hw);
363
364#endif /* _E1000_H_ */