drivers/net/sfc/falcon.h

   1 /****************************************************************************
   2  * Driver for Solarflare Solarstorm network controllers and boards
   3  * Copyright 2005-2006 Fen Systems Ltd.
   4  * Copyright 2006-2008 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_FALCON_H
  12 #define EFX_FALCON_H
  13
  14 #include <linux/i2c-algo-bit.h>
  15 #include "net_driver.h"
  16 #include "efx.h"
  17
  18 /*
  19  * Falcon hardware control
  20  */
  21
  22 enum falcon_revision {
  23         FALCON_REV_A0 = 0,
  24         FALCON_REV_A1 = 1,
  25         FALCON_REV_B0 = 2,
  26 };
  27
  28 static inline int falcon_rev(struct efx_nic *efx)
  29 {
  30         return efx->pci_dev->revision;
  31 }
  32
  33 /**
  34  * struct falcon_board - board information
  35  * @type: Board model type
  36  * @major: Major rev. ('A', 'B' ...)
  37  * @minor: Minor rev. (0, 1, ...)
  38  * @init: Allocate resources and initialise peripheral hardware
  39  * @init_phy: Do board-specific PHY initialisation
  40  * @set_id_led: Set state of identifying LED or revert to automatic function
  41  * @monitor: Board-specific health check function
  42  * @fini: Shut down hardware and free resources
  43  * @i2c_adap: I2C adapter for on-board peripherals
  44  * @i2c_data: Data for bit-banging algorithm
  45  * @hwmon_client: I2C client for hardware monitor
  46  * @ioexp_client: I2C client for power/port control
  47  */
  48 struct falcon_board {
  49         int type;
  50         int major;
  51         int minor;
  52         int (*init) (struct efx_nic *nic);
  53         void (*init_phy) (struct efx_nic *efx);
  54         void (*set_id_led) (struct efx_nic *efx, enum efx_led_mode mode);
  55         int (*monitor) (struct efx_nic *nic);
  56         void (*fini) (struct efx_nic *nic);
  57         struct i2c_adapter i2c_adap;
  58         struct i2c_algo_bit_data i2c_data;
  59         struct i2c_client *hwmon_client, *ioexp_client;
  60 };
  61
  62 /**
  63  * struct falcon_nic_data - Falcon NIC state
  64  * @pci_dev2: The secondary PCI device if present
  65  * @board: Board state and functions
  66  */
  67 struct falcon_nic_data {
  68         struct pci_dev *pci_dev2;
  69         struct falcon_board board;
  70 };
  71
  72 static inline struct falcon_board *falcon_board(struct efx_nic *efx)
  73 {
  74         struct falcon_nic_data *data = efx->nic_data;
  75         return &data->board;
  76 }
  77
  78 extern struct efx_nic_type falcon_a_nic_type;
  79 extern struct efx_nic_type falcon_b_nic_type;
  80
  81 /**************************************************************************
  82  *
  83  * Externs
  84  *
  85  **************************************************************************
  86  */
  87
  88 extern void falcon_probe_board(struct efx_nic *efx, u16 revision_info);
  89
  90 /* TX data path */
  91 extern int falcon_probe_tx(struct efx_tx_queue *tx_queue);
  92 extern void falcon_init_tx(struct efx_tx_queue *tx_queue);
  93 extern void falcon_fini_tx(struct efx_tx_queue *tx_queue);
  94 extern void falcon_remove_tx(struct efx_tx_queue *tx_queue);
  95 extern void falcon_push_buffers(struct efx_tx_queue *tx_queue);
  96
  97 /* RX data path */
  98 extern int falcon_probe_rx(struct efx_rx_queue *rx_queue);
  99 extern void falcon_init_rx(struct efx_rx_queue *rx_queue);
 100 extern void falcon_fini_rx(struct efx_rx_queue *rx_queue);
 101 extern void falcon_remove_rx(struct efx_rx_queue *rx_queue);
 102 extern void falcon_notify_rx_desc(struct efx_rx_queue *rx_queue);
 103
 104 /* Event data path */
 105 extern int falcon_probe_eventq(struct efx_channel *channel);
 106 extern void falcon_init_eventq(struct efx_channel *channel);
 107 extern void falcon_fini_eventq(struct efx_channel *channel);
 108 extern void falcon_remove_eventq(struct efx_channel *channel);
 109 extern int falcon_process_eventq(struct efx_channel *channel, int rx_quota);
 110 extern void falcon_eventq_read_ack(struct efx_channel *channel);
 111
 112 /* Ports */
 113 extern int falcon_probe_port(struct efx_nic *efx);
 114 extern void falcon_remove_port(struct efx_nic *efx);
 115
 116 /* MAC/PHY */
 117 extern int falcon_switch_mac(struct efx_nic *efx);
 118 extern bool falcon_xaui_link_ok(struct efx_nic *efx);
 119 extern int falcon_dma_stats(struct efx_nic *efx,
 120                             unsigned int done_offset);
 121 extern void falcon_drain_tx_fifo(struct efx_nic *efx);
 122 extern void falcon_deconfigure_mac_wrapper(struct efx_nic *efx);
 123 extern void falcon_reconfigure_mac_wrapper(struct efx_nic *efx);
 124
 125 /* Interrupts and test events */
 126 extern int falcon_init_interrupt(struct efx_nic *efx);
 127 extern void falcon_enable_interrupts(struct efx_nic *efx);
 128 extern void falcon_generate_test_event(struct efx_channel *channel,
 129                                        unsigned int magic);
 130 extern void falcon_sim_phy_event(struct efx_nic *efx);
 131 extern void falcon_generate_interrupt(struct efx_nic *efx);
 132 extern void falcon_set_int_moderation(struct efx_channel *channel);
 133 extern void falcon_disable_interrupts(struct efx_nic *efx);
 134 extern void falcon_fini_interrupt(struct efx_nic *efx);
 135
 136 #define FALCON_IRQ_MOD_RESOLUTION 5
 137
 138 /* Global Resources */
 139 extern int falcon_probe_nic(struct efx_nic *efx);
 140 extern int falcon_init_nic(struct efx_nic *efx);
 141 extern int falcon_flush_queues(struct efx_nic *efx);
 142 extern int falcon_reset_hw(struct efx_nic *efx, enum reset_type method);
 143 extern void falcon_remove_nic(struct efx_nic *efx);
 144 extern void falcon_update_nic_stats(struct efx_nic *efx);
 145 extern void falcon_set_multicast_hash(struct efx_nic *efx);
 146 extern int falcon_reset_xaui(struct efx_nic *efx);
 147
 148 /* Tests */
 149 struct falcon_nvconfig;
 150 extern int falcon_read_nvram(struct efx_nic *efx,
 151                              struct falcon_nvconfig *nvconfig);
 152 extern int falcon_test_registers(struct efx_nic *efx);
 153
 154 /**************************************************************************
 155  *
 156  * Falcon MAC stats
 157  *
 158  **************************************************************************
 159  */
 160
 161 #define FALCON_STAT_OFFSET(falcon_stat) EFX_VAL(falcon_stat, offset)
 162 #define FALCON_STAT_WIDTH(falcon_stat) EFX_VAL(falcon_stat, WIDTH)
 163
 164 /* Retrieve statistic from statistics block */
 165 #define FALCON_STAT(efx, falcon_stat, efx_stat) do {            \
 166         if (FALCON_STAT_WIDTH(falcon_stat) == 16)               \
 167                 (efx)->mac_stats.efx_stat += le16_to_cpu(       \
 168                         *((__force __le16 *)                            \
 169                           (efx->stats_buffer.addr +             \
 170                            FALCON_STAT_OFFSET(falcon_stat))));  \
 171         else if (FALCON_STAT_WIDTH(falcon_stat) == 32)          \
 172                 (efx)->mac_stats.efx_stat += le32_to_cpu(       \
 173                         *((__force __le32 *)                            \
 174                           (efx->stats_buffer.addr +             \
 175                            FALCON_STAT_OFFSET(falcon_stat))));  \
 176         else                                                    \
 177                 (efx)->mac_stats.efx_stat += le64_to_cpu(       \
 178                         *((__force __le64 *)                            \
 179                           (efx->stats_buffer.addr +             \
 180                            FALCON_STAT_OFFSET(falcon_stat))));  \
 181         } while (0)
 182
 183 #define FALCON_MAC_STATS_SIZE 0x100
 184
 185 #define MAC_DATA_LBN 0
 186 #define MAC_DATA_WIDTH 32
 187
 188 extern void falcon_generate_event(struct efx_channel *channel,
 189                                   efx_qword_t *event);
 190
 191 #endif /* EFX_FALCON_H */