intel/fm10k/fm10k.h

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 /* Copyright(c) 2013 - 2019 Intel Corporation. */
0003
0004 #ifndef _FM10K_H_
0005 #define _FM10K_H_
0006
0007 #include <linux/types.h>
0008 #include <linux/etherdevice.h>
0009 #include <linux/cpumask.h>
0010 #include <linux/rtnetlink.h>
0011 #include <linux/if_vlan.h>
0012 #include <linux/pci.h>
0013
0014 #include "fm10k_pf.h"
0015 #include "fm10k_vf.h"
0016
0017 #define FM10K_MAX_JUMBO_FRAME_SIZE  15342   /* Maximum supported size 15K */
0018
0019 #define MAX_QUEUES  FM10K_MAX_QUEUES_PF
0020
0021 #define FM10K_MIN_RXD        128
0022 #define FM10K_MAX_RXD       4096
0023 #define FM10K_DEFAULT_RXD    256
0024
0025 #define FM10K_MIN_TXD        128
0026 #define FM10K_MAX_TXD       4096
0027 #define FM10K_DEFAULT_TXD    256
0028 #define FM10K_DEFAULT_TX_WORK    256
0029
0030 #define FM10K_RXBUFFER_256    256
0031 #define FM10K_RX_HDR_LEN    FM10K_RXBUFFER_256
0032 #define FM10K_RXBUFFER_2048  2048
0033 #define FM10K_RX_BUFSZ      FM10K_RXBUFFER_2048
0034
0035 /* How many Rx Buffers do we bundle into one write to the hardware ? */
0036 #define FM10K_RX_BUFFER_WRITE   16  /* Must be power of 2 */
0037
0038 #define FM10K_MAX_STATIONS  63
0039 struct fm10k_l2_accel {
0040     int size;
0041     u16 count;
0042     u16 dglort;
0043     struct rcu_head rcu;
0044     struct net_device *macvlan[];
0045 };
0046
0047 enum fm10k_ring_state_t {
0048     __FM10K_TX_DETECT_HANG,
0049     __FM10K_HANG_CHECK_ARMED,
0050     __FM10K_TX_XPS_INIT_DONE,
0051     /* This must be last and is used to calculate BITMAP size */
0052     __FM10K_TX_STATE_SIZE__,
0053 };
0054
0055 #define check_for_tx_hang(ring) \
0056     test_bit(__FM10K_TX_DETECT_HANG, (ring)->state)
0057 #define set_check_for_tx_hang(ring) \
0058     set_bit(__FM10K_TX_DETECT_HANG, (ring)->state)
0059 #define clear_check_for_tx_hang(ring) \
0060     clear_bit(__FM10K_TX_DETECT_HANG, (ring)->state)
0061
0062 struct fm10k_tx_buffer {
0063     struct fm10k_tx_desc *next_to_watch;
0064     struct sk_buff *skb;
0065     unsigned int bytecount;
0066     u16 gso_segs;
0067     u16 tx_flags;
0068     DEFINE_DMA_UNMAP_ADDR(dma);
0069     DEFINE_DMA_UNMAP_LEN(len);
0070 };
0071
0072 struct fm10k_rx_buffer {
0073     dma_addr_t dma;
0074     struct page *page;
0075     u32 page_offset;
0076 };
0077
0078 struct fm10k_queue_stats {
0079     u64 packets;
0080     u64 bytes;
0081 };
0082
0083 struct fm10k_tx_queue_stats {
0084     u64 restart_queue;
0085     u64 csum_err;
0086     u64 tx_busy;
0087     u64 tx_done_old;
0088     u64 csum_good;
0089 };
0090
0091 struct fm10k_rx_queue_stats {
0092     u64 alloc_failed;
0093     u64 csum_err;
0094     u64 errors;
0095     u64 csum_good;
0096     u64 switch_errors;
0097     u64 drops;
0098     u64 pp_errors;
0099     u64 link_errors;
0100     u64 length_errors;
0101 };
0102
0103 struct fm10k_ring {
0104     struct fm10k_q_vector *q_vector;/* backpointer to host q_vector */
0105     struct net_device *netdev;  /* netdev ring belongs to */
0106     struct device *dev;     /* device for DMA mapping */
0107     struct fm10k_l2_accel __rcu *l2_accel;  /* L2 acceleration list */
0108     void *desc;         /* descriptor ring memory */
0109     union {
0110         struct fm10k_tx_buffer *tx_buffer;
0111         struct fm10k_rx_buffer *rx_buffer;
0112     };
0113     u32 __iomem *tail;
0114     DECLARE_BITMAP(state, __FM10K_TX_STATE_SIZE__);
0115     dma_addr_t dma;         /* phys. address of descriptor ring */
0116     unsigned int size;      /* length in bytes */
0117
0118     u8 queue_index;         /* needed for queue management */
0119     u8 reg_idx;         /* holds the special value that gets
0120                      * the hardware register offset
0121                      * associated with this ring, which is
0122                      * different for DCB and RSS modes
0123                      */
0124     u8 qos_pc;          /* priority class of queue */
0125     u16 vid;            /* default VLAN ID of queue */
0126     u16 count;          /* amount of descriptors */
0127
0128     u16 next_to_alloc;
0129     u16 next_to_use;
0130     u16 next_to_clean;
0131
0132     struct fm10k_queue_stats stats;
0133     struct u64_stats_sync syncp;
0134     union {
0135         /* Tx */
0136         struct fm10k_tx_queue_stats tx_stats;
0137         /* Rx */
0138         struct {
0139             struct fm10k_rx_queue_stats rx_stats;
0140             struct sk_buff *skb;
0141         };
0142     };
0143 } ____cacheline_internodealigned_in_smp;
0144
0145 struct fm10k_ring_container {
0146     struct fm10k_ring *ring;    /* pointer to linked list of rings */
0147     unsigned int total_bytes;   /* total bytes processed this int */
0148     unsigned int total_packets; /* total packets processed this int */
0149     u16 work_limit;         /* total work allowed per interrupt */
0150     u16 itr;            /* interrupt throttle rate value */
0151     u8 itr_scale;           /* ITR adjustment based on PCI speed */
0152     u8 count;           /* total number of rings in vector */
0153 };
0154
0155 #define FM10K_ITR_MAX       0x0FFF  /* maximum value for ITR */
0156 #define FM10K_ITR_10K       100 /* 100us */
0157 #define FM10K_ITR_20K       50  /* 50us */
0158 #define FM10K_ITR_40K       25  /* 25us */
0159 #define FM10K_ITR_ADAPTIVE  0x8000  /* adaptive interrupt moderation flag */
0160
0161 #define ITR_IS_ADAPTIVE(itr) (!!(itr & FM10K_ITR_ADAPTIVE))
0162
0163 #define FM10K_TX_ITR_DEFAULT    FM10K_ITR_40K
0164 #define FM10K_RX_ITR_DEFAULT    FM10K_ITR_20K
0165 #define FM10K_ITR_ENABLE    (FM10K_ITR_AUTOMASK | FM10K_ITR_MASK_CLEAR)
0166
0167 static inline struct netdev_queue *txring_txq(const struct fm10k_ring *ring)
0168 {
0169     return &ring->netdev->_tx[ring->queue_index];
0170 }
0171
0172 /* iterator for handling rings in ring container */
0173 #define fm10k_for_each_ring(pos, head) \
0174     for (pos = &(head).ring[(head).count]; (--pos) >= (head).ring;)
0175
0176 #define MAX_Q_VECTORS 256
0177 #define MIN_Q_VECTORS   1
0178 enum fm10k_non_q_vectors {
0179     FM10K_MBX_VECTOR,
0180     NON_Q_VECTORS
0181 };
0182
0183 #define MIN_MSIX_COUNT(hw)  (MIN_Q_VECTORS + NON_Q_VECTORS)
0184
0185 struct fm10k_q_vector {
0186     struct fm10k_intfc *interface;
0187     u32 __iomem *itr;   /* pointer to ITR register for this vector */
0188     u16 v_idx;      /* index of q_vector within interface array */
0189     struct fm10k_ring_container rx, tx;
0190
0191     struct napi_struct napi;
0192     cpumask_t affinity_mask;
0193     char name[IFNAMSIZ + 9];
0194
0195 #ifdef CONFIG_DEBUG_FS
0196     struct dentry *dbg_q_vector;
0197 #endif /* CONFIG_DEBUG_FS */
0198     struct rcu_head rcu;    /* to avoid race with update stats on free */
0199
0200     /* for dynamic allocation of rings associated with this q_vector */
0201     struct fm10k_ring ring[] ____cacheline_internodealigned_in_smp;
0202 };
0203
0204 enum fm10k_ring_f_enum {
0205     RING_F_RSS,
0206     RING_F_QOS,
0207     RING_F_ARRAY_SIZE  /* must be last in enum set */
0208 };
0209
0210 struct fm10k_ring_feature {
0211     u16 limit;  /* upper limit on feature indices */
0212     u16 indices;    /* current value of indices */
0213     u16 mask;   /* Mask used for feature to ring mapping */
0214     u16 offset; /* offset to start of feature */
0215 };
0216
0217 struct fm10k_iov_data {
0218     unsigned int        num_vfs;
0219     unsigned int        next_vf_mbx;
0220     struct rcu_head     rcu;
0221     struct fm10k_vf_info    vf_info[];
0222 };
0223
0224 enum fm10k_macvlan_request_type {
0225     FM10K_UC_MAC_REQUEST,
0226     FM10K_MC_MAC_REQUEST,
0227     FM10K_VLAN_REQUEST
0228 };
0229
0230 struct fm10k_macvlan_request {
0231     enum fm10k_macvlan_request_type type;
0232     struct list_head list;
0233     union {
0234         struct fm10k_mac_request {
0235             u8 addr[ETH_ALEN];
0236             u16 glort;
0237             u16 vid;
0238         } mac;
0239         struct fm10k_vlan_request {
0240             u32 vid;
0241             u8 vsi;
0242         } vlan;
0243     };
0244     bool set;
0245 };
0246
0247 /* one work queue for entire driver */
0248 extern struct workqueue_struct *fm10k_workqueue;
0249
0250 /* The following enumeration contains flags which indicate or enable modified
0251  * driver behaviors. To avoid race conditions, the flags are stored in
0252  * a BITMAP in the fm10k_intfc structure. The BITMAP should be accessed using
0253  * atomic *_bit() operations.
0254  */
0255 enum fm10k_flags_t {
0256     FM10K_FLAG_RESET_REQUESTED,
0257     FM10K_FLAG_RSS_FIELD_IPV4_UDP,
0258     FM10K_FLAG_RSS_FIELD_IPV6_UDP,
0259     FM10K_FLAG_SWPRI_CONFIG,
0260     /* __FM10K_FLAGS_SIZE__ is used to calculate the size of
0261      * interface->flags and must be the last value in this
0262      * enumeration.
0263      */
0264     __FM10K_FLAGS_SIZE__
0265 };
0266
0267 enum fm10k_state_t {
0268     __FM10K_RESETTING,
0269     __FM10K_RESET_DETACHED,
0270     __FM10K_RESET_SUSPENDED,
0271     __FM10K_DOWN,
0272     __FM10K_SERVICE_SCHED,
0273     __FM10K_SERVICE_REQUEST,
0274     __FM10K_SERVICE_DISABLE,
0275     __FM10K_MACVLAN_SCHED,
0276     __FM10K_MACVLAN_REQUEST,
0277     __FM10K_MACVLAN_DISABLE,
0278     __FM10K_LINK_DOWN,
0279     __FM10K_UPDATING_STATS,
0280     /* This value must be last and determines the BITMAP size */
0281     __FM10K_STATE_SIZE__,
0282 };
0283
0284 struct fm10k_intfc {
0285     unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
0286     struct net_device *netdev;
0287     struct fm10k_l2_accel *l2_accel; /* pointer to L2 acceleration list */
0288     struct pci_dev *pdev;
0289     DECLARE_BITMAP(state, __FM10K_STATE_SIZE__);
0290
0291     /* Access flag values using atomic *_bit() operations */
0292     DECLARE_BITMAP(flags, __FM10K_FLAGS_SIZE__);
0293
0294     int xcast_mode;
0295
0296     /* Tx fast path data */
0297     int num_tx_queues;
0298     u16 tx_itr;
0299
0300     /* Rx fast path data */
0301     int num_rx_queues;
0302     u16 rx_itr;
0303
0304     /* TX */
0305     struct fm10k_ring *tx_ring[MAX_QUEUES] ____cacheline_aligned_in_smp;
0306
0307     u64 restart_queue;
0308     u64 tx_busy;
0309     u64 tx_csum_errors;
0310     u64 alloc_failed;
0311     u64 rx_csum_errors;
0312
0313     u64 tx_bytes_nic;
0314     u64 tx_packets_nic;
0315     u64 rx_bytes_nic;
0316     u64 rx_packets_nic;
0317     u64 rx_drops_nic;
0318     u64 rx_overrun_pf;
0319     u64 rx_overrun_vf;
0320
0321     /* Debug Statistics */
0322     u64 hw_sm_mbx_full;
0323     u64 hw_csum_tx_good;
0324     u64 hw_csum_rx_good;
0325     u64 rx_switch_errors;
0326     u64 rx_drops;
0327     u64 rx_pp_errors;
0328     u64 rx_link_errors;
0329     u64 rx_length_errors;
0330
0331     u32 tx_timeout_count;
0332
0333     /* RX */
0334     struct fm10k_ring *rx_ring[MAX_QUEUES];
0335
0336     /* Queueing vectors */
0337     struct fm10k_q_vector *q_vector[MAX_Q_VECTORS];
0338     struct msix_entry *msix_entries;
0339     int num_q_vectors;  /* current number of q_vectors for device */
0340     struct fm10k_ring_feature ring_feature[RING_F_ARRAY_SIZE];
0341
0342     /* SR-IOV information management structure */
0343     struct fm10k_iov_data *iov_data;
0344
0345     struct fm10k_hw_stats stats;
0346     struct fm10k_hw hw;
0347     /* Mailbox lock */
0348     spinlock_t mbx_lock;
0349     u32 __iomem *uc_addr;
0350     u32 __iomem *sw_addr;
0351     u16 msg_enable;
0352     u16 tx_ring_count;
0353     u16 rx_ring_count;
0354     struct timer_list service_timer;
0355     struct work_struct service_task;
0356     unsigned long next_stats_update;
0357     unsigned long next_tx_hang_check;
0358     unsigned long last_reset;
0359     unsigned long link_down_event;
0360     bool host_ready;
0361     bool lport_map_failed;
0362
0363     u32 reta[FM10K_RETA_SIZE];
0364     u32 rssrk[FM10K_RSSRK_SIZE];
0365
0366     /* UDP encapsulation port tracking information */
0367     __be16 vxlan_port;
0368     __be16 geneve_port;
0369
0370     /* MAC/VLAN update queue */
0371     struct list_head macvlan_requests;
0372     struct delayed_work macvlan_task;
0373     /* MAC/VLAN update queue lock */
0374     spinlock_t macvlan_lock;
0375
0376 #ifdef CONFIG_DEBUG_FS
0377     struct dentry *dbg_intfc;
0378 #endif /* CONFIG_DEBUG_FS */
0379
0380 #ifdef CONFIG_DCB
0381     u8 pfc_en;
0382 #endif
0383     u8 rx_pause;
0384
0385     /* GLORT resources in use by PF */
0386     u16 glort;
0387     u16 glort_count;
0388
0389     /* VLAN ID for updating multicast/unicast lists */
0390     u16 vid;
0391 };
0392
0393 static inline void fm10k_mbx_lock(struct fm10k_intfc *interface)
0394 {
0395     spin_lock(&interface->mbx_lock);
0396 }
0397
0398 static inline void fm10k_mbx_unlock(struct fm10k_intfc *interface)
0399 {
0400     spin_unlock(&interface->mbx_lock);
0401 }
0402
0403 static inline int fm10k_mbx_trylock(struct fm10k_intfc *interface)
0404 {
0405     return spin_trylock(&interface->mbx_lock);
0406 }
0407
0408 /* fm10k_test_staterr - test bits in Rx descriptor status and error fields */
0409 static inline __le32 fm10k_test_staterr(union fm10k_rx_desc *rx_desc,
0410                     const u32 stat_err_bits)
0411 {
0412     return rx_desc->d.staterr & cpu_to_le32(stat_err_bits);
0413 }
0414
0415 /* fm10k_desc_unused - calculate if we have unused descriptors */
0416 static inline u16 fm10k_desc_unused(struct fm10k_ring *ring)
0417 {
0418     s16 unused = ring->next_to_clean - ring->next_to_use - 1;
0419
0420     return likely(unused < 0) ? unused + ring->count : unused;
0421 }
0422
0423 #define FM10K_TX_DESC(R, i) \
0424     (&(((struct fm10k_tx_desc *)((R)->desc))[i]))
0425 #define FM10K_RX_DESC(R, i) \
0426      (&(((union fm10k_rx_desc *)((R)->desc))[i]))
0427
0428 #define FM10K_MAX_TXD_PWR   14
0429 #define FM10K_MAX_DATA_PER_TXD  (1u << FM10K_MAX_TXD_PWR)
0430
0431 /* Tx Descriptors needed, worst case */
0432 #define TXD_USE_COUNT(S)    DIV_ROUND_UP((S), FM10K_MAX_DATA_PER_TXD)
0433 #define DESC_NEEDED (MAX_SKB_FRAGS + 4)
0434
0435 enum fm10k_tx_flags {
0436     /* Tx offload flags */
0437     FM10K_TX_FLAGS_CSUM = 0x01,
0438 };
0439
0440 /* This structure is stored as little endian values as that is the native
0441  * format of the Rx descriptor.  The ordering of these fields is reversed
0442  * from the actual ftag header to allow for a single bswap to take care
0443  * of placing all of the values in network order
0444  */
0445 union fm10k_ftag_info {
0446     __le64 ftag;
0447     struct {
0448         /* dglort and sglort combined into a single 32bit desc read */
0449         __le32 glort;
0450         /* upper 16 bits of VLAN are reserved 0 for swpri_type_user */
0451         __le32 vlan;
0452     } d;
0453     struct {
0454         __le16 dglort;
0455         __le16 sglort;
0456         __le16 vlan;
0457         __le16 swpri_type_user;
0458     } w;
0459 };
0460
0461 struct fm10k_cb {
0462     union {
0463         __le64 tstamp;
0464         unsigned long ts_tx_timeout;
0465     };
0466     union fm10k_ftag_info fi;
0467 };
0468
0469 #define FM10K_CB(skb) ((struct fm10k_cb *)(skb)->cb)
0470
0471 /* main */
0472 extern char fm10k_driver_name[];
0473 int fm10k_init_queueing_scheme(struct fm10k_intfc *interface);
0474 void fm10k_clear_queueing_scheme(struct fm10k_intfc *interface);
0475 __be16 fm10k_tx_encap_offload(struct sk_buff *skb);
0476 netdev_tx_t fm10k_xmit_frame_ring(struct sk_buff *skb,
0477                   struct fm10k_ring *tx_ring);
0478 void fm10k_tx_timeout_reset(struct fm10k_intfc *interface);
0479 u64 fm10k_get_tx_pending(struct fm10k_ring *ring, bool in_sw);
0480 bool fm10k_check_tx_hang(struct fm10k_ring *tx_ring);
0481 void fm10k_alloc_rx_buffers(struct fm10k_ring *rx_ring, u16 cleaned_count);
0482
0483 /* PCI */
0484 void fm10k_mbx_free_irq(struct fm10k_intfc *);
0485 int fm10k_mbx_request_irq(struct fm10k_intfc *);
0486 void fm10k_qv_free_irq(struct fm10k_intfc *interface);
0487 int fm10k_qv_request_irq(struct fm10k_intfc *interface);
0488 int fm10k_register_pci_driver(void);
0489 void fm10k_unregister_pci_driver(void);
0490 void fm10k_up(struct fm10k_intfc *interface);
0491 void fm10k_down(struct fm10k_intfc *interface);
0492 void fm10k_update_stats(struct fm10k_intfc *interface);
0493 void fm10k_service_event_schedule(struct fm10k_intfc *interface);
0494 void fm10k_macvlan_schedule(struct fm10k_intfc *interface);
0495 void fm10k_update_rx_drop_en(struct fm10k_intfc *interface);
0496
0497 /* Netdev */
0498 struct net_device *fm10k_alloc_netdev(const struct fm10k_info *info);
0499 int fm10k_setup_rx_resources(struct fm10k_ring *);
0500 int fm10k_setup_tx_resources(struct fm10k_ring *);
0501 void fm10k_free_rx_resources(struct fm10k_ring *);
0502 void fm10k_free_tx_resources(struct fm10k_ring *);
0503 void fm10k_clean_all_rx_rings(struct fm10k_intfc *);
0504 void fm10k_clean_all_tx_rings(struct fm10k_intfc *);
0505 void fm10k_unmap_and_free_tx_resource(struct fm10k_ring *,
0506                       struct fm10k_tx_buffer *);
0507 void fm10k_restore_rx_state(struct fm10k_intfc *);
0508 void fm10k_reset_rx_state(struct fm10k_intfc *);
0509 int fm10k_setup_tc(struct net_device *dev, u8 tc);
0510 int fm10k_open(struct net_device *netdev);
0511 int fm10k_close(struct net_device *netdev);
0512 int fm10k_queue_vlan_request(struct fm10k_intfc *interface, u32 vid,
0513                  u8 vsi, bool set);
0514 int fm10k_queue_mac_request(struct fm10k_intfc *interface, u16 glort,
0515                 const unsigned char *addr, u16 vid, bool set);
0516 void fm10k_clear_macvlan_queue(struct fm10k_intfc *interface,
0517                    u16 glort, bool vlans);
0518
0519 /* Ethtool */
0520 void fm10k_set_ethtool_ops(struct net_device *dev);
0521 void fm10k_write_reta(struct fm10k_intfc *interface, const u32 *indir);
0522
0523 /* IOV */
0524 s32 fm10k_iov_event(struct fm10k_intfc *interface);
0525 s32 fm10k_iov_mbx(struct fm10k_intfc *interface);
0526 void fm10k_iov_suspend(struct pci_dev *pdev);
0527 int fm10k_iov_resume(struct pci_dev *pdev);
0528 void fm10k_iov_disable(struct pci_dev *pdev);
0529 int fm10k_iov_configure(struct pci_dev *pdev, int num_vfs);
0530 void fm10k_iov_update_stats(struct fm10k_intfc *interface);
0531 s32 fm10k_iov_update_pvid(struct fm10k_intfc *interface, u16 glort, u16 pvid);
0532 int fm10k_ndo_set_vf_mac(struct net_device *netdev, int vf_idx, u8 *mac);
0533 int fm10k_ndo_set_vf_vlan(struct net_device *netdev,
0534               int vf_idx, u16 vid, u8 qos, __be16 vlan_proto);
0535 int fm10k_ndo_set_vf_bw(struct net_device *netdev, int vf_idx,
0536             int __always_unused min_rate, int max_rate);
0537 int fm10k_ndo_get_vf_config(struct net_device *netdev,
0538                 int vf_idx, struct ifla_vf_info *ivi);
0539 int fm10k_ndo_get_vf_stats(struct net_device *netdev,
0540                int vf_idx, struct ifla_vf_stats *stats);
0541
0542 /* DebugFS */
0543 #ifdef CONFIG_DEBUG_FS
0544 void fm10k_dbg_q_vector_init(struct fm10k_q_vector *q_vector);
0545 void fm10k_dbg_q_vector_exit(struct fm10k_q_vector *q_vector);
0546 void fm10k_dbg_intfc_init(struct fm10k_intfc *interface);
0547 void fm10k_dbg_intfc_exit(struct fm10k_intfc *interface);
0548 void fm10k_dbg_init(void);
0549 void fm10k_dbg_exit(void);
0550 #else
0551 static inline void fm10k_dbg_q_vector_init(struct fm10k_q_vector *q_vector) {}
0552 static inline void fm10k_dbg_q_vector_exit(struct fm10k_q_vector *q_vector) {}
0553 static inline void fm10k_dbg_intfc_init(struct fm10k_intfc *interface) {}
0554 static inline void fm10k_dbg_intfc_exit(struct fm10k_intfc *interface) {}
0555 static inline void fm10k_dbg_init(void) {}
0556 static inline void fm10k_dbg_exit(void) {}
0557 #endif /* CONFIG_DEBUG_FS */
0558
0559 /* DCB */
0560 #ifdef CONFIG_DCB
0561 void fm10k_dcbnl_set_ops(struct net_device *dev);
0562 #else
0563 static inline void fm10k_dcbnl_set_ops(struct net_device *dev) {}
0564 #endif
0565 #endif /* _FM10K_H_ */