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