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