]> Git Repo - linux.git/blob - drivers/net/ethernet/intel/fm10k/fm10k.h
efi/x86: add headroom to decompressor BSS to account for setup block
[linux.git] / drivers / net / ethernet / intel / fm10k / fm10k.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Copyright(c) 2013 - 2019 Intel Corporation. */
3
4 #ifndef _FM10K_H_
5 #define _FM10K_H_
6
7 #include <linux/types.h>
8 #include <linux/etherdevice.h>
9 #include <linux/cpumask.h>
10 #include <linux/rtnetlink.h>
11 #include <linux/if_vlan.h>
12 #include <linux/pci.h>
13
14 #include "fm10k_pf.h"
15 #include "fm10k_vf.h"
16
17 #define FM10K_MAX_JUMBO_FRAME_SIZE      15342   /* Maximum supported size 15K */
18
19 #define MAX_QUEUES      FM10K_MAX_QUEUES_PF
20
21 #define FM10K_MIN_RXD            128
22 #define FM10K_MAX_RXD           4096
23 #define FM10K_DEFAULT_RXD        256
24
25 #define FM10K_MIN_TXD            128
26 #define FM10K_MAX_TXD           4096
27 #define FM10K_DEFAULT_TXD        256
28 #define FM10K_DEFAULT_TX_WORK    256
29
30 #define FM10K_RXBUFFER_256        256
31 #define FM10K_RX_HDR_LEN        FM10K_RXBUFFER_256
32 #define FM10K_RXBUFFER_2048      2048
33 #define FM10K_RX_BUFSZ          FM10K_RXBUFFER_2048
34
35 /* How many Rx Buffers do we bundle into one write to the hardware ? */
36 #define FM10K_RX_BUFFER_WRITE   16      /* Must be power of 2 */
37
38 #define FM10K_MAX_STATIONS      63
39 struct fm10k_l2_accel {
40         int size;
41         u16 count;
42         u16 dglort;
43         struct rcu_head rcu;
44         struct net_device *macvlan[0];
45 };
46
47 enum fm10k_ring_state_t {
48         __FM10K_TX_DETECT_HANG,
49         __FM10K_HANG_CHECK_ARMED,
50         __FM10K_TX_XPS_INIT_DONE,
51         /* This must be last and is used to calculate BITMAP size */
52         __FM10K_TX_STATE_SIZE__,
53 };
54
55 #define check_for_tx_hang(ring) \
56         test_bit(__FM10K_TX_DETECT_HANG, (ring)->state)
57 #define set_check_for_tx_hang(ring) \
58         set_bit(__FM10K_TX_DETECT_HANG, (ring)->state)
59 #define clear_check_for_tx_hang(ring) \
60         clear_bit(__FM10K_TX_DETECT_HANG, (ring)->state)
61
62 struct fm10k_tx_buffer {
63         struct fm10k_tx_desc *next_to_watch;
64         struct sk_buff *skb;
65         unsigned int bytecount;
66         u16 gso_segs;
67         u16 tx_flags;
68         DEFINE_DMA_UNMAP_ADDR(dma);
69         DEFINE_DMA_UNMAP_LEN(len);
70 };
71
72 struct fm10k_rx_buffer {
73         dma_addr_t dma;
74         struct page *page;
75         u32 page_offset;
76 };
77
78 struct fm10k_queue_stats {
79         u64 packets;
80         u64 bytes;
81 };
82
83 struct fm10k_tx_queue_stats {
84         u64 restart_queue;
85         u64 csum_err;
86         u64 tx_busy;
87         u64 tx_done_old;
88         u64 csum_good;
89 };
90
91 struct fm10k_rx_queue_stats {
92         u64 alloc_failed;
93         u64 csum_err;
94         u64 errors;
95         u64 csum_good;
96         u64 switch_errors;
97         u64 drops;
98         u64 pp_errors;
99         u64 link_errors;
100         u64 length_errors;
101 };
102
103 struct fm10k_ring {
104         struct fm10k_q_vector *q_vector;/* backpointer to host q_vector */
105         struct net_device *netdev;      /* netdev ring belongs to */
106         struct device *dev;             /* device for DMA mapping */
107         struct fm10k_l2_accel __rcu *l2_accel;  /* L2 acceleration list */
108         void *desc;                     /* descriptor ring memory */
109         union {
110                 struct fm10k_tx_buffer *tx_buffer;
111                 struct fm10k_rx_buffer *rx_buffer;
112         };
113         u32 __iomem *tail;
114         DECLARE_BITMAP(state, __FM10K_TX_STATE_SIZE__);
115         dma_addr_t dma;                 /* phys. address of descriptor ring */
116         unsigned int size;              /* length in bytes */
117
118         u8 queue_index;                 /* needed for queue management */
119         u8 reg_idx;                     /* holds the special value that gets
120                                          * the hardware register offset
121                                          * associated with this ring, which is
122                                          * different for DCB and RSS modes
123                                          */
124         u8 qos_pc;                      /* priority class of queue */
125         u16 vid;                        /* default VLAN ID of queue */
126         u16 count;                      /* amount of descriptors */
127
128         u16 next_to_alloc;
129         u16 next_to_use;
130         u16 next_to_clean;
131
132         struct fm10k_queue_stats stats;
133         struct u64_stats_sync syncp;
134         union {
135                 /* Tx */
136                 struct fm10k_tx_queue_stats tx_stats;
137                 /* Rx */
138                 struct {
139                         struct fm10k_rx_queue_stats rx_stats;
140                         struct sk_buff *skb;
141                 };
142         };
143 } ____cacheline_internodealigned_in_smp;
144
145 struct fm10k_ring_container {
146         struct fm10k_ring *ring;        /* pointer to linked list of rings */
147         unsigned int total_bytes;       /* total bytes processed this int */
148         unsigned int total_packets;     /* total packets processed this int */
149         u16 work_limit;                 /* total work allowed per interrupt */
150         u16 itr;                        /* interrupt throttle rate value */
151         u8 itr_scale;                   /* ITR adjustment based on PCI speed */
152         u8 count;                       /* total number of rings in vector */
153 };
154
155 #define FM10K_ITR_MAX           0x0FFF  /* maximum value for ITR */
156 #define FM10K_ITR_10K           100     /* 100us */
157 #define FM10K_ITR_20K           50      /* 50us */
158 #define FM10K_ITR_40K           25      /* 25us */
159 #define FM10K_ITR_ADAPTIVE      0x8000  /* adaptive interrupt moderation flag */
160
161 #define ITR_IS_ADAPTIVE(itr) (!!(itr & FM10K_ITR_ADAPTIVE))
162
163 #define FM10K_TX_ITR_DEFAULT    FM10K_ITR_40K
164 #define FM10K_RX_ITR_DEFAULT    FM10K_ITR_20K
165 #define FM10K_ITR_ENABLE        (FM10K_ITR_AUTOMASK | FM10K_ITR_MASK_CLEAR)
166
167 static inline struct netdev_queue *txring_txq(const struct fm10k_ring *ring)
168 {
169         return &ring->netdev->_tx[ring->queue_index];
170 }
171
172 /* iterator for handling rings in ring container */
173 #define fm10k_for_each_ring(pos, head) \
174         for (pos = &(head).ring[(head).count]; (--pos) >= (head).ring;)
175
176 #define MAX_Q_VECTORS 256
177 #define MIN_Q_VECTORS   1
178 enum fm10k_non_q_vectors {
179         FM10K_MBX_VECTOR,
180         NON_Q_VECTORS
181 };
182
183 #define MIN_MSIX_COUNT(hw)      (MIN_Q_VECTORS + NON_Q_VECTORS)
184
185 struct fm10k_q_vector {
186         struct fm10k_intfc *interface;
187         u32 __iomem *itr;       /* pointer to ITR register for this vector */
188         u16 v_idx;              /* index of q_vector within interface array */
189         struct fm10k_ring_container rx, tx;
190
191         struct napi_struct napi;
192         cpumask_t affinity_mask;
193         char name[IFNAMSIZ + 9];
194
195 #ifdef CONFIG_DEBUG_FS
196         struct dentry *dbg_q_vector;
197 #endif /* CONFIG_DEBUG_FS */
198         struct rcu_head rcu;    /* to avoid race with update stats on free */
199
200         /* for dynamic allocation of rings associated with this q_vector */
201         struct fm10k_ring ring[0] ____cacheline_internodealigned_in_smp;
202 };
203
204 enum fm10k_ring_f_enum {
205         RING_F_RSS,
206         RING_F_QOS,
207         RING_F_ARRAY_SIZE  /* must be last in enum set */
208 };
209
210 struct fm10k_ring_feature {
211         u16 limit;      /* upper limit on feature indices */
212         u16 indices;    /* current value of indices */
213         u16 mask;       /* Mask used for feature to ring mapping */
214         u16 offset;     /* offset to start of feature */
215 };
216
217 struct fm10k_iov_data {
218         unsigned int            num_vfs;
219         unsigned int            next_vf_mbx;
220         struct rcu_head         rcu;
221         struct fm10k_vf_info    vf_info[0];
222 };
223
224 struct fm10k_udp_port {
225         struct list_head        list;
226         sa_family_t             sa_family;
227         __be16                  port;
228 };
229
230 enum fm10k_macvlan_request_type {
231         FM10K_UC_MAC_REQUEST,
232         FM10K_MC_MAC_REQUEST,
233         FM10K_VLAN_REQUEST
234 };
235
236 struct fm10k_macvlan_request {
237         enum fm10k_macvlan_request_type type;
238         struct list_head list;
239         union {
240                 struct fm10k_mac_request {
241                         u8 addr[ETH_ALEN];
242                         u16 glort;
243                         u16 vid;
244                 } mac;
245                 struct fm10k_vlan_request {
246                         u32 vid;
247                         u8 vsi;
248                 } vlan;
249         };
250         bool set;
251 };
252
253 /* one work queue for entire driver */
254 extern struct workqueue_struct *fm10k_workqueue;
255
256 /* The following enumeration contains flags which indicate or enable modified
257  * driver behaviors. To avoid race conditions, the flags are stored in
258  * a BITMAP in the fm10k_intfc structure. The BITMAP should be accessed using
259  * atomic *_bit() operations.
260  */
261 enum fm10k_flags_t {
262         FM10K_FLAG_RESET_REQUESTED,
263         FM10K_FLAG_RSS_FIELD_IPV4_UDP,
264         FM10K_FLAG_RSS_FIELD_IPV6_UDP,
265         FM10K_FLAG_SWPRI_CONFIG,
266         /* __FM10K_FLAGS_SIZE__ is used to calculate the size of
267          * interface->flags and must be the last value in this
268          * enumeration.
269          */
270         __FM10K_FLAGS_SIZE__
271 };
272
273 enum fm10k_state_t {
274         __FM10K_RESETTING,
275         __FM10K_RESET_DETACHED,
276         __FM10K_RESET_SUSPENDED,
277         __FM10K_DOWN,
278         __FM10K_SERVICE_SCHED,
279         __FM10K_SERVICE_REQUEST,
280         __FM10K_SERVICE_DISABLE,
281         __FM10K_MACVLAN_SCHED,
282         __FM10K_MACVLAN_REQUEST,
283         __FM10K_MACVLAN_DISABLE,
284         __FM10K_LINK_DOWN,
285         __FM10K_UPDATING_STATS,
286         /* This value must be last and determines the BITMAP size */
287         __FM10K_STATE_SIZE__,
288 };
289
290 struct fm10k_intfc {
291         unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
292         struct net_device *netdev;
293         struct fm10k_l2_accel *l2_accel; /* pointer to L2 acceleration list */
294         struct pci_dev *pdev;
295         DECLARE_BITMAP(state, __FM10K_STATE_SIZE__);
296
297         /* Access flag values using atomic *_bit() operations */
298         DECLARE_BITMAP(flags, __FM10K_FLAGS_SIZE__);
299
300         int xcast_mode;
301
302         /* Tx fast path data */
303         int num_tx_queues;
304         u16 tx_itr;
305
306         /* Rx fast path data */
307         int num_rx_queues;
308         u16 rx_itr;
309
310         /* TX */
311         struct fm10k_ring *tx_ring[MAX_QUEUES] ____cacheline_aligned_in_smp;
312
313         u64 restart_queue;
314         u64 tx_busy;
315         u64 tx_csum_errors;
316         u64 alloc_failed;
317         u64 rx_csum_errors;
318
319         u64 tx_bytes_nic;
320         u64 tx_packets_nic;
321         u64 rx_bytes_nic;
322         u64 rx_packets_nic;
323         u64 rx_drops_nic;
324         u64 rx_overrun_pf;
325         u64 rx_overrun_vf;
326
327         /* Debug Statistics */
328         u64 hw_sm_mbx_full;
329         u64 hw_csum_tx_good;
330         u64 hw_csum_rx_good;
331         u64 rx_switch_errors;
332         u64 rx_drops;
333         u64 rx_pp_errors;
334         u64 rx_link_errors;
335         u64 rx_length_errors;
336
337         u32 tx_timeout_count;
338
339         /* RX */
340         struct fm10k_ring *rx_ring[MAX_QUEUES];
341
342         /* Queueing vectors */
343         struct fm10k_q_vector *q_vector[MAX_Q_VECTORS];
344         struct msix_entry *msix_entries;
345         int num_q_vectors;      /* current number of q_vectors for device */
346         struct fm10k_ring_feature ring_feature[RING_F_ARRAY_SIZE];
347
348         /* SR-IOV information management structure */
349         struct fm10k_iov_data *iov_data;
350
351         struct fm10k_hw_stats stats;
352         struct fm10k_hw hw;
353         /* Mailbox lock */
354         spinlock_t mbx_lock;
355         u32 __iomem *uc_addr;
356         u32 __iomem *sw_addr;
357         u16 msg_enable;
358         u16 tx_ring_count;
359         u16 rx_ring_count;
360         struct timer_list service_timer;
361         struct work_struct service_task;
362         unsigned long next_stats_update;
363         unsigned long next_tx_hang_check;
364         unsigned long last_reset;
365         unsigned long link_down_event;
366         bool host_ready;
367         bool lport_map_failed;
368
369         u32 reta[FM10K_RETA_SIZE];
370         u32 rssrk[FM10K_RSSRK_SIZE];
371
372         /* UDP encapsulation port tracking information */
373         struct list_head vxlan_port;
374         struct list_head geneve_port;
375
376         /* MAC/VLAN update queue */
377         struct list_head macvlan_requests;
378         struct delayed_work macvlan_task;
379         /* MAC/VLAN update queue lock */
380         spinlock_t macvlan_lock;
381
382 #ifdef CONFIG_DEBUG_FS
383         struct dentry *dbg_intfc;
384 #endif /* CONFIG_DEBUG_FS */
385
386 #ifdef CONFIG_DCB
387         u8 pfc_en;
388 #endif
389         u8 rx_pause;
390
391         /* GLORT resources in use by PF */
392         u16 glort;
393         u16 glort_count;
394
395         /* VLAN ID for updating multicast/unicast lists */
396         u16 vid;
397 };
398
399 static inline void fm10k_mbx_lock(struct fm10k_intfc *interface)
400 {
401         spin_lock(&interface->mbx_lock);
402 }
403
404 static inline void fm10k_mbx_unlock(struct fm10k_intfc *interface)
405 {
406         spin_unlock(&interface->mbx_lock);
407 }
408
409 static inline int fm10k_mbx_trylock(struct fm10k_intfc *interface)
410 {
411         return spin_trylock(&interface->mbx_lock);
412 }
413
414 /* fm10k_test_staterr - test bits in Rx descriptor status and error fields */
415 static inline __le32 fm10k_test_staterr(union fm10k_rx_desc *rx_desc,
416                                         const u32 stat_err_bits)
417 {
418         return rx_desc->d.staterr & cpu_to_le32(stat_err_bits);
419 }
420
421 /* fm10k_desc_unused - calculate if we have unused descriptors */
422 static inline u16 fm10k_desc_unused(struct fm10k_ring *ring)
423 {
424         s16 unused = ring->next_to_clean - ring->next_to_use - 1;
425
426         return likely(unused < 0) ? unused + ring->count : unused;
427 }
428
429 #define FM10K_TX_DESC(R, i)     \
430         (&(((struct fm10k_tx_desc *)((R)->desc))[i]))
431 #define FM10K_RX_DESC(R, i)     \
432          (&(((union fm10k_rx_desc *)((R)->desc))[i]))
433
434 #define FM10K_MAX_TXD_PWR       14
435 #define FM10K_MAX_DATA_PER_TXD  (1u << FM10K_MAX_TXD_PWR)
436
437 /* Tx Descriptors needed, worst case */
438 #define TXD_USE_COUNT(S)        DIV_ROUND_UP((S), FM10K_MAX_DATA_PER_TXD)
439 #define DESC_NEEDED     (MAX_SKB_FRAGS + 4)
440
441 enum fm10k_tx_flags {
442         /* Tx offload flags */
443         FM10K_TX_FLAGS_CSUM     = 0x01,
444 };
445
446 /* This structure is stored as little endian values as that is the native
447  * format of the Rx descriptor.  The ordering of these fields is reversed
448  * from the actual ftag header to allow for a single bswap to take care
449  * of placing all of the values in network order
450  */
451 union fm10k_ftag_info {
452         __le64 ftag;
453         struct {
454                 /* dglort and sglort combined into a single 32bit desc read */
455                 __le32 glort;
456                 /* upper 16 bits of VLAN are reserved 0 for swpri_type_user */
457                 __le32 vlan;
458         } d;
459         struct {
460                 __le16 dglort;
461                 __le16 sglort;
462                 __le16 vlan;
463                 __le16 swpri_type_user;
464         } w;
465 };
466
467 struct fm10k_cb {
468         union {
469                 __le64 tstamp;
470                 unsigned long ts_tx_timeout;
471         };
472         union fm10k_ftag_info fi;
473 };
474
475 #define FM10K_CB(skb) ((struct fm10k_cb *)(skb)->cb)
476
477 /* main */
478 extern char fm10k_driver_name[];
479 extern const char fm10k_driver_version[];
480 int fm10k_init_queueing_scheme(struct fm10k_intfc *interface);
481 void fm10k_clear_queueing_scheme(struct fm10k_intfc *interface);
482 __be16 fm10k_tx_encap_offload(struct sk_buff *skb);
483 netdev_tx_t fm10k_xmit_frame_ring(struct sk_buff *skb,
484                                   struct fm10k_ring *tx_ring);
485 void fm10k_tx_timeout_reset(struct fm10k_intfc *interface);
486 u64 fm10k_get_tx_pending(struct fm10k_ring *ring, bool in_sw);
487 bool fm10k_check_tx_hang(struct fm10k_ring *tx_ring);
488 void fm10k_alloc_rx_buffers(struct fm10k_ring *rx_ring, u16 cleaned_count);
489
490 /* PCI */
491 void fm10k_mbx_free_irq(struct fm10k_intfc *);
492 int fm10k_mbx_request_irq(struct fm10k_intfc *);
493 void fm10k_qv_free_irq(struct fm10k_intfc *interface);
494 int fm10k_qv_request_irq(struct fm10k_intfc *interface);
495 int fm10k_register_pci_driver(void);
496 void fm10k_unregister_pci_driver(void);
497 void fm10k_up(struct fm10k_intfc *interface);
498 void fm10k_down(struct fm10k_intfc *interface);
499 void fm10k_update_stats(struct fm10k_intfc *interface);
500 void fm10k_service_event_schedule(struct fm10k_intfc *interface);
501 void fm10k_macvlan_schedule(struct fm10k_intfc *interface);
502 void fm10k_update_rx_drop_en(struct fm10k_intfc *interface);
503
504 /* Netdev */
505 struct net_device *fm10k_alloc_netdev(const struct fm10k_info *info);
506 int fm10k_setup_rx_resources(struct fm10k_ring *);
507 int fm10k_setup_tx_resources(struct fm10k_ring *);
508 void fm10k_free_rx_resources(struct fm10k_ring *);
509 void fm10k_free_tx_resources(struct fm10k_ring *);
510 void fm10k_clean_all_rx_rings(struct fm10k_intfc *);
511 void fm10k_clean_all_tx_rings(struct fm10k_intfc *);
512 void fm10k_unmap_and_free_tx_resource(struct fm10k_ring *,
513                                       struct fm10k_tx_buffer *);
514 void fm10k_restore_rx_state(struct fm10k_intfc *);
515 void fm10k_reset_rx_state(struct fm10k_intfc *);
516 int fm10k_setup_tc(struct net_device *dev, u8 tc);
517 int fm10k_open(struct net_device *netdev);
518 int fm10k_close(struct net_device *netdev);
519 int fm10k_queue_vlan_request(struct fm10k_intfc *interface, u32 vid,
520                              u8 vsi, bool set);
521 int fm10k_queue_mac_request(struct fm10k_intfc *interface, u16 glort,
522                             const unsigned char *addr, u16 vid, bool set);
523 void fm10k_clear_macvlan_queue(struct fm10k_intfc *interface,
524                                u16 glort, bool vlans);
525
526 /* Ethtool */
527 void fm10k_set_ethtool_ops(struct net_device *dev);
528 void fm10k_write_reta(struct fm10k_intfc *interface, const u32 *indir);
529
530 /* IOV */
531 s32 fm10k_iov_event(struct fm10k_intfc *interface);
532 s32 fm10k_iov_mbx(struct fm10k_intfc *interface);
533 void fm10k_iov_suspend(struct pci_dev *pdev);
534 int fm10k_iov_resume(struct pci_dev *pdev);
535 void fm10k_iov_disable(struct pci_dev *pdev);
536 int fm10k_iov_configure(struct pci_dev *pdev, int num_vfs);
537 void fm10k_iov_update_stats(struct fm10k_intfc *interface);
538 s32 fm10k_iov_update_pvid(struct fm10k_intfc *interface, u16 glort, u16 pvid);
539 int fm10k_ndo_set_vf_mac(struct net_device *netdev, int vf_idx, u8 *mac);
540 int fm10k_ndo_set_vf_vlan(struct net_device *netdev,
541                           int vf_idx, u16 vid, u8 qos, __be16 vlan_proto);
542 int fm10k_ndo_set_vf_bw(struct net_device *netdev, int vf_idx,
543                         int __always_unused min_rate, int max_rate);
544 int fm10k_ndo_get_vf_config(struct net_device *netdev,
545                             int vf_idx, struct ifla_vf_info *ivi);
546 int fm10k_ndo_get_vf_stats(struct net_device *netdev,
547                            int vf_idx, struct ifla_vf_stats *stats);
548
549 /* DebugFS */
550 #ifdef CONFIG_DEBUG_FS
551 void fm10k_dbg_q_vector_init(struct fm10k_q_vector *q_vector);
552 void fm10k_dbg_q_vector_exit(struct fm10k_q_vector *q_vector);
553 void fm10k_dbg_intfc_init(struct fm10k_intfc *interface);
554 void fm10k_dbg_intfc_exit(struct fm10k_intfc *interface);
555 void fm10k_dbg_init(void);
556 void fm10k_dbg_exit(void);
557 #else
558 static inline void fm10k_dbg_q_vector_init(struct fm10k_q_vector *q_vector) {}
559 static inline void fm10k_dbg_q_vector_exit(struct fm10k_q_vector *q_vector) {}
560 static inline void fm10k_dbg_intfc_init(struct fm10k_intfc *interface) {}
561 static inline void fm10k_dbg_intfc_exit(struct fm10k_intfc *interface) {}
562 static inline void fm10k_dbg_init(void) {}
563 static inline void fm10k_dbg_exit(void) {}
564 #endif /* CONFIG_DEBUG_FS */
565
566 /* DCB */
567 #ifdef CONFIG_DCB
568 void fm10k_dcbnl_set_ops(struct net_device *dev);
569 #else
570 static inline void fm10k_dcbnl_set_ops(struct net_device *dev) {}
571 #endif
572 #endif /* _FM10K_H_ */
This page took 0.085949 seconds and 4 git commands to generate.