git.oblomov.eu Git - linux-2.6/blob - 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/mii.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 /**
 117  * struct efx_tx_buffer - An Efx TX buffer
 118  * @skb: The associated socket buffer.
 119  *      Set only on the final fragment of a packet; %NULL for all other
 120  *      fragments.  When this fragment completes, then we can free this
 121  *      skb.
 122  * @tsoh: The associated TSO header structure, or %NULL if this
 123  *      buffer is not a TSO header.
 124  * @dma_addr: DMA address of the fragment.
 125  * @len: Length of this fragment.
 126  *      This field is zero when the queue slot is empty.
 127  * @continuation: True if this fragment is not the end of a packet.
 128  * @unmap_single: True if pci_unmap_single should be used.
 129  * @unmap_len: Length of this fragment to unmap
 130  */
 131 struct efx_tx_buffer {
 132         const struct sk_buff *skb;
 133         struct efx_tso_header *tsoh;
 134         dma_addr_t dma_addr;
 135         unsigned short len;
 136         bool continuation;
 137         bool unmap_single;
 138         unsigned short unmap_len;
 139 };
 140
 141 /**
 142  * struct efx_tx_queue - An Efx TX queue
 143  *
 144  * This is a ring buffer of TX fragments.
 145  * Since the TX completion path always executes on the same
 146  * CPU and the xmit path can operate on different CPUs,
 147  * performance is increased by ensuring that the completion
 148  * path and the xmit path operate on different cache lines.
 149  * This is particularly important if the xmit path is always
 150  * executing on one CPU which is different from the completion
 151  * path.  There is also a cache line for members which are
 152  * read but not written on the fast path.
 153  *
 154  * @efx: The associated Efx NIC
 155  * @queue: DMA queue number
 156  * @channel: The associated channel
 157  * @buffer: The software buffer ring
 158  * @txd: The hardware descriptor ring
 159  * @flushed: Used when handling queue flushing
 160  * @read_count: Current read pointer.
 161  *      This is the number of buffers that have been removed from both rings.
 162  * @stopped: Stopped count.
 163  *      Set if this TX queue is currently stopping its port.
 164  * @insert_count: Current insert pointer
 165  *      This is the number of buffers that have been added to the
 166  *      software ring.
 167  * @write_count: Current write pointer
 168  *      This is the number of buffers that have been added to the
 169  *      hardware ring.
 170  * @old_read_count: The value of read_count when last checked.
 171  *      This is here for performance reasons.  The xmit path will
 172  *      only get the up-to-date value of read_count if this
 173  *      variable indicates that the queue is full.  This is to
 174  *      avoid cache-line ping-pong between the xmit path and the
 175  *      completion path.
 176  * @tso_headers_free: A list of TSO headers allocated for this TX queue
 177  *      that are not in use, and so available for new TSO sends. The list
 178  *      is protected by the TX queue lock.
 179  * @tso_bursts: Number of times TSO xmit invoked by kernel
 180  * @tso_long_headers: Number of packets with headers too long for standard
 181  *      blocks
 182  * @tso_packets: Number of packets via the TSO xmit path
 183  */
 184 struct efx_tx_queue {
 185         /* Members which don't change on the fast path */
 186         struct efx_nic *efx ____cacheline_aligned_in_smp;
 187         int queue;
 188         struct efx_channel *channel;
 189         struct efx_nic *nic;
 190         struct efx_tx_buffer *buffer;
 191         struct efx_special_buffer txd;
 192         bool flushed;
 193
 194         /* Members used mainly on the completion path */
 195         unsigned int read_count ____cacheline_aligned_in_smp;
 196         int stopped;
 197
 198         /* Members used only on the xmit path */
 199         unsigned int insert_count ____cacheline_aligned_in_smp;
 200         unsigned int write_count;
 201         unsigned int old_read_count;
 202         struct efx_tso_header *tso_headers_free;
 203         unsigned int tso_bursts;
 204         unsigned int tso_long_headers;
 205         unsigned int tso_packets;
 206 };
 207
 208 /**
 209  * struct efx_rx_buffer - An Efx RX data buffer
 210  * @dma_addr: DMA base address of the buffer
 211  * @skb: The associated socket buffer, if any.
 212  *      If both this and page are %NULL, the buffer slot is currently free.
 213  * @page: The associated page buffer, if any.
 214  *      If both this and skb are %NULL, the buffer slot is currently free.
 215  * @data: Pointer to ethernet header
 216  * @len: Buffer length, in bytes.
 217  * @unmap_addr: DMA address to unmap
 218  */
 219 struct efx_rx_buffer {
 220         dma_addr_t dma_addr;
 221         struct sk_buff *skb;
 222         struct page *page;
 223         char *data;
 224         unsigned int len;
 225         dma_addr_t unmap_addr;
 226 };
 227
 228 /**
 229  * struct efx_rx_queue - An Efx RX queue
 230  * @efx: The associated Efx NIC
 231  * @queue: DMA queue number
 232  * @channel: The associated channel
 233  * @buffer: The software buffer ring
 234  * @rxd: The hardware descriptor ring
 235  * @added_count: Number of buffers added to the receive queue.
 236  * @notified_count: Number of buffers given to NIC (<= @added_count).
 237  * @removed_count: Number of buffers removed from the receive queue.
 238  * @add_lock: Receive queue descriptor add spin lock.
 239  *      This lock must be held in order to add buffers to the RX
 240  *      descriptor ring (rxd and buffer) and to update added_count (but
 241  *      not removed_count).
 242  * @max_fill: RX descriptor maximum fill level (<= ring size)
 243  * @fast_fill_trigger: RX descriptor fill level that will trigger a fast fill
 244  *      (<= @max_fill)
 245  * @fast_fill_limit: The level to which a fast fill will fill
 246  *      (@fast_fill_trigger <= @fast_fill_limit <= @max_fill)
 247  * @min_fill: RX descriptor minimum non-zero fill level.
 248  *      This records the minimum fill level observed when a ring
 249  *      refill was triggered.
 250  * @min_overfill: RX descriptor minimum overflow fill level.
 251  *      This records the minimum fill level at which RX queue
 252  *      overflow was observed.  It should never be set.
 253  * @alloc_page_count: RX allocation strategy counter.
 254  * @alloc_skb_count: RX allocation strategy counter.
 255  * @work: Descriptor push work thread
 256  * @buf_page: Page for next RX buffer.
 257  *      We can use a single page for multiple RX buffers. This tracks
 258  *      the remaining space in the allocation.
 259  * @buf_dma_addr: Page's DMA address.
 260  * @buf_data: Page's host address.
 261  * @flushed: Use when handling queue flushing
 262  */
 263 struct efx_rx_queue {
 264         struct efx_nic *efx;
 265         int queue;
 266         struct efx_channel *channel;
 267         struct efx_rx_buffer *buffer;
 268         struct efx_special_buffer rxd;
 269
 270         int added_count;
 271         int notified_count;
 272         int removed_count;
 273         spinlock_t add_lock;
 274         unsigned int max_fill;
 275         unsigned int fast_fill_trigger;
 276         unsigned int fast_fill_limit;
 277         unsigned int min_fill;
 278         unsigned int min_overfill;
 279         unsigned int alloc_page_count;
 280         unsigned int alloc_skb_count;
 281         struct delayed_work work;
 282         unsigned int slow_fill_count;
 283
 284         struct page *buf_page;
 285         dma_addr_t buf_dma_addr;
 286         char *buf_data;
 287         bool flushed;
 288 };
 289
 290 /**
 291  * struct efx_buffer - An Efx general-purpose buffer
 292  * @addr: host base address of the buffer
 293  * @dma_addr: DMA base address of the buffer
 294  * @len: Buffer length, in bytes
 295  *
 296  * Falcon uses these buffers for its interrupt status registers and
 297  * MAC stats dumps.
 298  */
 299 struct efx_buffer {
 300         void *addr;
 301         dma_addr_t dma_addr;
 302         unsigned int len;
 303 };
 304
 305
 306 /* Flags for channel->used_flags */
 307 #define EFX_USED_BY_RX 1
 308 #define EFX_USED_BY_TX 2
 309 #define EFX_USED_BY_RX_TX (EFX_USED_BY_RX | EFX_USED_BY_TX)
 310
 311 enum efx_rx_alloc_method {
 312         RX_ALLOC_METHOD_AUTO = 0,
 313         RX_ALLOC_METHOD_SKB = 1,
 314         RX_ALLOC_METHOD_PAGE = 2,
 315 };
 316
 317 /**
 318  * struct efx_channel - An Efx channel
 319  *
 320  * A channel comprises an event queue, at least one TX queue, at least
 321  * one RX queue, and an associated tasklet for processing the event
 322  * queue.
 323  *
 324  * @efx: Associated Efx NIC
 325  * @channel: Channel instance number
 326  * @name: Name for channel and IRQ
 327  * @used_flags: Channel is used by net driver
 328  * @enabled: Channel enabled indicator
 329  * @irq: IRQ number (MSI and MSI-X only)
 330  * @irq_moderation: IRQ moderation value (in us)
 331  * @napi_dev: Net device used with NAPI
 332  * @napi_str: NAPI control structure
 333  * @reset_work: Scheduled reset work thread
 334  * @work_pending: Is work pending via NAPI?
 335  * @eventq: Event queue buffer
 336  * @eventq_read_ptr: Event queue read pointer
 337  * @last_eventq_read_ptr: Last event queue read pointer value.
 338  * @eventq_magic: Event queue magic value for driver-generated test events
 339  * @rx_alloc_level: Watermark based heuristic counter for pushing descriptors
 340  *      and diagnostic counters
 341  * @rx_alloc_push_pages: RX allocation method currently in use for pushing
 342  *      descriptors
 343  * @n_rx_tobe_disc: Count of RX_TOBE_DISC errors
 344  * @n_rx_ip_frag_err: Count of RX IP fragment errors
 345  * @n_rx_ip_hdr_chksum_err: Count of RX IP header checksum errors
 346  * @n_rx_tcp_udp_chksum_err: Count of RX TCP and UDP checksum errors
 347  * @n_rx_frm_trunc: Count of RX_FRM_TRUNC errors
 348  * @n_rx_overlength: Count of RX_OVERLENGTH errors
 349  * @n_skbuff_leaks: Count of skbuffs leaked due to RX overrun
 350  */
 351 struct efx_channel {
 352         struct efx_nic *efx;
 353         int channel;
 354         char name[IFNAMSIZ + 6];
 355         int used_flags;
 356         bool enabled;
 357         int irq;
 358         unsigned int irq_moderation;
 359         struct net_device *napi_dev;
 360         struct napi_struct napi_str;
 361         bool work_pending;
 362         struct efx_special_buffer eventq;
 363         unsigned int eventq_read_ptr;
 364         unsigned int last_eventq_read_ptr;
 365         unsigned int eventq_magic;
 366
 367         int rx_alloc_level;
 368         int rx_alloc_push_pages;
 369
 370         unsigned n_rx_tobe_disc;
 371         unsigned n_rx_ip_frag_err;
 372         unsigned n_rx_ip_hdr_chksum_err;
 373         unsigned n_rx_tcp_udp_chksum_err;
 374         unsigned n_rx_frm_trunc;
 375         unsigned n_rx_overlength;
 376         unsigned n_skbuff_leaks;
 377
 378         /* Used to pipeline received packets in order to optimise memory
 379          * access with prefetches.
 380          */
 381         struct efx_rx_buffer *rx_pkt;
 382         bool rx_pkt_csummed;
 383
 384 };
 385
 386 /**
 387  * struct efx_blinker - S/W LED blinking context
 388  * @led_num: LED ID (board-specific meaning)
 389  * @state: Current state - on or off
 390  * @resubmit: Timer resubmission flag
 391  * @timer: Control timer for blinking
 392  */
 393 struct efx_blinker {
 394         int led_num;
 395         bool state;
 396         bool resubmit;
 397         struct timer_list timer;
 398 };
 399
 400
 401 /**
 402  * struct efx_board - board information
 403  * @type: Board model type
 404  * @major: Major rev. ('A', 'B' ...)
 405  * @minor: Minor rev. (0, 1, ...)
 406  * @init: Initialisation function
 407  * @init_leds: Sets up board LEDs
 408  * @set_fault_led: Turns the fault LED on or off
 409  * @blink: Starts/stops blinking
 410  * @monitor: Board-specific health check function
 411  * @fini: Cleanup function
 412  * @blinker: used to blink LEDs in software
 413  * @hwmon_client: I2C client for hardware monitor
 414  * @ioexp_client: I2C client for power/port control
 415  */
 416 struct efx_board {
 417         int type;
 418         int major;
 419         int minor;
 420         int (*init) (struct efx_nic *nic);
 421         /* As the LEDs are typically attached to the PHY, LEDs
 422          * have a separate init callback that happens later than
 423          * board init. */
 424         int (*init_leds)(struct efx_nic *efx);
 425         int (*monitor) (struct efx_nic *nic);
 426         void (*set_fault_led) (struct efx_nic *efx, bool state);
 427         void (*blink) (struct efx_nic *efx, bool start);
 428         void (*fini) (struct efx_nic *nic);
 429         struct efx_blinker blinker;
 430         struct i2c_client *hwmon_client, *ioexp_client;
 431 };
 432
 433 #define STRING_TABLE_LOOKUP(val, member)        \
 434         member ## _names[val]
 435
 436 enum efx_int_mode {
 437         /* Be careful if altering to correct macro below */
 438         EFX_INT_MODE_MSIX = 0,
 439         EFX_INT_MODE_MSI = 1,
 440         EFX_INT_MODE_LEGACY = 2,
 441         EFX_INT_MODE_MAX        /* Insert any new items before this */
 442 };
 443 #define EFX_INT_MODE_USE_MSI(x) (((x)->interrupt_mode) <= EFX_INT_MODE_MSI)
 444
 445 enum phy_type {
 446         PHY_TYPE_NONE = 0,
 447         PHY_TYPE_TXC43128 = 1,
 448         PHY_TYPE_88E1111 = 2,
 449         PHY_TYPE_SFX7101 = 3,
 450         PHY_TYPE_QT2022C2 = 4,
 451         PHY_TYPE_PM8358 = 6,
 452         PHY_TYPE_SFT9001A = 8,
 453         PHY_TYPE_SFT9001B = 10,
 454         PHY_TYPE_MAX    /* Insert any new items before this */
 455 };
 456
 457 #define PHY_ADDR_INVALID 0xff
 458
 459 #define EFX_IS10G(efx) ((efx)->link_speed == 10000)
 460
 461 enum nic_state {
 462         STATE_INIT = 0,
 463         STATE_RUNNING = 1,
 464         STATE_FINI = 2,
 465         STATE_DISABLED = 3,
 466         STATE_MAX,
 467 };
 468
 469 /*
 470  * Alignment of page-allocated RX buffers
 471  *
 472  * Controls the number of bytes inserted at the start of an RX buffer.
 473  * This is the equivalent of NET_IP_ALIGN [which controls the alignment
 474  * of the skb->head for hardware DMA].
 475  */
 476 #ifdef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
 477 #define EFX_PAGE_IP_ALIGN 0
 478 #else
 479 #define EFX_PAGE_IP_ALIGN NET_IP_ALIGN
 480 #endif
 481
 482 /*
 483  * Alignment of the skb->head which wraps a page-allocated RX buffer
 484  *
 485  * The skb allocated to wrap an rx_buffer can have this alignment. Since
 486  * the data is memcpy'd from the rx_buf, it does not need to be equal to
 487  * EFX_PAGE_IP_ALIGN.
 488  */
 489 #define EFX_PAGE_SKB_ALIGN 2
 490
 491 /* Forward declaration */
 492 struct efx_nic;
 493
 494 /* Pseudo bit-mask flow control field */
 495 enum efx_fc_type {
 496         EFX_FC_RX = 1,
 497         EFX_FC_TX = 2,
 498         EFX_FC_AUTO = 4,
 499 };
 500
 501 /* Supported MAC bit-mask */
 502 enum efx_mac_type {
 503         EFX_GMAC = 1,
 504         EFX_XMAC = 2,
 505 };
 506
 507 static inline unsigned int efx_fc_advertise(enum efx_fc_type wanted_fc)
 508 {
 509         unsigned int adv = 0;
 510         if (wanted_fc & EFX_FC_RX)
 511                 adv = ADVERTISE_PAUSE_CAP | ADVERTISE_PAUSE_ASYM;
 512         if (wanted_fc & EFX_FC_TX)
 513                 adv ^= ADVERTISE_PAUSE_ASYM;
 514         return adv;
 515 }
 516
 517 static inline enum efx_fc_type efx_fc_resolve(enum efx_fc_type wanted_fc,
 518                                               unsigned int lpa)
 519 {
 520         unsigned int adv = efx_fc_advertise(wanted_fc);
 521
 522         if (!(wanted_fc & EFX_FC_AUTO))
 523                 return wanted_fc;
 524
 525         if (adv & lpa & ADVERTISE_PAUSE_CAP)
 526                 return EFX_FC_RX | EFX_FC_TX;
 527         if (adv & lpa & ADVERTISE_PAUSE_ASYM) {
 528                 if (adv & ADVERTISE_PAUSE_CAP)
 529                         return EFX_FC_RX;
 530                 if (lpa & ADVERTISE_PAUSE_CAP)
 531                         return EFX_FC_TX;
 532         }
 533         return 0;
 534 }
 535
 536 /**
 537  * struct efx_mac_operations - Efx MAC operations table
 538  * @reconfigure: Reconfigure MAC. Serialised by the mac_lock
 539  * @update_stats: Update statistics
 540  * @irq: Hardware MAC event callback. Serialised by the mac_lock
 541  * @poll: Poll for hardware state. Serialised by the mac_lock
 542  */
 543 struct efx_mac_operations {
 544         void (*reconfigure) (struct efx_nic *efx);
 545         void (*update_stats) (struct efx_nic *efx);
 546         void (*irq) (struct efx_nic *efx);
 547         void (*poll) (struct efx_nic *efx);
 548 };
 549
 550 /**
 551  * struct efx_phy_operations - Efx PHY operations table
 552  * @init: Initialise PHY
 553  * @fini: Shut down PHY
 554  * @reconfigure: Reconfigure PHY (e.g. for new link parameters)
 555  * @clear_interrupt: Clear down interrupt
 556  * @blink: Blink LEDs
 557  * @poll: Poll for hardware state. Serialised by the mac_lock.
 558  * @get_settings: Get ethtool settings. Serialised by the mac_lock.
 559  * @set_settings: Set ethtool settings. Serialised by the mac_lock.
 560  * @set_xnp_advertise: Set abilities advertised in Extended Next Page
 561  *      (only needed where AN bit is set in mmds)
 562  * @num_tests: Number of PHY-specific tests/results
 563  * @test_names: Names of the tests/results
 564  * @run_tests: Run tests and record results as appropriate.
 565  *      Flags are the ethtool tests flags.
 566  * @mmds: MMD presence mask
 567  * @loopbacks: Supported loopback modes mask
 568  */
 569 struct efx_phy_operations {
 570         enum efx_mac_type macs;
 571         int (*init) (struct efx_nic *efx);
 572         void (*fini) (struct efx_nic *efx);
 573         void (*reconfigure) (struct efx_nic *efx);
 574         void (*clear_interrupt) (struct efx_nic *efx);
 575         void (*poll) (struct efx_nic *efx);
 576         void (*get_settings) (struct efx_nic *efx,
 577                               struct ethtool_cmd *ecmd);
 578         int (*set_settings) (struct efx_nic *efx,
 579                              struct ethtool_cmd *ecmd);
 580         bool (*set_xnp_advertise) (struct efx_nic *efx, u32);
 581         u32 num_tests;
 582         const char *const *test_names;
 583         int (*run_tests) (struct efx_nic *efx, int *results, unsigned flags);
 584         int mmds;
 585         unsigned loopbacks;
 586 };
 587
 588 /**
 589  * @enum efx_phy_mode - PHY operating mode flags
 590  * @PHY_MODE_NORMAL: on and should pass traffic
 591  * @PHY_MODE_TX_DISABLED: on with TX disabled
 592  * @PHY_MODE_LOW_POWER: set to low power through MDIO
 593  * @PHY_MODE_OFF: switched off through external control
 594  * @PHY_MODE_SPECIAL: on but will not pass traffic
 595  */
 596 enum efx_phy_mode {
 597         PHY_MODE_NORMAL         = 0,
 598         PHY_MODE_TX_DISABLED    = 1,
 599         PHY_MODE_LOW_POWER      = 2,
 600         PHY_MODE_OFF            = 4,
 601         PHY_MODE_SPECIAL        = 8,
 602 };
 603
 604 static inline bool efx_phy_mode_disabled(enum efx_phy_mode mode)
 605 {
 606         return !!(mode & ~PHY_MODE_TX_DISABLED);
 607 }
 608
 609 /*
 610  * Efx extended statistics
 611  *
 612  * Not all statistics are provided by all supported MACs.  The purpose
 613  * is this structure is to contain the raw statistics provided by each
 614  * MAC.
 615  */
 616 struct efx_mac_stats {
 617         u64 tx_bytes;
 618         u64 tx_good_bytes;
 619         u64 tx_bad_bytes;
 620         unsigned long tx_packets;
 621         unsigned long tx_bad;
 622         unsigned long tx_pause;
 623         unsigned long tx_control;
 624         unsigned long tx_unicast;
 625         unsigned long tx_multicast;
 626         unsigned long tx_broadcast;
 627         unsigned long tx_lt64;
 628         unsigned long tx_64;
 629         unsigned long tx_65_to_127;
 630         unsigned long tx_128_to_255;
 631         unsigned long tx_256_to_511;
 632         unsigned long tx_512_to_1023;
 633         unsigned long tx_1024_to_15xx;
 634         unsigned long tx_15xx_to_jumbo;
 635         unsigned long tx_gtjumbo;
 636         unsigned long tx_collision;
 637         unsigned long tx_single_collision;
 638         unsigned long tx_multiple_collision;
 639         unsigned long tx_excessive_collision;
 640         unsigned long tx_deferred;
 641         unsigned long tx_late_collision;
 642         unsigned long tx_excessive_deferred;
 643         unsigned long tx_non_tcpudp;
 644         unsigned long tx_mac_src_error;
 645         unsigned long tx_ip_src_error;
 646         u64 rx_bytes;
 647         u64 rx_good_bytes;
 648         u64 rx_bad_bytes;
 649         unsigned long rx_packets;
 650         unsigned long rx_good;
 651         unsigned long rx_bad;
 652         unsigned long rx_pause;
 653         unsigned long rx_control;
 654         unsigned long rx_unicast;
 655         unsigned long rx_multicast;
 656         unsigned long rx_broadcast;
 657         unsigned long rx_lt64;
 658         unsigned long rx_64;
 659         unsigned long rx_65_to_127;
 660         unsigned long rx_128_to_255;
 661         unsigned long rx_256_to_511;
 662         unsigned long rx_512_to_1023;
 663         unsigned long rx_1024_to_15xx;
 664         unsigned long rx_15xx_to_jumbo;
 665         unsigned long rx_gtjumbo;
 666         unsigned long rx_bad_lt64;
 667         unsigned long rx_bad_64_to_15xx;
 668         unsigned long rx_bad_15xx_to_jumbo;
 669         unsigned long rx_bad_gtjumbo;
 670         unsigned long rx_overflow;
 671         unsigned long rx_missed;
 672         unsigned long rx_false_carrier;
 673         unsigned long rx_symbol_error;
 674         unsigned long rx_align_error;
 675         unsigned long rx_length_error;
 676         unsigned long rx_internal_error;
 677         unsigned long rx_good_lt64;
 678 };
 679
 680 /* Number of bits used in a multicast filter hash address */
 681 #define EFX_MCAST_HASH_BITS 8
 682
 683 /* Number of (single-bit) entries in a multicast filter hash */
 684 #define EFX_MCAST_HASH_ENTRIES (1 << EFX_MCAST_HASH_BITS)
 685
 686 /* An Efx multicast filter hash */
 687 union efx_multicast_hash {
 688         u8 byte[EFX_MCAST_HASH_ENTRIES / 8];
 689         efx_oword_t oword[EFX_MCAST_HASH_ENTRIES / sizeof(efx_oword_t) / 8];
 690 };
 691
 692 /**
 693  * struct efx_nic - an Efx NIC
 694  * @name: Device name (net device name or bus id before net device registered)
 695  * @pci_dev: The PCI device
 696  * @type: Controller type attributes
 697  * @legacy_irq: IRQ number
 698  * @workqueue: Workqueue for port reconfigures and the HW monitor.
 699  *      Work items do not hold and must not acquire RTNL.
 700  * @workqueue_name: Name of workqueue
 701  * @reset_work: Scheduled reset workitem
 702  * @monitor_work: Hardware monitor workitem
 703  * @membase_phys: Memory BAR value as physical address
 704  * @membase: Memory BAR value
 705  * @biu_lock: BIU (bus interface unit) lock
 706  * @interrupt_mode: Interrupt mode
 707  * @i2c_adap: I2C adapter
 708  * @board_info: Board-level information
 709  * @state: Device state flag. Serialised by the rtnl_lock.
 710  * @reset_pending: Pending reset method (normally RESET_TYPE_NONE)
 711  * @tx_queue: TX DMA queues
 712  * @rx_queue: RX DMA queues
 713  * @channel: Channels
 714  * @n_rx_queues: Number of RX queues
 715  * @n_channels: Number of channels in use
 716  * @rx_buffer_len: RX buffer length
 717  * @rx_buffer_order: Order (log2) of number of pages for each RX buffer
 718  * @irq_status: Interrupt status buffer
 719  * @last_irq_cpu: Last CPU to handle interrupt.
 720  *      This register is written with the SMP processor ID whenever an
 721  *      interrupt is handled.  It is used by falcon_test_interrupt()
 722  *      to verify that an interrupt has occurred.
 723  * @spi_flash: SPI flash device
 724  *      This field will be %NULL if no flash device is present.
 725  * @spi_eeprom: SPI EEPROM device
 726  *      This field will be %NULL if no EEPROM device is present.
 727  * @spi_lock: SPI bus lock
 728  * @n_rx_nodesc_drop_cnt: RX no descriptor drop count
 729  * @nic_data: Hardware dependant state
 730  * @mac_lock: MAC access lock. Protects @port_enabled, @phy_mode,
 731  *      @port_inhibited, efx_monitor() and efx_reconfigure_port()
 732  * @port_enabled: Port enabled indicator.
 733  *      Serialises efx_stop_all(), efx_start_all(), efx_monitor(),
 734  *      efx_phy_work(), and efx_mac_work() with kernel interfaces. Safe to read
 735  *      under any one of the rtnl_lock, mac_lock, or netif_tx_lock, but all
 736  *      three must be held to modify it.
 737  * @port_inhibited: If set, the netif_carrier is always off. Hold the mac_lock
 738  * @port_initialized: Port initialized?
 739  * @net_dev: Operating system network device. Consider holding the rtnl lock
 740  * @rx_checksum_enabled: RX checksumming enabled
 741  * @netif_stop_count: Port stop count
 742  * @netif_stop_lock: Port stop lock
 743  * @mac_stats: MAC statistics. These include all statistics the MACs
 744  *      can provide.  Generic code converts these into a standard
 745  *      &struct net_device_stats.
 746  * @stats_buffer: DMA buffer for statistics
 747  * @stats_lock: Statistics update lock. Serialises statistics fetches
 748  * @stats_enabled: Temporarily disable statistics fetches.
 749  *      Serialised by @stats_lock
 750  * @mac_op: MAC interface
 751  * @mac_address: Permanent MAC address
 752  * @phy_type: PHY type
 753  * @phy_lock: PHY access lock
 754  * @phy_op: PHY interface
 755  * @phy_data: PHY private data (including PHY-specific stats)
 756  * @mii: PHY interface
 757  * @phy_mode: PHY operating mode. Serialised by @mac_lock.
 758  * @mac_up: MAC link state
 759  * @link_up: Link status
 760  * @link_fd: Link is full duplex
 761  * @link_fc: Actualy flow control flags
 762  * @link_speed: Link speed (Mbps)
 763  * @n_link_state_changes: Number of times the link has changed state
 764  * @promiscuous: Promiscuous flag. Protected by netif_tx_lock.
 765  * @multicast_hash: Multicast hash table
 766  * @wanted_fc: Wanted flow control flags
 767  * @phy_work: work item for dealing with PHY events
 768  * @mac_work: work item for dealing with MAC events
 769  * @loopback_mode: Loopback status
 770  * @loopback_modes: Supported loopback mode bitmask
 771  * @loopback_selftest: Offline self-test private state
 772  *
 773  * The @priv field of the corresponding &struct net_device points to
 774  * this.
 775  */
 776 struct efx_nic {
 777         char name[IFNAMSIZ];
 778         struct pci_dev *pci_dev;
 779         const struct efx_nic_type *type;
 780         int legacy_irq;
 781         struct workqueue_struct *workqueue;
 782         char workqueue_name[16];
 783         struct work_struct reset_work;
 784         struct delayed_work monitor_work;
 785         resource_size_t membase_phys;
 786         void __iomem *membase;
 787         spinlock_t biu_lock;
 788         enum efx_int_mode interrupt_mode;
 789
 790         struct i2c_adapter i2c_adap;
 791         struct efx_board board_info;
 792
 793         enum nic_state state;
 794         enum reset_type reset_pending;
 795
 796         struct efx_tx_queue tx_queue[EFX_TX_QUEUE_COUNT];
 797         struct efx_rx_queue rx_queue[EFX_MAX_RX_QUEUES];
 798         struct efx_channel channel[EFX_MAX_CHANNELS];
 799
 800         int n_rx_queues;
 801         int n_channels;
 802         unsigned int rx_buffer_len;
 803         unsigned int rx_buffer_order;
 804
 805         struct efx_buffer irq_status;
 806         volatile signed int last_irq_cpu;
 807
 808         struct efx_spi_device *spi_flash;
 809         struct efx_spi_device *spi_eeprom;
 810         struct mutex spi_lock;
 811
 812         unsigned n_rx_nodesc_drop_cnt;
 813
 814         struct falcon_nic_data *nic_data;
 815
 816         struct mutex mac_lock;
 817         struct work_struct mac_work;
 818         bool port_enabled;
 819         bool port_inhibited;
 820
 821         bool port_initialized;
 822         struct net_device *net_dev;
 823         bool rx_checksum_enabled;
 824
 825         atomic_t netif_stop_count;
 826         spinlock_t netif_stop_lock;
 827
 828         struct efx_mac_stats mac_stats;
 829         struct efx_buffer stats_buffer;
 830         spinlock_t stats_lock;
 831         bool stats_enabled;
 832
 833         struct efx_mac_operations *mac_op;
 834         unsigned char mac_address[ETH_ALEN];
 835
 836         enum phy_type phy_type;
 837         spinlock_t phy_lock;
 838         struct work_struct phy_work;
 839         struct efx_phy_operations *phy_op;
 840         void *phy_data;
 841         struct mii_if_info mii;
 842         enum efx_phy_mode phy_mode;
 843
 844         bool mac_up;
 845         bool link_up;
 846         bool link_fd;
 847         enum efx_fc_type link_fc;
 848         unsigned int link_speed;
 849         unsigned int n_link_state_changes;
 850
 851         bool promiscuous;
 852         union efx_multicast_hash multicast_hash;
 853         enum efx_fc_type wanted_fc;
 854
 855         atomic_t rx_reset;
 856         enum efx_loopback_mode loopback_mode;
 857         unsigned int loopback_modes;
 858
 859         void *loopback_selftest;
 860 };
 861
 862 static inline int efx_dev_registered(struct efx_nic *efx)
 863 {
 864         return efx->net_dev->reg_state == NETREG_REGISTERED;
 865 }
 866
 867 /* Net device name, for inclusion in log messages if it has been registered.
 868  * Use efx->name not efx->net_dev->name so that races with (un)registration
 869  * are harmless.
 870  */
 871 static inline const char *efx_dev_name(struct efx_nic *efx)
 872 {
 873         return efx_dev_registered(efx) ? efx->name : "";
 874 }
 875
 876 /**
 877  * struct efx_nic_type - Efx device type definition
 878  * @mem_bar: Memory BAR number
 879  * @mem_map_size: Memory BAR mapped size
 880  * @txd_ptr_tbl_base: TX descriptor ring base address
 881  * @rxd_ptr_tbl_base: RX descriptor ring base address
 882  * @buf_tbl_base: Buffer table base address
 883  * @evq_ptr_tbl_base: Event queue pointer table base address
 884  * @evq_rptr_tbl_base: Event queue read-pointer table base address
 885  * @txd_ring_mask: TX descriptor ring size - 1 (must be a power of two - 1)
 886  * @rxd_ring_mask: RX descriptor ring size - 1 (must be a power of two - 1)
 887  * @evq_size: Event queue size (must be a power of two)
 888  * @max_dma_mask: Maximum possible DMA mask
 889  * @tx_dma_mask: TX DMA mask
 890  * @bug5391_mask: Address mask for bug 5391 workaround
 891  * @rx_xoff_thresh: RX FIFO XOFF watermark (bytes)
 892  * @rx_xon_thresh: RX FIFO XON watermark (bytes)
 893  * @rx_buffer_padding: Padding added to each RX buffer
 894  * @max_interrupt_mode: Highest capability interrupt mode supported
 895  *      from &enum efx_init_mode.
 896  * @phys_addr_channels: Number of channels with physically addressed
 897  *      descriptors
 898  */
 899 struct efx_nic_type {
 900         unsigned int mem_bar;
 901         unsigned int mem_map_size;
 902         unsigned int txd_ptr_tbl_base;
 903         unsigned int rxd_ptr_tbl_base;
 904         unsigned int buf_tbl_base;
 905         unsigned int evq_ptr_tbl_base;
 906         unsigned int evq_rptr_tbl_base;
 907
 908         unsigned int txd_ring_mask;
 909         unsigned int rxd_ring_mask;
 910         unsigned int evq_size;
 911         u64 max_dma_mask;
 912         unsigned int tx_dma_mask;
 913         unsigned bug5391_mask;
 914
 915         int rx_xoff_thresh;
 916         int rx_xon_thresh;
 917         unsigned int rx_buffer_padding;
 918         unsigned int max_interrupt_mode;
 919         unsigned int phys_addr_channels;
 920 };
 921
 922 /**************************************************************************
 923  *
 924  * Prototypes and inline functions
 925  *
 926  *************************************************************************/
 927
 928 /* Iterate over all used channels */
 929 #define efx_for_each_channel(_channel, _efx)                            \
 930         for (_channel = &_efx->channel[0];                              \
 931              _channel < &_efx->channel[EFX_MAX_CHANNELS];               \
 932              _channel++)                                                \
 933                 if (!_channel->used_flags)                              \
 934                         continue;                                       \
 935                 else
 936
 937 /* Iterate over all used TX queues */
 938 #define efx_for_each_tx_queue(_tx_queue, _efx)                          \
 939         for (_tx_queue = &_efx->tx_queue[0];                            \
 940              _tx_queue < &_efx->tx_queue[EFX_TX_QUEUE_COUNT];           \
 941              _tx_queue++)
 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 = &_channel->efx->tx_queue[0];                   \
 946              _tx_queue < &_channel->efx->tx_queue[EFX_TX_QUEUE_COUNT];  \
 947              _tx_queue++)                                               \
 948                 if (_tx_queue->channel != _channel)                     \
 949                         continue;                                       \
 950                 else
 951
 952 /* Iterate over all used RX queues */
 953 #define efx_for_each_rx_queue(_rx_queue, _efx)                          \
 954         for (_rx_queue = &_efx->rx_queue[0];                            \
 955              _rx_queue < &_efx->rx_queue[_efx->n_rx_queues];            \
 956              _rx_queue++)
 957
 958 /* Iterate over all RX queues belonging to a channel */
 959 #define efx_for_each_channel_rx_queue(_rx_queue, _channel)              \
 960         for (_rx_queue = &_channel->efx->rx_queue[_channel->channel];   \
 961              _rx_queue;                                                 \
 962              _rx_queue = NULL)                                          \
 963                 if (_rx_queue->channel != _channel)                     \
 964                         continue;                                       \
 965                 else
 966
 967 /* Returns a pointer to the specified receive buffer in the RX
 968  * descriptor queue.
 969  */
 970 static inline struct efx_rx_buffer *efx_rx_buffer(struct efx_rx_queue *rx_queue,
 971                                                   unsigned int index)
 972 {
 973         return (&rx_queue->buffer[index]);
 974 }
 975
 976 /* Set bit in a little-endian bitfield */
 977 static inline void set_bit_le(unsigned nr, unsigned char *addr)
 978 {
 979         addr[nr / 8] |= (1 << (nr % 8));
 980 }
 981
 982 /* Clear bit in a little-endian bitfield */
 983 static inline void clear_bit_le(unsigned nr, unsigned char *addr)
 984 {
 985         addr[nr / 8] &= ~(1 << (nr % 8));
 986 }
 987
 988
 989 /**
 990  * EFX_MAX_FRAME_LEN - calculate maximum frame length
 991  *
 992  * This calculates the maximum frame length that will be used for a
 993  * given MTU.  The frame length will be equal to the MTU plus a
 994  * constant amount of header space and padding.  This is the quantity
 995  * that the net driver will program into the MAC as the maximum frame
 996  * length.
 997  *
 998  * The 10G MAC used in Falcon requires 8-byte alignment on the frame
 999  * length, so we round up to the nearest 8.
1000  */
1001 #define EFX_MAX_FRAME_LEN(mtu) \
1002         ((((mtu) + ETH_HLEN + VLAN_HLEN + 4/* FCS */) + 7) & ~7)
1003
1004
1005 #endif /* EFX_NET_DRIVER_H */