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