Linux Audio

Check our new training course

Loading...
Note: File does not exist in v4.6.
  1/* SPDX-License-Identifier: GPL-2.0 */
  2/* Copyright(c) 2013 - 2018 Intel Corporation. */
  3
  4#ifndef _IAVF_H_
  5#define _IAVF_H_
  6
  7#include <linux/module.h>
  8#include <linux/pci.h>
  9#include <linux/aer.h>
 10#include <linux/netdevice.h>
 11#include <linux/vmalloc.h>
 12#include <linux/interrupt.h>
 13#include <linux/ethtool.h>
 14#include <linux/if_vlan.h>
 15#include <linux/ip.h>
 16#include <linux/tcp.h>
 17#include <linux/sctp.h>
 18#include <linux/ipv6.h>
 19#include <linux/kernel.h>
 20#include <linux/bitops.h>
 21#include <linux/timer.h>
 22#include <linux/workqueue.h>
 23#include <linux/wait.h>
 24#include <linux/delay.h>
 25#include <linux/gfp.h>
 26#include <linux/skbuff.h>
 27#include <linux/dma-mapping.h>
 28#include <linux/etherdevice.h>
 29#include <linux/socket.h>
 30#include <linux/jiffies.h>
 31#include <net/ip6_checksum.h>
 32#include <net/pkt_cls.h>
 33#include <net/udp.h>
 34#include <net/tc_act/tc_gact.h>
 35#include <net/tc_act/tc_mirred.h>
 36
 37#include "iavf_type.h"
 38#include <linux/avf/virtchnl.h>
 39#include "iavf_txrx.h"
 40#include "iavf_fdir.h"
 41#include "iavf_adv_rss.h"
 42
 43#define DEFAULT_DEBUG_LEVEL_SHIFT 3
 44#define PFX "iavf: "
 45
 46/* VSI state flags shared with common code */
 47enum iavf_vsi_state_t {
 48	__IAVF_VSI_DOWN,
 49	/* This must be last as it determines the size of the BITMAP */
 50	__IAVF_VSI_STATE_SIZE__,
 51};
 52
 53/* dummy struct to make common code less painful */
 54struct iavf_vsi {
 55	struct iavf_adapter *back;
 56	struct net_device *netdev;
 57	unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
 58	u16 seid;
 59	u16 id;
 60	DECLARE_BITMAP(state, __IAVF_VSI_STATE_SIZE__);
 61	int base_vector;
 62	u16 work_limit;
 63	u16 qs_handle;
 64	void *priv;     /* client driver data reference. */
 65};
 66
 67/* How many Rx Buffers do we bundle into one write to the hardware ? */
 68#define IAVF_RX_BUFFER_WRITE	16	/* Must be power of 2 */
 69#define IAVF_DEFAULT_TXD	512
 70#define IAVF_DEFAULT_RXD	512
 71#define IAVF_MAX_TXD		4096
 72#define IAVF_MIN_TXD		64
 73#define IAVF_MAX_RXD		4096
 74#define IAVF_MIN_RXD		64
 75#define IAVF_REQ_DESCRIPTOR_MULTIPLE	32
 76#define IAVF_MAX_AQ_BUF_SIZE	4096
 77#define IAVF_AQ_LEN		32
 78#define IAVF_AQ_MAX_ERR	20 /* times to try before resetting AQ */
 79
 80#define MAXIMUM_ETHERNET_VLAN_SIZE (VLAN_ETH_FRAME_LEN + ETH_FCS_LEN)
 81
 82#define IAVF_RX_DESC(R, i) (&(((union iavf_32byte_rx_desc *)((R)->desc))[i]))
 83#define IAVF_TX_DESC(R, i) (&(((struct iavf_tx_desc *)((R)->desc))[i]))
 84#define IAVF_TX_CTXTDESC(R, i) \
 85	(&(((struct iavf_tx_context_desc *)((R)->desc))[i]))
 86#define IAVF_MAX_REQ_QUEUES 16
 87
 88#define IAVF_HKEY_ARRAY_SIZE ((IAVF_VFQF_HKEY_MAX_INDEX + 1) * 4)
 89#define IAVF_HLUT_ARRAY_SIZE ((IAVF_VFQF_HLUT_MAX_INDEX + 1) * 4)
 90#define IAVF_MBPS_DIVISOR	125000 /* divisor to convert to Mbps */
 91
 92#define IAVF_VIRTCHNL_VF_RESOURCE_SIZE (sizeof(struct virtchnl_vf_resource) + \
 93					(IAVF_MAX_VF_VSI * \
 94					 sizeof(struct virtchnl_vsi_resource)))
 95
 96/* MAX_MSIX_Q_VECTORS of these are allocated,
 97 * but we only use one per queue-specific vector.
 98 */
 99struct iavf_q_vector {
100	struct iavf_adapter *adapter;
101	struct iavf_vsi *vsi;
102	struct napi_struct napi;
103	struct iavf_ring_container rx;
104	struct iavf_ring_container tx;
105	u32 ring_mask;
106	u8 itr_countdown;	/* when 0 should adjust adaptive ITR */
107	u8 num_ringpairs;	/* total number of ring pairs in vector */
108	u16 v_idx;		/* index in the vsi->q_vector array. */
109	u16 reg_idx;		/* register index of the interrupt */
110	char name[IFNAMSIZ + 15];
111	bool arm_wb_state;
112	cpumask_t affinity_mask;
113	struct irq_affinity_notify affinity_notify;
114};
115
116/* Helper macros to switch between ints/sec and what the register uses.
117 * And yes, it's the same math going both ways.  The lowest value
118 * supported by all of the iavf hardware is 8.
119 */
120#define EITR_INTS_PER_SEC_TO_REG(_eitr) \
121	((_eitr) ? (1000000000 / ((_eitr) * 256)) : 8)
122#define EITR_REG_TO_INTS_PER_SEC EITR_INTS_PER_SEC_TO_REG
123
124#define IAVF_DESC_UNUSED(R) \
125	((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
126	(R)->next_to_clean - (R)->next_to_use - 1)
127
128#define OTHER_VECTOR 1
129#define NONQ_VECS (OTHER_VECTOR)
130
131#define MIN_MSIX_Q_VECTORS 1
132#define MIN_MSIX_COUNT (MIN_MSIX_Q_VECTORS + NONQ_VECS)
133
134#define IAVF_QUEUE_END_OF_LIST 0x7FF
135#define IAVF_FREE_VECTOR 0x7FFF
136struct iavf_mac_filter {
137	struct list_head list;
138	u8 macaddr[ETH_ALEN];
139	bool is_new_mac;	/* filter is new, wait for PF decision */
140	bool remove;		/* filter needs to be removed */
141	bool add;		/* filter needs to be added */
142};
143
144struct iavf_vlan_filter {
145	struct list_head list;
146	u16 vlan;
147	bool remove;		/* filter needs to be removed */
148	bool add;		/* filter needs to be added */
149};
150
151#define IAVF_MAX_TRAFFIC_CLASS	4
152/* State of traffic class creation */
153enum iavf_tc_state_t {
154	__IAVF_TC_INVALID, /* no traffic class, default state */
155	__IAVF_TC_RUNNING, /* traffic classes have been created */
156};
157
158/* channel info */
159struct iavf_channel_config {
160	struct virtchnl_channel_info ch_info[IAVF_MAX_TRAFFIC_CLASS];
161	enum iavf_tc_state_t state;
162	u8 total_qps;
163};
164
165/* State of cloud filter */
166enum iavf_cloud_filter_state_t {
167	__IAVF_CF_INVALID,	 /* cloud filter not added */
168	__IAVF_CF_ADD_PENDING, /* cloud filter pending add by the PF */
169	__IAVF_CF_DEL_PENDING, /* cloud filter pending del by the PF */
170	__IAVF_CF_ACTIVE,	 /* cloud filter is active */
171};
172
173/* Driver state. The order of these is important! */
174enum iavf_state_t {
175	__IAVF_STARTUP,		/* driver loaded, probe complete */
176	__IAVF_REMOVE,		/* driver is being unloaded */
177	__IAVF_INIT_VERSION_CHECK,	/* aq msg sent, awaiting reply */
178	__IAVF_INIT_GET_RESOURCES,	/* aq msg sent, awaiting reply */
179	__IAVF_INIT_SW,		/* got resources, setting up structs */
180	__IAVF_RESETTING,		/* in reset */
181	__IAVF_COMM_FAILED,		/* communication with PF failed */
182	/* Below here, watchdog is running */
183	__IAVF_DOWN,			/* ready, can be opened */
184	__IAVF_DOWN_PENDING,		/* descending, waiting for watchdog */
185	__IAVF_TESTING,		/* in ethtool self-test */
186	__IAVF_RUNNING,		/* opened, working */
187};
188
189#define IAVF_CLOUD_FIELD_OMAC		0x01
190#define IAVF_CLOUD_FIELD_IMAC		0x02
191#define IAVF_CLOUD_FIELD_IVLAN	0x04
192#define IAVF_CLOUD_FIELD_TEN_ID	0x08
193#define IAVF_CLOUD_FIELD_IIP		0x10
194
195#define IAVF_CF_FLAGS_OMAC	IAVF_CLOUD_FIELD_OMAC
196#define IAVF_CF_FLAGS_IMAC	IAVF_CLOUD_FIELD_IMAC
197#define IAVF_CF_FLAGS_IMAC_IVLAN	(IAVF_CLOUD_FIELD_IMAC |\
198					 IAVF_CLOUD_FIELD_IVLAN)
199#define IAVF_CF_FLAGS_IMAC_TEN_ID	(IAVF_CLOUD_FIELD_IMAC |\
200					 IAVF_CLOUD_FIELD_TEN_ID)
201#define IAVF_CF_FLAGS_OMAC_TEN_ID_IMAC	(IAVF_CLOUD_FIELD_OMAC |\
202						 IAVF_CLOUD_FIELD_IMAC |\
203						 IAVF_CLOUD_FIELD_TEN_ID)
204#define IAVF_CF_FLAGS_IMAC_IVLAN_TEN_ID	(IAVF_CLOUD_FIELD_IMAC |\
205						 IAVF_CLOUD_FIELD_IVLAN |\
206						 IAVF_CLOUD_FIELD_TEN_ID)
207#define IAVF_CF_FLAGS_IIP	IAVF_CLOUD_FIELD_IIP
208
209/* bookkeeping of cloud filters */
210struct iavf_cloud_filter {
211	enum iavf_cloud_filter_state_t state;
212	struct list_head list;
213	struct virtchnl_filter f;
214	unsigned long cookie;
215	bool del;		/* filter needs to be deleted */
216	bool add;		/* filter needs to be added */
217};
218
219#define IAVF_RESET_WAIT_MS 10
220#define IAVF_RESET_WAIT_DETECTED_COUNT 500
221#define IAVF_RESET_WAIT_COMPLETE_COUNT 2000
222
223/* board specific private data structure */
224struct iavf_adapter {
225	struct work_struct reset_task;
226	struct work_struct adminq_task;
227	struct delayed_work client_task;
228	struct delayed_work init_task;
229	wait_queue_head_t down_waitqueue;
230	struct iavf_q_vector *q_vectors;
231	struct list_head vlan_filter_list;
232	struct list_head mac_filter_list;
233	struct mutex crit_lock;
234	struct mutex client_lock;
235	struct mutex remove_lock;
236	/* Lock to protect accesses to MAC and VLAN lists */
237	spinlock_t mac_vlan_list_lock;
238	char misc_vector_name[IFNAMSIZ + 9];
239	int num_active_queues;
240	int num_req_queues;
241
242	/* TX */
243	struct iavf_ring *tx_rings;
244	u32 tx_timeout_count;
245	u32 tx_desc_count;
246
247	/* RX */
248	struct iavf_ring *rx_rings;
249	u64 hw_csum_rx_error;
250	u32 rx_desc_count;
251	int num_msix_vectors;
252	int num_iwarp_msix;
253	int iwarp_base_vector;
254	u32 client_pending;
255	struct iavf_client_instance *cinst;
256	struct msix_entry *msix_entries;
257
258	u32 flags;
259#define IAVF_FLAG_RX_CSUM_ENABLED		BIT(0)
260#define IAVF_FLAG_PF_COMMS_FAILED		BIT(3)
261#define IAVF_FLAG_RESET_PENDING		BIT(4)
262#define IAVF_FLAG_RESET_NEEDED		BIT(5)
263#define IAVF_FLAG_WB_ON_ITR_CAPABLE		BIT(6)
264#define IAVF_FLAG_SERVICE_CLIENT_REQUESTED	BIT(9)
265#define IAVF_FLAG_CLIENT_NEEDS_OPEN		BIT(10)
266#define IAVF_FLAG_CLIENT_NEEDS_CLOSE		BIT(11)
267#define IAVF_FLAG_CLIENT_NEEDS_L2_PARAMS	BIT(12)
268#define IAVF_FLAG_PROMISC_ON			BIT(13)
269#define IAVF_FLAG_ALLMULTI_ON			BIT(14)
270#define IAVF_FLAG_LEGACY_RX			BIT(15)
271#define IAVF_FLAG_REINIT_ITR_NEEDED		BIT(16)
272#define IAVF_FLAG_QUEUES_DISABLED		BIT(17)
273/* duplicates for common code */
274#define IAVF_FLAG_DCB_ENABLED			0
275	/* flags for admin queue service task */
276	u32 aq_required;
277#define IAVF_FLAG_AQ_ENABLE_QUEUES		BIT(0)
278#define IAVF_FLAG_AQ_DISABLE_QUEUES		BIT(1)
279#define IAVF_FLAG_AQ_ADD_MAC_FILTER		BIT(2)
280#define IAVF_FLAG_AQ_ADD_VLAN_FILTER		BIT(3)
281#define IAVF_FLAG_AQ_DEL_MAC_FILTER		BIT(4)
282#define IAVF_FLAG_AQ_DEL_VLAN_FILTER		BIT(5)
283#define IAVF_FLAG_AQ_CONFIGURE_QUEUES		BIT(6)
284#define IAVF_FLAG_AQ_MAP_VECTORS		BIT(7)
285#define IAVF_FLAG_AQ_HANDLE_RESET		BIT(8)
286#define IAVF_FLAG_AQ_CONFIGURE_RSS		BIT(9) /* direct AQ config */
287#define IAVF_FLAG_AQ_GET_CONFIG		BIT(10)
288/* Newer style, RSS done by the PF so we can ignore hardware vagaries. */
289#define IAVF_FLAG_AQ_GET_HENA			BIT(11)
290#define IAVF_FLAG_AQ_SET_HENA			BIT(12)
291#define IAVF_FLAG_AQ_SET_RSS_KEY		BIT(13)
292#define IAVF_FLAG_AQ_SET_RSS_LUT		BIT(14)
293#define IAVF_FLAG_AQ_REQUEST_PROMISC		BIT(15)
294#define IAVF_FLAG_AQ_RELEASE_PROMISC		BIT(16)
295#define IAVF_FLAG_AQ_REQUEST_ALLMULTI		BIT(17)
296#define IAVF_FLAG_AQ_RELEASE_ALLMULTI		BIT(18)
297#define IAVF_FLAG_AQ_ENABLE_VLAN_STRIPPING	BIT(19)
298#define IAVF_FLAG_AQ_DISABLE_VLAN_STRIPPING	BIT(20)
299#define IAVF_FLAG_AQ_ENABLE_CHANNELS		BIT(21)
300#define IAVF_FLAG_AQ_DISABLE_CHANNELS		BIT(22)
301#define IAVF_FLAG_AQ_ADD_CLOUD_FILTER		BIT(23)
302#define IAVF_FLAG_AQ_DEL_CLOUD_FILTER		BIT(24)
303#define IAVF_FLAG_AQ_ADD_FDIR_FILTER		BIT(25)
304#define IAVF_FLAG_AQ_DEL_FDIR_FILTER		BIT(26)
305#define IAVF_FLAG_AQ_ADD_ADV_RSS_CFG		BIT(27)
306#define IAVF_FLAG_AQ_DEL_ADV_RSS_CFG		BIT(28)
307
308	/* OS defined structs */
309	struct net_device *netdev;
310	struct pci_dev *pdev;
311
312	struct iavf_hw hw; /* defined in iavf_type.h */
313
314	enum iavf_state_t state;
315	unsigned long crit_section;
316
317	struct delayed_work watchdog_task;
318	bool netdev_registered;
319	bool link_up;
320	enum virtchnl_link_speed link_speed;
321	/* This is only populated if the VIRTCHNL_VF_CAP_ADV_LINK_SPEED is set
322	 * in vf_res->vf_cap_flags. Use ADV_LINK_SUPPORT macro to determine if
323	 * this field is valid. This field should be used going forward and the
324	 * enum virtchnl_link_speed above should be considered the legacy way of
325	 * storing/communicating link speeds.
326	 */
327	u32 link_speed_mbps;
328
329	enum virtchnl_ops current_op;
330#define CLIENT_ALLOWED(_a) ((_a)->vf_res ? \
331			    (_a)->vf_res->vf_cap_flags & \
332				VIRTCHNL_VF_OFFLOAD_IWARP : \
333			    0)
334#define CLIENT_ENABLED(_a) ((_a)->cinst)
335/* RSS by the PF should be preferred over RSS via other methods. */
336#define RSS_PF(_a) ((_a)->vf_res->vf_cap_flags & \
337		    VIRTCHNL_VF_OFFLOAD_RSS_PF)
338#define RSS_AQ(_a) ((_a)->vf_res->vf_cap_flags & \
339		    VIRTCHNL_VF_OFFLOAD_RSS_AQ)
340#define RSS_REG(_a) (!((_a)->vf_res->vf_cap_flags & \
341		       (VIRTCHNL_VF_OFFLOAD_RSS_AQ | \
342			VIRTCHNL_VF_OFFLOAD_RSS_PF)))
343#define VLAN_ALLOWED(_a) ((_a)->vf_res->vf_cap_flags & \
344			  VIRTCHNL_VF_OFFLOAD_VLAN)
345#define ADV_LINK_SUPPORT(_a) ((_a)->vf_res->vf_cap_flags & \
346			      VIRTCHNL_VF_CAP_ADV_LINK_SPEED)
347#define FDIR_FLTR_SUPPORT(_a) ((_a)->vf_res->vf_cap_flags & \
348			       VIRTCHNL_VF_OFFLOAD_FDIR_PF)
349#define ADV_RSS_SUPPORT(_a) ((_a)->vf_res->vf_cap_flags & \
350			     VIRTCHNL_VF_OFFLOAD_ADV_RSS_PF)
351	struct virtchnl_vf_resource *vf_res; /* incl. all VSIs */
352	struct virtchnl_vsi_resource *vsi_res; /* our LAN VSI */
353	struct virtchnl_version_info pf_version;
354#define PF_IS_V11(_a) (((_a)->pf_version.major == 1) && \
355		       ((_a)->pf_version.minor == 1))
356	u16 msg_enable;
357	struct iavf_eth_stats current_stats;
358	struct iavf_vsi vsi;
359	u32 aq_wait_count;
360	/* RSS stuff */
361	u64 hena;
362	u16 rss_key_size;
363	u16 rss_lut_size;
364	u8 *rss_key;
365	u8 *rss_lut;
366	/* ADQ related members */
367	struct iavf_channel_config ch_config;
368	u8 num_tc;
369	struct list_head cloud_filter_list;
370	/* lock to protect access to the cloud filter list */
371	spinlock_t cloud_filter_list_lock;
372	u16 num_cloud_filters;
373
374#define IAVF_MAX_FDIR_FILTERS 128	/* max allowed Flow Director filters */
375	u16 fdir_active_fltr;
376	struct list_head fdir_list_head;
377	spinlock_t fdir_fltr_lock;	/* protect the Flow Director filter list */
378
379	struct list_head adv_rss_list_head;
380	spinlock_t adv_rss_lock;	/* protect the RSS management list */
381};
382
383
384/* Ethtool Private Flags */
385
386/* lan device, used by client interface */
387struct iavf_device {
388	struct list_head list;
389	struct iavf_adapter *vf;
390};
391
392/* needed by iavf_ethtool.c */
393extern char iavf_driver_name[];
394extern struct workqueue_struct *iavf_wq;
395
396int iavf_up(struct iavf_adapter *adapter);
397void iavf_down(struct iavf_adapter *adapter);
398int iavf_process_config(struct iavf_adapter *adapter);
399void iavf_schedule_reset(struct iavf_adapter *adapter);
400void iavf_reset(struct iavf_adapter *adapter);
401void iavf_set_ethtool_ops(struct net_device *netdev);
402void iavf_update_stats(struct iavf_adapter *adapter);
403void iavf_reset_interrupt_capability(struct iavf_adapter *adapter);
404int iavf_init_interrupt_scheme(struct iavf_adapter *adapter);
405void iavf_irq_enable_queues(struct iavf_adapter *adapter, u32 mask);
406void iavf_free_all_tx_resources(struct iavf_adapter *adapter);
407void iavf_free_all_rx_resources(struct iavf_adapter *adapter);
408
409void iavf_napi_add_all(struct iavf_adapter *adapter);
410void iavf_napi_del_all(struct iavf_adapter *adapter);
411
412int iavf_send_api_ver(struct iavf_adapter *adapter);
413int iavf_verify_api_ver(struct iavf_adapter *adapter);
414int iavf_send_vf_config_msg(struct iavf_adapter *adapter);
415int iavf_get_vf_config(struct iavf_adapter *adapter);
416void iavf_irq_enable(struct iavf_adapter *adapter, bool flush);
417void iavf_configure_queues(struct iavf_adapter *adapter);
418void iavf_deconfigure_queues(struct iavf_adapter *adapter);
419void iavf_enable_queues(struct iavf_adapter *adapter);
420void iavf_disable_queues(struct iavf_adapter *adapter);
421void iavf_map_queues(struct iavf_adapter *adapter);
422int iavf_request_queues(struct iavf_adapter *adapter, int num);
423void iavf_add_ether_addrs(struct iavf_adapter *adapter);
424void iavf_del_ether_addrs(struct iavf_adapter *adapter);
425void iavf_add_vlans(struct iavf_adapter *adapter);
426void iavf_del_vlans(struct iavf_adapter *adapter);
427void iavf_set_promiscuous(struct iavf_adapter *adapter, int flags);
428void iavf_request_stats(struct iavf_adapter *adapter);
429void iavf_request_reset(struct iavf_adapter *adapter);
430void iavf_get_hena(struct iavf_adapter *adapter);
431void iavf_set_hena(struct iavf_adapter *adapter);
432void iavf_set_rss_key(struct iavf_adapter *adapter);
433void iavf_set_rss_lut(struct iavf_adapter *adapter);
434void iavf_enable_vlan_stripping(struct iavf_adapter *adapter);
435void iavf_disable_vlan_stripping(struct iavf_adapter *adapter);
436void iavf_virtchnl_completion(struct iavf_adapter *adapter,
437			      enum virtchnl_ops v_opcode,
438			      enum iavf_status v_retval, u8 *msg, u16 msglen);
439int iavf_config_rss(struct iavf_adapter *adapter);
440int iavf_lan_add_device(struct iavf_adapter *adapter);
441int iavf_lan_del_device(struct iavf_adapter *adapter);
442void iavf_client_subtask(struct iavf_adapter *adapter);
443void iavf_notify_client_message(struct iavf_vsi *vsi, u8 *msg, u16 len);
444void iavf_notify_client_l2_params(struct iavf_vsi *vsi);
445void iavf_notify_client_open(struct iavf_vsi *vsi);
446void iavf_notify_client_close(struct iavf_vsi *vsi, bool reset);
447void iavf_enable_channels(struct iavf_adapter *adapter);
448void iavf_disable_channels(struct iavf_adapter *adapter);
449void iavf_add_cloud_filter(struct iavf_adapter *adapter);
450void iavf_del_cloud_filter(struct iavf_adapter *adapter);
451void iavf_add_fdir_filter(struct iavf_adapter *adapter);
452void iavf_del_fdir_filter(struct iavf_adapter *adapter);
453void iavf_add_adv_rss_cfg(struct iavf_adapter *adapter);
454void iavf_del_adv_rss_cfg(struct iavf_adapter *adapter);
455struct iavf_mac_filter *iavf_add_filter(struct iavf_adapter *adapter,
456					const u8 *macaddr);
457#endif /* _IAVF_H_ */