tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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
39struct fm10k_l2_accel {
40 int size;
41 u16 count;
42 u16 dglort;
43 struct rcu_head rcu;
44 struct net_device *macvlan[];
45};
46
47enum 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
62struct 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
72struct fm10k_rx_buffer {
73 dma_addr_t dma;
74 struct page *page;
75 u32 page_offset;
76};
77
78struct fm10k_queue_stats {
79 u64 packets;
80 u64 bytes;
81};
82
83struct 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
91struct 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
103struct 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
145struct 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
167static 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
178enum 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
185struct 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 struct rcu_head rcu; /* to avoid race with update stats on free */
193
194 cpumask_t affinity_mask;
195 char name[IFNAMSIZ + 9];
196
197#ifdef CONFIG_DEBUG_FS
198 struct dentry *dbg_q_vector;
199#endif /* CONFIG_DEBUG_FS */
200
201 /* for dynamic allocation of rings associated with this q_vector */
202 struct fm10k_ring ring[] ____cacheline_internodealigned_in_smp;
203};
204
205enum fm10k_ring_f_enum {
206 RING_F_RSS,
207 RING_F_QOS,
208 RING_F_ARRAY_SIZE /* must be last in enum set */
209};
210
211struct fm10k_ring_feature {
212 u16 limit; /* upper limit on feature indices */
213 u16 indices; /* current value of indices */
214 u16 mask; /* Mask used for feature to ring mapping */
215 u16 offset; /* offset to start of feature */
216};
217
218struct fm10k_iov_data {
219 unsigned int num_vfs;
220 unsigned int next_vf_mbx;
221 struct rcu_head rcu;
222 struct fm10k_vf_info vf_info[];
223};
224
225enum fm10k_macvlan_request_type {
226 FM10K_UC_MAC_REQUEST,
227 FM10K_MC_MAC_REQUEST,
228 FM10K_VLAN_REQUEST
229};
230
231struct fm10k_macvlan_request {
232 enum fm10k_macvlan_request_type type;
233 struct list_head list;
234 union {
235 struct fm10k_mac_request {
236 u8 addr[ETH_ALEN];
237 u16 glort;
238 u16 vid;
239 } mac;
240 struct fm10k_vlan_request {
241 u32 vid;
242 u8 vsi;
243 } vlan;
244 };
245 bool set;
246};
247
248/* one work queue for entire driver */
249extern struct workqueue_struct *fm10k_workqueue;
250
251/* The following enumeration contains flags which indicate or enable modified
252 * driver behaviors. To avoid race conditions, the flags are stored in
253 * a BITMAP in the fm10k_intfc structure. The BITMAP should be accessed using
254 * atomic *_bit() operations.
255 */
256enum fm10k_flags_t {
257 FM10K_FLAG_RESET_REQUESTED,
258 FM10K_FLAG_RSS_FIELD_IPV4_UDP,
259 FM10K_FLAG_RSS_FIELD_IPV6_UDP,
260 FM10K_FLAG_SWPRI_CONFIG,
261 /* __FM10K_FLAGS_SIZE__ is used to calculate the size of
262 * interface->flags and must be the last value in this
263 * enumeration.
264 */
265 __FM10K_FLAGS_SIZE__
266};
267
268enum fm10k_state_t {
269 __FM10K_RESETTING,
270 __FM10K_RESET_DETACHED,
271 __FM10K_RESET_SUSPENDED,
272 __FM10K_DOWN,
273 __FM10K_SERVICE_SCHED,
274 __FM10K_SERVICE_REQUEST,
275 __FM10K_SERVICE_DISABLE,
276 __FM10K_MACVLAN_SCHED,
277 __FM10K_MACVLAN_REQUEST,
278 __FM10K_MACVLAN_DISABLE,
279 __FM10K_LINK_DOWN,
280 __FM10K_UPDATING_STATS,
281 /* This value must be last and determines the BITMAP size */
282 __FM10K_STATE_SIZE__,
283};
284
285struct fm10k_intfc {
286 unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
287 struct net_device *netdev;
288 struct fm10k_l2_accel *l2_accel; /* pointer to L2 acceleration list */
289 struct pci_dev *pdev;
290 DECLARE_BITMAP(state, __FM10K_STATE_SIZE__);
291
292 /* Access flag values using atomic *_bit() operations */
293 DECLARE_BITMAP(flags, __FM10K_FLAGS_SIZE__);
294
295 int xcast_mode;
296
297 /* Tx fast path data */
298 int num_tx_queues;
299 u16 tx_itr;
300
301 /* Rx fast path data */
302 int num_rx_queues;
303 u16 rx_itr;
304
305 /* TX */
306 struct fm10k_ring *tx_ring[MAX_QUEUES] ____cacheline_aligned_in_smp;
307
308 u64 restart_queue;
309 u64 tx_busy;
310 u64 tx_csum_errors;
311 u64 alloc_failed;
312 u64 rx_csum_errors;
313
314 u64 tx_bytes_nic;
315 u64 tx_packets_nic;
316 u64 rx_bytes_nic;
317 u64 rx_packets_nic;
318 u64 rx_drops_nic;
319 u64 rx_overrun_pf;
320 u64 rx_overrun_vf;
321
322 /* Debug Statistics */
323 u64 hw_sm_mbx_full;
324 u64 hw_csum_tx_good;
325 u64 hw_csum_rx_good;
326 u64 rx_switch_errors;
327 u64 rx_drops;
328 u64 rx_pp_errors;
329 u64 rx_link_errors;
330 u64 rx_length_errors;
331
332 u32 tx_timeout_count;
333
334 /* RX */
335 struct fm10k_ring *rx_ring[MAX_QUEUES];
336
337 /* Queueing vectors */
338 struct fm10k_q_vector *q_vector[MAX_Q_VECTORS];
339 struct msix_entry *msix_entries;
340 int num_q_vectors; /* current number of q_vectors for device */
341 struct fm10k_ring_feature ring_feature[RING_F_ARRAY_SIZE];
342
343 /* SR-IOV information management structure */
344 struct fm10k_iov_data *iov_data;
345
346 struct fm10k_hw_stats stats;
347 struct fm10k_hw hw;
348 /* Mailbox lock */
349 spinlock_t mbx_lock;
350 u32 __iomem *uc_addr;
351 u32 __iomem *sw_addr;
352 u16 msg_enable;
353 u16 tx_ring_count;
354 u16 rx_ring_count;
355 struct timer_list service_timer;
356 struct work_struct service_task;
357 unsigned long next_stats_update;
358 unsigned long next_tx_hang_check;
359 unsigned long last_reset;
360 unsigned long link_down_event;
361 bool host_ready;
362 bool lport_map_failed;
363
364 u32 reta[FM10K_RETA_SIZE];
365 u32 rssrk[FM10K_RSSRK_SIZE];
366
367 /* UDP encapsulation port tracking information */
368 __be16 vxlan_port;
369 __be16 geneve_port;
370
371 /* MAC/VLAN update queue */
372 struct list_head macvlan_requests;
373 struct delayed_work macvlan_task;
374 /* MAC/VLAN update queue lock */
375 spinlock_t macvlan_lock;
376
377#ifdef CONFIG_DEBUG_FS
378 struct dentry *dbg_intfc;
379#endif /* CONFIG_DEBUG_FS */
380
381#ifdef CONFIG_DCB
382 u8 pfc_en;
383#endif
384 u8 rx_pause;
385
386 /* GLORT resources in use by PF */
387 u16 glort;
388 u16 glort_count;
389
390 /* VLAN ID for updating multicast/unicast lists */
391 u16 vid;
392};
393
394static inline void fm10k_mbx_lock(struct fm10k_intfc *interface)
395{
396 spin_lock(&interface->mbx_lock);
397}
398
399static inline void fm10k_mbx_unlock(struct fm10k_intfc *interface)
400{
401 spin_unlock(&interface->mbx_lock);
402}
403
404static inline int fm10k_mbx_trylock(struct fm10k_intfc *interface)
405{
406 return spin_trylock(&interface->mbx_lock);
407}
408
409/* fm10k_test_staterr - test bits in Rx descriptor status and error fields */
410static inline __le32 fm10k_test_staterr(union fm10k_rx_desc *rx_desc,
411 const u32 stat_err_bits)
412{
413 return rx_desc->d.staterr & cpu_to_le32(stat_err_bits);
414}
415
416/* fm10k_desc_unused - calculate if we have unused descriptors */
417static inline u16 fm10k_desc_unused(struct fm10k_ring *ring)
418{
419 s16 unused = ring->next_to_clean - ring->next_to_use - 1;
420
421 return likely(unused < 0) ? unused + ring->count : unused;
422}
423
424#define FM10K_TX_DESC(R, i) \
425 (&(((struct fm10k_tx_desc *)((R)->desc))[i]))
426#define FM10K_RX_DESC(R, i) \
427 (&(((union fm10k_rx_desc *)((R)->desc))[i]))
428
429#define FM10K_MAX_TXD_PWR 14
430#define FM10K_MAX_DATA_PER_TXD (1u << FM10K_MAX_TXD_PWR)
431
432/* Tx Descriptors needed, worst case */
433#define TXD_USE_COUNT(S) DIV_ROUND_UP((S), FM10K_MAX_DATA_PER_TXD)
434#define DESC_NEEDED (MAX_SKB_FRAGS + 4)
435
436enum fm10k_tx_flags {
437 /* Tx offload flags */
438 FM10K_TX_FLAGS_CSUM = 0x01,
439};
440
441/* This structure is stored as little endian values as that is the native
442 * format of the Rx descriptor. The ordering of these fields is reversed
443 * from the actual ftag header to allow for a single bswap to take care
444 * of placing all of the values in network order
445 */
446union fm10k_ftag_info {
447 __le64 ftag;
448 struct {
449 /* dglort and sglort combined into a single 32bit desc read */
450 __le32 glort;
451 /* upper 16 bits of VLAN are reserved 0 for swpri_type_user */
452 __le32 vlan;
453 } d;
454 struct {
455 __le16 dglort;
456 __le16 sglort;
457 __le16 vlan;
458 __le16 swpri_type_user;
459 } w;
460};
461
462struct fm10k_cb {
463 union {
464 __le64 tstamp;
465 unsigned long ts_tx_timeout;
466 };
467 union fm10k_ftag_info fi;
468};
469
470#define FM10K_CB(skb) ((struct fm10k_cb *)(skb)->cb)
471
472/* main */
473extern char fm10k_driver_name[];
474int fm10k_init_queueing_scheme(struct fm10k_intfc *interface);
475void fm10k_clear_queueing_scheme(struct fm10k_intfc *interface);
476__be16 fm10k_tx_encap_offload(struct sk_buff *skb);
477netdev_tx_t fm10k_xmit_frame_ring(struct sk_buff *skb,
478 struct fm10k_ring *tx_ring);
479void fm10k_tx_timeout_reset(struct fm10k_intfc *interface);
480u64 fm10k_get_tx_pending(struct fm10k_ring *ring, bool in_sw);
481bool fm10k_check_tx_hang(struct fm10k_ring *tx_ring);
482void fm10k_alloc_rx_buffers(struct fm10k_ring *rx_ring, u16 cleaned_count);
483
484/* PCI */
485void fm10k_mbx_free_irq(struct fm10k_intfc *);
486int fm10k_mbx_request_irq(struct fm10k_intfc *);
487void fm10k_qv_free_irq(struct fm10k_intfc *interface);
488int fm10k_qv_request_irq(struct fm10k_intfc *interface);
489int fm10k_register_pci_driver(void);
490void fm10k_unregister_pci_driver(void);
491void fm10k_up(struct fm10k_intfc *interface);
492void fm10k_down(struct fm10k_intfc *interface);
493void fm10k_update_stats(struct fm10k_intfc *interface);
494void fm10k_service_event_schedule(struct fm10k_intfc *interface);
495void fm10k_macvlan_schedule(struct fm10k_intfc *interface);
496void fm10k_update_rx_drop_en(struct fm10k_intfc *interface);
497
498/* Netdev */
499struct net_device *fm10k_alloc_netdev(const struct fm10k_info *info);
500int fm10k_setup_rx_resources(struct fm10k_ring *);
501int fm10k_setup_tx_resources(struct fm10k_ring *);
502void fm10k_free_rx_resources(struct fm10k_ring *);
503void fm10k_free_tx_resources(struct fm10k_ring *);
504void fm10k_clean_all_rx_rings(struct fm10k_intfc *);
505void fm10k_clean_all_tx_rings(struct fm10k_intfc *);
506void fm10k_unmap_and_free_tx_resource(struct fm10k_ring *,
507 struct fm10k_tx_buffer *);
508void fm10k_restore_rx_state(struct fm10k_intfc *);
509void fm10k_reset_rx_state(struct fm10k_intfc *);
510int fm10k_setup_tc(struct net_device *dev, u8 tc);
511int fm10k_open(struct net_device *netdev);
512int fm10k_close(struct net_device *netdev);
513int fm10k_queue_vlan_request(struct fm10k_intfc *interface, u32 vid,
514 u8 vsi, bool set);
515int fm10k_queue_mac_request(struct fm10k_intfc *interface, u16 glort,
516 const unsigned char *addr, u16 vid, bool set);
517void fm10k_clear_macvlan_queue(struct fm10k_intfc *interface,
518 u16 glort, bool vlans);
519
520/* Ethtool */
521void fm10k_set_ethtool_ops(struct net_device *dev);
522void fm10k_write_reta(struct fm10k_intfc *interface, const u32 *indir);
523
524/* IOV */
525s32 fm10k_iov_event(struct fm10k_intfc *interface);
526s32 fm10k_iov_mbx(struct fm10k_intfc *interface);
527void fm10k_iov_suspend(struct pci_dev *pdev);
528int fm10k_iov_resume(struct pci_dev *pdev);
529void fm10k_iov_disable(struct pci_dev *pdev);
530int fm10k_iov_configure(struct pci_dev *pdev, int num_vfs);
531void fm10k_iov_update_stats(struct fm10k_intfc *interface);
532s32 fm10k_iov_update_pvid(struct fm10k_intfc *interface, u16 glort, u16 pvid);
533int fm10k_ndo_set_vf_mac(struct net_device *netdev, int vf_idx, u8 *mac);
534int fm10k_ndo_set_vf_vlan(struct net_device *netdev,
535 int vf_idx, u16 vid, u8 qos, __be16 vlan_proto);
536int fm10k_ndo_set_vf_bw(struct net_device *netdev, int vf_idx,
537 int __always_unused min_rate, int max_rate);
538int fm10k_ndo_get_vf_config(struct net_device *netdev,
539 int vf_idx, struct ifla_vf_info *ivi);
540int fm10k_ndo_get_vf_stats(struct net_device *netdev,
541 int vf_idx, struct ifla_vf_stats *stats);
542
543/* DebugFS */
544#ifdef CONFIG_DEBUG_FS
545void fm10k_dbg_q_vector_init(struct fm10k_q_vector *q_vector);
546void fm10k_dbg_q_vector_exit(struct fm10k_q_vector *q_vector);
547void fm10k_dbg_intfc_init(struct fm10k_intfc *interface);
548void fm10k_dbg_intfc_exit(struct fm10k_intfc *interface);
549void fm10k_dbg_init(void);
550void fm10k_dbg_exit(void);
551#else
552static inline void fm10k_dbg_q_vector_init(struct fm10k_q_vector *q_vector) {}
553static inline void fm10k_dbg_q_vector_exit(struct fm10k_q_vector *q_vector) {}
554static inline void fm10k_dbg_intfc_init(struct fm10k_intfc *interface) {}
555static inline void fm10k_dbg_intfc_exit(struct fm10k_intfc *interface) {}
556static inline void fm10k_dbg_init(void) {}
557static inline void fm10k_dbg_exit(void) {}
558#endif /* CONFIG_DEBUG_FS */
559
560/* DCB */
561#ifdef CONFIG_DCB
562void fm10k_dcbnl_set_ops(struct net_device *dev);
563#else
564static inline void fm10k_dcbnl_set_ops(struct net_device *dev) {}
565#endif
566#endif /* _FM10K_H_ */