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"
37 #include <linux/clocksource.h>
38 #include <linux/timecompare.h>
39 #include <linux/net_tstamp.h>
43 /* ((1000000000ns / (6000ints/s * 1024ns)) << 2 = 648 */
44 #define IGB_START_ITR 648
46 /* TX/RX descriptor defines */
47 #define IGB_DEFAULT_TXD 256
48 #define IGB_MIN_TXD 80
49 #define IGB_MAX_TXD 4096
51 #define IGB_DEFAULT_RXD 256
52 #define IGB_MIN_RXD 80
53 #define IGB_MAX_RXD 4096
55 #define IGB_DEFAULT_ITR 3 /* dynamic */
56 #define IGB_MAX_ITR_USECS 10000
57 #define IGB_MIN_ITR_USECS 10
58 #define NON_Q_VECTORS 1
59 #define MAX_Q_VECTORS 8
61 /* Transmit and receive queues */
62 #define IGB_MAX_RX_QUEUES (adapter->vfs_allocated_count ? \
63 (adapter->vfs_allocated_count > 6 ? 1 : 2) : 4)
64 #define IGB_MAX_TX_QUEUES IGB_MAX_RX_QUEUES
65 #define IGB_ABS_MAX_TX_QUEUES 4
67 #define IGB_MAX_VF_MC_ENTRIES 30
68 #define IGB_MAX_VF_FUNCTIONS 8
69 #define IGB_MAX_VFTA_ENTRIES 128
71 struct vf_data_storage
{
72 unsigned char vf_mac_addresses
[ETH_ALEN
];
73 u16 vf_mc_hashes
[IGB_MAX_VF_MC_ENTRIES
];
79 /* RX descriptor control thresholds.
80 * PTHRESH - MAC will consider prefetch if it has fewer than this number of
81 * descriptors available in its onboard memory.
82 * Setting this to 0 disables RX descriptor prefetch.
83 * HTHRESH - MAC will only prefetch if there are at least this many descriptors
84 * available in host memory.
85 * If PTHRESH is 0, this should also be 0.
86 * WTHRESH - RX descriptor writeback threshold - MAC will delay writing back
87 * descriptors until either it has this many to write back, or the
90 #define IGB_RX_PTHRESH (hw->mac.type <= e1000_82576 ? 16 : 8)
91 #define IGB_RX_HTHRESH 8
92 #define IGB_RX_WTHRESH 1
93 #define IGB_TX_PTHRESH 8
94 #define IGB_TX_HTHRESH 1
95 #define IGB_TX_WTHRESH ((hw->mac.type == e1000_82576 && \
96 adapter->msix_entries) ? 0 : 16)
98 /* this is the size past which hardware will drop packets when setting LPE=0 */
99 #define MAXIMUM_ETHERNET_VLAN_SIZE 1522
101 /* Supported Rx Buffer Sizes */
102 #define IGB_RXBUFFER_128 128 /* Used for packet split */
103 #define IGB_RXBUFFER_1024 1024
104 #define IGB_RXBUFFER_2048 2048
105 #define IGB_RXBUFFER_16384 16384
107 #define MAX_STD_JUMBO_FRAME_SIZE 9234
109 /* How many Tx Descriptors do we need to call netif_wake_queue ? */
110 #define IGB_TX_QUEUE_WAKE 16
111 /* How many Rx Buffers do we bundle into one write to the hardware ? */
112 #define IGB_RX_BUFFER_WRITE 16 /* Must be power of 2 */
114 #define AUTO_ALL_MODES 0
115 #define IGB_EEPROM_APME 0x0400
117 #ifndef IGB_MASTER_SLAVE
118 /* Switch to override PHY master/slave setting */
119 #define IGB_MASTER_SLAVE e1000_ms_hw_default
122 #define IGB_MNG_VLAN_NONE -1
124 /* wrapper around a pointer to a socket buffer,
125 * so a DMA handle can be stored along with the buffer */
132 unsigned long time_stamp
;
140 unsigned int page_offset
;
145 struct igb_tx_queue_stats
{
150 struct igb_rx_queue_stats
{
156 struct igb_q_vector
{
157 struct igb_adapter
*adapter
; /* backlink */
158 struct igb_ring
*rx_ring
;
159 struct igb_ring
*tx_ring
;
160 struct napi_struct napi
;
168 void __iomem
*itr_register
;
170 char name
[IFNAMSIZ
+ 9];
174 struct igb_q_vector
*q_vector
; /* backlink to q_vector */
175 void *desc
; /* descriptor ring memory */
176 struct pci_dev
*pdev
; /* pci device for dma mapping */
177 dma_addr_t dma
; /* phys address of the ring */
178 unsigned int size
; /* length of desc. ring in bytes */
179 unsigned int count
; /* number of desc. in the ring */
184 struct igb_buffer
*buffer_info
; /* array of buffer info structs */
189 unsigned int total_bytes
;
190 unsigned int total_packets
;
195 struct igb_tx_queue_stats tx_stats
;
200 struct igb_rx_queue_stats rx_stats
;
206 #define E1000_RX_DESC_ADV(R, i) \
207 (&(((union e1000_adv_rx_desc *)((R).desc))[i]))
208 #define E1000_TX_DESC_ADV(R, i) \
209 (&(((union e1000_adv_tx_desc *)((R).desc))[i]))
210 #define E1000_TX_CTXTDESC_ADV(R, i) \
211 (&(((struct e1000_adv_tx_context_desc *)((R).desc))[i]))
213 /* board specific private data structure */
216 struct timer_list watchdog_timer
;
217 struct timer_list phy_info_timer
;
218 struct vlan_group
*vlgrp
;
225 unsigned int total_tx_bytes
;
226 unsigned int total_tx_packets
;
227 unsigned int total_rx_bytes
;
228 unsigned int total_rx_packets
;
229 /* Interrupt Throttle Rate */
235 struct work_struct reset_task
;
236 struct work_struct watchdog_task
;
238 u8 tx_timeout_factor
;
239 struct timer_list blink_timer
;
240 unsigned long led_status
;
243 struct igb_ring
*tx_ring
; /* One per active queue */
244 unsigned int restart_queue
;
245 unsigned long tx_queue_len
;
251 u32 tx_timeout_count
;
254 struct igb_ring
*rx_ring
; /* One per active queue */
259 u32 alloc_rx_buff_failed
;
265 /* OS defined structs */
266 struct net_device
*netdev
;
267 struct pci_dev
*pdev
;
268 struct cyclecounter cycles
;
269 struct timecounter clock
;
270 struct timecompare compare
;
271 struct hwtstamp_config hwtstamp_config
;
273 /* structs defined in e1000_hw.h */
275 struct e1000_hw_stats stats
;
276 struct e1000_phy_info phy_info
;
277 struct e1000_phy_stats phy_stats
;
280 struct igb_ring test_tx_ring
;
281 struct igb_ring test_rx_ring
;
285 unsigned int num_q_vectors
;
286 struct igb_q_vector
*q_vector
[MAX_Q_VECTORS
];
287 struct msix_entry
*msix_entries
;
288 u32 eims_enable_mask
;
291 /* to not mess up cache alignment, always add to the bottom */
296 struct igb_ring
*multi_tx_table
[IGB_ABS_MAX_TX_QUEUES
];
297 unsigned int tx_ring_count
;
298 unsigned int rx_ring_count
;
299 unsigned int vfs_allocated_count
;
300 struct vf_data_storage
*vf_data
;
303 #define IGB_FLAG_HAS_MSI (1 << 0)
304 #define IGB_FLAG_DCA_ENABLED (1 << 1)
305 #define IGB_FLAG_QUAD_PORT_A (1 << 2)
306 #define IGB_FLAG_NEED_CTX_IDX (1 << 3)
307 #define IGB_FLAG_RX_CSUM_DISABLED (1 << 4)
319 extern char igb_driver_name
[];
320 extern char igb_driver_version
[];
322 extern char *igb_get_hw_dev_name(struct e1000_hw
*hw
);
323 extern int igb_up(struct igb_adapter
*);
324 extern void igb_down(struct igb_adapter
*);
325 extern void igb_reinit_locked(struct igb_adapter
*);
326 extern void igb_reset(struct igb_adapter
*);
327 extern int igb_set_spd_dplx(struct igb_adapter
*, u16
);
328 extern int igb_setup_tx_resources(struct igb_ring
*);
329 extern int igb_setup_rx_resources(struct igb_ring
*);
330 extern void igb_free_tx_resources(struct igb_ring
*);
331 extern void igb_free_rx_resources(struct igb_ring
*);
332 extern void igb_update_stats(struct igb_adapter
*);
333 extern void igb_set_ethtool_ops(struct net_device
*);
335 static inline s32
igb_reset_phy(struct e1000_hw
*hw
)
337 if (hw
->phy
.ops
.reset
)
338 return hw
->phy
.ops
.reset(hw
);
343 static inline s32
igb_read_phy_reg(struct e1000_hw
*hw
, u32 offset
, u16
*data
)
345 if (hw
->phy
.ops
.read_reg
)
346 return hw
->phy
.ops
.read_reg(hw
, offset
, data
);
351 static inline s32
igb_write_phy_reg(struct e1000_hw
*hw
, u32 offset
, u16 data
)
353 if (hw
->phy
.ops
.write_reg
)
354 return hw
->phy
.ops
.write_reg(hw
, offset
, data
);
359 static inline s32
igb_get_phy_info(struct e1000_hw
*hw
)
361 if (hw
->phy
.ops
.get_phy_info
)
362 return hw
->phy
.ops
.get_phy_info(hw
);