drivers/net/ethernet/intel/fm10k/fm10k.h

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