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