i40evf.h 12.8 KB
Newer Older
G
Greg Rose 已提交
1 2 3
/*******************************************************************************
 *
 * Intel Ethernet Controller XL710 Family Linux Virtual Function Driver
4
 * Copyright(c) 2013 - 2016 Intel Corporation.
G
Greg Rose 已提交
5 6 7 8 9 10 11 12 13 14
 *
 * 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.
 *
15 16 17
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
G
Greg Rose 已提交
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
 * 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
 *
 ******************************************************************************/

#ifndef _I40EVF_H_
#define _I40EVF_H_

#include <linux/module.h>
#include <linux/pci.h>
#include <linux/aer.h>
#include <linux/netdevice.h>
#include <linux/vmalloc.h>
#include <linux/interrupt.h>
#include <linux/ethtool.h>
#include <linux/if_vlan.h>
#include <linux/ip.h>
#include <linux/tcp.h>
#include <linux/sctp.h>
#include <linux/ipv6.h>
#include <net/ip6_checksum.h>
#include <net/udp.h>

#include "i40e_type.h"
#include "i40e_virtchnl.h"
#include "i40e_txrx.h"

#define DEFAULT_DEBUG_LEVEL_SHIFT 3
#define PFX "i40evf: "

52 53 54
/* VSI state flags shared with common code */
enum i40evf_vsi_state_t {
	__I40E_VSI_DOWN,
55 56
	/* This must be last as it determines the size of the BITMAP */
	__I40E_VSI_STATE_SIZE__,
57 58
};

G
Greg Rose 已提交
59 60 61 62 63 64 65
/* dummy struct to make common code less painful */
struct i40e_vsi {
	struct i40evf_adapter *back;
	struct net_device *netdev;
	unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
	u16 seid;
	u16 id;
66
	DECLARE_BITMAP(state, __I40E_VSI_STATE_SIZE__);
G
Greg Rose 已提交
67 68
	int base_vector;
	u16 work_limit;
69
	u16 qs_handle;
M
Mitch Williams 已提交
70
	void *priv;     /* client driver data reference. */
G
Greg Rose 已提交
71 72 73 74
};

/* How many Rx Buffers do we bundle into one write to the hardware ? */
#define I40EVF_RX_BUFFER_WRITE	16	/* Must be power of 2 */
J
Jeff Kirsher 已提交
75 76 77 78 79 80 81 82 83 84
#define I40EVF_DEFAULT_TXD	512
#define I40EVF_DEFAULT_RXD	512
#define I40EVF_MAX_TXD		4096
#define I40EVF_MIN_TXD		64
#define I40EVF_MAX_RXD		4096
#define I40EVF_MIN_RXD		64
#define I40EVF_REQ_DESCRIPTOR_MULTIPLE	32
#define I40EVF_MAX_AQ_BUF_SIZE	4096
#define I40EVF_AQ_LEN		32
#define I40EVF_AQ_MAX_ERR	20 /* times to try before resetting AQ */
G
Greg Rose 已提交
85 86 87 88 89 90 91

#define MAXIMUM_ETHERNET_VLAN_SIZE (VLAN_ETH_FRAME_LEN + ETH_FCS_LEN)

#define I40E_RX_DESC(R, i) (&(((union i40e_32byte_rx_desc *)((R)->desc))[i]))
#define I40E_TX_DESC(R, i) (&(((struct i40e_tx_desc *)((R)->desc))[i]))
#define I40E_TX_CTXTDESC(R, i) \
	(&(((struct i40e_tx_context_desc *)((R)->desc))[i]))
92
#define MAX_QUEUES 16
G
Greg Rose 已提交
93

94
#define I40EVF_HKEY_ARRAY_SIZE ((I40E_VFQF_HKEY_MAX_INDEX + 1) * 4)
95
#define I40EVF_HLUT_ARRAY_SIZE ((I40E_VFQF_HLUT_MAX_INDEX + 1) * 4)
96

G
Greg Rose 已提交
97 98 99 100 101 102 103 104 105 106 107 108
/* MAX_MSIX_Q_VECTORS of these are allocated,
 * but we only use one per queue-specific vector.
 */
struct i40e_q_vector {
	struct i40evf_adapter *adapter;
	struct i40e_vsi *vsi;
	struct napi_struct napi;
	unsigned long reg_idx;
	struct i40e_ring_container rx;
	struct i40e_ring_container tx;
	u32 ring_mask;
	u8 num_ringpairs;	/* total number of ring pairs in vector */
109 110
#define ITR_COUNTDOWN_START 100
	u8 itr_countdown;	/* when 0 or 1 update ITR */
J
Jeff Kirsher 已提交
111
	int v_idx;	/* vector index in list */
G
Greg Rose 已提交
112
	char name[IFNAMSIZ + 9];
113
	bool arm_wb_state;
114 115
	cpumask_t affinity_mask;
	struct irq_affinity_notify affinity_notify;
G
Greg Rose 已提交
116 117 118 119 120 121 122 123 124 125 126 127 128 129
};

/* Helper macros to switch between ints/sec and what the register uses.
 * And yes, it's the same math going both ways.  The lowest value
 * supported by all of the i40e hardware is 8.
 */
#define EITR_INTS_PER_SEC_TO_REG(_eitr) \
	((_eitr) ? (1000000000 / ((_eitr) * 256)) : 8)
#define EITR_REG_TO_INTS_PER_SEC EITR_INTS_PER_SEC_TO_REG

#define I40EVF_DESC_UNUSED(R) \
	((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
	(R)->next_to_clean - (R)->next_to_use - 1)

J
Jeff Kirsher 已提交
130
#define I40EVF_RX_DESC_ADV(R, i)	\
G
Greg Rose 已提交
131
	(&(((union i40e_adv_rx_desc *)((R).desc))[i]))
J
Jeff Kirsher 已提交
132
#define I40EVF_TX_DESC_ADV(R, i)	\
G
Greg Rose 已提交
133
	(&(((union i40e_adv_tx_desc *)((R).desc))[i]))
J
Jeff Kirsher 已提交
134
#define I40EVF_TX_CTXTDESC_ADV(R, i)	\
G
Greg Rose 已提交
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
	(&(((struct i40e_adv_tx_context_desc *)((R).desc))[i]))

#define OTHER_VECTOR 1
#define NONQ_VECS (OTHER_VECTOR)

#define MIN_MSIX_Q_VECTORS 1
#define MIN_MSIX_COUNT (MIN_MSIX_Q_VECTORS + NONQ_VECS)

#define I40EVF_QUEUE_END_OF_LIST 0x7FF
#define I40EVF_FREE_VECTOR 0x7FFF
struct i40evf_mac_filter {
	struct list_head list;
	u8 macaddr[ETH_ALEN];
	bool remove;		/* filter needs to be removed */
	bool add;		/* filter needs to be added */
};

struct i40evf_vlan_filter {
	struct list_head list;
	u16 vlan;
	bool remove;		/* filter needs to be removed */
	bool add;		/* filter needs to be added */
};

/* Driver state. The order of these is important! */
enum i40evf_state_t {
	__I40EVF_STARTUP,		/* driver loaded, probe complete */
	__I40EVF_REMOVE,		/* driver is being unloaded */
	__I40EVF_INIT_VERSION_CHECK,	/* aq msg sent, awaiting reply */
	__I40EVF_INIT_GET_RESOURCES,	/* aq msg sent, awaiting reply */
	__I40EVF_INIT_SW,		/* got resources, setting up structs */
M
Mitch Williams 已提交
166
	__I40EVF_RESETTING,		/* in reset */
G
Greg Rose 已提交
167 168
	/* Below here, watchdog is running */
	__I40EVF_DOWN,			/* ready, can be opened */
169
	__I40EVF_DOWN_PENDING,		/* descending, waiting for watchdog */
G
Greg Rose 已提交
170 171 172 173 174 175
	__I40EVF_TESTING,		/* in ethtool self-test */
	__I40EVF_RUNNING,		/* opened, working */
};

enum i40evf_critical_section_t {
	__I40EVF_IN_CRITICAL_TASK,	/* cannot be interrupted */
M
Mitch Williams 已提交
176
	__I40EVF_IN_CLIENT_TASK,
G
Greg Rose 已提交
177 178 179 180 181 182 183
};

/* board specific private data structure */
struct i40evf_adapter {
	struct timer_list watchdog_timer;
	struct work_struct reset_task;
	struct work_struct adminq_task;
M
Mitch Williams 已提交
184
	struct delayed_work client_task;
G
Greg Rose 已提交
185
	struct delayed_work init_task;
186
	struct i40e_q_vector *q_vectors;
G
Greg Rose 已提交
187
	struct list_head vlan_filter_list;
188
	char misc_vector_name[IFNAMSIZ + 9];
189
	int num_active_queues;
G
Greg Rose 已提交
190 191

	/* TX */
192
	struct i40e_ring *tx_rings;
G
Greg Rose 已提交
193 194
	u32 tx_timeout_count;
	struct list_head mac_filter_list;
195
	u32 tx_desc_count;
G
Greg Rose 已提交
196 197

	/* RX */
198
	struct i40e_ring *rx_rings;
G
Greg Rose 已提交
199
	u64 hw_csum_rx_error;
200
	u32 rx_desc_count;
G
Greg Rose 已提交
201
	int num_msix_vectors;
M
Mitch Williams 已提交
202 203
	int num_iwarp_msix;
	int iwarp_base_vector;
204
	u32 client_pending;
M
Mitch Williams 已提交
205
	struct i40e_client_instance *cinst;
G
Greg Rose 已提交
206 207
	struct msix_entry *msix_entries;

208
	u32 flags;
J
Jeff Kirsher 已提交
209 210 211 212 213 214
#define I40EVF_FLAG_RX_CSUM_ENABLED		BIT(0)
#define I40EVF_FLAG_IMIR_ENABLED		BIT(5)
#define I40EVF_FLAG_MQ_CAPABLE			BIT(6)
#define I40EVF_FLAG_PF_COMMS_FAILED		BIT(8)
#define I40EVF_FLAG_RESET_PENDING		BIT(9)
#define I40EVF_FLAG_RESET_NEEDED		BIT(10)
215 216
#define I40EVF_FLAG_WB_ON_ITR_CAPABLE		BIT(11)
#define I40EVF_FLAG_OUTER_UDP_CSUM_CAPABLE	BIT(12)
217
#define I40EVF_FLAG_ADDR_SET_BY_PF		BIT(13)
J
Jeff Kirsher 已提交
218
#define I40EVF_FLAG_SERVICE_CLIENT_REQUESTED	BIT(14)
M
Mitch Williams 已提交
219 220 221 222 223
#define I40EVF_FLAG_CLIENT_NEEDS_OPEN		BIT(15)
#define I40EVF_FLAG_CLIENT_NEEDS_CLOSE		BIT(16)
#define I40EVF_FLAG_CLIENT_NEEDS_L2_PARAMS	BIT(17)
#define I40EVF_FLAG_PROMISC_ON			BIT(18)
#define I40EVF_FLAG_ALLMULTI_ON			BIT(19)
224
#define I40EVF_FLAG_LEGACY_RX			BIT(20)
225
/* duplicates for common code */
J
Jeff Kirsher 已提交
226 227 228
#define I40E_FLAG_FDIR_ATR_ENABLED		0
#define I40E_FLAG_DCB_ENABLED			0
#define I40E_FLAG_RX_CSUM_ENABLED		I40EVF_FLAG_RX_CSUM_ENABLED
229 230
#define I40E_FLAG_WB_ON_ITR_CAPABLE		I40EVF_FLAG_WB_ON_ITR_CAPABLE
#define I40E_FLAG_OUTER_UDP_CSUM_CAPABLE	I40EVF_FLAG_OUTER_UDP_CSUM_CAPABLE
231
#define I40E_FLAG_LEGACY_RX			I40EVF_FLAG_LEGACY_RX
G
Greg Rose 已提交
232 233
	/* flags for admin queue service task */
	u32 aq_required;
234 235 236 237 238 239 240 241 242
#define I40EVF_FLAG_AQ_ENABLE_QUEUES		BIT(0)
#define I40EVF_FLAG_AQ_DISABLE_QUEUES		BIT(1)
#define I40EVF_FLAG_AQ_ADD_MAC_FILTER		BIT(2)
#define I40EVF_FLAG_AQ_ADD_VLAN_FILTER		BIT(3)
#define I40EVF_FLAG_AQ_DEL_MAC_FILTER		BIT(4)
#define I40EVF_FLAG_AQ_DEL_VLAN_FILTER		BIT(5)
#define I40EVF_FLAG_AQ_CONFIGURE_QUEUES		BIT(6)
#define I40EVF_FLAG_AQ_MAP_VECTORS		BIT(7)
#define I40EVF_FLAG_AQ_HANDLE_RESET		BIT(8)
J
Jeff Kirsher 已提交
243
#define I40EVF_FLAG_AQ_CONFIGURE_RSS		BIT(9) /* direct AQ config */
244
#define I40EVF_FLAG_AQ_GET_CONFIG		BIT(10)
245 246 247 248 249
/* Newer style, RSS done by the PF so we can ignore hardware vagaries. */
#define I40EVF_FLAG_AQ_GET_HENA			BIT(11)
#define I40EVF_FLAG_AQ_SET_HENA			BIT(12)
#define I40EVF_FLAG_AQ_SET_RSS_KEY		BIT(13)
#define I40EVF_FLAG_AQ_SET_RSS_LUT		BIT(14)
250 251
#define I40EVF_FLAG_AQ_REQUEST_PROMISC		BIT(15)
#define I40EVF_FLAG_AQ_RELEASE_PROMISC		BIT(16)
252 253
#define I40EVF_FLAG_AQ_REQUEST_ALLMULTI		BIT(17)
#define I40EVF_FLAG_AQ_RELEASE_ALLMULTI		BIT(18)
M
Mitch Williams 已提交
254

G
Greg Rose 已提交
255 256 257 258
	/* OS defined structs */
	struct net_device *netdev;
	struct pci_dev *pdev;

M
Mitch Williams 已提交
259
	struct i40e_hw hw; /* defined in i40e_type.h */
G
Greg Rose 已提交
260 261

	enum i40evf_state_t state;
M
Mitch Williams 已提交
262
	unsigned long crit_section;
G
Greg Rose 已提交
263 264 265 266

	struct work_struct watchdog_task;
	bool netdev_registered;
	bool link_up;
M
Mitch Williams 已提交
267
	enum i40e_aq_link_speed link_speed;
G
Greg Rose 已提交
268
	enum i40e_virtchnl_ops current_op;
M
Mitch Williams 已提交
269
#define CLIENT_ALLOWED(_a) ((_a)->vf_res ? \
M
Mitch Williams 已提交
270 271 272
			    (_a)->vf_res->vf_offload_flags & \
				I40E_VIRTCHNL_VF_OFFLOAD_IWARP : \
			    0)
M
Mitch Williams 已提交
273
#define CLIENT_ENABLED(_a) ((_a)->cinst)
274 275 276
/* RSS by the PF should be preferred over RSS via other methods. */
#define RSS_PF(_a) ((_a)->vf_res->vf_offload_flags & \
		    I40E_VIRTCHNL_VF_OFFLOAD_RSS_PF)
277 278
#define RSS_AQ(_a) ((_a)->vf_res->vf_offload_flags & \
		    I40E_VIRTCHNL_VF_OFFLOAD_RSS_AQ)
279 280 281
#define RSS_REG(_a) (!((_a)->vf_res->vf_offload_flags & \
		       (I40E_VIRTCHNL_VF_OFFLOAD_RSS_AQ | \
			I40E_VIRTCHNL_VF_OFFLOAD_RSS_PF)))
282 283
#define VLAN_ALLOWED(_a) ((_a)->vf_res->vf_offload_flags & \
			  I40E_VIRTCHNL_VF_OFFLOAD_VLAN)
G
Greg Rose 已提交
284 285
	struct i40e_virtchnl_vf_resource *vf_res; /* incl. all VSIs */
	struct i40e_virtchnl_vsi_resource *vsi_res; /* our LAN VSI */
286 287 288
	struct i40e_virtchnl_version_info pf_version;
#define PF_IS_V11(_a) (((_a)->pf_version.major == 1) && \
		       ((_a)->pf_version.minor == 1))
G
Greg Rose 已提交
289 290 291 292
	u16 msg_enable;
	struct i40e_eth_stats current_stats;
	struct i40e_vsi vsi;
	u32 aq_wait_count;
293 294 295 296 297 298
	/* RSS stuff */
	u64 hena;
	u16 rss_key_size;
	u16 rss_lut_size;
	u8 *rss_key;
	u8 *rss_lut;
G
Greg Rose 已提交
299 300 301
};


302 303
/* Ethtool Private Flags */

M
Mitch Williams 已提交
304 305 306 307 308 309
/* lan device */
struct i40e_device {
	struct list_head list;
	struct i40evf_adapter *vf;
};

G
Greg Rose 已提交
310 311 312 313 314 315
/* needed by i40evf_ethtool.c */
extern char i40evf_driver_name[];
extern const char i40evf_driver_version[];

int i40evf_up(struct i40evf_adapter *adapter);
void i40evf_down(struct i40evf_adapter *adapter);
M
Mitch Williams 已提交
316
int i40evf_process_config(struct i40evf_adapter *adapter);
317
void i40evf_schedule_reset(struct i40evf_adapter *adapter);
G
Greg Rose 已提交
318 319 320 321 322 323
void i40evf_reset(struct i40evf_adapter *adapter);
void i40evf_set_ethtool_ops(struct net_device *netdev);
void i40evf_update_stats(struct i40evf_adapter *adapter);
void i40evf_reset_interrupt_capability(struct i40evf_adapter *adapter);
int i40evf_init_interrupt_scheme(struct i40evf_adapter *adapter);
void i40evf_irq_enable_queues(struct i40evf_adapter *adapter, u32 mask);
M
Mitch Williams 已提交
324 325
void i40evf_free_all_tx_resources(struct i40evf_adapter *adapter);
void i40evf_free_all_rx_resources(struct i40evf_adapter *adapter);
G
Greg Rose 已提交
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345

void i40e_napi_add_all(struct i40evf_adapter *adapter);
void i40e_napi_del_all(struct i40evf_adapter *adapter);

int i40evf_send_api_ver(struct i40evf_adapter *adapter);
int i40evf_verify_api_ver(struct i40evf_adapter *adapter);
int i40evf_send_vf_config_msg(struct i40evf_adapter *adapter);
int i40evf_get_vf_config(struct i40evf_adapter *adapter);
void i40evf_irq_enable(struct i40evf_adapter *adapter, bool flush);
void i40evf_configure_queues(struct i40evf_adapter *adapter);
void i40evf_deconfigure_queues(struct i40evf_adapter *adapter);
void i40evf_enable_queues(struct i40evf_adapter *adapter);
void i40evf_disable_queues(struct i40evf_adapter *adapter);
void i40evf_map_queues(struct i40evf_adapter *adapter);
void i40evf_add_ether_addrs(struct i40evf_adapter *adapter);
void i40evf_del_ether_addrs(struct i40evf_adapter *adapter);
void i40evf_add_vlans(struct i40evf_adapter *adapter);
void i40evf_del_vlans(struct i40evf_adapter *adapter);
void i40evf_set_promiscuous(struct i40evf_adapter *adapter, int flags);
void i40evf_request_stats(struct i40evf_adapter *adapter);
346
void i40evf_request_reset(struct i40evf_adapter *adapter);
347 348 349 350
void i40evf_get_hena(struct i40evf_adapter *adapter);
void i40evf_set_hena(struct i40evf_adapter *adapter);
void i40evf_set_rss_key(struct i40evf_adapter *adapter);
void i40evf_set_rss_lut(struct i40evf_adapter *adapter);
G
Greg Rose 已提交
351 352 353
void i40evf_virtchnl_completion(struct i40evf_adapter *adapter,
				enum i40e_virtchnl_ops v_opcode,
				i40e_status v_retval, u8 *msg, u16 msglen);
354
int i40evf_config_rss(struct i40evf_adapter *adapter);
M
Mitch Williams 已提交
355 356 357 358 359 360 361
int i40evf_lan_add_device(struct i40evf_adapter *adapter);
int i40evf_lan_del_device(struct i40evf_adapter *adapter);
void i40evf_client_subtask(struct i40evf_adapter *adapter);
void i40evf_notify_client_message(struct i40e_vsi *vsi, u8 *msg, u16 len);
void i40evf_notify_client_l2_params(struct i40e_vsi *vsi);
void i40evf_notify_client_open(struct i40e_vsi *vsi);
void i40evf_notify_client_close(struct i40e_vsi *vsi, bool reset);
G
Greg Rose 已提交
362
#endif /* _I40EVF_H_ */