1 /* Intel Ethernet Switch Host Interface Driver
2 * Copyright(c) 2013 - 2014 Intel Corporation.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU General Public License,
6 * version 2, as published by the Free Software Foundation.
8 * This program is distributed in the hope it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * The full GNU General Public License is included in this distribution in
14 * the file called "COPYING".
16 * Contact Information:
17 * e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
18 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
24 #include <linux/types.h>
25 #include <linux/etherdevice.h>
26 #include <linux/rtnetlink.h>
27 #include <linux/if_vlan.h>
28 #include <linux/pci.h>
29 #include <linux/net_tstamp.h>
30 #include <linux/clocksource.h>
31 #include <linux/ptp_clock_kernel.h>
36 #define FM10K_MAX_JUMBO_FRAME_SIZE 15358 /* Maximum supported size 15K */
38 #define MAX_QUEUES FM10K_MAX_QUEUES_PF
40 #define FM10K_MIN_RXD 128
41 #define FM10K_MAX_RXD 4096
42 #define FM10K_DEFAULT_RXD 256
44 #define FM10K_MIN_TXD 128
45 #define FM10K_MAX_TXD 4096
46 #define FM10K_DEFAULT_TXD 256
47 #define FM10K_DEFAULT_TX_WORK 256
49 #define FM10K_RXBUFFER_256 256
50 #define FM10K_RX_HDR_LEN FM10K_RXBUFFER_256
51 #define FM10K_RXBUFFER_2048 2048
52 #define FM10K_RX_BUFSZ FM10K_RXBUFFER_2048
54 /* How many Rx Buffers do we bundle into one write to the hardware ? */
55 #define FM10K_RX_BUFFER_WRITE 16 /* Must be power of 2 */
57 #define FM10K_MAX_STATIONS 63
58 struct fm10k_l2_accel {
63 struct net_device *macvlan[0];
66 enum fm10k_ring_state_t {
67 __FM10K_TX_DETECT_HANG,
68 __FM10K_HANG_CHECK_ARMED,
71 #define check_for_tx_hang(ring) \
72 test_bit(__FM10K_TX_DETECT_HANG, &(ring)->state)
73 #define set_check_for_tx_hang(ring) \
74 set_bit(__FM10K_TX_DETECT_HANG, &(ring)->state)
75 #define clear_check_for_tx_hang(ring) \
76 clear_bit(__FM10K_TX_DETECT_HANG, &(ring)->state)
78 struct fm10k_tx_buffer {
79 struct fm10k_tx_desc *next_to_watch;
81 unsigned int bytecount;
84 DEFINE_DMA_UNMAP_ADDR(dma);
85 DEFINE_DMA_UNMAP_LEN(len);
88 struct fm10k_rx_buffer {
94 struct fm10k_queue_stats {
99 struct fm10k_tx_queue_stats {
106 struct fm10k_rx_queue_stats {
113 struct fm10k_q_vector *q_vector;/* backpointer to host q_vector */
114 struct net_device *netdev; /* netdev ring belongs to */
115 struct device *dev; /* device for DMA mapping */
116 struct fm10k_l2_accel __rcu *l2_accel; /* L2 acceleration list */
117 void *desc; /* descriptor ring memory */
119 struct fm10k_tx_buffer *tx_buffer;
120 struct fm10k_rx_buffer *rx_buffer;
124 dma_addr_t dma; /* phys. address of descriptor ring */
125 unsigned int size; /* length in bytes */
127 u8 queue_index; /* needed for queue management */
128 u8 reg_idx; /* holds the special value that gets
129 * the hardware register offset
130 * associated with this ring, which is
131 * different for DCB and RSS modes
133 u8 qos_pc; /* priority class of queue */
134 u16 vid; /* default vlan ID of queue */
135 u16 count; /* amount of descriptors */
141 struct fm10k_queue_stats stats;
142 struct u64_stats_sync syncp;
145 struct fm10k_tx_queue_stats tx_stats;
148 struct fm10k_rx_queue_stats rx_stats;
152 } ____cacheline_internodealigned_in_smp;
154 struct fm10k_ring_container {
155 struct fm10k_ring *ring; /* pointer to linked list of rings */
156 unsigned int total_bytes; /* total bytes processed this int */
157 unsigned int total_packets; /* total packets processed this int */
158 u16 work_limit; /* total work allowed per interrupt */
159 u16 itr; /* interrupt throttle rate value */
160 u8 count; /* total number of rings in vector */
163 #define FM10K_ITR_MAX 0x0FFF /* maximum value for ITR */
164 #define FM10K_ITR_10K 100 /* 100us */
165 #define FM10K_ITR_20K 50 /* 50us */
166 #define FM10K_ITR_ADAPTIVE 0x8000 /* adaptive interrupt moderation flag */
168 #define FM10K_ITR_ENABLE (FM10K_ITR_AUTOMASK | FM10K_ITR_MASK_CLEAR)
170 static inline struct netdev_queue *txring_txq(const struct fm10k_ring *ring)
172 return &ring->netdev->_tx[ring->queue_index];
175 /* iterator for handling rings in ring container */
176 #define fm10k_for_each_ring(pos, head) \
177 for (pos = &(head).ring[(head).count]; (--pos) >= (head).ring;)
179 #define MAX_Q_VECTORS 256
180 #define MIN_Q_VECTORS 1
181 enum fm10k_non_q_vectors {
183 #define NON_Q_VECTORS_VF NON_Q_VECTORS_PF
187 #define NON_Q_VECTORS(hw) (((hw)->mac.type == fm10k_mac_pf) ? \
190 #define MIN_MSIX_COUNT(hw) (MIN_Q_VECTORS + NON_Q_VECTORS(hw))
192 struct fm10k_q_vector {
193 struct fm10k_intfc *interface;
194 u32 __iomem *itr; /* pointer to ITR register for this vector */
195 u16 v_idx; /* index of q_vector within interface array */
196 struct fm10k_ring_container rx, tx;
198 struct napi_struct napi;
199 char name[IFNAMSIZ + 9];
201 #ifdef CONFIG_DEBUG_FS
202 struct dentry *dbg_q_vector;
203 #endif /* CONFIG_DEBUG_FS */
204 struct rcu_head rcu; /* to avoid race with update stats on free */
206 /* for dynamic allocation of rings associated with this q_vector */
207 struct fm10k_ring ring[0] ____cacheline_internodealigned_in_smp;
210 enum fm10k_ring_f_enum {
213 RING_F_ARRAY_SIZE /* must be last in enum set */
216 struct fm10k_ring_feature {
217 u16 limit; /* upper limit on feature indices */
218 u16 indices; /* current value of indices */
219 u16 mask; /* Mask used for feature to ring mapping */
220 u16 offset; /* offset to start of feature */
223 struct fm10k_iov_data {
224 unsigned int num_vfs;
225 unsigned int next_vf_mbx;
227 struct fm10k_vf_info vf_info[0];
230 #define fm10k_vxlan_port_for_each(vp, intfc) \
231 list_for_each_entry(vp, &(intfc)->vxlan_port, list)
232 struct fm10k_vxlan_port {
233 struct list_head list;
234 sa_family_t sa_family;
239 unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
240 struct net_device *netdev;
241 struct fm10k_l2_accel *l2_accel; /* pointer to L2 acceleration list */
242 struct pci_dev *pdev;
246 #define FM10K_FLAG_RESET_REQUESTED (u32)(1 << 0)
247 #define FM10K_FLAG_RSS_FIELD_IPV4_UDP (u32)(1 << 1)
248 #define FM10K_FLAG_RSS_FIELD_IPV6_UDP (u32)(1 << 2)
249 #define FM10K_FLAG_RX_TS_ENABLED (u32)(1 << 3)
250 #define FM10K_FLAG_SWPRI_CONFIG (u32)(1 << 4)
253 /* Tx fast path data */
257 /* Rx fast path data */
262 struct fm10k_ring *tx_ring[MAX_QUEUES] ____cacheline_aligned_in_smp;
278 u32 tx_timeout_count;
281 struct fm10k_ring *rx_ring[MAX_QUEUES];
283 /* Queueing vectors */
284 struct fm10k_q_vector *q_vector[MAX_Q_VECTORS];
285 struct msix_entry *msix_entries;
286 int num_q_vectors; /* current number of q_vectors for device */
287 struct fm10k_ring_feature ring_feature[RING_F_ARRAY_SIZE];
289 /* SR-IOV information management structure */
290 struct fm10k_iov_data *iov_data;
292 struct fm10k_hw_stats stats;
294 u32 __iomem *uc_addr;
295 u32 __iomem *sw_addr;
299 struct timer_list service_timer;
300 struct work_struct service_task;
301 unsigned long next_stats_update;
302 unsigned long next_tx_hang_check;
303 unsigned long last_reset;
304 unsigned long link_down_event;
307 u32 reta[FM10K_RETA_SIZE];
308 u32 rssrk[FM10K_RSSRK_SIZE];
310 /* VXLAN port tracking information */
311 struct list_head vxlan_port;
313 #ifdef CONFIG_DEBUG_FS
314 struct dentry *dbg_intfc;
316 #endif /* CONFIG_DEBUG_FS */
317 struct ptp_clock_info ptp_caps;
318 struct ptp_clock *ptp_clock;
320 struct sk_buff_head ts_tx_skb_queue;
321 u32 tx_hwtstamp_timeouts;
323 struct hwtstamp_config ts_config;
324 /* We are unable to actually adjust the clock beyond the frequency
325 * value. Once the clock is started there is no resetting it. As
326 * such we maintain a separate offset from the actual hardware clock
327 * to allow for offset adjustment.
330 rwlock_t systime_lock;
336 /* GLORT resources in use by PF */
340 /* VLAN ID for updating multicast/unicast lists */
347 __FM10K_SERVICE_SCHED,
348 __FM10K_SERVICE_DISABLE,
353 static inline void fm10k_mbx_lock(struct fm10k_intfc *interface)
355 /* busy loop if we cannot obtain the lock as some calls
356 * such as ndo_set_rx_mode may be made in atomic context
358 while (test_and_set_bit(__FM10K_MBX_LOCK, &interface->state))
362 static inline void fm10k_mbx_unlock(struct fm10k_intfc *interface)
364 /* flush memory to make sure state is correct */
365 smp_mb__before_atomic();
366 clear_bit(__FM10K_MBX_LOCK, &interface->state);
369 static inline int fm10k_mbx_trylock(struct fm10k_intfc *interface)
371 return !test_and_set_bit(__FM10K_MBX_LOCK, &interface->state);
374 /* fm10k_test_staterr - test bits in Rx descriptor status and error fields */
375 static inline __le32 fm10k_test_staterr(union fm10k_rx_desc *rx_desc,
376 const u32 stat_err_bits)
378 return rx_desc->d.staterr & cpu_to_le32(stat_err_bits);
381 /* fm10k_desc_unused - calculate if we have unused descriptors */
382 static inline u16 fm10k_desc_unused(struct fm10k_ring *ring)
384 s16 unused = ring->next_to_clean - ring->next_to_use - 1;
386 return likely(unused < 0) ? unused + ring->count : unused;
389 #define FM10K_TX_DESC(R, i) \
390 (&(((struct fm10k_tx_desc *)((R)->desc))[i]))
391 #define FM10K_RX_DESC(R, i) \
392 (&(((union fm10k_rx_desc *)((R)->desc))[i]))
394 #define FM10K_MAX_TXD_PWR 14
395 #define FM10K_MAX_DATA_PER_TXD (1 << FM10K_MAX_TXD_PWR)
397 /* Tx Descriptors needed, worst case */
398 #define TXD_USE_COUNT(S) DIV_ROUND_UP((S), FM10K_MAX_DATA_PER_TXD)
399 #define DESC_NEEDED (MAX_SKB_FRAGS + 4)
401 enum fm10k_tx_flags {
402 /* Tx offload flags */
403 FM10K_TX_FLAGS_CSUM = 0x01,
406 /* This structure is stored as little endian values as that is the native
407 * format of the Rx descriptor. The ordering of these fields is reversed
408 * from the actual ftag header to allow for a single bswap to take care
409 * of placing all of the values in network order
411 union fm10k_ftag_info {
414 /* dglort and sglort combined into a single 32bit desc read */
416 /* upper 16 bits of vlan are reserved 0 for swpri_type_user */
423 __le16 swpri_type_user;
430 unsigned long ts_tx_timeout;
432 union fm10k_ftag_info fi;
435 #define FM10K_CB(skb) ((struct fm10k_cb *)(skb)->cb)
438 extern char fm10k_driver_name[];
439 extern const char fm10k_driver_version[];
440 int fm10k_init_queueing_scheme(struct fm10k_intfc *interface);
441 void fm10k_clear_queueing_scheme(struct fm10k_intfc *interface);
442 netdev_tx_t fm10k_xmit_frame_ring(struct sk_buff *skb,
443 struct fm10k_ring *tx_ring);
444 void fm10k_tx_timeout_reset(struct fm10k_intfc *interface);
445 bool fm10k_check_tx_hang(struct fm10k_ring *tx_ring);
446 void fm10k_alloc_rx_buffers(struct fm10k_ring *rx_ring, u16 cleaned_count);
449 void fm10k_mbx_free_irq(struct fm10k_intfc *);
450 int fm10k_mbx_request_irq(struct fm10k_intfc *);
451 void fm10k_qv_free_irq(struct fm10k_intfc *interface);
452 int fm10k_qv_request_irq(struct fm10k_intfc *interface);
453 int fm10k_register_pci_driver(void);
454 void fm10k_unregister_pci_driver(void);
455 void fm10k_up(struct fm10k_intfc *interface);
456 void fm10k_down(struct fm10k_intfc *interface);
457 void fm10k_update_stats(struct fm10k_intfc *interface);
458 void fm10k_service_event_schedule(struct fm10k_intfc *interface);
459 void fm10k_update_rx_drop_en(struct fm10k_intfc *interface);
462 struct net_device *fm10k_alloc_netdev(void);
463 int fm10k_setup_rx_resources(struct fm10k_ring *);
464 int fm10k_setup_tx_resources(struct fm10k_ring *);
465 void fm10k_free_rx_resources(struct fm10k_ring *);
466 void fm10k_free_tx_resources(struct fm10k_ring *);
467 void fm10k_clean_all_rx_rings(struct fm10k_intfc *);
468 void fm10k_clean_all_tx_rings(struct fm10k_intfc *);
469 void fm10k_unmap_and_free_tx_resource(struct fm10k_ring *,
470 struct fm10k_tx_buffer *);
471 void fm10k_restore_rx_state(struct fm10k_intfc *);
472 void fm10k_reset_rx_state(struct fm10k_intfc *);
473 int fm10k_setup_tc(struct net_device *dev, u8 tc);
474 int fm10k_open(struct net_device *netdev);
475 int fm10k_close(struct net_device *netdev);
478 void fm10k_set_ethtool_ops(struct net_device *dev);
481 s32 fm10k_iov_event(struct fm10k_intfc *interface);
482 s32 fm10k_iov_mbx(struct fm10k_intfc *interface);
483 void fm10k_iov_suspend(struct pci_dev *pdev);
484 int fm10k_iov_resume(struct pci_dev *pdev);
485 void fm10k_iov_disable(struct pci_dev *pdev);
486 int fm10k_iov_configure(struct pci_dev *pdev, int num_vfs);
487 s32 fm10k_iov_update_pvid(struct fm10k_intfc *interface, u16 glort, u16 pvid);
488 int fm10k_ndo_set_vf_mac(struct net_device *netdev, int vf_idx, u8 *mac);
489 int fm10k_ndo_set_vf_vlan(struct net_device *netdev,
490 int vf_idx, u16 vid, u8 qos);
491 int fm10k_ndo_set_vf_bw(struct net_device *netdev, int vf_idx, int rate,
493 int fm10k_ndo_get_vf_config(struct net_device *netdev,
494 int vf_idx, struct ifla_vf_info *ivi);
497 #ifdef CONFIG_DEBUG_FS
498 void fm10k_dbg_q_vector_init(struct fm10k_q_vector *q_vector);
499 void fm10k_dbg_q_vector_exit(struct fm10k_q_vector *q_vector);
500 void fm10k_dbg_intfc_init(struct fm10k_intfc *interface);
501 void fm10k_dbg_intfc_exit(struct fm10k_intfc *interface);
502 void fm10k_dbg_init(void);
503 void fm10k_dbg_exit(void);
505 static inline void fm10k_dbg_q_vector_init(struct fm10k_q_vector *q_vector) {}
506 static inline void fm10k_dbg_q_vector_exit(struct fm10k_q_vector *q_vector) {}
507 static inline void fm10k_dbg_intfc_init(struct fm10k_intfc *interface) {}
508 static inline void fm10k_dbg_intfc_exit(struct fm10k_intfc *interface) {}
509 static inline void fm10k_dbg_init(void) {}
510 static inline void fm10k_dbg_exit(void) {}
511 #endif /* CONFIG_DEBUG_FS */
514 void fm10k_systime_to_hwtstamp(struct fm10k_intfc *interface,
515 struct skb_shared_hwtstamps *hwtstamp,
517 void fm10k_ts_tx_enqueue(struct fm10k_intfc *interface, struct sk_buff *skb);
518 void fm10k_ts_tx_hwtstamp(struct fm10k_intfc *interface, __le16 dglort,
520 void fm10k_ts_reset(struct fm10k_intfc *interface);
521 void fm10k_ts_init(struct fm10k_intfc *interface);
522 void fm10k_ts_tx_subtask(struct fm10k_intfc *interface);
523 void fm10k_ptp_register(struct fm10k_intfc *interface);
524 void fm10k_ptp_unregister(struct fm10k_intfc *interface);
525 int fm10k_get_ts_config(struct net_device *netdev, struct ifreq *ifr);
526 int fm10k_set_ts_config(struct net_device *netdev, struct ifreq *ifr);
529 void fm10k_dcbnl_set_ops(struct net_device *dev);
530 #endif /* _FM10K_H_ */