blob: f47bac78b92c1b75b91ae312a86fb31b1f704eb3 [file] [log] [blame]
Ben Hutchings8ceee662008-04-27 12:55:59 +01001/****************************************************************************
Ben Hutchingsf7a6d2c2013-08-29 23:32:48 +01002 * Driver for Solarflare network controllers and boards
Ben Hutchings8ceee662008-04-27 12:55:59 +01003 * Copyright 2005-2006 Fen Systems Ltd.
Ben Hutchingsf7a6d2c2013-08-29 23:32:48 +01004 * Copyright 2005-2013 Solarflare Communications Inc.
Ben Hutchings8ceee662008-04-27 12:55:59 +01005 *
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
Ben Hutchings8ceee662008-04-27 12:55:59 +010016#include <linux/netdevice.h>
17#include <linux/etherdevice.h>
18#include <linux/ethtool.h>
19#include <linux/if_vlan.h>
Steve Hodgson90d683a2010-06-01 11:19:39 +000020#include <linux/timer.h>
Ben Hutchings68e7f452009-04-29 08:05:08 +000021#include <linux/mdio.h>
Ben Hutchings8ceee662008-04-27 12:55:59 +010022#include <linux/list.h>
23#include <linux/pci.h>
24#include <linux/device.h>
25#include <linux/highmem.h>
26#include <linux/workqueue.h>
Ben Hutchingscd2d5b52012-02-14 00:48:07 +000027#include <linux/mutex.h>
David S. Miller10ed61c2010-09-21 16:11:06 -070028#include <linux/vmalloc.h>
Ben Hutchings37b5a602008-05-30 22:27:04 +010029#include <linux/i2c.h>
Ben Hutchings45a3fd52012-11-28 04:38:14 +000030#include <linux/mtd/mtd.h>
Ben Hutchings8ceee662008-04-27 12:55:59 +010031
32#include "enum.h"
33#include "bitfield.h"
Ben Hutchingsadd72472012-11-08 01:46:53 +000034#include "filter.h"
Ben Hutchings8ceee662008-04-27 12:55:59 +010035
Ben Hutchings8ceee662008-04-27 12:55:59 +010036/**************************************************************************
37 *
38 * Build definitions
39 *
40 **************************************************************************/
Ben Hutchingsc5d5f5f2010-06-23 11:30:26 +000041
Ben Hutchings8127d662013-08-29 19:19:29 +010042#define EFX_DRIVER_VERSION "4.0"
Ben Hutchings8ceee662008-04-27 12:55:59 +010043
Ben Hutchings5f3f9d62011-11-04 22:29:14 +000044#ifdef DEBUG
Ben Hutchings8ceee662008-04-27 12:55:59 +010045#define EFX_BUG_ON_PARANOID(x) BUG_ON(x)
46#define EFX_WARN_ON_PARANOID(x) WARN_ON(x)
47#else
48#define EFX_BUG_ON_PARANOID(x) do {} while (0)
49#define EFX_WARN_ON_PARANOID(x) do {} while (0)
50#endif
51
Ben Hutchings8ceee662008-04-27 12:55:59 +010052/**************************************************************************
53 *
54 * Efx data structures
55 *
56 **************************************************************************/
57
Ben Hutchingsa16e5b22012-02-14 00:40:12 +000058#define EFX_MAX_CHANNELS 32U
Ben Hutchings8ceee662008-04-27 12:55:59 +010059#define EFX_MAX_RX_QUEUES EFX_MAX_CHANNELS
Ben Hutchingscd2d5b52012-02-14 00:48:07 +000060#define EFX_EXTRA_CHANNEL_IOV 0
Stuart Hodgson7c236c42012-09-03 11:09:36 +010061#define EFX_EXTRA_CHANNEL_PTP 1
62#define EFX_MAX_EXTRA_CHANNELS 2U
Ben Hutchings8ceee662008-04-27 12:55:59 +010063
Ben Hutchingsa4900ac2010-04-28 09:30:43 +000064/* Checksum generation is a per-queue option in hardware, so each
65 * queue visible to the networking core is backed by two hardware TX
66 * queues. */
Ben Hutchings94b274b2011-01-10 21:18:20 +000067#define EFX_MAX_TX_TC 2
68#define EFX_MAX_CORE_TX_QUEUES (EFX_MAX_TX_TC * EFX_MAX_CHANNELS)
69#define EFX_TXQ_TYPE_OFFLOAD 1 /* flag */
70#define EFX_TXQ_TYPE_HIGHPRI 2 /* flag */
71#define EFX_TXQ_TYPES 4
72#define EFX_MAX_TX_QUEUES (EFX_TXQ_TYPES * EFX_MAX_CHANNELS)
Ben Hutchings60ac1062008-09-01 12:44:59 +010073
Ben Hutchings85740cdf2013-01-29 23:33:15 +000074/* Maximum possible MTU the driver supports */
75#define EFX_MAX_MTU (9 * 1024)
76
Ben Hutchings950c54d2013-05-13 12:01:22 +000077/* Size of an RX scatter buffer. Small enough to pack 2 into a 4K page,
78 * and should be a multiple of the cache line size.
79 */
80#define EFX_RX_USR_BUF_SIZE (2048 - 256)
81
82/* If possible, we should ensure cache line alignment at start and end
83 * of every buffer. Otherwise, we just need to ensure 4-byte
84 * alignment of the network header.
85 */
86#if NET_IP_ALIGN == 0
87#define EFX_RX_BUF_ALIGNMENT L1_CACHE_BYTES
88#else
89#define EFX_RX_BUF_ALIGNMENT 4
90#endif
Ben Hutchings85740cdf2013-01-29 23:33:15 +000091
Stuart Hodgson7c236c42012-09-03 11:09:36 +010092/* Forward declare Precision Time Protocol (PTP) support structure. */
93struct efx_ptp_data;
94
Ben Hutchingsd4f2cec2012-07-04 03:58:33 +010095struct efx_self_tests;
96
Ben Hutchings8ceee662008-04-27 12:55:59 +010097/**
Ben Hutchingscaa75582012-09-19 00:31:42 +010098 * struct efx_buffer - A general-purpose DMA buffer
99 * @addr: host base address of the buffer
Ben Hutchings8ceee662008-04-27 12:55:59 +0100100 * @dma_addr: DMA base address of the buffer
101 * @len: Buffer length, in bytes
Ben Hutchings8ceee662008-04-27 12:55:59 +0100102 *
Ben Hutchingscaa75582012-09-19 00:31:42 +0100103 * The NIC uses these buffers for its interrupt status registers and
104 * MAC stats dumps.
Ben Hutchings8ceee662008-04-27 12:55:59 +0100105 */
Ben Hutchingscaa75582012-09-19 00:31:42 +0100106struct efx_buffer {
Ben Hutchings8ceee662008-04-27 12:55:59 +0100107 void *addr;
108 dma_addr_t dma_addr;
109 unsigned int len;
Ben Hutchingscaa75582012-09-19 00:31:42 +0100110};
111
112/**
113 * struct efx_special_buffer - DMA buffer entered into buffer table
114 * @buf: Standard &struct efx_buffer
115 * @index: Buffer index within controller;s buffer table
116 * @entries: Number of buffer table entries
117 *
118 * The NIC has a buffer table that maps buffers of size %EFX_BUF_SIZE.
119 * Event and descriptor rings are addressed via one or more buffer
120 * table entries (and so can be physically non-contiguous, although we
121 * currently do not take advantage of that). On Falcon and Siena we
122 * have to take care of allocating and initialising the entries
123 * ourselves. On later hardware this is managed by the firmware and
124 * @index and @entries are left as 0.
125 */
126struct efx_special_buffer {
127 struct efx_buffer buf;
Ben Hutchings5bbe2f42012-02-13 23:14:23 +0000128 unsigned int index;
129 unsigned int entries;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100130};
131
132/**
Ben Hutchings7668ff92012-05-17 20:52:20 +0100133 * struct efx_tx_buffer - buffer state for a TX descriptor
134 * @skb: When @flags & %EFX_TX_BUF_SKB, the associated socket buffer to be
135 * freed when descriptor completes
Ben Hutchingsf7251a92012-05-17 18:40:54 +0100136 * @heap_buf: When @flags & %EFX_TX_BUF_HEAP, the associated heap buffer to be
137 * freed when descriptor completes.
Ben Hutchingsba8977b2013-01-08 23:43:19 +0000138 * @option: When @flags & %EFX_TX_BUF_OPTION, a NIC-specific option descriptor.
Ben Hutchings8ceee662008-04-27 12:55:59 +0100139 * @dma_addr: DMA address of the fragment.
Ben Hutchings7668ff92012-05-17 20:52:20 +0100140 * @flags: Flags for allocation and DMA mapping type
Ben Hutchings8ceee662008-04-27 12:55:59 +0100141 * @len: Length of this fragment.
142 * This field is zero when the queue slot is empty.
Ben Hutchings8ceee662008-04-27 12:55:59 +0100143 * @unmap_len: Length of this fragment to unmap
Alexandre Rames2acdb922013-10-31 12:42:32 +0000144 * @dma_offset: Offset of @dma_addr from the address of the backing DMA mapping.
145 * Only valid if @unmap_len != 0.
Ben Hutchings8ceee662008-04-27 12:55:59 +0100146 */
147struct efx_tx_buffer {
Ben Hutchings7668ff92012-05-17 20:52:20 +0100148 union {
149 const struct sk_buff *skb;
Ben Hutchingsf7251a92012-05-17 18:40:54 +0100150 void *heap_buf;
Ben Hutchings7668ff92012-05-17 20:52:20 +0100151 };
Ben Hutchingsba8977b2013-01-08 23:43:19 +0000152 union {
153 efx_qword_t option;
154 dma_addr_t dma_addr;
155 };
Ben Hutchings7668ff92012-05-17 20:52:20 +0100156 unsigned short flags;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100157 unsigned short len;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100158 unsigned short unmap_len;
Alexandre Rames2acdb922013-10-31 12:42:32 +0000159 unsigned short dma_offset;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100160};
Ben Hutchings7668ff92012-05-17 20:52:20 +0100161#define EFX_TX_BUF_CONT 1 /* not last descriptor of packet */
162#define EFX_TX_BUF_SKB 2 /* buffer is last part of skb */
Ben Hutchingsf7251a92012-05-17 18:40:54 +0100163#define EFX_TX_BUF_HEAP 4 /* buffer was allocated with kmalloc() */
Ben Hutchings7668ff92012-05-17 20:52:20 +0100164#define EFX_TX_BUF_MAP_SINGLE 8 /* buffer was mapped with dma_map_single() */
Ben Hutchingsba8977b2013-01-08 23:43:19 +0000165#define EFX_TX_BUF_OPTION 0x10 /* empty buffer for option descriptor */
Ben Hutchings8ceee662008-04-27 12:55:59 +0100166
167/**
168 * struct efx_tx_queue - An Efx TX queue
169 *
170 * This is a ring buffer of TX fragments.
171 * Since the TX completion path always executes on the same
172 * CPU and the xmit path can operate on different CPUs,
173 * performance is increased by ensuring that the completion
174 * path and the xmit path operate on different cache lines.
175 * This is particularly important if the xmit path is always
176 * executing on one CPU which is different from the completion
177 * path. There is also a cache line for members which are
178 * read but not written on the fast path.
179 *
180 * @efx: The associated Efx NIC
181 * @queue: DMA queue number
Ben Hutchings8ceee662008-04-27 12:55:59 +0100182 * @channel: The associated channel
Ben Hutchingsc04bfc62010-12-10 01:24:16 +0000183 * @core_txq: The networking core TX queue structure
Ben Hutchings8ceee662008-04-27 12:55:59 +0100184 * @buffer: The software buffer ring
Ben Hutchingsf7251a92012-05-17 18:40:54 +0100185 * @tsoh_page: Array of pages of TSO header buffers
Ben Hutchings8ceee662008-04-27 12:55:59 +0100186 * @txd: The hardware descriptor ring
Steve Hodgsonecc910f2010-09-10 06:42:22 +0000187 * @ptr_mask: The size of the ring minus 1.
Ben Hutchings183233b2013-06-28 21:47:12 +0100188 * @piobuf: PIO buffer region for this TX queue (shared with its partner).
189 * Size of the region is efx_piobuf_size.
190 * @piobuf_offset: Buffer offset to be specified in PIO descriptors
Ben Hutchings94b274b2011-01-10 21:18:20 +0000191 * @initialised: Has hardware queue been initialised?
Ben Hutchings8ceee662008-04-27 12:55:59 +0100192 * @read_count: Current read pointer.
193 * This is the number of buffers that have been removed from both rings.
Ben Hutchingscd385572010-11-15 23:53:11 +0000194 * @old_write_count: The value of @write_count when last checked.
195 * This is here for performance reasons. The xmit path will
196 * only get the up-to-date value of @write_count if this
197 * variable indicates that the queue is empty. This is to
198 * avoid cache-line ping-pong between the xmit path and the
199 * completion path.
Ben Hutchings02e12162013-04-27 01:55:21 +0100200 * @merge_events: Number of TX merged completion events
Ben Hutchings8ceee662008-04-27 12:55:59 +0100201 * @insert_count: Current insert pointer
202 * This is the number of buffers that have been added to the
203 * software ring.
204 * @write_count: Current write pointer
205 * This is the number of buffers that have been added to the
206 * hardware ring.
207 * @old_read_count: The value of read_count when last checked.
208 * This is here for performance reasons. The xmit path will
209 * only get the up-to-date value of read_count if this
210 * variable indicates that the queue is full. This is to
211 * avoid cache-line ping-pong between the xmit path and the
212 * completion path.
Ben Hutchingsb9b39b62008-05-07 12:51:12 +0100213 * @tso_bursts: Number of times TSO xmit invoked by kernel
214 * @tso_long_headers: Number of packets with headers too long for standard
215 * blocks
216 * @tso_packets: Number of packets via the TSO xmit path
Ben Hutchingscd385572010-11-15 23:53:11 +0000217 * @pushes: Number of times the TX push feature has been used
Jon Cooperee45fd92013-09-02 18:24:29 +0100218 * @pio_packets: Number of times the TX PIO feature has been used
Ben Hutchingscd385572010-11-15 23:53:11 +0000219 * @empty_read_count: If the completion path has seen the queue as empty
220 * and the transmission path has not yet checked this, the value of
221 * @read_count bitwise-added to %EFX_EMPTY_COUNT_VALID; otherwise 0.
Ben Hutchings8ceee662008-04-27 12:55:59 +0100222 */
223struct efx_tx_queue {
224 /* Members which don't change on the fast path */
225 struct efx_nic *efx ____cacheline_aligned_in_smp;
Ben Hutchingsa4900ac2010-04-28 09:30:43 +0000226 unsigned queue;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100227 struct efx_channel *channel;
Ben Hutchingsc04bfc62010-12-10 01:24:16 +0000228 struct netdev_queue *core_txq;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100229 struct efx_tx_buffer *buffer;
Ben Hutchingsf7251a92012-05-17 18:40:54 +0100230 struct efx_buffer *tsoh_page;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100231 struct efx_special_buffer txd;
Steve Hodgsonecc910f2010-09-10 06:42:22 +0000232 unsigned int ptr_mask;
Ben Hutchings183233b2013-06-28 21:47:12 +0100233 void __iomem *piobuf;
234 unsigned int piobuf_offset;
Ben Hutchings94b274b2011-01-10 21:18:20 +0000235 bool initialised;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100236
237 /* Members used mainly on the completion path */
238 unsigned int read_count ____cacheline_aligned_in_smp;
Ben Hutchingscd385572010-11-15 23:53:11 +0000239 unsigned int old_write_count;
Ben Hutchings02e12162013-04-27 01:55:21 +0100240 unsigned int merge_events;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100241
242 /* Members used only on the xmit path */
243 unsigned int insert_count ____cacheline_aligned_in_smp;
244 unsigned int write_count;
245 unsigned int old_read_count;
Ben Hutchingsb9b39b62008-05-07 12:51:12 +0100246 unsigned int tso_bursts;
247 unsigned int tso_long_headers;
248 unsigned int tso_packets;
Ben Hutchingscd385572010-11-15 23:53:11 +0000249 unsigned int pushes;
Jon Cooperee45fd92013-09-02 18:24:29 +0100250 unsigned int pio_packets;
Ben Hutchingscd385572010-11-15 23:53:11 +0000251
252 /* Members shared between paths and sometimes updated */
253 unsigned int empty_read_count ____cacheline_aligned_in_smp;
254#define EFX_EMPTY_COUNT_VALID 0x80000000
Daniel Pieczko525d9e82012-10-02 13:36:18 +0100255 atomic_t flush_outstanding;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100256};
257
258/**
259 * struct efx_rx_buffer - An Efx RX data buffer
260 * @dma_addr: DMA base address of the buffer
Alexandre Rames97d48a12013-01-11 12:26:21 +0000261 * @page: The associated page buffer.
Ben Hutchingsdb339562011-08-26 18:05:11 +0100262 * Will be %NULL if the buffer slot is currently free.
Ben Hutchingsb74e3e82013-01-29 23:33:15 +0000263 * @page_offset: If pending: offset in @page of DMA base address.
264 * If completed: offset in @page of Ethernet header.
Ben Hutchings80c2e712013-01-23 21:52:13 +0000265 * @len: If pending: length for DMA descriptor.
266 * If completed: received length, excluding hash prefix.
Ben Hutchings85740cdf2013-01-29 23:33:15 +0000267 * @flags: Flags for buffer and packet state. These are only set on the
268 * first buffer of a scattered packet.
Ben Hutchings8ceee662008-04-27 12:55:59 +0100269 */
270struct efx_rx_buffer {
271 dma_addr_t dma_addr;
Alexandre Rames97d48a12013-01-11 12:26:21 +0000272 struct page *page;
Ben Hutchingsb590ace2013-01-10 23:51:54 +0000273 u16 page_offset;
274 u16 len;
Ben Hutchingsdb339562011-08-26 18:05:11 +0100275 u16 flags;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100276};
Ben Hutchings179ea7f2013-03-07 16:31:17 +0000277#define EFX_RX_BUF_LAST_IN_PAGE 0x0001
Ben Hutchingsdb339562011-08-26 18:05:11 +0100278#define EFX_RX_PKT_CSUMMED 0x0002
279#define EFX_RX_PKT_DISCARD 0x0004
Ben Hutchingsd07df8e2013-05-16 18:38:11 +0100280#define EFX_RX_PKT_TCP 0x0040
Ben Hutchings3dced742013-04-27 01:55:18 +0100281#define EFX_RX_PKT_PREFIX_LEN 0x0080 /* length is in prefix only */
Ben Hutchings8ceee662008-04-27 12:55:59 +0100282
283/**
Steve Hodgson62b330b2010-06-01 11:20:53 +0000284 * struct efx_rx_page_state - Page-based rx buffer state
285 *
286 * Inserted at the start of every page allocated for receive buffers.
287 * Used to facilitate sharing dma mappings between recycled rx buffers
288 * and those passed up to the kernel.
289 *
290 * @refcnt: Number of struct efx_rx_buffer's referencing this page.
291 * When refcnt falls to zero, the page is unmapped for dma
292 * @dma_addr: The dma address of this page.
293 */
294struct efx_rx_page_state {
295 unsigned refcnt;
296 dma_addr_t dma_addr;
297
298 unsigned int __pad[0] ____cacheline_aligned;
299};
300
301/**
Ben Hutchings8ceee662008-04-27 12:55:59 +0100302 * struct efx_rx_queue - An Efx RX queue
303 * @efx: The associated Efx NIC
Stuart Hodgson79d68b32012-07-16 17:08:33 +0100304 * @core_index: Index of network core RX queue. Will be >= 0 iff this
305 * is associated with a real RX queue.
Ben Hutchings8ceee662008-04-27 12:55:59 +0100306 * @buffer: The software buffer ring
307 * @rxd: The hardware descriptor ring
Steve Hodgsonecc910f2010-09-10 06:42:22 +0000308 * @ptr_mask: The size of the ring minus 1.
Ben Hutchingsd8aec742013-05-27 16:52:54 +0100309 * @refill_enabled: Enable refill whenever fill level is low
Ben Hutchings9f2cb712012-02-08 00:11:20 +0000310 * @flush_pending: Set when a RX flush is pending. Has the same lifetime as
311 * @rxq_flush_pending.
Ben Hutchings8ceee662008-04-27 12:55:59 +0100312 * @added_count: Number of buffers added to the receive queue.
313 * @notified_count: Number of buffers given to NIC (<= @added_count).
314 * @removed_count: Number of buffers removed from the receive queue.
Jon Coopere8c68c02013-03-08 10:18:28 +0000315 * @scatter_n: Used by NIC specific receive code.
316 * @scatter_len: Used by NIC specific receive code.
Daniel Pieczko27689352013-02-13 10:54:41 +0000317 * @page_ring: The ring to store DMA mapped pages for reuse.
318 * @page_add: Counter to calculate the write pointer for the recycle ring.
319 * @page_remove: Counter to calculate the read pointer for the recycle ring.
320 * @page_recycle_count: The number of pages that have been recycled.
321 * @page_recycle_failed: The number of pages that couldn't be recycled because
322 * the kernel still held a reference to them.
323 * @page_recycle_full: The number of pages that were released because the
324 * recycle ring was full.
325 * @page_ptr_mask: The number of pages in the RX recycle ring minus 1.
Ben Hutchings8ceee662008-04-27 12:55:59 +0100326 * @max_fill: RX descriptor maximum fill level (<= ring size)
327 * @fast_fill_trigger: RX descriptor fill level that will trigger a fast fill
328 * (<= @max_fill)
Ben Hutchings8ceee662008-04-27 12:55:59 +0100329 * @min_fill: RX descriptor minimum non-zero fill level.
330 * This records the minimum fill level observed when a ring
331 * refill was triggered.
Daniel Pieczko27689352013-02-13 10:54:41 +0000332 * @recycle_count: RX buffer recycle counter.
Steve Hodgson90d683a2010-06-01 11:19:39 +0000333 * @slow_fill: Timer used to defer efx_nic_generate_fill_event().
Ben Hutchings8ceee662008-04-27 12:55:59 +0100334 */
335struct efx_rx_queue {
336 struct efx_nic *efx;
Stuart Hodgson79d68b32012-07-16 17:08:33 +0100337 int core_index;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100338 struct efx_rx_buffer *buffer;
339 struct efx_special_buffer rxd;
Steve Hodgsonecc910f2010-09-10 06:42:22 +0000340 unsigned int ptr_mask;
Ben Hutchingsd8aec742013-05-27 16:52:54 +0100341 bool refill_enabled;
Ben Hutchings9f2cb712012-02-08 00:11:20 +0000342 bool flush_pending;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100343
Ben Hutchings9bc2fc92013-01-29 23:33:14 +0000344 unsigned int added_count;
345 unsigned int notified_count;
346 unsigned int removed_count;
Ben Hutchings85740cdf2013-01-29 23:33:15 +0000347 unsigned int scatter_n;
Jon Coopere8c68c02013-03-08 10:18:28 +0000348 unsigned int scatter_len;
Daniel Pieczko27689352013-02-13 10:54:41 +0000349 struct page **page_ring;
350 unsigned int page_add;
351 unsigned int page_remove;
352 unsigned int page_recycle_count;
353 unsigned int page_recycle_failed;
354 unsigned int page_recycle_full;
355 unsigned int page_ptr_mask;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100356 unsigned int max_fill;
357 unsigned int fast_fill_trigger;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100358 unsigned int min_fill;
359 unsigned int min_overfill;
Daniel Pieczko27689352013-02-13 10:54:41 +0000360 unsigned int recycle_count;
Steve Hodgson90d683a2010-06-01 11:19:39 +0000361 struct timer_list slow_fill;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100362 unsigned int slow_fill_count;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100363};
364
Ben Hutchings8ceee662008-04-27 12:55:59 +0100365enum efx_rx_alloc_method {
366 RX_ALLOC_METHOD_AUTO = 0,
367 RX_ALLOC_METHOD_SKB = 1,
368 RX_ALLOC_METHOD_PAGE = 2,
369};
370
371/**
372 * struct efx_channel - An Efx channel
373 *
374 * A channel comprises an event queue, at least one TX queue, at least
375 * one RX queue, and an associated tasklet for processing the event
376 * queue.
377 *
378 * @efx: Associated Efx NIC
Ben Hutchings8ceee662008-04-27 12:55:59 +0100379 * @channel: Channel instance number
Ben Hutchings7f967c02012-02-13 23:45:02 +0000380 * @type: Channel type definition
Ben Hutchingsbe3fc092012-10-08 18:21:51 +0100381 * @eventq_init: Event queue initialised flag
Ben Hutchings8ceee662008-04-27 12:55:59 +0100382 * @enabled: Channel enabled indicator
383 * @irq: IRQ number (MSI and MSI-X only)
Ben Hutchings0d86ebd2009-10-23 08:32:13 +0000384 * @irq_moderation: IRQ moderation value (in hardware ticks)
Ben Hutchings8ceee662008-04-27 12:55:59 +0100385 * @napi_dev: Net device used with NAPI
386 * @napi_str: NAPI control structure
Ben Hutchings8ceee662008-04-27 12:55:59 +0100387 * @eventq: Event queue buffer
Steve Hodgsonecc910f2010-09-10 06:42:22 +0000388 * @eventq_mask: Event queue pointer mask
Ben Hutchings8ceee662008-04-27 12:55:59 +0100389 * @eventq_read_ptr: Event queue read pointer
Ben Hutchingsdd407812012-02-28 23:40:21 +0000390 * @event_test_cpu: Last CPU to handle interrupt or test event for this channel
Ben Hutchings6fb70fd2009-03-20 13:30:37 +0000391 * @irq_count: Number of IRQs since last adaptive moderation decision
392 * @irq_mod_score: IRQ moderation score
Ben Hutchings8ceee662008-04-27 12:55:59 +0100393 * @n_rx_tobe_disc: Count of RX_TOBE_DISC errors
Ben Hutchings8ceee662008-04-27 12:55:59 +0100394 * @n_rx_ip_hdr_chksum_err: Count of RX IP header checksum errors
395 * @n_rx_tcp_udp_chksum_err: Count of RX TCP and UDP checksum errors
Ben Hutchingsc1ac4032009-11-28 05:36:29 +0000396 * @n_rx_mcast_mismatch: Count of unmatched multicast frames
Ben Hutchings8ceee662008-04-27 12:55:59 +0100397 * @n_rx_frm_trunc: Count of RX_FRM_TRUNC errors
398 * @n_rx_overlength: Count of RX_OVERLENGTH errors
399 * @n_skbuff_leaks: Count of skbuffs leaked due to RX overrun
Ben Hutchings85740cdf2013-01-29 23:33:15 +0000400 * @n_rx_nodesc_trunc: Number of RX packets truncated and then dropped due to
401 * lack of descriptors
Ben Hutchings8127d662013-08-29 19:19:29 +0100402 * @n_rx_merge_events: Number of RX merged completion events
403 * @n_rx_merge_packets: Number of RX packets completed by merged events
Ben Hutchings85740cdf2013-01-29 23:33:15 +0000404 * @rx_pkt_n_frags: Number of fragments in next packet to be delivered by
405 * __efx_rx_packet(), or zero if there is none
406 * @rx_pkt_index: Ring index of first buffer for next packet to be delivered
407 * by __efx_rx_packet(), if @rx_pkt_n_frags != 0
Ben Hutchings8313aca2010-09-10 06:41:57 +0000408 * @rx_queue: RX queue for this channel
Ben Hutchings8313aca2010-09-10 06:41:57 +0000409 * @tx_queue: TX queues for this channel
Ben Hutchings8ceee662008-04-27 12:55:59 +0100410 */
411struct efx_channel {
412 struct efx_nic *efx;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100413 int channel;
Ben Hutchings7f967c02012-02-13 23:45:02 +0000414 const struct efx_channel_type *type;
Ben Hutchingsbe3fc092012-10-08 18:21:51 +0100415 bool eventq_init;
Ben Hutchingsdc8cfa52008-09-01 12:46:50 +0100416 bool enabled;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100417 int irq;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100418 unsigned int irq_moderation;
419 struct net_device *napi_dev;
420 struct napi_struct napi_str;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100421 struct efx_special_buffer eventq;
Steve Hodgsonecc910f2010-09-10 06:42:22 +0000422 unsigned int eventq_mask;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100423 unsigned int eventq_read_ptr;
Ben Hutchingsdd407812012-02-28 23:40:21 +0000424 int event_test_cpu;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100425
Ben Hutchings6fb70fd2009-03-20 13:30:37 +0000426 unsigned int irq_count;
427 unsigned int irq_mod_score;
Ben Hutchings64d8ad62011-01-05 00:50:41 +0000428#ifdef CONFIG_RFS_ACCEL
429 unsigned int rfs_filters_added;
430#endif
Ben Hutchings6fb70fd2009-03-20 13:30:37 +0000431
Ben Hutchings8ceee662008-04-27 12:55:59 +0100432 unsigned n_rx_tobe_disc;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100433 unsigned n_rx_ip_hdr_chksum_err;
434 unsigned n_rx_tcp_udp_chksum_err;
Ben Hutchingsc1ac4032009-11-28 05:36:29 +0000435 unsigned n_rx_mcast_mismatch;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100436 unsigned n_rx_frm_trunc;
437 unsigned n_rx_overlength;
438 unsigned n_skbuff_leaks;
Ben Hutchings85740cdf2013-01-29 23:33:15 +0000439 unsigned int n_rx_nodesc_trunc;
Ben Hutchings8127d662013-08-29 19:19:29 +0100440 unsigned int n_rx_merge_events;
441 unsigned int n_rx_merge_packets;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100442
Ben Hutchings85740cdf2013-01-29 23:33:15 +0000443 unsigned int rx_pkt_n_frags;
444 unsigned int rx_pkt_index;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100445
Ben Hutchings8313aca2010-09-10 06:41:57 +0000446 struct efx_rx_queue rx_queue;
Ben Hutchings94b274b2011-01-10 21:18:20 +0000447 struct efx_tx_queue tx_queue[EFX_TXQ_TYPES];
Ben Hutchings8ceee662008-04-27 12:55:59 +0100448};
449
Ben Hutchings7f967c02012-02-13 23:45:02 +0000450/**
Ben Hutchingsd8291182012-10-05 23:35:41 +0100451 * struct efx_msi_context - Context for each MSI
452 * @efx: The associated NIC
453 * @index: Index of the channel/IRQ
454 * @name: Name of the channel/IRQ
455 *
456 * Unlike &struct efx_channel, this is never reallocated and is always
457 * safe for the IRQ handler to access.
458 */
459struct efx_msi_context {
460 struct efx_nic *efx;
461 unsigned int index;
462 char name[IFNAMSIZ + 6];
463};
464
465/**
Ben Hutchings7f967c02012-02-13 23:45:02 +0000466 * struct efx_channel_type - distinguishes traffic and extra channels
467 * @handle_no_channel: Handle failure to allocate an extra channel
468 * @pre_probe: Set up extra state prior to initialisation
469 * @post_remove: Tear down extra state after finalisation, if allocated.
470 * May be called on channels that have not been probed.
471 * @get_name: Generate the channel's name (used for its IRQ handler)
472 * @copy: Copy the channel state prior to reallocation. May be %NULL if
473 * reallocation is not supported.
Stuart Hodgsonc31e5f92012-07-18 09:52:11 +0100474 * @receive_skb: Handle an skb ready to be passed to netif_receive_skb()
Ben Hutchings7f967c02012-02-13 23:45:02 +0000475 * @keep_eventq: Flag for whether event queue should be kept initialised
476 * while the device is stopped
477 */
478struct efx_channel_type {
479 void (*handle_no_channel)(struct efx_nic *);
480 int (*pre_probe)(struct efx_channel *);
Stuart Hodgsonc31e5f92012-07-18 09:52:11 +0100481 void (*post_remove)(struct efx_channel *);
Ben Hutchings7f967c02012-02-13 23:45:02 +0000482 void (*get_name)(struct efx_channel *, char *buf, size_t len);
483 struct efx_channel *(*copy)(const struct efx_channel *);
Ben Hutchings4a74dc62013-03-05 20:13:54 +0000484 bool (*receive_skb)(struct efx_channel *, struct sk_buff *);
Ben Hutchings7f967c02012-02-13 23:45:02 +0000485 bool keep_eventq;
486};
487
Ben Hutchings398468e2009-11-23 16:03:45 +0000488enum efx_led_mode {
489 EFX_LED_OFF = 0,
490 EFX_LED_ON = 1,
491 EFX_LED_DEFAULT = 2
492};
493
Ben Hutchingsc4593022009-11-23 16:08:17 +0000494#define STRING_TABLE_LOOKUP(val, member) \
495 ((val) < member ## _max) ? member ## _names[val] : "(invalid)"
496
Ben Hutchings18e83e42012-01-05 19:05:20 +0000497extern const char *const efx_loopback_mode_names[];
Ben Hutchingsc4593022009-11-23 16:08:17 +0000498extern const unsigned int efx_loopback_mode_max;
499#define LOOPBACK_MODE(efx) \
500 STRING_TABLE_LOOKUP((efx)->loopback_mode, efx_loopback_mode)
501
Ben Hutchings18e83e42012-01-05 19:05:20 +0000502extern const char *const efx_reset_type_names[];
Ben Hutchingsc4593022009-11-23 16:08:17 +0000503extern const unsigned int efx_reset_type_max;
504#define RESET_TYPE(type) \
505 STRING_TABLE_LOOKUP(type, efx_reset_type)
Ben Hutchings3273c2e2008-05-07 13:36:19 +0100506
Ben Hutchings8ceee662008-04-27 12:55:59 +0100507enum efx_int_mode {
508 /* Be careful if altering to correct macro below */
509 EFX_INT_MODE_MSIX = 0,
510 EFX_INT_MODE_MSI = 1,
511 EFX_INT_MODE_LEGACY = 2,
512 EFX_INT_MODE_MAX /* Insert any new items before this */
513};
514#define EFX_INT_MODE_USE_MSI(x) (((x)->interrupt_mode) <= EFX_INT_MODE_MSI)
515
Ben Hutchings8ceee662008-04-27 12:55:59 +0100516enum nic_state {
Ben Hutchingsf16aeea2012-07-27 19:31:16 +0100517 STATE_UNINIT = 0, /* device being probed/removed or is frozen */
518 STATE_READY = 1, /* hardware ready and netdev registered */
519 STATE_DISABLED = 2, /* device disabled due to hardware errors */
Alexandre Rames626950d2013-01-14 17:20:22 +0000520 STATE_RECOVERY = 3, /* device recovering from PCI error */
Ben Hutchings8ceee662008-04-27 12:55:59 +0100521};
522
523/*
Ben Hutchings8ceee662008-04-27 12:55:59 +0100524 * Alignment of the skb->head which wraps a page-allocated RX buffer
525 *
526 * The skb allocated to wrap an rx_buffer can have this alignment. Since
527 * the data is memcpy'd from the rx_buf, it does not need to be equal to
Ben Hutchingsc14ff2e2013-05-13 11:58:31 +0000528 * NET_IP_ALIGN.
Ben Hutchings8ceee662008-04-27 12:55:59 +0100529 */
530#define EFX_PAGE_SKB_ALIGN 2
531
532/* Forward declaration */
533struct efx_nic;
534
535/* Pseudo bit-mask flow control field */
David S. Millerb56269462011-05-17 17:53:22 -0400536#define EFX_FC_RX FLOW_CTRL_RX
537#define EFX_FC_TX FLOW_CTRL_TX
538#define EFX_FC_AUTO 4
Ben Hutchings8ceee662008-04-27 12:55:59 +0100539
Ben Hutchings177dfcd2008-12-12 21:50:08 -0800540/**
Ben Hutchingseb50c0d2009-11-23 16:06:30 +0000541 * struct efx_link_state - Current state of the link
542 * @up: Link is up
543 * @fd: Link is full-duplex
544 * @fc: Actual flow control flags
545 * @speed: Link speed (Mbps)
546 */
547struct efx_link_state {
548 bool up;
549 bool fd;
David S. Millerb56269462011-05-17 17:53:22 -0400550 u8 fc;
Ben Hutchingseb50c0d2009-11-23 16:06:30 +0000551 unsigned int speed;
552};
553
Steve Hodgsonfdaa9ae2009-11-28 05:34:05 +0000554static inline bool efx_link_state_equal(const struct efx_link_state *left,
555 const struct efx_link_state *right)
556{
557 return left->up == right->up && left->fd == right->fd &&
558 left->fc == right->fc && left->speed == right->speed;
559}
560
Ben Hutchingseb50c0d2009-11-23 16:06:30 +0000561/**
Ben Hutchings8ceee662008-04-27 12:55:59 +0100562 * struct efx_phy_operations - Efx PHY operations table
Ben Hutchingsc1c4f452009-11-29 15:08:55 +0000563 * @probe: Probe PHY and initialise efx->mdio.mode_support, efx->mdio.mmds,
564 * efx->loopback_modes.
Ben Hutchings8ceee662008-04-27 12:55:59 +0100565 * @init: Initialise PHY
566 * @fini: Shut down PHY
567 * @reconfigure: Reconfigure PHY (e.g. for new link parameters)
Steve Hodgsonfdaa9ae2009-11-28 05:34:05 +0000568 * @poll: Update @link_state and report whether it changed.
569 * Serialised by the mac_lock.
Ben Hutchings177dfcd2008-12-12 21:50:08 -0800570 * @get_settings: Get ethtool settings. Serialised by the mac_lock.
571 * @set_settings: Set ethtool settings. Serialised by the mac_lock.
Ben Hutchingsaf4ad9b2009-01-29 17:59:37 +0000572 * @set_npage_adv: Set abilities advertised in (Extended) Next Page
Ben Hutchings04cc8ca2008-12-12 21:50:46 -0800573 * (only needed where AN bit is set in mmds)
Ben Hutchings4f16c072010-02-03 09:30:50 +0000574 * @test_alive: Test that PHY is 'alive' (online)
Ben Hutchingsc1c4f452009-11-29 15:08:55 +0000575 * @test_name: Get the name of a PHY-specific test/result
Ben Hutchings4f16c072010-02-03 09:30:50 +0000576 * @run_tests: Run tests and record results as appropriate (offline).
Ben Hutchings17967212008-12-26 13:47:25 -0800577 * Flags are the ethtool tests flags.
Ben Hutchings8ceee662008-04-27 12:55:59 +0100578 */
579struct efx_phy_operations {
Ben Hutchingsc1c4f452009-11-29 15:08:55 +0000580 int (*probe) (struct efx_nic *efx);
Ben Hutchings8ceee662008-04-27 12:55:59 +0100581 int (*init) (struct efx_nic *efx);
582 void (*fini) (struct efx_nic *efx);
Steve Hodgsonff3b00a2009-12-23 13:46:36 +0000583 void (*remove) (struct efx_nic *efx);
Ben Hutchingsd3245b22009-11-29 03:42:41 +0000584 int (*reconfigure) (struct efx_nic *efx);
Steve Hodgsonfdaa9ae2009-11-28 05:34:05 +0000585 bool (*poll) (struct efx_nic *efx);
Ben Hutchings177dfcd2008-12-12 21:50:08 -0800586 void (*get_settings) (struct efx_nic *efx,
587 struct ethtool_cmd *ecmd);
588 int (*set_settings) (struct efx_nic *efx,
589 struct ethtool_cmd *ecmd);
Ben Hutchingsaf4ad9b2009-01-29 17:59:37 +0000590 void (*set_npage_adv) (struct efx_nic *efx, u32);
Ben Hutchings4f16c072010-02-03 09:30:50 +0000591 int (*test_alive) (struct efx_nic *efx);
Ben Hutchingsc1c4f452009-11-29 15:08:55 +0000592 const char *(*test_name) (struct efx_nic *efx, unsigned int index);
Ben Hutchings17967212008-12-26 13:47:25 -0800593 int (*run_tests) (struct efx_nic *efx, int *results, unsigned flags);
Stuart Hodgsonc087bd22012-05-01 18:50:43 +0100594 int (*get_module_eeprom) (struct efx_nic *efx,
595 struct ethtool_eeprom *ee,
596 u8 *data);
597 int (*get_module_info) (struct efx_nic *efx,
598 struct ethtool_modinfo *modinfo);
Ben Hutchings8ceee662008-04-27 12:55:59 +0100599};
600
Ben Hutchingsf8b87c12008-09-01 12:48:17 +0100601/**
Ben Hutchings49ce9c22012-07-10 10:56:00 +0000602 * enum efx_phy_mode - PHY operating mode flags
Ben Hutchingsf8b87c12008-09-01 12:48:17 +0100603 * @PHY_MODE_NORMAL: on and should pass traffic
604 * @PHY_MODE_TX_DISABLED: on with TX disabled
Ben Hutchings3e133c42008-11-04 20:34:56 +0000605 * @PHY_MODE_LOW_POWER: set to low power through MDIO
606 * @PHY_MODE_OFF: switched off through external control
Ben Hutchingsf8b87c12008-09-01 12:48:17 +0100607 * @PHY_MODE_SPECIAL: on but will not pass traffic
608 */
609enum efx_phy_mode {
610 PHY_MODE_NORMAL = 0,
611 PHY_MODE_TX_DISABLED = 1,
Ben Hutchings3e133c42008-11-04 20:34:56 +0000612 PHY_MODE_LOW_POWER = 2,
613 PHY_MODE_OFF = 4,
Ben Hutchingsf8b87c12008-09-01 12:48:17 +0100614 PHY_MODE_SPECIAL = 8,
615};
616
617static inline bool efx_phy_mode_disabled(enum efx_phy_mode mode)
618{
Ben Hutchings8c8661e2008-09-01 12:49:02 +0100619 return !!(mode & ~PHY_MODE_TX_DISABLED);
Ben Hutchingsf8b87c12008-09-01 12:48:17 +0100620}
621
Ben Hutchingscd0ecc92012-12-14 21:52:56 +0000622/**
623 * struct efx_hw_stat_desc - Description of a hardware statistic
624 * @name: Name of the statistic as visible through ethtool, or %NULL if
625 * it should not be exposed
626 * @dma_width: Width in bits (0 for non-DMA statistics)
627 * @offset: Offset within stats (ignored for non-DMA statistics)
Ben Hutchings8ceee662008-04-27 12:55:59 +0100628 */
Ben Hutchingscd0ecc92012-12-14 21:52:56 +0000629struct efx_hw_stat_desc {
630 const char *name;
631 u16 dma_width;
632 u16 offset;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100633};
634
635/* Number of bits used in a multicast filter hash address */
636#define EFX_MCAST_HASH_BITS 8
637
638/* Number of (single-bit) entries in a multicast filter hash */
639#define EFX_MCAST_HASH_ENTRIES (1 << EFX_MCAST_HASH_BITS)
640
641/* An Efx multicast filter hash */
642union efx_multicast_hash {
643 u8 byte[EFX_MCAST_HASH_ENTRIES / 8];
644 efx_oword_t oword[EFX_MCAST_HASH_ENTRIES / sizeof(efx_oword_t) / 8];
645};
646
Ben Hutchingscd2d5b52012-02-14 00:48:07 +0000647struct efx_vf;
648struct vfdi_status;
Ben Hutchings64eebcf2010-09-20 08:43:07 +0000649
Ben Hutchings8ceee662008-04-27 12:55:59 +0100650/**
651 * struct efx_nic - an Efx NIC
652 * @name: Device name (net device name or bus id before net device registered)
653 * @pci_dev: The PCI device
654 * @type: Controller type attributes
655 * @legacy_irq: IRQ number
Ben Hutchings8d9853d2008-07-18 19:01:20 +0100656 * @workqueue: Workqueue for port reconfigures and the HW monitor.
657 * Work items do not hold and must not acquire RTNL.
Ben Hutchings6977dc62008-12-26 13:44:39 -0800658 * @workqueue_name: Name of workqueue
Ben Hutchings8ceee662008-04-27 12:55:59 +0100659 * @reset_work: Scheduled reset workitem
Ben Hutchings8ceee662008-04-27 12:55:59 +0100660 * @membase_phys: Memory BAR value as physical address
661 * @membase: Memory BAR value
Ben Hutchings8ceee662008-04-27 12:55:59 +0100662 * @interrupt_mode: Interrupt mode
Ben Hutchingscc180b62011-12-08 19:51:47 +0000663 * @timer_quantum_ns: Interrupt timer quantum, in nanoseconds
Ben Hutchings6fb70fd2009-03-20 13:30:37 +0000664 * @irq_rx_adaptive: Adaptive IRQ moderation enabled for RX event queues
665 * @irq_rx_moderation: IRQ moderation time for RX event queues
Ben Hutchings62776d02010-06-23 11:30:07 +0000666 * @msg_enable: Log message enable flags
Ben Hutchingsf16aeea2012-07-27 19:31:16 +0100667 * @state: Device state number (%STATE_*). Serialised by the rtnl_lock.
Ben Hutchingsa7d529a2011-06-24 20:46:31 +0100668 * @reset_pending: Bitmask for pending resets
Ben Hutchings8ceee662008-04-27 12:55:59 +0100669 * @tx_queue: TX DMA queues
670 * @rx_queue: RX DMA queues
671 * @channel: Channels
Ben Hutchingsd8291182012-10-05 23:35:41 +0100672 * @msi_context: Context for each MSI
Ben Hutchings7f967c02012-02-13 23:45:02 +0000673 * @extra_channel_types: Types of extra (non-traffic) channels that
674 * should be allocated for this NIC
Steve Hodgsonecc910f2010-09-10 06:42:22 +0000675 * @rxq_entries: Size of receive queues requested by user.
676 * @txq_entries: Size of transmit queues requested by user.
Ben Hutchings14bf7182012-05-22 01:27:58 +0100677 * @txq_stop_thresh: TX queue fill level at or above which we stop it.
678 * @txq_wake_thresh: TX queue fill level at or below which we wake it.
Ben Hutchings28e47c42012-02-15 01:58:49 +0000679 * @tx_dc_base: Base qword address in SRAM of TX queue descriptor caches
680 * @rx_dc_base: Base qword address in SRAM of RX queue descriptor caches
681 * @sram_lim_qw: Qword address limit of SRAM
Ben Hutchings0484e0d2009-10-23 08:32:04 +0000682 * @next_buffer_table: First available buffer table id
Neil Turton28b581a2008-12-12 21:41:06 -0800683 * @n_channels: Number of channels in use
Ben Hutchingsa4900ac2010-04-28 09:30:43 +0000684 * @n_rx_channels: Number of channels used for RX (= number of RX queues)
685 * @n_tx_channels: Number of channels used for TX
Andrew Rybchenko2ec03012013-11-16 11:02:27 +0400686 * @rx_ip_align: RX DMA address offset to have IP header aligned in
687 * in accordance with NET_IP_ALIGN
Ben Hutchings272baee2013-01-29 23:33:14 +0000688 * @rx_dma_len: Current maximum RX DMA length
Ben Hutchings8ceee662008-04-27 12:55:59 +0100689 * @rx_buffer_order: Order (log2) of number of pages for each RX buffer
Ben Hutchings85740cdf2013-01-29 23:33:15 +0000690 * @rx_buffer_truesize: Amortised allocation size of an RX buffer,
691 * for use in sk_buff::truesize
Jon Cooper43a37392012-10-18 15:49:54 +0100692 * @rx_prefix_size: Size of RX prefix before packet data
693 * @rx_packet_hash_offset: Offset of RX flow hash from start of packet data
694 * (valid only if @rx_prefix_size != 0; always negative)
Ben Hutchings3dced742013-04-27 01:55:18 +0100695 * @rx_packet_len_offset: Offset of RX packet length from start of packet data
696 * (valid only for NICs that set %EFX_RX_PKT_PREFIX_LEN; always negative)
Ben Hutchings78d41892010-12-02 13:47:56 +0000697 * @rx_hash_key: Toeplitz hash key for RSS
Ben Hutchings765c9f42010-06-30 05:06:28 +0000698 * @rx_indir_table: Indirection table for RSS
Ben Hutchings85740cdf2013-01-29 23:33:15 +0000699 * @rx_scatter: Scatter mode enabled for receives
Ben Hutchings0484e0d2009-10-23 08:32:04 +0000700 * @int_error_count: Number of internal errors seen recently
701 * @int_error_expire: Time at which error count will be expired
Ben Hutchingsd8291182012-10-05 23:35:41 +0100702 * @irq_soft_enabled: Are IRQs soft-enabled? If not, IRQ handler will
703 * acknowledge but do nothing else.
Ben Hutchings8ceee662008-04-27 12:55:59 +0100704 * @irq_status: Interrupt status buffer
Ben Hutchingsc28884c2010-04-28 09:30:00 +0000705 * @irq_zero_count: Number of legacy IRQs seen with queue flags == 0
Ben Hutchings1646a6f2012-01-05 20:14:10 +0000706 * @irq_level: IRQ level/index for IRQs not triggered by an event queue
Ben Hutchingsdd407812012-02-28 23:40:21 +0000707 * @selftest_work: Work item for asynchronous self-test
Ben Hutchings76884832009-11-29 15:10:44 +0000708 * @mtd_list: List of MTDs attached to the NIC
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300709 * @nic_data: Hardware dependent state
Ben Hutchingsf3ad5002012-09-18 02:33:56 +0100710 * @mcdi: Management-Controller-to-Driver Interface state
Ben Hutchings8c8661e2008-09-01 12:49:02 +0100711 * @mac_lock: MAC access lock. Protects @port_enabled, @phy_mode,
Ben Hutchingse4abce82011-05-16 18:51:24 +0100712 * efx_monitor() and efx_reconfigure_port()
Ben Hutchings8ceee662008-04-27 12:55:59 +0100713 * @port_enabled: Port enabled indicator.
Steve Hodgsonfdaa9ae2009-11-28 05:34:05 +0000714 * Serialises efx_stop_all(), efx_start_all(), efx_monitor() and
715 * efx_mac_work() with kernel interfaces. Safe to read under any
716 * one of the rtnl_lock, mac_lock, or netif_tx_lock, but all three must
717 * be held to modify it.
Ben Hutchings8ceee662008-04-27 12:55:59 +0100718 * @port_initialized: Port initialized?
719 * @net_dev: Operating system network device. Consider holding the rtnl lock
Ben Hutchings8ceee662008-04-27 12:55:59 +0100720 * @stats_buffer: DMA buffer for statistics
Ben Hutchings8ceee662008-04-27 12:55:59 +0100721 * @phy_type: PHY type
Ben Hutchings8ceee662008-04-27 12:55:59 +0100722 * @phy_op: PHY interface
723 * @phy_data: PHY private data (including PHY-specific stats)
Ben Hutchings68e7f452009-04-29 08:05:08 +0000724 * @mdio: PHY MDIO interface
Ben Hutchings8880f4e2009-11-29 15:15:41 +0000725 * @mdio_bus: PHY MDIO bus ID (only used by Siena)
Ben Hutchings8c8661e2008-09-01 12:49:02 +0100726 * @phy_mode: PHY operating mode. Serialised by @mac_lock.
Ben Hutchingsd3245b22009-11-29 03:42:41 +0000727 * @link_advertising: Autonegotiation advertising flags
Ben Hutchingseb50c0d2009-11-23 16:06:30 +0000728 * @link_state: Current state of the link
Ben Hutchings8ceee662008-04-27 12:55:59 +0100729 * @n_link_state_changes: Number of times the link has changed state
Ben Hutchings964e6132012-11-19 23:08:22 +0000730 * @unicast_filter: Flag for Falcon-arch simple unicast filter.
731 * Protected by @mac_lock.
732 * @multicast_hash: Multicast hash table for Falcon-arch.
733 * Protected by @mac_lock.
Ben Hutchings04cc8ca2008-12-12 21:50:46 -0800734 * @wanted_fc: Wanted flow control flags
Steve Hodgsona606f432011-05-23 12:18:45 +0100735 * @fc_disable: When non-zero flow control is disabled. Typically used to
736 * ensure that network back pressure doesn't delay dma queue flushes.
737 * Serialised by the rtnl lock.
Ben Hutchings8be4f3e2009-11-25 16:12:16 +0000738 * @mac_work: Work item for changing MAC promiscuity and multicast hash
Ben Hutchings3273c2e2008-05-07 13:36:19 +0100739 * @loopback_mode: Loopback status
740 * @loopback_modes: Supported loopback mode bitmask
741 * @loopback_selftest: Offline self-test private state
Ben Hutchings6d661ce2012-10-27 00:33:30 +0100742 * @filter_lock: Filter table lock
743 * @filter_state: Architecture-dependent filter table state
744 * @rps_flow_id: Flow IDs of filters allocated for accelerated RFS,
745 * indexed by filter ID
746 * @rps_expire_index: Next index to check for expiry in @rps_flow_id
Alexandre Rames3881d8a2013-06-10 11:03:21 +0100747 * @active_queues: Count of RX and TX queues that haven't been flushed and drained.
Ben Hutchings9f2cb712012-02-08 00:11:20 +0000748 * @rxq_flush_pending: Count of number of receive queues that need to be flushed.
749 * Decremented when the efx_flush_rx_queue() is called.
750 * @rxq_flush_outstanding: Count of number of RX flushes started but not yet
751 * completed (either success or failure). Not used when MCDI is used to
752 * flush receive queues.
753 * @flush_wq: wait queue used by efx_nic_flush_queues() to wait for flush completions.
Ben Hutchingscd2d5b52012-02-14 00:48:07 +0000754 * @vf: Array of &struct efx_vf objects.
755 * @vf_count: Number of VFs intended to be enabled.
756 * @vf_init_count: Number of VFs that have been fully initialised.
757 * @vi_scale: log2 number of vnics per VF.
758 * @vf_buftbl_base: The zeroth buffer table index used to back VF queues.
759 * @vfdi_status: Common VFDI status page to be dmad to VF address space.
760 * @local_addr_list: List of local addresses. Protected by %local_lock.
761 * @local_page_list: List of DMA addressable pages used to broadcast
762 * %local_addr_list. Protected by %local_lock.
763 * @local_lock: Mutex protecting %local_addr_list and %local_page_list.
764 * @peer_work: Work item to broadcast peer addresses to VMs.
Stuart Hodgson7c236c42012-09-03 11:09:36 +0100765 * @ptp_data: PTP state data
Ben Hutchingsab28c122010-12-06 22:53:15 +0000766 * @monitor_work: Hardware monitor workitem
767 * @biu_lock: BIU (bus interface unit) lock
Ben Hutchings1646a6f2012-01-05 20:14:10 +0000768 * @last_irq_cpu: Last CPU to handle a possible test interrupt. This
769 * field is used by efx_test_interrupts() to verify that an
770 * interrupt has occurred.
Ben Hutchingscd0ecc92012-12-14 21:52:56 +0000771 * @stats_lock: Statistics update lock. Must be held when calling
772 * efx_nic_type::{update,start,stop}_stats.
Ben Hutchings8ceee662008-04-27 12:55:59 +0100773 *
Ben Hutchings754c6532010-02-03 09:31:57 +0000774 * This is stored in the private area of the &struct net_device.
Ben Hutchings8ceee662008-04-27 12:55:59 +0100775 */
776struct efx_nic {
Ben Hutchingsab28c122010-12-06 22:53:15 +0000777 /* The following fields should be written very rarely */
778
Ben Hutchings8ceee662008-04-27 12:55:59 +0100779 char name[IFNAMSIZ];
780 struct pci_dev *pci_dev;
Ben Hutchings66020412013-06-10 18:03:17 +0100781 unsigned int port_num;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100782 const struct efx_nic_type *type;
783 int legacy_irq;
Alexandre Ramesb28405b2013-03-21 16:41:43 +0000784 bool eeh_disabled_legacy_irq;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100785 struct workqueue_struct *workqueue;
Ben Hutchings6977dc62008-12-26 13:44:39 -0800786 char workqueue_name[16];
Ben Hutchings8ceee662008-04-27 12:55:59 +0100787 struct work_struct reset_work;
Ben Hutchings086ea352008-05-16 21:17:06 +0100788 resource_size_t membase_phys;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100789 void __iomem *membase;
Ben Hutchingsab28c122010-12-06 22:53:15 +0000790
Ben Hutchings8ceee662008-04-27 12:55:59 +0100791 enum efx_int_mode interrupt_mode;
Ben Hutchingscc180b62011-12-08 19:51:47 +0000792 unsigned int timer_quantum_ns;
Ben Hutchings6fb70fd2009-03-20 13:30:37 +0000793 bool irq_rx_adaptive;
794 unsigned int irq_rx_moderation;
Ben Hutchings62776d02010-06-23 11:30:07 +0000795 u32 msg_enable;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100796
Ben Hutchings8ceee662008-04-27 12:55:59 +0100797 enum nic_state state;
Ben Hutchingsa7d529a2011-06-24 20:46:31 +0100798 unsigned long reset_pending;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100799
Ben Hutchings8313aca2010-09-10 06:41:57 +0000800 struct efx_channel *channel[EFX_MAX_CHANNELS];
Ben Hutchingsd8291182012-10-05 23:35:41 +0100801 struct efx_msi_context msi_context[EFX_MAX_CHANNELS];
Ben Hutchings7f967c02012-02-13 23:45:02 +0000802 const struct efx_channel_type *
803 extra_channel_type[EFX_MAX_EXTRA_CHANNELS];
Ben Hutchings8ceee662008-04-27 12:55:59 +0100804
Steve Hodgsonecc910f2010-09-10 06:42:22 +0000805 unsigned rxq_entries;
806 unsigned txq_entries;
Ben Hutchings14bf7182012-05-22 01:27:58 +0100807 unsigned int txq_stop_thresh;
808 unsigned int txq_wake_thresh;
809
Ben Hutchings28e47c42012-02-15 01:58:49 +0000810 unsigned tx_dc_base;
811 unsigned rx_dc_base;
812 unsigned sram_lim_qw;
Ben Hutchings0484e0d2009-10-23 08:32:04 +0000813 unsigned next_buffer_table;
Ben Hutchingsb1057982012-09-19 00:56:47 +0100814
815 unsigned int max_channels;
Ben Hutchingsa4900ac2010-04-28 09:30:43 +0000816 unsigned n_channels;
817 unsigned n_rx_channels;
Ben Hutchingscd2d5b52012-02-14 00:48:07 +0000818 unsigned rss_spread;
Ben Hutchings97653432011-01-12 18:26:56 +0000819 unsigned tx_channel_offset;
Ben Hutchingsa4900ac2010-04-28 09:30:43 +0000820 unsigned n_tx_channels;
Andrew Rybchenko2ec03012013-11-16 11:02:27 +0400821 unsigned int rx_ip_align;
Ben Hutchings272baee2013-01-29 23:33:14 +0000822 unsigned int rx_dma_len;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100823 unsigned int rx_buffer_order;
Ben Hutchings85740cdf2013-01-29 23:33:15 +0000824 unsigned int rx_buffer_truesize;
Daniel Pieczko1648a232013-02-13 10:54:41 +0000825 unsigned int rx_page_buf_step;
Daniel Pieczko27689352013-02-13 10:54:41 +0000826 unsigned int rx_bufs_per_page;
Daniel Pieczko1648a232013-02-13 10:54:41 +0000827 unsigned int rx_pages_per_batch;
Jon Cooper43a37392012-10-18 15:49:54 +0100828 unsigned int rx_prefix_size;
829 int rx_packet_hash_offset;
Ben Hutchings3dced742013-04-27 01:55:18 +0100830 int rx_packet_len_offset;
Ben Hutchings5d3a6fc2010-06-25 07:05:43 +0000831 u8 rx_hash_key[40];
Ben Hutchings765c9f42010-06-30 05:06:28 +0000832 u32 rx_indir_table[128];
Ben Hutchings85740cdf2013-01-29 23:33:15 +0000833 bool rx_scatter;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100834
Ben Hutchings0484e0d2009-10-23 08:32:04 +0000835 unsigned int_error_count;
836 unsigned long int_error_expire;
837
Ben Hutchingsd8291182012-10-05 23:35:41 +0100838 bool irq_soft_enabled;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100839 struct efx_buffer irq_status;
Ben Hutchingsc28884c2010-04-28 09:30:00 +0000840 unsigned irq_zero_count;
Ben Hutchings1646a6f2012-01-05 20:14:10 +0000841 unsigned irq_level;
Ben Hutchingsdd407812012-02-28 23:40:21 +0000842 struct delayed_work selftest_work;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100843
Ben Hutchings76884832009-11-29 15:10:44 +0000844#ifdef CONFIG_SFC_MTD
845 struct list_head mtd_list;
846#endif
Ben Hutchings4a5b5042008-09-01 12:47:16 +0100847
Ben Hutchings8880f4e2009-11-29 15:15:41 +0000848 void *nic_data;
Ben Hutchingsf3ad5002012-09-18 02:33:56 +0100849 struct efx_mcdi_data *mcdi;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100850
851 struct mutex mac_lock;
Ben Hutchings766ca0f2008-12-12 21:59:24 -0800852 struct work_struct mac_work;
Ben Hutchingsdc8cfa52008-09-01 12:46:50 +0100853 bool port_enabled;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100854
Jon Cooper74cd60a2013-09-16 14:18:51 +0100855 bool mc_bist_for_other_fn;
Ben Hutchingsdc8cfa52008-09-01 12:46:50 +0100856 bool port_initialized;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100857 struct net_device *net_dev;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100858
Ben Hutchings8ceee662008-04-27 12:55:59 +0100859 struct efx_buffer stats_buffer;
Jon Cooperf8f3b5a2013-09-30 17:36:50 +0100860 u64 rx_nodesc_drops_total;
861 u64 rx_nodesc_drops_while_down;
862 bool rx_nodesc_drops_prev_state;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100863
Ben Hutchingsc1c4f452009-11-29 15:08:55 +0000864 unsigned int phy_type;
stephen hemminger6c8c2512011-04-14 05:50:12 +0000865 const struct efx_phy_operations *phy_op;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100866 void *phy_data;
Ben Hutchings68e7f452009-04-29 08:05:08 +0000867 struct mdio_if_info mdio;
Ben Hutchings8880f4e2009-11-29 15:15:41 +0000868 unsigned int mdio_bus;
Ben Hutchingsf8b87c12008-09-01 12:48:17 +0100869 enum efx_phy_mode phy_mode;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100870
Ben Hutchingsd3245b22009-11-29 03:42:41 +0000871 u32 link_advertising;
Ben Hutchingseb50c0d2009-11-23 16:06:30 +0000872 struct efx_link_state link_state;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100873 unsigned int n_link_state_changes;
874
Ben Hutchings964e6132012-11-19 23:08:22 +0000875 bool unicast_filter;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100876 union efx_multicast_hash multicast_hash;
David S. Millerb56269462011-05-17 17:53:22 -0400877 u8 wanted_fc;
Steve Hodgsona606f432011-05-23 12:18:45 +0100878 unsigned fc_disable;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100879
880 atomic_t rx_reset;
Ben Hutchings3273c2e2008-05-07 13:36:19 +0100881 enum efx_loopback_mode loopback_mode;
Ben Hutchingse58f69f2009-11-29 15:08:41 +0000882 u64 loopback_modes;
Ben Hutchings3273c2e2008-05-07 13:36:19 +0100883
884 void *loopback_selftest;
Ben Hutchings64eebcf2010-09-20 08:43:07 +0000885
Ben Hutchings6d661ce2012-10-27 00:33:30 +0100886 spinlock_t filter_lock;
887 void *filter_state;
888#ifdef CONFIG_RFS_ACCEL
889 u32 *rps_flow_id;
890 unsigned int rps_expire_index;
891#endif
Ben Hutchingsab28c122010-12-06 22:53:15 +0000892
Alexandre Rames3881d8a2013-06-10 11:03:21 +0100893 atomic_t active_queues;
Ben Hutchings9f2cb712012-02-08 00:11:20 +0000894 atomic_t rxq_flush_pending;
895 atomic_t rxq_flush_outstanding;
896 wait_queue_head_t flush_wq;
897
Ben Hutchingscd2d5b52012-02-14 00:48:07 +0000898#ifdef CONFIG_SFC_SRIOV
899 struct efx_channel *vfdi_channel;
900 struct efx_vf *vf;
901 unsigned vf_count;
902 unsigned vf_init_count;
903 unsigned vi_scale;
904 unsigned vf_buftbl_base;
905 struct efx_buffer vfdi_status;
906 struct list_head local_addr_list;
907 struct list_head local_page_list;
908 struct mutex local_lock;
909 struct work_struct peer_work;
910#endif
911
Stuart Hodgson7c236c42012-09-03 11:09:36 +0100912 struct efx_ptp_data *ptp_data;
Stuart Hodgson7c236c42012-09-03 11:09:36 +0100913
Ben Hutchingsab28c122010-12-06 22:53:15 +0000914 /* The following fields may be written more often */
915
916 struct delayed_work monitor_work ____cacheline_aligned_in_smp;
917 spinlock_t biu_lock;
Ben Hutchings1646a6f2012-01-05 20:14:10 +0000918 int last_irq_cpu;
Ben Hutchingsab28c122010-12-06 22:53:15 +0000919 spinlock_t stats_lock;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100920};
921
Ben Hutchings55668612008-05-16 21:16:10 +0100922static inline int efx_dev_registered(struct efx_nic *efx)
923{
924 return efx->net_dev->reg_state == NETREG_REGISTERED;
925}
926
Ben Hutchings8880f4e2009-11-29 15:15:41 +0000927static inline unsigned int efx_port_num(struct efx_nic *efx)
928{
Ben Hutchings66020412013-06-10 18:03:17 +0100929 return efx->port_num;
Ben Hutchings8880f4e2009-11-29 15:15:41 +0000930}
931
Ben Hutchings45a3fd52012-11-28 04:38:14 +0000932struct efx_mtd_partition {
933 struct list_head node;
934 struct mtd_info mtd;
935 const char *dev_type_name;
936 const char *type_name;
937 char name[IFNAMSIZ + 20];
938};
939
Ben Hutchings8ceee662008-04-27 12:55:59 +0100940/**
941 * struct efx_nic_type - Efx device type definition
Ben Hutchingsb1057982012-09-19 00:56:47 +0100942 * @mem_map_size: Get memory BAR mapped size
Ben Hutchingsef2b90e2009-11-29 03:42:31 +0000943 * @probe: Probe the controller
944 * @remove: Free resources allocated by probe()
945 * @init: Initialise the controller
Ben Hutchings28e47c42012-02-15 01:58:49 +0000946 * @dimension_resources: Dimension controller resources (buffer table,
947 * and VIs once the available interrupt resources are clear)
Ben Hutchingsef2b90e2009-11-29 03:42:31 +0000948 * @fini: Shut down the controller
949 * @monitor: Periodic function for polling link state and hardware monitor
Ben Hutchings0e2a9c72011-06-24 20:50:07 +0100950 * @map_reset_reason: Map ethtool reset reason to a reset method
951 * @map_reset_flags: Map ethtool reset flags to a reset method, if possible
Ben Hutchingsef2b90e2009-11-29 03:42:31 +0000952 * @reset: Reset the controller hardware and possibly the PHY. This will
953 * be called while the controller is uninitialised.
954 * @probe_port: Probe the MAC and PHY
955 * @remove_port: Free resources allocated by probe_port()
Ben Hutchings40641ed2010-12-02 13:47:45 +0000956 * @handle_global_event: Handle a "global" event (may be %NULL)
Ben Hutchingse42c3d82013-05-27 16:52:54 +0100957 * @fini_dmaq: Flush and finalise DMA queues (RX and TX queues)
Ben Hutchingsef2b90e2009-11-29 03:42:31 +0000958 * @prepare_flush: Prepare the hardware for flushing the DMA queues
Ben Hutchingse42c3d82013-05-27 16:52:54 +0100959 * (for Falcon architecture)
960 * @finish_flush: Clean up after flushing the DMA queues (for Falcon
961 * architecture)
Ben Hutchingscd0ecc92012-12-14 21:52:56 +0000962 * @describe_stats: Describe statistics for ethtool
963 * @update_stats: Update statistics not provided by event handling.
964 * Either argument may be %NULL.
Ben Hutchingsef2b90e2009-11-29 03:42:31 +0000965 * @start_stats: Start the regular fetching of statistics
Jon Cooperf8f3b5a2013-09-30 17:36:50 +0100966 * @pull_stats: Pull stats from the NIC and wait until they arrive.
Ben Hutchingsef2b90e2009-11-29 03:42:31 +0000967 * @stop_stats: Stop the regular fetching of statistics
Ben Hutchings06629f02009-11-29 03:43:43 +0000968 * @set_id_led: Set state of identifying LED or revert to automatic function
Ben Hutchingsef2b90e2009-11-29 03:42:31 +0000969 * @push_irq_moderation: Apply interrupt moderation value
Ben Hutchingsd3245b22009-11-29 03:42:41 +0000970 * @reconfigure_port: Push loopback/power/txdis changes to the MAC and PHY
Ben Hutchings9dd3a132012-09-13 01:11:25 +0100971 * @prepare_enable_fc_tx: Prepare MAC to enable pause frame TX (may be %NULL)
Ben Hutchings30b81cd2011-09-13 19:47:48 +0100972 * @reconfigure_mac: Push MAC address, MTU, flow control and filter settings
973 * to the hardware. Serialised by the mac_lock.
Ben Hutchings710b2082011-09-03 00:15:00 +0100974 * @check_mac_fault: Check MAC fault state. True if fault present.
Ben Hutchings89c758f2009-11-29 03:43:07 +0000975 * @get_wol: Get WoL configuration from driver state
976 * @set_wol: Push WoL configuration to the NIC
977 * @resume_wol: Synchronise WoL state between driver and MC (e.g. after resume)
Ben Hutchings86094f72013-08-21 19:51:04 +0100978 * @test_chip: Test registers. May use efx_farch_test_registers(), and is
Ben Hutchingsd4f2cec2012-07-04 03:58:33 +0100979 * expected to reset the NIC.
Ben Hutchings0aa3fba2009-11-29 03:43:33 +0000980 * @test_nvram: Test validity of NVRAM contents
Ben Hutchingsf3ad5002012-09-18 02:33:56 +0100981 * @mcdi_request: Send an MCDI request with the given header and SDU.
982 * The SDU length may be any value from 0 up to the protocol-
983 * defined maximum, but its buffer will be padded to a multiple
984 * of 4 bytes.
985 * @mcdi_poll_response: Test whether an MCDI response is available.
986 * @mcdi_read_response: Read the MCDI response PDU. The offset will
987 * be a multiple of 4. The length may not be, but the buffer
988 * will be padded so it is safe to round up.
989 * @mcdi_poll_reboot: Test whether the MCDI has rebooted. If so,
990 * return an appropriate error code for aborting any current
991 * request; otherwise return 0.
Ben Hutchings86094f72013-08-21 19:51:04 +0100992 * @irq_enable_master: Enable IRQs on the NIC. Each event queue must
993 * be separately enabled after this.
994 * @irq_test_generate: Generate a test IRQ
995 * @irq_disable_non_ev: Disable non-event IRQs on the NIC. Each event
996 * queue must be separately disabled before this.
997 * @irq_handle_msi: Handle MSI for a channel. The @dev_id argument is
998 * a pointer to the &struct efx_msi_context for the channel.
999 * @irq_handle_legacy: Handle legacy interrupt. The @dev_id argument
1000 * is a pointer to the &struct efx_nic.
1001 * @tx_probe: Allocate resources for TX queue
1002 * @tx_init: Initialise TX queue on the NIC
1003 * @tx_remove: Free resources for TX queue
1004 * @tx_write: Write TX descriptors and doorbell
1005 * @rx_push_indir_table: Write RSS indirection table to the NIC
1006 * @rx_probe: Allocate resources for RX queue
1007 * @rx_init: Initialise RX queue on the NIC
1008 * @rx_remove: Free resources for RX queue
1009 * @rx_write: Write RX descriptors and doorbell
1010 * @rx_defer_refill: Generate a refill reminder event
1011 * @ev_probe: Allocate resources for event queue
1012 * @ev_init: Initialise event queue on the NIC
1013 * @ev_fini: Deinitialise event queue on the NIC
1014 * @ev_remove: Free resources for event queue
1015 * @ev_process: Process events for a queue, up to the given NAPI quota
1016 * @ev_read_ack: Acknowledge read events on a queue, rearming its IRQ
1017 * @ev_test_generate: Generate a test event
Ben Hutchingsadd72472012-11-08 01:46:53 +00001018 * @filter_table_probe: Probe filter capabilities and set up filter software state
1019 * @filter_table_restore: Restore filters removed from hardware
1020 * @filter_table_remove: Remove filters from hardware and tear down software state
1021 * @filter_update_rx_scatter: Update filters after change to rx scatter setting
1022 * @filter_insert: add or replace a filter
1023 * @filter_remove_safe: remove a filter by ID, carefully
1024 * @filter_get_safe: retrieve a filter by ID, carefully
1025 * @filter_clear_rx: remove RX filters by priority
1026 * @filter_count_rx_used: Get the number of filters in use at a given priority
1027 * @filter_get_rx_id_limit: Get maximum value of a filter id, plus 1
1028 * @filter_get_rx_ids: Get list of RX filters at a given priority
1029 * @filter_rfs_insert: Add or replace a filter for RFS. This must be
1030 * atomic. The hardware change may be asynchronous but should
1031 * not be delayed for long. It may fail if this can't be done
1032 * atomically.
1033 * @filter_rfs_expire_one: Consider expiring a filter inserted for RFS.
1034 * This must check whether the specified table entry is used by RFS
1035 * and that rps_may_expire_flow() returns true for it.
Ben Hutchings45a3fd52012-11-28 04:38:14 +00001036 * @mtd_probe: Probe and add MTD partitions associated with this net device,
1037 * using efx_mtd_add()
1038 * @mtd_rename: Set an MTD partition name using the net device name
1039 * @mtd_read: Read from an MTD partition
1040 * @mtd_erase: Erase part of an MTD partition
1041 * @mtd_write: Write to an MTD partition
1042 * @mtd_sync: Wait for write-back to complete on MTD partition. This
1043 * also notifies the driver that a writer has finished using this
1044 * partition.
Ben Hutchingsdaeda632009-11-28 05:36:04 +00001045 * @revision: Hardware architecture revision
Ben Hutchings8ceee662008-04-27 12:55:59 +01001046 * @txd_ptr_tbl_base: TX descriptor ring base address
1047 * @rxd_ptr_tbl_base: RX descriptor ring base address
1048 * @buf_tbl_base: Buffer table base address
1049 * @evq_ptr_tbl_base: Event queue pointer table base address
1050 * @evq_rptr_tbl_base: Event queue read-pointer table base address
Ben Hutchings8ceee662008-04-27 12:55:59 +01001051 * @max_dma_mask: Maximum possible DMA mask
Jon Cooper43a37392012-10-18 15:49:54 +01001052 * @rx_prefix_size: Size of RX prefix before packet data
1053 * @rx_hash_offset: Offset of RX flow hash within prefix
Ben Hutchings85740cdf2013-01-29 23:33:15 +00001054 * @rx_buffer_padding: Size of padding at end of RX packet
Jon Coopere8c68c02013-03-08 10:18:28 +00001055 * @can_rx_scatter: NIC is able to scatter packets to multiple buffers
1056 * @always_rx_scatter: NIC will always scatter packets to multiple buffers
Ben Hutchings8ceee662008-04-27 12:55:59 +01001057 * @max_interrupt_mode: Highest capability interrupt mode supported
1058 * from &enum efx_init_mode.
Ben Hutchingscc180b62011-12-08 19:51:47 +00001059 * @timer_period_max: Maximum period of interrupt timer (in ticks)
Ben Hutchingsc383b532009-11-29 15:11:02 +00001060 * @offload_features: net_device feature flags for protocol offload
1061 * features implemented in hardware
Ben Hutchingsdf2cd8a2012-09-19 00:56:18 +01001062 * @mcdi_max_ver: Maximum MCDI version supported
Ben Hutchings8ceee662008-04-27 12:55:59 +01001063 */
1064struct efx_nic_type {
Ben Hutchingsb1057982012-09-19 00:56:47 +01001065 unsigned int (*mem_map_size)(struct efx_nic *efx);
Ben Hutchingsef2b90e2009-11-29 03:42:31 +00001066 int (*probe)(struct efx_nic *efx);
1067 void (*remove)(struct efx_nic *efx);
1068 int (*init)(struct efx_nic *efx);
Ben Hutchingsc15eed22013-08-29 00:45:48 +01001069 int (*dimension_resources)(struct efx_nic *efx);
Ben Hutchingsef2b90e2009-11-29 03:42:31 +00001070 void (*fini)(struct efx_nic *efx);
1071 void (*monitor)(struct efx_nic *efx);
Ben Hutchings0e2a9c72011-06-24 20:50:07 +01001072 enum reset_type (*map_reset_reason)(enum reset_type reason);
1073 int (*map_reset_flags)(u32 *flags);
Ben Hutchingsef2b90e2009-11-29 03:42:31 +00001074 int (*reset)(struct efx_nic *efx, enum reset_type method);
1075 int (*probe_port)(struct efx_nic *efx);
1076 void (*remove_port)(struct efx_nic *efx);
Ben Hutchings40641ed2010-12-02 13:47:45 +00001077 bool (*handle_global_event)(struct efx_channel *channel, efx_qword_t *);
Ben Hutchingse42c3d82013-05-27 16:52:54 +01001078 int (*fini_dmaq)(struct efx_nic *efx);
Ben Hutchingsef2b90e2009-11-29 03:42:31 +00001079 void (*prepare_flush)(struct efx_nic *efx);
Ben Hutchingsd5e8cc62012-09-06 16:52:31 +01001080 void (*finish_flush)(struct efx_nic *efx);
Ben Hutchingscd0ecc92012-12-14 21:52:56 +00001081 size_t (*describe_stats)(struct efx_nic *efx, u8 *names);
1082 size_t (*update_stats)(struct efx_nic *efx, u64 *full_stats,
1083 struct rtnl_link_stats64 *core_stats);
Ben Hutchingsef2b90e2009-11-29 03:42:31 +00001084 void (*start_stats)(struct efx_nic *efx);
Jon Cooperf8f3b5a2013-09-30 17:36:50 +01001085 void (*pull_stats)(struct efx_nic *efx);
Ben Hutchingsef2b90e2009-11-29 03:42:31 +00001086 void (*stop_stats)(struct efx_nic *efx);
Ben Hutchings06629f02009-11-29 03:43:43 +00001087 void (*set_id_led)(struct efx_nic *efx, enum efx_led_mode mode);
Ben Hutchingsef2b90e2009-11-29 03:42:31 +00001088 void (*push_irq_moderation)(struct efx_channel *channel);
Ben Hutchingsd3245b22009-11-29 03:42:41 +00001089 int (*reconfigure_port)(struct efx_nic *efx);
Ben Hutchings9dd3a132012-09-13 01:11:25 +01001090 void (*prepare_enable_fc_tx)(struct efx_nic *efx);
Ben Hutchings710b2082011-09-03 00:15:00 +01001091 int (*reconfigure_mac)(struct efx_nic *efx);
1092 bool (*check_mac_fault)(struct efx_nic *efx);
Ben Hutchings89c758f2009-11-29 03:43:07 +00001093 void (*get_wol)(struct efx_nic *efx, struct ethtool_wolinfo *wol);
1094 int (*set_wol)(struct efx_nic *efx, u32 type);
1095 void (*resume_wol)(struct efx_nic *efx);
Ben Hutchingsd4f2cec2012-07-04 03:58:33 +01001096 int (*test_chip)(struct efx_nic *efx, struct efx_self_tests *tests);
Ben Hutchings0aa3fba2009-11-29 03:43:33 +00001097 int (*test_nvram)(struct efx_nic *efx);
Ben Hutchingsf3ad5002012-09-18 02:33:56 +01001098 void (*mcdi_request)(struct efx_nic *efx,
1099 const efx_dword_t *hdr, size_t hdr_len,
1100 const efx_dword_t *sdu, size_t sdu_len);
1101 bool (*mcdi_poll_response)(struct efx_nic *efx);
1102 void (*mcdi_read_response)(struct efx_nic *efx, efx_dword_t *pdu,
1103 size_t pdu_offset, size_t pdu_len);
1104 int (*mcdi_poll_reboot)(struct efx_nic *efx);
Ben Hutchings86094f72013-08-21 19:51:04 +01001105 void (*irq_enable_master)(struct efx_nic *efx);
1106 void (*irq_test_generate)(struct efx_nic *efx);
1107 void (*irq_disable_non_ev)(struct efx_nic *efx);
1108 irqreturn_t (*irq_handle_msi)(int irq, void *dev_id);
1109 irqreturn_t (*irq_handle_legacy)(int irq, void *dev_id);
1110 int (*tx_probe)(struct efx_tx_queue *tx_queue);
1111 void (*tx_init)(struct efx_tx_queue *tx_queue);
1112 void (*tx_remove)(struct efx_tx_queue *tx_queue);
1113 void (*tx_write)(struct efx_tx_queue *tx_queue);
1114 void (*rx_push_indir_table)(struct efx_nic *efx);
1115 int (*rx_probe)(struct efx_rx_queue *rx_queue);
1116 void (*rx_init)(struct efx_rx_queue *rx_queue);
1117 void (*rx_remove)(struct efx_rx_queue *rx_queue);
1118 void (*rx_write)(struct efx_rx_queue *rx_queue);
1119 void (*rx_defer_refill)(struct efx_rx_queue *rx_queue);
1120 int (*ev_probe)(struct efx_channel *channel);
Jon Cooper261e4d92013-04-15 18:51:54 +01001121 int (*ev_init)(struct efx_channel *channel);
Ben Hutchings86094f72013-08-21 19:51:04 +01001122 void (*ev_fini)(struct efx_channel *channel);
1123 void (*ev_remove)(struct efx_channel *channel);
1124 int (*ev_process)(struct efx_channel *channel, int quota);
1125 void (*ev_read_ack)(struct efx_channel *channel);
1126 void (*ev_test_generate)(struct efx_channel *channel);
Ben Hutchingsadd72472012-11-08 01:46:53 +00001127 int (*filter_table_probe)(struct efx_nic *efx);
1128 void (*filter_table_restore)(struct efx_nic *efx);
1129 void (*filter_table_remove)(struct efx_nic *efx);
1130 void (*filter_update_rx_scatter)(struct efx_nic *efx);
1131 s32 (*filter_insert)(struct efx_nic *efx,
1132 struct efx_filter_spec *spec, bool replace);
1133 int (*filter_remove_safe)(struct efx_nic *efx,
1134 enum efx_filter_priority priority,
1135 u32 filter_id);
1136 int (*filter_get_safe)(struct efx_nic *efx,
1137 enum efx_filter_priority priority,
1138 u32 filter_id, struct efx_filter_spec *);
1139 void (*filter_clear_rx)(struct efx_nic *efx,
1140 enum efx_filter_priority priority);
1141 u32 (*filter_count_rx_used)(struct efx_nic *efx,
1142 enum efx_filter_priority priority);
1143 u32 (*filter_get_rx_id_limit)(struct efx_nic *efx);
1144 s32 (*filter_get_rx_ids)(struct efx_nic *efx,
1145 enum efx_filter_priority priority,
1146 u32 *buf, u32 size);
1147#ifdef CONFIG_RFS_ACCEL
1148 s32 (*filter_rfs_insert)(struct efx_nic *efx,
1149 struct efx_filter_spec *spec);
1150 bool (*filter_rfs_expire_one)(struct efx_nic *efx, u32 flow_id,
1151 unsigned int index);
1152#endif
Ben Hutchings45a3fd52012-11-28 04:38:14 +00001153#ifdef CONFIG_SFC_MTD
1154 int (*mtd_probe)(struct efx_nic *efx);
1155 void (*mtd_rename)(struct efx_mtd_partition *part);
1156 int (*mtd_read)(struct mtd_info *mtd, loff_t start, size_t len,
1157 size_t *retlen, u8 *buffer);
1158 int (*mtd_erase)(struct mtd_info *mtd, loff_t start, size_t len);
1159 int (*mtd_write)(struct mtd_info *mtd, loff_t start, size_t len,
1160 size_t *retlen, const u8 *buffer);
1161 int (*mtd_sync)(struct mtd_info *mtd);
1162#endif
Laurence Evans977a5d52013-03-07 11:46:58 +00001163 void (*ptp_write_host_time)(struct efx_nic *efx, u32 host_time);
Steve Hodgsonb895d732009-11-28 05:35:00 +00001164
Ben Hutchingsdaeda632009-11-28 05:36:04 +00001165 int revision;
Ben Hutchings8ceee662008-04-27 12:55:59 +01001166 unsigned int txd_ptr_tbl_base;
1167 unsigned int rxd_ptr_tbl_base;
1168 unsigned int buf_tbl_base;
1169 unsigned int evq_ptr_tbl_base;
1170 unsigned int evq_rptr_tbl_base;
Ben Hutchings9bbd7d92008-05-16 21:18:48 +01001171 u64 max_dma_mask;
Jon Cooper43a37392012-10-18 15:49:54 +01001172 unsigned int rx_prefix_size;
1173 unsigned int rx_hash_offset;
Ben Hutchings8ceee662008-04-27 12:55:59 +01001174 unsigned int rx_buffer_padding;
Ben Hutchings85740cdf2013-01-29 23:33:15 +00001175 bool can_rx_scatter;
Jon Coopere8c68c02013-03-08 10:18:28 +00001176 bool always_rx_scatter;
Ben Hutchings8ceee662008-04-27 12:55:59 +01001177 unsigned int max_interrupt_mode;
Ben Hutchingscc180b62011-12-08 19:51:47 +00001178 unsigned int timer_period_max;
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001179 netdev_features_t offload_features;
Ben Hutchingsdf2cd8a2012-09-19 00:56:18 +01001180 int mcdi_max_ver;
Ben Hutchingsadd72472012-11-08 01:46:53 +00001181 unsigned int max_rx_ip_filters;
Ben Hutchings8ceee662008-04-27 12:55:59 +01001182};
1183
1184/**************************************************************************
1185 *
1186 * Prototypes and inline functions
1187 *
1188 *************************************************************************/
1189
Ben Hutchingsf7d12cd2010-09-10 06:41:47 +00001190static inline struct efx_channel *
1191efx_get_channel(struct efx_nic *efx, unsigned index)
1192{
1193 EFX_BUG_ON_PARANOID(index >= efx->n_channels);
Ben Hutchings8313aca2010-09-10 06:41:57 +00001194 return efx->channel[index];
Ben Hutchingsf7d12cd2010-09-10 06:41:47 +00001195}
1196
Ben Hutchings8ceee662008-04-27 12:55:59 +01001197/* Iterate over all used channels */
1198#define efx_for_each_channel(_channel, _efx) \
Ben Hutchings8313aca2010-09-10 06:41:57 +00001199 for (_channel = (_efx)->channel[0]; \
1200 _channel; \
1201 _channel = (_channel->channel + 1 < (_efx)->n_channels) ? \
1202 (_efx)->channel[_channel->channel + 1] : NULL)
Ben Hutchings8ceee662008-04-27 12:55:59 +01001203
Ben Hutchings7f967c02012-02-13 23:45:02 +00001204/* Iterate over all used channels in reverse */
1205#define efx_for_each_channel_rev(_channel, _efx) \
1206 for (_channel = (_efx)->channel[(_efx)->n_channels - 1]; \
1207 _channel; \
1208 _channel = _channel->channel ? \
1209 (_efx)->channel[_channel->channel - 1] : NULL)
1210
Ben Hutchings97653432011-01-12 18:26:56 +00001211static inline struct efx_tx_queue *
1212efx_get_tx_queue(struct efx_nic *efx, unsigned index, unsigned type)
1213{
1214 EFX_BUG_ON_PARANOID(index >= efx->n_tx_channels ||
1215 type >= EFX_TXQ_TYPES);
1216 return &efx->channel[efx->tx_channel_offset + index]->tx_queue[type];
1217}
Ben Hutchingsf7d12cd2010-09-10 06:41:47 +00001218
Ben Hutchings525da902011-02-07 23:04:38 +00001219static inline bool efx_channel_has_tx_queues(struct efx_channel *channel)
1220{
1221 return channel->channel - channel->efx->tx_channel_offset <
1222 channel->efx->n_tx_channels;
1223}
1224
Ben Hutchingsf7d12cd2010-09-10 06:41:47 +00001225static inline struct efx_tx_queue *
1226efx_channel_get_tx_queue(struct efx_channel *channel, unsigned type)
1227{
Ben Hutchings525da902011-02-07 23:04:38 +00001228 EFX_BUG_ON_PARANOID(!efx_channel_has_tx_queues(channel) ||
1229 type >= EFX_TXQ_TYPES);
1230 return &channel->tx_queue[type];
Ben Hutchingsf7d12cd2010-09-10 06:41:47 +00001231}
Ben Hutchings8ceee662008-04-27 12:55:59 +01001232
Ben Hutchings94b274b2011-01-10 21:18:20 +00001233static inline bool efx_tx_queue_used(struct efx_tx_queue *tx_queue)
1234{
1235 return !(tx_queue->efx->net_dev->num_tc < 2 &&
1236 tx_queue->queue & EFX_TXQ_TYPE_HIGHPRI);
1237}
1238
Ben Hutchings8ceee662008-04-27 12:55:59 +01001239/* Iterate over all TX queues belonging to a channel */
1240#define efx_for_each_channel_tx_queue(_tx_queue, _channel) \
Ben Hutchings525da902011-02-07 23:04:38 +00001241 if (!efx_channel_has_tx_queues(_channel)) \
1242 ; \
1243 else \
1244 for (_tx_queue = (_channel)->tx_queue; \
Ben Hutchings94b274b2011-01-10 21:18:20 +00001245 _tx_queue < (_channel)->tx_queue + EFX_TXQ_TYPES && \
1246 efx_tx_queue_used(_tx_queue); \
Ben Hutchings525da902011-02-07 23:04:38 +00001247 _tx_queue++)
Ben Hutchings8ceee662008-04-27 12:55:59 +01001248
Ben Hutchings94b274b2011-01-10 21:18:20 +00001249/* Iterate over all possible TX queues belonging to a channel */
1250#define efx_for_each_possible_channel_tx_queue(_tx_queue, _channel) \
Ben Hutchings73e00262012-02-23 00:45:50 +00001251 if (!efx_channel_has_tx_queues(_channel)) \
1252 ; \
1253 else \
1254 for (_tx_queue = (_channel)->tx_queue; \
1255 _tx_queue < (_channel)->tx_queue + EFX_TXQ_TYPES; \
1256 _tx_queue++)
Ben Hutchings94b274b2011-01-10 21:18:20 +00001257
Ben Hutchings525da902011-02-07 23:04:38 +00001258static inline bool efx_channel_has_rx_queue(struct efx_channel *channel)
1259{
Stuart Hodgson79d68b32012-07-16 17:08:33 +01001260 return channel->rx_queue.core_index >= 0;
Ben Hutchings525da902011-02-07 23:04:38 +00001261}
1262
Ben Hutchingsf7d12cd2010-09-10 06:41:47 +00001263static inline struct efx_rx_queue *
1264efx_channel_get_rx_queue(struct efx_channel *channel)
1265{
Ben Hutchings525da902011-02-07 23:04:38 +00001266 EFX_BUG_ON_PARANOID(!efx_channel_has_rx_queue(channel));
1267 return &channel->rx_queue;
Ben Hutchingsf7d12cd2010-09-10 06:41:47 +00001268}
1269
Ben Hutchings8ceee662008-04-27 12:55:59 +01001270/* Iterate over all RX queues belonging to a channel */
1271#define efx_for_each_channel_rx_queue(_rx_queue, _channel) \
Ben Hutchings525da902011-02-07 23:04:38 +00001272 if (!efx_channel_has_rx_queue(_channel)) \
1273 ; \
1274 else \
1275 for (_rx_queue = &(_channel)->rx_queue; \
1276 _rx_queue; \
1277 _rx_queue = NULL)
Ben Hutchings8ceee662008-04-27 12:55:59 +01001278
Ben Hutchingsba1e8a32010-09-10 06:41:36 +00001279static inline struct efx_channel *
1280efx_rx_queue_channel(struct efx_rx_queue *rx_queue)
1281{
Ben Hutchings8313aca2010-09-10 06:41:57 +00001282 return container_of(rx_queue, struct efx_channel, rx_queue);
Ben Hutchingsba1e8a32010-09-10 06:41:36 +00001283}
1284
1285static inline int efx_rx_queue_index(struct efx_rx_queue *rx_queue)
1286{
Ben Hutchings8313aca2010-09-10 06:41:57 +00001287 return efx_rx_queue_channel(rx_queue)->channel;
Ben Hutchingsba1e8a32010-09-10 06:41:36 +00001288}
1289
Ben Hutchings8ceee662008-04-27 12:55:59 +01001290/* Returns a pointer to the specified receive buffer in the RX
1291 * descriptor queue.
1292 */
1293static inline struct efx_rx_buffer *efx_rx_buffer(struct efx_rx_queue *rx_queue,
1294 unsigned int index)
1295{
Eric Dumazet807540b2010-09-23 05:40:09 +00001296 return &rx_queue->buffer[index];
Ben Hutchings8ceee662008-04-27 12:55:59 +01001297}
1298
Ben Hutchings8ceee662008-04-27 12:55:59 +01001299
1300/**
1301 * EFX_MAX_FRAME_LEN - calculate maximum frame length
1302 *
1303 * This calculates the maximum frame length that will be used for a
1304 * given MTU. The frame length will be equal to the MTU plus a
1305 * constant amount of header space and padding. This is the quantity
1306 * that the net driver will program into the MAC as the maximum frame
1307 * length.
1308 *
Ben Hutchings754c6532010-02-03 09:31:57 +00001309 * The 10G MAC requires 8-byte alignment on the frame
Ben Hutchings8ceee662008-04-27 12:55:59 +01001310 * length, so we round up to the nearest 8.
Ben Hutchingscc117632009-08-26 08:17:59 +00001311 *
1312 * Re-clocking by the XGXS on RX can reduce an IPG to 32 bits (half an
1313 * XGMII cycle). If the frame length reaches the maximum value in the
1314 * same cycle, the XMAC can miss the IPG altogether. We work around
1315 * this by adding a further 16 bytes.
Ben Hutchings8ceee662008-04-27 12:55:59 +01001316 */
1317#define EFX_MAX_FRAME_LEN(mtu) \
Ben Hutchingscc117632009-08-26 08:17:59 +00001318 ((((mtu) + ETH_HLEN + VLAN_HLEN + 4/* FCS */ + 7) & ~7) + 16)
Ben Hutchings8ceee662008-04-27 12:55:59 +01001319
Stuart Hodgson7c236c42012-09-03 11:09:36 +01001320static inline bool efx_xmit_with_hwtstamp(struct sk_buff *skb)
1321{
1322 return skb_shinfo(skb)->tx_flags & SKBTX_HW_TSTAMP;
1323}
1324static inline void efx_xmit_hwtstamp_pending(struct sk_buff *skb)
1325{
1326 skb_shinfo(skb)->tx_flags |= SKBTX_IN_PROGRESS;
1327}
Ben Hutchings8ceee662008-04-27 12:55:59 +01001328
1329#endif /* EFX_NET_DRIVER_H */