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 /* Alignment of PCIe DMA boundaries (4KB) */
  69 #define EFX_PAGE_SIZE   4096
  70
  71 /**
  72  * struct falcon_board_type - board operations and type information
  73  * @id: Board type id, as found in NVRAM
  74  * @ref_model: Model number of Solarflare reference design
  75  * @gen_type: Generic board type description
  76  * @init: Allocate resources and initialise peripheral hardware
  77  * @init_phy: Do board-specific PHY initialisation
  78  * @fini: Shut down hardware and free resources
  79  * @set_id_led: Set state of identifying LED or revert to automatic function
  80  * @monitor: Board-specific health check function
  81  */
  82 struct falcon_board_type {
  83         u8 id;
  84         const char *ref_model;
  85         const char *gen_type;
  86         int (*init) (struct efx_nic *nic);
  87         void (*init_phy) (struct efx_nic *efx);
  88         void (*fini) (struct efx_nic *nic);
  89         void (*set_id_led) (struct efx_nic *efx, enum efx_led_mode mode);
  90         int (*monitor) (struct efx_nic *nic);
  91 };
  92
  93 /**
  94  * struct falcon_board - board information
  95  * @type: Type of board
  96  * @major: Major rev. ('A', 'B' ...)
  97  * @minor: Minor rev. (0, 1, ...)
  98  * @i2c_adap: I2C adapter for on-board peripherals
  99  * @i2c_data: Data for bit-banging algorithm
 100  * @hwmon_client: I2C client for hardware monitor
 101  * @ioexp_client: I2C client for power/port control
 102  */
 103 struct falcon_board {
 104         const struct falcon_board_type *type;
 105         int major;
 106         int minor;
 107         struct i2c_adapter i2c_adap;
 108         struct i2c_algo_bit_data i2c_data;
 109         struct i2c_client *hwmon_client, *ioexp_client;
 110 };
 111
 112 /**
 113  * struct falcon_nic_data - Falcon NIC state
 114  * @pci_dev2: Secondary function of Falcon A
 115  * @board: Board state and functions
 116  * @stats_disable_count: Nest count for disabling statistics fetches
 117  * @stats_pending: Is there a pending DMA of MAC statistics.
 118  * @stats_timer: A timer for regularly fetching MAC statistics.
 119  * @stats_dma_done: Pointer to the flag which indicates DMA completion.
 120  * @spi_flash: SPI flash device
 121  * @spi_eeprom: SPI EEPROM device
 122  * @spi_lock: SPI bus lock
 123  * @mdio_lock: MDIO bus lock
 124  * @xmac_poll_required: XMAC link state needs polling
 125  */
 126 struct falcon_nic_data {
 127         struct pci_dev *pci_dev2;
 128         struct falcon_board board;
 129         unsigned int stats_disable_count;
 130         bool stats_pending;
 131         struct timer_list stats_timer;
 132         u32 *stats_dma_done;
 133         struct efx_spi_device spi_flash;
 134         struct efx_spi_device spi_eeprom;
 135         struct mutex spi_lock;
 136         struct mutex mdio_lock;
 137         bool xmac_poll_required;
 138 };
 139
 140 static inline struct falcon_board *falcon_board(struct efx_nic *efx)
 141 {
 142         struct falcon_nic_data *data = efx->nic_data;
 143         return &data->board;
 144 }
 145
 146 /**
 147  * struct siena_nic_data - Siena NIC state
 148  * @mcdi: Management-Controller-to-Driver Interface
 149  * @wol_filter_id: Wake-on-LAN packet filter id
 150  */
 151 struct siena_nic_data {
 152         struct efx_mcdi_iface mcdi;
 153         int wol_filter_id;
 154 };
 155
 156 extern const struct efx_nic_type falcon_a1_nic_type;
 157 extern const struct efx_nic_type falcon_b0_nic_type;
 158 extern const struct efx_nic_type siena_a0_nic_type;
 159
 160 /**************************************************************************
 161  *
 162  * Externs
 163  *
 164  **************************************************************************
 165  */
 166
 167 extern int falcon_probe_board(struct efx_nic *efx, u16 revision_info);
 168
 169 /* TX data path */
 170 extern int efx_nic_probe_tx(struct efx_tx_queue *tx_queue);
 171 extern void efx_nic_init_tx(struct efx_tx_queue *tx_queue);
 172 extern void efx_nic_fini_tx(struct efx_tx_queue *tx_queue);
 173 extern void efx_nic_remove_tx(struct efx_tx_queue *tx_queue);
 174 extern void efx_nic_push_buffers(struct efx_tx_queue *tx_queue);
 175
 176 /* RX data path */
 177 extern int efx_nic_probe_rx(struct efx_rx_queue *rx_queue);
 178 extern void efx_nic_init_rx(struct efx_rx_queue *rx_queue);
 179 extern void efx_nic_fini_rx(struct efx_rx_queue *rx_queue);
 180 extern void efx_nic_remove_rx(struct efx_rx_queue *rx_queue);
 181 extern void efx_nic_notify_rx_desc(struct efx_rx_queue *rx_queue);
 182
 183 /* Event data path */
 184 extern int efx_nic_probe_eventq(struct efx_channel *channel);
 185 extern void efx_nic_init_eventq(struct efx_channel *channel);
 186 extern void efx_nic_fini_eventq(struct efx_channel *channel);
 187 extern void efx_nic_remove_eventq(struct efx_channel *channel);
 188 extern int efx_nic_process_eventq(struct efx_channel *channel, int rx_quota);
 189 extern void efx_nic_eventq_read_ack(struct efx_channel *channel);
 190 extern bool efx_nic_event_present(struct efx_channel *channel);
 191
 192 /* MAC/PHY */
 193 extern void falcon_drain_tx_fifo(struct efx_nic *efx);
 194 extern void falcon_reconfigure_mac_wrapper(struct efx_nic *efx);
 195
 196 /* Interrupts and test events */
 197 extern int efx_nic_init_interrupt(struct efx_nic *efx);
 198 extern void efx_nic_enable_interrupts(struct efx_nic *efx);
 199 extern void efx_nic_generate_test_event(struct efx_channel *channel);
 200 extern void efx_nic_generate_fill_event(struct efx_channel *channel);
 201 extern void efx_nic_generate_interrupt(struct efx_nic *efx);
 202 extern void efx_nic_disable_interrupts(struct efx_nic *efx);
 203 extern void efx_nic_fini_interrupt(struct efx_nic *efx);
 204 extern irqreturn_t efx_nic_fatal_interrupt(struct efx_nic *efx);
 205 extern irqreturn_t falcon_legacy_interrupt_a1(int irq, void *dev_id);
 206 extern void falcon_irq_ack_a1(struct efx_nic *efx);
 207
 208 #define EFX_IRQ_MOD_RESOLUTION  5
 209 #define EFX_IRQ_MOD_MAX         0x1000
 210
 211 /* Global Resources */
 212 extern int efx_nic_flush_queues(struct efx_nic *efx);
 213 extern void falcon_start_nic_stats(struct efx_nic *efx);
 214 extern void falcon_stop_nic_stats(struct efx_nic *efx);
 215 extern void falcon_setup_xaui(struct efx_nic *efx);
 216 extern int falcon_reset_xaui(struct efx_nic *efx);
 217 extern void efx_nic_init_common(struct efx_nic *efx);
 218 extern void efx_nic_push_rx_indir_table(struct efx_nic *efx);
 219
 220 int efx_nic_alloc_buffer(struct efx_nic *efx, struct efx_buffer *buffer,
 221                          unsigned int len);
 222 void efx_nic_free_buffer(struct efx_nic *efx, struct efx_buffer *buffer);
 223
 224 /* Tests */
 225 struct efx_nic_register_test {
 226         unsigned address;
 227         efx_oword_t mask;
 228 };
 229 extern int efx_nic_test_registers(struct efx_nic *efx,
 230                                   const struct efx_nic_register_test *regs,
 231                                   size_t n_regs);
 232
 233 extern size_t efx_nic_get_regs_len(struct efx_nic *efx);
 234 extern void efx_nic_get_regs(struct efx_nic *efx, void *buf);
 235
 236 /**************************************************************************
 237  *
 238  * Falcon MAC stats
 239  *
 240  **************************************************************************
 241  */
 242
 243 #define FALCON_STAT_OFFSET(falcon_stat) EFX_VAL(falcon_stat, offset)
 244 #define FALCON_STAT_WIDTH(falcon_stat) EFX_VAL(falcon_stat, WIDTH)
 245
 246 /* Retrieve statistic from statistics block */
 247 #define FALCON_STAT(efx, falcon_stat, efx_stat) do {            \
 248         if (FALCON_STAT_WIDTH(falcon_stat) == 16)               \
 249                 (efx)->mac_stats.efx_stat += le16_to_cpu(       \
 250                         *((__force __le16 *)                            \
 251                           (efx->stats_buffer.addr +             \
 252                            FALCON_STAT_OFFSET(falcon_stat))));  \
 253         else if (FALCON_STAT_WIDTH(falcon_stat) == 32)          \
 254                 (efx)->mac_stats.efx_stat += le32_to_cpu(       \
 255                         *((__force __le32 *)                            \
 256                           (efx->stats_buffer.addr +             \
 257                            FALCON_STAT_OFFSET(falcon_stat))));  \
 258         else                                                    \
 259                 (efx)->mac_stats.efx_stat += le64_to_cpu(       \
 260                         *((__force __le64 *)                            \
 261                           (efx->stats_buffer.addr +             \
 262                            FALCON_STAT_OFFSET(falcon_stat))));  \
 263         } while (0)
 264
 265 #define FALCON_MAC_STATS_SIZE 0x100
 266
 267 #define MAC_DATA_LBN 0
 268 #define MAC_DATA_WIDTH 32
 269
 270 extern void efx_nic_generate_event(struct efx_channel *channel,
 271                                    efx_qword_t *event);
 272
 273 extern void falcon_poll_xmac(struct efx_nic *efx);
 274
 275 #endif /* EFX_NIC_H */