igb: Update NVM functions to work with i350 devices
[deliverable/linux.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 */
a99955fc
AD
62#define IGB_MAX_RX_QUEUES (adapter->vfs_allocated_count ? 2 : \
63 (hw->mac.type > e1000_82575 ? 8 : 4))
64#define IGB_ABS_MAX_TX_QUEUES 8
65#define IGB_MAX_TX_QUEUES IGB_MAX_RX_QUEUES
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;
f2ca0dbe
AD
76 u32 flags;
77 unsigned long last_nack;
8151d294
WM
78 u16 pf_vlan; /* When set, guest VLAN config not allowed. */
79 u16 pf_qos;
17dc566c 80 u16 tx_rate;
4ae196df
AD
81};
82
f2ca0dbe 83#define IGB_VF_FLAG_CTS 0x00000001 /* VF is clear to send data */
7d5753f0
AD
84#define IGB_VF_FLAG_UNI_PROMISC 0x00000002 /* VF has unicast promisc */
85#define IGB_VF_FLAG_MULTI_PROMISC 0x00000004 /* VF has multicast promisc */
8151d294 86#define IGB_VF_FLAG_PF_SET_MAC 0x00000008 /* PF has set MAC address */
f2ca0dbe 87
9d5c8243
AK
88/* RX descriptor control thresholds.
89 * PTHRESH - MAC will consider prefetch if it has fewer than this number of
90 * descriptors available in its onboard memory.
91 * Setting this to 0 disables RX descriptor prefetch.
92 * HTHRESH - MAC will only prefetch if there are at least this many descriptors
93 * available in host memory.
94 * If PTHRESH is 0, this should also be 0.
95 * WTHRESH - RX descriptor writeback threshold - MAC will delay writing back
96 * descriptors until either it has this many to write back, or the
97 * ITR timer expires.
98 */
58fd62f5 99#define IGB_RX_PTHRESH 8
9d5c8243
AK
100#define IGB_RX_HTHRESH 8
101#define IGB_RX_WTHRESH 1
85b430b4
AD
102#define IGB_TX_PTHRESH 8
103#define IGB_TX_HTHRESH 1
104#define IGB_TX_WTHRESH ((hw->mac.type == e1000_82576 && \
58fd62f5 105 adapter->msix_entries) ? 1 : 16)
9d5c8243
AK
106
107/* this is the size past which hardware will drop packets when setting LPE=0 */
108#define MAXIMUM_ETHERNET_VLAN_SIZE 1522
109
110/* Supported Rx Buffer Sizes */
757b77e2 111#define IGB_RXBUFFER_64 64 /* Used for packet split */
9d5c8243 112#define IGB_RXBUFFER_128 128 /* Used for packet split */
9d5c8243
AK
113#define IGB_RXBUFFER_1024 1024
114#define IGB_RXBUFFER_2048 2048
9d5c8243
AK
115#define IGB_RXBUFFER_16384 16384
116
e1739522 117#define MAX_STD_JUMBO_FRAME_SIZE 9234
9d5c8243
AK
118
119/* How many Tx Descriptors do we need to call netif_wake_queue ? */
120#define IGB_TX_QUEUE_WAKE 16
121/* How many Rx Buffers do we bundle into one write to the hardware ? */
122#define IGB_RX_BUFFER_WRITE 16 /* Must be power of 2 */
123
124#define AUTO_ALL_MODES 0
125#define IGB_EEPROM_APME 0x0400
126
127#ifndef IGB_MASTER_SLAVE
128/* Switch to override PHY master/slave setting */
129#define IGB_MASTER_SLAVE e1000_ms_hw_default
130#endif
131
132#define IGB_MNG_VLAN_NONE -1
133
134/* wrapper around a pointer to a socket buffer,
135 * so a DMA handle can be stored along with the buffer */
136struct igb_buffer {
137 struct sk_buff *skb;
138 dma_addr_t dma;
139 union {
140 /* TX */
141 struct {
142 unsigned long time_stamp;
0e014cb1
AD
143 u16 length;
144 u16 next_to_watch;
2873957d 145 unsigned int bytecount;
40e90c26 146 u16 gso_segs;
2244d07b 147 u8 tx_flags;
2873957d 148 u8 mapped_as_page;
9d5c8243
AK
149 };
150 /* RX */
151 struct {
152 struct page *page;
6366ad33
AD
153 dma_addr_t page_dma;
154 u16 page_offset;
9d5c8243
AK
155 };
156 };
157};
158
8c0ab70a 159struct igb_tx_queue_stats {
9d5c8243
AK
160 u64 packets;
161 u64 bytes;
04a5fcaa 162 u64 restart_queue;
12dcd86b 163 u64 restart_queue2;
9d5c8243
AK
164};
165
8c0ab70a
JDB
166struct igb_rx_queue_stats {
167 u64 packets;
168 u64 bytes;
169 u64 drops;
04a5fcaa
AD
170 u64 csum_err;
171 u64 alloc_failed;
8c0ab70a
JDB
172};
173
047e0030 174struct igb_q_vector {
9d5c8243 175 struct igb_adapter *adapter; /* backlink */
047e0030
AD
176 struct igb_ring *rx_ring;
177 struct igb_ring *tx_ring;
178 struct napi_struct napi;
179
180 u32 eims_value;
181 u16 cpu;
182
183 u16 itr_val;
184 u8 set_itr;
047e0030
AD
185 void __iomem *itr_register;
186
187 char name[IFNAMSIZ + 9];
188};
189
190struct igb_ring {
191 struct igb_q_vector *q_vector; /* backlink to q_vector */
e694e964 192 struct net_device *netdev; /* back pointer to net_device */
59d71989 193 struct device *dev; /* device pointer for dma mapping */
047e0030 194 dma_addr_t dma; /* phys address of the ring */
e694e964 195 void *desc; /* descriptor ring memory */
047e0030 196 unsigned int size; /* length of desc. ring in bytes */
2e5655e7 197 u16 count; /* number of desc. in the ring */
9d5c8243
AK
198 u16 next_to_use;
199 u16 next_to_clean;
2e5655e7
AD
200 u8 queue_index;
201 u8 reg_idx;
fce99e34
AD
202 void __iomem *head;
203 void __iomem *tail;
9d5c8243
AK
204 struct igb_buffer *buffer_info; /* array of buffer info structs */
205
9d5c8243
AK
206 unsigned int total_bytes;
207 unsigned int total_packets;
208
85ad76b2
AD
209 u32 flags;
210
9d5c8243
AK
211 union {
212 /* TX */
213 struct {
8c0ab70a 214 struct igb_tx_queue_stats tx_stats;
12dcd86b
ED
215 struct u64_stats_sync tx_syncp;
216 struct u64_stats_sync tx_syncp2;
9d5c8243
AK
217 bool detect_tx_hung;
218 };
219 /* RX */
220 struct {
8c0ab70a 221 struct igb_rx_queue_stats rx_stats;
12dcd86b 222 struct u64_stats_sync rx_syncp;
4c844851 223 u32 rx_buffer_len;
9d5c8243
AK
224 };
225 };
9d5c8243
AK
226};
227
85ad76b2
AD
228#define IGB_RING_FLAG_RX_CSUM 0x00000001 /* RX CSUM enabled */
229#define IGB_RING_FLAG_RX_SCTP_CSUM 0x00000002 /* SCTP CSUM offload enabled */
230
231#define IGB_RING_FLAG_TX_CTX_IDX 0x00000001 /* HW requires context index */
232
233#define IGB_ADVTXD_DCMD (E1000_TXD_CMD_EOP | E1000_TXD_CMD_RS)
234
9d5c8243
AK
235#define E1000_RX_DESC_ADV(R, i) \
236 (&(((union e1000_adv_rx_desc *)((R).desc))[i]))
237#define E1000_TX_DESC_ADV(R, i) \
238 (&(((union e1000_adv_tx_desc *)((R).desc))[i]))
239#define E1000_TX_CTXTDESC_ADV(R, i) \
240 (&(((struct e1000_adv_tx_context_desc *)((R).desc))[i]))
9d5c8243 241
d7ee5b3a
AD
242/* igb_desc_unused - calculate if we have unused descriptors */
243static inline int igb_desc_unused(struct igb_ring *ring)
244{
245 if (ring->next_to_clean > ring->next_to_use)
246 return ring->next_to_clean - ring->next_to_use - 1;
247
248 return ring->count + ring->next_to_clean - ring->next_to_use - 1;
249}
250
9d5c8243 251/* board specific private data structure */
9d5c8243
AK
252struct igb_adapter {
253 struct timer_list watchdog_timer;
254 struct timer_list phy_info_timer;
255 struct vlan_group *vlgrp;
256 u16 mng_vlan_id;
257 u32 bd_number;
9d5c8243
AK
258 u32 wol;
259 u32 en_mng_pt;
260 u16 link_speed;
261 u16 link_duplex;
2e5655e7 262
9d5c8243 263 /* Interrupt Throttle Rate */
4fc82adf
AD
264 u32 rx_itr_setting;
265 u32 tx_itr_setting;
9d5c8243
AK
266 u16 tx_itr;
267 u16 rx_itr;
9d5c8243
AK
268
269 struct work_struct reset_task;
270 struct work_struct watchdog_task;
271 bool fc_autoneg;
272 u8 tx_timeout_factor;
273 struct timer_list blink_timer;
274 unsigned long led_status;
275
276 /* TX */
3025a446 277 struct igb_ring *tx_ring[16];
9d5c8243
AK
278 u32 tx_timeout_count;
279
280 /* RX */
3025a446 281 struct igb_ring *rx_ring[16];
9d5c8243
AK
282 int num_tx_queues;
283 int num_rx_queues;
284
9d5c8243
AK
285 u32 max_frame_size;
286 u32 min_frame_size;
287
288 /* OS defined structs */
289 struct net_device *netdev;
9d5c8243 290 struct pci_dev *pdev;
38c845c7
PO
291 struct cyclecounter cycles;
292 struct timecounter clock;
33af6bcc
PO
293 struct timecompare compare;
294 struct hwtstamp_config hwtstamp_config;
9d5c8243 295
12dcd86b
ED
296 spinlock_t stats64_lock;
297 struct rtnl_link_stats64 stats64;
298
9d5c8243
AK
299 /* structs defined in e1000_hw.h */
300 struct e1000_hw hw;
301 struct e1000_hw_stats stats;
302 struct e1000_phy_info phy_info;
303 struct e1000_phy_stats phy_stats;
304
305 u32 test_icr;
306 struct igb_ring test_tx_ring;
307 struct igb_ring test_rx_ring;
308
309 int msg_enable;
047e0030
AD
310
311 unsigned int num_q_vectors;
312 struct igb_q_vector *q_vector[MAX_Q_VECTORS];
9d5c8243
AK
313 struct msix_entry *msix_entries;
314 u32 eims_enable_mask;
844290e5 315 u32 eims_other;
9d5c8243
AK
316
317 /* to not mess up cache alignment, always add to the bottom */
318 unsigned long state;
7dfc16fa 319 unsigned int flags;
9d5c8243 320 u32 eeprom_wol;
42bfd33a 321
1bfaf07b 322 struct igb_ring *multi_tx_table[IGB_ABS_MAX_TX_QUEUES];
2e5655e7
AD
323 u16 tx_ring_count;
324 u16 rx_ring_count;
1bfaf07b 325 unsigned int vfs_allocated_count;
4ae196df 326 struct vf_data_storage *vf_data;
17dc566c 327 int vf_rate_link_speed;
a99955fc 328 u32 rss_queues;
13800469 329 u32 wvbr;
9d5c8243
AK
330};
331
7dfc16fa 332#define IGB_FLAG_HAS_MSI (1 << 0)
cbd347ad
AD
333#define IGB_FLAG_DCA_ENABLED (1 << 1)
334#define IGB_FLAG_QUAD_PORT_A (1 << 2)
4fc82adf 335#define IGB_FLAG_QUEUE_PAIRS (1 << 3)
7dfc16fa 336
c5b9bd5e 337#define IGB_82576_TSYNC_SHIFT 19
55cac248 338#define IGB_82580_TSYNC_SHIFT 24
757b77e2 339#define IGB_TS_HDR_LEN 16
9d5c8243
AK
340enum e1000_state_t {
341 __IGB_TESTING,
342 __IGB_RESETTING,
343 __IGB_DOWN
344};
345
346enum igb_boards {
347 board_82575,
348};
349
350extern char igb_driver_name[];
351extern char igb_driver_version[];
352
9d5c8243
AK
353extern int igb_up(struct igb_adapter *);
354extern void igb_down(struct igb_adapter *);
355extern void igb_reinit_locked(struct igb_adapter *);
356extern void igb_reset(struct igb_adapter *);
357extern int igb_set_spd_dplx(struct igb_adapter *, u16);
80785298
AD
358extern int igb_setup_tx_resources(struct igb_ring *);
359extern int igb_setup_rx_resources(struct igb_ring *);
68fd9910
AD
360extern void igb_free_tx_resources(struct igb_ring *);
361extern void igb_free_rx_resources(struct igb_ring *);
d7ee5b3a
AD
362extern void igb_configure_tx_ring(struct igb_adapter *, struct igb_ring *);
363extern void igb_configure_rx_ring(struct igb_adapter *, struct igb_ring *);
364extern void igb_setup_tctl(struct igb_adapter *);
365extern void igb_setup_rctl(struct igb_adapter *);
b1a436c3
AD
366extern netdev_tx_t igb_xmit_frame_ring_adv(struct sk_buff *, struct igb_ring *);
367extern void igb_unmap_and_free_tx_resource(struct igb_ring *,
368 struct igb_buffer *);
d7ee5b3a 369extern void igb_alloc_rx_buffers_adv(struct igb_ring *, int);
12dcd86b 370extern void igb_update_stats(struct igb_adapter *, struct rtnl_link_stats64 *);
3145535a 371extern bool igb_has_link(struct igb_adapter *adapter);
9d5c8243 372extern void igb_set_ethtool_ops(struct net_device *);
88a268c1 373extern void igb_power_up_link(struct igb_adapter *);
9d5c8243 374
f5f4cf08
AD
375static inline s32 igb_reset_phy(struct e1000_hw *hw)
376{
a8d2a0c2
AD
377 if (hw->phy.ops.reset)
378 return hw->phy.ops.reset(hw);
f5f4cf08
AD
379
380 return 0;
381}
382
383static inline s32 igb_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data)
384{
a8d2a0c2
AD
385 if (hw->phy.ops.read_reg)
386 return hw->phy.ops.read_reg(hw, offset, data);
f5f4cf08
AD
387
388 return 0;
389}
390
391static inline s32 igb_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data)
392{
a8d2a0c2
AD
393 if (hw->phy.ops.write_reg)
394 return hw->phy.ops.write_reg(hw, offset, data);
f5f4cf08
AD
395
396 return 0;
397}
398
399static inline s32 igb_get_phy_info(struct e1000_hw *hw)
400{
401 if (hw->phy.ops.get_phy_info)
402 return hw->phy.ops.get_phy_info(hw);
403
404 return 0;
405}
406
9d5c8243 407#endif /* _IGB_H_ */
This page took 0.41774 seconds and 5 git commands to generate.