igb.h 11.8 KB
Newer Older
1 2 3
/*******************************************************************************

  Intel(R) Gigabit Ethernet Linux driver
4
  Copyright(c) 2007-2011 Intel Corporation.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36

  This program is free software; you can redistribute it and/or modify it
  under the terms and conditions of the GNU General Public License,
  version 2, as published by the Free Software Foundation.

  This program is distributed in the hope it will be useful, but WITHOUT
  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  more details.

  You should have received a copy of the GNU General Public License along with
  this program; if not, write to the Free Software Foundation, Inc.,
  51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.

  The full GNU General Public License is included in this distribution in
  the file called "COPYING".

  Contact Information:
  e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
  Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497

*******************************************************************************/


/* Linux PRO/1000 Ethernet Driver main header file */

#ifndef _IGB_H_
#define _IGB_H_

#include "e1000_mac.h"
#include "e1000_82575.h"

P
Patrick Ohly 已提交
37
#include <linux/clocksource.h>
38 39
#include <linux/timecompare.h>
#include <linux/net_tstamp.h>
J
Jiri Pirko 已提交
40 41
#include <linux/bitops.h>
#include <linux/if_vlan.h>
P
Patrick Ohly 已提交
42

43 44
struct igb_adapter;

45 46
/* ((1000000000ns / (6000ints/s * 1024ns)) << 2 = 648 */
#define IGB_START_ITR 648
47 48 49

/* TX/RX descriptor defines */
#define IGB_DEFAULT_TXD                  256
50
#define IGB_DEFAULT_TX_WORK		 128
51 52 53 54 55 56 57 58 59 60
#define IGB_MIN_TXD                       80
#define IGB_MAX_TXD                     4096

#define IGB_DEFAULT_RXD                  256
#define IGB_MIN_RXD                       80
#define IGB_MAX_RXD                     4096

#define IGB_DEFAULT_ITR                    3 /* dynamic */
#define IGB_MAX_ITR_USECS              10000
#define IGB_MIN_ITR_USECS                 10
61 62
#define NON_Q_VECTORS                      1
#define MAX_Q_VECTORS                      8
63 64

/* Transmit and receive queues */
65 66
#define IGB_MAX_RX_QUEUES                  (adapter->vfs_allocated_count ? 2 : \
                                           (hw->mac.type > e1000_82575 ? 8 : 4))
67
#define IGB_MAX_TX_QUEUES                  16
68

69 70 71 72 73 74 75 76
#define IGB_MAX_VF_MC_ENTRIES              30
#define IGB_MAX_VF_FUNCTIONS               8
#define IGB_MAX_VFTA_ENTRIES               128

struct vf_data_storage {
	unsigned char vf_mac_addresses[ETH_ALEN];
	u16 vf_mc_hashes[IGB_MAX_VF_MC_ENTRIES];
	u16 num_vf_mc_hashes;
77
	u16 vlans_enabled;
78 79
	u32 flags;
	unsigned long last_nack;
80 81
	u16 pf_vlan; /* When set, guest VLAN config not allowed. */
	u16 pf_qos;
82
	u16 tx_rate;
83 84
};

85
#define IGB_VF_FLAG_CTS            0x00000001 /* VF is clear to send data */
86 87
#define IGB_VF_FLAG_UNI_PROMISC    0x00000002 /* VF has unicast promisc */
#define IGB_VF_FLAG_MULTI_PROMISC  0x00000004 /* VF has multicast promisc */
88
#define IGB_VF_FLAG_PF_SET_MAC     0x00000008 /* PF has set MAC address */
89

90 91 92 93 94 95 96 97 98 99 100
/* RX descriptor control thresholds.
 * PTHRESH - MAC will consider prefetch if it has fewer than this number of
 *           descriptors available in its onboard memory.
 *           Setting this to 0 disables RX descriptor prefetch.
 * HTHRESH - MAC will only prefetch if there are at least this many descriptors
 *           available in host memory.
 *           If PTHRESH is 0, this should also be 0.
 * WTHRESH - RX descriptor writeback threshold - MAC will delay writing back
 *           descriptors until either it has this many to write back, or the
 *           ITR timer expires.
 */
101
#define IGB_RX_PTHRESH                     8
102
#define IGB_RX_HTHRESH                     8
103 104
#define IGB_TX_PTHRESH                     8
#define IGB_TX_HTHRESH                     1
105 106
#define IGB_RX_WTHRESH                     ((hw->mac.type == e1000_82576 && \
					     adapter->msix_entries) ? 1 : 4)
107
#define IGB_TX_WTHRESH                     ((hw->mac.type == e1000_82576 && \
108
					     adapter->msix_entries) ? 1 : 16)
109 110 111 112 113

/* this is the size past which hardware will drop packets when setting LPE=0 */
#define MAXIMUM_ETHERNET_VLAN_SIZE 1522

/* Supported Rx Buffer Sizes */
114
#define IGB_RXBUFFER_512   512
115
#define IGB_RXBUFFER_16384 16384
116
#define IGB_RX_HDR_LEN     IGB_RXBUFFER_512
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134

/* How many Tx Descriptors do we need to call netif_wake_queue ? */
#define IGB_TX_QUEUE_WAKE	16
/* How many Rx Buffers do we bundle into one write to the hardware ? */
#define IGB_RX_BUFFER_WRITE	16	/* Must be power of 2 */

#define AUTO_ALL_MODES            0
#define IGB_EEPROM_APME         0x0400

#ifndef IGB_MASTER_SLAVE
/* Switch to override PHY master/slave setting */
#define IGB_MASTER_SLAVE	e1000_ms_hw_default
#endif

#define IGB_MNG_VLAN_NONE -1

/* wrapper around a pointer to a socket buffer,
 * so a DMA handle can be stored along with the buffer */
135 136 137 138 139 140 141 142 143 144 145 146 147
struct igb_tx_buffer {
	u16 next_to_watch;
	unsigned long time_stamp;
	dma_addr_t dma;
	u32 length;
	u32 tx_flags;
	struct sk_buff *skb;
	unsigned int bytecount;
	u16 gso_segs;
	u8 mapped_as_page;
};

struct igb_rx_buffer {
148 149
	struct sk_buff *skb;
	dma_addr_t dma;
150 151 152
	struct page *page;
	dma_addr_t page_dma;
	u32 page_offset;
153 154
};

155
struct igb_tx_queue_stats {
156 157
	u64 packets;
	u64 bytes;
158
	u64 restart_queue;
E
Eric Dumazet 已提交
159
	u64 restart_queue2;
160 161
};

162 163 164 165
struct igb_rx_queue_stats {
	u64 packets;
	u64 bytes;
	u64 drops;
166 167
	u64 csum_err;
	u64 alloc_failed;
168 169
};

170
struct igb_q_vector {
171
	struct igb_adapter *adapter; /* backlink */
172 173 174 175 176 177
	struct igb_ring *rx_ring;
	struct igb_ring *tx_ring;
	struct napi_struct napi;

	u32 eims_value;
	u16 cpu;
178
	u16 tx_work_limit;
179 180 181 182 183 184 185 186 187

	u16 itr_val;
	u8 set_itr;
	void __iomem *itr_register;

	char name[IFNAMSIZ + 9];
};

struct igb_ring {
188 189 190
	struct igb_q_vector *q_vector;	/* backlink to q_vector */
	struct net_device *netdev;	/* back pointer to net_device */
	struct device *dev;		/* device pointer for dma mapping */
191 192 193 194
	union {				/* array of buffer info structs */
		struct igb_tx_buffer *tx_buffer_info;
		struct igb_rx_buffer *rx_buffer_info;
	};
195 196 197 198 199 200 201 202 203 204 205
	void *desc;			/* descriptor ring memory */
	unsigned long flags;		/* ring specific flags */
	void __iomem *tail;		/* pointer to ring tail register */

	u16 count;			/* number of desc. in the ring */
	u8 queue_index;			/* logical index of the ring*/
	u8 reg_idx;			/* physical index of the ring */
	u32 size;			/* length of desc. ring in bytes */

	/* everything past this point are written often */
	u16 next_to_clean ____cacheline_aligned_in_smp;
206 207 208 209 210 211 212 213
	u16 next_to_use;

	unsigned int total_bytes;
	unsigned int total_packets;

	union {
		/* TX */
		struct {
214
			struct igb_tx_queue_stats tx_stats;
E
Eric Dumazet 已提交
215 216
			struct u64_stats_sync tx_syncp;
			struct u64_stats_sync tx_syncp2;
217 218 219 220
			bool detect_tx_hung;
		};
		/* RX */
		struct {
221
			struct igb_rx_queue_stats rx_stats;
E
Eric Dumazet 已提交
222
			struct u64_stats_sync rx_syncp;
223 224
		};
	};
225 226
	/* Items past this point are only used during ring alloc / free */
	dma_addr_t dma;                /* phys address of the ring */
227 228
};

229 230 231 232 233 234 235
#define IGB_RING_FLAG_RX_CSUM        0x00000001 /* RX CSUM enabled */
#define IGB_RING_FLAG_RX_SCTP_CSUM   0x00000002 /* SCTP CSUM offload enabled */

#define IGB_RING_FLAG_TX_CTX_IDX     0x00000001 /* HW requires context index */

#define IGB_ADVTXD_DCMD (E1000_TXD_CMD_EOP | E1000_TXD_CMD_RS)

236 237 238 239 240 241
#define IGB_RX_DESC(R, i)	    \
	(&(((union e1000_adv_rx_desc *)((R)->desc))[i]))
#define IGB_TX_DESC(R, i)	    \
	(&(((union e1000_adv_tx_desc *)((R)->desc))[i]))
#define IGB_TX_CTXTDESC(R, i)	    \
	(&(((struct e1000_adv_tx_context_desc *)((R)->desc))[i]))
242

243 244 245 246 247 248 249 250 251
/* igb_desc_unused - calculate if we have unused descriptors */
static inline int igb_desc_unused(struct igb_ring *ring)
{
	if (ring->next_to_clean > ring->next_to_use)
		return ring->next_to_clean - ring->next_to_use - 1;

	return ring->count + ring->next_to_clean - ring->next_to_use - 1;
}

252 253
/* board specific private data structure */
struct igb_adapter {
J
Jiri Pirko 已提交
254
	unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
255 256 257 258 259 260 261 262

	struct net_device *netdev;

	unsigned long state;
	unsigned int flags;

	unsigned int num_q_vectors;
	struct msix_entry *msix_entries;
263

264
	/* Interrupt Throttle Rate */
265 266
	u32 rx_itr_setting;
	u32 tx_itr_setting;
267 268 269 270
	u16 tx_itr;
	u16 rx_itr;

	/* TX */
271
	u16 tx_work_limit;
272
	u32 tx_timeout_count;
273 274
	int num_tx_queues;
	struct igb_ring *tx_ring[16];
275 276 277

	/* RX */
	int num_rx_queues;
278
	struct igb_ring *rx_ring[16];
279 280 281 282

	u32 max_frame_size;
	u32 min_frame_size;

283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
	struct timer_list watchdog_timer;
	struct timer_list phy_info_timer;

	u16 mng_vlan_id;
	u32 bd_number;
	u32 wol;
	u32 en_mng_pt;
	u16 link_speed;
	u16 link_duplex;

	struct work_struct reset_task;
	struct work_struct watchdog_task;
	bool fc_autoneg;
	u8  tx_timeout_factor;
	struct timer_list blink_timer;
	unsigned long led_status;

300 301
	/* OS defined structs */
	struct pci_dev *pdev;
P
Patrick Ohly 已提交
302 303
	struct cyclecounter cycles;
	struct timecounter clock;
304 305
	struct timecompare compare;
	struct hwtstamp_config hwtstamp_config;
306

E
Eric Dumazet 已提交
307 308 309
	spinlock_t stats64_lock;
	struct rtnl_link_stats64 stats64;

310 311 312 313 314 315 316 317 318 319 320
	/* structs defined in e1000_hw.h */
	struct e1000_hw hw;
	struct e1000_hw_stats stats;
	struct e1000_phy_info phy_info;
	struct e1000_phy_stats phy_stats;

	u32 test_icr;
	struct igb_ring test_tx_ring;
	struct igb_ring test_rx_ring;

	int msg_enable;
321 322

	struct igb_q_vector *q_vector[MAX_Q_VECTORS];
323
	u32 eims_enable_mask;
P
PJ Waskiewicz 已提交
324
	u32 eims_other;
325 326 327

	/* to not mess up cache alignment, always add to the bottom */
	u32 eeprom_wol;
T
Taku Izumi 已提交
328

329 330
	u16 tx_ring_count;
	u16 rx_ring_count;
331
	unsigned int vfs_allocated_count;
332
	struct vf_data_storage *vf_data;
333
	int vf_rate_link_speed;
334
	u32 rss_queues;
G
Greg Rose 已提交
335
	u32 wvbr;
336 337
};

338
#define IGB_FLAG_HAS_MSI           (1 << 0)
A
Alexander Duyck 已提交
339 340
#define IGB_FLAG_DCA_ENABLED       (1 << 1)
#define IGB_FLAG_QUAD_PORT_A       (1 << 2)
341
#define IGB_FLAG_QUEUE_PAIRS       (1 << 3)
342 343 344 345 346 347
#define IGB_FLAG_DMAC              (1 << 4)

/* DMA Coalescing defines */
#define IGB_MIN_TXPBSIZE           20408
#define IGB_TX_BUF_4096            4096
#define IGB_DMCTLX_DCFLUSH_DIS     0x80000000  /* Disable DMA Coal Flush */
348

349
#define IGB_82576_TSYNC_SHIFT 19
350
#define IGB_82580_TSYNC_SHIFT 24
N
Nick Nunley 已提交
351
#define IGB_TS_HDR_LEN        16
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
enum e1000_state_t {
	__IGB_TESTING,
	__IGB_RESETTING,
	__IGB_DOWN
};

enum igb_boards {
	board_82575,
};

extern char igb_driver_name[];
extern char igb_driver_version[];

extern int igb_up(struct igb_adapter *);
extern void igb_down(struct igb_adapter *);
extern void igb_reinit_locked(struct igb_adapter *);
extern void igb_reset(struct igb_adapter *);
369
extern int igb_set_spd_dplx(struct igb_adapter *, u32, u8);
370 371
extern int igb_setup_tx_resources(struct igb_ring *);
extern int igb_setup_rx_resources(struct igb_ring *);
372 373
extern void igb_free_tx_resources(struct igb_ring *);
extern void igb_free_rx_resources(struct igb_ring *);
374 375 376 377
extern void igb_configure_tx_ring(struct igb_adapter *, struct igb_ring *);
extern void igb_configure_rx_ring(struct igb_adapter *, struct igb_ring *);
extern void igb_setup_tctl(struct igb_adapter *);
extern void igb_setup_rctl(struct igb_adapter *);
378
extern netdev_tx_t igb_xmit_frame_ring(struct sk_buff *, struct igb_ring *);
379
extern void igb_unmap_and_free_tx_resource(struct igb_ring *,
380
					   struct igb_tx_buffer *);
381
extern void igb_alloc_rx_buffers(struct igb_ring *, u16);
E
Eric Dumazet 已提交
382
extern void igb_update_stats(struct igb_adapter *, struct rtnl_link_stats64 *);
383
extern bool igb_has_link(struct igb_adapter *adapter);
384
extern void igb_set_ethtool_ops(struct net_device *);
385
extern void igb_power_up_link(struct igb_adapter *);
386

387 388
static inline s32 igb_reset_phy(struct e1000_hw *hw)
{
A
Alexander Duyck 已提交
389 390
	if (hw->phy.ops.reset)
		return hw->phy.ops.reset(hw);
391 392 393 394 395 396

	return 0;
}

static inline s32 igb_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data)
{
A
Alexander Duyck 已提交
397 398
	if (hw->phy.ops.read_reg)
		return hw->phy.ops.read_reg(hw, offset, data);
399 400 401 402 403 404

	return 0;
}

static inline s32 igb_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data)
{
A
Alexander Duyck 已提交
405 406
	if (hw->phy.ops.write_reg)
		return hw->phy.ops.write_reg(hw, offset, data);
407 408 409 410 411 412 413 414 415 416 417 418

	return 0;
}

static inline s32 igb_get_phy_info(struct e1000_hw *hw)
{
	if (hw->phy.ops.get_phy_info)
		return hw->phy.ops.get_phy_info(hw);

	return 0;
}

419
#endif /* _IGB_H_ */