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