net_driver.h 32.5 KB
Newer Older
1
2
3
/****************************************************************************
 * Driver for Solarflare Solarstorm network controllers and boards
 * Copyright 2005-2006 Fen Systems Ltd.
4
 * Copyright 2005-2009 Solarflare Communications Inc.
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 as published
 * by the Free Software Foundation, incorporated herein by reference.
 */

/* Common definitions for all Efx net driver code */

#ifndef EFX_NET_DRIVER_H
#define EFX_NET_DRIVER_H

#include <linux/version.h>
#include <linux/netdevice.h>
#include <linux/etherdevice.h>
#include <linux/ethtool.h>
#include <linux/if_vlan.h>
21
#include <linux/mdio.h>
22
23
24
25
26
#include <linux/list.h>
#include <linux/pci.h>
#include <linux/device.h>
#include <linux/highmem.h>
#include <linux/workqueue.h>
27
#include <linux/i2c.h>
28
29
30
31
32
33
34
35
36
37
38
39

#include "enum.h"
#include "bitfield.h"

/**************************************************************************
 *
 * Build definitions
 *
 **************************************************************************/
#ifndef EFX_DRIVER_NAME
#define EFX_DRIVER_NAME	"sfc"
#endif
40
#define EFX_DRIVER_VERSION	"3.0"
41
42
43
44
45
46
47
48
49
50
51

#ifdef EFX_ENABLE_DEBUG
#define EFX_BUG_ON_PARANOID(x) BUG_ON(x)
#define EFX_WARN_ON_PARANOID(x) WARN_ON(x)
#else
#define EFX_BUG_ON_PARANOID(x) do {} while (0)
#define EFX_WARN_ON_PARANOID(x) do {} while (0)
#endif

/* Un-rate-limited logging */
#define EFX_ERR(efx, fmt, args...) \
52
dev_err(&((efx)->pci_dev->dev), "ERR: %s " fmt, efx_dev_name(efx), ##args)
53
54

#define EFX_INFO(efx, fmt, args...) \
55
dev_info(&((efx)->pci_dev->dev), "INFO: %s " fmt, efx_dev_name(efx), ##args)
56
57
58

#ifdef EFX_ENABLE_DEBUG
#define EFX_LOG(efx, fmt, args...) \
59
dev_info(&((efx)->pci_dev->dev), "DBG: %s " fmt, efx_dev_name(efx), ##args)
60
61
#else
#define EFX_LOG(efx, fmt, args...) \
62
dev_dbg(&((efx)->pci_dev->dev), "DBG: %s " fmt, efx_dev_name(efx), ##args)
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
#endif

#define EFX_TRACE(efx, fmt, args...) do {} while (0)

#define EFX_REGDUMP(efx, fmt, args...) do {} while (0)

/* Rate-limited logging */
#define EFX_ERR_RL(efx, fmt, args...) \
do {if (net_ratelimit()) EFX_ERR(efx, fmt, ##args); } while (0)

#define EFX_INFO_RL(efx, fmt, args...) \
do {if (net_ratelimit()) EFX_INFO(efx, fmt, ##args); } while (0)

#define EFX_LOG_RL(efx, fmt, args...) \
do {if (net_ratelimit()) EFX_LOG(efx, fmt, ##args); } while (0)

/**************************************************************************
 *
 * Efx data structures
 *
 **************************************************************************/

#define EFX_MAX_CHANNELS 32
#define EFX_MAX_RX_QUEUES EFX_MAX_CHANNELS

88
89
90
91
#define EFX_TX_QUEUE_OFFLOAD_CSUM	0
#define EFX_TX_QUEUE_NO_CSUM		1
#define EFX_TX_QUEUE_COUNT		2

92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
/**
 * struct efx_special_buffer - An Efx special buffer
 * @addr: CPU base address of the buffer
 * @dma_addr: DMA base address of the buffer
 * @len: Buffer length, in bytes
 * @index: Buffer index within controller;s buffer table
 * @entries: Number of buffer table entries
 *
 * Special buffers are used for the event queues and the TX and RX
 * descriptor queues for each channel.  They are *not* used for the
 * actual transmit and receive buffers.
 */
struct efx_special_buffer {
	void *addr;
	dma_addr_t dma_addr;
	unsigned int len;
	int index;
	int entries;
};

112
113
114
115
116
117
118
enum efx_flush_state {
	FLUSH_NONE,
	FLUSH_PENDING,
	FLUSH_FAILED,
	FLUSH_DONE,
};

119
120
121
122
123
124
/**
 * struct efx_tx_buffer - An Efx TX buffer
 * @skb: The associated socket buffer.
 *	Set only on the final fragment of a packet; %NULL for all other
 *	fragments.  When this fragment completes, then we can free this
 *	skb.
Ben Hutchings's avatar
Ben Hutchings committed
125
126
 * @tsoh: The associated TSO header structure, or %NULL if this
 *	buffer is not a TSO header.
127
128
129
130
131
132
133
134
135
 * @dma_addr: DMA address of the fragment.
 * @len: Length of this fragment.
 *	This field is zero when the queue slot is empty.
 * @continuation: True if this fragment is not the end of a packet.
 * @unmap_single: True if pci_unmap_single should be used.
 * @unmap_len: Length of this fragment to unmap
 */
struct efx_tx_buffer {
	const struct sk_buff *skb;
Ben Hutchings's avatar
Ben Hutchings committed
136
	struct efx_tso_header *tsoh;
137
138
	dma_addr_t dma_addr;
	unsigned short len;
139
140
	bool continuation;
	bool unmap_single;
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
	unsigned short unmap_len;
};

/**
 * struct efx_tx_queue - An Efx TX queue
 *
 * This is a ring buffer of TX fragments.
 * Since the TX completion path always executes on the same
 * CPU and the xmit path can operate on different CPUs,
 * performance is increased by ensuring that the completion
 * path and the xmit path operate on different cache lines.
 * This is particularly important if the xmit path is always
 * executing on one CPU which is different from the completion
 * path.  There is also a cache line for members which are
 * read but not written on the fast path.
 *
 * @efx: The associated Efx NIC
 * @queue: DMA queue number
 * @channel: The associated channel
 * @buffer: The software buffer ring
 * @txd: The hardware descriptor ring
162
 * @flushed: Used when handling queue flushing
163
164
 * @read_count: Current read pointer.
 *	This is the number of buffers that have been removed from both rings.
165
 * @stopped: Stopped count.
166
167
168
169
170
171
172
173
174
175
176
177
178
 *	Set if this TX queue is currently stopping its port.
 * @insert_count: Current insert pointer
 *	This is the number of buffers that have been added to the
 *	software ring.
 * @write_count: Current write pointer
 *	This is the number of buffers that have been added to the
 *	hardware ring.
 * @old_read_count: The value of read_count when last checked.
 *	This is here for performance reasons.  The xmit path will
 *	only get the up-to-date value of read_count if this
 *	variable indicates that the queue is full.  This is to
 *	avoid cache-line ping-pong between the xmit path and the
 *	completion path.
Ben Hutchings's avatar
Ben Hutchings committed
179
180
181
182
183
184
185
 * @tso_headers_free: A list of TSO headers allocated for this TX queue
 *	that are not in use, and so available for new TSO sends. The list
 *	is protected by the TX queue lock.
 * @tso_bursts: Number of times TSO xmit invoked by kernel
 * @tso_long_headers: Number of packets with headers too long for standard
 *	blocks
 * @tso_packets: Number of packets via the TSO xmit path
186
187
188
189
190
191
192
193
194
 */
struct efx_tx_queue {
	/* Members which don't change on the fast path */
	struct efx_nic *efx ____cacheline_aligned_in_smp;
	int queue;
	struct efx_channel *channel;
	struct efx_nic *nic;
	struct efx_tx_buffer *buffer;
	struct efx_special_buffer txd;
195
	enum efx_flush_state flushed;
196
197
198
199
200
201
202
203
204

	/* Members used mainly on the completion path */
	unsigned int read_count ____cacheline_aligned_in_smp;
	int stopped;

	/* Members used only on the xmit path */
	unsigned int insert_count ____cacheline_aligned_in_smp;
	unsigned int write_count;
	unsigned int old_read_count;
Ben Hutchings's avatar
Ben Hutchings committed
205
206
207
208
	struct efx_tso_header *tso_headers_free;
	unsigned int tso_bursts;
	unsigned int tso_long_headers;
	unsigned int tso_packets;
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
};

/**
 * struct efx_rx_buffer - An Efx RX data buffer
 * @dma_addr: DMA base address of the buffer
 * @skb: The associated socket buffer, if any.
 *	If both this and page are %NULL, the buffer slot is currently free.
 * @page: The associated page buffer, if any.
 *	If both this and skb are %NULL, the buffer slot is currently free.
 * @data: Pointer to ethernet header
 * @len: Buffer length, in bytes.
 * @unmap_addr: DMA address to unmap
 */
struct efx_rx_buffer {
	dma_addr_t dma_addr;
	struct sk_buff *skb;
	struct page *page;
	char *data;
	unsigned int len;
	dma_addr_t unmap_addr;
};

/**
 * struct efx_rx_queue - An Efx RX queue
 * @efx: The associated Efx NIC
 * @queue: DMA queue number
 * @channel: The associated channel
 * @buffer: The software buffer ring
 * @rxd: The hardware descriptor ring
 * @added_count: Number of buffers added to the receive queue.
 * @notified_count: Number of buffers given to NIC (<= @added_count).
 * @removed_count: Number of buffers removed from the receive queue.
 * @add_lock: Receive queue descriptor add spin lock.
 *	This lock must be held in order to add buffers to the RX
 *	descriptor ring (rxd and buffer) and to update added_count (but
 *	not removed_count).
 * @max_fill: RX descriptor maximum fill level (<= ring size)
 * @fast_fill_trigger: RX descriptor fill level that will trigger a fast fill
 *	(<= @max_fill)
 * @fast_fill_limit: The level to which a fast fill will fill
 *	(@fast_fill_trigger <= @fast_fill_limit <= @max_fill)
 * @min_fill: RX descriptor minimum non-zero fill level.
 *	This records the minimum fill level observed when a ring
 *	refill was triggered.
 * @min_overfill: RX descriptor minimum overflow fill level.
 *	This records the minimum fill level at which RX queue
 *	overflow was observed.  It should never be set.
 * @alloc_page_count: RX allocation strategy counter.
 * @alloc_skb_count: RX allocation strategy counter.
 * @work: Descriptor push work thread
 * @buf_page: Page for next RX buffer.
 *	We can use a single page for multiple RX buffers. This tracks
 *	the remaining space in the allocation.
 * @buf_dma_addr: Page's DMA address.
 * @buf_data: Page's host address.
264
 * @flushed: Use when handling queue flushing
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 */
struct efx_rx_queue {
	struct efx_nic *efx;
	int queue;
	struct efx_channel *channel;
	struct efx_rx_buffer *buffer;
	struct efx_special_buffer rxd;

	int added_count;
	int notified_count;
	int removed_count;
	spinlock_t add_lock;
	unsigned int max_fill;
	unsigned int fast_fill_trigger;
	unsigned int fast_fill_limit;
	unsigned int min_fill;
	unsigned int min_overfill;
	unsigned int alloc_page_count;
	unsigned int alloc_skb_count;
	struct delayed_work work;
	unsigned int slow_fill_count;

	struct page *buf_page;
	dma_addr_t buf_dma_addr;
	char *buf_data;
290
	enum efx_flush_state flushed;
291
292
293
294
295
296
297
298
};

/**
 * struct efx_buffer - An Efx general-purpose buffer
 * @addr: host base address of the buffer
 * @dma_addr: DMA base address of the buffer
 * @len: Buffer length, in bytes
 *
299
 * The NIC uses these buffers for its interrupt status registers and
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 * MAC stats dumps.
 */
struct efx_buffer {
	void *addr;
	dma_addr_t dma_addr;
	unsigned int len;
};


/* Flags for channel->used_flags */
#define EFX_USED_BY_RX 1
#define EFX_USED_BY_TX 2
#define EFX_USED_BY_RX_TX (EFX_USED_BY_RX | EFX_USED_BY_TX)

enum efx_rx_alloc_method {
	RX_ALLOC_METHOD_AUTO = 0,
	RX_ALLOC_METHOD_SKB = 1,
	RX_ALLOC_METHOD_PAGE = 2,
};

/**
 * struct efx_channel - An Efx channel
 *
 * A channel comprises an event queue, at least one TX queue, at least
 * one RX queue, and an associated tasklet for processing the event
 * queue.
 *
 * @efx: Associated Efx NIC
 * @channel: Channel instance number
329
 * @name: Name for channel and IRQ
330
331
332
 * @used_flags: Channel is used by net driver
 * @enabled: Channel enabled indicator
 * @irq: IRQ number (MSI and MSI-X only)
333
 * @irq_moderation: IRQ moderation value (in hardware ticks)
334
335
336
337
338
339
340
341
 * @napi_dev: Net device used with NAPI
 * @napi_str: NAPI control structure
 * @reset_work: Scheduled reset work thread
 * @work_pending: Is work pending via NAPI?
 * @eventq: Event queue buffer
 * @eventq_read_ptr: Event queue read pointer
 * @last_eventq_read_ptr: Last event queue read pointer value.
 * @eventq_magic: Event queue magic value for driver-generated test events
342
343
 * @irq_count: Number of IRQs since last adaptive moderation decision
 * @irq_mod_score: IRQ moderation score
344
345
346
347
348
349
350
 * @rx_alloc_level: Watermark based heuristic counter for pushing descriptors
 *	and diagnostic counters
 * @rx_alloc_push_pages: RX allocation method currently in use for pushing
 *	descriptors
 * @n_rx_tobe_disc: Count of RX_TOBE_DISC errors
 * @n_rx_ip_hdr_chksum_err: Count of RX IP header checksum errors
 * @n_rx_tcp_udp_chksum_err: Count of RX TCP and UDP checksum errors
351
 * @n_rx_mcast_mismatch: Count of unmatched multicast frames
352
353
354
355
356
357
358
 * @n_rx_frm_trunc: Count of RX_FRM_TRUNC errors
 * @n_rx_overlength: Count of RX_OVERLENGTH errors
 * @n_skbuff_leaks: Count of skbuffs leaked due to RX overrun
 */
struct efx_channel {
	struct efx_nic *efx;
	int channel;
359
	char name[IFNAMSIZ + 6];
360
	int used_flags;
361
	bool enabled;
362
363
364
365
	int irq;
	unsigned int irq_moderation;
	struct net_device *napi_dev;
	struct napi_struct napi_str;
366
	bool work_pending;
367
368
369
370
371
	struct efx_special_buffer eventq;
	unsigned int eventq_read_ptr;
	unsigned int last_eventq_read_ptr;
	unsigned int eventq_magic;

372
373
374
	unsigned int irq_count;
	unsigned int irq_mod_score;

375
376
377
378
379
380
	int rx_alloc_level;
	int rx_alloc_push_pages;

	unsigned n_rx_tobe_disc;
	unsigned n_rx_ip_hdr_chksum_err;
	unsigned n_rx_tcp_udp_chksum_err;
381
	unsigned n_rx_mcast_mismatch;
382
383
384
385
386
387
388
389
	unsigned n_rx_frm_trunc;
	unsigned n_rx_overlength;
	unsigned n_skbuff_leaks;

	/* Used to pipeline received packets in order to optimise memory
	 * access with prefetches.
	 */
	struct efx_rx_buffer *rx_pkt;
390
	bool rx_pkt_csummed;
391
392
393

};

394
395
396
397
398
399
enum efx_led_mode {
	EFX_LED_OFF	= 0,
	EFX_LED_ON	= 1,
	EFX_LED_DEFAULT	= 2
};

400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
#define STRING_TABLE_LOOKUP(val, member) \
	((val) < member ## _max) ? member ## _names[val] : "(invalid)"

extern const char *efx_loopback_mode_names[];
extern const unsigned int efx_loopback_mode_max;
#define LOOPBACK_MODE(efx) \
	STRING_TABLE_LOOKUP((efx)->loopback_mode, efx_loopback_mode)

extern const char *efx_interrupt_mode_names[];
extern const unsigned int efx_interrupt_mode_max;
#define INT_MODE(efx) \
	STRING_TABLE_LOOKUP(efx->interrupt_mode, efx_interrupt_mode)

extern const char *efx_reset_type_names[];
extern const unsigned int efx_reset_type_max;
#define RESET_TYPE(type) \
	STRING_TABLE_LOOKUP(type, efx_reset_type)
417

418
419
420
421
422
423
424
425
426
enum efx_int_mode {
	/* Be careful if altering to correct macro below */
	EFX_INT_MODE_MSIX = 0,
	EFX_INT_MODE_MSI = 1,
	EFX_INT_MODE_LEGACY = 2,
	EFX_INT_MODE_MAX	/* Insert any new items before this */
};
#define EFX_INT_MODE_USE_MSI(x) (((x)->interrupt_mode) <= EFX_INT_MODE_MSI)

427
#define EFX_IS10G(efx) ((efx)->link_state.speed == 10000)
428

429
430
431
432
enum nic_state {
	STATE_INIT = 0,
	STATE_RUNNING = 1,
	STATE_FINI = 2,
433
	STATE_DISABLED = 3,
434
435
436
437
438
439
440
441
442
443
	STATE_MAX,
};

/*
 * Alignment of page-allocated RX buffers
 *
 * Controls the number of bytes inserted at the start of an RX buffer.
 * This is the equivalent of NET_IP_ALIGN [which controls the alignment
 * of the skb->head for hardware DMA].
 */
444
#ifdef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
#define EFX_PAGE_IP_ALIGN 0
#else
#define EFX_PAGE_IP_ALIGN NET_IP_ALIGN
#endif

/*
 * Alignment of the skb->head which wraps a page-allocated RX buffer
 *
 * The skb allocated to wrap an rx_buffer can have this alignment. Since
 * the data is memcpy'd from the rx_buf, it does not need to be equal to
 * EFX_PAGE_IP_ALIGN.
 */
#define EFX_PAGE_SKB_ALIGN 2

/* Forward declaration */
struct efx_nic;

/* Pseudo bit-mask flow control field */
enum efx_fc_type {
464
465
	EFX_FC_RX = FLOW_CTRL_RX,
	EFX_FC_TX = FLOW_CTRL_TX,
466
467
468
	EFX_FC_AUTO = 4,
};

469
470
471
472
473
474
475
476
477
478
479
480
481
482
/**
 * struct efx_link_state - Current state of the link
 * @up: Link is up
 * @fd: Link is full-duplex
 * @fc: Actual flow control flags
 * @speed: Link speed (Mbps)
 */
struct efx_link_state {
	bool up;
	bool fd;
	enum efx_fc_type fc;
	unsigned int speed;
};

Steve Hodgson's avatar
Steve Hodgson committed
483
484
485
486
487
488
489
static inline bool efx_link_state_equal(const struct efx_link_state *left,
					const struct efx_link_state *right)
{
	return left->up == right->up && left->fd == right->fd &&
		left->fc == right->fc && left->speed == right->speed;
}

490
491
492
493
/**
 * struct efx_mac_operations - Efx MAC operations table
 * @reconfigure: Reconfigure MAC. Serialised by the mac_lock
 * @update_stats: Update statistics
494
 * @check_fault: Check fault state. True if fault present.
495
496
 */
struct efx_mac_operations {
497
	int (*reconfigure) (struct efx_nic *efx);
498
	void (*update_stats) (struct efx_nic *efx);
499
	bool (*check_fault)(struct efx_nic *efx);
500
501
};

502
503
/**
 * struct efx_phy_operations - Efx PHY operations table
504
505
 * @probe: Probe PHY and initialise efx->mdio.mode_support, efx->mdio.mmds,
 *	efx->loopback_modes.
506
507
508
 * @init: Initialise PHY
 * @fini: Shut down PHY
 * @reconfigure: Reconfigure PHY (e.g. for new link parameters)
Steve Hodgson's avatar
Steve Hodgson committed
509
510
 * @poll: Update @link_state and report whether it changed.
 *	Serialised by the mac_lock.
511
512
 * @get_settings: Get ethtool settings. Serialised by the mac_lock.
 * @set_settings: Set ethtool settings. Serialised by the mac_lock.
513
 * @set_npage_adv: Set abilities advertised in (Extended) Next Page
514
 *	(only needed where AN bit is set in mmds)
515
 * @test_alive: Test that PHY is 'alive' (online)
516
 * @test_name: Get the name of a PHY-specific test/result
517
 * @run_tests: Run tests and record results as appropriate (offline).
518
 *	Flags are the ethtool tests flags.
519
520
 */
struct efx_phy_operations {
521
	int (*probe) (struct efx_nic *efx);
522
523
	int (*init) (struct efx_nic *efx);
	void (*fini) (struct efx_nic *efx);
524
	void (*remove) (struct efx_nic *efx);
525
	int (*reconfigure) (struct efx_nic *efx);
Steve Hodgson's avatar
Steve Hodgson committed
526
	bool (*poll) (struct efx_nic *efx);
527
528
529
530
	void (*get_settings) (struct efx_nic *efx,
			      struct ethtool_cmd *ecmd);
	int (*set_settings) (struct efx_nic *efx,
			     struct ethtool_cmd *ecmd);
531
	void (*set_npage_adv) (struct efx_nic *efx, u32);
532
	int (*test_alive) (struct efx_nic *efx);
533
	const char *(*test_name) (struct efx_nic *efx, unsigned int index);
534
	int (*run_tests) (struct efx_nic *efx, int *results, unsigned flags);
535
536
};

537
538
539
540
/**
 * @enum efx_phy_mode - PHY operating mode flags
 * @PHY_MODE_NORMAL: on and should pass traffic
 * @PHY_MODE_TX_DISABLED: on with TX disabled
541
542
 * @PHY_MODE_LOW_POWER: set to low power through MDIO
 * @PHY_MODE_OFF: switched off through external control
543
544
545
546
547
 * @PHY_MODE_SPECIAL: on but will not pass traffic
 */
enum efx_phy_mode {
	PHY_MODE_NORMAL		= 0,
	PHY_MODE_TX_DISABLED	= 1,
548
549
	PHY_MODE_LOW_POWER	= 2,
	PHY_MODE_OFF		= 4,
550
551
552
553
554
	PHY_MODE_SPECIAL	= 8,
};

static inline bool efx_phy_mode_disabled(enum efx_phy_mode mode)
{
Ben Hutchings's avatar
Ben Hutchings committed
555
	return !!(mode & ~PHY_MODE_TX_DISABLED);
556
557
}

558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
/*
 * Efx extended statistics
 *
 * Not all statistics are provided by all supported MACs.  The purpose
 * is this structure is to contain the raw statistics provided by each
 * MAC.
 */
struct efx_mac_stats {
	u64 tx_bytes;
	u64 tx_good_bytes;
	u64 tx_bad_bytes;
	unsigned long tx_packets;
	unsigned long tx_bad;
	unsigned long tx_pause;
	unsigned long tx_control;
	unsigned long tx_unicast;
	unsigned long tx_multicast;
	unsigned long tx_broadcast;
	unsigned long tx_lt64;
	unsigned long tx_64;
	unsigned long tx_65_to_127;
	unsigned long tx_128_to_255;
	unsigned long tx_256_to_511;
	unsigned long tx_512_to_1023;
	unsigned long tx_1024_to_15xx;
	unsigned long tx_15xx_to_jumbo;
	unsigned long tx_gtjumbo;
	unsigned long tx_collision;
	unsigned long tx_single_collision;
	unsigned long tx_multiple_collision;
	unsigned long tx_excessive_collision;
	unsigned long tx_deferred;
	unsigned long tx_late_collision;
	unsigned long tx_excessive_deferred;
	unsigned long tx_non_tcpudp;
	unsigned long tx_mac_src_error;
	unsigned long tx_ip_src_error;
	u64 rx_bytes;
	u64 rx_good_bytes;
	u64 rx_bad_bytes;
	unsigned long rx_packets;
	unsigned long rx_good;
	unsigned long rx_bad;
	unsigned long rx_pause;
	unsigned long rx_control;
	unsigned long rx_unicast;
	unsigned long rx_multicast;
	unsigned long rx_broadcast;
	unsigned long rx_lt64;
	unsigned long rx_64;
	unsigned long rx_65_to_127;
	unsigned long rx_128_to_255;
	unsigned long rx_256_to_511;
	unsigned long rx_512_to_1023;
	unsigned long rx_1024_to_15xx;
	unsigned long rx_15xx_to_jumbo;
	unsigned long rx_gtjumbo;
	unsigned long rx_bad_lt64;
	unsigned long rx_bad_64_to_15xx;
	unsigned long rx_bad_15xx_to_jumbo;
	unsigned long rx_bad_gtjumbo;
	unsigned long rx_overflow;
	unsigned long rx_missed;
	unsigned long rx_false_carrier;
	unsigned long rx_symbol_error;
	unsigned long rx_align_error;
	unsigned long rx_length_error;
	unsigned long rx_internal_error;
	unsigned long rx_good_lt64;
};

/* Number of bits used in a multicast filter hash address */
#define EFX_MCAST_HASH_BITS 8

/* Number of (single-bit) entries in a multicast filter hash */
#define EFX_MCAST_HASH_ENTRIES (1 << EFX_MCAST_HASH_BITS)

/* An Efx multicast filter hash */
union efx_multicast_hash {
	u8 byte[EFX_MCAST_HASH_ENTRIES / 8];
	efx_oword_t oword[EFX_MCAST_HASH_ENTRIES / sizeof(efx_oword_t) / 8];
};

/**
 * struct efx_nic - an Efx NIC
 * @name: Device name (net device name or bus id before net device registered)
 * @pci_dev: The PCI device
 * @type: Controller type attributes
 * @legacy_irq: IRQ number
647
648
 * @workqueue: Workqueue for port reconfigures and the HW monitor.
 *	Work items do not hold and must not acquire RTNL.
649
 * @workqueue_name: Name of workqueue
650
651
652
653
654
655
 * @reset_work: Scheduled reset workitem
 * @monitor_work: Hardware monitor workitem
 * @membase_phys: Memory BAR value as physical address
 * @membase: Memory BAR value
 * @biu_lock: BIU (bus interface unit) lock
 * @interrupt_mode: Interrupt mode
656
657
 * @irq_rx_adaptive: Adaptive IRQ moderation enabled for RX event queues
 * @irq_rx_moderation: IRQ moderation time for RX event queues
658
659
660
661
662
 * @state: Device state flag. Serialised by the rtnl_lock.
 * @reset_pending: Pending reset method (normally RESET_TYPE_NONE)
 * @tx_queue: TX DMA queues
 * @rx_queue: RX DMA queues
 * @channel: Channels
663
 * @next_buffer_table: First available buffer table id
664
 * @n_rx_queues: Number of RX queues
665
 * @n_channels: Number of channels in use
666
667
 * @rx_buffer_len: RX buffer length
 * @rx_buffer_order: Order (log2) of number of pages for each RX buffer
668
669
 * @int_error_count: Number of internal errors seen recently
 * @int_error_expire: Time at which error count will be expired
670
671
672
 * @irq_status: Interrupt status buffer
 * @last_irq_cpu: Last CPU to handle interrupt.
 *	This register is written with the SMP processor ID whenever an
673
 *	interrupt is handled.  It is used by efx_nic_test_interrupt()
674
 *	to verify that an interrupt has occurred.
675
 * @fatal_irq_level: IRQ level (bit number) used for serious errors
676
 * @spi_flash: SPI flash device
677
 *	This field will be %NULL if no flash device is present (or for Siena).
678
 * @spi_eeprom: SPI EEPROM device
679
 *	This field will be %NULL if no EEPROM device is present (or for Siena).
680
 * @spi_lock: SPI bus lock
681
 * @mtd_list: List of MTDs attached to the NIC
682
683
 * @n_rx_nodesc_drop_cnt: RX no descriptor drop count
 * @nic_data: Hardware dependant state
Ben Hutchings's avatar
Ben Hutchings committed
684
685
 * @mac_lock: MAC access lock. Protects @port_enabled, @phy_mode,
 *	@port_inhibited, efx_monitor() and efx_reconfigure_port()
686
 * @port_enabled: Port enabled indicator.
Steve Hodgson's avatar
Steve Hodgson committed
687
688
689
690
 *	Serialises efx_stop_all(), efx_start_all(), efx_monitor() and
 *	efx_mac_work() with kernel interfaces. Safe to read under any
 *	one of the rtnl_lock, mac_lock, or netif_tx_lock, but all three must
 *	be held to modify it.
Ben Hutchings's avatar
Ben Hutchings committed
691
 * @port_inhibited: If set, the netif_carrier is always off. Hold the mac_lock
692
693
694
695
696
697
698
699
700
 * @port_initialized: Port initialized?
 * @net_dev: Operating system network device. Consider holding the rtnl lock
 * @rx_checksum_enabled: RX checksumming enabled
 * @netif_stop_count: Port stop count
 * @netif_stop_lock: Port stop lock
 * @mac_stats: MAC statistics. These include all statistics the MACs
 *	can provide.  Generic code converts these into a standard
 *	&struct net_device_stats.
 * @stats_buffer: DMA buffer for statistics
Ben Hutchings's avatar
Ben Hutchings committed
701
 * @stats_lock: Statistics update lock. Serialises statistics fetches
702
 * @mac_op: MAC interface
703
704
 * @mac_address: Permanent MAC address
 * @phy_type: PHY type
705
 * @mdio_lock: MDIO lock
706
707
 * @phy_op: PHY interface
 * @phy_data: PHY private data (including PHY-specific stats)
708
 * @mdio: PHY MDIO interface
709
 * @mdio_bus: PHY MDIO bus ID (only used by Siena)
Ben Hutchings's avatar
Ben Hutchings committed
710
 * @phy_mode: PHY operating mode. Serialised by @mac_lock.
711
 * @xmac_poll_required: XMAC link state needs polling
712
 * @link_advertising: Autonegotiation advertising flags
713
 * @link_state: Current state of the link
714
715
716
 * @n_link_state_changes: Number of times the link has changed state
 * @promiscuous: Promiscuous flag. Protected by netif_tx_lock.
 * @multicast_hash: Multicast hash table
717
 * @wanted_fc: Wanted flow control flags
718
 * @mac_work: Work item for changing MAC promiscuity and multicast hash
719
720
721
 * @loopback_mode: Loopback status
 * @loopback_modes: Supported loopback mode bitmask
 * @loopback_selftest: Offline self-test private state
722
 *
723
 * This is stored in the private area of the &struct net_device.
724
725
726
727
728
729
730
 */
struct efx_nic {
	char name[IFNAMSIZ];
	struct pci_dev *pci_dev;
	const struct efx_nic_type *type;
	int legacy_irq;
	struct workqueue_struct *workqueue;
731
	char workqueue_name[16];
732
733
	struct work_struct reset_work;
	struct delayed_work monitor_work;
734
	resource_size_t membase_phys;
735
736
737
	void __iomem *membase;
	spinlock_t biu_lock;
	enum efx_int_mode interrupt_mode;
738
739
	bool irq_rx_adaptive;
	unsigned int irq_rx_moderation;
740
741
742
743

	enum nic_state state;
	enum reset_type reset_pending;

744
	struct efx_tx_queue tx_queue[EFX_TX_QUEUE_COUNT];
745
746
747
	struct efx_rx_queue rx_queue[EFX_MAX_RX_QUEUES];
	struct efx_channel channel[EFX_MAX_CHANNELS];

748
	unsigned next_buffer_table;
749
	int n_rx_queues;
750
	int n_channels;
751
752
753
	unsigned int rx_buffer_len;
	unsigned int rx_buffer_order;

754
755
756
	unsigned int_error_count;
	unsigned long int_error_expire;

757
758
	struct efx_buffer irq_status;
	volatile signed int last_irq_cpu;
759
	unsigned long irq_zero_count;
760
	unsigned fatal_irq_level;
761

762
763
	struct efx_spi_device *spi_flash;
	struct efx_spi_device *spi_eeprom;
764
	struct mutex spi_lock;
765
766
767
#ifdef CONFIG_SFC_MTD
	struct list_head mtd_list;
#endif
768

769
770
	unsigned n_rx_nodesc_drop_cnt;

771
	void *nic_data;
772
773

	struct mutex mac_lock;
774
	struct work_struct mac_work;
775
	bool port_enabled;
Ben Hutchings's avatar
Ben Hutchings committed
776
	bool port_inhibited;
777

778
	bool port_initialized;
779
	struct net_device *net_dev;
780
	bool rx_checksum_enabled;
781
782
783
784
785
786
787
788

	atomic_t netif_stop_count;
	spinlock_t netif_stop_lock;

	struct efx_mac_stats mac_stats;
	struct efx_buffer stats_buffer;
	spinlock_t stats_lock;

789
	struct efx_mac_operations *mac_op;
790
791
	unsigned char mac_address[ETH_ALEN];

792
	unsigned int phy_type;
793
	struct mutex mdio_lock;
794
795
	struct efx_phy_operations *phy_op;
	void *phy_data;
796
	struct mdio_if_info mdio;
797
	unsigned int mdio_bus;
798
	enum efx_phy_mode phy_mode;
799

800
	bool xmac_poll_required;
801
	u32 link_advertising;
802
	struct efx_link_state link_state;
803
804
	unsigned int n_link_state_changes;

805
	bool promiscuous;
806
	union efx_multicast_hash multicast_hash;
807
	enum efx_fc_type wanted_fc;
808
809

	atomic_t rx_reset;
810
	enum efx_loopback_mode loopback_mode;
811
	u64 loopback_modes;
812
813

	void *loopback_selftest;
814
815
};

816
817
818
819
820
821
822
823
824
825
826
827
828
829
static inline int efx_dev_registered(struct efx_nic *efx)
{
	return efx->net_dev->reg_state == NETREG_REGISTERED;
}

/* Net device name, for inclusion in log messages if it has been registered.
 * Use efx->name not efx->net_dev->name so that races with (un)registration
 * are harmless.
 */
static inline const char *efx_dev_name(struct efx_nic *efx)
{
	return efx_dev_registered(efx) ? efx->name : "";
}

830
831
832
833
834
static inline unsigned int efx_port_num(struct efx_nic *efx)
{
	return PCI_FUNC(efx->pci_dev->devfn);
}

835
836
/**
 * struct efx_nic_type - Efx device type definition
837
838
839
840
841
842
843
844
845
846
847
848
849
 * @probe: Probe the controller
 * @remove: Free resources allocated by probe()
 * @init: Initialise the controller
 * @fini: Shut down the controller
 * @monitor: Periodic function for polling link state and hardware monitor
 * @reset: Reset the controller hardware and possibly the PHY.  This will
 *	be called while the controller is uninitialised.
 * @probe_port: Probe the MAC and PHY
 * @remove_port: Free resources allocated by probe_port()
 * @prepare_flush: Prepare the hardware for flushing the DMA queues
 * @update_stats: Update statistics not provided by event handling
 * @start_stats: Start the regular fetching of statistics
 * @stop_stats: Stop the regular fetching of statistics
850
 * @set_id_led: Set state of identifying LED or revert to automatic function
851
852
 * @push_irq_moderation: Apply interrupt moderation value
 * @push_multicast_hash: Apply multicast hash table
853
 * @reconfigure_port: Push loopback/power/txdis changes to the MAC and PHY
854
855
856
 * @get_wol: Get WoL configuration from driver state
 * @set_wol: Push WoL configuration to the NIC
 * @resume_wol: Synchronise WoL state between driver and MC (e.g. after resume)
857
 * @test_registers: Test read/write functionality of control registers
858
 * @test_nvram: Test validity of NVRAM contents
859
 * @default_mac_ops: efx_mac_operations to set at startup
860
 * @revision: Hardware architecture revision
861
862
863
864
865
866
867
868
869
870
871
872
 * @mem_map_size: Memory BAR mapped size
 * @txd_ptr_tbl_base: TX descriptor ring base address
 * @rxd_ptr_tbl_base: RX descriptor ring base address
 * @buf_tbl_base: Buffer table base address
 * @evq_ptr_tbl_base: Event queue pointer table base address
 * @evq_rptr_tbl_base: Event queue read-pointer table base address
 * @max_dma_mask: Maximum possible DMA mask
 * @rx_buffer_padding: Padding added to each RX buffer
 * @max_interrupt_mode: Highest capability interrupt mode supported
 *	from &enum efx_init_mode.
 * @phys_addr_channels: Number of channels with physically addressed
 *	descriptors
873
874
 * @tx_dc_base: Base address in SRAM of TX queue descriptor caches
 * @rx_dc_base: Base address in SRAM of RX queue descriptor caches
875
876
 * @offload_features: net_device feature flags for protocol offload
 *	features implemented in hardware
877
878
 * @reset_world_flags: Flags for additional components covered by
 *	reset method RESET_TYPE_WORLD
879
880
 */
struct efx_nic_type {
881
882
883
884
885
886
887
888
889
890
891
892
	int (*probe)(struct efx_nic *efx);
	void (*remove)(struct efx_nic *efx);
	int (*init)(struct efx_nic *efx);
	void (*fini)(struct efx_nic *efx);
	void (*monitor)(struct efx_nic *efx);
	int (*reset)(struct efx_nic *efx, enum reset_type method);
	int (*probe_port)(struct efx_nic *efx);
	void (*remove_port)(struct efx_nic *efx);
	void (*prepare_flush)(struct efx_nic *efx);
	void (*update_stats)(struct efx_nic *efx);
	void (*start_stats)(struct efx_nic *efx);
	void (*stop_stats)(struct efx_nic *efx);
893
	void (*set_id_led)(struct efx_nic *efx, enum efx_led_mode mode);
894
895
	void (*push_irq_moderation)(struct efx_channel *channel);
	void (*push_multicast_hash)(struct efx_nic *efx);
896
	int (*reconfigure_port)(struct efx_nic *efx);
897
898
899
	void (*get_wol)(struct efx_nic *efx, struct ethtool_wolinfo *wol);
	int (*set_wol)(struct efx_nic *efx, u32 type);
	void (*resume_wol)(struct efx_nic *efx);
900
	int (*test_registers)(struct efx_nic *efx);
901
	int (*test_nvram)(struct efx_nic *efx);
902
903
	struct efx_mac_operations *default_mac_ops;

904
	int revision;
905
906
907
908
909
910
	unsigned int mem_map_size;
	unsigned int txd_ptr_tbl_base;
	unsigned int rxd_ptr_tbl_base;
	unsigned int buf_tbl_base;
	unsigned int evq_ptr_tbl_base;
	unsigned int evq_rptr_tbl_base;
911
	u64 max_dma_mask;
912
913
914
	unsigned int rx_buffer_padding;
	unsigned int max_interrupt_mode;
	unsigned int phys_addr_channels;
915
916
	unsigned int tx_dc_base;
	unsigned int rx_dc_base;
917
	unsigned long offload_features;
918
	u32 reset_world_flags;
919
920
921
922
923
924
925
926
927
928
};

/**************************************************************************
 *
 * Prototypes and inline functions
 *
 *************************************************************************/

/* Iterate over all used channels */
#define efx_for_each_channel(_channel, _efx)				\
929
930
	for (_channel = &((_efx)->channel[0]);				\
	     _channel < &((_efx)->channel[EFX_MAX_CHANNELS]);		\
931
932
933
934
935
936
937
	     _channel++)						\
		if (!_channel->used_flags)				\
			continue;					\
		else

/* Iterate over all used TX queues */
#define efx_for_each_tx_queue(_tx_queue, _efx)				\
938
939
	for (_tx_queue = &((_efx)->tx_queue[0]);			\
	     _tx_queue < &((_efx)->tx_queue[EFX_TX_QUEUE_COUNT]);	\
940
	     _tx_queue++)
941
942
943

/* Iterate over all TX queues belonging to a channel */
#define efx_for_each_channel_tx_queue(_tx_queue, _channel)		\
944
945
	for (_tx_queue = &((_channel)->efx->tx_queue[0]);		\
	     _tx_queue < &((_channel)->efx->tx_queue[EFX_TX_QUEUE_COUNT]); \
946
	     _tx_queue++)						\
947
		if (_tx_queue->channel != (_channel))			\
948
949
950
951
952
			continue;					\
		else

/* Iterate over all used RX queues */
#define efx_for_each_rx_queue(_rx_queue, _efx)				\
953
954
	for (_rx_queue = &((_efx)->rx_queue[0]);			\
	     _rx_queue < &((_efx)->rx_queue[(_efx)->n_rx_queues]);	\
955
	     _rx_queue++)
956
957
958

/* Iterate over all RX queues belonging to a channel */
#define efx_for_each_channel_rx_queue(_rx_queue, _channel)		\
959
	for (_rx_queue = &((_channel)->efx->rx_queue[(_channel)->channel]); \
960
961
	     _rx_queue;							\
	     _rx_queue = NULL)						\
962
		if (_rx_queue->channel != (_channel))			\
963
964
965
966
967
968
969
970
971
972
973
974
975
			continue;					\
		else

/* Returns a pointer to the specified receive buffer in the RX
 * descriptor queue.
 */
static inline struct efx_rx_buffer *efx_rx_buffer(struct efx_rx_queue *rx_queue,
						  unsigned int index)
{
	return (&rx_queue->buffer[index]);
}

/* Set bit in a little-endian bitfield */
976
static inline void set_bit_le(unsigned nr, unsigned char *addr)
977
978
979
980
981
{
	addr[nr / 8] |= (1 << (nr % 8));
}

/* Clear bit in a little-endian bitfield */
982
static inline void clear_bit_le(unsigned nr, unsigned char *addr)
983
984
985
986
987
988
989
990
991
992
993
994
995
996
{
	addr[nr / 8] &= ~(1 << (nr % 8));
}


/**
 * EFX_MAX_FRAME_LEN - calculate maximum frame length
 *
 * This calculates the maximum frame length that will be used for a
 * given MTU.  The frame length will be equal to the MTU plus a
 * constant amount of header space and padding.  This is the quantity
 * that the net driver will program into the MAC as the maximum frame
 * length.
 *
997
 * The 10G MAC requires 8-byte alignment on the frame
998
 * length, so we round up to the nearest 8.
999
1000
1001
1002
1003
 *
 * Re-clocking by the XGXS on RX can reduce an IPG to 32 bits (half an
 * XGMII cycle).  If the frame length reaches the maximum value in the
 * same cycle, the XMAC can miss the IPG altogether.  We work around
 * this by adding a further 16 bytes.
1004
1005
 */
#define EFX_MAX_FRAME_LEN(mtu) \
1006
	((((mtu) + ETH_HLEN + VLAN_HLEN + 4/* FCS */ + 7) & ~7) + 16)
1007
1008
1009


#endif /* EFX_NET_DRIVER_H */