drivers/net/ethernet/sfc/net_driver.h

   1 /****************************************************************************
   2  * Driver for Solarflare Solarstorm network controllers and boards
   3  * Copyright 2005-2006 Fen Systems Ltd.
   4  * Copyright 2005-2011 Solarflare Communications Inc.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License version 2 as published
   8  * by the Free Software Foundation, incorporated herein by reference.
   9  */
  10
  11 /* Common definitions for all Efx net driver code */
  12
  13 #ifndef EFX_NET_DRIVER_H
  14 #define EFX_NET_DRIVER_H
  15
  16 #include <linux/netdevice.h>
  17 #include <linux/etherdevice.h>
  18 #include <linux/ethtool.h>
  19 #include <linux/if_vlan.h>
  20 #include <linux/timer.h>
  21 #include <linux/mdio.h>
  22 #include <linux/list.h>
  23 #include <linux/pci.h>
  24 #include <linux/device.h>
  25 #include <linux/highmem.h>
  26 #include <linux/workqueue.h>
  27 #include <linux/mutex.h>
  28 #include <linux/vmalloc.h>
  29 #include <linux/i2c.h>
  30
  31 #include "enum.h"
  32 #include "bitfield.h"
  33
  34 /**************************************************************************
  35  *
  36  * Build definitions
  37  *
  38  **************************************************************************/
  39
  40 #define EFX_DRIVER_VERSION      "3.2"
  41
  42 #ifdef DEBUG
  43 #define EFX_BUG_ON_PARANOID(x) BUG_ON(x)
  44 #define EFX_WARN_ON_PARANOID(x) WARN_ON(x)
  45 #else
  46 #define EFX_BUG_ON_PARANOID(x) do {} while (0)
  47 #define EFX_WARN_ON_PARANOID(x) do {} while (0)
  48 #endif
  49
  50 /**************************************************************************
  51  *
  52  * Efx data structures
  53  *
  54  **************************************************************************/
  55
  56 #define EFX_MAX_CHANNELS 32U
  57 #define EFX_MAX_RX_QUEUES EFX_MAX_CHANNELS
  58 #define EFX_EXTRA_CHANNEL_IOV   0
  59 #define EFX_EXTRA_CHANNEL_PTP   1
  60 #define EFX_MAX_EXTRA_CHANNELS  2U
  61
  62 /* Checksum generation is a per-queue option in hardware, so each
  63  * queue visible to the networking core is backed by two hardware TX
  64  * queues. */
  65 #define EFX_MAX_TX_TC           2
  66 #define EFX_MAX_CORE_TX_QUEUES  (EFX_MAX_TX_TC * EFX_MAX_CHANNELS)
  67 #define EFX_TXQ_TYPE_OFFLOAD    1       /* flag */
  68 #define EFX_TXQ_TYPE_HIGHPRI    2       /* flag */
  69 #define EFX_TXQ_TYPES           4
  70 #define EFX_MAX_TX_QUEUES       (EFX_TXQ_TYPES * EFX_MAX_CHANNELS)
  71
  72 /* Maximum possible MTU the driver supports */
  73 #define EFX_MAX_MTU (9 * 1024)
  74
  75 /* Size of an RX scatter buffer.  Small enough to pack 2 into a 4K page. */
  76 #define EFX_RX_USR_BUF_SIZE 1824
  77
  78 /* Forward declare Precision Time Protocol (PTP) support structure. */
  79 struct efx_ptp_data;
  80
  81 struct efx_self_tests;
  82
  83 /**
  84  * struct efx_special_buffer - An Efx special buffer
  85  * @addr: CPU base address of the buffer
  86  * @dma_addr: DMA base address of the buffer
  87  * @len: Buffer length, in bytes
  88  * @index: Buffer index within controller;s buffer table
  89  * @entries: Number of buffer table entries
  90  *
  91  * Special buffers are used for the event queues and the TX and RX
  92  * descriptor queues for each channel.  They are *not* used for the
  93  * actual transmit and receive buffers.
  94  */
  95 struct efx_special_buffer {
  96         void *addr;
  97         dma_addr_t dma_addr;
  98         unsigned int len;
  99         unsigned int index;
 100         unsigned int entries;
 101 };
 102
 103 /**
 104  * struct efx_tx_buffer - buffer state for a TX descriptor
 105  * @skb: When @flags & %EFX_TX_BUF_SKB, the associated socket buffer to be
 106  *      freed when descriptor completes
 107  * @heap_buf: When @flags & %EFX_TX_BUF_HEAP, the associated heap buffer to be
 108  *      freed when descriptor completes.
 109  * @dma_addr: DMA address of the fragment.
 110  * @flags: Flags for allocation and DMA mapping type
 111  * @len: Length of this fragment.
 112  *      This field is zero when the queue slot is empty.
 113  * @unmap_len: Length of this fragment to unmap
 114  */
 115 struct efx_tx_buffer {
 116         union {
 117                 const struct sk_buff *skb;
 118                 void *heap_buf;
 119         };
 120         dma_addr_t dma_addr;
 121         unsigned short flags;
 122         unsigned short len;
 123         unsigned short unmap_len;
 124 };
 125 #define EFX_TX_BUF_CONT         1       /* not last descriptor of packet */
 126 #define EFX_TX_BUF_SKB          2       /* buffer is last part of skb */
 127 #define EFX_TX_BUF_HEAP         4       /* buffer was allocated with kmalloc() */
 128 #define EFX_TX_BUF_MAP_SINGLE   8       /* buffer was mapped with dma_map_single() */
 129
 130 /**
 131  * struct efx_tx_queue - An Efx TX queue
 132  *
 133  * This is a ring buffer of TX fragments.
 134  * Since the TX completion path always executes on the same
 135  * CPU and the xmit path can operate on different CPUs,
 136  * performance is increased by ensuring that the completion
 137  * path and the xmit path operate on different cache lines.
 138  * This is particularly important if the xmit path is always
 139  * executing on one CPU which is different from the completion
 140  * path.  There is also a cache line for members which are
 141  * read but not written on the fast path.
 142  *
 143  * @efx: The associated Efx NIC
 144  * @queue: DMA queue number
 145  * @channel: The associated channel
 146  * @core_txq: The networking core TX queue structure
 147  * @buffer: The software buffer ring
 148  * @tsoh_page: Array of pages of TSO header buffers
 149  * @txd: The hardware descriptor ring
 150  * @ptr_mask: The size of the ring minus 1.
 151  * @initialised: Has hardware queue been initialised?
 152  * @read_count: Current read pointer.
 153  *      This is the number of buffers that have been removed from both rings.
 154  * @old_write_count: The value of @write_count when last checked.
 155  *      This is here for performance reasons.  The xmit path will
 156  *      only get the up-to-date value of @write_count if this
 157  *      variable indicates that the queue is empty.  This is to
 158  *      avoid cache-line ping-pong between the xmit path and the
 159  *      completion path.
 160  * @insert_count: Current insert pointer
 161  *      This is the number of buffers that have been added to the
 162  *      software ring.
 163  * @write_count: Current write pointer
 164  *      This is the number of buffers that have been added to the
 165  *      hardware ring.
 166  * @old_read_count: The value of read_count when last checked.
 167  *      This is here for performance reasons.  The xmit path will
 168  *      only get the up-to-date value of read_count if this
 169  *      variable indicates that the queue is full.  This is to
 170  *      avoid cache-line ping-pong between the xmit path and the
 171  *      completion path.
 172  * @tso_bursts: Number of times TSO xmit invoked by kernel
 173  * @tso_long_headers: Number of packets with headers too long for standard
 174  *      blocks
 175  * @tso_packets: Number of packets via the TSO xmit path
 176  * @pushes: Number of times the TX push feature has been used
 177  * @empty_read_count: If the completion path has seen the queue as empty
 178  *      and the transmission path has not yet checked this, the value of
 179  *      @read_count bitwise-added to %EFX_EMPTY_COUNT_VALID; otherwise 0.
 180  */
 181 struct efx_tx_queue {
 182         /* Members which don't change on the fast path */
 183         struct efx_nic *efx ____cacheline_aligned_in_smp;
 184         unsigned queue;
 185         struct efx_channel *channel;
 186         struct netdev_queue *core_txq;
 187         struct efx_tx_buffer *buffer;
 188         struct efx_buffer *tsoh_page;
 189         struct efx_special_buffer txd;
 190         unsigned int ptr_mask;
 191         bool initialised;
 192
 193         /* Members used mainly on the completion path */
 194         unsigned int read_count ____cacheline_aligned_in_smp;
 195         unsigned int old_write_count;
 196
 197         /* Members used only on the xmit path */
 198         unsigned int insert_count ____cacheline_aligned_in_smp;
 199         unsigned int write_count;
 200         unsigned int old_read_count;
 201         unsigned int tso_bursts;
 202         unsigned int tso_long_headers;
 203         unsigned int tso_packets;
 204         unsigned int pushes;
 205
 206         /* Members shared between paths and sometimes updated */
 207         unsigned int empty_read_count ____cacheline_aligned_in_smp;
 208 #define EFX_EMPTY_COUNT_VALID 0x80000000
 209         atomic_t flush_outstanding;
 210 };
 211
 212 /**
 213  * struct efx_rx_buffer - An Efx RX data buffer
 214  * @dma_addr: DMA base address of the buffer
 215  * @page: The associated page buffer.
 216  *      Will be %NULL if the buffer slot is currently free.
 217  * @page_offset: If pending: offset in @page of DMA base address.
 218  *      If completed: offset in @page of Ethernet header.
 219  * @len: If pending: length for DMA descriptor.
 220  *      If completed: received length, excluding hash prefix.
 221  * @flags: Flags for buffer and packet state.  These are only set on the
 222  *      first buffer of a scattered packet.
 223  */
 224 struct efx_rx_buffer {
 225         dma_addr_t dma_addr;
 226         struct page *page;
 227         u16 page_offset;
 228         u16 len;
 229         u16 flags;
 230 };
 231 #define EFX_RX_BUF_LAST_IN_PAGE 0x0001
 232 #define EFX_RX_PKT_CSUMMED      0x0002
 233 #define EFX_RX_PKT_DISCARD      0x0004
 234
 235 /**
 236  * struct efx_rx_page_state - Page-based rx buffer state
 237  *
 238  * Inserted at the start of every page allocated for receive buffers.
 239  * Used to facilitate sharing dma mappings between recycled rx buffers
 240  * and those passed up to the kernel.
 241  *
 242  * @refcnt: Number of struct efx_rx_buffer's referencing this page.
 243  *      When refcnt falls to zero, the page is unmapped for dma
 244  * @dma_addr: The dma address of this page.
 245  */
 246 struct efx_rx_page_state {
 247         unsigned refcnt;
 248         dma_addr_t dma_addr;
 249
 250         unsigned int __pad[0] ____cacheline_aligned;
 251 };
 252
 253 /**
 254  * struct efx_rx_queue - An Efx RX queue
 255  * @efx: The associated Efx NIC
 256  * @core_index:  Index of network core RX queue.  Will be >= 0 iff this
 257  *      is associated with a real RX queue.
 258  * @buffer: The software buffer ring
 259  * @rxd: The hardware descriptor ring
 260  * @ptr_mask: The size of the ring minus 1.
 261  * @enabled: Receive queue enabled indicator.
 262  * @flush_pending: Set when a RX flush is pending. Has the same lifetime as
 263  *      @rxq_flush_pending.
 264  * @added_count: Number of buffers added to the receive queue.
 265  * @notified_count: Number of buffers given to NIC (<= @added_count).
 266  * @removed_count: Number of buffers removed from the receive queue.
 267  * @scatter_n: Number of buffers used by current packet
 268  * @page_ring: The ring to store DMA mapped pages for reuse.
 269  * @page_add: Counter to calculate the write pointer for the recycle ring.
 270  * @page_remove: Counter to calculate the read pointer for the recycle ring.
 271  * @page_recycle_count: The number of pages that have been recycled.
 272  * @page_recycle_failed: The number of pages that couldn't be recycled because
 273  *      the kernel still held a reference to them.
 274  * @page_recycle_full: The number of pages that were released because the
 275  *      recycle ring was full.
 276  * @page_ptr_mask: The number of pages in the RX recycle ring minus 1.
 277  * @max_fill: RX descriptor maximum fill level (<= ring size)
 278  * @fast_fill_trigger: RX descriptor fill level that will trigger a fast fill
 279  *      (<= @max_fill)
 280  * @min_fill: RX descriptor minimum non-zero fill level.
 281  *      This records the minimum fill level observed when a ring
 282  *      refill was triggered.
 283  * @recycle_count: RX buffer recycle counter.
 284  * @slow_fill: Timer used to defer efx_nic_generate_fill_event().
 285  */
 286 struct efx_rx_queue {
 287         struct efx_nic *efx;
 288         int core_index;
 289         struct efx_rx_buffer *buffer;
 290         struct efx_special_buffer rxd;
 291         unsigned int ptr_mask;
 292         bool enabled;
 293         bool flush_pending;
 294
 295         unsigned int added_count;
 296         unsigned int notified_count;
 297         unsigned int removed_count;
 298         unsigned int scatter_n;
 299         struct page **page_ring;
 300         unsigned int page_add;
 301         unsigned int page_remove;
 302         unsigned int page_recycle_count;
 303         unsigned int page_recycle_failed;
 304         unsigned int page_recycle_full;
 305         unsigned int page_ptr_mask;
 306         unsigned int max_fill;
 307         unsigned int fast_fill_trigger;
 308         unsigned int min_fill;
 309         unsigned int min_overfill;
 310         unsigned int recycle_count;
 311         struct timer_list slow_fill;
 312         unsigned int slow_fill_count;
 313 };
 314
 315 /**
 316  * struct efx_buffer - An Efx general-purpose buffer
 317  * @addr: host base address of the buffer
 318  * @dma_addr: DMA base address of the buffer
 319  * @len: Buffer length, in bytes
 320  *
 321  * The NIC uses these buffers for its interrupt status registers and
 322  * MAC stats dumps.
 323  */
 324 struct efx_buffer {
 325         void *addr;
 326         dma_addr_t dma_addr;
 327         unsigned int len;
 328 };
 329
 330
 331 enum efx_rx_alloc_method {
 332         RX_ALLOC_METHOD_AUTO = 0,
 333         RX_ALLOC_METHOD_SKB = 1,
 334         RX_ALLOC_METHOD_PAGE = 2,
 335 };
 336
 337 /**
 338  * struct efx_channel - An Efx channel
 339  *
 340  * A channel comprises an event queue, at least one TX queue, at least
 341  * one RX queue, and an associated tasklet for processing the event
 342  * queue.
 343  *
 344  * @efx: Associated Efx NIC
 345  * @channel: Channel instance number
 346  * @type: Channel type definition
 347  * @enabled: Channel enabled indicator
 348  * @irq: IRQ number (MSI and MSI-X only)
 349  * @irq_moderation: IRQ moderation value (in hardware ticks)
 350  * @napi_dev: Net device used with NAPI
 351  * @napi_str: NAPI control structure
 352  * @work_pending: Is work pending via NAPI?
 353  * @eventq: Event queue buffer
 354  * @eventq_mask: Event queue pointer mask
 355  * @eventq_read_ptr: Event queue read pointer
 356  * @event_test_cpu: Last CPU to handle interrupt or test event for this channel
 357  * @irq_count: Number of IRQs since last adaptive moderation decision
 358  * @irq_mod_score: IRQ moderation score
 359  * @n_rx_tobe_disc: Count of RX_TOBE_DISC errors
 360  * @n_rx_ip_hdr_chksum_err: Count of RX IP header checksum errors
 361  * @n_rx_tcp_udp_chksum_err: Count of RX TCP and UDP checksum errors
 362  * @n_rx_mcast_mismatch: Count of unmatched multicast frames
 363  * @n_rx_frm_trunc: Count of RX_FRM_TRUNC errors
 364  * @n_rx_overlength: Count of RX_OVERLENGTH errors
 365  * @n_skbuff_leaks: Count of skbuffs leaked due to RX overrun
 366  * @n_rx_nodesc_trunc: Number of RX packets truncated and then dropped due to
 367  *      lack of descriptors
 368  * @rx_pkt_n_frags: Number of fragments in next packet to be delivered by
 369  *      __efx_rx_packet(), or zero if there is none
 370  * @rx_pkt_index: Ring index of first buffer for next packet to be delivered
 371  *      by __efx_rx_packet(), if @rx_pkt_n_frags != 0
 372  * @rx_queue: RX queue for this channel
 373  * @tx_queue: TX queues for this channel
 374  */
 375 struct efx_channel {
 376         struct efx_nic *efx;
 377         int channel;
 378         const struct efx_channel_type *type;
 379         bool enabled;
 380         int irq;
 381         unsigned int irq_moderation;
 382         struct net_device *napi_dev;
 383         struct napi_struct napi_str;
 384         bool work_pending;
 385         struct efx_special_buffer eventq;
 386         unsigned int eventq_mask;
 387         unsigned int eventq_read_ptr;
 388         int event_test_cpu;
 389
 390         unsigned int irq_count;
 391         unsigned int irq_mod_score;
 392 #ifdef CONFIG_RFS_ACCEL
 393         unsigned int rfs_filters_added;
 394 #endif
 395
 396         unsigned n_rx_tobe_disc;
 397         unsigned n_rx_ip_hdr_chksum_err;
 398         unsigned n_rx_tcp_udp_chksum_err;
 399         unsigned n_rx_mcast_mismatch;
 400         unsigned n_rx_frm_trunc;
 401         unsigned n_rx_overlength;
 402         unsigned n_skbuff_leaks;
 403         unsigned int n_rx_nodesc_trunc;
 404
 405         unsigned int rx_pkt_n_frags;
 406         unsigned int rx_pkt_index;
 407
 408         struct efx_rx_queue rx_queue;
 409         struct efx_tx_queue tx_queue[EFX_TXQ_TYPES];
 410 };
 411
 412 /**
 413  * struct efx_channel_type - distinguishes traffic and extra channels
 414  * @handle_no_channel: Handle failure to allocate an extra channel
 415  * @pre_probe: Set up extra state prior to initialisation
 416  * @post_remove: Tear down extra state after finalisation, if allocated.
 417  *      May be called on channels that have not been probed.
 418  * @get_name: Generate the channel's name (used for its IRQ handler)
 419  * @copy: Copy the channel state prior to reallocation.  May be %NULL if
 420  *      reallocation is not supported.
 421  * @receive_skb: Handle an skb ready to be passed to netif_receive_skb()
 422  * @keep_eventq: Flag for whether event queue should be kept initialised
 423  *      while the device is stopped
 424  */
 425 struct efx_channel_type {
 426         void (*handle_no_channel)(struct efx_nic *);
 427         int (*pre_probe)(struct efx_channel *);
 428         void (*post_remove)(struct efx_channel *);
 429         void (*get_name)(struct efx_channel *, char *buf, size_t len);
 430         struct efx_channel *(*copy)(const struct efx_channel *);
 431         bool (*receive_skb)(struct efx_channel *, struct sk_buff *);
 432         bool keep_eventq;
 433 };
 434
 435 enum efx_led_mode {
 436         EFX_LED_OFF     = 0,
 437         EFX_LED_ON      = 1,
 438         EFX_LED_DEFAULT = 2
 439 };
 440
 441 #define STRING_TABLE_LOOKUP(val, member) \
 442         ((val) < member ## _max) ? member ## _names[val] : "(invalid)"
 443
 444 extern const char *const efx_loopback_mode_names[];
 445 extern const unsigned int efx_loopback_mode_max;
 446 #define LOOPBACK_MODE(efx) \
 447         STRING_TABLE_LOOKUP((efx)->loopback_mode, efx_loopback_mode)
 448
 449 extern const char *const efx_reset_type_names[];
 450 extern const unsigned int efx_reset_type_max;
 451 #define RESET_TYPE(type) \
 452         STRING_TABLE_LOOKUP(type, efx_reset_type)
 453
 454 enum efx_int_mode {
 455         /* Be careful if altering to correct macro below */
 456         EFX_INT_MODE_MSIX = 0,
 457         EFX_INT_MODE_MSI = 1,
 458         EFX_INT_MODE_LEGACY = 2,
 459         EFX_INT_MODE_MAX        /* Insert any new items before this */
 460 };
 461 #define EFX_INT_MODE_USE_MSI(x) (((x)->interrupt_mode) <= EFX_INT_MODE_MSI)
 462
 463 enum nic_state {
 464         STATE_UNINIT = 0,       /* device being probed/removed or is frozen */
 465         STATE_READY = 1,        /* hardware ready and netdev registered */
 466         STATE_DISABLED = 2,     /* device disabled due to hardware errors */
 467         STATE_RECOVERY = 3,     /* device recovering from PCI error */
 468 };
 469
 470 /*
 471  * Alignment of page-allocated RX buffers
 472  *
 473  * Controls the number of bytes inserted at the start of an RX buffer.
 474  * This is the equivalent of NET_IP_ALIGN [which controls the alignment
 475  * of the skb->head for hardware DMA].
 476  */
 477 #ifdef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
 478 #define EFX_PAGE_IP_ALIGN 0
 479 #else
 480 #define EFX_PAGE_IP_ALIGN NET_IP_ALIGN
 481 #endif
 482
 483 /*
 484  * Alignment of the skb->head which wraps a page-allocated RX buffer
 485  *
 486  * The skb allocated to wrap an rx_buffer can have this alignment. Since
 487  * the data is memcpy'd from the rx_buf, it does not need to be equal to
 488  * EFX_PAGE_IP_ALIGN.
 489  */
 490 #define EFX_PAGE_SKB_ALIGN 2
 491
 492 /* Forward declaration */
 493 struct efx_nic;
 494
 495 /* Pseudo bit-mask flow control field */
 496 #define EFX_FC_RX       FLOW_CTRL_RX
 497 #define EFX_FC_TX       FLOW_CTRL_TX
 498 #define EFX_FC_AUTO     4
 499
 500 /**
 501  * struct efx_link_state - Current state of the link
 502  * @up: Link is up
 503  * @fd: Link is full-duplex
 504  * @fc: Actual flow control flags
 505  * @speed: Link speed (Mbps)
 506  */
 507 struct efx_link_state {
 508         bool up;
 509         bool fd;
 510         u8 fc;
 511         unsigned int speed;
 512 };
 513
 514 static inline bool efx_link_state_equal(const struct efx_link_state *left,
 515                                         const struct efx_link_state *right)
 516 {
 517         return left->up == right->up && left->fd == right->fd &&
 518                 left->fc == right->fc && left->speed == right->speed;
 519 }
 520
 521 /**
 522  * struct efx_phy_operations - Efx PHY operations table
 523  * @probe: Probe PHY and initialise efx->mdio.mode_support, efx->mdio.mmds,
 524  *      efx->loopback_modes.
 525  * @init: Initialise PHY
 526  * @fini: Shut down PHY
 527  * @reconfigure: Reconfigure PHY (e.g. for new link parameters)
 528  * @poll: Update @link_state and report whether it changed.
 529  *      Serialised by the mac_lock.
 530  * @get_settings: Get ethtool settings. Serialised by the mac_lock.
 531  * @set_settings: Set ethtool settings. Serialised by the mac_lock.
 532  * @set_npage_adv: Set abilities advertised in (Extended) Next Page
 533  *      (only needed where AN bit is set in mmds)
 534  * @test_alive: Test that PHY is 'alive' (online)
 535  * @test_name: Get the name of a PHY-specific test/result
 536  * @run_tests: Run tests and record results as appropriate (offline).
 537  *      Flags are the ethtool tests flags.
 538  */
 539 struct efx_phy_operations {
 540         int (*probe) (struct efx_nic *efx);
 541         int (*init) (struct efx_nic *efx);
 542         void (*fini) (struct efx_nic *efx);
 543         void (*remove) (struct efx_nic *efx);
 544         int (*reconfigure) (struct efx_nic *efx);
 545         bool (*poll) (struct efx_nic *efx);
 546         void (*get_settings) (struct efx_nic *efx,
 547                               struct ethtool_cmd *ecmd);
 548         int (*set_settings) (struct efx_nic *efx,
 549                              struct ethtool_cmd *ecmd);
 550         void (*set_npage_adv) (struct efx_nic *efx, u32);
 551         int (*test_alive) (struct efx_nic *efx);
 552         const char *(*test_name) (struct efx_nic *efx, unsigned int index);
 553         int (*run_tests) (struct efx_nic *efx, int *results, unsigned flags);
 554         int (*get_module_eeprom) (struct efx_nic *efx,
 555                                struct ethtool_eeprom *ee,
 556                                u8 *data);
 557         int (*get_module_info) (struct efx_nic *efx,
 558                                 struct ethtool_modinfo *modinfo);
 559 };
 560
 561 /**
 562  * enum efx_phy_mode - PHY operating mode flags
 563  * @PHY_MODE_NORMAL: on and should pass traffic
 564  * @PHY_MODE_TX_DISABLED: on with TX disabled
 565  * @PHY_MODE_LOW_POWER: set to low power through MDIO
 566  * @PHY_MODE_OFF: switched off through external control
 567  * @PHY_MODE_SPECIAL: on but will not pass traffic
 568  */
 569 enum efx_phy_mode {
 570         PHY_MODE_NORMAL         = 0,
 571         PHY_MODE_TX_DISABLED    = 1,
 572         PHY_MODE_LOW_POWER      = 2,
 573         PHY_MODE_OFF            = 4,
 574         PHY_MODE_SPECIAL        = 8,
 575 };
 576
 577 static inline bool efx_phy_mode_disabled(enum efx_phy_mode mode)
 578 {
 579         return !!(mode & ~PHY_MODE_TX_DISABLED);
 580 }
 581
 582 /*
 583  * Efx extended statistics
 584  *
 585  * Not all statistics are provided by all supported MACs.  The purpose
 586  * is this structure is to contain the raw statistics provided by each
 587  * MAC.
 588  */
 589 struct efx_mac_stats {
 590         u64 tx_bytes;
 591         u64 tx_good_bytes;
 592         u64 tx_bad_bytes;
 593         u64 tx_packets;
 594         u64 tx_bad;
 595         u64 tx_pause;
 596         u64 tx_control;
 597         u64 tx_unicast;
 598         u64 tx_multicast;
 599         u64 tx_broadcast;
 600         u64 tx_lt64;
 601         u64 tx_64;
 602         u64 tx_65_to_127;
 603         u64 tx_128_to_255;
 604         u64 tx_256_to_511;
 605         u64 tx_512_to_1023;
 606         u64 tx_1024_to_15xx;
 607         u64 tx_15xx_to_jumbo;
 608         u64 tx_gtjumbo;
 609         u64 tx_collision;
 610         u64 tx_single_collision;
 611         u64 tx_multiple_collision;
 612         u64 tx_excessive_collision;
 613         u64 tx_deferred;
 614         u64 tx_late_collision;
 615         u64 tx_excessive_deferred;
 616         u64 tx_non_tcpudp;
 617         u64 tx_mac_src_error;
 618         u64 tx_ip_src_error;
 619         u64 rx_bytes;
 620         u64 rx_good_bytes;
 621         u64 rx_bad_bytes;
 622         u64 rx_packets;
 623         u64 rx_good;
 624         u64 rx_bad;
 625         u64 rx_pause;
 626         u64 rx_control;
 627         u64 rx_unicast;
 628         u64 rx_multicast;
 629         u64 rx_broadcast;
 630         u64 rx_lt64;
 631         u64 rx_64;
 632         u64 rx_65_to_127;
 633         u64 rx_128_to_255;
 634         u64 rx_256_to_511;
 635         u64 rx_512_to_1023;
 636         u64 rx_1024_to_15xx;
 637         u64 rx_15xx_to_jumbo;
 638         u64 rx_gtjumbo;
 639         u64 rx_bad_lt64;
 640         u64 rx_bad_64_to_15xx;
 641         u64 rx_bad_15xx_to_jumbo;
 642         u64 rx_bad_gtjumbo;
 643         u64 rx_overflow;
 644         u64 rx_missed;
 645         u64 rx_false_carrier;
 646         u64 rx_symbol_error;
 647         u64 rx_align_error;
 648         u64 rx_length_error;
 649         u64 rx_internal_error;
 650         u64 rx_good_lt64;
 651 };
 652
 653 /* Number of bits used in a multicast filter hash address */
 654 #define EFX_MCAST_HASH_BITS 8
 655
 656 /* Number of (single-bit) entries in a multicast filter hash */
 657 #define EFX_MCAST_HASH_ENTRIES (1 << EFX_MCAST_HASH_BITS)
 658
 659 /* An Efx multicast filter hash */
 660 union efx_multicast_hash {
 661         u8 byte[EFX_MCAST_HASH_ENTRIES / 8];
 662         efx_oword_t oword[EFX_MCAST_HASH_ENTRIES / sizeof(efx_oword_t) / 8];
 663 };
 664
 665 struct efx_filter_state;
 666 struct efx_vf;
 667 struct vfdi_status;
 668
 669 /**
 670  * struct efx_nic - an Efx NIC
 671  * @name: Device name (net device name or bus id before net device registered)
 672  * @pci_dev: The PCI device
 673  * @type: Controller type attributes
 674  * @legacy_irq: IRQ number
 675  * @legacy_irq_enabled: Are IRQs enabled on NIC (INT_EN_KER register)?
 676  * @workqueue: Workqueue for port reconfigures and the HW monitor.
 677  *      Work items do not hold and must not acquire RTNL.
 678  * @workqueue_name: Name of workqueue
 679  * @reset_work: Scheduled reset workitem
 680  * @membase_phys: Memory BAR value as physical address
 681  * @membase: Memory BAR value
 682  * @interrupt_mode: Interrupt mode
 683  * @timer_quantum_ns: Interrupt timer quantum, in nanoseconds
 684  * @irq_rx_adaptive: Adaptive IRQ moderation enabled for RX event queues
 685  * @irq_rx_moderation: IRQ moderation time for RX event queues
 686  * @msg_enable: Log message enable flags
 687  * @state: Device state number (%STATE_*). Serialised by the rtnl_lock.
 688  * @reset_pending: Bitmask for pending resets
 689  * @tx_queue: TX DMA queues
 690  * @rx_queue: RX DMA queues
 691  * @channel: Channels
 692  * @channel_name: Names for channels and their IRQs
 693  * @extra_channel_types: Types of extra (non-traffic) channels that
 694  *      should be allocated for this NIC
 695  * @rxq_entries: Size of receive queues requested by user.
 696  * @txq_entries: Size of transmit queues requested by user.
 697  * @txq_stop_thresh: TX queue fill level at or above which we stop it.
 698  * @txq_wake_thresh: TX queue fill level at or below which we wake it.
 699  * @tx_dc_base: Base qword address in SRAM of TX queue descriptor caches
 700  * @rx_dc_base: Base qword address in SRAM of RX queue descriptor caches
 701  * @sram_lim_qw: Qword address limit of SRAM
 702  * @next_buffer_table: First available buffer table id
 703  * @n_channels: Number of channels in use
 704  * @n_rx_channels: Number of channels used for RX (= number of RX queues)
 705  * @n_tx_channels: Number of channels used for TX
 706  * @rx_dma_len: Current maximum RX DMA length
 707  * @rx_buffer_order: Order (log2) of number of pages for each RX buffer
 708  * @rx_buffer_truesize: Amortised allocation size of an RX buffer,
 709  *      for use in sk_buff::truesize
 710  * @rx_hash_key: Toeplitz hash key for RSS
 711  * @rx_indir_table: Indirection table for RSS
 712  * @rx_scatter: Scatter mode enabled for receives
 713  * @int_error_count: Number of internal errors seen recently
 714  * @int_error_expire: Time at which error count will be expired
 715  * @irq_status: Interrupt status buffer
 716  * @irq_zero_count: Number of legacy IRQs seen with queue flags == 0
 717  * @irq_level: IRQ level/index for IRQs not triggered by an event queue
 718  * @selftest_work: Work item for asynchronous self-test
 719  * @mtd_list: List of MTDs attached to the NIC
 720  * @nic_data: Hardware dependent state
 721  * @mac_lock: MAC access lock. Protects @port_enabled, @phy_mode,
 722  *      efx_monitor() and efx_reconfigure_port()
 723  * @port_enabled: Port enabled indicator.
 724  *      Serialises efx_stop_all(), efx_start_all(), efx_monitor() and
 725  *      efx_mac_work() with kernel interfaces. Safe to read under any
 726  *      one of the rtnl_lock, mac_lock, or netif_tx_lock, but all three must
 727  *      be held to modify it.
 728  * @port_initialized: Port initialized?
 729  * @net_dev: Operating system network device. Consider holding the rtnl lock
 730  * @stats_buffer: DMA buffer for statistics
 731  * @phy_type: PHY type
 732  * @phy_op: PHY interface
 733  * @phy_data: PHY private data (including PHY-specific stats)
 734  * @mdio: PHY MDIO interface
 735  * @mdio_bus: PHY MDIO bus ID (only used by Siena)
 736  * @phy_mode: PHY operating mode. Serialised by @mac_lock.
 737  * @link_advertising: Autonegotiation advertising flags
 738  * @link_state: Current state of the link
 739  * @n_link_state_changes: Number of times the link has changed state
 740  * @promiscuous: Promiscuous flag. Protected by netif_tx_lock.
 741  * @multicast_hash: Multicast hash table
 742  * @wanted_fc: Wanted flow control flags
 743  * @fc_disable: When non-zero flow control is disabled. Typically used to
 744  *      ensure that network back pressure doesn't delay dma queue flushes.
 745  *      Serialised by the rtnl lock.
 746  * @mac_work: Work item for changing MAC promiscuity and multicast hash
 747  * @loopback_mode: Loopback status
 748  * @loopback_modes: Supported loopback mode bitmask
 749  * @loopback_selftest: Offline self-test private state
 750  * @drain_pending: Count of RX and TX queues that haven't been flushed and drained.
 751  * @rxq_flush_pending: Count of number of receive queues that need to be flushed.
 752  *      Decremented when the efx_flush_rx_queue() is called.
 753  * @rxq_flush_outstanding: Count of number of RX flushes started but not yet
 754  *      completed (either success or failure). Not used when MCDI is used to
 755  *      flush receive queues.
 756  * @flush_wq: wait queue used by efx_nic_flush_queues() to wait for flush completions.
 757  * @vf: Array of &struct efx_vf objects.
 758  * @vf_count: Number of VFs intended to be enabled.
 759  * @vf_init_count: Number of VFs that have been fully initialised.
 760  * @vi_scale: log2 number of vnics per VF.
 761  * @vf_buftbl_base: The zeroth buffer table index used to back VF queues.
 762  * @vfdi_status: Common VFDI status page to be dmad to VF address space.
 763  * @local_addr_list: List of local addresses. Protected by %local_lock.
 764  * @local_page_list: List of DMA addressable pages used to broadcast
 765  *      %local_addr_list. Protected by %local_lock.
 766  * @local_lock: Mutex protecting %local_addr_list and %local_page_list.
 767  * @peer_work: Work item to broadcast peer addresses to VMs.
 768  * @ptp_data: PTP state data
 769  * @monitor_work: Hardware monitor workitem
 770  * @biu_lock: BIU (bus interface unit) lock
 771  * @last_irq_cpu: Last CPU to handle a possible test interrupt.  This
 772  *      field is used by efx_test_interrupts() to verify that an
 773  *      interrupt has occurred.
 774  * @n_rx_nodesc_drop_cnt: RX no descriptor drop count
 775  * @mac_stats: MAC statistics. These include all statistics the MACs
 776  *      can provide.  Generic code converts these into a standard
 777  *      &struct net_device_stats.
 778  * @stats_lock: Statistics update lock. Serialises statistics fetches
 779  *      and access to @mac_stats.
 780  *
 781  * This is stored in the private area of the &struct net_device.
 782  */
 783 struct efx_nic {
 784         /* The following fields should be written very rarely */
 785
 786         char name[IFNAMSIZ];
 787         struct pci_dev *pci_dev;
 788         const struct efx_nic_type *type;
 789         int legacy_irq;
 790         bool legacy_irq_enabled;
 791         struct workqueue_struct *workqueue;
 792         char workqueue_name[16];
 793         struct work_struct reset_work;
 794         resource_size_t membase_phys;
 795         void __iomem *membase;
 796
 797         enum efx_int_mode interrupt_mode;
 798         unsigned int timer_quantum_ns;
 799         bool irq_rx_adaptive;
 800         unsigned int irq_rx_moderation;
 801         u32 msg_enable;
 802
 803         enum nic_state state;
 804         unsigned long reset_pending;
 805
 806         struct efx_channel *channel[EFX_MAX_CHANNELS];
 807         char channel_name[EFX_MAX_CHANNELS][IFNAMSIZ + 6];
 808         const struct efx_channel_type *
 809         extra_channel_type[EFX_MAX_EXTRA_CHANNELS];
 810
 811         unsigned rxq_entries;
 812         unsigned txq_entries;
 813         unsigned int txq_stop_thresh;
 814         unsigned int txq_wake_thresh;
 815
 816         unsigned tx_dc_base;
 817         unsigned rx_dc_base;
 818         unsigned sram_lim_qw;
 819         unsigned next_buffer_table;
 820         unsigned n_channels;
 821         unsigned n_rx_channels;
 822         unsigned rss_spread;
 823         unsigned tx_channel_offset;
 824         unsigned n_tx_channels;
 825         unsigned int rx_dma_len;
 826         unsigned int rx_buffer_order;
 827         unsigned int rx_buffer_truesize;
 828         unsigned int rx_page_buf_step;
 829         unsigned int rx_bufs_per_page;
 830         unsigned int rx_pages_per_batch;
 831         u8 rx_hash_key[40];
 832         u32 rx_indir_table[128];
 833         bool rx_scatter;
 834
 835         unsigned int_error_count;
 836         unsigned long int_error_expire;
 837
 838         struct efx_buffer irq_status;
 839         unsigned irq_zero_count;
 840         unsigned irq_level;
 841         struct delayed_work selftest_work;
 842
 843 #ifdef CONFIG_SFC_MTD
 844         struct list_head mtd_list;
 845 #endif
 846
 847         void *nic_data;
 848
 849         struct mutex mac_lock;
 850         struct work_struct mac_work;
 851         bool port_enabled;
 852
 853         bool port_initialized;
 854         struct net_device *net_dev;
 855
 856         struct efx_buffer stats_buffer;
 857
 858         unsigned int phy_type;
 859         const struct efx_phy_operations *phy_op;
 860         void *phy_data;
 861         struct mdio_if_info mdio;
 862         unsigned int mdio_bus;
 863         enum efx_phy_mode phy_mode;
 864
 865         u32 link_advertising;
 866         struct efx_link_state link_state;
 867         unsigned int n_link_state_changes;
 868
 869         bool promiscuous;
 870         union efx_multicast_hash multicast_hash;
 871         u8 wanted_fc;
 872         unsigned fc_disable;
 873
 874         atomic_t rx_reset;
 875         enum efx_loopback_mode loopback_mode;
 876         u64 loopback_modes;
 877
 878         void *loopback_selftest;
 879
 880         struct efx_filter_state *filter_state;
 881
 882         atomic_t drain_pending;
 883         atomic_t rxq_flush_pending;
 884         atomic_t rxq_flush_outstanding;
 885         wait_queue_head_t flush_wq;
 886
 887 #ifdef CONFIG_SFC_SRIOV
 888         struct efx_channel *vfdi_channel;
 889         struct efx_vf *vf;
 890         unsigned vf_count;
 891         unsigned vf_init_count;
 892         unsigned vi_scale;
 893         unsigned vf_buftbl_base;
 894         struct efx_buffer vfdi_status;
 895         struct list_head local_addr_list;
 896         struct list_head local_page_list;
 897         struct mutex local_lock;
 898         struct work_struct peer_work;
 899 #endif
 900
 901         struct efx_ptp_data *ptp_data;
 902
 903         /* The following fields may be written more often */
 904
 905         struct delayed_work monitor_work ____cacheline_aligned_in_smp;
 906         spinlock_t biu_lock;
 907         int last_irq_cpu;
 908         unsigned n_rx_nodesc_drop_cnt;
 909         struct efx_mac_stats mac_stats;
 910         spinlock_t stats_lock;
 911 };
 912
 913 static inline int efx_dev_registered(struct efx_nic *efx)
 914 {
 915         return efx->net_dev->reg_state == NETREG_REGISTERED;
 916 }
 917
 918 static inline unsigned int efx_port_num(struct efx_nic *efx)
 919 {
 920         return efx->net_dev->dev_id;
 921 }
 922
 923 /**
 924  * struct efx_nic_type - Efx device type definition
 925  * @probe: Probe the controller
 926  * @remove: Free resources allocated by probe()
 927  * @init: Initialise the controller
 928  * @dimension_resources: Dimension controller resources (buffer table,
 929  *      and VIs once the available interrupt resources are clear)
 930  * @fini: Shut down the controller
 931  * @monitor: Periodic function for polling link state and hardware monitor
 932  * @map_reset_reason: Map ethtool reset reason to a reset method
 933  * @map_reset_flags: Map ethtool reset flags to a reset method, if possible
 934  * @reset: Reset the controller hardware and possibly the PHY.  This will
 935  *      be called while the controller is uninitialised.
 936  * @probe_port: Probe the MAC and PHY
 937  * @remove_port: Free resources allocated by probe_port()
 938  * @handle_global_event: Handle a "global" event (may be %NULL)
 939  * @prepare_flush: Prepare the hardware for flushing the DMA queues
 940  * @finish_flush: Clean up after flushing the DMA queues
 941  * @update_stats: Update statistics not provided by event handling
 942  * @start_stats: Start the regular fetching of statistics
 943  * @stop_stats: Stop the regular fetching of statistics
 944  * @set_id_led: Set state of identifying LED or revert to automatic function
 945  * @push_irq_moderation: Apply interrupt moderation value
 946  * @reconfigure_port: Push loopback/power/txdis changes to the MAC and PHY
 947  * @reconfigure_mac: Push MAC address, MTU, flow control and filter settings
 948  *      to the hardware.  Serialised by the mac_lock.
 949  * @check_mac_fault: Check MAC fault state. True if fault present.
 950  * @get_wol: Get WoL configuration from driver state
 951  * @set_wol: Push WoL configuration to the NIC
 952  * @resume_wol: Synchronise WoL state between driver and MC (e.g. after resume)
 953  * @test_chip: Test registers.  Should use efx_nic_test_registers(), and is
 954  *      expected to reset the NIC.
 955  * @test_nvram: Test validity of NVRAM contents
 956  * @revision: Hardware architecture revision
 957  * @mem_map_size: Memory BAR mapped size
 958  * @txd_ptr_tbl_base: TX descriptor ring base address
 959  * @rxd_ptr_tbl_base: RX descriptor ring base address
 960  * @buf_tbl_base: Buffer table base address
 961  * @evq_ptr_tbl_base: Event queue pointer table base address
 962  * @evq_rptr_tbl_base: Event queue read-pointer table base address
 963  * @max_dma_mask: Maximum possible DMA mask
 964  * @rx_buffer_hash_size: Size of hash at start of RX packet
 965  * @rx_buffer_padding: Size of padding at end of RX packet
 966  * @can_rx_scatter: NIC is able to scatter packet to multiple buffers
 967  * @max_interrupt_mode: Highest capability interrupt mode supported
 968  *      from &enum efx_init_mode.
 969  * @phys_addr_channels: Number of channels with physically addressed
 970  *      descriptors
 971  * @timer_period_max: Maximum period of interrupt timer (in ticks)
 972  * @offload_features: net_device feature flags for protocol offload
 973  *      features implemented in hardware
 974  */
 975 struct efx_nic_type {
 976         int (*probe)(struct efx_nic *efx);
 977         void (*remove)(struct efx_nic *efx);
 978         int (*init)(struct efx_nic *efx);
 979         void (*dimension_resources)(struct efx_nic *efx);
 980         void (*fini)(struct efx_nic *efx);
 981         void (*monitor)(struct efx_nic *efx);
 982         enum reset_type (*map_reset_reason)(enum reset_type reason);
 983         int (*map_reset_flags)(u32 *flags);
 984         int (*reset)(struct efx_nic *efx, enum reset_type method);
 985         int (*probe_port)(struct efx_nic *efx);
 986         void (*remove_port)(struct efx_nic *efx);
 987         bool (*handle_global_event)(struct efx_channel *channel, efx_qword_t *);
 988         void (*prepare_flush)(struct efx_nic *efx);
 989         void (*finish_flush)(struct efx_nic *efx);
 990         void (*update_stats)(struct efx_nic *efx);
 991         void (*start_stats)(struct efx_nic *efx);
 992         void (*stop_stats)(struct efx_nic *efx);
 993         void (*set_id_led)(struct efx_nic *efx, enum efx_led_mode mode);
 994         void (*push_irq_moderation)(struct efx_channel *channel);
 995         int (*reconfigure_port)(struct efx_nic *efx);
 996         int (*reconfigure_mac)(struct efx_nic *efx);
 997         bool (*check_mac_fault)(struct efx_nic *efx);
 998         void (*get_wol)(struct efx_nic *efx, struct ethtool_wolinfo *wol);
 999         int (*set_wol)(struct efx_nic *efx, u32 type);
1000         void (*resume_wol)(struct efx_nic *efx);
1001         int (*test_chip)(struct efx_nic *efx, struct efx_self_tests *tests);
1002         int (*test_nvram)(struct efx_nic *efx);
1003
1004         int revision;
1005         unsigned int mem_map_size;
1006         unsigned int txd_ptr_tbl_base;
1007         unsigned int rxd_ptr_tbl_base;
1008         unsigned int buf_tbl_base;
1009         unsigned int evq_ptr_tbl_base;
1010         unsigned int evq_rptr_tbl_base;
1011         u64 max_dma_mask;
1012         unsigned int rx_buffer_hash_size;
1013         unsigned int rx_buffer_padding;
1014         bool can_rx_scatter;
1015         unsigned int max_interrupt_mode;
1016         unsigned int phys_addr_channels;
1017         unsigned int timer_period_max;
1018         netdev_features_t offload_features;
1019 };
1020
1021 /**************************************************************************
1022  *
1023  * Prototypes and inline functions
1024  *
1025  *************************************************************************/
1026
1027 static inline struct efx_channel *
1028 efx_get_channel(struct efx_nic *efx, unsigned index)
1029 {
1030         EFX_BUG_ON_PARANOID(index >= efx->n_channels);
1031         return efx->channel[index];
1032 }
1033
1034 /* Iterate over all used channels */
1035 #define efx_for_each_channel(_channel, _efx)                            \
1036         for (_channel = (_efx)->channel[0];                             \
1037              _channel;                                                  \
1038              _channel = (_channel->channel + 1 < (_efx)->n_channels) ?  \
1039                      (_efx)->channel[_channel->channel + 1] : NULL)
1040
1041 /* Iterate over all used channels in reverse */
1042 #define efx_for_each_channel_rev(_channel, _efx)                        \
1043         for (_channel = (_efx)->channel[(_efx)->n_channels - 1];        \
1044              _channel;                                                  \
1045              _channel = _channel->channel ?                             \
1046                      (_efx)->channel[_channel->channel - 1] : NULL)
1047
1048 static inline struct efx_tx_queue *
1049 efx_get_tx_queue(struct efx_nic *efx, unsigned index, unsigned type)
1050 {
1051         EFX_BUG_ON_PARANOID(index >= efx->n_tx_channels ||
1052                             type >= EFX_TXQ_TYPES);
1053         return &efx->channel[efx->tx_channel_offset + index]->tx_queue[type];
1054 }
1055
1056 static inline bool efx_channel_has_tx_queues(struct efx_channel *channel)
1057 {
1058         return channel->channel - channel->efx->tx_channel_offset <
1059                 channel->efx->n_tx_channels;
1060 }
1061
1062 static inline struct efx_tx_queue *
1063 efx_channel_get_tx_queue(struct efx_channel *channel, unsigned type)
1064 {
1065         EFX_BUG_ON_PARANOID(!efx_channel_has_tx_queues(channel) ||
1066                             type >= EFX_TXQ_TYPES);
1067         return &channel->tx_queue[type];
1068 }
1069
1070 static inline bool efx_tx_queue_used(struct efx_tx_queue *tx_queue)
1071 {
1072         return !(tx_queue->efx->net_dev->num_tc < 2 &&
1073                  tx_queue->queue & EFX_TXQ_TYPE_HIGHPRI);
1074 }
1075
1076 /* Iterate over all TX queues belonging to a channel */
1077 #define efx_for_each_channel_tx_queue(_tx_queue, _channel)              \
1078         if (!efx_channel_has_tx_queues(_channel))                       \
1079                 ;                                                       \
1080         else                                                            \
1081                 for (_tx_queue = (_channel)->tx_queue;                  \
1082                      _tx_queue < (_channel)->tx_queue + EFX_TXQ_TYPES && \
1083                              efx_tx_queue_used(_tx_queue);              \
1084                      _tx_queue++)
1085
1086 /* Iterate over all possible TX queues belonging to a channel */
1087 #define efx_for_each_possible_channel_tx_queue(_tx_queue, _channel)     \
1088         if (!efx_channel_has_tx_queues(_channel))                       \
1089                 ;                                                       \
1090         else                                                            \
1091                 for (_tx_queue = (_channel)->tx_queue;                  \
1092                      _tx_queue < (_channel)->tx_queue + EFX_TXQ_TYPES;  \
1093                      _tx_queue++)
1094
1095 static inline bool efx_channel_has_rx_queue(struct efx_channel *channel)
1096 {
1097         return channel->rx_queue.core_index >= 0;
1098 }
1099
1100 static inline struct efx_rx_queue *
1101 efx_channel_get_rx_queue(struct efx_channel *channel)
1102 {
1103         EFX_BUG_ON_PARANOID(!efx_channel_has_rx_queue(channel));
1104         return &channel->rx_queue;
1105 }
1106
1107 /* Iterate over all RX queues belonging to a channel */
1108 #define efx_for_each_channel_rx_queue(_rx_queue, _channel)              \
1109         if (!efx_channel_has_rx_queue(_channel))                        \
1110                 ;                                                       \
1111         else                                                            \
1112                 for (_rx_queue = &(_channel)->rx_queue;                 \
1113                      _rx_queue;                                         \
1114                      _rx_queue = NULL)
1115
1116 static inline struct efx_channel *
1117 efx_rx_queue_channel(struct efx_rx_queue *rx_queue)
1118 {
1119         return container_of(rx_queue, struct efx_channel, rx_queue);
1120 }
1121
1122 static inline int efx_rx_queue_index(struct efx_rx_queue *rx_queue)
1123 {
1124         return efx_rx_queue_channel(rx_queue)->channel;
1125 }
1126
1127 /* Returns a pointer to the specified receive buffer in the RX
1128  * descriptor queue.
1129  */
1130 static inline struct efx_rx_buffer *efx_rx_buffer(struct efx_rx_queue *rx_queue,
1131                                                   unsigned int index)
1132 {
1133         return &rx_queue->buffer[index];
1134 }
1135
1136
1137 /**
1138  * EFX_MAX_FRAME_LEN - calculate maximum frame length
1139  *
1140  * This calculates the maximum frame length that will be used for a
1141  * given MTU.  The frame length will be equal to the MTU plus a
1142  * constant amount of header space and padding.  This is the quantity
1143  * that the net driver will program into the MAC as the maximum frame
1144  * length.
1145  *
1146  * The 10G MAC requires 8-byte alignment on the frame
1147  * length, so we round up to the nearest 8.
1148  *
1149  * Re-clocking by the XGXS on RX can reduce an IPG to 32 bits (half an
1150  * XGMII cycle).  If the frame length reaches the maximum value in the
1151  * same cycle, the XMAC can miss the IPG altogether.  We work around
1152  * this by adding a further 16 bytes.
1153  */
1154 #define EFX_MAX_FRAME_LEN(mtu) \
1155         ((((mtu) + ETH_HLEN + VLAN_HLEN + 4/* FCS */ + 7) & ~7) + 16)
1156
1157 static inline bool efx_xmit_with_hwtstamp(struct sk_buff *skb)
1158 {
1159         return skb_shinfo(skb)->tx_flags & SKBTX_HW_TSTAMP;
1160 }
1161 static inline void efx_xmit_hwtstamp_pending(struct sk_buff *skb)
1162 {
1163         skb_shinfo(skb)->tx_flags |= SKBTX_IN_PROGRESS;
1164 }
1165
1166 #endif /* EFX_NET_DRIVER_H */