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