drivers/net/ethernet/sfc/efx.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /****************************************************************************
   3  * Driver for Solarflare network controllers and boards
   4  * Copyright 2005-2006 Fen Systems Ltd.
   5  * Copyright 2006-2013 Solarflare Communications Inc.
   6  */
   7
   8 #ifndef EFX_EFX_H
   9 #define EFX_EFX_H
  10
  11 #include "net_driver.h"
  12 #include "filter.h"
  13
  14 int efx_net_open(struct net_device *net_dev);
  15 int efx_net_stop(struct net_device *net_dev);
  16
  17 /* TX */
  18 void efx_init_tx_queue_core_txq(struct efx_tx_queue *tx_queue);
  19 netdev_tx_t efx_hard_start_xmit(struct sk_buff *skb,
  20                                 struct net_device *net_dev);
  21 netdev_tx_t efx_enqueue_skb(struct efx_tx_queue *tx_queue, struct sk_buff *skb);
  22 void efx_xmit_done(struct efx_tx_queue *tx_queue, unsigned int index);
  23 void efx_xmit_done_single(struct efx_tx_queue *tx_queue);
  24 int efx_setup_tc(struct net_device *net_dev, enum tc_setup_type type,
  25                  void *type_data);
  26 extern unsigned int efx_piobuf_size;
  27 extern bool efx_separate_tx_channels;
  28
  29 /* RX */
  30 void __efx_rx_packet(struct efx_channel *channel);
  31 void efx_rx_packet(struct efx_rx_queue *rx_queue, unsigned int index,
  32                    unsigned int n_frags, unsigned int len, u16 flags);
  33 static inline void efx_rx_flush_packet(struct efx_channel *channel)
  34 {
  35         if (channel->rx_pkt_n_frags)
  36                 __efx_rx_packet(channel);
  37 }
  38
  39 #define EFX_MAX_DMAQ_SIZE 4096UL
  40 #define EFX_DEFAULT_DMAQ_SIZE 1024UL
  41 #define EFX_MIN_DMAQ_SIZE 512UL
  42
  43 #define EFX_MAX_EVQ_SIZE 16384UL
  44 #define EFX_MIN_EVQ_SIZE 512UL
  45
  46 /* Maximum number of TCP segments we support for soft-TSO */
  47 #define EFX_TSO_MAX_SEGS        100
  48
  49 /* The smallest [rt]xq_entries that the driver supports.  RX minimum
  50  * is a bit arbitrary.  For TX, we must have space for at least 2
  51  * TSO skbs.
  52  */
  53 #define EFX_RXQ_MIN_ENT         128U
  54 #define EFX_TXQ_MIN_ENT(efx)    (2 * efx_tx_max_skb_descs(efx))
  55
  56 /* All EF10 architecture NICs steal one bit of the DMAQ size for various
  57  * other purposes when counting TxQ entries, so we halve the queue size.
  58  */
  59 #define EFX_TXQ_MAX_ENT(efx)    (EFX_WORKAROUND_EF10(efx) ? \
  60                                  EFX_MAX_DMAQ_SIZE / 2 : EFX_MAX_DMAQ_SIZE)
  61
  62 static inline bool efx_rss_enabled(struct efx_nic *efx)
  63 {
  64         return efx->rss_spread > 1;
  65 }
  66
  67 /* Filters */
  68
  69 /**
  70  * efx_filter_insert_filter - add or replace a filter
  71  * @efx: NIC in which to insert the filter
  72  * @spec: Specification for the filter
  73  * @replace_equal: Flag for whether the specified filter may replace an
  74  *      existing filter with equal priority
  75  *
  76  * On success, return the filter ID.
  77  * On failure, return a negative error code.
  78  *
  79  * If existing filters have equal match values to the new filter spec,
  80  * then the new filter might replace them or the function might fail,
  81  * as follows.
  82  *
  83  * 1. If the existing filters have lower priority, or @replace_equal
  84  *    is set and they have equal priority, replace them.
  85  *
  86  * 2. If the existing filters have higher priority, return -%EPERM.
  87  *
  88  * 3. If !efx_filter_is_mc_recipient(@spec), or the NIC does not
  89  *    support delivery to multiple recipients, return -%EEXIST.
  90  *
  91  * This implies that filters for multiple multicast recipients must
  92  * all be inserted with the same priority and @replace_equal = %false.
  93  */
  94 static inline s32 efx_filter_insert_filter(struct efx_nic *efx,
  95                                            struct efx_filter_spec *spec,
  96                                            bool replace_equal)
  97 {
  98         return efx->type->filter_insert(efx, spec, replace_equal);
  99 }
 100
 101 /**
 102  * efx_filter_remove_id_safe - remove a filter by ID, carefully
 103  * @efx: NIC from which to remove the filter
 104  * @priority: Priority of filter, as passed to @efx_filter_insert_filter
 105  * @filter_id: ID of filter, as returned by @efx_filter_insert_filter
 106  *
 107  * This function will range-check @filter_id, so it is safe to call
 108  * with a value passed from userland.
 109  */
 110 static inline int efx_filter_remove_id_safe(struct efx_nic *efx,
 111                                             enum efx_filter_priority priority,
 112                                             u32 filter_id)
 113 {
 114         return efx->type->filter_remove_safe(efx, priority, filter_id);
 115 }
 116
 117 /**
 118  * efx_filter_get_filter_safe - retrieve a filter by ID, carefully
 119  * @efx: NIC from which to remove the filter
 120  * @priority: Priority of filter, as passed to @efx_filter_insert_filter
 121  * @filter_id: ID of filter, as returned by @efx_filter_insert_filter
 122  * @spec: Buffer in which to store filter specification
 123  *
 124  * This function will range-check @filter_id, so it is safe to call
 125  * with a value passed from userland.
 126  */
 127 static inline int
 128 efx_filter_get_filter_safe(struct efx_nic *efx,
 129                            enum efx_filter_priority priority,
 130                            u32 filter_id, struct efx_filter_spec *spec)
 131 {
 132         return efx->type->filter_get_safe(efx, priority, filter_id, spec);
 133 }
 134
 135 static inline u32 efx_filter_count_rx_used(struct efx_nic *efx,
 136                                            enum efx_filter_priority priority)
 137 {
 138         return efx->type->filter_count_rx_used(efx, priority);
 139 }
 140 static inline u32 efx_filter_get_rx_id_limit(struct efx_nic *efx)
 141 {
 142         return efx->type->filter_get_rx_id_limit(efx);
 143 }
 144 static inline s32 efx_filter_get_rx_ids(struct efx_nic *efx,
 145                                         enum efx_filter_priority priority,
 146                                         u32 *buf, u32 size)
 147 {
 148         return efx->type->filter_get_rx_ids(efx, priority, buf, size);
 149 }
 150 #ifdef CONFIG_RFS_ACCEL
 151 int efx_filter_rfs(struct net_device *net_dev, const struct sk_buff *skb,
 152                    u16 rxq_index, u32 flow_id);
 153 bool __efx_filter_rfs_expire(struct efx_channel *channel, unsigned int quota);
 154 #endif
 155
 156 /* RSS contexts */
 157 static inline bool efx_rss_active(struct efx_rss_context *ctx)
 158 {
 159         return ctx->context_id != EFX_MCDI_RSS_CONTEXT_INVALID;
 160 }
 161
 162 /* Ethtool support */
 163 extern const struct ethtool_ops efx_ethtool_ops;
 164
 165 /* Global */
 166 unsigned int efx_usecs_to_ticks(struct efx_nic *efx, unsigned int usecs);
 167 unsigned int efx_ticks_to_usecs(struct efx_nic *efx, unsigned int ticks);
 168 int efx_init_irq_moderation(struct efx_nic *efx, unsigned int tx_usecs,
 169                             unsigned int rx_usecs, bool rx_adaptive,
 170                             bool rx_may_override_tx);
 171 void efx_get_irq_moderation(struct efx_nic *efx, unsigned int *tx_usecs,
 172                             unsigned int *rx_usecs, bool *rx_adaptive);
 173
 174 /* Dummy PHY ops for PHY drivers */
 175 int efx_port_dummy_op_int(struct efx_nic *efx);
 176 void efx_port_dummy_op_void(struct efx_nic *efx);
 177
 178 /* Update the generic software stats in the passed stats array */
 179 void efx_update_sw_stats(struct efx_nic *efx, u64 *stats);
 180
 181 /* MTD */
 182 #ifdef CONFIG_SFC_MTD
 183 int efx_mtd_add(struct efx_nic *efx, struct efx_mtd_partition *parts,
 184                 size_t n_parts, size_t sizeof_part);
 185 static inline int efx_mtd_probe(struct efx_nic *efx)
 186 {
 187         return efx->type->mtd_probe(efx);
 188 }
 189 void efx_mtd_rename(struct efx_nic *efx);
 190 void efx_mtd_remove(struct efx_nic *efx);
 191 #else
 192 static inline int efx_mtd_probe(struct efx_nic *efx) { return 0; }
 193 static inline void efx_mtd_rename(struct efx_nic *efx) {}
 194 static inline void efx_mtd_remove(struct efx_nic *efx) {}
 195 #endif
 196
 197 #ifdef CONFIG_SFC_SRIOV
 198 static inline unsigned int efx_vf_size(struct efx_nic *efx)
 199 {
 200         return 1 << efx->vi_scale;
 201 }
 202 #endif
 203
 204 static inline void efx_schedule_channel(struct efx_channel *channel)
 205 {
 206         netif_vdbg(channel->efx, intr, channel->efx->net_dev,
 207                    "channel %d scheduling NAPI poll on CPU%d\n",
 208                    channel->channel, raw_smp_processor_id());
 209
 210         napi_schedule(&channel->napi_str);
 211 }
 212
 213 static inline void efx_schedule_channel_irq(struct efx_channel *channel)
 214 {
 215         channel->event_test_cpu = raw_smp_processor_id();
 216         efx_schedule_channel(channel);
 217 }
 218
 219 void efx_link_clear_advertising(struct efx_nic *efx);
 220 void efx_link_set_wanted_fc(struct efx_nic *efx, u8);
 221
 222 static inline void efx_device_detach_sync(struct efx_nic *efx)
 223 {
 224         struct net_device *dev = efx->net_dev;
 225
 226         /* Lock/freeze all TX queues so that we can be sure the
 227          * TX scheduler is stopped when we're done and before
 228          * netif_device_present() becomes false.
 229          */
 230         netif_tx_lock_bh(dev);
 231         netif_device_detach(dev);
 232         netif_tx_unlock_bh(dev);
 233 }
 234
 235 static inline void efx_device_attach_if_not_resetting(struct efx_nic *efx)
 236 {
 237         if ((efx->state != STATE_DISABLED) && !efx->reset_pending)
 238                 netif_device_attach(efx->net_dev);
 239 }
 240
 241 static inline bool efx_rwsem_assert_write_locked(struct rw_semaphore *sem)
 242 {
 243         if (WARN_ON(down_read_trylock(sem))) {
 244                 up_read(sem);
 245                 return false;
 246         }
 247         return true;
 248 }
 249
 250 int efx_xdp_tx_buffers(struct efx_nic *efx, int n, struct xdp_frame **xdpfs,
 251                        bool flush);
 252
 253 #endif /* EFX_EFX_H */