1 /*******************************************************************************
3 Intel(R) Gigabit Ethernet Linux driver
4 Copyright(c) 2007-2012 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"
38 #include <linux/clocksource.h>
39 #include <linux/net_tstamp.h>
40 #include <linux/ptp_clock_kernel.h>
41 #endif /* CONFIG_IGB_PTP */
42 #include <linux/bitops.h>
43 #include <linux/if_vlan.h>
47 /* Interrupt defines */
48 #define IGB_START_ITR 648 /* ~6000 ints/sec */
49 #define IGB_4K_ITR 980
50 #define IGB_20K_ITR 196
51 #define IGB_70K_ITR 56
53 /* TX/RX descriptor defines */
54 #define IGB_DEFAULT_TXD 256
55 #define IGB_DEFAULT_TX_WORK 128
56 #define IGB_MIN_TXD 80
57 #define IGB_MAX_TXD 4096
59 #define IGB_DEFAULT_RXD 256
60 #define IGB_MIN_RXD 80
61 #define IGB_MAX_RXD 4096
63 #define IGB_DEFAULT_ITR 3 /* dynamic */
64 #define IGB_MAX_ITR_USECS 10000
65 #define IGB_MIN_ITR_USECS 10
66 #define NON_Q_VECTORS 1
67 #define MAX_Q_VECTORS 8
69 /* Transmit and receive queues */
70 #define IGB_MAX_RX_QUEUES 8
71 #define IGB_MAX_RX_QUEUES_82575 4
72 #define IGB_MAX_RX_QUEUES_I211 2
73 #define IGB_MAX_TX_QUEUES 8
74 #define IGB_MAX_VF_MC_ENTRIES 30
75 #define IGB_MAX_VF_FUNCTIONS 8
76 #define IGB_MAX_VFTA_ENTRIES 128
77 #define IGB_82576_VF_DEV_ID 0x10CA
78 #define IGB_I350_VF_DEV_ID 0x1520
80 /* NVM version defines */
81 #define IGB_MAJOR_MASK 0xF000
82 #define IGB_MINOR_MASK 0x0FF0
83 #define IGB_BUILD_MASK 0x000F
84 #define IGB_COMB_VER_MASK 0x00FF
85 #define IGB_MAJOR_SHIFT 12
86 #define IGB_MINOR_SHIFT 4
87 #define IGB_COMB_VER_SHFT 8
88 #define IGB_NVM_VER_INVALID 0xFFFF
89 #define IGB_ETRACK_SHIFT 16
90 #define NVM_ETRACK_WORD 0x0042
91 #define NVM_COMB_VER_OFF 0x0083
92 #define NVM_COMB_VER_PTR 0x003d
94 struct vf_data_storage
{
95 unsigned char vf_mac_addresses
[ETH_ALEN
];
96 u16 vf_mc_hashes
[IGB_MAX_VF_MC_ENTRIES
];
100 unsigned long last_nack
;
101 u16 pf_vlan
; /* When set, guest VLAN config not allowed. */
106 #define IGB_VF_FLAG_CTS 0x00000001 /* VF is clear to send data */
107 #define IGB_VF_FLAG_UNI_PROMISC 0x00000002 /* VF has unicast promisc */
108 #define IGB_VF_FLAG_MULTI_PROMISC 0x00000004 /* VF has multicast promisc */
109 #define IGB_VF_FLAG_PF_SET_MAC 0x00000008 /* PF has set MAC address */
111 /* RX descriptor control thresholds.
112 * PTHRESH - MAC will consider prefetch if it has fewer than this number of
113 * descriptors available in its onboard memory.
114 * Setting this to 0 disables RX descriptor prefetch.
115 * HTHRESH - MAC will only prefetch if there are at least this many descriptors
116 * available in host memory.
117 * If PTHRESH is 0, this should also be 0.
118 * WTHRESH - RX descriptor writeback threshold - MAC will delay writing back
119 * descriptors until either it has this many to write back, or the
122 #define IGB_RX_PTHRESH 8
123 #define IGB_RX_HTHRESH 8
124 #define IGB_TX_PTHRESH 8
125 #define IGB_TX_HTHRESH 1
126 #define IGB_RX_WTHRESH ((hw->mac.type == e1000_82576 && \
127 adapter->msix_entries) ? 1 : 4)
128 #define IGB_TX_WTHRESH ((hw->mac.type == e1000_82576 && \
129 adapter->msix_entries) ? 1 : 16)
131 /* this is the size past which hardware will drop packets when setting LPE=0 */
132 #define MAXIMUM_ETHERNET_VLAN_SIZE 1522
134 /* Supported Rx Buffer Sizes */
135 #define IGB_RXBUFFER_256 256
136 #define IGB_RXBUFFER_2048 2048
137 #define IGB_RX_HDR_LEN IGB_RXBUFFER_256
138 #define IGB_RX_BUFSZ IGB_RXBUFFER_2048
140 /* How many Tx Descriptors do we need to call netif_wake_queue ? */
141 #define IGB_TX_QUEUE_WAKE 16
142 /* How many Rx Buffers do we bundle into one write to the hardware ? */
143 #define IGB_RX_BUFFER_WRITE 16 /* Must be power of 2 */
145 #define AUTO_ALL_MODES 0
146 #define IGB_EEPROM_APME 0x0400
148 #ifndef IGB_MASTER_SLAVE
149 /* Switch to override PHY master/slave setting */
150 #define IGB_MASTER_SLAVE e1000_ms_hw_default
153 #define IGB_MNG_VLAN_NONE -1
155 #define IGB_TX_FLAGS_CSUM 0x00000001
156 #define IGB_TX_FLAGS_VLAN 0x00000002
157 #define IGB_TX_FLAGS_TSO 0x00000004
158 #define IGB_TX_FLAGS_IPV4 0x00000008
159 #define IGB_TX_FLAGS_TSTAMP 0x00000010
160 #define IGB_TX_FLAGS_VLAN_MASK 0xffff0000
161 #define IGB_TX_FLAGS_VLAN_SHIFT 16
163 /* wrapper around a pointer to a socket buffer,
164 * so a DMA handle can be stored along with the buffer */
165 struct igb_tx_buffer
{
166 union e1000_adv_tx_desc
*next_to_watch
;
167 unsigned long time_stamp
;
169 unsigned int bytecount
;
172 DEFINE_DMA_UNMAP_ADDR(dma
);
173 DEFINE_DMA_UNMAP_LEN(len
);
177 struct igb_rx_buffer
{
180 unsigned int page_offset
;
183 struct igb_tx_queue_stats
{
190 struct igb_rx_queue_stats
{
198 struct igb_ring_container
{
199 struct igb_ring
*ring
; /* pointer to linked list of rings */
200 unsigned int total_bytes
; /* total bytes processed this int */
201 unsigned int total_packets
; /* total packets processed this int */
202 u16 work_limit
; /* total work allowed per interrupt */
203 u8 count
; /* total number of rings in vector */
204 u8 itr
; /* current ITR setting for ring */
207 struct igb_q_vector
{
208 struct igb_adapter
*adapter
; /* backlink */
209 int cpu
; /* CPU for DCA */
210 u32 eims_value
; /* EIMS mask value */
212 struct igb_ring_container rx
, tx
;
214 struct napi_struct napi
;
218 void __iomem
*itr_register
;
220 char name
[IFNAMSIZ
+ 9];
224 struct igb_q_vector
*q_vector
; /* backlink to q_vector */
225 struct net_device
*netdev
; /* back pointer to net_device */
226 struct device
*dev
; /* device pointer for dma mapping */
227 union { /* array of buffer info structs */
228 struct igb_tx_buffer
*tx_buffer_info
;
229 struct igb_rx_buffer
*rx_buffer_info
;
231 void *desc
; /* descriptor ring memory */
232 unsigned long flags
; /* ring specific flags */
233 void __iomem
*tail
; /* pointer to ring tail register */
235 u16 count
; /* number of desc. in the ring */
236 u8 queue_index
; /* logical index of the ring*/
237 u8 reg_idx
; /* physical index of the ring */
238 u32 size
; /* length of desc. ring in bytes */
240 /* everything past this point are written often */
241 u16 next_to_clean ____cacheline_aligned_in_smp
;
248 struct igb_tx_queue_stats tx_stats
;
249 struct u64_stats_sync tx_syncp
;
250 struct u64_stats_sync tx_syncp2
;
255 struct igb_rx_queue_stats rx_stats
;
256 struct u64_stats_sync rx_syncp
;
259 /* Items past this point are only used during ring alloc / free */
260 dma_addr_t dma
; /* phys address of the ring */
263 enum e1000_ring_flags_t
{
264 IGB_RING_FLAG_RX_SCTP_CSUM
,
265 IGB_RING_FLAG_RX_LB_VLAN_BSWAP
,
266 IGB_RING_FLAG_TX_CTX_IDX
,
267 IGB_RING_FLAG_TX_DETECT_HANG
270 #define IGB_TXD_DCMD (E1000_ADVTXD_DCMD_EOP | E1000_ADVTXD_DCMD_RS)
272 #define IGB_RX_DESC(R, i) \
273 (&(((union e1000_adv_rx_desc *)((R)->desc))[i]))
274 #define IGB_TX_DESC(R, i) \
275 (&(((union e1000_adv_tx_desc *)((R)->desc))[i]))
276 #define IGB_TX_CTXTDESC(R, i) \
277 (&(((struct e1000_adv_tx_context_desc *)((R)->desc))[i]))
279 /* igb_test_staterr - tests bits within Rx descriptor status and error fields */
280 static inline __le32
igb_test_staterr(union e1000_adv_rx_desc
*rx_desc
,
281 const u32 stat_err_bits
)
283 return rx_desc
->wb
.upper
.status_error
& cpu_to_le32(stat_err_bits
);
286 /* igb_desc_unused - calculate if we have unused descriptors */
287 static inline int igb_desc_unused(struct igb_ring
*ring
)
289 if (ring
->next_to_clean
> ring
->next_to_use
)
290 return ring
->next_to_clean
- ring
->next_to_use
- 1;
292 return ring
->count
+ ring
->next_to_clean
- ring
->next_to_use
- 1;
295 /* board specific private data structure */
297 unsigned long active_vlans
[BITS_TO_LONGS(VLAN_N_VID
)];
299 struct net_device
*netdev
;
304 unsigned int num_q_vectors
;
305 struct msix_entry
*msix_entries
;
307 /* Interrupt Throttle Rate */
315 u32 tx_timeout_count
;
317 struct igb_ring
*tx_ring
[16];
321 struct igb_ring
*rx_ring
[16];
326 struct timer_list watchdog_timer
;
327 struct timer_list phy_info_timer
;
336 struct work_struct reset_task
;
337 struct work_struct watchdog_task
;
339 u8 tx_timeout_factor
;
340 struct timer_list blink_timer
;
341 unsigned long led_status
;
343 /* OS defined structs */
344 struct pci_dev
*pdev
;
346 spinlock_t stats64_lock
;
347 struct rtnl_link_stats64 stats64
;
349 /* structs defined in e1000_hw.h */
351 struct e1000_hw_stats stats
;
352 struct e1000_phy_info phy_info
;
353 struct e1000_phy_stats phy_stats
;
356 struct igb_ring test_tx_ring
;
357 struct igb_ring test_rx_ring
;
361 struct igb_q_vector
*q_vector
[MAX_Q_VECTORS
];
362 u32 eims_enable_mask
;
365 /* to not mess up cache alignment, always add to the bottom */
370 unsigned int vfs_allocated_count
;
371 struct vf_data_storage
*vf_data
;
372 int vf_rate_link_speed
;
377 #ifdef CONFIG_IGB_PTP
378 struct ptp_clock
*ptp_clock
;
379 struct ptp_clock_info ptp_caps
;
380 struct delayed_work ptp_overflow_work
;
381 struct work_struct ptp_tx_work
;
382 struct sk_buff
*ptp_tx_skb
;
383 spinlock_t tmreg_lock
;
384 struct cyclecounter cc
;
385 struct timecounter tc
;
386 #endif /* CONFIG_IGB_PTP */
391 #define IGB_FLAG_HAS_MSI (1 << 0)
392 #define IGB_FLAG_DCA_ENABLED (1 << 1)
393 #define IGB_FLAG_QUAD_PORT_A (1 << 2)
394 #define IGB_FLAG_QUEUE_PAIRS (1 << 3)
395 #define IGB_FLAG_DMAC (1 << 4)
396 #define IGB_FLAG_PTP (1 << 5)
398 /* DMA Coalescing defines */
399 #define IGB_MIN_TXPBSIZE 20408
400 #define IGB_TX_BUF_4096 4096
401 #define IGB_DMCTLX_DCFLUSH_DIS 0x80000000 /* Disable DMA Coal Flush */
403 #define IGB_82576_TSYNC_SHIFT 19
404 #define IGB_TS_HDR_LEN 16
415 extern char igb_driver_name
[];
416 extern char igb_driver_version
[];
418 extern int igb_up(struct igb_adapter
*);
419 extern void igb_down(struct igb_adapter
*);
420 extern void igb_reinit_locked(struct igb_adapter
*);
421 extern void igb_reset(struct igb_adapter
*);
422 extern int igb_set_spd_dplx(struct igb_adapter
*, u32
, u8
);
423 extern int igb_setup_tx_resources(struct igb_ring
*);
424 extern int igb_setup_rx_resources(struct igb_ring
*);
425 extern void igb_free_tx_resources(struct igb_ring
*);
426 extern void igb_free_rx_resources(struct igb_ring
*);
427 extern void igb_configure_tx_ring(struct igb_adapter
*, struct igb_ring
*);
428 extern void igb_configure_rx_ring(struct igb_adapter
*, struct igb_ring
*);
429 extern void igb_setup_tctl(struct igb_adapter
*);
430 extern void igb_setup_rctl(struct igb_adapter
*);
431 extern netdev_tx_t
igb_xmit_frame_ring(struct sk_buff
*, struct igb_ring
*);
432 extern void igb_unmap_and_free_tx_resource(struct igb_ring
*,
433 struct igb_tx_buffer
*);
434 extern void igb_alloc_rx_buffers(struct igb_ring
*, u16
);
435 extern void igb_update_stats(struct igb_adapter
*, struct rtnl_link_stats64
*);
436 extern bool igb_has_link(struct igb_adapter
*adapter
);
437 extern void igb_set_ethtool_ops(struct net_device
*);
438 extern void igb_power_up_link(struct igb_adapter
*);
439 extern void igb_set_fw_version(struct igb_adapter
*);
440 #ifdef CONFIG_IGB_PTP
441 extern void igb_ptp_init(struct igb_adapter
*adapter
);
442 extern void igb_ptp_stop(struct igb_adapter
*adapter
);
443 extern void igb_ptp_reset(struct igb_adapter
*adapter
);
444 extern void igb_ptp_tx_work(struct work_struct
*work
);
445 extern void igb_ptp_tx_hwtstamp(struct igb_adapter
*adapter
);
446 extern void igb_ptp_rx_rgtstamp(struct igb_q_vector
*q_vector
,
447 struct sk_buff
*skb
);
448 extern void igb_ptp_rx_pktstamp(struct igb_q_vector
*q_vector
,
450 struct sk_buff
*skb
);
451 static inline void igb_ptp_rx_hwtstamp(struct igb_q_vector
*q_vector
,
452 union e1000_adv_rx_desc
*rx_desc
,
455 if (igb_test_staterr(rx_desc
, E1000_RXDADV_STAT_TS
) &&
456 !igb_test_staterr(rx_desc
, E1000_RXDADV_STAT_TSIP
))
457 igb_ptp_rx_rgtstamp(q_vector
, skb
);
460 extern int igb_ptp_hwtstamp_ioctl(struct net_device
*netdev
,
461 struct ifreq
*ifr
, int cmd
);
462 #endif /* CONFIG_IGB_PTP */
464 static inline s32
igb_reset_phy(struct e1000_hw
*hw
)
466 if (hw
->phy
.ops
.reset
)
467 return hw
->phy
.ops
.reset(hw
);
472 static inline s32
igb_read_phy_reg(struct e1000_hw
*hw
, u32 offset
, u16
*data
)
474 if (hw
->phy
.ops
.read_reg
)
475 return hw
->phy
.ops
.read_reg(hw
, offset
, data
);
480 static inline s32
igb_write_phy_reg(struct e1000_hw
*hw
, u32 offset
, u16 data
)
482 if (hw
->phy
.ops
.write_reg
)
483 return hw
->phy
.ops
.write_reg(hw
, offset
, data
);
488 static inline s32
igb_get_phy_info(struct e1000_hw
*hw
)
490 if (hw
->phy
.ops
.get_phy_info
)
491 return hw
->phy
.ops
.get_phy_info(hw
);
496 static inline struct netdev_queue
*txring_txq(const struct igb_ring
*tx_ring
)
498 return netdev_get_tx_queue(tx_ring
->netdev
, tx_ring
->queue_index
);