1 /*******************************************************************************
3 Intel(R) Gigabit Ethernet Linux driver
4 Copyright(c) 2007-2009 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"
39 /* Interrupt defines */
40 #define IGB_MIN_DYN_ITR 3000
41 #define IGB_MAX_DYN_ITR 96000
43 /* ((1000000000ns / (6000ints/s * 1024ns)) << 2 = 648 */
44 #define IGB_START_ITR 648
46 #define IGB_DYN_ITR_PACKET_THRESHOLD 2
47 #define IGB_DYN_ITR_LENGTH_LOW 200
48 #define IGB_DYN_ITR_LENGTH_HIGH 1000
50 /* TX/RX descriptor defines */
51 #define IGB_DEFAULT_TXD 256
52 #define IGB_MIN_TXD 80
53 #define IGB_MAX_TXD 4096
55 #define IGB_DEFAULT_RXD 256
56 #define IGB_MIN_RXD 80
57 #define IGB_MAX_RXD 4096
59 #define IGB_DEFAULT_ITR 3 /* dynamic */
60 #define IGB_MAX_ITR_USECS 10000
61 #define IGB_MIN_ITR_USECS 10
63 /* Transmit and receive queues */
64 #define IGB_MAX_RX_QUEUES 4
65 #define IGB_MAX_TX_QUEUES 4
67 /* RX descriptor control thresholds.
68 * PTHRESH - MAC will consider prefetch if it has fewer than this number of
69 * descriptors available in its onboard memory.
70 * Setting this to 0 disables RX descriptor prefetch.
71 * HTHRESH - MAC will only prefetch if there are at least this many descriptors
72 * available in host memory.
73 * If PTHRESH is 0, this should also be 0.
74 * WTHRESH - RX descriptor writeback threshold - MAC will delay writing back
75 * descriptors until either it has this many to write back, or the
78 #define IGB_RX_PTHRESH 16
79 #define IGB_RX_HTHRESH 8
80 #define IGB_RX_WTHRESH 1
82 /* this is the size past which hardware will drop packets when setting LPE=0 */
83 #define MAXIMUM_ETHERNET_VLAN_SIZE 1522
85 /* Supported Rx Buffer Sizes */
86 #define IGB_RXBUFFER_128 128 /* Used for packet split */
87 #define IGB_RXBUFFER_256 256 /* Used for packet split */
88 #define IGB_RXBUFFER_512 512
89 #define IGB_RXBUFFER_1024 1024
90 #define IGB_RXBUFFER_2048 2048
91 #define IGB_RXBUFFER_4096 4096
92 #define IGB_RXBUFFER_8192 8192
93 #define IGB_RXBUFFER_16384 16384
95 /* Packet Buffer allocations */
98 /* How many Tx Descriptors do we need to call netif_wake_queue ? */
99 #define IGB_TX_QUEUE_WAKE 16
100 /* How many Rx Buffers do we bundle into one write to the hardware ? */
101 #define IGB_RX_BUFFER_WRITE 16 /* Must be power of 2 */
103 #define AUTO_ALL_MODES 0
104 #define IGB_EEPROM_APME 0x0400
106 #ifndef IGB_MASTER_SLAVE
107 /* Switch to override PHY master/slave setting */
108 #define IGB_MASTER_SLAVE e1000_ms_hw_default
111 #define IGB_MNG_VLAN_NONE -1
113 /* wrapper around a pointer to a socket buffer,
114 * so a DMA handle can be stored along with the buffer */
121 unsigned long time_stamp;
129 unsigned int page_offset;
134 struct igb_queue_stats {
140 struct igb_adapter *adapter; /* backlink */
141 void *desc; /* descriptor ring memory */
142 dma_addr_t dma; /* phys address of the ring */
143 unsigned int size; /* length of desc. ring in bytes */
144 unsigned int count; /* number of desc. in the ring */
149 struct igb_buffer *buffer_info; /* array of buffer info structs */
158 unsigned int total_bytes;
159 unsigned int total_packets;
164 struct igb_queue_stats tx_stats;
169 struct igb_queue_stats rx_stats;
170 struct napi_struct napi;
172 struct igb_ring *buddy;
176 char name[IFNAMSIZ + 5];
179 #define IGB_DESC_UNUSED(R) \
180 ((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
181 (R)->next_to_clean - (R)->next_to_use - 1)
183 #define E1000_RX_DESC_ADV(R, i) \
184 (&(((union e1000_adv_rx_desc *)((R).desc))[i]))
185 #define E1000_TX_DESC_ADV(R, i) \
186 (&(((union e1000_adv_tx_desc *)((R).desc))[i]))
187 #define E1000_TX_CTXTDESC_ADV(R, i) \
188 (&(((struct e1000_adv_tx_context_desc *)((R).desc))[i]))
189 #define E1000_GET_DESC(R, i, type) (&(((struct type *)((R).desc))[i]))
190 #define E1000_TX_DESC(R, i) E1000_GET_DESC(R, i, e1000_tx_desc)
191 #define E1000_RX_DESC(R, i) E1000_GET_DESC(R, i, e1000_rx_desc)
193 /* board specific private data structure */
196 struct timer_list watchdog_timer;
197 struct timer_list phy_info_timer;
198 struct vlan_group *vlgrp;
206 unsigned int total_tx_bytes;
207 unsigned int total_tx_packets;
208 unsigned int total_rx_bytes;
209 unsigned int total_rx_packets;
210 /* Interrupt Throttle Rate */
216 struct work_struct reset_task;
217 struct work_struct watchdog_task;
219 u8 tx_timeout_factor;
220 struct timer_list blink_timer;
221 unsigned long led_status;
224 struct igb_ring *tx_ring; /* One per active queue */
225 unsigned int restart_queue;
226 unsigned long tx_queue_len;
232 u32 tx_timeout_count;
235 struct igb_ring *rx_ring; /* One per active queue */
241 u32 alloc_rx_buff_failed;
249 /* OS defined structs */
250 struct net_device *netdev;
251 struct napi_struct napi;
252 struct pci_dev *pdev;
253 struct net_device_stats net_stats;
255 /* structs defined in e1000_hw.h */
257 struct e1000_hw_stats stats;
258 struct e1000_phy_info phy_info;
259 struct e1000_phy_stats phy_stats;
262 struct igb_ring test_tx_ring;
263 struct igb_ring test_rx_ring;
266 struct msix_entry *msix_entries;
267 u32 eims_enable_mask;
270 /* to not mess up cache alignment, always add to the bottom */
275 struct igb_ring *multi_tx_table[IGB_MAX_TX_QUEUES];
276 unsigned int tx_ring_count;
277 unsigned int rx_ring_count;
280 #define IGB_FLAG_HAS_MSI (1 << 0)
281 #define IGB_FLAG_MSI_ENABLE (1 << 1)
282 #define IGB_FLAG_DCA_ENABLED (1 << 2)
283 #define IGB_FLAG_QUAD_PORT_A (1 << 3)
284 #define IGB_FLAG_NEED_CTX_IDX (1 << 4)
296 extern char igb_driver_name[];
297 extern char igb_driver_version[];
299 extern char *igb_get_hw_dev_name(struct e1000_hw *hw);
300 extern int igb_up(struct igb_adapter *);
301 extern void igb_down(struct igb_adapter *);
302 extern void igb_reinit_locked(struct igb_adapter *);
303 extern void igb_reset(struct igb_adapter *);
304 extern int igb_set_spd_dplx(struct igb_adapter *, u16);
305 extern int igb_setup_tx_resources(struct igb_adapter *, struct igb_ring *);
306 extern int igb_setup_rx_resources(struct igb_adapter *, struct igb_ring *);
307 extern void igb_free_tx_resources(struct igb_ring *);
308 extern void igb_free_rx_resources(struct igb_ring *);
309 extern void igb_update_stats(struct igb_adapter *);
310 extern void igb_set_ethtool_ops(struct net_device *);
312 static inline s32 igb_reset_phy(struct e1000_hw *hw)
314 if (hw->phy.ops.reset)
315 return hw->phy.ops.reset(hw);
320 static inline s32 igb_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data)
322 if (hw->phy.ops.read_reg)
323 return hw->phy.ops.read_reg(hw, offset, data);
328 static inline s32 igb_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data)
330 if (hw->phy.ops.write_reg)
331 return hw->phy.ops.write_reg(hw, offset, data);
336 static inline s32 igb_get_phy_info(struct e1000_hw *hw)
338 if (hw->phy.ops.get_phy_info)
339 return hw->phy.ops.get_phy_info(hw);