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