]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - drivers/net/ethernet/sfc/nic.h
sfc: Test all event queues in parallel
[mirror_ubuntu-hirsute-kernel.git] / drivers / net / ethernet / sfc / nic.h
CommitLineData
8ceee660
BH
1/****************************************************************************
2 * Driver for Solarflare Solarstorm network controllers and boards
3 * Copyright 2005-2006 Fen Systems Ltd.
0a6f40c6 4 * Copyright 2006-2011 Solarflare Communications Inc.
8ceee660
BH
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License version 2 as published
8 * by the Free Software Foundation, incorporated herein by reference.
9 */
10
744093c9
BH
11#ifndef EFX_NIC_H
12#define EFX_NIC_H
8ceee660 13
5c16a96c 14#include <linux/i2c-algo-bit.h>
8ceee660 15#include "net_driver.h"
177dfcd8 16#include "efx.h"
8880f4ec 17#include "mcdi.h"
4de92180 18#include "spi.h"
8ceee660
BH
19
20/*
21 * Falcon hardware control
22 */
23
daeda630
BH
24enum {
25 EFX_REV_FALCON_A0 = 0,
26 EFX_REV_FALCON_A1 = 1,
27 EFX_REV_FALCON_B0 = 2,
8880f4ec 28 EFX_REV_SIENA_A0 = 3,
8ceee660
BH
29};
30
daeda630 31static inline int efx_nic_rev(struct efx_nic *efx)
55668611 32{
daeda630 33 return efx->type->revision;
55668611 34}
8ceee660 35
152b6a62
BH
36extern u32 efx_nic_fpga_ver(struct efx_nic *efx);
37
38/* NIC has two interlinked PCI functions for the same port. */
39static inline bool efx_nic_is_dual_func(struct efx_nic *efx)
40{
41 return efx_nic_rev(efx) < EFX_REV_FALCON_B0;
42}
43
c1c4f453
BH
44enum {
45 PHY_TYPE_NONE = 0,
46 PHY_TYPE_TXC43128 = 1,
47 PHY_TYPE_88E1111 = 2,
48 PHY_TYPE_SFX7101 = 3,
49 PHY_TYPE_QT2022C2 = 4,
50 PHY_TYPE_PM8358 = 6,
51 PHY_TYPE_SFT9001A = 8,
52 PHY_TYPE_QT2025C = 9,
53 PHY_TYPE_SFT9001B = 10,
54};
55
56#define FALCON_XMAC_LOOPBACKS \
57 ((1 << LOOPBACK_XGMII) | \
58 (1 << LOOPBACK_XGXS) | \
59 (1 << LOOPBACK_XAUI))
60
61#define FALCON_GMAC_LOOPBACKS \
62 (1 << LOOPBACK_GMAC)
63
5b6262d0
BH
64/* Alignment of PCIe DMA boundaries (4KB) */
65#define EFX_PAGE_SIZE 4096
66/* Size and alignment of buffer table entries (same) */
67#define EFX_BUF_SIZE EFX_PAGE_SIZE
68
3759433d 69/**
44838a44
BH
70 * struct falcon_board_type - board operations and type information
71 * @id: Board type id, as found in NVRAM
72 * @ref_model: Model number of Solarflare reference design
73 * @gen_type: Generic board type description
3759433d
BH
74 * @init: Allocate resources and initialise peripheral hardware
75 * @init_phy: Do board-specific PHY initialisation
44838a44 76 * @fini: Shut down hardware and free resources
3759433d
BH
77 * @set_id_led: Set state of identifying LED or revert to automatic function
78 * @monitor: Board-specific health check function
44838a44
BH
79 */
80struct falcon_board_type {
81 u8 id;
82 const char *ref_model;
83 const char *gen_type;
84 int (*init) (struct efx_nic *nic);
85 void (*init_phy) (struct efx_nic *efx);
86 void (*fini) (struct efx_nic *nic);
87 void (*set_id_led) (struct efx_nic *efx, enum efx_led_mode mode);
88 int (*monitor) (struct efx_nic *nic);
89};
90
91/**
92 * struct falcon_board - board information
93 * @type: Type of board
94 * @major: Major rev. ('A', 'B' ...)
95 * @minor: Minor rev. (0, 1, ...)
e775fb93
BH
96 * @i2c_adap: I2C adapter for on-board peripherals
97 * @i2c_data: Data for bit-banging algorithm
3759433d
BH
98 * @hwmon_client: I2C client for hardware monitor
99 * @ioexp_client: I2C client for power/port control
100 */
101struct falcon_board {
44838a44 102 const struct falcon_board_type *type;
3759433d
BH
103 int major;
104 int minor;
e775fb93
BH
105 struct i2c_adapter i2c_adap;
106 struct i2c_algo_bit_data i2c_data;
3759433d
BH
107 struct i2c_client *hwmon_client, *ioexp_client;
108};
109
5c16a96c
BH
110/**
111 * struct falcon_nic_data - Falcon NIC state
8986352a 112 * @pci_dev2: Secondary function of Falcon A
3759433d 113 * @board: Board state and functions
55edc6e6
BH
114 * @stats_disable_count: Nest count for disabling statistics fetches
115 * @stats_pending: Is there a pending DMA of MAC statistics.
116 * @stats_timer: A timer for regularly fetching MAC statistics.
117 * @stats_dma_done: Pointer to the flag which indicates DMA completion.
4de92180
BH
118 * @spi_flash: SPI flash device
119 * @spi_eeprom: SPI EEPROM device
120 * @spi_lock: SPI bus lock
4833f02a 121 * @mdio_lock: MDIO bus lock
cef68bde 122 * @xmac_poll_required: XMAC link state needs polling
5c16a96c
BH
123 */
124struct falcon_nic_data {
125 struct pci_dev *pci_dev2;
3759433d 126 struct falcon_board board;
55edc6e6
BH
127 unsigned int stats_disable_count;
128 bool stats_pending;
129 struct timer_list stats_timer;
130 u32 *stats_dma_done;
4de92180
BH
131 struct efx_spi_device spi_flash;
132 struct efx_spi_device spi_eeprom;
133 struct mutex spi_lock;
4833f02a 134 struct mutex mdio_lock;
cef68bde 135 bool xmac_poll_required;
5c16a96c
BH
136};
137
278c0621
BH
138static inline struct falcon_board *falcon_board(struct efx_nic *efx)
139{
3759433d
BH
140 struct falcon_nic_data *data = efx->nic_data;
141 return &data->board;
278c0621
BH
142}
143
8880f4ec
BH
144/**
145 * struct siena_nic_data - Siena NIC state
8880f4ec
BH
146 * @mcdi: Management-Controller-to-Driver Interface
147 * @wol_filter_id: Wake-on-LAN packet filter id
55c5e0f8 148 * @hwmon: Hardware monitor state
8880f4ec
BH
149 */
150struct siena_nic_data {
8880f4ec
BH
151 struct efx_mcdi_iface mcdi;
152 int wol_filter_id;
55c5e0f8
BH
153#ifdef CONFIG_SFC_MCDI_MON
154 struct efx_mcdi_mon hwmon;
155#endif
8880f4ec
BH
156};
157
55c5e0f8
BH
158#ifdef CONFIG_SFC_MCDI_MON
159static inline struct efx_mcdi_mon *efx_mcdi_mon(struct efx_nic *efx)
160{
161 struct siena_nic_data *nic_data;
162 EFX_BUG_ON_PARANOID(efx_nic_rev(efx) < EFX_REV_SIENA_A0);
163 nic_data = efx->nic_data;
164 return &nic_data->hwmon;
165}
166#endif
167
cd2d5b52
BH
168/*
169 * On the SFC9000 family each port is associated with 1 PCI physical
170 * function (PF) handled by sfc and a configurable number of virtual
171 * functions (VFs) that may be handled by some other driver, often in
172 * a VM guest. The queue pointer registers are mapped in both PF and
173 * VF BARs such that an 8K region provides access to a single RX, TX
174 * and event queue (collectively a Virtual Interface, VI or VNIC).
175 *
176 * The PF has access to all 1024 VIs while VFs are mapped to VIs
177 * according to VI_BASE and VI_SCALE: VF i has access to VIs numbered
178 * in range [VI_BASE + i << VI_SCALE, VI_BASE + i + 1 << VI_SCALE).
179 * The number of VIs and the VI_SCALE value are configurable but must
180 * be established at boot time by firmware.
181 */
182
183/* Maximum VI_SCALE parameter supported by Siena */
184#define EFX_VI_SCALE_MAX 6
185/* Base VI to use for SR-IOV. Must be aligned to (1 << EFX_VI_SCALE_MAX),
186 * so this is the smallest allowed value. */
187#define EFX_VI_BASE 128U
188/* Maximum number of VFs allowed */
189#define EFX_VF_COUNT_MAX 127
190/* Limit EVQs on VFs to be only 8k to reduce buffer table reservation */
191#define EFX_MAX_VF_EVQ_SIZE 8192UL
192/* The number of buffer table entries reserved for each VI on a VF */
193#define EFX_VF_BUFTBL_PER_VI \
194 ((EFX_MAX_VF_EVQ_SIZE + 2 * EFX_MAX_DMAQ_SIZE) * \
195 sizeof(efx_qword_t) / EFX_BUF_SIZE)
196
197#ifdef CONFIG_SFC_SRIOV
198
199static inline bool efx_sriov_wanted(struct efx_nic *efx)
200{
201 return efx->vf_count != 0;
202}
203static inline bool efx_sriov_enabled(struct efx_nic *efx)
204{
205 return efx->vf_init_count != 0;
206}
207static inline unsigned int efx_vf_size(struct efx_nic *efx)
208{
209 return 1 << efx->vi_scale;
210}
211
212extern int efx_init_sriov(void);
213extern void efx_sriov_probe(struct efx_nic *efx);
214extern int efx_sriov_init(struct efx_nic *efx);
215extern void efx_sriov_mac_address_changed(struct efx_nic *efx);
216extern void efx_sriov_tx_flush_done(struct efx_nic *efx, efx_qword_t *event);
217extern void efx_sriov_rx_flush_done(struct efx_nic *efx, efx_qword_t *event);
218extern void efx_sriov_event(struct efx_channel *channel, efx_qword_t *event);
219extern void efx_sriov_desc_fetch_err(struct efx_nic *efx, unsigned dmaq);
220extern void efx_sriov_flr(struct efx_nic *efx, unsigned flr);
221extern void efx_sriov_reset(struct efx_nic *efx);
222extern void efx_sriov_fini(struct efx_nic *efx);
223extern void efx_fini_sriov(void);
224
225#else
226
227static inline bool efx_sriov_wanted(struct efx_nic *efx) { return false; }
228static inline bool efx_sriov_enabled(struct efx_nic *efx) { return false; }
229static inline unsigned int efx_vf_size(struct efx_nic *efx) { return 0; }
230
231static inline int efx_init_sriov(void) { return 0; }
232static inline void efx_sriov_probe(struct efx_nic *efx) {}
233static inline int efx_sriov_init(struct efx_nic *efx) { return -EOPNOTSUPP; }
234static inline void efx_sriov_mac_address_changed(struct efx_nic *efx) {}
235static inline void efx_sriov_tx_flush_done(struct efx_nic *efx,
236 efx_qword_t *event) {}
237static inline void efx_sriov_rx_flush_done(struct efx_nic *efx,
238 efx_qword_t *event) {}
239static inline void efx_sriov_event(struct efx_channel *channel,
240 efx_qword_t *event) {}
241static inline void efx_sriov_desc_fetch_err(struct efx_nic *efx, unsigned dmaq) {}
242static inline void efx_sriov_flr(struct efx_nic *efx, unsigned flr) {}
243static inline void efx_sriov_reset(struct efx_nic *efx) {}
244static inline void efx_sriov_fini(struct efx_nic *efx) {}
245static inline void efx_fini_sriov(void) {}
246
247#endif
248
249extern int efx_sriov_set_vf_mac(struct net_device *dev, int vf, u8 *mac);
250extern int efx_sriov_set_vf_vlan(struct net_device *dev, int vf,
251 u16 vlan, u8 qos);
252extern int efx_sriov_get_vf_config(struct net_device *dev, int vf,
253 struct ifla_vf_info *ivf);
254extern int efx_sriov_set_vf_spoofchk(struct net_device *net_dev, int vf,
255 bool spoofchk);
256
6c8c2513 257extern const struct efx_nic_type falcon_a1_nic_type;
258extern const struct efx_nic_type falcon_b0_nic_type;
259extern const struct efx_nic_type siena_a0_nic_type;
8ceee660
BH
260
261/**************************************************************************
262 *
263 * Externs
264 *
265 **************************************************************************
266 */
267
e41c11ee 268extern int falcon_probe_board(struct efx_nic *efx, u16 revision_info);
5087b54d 269
8ceee660 270/* TX data path */
152b6a62
BH
271extern int efx_nic_probe_tx(struct efx_tx_queue *tx_queue);
272extern void efx_nic_init_tx(struct efx_tx_queue *tx_queue);
273extern void efx_nic_fini_tx(struct efx_tx_queue *tx_queue);
274extern void efx_nic_remove_tx(struct efx_tx_queue *tx_queue);
275extern void efx_nic_push_buffers(struct efx_tx_queue *tx_queue);
8ceee660
BH
276
277/* RX data path */
152b6a62
BH
278extern int efx_nic_probe_rx(struct efx_rx_queue *rx_queue);
279extern void efx_nic_init_rx(struct efx_rx_queue *rx_queue);
280extern void efx_nic_fini_rx(struct efx_rx_queue *rx_queue);
281extern void efx_nic_remove_rx(struct efx_rx_queue *rx_queue);
282extern void efx_nic_notify_rx_desc(struct efx_rx_queue *rx_queue);
2ae75dac 283extern void efx_nic_generate_fill_event(struct efx_rx_queue *rx_queue);
8ceee660
BH
284
285/* Event data path */
152b6a62
BH
286extern int efx_nic_probe_eventq(struct efx_channel *channel);
287extern void efx_nic_init_eventq(struct efx_channel *channel);
288extern void efx_nic_fini_eventq(struct efx_channel *channel);
289extern void efx_nic_remove_eventq(struct efx_channel *channel);
290extern int efx_nic_process_eventq(struct efx_channel *channel, int rx_quota);
291extern void efx_nic_eventq_read_ack(struct efx_channel *channel);
d4fabcc8 292extern bool efx_nic_event_present(struct efx_channel *channel);
8ceee660 293
8ceee660 294/* MAC/PHY */
8ceee660 295extern void falcon_drain_tx_fifo(struct efx_nic *efx);
8ceee660 296extern void falcon_reconfigure_mac_wrapper(struct efx_nic *efx);
710b208d
BH
297extern bool falcon_xmac_check_fault(struct efx_nic *efx);
298extern int falcon_reconfigure_xmac(struct efx_nic *efx);
299extern void falcon_update_stats_xmac(struct efx_nic *efx);
8ceee660
BH
300
301/* Interrupts and test events */
152b6a62
BH
302extern int efx_nic_init_interrupt(struct efx_nic *efx);
303extern void efx_nic_enable_interrupts(struct efx_nic *efx);
d730dc52 304extern void efx_nic_generate_test_event(struct efx_channel *channel);
152b6a62
BH
305extern void efx_nic_generate_interrupt(struct efx_nic *efx);
306extern void efx_nic_disable_interrupts(struct efx_nic *efx);
307extern void efx_nic_fini_interrupt(struct efx_nic *efx);
308extern irqreturn_t efx_nic_fatal_interrupt(struct efx_nic *efx);
309extern irqreturn_t falcon_legacy_interrupt_a1(int irq, void *dev_id);
310extern void falcon_irq_ack_a1(struct efx_nic *efx);
311
8ceee660 312/* Global Resources */
152b6a62 313extern int efx_nic_flush_queues(struct efx_nic *efx);
55edc6e6
BH
314extern void falcon_start_nic_stats(struct efx_nic *efx);
315extern void falcon_stop_nic_stats(struct efx_nic *efx);
b7b40eeb 316extern void falcon_setup_xaui(struct efx_nic *efx);
8ceee660 317extern int falcon_reset_xaui(struct efx_nic *efx);
28e47c49
BH
318extern void
319efx_nic_dimension_resources(struct efx_nic *efx, unsigned sram_lim_qw);
152b6a62 320extern void efx_nic_init_common(struct efx_nic *efx);
765c9f46 321extern void efx_nic_push_rx_indir_table(struct efx_nic *efx);
152b6a62
BH
322
323int efx_nic_alloc_buffer(struct efx_nic *efx, struct efx_buffer *buffer,
324 unsigned int len);
325void efx_nic_free_buffer(struct efx_nic *efx, struct efx_buffer *buffer);
8ceee660 326
8c8661e4 327/* Tests */
152b6a62
BH
328struct efx_nic_register_test {
329 unsigned address;
330 efx_oword_t mask;
331};
332extern int efx_nic_test_registers(struct efx_nic *efx,
333 const struct efx_nic_register_test *regs,
334 size_t n_regs);
8c8661e4 335
5b98c1bf
BH
336extern size_t efx_nic_get_regs_len(struct efx_nic *efx);
337extern void efx_nic_get_regs(struct efx_nic *efx, void *buf);
338
8ceee660
BH
339/**************************************************************************
340 *
341 * Falcon MAC stats
342 *
343 **************************************************************************
344 */
345
346#define FALCON_STAT_OFFSET(falcon_stat) EFX_VAL(falcon_stat, offset)
347#define FALCON_STAT_WIDTH(falcon_stat) EFX_VAL(falcon_stat, WIDTH)
348
349/* Retrieve statistic from statistics block */
350#define FALCON_STAT(efx, falcon_stat, efx_stat) do { \
351 if (FALCON_STAT_WIDTH(falcon_stat) == 16) \
352 (efx)->mac_stats.efx_stat += le16_to_cpu( \
353 *((__force __le16 *) \
354 (efx->stats_buffer.addr + \
355 FALCON_STAT_OFFSET(falcon_stat)))); \
356 else if (FALCON_STAT_WIDTH(falcon_stat) == 32) \
357 (efx)->mac_stats.efx_stat += le32_to_cpu( \
358 *((__force __le32 *) \
359 (efx->stats_buffer.addr + \
360 FALCON_STAT_OFFSET(falcon_stat)))); \
361 else \
362 (efx)->mac_stats.efx_stat += le64_to_cpu( \
363 *((__force __le64 *) \
364 (efx->stats_buffer.addr + \
365 FALCON_STAT_OFFSET(falcon_stat)))); \
366 } while (0)
367
368#define FALCON_MAC_STATS_SIZE 0x100
369
370#define MAC_DATA_LBN 0
371#define MAC_DATA_WIDTH 32
372
90893000
BH
373extern void efx_generate_event(struct efx_nic *efx, unsigned int evq,
374 efx_qword_t *event);
8ceee660 375
9007b9fa
BH
376extern void falcon_poll_xmac(struct efx_nic *efx);
377
744093c9 378#endif /* EFX_NIC_H */