drivers/net/sfc/net_driver.h

   1 /****************************************************************************
   2  * Driver for Solarflare Solarstorm network controllers and boards
   3  * Copyright 2005-2006 Fen Systems Ltd.
   4  * Copyright 2005-2009 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 #if defined(EFX_ENABLE_DEBUG) && !defined(DEBUG)
  17 #define DEBUG
  18 #endif
  19
  20 #include <linux/version.h>
  21 #include <linux/netdevice.h>
  22 #include <linux/etherdevice.h>
  23 #include <linux/ethtool.h>
  24 #include <linux/if_vlan.h>
  25 #include <linux/timer.h>
  26 #include <linux/mdio.h>
  27 #include <linux/list.h>
  28 #include <linux/pci.h>
  29 #include <linux/device.h>
  30 #include <linux/highmem.h>
  31 #include <linux/workqueue.h>
  32 #include <linux/vmalloc.h>
  33 #include <linux/i2c.h>
  34
  35 #include "enum.h"
  36 #include "bitfield.h"
  37
  38 /**************************************************************************
  39  *
  40  * Build definitions
  41  *
  42  **************************************************************************/
  43
  44 #define EFX_DRIVER_VERSION      "3.0"
  45
  46 #ifdef EFX_ENABLE_DEBUG
  47 #define EFX_BUG_ON_PARANOID(x) BUG_ON(x)
  48 #define EFX_WARN_ON_PARANOID(x) WARN_ON(x)
  49 #else
  50 #define EFX_BUG_ON_PARANOID(x) do {} while (0)
  51 #define EFX_WARN_ON_PARANOID(x) do {} while (0)
  52 #endif
  53
  54 /**************************************************************************
  55  *
  56  * Efx data structures
  57  *
  58  **************************************************************************/
  59
  60 #define EFX_MAX_CHANNELS 32
  61 #define EFX_MAX_RX_QUEUES EFX_MAX_CHANNELS
  62
  63 /* Checksum generation is a per-queue option in hardware, so each
  64  * queue visible to the networking core is backed by two hardware TX
  65  * queues. */
  66 #define EFX_MAX_CORE_TX_QUEUES  EFX_MAX_CHANNELS
  67 #define EFX_TXQ_TYPE_OFFLOAD    1
  68 #define EFX_TXQ_TYPES           2
  69 #define EFX_MAX_TX_QUEUES       (EFX_TXQ_TYPES * EFX_MAX_CORE_TX_QUEUES)
  70
  71 /**
  72  * struct efx_special_buffer - An Efx special buffer
  73  * @addr: CPU base address of the buffer
  74  * @dma_addr: DMA base address of the buffer
  75  * @len: Buffer length, in bytes
  76  * @index: Buffer index within controller;s buffer table
  77  * @entries: Number of buffer table entries
  78  *
  79  * Special buffers are used for the event queues and the TX and RX
  80  * descriptor queues for each channel.  They are *not* used for the
  81  * actual transmit and receive buffers.
  82  */
  83 struct efx_special_buffer {
  84         void *addr;
  85         dma_addr_t dma_addr;
  86         unsigned int len;
  87         int index;
  88         int entries;
  89 };
  90
  91 enum efx_flush_state {
  92         FLUSH_NONE,
  93         FLUSH_PENDING,
  94         FLUSH_FAILED,
  95         FLUSH_DONE,
  96 };
  97
  98 /**
  99  * struct efx_tx_buffer - An Efx TX buffer
 100  * @skb: The associated socket buffer.
 101  *      Set only on the final fragment of a packet; %NULL for all other
 102  *      fragments.  When this fragment completes, then we can free this
 103  *      skb.
 104  * @tsoh: The associated TSO header structure, or %NULL if this
 105  *      buffer is not a TSO header.
 106  * @dma_addr: DMA address of the fragment.
 107  * @len: Length of this fragment.
 108  *      This field is zero when the queue slot is empty.
 109  * @continuation: True if this fragment is not the end of a packet.
 110  * @unmap_single: True if pci_unmap_single should be used.
 111  * @unmap_len: Length of this fragment to unmap
 112  */
 113 struct efx_tx_buffer {
 114         const struct sk_buff *skb;
 115         struct efx_tso_header *tsoh;
 116         dma_addr_t dma_addr;
 117         unsigned short len;
 118         bool continuation;
 119         bool unmap_single;
 120         unsigned short unmap_len;
 121 };
 122
 123 /**
 124  * struct efx_tx_queue - An Efx TX queue
 125  *
 126  * This is a ring buffer of TX fragments.
 127  * Since the TX completion path always executes on the same
 128  * CPU and the xmit path can operate on different CPUs,
 129  * performance is increased by ensuring that the completion
 130  * path and the xmit path operate on different cache lines.
 131  * This is particularly important if the xmit path is always
 132  * executing on one CPU which is different from the completion
 133  * path.  There is also a cache line for members which are
 134  * read but not written on the fast path.
 135  *
 136  * @efx: The associated Efx NIC
 137  * @queue: DMA queue number
 138  * @channel: The associated channel
 139  * @core_txq: The networking core TX queue structure
 140  * @buffer: The software buffer ring
 141  * @txd: The hardware descriptor ring
 142  * @ptr_mask: The size of the ring minus 1.
 143  * @flushed: Used when handling queue flushing
 144  * @read_count: Current read pointer.
 145  *      This is the number of buffers that have been removed from both rings.
 146  * @old_write_count: The value of @write_count when last checked.
 147  *      This is here for performance reasons.  The xmit path will
 148  *      only get the up-to-date value of @write_count if this
 149  *      variable indicates that the queue is empty.  This is to
 150  *      avoid cache-line ping-pong between the xmit path and the
 151  *      completion path.
 152  * @insert_count: Current insert pointer
 153  *      This is the number of buffers that have been added to the
 154  *      software ring.
 155  * @write_count: Current write pointer
 156  *      This is the number of buffers that have been added to the
 157  *      hardware ring.
 158  * @old_read_count: The value of read_count when last checked.
 159  *      This is here for performance reasons.  The xmit path will
 160  *      only get the up-to-date value of read_count if this
 161  *      variable indicates that the queue is full.  This is to
 162  *      avoid cache-line ping-pong between the xmit path and the
 163  *      completion path.
 164  * @tso_headers_free: A list of TSO headers allocated for this TX queue
 165  *      that are not in use, and so available for new TSO sends. The list
 166  *      is protected by the TX queue lock.
 167  * @tso_bursts: Number of times TSO xmit invoked by kernel
 168  * @tso_long_headers: Number of packets with headers too long for standard
 169  *      blocks
 170  * @tso_packets: Number of packets via the TSO xmit path
 171  * @pushes: Number of times the TX push feature has been used
 172  * @empty_read_count: If the completion path has seen the queue as empty
 173  *      and the transmission path has not yet checked this, the value of
 174  *      @read_count bitwise-added to %EFX_EMPTY_COUNT_VALID; otherwise 0.
 175  */
 176 struct efx_tx_queue {
 177         /* Members which don't change on the fast path */
 178         struct efx_nic *efx ____cacheline_aligned_in_smp;
 179         unsigned queue;
 180         struct efx_channel *channel;
 181         struct netdev_queue *core_txq;
 182         struct efx_tx_buffer *buffer;
 183         struct efx_special_buffer txd;
 184         unsigned int ptr_mask;
 185         enum efx_flush_state flushed;
 186
 187         /* Members used mainly on the completion path */
 188         unsigned int read_count ____cacheline_aligned_in_smp;
 189         unsigned int old_write_count;
 190
 191         /* Members used only on the xmit path */
 192         unsigned int insert_count ____cacheline_aligned_in_smp;
 193         unsigned int write_count;
 194         unsigned int old_read_count;
 195         struct efx_tso_header *tso_headers_free;
 196         unsigned int tso_bursts;
 197         unsigned int tso_long_headers;
 198         unsigned int tso_packets;
 199         unsigned int pushes;
 200
 201         /* Members shared between paths and sometimes updated */
 202         unsigned int empty_read_count ____cacheline_aligned_in_smp;
 203 #define EFX_EMPTY_COUNT_VALID 0x80000000
 204 };
 205
 206 /**
 207  * struct efx_rx_buffer - An Efx RX data buffer
 208  * @dma_addr: DMA base address of the buffer
 209  * @skb: The associated socket buffer, if any.
 210  *      If both this and page are %NULL, the buffer slot is currently free.
 211  * @page: The associated page buffer, if any.
 212  *      If both this and skb are %NULL, the buffer slot is currently free.
 213  * @data: Pointer to ethernet header
 214  * @len: Buffer length, in bytes.
 215  */
 216 struct efx_rx_buffer {
 217         dma_addr_t dma_addr;
 218         struct sk_buff *skb;
 219         struct page *page;
 220         char *data;
 221         unsigned int len;
 222 };
 223
 224 /**
 225  * struct efx_rx_page_state - Page-based rx buffer state
 226  *
 227  * Inserted at the start of every page allocated for receive buffers.
 228  * Used to facilitate sharing dma mappings between recycled rx buffers
 229  * and those passed up to the kernel.
 230  *
 231  * @refcnt: Number of struct efx_rx_buffer's referencing this page.
 232  *      When refcnt falls to zero, the page is unmapped for dma
 233  * @dma_addr: The dma address of this page.
 234  */
 235 struct efx_rx_page_state {
 236         unsigned refcnt;
 237         dma_addr_t dma_addr;
 238
 239         unsigned int __pad[0] ____cacheline_aligned;
 240 };
 241
 242 /**
 243  * struct efx_rx_queue - An Efx RX queue
 244  * @efx: The associated Efx NIC
 245  * @buffer: The software buffer ring
 246  * @rxd: The hardware descriptor ring
 247  * @ptr_mask: The size of the ring minus 1.
 248  * @added_count: Number of buffers added to the receive queue.
 249  * @notified_count: Number of buffers given to NIC (<= @added_count).
 250  * @removed_count: Number of buffers removed from the receive queue.
 251  * @max_fill: RX descriptor maximum fill level (<= ring size)
 252  * @fast_fill_trigger: RX descriptor fill level that will trigger a fast fill
 253  *      (<= @max_fill)
 254  * @fast_fill_limit: The level to which a fast fill will fill
 255  *      (@fast_fill_trigger <= @fast_fill_limit <= @max_fill)
 256  * @min_fill: RX descriptor minimum non-zero fill level.
 257  *      This records the minimum fill level observed when a ring
 258  *      refill was triggered.
 259  * @alloc_page_count: RX allocation strategy counter.
 260  * @alloc_skb_count: RX allocation strategy counter.
 261  * @slow_fill: Timer used to defer efx_nic_generate_fill_event().
 262  * @flushed: Use when handling queue flushing
 263  */
 264 struct efx_rx_queue {
 265         struct efx_nic *efx;
 266         struct efx_rx_buffer *buffer;
 267         struct efx_special_buffer rxd;
 268         unsigned int ptr_mask;
 269
 270         int added_count;
 271         int notified_count;
 272         int removed_count;
 273         unsigned int max_fill;
 274         unsigned int fast_fill_trigger;
 275         unsigned int fast_fill_limit;
 276         unsigned int min_fill;
 277         unsigned int min_overfill;
 278         unsigned int alloc_page_count;
 279         unsigned int alloc_skb_count;
 280         struct timer_list slow_fill;
 281         unsigned int slow_fill_count;
 282
 283         enum efx_flush_state flushed;
 284 };
 285
 286 /**
 287  * struct efx_buffer - An Efx general-purpose buffer
 288  * @addr: host base address of the buffer
 289  * @dma_addr: DMA base address of the buffer
 290  * @len: Buffer length, in bytes
 291  *
 292  * The NIC uses these buffers for its interrupt status registers and
 293  * MAC stats dumps.
 294  */
 295 struct efx_buffer {
 296         void *addr;
 297         dma_addr_t dma_addr;
 298         unsigned int len;
 299 };
 300
 301
 302 enum efx_rx_alloc_method {
 303         RX_ALLOC_METHOD_AUTO = 0,
 304         RX_ALLOC_METHOD_SKB = 1,
 305         RX_ALLOC_METHOD_PAGE = 2,
 306 };
 307
 308 /**
 309  * struct efx_channel - An Efx channel
 310  *
 311  * A channel comprises an event queue, at least one TX queue, at least
 312  * one RX queue, and an associated tasklet for processing the event
 313  * queue.
 314  *
 315  * @efx: Associated Efx NIC
 316  * @channel: Channel instance number
 317  * @enabled: Channel enabled indicator
 318  * @irq: IRQ number (MSI and MSI-X only)
 319  * @irq_moderation: IRQ moderation value (in hardware ticks)
 320  * @napi_dev: Net device used with NAPI
 321  * @napi_str: NAPI control structure
 322  * @work_pending: Is work pending via NAPI?
 323  * @eventq: Event queue buffer
 324  * @eventq_mask: Event queue pointer mask
 325  * @eventq_read_ptr: Event queue read pointer
 326  * @last_eventq_read_ptr: Last event queue read pointer value.
 327  * @magic_count: Event queue test event count
 328  * @irq_count: Number of IRQs since last adaptive moderation decision
 329  * @irq_mod_score: IRQ moderation score
 330  * @rx_alloc_level: Watermark based heuristic counter for pushing descriptors
 331  *      and diagnostic counters
 332  * @rx_alloc_push_pages: RX allocation method currently in use for pushing
 333  *      descriptors
 334  * @n_rx_tobe_disc: Count of RX_TOBE_DISC errors
 335  * @n_rx_ip_hdr_chksum_err: Count of RX IP header checksum errors
 336  * @n_rx_tcp_udp_chksum_err: Count of RX TCP and UDP checksum errors
 337  * @n_rx_mcast_mismatch: Count of unmatched multicast frames
 338  * @n_rx_frm_trunc: Count of RX_FRM_TRUNC errors
 339  * @n_rx_overlength: Count of RX_OVERLENGTH errors
 340  * @n_skbuff_leaks: Count of skbuffs leaked due to RX overrun
 341  * @rx_queue: RX queue for this channel
 342  * @tx_queue: TX queues for this channel
 343  */
 344 struct efx_channel {
 345         struct efx_nic *efx;
 346         int channel;
 347         bool enabled;
 348         int irq;
 349         unsigned int irq_moderation;
 350         struct net_device *napi_dev;
 351         struct napi_struct napi_str;
 352         bool work_pending;
 353         struct efx_special_buffer eventq;
 354         unsigned int eventq_mask;
 355         unsigned int eventq_read_ptr;
 356         unsigned int last_eventq_read_ptr;
 357         unsigned int magic_count;
 358
 359         unsigned int irq_count;
 360         unsigned int irq_mod_score;
 361
 362         int rx_alloc_level;
 363         int rx_alloc_push_pages;
 364
 365         unsigned n_rx_tobe_disc;
 366         unsigned n_rx_ip_hdr_chksum_err;
 367         unsigned n_rx_tcp_udp_chksum_err;
 368         unsigned n_rx_mcast_mismatch;
 369         unsigned n_rx_frm_trunc;
 370         unsigned n_rx_overlength;
 371         unsigned n_skbuff_leaks;
 372
 373         /* Used to pipeline received packets in order to optimise memory
 374          * access with prefetches.
 375          */
 376         struct efx_rx_buffer *rx_pkt;
 377         bool rx_pkt_csummed;
 378
 379         struct efx_rx_queue rx_queue;
 380         struct efx_tx_queue tx_queue[2];
 381 };
 382
 383 enum efx_led_mode {
 384         EFX_LED_OFF     = 0,
 385         EFX_LED_ON      = 1,
 386         EFX_LED_DEFAULT = 2
 387 };
 388
 389 #define STRING_TABLE_LOOKUP(val, member) \
 390         ((val) < member ## _max) ? member ## _names[val] : "(invalid)"
 391
 392 extern const char *efx_loopback_mode_names[];
 393 extern const unsigned int efx_loopback_mode_max;
 394 #define LOOPBACK_MODE(efx) \
 395         STRING_TABLE_LOOKUP((efx)->loopback_mode, efx_loopback_mode)
 396
 397 extern const char *efx_reset_type_names[];
 398 extern const unsigned int efx_reset_type_max;
 399 #define RESET_TYPE(type) \
 400         STRING_TABLE_LOOKUP(type, efx_reset_type)
 401
 402 enum efx_int_mode {
 403         /* Be careful if altering to correct macro below */
 404         EFX_INT_MODE_MSIX = 0,
 405         EFX_INT_MODE_MSI = 1,
 406         EFX_INT_MODE_LEGACY = 2,
 407         EFX_INT_MODE_MAX        /* Insert any new items before this */
 408 };
 409 #define EFX_INT_MODE_USE_MSI(x) (((x)->interrupt_mode) <= EFX_INT_MODE_MSI)
 410
 411 enum nic_state {
 412         STATE_INIT = 0,
 413         STATE_RUNNING = 1,
 414         STATE_FINI = 2,
 415         STATE_DISABLED = 3,
 416         STATE_MAX,
 417 };
 418
 419 /*
 420  * Alignment of page-allocated RX buffers
 421  *
 422  * Controls the number of bytes inserted at the start of an RX buffer.
 423  * This is the equivalent of NET_IP_ALIGN [which controls the alignment
 424  * of the skb->head for hardware DMA].
 425  */
 426 #ifdef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
 427 #define EFX_PAGE_IP_ALIGN 0
 428 #else
 429 #define EFX_PAGE_IP_ALIGN NET_IP_ALIGN
 430 #endif
 431
 432 /*
 433  * Alignment of the skb->head which wraps a page-allocated RX buffer
 434  *
 435  * The skb allocated to wrap an rx_buffer can have this alignment. Since
 436  * the data is memcpy'd from the rx_buf, it does not need to be equal to
 437  * EFX_PAGE_IP_ALIGN.
 438  */
 439 #define EFX_PAGE_SKB_ALIGN 2
 440
 441 /* Forward declaration */
 442 struct efx_nic;
 443
 444 /* Pseudo bit-mask flow control field */
 445 enum efx_fc_type {
 446         EFX_FC_RX = FLOW_CTRL_RX,
 447         EFX_FC_TX = FLOW_CTRL_TX,
 448         EFX_FC_AUTO = 4,
 449 };
 450
 451 /**
 452  * struct efx_link_state - Current state of the link
 453  * @up: Link is up
 454  * @fd: Link is full-duplex
 455  * @fc: Actual flow control flags
 456  * @speed: Link speed (Mbps)
 457  */
 458 struct efx_link_state {
 459         bool up;
 460         bool fd;
 461         enum efx_fc_type fc;
 462         unsigned int speed;
 463 };
 464
 465 static inline bool efx_link_state_equal(const struct efx_link_state *left,
 466                                         const struct efx_link_state *right)
 467 {
 468         return left->up == right->up && left->fd == right->fd &&
 469                 left->fc == right->fc && left->speed == right->speed;
 470 }
 471
 472 /**
 473  * struct efx_mac_operations - Efx MAC operations table
 474  * @reconfigure: Reconfigure MAC. Serialised by the mac_lock
 475  * @update_stats: Update statistics
 476  * @check_fault: Check fault state. True if fault present.
 477  */
 478 struct efx_mac_operations {
 479         int (*reconfigure) (struct efx_nic *efx);
 480         void (*update_stats) (struct efx_nic *efx);
 481         bool (*check_fault)(struct efx_nic *efx);
 482 };
 483
 484 /**
 485  * struct efx_phy_operations - Efx PHY operations table
 486  * @probe: Probe PHY and initialise efx->mdio.mode_support, efx->mdio.mmds,
 487  *      efx->loopback_modes.
 488  * @init: Initialise PHY
 489  * @fini: Shut down PHY
 490  * @reconfigure: Reconfigure PHY (e.g. for new link parameters)
 491  * @poll: Update @link_state and report whether it changed.
 492  *      Serialised by the mac_lock.
 493  * @get_settings: Get ethtool settings. Serialised by the mac_lock.
 494  * @set_settings: Set ethtool settings. Serialised by the mac_lock.
 495  * @set_npage_adv: Set abilities advertised in (Extended) Next Page
 496  *      (only needed where AN bit is set in mmds)
 497  * @test_alive: Test that PHY is 'alive' (online)
 498  * @test_name: Get the name of a PHY-specific test/result
 499  * @run_tests: Run tests and record results as appropriate (offline).
 500  *      Flags are the ethtool tests flags.
 501  */
 502 struct efx_phy_operations {
 503         int (*probe) (struct efx_nic *efx);
 504         int (*init) (struct efx_nic *efx);
 505         void (*fini) (struct efx_nic *efx);
 506         void (*remove) (struct efx_nic *efx);
 507         int (*reconfigure) (struct efx_nic *efx);
 508         bool (*poll) (struct efx_nic *efx);
 509         void (*get_settings) (struct efx_nic *efx,
 510                               struct ethtool_cmd *ecmd);
 511         int (*set_settings) (struct efx_nic *efx,
 512                              struct ethtool_cmd *ecmd);
 513         void (*set_npage_adv) (struct efx_nic *efx, u32);
 514         int (*test_alive) (struct efx_nic *efx);
 515         const char *(*test_name) (struct efx_nic *efx, unsigned int index);
 516         int (*run_tests) (struct efx_nic *efx, int *results, unsigned flags);
 517 };
 518
 519 /**
 520  * @enum efx_phy_mode - PHY operating mode flags
 521  * @PHY_MODE_NORMAL: on and should pass traffic
 522  * @PHY_MODE_TX_DISABLED: on with TX disabled
 523  * @PHY_MODE_LOW_POWER: set to low power through MDIO
 524  * @PHY_MODE_OFF: switched off through external control
 525  * @PHY_MODE_SPECIAL: on but will not pass traffic
 526  */
 527 enum efx_phy_mode {
 528         PHY_MODE_NORMAL         = 0,
 529         PHY_MODE_TX_DISABLED    = 1,
 530         PHY_MODE_LOW_POWER      = 2,
 531         PHY_MODE_OFF            = 4,
 532         PHY_MODE_SPECIAL        = 8,
 533 };
 534
 535 static inline bool efx_phy_mode_disabled(enum efx_phy_mode mode)
 536 {
 537         return !!(mode & ~PHY_MODE_TX_DISABLED);
 538 }
 539
 540 /*
 541  * Efx extended statistics
 542  *
 543  * Not all statistics are provided by all supported MACs.  The purpose
 544  * is this structure is to contain the raw statistics provided by each
 545  * MAC.
 546  */
 547 struct efx_mac_stats {
 548         u64 tx_bytes;
 549         u64 tx_good_bytes;
 550         u64 tx_bad_bytes;
 551         unsigned long tx_packets;
 552         unsigned long tx_bad;
 553         unsigned long tx_pause;
 554         unsigned long tx_control;
 555         unsigned long tx_unicast;
 556         unsigned long tx_multicast;
 557         unsigned long tx_broadcast;
 558         unsigned long tx_lt64;
 559         unsigned long tx_64;
 560         unsigned long tx_65_to_127;
 561         unsigned long tx_128_to_255;
 562         unsigned long tx_256_to_511;
 563         unsigned long tx_512_to_1023;
 564         unsigned long tx_1024_to_15xx;
 565         unsigned long tx_15xx_to_jumbo;
 566         unsigned long tx_gtjumbo;
 567         unsigned long tx_collision;
 568         unsigned long tx_single_collision;
 569         unsigned long tx_multiple_collision;
 570         unsigned long tx_excessive_collision;
 571         unsigned long tx_deferred;
 572         unsigned long tx_late_collision;
 573         unsigned long tx_excessive_deferred;
 574         unsigned long tx_non_tcpudp;
 575         unsigned long tx_mac_src_error;
 576         unsigned long tx_ip_src_error;
 577         u64 rx_bytes;
 578         u64 rx_good_bytes;
 579         u64 rx_bad_bytes;
 580         unsigned long rx_packets;
 581         unsigned long rx_good;
 582         unsigned long rx_bad;
 583         unsigned long rx_pause;
 584         unsigned long rx_control;
 585         unsigned long rx_unicast;
 586         unsigned long rx_multicast;
 587         unsigned long rx_broadcast;
 588         unsigned long rx_lt64;
 589         unsigned long rx_64;
 590         unsigned long rx_65_to_127;
 591         unsigned long rx_128_to_255;
 592         unsigned long rx_256_to_511;
 593         unsigned long rx_512_to_1023;
 594         unsigned long rx_1024_to_15xx;
 595         unsigned long rx_15xx_to_jumbo;
 596         unsigned long rx_gtjumbo;
 597         unsigned long rx_bad_lt64;
 598         unsigned long rx_bad_64_to_15xx;
 599         unsigned long rx_bad_15xx_to_jumbo;
 600         unsigned long rx_bad_gtjumbo;
 601         unsigned long rx_overflow;
 602         unsigned long rx_missed;
 603         unsigned long rx_false_carrier;
 604         unsigned long rx_symbol_error;
 605         unsigned long rx_align_error;
 606         unsigned long rx_length_error;
 607         unsigned long rx_internal_error;
 608         unsigned long rx_good_lt64;
 609 };
 610
 611 /* Number of bits used in a multicast filter hash address */
 612 #define EFX_MCAST_HASH_BITS 8
 613
 614 /* Number of (single-bit) entries in a multicast filter hash */
 615 #define EFX_MCAST_HASH_ENTRIES (1 << EFX_MCAST_HASH_BITS)
 616
 617 /* An Efx multicast filter hash */
 618 union efx_multicast_hash {
 619         u8 byte[EFX_MCAST_HASH_ENTRIES / 8];
 620         efx_oword_t oword[EFX_MCAST_HASH_ENTRIES / sizeof(efx_oword_t) / 8];
 621 };
 622
 623 struct efx_filter_state;
 624
 625 /**
 626  * struct efx_nic - an Efx NIC
 627  * @name: Device name (net device name or bus id before net device registered)
 628  * @pci_dev: The PCI device
 629  * @type: Controller type attributes
 630  * @legacy_irq: IRQ number
 631  * @legacy_irq_enabled: Are IRQs enabled on NIC (INT_EN_KER register)?
 632  * @workqueue: Workqueue for port reconfigures and the HW monitor.
 633  *      Work items do not hold and must not acquire RTNL.
 634  * @workqueue_name: Name of workqueue
 635  * @reset_work: Scheduled reset workitem
 636  * @membase_phys: Memory BAR value as physical address
 637  * @membase: Memory BAR value
 638  * @interrupt_mode: Interrupt mode
 639  * @irq_rx_adaptive: Adaptive IRQ moderation enabled for RX event queues
 640  * @irq_rx_moderation: IRQ moderation time for RX event queues
 641  * @msg_enable: Log message enable flags
 642  * @state: Device state flag. Serialised by the rtnl_lock.
 643  * @reset_pending: Pending reset method (normally RESET_TYPE_NONE)
 644  * @tx_queue: TX DMA queues
 645  * @rx_queue: RX DMA queues
 646  * @channel: Channels
 647  * @channel_name: Names for channels and their IRQs
 648  * @rxq_entries: Size of receive queues requested by user.
 649  * @txq_entries: Size of transmit queues requested by user.
 650  * @next_buffer_table: First available buffer table id
 651  * @n_channels: Number of channels in use
 652  * @n_rx_channels: Number of channels used for RX (= number of RX queues)
 653  * @n_tx_channels: Number of channels used for TX
 654  * @rx_buffer_len: RX buffer length
 655  * @rx_buffer_order: Order (log2) of number of pages for each RX buffer
 656  * @rx_hash_key: Toeplitz hash key for RSS
 657  * @rx_indir_table: Indirection table for RSS
 658  * @int_error_count: Number of internal errors seen recently
 659  * @int_error_expire: Time at which error count will be expired
 660  * @irq_status: Interrupt status buffer
 661  * @irq_zero_count: Number of legacy IRQs seen with queue flags == 0
 662  * @fatal_irq_level: IRQ level (bit number) used for serious errors
 663  * @mtd_list: List of MTDs attached to the NIC
 664  * @nic_data: Hardware dependant state
 665  * @mac_lock: MAC access lock. Protects @port_enabled, @phy_mode,
 666  *      @port_inhibited, efx_monitor() and efx_reconfigure_port()
 667  * @port_enabled: Port enabled indicator.
 668  *      Serialises efx_stop_all(), efx_start_all(), efx_monitor() and
 669  *      efx_mac_work() with kernel interfaces. Safe to read under any
 670  *      one of the rtnl_lock, mac_lock, or netif_tx_lock, but all three must
 671  *      be held to modify it.
 672  * @port_inhibited: If set, the netif_carrier is always off. Hold the mac_lock
 673  * @port_initialized: Port initialized?
 674  * @net_dev: Operating system network device. Consider holding the rtnl lock
 675  * @rx_checksum_enabled: RX checksumming enabled
 676  * @stats_buffer: DMA buffer for statistics
 677  * @mac_op: MAC interface
 678  * @phy_type: PHY type
 679  * @phy_op: PHY interface
 680  * @phy_data: PHY private data (including PHY-specific stats)
 681  * @mdio: PHY MDIO interface
 682  * @mdio_bus: PHY MDIO bus ID (only used by Siena)
 683  * @phy_mode: PHY operating mode. Serialised by @mac_lock.
 684  * @link_advertising: Autonegotiation advertising flags
 685  * @link_state: Current state of the link
 686  * @n_link_state_changes: Number of times the link has changed state
 687  * @promiscuous: Promiscuous flag. Protected by netif_tx_lock.
 688  * @multicast_hash: Multicast hash table
 689  * @wanted_fc: Wanted flow control flags
 690  * @mac_work: Work item for changing MAC promiscuity and multicast hash
 691  * @loopback_mode: Loopback status
 692  * @loopback_modes: Supported loopback mode bitmask
 693  * @loopback_selftest: Offline self-test private state
 694  * @monitor_work: Hardware monitor workitem
 695  * @biu_lock: BIU (bus interface unit) lock
 696  * @last_irq_cpu: Last CPU to handle interrupt.
 697  *      This register is written with the SMP processor ID whenever an
 698  *      interrupt is handled.  It is used by efx_nic_test_interrupt()
 699  *      to verify that an interrupt has occurred.
 700  * @n_rx_nodesc_drop_cnt: RX no descriptor drop count
 701  * @mac_stats: MAC statistics. These include all statistics the MACs
 702  *      can provide.  Generic code converts these into a standard
 703  *      &struct net_device_stats.
 704  * @stats_lock: Statistics update lock. Serialises statistics fetches
 705  *
 706  * This is stored in the private area of the &struct net_device.
 707  */
 708 struct efx_nic {
 709         /* The following fields should be written very rarely */
 710
 711         char name[IFNAMSIZ];
 712         struct pci_dev *pci_dev;
 713         const struct efx_nic_type *type;
 714         int legacy_irq;
 715         bool legacy_irq_enabled;
 716         struct workqueue_struct *workqueue;
 717         char workqueue_name[16];
 718         struct work_struct reset_work;
 719         resource_size_t membase_phys;
 720         void __iomem *membase;
 721
 722         enum efx_int_mode interrupt_mode;
 723         bool irq_rx_adaptive;
 724         unsigned int irq_rx_moderation;
 725         u32 msg_enable;
 726
 727         enum nic_state state;
 728         enum reset_type reset_pending;
 729
 730         struct efx_channel *channel[EFX_MAX_CHANNELS];
 731         char channel_name[EFX_MAX_CHANNELS][IFNAMSIZ + 6];
 732
 733         unsigned rxq_entries;
 734         unsigned txq_entries;
 735         unsigned next_buffer_table;
 736         unsigned n_channels;
 737         unsigned n_rx_channels;
 738         unsigned n_tx_channels;
 739         unsigned int rx_buffer_len;
 740         unsigned int rx_buffer_order;
 741         u8 rx_hash_key[40];
 742         u32 rx_indir_table[128];
 743
 744         unsigned int_error_count;
 745         unsigned long int_error_expire;
 746
 747         struct efx_buffer irq_status;
 748         unsigned irq_zero_count;
 749         unsigned fatal_irq_level;
 750
 751 #ifdef CONFIG_SFC_MTD
 752         struct list_head mtd_list;
 753 #endif
 754
 755         void *nic_data;
 756
 757         struct mutex mac_lock;
 758         struct work_struct mac_work;
 759         bool port_enabled;
 760         bool port_inhibited;
 761
 762         bool port_initialized;
 763         struct net_device *net_dev;
 764         bool rx_checksum_enabled;
 765
 766         struct efx_buffer stats_buffer;
 767
 768         struct efx_mac_operations *mac_op;
 769
 770         unsigned int phy_type;
 771         struct efx_phy_operations *phy_op;
 772         void *phy_data;
 773         struct mdio_if_info mdio;
 774         unsigned int mdio_bus;
 775         enum efx_phy_mode phy_mode;
 776
 777         u32 link_advertising;
 778         struct efx_link_state link_state;
 779         unsigned int n_link_state_changes;
 780
 781         bool promiscuous;
 782         union efx_multicast_hash multicast_hash;
 783         enum efx_fc_type wanted_fc;
 784
 785         atomic_t rx_reset;
 786         enum efx_loopback_mode loopback_mode;
 787         u64 loopback_modes;
 788
 789         void *loopback_selftest;
 790
 791         struct efx_filter_state *filter_state;
 792
 793         /* The following fields may be written more often */
 794
 795         struct delayed_work monitor_work ____cacheline_aligned_in_smp;
 796         spinlock_t biu_lock;
 797         volatile signed int last_irq_cpu;
 798         unsigned n_rx_nodesc_drop_cnt;
 799         struct efx_mac_stats mac_stats;
 800         spinlock_t stats_lock;
 801 };
 802
 803 static inline int efx_dev_registered(struct efx_nic *efx)
 804 {
 805         return efx->net_dev->reg_state == NETREG_REGISTERED;
 806 }
 807
 808 /* Net device name, for inclusion in log messages if it has been registered.
 809  * Use efx->name not efx->net_dev->name so that races with (un)registration
 810  * are harmless.
 811  */
 812 static inline const char *efx_dev_name(struct efx_nic *efx)
 813 {
 814         return efx_dev_registered(efx) ? efx->name : "";
 815 }
 816
 817 static inline unsigned int efx_port_num(struct efx_nic *efx)
 818 {
 819         return efx->net_dev->dev_id;
 820 }
 821
 822 /**
 823  * struct efx_nic_type - Efx device type definition
 824  * @probe: Probe the controller
 825  * @remove: Free resources allocated by probe()
 826  * @init: Initialise the controller
 827  * @fini: Shut down the controller
 828  * @monitor: Periodic function for polling link state and hardware monitor
 829  * @reset: Reset the controller hardware and possibly the PHY.  This will
 830  *      be called while the controller is uninitialised.
 831  * @probe_port: Probe the MAC and PHY
 832  * @remove_port: Free resources allocated by probe_port()
 833  * @handle_global_event: Handle a "global" event (may be %NULL)
 834  * @prepare_flush: Prepare the hardware for flushing the DMA queues
 835  * @update_stats: Update statistics not provided by event handling
 836  * @start_stats: Start the regular fetching of statistics
 837  * @stop_stats: Stop the regular fetching of statistics
 838  * @set_id_led: Set state of identifying LED or revert to automatic function
 839  * @push_irq_moderation: Apply interrupt moderation value
 840  * @push_multicast_hash: Apply multicast hash table
 841  * @reconfigure_port: Push loopback/power/txdis changes to the MAC and PHY
 842  * @get_wol: Get WoL configuration from driver state
 843  * @set_wol: Push WoL configuration to the NIC
 844  * @resume_wol: Synchronise WoL state between driver and MC (e.g. after resume)
 845  * @test_registers: Test read/write functionality of control registers
 846  * @test_nvram: Test validity of NVRAM contents
 847  * @default_mac_ops: efx_mac_operations to set at startup
 848  * @revision: Hardware architecture revision
 849  * @mem_map_size: Memory BAR mapped size
 850  * @txd_ptr_tbl_base: TX descriptor ring base address
 851  * @rxd_ptr_tbl_base: RX descriptor ring base address
 852  * @buf_tbl_base: Buffer table base address
 853  * @evq_ptr_tbl_base: Event queue pointer table base address
 854  * @evq_rptr_tbl_base: Event queue read-pointer table base address
 855  * @max_dma_mask: Maximum possible DMA mask
 856  * @rx_buffer_hash_size: Size of hash at start of RX buffer
 857  * @rx_buffer_padding: Size of padding at end of RX buffer
 858  * @max_interrupt_mode: Highest capability interrupt mode supported
 859  *      from &enum efx_init_mode.
 860  * @phys_addr_channels: Number of channels with physically addressed
 861  *      descriptors
 862  * @tx_dc_base: Base address in SRAM of TX queue descriptor caches
 863  * @rx_dc_base: Base address in SRAM of RX queue descriptor caches
 864  * @offload_features: net_device feature flags for protocol offload
 865  *      features implemented in hardware
 866  * @reset_world_flags: Flags for additional components covered by
 867  *      reset method RESET_TYPE_WORLD
 868  */
 869 struct efx_nic_type {
 870         int (*probe)(struct efx_nic *efx);
 871         void (*remove)(struct efx_nic *efx);
 872         int (*init)(struct efx_nic *efx);
 873         void (*fini)(struct efx_nic *efx);
 874         void (*monitor)(struct efx_nic *efx);
 875         int (*reset)(struct efx_nic *efx, enum reset_type method);
 876         int (*probe_port)(struct efx_nic *efx);
 877         void (*remove_port)(struct efx_nic *efx);
 878         bool (*handle_global_event)(struct efx_channel *channel, efx_qword_t *);
 879         void (*prepare_flush)(struct efx_nic *efx);
 880         void (*update_stats)(struct efx_nic *efx);
 881         void (*start_stats)(struct efx_nic *efx);
 882         void (*stop_stats)(struct efx_nic *efx);
 883         void (*set_id_led)(struct efx_nic *efx, enum efx_led_mode mode);
 884         void (*push_irq_moderation)(struct efx_channel *channel);
 885         void (*push_multicast_hash)(struct efx_nic *efx);
 886         int (*reconfigure_port)(struct efx_nic *efx);
 887         void (*get_wol)(struct efx_nic *efx, struct ethtool_wolinfo *wol);
 888         int (*set_wol)(struct efx_nic *efx, u32 type);
 889         void (*resume_wol)(struct efx_nic *efx);
 890         int (*test_registers)(struct efx_nic *efx);
 891         int (*test_nvram)(struct efx_nic *efx);
 892         struct efx_mac_operations *default_mac_ops;
 893
 894         int revision;
 895         unsigned int mem_map_size;
 896         unsigned int txd_ptr_tbl_base;
 897         unsigned int rxd_ptr_tbl_base;
 898         unsigned int buf_tbl_base;
 899         unsigned int evq_ptr_tbl_base;
 900         unsigned int evq_rptr_tbl_base;
 901         u64 max_dma_mask;
 902         unsigned int rx_buffer_hash_size;
 903         unsigned int rx_buffer_padding;
 904         unsigned int max_interrupt_mode;
 905         unsigned int phys_addr_channels;
 906         unsigned int tx_dc_base;
 907         unsigned int rx_dc_base;
 908         unsigned long offload_features;
 909         u32 reset_world_flags;
 910 };
 911
 912 /**************************************************************************
 913  *
 914  * Prototypes and inline functions
 915  *
 916  *************************************************************************/
 917
 918 static inline struct efx_channel *
 919 efx_get_channel(struct efx_nic *efx, unsigned index)
 920 {
 921         EFX_BUG_ON_PARANOID(index >= efx->n_channels);
 922         return efx->channel[index];
 923 }
 924
 925 /* Iterate over all used channels */
 926 #define efx_for_each_channel(_channel, _efx)                            \
 927         for (_channel = (_efx)->channel[0];                             \
 928              _channel;                                                  \
 929              _channel = (_channel->channel + 1 < (_efx)->n_channels) ?  \
 930                      (_efx)->channel[_channel->channel + 1] : NULL)
 931
 932 extern struct efx_tx_queue *
 933 efx_get_tx_queue(struct efx_nic *efx, unsigned index, unsigned type);
 934
 935 static inline struct efx_tx_queue *
 936 efx_channel_get_tx_queue(struct efx_channel *channel, unsigned type)
 937 {
 938         struct efx_tx_queue *tx_queue = channel->tx_queue;
 939         EFX_BUG_ON_PARANOID(type >= EFX_TXQ_TYPES);
 940         return tx_queue->channel ? tx_queue + type : NULL;
 941 }
 942
 943 /* Iterate over all TX queues belonging to a channel */
 944 #define efx_for_each_channel_tx_queue(_tx_queue, _channel)              \
 945         for (_tx_queue = efx_channel_get_tx_queue(channel, 0);          \
 946              _tx_queue && _tx_queue < (_channel)->tx_queue + EFX_TXQ_TYPES; \
 947              _tx_queue++)
 948
 949 static inline struct efx_rx_queue *
 950 efx_get_rx_queue(struct efx_nic *efx, unsigned index)
 951 {
 952         EFX_BUG_ON_PARANOID(index >= efx->n_rx_channels);
 953         return &efx->channel[index]->rx_queue;
 954 }
 955
 956 static inline struct efx_rx_queue *
 957 efx_channel_get_rx_queue(struct efx_channel *channel)
 958 {
 959         return channel->channel < channel->efx->n_rx_channels ?
 960                 &channel->rx_queue : NULL;
 961 }
 962
 963 /* Iterate over all RX queues belonging to a channel */
 964 #define efx_for_each_channel_rx_queue(_rx_queue, _channel)              \
 965         for (_rx_queue = efx_channel_get_rx_queue(channel);             \
 966              _rx_queue;                                                 \
 967              _rx_queue = NULL)
 968
 969 static inline struct efx_channel *
 970 efx_rx_queue_channel(struct efx_rx_queue *rx_queue)
 971 {
 972         return container_of(rx_queue, struct efx_channel, rx_queue);
 973 }
 974
 975 static inline int efx_rx_queue_index(struct efx_rx_queue *rx_queue)
 976 {
 977         return efx_rx_queue_channel(rx_queue)->channel;
 978 }
 979
 980 /* Returns a pointer to the specified receive buffer in the RX
 981  * descriptor queue.
 982  */
 983 static inline struct efx_rx_buffer *efx_rx_buffer(struct efx_rx_queue *rx_queue,
 984                                                   unsigned int index)
 985 {
 986         return &rx_queue->buffer[index];
 987 }
 988
 989 /* Set bit in a little-endian bitfield */
 990 static inline void set_bit_le(unsigned nr, unsigned char *addr)
 991 {
 992         addr[nr / 8] |= (1 << (nr % 8));
 993 }
 994
 995 /* Clear bit in a little-endian bitfield */
 996 static inline void clear_bit_le(unsigned nr, unsigned char *addr)
 997 {
 998         addr[nr / 8] &= ~(1 << (nr % 8));
 999 }
1000
1001
1002 /**
1003  * EFX_MAX_FRAME_LEN - calculate maximum frame length
1004  *
1005  * This calculates the maximum frame length that will be used for a
1006  * given MTU.  The frame length will be equal to the MTU plus a
1007  * constant amount of header space and padding.  This is the quantity
1008  * that the net driver will program into the MAC as the maximum frame
1009  * length.
1010  *
1011  * The 10G MAC requires 8-byte alignment on the frame
1012  * length, so we round up to the nearest 8.
1013  *
1014  * Re-clocking by the XGXS on RX can reduce an IPG to 32 bits (half an
1015  * XGMII cycle).  If the frame length reaches the maximum value in the
1016  * same cycle, the XMAC can miss the IPG altogether.  We work around
1017  * this by adding a further 16 bytes.
1018  */
1019 #define EFX_MAX_FRAME_LEN(mtu) \
1020         ((((mtu) + ETH_HLEN + VLAN_HLEN + 4/* FCS */ + 7) & ~7) + 16)
1021
1022
1023 #endif /* EFX_NET_DRIVER_H */