5fb24d3aa3cafba68733d64a4663c5de411a5c31
[pandora-kernel.git] / drivers / net / ethernet / sfc / nic.h
1 /****************************************************************************
2  * Driver for Solarflare Solarstorm network controllers and boards
3  * Copyright 2005-2006 Fen Systems Ltd.
4  * Copyright 2006-2011 Solarflare Communications Inc.
5  *
6  * This program is free software; you can redistribute it and/or modify it
7  * under the terms of the GNU General Public License version 2 as published
8  * by the Free Software Foundation, incorporated herein by reference.
9  */
10
11 #ifndef EFX_NIC_H
12 #define EFX_NIC_H
13
14 #include <linux/i2c-algo-bit.h>
15 #include "net_driver.h"
16 #include "efx.h"
17 #include "mcdi.h"
18 #include "spi.h"
19
20 /*
21  * Falcon hardware control
22  */
23
24 enum {
25         EFX_REV_FALCON_A0 = 0,
26         EFX_REV_FALCON_A1 = 1,
27         EFX_REV_FALCON_B0 = 2,
28         EFX_REV_SIENA_A0 = 3,
29 };
30
31 static inline int efx_nic_rev(struct efx_nic *efx)
32 {
33         return efx->type->revision;
34 }
35
36 extern u32 efx_nic_fpga_ver(struct efx_nic *efx);
37
38 static inline bool efx_nic_has_mc(struct efx_nic *efx)
39 {
40         return efx_nic_rev(efx) >= EFX_REV_SIENA_A0;
41 }
42 /* NIC has two interlinked PCI functions for the same port. */
43 static inline bool efx_nic_is_dual_func(struct efx_nic *efx)
44 {
45         return efx_nic_rev(efx) < EFX_REV_FALCON_B0;
46 }
47
48 enum {
49         PHY_TYPE_NONE = 0,
50         PHY_TYPE_TXC43128 = 1,
51         PHY_TYPE_88E1111 = 2,
52         PHY_TYPE_SFX7101 = 3,
53         PHY_TYPE_QT2022C2 = 4,
54         PHY_TYPE_PM8358 = 6,
55         PHY_TYPE_SFT9001A = 8,
56         PHY_TYPE_QT2025C = 9,
57         PHY_TYPE_SFT9001B = 10,
58 };
59
60 #define FALCON_XMAC_LOOPBACKS                   \
61         ((1 << LOOPBACK_XGMII) |                \
62          (1 << LOOPBACK_XGXS) |                 \
63          (1 << LOOPBACK_XAUI))
64
65 #define FALCON_GMAC_LOOPBACKS                   \
66         (1 << LOOPBACK_GMAC)
67
68 /**
69  * struct falcon_board_type - board operations and type information
70  * @id: Board type id, as found in NVRAM
71  * @ref_model: Model number of Solarflare reference design
72  * @gen_type: Generic board type description
73  * @init: Allocate resources and initialise peripheral hardware
74  * @init_phy: Do board-specific PHY initialisation
75  * @fini: Shut down hardware and free resources
76  * @set_id_led: Set state of identifying LED or revert to automatic function
77  * @monitor: Board-specific health check function
78  */
79 struct falcon_board_type {
80         u8 id;
81         const char *ref_model;
82         const char *gen_type;
83         int (*init) (struct efx_nic *nic);
84         void (*init_phy) (struct efx_nic *efx);
85         void (*fini) (struct efx_nic *nic);
86         void (*set_id_led) (struct efx_nic *efx, enum efx_led_mode mode);
87         int (*monitor) (struct efx_nic *nic);
88 };
89
90 /**
91  * struct falcon_board - board information
92  * @type: Type of board
93  * @major: Major rev. ('A', 'B' ...)
94  * @minor: Minor rev. (0, 1, ...)
95  * @i2c_adap: I2C adapter for on-board peripherals
96  * @i2c_data: Data for bit-banging algorithm
97  * @hwmon_client: I2C client for hardware monitor
98  * @ioexp_client: I2C client for power/port control
99  */
100 struct falcon_board {
101         const struct falcon_board_type *type;
102         int major;
103         int minor;
104         struct i2c_adapter i2c_adap;
105         struct i2c_algo_bit_data i2c_data;
106         struct i2c_client *hwmon_client, *ioexp_client;
107 };
108
109 /**
110  * struct falcon_nic_data - Falcon NIC state
111  * @pci_dev2: Secondary function of Falcon A
112  * @board: Board state and functions
113  * @stats_disable_count: Nest count for disabling statistics fetches
114  * @stats_pending: Is there a pending DMA of MAC statistics.
115  * @stats_timer: A timer for regularly fetching MAC statistics.
116  * @stats_dma_done: Pointer to the flag which indicates DMA completion.
117  * @spi_flash: SPI flash device
118  * @spi_eeprom: SPI EEPROM device
119  * @spi_lock: SPI bus lock
120  * @mdio_lock: MDIO bus lock
121  * @xmac_poll_required: XMAC link state needs polling
122  */
123 struct falcon_nic_data {
124         struct pci_dev *pci_dev2;
125         struct falcon_board board;
126         unsigned int stats_disable_count;
127         bool stats_pending;
128         struct timer_list stats_timer;
129         u32 *stats_dma_done;
130         struct efx_spi_device spi_flash;
131         struct efx_spi_device spi_eeprom;
132         struct mutex spi_lock;
133         struct mutex mdio_lock;
134         bool xmac_poll_required;
135 };
136
137 static inline struct falcon_board *falcon_board(struct efx_nic *efx)
138 {
139         struct falcon_nic_data *data = efx->nic_data;
140         return &data->board;
141 }
142
143 /**
144  * struct siena_nic_data - Siena NIC state
145  * @mcdi: Management-Controller-to-Driver Interface
146  * @wol_filter_id: Wake-on-LAN packet filter id
147  */
148 struct siena_nic_data {
149         struct efx_mcdi_iface mcdi;
150         int wol_filter_id;
151 };
152
153 extern const struct efx_nic_type falcon_a1_nic_type;
154 extern const struct efx_nic_type falcon_b0_nic_type;
155 extern const struct efx_nic_type siena_a0_nic_type;
156
157 /**************************************************************************
158  *
159  * Externs
160  *
161  **************************************************************************
162  */
163
164 extern int falcon_probe_board(struct efx_nic *efx, u16 revision_info);
165
166 /* TX data path */
167 extern int efx_nic_probe_tx(struct efx_tx_queue *tx_queue);
168 extern void efx_nic_init_tx(struct efx_tx_queue *tx_queue);
169 extern void efx_nic_fini_tx(struct efx_tx_queue *tx_queue);
170 extern void efx_nic_remove_tx(struct efx_tx_queue *tx_queue);
171 extern void efx_nic_push_buffers(struct efx_tx_queue *tx_queue);
172
173 /* RX data path */
174 extern int efx_nic_probe_rx(struct efx_rx_queue *rx_queue);
175 extern void efx_nic_init_rx(struct efx_rx_queue *rx_queue);
176 extern void efx_nic_fini_rx(struct efx_rx_queue *rx_queue);
177 extern void efx_nic_remove_rx(struct efx_rx_queue *rx_queue);
178 extern void efx_nic_notify_rx_desc(struct efx_rx_queue *rx_queue);
179
180 /* Event data path */
181 extern int efx_nic_probe_eventq(struct efx_channel *channel);
182 extern void efx_nic_init_eventq(struct efx_channel *channel);
183 extern void efx_nic_fini_eventq(struct efx_channel *channel);
184 extern void efx_nic_remove_eventq(struct efx_channel *channel);
185 extern int efx_nic_process_eventq(struct efx_channel *channel, int rx_quota);
186 extern void efx_nic_eventq_read_ack(struct efx_channel *channel);
187 extern bool efx_nic_event_present(struct efx_channel *channel);
188
189 /* MAC/PHY */
190 extern void falcon_drain_tx_fifo(struct efx_nic *efx);
191 extern void falcon_reconfigure_mac_wrapper(struct efx_nic *efx);
192
193 /* Interrupts and test events */
194 extern int efx_nic_init_interrupt(struct efx_nic *efx);
195 extern void efx_nic_enable_interrupts(struct efx_nic *efx);
196 extern void efx_nic_generate_test_event(struct efx_channel *channel);
197 extern void efx_nic_generate_fill_event(struct efx_channel *channel);
198 extern void efx_nic_generate_interrupt(struct efx_nic *efx);
199 extern void efx_nic_disable_interrupts(struct efx_nic *efx);
200 extern void efx_nic_fini_interrupt(struct efx_nic *efx);
201 extern irqreturn_t efx_nic_fatal_interrupt(struct efx_nic *efx);
202 extern irqreturn_t falcon_legacy_interrupt_a1(int irq, void *dev_id);
203 extern void falcon_irq_ack_a1(struct efx_nic *efx);
204
205 #define EFX_IRQ_MOD_RESOLUTION  5
206 #define EFX_IRQ_MOD_MAX         0x1000
207
208 /* Global Resources */
209 extern int efx_nic_flush_queues(struct efx_nic *efx);
210 extern void falcon_start_nic_stats(struct efx_nic *efx);
211 extern void falcon_stop_nic_stats(struct efx_nic *efx);
212 extern void falcon_setup_xaui(struct efx_nic *efx);
213 extern int falcon_reset_xaui(struct efx_nic *efx);
214 extern void efx_nic_init_common(struct efx_nic *efx);
215 extern void efx_nic_push_rx_indir_table(struct efx_nic *efx);
216
217 int efx_nic_alloc_buffer(struct efx_nic *efx, struct efx_buffer *buffer,
218                          unsigned int len);
219 void efx_nic_free_buffer(struct efx_nic *efx, struct efx_buffer *buffer);
220
221 /* Tests */
222 struct efx_nic_register_test {
223         unsigned address;
224         efx_oword_t mask;
225 };
226 extern int efx_nic_test_registers(struct efx_nic *efx,
227                                   const struct efx_nic_register_test *regs,
228                                   size_t n_regs);
229
230 extern size_t efx_nic_get_regs_len(struct efx_nic *efx);
231 extern void efx_nic_get_regs(struct efx_nic *efx, void *buf);
232
233 /**************************************************************************
234  *
235  * Falcon MAC stats
236  *
237  **************************************************************************
238  */
239
240 #define FALCON_STAT_OFFSET(falcon_stat) EFX_VAL(falcon_stat, offset)
241 #define FALCON_STAT_WIDTH(falcon_stat) EFX_VAL(falcon_stat, WIDTH)
242
243 /* Retrieve statistic from statistics block */
244 #define FALCON_STAT(efx, falcon_stat, efx_stat) do {            \
245         if (FALCON_STAT_WIDTH(falcon_stat) == 16)               \
246                 (efx)->mac_stats.efx_stat += le16_to_cpu(       \
247                         *((__force __le16 *)                            \
248                           (efx->stats_buffer.addr +             \
249                            FALCON_STAT_OFFSET(falcon_stat))));  \
250         else if (FALCON_STAT_WIDTH(falcon_stat) == 32)          \
251                 (efx)->mac_stats.efx_stat += le32_to_cpu(       \
252                         *((__force __le32 *)                            \
253                           (efx->stats_buffer.addr +             \
254                            FALCON_STAT_OFFSET(falcon_stat))));  \
255         else                                                    \
256                 (efx)->mac_stats.efx_stat += le64_to_cpu(       \
257                         *((__force __le64 *)                            \
258                           (efx->stats_buffer.addr +             \
259                            FALCON_STAT_OFFSET(falcon_stat))));  \
260         } while (0)
261
262 #define FALCON_MAC_STATS_SIZE 0x100
263
264 #define MAC_DATA_LBN 0
265 #define MAC_DATA_WIDTH 32
266
267 extern void efx_nic_generate_event(struct efx_channel *channel,
268                                    efx_qword_t *event);
269
270 extern void falcon_poll_xmac(struct efx_nic *efx);
271
272 #endif /* EFX_NIC_H */