[net-next-2.6.git] / drivers / net / igbvf / igbvf.h

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

  Intel(R) 82576 Virtual Function Linux driver
  Copyright(c) 2009 - 2010 Intel Corporation.

  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 _IGBVF_H_
#define _IGBVF_H_

#include <linux/types.h>
#include <linux/timer.h>
#include <linux/io.h>
#include <linux/netdevice.h>


#include "vf.h"

/* Forward declarations */
struct igbvf_info;
struct igbvf_adapter;

/* Interrupt defines */
#define IGBVF_START_ITR                 648 /* ~6000 ints/sec */

/* Interrupt modes, as used by the IntMode parameter */
#define IGBVF_INT_MODE_LEGACY           0
#define IGBVF_INT_MODE_MSI              1
#define IGBVF_INT_MODE_MSIX             2

/* Tx/Rx descriptor defines */
#define IGBVF_DEFAULT_TXD               256
#define IGBVF_MAX_TXD                   4096
#define IGBVF_MIN_TXD                   80

#define IGBVF_DEFAULT_RXD               256
#define IGBVF_MAX_RXD                   4096
#define IGBVF_MIN_RXD                   80

#define IGBVF_MIN_ITR_USECS             10 /* 100000 irq/sec */
#define IGBVF_MAX_ITR_USECS             10000 /* 100    irq/sec */

/* 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.
 */
#define IGBVF_RX_PTHRESH                16
#define IGBVF_RX_HTHRESH                8
#define IGBVF_RX_WTHRESH                1

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

#define IGBVF_FC_PAUSE_TIME             0x0680 /* 858 usec */

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

#define AUTO_ALL_MODES                  0
#define IGBVF_EEPROM_APME               0x0400

#define IGBVF_MNG_VLAN_NONE             (-1)

/* Number of packet split data buffers (not including the header buffer) */
#define PS_PAGE_BUFFERS                 (MAX_PS_BUFFERS - 1)

enum igbvf_boards {
	board_vf,
};

struct igbvf_queue_stats {
	u64 packets;
	u64 bytes;
};

/*
 * wrappers around a pointer to a socket buffer,
 * so a DMA handle can be stored along with the buffer
 */
struct igbvf_buffer {
	dma_addr_t dma;
	struct sk_buff *skb;
	union {
		/* Tx */
		struct {
			unsigned long time_stamp;
			u16 length;
			u16 next_to_watch;
			u16 mapped_as_page;
		};
		/* Rx */
		struct {
			struct page *page;
			u64 page_dma;
			unsigned int page_offset;
		};
	};
};

union igbvf_desc {
	union e1000_adv_rx_desc rx_desc;
	union e1000_adv_tx_desc tx_desc;
	struct e1000_adv_tx_context_desc tx_context_desc;
};

struct igbvf_ring {
	struct igbvf_adapter *adapter;  /* backlink */
	union igbvf_desc *desc;         /* pointer to ring memory  */
	dma_addr_t dma;                 /* phys address of ring    */
	unsigned int size;              /* length of ring in bytes */
	unsigned int count;             /* number of desc. in ring */

	u16 next_to_use;
	u16 next_to_clean;

	u16 head;
	u16 tail;

	/* array of buffer information structs */
	struct igbvf_buffer *buffer_info;
	struct napi_struct napi;

	char name[IFNAMSIZ + 5];
	u32 eims_value;
	u32 itr_val;
	u16 itr_register;
	int set_itr;

	struct sk_buff *rx_skb_top;

	struct igbvf_queue_stats stats;
};

/* board specific private data structure */
struct igbvf_adapter {
	struct timer_list watchdog_timer;
	struct timer_list blink_timer;

	struct work_struct reset_task;
	struct work_struct watchdog_task;

	const struct igbvf_info *ei;

	struct vlan_group *vlgrp;
	u32 bd_number;
	u32 rx_buffer_len;
	u32 polling_interval;
	u16 mng_vlan_id;
	u16 link_speed;
	u16 link_duplex;

	spinlock_t tx_queue_lock; /* prevent concurrent tail updates */

	/* track device up/down/testing state */
	unsigned long state;

	/* Interrupt Throttle Rate */
	u32 itr;
	u32 itr_setting;
	u16 tx_itr;
	u16 rx_itr;

	/*
	 * Tx
	 */
	struct igbvf_ring *tx_ring /* One per active queue */
	____cacheline_aligned_in_smp;

	unsigned int restart_queue;
	u32 txd_cmd;

	bool detect_tx_hung;
	u8 tx_timeout_factor;

	u32 tx_int_delay;
	u32 tx_abs_int_delay;

	unsigned int total_tx_bytes;
	unsigned int total_tx_packets;
	unsigned int total_rx_bytes;
	unsigned int total_rx_packets;

	/* Tx stats */
	u32 tx_timeout_count;
	u32 tx_fifo_head;
	u32 tx_head_addr;
	u32 tx_fifo_size;
	u32 tx_dma_failed;

	/*
	 * Rx
	 */
	struct igbvf_ring *rx_ring;

	u32 rx_int_delay;
	u32 rx_abs_int_delay;

	/* Rx stats */
	u64 hw_csum_err;
	u64 hw_csum_good;
	u64 rx_hdr_split;
	u32 alloc_rx_buff_failed;
	u32 rx_dma_failed;

	unsigned int rx_ps_hdr_size;
	u32 max_frame_size;
	u32 min_frame_size;

	/* OS defined structs */
	struct net_device *netdev;
	struct pci_dev *pdev;
	struct net_device_stats net_stats;
	spinlock_t stats_lock;      /* prevent concurrent stats updates */

	/* structs defined in e1000_hw.h */
	struct e1000_hw hw;

	/* The VF counters don't clear on read so we have to get a base
	 * count on driver start up and always subtract that base on
	 * on the first update, thus the flag..
	 */
	struct e1000_vf_stats stats;
	u64 zero_base;

	struct igbvf_ring test_tx_ring;
	struct igbvf_ring test_rx_ring;
	u32 test_icr;

	u32 msg_enable;
	struct msix_entry *msix_entries;
	int int_mode;
	u32 eims_enable_mask;
	u32 eims_other;
	u32 int_counter0;
	u32 int_counter1;

	u32 eeprom_wol;
	u32 wol;
	u32 pba;

	bool fc_autoneg;

	unsigned long led_status;

	unsigned int flags;
	unsigned long last_reset;
};

struct igbvf_info {
	enum e1000_mac_type     mac;
	unsigned int            flags;
	u32                     pba;
	void                    (*init_ops)(struct e1000_hw *);
	s32                     (*get_variants)(struct igbvf_adapter *);
};

/* hardware capability, feature, and workaround flags */
#define IGBVF_FLAG_RX_CSUM_DISABLED             (1 << 0)

#define IGBVF_RX_DESC_ADV(R, i)     \
	(&((((R).desc))[i].rx_desc))
#define IGBVF_TX_DESC_ADV(R, i)     \
	(&((((R).desc))[i].tx_desc))
#define IGBVF_TX_CTXTDESC_ADV(R, i) \
	(&((((R).desc))[i].tx_context_desc))

enum igbvf_state_t {
	__IGBVF_TESTING,
	__IGBVF_RESETTING,
	__IGBVF_DOWN
};

enum latency_range {
	lowest_latency = 0,
	low_latency = 1,
	bulk_latency = 2,
	latency_invalid = 255
};

extern char igbvf_driver_name[];
extern const char igbvf_driver_version[];

extern void igbvf_check_options(struct igbvf_adapter *);
extern void igbvf_set_ethtool_ops(struct net_device *);

extern int igbvf_up(struct igbvf_adapter *);
extern void igbvf_down(struct igbvf_adapter *);
extern void igbvf_reinit_locked(struct igbvf_adapter *);
extern int igbvf_setup_rx_resources(struct igbvf_adapter *, struct igbvf_ring *);
extern int igbvf_setup_tx_resources(struct igbvf_adapter *, struct igbvf_ring *);
extern void igbvf_free_rx_resources(struct igbvf_ring *);
extern void igbvf_free_tx_resources(struct igbvf_ring *);
extern void igbvf_update_stats(struct igbvf_adapter *);

extern unsigned int copybreak;

#endif /* _IGBVF_H_ */
Commit	Line	Data
d4e0fe01 AD	1	/*******************************************************************************
	2
	3	Intel(R) 82576 Virtual Function Linux driver
2c20ebba	4	Copyright(c) 2009 - 2010 Intel Corporation.
d4e0fe01 AD	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	/* Linux PRO/1000 Ethernet Driver main header file */
	29
	30	#ifndef _IGBVF_H_
	31	#define _IGBVF_H_
	32
	33	#include <linux/types.h>
	34	#include <linux/timer.h>
	35	#include <linux/io.h>
	36	#include <linux/netdevice.h>
	37
	38
	39	#include "vf.h"
	40
	41	/* Forward declarations */
	42	struct igbvf_info;
	43	struct igbvf_adapter;
	44
	45	/* Interrupt defines */
	46	#define IGBVF_START_ITR 648 /* ~6000 ints/sec */
	47
98a1708d	48	/* Interrupt modes, as used by the IntMode parameter */
d4e0fe01 AD	49	#define IGBVF_INT_MODE_LEGACY 0
	50	#define IGBVF_INT_MODE_MSI 1
	51	#define IGBVF_INT_MODE_MSIX 2
	52
	53	/* Tx/Rx descriptor defines */
	54	#define IGBVF_DEFAULT_TXD 256
	55	#define IGBVF_MAX_TXD 4096
	56	#define IGBVF_MIN_TXD 80
	57
	58	#define IGBVF_DEFAULT_RXD 256
	59	#define IGBVF_MAX_RXD 4096
	60	#define IGBVF_MIN_RXD 80
	61
	62	#define IGBVF_MIN_ITR_USECS 10 /* 100000 irq/sec */
	63	#define IGBVF_MAX_ITR_USECS 10000 /* 100 irq/sec */
	64
	65	/* RX descriptor control thresholds.
	66	* PTHRESH - MAC will consider prefetch if it has fewer than this number of
	67	* descriptors available in its onboard memory.
	68	* Setting this to 0 disables RX descriptor prefetch.
	69	* HTHRESH - MAC will only prefetch if there are at least this many descriptors
	70	* available in host memory.
	71	* If PTHRESH is 0, this should also be 0.
	72	* WTHRESH - RX descriptor writeback threshold - MAC will delay writing back
	73	* descriptors until either it has this many to write back, or the
	74	* ITR timer expires.
	75	*/
	76	#define IGBVF_RX_PTHRESH 16
	77	#define IGBVF_RX_HTHRESH 8
	78	#define IGBVF_RX_WTHRESH 1
	79
	80	/* this is the size past which hardware will drop packets when setting LPE=0 */
	81	#define MAXIMUM_ETHERNET_VLAN_SIZE 1522
	82
	83	#define IGBVF_FC_PAUSE_TIME 0x0680 /* 858 usec */
	84
	85	/* How many Tx Descriptors do we need to call netif_wake_queue ? */
	86	#define IGBVF_TX_QUEUE_WAKE 32
	87	/* How many Rx Buffers do we bundle into one write to the hardware ? */
	88	#define IGBVF_RX_BUFFER_WRITE 16 /* Must be power of 2 */
	89
	90	#define AUTO_ALL_MODES 0
	91	#define IGBVF_EEPROM_APME 0x0400
	92
	93	#define IGBVF_MNG_VLAN_NONE (-1)
	94
	95	/* Number of packet split data buffers (not including the header buffer) */
	96	#define PS_PAGE_BUFFERS (MAX_PS_BUFFERS - 1)
	97
	98	enum igbvf_boards {
	99	board_vf,
	100	};
	101
	102	struct igbvf_queue_stats {
	103	u64 packets;
	104	u64 bytes;
	105	};
	106
	107	/*
	108	* wrappers around a pointer to a socket buffer,
	109	* so a DMA handle can be stored along with the buffer
	110	*/
	111	struct igbvf_buffer {
	112	dma_addr_t dma;
113	struct sk_buff *skb;
114	union {
115	/* Tx */
116	struct {
117	unsigned long time_stamp;
118	u16 length;
119	u16 next_to_watch;
a7d5ca40	120	u16 mapped_as_page;
d4e0fe01 AD	121	};
	122	/* Rx */
	123	struct {
	124	struct page *page;
	125	u64 page_dma;
	126	unsigned int page_offset;
	127	};
	128	};
d4e0fe01 AD	129	};
	130
	131	union igbvf_desc {
	132	union e1000_adv_rx_desc rx_desc;
	133	union e1000_adv_tx_desc tx_desc;
	134	struct e1000_adv_tx_context_desc tx_context_desc;
	135	};
	136
	137	struct igbvf_ring {
	138	struct igbvf_adapter adapter; / backlink */
	139	union igbvf_desc desc; / pointer to ring memory */
	140	dma_addr_t dma; /* phys address of ring */
	141	unsigned int size; /* length of ring in bytes */
	142	unsigned int count; /* number of desc. in ring */
	143
	144	u16 next_to_use;
	145	u16 next_to_clean;
	146
	147	u16 head;
	148	u16 tail;
	149
	150	/* array of buffer information structs */
	151	struct igbvf_buffer *buffer_info;
	152	struct napi_struct napi;
	153
	154	char name[IFNAMSIZ + 5];
	155	u32 eims_value;
	156	u32 itr_val;
	157	u16 itr_register;
	158	int set_itr;
	159
	160	struct sk_buff *rx_skb_top;
	161
	162	struct igbvf_queue_stats stats;
	163	};
	164
	165	/* board specific private data structure */
	166	struct igbvf_adapter {
	167	struct timer_list watchdog_timer;
	168	struct timer_list blink_timer;
	169
	170	struct work_struct reset_task;
	171	struct work_struct watchdog_task;
	172
	173	const struct igbvf_info *ei;
	174
	175	struct vlan_group *vlgrp;
	176	u32 bd_number;
	177	u32 rx_buffer_len;
	178	u32 polling_interval;
	179	u16 mng_vlan_id;
	180	u16 link_speed;
	181	u16 link_duplex;
	182
	183	spinlock_t tx_queue_lock; /* prevent concurrent tail updates */
	184
	185	/* track device up/down/testing state */
	186	unsigned long state;
	187
	188	/* Interrupt Throttle Rate */
	189	u32 itr;
	190	u32 itr_setting;
	191	u16 tx_itr;
	192	u16 rx_itr;
193
194	/*
195	* Tx
196	*/
197	struct igbvf_ring tx_ring / One per active queue */
198	____cacheline_aligned_in_smp;
199
d4e0fe01 AD	200	unsigned int restart_queue;
	201	u32 txd_cmd;
	202
	203	bool detect_tx_hung;
	204	u8 tx_timeout_factor;
	205
	206	u32 tx_int_delay;
	207	u32 tx_abs_int_delay;
	208
	209	unsigned int total_tx_bytes;
	210	unsigned int total_tx_packets;
	211	unsigned int total_rx_bytes;
	212	unsigned int total_rx_packets;
	213
	214	/* Tx stats */
	215	u32 tx_timeout_count;
	216	u32 tx_fifo_head;
	217	u32 tx_head_addr;
	218	u32 tx_fifo_size;
	219	u32 tx_dma_failed;
	220
	221	/*
	222	* Rx
	223	*/
	224	struct igbvf_ring *rx_ring;
	225
	226	u32 rx_int_delay;
	227	u32 rx_abs_int_delay;
	228
	229	/* Rx stats */
	230	u64 hw_csum_err;
	231	u64 hw_csum_good;
	232	u64 rx_hdr_split;
	233	u32 alloc_rx_buff_failed;
	234	u32 rx_dma_failed;
	235
	236	unsigned int rx_ps_hdr_size;
	237	u32 max_frame_size;
	238	u32 min_frame_size;
	239
	240	/* OS defined structs */
	241	struct net_device *netdev;
	242	struct pci_dev *pdev;
	243	struct net_device_stats net_stats;
	244	spinlock_t stats_lock; /* prevent concurrent stats updates */
	245
	246	/* structs defined in e1000_hw.h */
	247	struct e1000_hw hw;
	248
	249	/* The VF counters don't clear on read so we have to get a base
	250	* count on driver start up and always subtract that base on
	251	* on the first update, thus the flag..
	252	*/
	253	struct e1000_vf_stats stats;
	254	u64 zero_base;
	255
	256	struct igbvf_ring test_tx_ring;
	257	struct igbvf_ring test_rx_ring;
	258	u32 test_icr;
	259
	260	u32 msg_enable;
	261	struct msix_entry *msix_entries;
	262	int int_mode;
	263	u32 eims_enable_mask;
264	u32 eims_other;
265	u32 int_counter0;
266	u32 int_counter1;
267
268	u32 eeprom_wol;
269	u32 wol;
270	u32 pba;
271
272	bool fc_autoneg;
273
274	unsigned long led_status;
275
276	unsigned int flags;
72279093	277	unsigned long last_reset;
d4e0fe01 AD	278	};
	279
	280	struct igbvf_info {
	281	enum e1000_mac_type mac;
	282	unsigned int flags;
	283	u32 pba;
	284	void (init_ops)(struct e1000_hw );
	285	s32 (get_variants)(struct igbvf_adapter );
	286	};
	287
	288	/* hardware capability, feature, and workaround flags */
0364d6fd	289	#define IGBVF_FLAG_RX_CSUM_DISABLED (1 << 0)
d4e0fe01 AD	290
	291	#define IGBVF_RX_DESC_ADV(R, i) \
	292	(&((((R).desc))[i].rx_desc))
	293	#define IGBVF_TX_DESC_ADV(R, i) \
	294	(&((((R).desc))[i].tx_desc))
	295	#define IGBVF_TX_CTXTDESC_ADV(R, i) \
	296	(&((((R).desc))[i].tx_context_desc))
	297
	298	enum igbvf_state_t {
	299	__IGBVF_TESTING,
	300	__IGBVF_RESETTING,
	301	__IGBVF_DOWN
	302	};
	303
	304	enum latency_range {
	305	lowest_latency = 0,
	306	low_latency = 1,
	307	bulk_latency = 2,
	308	latency_invalid = 255
	309	};
	310
	311	extern char igbvf_driver_name[];
	312	extern const char igbvf_driver_version[];
	313
	314	extern void igbvf_check_options(struct igbvf_adapter *);
	315	extern void igbvf_set_ethtool_ops(struct net_device *);
	316
	317	extern int igbvf_up(struct igbvf_adapter *);
	318	extern void igbvf_down(struct igbvf_adapter *);
	319	extern void igbvf_reinit_locked(struct igbvf_adapter *);
d4e0fe01 AD	320	extern int igbvf_setup_rx_resources(struct igbvf_adapter , struct igbvf_ring );
	321	extern int igbvf_setup_tx_resources(struct igbvf_adapter , struct igbvf_ring );
	322	extern void igbvf_free_rx_resources(struct igbvf_ring *);
	323	extern void igbvf_free_tx_resources(struct igbvf_ring *);
	324	extern void igbvf_update_stats(struct igbvf_adapter *);
d4e0fe01 AD	325
	326	extern unsigned int copybreak;
	327
	328	#endif /* _IGBVF_H_ */