drivers/net/ethernet/sfc/efx.h

   1 /****************************************************************************
   2  * Driver for Solarflare network controllers and boards
   3  * Copyright 2005-2006 Fen Systems Ltd.
   4  * Copyright 2006-2013 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_EFX_H
  12 #define EFX_EFX_H
  13
  14 #include "net_driver.h"
  15 #include "filter.h"
  16
  17 /* Solarstorm controllers use BAR 0 for I/O space and BAR 2(&3) for memory */
  18 #define EFX_MEM_BAR 2
  19
  20 /* TX */
  21 extern int efx_probe_tx_queue(struct efx_tx_queue *tx_queue);
  22 extern void efx_remove_tx_queue(struct efx_tx_queue *tx_queue);
  23 extern void efx_init_tx_queue(struct efx_tx_queue *tx_queue);
  24 extern void efx_init_tx_queue_core_txq(struct efx_tx_queue *tx_queue);
  25 extern void efx_fini_tx_queue(struct efx_tx_queue *tx_queue);
  26 extern netdev_tx_t
  27 efx_hard_start_xmit(struct sk_buff *skb, struct net_device *net_dev);
  28 extern netdev_tx_t
  29 efx_enqueue_skb(struct efx_tx_queue *tx_queue, struct sk_buff *skb);
  30 extern void efx_xmit_done(struct efx_tx_queue *tx_queue, unsigned int index);
  31 extern int efx_setup_tc(struct net_device *net_dev, u8 num_tc);
  32 extern unsigned int efx_tx_max_skb_descs(struct efx_nic *efx);
  33 extern unsigned int efx_piobuf_size;
  34
  35 /* RX */
  36 extern void efx_rx_config_page_split(struct efx_nic *efx);
  37 extern int efx_probe_rx_queue(struct efx_rx_queue *rx_queue);
  38 extern void efx_remove_rx_queue(struct efx_rx_queue *rx_queue);
  39 extern void efx_init_rx_queue(struct efx_rx_queue *rx_queue);
  40 extern void efx_fini_rx_queue(struct efx_rx_queue *rx_queue);
  41 extern void efx_fast_push_rx_descriptors(struct efx_rx_queue *rx_queue);
  42 extern void efx_rx_slow_fill(unsigned long context);
  43 extern void __efx_rx_packet(struct efx_channel *channel);
  44 extern void efx_rx_packet(struct efx_rx_queue *rx_queue,
  45                           unsigned int index, unsigned int n_frags,
  46                           unsigned int len, u16 flags);
  47 static inline void efx_rx_flush_packet(struct efx_channel *channel)
  48 {
  49         if (channel->rx_pkt_n_frags)
  50                 __efx_rx_packet(channel);
  51 }
  52 extern void efx_schedule_slow_fill(struct efx_rx_queue *rx_queue);
  53
  54 #define EFX_MAX_DMAQ_SIZE 4096UL
  55 #define EFX_DEFAULT_DMAQ_SIZE 1024UL
  56 #define EFX_MIN_DMAQ_SIZE 512UL
  57
  58 #define EFX_MAX_EVQ_SIZE 16384UL
  59 #define EFX_MIN_EVQ_SIZE 512UL
  60
  61 /* Maximum number of TCP segments we support for soft-TSO */
  62 #define EFX_TSO_MAX_SEGS        100
  63
  64 /* The smallest [rt]xq_entries that the driver supports.  RX minimum
  65  * is a bit arbitrary.  For TX, we must have space for at least 2
  66  * TSO skbs.
  67  */
  68 #define EFX_RXQ_MIN_ENT         128U
  69 #define EFX_TXQ_MIN_ENT(efx)    (2 * efx_tx_max_skb_descs(efx))
  70
  71 /* Filters */
  72
  73 /**
  74  * efx_filter_insert_filter - add or replace a filter
  75  * @efx: NIC in which to insert the filter
  76  * @spec: Specification for the filter
  77  * @replace_equal: Flag for whether the specified filter may replace an
  78  *      existing filter with equal priority
  79  *
  80  * On success, return the filter ID.
  81  * On failure, return a negative error code.
  82  *
  83  * If existing filters have equal match values to the new filter spec,
  84  * then the new filter might replace them or the function might fail,
  85  * as follows.
  86  *
  87  * 1. If the existing filters have lower priority, or @replace_equal
  88  *    is set and they have equal priority, replace them.
  89  *
  90  * 2. If the existing filters have higher priority, return -%EPERM.
  91  *
  92  * 3. If !efx_filter_is_mc_recipient(@spec), or the NIC does not
  93  *    support delivery to multiple recipients, return -%EEXIST.
  94  *
  95  * This implies that filters for multiple multicast recipients must
  96  * all be inserted with the same priority and @replace_equal = %false.
  97  */
  98 static inline s32 efx_filter_insert_filter(struct efx_nic *efx,
  99                                            struct efx_filter_spec *spec,
 100                                            bool replace_equal)
 101 {
 102         return efx->type->filter_insert(efx, spec, replace_equal);
 103 }
 104
 105 /**
 106  * efx_filter_remove_id_safe - remove a filter by ID, carefully
 107  * @efx: NIC from which to remove the filter
 108  * @priority: Priority of filter, as passed to @efx_filter_insert_filter
 109  * @filter_id: ID of filter, as returned by @efx_filter_insert_filter
 110  *
 111  * This function will range-check @filter_id, so it is safe to call
 112  * with a value passed from userland.
 113  */
 114 static inline int efx_filter_remove_id_safe(struct efx_nic *efx,
 115                                             enum efx_filter_priority priority,
 116                                             u32 filter_id)
 117 {
 118         return efx->type->filter_remove_safe(efx, priority, filter_id);
 119 }
 120
 121 /**
 122  * efx_filter_get_filter_safe - retrieve a filter by ID, carefully
 123  * @efx: NIC from which to remove the filter
 124  * @priority: Priority of filter, as passed to @efx_filter_insert_filter
 125  * @filter_id: ID of filter, as returned by @efx_filter_insert_filter
 126  * @spec: Buffer in which to store filter specification
 127  *
 128  * This function will range-check @filter_id, so it is safe to call
 129  * with a value passed from userland.
 130  */
 131 static inline int
 132 efx_filter_get_filter_safe(struct efx_nic *efx,
 133                            enum efx_filter_priority priority,
 134                            u32 filter_id, struct efx_filter_spec *spec)
 135 {
 136         return efx->type->filter_get_safe(efx, priority, filter_id, spec);
 137 }
 138
 139 /**
 140  * efx_farch_filter_clear_rx - remove RX filters by priority
 141  * @efx: NIC from which to remove the filters
 142  * @priority: Maximum priority to remove
 143  */
 144 static inline void efx_filter_clear_rx(struct efx_nic *efx,
 145                                        enum efx_filter_priority priority)
 146 {
 147         return efx->type->filter_clear_rx(efx, priority);
 148 }
 149
 150 static inline u32 efx_filter_count_rx_used(struct efx_nic *efx,
 151                                            enum efx_filter_priority priority)
 152 {
 153         return efx->type->filter_count_rx_used(efx, priority);
 154 }
 155 static inline u32 efx_filter_get_rx_id_limit(struct efx_nic *efx)
 156 {
 157         return efx->type->filter_get_rx_id_limit(efx);
 158 }
 159 static inline s32 efx_filter_get_rx_ids(struct efx_nic *efx,
 160                                         enum efx_filter_priority priority,
 161                                         u32 *buf, u32 size)
 162 {
 163         return efx->type->filter_get_rx_ids(efx, priority, buf, size);
 164 }
 165 #ifdef CONFIG_RFS_ACCEL
 166 extern int efx_filter_rfs(struct net_device *net_dev, const struct sk_buff *skb,
 167                           u16 rxq_index, u32 flow_id);
 168 extern bool __efx_filter_rfs_expire(struct efx_nic *efx, unsigned quota);
 169 static inline void efx_filter_rfs_expire(struct efx_channel *channel)
 170 {
 171         if (channel->rfs_filters_added >= 60 &&
 172             __efx_filter_rfs_expire(channel->efx, 100))
 173                 channel->rfs_filters_added -= 60;
 174 }
 175 #define efx_filter_rfs_enabled() 1
 176 #else
 177 static inline void efx_filter_rfs_expire(struct efx_channel *channel) {}
 178 #define efx_filter_rfs_enabled() 0
 179 #endif
 180 extern bool efx_filter_is_mc_recipient(const struct efx_filter_spec *spec);
 181
 182 /* Channels */
 183 extern int efx_channel_dummy_op_int(struct efx_channel *channel);
 184 extern void efx_channel_dummy_op_void(struct efx_channel *channel);
 185 extern int
 186 efx_realloc_channels(struct efx_nic *efx, u32 rxq_entries, u32 txq_entries);
 187
 188 /* Ports */
 189 extern int efx_reconfigure_port(struct efx_nic *efx);
 190 extern int __efx_reconfigure_port(struct efx_nic *efx);
 191
 192 /* Ethtool support */
 193 extern const struct ethtool_ops efx_ethtool_ops;
 194
 195 /* Reset handling */
 196 extern int efx_reset(struct efx_nic *efx, enum reset_type method);
 197 extern void efx_reset_down(struct efx_nic *efx, enum reset_type method);
 198 extern int efx_reset_up(struct efx_nic *efx, enum reset_type method, bool ok);
 199 extern int efx_try_recovery(struct efx_nic *efx);
 200
 201 /* Global */
 202 extern void efx_schedule_reset(struct efx_nic *efx, enum reset_type type);
 203 extern int efx_init_irq_moderation(struct efx_nic *efx, unsigned int tx_usecs,
 204                                    unsigned int rx_usecs, bool rx_adaptive,
 205                                    bool rx_may_override_tx);
 206 extern void efx_get_irq_moderation(struct efx_nic *efx, unsigned int *tx_usecs,
 207                                    unsigned int *rx_usecs, bool *rx_adaptive);
 208
 209 /* Dummy PHY ops for PHY drivers */
 210 extern int efx_port_dummy_op_int(struct efx_nic *efx);
 211 extern void efx_port_dummy_op_void(struct efx_nic *efx);
 212
 213
 214 /* MTD */
 215 #ifdef CONFIG_SFC_MTD
 216 extern int efx_mtd_add(struct efx_nic *efx, struct efx_mtd_partition *parts,
 217                        size_t n_parts, size_t sizeof_part);
 218 static inline int efx_mtd_probe(struct efx_nic *efx)
 219 {
 220         return efx->type->mtd_probe(efx);
 221 }
 222 extern void efx_mtd_rename(struct efx_nic *efx);
 223 extern void efx_mtd_remove(struct efx_nic *efx);
 224 #else
 225 static inline int efx_mtd_probe(struct efx_nic *efx) { return 0; }
 226 static inline void efx_mtd_rename(struct efx_nic *efx) {}
 227 static inline void efx_mtd_remove(struct efx_nic *efx) {}
 228 #endif
 229
 230 static inline void efx_schedule_channel(struct efx_channel *channel)
 231 {
 232         netif_vdbg(channel->efx, intr, channel->efx->net_dev,
 233                    "channel %d scheduling NAPI poll on CPU%d\n",
 234                    channel->channel, raw_smp_processor_id());
 235
 236         napi_schedule(&channel->napi_str);
 237 }
 238
 239 static inline void efx_schedule_channel_irq(struct efx_channel *channel)
 240 {
 241         channel->event_test_cpu = raw_smp_processor_id();
 242         efx_schedule_channel(channel);
 243 }
 244
 245 extern void efx_link_status_changed(struct efx_nic *efx);
 246 extern void efx_link_set_advertising(struct efx_nic *efx, u32);
 247 extern void efx_link_set_wanted_fc(struct efx_nic *efx, u8);
 248
 249 static inline void efx_device_detach_sync(struct efx_nic *efx)
 250 {
 251         struct net_device *dev = efx->net_dev;
 252
 253         /* Lock/freeze all TX queues so that we can be sure the
 254          * TX scheduler is stopped when we're done and before
 255          * netif_device_present() becomes false.
 256          */
 257         netif_tx_lock_bh(dev);
 258         netif_device_detach(dev);
 259         netif_tx_unlock_bh(dev);
 260 }
 261
 262 #endif /* EFX_EFX_H */