xref: /openbmc/linux/drivers/net/ethernet/sfc/efx.h (revision 2169e6da)
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 int efx_probe_tx_queue(struct efx_tx_queue *tx_queue);
19 void efx_remove_tx_queue(struct efx_tx_queue *tx_queue);
20 void efx_init_tx_queue(struct efx_tx_queue *tx_queue);
21 void efx_init_tx_queue_core_txq(struct efx_tx_queue *tx_queue);
22 void efx_fini_tx_queue(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 void efx_xmit_done(struct efx_tx_queue *tx_queue, unsigned int index);
27 int efx_setup_tc(struct net_device *net_dev, enum tc_setup_type type,
28 		 void *type_data);
29 unsigned int efx_tx_max_skb_descs(struct efx_nic *efx);
30 extern unsigned int efx_piobuf_size;
31 extern bool efx_separate_tx_channels;
32 
33 /* RX */
34 void efx_set_default_rx_indir_table(struct efx_nic *efx,
35 				    struct efx_rss_context *ctx);
36 void efx_rx_config_page_split(struct efx_nic *efx);
37 int efx_probe_rx_queue(struct efx_rx_queue *rx_queue);
38 void efx_remove_rx_queue(struct efx_rx_queue *rx_queue);
39 void efx_init_rx_queue(struct efx_rx_queue *rx_queue);
40 void efx_fini_rx_queue(struct efx_rx_queue *rx_queue);
41 void efx_fast_push_rx_descriptors(struct efx_rx_queue *rx_queue, bool atomic);
42 void efx_rx_slow_fill(struct timer_list *t);
43 void __efx_rx_packet(struct efx_channel *channel);
44 void efx_rx_packet(struct efx_rx_queue *rx_queue, unsigned int index,
45 		   unsigned int n_frags, unsigned int len, u16 flags);
46 static inline void efx_rx_flush_packet(struct efx_channel *channel)
47 {
48 	if (channel->rx_pkt_n_frags)
49 		__efx_rx_packet(channel);
50 }
51 void efx_schedule_slow_fill(struct efx_rx_queue *rx_queue);
52 
53 #define EFX_MAX_DMAQ_SIZE 4096UL
54 #define EFX_DEFAULT_DMAQ_SIZE 1024UL
55 #define EFX_MIN_DMAQ_SIZE 512UL
56 
57 #define EFX_MAX_EVQ_SIZE 16384UL
58 #define EFX_MIN_EVQ_SIZE 512UL
59 
60 /* Maximum number of TCP segments we support for soft-TSO */
61 #define EFX_TSO_MAX_SEGS	100
62 
63 /* The smallest [rt]xq_entries that the driver supports.  RX minimum
64  * is a bit arbitrary.  For TX, we must have space for at least 2
65  * TSO skbs.
66  */
67 #define EFX_RXQ_MIN_ENT		128U
68 #define EFX_TXQ_MIN_ENT(efx)	(2 * efx_tx_max_skb_descs(efx))
69 
70 /* All EF10 architecture NICs steal one bit of the DMAQ size for various
71  * other purposes when counting TxQ entries, so we halve the queue size.
72  */
73 #define EFX_TXQ_MAX_ENT(efx)	(EFX_WORKAROUND_EF10(efx) ? \
74 				 EFX_MAX_DMAQ_SIZE / 2 : EFX_MAX_DMAQ_SIZE)
75 
76 static inline bool efx_rss_enabled(struct efx_nic *efx)
77 {
78 	return efx->rss_spread > 1;
79 }
80 
81 /* Filters */
82 
83 void efx_mac_reconfigure(struct efx_nic *efx);
84 
85 /**
86  * efx_filter_insert_filter - add or replace a filter
87  * @efx: NIC in which to insert the filter
88  * @spec: Specification for the filter
89  * @replace_equal: Flag for whether the specified filter may replace an
90  *	existing filter with equal priority
91  *
92  * On success, return the filter ID.
93  * On failure, return a negative error code.
94  *
95  * If existing filters have equal match values to the new filter spec,
96  * then the new filter might replace them or the function might fail,
97  * as follows.
98  *
99  * 1. If the existing filters have lower priority, or @replace_equal
100  *    is set and they have equal priority, replace them.
101  *
102  * 2. If the existing filters have higher priority, return -%EPERM.
103  *
104  * 3. If !efx_filter_is_mc_recipient(@spec), or the NIC does not
105  *    support delivery to multiple recipients, return -%EEXIST.
106  *
107  * This implies that filters for multiple multicast recipients must
108  * all be inserted with the same priority and @replace_equal = %false.
109  */
110 static inline s32 efx_filter_insert_filter(struct efx_nic *efx,
111 					   struct efx_filter_spec *spec,
112 					   bool replace_equal)
113 {
114 	return efx->type->filter_insert(efx, spec, replace_equal);
115 }
116 
117 /**
118  * efx_filter_remove_id_safe - remove 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  *
123  * This function will range-check @filter_id, so it is safe to call
124  * with a value passed from userland.
125  */
126 static inline int efx_filter_remove_id_safe(struct efx_nic *efx,
127 					    enum efx_filter_priority priority,
128 					    u32 filter_id)
129 {
130 	return efx->type->filter_remove_safe(efx, priority, filter_id);
131 }
132 
133 /**
134  * efx_filter_get_filter_safe - retrieve a filter by ID, carefully
135  * @efx: NIC from which to remove the filter
136  * @priority: Priority of filter, as passed to @efx_filter_insert_filter
137  * @filter_id: ID of filter, as returned by @efx_filter_insert_filter
138  * @spec: Buffer in which to store filter specification
139  *
140  * This function will range-check @filter_id, so it is safe to call
141  * with a value passed from userland.
142  */
143 static inline int
144 efx_filter_get_filter_safe(struct efx_nic *efx,
145 			   enum efx_filter_priority priority,
146 			   u32 filter_id, struct efx_filter_spec *spec)
147 {
148 	return efx->type->filter_get_safe(efx, priority, filter_id, spec);
149 }
150 
151 static inline u32 efx_filter_count_rx_used(struct efx_nic *efx,
152 					   enum efx_filter_priority priority)
153 {
154 	return efx->type->filter_count_rx_used(efx, priority);
155 }
156 static inline u32 efx_filter_get_rx_id_limit(struct efx_nic *efx)
157 {
158 	return efx->type->filter_get_rx_id_limit(efx);
159 }
160 static inline s32 efx_filter_get_rx_ids(struct efx_nic *efx,
161 					enum efx_filter_priority priority,
162 					u32 *buf, u32 size)
163 {
164 	return efx->type->filter_get_rx_ids(efx, priority, buf, size);
165 }
166 #ifdef CONFIG_RFS_ACCEL
167 int efx_filter_rfs(struct net_device *net_dev, const struct sk_buff *skb,
168 		   u16 rxq_index, u32 flow_id);
169 bool __efx_filter_rfs_expire(struct efx_nic *efx, unsigned quota);
170 static inline void efx_filter_rfs_expire(struct work_struct *data)
171 {
172 	struct efx_channel *channel = container_of(data, struct efx_channel,
173 						   filter_work);
174 
175 	if (channel->rfs_filters_added >= 60 &&
176 	    __efx_filter_rfs_expire(channel->efx, 100))
177 		channel->rfs_filters_added -= 60;
178 }
179 #define efx_filter_rfs_enabled() 1
180 #else
181 static inline void efx_filter_rfs_expire(struct work_struct *data) {}
182 #define efx_filter_rfs_enabled() 0
183 #endif
184 bool efx_filter_is_mc_recipient(const struct efx_filter_spec *spec);
185 
186 bool efx_filter_spec_equal(const struct efx_filter_spec *left,
187 			   const struct efx_filter_spec *right);
188 u32 efx_filter_spec_hash(const struct efx_filter_spec *spec);
189 
190 #ifdef CONFIG_RFS_ACCEL
191 bool efx_rps_check_rule(struct efx_arfs_rule *rule, unsigned int filter_idx,
192 			bool *force);
193 
194 struct efx_arfs_rule *efx_rps_hash_find(struct efx_nic *efx,
195 					const struct efx_filter_spec *spec);
196 
197 /* @new is written to indicate if entry was newly added (true) or if an old
198  * entry was found and returned (false).
199  */
200 struct efx_arfs_rule *efx_rps_hash_add(struct efx_nic *efx,
201 				       const struct efx_filter_spec *spec,
202 				       bool *new);
203 
204 void efx_rps_hash_del(struct efx_nic *efx, const struct efx_filter_spec *spec);
205 #endif
206 
207 /* RSS contexts */
208 struct efx_rss_context *efx_alloc_rss_context_entry(struct efx_nic *efx);
209 struct efx_rss_context *efx_find_rss_context_entry(struct efx_nic *efx, u32 id);
210 void efx_free_rss_context_entry(struct efx_rss_context *ctx);
211 static inline bool efx_rss_active(struct efx_rss_context *ctx)
212 {
213 	return ctx->context_id != EFX_EF10_RSS_CONTEXT_INVALID;
214 }
215 
216 /* Channels */
217 int efx_channel_dummy_op_int(struct efx_channel *channel);
218 void efx_channel_dummy_op_void(struct efx_channel *channel);
219 int efx_realloc_channels(struct efx_nic *efx, u32 rxq_entries, u32 txq_entries);
220 
221 /* Ports */
222 int efx_reconfigure_port(struct efx_nic *efx);
223 int __efx_reconfigure_port(struct efx_nic *efx);
224 
225 /* Ethtool support */
226 extern const struct ethtool_ops efx_ethtool_ops;
227 
228 /* Reset handling */
229 int efx_reset(struct efx_nic *efx, enum reset_type method);
230 void efx_reset_down(struct efx_nic *efx, enum reset_type method);
231 int efx_reset_up(struct efx_nic *efx, enum reset_type method, bool ok);
232 int efx_try_recovery(struct efx_nic *efx);
233 
234 /* Global */
235 void efx_schedule_reset(struct efx_nic *efx, enum reset_type type);
236 unsigned int efx_usecs_to_ticks(struct efx_nic *efx, unsigned int usecs);
237 unsigned int efx_ticks_to_usecs(struct efx_nic *efx, unsigned int ticks);
238 int efx_init_irq_moderation(struct efx_nic *efx, unsigned int tx_usecs,
239 			    unsigned int rx_usecs, bool rx_adaptive,
240 			    bool rx_may_override_tx);
241 void efx_get_irq_moderation(struct efx_nic *efx, unsigned int *tx_usecs,
242 			    unsigned int *rx_usecs, bool *rx_adaptive);
243 void efx_stop_eventq(struct efx_channel *channel);
244 void efx_start_eventq(struct efx_channel *channel);
245 
246 /* Dummy PHY ops for PHY drivers */
247 int efx_port_dummy_op_int(struct efx_nic *efx);
248 void efx_port_dummy_op_void(struct efx_nic *efx);
249 
250 /* Update the generic software stats in the passed stats array */
251 void efx_update_sw_stats(struct efx_nic *efx, u64 *stats);
252 
253 /* MTD */
254 #ifdef CONFIG_SFC_MTD
255 int efx_mtd_add(struct efx_nic *efx, struct efx_mtd_partition *parts,
256 		size_t n_parts, size_t sizeof_part);
257 static inline int efx_mtd_probe(struct efx_nic *efx)
258 {
259 	return efx->type->mtd_probe(efx);
260 }
261 void efx_mtd_rename(struct efx_nic *efx);
262 void efx_mtd_remove(struct efx_nic *efx);
263 #else
264 static inline int efx_mtd_probe(struct efx_nic *efx) { return 0; }
265 static inline void efx_mtd_rename(struct efx_nic *efx) {}
266 static inline void efx_mtd_remove(struct efx_nic *efx) {}
267 #endif
268 
269 #ifdef CONFIG_SFC_SRIOV
270 static inline unsigned int efx_vf_size(struct efx_nic *efx)
271 {
272 	return 1 << efx->vi_scale;
273 }
274 #endif
275 
276 static inline void efx_schedule_channel(struct efx_channel *channel)
277 {
278 	netif_vdbg(channel->efx, intr, channel->efx->net_dev,
279 		   "channel %d scheduling NAPI poll on CPU%d\n",
280 		   channel->channel, raw_smp_processor_id());
281 
282 	napi_schedule(&channel->napi_str);
283 }
284 
285 static inline void efx_schedule_channel_irq(struct efx_channel *channel)
286 {
287 	channel->event_test_cpu = raw_smp_processor_id();
288 	efx_schedule_channel(channel);
289 }
290 
291 void efx_link_status_changed(struct efx_nic *efx);
292 void efx_link_set_advertising(struct efx_nic *efx,
293 			      const unsigned long *advertising);
294 void efx_link_clear_advertising(struct efx_nic *efx);
295 void efx_link_set_wanted_fc(struct efx_nic *efx, u8);
296 
297 static inline void efx_device_detach_sync(struct efx_nic *efx)
298 {
299 	struct net_device *dev = efx->net_dev;
300 
301 	/* Lock/freeze all TX queues so that we can be sure the
302 	 * TX scheduler is stopped when we're done and before
303 	 * netif_device_present() becomes false.
304 	 */
305 	netif_tx_lock_bh(dev);
306 	netif_device_detach(dev);
307 	netif_tx_unlock_bh(dev);
308 }
309 
310 static inline void efx_device_attach_if_not_resetting(struct efx_nic *efx)
311 {
312 	if ((efx->state != STATE_DISABLED) && !efx->reset_pending)
313 		netif_device_attach(efx->net_dev);
314 }
315 
316 static inline bool efx_rwsem_assert_write_locked(struct rw_semaphore *sem)
317 {
318 	if (WARN_ON(down_read_trylock(sem))) {
319 		up_read(sem);
320 		return false;
321 	}
322 	return true;
323 }
324 
325 #endif /* EFX_EFX_H */
326