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