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