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