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