]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - drivers/net/igb/igb.h
igb: use packet buffer sizes from RXPBS register
[mirror_ubuntu-zesty-kernel.git] / drivers / net / igb / igb.h
CommitLineData
9d5c8243
AK
1/*******************************************************************************
2
3 Intel(R) Gigabit Ethernet Linux driver
86d5d38f 4 Copyright(c) 2007-2009 Intel Corporation.
9d5c8243
AK
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 e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
24 Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
25
26*******************************************************************************/
27
28
29/* Linux PRO/1000 Ethernet Driver main header file */
30
31#ifndef _IGB_H_
32#define _IGB_H_
33
34#include "e1000_mac.h"
35#include "e1000_82575.h"
36
38c845c7 37#include <linux/clocksource.h>
33af6bcc
PO
38#include <linux/timecompare.h>
39#include <linux/net_tstamp.h>
38c845c7 40
9d5c8243
AK
41struct igb_adapter;
42
6eb5a7f1
AD
43/* ((1000000000ns / (6000ints/s * 1024ns)) << 2 = 648 */
44#define IGB_START_ITR 648
9d5c8243 45
9d5c8243
AK
46/* TX/RX descriptor defines */
47#define IGB_DEFAULT_TXD 256
48#define IGB_MIN_TXD 80
49#define IGB_MAX_TXD 4096
50
51#define IGB_DEFAULT_RXD 256
52#define IGB_MIN_RXD 80
53#define IGB_MAX_RXD 4096
54
55#define IGB_DEFAULT_ITR 3 /* dynamic */
56#define IGB_MAX_ITR_USECS 10000
57#define IGB_MIN_ITR_USECS 10
047e0030
AD
58#define NON_Q_VECTORS 1
59#define MAX_Q_VECTORS 8
9d5c8243
AK
60
61/* Transmit and receive queues */
1bfaf07b
AD
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
9d5c8243 66
4ae196df
AD
67#define IGB_MAX_VF_MC_ENTRIES 30
68#define IGB_MAX_VF_FUNCTIONS 8
69#define IGB_MAX_VFTA_ENTRIES 128
70
71struct vf_data_storage {
72 unsigned char vf_mac_addresses[ETH_ALEN];
73 u16 vf_mc_hashes[IGB_MAX_VF_MC_ENTRIES];
74 u16 num_vf_mc_hashes;
ae641bdc 75 u16 vlans_enabled;
4ae196df
AD
76 bool clear_to_send;
77};
78
9d5c8243
AK
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
88 * ITR timer expires.
89 */
85b430b4 90#define IGB_RX_PTHRESH (hw->mac.type <= e1000_82576 ? 16 : 8)
9d5c8243
AK
91#define IGB_RX_HTHRESH 8
92#define IGB_RX_WTHRESH 1
85b430b4
AD
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)
9d5c8243
AK
97
98/* this is the size past which hardware will drop packets when setting LPE=0 */
99#define MAXIMUM_ETHERNET_VLAN_SIZE 1522
100
101/* Supported Rx Buffer Sizes */
102#define IGB_RXBUFFER_128 128 /* Used for packet split */
9d5c8243
AK
103#define IGB_RXBUFFER_1024 1024
104#define IGB_RXBUFFER_2048 2048
9d5c8243
AK
105#define IGB_RXBUFFER_16384 16384
106
e1739522 107#define MAX_STD_JUMBO_FRAME_SIZE 9234
9d5c8243
AK
108
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 */
113
114#define AUTO_ALL_MODES 0
115#define IGB_EEPROM_APME 0x0400
116
117#ifndef IGB_MASTER_SLAVE
118/* Switch to override PHY master/slave setting */
119#define IGB_MASTER_SLAVE e1000_ms_hw_default
120#endif
121
122#define IGB_MNG_VLAN_NONE -1
123
124/* wrapper around a pointer to a socket buffer,
125 * so a DMA handle can be stored along with the buffer */
126struct igb_buffer {
127 struct sk_buff *skb;
128 dma_addr_t dma;
129 union {
130 /* TX */
131 struct {
132 unsigned long time_stamp;
0e014cb1
AD
133 u16 length;
134 u16 next_to_watch;
9d5c8243
AK
135 };
136 /* RX */
137 struct {
138 struct page *page;
139 u64 page_dma;
bf36c1a0 140 unsigned int page_offset;
9d5c8243
AK
141 };
142 };
143};
144
8c0ab70a 145struct igb_tx_queue_stats {
9d5c8243
AK
146 u64 packets;
147 u64 bytes;
04a5fcaa 148 u64 restart_queue;
9d5c8243
AK
149};
150
8c0ab70a
JDB
151struct igb_rx_queue_stats {
152 u64 packets;
153 u64 bytes;
154 u64 drops;
04a5fcaa
AD
155 u64 csum_err;
156 u64 alloc_failed;
8c0ab70a
JDB
157};
158
047e0030 159struct igb_q_vector {
9d5c8243 160 struct igb_adapter *adapter; /* backlink */
047e0030
AD
161 struct igb_ring *rx_ring;
162 struct igb_ring *tx_ring;
163 struct napi_struct napi;
164
165 u32 eims_value;
166 u16 cpu;
167
168 u16 itr_val;
169 u8 set_itr;
170 u8 itr_shift;
171 void __iomem *itr_register;
172
173 char name[IFNAMSIZ + 9];
174};
175
176struct igb_ring {
177 struct igb_q_vector *q_vector; /* backlink to q_vector */
e694e964 178 struct net_device *netdev; /* back pointer to net_device */
80785298 179 struct pci_dev *pdev; /* pci device for dma mapping */
047e0030 180 dma_addr_t dma; /* phys address of the ring */
e694e964 181 void *desc; /* descriptor ring memory */
047e0030
AD
182 unsigned int size; /* length of desc. ring in bytes */
183 unsigned int count; /* number of desc. in the ring */
9d5c8243
AK
184 u16 next_to_use;
185 u16 next_to_clean;
fce99e34
AD
186 void __iomem *head;
187 void __iomem *tail;
9d5c8243
AK
188 struct igb_buffer *buffer_info; /* array of buffer info structs */
189
047e0030
AD
190 u8 queue_index;
191 u8 reg_idx;
9d5c8243
AK
192
193 unsigned int total_bytes;
194 unsigned int total_packets;
195
85ad76b2
AD
196 u32 flags;
197
9d5c8243
AK
198 union {
199 /* TX */
200 struct {
8c0ab70a 201 struct igb_tx_queue_stats tx_stats;
9d5c8243
AK
202 bool detect_tx_hung;
203 };
204 /* RX */
205 struct {
8c0ab70a 206 struct igb_rx_queue_stats rx_stats;
4c844851 207 u32 rx_buffer_len;
9d5c8243
AK
208 };
209 };
9d5c8243
AK
210};
211
85ad76b2
AD
212#define IGB_RING_FLAG_RX_CSUM 0x00000001 /* RX CSUM enabled */
213#define IGB_RING_FLAG_RX_SCTP_CSUM 0x00000002 /* SCTP CSUM offload enabled */
214
215#define IGB_RING_FLAG_TX_CTX_IDX 0x00000001 /* HW requires context index */
216
217#define IGB_ADVTXD_DCMD (E1000_TXD_CMD_EOP | E1000_TXD_CMD_RS)
218
9d5c8243
AK
219#define E1000_RX_DESC_ADV(R, i) \
220 (&(((union e1000_adv_rx_desc *)((R).desc))[i]))
221#define E1000_TX_DESC_ADV(R, i) \
222 (&(((union e1000_adv_tx_desc *)((R).desc))[i]))
223#define E1000_TX_CTXTDESC_ADV(R, i) \
224 (&(((struct e1000_adv_tx_context_desc *)((R).desc))[i]))
9d5c8243 225
d7ee5b3a
AD
226/* igb_desc_unused - calculate if we have unused descriptors */
227static inline int igb_desc_unused(struct igb_ring *ring)
228{
229 if (ring->next_to_clean > ring->next_to_use)
230 return ring->next_to_clean - ring->next_to_use - 1;
231
232 return ring->count + ring->next_to_clean - ring->next_to_use - 1;
233}
234
9d5c8243
AK
235/* board specific private data structure */
236
237struct igb_adapter {
238 struct timer_list watchdog_timer;
239 struct timer_list phy_info_timer;
240 struct vlan_group *vlgrp;
241 u16 mng_vlan_id;
242 u32 bd_number;
9d5c8243
AK
243 u32 wol;
244 u32 en_mng_pt;
245 u16 link_speed;
246 u16 link_duplex;
247 unsigned int total_tx_bytes;
248 unsigned int total_tx_packets;
249 unsigned int total_rx_bytes;
250 unsigned int total_rx_packets;
251 /* Interrupt Throttle Rate */
4fc82adf
AD
252 u32 rx_itr_setting;
253 u32 tx_itr_setting;
9d5c8243
AK
254 u16 tx_itr;
255 u16 rx_itr;
9d5c8243
AK
256
257 struct work_struct reset_task;
258 struct work_struct watchdog_task;
259 bool fc_autoneg;
260 u8 tx_timeout_factor;
261 struct timer_list blink_timer;
262 unsigned long led_status;
263
264 /* TX */
265 struct igb_ring *tx_ring; /* One per active queue */
9d5c8243 266 unsigned long tx_queue_len;
9d5c8243
AK
267 u32 gotc;
268 u64 gotc_old;
269 u64 tpt_old;
270 u64 colc_old;
271 u32 tx_timeout_count;
272
273 /* RX */
274 struct igb_ring *rx_ring; /* One per active queue */
275 int num_tx_queues;
276 int num_rx_queues;
277
9d5c8243
AK
278 u32 gorc;
279 u64 gorc_old;
9d5c8243
AK
280 u32 max_frame_size;
281 u32 min_frame_size;
282
283 /* OS defined structs */
284 struct net_device *netdev;
9d5c8243 285 struct pci_dev *pdev;
38c845c7
PO
286 struct cyclecounter cycles;
287 struct timecounter clock;
33af6bcc
PO
288 struct timecompare compare;
289 struct hwtstamp_config hwtstamp_config;
9d5c8243
AK
290
291 /* structs defined in e1000_hw.h */
292 struct e1000_hw hw;
293 struct e1000_hw_stats stats;
294 struct e1000_phy_info phy_info;
295 struct e1000_phy_stats phy_stats;
296
297 u32 test_icr;
298 struct igb_ring test_tx_ring;
299 struct igb_ring test_rx_ring;
300
301 int msg_enable;
047e0030
AD
302
303 unsigned int num_q_vectors;
304 struct igb_q_vector *q_vector[MAX_Q_VECTORS];
9d5c8243
AK
305 struct msix_entry *msix_entries;
306 u32 eims_enable_mask;
844290e5 307 u32 eims_other;
9d5c8243
AK
308
309 /* to not mess up cache alignment, always add to the bottom */
310 unsigned long state;
7dfc16fa 311 unsigned int flags;
9d5c8243 312 u32 eeprom_wol;
42bfd33a 313
1bfaf07b 314 struct igb_ring *multi_tx_table[IGB_ABS_MAX_TX_QUEUES];
68fd9910
AD
315 unsigned int tx_ring_count;
316 unsigned int rx_ring_count;
1bfaf07b 317 unsigned int vfs_allocated_count;
4ae196df 318 struct vf_data_storage *vf_data;
9d5c8243
AK
319};
320
7dfc16fa 321#define IGB_FLAG_HAS_MSI (1 << 0)
cbd347ad
AD
322#define IGB_FLAG_DCA_ENABLED (1 << 1)
323#define IGB_FLAG_QUAD_PORT_A (1 << 2)
4fc82adf 324#define IGB_FLAG_QUEUE_PAIRS (1 << 3)
7dfc16fa 325
c5b9bd5e 326#define IGB_82576_TSYNC_SHIFT 19
9d5c8243
AK
327enum e1000_state_t {
328 __IGB_TESTING,
329 __IGB_RESETTING,
330 __IGB_DOWN
331};
332
333enum igb_boards {
334 board_82575,
335};
336
337extern char igb_driver_name[];
338extern char igb_driver_version[];
339
340extern char *igb_get_hw_dev_name(struct e1000_hw *hw);
341extern int igb_up(struct igb_adapter *);
342extern void igb_down(struct igb_adapter *);
343extern void igb_reinit_locked(struct igb_adapter *);
344extern void igb_reset(struct igb_adapter *);
345extern int igb_set_spd_dplx(struct igb_adapter *, u16);
80785298
AD
346extern int igb_setup_tx_resources(struct igb_ring *);
347extern int igb_setup_rx_resources(struct igb_ring *);
68fd9910
AD
348extern void igb_free_tx_resources(struct igb_ring *);
349extern void igb_free_rx_resources(struct igb_ring *);
d7ee5b3a
AD
350extern void igb_configure_tx_ring(struct igb_adapter *, struct igb_ring *);
351extern void igb_configure_rx_ring(struct igb_adapter *, struct igb_ring *);
352extern void igb_setup_tctl(struct igb_adapter *);
353extern void igb_setup_rctl(struct igb_adapter *);
b1a436c3
AD
354extern netdev_tx_t igb_xmit_frame_ring_adv(struct sk_buff *, struct igb_ring *);
355extern void igb_unmap_and_free_tx_resource(struct igb_ring *,
356 struct igb_buffer *);
d7ee5b3a 357extern void igb_alloc_rx_buffers_adv(struct igb_ring *, int);
9d5c8243
AK
358extern void igb_update_stats(struct igb_adapter *);
359extern void igb_set_ethtool_ops(struct net_device *);
360
f5f4cf08
AD
361static inline s32 igb_reset_phy(struct e1000_hw *hw)
362{
a8d2a0c2
AD
363 if (hw->phy.ops.reset)
364 return hw->phy.ops.reset(hw);
f5f4cf08
AD
365
366 return 0;
367}
368
369static inline s32 igb_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data)
370{
a8d2a0c2
AD
371 if (hw->phy.ops.read_reg)
372 return hw->phy.ops.read_reg(hw, offset, data);
f5f4cf08
AD
373
374 return 0;
375}
376
377static inline s32 igb_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data)
378{
a8d2a0c2
AD
379 if (hw->phy.ops.write_reg)
380 return hw->phy.ops.write_reg(hw, offset, data);
f5f4cf08
AD
381
382 return 0;
383}
384
385static inline s32 igb_get_phy_info(struct e1000_hw *hw)
386{
387 if (hw->phy.ops.get_phy_info)
388 return hw->phy.ops.get_phy_info(hw);
389
390 return 0;
391}
392
9d5c8243 393#endif /* _IGB_H_ */