blob: 9351c0331a47f028ff0cbf15211f66873e94117f [file] [log] [blame]
Ben Hutchings8ceee662008-04-27 12:55:59 +01001/****************************************************************************
2 * Driver for Solarflare Solarstorm network controllers and boards
3 * Copyright 2005-2006 Fen Systems Ltd.
Ben Hutchings906bb262009-11-29 15:16:19 +00004 * Copyright 2006-2009 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
Ben Hutchings744093c2009-11-29 15:12:08 +000011#ifndef EFX_NIC_H
12#define EFX_NIC_H
Ben Hutchings8ceee662008-04-27 12:55:59 +010013
Ben Hutchings5c16a962009-11-23 16:05:28 +000014#include <linux/i2c-algo-bit.h>
Ben Hutchings8ceee662008-04-27 12:55:59 +010015#include "net_driver.h"
Ben Hutchings177dfcd2008-12-12 21:50:08 -080016#include "efx.h"
Ben Hutchings8880f4e2009-11-29 15:15:41 +000017#include "mcdi.h"
Ben Hutchings8ceee662008-04-27 12:55:59 +010018
19/*
20 * Falcon hardware control
21 */
22
Ben Hutchingsdaeda632009-11-28 05:36:04 +000023enum {
24 EFX_REV_FALCON_A0 = 0,
25 EFX_REV_FALCON_A1 = 1,
26 EFX_REV_FALCON_B0 = 2,
Ben Hutchings8880f4e2009-11-29 15:15:41 +000027 EFX_REV_SIENA_A0 = 3,
Ben Hutchings8ceee662008-04-27 12:55:59 +010028};
29
Ben Hutchingsdaeda632009-11-28 05:36:04 +000030static inline int efx_nic_rev(struct efx_nic *efx)
Ben Hutchings55668612008-05-16 21:16:10 +010031{
Ben Hutchingsdaeda632009-11-28 05:36:04 +000032 return efx->type->revision;
Ben Hutchings55668612008-05-16 21:16:10 +010033}
Ben Hutchings8ceee662008-04-27 12:55:59 +010034
Ben Hutchings152b6a62009-11-29 03:43:56 +000035extern u32 efx_nic_fpga_ver(struct efx_nic *efx);
36
Ben Hutchings8880f4e2009-11-29 15:15:41 +000037static inline bool efx_nic_has_mc(struct efx_nic *efx)
38{
39 return efx_nic_rev(efx) >= EFX_REV_SIENA_A0;
40}
Ben Hutchings152b6a62009-11-29 03:43:56 +000041/* NIC has two interlinked PCI functions for the same port. */
42static inline bool efx_nic_is_dual_func(struct efx_nic *efx)
43{
44 return efx_nic_rev(efx) < EFX_REV_FALCON_B0;
45}
46
Ben Hutchingsc1c4f452009-11-29 15:08:55 +000047enum {
48 PHY_TYPE_NONE = 0,
49 PHY_TYPE_TXC43128 = 1,
50 PHY_TYPE_88E1111 = 2,
51 PHY_TYPE_SFX7101 = 3,
52 PHY_TYPE_QT2022C2 = 4,
53 PHY_TYPE_PM8358 = 6,
54 PHY_TYPE_SFT9001A = 8,
55 PHY_TYPE_QT2025C = 9,
56 PHY_TYPE_SFT9001B = 10,
57};
58
59#define FALCON_XMAC_LOOPBACKS \
60 ((1 << LOOPBACK_XGMII) | \
61 (1 << LOOPBACK_XGXS) | \
62 (1 << LOOPBACK_XAUI))
63
64#define FALCON_GMAC_LOOPBACKS \
65 (1 << LOOPBACK_GMAC)
66
Ben Hutchings5c16a962009-11-23 16:05:28 +000067/**
Ben Hutchings44838a42009-11-25 16:09:41 +000068 * struct falcon_board_type - board operations and type information
69 * @id: Board type id, as found in NVRAM
70 * @ref_model: Model number of Solarflare reference design
71 * @gen_type: Generic board type description
Ben Hutchings37594332009-11-23 16:05:45 +000072 * @init: Allocate resources and initialise peripheral hardware
73 * @init_phy: Do board-specific PHY initialisation
Ben Hutchings44838a42009-11-25 16:09:41 +000074 * @fini: Shut down hardware and free resources
Ben Hutchings37594332009-11-23 16:05:45 +000075 * @set_id_led: Set state of identifying LED or revert to automatic function
76 * @monitor: Board-specific health check function
Ben Hutchings44838a42009-11-25 16:09:41 +000077 */
78struct falcon_board_type {
79 u8 id;
80 const char *ref_model;
81 const char *gen_type;
82 int (*init) (struct efx_nic *nic);
83 void (*init_phy) (struct efx_nic *efx);
84 void (*fini) (struct efx_nic *nic);
85 void (*set_id_led) (struct efx_nic *efx, enum efx_led_mode mode);
86 int (*monitor) (struct efx_nic *nic);
87};
88
89/**
90 * struct falcon_board - board information
91 * @type: Type of board
92 * @major: Major rev. ('A', 'B' ...)
93 * @minor: Minor rev. (0, 1, ...)
Ben Hutchingse775fb92009-11-23 16:06:02 +000094 * @i2c_adap: I2C adapter for on-board peripherals
95 * @i2c_data: Data for bit-banging algorithm
Ben Hutchings37594332009-11-23 16:05:45 +000096 * @hwmon_client: I2C client for hardware monitor
97 * @ioexp_client: I2C client for power/port control
98 */
99struct falcon_board {
Ben Hutchings44838a42009-11-25 16:09:41 +0000100 const struct falcon_board_type *type;
Ben Hutchings37594332009-11-23 16:05:45 +0000101 int major;
102 int minor;
Ben Hutchingse775fb92009-11-23 16:06:02 +0000103 struct i2c_adapter i2c_adap;
104 struct i2c_algo_bit_data i2c_data;
Ben Hutchings37594332009-11-23 16:05:45 +0000105 struct i2c_client *hwmon_client, *ioexp_client;
106};
107
108/**
Ben Hutchings5c16a962009-11-23 16:05:28 +0000109 * struct falcon_nic_data - Falcon NIC state
Ben Hutchings89863522009-11-25 16:09:04 +0000110 * @pci_dev2: Secondary function of Falcon A
Ben Hutchings37594332009-11-23 16:05:45 +0000111 * @board: Board state and functions
Ben Hutchings55edc6e2009-11-25 16:11:35 +0000112 * @stats_disable_count: Nest count for disabling statistics fetches
113 * @stats_pending: Is there a pending DMA of MAC statistics.
114 * @stats_timer: A timer for regularly fetching MAC statistics.
115 * @stats_dma_done: Pointer to the flag which indicates DMA completion.
Ben Hutchings5c16a962009-11-23 16:05:28 +0000116 */
117struct falcon_nic_data {
118 struct pci_dev *pci_dev2;
Ben Hutchings37594332009-11-23 16:05:45 +0000119 struct falcon_board board;
Ben Hutchings55edc6e2009-11-25 16:11:35 +0000120 unsigned int stats_disable_count;
121 bool stats_pending;
122 struct timer_list stats_timer;
123 u32 *stats_dma_done;
Ben Hutchings5c16a962009-11-23 16:05:28 +0000124};
125
Ben Hutchings278c0622009-11-23 16:05:12 +0000126static inline struct falcon_board *falcon_board(struct efx_nic *efx)
127{
Ben Hutchings37594332009-11-23 16:05:45 +0000128 struct falcon_nic_data *data = efx->nic_data;
129 return &data->board;
Ben Hutchings278c0622009-11-23 16:05:12 +0000130}
131
Ben Hutchings8880f4e2009-11-29 15:15:41 +0000132/**
133 * struct siena_nic_data - Siena NIC state
134 * @fw_version: Management controller firmware version
135 * @fw_build: Firmware build number
136 * @mcdi: Management-Controller-to-Driver Interface
137 * @wol_filter_id: Wake-on-LAN packet filter id
138 */
139struct siena_nic_data {
140 u64 fw_version;
141 u32 fw_build;
142 struct efx_mcdi_iface mcdi;
143 int wol_filter_id;
144};
145
146extern void siena_print_fwver(struct efx_nic *efx, char *buf, size_t len);
147
Ben Hutchingsdaeda632009-11-28 05:36:04 +0000148extern struct efx_nic_type falcon_a1_nic_type;
149extern struct efx_nic_type falcon_b0_nic_type;
Ben Hutchings8880f4e2009-11-29 15:15:41 +0000150extern struct efx_nic_type siena_a0_nic_type;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100151
152/**************************************************************************
153 *
154 * Externs
155 *
156 **************************************************************************
157 */
158
Ben Hutchings5087b542009-10-23 08:29:51 +0000159extern void falcon_probe_board(struct efx_nic *efx, u16 revision_info);
160
Ben Hutchings8ceee662008-04-27 12:55:59 +0100161/* TX data path */
Ben Hutchings152b6a62009-11-29 03:43:56 +0000162extern int efx_nic_probe_tx(struct efx_tx_queue *tx_queue);
163extern void efx_nic_init_tx(struct efx_tx_queue *tx_queue);
164extern void efx_nic_fini_tx(struct efx_tx_queue *tx_queue);
165extern void efx_nic_remove_tx(struct efx_tx_queue *tx_queue);
166extern void efx_nic_push_buffers(struct efx_tx_queue *tx_queue);
Ben Hutchings8ceee662008-04-27 12:55:59 +0100167
168/* RX data path */
Ben Hutchings152b6a62009-11-29 03:43:56 +0000169extern int efx_nic_probe_rx(struct efx_rx_queue *rx_queue);
170extern void efx_nic_init_rx(struct efx_rx_queue *rx_queue);
171extern void efx_nic_fini_rx(struct efx_rx_queue *rx_queue);
172extern void efx_nic_remove_rx(struct efx_rx_queue *rx_queue);
173extern void efx_nic_notify_rx_desc(struct efx_rx_queue *rx_queue);
Ben Hutchings8ceee662008-04-27 12:55:59 +0100174
175/* Event data path */
Ben Hutchings152b6a62009-11-29 03:43:56 +0000176extern int efx_nic_probe_eventq(struct efx_channel *channel);
177extern void efx_nic_init_eventq(struct efx_channel *channel);
178extern void efx_nic_fini_eventq(struct efx_channel *channel);
179extern void efx_nic_remove_eventq(struct efx_channel *channel);
180extern int efx_nic_process_eventq(struct efx_channel *channel, int rx_quota);
181extern void efx_nic_eventq_read_ack(struct efx_channel *channel);
Ben Hutchings8ceee662008-04-27 12:55:59 +0100182
Ben Hutchings8ceee662008-04-27 12:55:59 +0100183/* MAC/PHY */
Ben Hutchings8ceee662008-04-27 12:55:59 +0100184extern void falcon_drain_tx_fifo(struct efx_nic *efx);
Ben Hutchings8ceee662008-04-27 12:55:59 +0100185extern void falcon_reconfigure_mac_wrapper(struct efx_nic *efx);
Ben Hutchings152b6a62009-11-29 03:43:56 +0000186extern int efx_nic_rx_xoff_thresh, efx_nic_rx_xon_thresh;
Ben Hutchings8ceee662008-04-27 12:55:59 +0100187
188/* Interrupts and test events */
Ben Hutchings152b6a62009-11-29 03:43:56 +0000189extern int efx_nic_init_interrupt(struct efx_nic *efx);
190extern void efx_nic_enable_interrupts(struct efx_nic *efx);
191extern void efx_nic_generate_test_event(struct efx_channel *channel,
192 unsigned int magic);
193extern void efx_nic_generate_interrupt(struct efx_nic *efx);
194extern void efx_nic_disable_interrupts(struct efx_nic *efx);
195extern void efx_nic_fini_interrupt(struct efx_nic *efx);
196extern irqreturn_t efx_nic_fatal_interrupt(struct efx_nic *efx);
197extern irqreturn_t falcon_legacy_interrupt_a1(int irq, void *dev_id);
198extern void falcon_irq_ack_a1(struct efx_nic *efx);
Ben Hutchings8ceee662008-04-27 12:55:59 +0100199
Ben Hutchings152b6a62009-11-29 03:43:56 +0000200#define EFX_IRQ_MOD_RESOLUTION 5
Ben Hutchings6fb70fd2009-03-20 13:30:37 +0000201
Ben Hutchings8ceee662008-04-27 12:55:59 +0100202/* Global Resources */
Ben Hutchings152b6a62009-11-29 03:43:56 +0000203extern int efx_nic_flush_queues(struct efx_nic *efx);
Ben Hutchings55edc6e2009-11-25 16:11:35 +0000204extern void falcon_start_nic_stats(struct efx_nic *efx);
205extern void falcon_stop_nic_stats(struct efx_nic *efx);
Ben Hutchings8ceee662008-04-27 12:55:59 +0100206extern int falcon_reset_xaui(struct efx_nic *efx);
Ben Hutchings152b6a62009-11-29 03:43:56 +0000207extern void efx_nic_init_common(struct efx_nic *efx);
208
209int efx_nic_alloc_buffer(struct efx_nic *efx, struct efx_buffer *buffer,
210 unsigned int len);
211void efx_nic_free_buffer(struct efx_nic *efx, struct efx_buffer *buffer);
Ben Hutchings8ceee662008-04-27 12:55:59 +0100212
Ben Hutchings8c8661e2008-09-01 12:49:02 +0100213/* Tests */
Ben Hutchings152b6a62009-11-29 03:43:56 +0000214struct efx_nic_register_test {
215 unsigned address;
216 efx_oword_t mask;
217};
218extern int efx_nic_test_registers(struct efx_nic *efx,
219 const struct efx_nic_register_test *regs,
220 size_t n_regs);
Ben Hutchings8c8661e2008-09-01 12:49:02 +0100221
Ben Hutchings8ceee662008-04-27 12:55:59 +0100222/**************************************************************************
223 *
224 * Falcon MAC stats
225 *
226 **************************************************************************
227 */
228
229#define FALCON_STAT_OFFSET(falcon_stat) EFX_VAL(falcon_stat, offset)
230#define FALCON_STAT_WIDTH(falcon_stat) EFX_VAL(falcon_stat, WIDTH)
231
232/* Retrieve statistic from statistics block */
233#define FALCON_STAT(efx, falcon_stat, efx_stat) do { \
234 if (FALCON_STAT_WIDTH(falcon_stat) == 16) \
235 (efx)->mac_stats.efx_stat += le16_to_cpu( \
236 *((__force __le16 *) \
237 (efx->stats_buffer.addr + \
238 FALCON_STAT_OFFSET(falcon_stat)))); \
239 else if (FALCON_STAT_WIDTH(falcon_stat) == 32) \
240 (efx)->mac_stats.efx_stat += le32_to_cpu( \
241 *((__force __le32 *) \
242 (efx->stats_buffer.addr + \
243 FALCON_STAT_OFFSET(falcon_stat)))); \
244 else \
245 (efx)->mac_stats.efx_stat += le64_to_cpu( \
246 *((__force __le64 *) \
247 (efx->stats_buffer.addr + \
248 FALCON_STAT_OFFSET(falcon_stat)))); \
249 } while (0)
250
251#define FALCON_MAC_STATS_SIZE 0x100
252
253#define MAC_DATA_LBN 0
254#define MAC_DATA_WIDTH 32
255
Ben Hutchings152b6a62009-11-29 03:43:56 +0000256extern void efx_nic_generate_event(struct efx_channel *channel,
257 efx_qword_t *event);
Ben Hutchings8ceee662008-04-27 12:55:59 +0100258
Ben Hutchings9007b9f2009-11-25 16:12:01 +0000259extern void falcon_poll_xmac(struct efx_nic *efx);
260
Ben Hutchings744093c2009-11-29 15:12:08 +0000261#endif /* EFX_NIC_H */