1 /*******************************************************************************
3 Intel(R) Gigabit Ethernet Linux driver
4 Copyright(c) 2007 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 e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
24 Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
26 *******************************************************************************/
29 /* Linux PRO/1000 Ethernet Driver main header file */
34 #include "e1000_mac.h"
35 #include "e1000_82575.h"
40 #include <linux/inet_lro.h>
41 #define MAX_LRO_AGGR 32
42 #define MAX_LRO_DESCRIPTORS 8
45 /* Interrupt defines */
46 #define IGB_MAX_TX_CLEAN 72
48 #define IGB_MIN_DYN_ITR 3000
49 #define IGB_MAX_DYN_ITR 96000
50 #define IGB_START_ITR 6000
52 #define IGB_DYN_ITR_PACKET_THRESHOLD 2
53 #define IGB_DYN_ITR_LENGTH_LOW 200
54 #define IGB_DYN_ITR_LENGTH_HIGH 1000
56 /* TX/RX descriptor defines */
57 #define IGB_DEFAULT_TXD 256
58 #define IGB_MIN_TXD 80
59 #define IGB_MAX_TXD 4096
61 #define IGB_DEFAULT_RXD 256
62 #define IGB_MIN_RXD 80
63 #define IGB_MAX_RXD 4096
65 #define IGB_DEFAULT_ITR 3 /* dynamic */
66 #define IGB_MAX_ITR_USECS 10000
67 #define IGB_MIN_ITR_USECS 10
69 /* Transmit and receive queues */
70 #define IGB_MAX_RX_QUEUES 4
71 #define IGB_MAX_TX_QUEUES 4
73 /* RX descriptor control thresholds.
74 * PTHRESH - MAC will consider prefetch if it has fewer than this number of
75 * descriptors available in its onboard memory.
76 * Setting this to 0 disables RX descriptor prefetch.
77 * HTHRESH - MAC will only prefetch if there are at least this many descriptors
78 * available in host memory.
79 * If PTHRESH is 0, this should also be 0.
80 * WTHRESH - RX descriptor writeback threshold - MAC will delay writing back
81 * descriptors until either it has this many to write back, or the
84 #define IGB_RX_PTHRESH 16
85 #define IGB_RX_HTHRESH 8
86 #define IGB_RX_WTHRESH 1
88 /* this is the size past which hardware will drop packets when setting LPE=0 */
89 #define MAXIMUM_ETHERNET_VLAN_SIZE 1522
91 /* Supported Rx Buffer Sizes */
92 #define IGB_RXBUFFER_128 128 /* Used for packet split */
93 #define IGB_RXBUFFER_256 256 /* Used for packet split */
94 #define IGB_RXBUFFER_512 512
95 #define IGB_RXBUFFER_1024 1024
96 #define IGB_RXBUFFER_2048 2048
97 #define IGB_RXBUFFER_4096 4096
98 #define IGB_RXBUFFER_8192 8192
99 #define IGB_RXBUFFER_16384 16384
101 /* Packet Buffer allocations */
104 /* How many Tx Descriptors do we need to call netif_wake_queue ? */
105 #define IGB_TX_QUEUE_WAKE 16
106 /* How many Rx Buffers do we bundle into one write to the hardware ? */
107 #define IGB_RX_BUFFER_WRITE 16 /* Must be power of 2 */
109 #define AUTO_ALL_MODES 0
110 #define IGB_EEPROM_APME 0x0400
112 #ifndef IGB_MASTER_SLAVE
113 /* Switch to override PHY master/slave setting */
114 #define IGB_MASTER_SLAVE e1000_ms_hw_default
117 #define IGB_MNG_VLAN_NONE -1
119 /* wrapper around a pointer to a socket buffer,
120 * so a DMA handle can be stored along with the buffer */
127 unsigned long time_stamp;
134 unsigned int page_offset;
139 struct igb_queue_stats {
145 struct igb_adapter *adapter; /* backlink */
146 void *desc; /* descriptor ring memory */
147 dma_addr_t dma; /* phys address of the ring */
148 unsigned int size; /* length of desc. ring in bytes */
149 unsigned int count; /* number of desc. in the ring */
154 struct igb_buffer *buffer_info; /* array of buffer info structs */
162 unsigned int total_bytes;
163 unsigned int total_packets;
168 struct igb_queue_stats tx_stats;
174 struct igb_queue_stats rx_stats;
175 struct napi_struct napi;
176 #ifdef CONFIG_IGB_LRO
177 struct net_lro_mgr lro_mgr;
183 char name[IFNAMSIZ + 5];
186 #define IGB_DESC_UNUSED(R) \
187 ((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
188 (R)->next_to_clean - (R)->next_to_use - 1)
190 #define E1000_RX_DESC_ADV(R, i) \
191 (&(((union e1000_adv_rx_desc *)((R).desc))[i]))
192 #define E1000_TX_DESC_ADV(R, i) \
193 (&(((union e1000_adv_tx_desc *)((R).desc))[i]))
194 #define E1000_TX_CTXTDESC_ADV(R, i) \
195 (&(((struct e1000_adv_tx_context_desc *)((R).desc))[i]))
196 #define E1000_GET_DESC(R, i, type) (&(((struct type *)((R).desc))[i]))
197 #define E1000_TX_DESC(R, i) E1000_GET_DESC(R, i, e1000_tx_desc)
198 #define E1000_RX_DESC(R, i) E1000_GET_DESC(R, i, e1000_rx_desc)
200 /* board specific private data structure */
203 struct timer_list watchdog_timer;
204 struct timer_list phy_info_timer;
205 struct vlan_group *vlgrp;
213 unsigned int total_tx_bytes;
214 unsigned int total_tx_packets;
215 unsigned int total_rx_bytes;
216 unsigned int total_rx_packets;
217 /* Interrupt Throttle Rate */
224 struct work_struct reset_task;
225 struct work_struct watchdog_task;
227 u8 tx_timeout_factor;
228 struct timer_list blink_timer;
229 unsigned long led_status;
232 struct igb_ring *tx_ring; /* One per active queue */
233 unsigned int restart_queue;
234 unsigned long tx_queue_len;
240 u32 tx_timeout_count;
243 struct igb_ring *rx_ring; /* One per active queue */
250 u32 alloc_rx_buff_failed;
258 /* OS defined structs */
259 struct net_device *netdev;
260 struct napi_struct napi;
261 struct pci_dev *pdev;
262 struct net_device_stats net_stats;
264 /* structs defined in e1000_hw.h */
266 struct e1000_hw_stats stats;
267 struct e1000_phy_info phy_info;
268 struct e1000_phy_stats phy_stats;
271 struct igb_ring test_tx_ring;
272 struct igb_ring test_rx_ring;
275 struct msix_entry *msix_entries;
276 u32 eims_enable_mask;
279 /* to not mess up cache alignment, always add to the bottom */
284 /* for ioport free */
288 #ifdef CONFIG_NETDEVICES_MULTIQUEUE
289 struct igb_ring *multi_tx_table[IGB_MAX_TX_QUEUES];
290 #endif /* CONFIG_NETDEVICES_MULTIQUEUE */
291 #ifdef CONFIG_IGB_LRO
292 unsigned int lro_max_aggr;
293 unsigned int lro_aggregated;
294 unsigned int lro_flushed;
295 unsigned int lro_no_desc;
299 #define IGB_FLAG_HAS_MSI (1 << 0)
300 #define IGB_FLAG_MSI_ENABLE (1 << 1)
301 #define IGB_FLAG_HAS_DCA (1 << 2)
302 #define IGB_FLAG_DCA_ENABLED (1 << 3)
303 #define IGB_FLAG_IN_NETPOLL (1 << 5)
304 #define IGB_FLAG_QUAD_PORT_A (1 << 6)
305 #define IGB_FLAG_NEED_CTX_IDX (1 << 7)
317 extern char igb_driver_name[];
318 extern char igb_driver_version[];
320 extern char *igb_get_hw_dev_name(struct e1000_hw *hw);
321 extern int igb_up(struct igb_adapter *);
322 extern void igb_down(struct igb_adapter *);
323 extern void igb_reinit_locked(struct igb_adapter *);
324 extern void igb_reset(struct igb_adapter *);
325 extern int igb_set_spd_dplx(struct igb_adapter *, u16);
326 extern int igb_setup_tx_resources(struct igb_adapter *, struct igb_ring *);
327 extern int igb_setup_rx_resources(struct igb_adapter *, struct igb_ring *);
328 extern void igb_update_stats(struct igb_adapter *);
329 extern void igb_set_ethtool_ops(struct net_device *);